ultracart_api 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 973e1851cbd7dd1d0481726fd57f45fe46eab86d9e89543166aeaca494827159
-  data.tar.gz: 210b313bd8f49860508a69095f369c2ff050f1eb7312933479207eb8c29877a0
+  metadata.gz: 94efd609acdfdc97a1723452a7e90da9fc89b3f86ae5d02b8b48c706e969018c
+  data.tar.gz: 7412f2aa45760fad55ea1ff684488b3054ed0cc4e2a1b5d19e8bea83ebd5bcf8
 SHA512:
-  metadata.gz: 0224b0f76d1132f9873e8d36895c36b3cdc78602fac467c3f72517aaecca72d70d215e761a5d04b3bf3ed86b80cf7a8661186996a4b29c0dbd96051f33705137
-  data.tar.gz: bbdd9dfdf2136259e2a468752a1239d3a271fa59edb54ac61313b4650f5eaeeb05798549a0555ddbc6a4289906068d57f6848e10641963a9447582952d47c470
+  metadata.gz: 87b17f2a5b510b65647546cd87525be3840e6fb6564552c0629b5dfb696be2d89541eb669303d21bb4e55d400ad8ad850abc2190f4b9bce6a4a187f990235d90
+  data.tar.gz: fead47614254b4e61c3bd385a5c7c34553827cceec181ff91ef255b1dc78da3925b95629d3ed6fe7b3dbc440de4e60ee8830e88e23006460db12fe132ae554b5

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.3.1
+- Package version: 3.3.2
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.3.1.gem
+gem install ./ultracart_api-3.3.2.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.3.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.3.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.3.1'
+    gem 'ultracart_api', '~> 3.3.2'
 
 ### Install from Git
 
@@ -926,7 +926,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SelfConfig](docs/SelfConfig.md)
  - [UltracartClient::SimpleValue](docs/SimpleValue.md)
  - [UltracartClient::SingleSignOnAuthorizeRequest](docs/SingleSignOnAuthorizeRequest.md)
+ - [UltracartClient::SingleSignOnAuthorizeResponse](docs/SingleSignOnAuthorizeResponse.md)
  - [UltracartClient::SingleSignOnTokenRequest](docs/SingleSignOnTokenRequest.md)
+ - [UltracartClient::SingleSignOnTokenResponse](docs/SingleSignOnTokenResponse.md)
  - [UltracartClient::SovosConfig](docs/SovosConfig.md)
  - [UltracartClient::StateProvince](docs/StateProvince.md)
  - [UltracartClient::StepWaiting](docs/StepWaiting.md)
@@ -1044,6 +1046,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.3.2 | 07/16/2021 | sso bug fixes | 
 | 3.3.1 | 07/16/2021 | screen recording - event sub text used for assisting in UX rendering | 
 | 3.3.0 | 07/16/2021 | new endpoint SingleSignOn | 
 | 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs | 

data/docs/SingleSignOnAuthorizeResponse.md

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnAuthorizeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_dts** | **String** | Expiration date/time after which the single sign-on login operation will have timed out | [optional] 
+**login_url** | **String** | The URL that you should redirect the customer's browser to.  This URL will begin the login process. | [optional] 
+
+

data/docs/SingleSignOnTokenResponse.md

@@ -0,0 +1,10 @@
+# UltracartClient::SingleSignOnTokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_dts** | **String** | Expiration date/time after which time the key is no longer valid | [optional] 
+**ip_address** | **String** | IP address of the user which we recommend you lock the simple key's usage to. | [optional] 
+**simple_key** | **String** | The simple key that can then be used to make SDK calls on the users behalf. | [optional] 
+
+

data/docs/SsoApi.md

@@ -56,7 +56,7 @@ This endpoint does not need any parameter.
 
 
 # **sso_authorize**
-> ItemsResponse sso_authorize(authorization_request)
+> SingleSignOnAuthorizeResponse sso_authorize(authorization_request)
 
 Authorize a single sign on session
 
@@ -92,7 +92,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ItemsResponse**](ItemsResponse.md)
+[**SingleSignOnAuthorizeResponse**](SingleSignOnAuthorizeResponse.md)
 
 ### Authorization
 
@@ -150,7 +150,7 @@ nil (empty response body)
 
 
 # **sso_token**
-> ItemsResponse sso_token(token_request)
+> SingleSignOnTokenResponse sso_token(token_request)
 
 Exchange a single sign on code for a simple key token
 
@@ -186,7 +186,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ItemsResponse**](ItemsResponse.md)
+[**SingleSignOnTokenResponse**](SingleSignOnTokenResponse.md)
 
 ### Authorization
 

data/lib/ultracart_api.rb

@@ -546,7 +546,9 @@ require 'ultracart_api/models/screenshots_response'
 require 'ultracart_api/models/self_config'
 require 'ultracart_api/models/simple_value'
 require 'ultracart_api/models/single_sign_on_authorize_request'
+require 'ultracart_api/models/single_sign_on_authorize_response'
 require 'ultracart_api/models/single_sign_on_token_request'
