mx-platform-ruby 0.6.3 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 262c6362945060899351feb3aa49356bbfa5a234f917b2efa099f39188f4cc55
4
- data.tar.gz: 3dfa97a2aa14f65c8f048f8c9e6a5bbc199bc3fef5c0ccbe58e7f11e38737aad
3
+ metadata.gz: 8e1b23a7826a1747fe4e70489563eccfb6ebf00fe33a1bb3fa196d848aad5319
4
+ data.tar.gz: 24b24c73997bd24c5e0d98996e62c01822fa3905d0a083780b31724c38e7b42c
5
5
  SHA512:
6
- metadata.gz: 986214ba1b32b491894c84294f03c7413a62b8fe145c485ac9965bd90285981fac989e1e8607ba48f32ecfc08e54ea8d01fe34d62be775143f43eeaa10036627
7
- data.tar.gz: a0e99f8388aea551610df4241e34c57a0c4c035d6b3fd3a8da6edb5c37c1422a379846ef6ec411cb8e9ba67d3e9ca22cd74c6c99125dc5f9569a2af3fec3e2ab
6
+ metadata.gz: 1929b26718b7e202f2d9cba036fcc2d7f1911de6eeeac9471653caecc2465b142a22761d2b0078126c41a51c47208b8a1c2da1fa4c944fbb51a97831c63a8727
7
+ data.tar.gz: 418722dca6d503d7fd646955f001fb1c7778921b85aa2ef050fa23142d4c5c6b2842e114917fc21cad7039609a9f0fc636735343aeb42309ecc6f2c1ff3b3f80
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mx-platform-ruby (0.6.3)
4
+ mx-platform-ruby (0.7.0)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -10,7 +10,7 @@ GEM
10
10
  ast (2.4.2)
11
11
  byebug (11.1.3)
12
12
  coderay (1.1.3)
13
- diff-lcs (1.4.4)
13
+ diff-lcs (1.5.0)
14
14
  faraday (1.8.0)
15
15
  faraday-em_http (~> 1.0)
16
16
  faraday-em_synchrony (~> 1.0)
@@ -34,7 +34,7 @@ GEM
34
34
  method_source (1.0.0)
35
35
  multipart-post (2.1.1)
36
36
  parallel (1.21.0)
37
- parser (3.0.3.1)
37
+ parser (3.1.0.0)
38
38
  ast (~> 2.4.1)
39
39
  pry (0.13.1)
40
40
  coderay (~> 1.1)
@@ -42,7 +42,8 @@ GEM
42
42
  pry-byebug (3.9.0)
43
43
  byebug (~> 11.0)
44
44
  pry (~> 0.13.0)
45
- psych (4.0.2)
45
+ psych (4.0.3)
46
+ stringio
46
47
  rainbow (3.0.0)
47
48
  rake (13.0.6)
48
49
  rspec (3.10.0)
@@ -68,6 +69,7 @@ GEM
68
69
  unicode-display_width (>= 1.4.0, < 1.6)
69
70
  ruby-progressbar (1.11.0)
70
71
  ruby2_keywords (0.0.5)
72
+ stringio (3.0.1)
71
73
  unicode-display_width (1.5.0)
72
74
 
73
75
  PLATFORMS
@@ -81,4 +83,4 @@ DEPENDENCIES
81
83
  rubocop (~> 0.66.0)
82
84
 
83
85
  BUNDLED WITH
84
- 2.2.32
86
+ 2.3.4
data/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2021 MX Technologies Inc.
3
+ Copyright (c) 2022 MX Technologies Inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
data/README.md CHANGED
@@ -77,4 +77,4 @@ openapi-generator-cli generate \
77
77
 
78
78
  ## Contributing
79
79
 
