mx-platform-ruby 0.5.0 → 0.6.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +1 -1
- data/docs/MxPlatformApi.md +28 -8
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +24 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +8 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e0dfe5713f1eadf232d11dc0fb56b6a700681c3dd3662ee9d4a28c0ad73cfd0
|
4
|
+
data.tar.gz: 6c0a0d3eba0d715203029ad3785c2c2d49d3c365bad34182f2f2ac7bcbb57047
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: caec6217ce34a5f03e4d52e670d18ae5df116ae3bba0c57cd13d8b9af5507d8660cceb8a6168fbe565e9303803ce5d3c98061a33f8f2f4f92b8e9756d455eb10
|
7
|
+
data.tar.gz: a4ba09563cc67f49cd50c41728dcc499d1a5e4c5a441190a4e9f1aaf637d7b5466a14274a647e56703ba6160a027bece08afcb374019c43f0b5d74769c7f0b1d
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -8,7 +8,7 @@ The MX Platform API is a powerful, fully-featured API designed to make aggregati
|
|
8
8
|
|
9
9
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
10
10
|
|
11
|
-
- Package version: 0.
|
11
|
+
- Package version: 0.6.0
|
12
12
|
|
13
13
|
## Installation
|
14
14
|
|
data/docs/MxPlatformApi.md
CHANGED
@@ -2199,7 +2199,7 @@ end
|
|
2199
2199
|
|
2200
2200
|
## list_default_categories
|
2201
2201
|
|
2202
|
-
> <CategoriesResponseBody> list_default_categories(user_guid)
|
2202
|
+
> <CategoriesResponseBody> list_default_categories(user_guid, opts)
|
2203
2203
|
|
2204
2204
|
List default categories
|
2205
2205
|
|
@@ -2219,10 +2219,14 @@ end
|
|
2219
2219
|
|
2220
2220
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2221
2221
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2222
|
+
opts = {
|
2223
|
+
page: 1, # Integer | Specify current page.
|
2224
|
+
records_per_page: 10 # Integer | Specify records per page.
|
2225
|
+
}
|
2222
2226
|
|
2223
2227
|
begin
|
2224
2228
|
# List default categories
|
2225
|
-
result = api_instance.list_default_categories(user_guid)
|
2229
|
+
result = api_instance.list_default_categories(user_guid, opts)
|
2226
2230
|
p result
|
2227
2231
|
rescue MxPlatformRuby::ApiError => e
|
2228
2232
|
puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
|
@@ -2233,12 +2237,12 @@ end
|
|
2233
2237
|
|
2234
2238
|
This returns an Array which contains the response data, status code and headers.
|
2235
2239
|
|
2236
|
-
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid)
|
2240
|
+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
|
2237
2241
|
|
2238
2242
|
```ruby
|
2239
2243
|
begin
|
2240
2244
|
# List default categories
|
2241
|
-
data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid)
|
2245
|
+
data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
|
2242
2246
|
p status_code # => 2xx
|
2243
2247
|
p headers # => { ... }
|
2244
2248
|
p data # => <CategoriesResponseBody>
|
@@ -2252,6 +2256,8 @@ end
|
|
2252
2256
|
| Name | Type | Description | Notes |
|
2253
2257
|
| ---- | ---- | ----------- | ----- |
|
2254
2258
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
2259
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
2260
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
2255
2261
|
|
2256
2262
|
### Return type
|
2257
2263
|
|
@@ -2602,6 +2608,8 @@ end
|
|
2602
2608
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2603
2609
|
opts = {
|
2604
2610
|
name: 'chase', # String | This will list only institutions in which the appended string appears.
|
2611
|
+
page: 1, # Integer | Specify current page.
|
2612
|
+
records_per_page: 10, # Integer | Specify records per page.
|
2605
2613
|
supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
|
2606
2614
|
supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
|
2607
2615
|
supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
|
@@ -2640,6 +2648,8 @@ end
|
|
2640
2648
|
| Name | Type | Description | Notes |
|
2641
2649
|
| ---- | ---- | ----------- | ----- |
|
2642
2650
|
| **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
|
2651
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
2652
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
2643
2653
|
| **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
|
2644
2654
|
| **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
|
2645
2655
|
| **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
|
@@ -3823,7 +3833,7 @@ end
|
|
3823
3833
|
|
3824
3834
|
## list_transactions_by_tag
|
3825
3835
|
|
3826
|
-
> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid)
|
3836
|
+
> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid, opts)
|
3827
3837
|
|
3828
3838
|
List transactions by tag
|
3829
3839
|
|
@@ -3844,10 +3854,16 @@ end
|
|
3844
3854
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
3845
3855
|
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
3846
3856
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
3857
|
+
opts = {
|
3858
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
3859
|
+
page: 1, # Integer | Specify current page.
|
3860
|
+
records_per_page: 10, # Integer | Specify records per page.
|
3861
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
3862
|
+
}
|
3847
3863
|
|
3848
3864
|
begin
|
3849
3865
|
# List transactions by tag
|
3850
|
-
result = api_instance.list_transactions_by_tag(tag_guid, user_guid)
|
3866
|
+
result = api_instance.list_transactions_by_tag(tag_guid, user_guid, opts)
|
3851
3867
|
p result
|
3852
3868
|
rescue MxPlatformRuby::ApiError => e
|
3853
3869
|
puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}"
|
@@ -3858,12 +3874,12 @@ end
|
|
3858
3874
|
|
3859
3875
|
This returns an Array which contains the response data, status code and headers.
|
3860
3876
|
|
3861
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid)
|
3877
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
3862
3878
|
|
3863
3879
|
```ruby
|
3864
3880
|
begin
|
3865
3881
|
# List transactions by tag
|
3866
|
-
data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid)
|
3882
|
+
data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
3867
3883
|
p status_code # => 2xx
|
3868
3884
|
p headers # => { ... }
|
3869
3885
|
p data # => <TransactionsResponseBody>
|
@@ -3878,6 +3894,10 @@ end
|
|
3878
3894
|
| ---- | ---- | ----------- | ----- |
|
3879
3895
|
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
3880
3896
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
3897
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
3898
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
3899
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
3900
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
3881
3901
|
|
3882
3902
|
### Return type
|
3883
3903
|
|
@@ -2074,6 +2074,8 @@ module MxPlatformRuby
|
|
2074
2074
|
# Use this endpoint to read the attributes of a specific user.
|
2075
2075
|
# @param user_guid [String] The unique id for a `user`.
|
2076
2076
|
# @param [Hash] opts the optional parameters
|
2077
|
+
# @option opts [Integer] :page Specify current page.
|
2078
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
2077
2079
|
# @return [CategoriesResponseBody]
|
2078
2080
|
def list_default_categories(user_guid, opts = {})
|
2079
2081
|
data, _status_code, _headers = list_default_categories_with_http_info(user_guid, opts)
|
@@ -2084,6 +2086,8 @@ module MxPlatformRuby
|
|
2084
2086
|
# Use this endpoint to read the attributes of a specific user.
|
2085
2087
|
# @param user_guid [String] The unique id for a `user`.
|
2086
2088
|
# @param [Hash] opts the optional parameters
|
2089
|
+
# @option opts [Integer] :page Specify current page.
|
2090
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
2087
2091
|
# @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
|
2088
2092
|
def list_default_categories_with_http_info(user_guid, opts = {})
|
2089
2093
|
if @api_client.config.debugging
|
@@ -2098,6 +2102,8 @@ module MxPlatformRuby
|
|
2098
2102
|
|
2099
2103
|
# query parameters
|
2100
2104
|
query_params = opts[:query_params] || {}
|
2105
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2106
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
2101
2107
|
|
2102
2108
|
# header parameters
|
2103
2109
|
header_params = opts[:header_params] || {}
|
@@ -2425,6 +2431,8 @@ module MxPlatformRuby
|
|
2425
2431
|
# This endpoint returns a list of institutions based on the specified search term or parameter.
|
2426
2432
|
# @param [Hash] opts the optional parameters
|
2427
2433
|
# @option opts [String] :name This will list only institutions in which the appended string appears.
|
2434
|
+
# @option opts [Integer] :page Specify current page.
|
2435
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
2428
2436
|
# @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
|
2429
2437
|
# @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
|
2430
2438
|
# @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
|
@@ -2439,6 +2447,8 @@ module MxPlatformRuby
|
|
2439
2447
|
# This endpoint returns a list of institutions based on the specified search term or parameter.
|
2440
2448
|
# @param [Hash] opts the optional parameters
|
2441
2449
|
# @option opts [String] :name This will list only institutions in which the appended string appears.
|
2450
|
+
# @option opts [Integer] :page Specify current page.
|
2451
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
2442
2452
|
# @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
|
2443
2453
|
# @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
|
2444
2454
|
# @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
|
@@ -2454,6 +2464,8 @@ module MxPlatformRuby
|
|
2454
2464
|
# query parameters
|
2455
2465
|
query_params = opts[:query_params] || {}
|
2456
2466
|
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
2467
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2468
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
2457
2469
|
query_params[:'supports_account_identification'] = opts[:'supports_account_identification'] if !opts[:'supports_account_identification'].nil?
|
2458
2470
|
query_params[:'supports_account_statement'] = opts[:'supports_account_statement'] if !opts[:'supports_account_statement'].nil?
|
2459
2471
|
query_params[:'supports_account_verification'] = opts[:'supports_account_verification'] if !opts[:'supports_account_verification'].nil?
|
@@ -3581,6 +3593,10 @@ module MxPlatformRuby
|
|
3581
3593
|
# @param tag_guid [String] The unique id for a `tag`.
|
3582
3594
|
# @param user_guid [String] The unique id for a `user`.
|
3583
3595
|
# @param [Hash] opts the optional parameters
|
3596
|
+
# @option opts [String] :from_date Filter transactions from this date.
|
3597
|
+
# @option opts [Integer] :page Specify current page.
|
3598
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
3599
|
+
# @option opts [String] :to_date Filter transactions to this date.
|
3584
3600
|
# @return [TransactionsResponseBody]
|
3585
3601
|
def list_transactions_by_tag(tag_guid, user_guid, opts = {})
|
3586
3602
|
data, _status_code, _headers = list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
@@ -3592,6 +3608,10 @@ module MxPlatformRuby
|
|
3592
3608
|
# @param tag_guid [String] The unique id for a `tag`.
|
3593
3609
|
# @param user_guid [String] The unique id for a `user`.
|
3594
3610
|
# @param [Hash] opts the optional parameters
|
3611
|
+
# @option opts [String] :from_date Filter transactions from this date.
|
3612
|
+
# @option opts [Integer] :page Specify current page.
|
3613
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
3614
|
+
# @option opts [String] :to_date Filter transactions to this date.
|
3595
3615
|
# @return [Array<(TransactionsResponseBody, Integer, Hash)>] TransactionsResponseBody data, response status code and response headers
|
3596
3616
|
def list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {})
|
3597
3617
|
if @api_client.config.debugging
|
@@ -3610,6 +3630,10 @@ module MxPlatformRuby
|
|
3610
3630
|
|
3611
3631
|
# query parameters
|
3612
3632
|
query_params = opts[:query_params] || {}
|
3633
|
+
query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
3634
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
3635
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
3636
|
+
query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
3613
3637
|
|
3614
3638
|
# header parameters
|
3615
3639
|
header_params = opts[:header_params] || {}
|
data/openapi/config.yml
CHANGED
@@ -423,6 +423,8 @@ describe 'MxPlatformApi' do
|
|
423
423
|
# Use this endpoint to read the attributes of a specific user.
|
424
424
|
# @param user_guid The unique id for a `user`.
|
425
425
|
# @param [Hash] opts the optional parameters
|
426
|
+
# @option opts [Integer] :page Specify current page.
|
427
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
426
428
|
# @return [CategoriesResponseBody]
|
427
429
|
describe 'list_default_categories test' do
|
428
430
|
it 'should work' do
|
@@ -495,6 +497,8 @@ describe 'MxPlatformApi' do
|
|
495
497
|
# This endpoint returns a list of institutions based on the specified search term or parameter.
|
496
498
|
# @param [Hash] opts the optional parameters
|
497
499
|
# @option opts [String] :name This will list only institutions in which the appended string appears.
|
500
|
+
# @option opts [Integer] :page Specify current page.
|
501
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
498
502
|
# @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
|
499
503
|
# @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
|
500
504
|
# @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
|
@@ -733,6 +737,10 @@ describe 'MxPlatformApi' do
|
|
733
737
|
# @param tag_guid The unique id for a `tag`.
|
734
738
|
# @param user_guid The unique id for a `user`.
|
735
739
|
# @param [Hash] opts the optional parameters
|
740
|
+
# @option opts [String] :from_date Filter transactions from this date.
|
741
|
+
# @option opts [Integer] :page Specify current page.
|
742
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
743
|
+
# @option opts [String] :to_date Filter transactions to this date.
|
736
744
|
# @return [TransactionsResponseBody]
|
737
745
|
describe 'list_transactions_by_tag test' do
|
738
746
|
it 'should work' do
|
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.
|
4
|
+
version: 0.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- MX
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-10-
|
11
|
+
date: 2021-10-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|