mx-platform-ruby 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 633ac15d0a242e33d7a2e6e8e822d33dcf49604fbbdd3ede811655ae6d333221
-  data.tar.gz: 853e87b4bc16ae383ae138400cce437e4be86641b4d8d5f65d3bbc470f1baef4
+  metadata.gz: 7f44975b00f2bdf10c89ce33faa117c1ccf3d054b8dd2865bfbe7525022ba134
+  data.tar.gz: 3106281466bbd8b640045dd2591644e01c86657d70a8aa55caf141caa9ac3420
 SHA512:
-  metadata.gz: aa179190cf17c5c79eebc03fdbcfd6cd3077a25d61ca668f2306715ca6433dc9d215110e933af9a6a646953a3a854c11118e20ecedfb40da219223a7615ac99b
-  data.tar.gz: ca372ccfe3bd0937fe0cc3923ec8b04007abf750796707db7edcf003d4fa7196771f8eb3120339c404fd419ce07ae1076dafe17db8213bd150dd136d7093b3c0
+  metadata.gz: 2e8ba61ff2fa97d8d4b703c0b07d6e03c4315b3c82967759eff150ab083cec7b3e81eca1c06e5a38731a8dd4ef64382ce885caa01ed477d6f2057e288137097e
+  data.tar.gz: 48c7af2ffd3f9f68a2e14c7b72f69f3381dccfbec84cd89a7917d52ca2ab7e52204bb7abfba6dc50eb1cfb31a1a5e1f5df0385463fdb27a6586cbce1af81a407

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.9.2)
+    mx-platform-ruby (0.9.3)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -38,7 +38,7 @@ Please follow the [installation](#installation) procedure and then run the follo
 ```ruby
 require 'mx-platform-ruby'
 
-MxPlatformRuby.configure do |config|
+::MxPlatformRuby.configure do |config|
   # Configure with your Client ID/API Key from https://dashboard.mx.com
   config.username = 'Your Client ID'
   config.password = 'Your API Key'
@@ -51,16 +51,16 @@ api_client = ::MxPlatformRuby::ApiClient.new
 api_client.default_headers['Accept'] = 'application/vnd.mx.api.v1+json'
 mx_platform_api = ::MxPlatformRuby::MxPlatformApi.new(api_client)
 
-user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
-  user: MxPlatformRuby::UserCreateRequest.new(
-    metadata: "Creating a user!"
+request_body = ::MxPlatformRuby::UserCreateRequestBody.new(
+  user: ::MxPlatformRuby::UserCreateRequest.new(
+    metadata: 'Creating a user!'
   )
 )
 
 begin
-  result = mx_platform_api.create_user(user_create_request_body)
-  p result
-rescue MxPlatformRuby::ApiError => e
+  response = mx_platform_api.create_user(request_body)
+  p response
+rescue ::MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->create_user: #{e}"
 end
 ```

data/docs/MxPlatformApi.md

@@ -4368,7 +4368,7 @@ end
 
 ## read_default_category
 
-> <CategoryResponseBody> read_default_category(category_guid, user_guid)
+> <CategoryResponseBody> read_default_category(category_guid)
 
 Read a default category
 
@@ -4388,11 +4388,10 @@ end
 
 api_instance = MxPlatformRuby::MxPlatformApi.new
 category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
-user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
 
 begin
   # Read a default category
-  result = api_instance.read_default_category(category_guid, user_guid)
+  result = api_instance.read_default_category(category_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->read_default_category: #{e}"
@@ -4403,12 +4402,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid, user_guid)
+> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid)
 
 ```ruby
 begin
   # Read a default category
-  data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid, user_guid)
+  data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CategoryResponseBody>
@@ -4422,7 +4421,6 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **category_guid** | **String** | The unique id for a &#x60;category&#x60;. |  |
-| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
 
 ### Return type
 
@@ -5518,7 +5516,7 @@ end
 
 ## request_connect_widget_url
 
-> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, opts)
+> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)
 
 Request connect widget url
 
@@ -5538,13 +5536,11 @@ end
 
 api_instance = MxPlatformRuby::MxPlatformApi.new
 user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
-opts = {
-  connect_widget_request_body: MxPlatformRuby::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
-}
+connect_widget_request_body = MxPlatformRuby::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
 
 begin
   # Request connect widget url
-  result = api_instance.request_connect_widget_url(user_guid, opts)
+  result = api_instance.request_connect_widget_url(user_guid, connect_widget_request_body)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->request_connect_widget_url: #{e}"
@@ -5555,12 +5551,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ConnectWidgetResponseBody>, Integer, Hash)> request_connect_widget_url_with_http_info(user_guid, opts)
+> <Array(<ConnectWidgetResponseBody>, Integer, Hash)> request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body)
 
 ```ruby
 begin
   # Request connect widget url
-  data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid, opts)
+  data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ConnectWidgetResponseBody>
@@ -5574,7 +5570,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
-| **connect_widget_request_body** | [**ConnectWidgetRequestBody**](ConnectWidgetRequestBody.md) | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) | [optional] |
+| **connect_widget_request_body** | [**ConnectWidgetRequestBody**](ConnectWidgetRequestBody.md) | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) |  |
 
 ### Return type
 

data/lib/mx-platform-ruby/api/mx_platform_api.rb

@@ -4098,21 +4098,19 @@ module MxPlatformRuby
     # Read a default category
     # Use this endpoint to read the attributes of a default category.
     # @param category_guid [String] The unique id for a `category`.
-    # @param user_guid [String] The unique id for a `user`.
     # @param [Hash] opts the optional parameters
     # @return [CategoryResponseBody]