80
- Please [open an issue](https://github.com/mxenabled/mx-platform-java/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-java/pulls)
80
+ Please [open an issue](https://github.com/mxenabled/mx-platform-ruby/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-ruby/pulls)
@@ -52,7 +52,7 @@ instance = MxPlatformRuby::EnhanceTransactionResponse.new(
52
52
  is_payroll_advance: false,
53
53
  is_subscription: false,
54
54
  memo: Additional-information*on_transaction,
55
- merchant_category_code: 5411,
55
+ merchant_category_code: 4121,
56
56
  merchant_guid: MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e,
57
57
  merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea,
58
58
  original_description: ubr* pending.uber.com,
@@ -23,7 +23,7 @@ instance = MxPlatformRuby::EnhanceTransactionsRequest.new(
23
23
  extended_transaction_type: partner_transaction_type,
24
24
  id: ID-123,
25
25
  memo: Additional-information*on_transaction,
26
- merchant_category_code: 123,
26
+ merchant_category_code: 4121,
27
27
  type: DEBIT
28
28
  )
29
29
  ```
@@ -33,7 +33,8 @@ All URIs are relative to *https://api.mx.com*
33
33
  | [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
34
34
  | [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member |
35
35
  | [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
36
- | [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories |
36
+ | [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /categories/default | List default categories |
37
+ | [**list_default_categories_by_user**](MxPlatformApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user |
37
38
  | [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions |
38
39
  | [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings |
39
40
  | [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
@@ -58,7 +59,8 @@ All URIs are relative to *https://api.mx.com*
58
59
  | [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
59
60
  | [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
60
61
  | [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
61
- | [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
62
+ | [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
63
+ | [**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
62
64
  | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
63
65
  | [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
64
66
  | [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
@@ -2199,11 +2201,11 @@ end
2199
2201
 
2200
2202
  ## list_default_categories
2201
2203
 
2202
- > <CategoriesResponseBody> list_default_categories(user_guid, opts)
2204
+ > <CategoriesResponseBody> list_default_categories(opts)
2203
2205
 
2204
2206
  List default categories
2205
2207
 
2206
- Use this endpoint to read the attributes of a specific user.
2208
+ Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2207
2209
 
2208
2210
  ### Examples
2209
2211
 
@@ -2218,7 +2220,6 @@ MxPlatformRuby.configure do |config|
2218
2220
  end
2219
2221
 
2220
2222
  api_instance = MxPlatformRuby::MxPlatformApi.new
2221
- user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2222
2223
  opts = {
2223
2224
  page: 1, # Integer | Specify current page.
2224
2225
  records_per_page: 10 # Integer | Specify records per page.
@@ -2226,7 +2227,7 @@ opts = {
2226
2227
 
2227
2228
  begin
2228
2229
  # List default categories
2229
- result = api_instance.list_default_categories(user_guid, opts)
2230
+ result = api_instance.list_default_categories(opts)
2230
2231
  p result
2231
2232
  rescue MxPlatformRuby::ApiError => e
2232
2233
  puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
@@ -2237,12 +2238,12 @@ end
2237
2238
 
2238
2239
  This returns an Array which contains the response data, status code and headers.
2239
2240
 
2240
- > <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
2241
+ > <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(opts)
2241
2242
 
2242
2243
  ```ruby
2243
2244
  begin
2244
2245
  # List default categories
2245
- data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
2246
+ data, status_code, headers = api_instance.list_default_categories_with_http_info(opts)
2246
2247
  p status_code # => 2xx
2247
2248
  p headers # => { ... }
2248
2249
  p data # => <CategoriesResponseBody>
@@ -2253,6 +2254,81 @@ end
2253
2254
 
2254
2255
  ### Parameters
2255
2256
 
2257
+ | Name | Type | Description | Notes |
2258
+ | ---- | ---- | ----------- | ----- |
2259
+ | **page** | **Integer** | Specify current page. | [optional] |
2260
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2261
+
2262
+ ### Return type
2263
+
2264
+ [**CategoriesResponseBody**](CategoriesResponseBody.md)
2265
+
2266
+ ### Authorization
2267
+
2268
+ [basicAuth](../README.md#basicAuth)
2269
+
2270
+ ### HTTP request headers
2271
+
2272
+ - **Content-Type**: Not defined
2273
+ - **Accept**: application/vnd.mx.api.v1+json
2274
+
2275
+
2276
+ ## list_default_categories_by_user
2277
+
2278
+ > <CategoriesResponseBody> list_default_categories_by_user(user_guid, opts)
2279
+
2280
+ List default categories by user
2281
+
2282
+ Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2283
+
2284
+ ### Examples
2285
+
2286
+ ```ruby
2287
+ require 'time'
2288
+ require 'mx-platform-ruby'
2289
+ # setup authorization
2290
+ MxPlatformRuby.configure do |config|
2291
+ # Configure HTTP basic authorization: basicAuth
2292
+ config.username = 'YOUR USERNAME'
2293
+ config.password = 'YOUR PASSWORD'
2294
+ end
2295
+
2296
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2297
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2298
+ opts = {
2299
+ page: 1, # Integer | Specify current page.
2300
+ records_per_page: 10 # Integer | Specify records per page.
2301
+ }
2302
+
2303
+ begin
2304
+ # List default categories by user
2305
+ result = api_instance.list_default_categories_by_user(user_guid, opts)
2306
+ p result
2307
+ rescue MxPlatformRuby::ApiError => e
2308
+ puts "Error when calling MxPlatformApi->list_default_categories_by_user: #{e}"
2309
+ end
2310
+ ```
2311
+
2312
+ #### Using the list_default_categories_by_user_with_http_info variant
2313
+
2314
+ This returns an Array which contains the response data, status code and headers.
2315
+
2316
+ > <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_by_user_with_http_info(user_guid, opts)
2317
+
2318
+ ```ruby
2319
+ begin
2320
+ # List default categories by user
2321
+ data, status_code, headers = api_instance.list_default_categories_by_user_with_http_info(user_guid, opts)
2322
+ p status_code # => 2xx
2323
+ p headers # => { ... }
2324
+ p data # => <CategoriesResponseBody>
2325
+ rescue MxPlatformRuby::ApiError => e
2326
+ puts "Error when calling MxPlatformApi->list_default_categories_by_user_with_http_info: #{e}"
2327
+ end
2328
+ ```
2329
+
2330
+ ### Parameters
2331
+
2256
2332
  | Name | Type | Description | Notes |
2257
2333
  | ---- | ---- | ----------- | ----- |
2258
2334
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
@@ -4139,7 +4215,7 @@ end
4139
4215
 
4140
4216
  > <CategoryResponseBody> read_category(category_guid, user_guid)
4141
4217
 
4142
- Read category
4218
+ Read a custom category
4143
4219
 
4144
4220
  Use this endpoint to read the attributes of either a default category or a custom category.
4145
4221
 
@@ -4160,7 +4236,7 @@ category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique
4160
4236
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4161
4237
 
4162
4238
  begin
4163
- # Read category
4239
+ # Read a custom category
4164
4240
  result = api_instance.read_category(category_guid, user_guid)
4165
4241
  p result
4166
4242
  rescue MxPlatformRuby::ApiError => e
@@ -4176,7 +4252,7 @@ This returns an Array which contains the response data, status code and headers.
4176
4252
 
4177
4253
  ```ruby
4178
4254
  begin
4179
- # Read category
4255
+ # Read a custom category
4180
4256
  data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
4181
4257
  p status_code # => 2xx
4182
4258
  p headers # => { ... }
@@ -4207,6 +4283,78 @@ end
4207
4283
  - **Accept**: application/vnd.mx.api.v1+json
4208
4284
 
4209
4285
 
4286
+ ## read_default_category
4287
+
4288
+ > <CategoryResponseBody> read_default_category(category_guid, user_guid)
4289
+
4290
+ Read a default category
4291
+
4292
+ Use this endpoint to read the attributes of a default category.
4293
+
4294
+ ### Examples
4295
+
4296
+ ```ruby
4297
+ require 'time'
4298
+ require 'mx-platform-ruby'
4299
+ # setup authorization
4300
+ MxPlatformRuby.configure do |config|
4301
+ # Configure HTTP basic authorization: basicAuth
4302
+ config.username = 'YOUR USERNAME'
4303
+ config.password = 'YOUR PASSWORD'
4304
+ end
4305
+
4306
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4307
+ category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
4308
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4309
+
4310
+ begin
4311
+ # Read a default category
4312
+ result = api_instance.read_default_category(category_guid, user_guid)
4313
+ p result
4314
+ rescue MxPlatformRuby::ApiError => e
4315
+ puts "Error when calling MxPlatformApi->read_default_category: #{e}"
4316
+ end
4317
+ ```
4318
+
4319
+ #### Using the read_default_category_with_http_info variant
4320
+
4321
+ This returns an Array which contains the response data, status code and headers.
4322
+
4323
+ > <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid, user_guid)
4324
+
4325
+ ```ruby
4326
+ begin
4327
+ # Read a default category
4328
+ data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid, user_guid)
4329
+ p status_code # => 2xx
4330
+ p headers # => { ... }
4331
+ p data # => <CategoryResponseBody>
4332
+ rescue MxPlatformRuby::ApiError => e
4333
+ puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
4334
+ end
4335
+ ```
4336
+
4337
+ ### Parameters
4338
+
4339
+ | Name | Type | Description | Notes |
4340
+ | ---- | ---- | ----------- | ----- |
4341
+ | **category_guid** | **String** | The unique id for a &#x60;category&#x60;. | |
4342
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4343
+
4344
+ ### Return type
4345
+
4346
+ [**CategoryResponseBody**](CategoryResponseBody.md)
4347
+
4348
+ ### Authorization
4349
+
4350
+ [basicAuth](../README.md#basicAuth)
4351
+
4352
+ ### HTTP request headers
4353
+
4354
+ - **Content-Type**: Not defined
4355
+ - **Accept**: application/vnd.mx.api.v1+json
4356
+
4357
+
4210
4358
  ## read_holding
4211
4359
 
4212
4360
  > <HoldingResponseBody> read_holding(holding_guid, user_guid)
@@ -2101,31 +2101,94 @@ module MxPlatformRuby
2101
2101
  end
2102
2102
 
2103
2103
  # List default categories
2104
- # Use this endpoint to read the attributes of a specific user.
2105
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
2104
+ # Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2106
2105
  # @param [Hash] opts the optional parameters
2107
2106
  # @option opts [Integer] :page Specify current page.
2108
2107
  # @option opts [Integer] :records_per_page Specify records per page.
2109
2108
  # @return [CategoriesResponseBody]
2110
- def list_default_categories(user_guid, opts = {})
2111
- data, _status_code, _headers = list_default_categories_with_http_info(user_guid, opts)
2109
+ def list_default_categories(opts = {})
2110
+ data, _status_code, _headers = list_default_categories_with_http_info(opts)
2112
2111
  data
2113
2112
  end
2114
2113
 
2115
2114
  # List default categories
2116
- # Use this endpoint to read the attributes of a specific user.
2117
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
2115
+ # Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its &#x60;is_default&#x60; field set to &#x60;true&#x60;. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2118
2116
  # @param [Hash] opts the optional parameters
2119
2117
  # @option opts [Integer] :page Specify current page.
2120
2118
  # @option opts [Integer] :records_per_page Specify records per page.
2121
2119
  # @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
2122
- def list_default_categories_with_http_info(user_guid, opts = {})
2120
+ def list_default_categories_with_http_info(opts = {})
2123
2121
  if @api_client.config.debugging
2124
2122
  @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories ...'
2125
2123
  end
2124
+ # resource path
2125
+ local_var_path = '/categories/default'
2126
+
2127
+ # query parameters
2128
+ query_params = opts[:query_params] || {}
2129
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2130
+ query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
2131
+
2132
+ # header parameters
2133
+ header_params = opts[:header_params] || {}
2134
+ # HTTP header 'Accept' (if needed)
2135
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
2136
+
2137
+ # form parameters
2138
+ form_params = opts[:form_params] || {}
2139
+
2140
+ # http body (model)
2141
+ post_body = opts[:debug_body]
2142
+
2143
+ # return_type
2144
+ return_type = opts[:debug_return_type] || 'CategoriesResponseBody'
2145
+
2146
+ # auth_names
2147
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
2148
+
2149
+ new_options = opts.merge(
2150
+ :operation => :"MxPlatformApi.list_default_categories",
2151
+ :header_params => header_params,
2152
+ :query_params => query_params,
2153
+ :form_params => form_params,
2154
+ :body => post_body,
2155
+ :auth_names => auth_names,
2156
+ :return_type => return_type
2157
+ )
2158
+
2159
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2160
+ if @api_client.config.debugging
2161
+ @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2162
+ end
2163
+ return data, status_code, headers
2164
+ end
2165
+
2166
+ # List default categories by user
2167
+ # Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2168
+ # @param user_guid [String] The unique id for a &#x60;user&#x60;.
2169
+ # @param [Hash] opts the optional parameters
2170
+ # @option opts [Integer] :page Specify current page.
2171
+ # @option opts [Integer] :records_per_page Specify records per page.
2172
+ # @return [CategoriesResponseBody]
2173
+ def list_default_categories_by_user(user_guid, opts = {})
2174
+ data, _status_code, _headers = list_default_categories_by_user_with_http_info(user_guid, opts)
2175
+ data
2176
+ end
2177
+
2178
+ # List default categories by user
2179
+ # Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its &#x60;is_default&#x60; field set to &#x60;true&#x60;. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2180
+ # @param user_guid [String] The unique id for a &#x60;user&#x60;.
2181
+ # @param [Hash] opts the optional parameters
2182
+ # @option opts [Integer] :page Specify current page.
2183
+ # @option opts [Integer] :records_per_page Specify records per page.
2184
+ # @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
2185
+ def list_default_categories_by_user_with_http_info(user_guid, opts = {})
2186
+ if @api_client.config.debugging
2187
+ @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories_by_user ...'
2188
+ end
2126
2189
  # verify the required parameter 'user_guid' is set
2127
2190
  if @api_client.config.client_side_validation && user_guid.nil?
2128
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_default_categories"
2191
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_default_categories_by_user"
2129
2192
  end
2130
2193
  # resource path
2131
2194
  local_var_path = '/users/{user_guid}/categories/default'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
@@ -2153,7 +2216,7 @@ module MxPlatformRuby
2153
2216
  auth_names = opts[:debug_auth_names] || ['basicAuth']
2154
2217
 
2155
2218
  new_options = opts.merge(
2156
- :operation => :"MxPlatformApi.list_default_categories",
2219
+ :operation => :"MxPlatformApi.list_default_categories_by_user",
2157
2220
  :header_params => header_params,
2158
2221
  :query_params => query_params,
2159
2222
  :form_params => form_params,
@@ -2164,7 +2227,7 @@ module MxPlatformRuby
2164
2227
 
2165
2228
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2166
2229
  if @api_client.config.debugging
2167
- @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2230
+ @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories_by_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2168
2231
  end
2169
2232
  return data, status_code, headers
2170
2233
  end
@@ -3900,7 +3963,7 @@ module MxPlatformRuby
3900
3963
  return data, status_code, headers
3901
3964
  end
3902
3965
 
3903
- # Read category
3966
+ # Read a custom category
3904
3967
  # Use this endpoint to read the attributes of either a default category or a custom category.
3905
3968
  # @param category_guid [String] The unique id for a &#x60;category&#x60;.
3906
3969
  # @param user_guid [String] The unique id for a &#x60;user&#x60;.
@@ -3911,7 +3974,7 @@ module MxPlatformRuby
3911
3974
  data
3912
3975
  end
3913
3976
 
3914
- # Read category
3977
+ # Read a custom category
3915
3978
  # Use this endpoint to read the attributes of either a default category or a custom category.
3916
3979
  # @param category_guid [String] The unique id for a &#x60;category&#x60;.
3917
3980
  # @param user_guid [String] The unique id for a &#x60;user&#x60;.
@@ -3969,6 +4032,75 @@ module MxPlatformRuby
3969
4032
  return data, status_code, headers
3970
4033
  end
3971
4034
 
4035
+ # Read a default category
4036
+ # Use this endpoint to read the attributes of a default category.
4037
+ # @param category_guid [String] The unique id for a &#x60;category&#x60;.
4038
+ # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4039
+ # @param [Hash] opts the optional parameters
4040
+ # @return [CategoryResponseBody]
4041
+ def read_default_category(category_guid, user_guid, opts = {})
4042
+ data, _status_code, _headers = read_default_category_with_http_info(category_guid, user_guid, opts)
4043
+ data
4044
+ end
4045
+
4046
+ # Read a default category
4047
+ # Use this endpoint to read the attributes of a default category.
4048
+ # @param category_guid [String] The unique id for a &#x60;category&#x60;.
4049
+ # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4050
+ # @param [Hash] opts the optional parameters
4051
+ # @return [Array<(CategoryResponseBody, Integer, Hash)>] CategoryResponseBody data, response status code and response headers
4052
+ def read_default_category_with_http_info(category_guid, user_guid, opts = {})
4053
+ if @api_client.config.debugging
4054
+ @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_default_category ...'
4055
+ end
4056
+ # verify the required parameter 'category_guid' is set
4057
+ if @api_client.config.client_side_validation && category_guid.nil?
4058
+ fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_default_category"
4059
+ end
4060
+ # verify the required parameter 'user_guid' is set
4061
+ if @api_client.config.client_side_validation && user_guid.nil?
4062
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_default_category"
4063
+ end
4064
+ # resource path
4065
+ local_var_path = '/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
4066
+
4067
+ # query parameters
4068
+ query_params = opts[:query_params] || {}
4069
+
4070
+ # header parameters
4071
+ header_params = opts[:header_params] || {}
4072
+ # HTTP header 'Accept' (if needed)
4073
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
4074
+
4075
+ # form parameters
4076
+ form_params = opts[:form_params] || {}
4077
+
4078
+ # http body (model)
4079
+ post_body = opts[:debug_body]
4080
+
4081
+ # return_type
4082
+ return_type = opts[:debug_return_type] || 'CategoryResponseBody'
4083
+
4084
+ # auth_names
4085
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
4086
+
4087
+ new_options = opts.merge(
4088
+ :operation => :"MxPlatformApi.read_default_category",
4089
+ :header_params => header_params,
4090
+ :query_params => query_params,
4091
+ :form_params => form_params,
4092
+ :body => post_body,
4093
+ :auth_names => auth_names,
4094
+ :return_type => return_type
4095
+ )
4096
+
4097
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4098
+ if @api_client.config.debugging
4099
+ @api_client.config.logger.debug "API called: MxPlatformApi#read_default_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4100
+ end
4101
+ return data, status_code, headers
4102
+ end
4103
+
3972
4104
  # Read holding
3973
4105
  # Use this endpoint to read the attributes of a specific `holding`.
3974
4106
  # @param holding_guid [String] The unique id for a &#x60;holding&#x60;.
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.0
11
11
  =end
12
12
 
13
13
  module MxPlatformRuby
14
- VERSION = '0.6.3'
14
+ VERSION = '0.7.0'
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.6.3"
9
+ gemVersion: "0.7.0"
10
10
  library: "faraday"
11
11
  moduleName: "MxPlatformRuby"
@@ -77,4 +77,4 @@ openapi-generator-cli generate \
77
77
 
78
78
  ## Contributing
79
79
 
80
- Please [open an issue](https://github.com/mxenabled/mx-platform-java/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-java/pulls)
80
+ Please [open an issue](https://github.com/mxenabled/mx-platform-ruby/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-ruby/pulls)
@@ -420,8 +420,7 @@ describe 'MxPlatformApi' do
420
420
 
421
421
  # unit tests for list_default_categories
422
422
  # List default categories
423
- # Use this endpoint to read the attributes of a specific user.
424
- # @param user_guid The unique id for a &#x60;user&#x60;.
423
+ # Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its &#x60;is_default&#x60; field set to &#x60;true&#x60;. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
425
424
  # @param [Hash] opts the optional parameters
426
425
  # @option opts [Integer] :page Specify current page.
427
426
  # @option opts [Integer] :records_per_page Specify records per page.
@@ -432,6 +431,20 @@ describe 'MxPlatformApi' do
432
431
  end
433
432
  end
434
433
 
434
+ # unit tests for list_default_categories_by_user
435
+ # List default categories by user
436
+ # Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its &#x60;is_default&#x60; field set to &#x60;true&#x60;. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
437
+ # @param user_guid The unique id for a &#x60;user&#x60;.
438
+ # @param [Hash] opts the optional parameters
439
+ # @option opts [Integer] :page Specify current page.
440
+ # @option opts [Integer] :records_per_page Specify records per page.
441
+ # @return [CategoriesResponseBody]
442
+ describe 'list_default_categories_by_user test' do
443
+ it 'should work' do
444
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
445
+ end
446
+ end
447
+
435
448
  # unit tests for list_favorite_institutions
436
449
  # List favorite institutions
437
450
  # This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
@@ -789,7 +802,7 @@ describe 'MxPlatformApi' do
789
802
  end
790
803
 
791
804
  # unit tests for read_category
792
- # Read category
805
+ # Read a custom category
793
806
  # Use this endpoint to read the attributes of either a default category or a custom category.
794
807
  # @param category_guid The unique id for a &#x60;category&#x60;.
795
808
  # @param user_guid The unique id for a &#x60;user&#x60;.
@@ -801,6 +814,19 @@ describe 'MxPlatformApi' do
801
814
  end
802
815
  end
803
816
 
817
+ # unit tests for read_default_category
818
+ # Read a default category
819
+ # Use this endpoint to read the attributes of a default category.
820
+ # @param category_guid The unique id for a &#x60;category&#x60;.
821
+ # @param user_guid The unique id for a &#x60;user&#x60;.
822
+ # @param [Hash] opts the optional parameters
823
+ # @return [CategoryResponseBody]
824
+ describe 'read_default_category test' do
825
+ it 'should work' do
826
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
827
+ end
828
+ end
829
+
804
830
  # unit tests for read_holding
805
831
  # Read holding
806
832
  # Use this endpoint to read the attributes of a specific &#x60;holding&#x60;.
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.6.3
4
+ version: 0.7.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-11-30 00:00:00.000000000 Z
11
+ date: 2022-01-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -427,112 +427,112 @@ test_files:
427
427
  - spec/api/mx_platform_api_spec.rb
428
428
  - spec/api_client_spec.rb
429
429
  - spec/configuration_spec.rb
430
- - spec/models/tag_update_request_body_spec.rb
431
- - spec/models/enhance_transaction_response_spec.rb
432
- - spec/models/enhance_transactions_response_body_spec.rb
433
- - spec/models/user_response_body_spec.rb
434
- - spec/models/account_update_request_spec.rb
435
- - spec/models/tagging_create_request_spec.rb
436
- - spec/models/member_update_request_spec.rb
437
- - spec/models/user_update_request_body_spec.rb
438
- - spec/models/transaction_update_request_spec.rb
439
- - spec/models/institutions_response_body_spec.rb
440
- - spec/models/transactions_response_body_spec.rb
441
- - spec/models/transaction_update_request_body_spec.rb
442
- - spec/models/member_status_response_body_spec.rb
443
- - spec/models/category_response_spec.rb
444
- - spec/models/option_response_spec.rb
445
- - spec/models/tag_response_body_spec.rb
446
- - spec/models/pagination_response_spec.rb
430
+ - spec/models/managed_transaction_update_request_spec.rb
431
+ - spec/models/connect_widget_request_body_spec.rb
432
+ - spec/models/tagging_response_spec.rb
433
+ - spec/models/widget_request_body_spec.rb
434
+ - spec/models/transaction_rules_response_body_spec.rb
447
435
  - spec/models/transaction_rule_response_body_spec.rb
448
- - spec/models/categories_response_body_spec.rb
449
- - spec/models/members_response_body_spec.rb
436
+ - spec/models/tag_response_spec.rb
437
+ - spec/models/merchant_location_response_body_spec.rb
438
+ - spec/models/managed_member_update_request_spec.rb
439
+ - spec/models/member_status_response_spec.rb
440
+ - spec/models/managed_transaction_update_request_body_spec.rb
450
441
  - spec/models/member_create_request_body_spec.rb
451
- - spec/models/credential_request_spec.rb
442
+ - spec/models/user_create_request_body_spec.rb
443
+ - spec/models/member_create_request_spec.rb
444
+ - spec/models/managed_account_create_request_body_spec.rb
445
+ - spec/models/user_update_request_spec.rb
446
+ - spec/models/enhance_transactions_request_body_spec.rb
447
+ - spec/models/tagging_update_request_body_spec.rb
448
+ - spec/models/user_response_body_spec.rb
449
+ - spec/models/transaction_response_spec.rb
450
+ - spec/models/member_response_body_spec.rb
451
+ - spec/models/account_response_spec.rb
452
452
  - spec/models/category_create_request_spec.rb
453
- - spec/models/statement_response_spec.rb
454
- - spec/models/managed_member_create_request_body_spec.rb
455
- - spec/models/credential_response_spec.rb
453
+ - spec/models/widget_request_spec.rb
454
+ - spec/models/institutions_response_body_spec.rb
455
+ - spec/models/user_update_request_body_spec.rb
456
456
  - spec/models/merchant_response_body_spec.rb
457
- - spec/models/credentials_response_body_spec.rb
458
- - spec/models/category_update_request_spec.rb
459
- - spec/models/connect_widget_request_body_spec.rb
460
- - spec/models/account_numbers_response_body_spec.rb
461
- - spec/models/member_status_response_spec.rb
462
- - spec/models/holdings_response_body_spec.rb
463
- - spec/models/holding_response_body_spec.rb
464
- - spec/models/account_number_response_spec.rb
465
- - spec/models/managed_member_update_request_spec.rb
466
- - spec/models/user_create_request_body_spec.rb
467
- - spec/models/transaction_rule_create_request_spec.rb
468
- - spec/models/statements_response_body_spec.rb
457
+ - spec/models/credential_response_spec.rb
469
458
  - spec/models/tag_update_request_spec.rb
470
- - spec/models/managed_member_update_request_body_spec.rb
471
- - spec/models/member_response_spec.rb
472
- - spec/models/enhance_transactions_request_spec.rb
473
- - spec/models/managed_account_update_request_body_spec.rb
474
- - spec/models/institution_response_body_spec.rb
475
- - spec/models/tagging_update_request_spec.rb
476
- - spec/models/statement_response_body_spec.rb
477
- - spec/models/accounts_response_body_spec.rb
478
- - spec/models/tag_create_request_body_spec.rb
479
459
  - spec/models/connect_widget_request_spec.rb
480
- - spec/models/managed_account_create_request_body_spec.rb
481
- - spec/models/merchant_response_spec.rb
482
- - spec/models/widget_response_body_spec.rb
483
- - spec/models/widget_request_spec.rb
460
+ - spec/models/connect_widget_response_body_spec.rb
461
+ - spec/models/user_create_request_spec.rb
462
+ - spec/models/transaction_update_request_spec.rb
463
+ - spec/models/transaction_rule_response_spec.rb
464
+ - spec/models/transaction_update_request_body_spec.rb
484
465
  - spec/models/category_update_request_body_spec.rb
485
- - spec/models/image_option_response_spec.rb
486
- - spec/models/managed_transaction_create_request_body_spec.rb
487
- - spec/models/challenge_response_spec.rb
488
- - spec/models/account_owner_response_spec.rb
489
- - spec/models/tagging_update_request_body_spec.rb
490
- - spec/models/transaction_rule_create_request_body_spec.rb
466
+ - spec/models/users_response_body_spec.rb
467
+ - spec/models/enhance_transactions_response_body_spec.rb
468
+ - spec/models/tagging_response_body_spec.rb
469
+ - spec/models/tag_create_request_spec.rb
470
+ - spec/models/member_update_request_body_spec.rb
491
471
  - spec/models/merchants_response_body_spec.rb
472
+ - spec/models/transaction_rule_create_request_spec.rb
473
+ - spec/models/categories_response_body_spec.rb
474
+ - spec/models/tags_response_body_spec.rb
475
+ - spec/models/enhance_transactions_request_spec.rb
476
+ - spec/models/member_response_spec.rb
492
477
  - spec/models/managed_member_create_request_spec.rb
493
- - spec/models/transaction_response_spec.rb
494
- - spec/models/tag_create_request_spec.rb
478
+ - spec/models/challenge_response_spec.rb
495
479
  - spec/models/holding_response_spec.rb
496
- - spec/models/user_update_request_spec.rb
480
+ - spec/models/pagination_response_spec.rb
481
+ - spec/models/managed_account_update_request_spec.rb
482
+ - spec/models/merchant_response_spec.rb
483
+ - spec/models/members_response_body_spec.rb
484
+ - spec/models/tag_response_body_spec.rb
485
+ - spec/models/category_create_request_body_spec.rb
486
+ - spec/models/option_response_spec.rb
487
+ - spec/models/category_response_body_spec.rb
488
+ - spec/models/managed_member_update_request_body_spec.rb
489
+ - spec/models/managed_account_create_request_spec.rb
497
490
  - spec/models/o_auth_window_response_spec.rb
498
- - spec/models/users_response_body_spec.rb
499
- - spec/models/managed_transaction_update_request_body_spec.rb
500
- - spec/models/member_update_request_body_spec.rb
501
- - spec/models/challenges_response_body_spec.rb
502
- - spec/models/tag_response_spec.rb
503
- - spec/models/account_owners_response_body_spec.rb
491
+ - spec/models/account_numbers_response_body_spec.rb
492
+ - spec/models/member_status_response_body_spec.rb
493
+ - spec/models/managed_member_create_request_body_spec.rb
494
+ - spec/models/taggings_response_body_spec.rb
495
+ - spec/models/statements_response_body_spec.rb
496
+ - spec/models/holdings_response_body_spec.rb
497
+ - spec/models/member_resume_request_spec.rb
498
+ - spec/models/member_update_request_spec.rb
504
499
  - spec/models/merchant_location_response_spec.rb
505
- - spec/models/connect_widget_response_body_spec.rb
500
+ - spec/models/account_update_request_spec.rb
506
501
  - spec/models/widget_response_spec.rb
507
- - spec/models/managed_transaction_create_request_spec.rb
508
- - spec/models/account_response_body_spec.rb
509
- - spec/models/transaction_rule_update_request_body_spec.rb
510
- - spec/models/transaction_rules_response_body_spec.rb
511
- - spec/models/managed_account_update_request_spec.rb
512
- - spec/models/taggings_response_body_spec.rb
513
- - spec/models/managed_account_create_request_spec.rb
514
- - spec/models/member_response_body_spec.rb
515
- - spec/models/tagging_response_body_spec.rb
516
- - spec/models/transaction_response_body_spec.rb
517
- - spec/models/managed_transaction_update_request_spec.rb
518
- - spec/models/tags_response_body_spec.rb
519
- - spec/models/o_auth_window_response_body_spec.rb
520
- - spec/models/member_create_request_spec.rb
502
+ - spec/models/user_response_spec.rb
521
503
  - spec/models/tagging_create_request_body_spec.rb
522
- - spec/models/user_create_request_spec.rb
523
- - spec/models/transaction_rule_response_spec.rb
524
- - spec/models/transaction_rule_update_request_spec.rb
525
- - spec/models/merchant_location_response_body_spec.rb
504
+ - spec/models/managed_account_update_request_body_spec.rb
505
+ - spec/models/tagging_update_request_spec.rb
506
+ - spec/models/statement_response_body_spec.rb
507
+ - spec/models/credentials_response_body_spec.rb
508
+ - spec/models/challenges_response_body_spec.rb
509
+ - spec/models/credential_request_spec.rb
510
+ - spec/models/transaction_response_body_spec.rb
526
511
  - spec/models/member_resume_request_body_spec.rb
527
- - spec/models/user_response_spec.rb
528
- - spec/models/member_resume_request_spec.rb
529
- - spec/models/category_create_request_body_spec.rb
530
- - spec/models/account_response_spec.rb
531
- - spec/models/account_update_request_body_spec.rb
512
+ - spec/models/account_owner_response_spec.rb
513
+ - spec/models/transaction_rule_update_request_spec.rb
514
+ - spec/models/institution_response_body_spec.rb
515
+ - spec/models/holding_response_body_spec.rb
516
+ - spec/models/account_owners_response_body_spec.rb
517
+ - spec/models/account_number_response_spec.rb
532
518
  - spec/models/institution_response_spec.rb
533
519
  - spec/models/connect_widget_response_spec.rb
534
- - spec/models/enhance_transactions_request_body_spec.rb
535
- - spec/models/widget_request_body_spec.rb
536
- - spec/models/tagging_response_spec.rb
537
- - spec/models/category_response_body_spec.rb
520
+ - spec/models/category_update_request_spec.rb
521
+ - spec/models/transactions_response_body_spec.rb
522
+ - spec/models/tag_update_request_body_spec.rb
523
+ - spec/models/image_option_response_spec.rb
524
+ - spec/models/accounts_response_body_spec.rb
525
+ - spec/models/widget_response_body_spec.rb
526
+ - spec/models/managed_transaction_create_request_body_spec.rb
527
+ - spec/models/tagging_create_request_spec.rb
528
+ - spec/models/statement_response_spec.rb
529
+ - spec/models/account_response_body_spec.rb
530
+ - spec/models/account_update_request_body_spec.rb
531
+ - spec/models/category_response_spec.rb
532
+ - spec/models/transaction_rule_update_request_body_spec.rb
533
+ - spec/models/enhance_transaction_response_spec.rb
534
+ - spec/models/tag_create_request_body_spec.rb
535
+ - spec/models/transaction_rule_create_request_body_spec.rb
536
+ - spec/models/o_auth_window_response_body_spec.rb
537
+ - spec/models/managed_transaction_create_request_spec.rb
538
538
  - spec/spec_helper.rb