ultracart_api 4.0.115.rc → 4.0.117.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d222cbdae0a4ea79d240f39620be43af619e1d18f22f3d67106d50c1f3234ebe
-  data.tar.gz: a317a87f132d99400196a4b55f9491b69bed11a7061d110c6c03621b570ec3e8
+  metadata.gz: a76099b585a593b8878572d15fedb9d7628c3e5e129136167bd536bb601fbfb7
+  data.tar.gz: 780f074334867f4b1c212f6b317add8d381f16c9b5ebbb75351c224f837df2ba
 SHA512:
-  metadata.gz: f7d1b55bcf90203f0618e57dc30fa8427548b6c63b3f877c7ff34ecdcae74ee032263b34a6cf933694a76ba4cbdcb39b993cbab419e47f1fd8ac9ed5f15b3f9c
-  data.tar.gz: 6573dd3e477530a83ed04185432536075d29dcf2464cd6185145fc5ff4d52652341142278d948ec22595821d27e1bc91f68b5708e68d2e0dd06170f74eb6f116
+  metadata.gz: 7365898eb84fce7f804900ca6847b48e5106c64930765d4eca56e021bdf0f7b5c4fb702ebe870e61a9f78073601bf5bc70379959fe2f5eccd7191a8b5015934c
+  data.tar.gz: c31c91d3950309a41e16e62046c136458b19c2401cac752d166963837b8447cdc09d28580cf3090578eec085f60c202903ce34b5e9f0776e0bf85879464c9832

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.115.rc
+- Package version: 4.0.117.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.115.rc.gem
+gem install ./ultracart_api-4.0.117.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.115.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.117.rc.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', '~> 4.0.115.rc'
+    gem 'ultracart_api', '~> 4.0.117.rc'
 
 ### Install from Git
 