-    def read_default_category(category_guid, user_guid, opts = {})
-      data, _status_code, _headers = read_default_category_with_http_info(category_guid, user_guid, opts)
+    def read_default_category(category_guid, opts = {})
+      data, _status_code, _headers = read_default_category_with_http_info(category_guid, opts)
       data
     end
 
     # Read a default category
     # Use this endpoint to read the attributes of a default category.
     # @param category_guid [String] The unique id for a `category`.
-    # @param user_guid [String] The unique id for a `user`.
     # @param [Hash] opts the optional parameters
     # @return [Array<(CategoryResponseBody, Integer, Hash)>] CategoryResponseBody data, response status code and response headers
-    def read_default_category_with_http_info(category_guid, user_guid, opts = {})
+    def read_default_category_with_http_info(category_guid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_default_category ...'
       end
@@ -4120,12 +4118,8 @@ module MxPlatformRuby
       if @api_client.config.client_side_validation && category_guid.nil?
         fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_default_category"
       end
-      # verify the required parameter 'user_guid' is set
-      if @api_client.config.client_side_validation && user_guid.nil?
-        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_default_category"
-      end
       # resource path
-      local_var_path = '/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+      local_var_path = '/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -5196,21 +5190,21 @@ module MxPlatformRuby
     # Request connect widget url
     # This endpoint will return a URL for an embeddable version of MX Connect.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param connect_widget_request_body [ConnectWidgetRequestBody] Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
     # @param [Hash] opts the optional parameters
-    # @option opts [ConnectWidgetRequestBody] :connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
     # @return [ConnectWidgetResponseBody]
-    def request_connect_widget_url(user_guid, opts = {})
-      data, _status_code, _headers = request_connect_widget_url_with_http_info(user_guid, opts)
+    def request_connect_widget_url(user_guid, connect_widget_request_body, opts = {})
+      data, _status_code, _headers = request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body, opts)
       data
     end
 
     # Request connect widget url
     # This endpoint will return a URL for an embeddable version of MX Connect.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param connect_widget_request_body [ConnectWidgetRequestBody] Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
     # @param [Hash] opts the optional parameters
-    # @option opts [ConnectWidgetRequestBody] :connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
     # @return [Array<(ConnectWidgetResponseBody, Integer, Hash)>] ConnectWidgetResponseBody data, response status code and response headers
-    def request_connect_widget_url_with_http_info(user_guid, opts = {})
+    def request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_connect_widget_url ...'
       end
@@ -5218,6 +5212,10 @@ module MxPlatformRuby
       if @api_client.config.client_side_validation && user_guid.nil?
         fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.request_connect_widget_url"
       end
+      # verify the required parameter 'connect_widget_request_body' is set
+      if @api_client.config.client_side_validation && connect_widget_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'connect_widget_request_body' when calling MxPlatformApi.request_connect_widget_url"
+      end
       # resource path
       local_var_path = '/users/{user_guid}/connect_widget_url'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
 
@@ -5238,7 +5236,7 @@ module MxPlatformRuby
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'connect_widget_request_body'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(connect_widget_request_body)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ConnectWidgetResponseBody'

data/lib/mx-platform-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module MxPlatformRuby
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 end

data/openapi/config.yml

@@ -6,6 +6,6 @@ gemHomepage: https://github.com/mxenabled/mx-platform-ruby
 gemLicense: MIT
 gemName: mx-platform-ruby
 gemRequiredRubyVersion: ">= 2.6"
-gemVersion: 0.9.2
+gemVersion: 0.9.3
 library: faraday
 moduleName: MxPlatformRuby

data/openapi/templates/README.mustache

@@ -38,7 +38,7 @@ Please follow the [installation](#installation) procedure and then run the follo
 ```ruby
 require 'mx-platform-ruby'
 
-MxPlatformRuby.configure do |config|
+::MxPlatformRuby.configure do |config|
   # Configure with your Client ID/API Key from https://dashboard.mx.com
   config.username = 'Your Client ID'
   config.password = 'Your API Key'
@@ -51,16 +51,16 @@ api_client = ::MxPlatformRuby::ApiClient.new
 api_client.default_headers['Accept'] = 'application/vnd.mx.api.v1+json'
 mx_platform_api = ::MxPlatformRuby::MxPlatformApi.new(api_client)
 
-user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
-  user: MxPlatformRuby::UserCreateRequest.new(
-    metadata: "Creating a user!"
+request_body = ::MxPlatformRuby::UserCreateRequestBody.new(
+  user: ::MxPlatformRuby::UserCreateRequest.new(
+    metadata: 'Creating a user!'
   )
 )
 
 begin
-  result = mx_platform_api.create_user(user_create_request_body)
-  p result
-rescue MxPlatformRuby::ApiError => e
+  response = mx_platform_api.create_user(request_body)
+  p response
+rescue ::MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->create_user: #{e}"
 end
 ```

data/spec/api/mx_platform_api_spec.rb

@@ -835,7 +835,6 @@ describe 'MxPlatformApi' do
   # Read a default category
   # Use this endpoint to read the attributes of a default category.
   # @param category_guid The unique id for a `category`.
-  # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
   # @return [CategoryResponseBody]
   describe 'read_default_category test' do
@@ -1042,8 +1041,8 @@ describe 'MxPlatformApi' do
   # Request connect widget url
   # This endpoint will return a URL for an embeddable version of MX Connect.
   # @param user_guid The unique id for a `user`.
+  # @param connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
   # @param [Hash] opts the optional parameters
-  # @option opts [ConnectWidgetRequestBody] :connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
   # @return [ConnectWidgetResponseBody]
   describe 'request_connect_widget_url test' do
     it 'should work' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mx-platform-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - MX
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday