README.md in minty-1.0.1 vs README.md in minty-1.1.0
- old
+ new
@@ -1,88 +1,89 @@
-Ruby API client for the [Minty](https://minty.page) platform.
+# minty
-[](https://github.com/mintypage/ruby/blob/master/LICENSE)
+MintyApi - the Ruby gem for the Minty API
-## Documentation
+Minty API
-- [API documentation](https://www.rubydoc.info/gems/minty) - documentation auto-generated from the code comments that explains all the available features
-- [Examples](https://github.com/mintypage/ruby/blob/master/EXAMPLES.md) - examples that demonstrate the different ways in which this SDK can be used
-[FAQ](https://github.com/mintypage/ruby/blob/master/FAQ.md) - frequently asked questions about the SDK
-- [Docs Site](https://minty.page/docs) - explore our Docs site and learn more about Minty
+- API version: 1.0.0
+- Package version: 1.0.2
-## Getting Started
+## Installation
-### Installation
+### Build a gem
-This gem can be installed directly:
+To build the Ruby code into a gem:
-```bash
-$ gem install minty
+```shell
+gem build minty.gemspec
```
-or with [Bundler](https://bundler.io/man/bundle-add.1.html):
+Then either install the gem locally:
-```bash
-bundle add minty
+```shell
+gem install ./minty-1.0.2.gem
```
-### Usage
+(for development, run `gem install --dev ./minty-1.0.2.gem` to install the development dependencies)
-Create an instance of `MintyClient` to access properties and methods of the authentication and management APIs:
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-```ruby
-require 'minty'
+Finally add this to the Gemfile:
-client = MintyClient.new(
- client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
- client_secret: ENV['AUTH0_RUBY_CLIENT_SECRET'],
- domain: ENV['AUTH0_RUBY_DOMAIN'],
-)
-```
+ gem 'minty', '~> 1.0.2'
-If `token` is omitted, the SDK will attempt to fetch a new token using the `client_credentials` grant, provided that `client_id` and `client_secret` are provided in the configuration. Once the token is about to expire (or has already expired), a new token will be fetched and cached for future calls.
+### Install from Git
-For this to work, ensure your application can make a Client Credentials grant (Application settings in Minty > Advanced > Grant Types tab) and that the application is authorized for the Management API: https://minty.page/docs/api-auth/config/using-the-minty-dashboard
+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:
-## Authentication API Client
+ gem 'minty', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-This SDK provides access to [Authentication API](https://minty.page/docs/api/authentication) endpoints with the `Minty::API::AuthenticationEndpoints` module.
+### Include the Ruby code directly
-## Further reading
+Include the Ruby code directly using `-I` as follows:
-- [API authentication in Ruby](https://minty.page/docs/quickstart/backend/ruby)
-- [API authentication in Rails](https://minty.page/docs/quickstart/backend/rails)
-- [Managing authentication with Minty (blog)](https://minty.page/blog/rails-5-with-minty/)
-- [Ruby on Rails workflow with Docker (blog)](https://minty.page/blog/ruby-on-rails-killer-workflow-with-docker-part-1/)
+```shell
+ruby -Ilib script.rb
+```
-## Feedback
+## Getting Started
-### Contributing
+Please follow the [installation](#installation) procedure and then run the following code:
-We appreciate feedback and contribution to this repo! Before you get started, please see the following:
+```ruby
+# Load the gem
+require 'minty'
-- [Minty's general contribution guidelines](https://github.com/minty/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
-- [Minty's code of conduct guidelines](https://github.com/minty/open-source-template/blob/master/CODE-OF-CONDUCT.md)
+# Setup authorization
+MintyApi.configure do |config|
+ config.access_token = 'YOUR_BEARER_TOKEN'
+ config.scheme = 'https'
+ config.host = 'HOST'
+end
-### Raise an issue
+api_instance = MintyApi::DefaultApi.new
+api_minty_application_id = 'api_minty_application_id_example' # String |
-To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/mintypage/ruby/issues).
+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
-### Vulnerability Reporting
+```
-Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://minty.page/whitehat) details the procedure for disclosing security issues.
+## Documentation for API Endpoints
----
+All URIs are relative to *http://localhost*
-<p align="center">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://cdn.minty.page/website/sdks/logos/minty_dark_mode.png" width="150">
- <source media="(prefers-color-scheme: light)" srcset="https://cdn.minty.page/website/sdks/logos/minty_light_mode.png" width="150">
- <img alt="Minty Logo" src="https://cdn.minty.page/website/sdks/logos/minty_light_mode.png" width="150">
- </picture>
-</p>
-<p align="center">
- Minty is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://minty.page/why-minty">Why Minty?</a>
-</p>
-<p align="center">
- This project is licensed under the MIT license. See the <a href="https://github.com/mintypage/ruby/blob/master/LICENSE"> LICENSE</a> file for more info.
-</p>
+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)