@@ -625,6 +625,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
  - [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
  - [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
+ - [UltracartClient::ConversationDepartmentMember](docs/ConversationDepartmentMember.md)
  - [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
  - [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
  - [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
@@ -1290,6 +1291,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.117-RC | 01/18/2023 | conversation dept members |
+| 4.0.116-RC | 01/18/2023 | channel partner ship to pref desc field |
 | 4.0.115-RC | 01/17/2023 | changed convo webchat constant |
 | 4.0.114-RC | 01/17/2023 | support for checkout item properties |
 | 4.0.113-RC | 01/14/2023 | add external_id to the point of sale location object |

data/docs/ChannelPartnerShipToPreference.md

@@ -7,6 +7,7 @@
 | **additional_kit_component_item_ids** | **Array<String>** | Additional item ids to add as kit components to the order with a zero price. | [optional] |
 | **channel_partner_oid** | **Integer** | The channel partner object identifier this preference is associated with | [optional] |
 | **channel_partner_ship_to_preference_oid** | **Integer** | Object identifier for the ship to preference | [optional] |
+| **description** | **String** | A description that is meaningful to the merchant. | [optional] |
 | **merchant_id** | **String** | The merchant id that owns the channel partner | [optional] |
 | **return_policy** | **String** | Alternate return policy to print on the packing slip. | [optional] |
 | **ship_to_edi_code** | **String** | The ship to EDI code that the preferences are for | [optional] |
@@ -20,6 +21,7 @@ instance = UltracartClient::ChannelPartnerShipToPreference.new(
   additional_kit_component_item_ids: null,
   channel_partner_oid: null,
   channel_partner_ship_to_preference_oid: null,
+  description: null,
   merchant_id: null,
   return_policy: null,
   ship_to_edi_code: null

data/docs/ConversationDepartment.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **conversation_department_oid** | **Integer** |  | [optional] |
 | **department_name** | **String** |  | [optional] |
+| **members** | [**Array<ConversationDepartmentMember>**](ConversationDepartmentMember.md) |  | [optional] |
 | **merchant_id** | **String** |  | [optional] |
 | **settings** | **Object** |  | [optional] |
 
@@ -17,6 +18,7 @@ require 'ultracart_api'
 instance = UltracartClient::ConversationDepartment.new(
   conversation_department_oid: null,
   department_name: null,
+  members: null,
   merchant_id: null,
   settings: null
 )

data/docs/ConversationDepartmentMember.md

@@ -0,0 +1,22 @@
+# UltracartClient::ConversationDepartmentMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member** | **Boolean** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **user_id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationDepartmentMember.new(
+  member: null,
+  name: null,
+  user_id: null
+)
+```
+

data/docs/ConversationDepartmentsResponse.md

@@ -7,6 +7,7 @@
 | **conversation_departments** | [**Array<ConversationDepartment>**](ConversationDepartment.md) |  | [optional] |
 | **error** | [**Error**](Error.md) |  | [optional] |
 | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **read_only** | **Boolean** |  | [optional] |
 | **success** | **Boolean** | Indicates if API call was successful | [optional] |
 | **warning** | [**Warning**](Warning.md) |  | [optional] |
 
@@ -19,6 +20,7 @@ instance = UltracartClient::ConversationDepartmentsResponse.new(
   conversation_departments: null,
   error: null,
   metadata: null,
+  read_only: null,
   success: null,
   warning: null
 )

data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # Object identifier for the ship to preference
     attr_accessor :channel_partner_ship_to_preference_oid
 
+    # A description that is meaningful to the merchant.
+    attr_accessor :description
+
     # The merchant id that owns the channel partner
     attr_accessor :merchant_id
 
@@ -39,6 +42,7 @@ module UltracartClient
         :'additional_kit_component_item_ids' => :'additional_kit_component_item_ids',
         :'channel_partner_oid' => :'channel_partner_oid',
         :'channel_partner_ship_to_preference_oid' => :'channel_partner_ship_to_preference_oid',
+        :'description' => :'description',
         :'merchant_id' => :'merchant_id',
         :'return_policy' => :'return_policy',
         :'ship_to_edi_code' => :'ship_to_edi_code'
@@ -56,6 +60,7 @@ module UltracartClient
         :'additional_kit_component_item_ids' => :'Array<String>',
         :'channel_partner_oid' => :'Integer',
         :'channel_partner_ship_to_preference_oid' => :'Integer',
+        :'description' => :'String',
         :'merchant_id' => :'String',
         :'return_policy' => :'String',
         :'ship_to_edi_code' => :'String'
@@ -97,6 +102,10 @@ module UltracartClient
         self.channel_partner_ship_to_preference_oid = attributes[:'channel_partner_ship_to_preference_oid']
       end
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -114,15 +123,30 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@description.nil? && @description.to_s.length > 100
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.')
+      end
+
       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?
+      return false if !@description.nil? && @description.to_s.length > 100
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 100
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 100.'
+      end
+
+      @description = description
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -131,6 +155,7 @@ module UltracartClient
           additional_kit_component_item_ids == o.additional_kit_component_item_ids &&
           channel_partner_oid == o.channel_partner_oid &&
           channel_partner_ship_to_preference_oid == o.channel_partner_ship_to_preference_oid &&
+          description == o.description &&
           merchant_id == o.merchant_id &&
           return_policy == o.return_policy &&
           ship_to_edi_code == o.ship_to_edi_code
@@ -145,7 +170,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [additional_kit_component_item_ids, channel_partner_oid, channel_partner_ship_to_preference_oid, merchant_id, return_policy, ship_to_edi_code].hash
+      [additional_kit_component_item_ids, channel_partner_oid, channel_partner_ship_to_preference_oid, description, merchant_id, return_policy, ship_to_edi_code].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_department.rb

@@ -19,6 +19,8 @@ module UltracartClient
 
     attr_accessor :department_name
 
+    attr_accessor :members
+
     attr_accessor :merchant_id
 
     attr_accessor :settings
@@ -28,6 +30,7 @@ module UltracartClient
       {
         :'conversation_department_oid' => :'conversation_department_oid',
         :'department_name' => :'department_name',
+        :'members' => :'members',
         :'merchant_id' => :'merchant_id',
         :'settings' => :'settings'
       }
@@ -43,6 +46,7 @@ module UltracartClient
       {
         :'conversation_department_oid' => :'Integer',
         :'department_name' => :'String',
+        :'members' => :'Array<ConversationDepartmentMember>',
         :'merchant_id' => :'String',
         :'settings' => :'Object'
       }
@@ -77,6 +81,12 @@ module UltracartClient
         self.department_name = attributes[:'department_name']
       end
 
+      if attributes.key?(:'members')
+        if (value = attributes[:'members']).is_a?(Array)
+          self.members = value
+        end
+      end
+
       if attributes.key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -106,6 +116,7 @@ module UltracartClient
       self.class == o.class &&
           conversation_department_oid == o.conversation_department_oid &&
           department_name == o.department_name &&
+          members == o.members &&
           merchant_id == o.merchant_id &&
           settings == o.settings
     end
@@ -119,7 +130,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [conversation_department_oid, department_name, merchant_id, settings].hash
+      [conversation_department_oid, department_name, members, merchant_id, settings].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_department_member.rb

@@ -0,0 +1,237 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationDepartmentMember
+    attr_accessor :member
+
+    attr_accessor :name
+
+    attr_accessor :user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'member' => :'member',
+        :'name' => :'name',
+        :'user_id' => :'user_id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'member' => :'Boolean',
+        :'name' => :'String',
+        :'user_id' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationDepartmentMember` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationDepartmentMember`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'member')
+        self.member = attributes[:'member']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      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 &&
+          member == o.member &&
+          name == o.name &&
+          user_id == o.user_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [member, name, user_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/conversation_departments_response.rb

@@ -21,6 +21,8 @@ module UltracartClient
 
     attr_accessor :metadata
 
+    attr_accessor :read_only
+
     # Indicates if API call was successful
     attr_accessor :success
 
@@ -32,6 +34,7 @@ module UltracartClient
         :'conversation_departments' => :'conversation_departments',
         :'error' => :'error',
         :'metadata' => :'metadata',
+        :'read_only' => :'read_only',
         :'success' => :'success',
         :'warning' => :'warning'
       }
@@ -48,6 +51,7 @@ module UltracartClient
         :'conversation_departments' => :'Array<ConversationDepartment>',
         :'error' => :'Error',
         :'metadata' => :'ResponseMetadata',
+        :'read_only' => :'Boolean',
         :'success' => :'Boolean',
         :'warning' => :'Warning'
       }
@@ -88,6 +92,10 @@ module UltracartClient
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.key?(:'read_only')
+        self.read_only = attributes[:'read_only']
+      end
+
       if attributes.key?(:'success')
         self.success = attributes[:'success']
       end
@@ -118,6 +126,7 @@ module UltracartClient
           conversation_departments == o.conversation_departments &&
           error == o.error &&
           metadata == o.metadata &&
+          read_only == o.read_only &&
           success == o.success &&
           warning == o.warning
     end
@@ -131,7 +140,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [conversation_departments, error, metadata, success, warning].hash
+      [conversation_departments, error, metadata, read_only, success, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.115.rc'
+  VERSION = '4.0.117.rc'
 end

data/lib/ultracart_api.rb

@@ -151,6 +151,7 @@ require 'ultracart_api/models/conversation_canned_message_response'
 require 'ultracart_api/models/conversation_canned_messages_response'
 require 'ultracart_api/models/conversation_canned_messages_search'
 require 'ultracart_api/models/conversation_department'
+require 'ultracart_api/models/conversation_department_member'
 require 'ultracart_api/models/conversation_department_response'
 require 'ultracart_api/models/conversation_departments_response'
 require 'ultracart_api/models/conversation_engagement'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.115.rc
+  version: 4.0.117.rc
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -201,6 +201,7 @@ files:
 - docs/ConversationCannedMessagesResponse.md
 - docs/ConversationCannedMessagesSearch.md
 - docs/ConversationDepartment.md
+- docs/ConversationDepartmentMember.md
 - docs/ConversationDepartmentResponse.md
 - docs/ConversationDepartmentsResponse.md
 - docs/ConversationEngagement.md
@@ -964,6 +965,7 @@ files:
 - lib/ultracart_api/models/conversation_canned_messages_response.rb
 - lib/ultracart_api/models/conversation_canned_messages_search.rb
 - lib/ultracart_api/models/conversation_department.rb
+- lib/ultracart_api/models/conversation_department_member.rb
 - lib/ultracart_api/models/conversation_department_response.rb
 - lib/ultracart_api/models/conversation_departments_response.rb
 - lib/ultracart_api/models/conversation_engagement.rb