mx-platform-ruby 0.42.0 → 0.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/docs/MicrodepositRequest.md +30 -0
  4. data/docs/MicrodepositRequestBody.md +18 -0
  5. data/docs/MicrodepositResponse.md +44 -0
  6. data/docs/MicrodepositResponseBody.md +18 -0
  7. data/docs/MicrodepositVerifyRequest.md +20 -0
  8. data/docs/MicrodepositVerifyRequestBody.md +18 -0
  9. data/docs/MicrodepositsApi.md +371 -0
  10. data/docs/MicrodepositsResponseBody.md +20 -0
  11. data/docs/TransactionCreateRequest.md +40 -0
  12. data/docs/TransactionCreateRequestBody.md +18 -0
  13. data/docs/TransactionCreateResponseBody.md +104 -0
  14. data/docs/TransactionsApi.md +82 -0
  15. data/lib/mx-platform-ruby/api/microdeposits_api.rb +365 -0
  16. data/lib/mx-platform-ruby/api/transactions_api.rb +102 -0
  17. data/lib/mx-platform-ruby/models/microdeposit_request.rb +289 -0
  18. data/lib/mx-platform-ruby/models/microdeposit_request_body.rb +214 -0
  19. data/lib/mx-platform-ruby/models/microdeposit_response.rb +331 -0
  20. data/lib/mx-platform-ruby/models/microdeposit_response_body.rb +214 -0
  21. data/lib/mx-platform-ruby/models/microdeposit_verify_request.rb +223 -0
  22. data/lib/mx-platform-ruby/models/microdeposit_verify_request_body.rb +214 -0
  23. data/lib/mx-platform-ruby/models/microdeposits_response_body.rb +225 -0
  24. data/lib/mx-platform-ruby/models/transaction_create_request.rb +344 -0
  25. data/lib/mx-platform-ruby/models/transaction_create_request_body.rb +214 -0
  26. data/lib/mx-platform-ruby/models/transaction_create_response_body.rb +642 -0
  27. data/lib/mx-platform-ruby/version.rb +1 -1
  28. data/lib/mx-platform-ruby.rb +12 -0
  29. data/openapi/config.yml +1 -1
  30. data/spec/api/microdeposits_api_spec.rb +99 -0
  31. data/spec/api/transactions_api_spec.rb +49 -0
  32. data/spec/models/microdeposit_request_body_spec.rb +34 -0
  33. data/spec/models/microdeposit_request_spec.rb +70 -0
  34. data/spec/models/microdeposit_response_body_spec.rb +34 -0
  35. data/spec/models/microdeposit_response_spec.rb +112 -0
  36. data/spec/models/microdeposit_verify_request_body_spec.rb +34 -0
  37. data/spec/models/microdeposit_verify_request_spec.rb +40 -0
  38. data/spec/models/microdeposits_response_body_spec.rb +40 -0
  39. data/spec/models/transaction_create_request_body_spec.rb +34 -0
  40. data/spec/models/transaction_create_request_spec.rb +100 -0
  41. data/spec/models/transaction_create_response_body_spec.rb +292 -0
  42. metadata +195 -147
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f85514e3daf7cee10b17f3bca0033f66670691704407af1b247cc4b30b0e4948
4
- data.tar.gz: 74b5f33666e30034cbdeb216ffe4407ea84ff33b6bbc77ef4b05628875b7f45e
3
+ metadata.gz: d6d491beb90fe4ad7ec417211875561d41ff03c69766c045a390e236383bd334
4
+ data.tar.gz: bd7d0ec81f66bff90de8fe6c51ab058259df32d8299fee768939d061414f743e
5
5
  SHA512:
6
- metadata.gz: b6fbcc5dc89aaba68d8d90413bde084044aaec15cf9d6be04589dc67b3443a244773a6356676f96dd96d1f7fa56f92b32bc465d46a21bd9d6e74fcaf0a121791
7
- data.tar.gz: 9774608fc80fcfcff3d55efae4a66cc0af525737f3d46fb143c3ff86b340ba8ce66b5dfad78bf34ec436c1b17c234b5c8a79495b3ba0e7636c20067dd6556b92
6
+ metadata.gz: 18d92bc09d341be103eecce142737c04f4d1e8be1d2403f34c9951e4871679cfb48f48eb685c9b88e63b14cdb155d4911f7be9e9ff9acb81a16ec141e16cd4a2
7
+ data.tar.gz: daa4ed13c6148fc9a4376404bfd5a08e60dffb0d8b0df8ff65db9240c8f9cf05d9ff7fe5ac84e445b1c7c6f6a249965400f56bc212da53f14fcdc7318ba8e22e
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mx-platform-ruby (0.42.0)
4
+ mx-platform-ruby (0.43.0)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
7
 