+require 'ultracart_api/models/single_sign_on_token_response'
 require 'ultracart_api/models/sovos_config'
 require 'ultracart_api/models/state_province'
 require 'ultracart_api/models/step_waiting'

data/lib/ultracart_api/api/sso_api.rb

@@ -85,7 +85,7 @@ module UltracartClient
     # Starts the process of authorizing a single sign on session. 
     # @param authorization_request Authorization request
     # @param [Hash] opts the optional parameters
-    # @return [ItemsResponse]
+    # @return [SingleSignOnAuthorizeResponse]
     def sso_authorize(authorization_request, opts = {})
       data, _status_code, _headers = sso_authorize_with_http_info(authorization_request, opts)
       data
@@ -95,7 +95,7 @@ module UltracartClient
     # Starts the process of authorizing a single sign on session. 
     # @param authorization_request Authorization request
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ItemsResponse, Fixnum, Hash)>] ItemsResponse data, response status code and response headers
+    # @return [Array<(SingleSignOnAuthorizeResponse, Fixnum, Hash)>] SingleSignOnAuthorizeResponse data, response status code and response headers
     def sso_authorize_with_http_info(authorization_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SsoApi.sso_authorize ...'
@@ -130,7 +130,7 @@ module UltracartClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'ItemsResponse')
+        :return_type => 'SingleSignOnAuthorizeResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: SsoApi#sso_authorize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -188,7 +188,7 @@ module UltracartClient
     # Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with 
     # @param token_request Token request
     # @param [Hash] opts the optional parameters
-    # @return [ItemsResponse]
+    # @return [SingleSignOnTokenResponse]
     def sso_token(token_request, opts = {})
       data, _status_code, _headers = sso_token_with_http_info(token_request, opts)
       data
@@ -198,7 +198,7 @@ module UltracartClient
     # Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with 
     # @param token_request Token request
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ItemsResponse, Fixnum, Hash)>] ItemsResponse data, response status code and response headers
+    # @return [Array<(SingleSignOnTokenResponse, Fixnum, Hash)>] SingleSignOnTokenResponse data, response status code and response headers
     def sso_token_with_http_info(token_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SsoApi.sso_token ...'
@@ -233,7 +233,7 @@ module UltracartClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'ItemsResponse')
+        :return_type => 'SingleSignOnTokenResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: SsoApi#sso_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/ultracart_api/models/single_sign_on_authorize_response.rb

@@ -0,0 +1,195 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class SingleSignOnAuthorizeResponse
+    # Expiration date/time after which the single sign-on login operation will have timed out
+    attr_accessor :expiration_dts
+
+    # The URL that you should redirect the customer's browser to.  This URL will begin the login process.
+    attr_accessor :login_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expiration_dts' => :'expiration_dts',
+        :'login_url' => :'login_url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'expiration_dts' => :'String',
+        :'login_url' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.has_key?(:'login_url')
+        self.login_url = attributes[:'login_url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          expiration_dts == o.expiration_dts &&
+          login_url == o.login_url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [expiration_dts, login_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/single_sign_on_token_response.rb

@@ -0,0 +1,205 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class SingleSignOnTokenResponse
+    # Expiration date/time after which time the key is no longer valid
+    attr_accessor :expiration_dts
+
+    # IP address of the user which we recommend you lock the simple key's usage to.
+    attr_accessor :ip_address
+
+    # The simple key that can then be used to make SDK calls on the users behalf.
+    attr_accessor :simple_key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expiration_dts' => :'expiration_dts',
+        :'ip_address' => :'ip_address',
+        :'simple_key' => :'simple_key'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'expiration_dts' => :'String',
+        :'ip_address' => :'String',
+        :'simple_key' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.has_key?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.has_key?(:'simple_key')
+        self.simple_key = attributes[:'simple_key']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          expiration_dts == o.expiration_dts &&
+          ip_address == o.ip_address &&
+          simple_key == o.simple_key
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [expiration_dts, ip_address, simple_key].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.3.1'
+  VERSION = '3.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - UltraCart
@@ -741,7 +741,9 @@ files:
 - docs/SelfConfig.md
 - docs/SimpleValue.md
 - docs/SingleSignOnAuthorizeRequest.md
+- docs/SingleSignOnAuthorizeResponse.md
 - docs/SingleSignOnTokenRequest.md
+- docs/SingleSignOnTokenResponse.md
 - docs/SovosConfig.md
 - docs/SsoApi.md
 - docs/StateProvince.md
@@ -1352,7 +1354,9 @@ files:
 - lib/ultracart_api/models/self_config.rb
 - lib/ultracart_api/models/simple_value.rb
 - lib/ultracart_api/models/single_sign_on_authorize_request.rb
+- lib/ultracart_api/models/single_sign_on_authorize_response.rb
 - lib/ultracart_api/models/single_sign_on_token_request.rb
+- lib/ultracart_api/models/single_sign_on_token_response.rb
 - lib/ultracart_api/models/sovos_config.rb
 - lib/ultracart_api/models/state_province.rb
 - lib/ultracart_api/models/step_waiting.rb