mx-platform-ruby 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +29 -222
  4. data/lib/mx-platform-ruby/version.rb +1 -1
  5. data/openapi/config.yml +1 -1
  6. data/openapi/templates/README.mustache +71 -0
  7. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d3bb689083b67b189f4495d6898f258fb438766ca06d8ba3337f28f883f9e2c4
4
- data.tar.gz: 1ec5f3bd173749315e20783a4ea492a9e97b7f2a6b179e31c2f561ede895af57
3
+ metadata.gz: 64460d2b4b070e0c3d41f9dff8dd69fba06150c2e7bc66fde266832a9f8effc4
4
+ data.tar.gz: c0f1a9c7e311872a5de6847ae9f7a5df4556f9c08d530140199430a78162c79d
5
5
  SHA512:
6
- metadata.gz: 772e97ebda9f165bc7d617a15fdaeb5cea634f81982a8de4c128394731349d4f3b57f21380e257914bab1df9e00354a32f8c89bc75b81ef6c310db3e8c1e5fa6
7
- data.tar.gz: 4f3970884a35157b87cc33efe10484a12c6723cdda6ce0757ae80e65242a391915683ac19b2192b63e0f2501dcf7ab570622a27f3b110bcad50a2c84d22e8f38
6
+ metadata.gz: 6f48ba947a2508e1ec27e17d2ec6e6f4b54f98ff3d8e8dae5dcacbe884f39e1e75ccb237ee4affaa0d817bd56a9d155986bc85cf921bd8dff501a606cce27990
7
+ data.tar.gz: c0ceae565cdf60de52dfd679395ff29e793b79be5366d5c03b2f36529a2616e3c25b4263eddf6f912ee82e861ca6f392d39102c1fe66e74963539f530acefdc2
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mx-platform-ruby (0.3.1)
4
+ mx-platform-ruby (0.3.2)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ *This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform API Ruby Library.*
2
+
1
3
  # mx-platform-ruby
2
4
 
3
5
  MxPlatformRuby - the Ruby gem for the MX Platform API
@@ -6,257 +8,62 @@ The MX Platform API is a powerful, fully-featured API designed to make aggregati
6
8
 
7
9
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
10
 
9
- - API version: 0.1.0
10
- - Package version: 0.3.1
11
- - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
- For more information, please visit [https://www.mx.com/products/platform-api](https://www.mx.com/products/platform-api)
11
+ - Package version: 0.3.2
13
12
 
14
13
  ## Installation
15
14
 
16
- ### Build a gem
17
-
18
- To build the Ruby code into a gem:
15
+ Add this line to your application's Gemfile:
19
16
 
20
- ```shell
21
- gem build mx-platform-ruby.gemspec
17
+ ```ruby
18
+ gem 'mx-platform-ruby'
22
19
  ```
23
20
 
24
- Then either install the gem locally:
25
-
21
+ And then execute:
26
22
  ```shell
27
- gem install ./mx-platform-ruby-0.3.1.gem
23
+ $ bundle
28
24
  ```
29
25
 
30
- (for development, run `gem install --dev ./mx-platform-ruby-0.3.1.gem` to install the development dependencies)
31
-
32
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
-
34
- Finally add this to the Gemfile:
35
-
36
- gem 'mx-platform-ruby', '~> 0.3.1'
37
-
38
- ### Install from Git
39
-
40
- 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:
41
-
42
- gem 'mx-platform-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
43
-
44
- ### Include the Ruby code directly
45
-
46
- Include the Ruby code directly using `-I` as follows:
47
-
26
+ Or install it yourself with:
48
27
  ```shell
49
- ruby -Ilib script.rb
28
+ $ gem install mx-platform-ruby
50
29
  ```
51
30
 
52
31
  ## Getting Started
53
32
 
33
+ In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
34
+
54
35
  Please follow the [installation](#installation) procedure and then run the following code:
55
36
 
56
37
  ```ruby
57
38
  # Load the gem
58
39
  require 'mx-platform-ruby'
59
40
 
60
- # Setup authorization
41
+ # setup authorization
61
42
  MxPlatformRuby.configure do |config|
62
- # Configure HTTP basic authorization: basicAuth
63
- config.username = 'YOUR_USERNAME'
64
- config.password = 'YOUR_PASSWORD'
43
+ # Configure HTTP basic authorization
44
+ config.username = 'Your Client ID from https://dashboard.mx.com'
45
+ config.password = 'Your API Key from https://dashboard.mx.com'
46
+
47
+ # Configure server. 0 for production, 1 for development
48
+ config.server_index = 1
65
49
  end
66
50
 
67
51
  api_instance = MxPlatformRuby::MxPlatformApi.new
68
- member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
69
- user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
52
+ user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
53
+ user: MxPlatformRuby::UserCreateRequest.new(
54
+ metadata: "Creating a user!"
55
+ )
56
+ )
70
57
 