@@ -44,7 +44,7 @@ GEM
44
44
  rspec-mocks (~> 3.13.0)
45
45
  rspec-core (3.13.1)
46
46
  rspec-support (~> 3.13.0)
47
- rspec-expectations (3.13.2)
47
+ rspec-expectations (3.13.3)
48
48
  diff-lcs (>= 1.2.0, < 2.0)
49
49
  rspec-support (~> 3.13.0)
50
50
  rspec-mocks (3.13.1)
@@ -0,0 +1,30 @@
1
+ # MxPlatformRuby::MicrodepositRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_number** | **String** | | |
8
+ | **account_type** | **String** | | |
9
+ | **routing_number** | **String** | | |
10
+ | **account_name** | **String** | | [optional] |
11
+ | **email** | **String** | | [optional] |
12
+ | **first_name** | **String** | | [optional] |
13
+ | **last_name** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mx-platform-ruby'
19
+
20
+ instance = MxPlatformRuby::MicrodepositRequest.new(
21
+ account_number: 3331261,
22
+ account_type: CHECKING,
23
+ routing_number: 091000019,
24
+ account_name: My test account,
25
+ email: joshyboy2@example.com,
26
+ first_name: Joshy,
27
+ last_name: Grobanne
28
+ )
29
+ ```
30
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MicrodepositRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **micro_deposit** | [**MicrodepositRequest**](MicrodepositRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MicrodepositRequestBody.new(
15
+ micro_deposit: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,44 @@
1
+ # MxPlatformRuby::MicrodepositResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_name** | **String** | | [optional] |
8
+ | **account_number** | **String** | | [optional] |
9
+ | **account_type** | **String** | | [optional] |
10
+ | **email** | **String** | | [optional] |
11
+ | **first_name** | **String** | | [optional] |
12
+ | **last_name** | **String** | | [optional] |
13
+ | **routing_number** | **String** | | [optional] |
14
+ | **error_message** | **String** | | [optional] |
15
+ | **guid** | **String** | | [optional] |
16
+ | **institution_code** | **String** | | [optional] |
17
+ | **institution_name** | **String** | | [optional] |
18
+ | **status** | **String** | | [optional] |
19
+ | **updated_at** | **String** | | [optional] |
20
+ | **verified_at** | **String** | | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'mx-platform-ruby'
26
+
27
+ instance = MxPlatformRuby::MicrodepositResponse.new(
28
+ account_name: My test account,
29
+ account_number: 3331261,
30
+ account_type: CHECKING,
31
+ email: joshyboy2@example.com,
32
+ first_name: Joshy,
33
+ last_name: Grobanne,
34
+ routing_number: 091000019,
35
+ error_message: null,
36
+ guid: MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb,
37
+ institution_code: mxbank,
38
+ institution_name: MX Bank,
39
+ status: INITIATED,
40
+ updated_at: 2023-06-01T19:18:06Z,
41
+ verified_at: null
42
+ )
43
+ ```
44
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MicrodepositResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **micro_deposit** | [**MicrodepositResponse**](MicrodepositResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MicrodepositResponseBody.new(
15
+ micro_deposit: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::MicrodepositVerifyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **deposit_amount_1** | **Integer** | | [optional] |
8
+ | **deposit_amount_2** | **Integer** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::MicrodepositVerifyRequest.new(
16
+ deposit_amount_1: null,
17
+ deposit_amount_2: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MicrodepositVerifyRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **micro_deposit** | [**MicrodepositVerifyRequest**](MicrodepositVerifyRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MicrodepositVerifyRequestBody.new(
15
+ micro_deposit: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,371 @@
1
+ # MxPlatformRuby::MicrodepositsApi
2
+
3
+ All URIs are relative to *https://api.mx.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**micro_deposits_microdeposit_guid_verify_put**](MicrodepositsApi.md#micro_deposits_microdeposit_guid_verify_put) | **PUT** /micro_deposits/{microdeposit_guid}/verify | Verify a Microdeposit |
8
+ | [**users_user_guid_micro_deposits_get**](MicrodepositsApi.md#users_user_guid_micro_deposits_get) | **GET** /users/{user_guid}/micro_deposits | List all microdeposits for a user |
9
+ | [**users_user_guid_micro_deposits_micro_deposit_guid_delete**](MicrodepositsApi.md#users_user_guid_micro_deposits_micro_deposit_guid_delete) | **DELETE** /users/{user_guid}/micro_deposits/{micro_deposit_guid} | Delete a microdeposit |
10
+ | [**users_user_guid_micro_deposits_micro_deposit_guid_get**](MicrodepositsApi.md#users_user_guid_micro_deposits_micro_deposit_guid_get) | **GET** /users/{user_guid}/micro_deposits/{micro_deposit_guid} | Read a microdeposit for a user |
11
+ | [**users_user_guid_micro_deposits_post**](MicrodepositsApi.md#users_user_guid_micro_deposits_post) | **POST** /users/{user_guid}/micro_deposits | Create a microdeposit |
12
+
13
+
14
+ ## micro_deposits_microdeposit_guid_verify_put
15
+
16
+ > <MicrodepositResponseBody> micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts)
17
+
18
+ Verify a Microdeposit
19
+
20
+ Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the `status` is `VERIFIED`. Poll the `/users/{user_guid}/micro_deposits/{micro_deposit_guid}` (read microdeposit) endpoint until you see this status or an error state.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'mx-platform-ruby'
27
+ # setup authorization
28
+ MxPlatformRuby.configure do |config|
29
+ # Configure HTTP basic authorization: basicAuth
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = MxPlatformRuby::MicrodepositsApi.new
35
+ microdeposit_guid = 'microdeposit_guid_example' # String | The unique identifier for the microdeposit. Defined by MX.
36
+ opts = {
37
+ microdeposit_verify_request_body: MxPlatformRuby::MicrodepositVerifyRequestBody.new # MicrodepositVerifyRequestBody |
38
+ }
39
+
40
+ begin
41
+ # Verify a Microdeposit
42
+ result = api_instance.micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts)
43
+ p result
44
+ rescue MxPlatformRuby::ApiError => e
45
+ puts "Error when calling MicrodepositsApi->micro_deposits_microdeposit_guid_verify_put: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the micro_deposits_microdeposit_guid_verify_put_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<MicrodepositResponseBody>, Integer, Hash)> micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts)
54
+
55
+ ```ruby
56
+ begin
57
+ # Verify a Microdeposit
58
+ data, status_code, headers = api_instance.micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <MicrodepositResponseBody>
62
+ rescue MxPlatformRuby::ApiError => e
63
+ puts "Error when calling MicrodepositsApi->micro_deposits_microdeposit_guid_verify_put_with_http_info: #{e}"
64
+ end
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **microdeposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. | |
72
+ | **microdeposit_verify_request_body** | [**MicrodepositVerifyRequestBody**](MicrodepositVerifyRequestBody.md) | | [optional] |
73
+
74
+ ### Return type
75
+
76
+ [**MicrodepositResponseBody**](MicrodepositResponseBody.md)
77
+
78
+ ### Authorization
79
+
80
+ [basicAuth](../README.md#basicAuth)
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: application/json
85
+ - **Accept**: application/json
86
+
87
+
88
+ ## users_user_guid_micro_deposits_get
89
+
90
+ > <MicrodepositsResponseBody> users_user_guid_micro_deposits_get(user_guid)
91
+
92
+ List all microdeposits for a user
93
+
94
+ Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.
95
+
96
+ ### Examples
97
+
98
+ ```ruby
99
+ require 'time'
100
+ require 'mx-platform-ruby'
101
+ # setup authorization
102
+ MxPlatformRuby.configure do |config|
103
+ # Configure HTTP basic authorization: basicAuth
104
+ config.username = 'YOUR USERNAME'
105
+ config.password = 'YOUR PASSWORD'
106
+ end
107
+
108
+ api_instance = MxPlatformRuby::MicrodepositsApi.new
109
+ user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
110
+
111
+ begin
112
+ # List all microdeposits for a user
113
+ result = api_instance.users_user_guid_micro_deposits_get(user_guid)
114
+ p result
115
+ rescue MxPlatformRuby::ApiError => e
116
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_get: #{e}"
117
+ end
118
+ ```
119
+
120
+ #### Using the users_user_guid_micro_deposits_get_with_http_info variant
121
+
122
+ This returns an Array which contains the response data, status code and headers.
123
+
124
+ > <Array(<MicrodepositsResponseBody>, Integer, Hash)> users_user_guid_micro_deposits_get_with_http_info(user_guid)
125
+
126
+ ```ruby
127
+ begin
128
+ # List all microdeposits for a user
129
+ data, status_code, headers = api_instance.users_user_guid_micro_deposits_get_with_http_info(user_guid)
130
+ p status_code # => 2xx
131
+ p headers # => { ... }
132
+ p data # => <MicrodepositsResponseBody>
133
+ rescue MxPlatformRuby::ApiError => e
134
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_get_with_http_info: #{e}"
135
+ end
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ | Name | Type | Description | Notes |
141
+ | ---- | ---- | ----------- | ----- |
142
+ | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
143
+
144
+ ### Return type
145
+
146
+ [**MicrodepositsResponseBody**](MicrodepositsResponseBody.md)
147
+
148
+ ### Authorization
149
+
150
+ [basicAuth](../README.md#basicAuth)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: application/json
156
+
157
+
158
+ ## users_user_guid_micro_deposits_micro_deposit_guid_delete
159
+
160
+ > users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid)
161
+
162
+ Delete a microdeposit
163
+
164
+ Use this endpoint to delete the specified microdeposit.
165
+
166
+ ### Examples
167
+
168
+ ```ruby
169
+ require 'time'
170
+ require 'mx-platform-ruby'
171
+ # setup authorization
172
+ MxPlatformRuby.configure do |config|
173
+ # Configure HTTP basic authorization: basicAuth
174
+ config.username = 'YOUR USERNAME'
175
+ config.password = 'YOUR PASSWORD'
176
+ end
177
+
178
+ api_instance = MxPlatformRuby::MicrodepositsApi.new
179
+ micro_deposit_guid = 'MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb' # String | The unique identifier for the microdeposit. Defined by MX.
180
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
181
+
182
+ begin
183
+ # Delete a microdeposit
184
+ api_instance.users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid)
185
+ rescue MxPlatformRuby::ApiError => e
186
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_delete: #{e}"
187
+ end
188
+ ```
189
+
190
+ #### Using the users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info variant
191
+
192
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
193
+
194
+ > <Array(nil, Integer, Hash)> users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid)
195
+
196
+ ```ruby
197
+ begin
198
+ # Delete a microdeposit
199
+ data, status_code, headers = api_instance.users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid)
200
+ p status_code # => 2xx
201
+ p headers # => { ... }
202
+ p data # => nil
203
+ rescue MxPlatformRuby::ApiError => e
204
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ | Name | Type | Description | Notes |
211
+ | ---- | ---- | ----------- | ----- |
212
+ | **micro_deposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. | |
213
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
214
+
215
+ ### Return type
216
+
217
+ nil (empty response body)
218
+
219
+ ### Authorization
220
+
221
+ [basicAuth](../README.md#basicAuth)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: Not defined
227
+
228
+
229
+ ## users_user_guid_micro_deposits_micro_deposit_guid_get
230
+
231
+ > <MicrodepositResponseBody> users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid)
232
+
233
+ Read a microdeposit for a user
234
+
235
+ Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
236
+
237
+ ### Examples
238
+
239
+ ```ruby
240
+ require 'time'
241
+ require 'mx-platform-ruby'
242
+ # setup authorization
243
+ MxPlatformRuby.configure do |config|
244
+ # Configure HTTP basic authorization: basicAuth
245
+ config.username = 'YOUR USERNAME'
246
+ config.password = 'YOUR PASSWORD'
247
+ end
248
+
249
+ api_instance = MxPlatformRuby::MicrodepositsApi.new
250
+ user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
251
+ micro_deposit_guid = 'micro_deposit_guid_example' # String | The unique identifier for the microdeposit. Defined by MX.
252
+
253
+ begin
254
+ # Read a microdeposit for a user
255
+ result = api_instance.users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid)
256
+ p result
257
+ rescue MxPlatformRuby::ApiError => e
258
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_get: #{e}"
259
+ end
260
+ ```
261
+
262
+ #### Using the users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info variant
263
+
264
+ This returns an Array which contains the response data, status code and headers.
265
+
266
+ > <Array(<MicrodepositResponseBody>, Integer, Hash)> users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid)
267
+
268
+ ```ruby
269
+ begin
270
+ # Read a microdeposit for a user
271
+ data, status_code, headers = api_instance.users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid)
272
+ p status_code # => 2xx
273
+ p headers # => { ... }
274
+ p data # => <MicrodepositResponseBody>
275
+ rescue MxPlatformRuby::ApiError => e
276
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info: #{e}"
277
+ end
278
+ ```
279
+
280
+ ### Parameters
281
+
282
+ | Name | Type | Description | Notes |
283
+ | ---- | ---- | ----------- | ----- |
284
+ | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
285
+ | **micro_deposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. | |
286
+
287
+ ### Return type
288
+
289
+ [**MicrodepositResponseBody**](MicrodepositResponseBody.md)
290
+
291
+ ### Authorization
292
+
293
+ [basicAuth](../README.md#basicAuth)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: Not defined
298
+ - **Accept**: application/json
299
+
300
+
301
+ ## users_user_guid_micro_deposits_post
302
+
303
+ > <MicrodepositResponseBody> users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body)
304
+
305
+ Create a microdeposit
306
+
307
+ Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED.
308
+
309
+ ### Examples
310
+
311
+ ```ruby
312
+ require 'time'
313
+ require 'mx-platform-ruby'
314
+ # setup authorization
315
+ MxPlatformRuby.configure do |config|
316
+ # Configure HTTP basic authorization: basicAuth
317
+ config.username = 'YOUR USERNAME'
318
+ config.password = 'YOUR PASSWORD'
319
+ end
320
+
321
+ api_instance = MxPlatformRuby::MicrodepositsApi.new
322
+ user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
323
+ microdeposit_request_body = MxPlatformRuby::MicrodepositRequestBody.new # MicrodepositRequestBody |
324
+
325
+ begin
326
+ # Create a microdeposit
327
+ result = api_instance.users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body)
328
+ p result
329
+ rescue MxPlatformRuby::ApiError => e
330
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_post: #{e}"
331
+ end
332
+ ```
333
+
334
+ #### Using the users_user_guid_micro_deposits_post_with_http_info variant
335
+
336
+ This returns an Array which contains the response data, status code and headers.
337
+
338
+ > <Array(<MicrodepositResponseBody>, Integer, Hash)> users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body)
339
+
340
+ ```ruby
341
+ begin
342
+ # Create a microdeposit
343
+ data, status_code, headers = api_instance.users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body)
344
+ p status_code # => 2xx
345
+ p headers # => { ... }
346
+ p data # => <MicrodepositResponseBody>
347
+ rescue MxPlatformRuby::ApiError => e
348
+ puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_post_with_http_info: #{e}"
349
+ end
350
+ ```
351
+
352
+ ### Parameters
353
+
354
+ | Name | Type | Description | Notes |
355
+ | ---- | ---- | ----------- | ----- |
356
+ | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
357
+ | **microdeposit_request_body** | [**MicrodepositRequestBody**](MicrodepositRequestBody.md) | | |
358
+
359
+ ### Return type
360
+
361
+ [**MicrodepositResponseBody**](MicrodepositResponseBody.md)
362
+
363
+ ### Authorization
364
+
365
+ [basicAuth](../README.md#basicAuth)
366
+
367
+ ### HTTP request headers
368
+
369
+ - **Content-Type**: application/json
370
+ - **Accept**: application/json
371
+
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::MicrodepositsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **micro_deposits** | [**Array&lt;MicrodepositResponse&gt;**](MicrodepositResponse.md) | | [optional] |
8
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::MicrodepositsResponseBody.new(
16
+ micro_deposits: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,40 @@
1
+ # MxPlatformRuby::TransactionCreateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Float** | | |
8
+ | **date** | **String** | | |
9
+ | **description** | **String** | | |
10
+ | **type** | **String** | The type of transaction, which must be CREDIT or DEBIT. See Transaction Fields for more information. | |
11
+ | **category_guid** | **String** | Unique identifier of the category. | [optional] |
12
+ | **currency_code** | **String** | | [optional] |
13
+ | **has_been_viewed** | **Boolean** | | [optional] |
14
+ | **is_hidden** | **Boolean** | | [optional] |
15
+ | **is_international** | **Boolean** | | [optional] |
16
+ | **memo** | **String** | | [optional] |
17
+ | **metadata** | **String** | | [optional] |
18
+ | **skip_webhook** | **Boolean** | When set to true, this parameter will prevent a webhook from being triggered by the request. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'mx-platform-ruby'
24
+
25
+ instance = MxPlatformRuby::TransactionCreateRequest.new(
26
+ amount: 61.11,
27
+ date: 2016-10-06,
28
+ description: Whole foods,
29
+ type: DEBIT,
30
+ category_guid: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e,
31
+ currency_code: USD,
32
+ has_been_viewed: false,
33
+ is_hidden: false,
34
+ is_international: false,
35
+ memo: This is a memo,
36
+ metadata: some metadata,
37
+ skip_webhook: true
38
+ )
39
+ ```
40
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::TransactionCreateRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transaction** | [**TransactionCreateRequest**](TransactionCreateRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::TransactionCreateRequestBody.new(
15
+ transaction: null
16
+ )
17
+ ```
18
+