ultracart_api 3.10.70 → 3.10.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88f249291871a874dd61ec3e8b99538d35c8ac532cfb9e90fe35ca5d4bef2d4
-  data.tar.gz: 1c4f98d9ec2ddc6c893cc2b476fcf0a0a43dac207cf469a393316485f4bef684
+  metadata.gz: a23cf90af37f343bfa79e47b903d3ba2bb171456e8f9b8bc6e2da4cb436806da
+  data.tar.gz: 6934ff83c022f9ab12072850e831ae87872138cc066cc8b6ab80a3c7b83debd5
 SHA512:
-  metadata.gz: 4e25306978125ee5e1f4b57d5d42b508d53f9cd636dfe18b0fb63bb0d87de9f852c00f726399c1fcf024a25ef0e950c07730e41469e3ab24e0b0aecbd8e11080
-  data.tar.gz: 53213c2cf7e48d1b77de06d3437f3cbb7dcaa0be779a1d02fc0f77709d75dac28026125a3270f508fc040bdcfb3838d0f19b9d043c36413d56cfe6f326540297
+  metadata.gz: d89fc6270427f74a77797c57e1f8262d29628c6647ffac2cd79583f1d467467d8e41bd7945c26990bbca4686f7a282282bc5a9f763622833ed575c06c1f3e755
+  data.tar.gz: 654c0c2e4dbe086109db9ad680a03a17e1f0af6c28c482bbc07a7ea68e1a8380c55caa9b1cc289c310d40d59c110040df4f46a0e3fcbc6ac19673f0740aa25b1

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.10.70
+- Package version: 3.10.72
 - 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.10.70.gem
+gem install ./ultracart_api-3.10.72.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.70.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.72.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.10.70'
+    gem 'ultracart_api', '~> 3.10.72'
 
 ### Install from Git
 
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
 *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
+*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
@@ -1224,6 +1225,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.72 | 11/30/2022 | order item - addl fields for linking kits to kit components |
+| 3.10.71 | 11/29/2022 | converstation marked convo read method |
 | 3.10.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
 | 3.10.69 | 11/21/2022 | conversation context method |
 | 3.10.68 | 11/21/2022 | adjusted conversation event model |