71
58
  begin
72
- #Aggregate member
73
- result = api_instance.aggregate_member(member_guid, user_guid)
59
+ # Create user
60
+ result = api_instance.create_user(user_create_request_body)
74
61
  p result
75
62
  rescue MxPlatformRuby::ApiError => e
76
- puts "Exception when calling MxPlatformApi->aggregate_member: #{e}"
63
+ puts "Error when calling MxPlatformApi->create_user: #{e}"
77
64
  end
78
-
79
65
  ```
80
66
 
81
- ## Documentation for API Endpoints
82
-
83
- All URIs are relative to *https://api.mx.com*
84
-
85
- Class | Method | HTTP request | Description
86
- ------------ | ------------- | ------------- | -------------
87
- *MxPlatformRuby::MxPlatformApi* | [**aggregate_member**](docs/MxPlatformApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
88
- *MxPlatformRuby::MxPlatformApi* | [**check_balances**](docs/MxPlatformApi.md#check_balances) | **POST** /users/{user_guid}/members/{member_guid}/check_balance | Check balances
89
- *MxPlatformRuby::MxPlatformApi* | [**create_category**](docs/MxPlatformApi.md#create_category) | **POST** /users/{user_guid}/categories | Create category
90
- *MxPlatformRuby::MxPlatformApi* | [**create_member**](docs/MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
91
- *MxPlatformRuby::MxPlatformApi* | [**create_tag**](docs/MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag
92
- *MxPlatformRuby::MxPlatformApi* | [**create_tagging**](docs/MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging
93
- *MxPlatformRuby::MxPlatformApi* | [**create_transaction_rule**](docs/MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule
94
- *MxPlatformRuby::MxPlatformApi* | [**create_user**](docs/MxPlatformApi.md#create_user) | **POST** /users | Create user
95
- *MxPlatformRuby::MxPlatformApi* | [**delete_category**](docs/MxPlatformApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category
96
- *MxPlatformRuby::MxPlatformApi* | [**delete_member**](docs/MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
97
- *MxPlatformRuby::MxPlatformApi* | [**delete_tag**](docs/MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag
98
- *MxPlatformRuby::MxPlatformApi* | [**delete_tagging**](docs/MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging
99
- *MxPlatformRuby::MxPlatformApi* | [**delete_transaction_rule**](docs/MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule
100
- *MxPlatformRuby::MxPlatformApi* | [**delete_user**](docs/MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user
101
- *MxPlatformRuby::MxPlatformApi* | [**download_statement_pdf**](docs/MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf
102
- *MxPlatformRuby::MxPlatformApi* | [**enhance_transactions**](docs/MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions
103
- *MxPlatformRuby::MxPlatformApi* | [**extend_history**](docs/MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
104
- *MxPlatformRuby::MxPlatformApi* | [**fetch_statements**](docs/MxPlatformApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
105
- *MxPlatformRuby::MxPlatformApi* | [**identify_member**](docs/MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member
106
- *MxPlatformRuby::MxPlatformApi* | [**list_account_numbers_by_account**](docs/MxPlatformApi.md#list_account_numbers_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account
107
- *MxPlatformRuby::MxPlatformApi* | [**list_account_numbers_by_member**](docs/MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member
108
- *MxPlatformRuby::MxPlatformApi* | [**list_account_owners_by_member**](docs/MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member
109
- *MxPlatformRuby::MxPlatformApi* | [**list_categories**](docs/MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories
110
- *MxPlatformRuby::MxPlatformApi* | [**list_default_categories**](docs/MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories
111
- *MxPlatformRuby::MxPlatformApi* | [**list_favorite_institutions**](docs/MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions
112
- *MxPlatformRuby::MxPlatformApi* | [**list_holdings**](docs/MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings
113
- *MxPlatformRuby::MxPlatformApi* | [**list_holdings_by_member**](docs/MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member
114
- *MxPlatformRuby::MxPlatformApi* | [**list_institution_credentials**](docs/MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials
115
- *MxPlatformRuby::MxPlatformApi* | [**list_institutions**](docs/MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions
116
- *MxPlatformRuby::MxPlatformApi* | [**list_member_challenges**](docs/MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges
117
- *MxPlatformRuby::MxPlatformApi* | [**list_member_credentials**](docs/MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials
118
- *MxPlatformRuby::MxPlatformApi* | [**list_members**](docs/MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members
119
- *MxPlatformRuby::MxPlatformApi* | [**list_merchants**](docs/MxPlatformApi.md#list_merchants) | **GET** /merchants | List merchants
120
- *MxPlatformRuby::MxPlatformApi* | [**list_statements_by_member**](docs/MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member
121
- *MxPlatformRuby::MxPlatformApi* | [**list_taggings**](docs/MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings
122
- *MxPlatformRuby::MxPlatformApi* | [**list_tags**](docs/MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags
123
- *MxPlatformRuby::MxPlatformApi* | [**list_transaction_rules**](docs/MxPlatformApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules
124
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions**](docs/MxPlatformApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions
125
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions_by_account**](docs/MxPlatformApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account
126
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions_by_member**](docs/MxPlatformApi.md#list_transactions_by_member) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List transactions by member
127
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions_by_tag**](docs/MxPlatformApi.md#list_transactions_by_tag) | **GET** /users/{user_guid}/tags/{tag_guid}/transactions | List transactions by tag
128
- *MxPlatformRuby::MxPlatformApi* | [**list_user_accounts**](docs/MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts
129
- *MxPlatformRuby::MxPlatformApi* | [**list_users**](docs/MxPlatformApi.md#list_users) | **GET** /users | List users
130
- *MxPlatformRuby::MxPlatformApi* | [**read_account**](docs/MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account
131
- *MxPlatformRuby::MxPlatformApi* | [**read_category**](docs/MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category
132
- *MxPlatformRuby::MxPlatformApi* | [**read_holding**](docs/MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding
133
- *MxPlatformRuby::MxPlatformApi* | [**read_institution**](docs/MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
134
- *MxPlatformRuby::MxPlatformApi* | [**read_member**](docs/MxPlatformApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
135
- *MxPlatformRuby::MxPlatformApi* | [**read_member_status**](docs/MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status
136
- *MxPlatformRuby::MxPlatformApi* | [**read_merchant**](docs/MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
137
- *MxPlatformRuby::MxPlatformApi* | [**read_statement_by_member**](docs/MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member
138
- *MxPlatformRuby::MxPlatformApi* | [**read_tag**](docs/MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag
139
- *MxPlatformRuby::MxPlatformApi* | [**read_tagging**](docs/MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging
140
- *MxPlatformRuby::MxPlatformApi* | [**read_transaction**](docs/MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction
141
- *MxPlatformRuby::MxPlatformApi* | [**read_transaction_rule**](docs/MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule
142
- *MxPlatformRuby::MxPlatformApi* | [**read_user**](docs/MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user
143
- *MxPlatformRuby::MxPlatformApi* | [**request_connect_widget_url**](docs/MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url
144
- *MxPlatformRuby::MxPlatformApi* | [**request_o_auth_window_uri**](docs/MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri
145
- *MxPlatformRuby::MxPlatformApi* | [**request_widget_url**](docs/MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url
146
- *MxPlatformRuby::MxPlatformApi* | [**resume_aggregation**](docs/MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation
147
- *MxPlatformRuby::MxPlatformApi* | [**update_account_by_member**](docs/MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member
148
- *MxPlatformRuby::MxPlatformApi* | [**update_category**](docs/MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category
149
- *MxPlatformRuby::MxPlatformApi* | [**update_member**](docs/MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
150
- *MxPlatformRuby::MxPlatformApi* | [**update_tag**](docs/MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag
151
- *MxPlatformRuby::MxPlatformApi* | [**update_tagging**](docs/MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging
152
- *MxPlatformRuby::MxPlatformApi* | [**update_transaction**](docs/MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction
153
- *MxPlatformRuby::MxPlatformApi* | [**update_transaction_rule**](docs/MxPlatformApi.md#update_transaction_rule) | **PUT** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Update transaction_rule
154
- *MxPlatformRuby::MxPlatformApi* | [**update_user**](docs/MxPlatformApi.md#update_user) | **PUT** /users/{user_guid} | Update user
155
- *MxPlatformRuby::MxPlatformApi* | [**verify_member**](docs/MxPlatformApi.md#verify_member) | **POST** /users/{user_guid}/members/{member_guid}/verify | Verify member
156
-
157
-
158
- ## Documentation for Models
159
-
160
- - [MxPlatformRuby::AccountNumberResponse](docs/AccountNumberResponse.md)
161
- - [MxPlatformRuby::AccountNumbersResponseBody](docs/AccountNumbersResponseBody.md)
162
- - [MxPlatformRuby::AccountOwnerResponse](docs/AccountOwnerResponse.md)
163
- - [MxPlatformRuby::AccountOwnersResponseBody](docs/AccountOwnersResponseBody.md)
164
- - [MxPlatformRuby::AccountResponse](docs/AccountResponse.md)
165
- - [MxPlatformRuby::AccountResponseBody](docs/AccountResponseBody.md)
166
- - [MxPlatformRuby::AccountUpdateRequest](docs/AccountUpdateRequest.md)
167
- - [MxPlatformRuby::AccountUpdateRequestBody](docs/AccountUpdateRequestBody.md)
168
- - [MxPlatformRuby::AccountsResponseBody](docs/AccountsResponseBody.md)
169
- - [MxPlatformRuby::CategoriesResponseBody](docs/CategoriesResponseBody.md)
170
- - [MxPlatformRuby::CategoryCreateRequest](docs/CategoryCreateRequest.md)
171
- - [MxPlatformRuby::CategoryCreateRequestBody](docs/CategoryCreateRequestBody.md)
172
- - [MxPlatformRuby::CategoryResponse](docs/CategoryResponse.md)
173
- - [MxPlatformRuby::CategoryResponseBody](docs/CategoryResponseBody.md)
174
- - [MxPlatformRuby::CategoryUpdateRequest](docs/CategoryUpdateRequest.md)
175
- - [MxPlatformRuby::CategoryUpdateRequestBody](docs/CategoryUpdateRequestBody.md)
176
- - [MxPlatformRuby::ChallengeResponse](docs/ChallengeResponse.md)
177
- - [MxPlatformRuby::ChallengeResponseImageOptions](docs/ChallengeResponseImageOptions.md)
178
- - [MxPlatformRuby::ChallengeResponseOptions](docs/ChallengeResponseOptions.md)
179
- - [MxPlatformRuby::ChallengesResponseBody](docs/ChallengesResponseBody.md)
180
- - [MxPlatformRuby::ConnectWidgetRequest](docs/ConnectWidgetRequest.md)
181
- - [MxPlatformRuby::ConnectWidgetRequestBody](docs/ConnectWidgetRequestBody.md)
182
- - [MxPlatformRuby::ConnectWidgetResponse](docs/ConnectWidgetResponse.md)
183
- - [MxPlatformRuby::ConnectWidgetResponseBody](docs/ConnectWidgetResponseBody.md)
184
- - [MxPlatformRuby::CredentialRequest](docs/CredentialRequest.md)
185
- - [MxPlatformRuby::CredentialResponse](docs/CredentialResponse.md)
186
- - [MxPlatformRuby::CredentialsResponseBody](docs/CredentialsResponseBody.md)
187
- - [MxPlatformRuby::EnhanceTransactionResponse](docs/EnhanceTransactionResponse.md)
188
- - [MxPlatformRuby::EnhanceTransactionsRequest](docs/EnhanceTransactionsRequest.md)
189
- - [MxPlatformRuby::EnhanceTransactionsRequestBody](docs/EnhanceTransactionsRequestBody.md)
190
- - [MxPlatformRuby::EnhanceTransactionsResponseBody](docs/EnhanceTransactionsResponseBody.md)
191
- - [MxPlatformRuby::HoldingResponse](docs/HoldingResponse.md)
192
- - [MxPlatformRuby::HoldingResponseBody](docs/HoldingResponseBody.md)
193
- - [MxPlatformRuby::HoldingsResponseBody](docs/HoldingsResponseBody.md)
194
- - [MxPlatformRuby::InstitutionResponse](docs/InstitutionResponse.md)
195
- - [MxPlatformRuby::InstitutionResponseBody](docs/InstitutionResponseBody.md)
196
- - [MxPlatformRuby::InstitutionsResponseBody](docs/InstitutionsResponseBody.md)
197
- - [MxPlatformRuby::MemberCreateRequest](docs/MemberCreateRequest.md)
198
- - [MxPlatformRuby::MemberCreateRequestBody](docs/MemberCreateRequestBody.md)
199
- - [MxPlatformRuby::MemberResponse](docs/MemberResponse.md)
200
- - [MxPlatformRuby::MemberResponseBody](docs/MemberResponseBody.md)
201
- - [MxPlatformRuby::MemberResumeRequest](docs/MemberResumeRequest.md)
202
- - [MxPlatformRuby::MemberResumeRequestBody](docs/MemberResumeRequestBody.md)
203
- - [MxPlatformRuby::MemberStatusResponse](docs/MemberStatusResponse.md)
204
- - [MxPlatformRuby::MemberStatusResponseBody](docs/MemberStatusResponseBody.md)
205
- - [MxPlatformRuby::MemberUpdateRequest](docs/MemberUpdateRequest.md)
206
- - [MxPlatformRuby::MemberUpdateRequestBody](docs/MemberUpdateRequestBody.md)
207
- - [MxPlatformRuby::MembersResponseBody](docs/MembersResponseBody.md)
208
- - [MxPlatformRuby::MerchantResponse](docs/MerchantResponse.md)
209
- - [MxPlatformRuby::MerchantResponseBody](docs/MerchantResponseBody.md)
210
- - [MxPlatformRuby::MerchantsResponseBody](docs/MerchantsResponseBody.md)
211
- - [MxPlatformRuby::OAuthWindowResponse](docs/OAuthWindowResponse.md)
212
- - [MxPlatformRuby::OAuthWindowResponseBody](docs/OAuthWindowResponseBody.md)
213
- - [MxPlatformRuby::PaginationResponse](docs/PaginationResponse.md)
214
- - [MxPlatformRuby::StatementResponse](docs/StatementResponse.md)
215
- - [MxPlatformRuby::StatementResponseBody](docs/StatementResponseBody.md)
216
- - [MxPlatformRuby::StatementsResponseBody](docs/StatementsResponseBody.md)
217
- - [MxPlatformRuby::TagCreateRequest](docs/TagCreateRequest.md)
218
- - [MxPlatformRuby::TagCreateRequestBody](docs/TagCreateRequestBody.md)
219
- - [MxPlatformRuby::TagResponse](docs/TagResponse.md)
220
- - [MxPlatformRuby::TagResponseBody](docs/TagResponseBody.md)
221
- - [MxPlatformRuby::TagUpdateRequest](docs/TagUpdateRequest.md)
222
- - [MxPlatformRuby::TagUpdateRequestBody](docs/TagUpdateRequestBody.md)
223
- - [MxPlatformRuby::TaggingCreateRequest](docs/TaggingCreateRequest.md)
224
- - [MxPlatformRuby::TaggingCreateRequestBody](docs/TaggingCreateRequestBody.md)
225
- - [MxPlatformRuby::TaggingResponse](docs/TaggingResponse.md)
226
- - [MxPlatformRuby::TaggingResponseBody](docs/TaggingResponseBody.md)
227
- - [MxPlatformRuby::TaggingUpdateRequest](docs/TaggingUpdateRequest.md)
228
- - [MxPlatformRuby::TaggingUpdateRequestBody](docs/TaggingUpdateRequestBody.md)
229
- - [MxPlatformRuby::TaggingsResponseBody](docs/TaggingsResponseBody.md)
230
- - [MxPlatformRuby::TagsResponseBody](docs/TagsResponseBody.md)
231
- - [MxPlatformRuby::TransactionResponse](docs/TransactionResponse.md)
232
- - [MxPlatformRuby::TransactionResponseBody](docs/TransactionResponseBody.md)
233
- - [MxPlatformRuby::TransactionRuleCreateRequest](docs/TransactionRuleCreateRequest.md)
234
- - [MxPlatformRuby::TransactionRuleCreateRequestBody](docs/TransactionRuleCreateRequestBody.md)
235
- - [MxPlatformRuby::TransactionRuleResponse](docs/TransactionRuleResponse.md)
236
- - [MxPlatformRuby::TransactionRuleResponseBody](docs/TransactionRuleResponseBody.md)
237
- - [MxPlatformRuby::TransactionRuleUpdateRequest](docs/TransactionRuleUpdateRequest.md)
238
- - [MxPlatformRuby::TransactionRuleUpdateRequestBody](docs/TransactionRuleUpdateRequestBody.md)
239
- - [MxPlatformRuby::TransactionRulesResponseBody](docs/TransactionRulesResponseBody.md)
240
- - [MxPlatformRuby::TransactionUpdateRequest](docs/TransactionUpdateRequest.md)
241
- - [MxPlatformRuby::TransactionUpdateRequestBody](docs/TransactionUpdateRequestBody.md)
242
- - [MxPlatformRuby::TransactionsResponseBody](docs/TransactionsResponseBody.md)
243
- - [MxPlatformRuby::UserCreateRequest](docs/UserCreateRequest.md)
244
- - [MxPlatformRuby::UserCreateRequestBody](docs/UserCreateRequestBody.md)
245
- - [MxPlatformRuby::UserResponse](docs/UserResponse.md)
246
- - [MxPlatformRuby::UserResponseBody](docs/UserResponseBody.md)
247
- - [MxPlatformRuby::UserUpdateRequest](docs/UserUpdateRequest.md)
248
- - [MxPlatformRuby::UserUpdateRequestBody](docs/UserUpdateRequestBody.md)
249
- - [MxPlatformRuby::UsersResponseBody](docs/UsersResponseBody.md)
250
- - [MxPlatformRuby::WidgetRequest](docs/WidgetRequest.md)
251
- - [MxPlatformRuby::WidgetRequestBody](docs/WidgetRequestBody.md)
252
- - [MxPlatformRuby::WidgetResponse](docs/WidgetResponse.md)
253
- - [MxPlatformRuby::WidgetResponseBody](docs/WidgetResponseBody.md)
254
-
255
-
256
- ## Documentation for Authorization
257
-
258
-
259
- ### basicAuth
260
-
261
- - **Type**: HTTP basic authentication
67
+ ## Documentation
262
68
 
69
+ Additional examples for the API endpoints can be found [here](docs/MxPlatformApi.md).
data/lib/mx-platform-ruby/version.rb CHANGED
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.0
11
11
  =end
12
12
 
13
13
  module MxPlatformRuby
14
- VERSION = '0.3.1'
14
+ VERSION = '0.3.2'
15
15
  end
data/openapi/config.yml CHANGED
@@ -6,6 +6,6 @@ gemHomepage: "https://github.com/mxenabled/mx-platform-ruby"
6
6
  gemLicense: "MIT"
7
7
  gemName: "mx-platform-ruby"
8
8
  gemRequiredRubyVersion: ">= 2.6"
9
- gemVersion: "0.3.1"
9
+ gemVersion: "0.3.2"
10
10
  library: "faraday"
11
11
  moduleName: "MxPlatformRuby"
data/openapi/templates/README.mustache ADDED
@@ -0,0 +1,71 @@
1
+ *This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform API Ruby Library.*
2
+
3
+ # {{gemName}}
4
+
5
+ {{moduleName}} - the Ruby gem for the {{appName}}
6
+
7
+ {{#appDescriptionWithNewLines}}
8
+ {{{.}}}
9
+ {{/appDescriptionWithNewLines}}
10
+
11
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
12
+
13
+ - Package version: {{gemVersion}}
14
+
15
+ ## Installation
16
+
17
+ Add this line to your application's Gemfile:
18
+
19
+ ```ruby
20
+ gem 'mx-platform-ruby'
21
+ ```
22
+
23
+ And then execute:
24
+ ```shell
25
+ $ bundle
26
+ ```
27
+
28
+ Or install it yourself with:
29
+ ```shell
30
+ $ gem install mx-platform-ruby
31
+ ```
32
+
33
+ ## Getting Started
34
+
35
+ In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
36
+
37
+ Please follow the [installation](#installation) procedure and then run the following code:
38
+
39
+ ```ruby
40
+ # Load the gem
41
+ require 'mx-platform-ruby'
42
+
43
+ # setup authorization
44
+ MxPlatformRuby.configure do |config|
45
+ # Configure HTTP basic authorization
46
+ config.username = 'Your Client ID from https://dashboard.mx.com'
47
+ config.password = 'Your API Key from https://dashboard.mx.com'
48
+
49
+ # Configure server. 0 for production, 1 for development
50
+ config.server_index = 1
51
+ end
52
+
53
+ api_instance = MxPlatformRuby::MxPlatformApi.new
54
+ user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
55
+ user: MxPlatformRuby::UserCreateRequest.new(
56
+ metadata: "Creating a user!"
57
+ )
58
+ )
59
+
60
+ begin
61
+ # Create user
62
+ result = api_instance.create_user(user_create_request_body)
63
+ p result
64
+ rescue MxPlatformRuby::ApiError => e
65
+ puts "Error when calling MxPlatformApi->create_user: #{e}"
66
+ end
67
+ ```
68
+
69
+ ## Documentation
70
+
71
+ Additional examples for the API endpoints can be found [here](docs/MxPlatformApi.md).
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mx-platform-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - MX
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-08-20 00:00:00.000000000 Z
11
+ date: 2021-08-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -259,6 +259,7 @@ files:
259
259
  - lib/mx-platform-ruby/version.rb
260
260
  - mx-platform-ruby.gemspec
261
261
  - openapi/config.yml
262
+ - openapi/templates/README.mustache
262
263
  - spec/api/mx_platform_api_spec.rb
263
264
  - spec/api_client_spec.rb
264
265
  - spec/configuration_spec.rb