# minty

MintyApi - the Ruby gem for the Minty API

Minty API

- API version: 1.0.0
- Package version: 1.0.2

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build minty.gemspec
```

Then either install the gem locally:

```shell
gem install ./minty-1.0.2.gem
```

(for development, run `gem install --dev ./minty-1.0.2.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'minty', '~> 1.0.2'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

    gem 'minty', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby
# Load the gem
require 'minty'

# Setup authorization
MintyApi.configure do |config|
  config.access_token = 'YOUR_BEARER_TOKEN'
  config.scheme = 'https'
  config.host = 'HOST'
end

api_instance = MintyApi::DefaultApi.new
api_minty_application_id = 'api_minty_application_id_example' # String | 

begin
  #forgot_password_url
  result = api_instance.api_v1_forgot_password_url_get(api_minty_application_id)
  p result
rescue MintyApi::ApiError => e
  puts "Exception when calling DefaultApi->api_v1_forgot_password_url_get: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*MintyApi::DefaultApi* | [**api_v1_forgot_password_url_get**](docs/DefaultApi.md#api_v1_forgot_password_url_get) | **GET** /api/v1/forgot_password_url | forgot_password_url
*MintyApi::DefaultApi* | [**api_v1_sign_in_url_get**](docs/DefaultApi.md#api_v1_sign_in_url_get) | **GET** /api/v1/sign_in_url | sign_in_url summary
*MintyApi::DefaultApi* | [**api_v1_sign_up_url_get**](docs/DefaultApi.md#api_v1_sign_up_url_get) | **GET** /api/v1/sign_up_url | sign_up_url


## Documentation for Models

 - [MintyApi::RedirectUrl](docs/RedirectUrl.md)