data/docs/ConversationApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
 [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
+[**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 
@@ -518,6 +519,55 @@ nil (empty response body)
 
 
 
+# **mark_read_conversation**
+> mark_read_conversation(conversation_uuid)
+
+Mark a conversation as read
+
+Mark a conversation as read 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Mark a conversation as read
+  api_instance.mark_read_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->mark_read_conversation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_uuid** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **start_conversation**
 > ConversationStartResponse start_conversation(start_request)
 

data/docs/ConversationMessage.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **body** | **String** |  | [optional] 
 **client_message_id** | **String** |  | [optional] 
 **conversation_message_uuid** | **String** |  | [optional] 
+**delay_until_dts** | **String** | Delay message transmission until date/time | [optional] 
 **media_urls** | **Array<String>** |  | [optional] 
 **merchant_id** | **String** |  | [optional] 
 **message_dts** | **String** | Message date/time | [optional] 

data/docs/OrderItem.md

@@ -25,6 +25,7 @@ Name | Type | Description | Notes
 **free_shipping** | **BOOLEAN** | True if the item receives free shipping | [optional] 
 **hazmat** | **BOOLEAN** | Hazardous materials indicator | [optional] 
 **height** | [**Distance**](Distance.md) |  | [optional] 
+**item_index** | **Integer** | Index of the item on the order (one based index) | [optional] 
 **item_reference_oid** | **Integer** | Item reference object identifier used to linked to auto order item record | [optional] 
 **kit** | **BOOLEAN** | True if this item is a kit | [optional] 
 **kit_component** | **BOOLEAN** | True if this item is a kit component | [optional] 
@@ -37,6 +38,8 @@ Name | Type | Description | Notes
 **no_shipping_discount** | **BOOLEAN** | True if this item is excluded from shipping discounts | [optional] 
 **options** | [**Array<OrderItemOption>**](OrderItemOption.md) | Options | [optional] 
 **packed_by_user** | **String** | Packed by user | [optional] 
+**parent_item_index** | **Integer** | If this item is a kit component, this is the item index of the parent item (kit) | [optional] 
+**parent_merchant_item_id** | **String** | If this item is a kit component, this is the item id of the parent item (kit) | [optional] 
 **perishable_class** | **String** | Perishable class of the item | [optional] 
 **pricing_tier_name** | **String** | Pricing tier that granted the particular price for this item if the customer profile had pricing tiers assigned | [optional] 
 **properties** | [**Array<OrderItemProperty>**](OrderItemProperty.md) | Properties | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -579,6 +579,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Mark a conversation as read
+    # Mark a conversation as read 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def mark_read_conversation(conversation_uuid, opts = {})
+      mark_read_conversation_with_http_info(conversation_uuid, opts)
+      nil
+    end
+
+    # Mark a conversation as read
+    # Mark a conversation as read 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Start a conversation
     # Start a new conversation 
     # @param start_request Start request

data/lib/ultracart_api/models/conversation_message.rb

@@ -24,6 +24,9 @@ module UltracartClient
 
     attr_accessor :conversation_message_uuid
 
+    # Delay message transmission until date/time
+    attr_accessor :delay_until_dts
+
     attr_accessor :media_urls
 
     attr_accessor :merchant_id
@@ -71,6 +74,7 @@ module UltracartClient
         :'body' => :'body',
         :'client_message_id' => :'client_message_id',
         :'conversation_message_uuid' => :'conversation_message_uuid',
+        :'delay_until_dts' => :'delay_until_dts',
         :'media_urls' => :'media_urls',
         :'merchant_id' => :'merchant_id',
         :'message_dts' => :'message_dts',
@@ -89,6 +93,7 @@ module UltracartClient
         :'body' => :'String',
         :'client_message_id' => :'String',
         :'conversation_message_uuid' => :'String',
+        :'delay_until_dts' => :'String',
         :'media_urls' => :'Array<String>',
         :'merchant_id' => :'String',
         :'message_dts' => :'String',
@@ -127,6 +132,10 @@ module UltracartClient
         self.conversation_message_uuid = attributes[:'conversation_message_uuid']
       end
 
+      if attributes.has_key?(:'delay_until_dts')
+        self.delay_until_dts = attributes[:'delay_until_dts']
+      end
+
       if attributes.has_key?(:'media_urls')
         if (value = attributes[:'media_urls']).is_a?(Array)
           self.media_urls = value
@@ -197,6 +206,7 @@ module UltracartClient
           body == o.body &&
           client_message_id == o.client_message_id &&
           conversation_message_uuid == o.conversation_message_uuid &&
+          delay_until_dts == o.delay_until_dts &&
           media_urls == o.media_urls &&
           merchant_id == o.merchant_id &&
           message_dts == o.message_dts &&
@@ -215,7 +225,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, media_urls, merchant_id, message_dts, message_epoch, transport_statuses, type, upload_keys].hash
+      [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, delay_until_dts, media_urls, merchant_id, message_dts, message_epoch, transport_statuses, type, upload_keys].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_item.rb

@@ -74,6 +74,9 @@ module UltracartClient
 
     attr_accessor :height
 
+    # Index of the item on the order (one based index)
+    attr_accessor :item_index
+
     # Item reference object identifier used to linked to auto order item record
     attr_accessor :item_reference_oid
 
@@ -109,6 +112,12 @@ module UltracartClient
     # Packed by user
     attr_accessor :packed_by_user
 
+    # If this item is a kit component, this is the item index of the parent item (kit)
+    attr_accessor :parent_item_index
+
+    # If this item is a kit component, this is the item id of the parent item (kit)
+    attr_accessor :parent_merchant_item_id
+
     # Perishable class of the item
     attr_accessor :perishable_class
 
@@ -216,6 +225,7 @@ module UltracartClient
         :'free_shipping' => :'free_shipping',
         :'hazmat' => :'hazmat',
         :'height' => :'height',
+        :'item_index' => :'item_index',
         :'item_reference_oid' => :'item_reference_oid',
         :'kit' => :'kit',
         :'kit_component' => :'kit_component',
@@ -228,6 +238,8 @@ module UltracartClient
         :'no_shipping_discount' => :'no_shipping_discount',
         :'options' => :'options',
         :'packed_by_user' => :'packed_by_user',
+        :'parent_item_index' => :'parent_item_index',
+        :'parent_merchant_item_id' => :'parent_merchant_item_id',
         :'perishable_class' => :'perishable_class',
         :'pricing_tier_name' => :'pricing_tier_name',
         :'properties' => :'properties',
@@ -278,6 +290,7 @@ module UltracartClient
         :'free_shipping' => :'BOOLEAN',
         :'hazmat' => :'BOOLEAN',
         :'height' => :'Distance',
+        :'item_index' => :'Integer',
         :'item_reference_oid' => :'Integer',
         :'kit' => :'BOOLEAN',
         :'kit_component' => :'BOOLEAN',
@@ -290,6 +303,8 @@ module UltracartClient
         :'no_shipping_discount' => :'BOOLEAN',
         :'options' => :'Array<OrderItemOption>',
         :'packed_by_user' => :'String',
+        :'parent_item_index' => :'Integer',
+        :'parent_merchant_item_id' => :'String',
         :'perishable_class' => :'String',
         :'pricing_tier_name' => :'String',
         :'properties' => :'Array<OrderItemProperty>',
@@ -413,6 +428,10 @@ module UltracartClient
         self.height = attributes[:'height']
       end
 
+      if attributes.has_key?(:'item_index')
+        self.item_index = attributes[:'item_index']
+      end
+
       if attributes.has_key?(:'item_reference_oid')
         self.item_reference_oid = attributes[:'item_reference_oid']
       end
@@ -463,6 +482,14 @@ module UltracartClient
         self.packed_by_user = attributes[:'packed_by_user']
       end
 
+      if attributes.has_key?(:'parent_item_index')
+        self.parent_item_index = attributes[:'parent_item_index']
+      end
+
+      if attributes.has_key?(:'parent_merchant_item_id')
+        self.parent_merchant_item_id = attributes[:'parent_merchant_item_id']
+      end
+
       if attributes.has_key?(:'perishable_class')
         self.perishable_class = attributes[:'perishable_class']
       end
@@ -576,6 +603,10 @@ module UltracartClient
         invalid_properties.push('invalid value for "merchant_item_id", the character length must be smaller than or equal to 20.')
       end
 
+      if !@parent_merchant_item_id.nil? && @parent_merchant_item_id.to_s.length > 20
+        invalid_properties.push('invalid value for "parent_merchant_item_id", the character length must be smaller than or equal to 20.')
+      end
+
       if !@perishable_class.nil? && @perishable_class.to_s.length > 50
         invalid_properties.push('invalid value for "perishable_class", the character length must be smaller than or equal to 50.')
       end
@@ -594,6 +625,7 @@ module UltracartClient
       return false if !@country_code_of_origin.nil? && @country_code_of_origin.to_s.length > 2
       return false if !@description.nil? && @description.to_s.length > 2000
       return false if !@merchant_item_id.nil? && @merchant_item_id.to_s.length > 20
+      return false if !@parent_merchant_item_id.nil? && @parent_merchant_item_id.to_s.length > 20
       return false if !@perishable_class.nil? && @perishable_class.to_s.length > 50
       return false if !@quickbooks_class.nil? && @quickbooks_class.to_s.length > 31
       tax_product_type_validator = EnumAttributeValidator.new('String', ['', 'digital', 'physical', 'service'])
@@ -641,6 +673,16 @@ module UltracartClient
       @merchant_item_id = merchant_item_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] parent_merchant_item_id Value to be assigned
+    def parent_merchant_item_id=(parent_merchant_item_id)
+      if !parent_merchant_item_id.nil? && parent_merchant_item_id.to_s.length > 20
+        fail ArgumentError, 'invalid value for "parent_merchant_item_id", the character length must be smaller than or equal to 20.'
+      end
+
+      @parent_merchant_item_id = parent_merchant_item_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] perishable_class Value to be assigned
     def perishable_class=(perishable_class)
@@ -698,6 +740,7 @@ module UltracartClient
           free_shipping == o.free_shipping &&
           hazmat == o.hazmat &&
           height == o.height &&
+          item_index == o.item_index &&
           item_reference_oid == o.item_reference_oid &&
           kit == o.kit &&
           kit_component == o.kit_component &&
@@ -710,6 +753,8 @@ module UltracartClient
           no_shipping_discount == o.no_shipping_discount &&
           options == o.options &&
           packed_by_user == o.packed_by_user &&
+          parent_item_index == o.parent_item_index &&
+          parent_merchant_item_id == o.parent_merchant_item_id &&
           perishable_class == o.perishable_class &&
           pricing_tier_name == o.pricing_tier_name &&
           properties == o.properties &&
@@ -743,7 +788,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
+      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.70
+  version: 3.10.72
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus