ultracart_api 3.10.186 → 3.10.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5909f9761add65b9835d930b3e3a1b73b8539a0f29f8111990896670f7eee7bf
-  data.tar.gz: 939cfe3ad130345fb726accbe3aeb4a72329a9832fed83bb9ce3aa9c8d7d512d
+  metadata.gz: e17cdf0aa137f414487fec5c4da52010db9191af8fe8bde623fb046dab7201ca
+  data.tar.gz: 4c006506465353652a478aba76972ddb75014be2a4f8d732e4ec7bd84284cc0a
 SHA512:
-  metadata.gz: 275c21d6f2303773ff1d94c3623c625c073fb536e7f5595a520b0e7244c0f1d601354173268e5d616ca93b0913c6842df755f327b32d9d68107d5bd4f05b0321
-  data.tar.gz: d59f6f1af8df53cebaefb52e3ef6e0a1aaf431136f48a0f11b29ab7942402a47a6b15c337bb858b1d5ab8da27c98fef2cd9a37eb0696b5bcde57946a2fd8eecb
+  metadata.gz: '00488bd9b47fec1d11db5447f1c28d9aa7ca2aac01dc983cfcae5e2f8588d165d8e9d245bab308408979037c3984a2e904d3f89afe4b54955f275b2137fcbf4b'
+  data.tar.gz: 81127e64bdff43f2852c9bed27461702e1bd4683e26edb651469028057860a666399098b8ea21900ce10552c9a61df1a486f7c2116c6df599c153a329275ef80

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.186
+- Package version: 3.10.187
 - 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.186.gem
+gem install ./ultracart_api-3.10.187.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.186.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.187.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.186'
+    gem 'ultracart_api', '~> 3.10.187'
 
 ### Install from Git
 
@@ -193,6 +193,7 @@ Class | Method | HTTP request | Description
 *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* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
 *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 *UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
@@ -1483,6 +1484,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.187 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
 | 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |
 | 3.10.184 | 02/27/2024 | esp - sms statistic layer |

data/docs/ConversationApi.md

@@ -65,6 +65,7 @@ Method | HTTP request | Description
 [**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
+[**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
 [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
@@ -3058,6 +3059,55 @@ nil (empty response body)
 
 
 
+# **reset_conversation_pbx_queue_statistics**
+> reset_conversation_pbx_queue_statistics(queue_uuid)
+
+reset statistics within the queue
+
+reset statistics within the queue 
+
+### 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)
+
+
+queue_uuid = 'queue_uuid_example' # String | 
+
+
+begin
+  #reset statistics within the queue
+  api_instance.reset_conversation_pbx_queue_statistics(queue_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->reset_conversation_pbx_queue_statistics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **queue_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
+
+
+
 # **search_conversation_canned_messages**
 > ConversationCannedMessagesResponse search_conversation_canned_messages(search_request)
 

data/docs/WorkflowTask.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional] 
 **dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional] 
 **due_dts** | **String** | Date/time that the workflow task is due | [optional] 
+**expiration_dts** | **String** | Date/time that the workflow task will expire and be closed.  This is set by system generated tasks. | [optional] 
 **histories** | [**Array<WorkflowTaskHistory>**](WorkflowTaskHistory.md) | Array of history records for the task | [optional] 
 **last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional] 
 **merchant_id** | **String** | Merchant ID | [optional] 
@@ -25,6 +26,7 @@ Name | Type | Description | Notes
 **properties** | [**Array<Property>**](Property.md) | Properties | [optional] 
 **related_workflow_task_uuid** | **String** | Related Workflow Task UUID | [optional] 
 **status** | **String** | Status of the workflow task | [optional] 
+**system_task_type** | **String** | Constant for the type of system generated task | [optional] 
 **tags** | **Array<String>** | Tags | [optional] 
 **task_context** | **String** | User friendly string of the task context | [optional] 
 **task_details** | **String** | Task Details | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -3292,6 +3292,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # reset statistics within the queue
+    # reset statistics within the queue 
+    # @param queue_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def reset_conversation_pbx_queue_statistics(queue_uuid, opts = {})
+      reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts)
+      nil
+    end
+
+    # reset statistics within the queue
+    # reset statistics within the queue 
+    # @param queue_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.reset_conversation_pbx_queue_statistics ...'
+      end
+      # verify the required parameter 'queue_uuid' is set
+      if @api_client.config.client_side_validation && queue_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.reset_conversation_pbx_queue_statistics"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/queues/{queue_uuid}/reset_statistics'.sub('{' + 'queue_uuid' + '}', queue_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(:POST, 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#reset_conversation_pbx_queue_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Search for canned messages by short_code
     # Search for canned messages by short_code 
     # @param search_request Search request

data/lib/ultracart_api/models/workflow_task.rb

@@ -43,6 +43,9 @@ module UltracartClient
     # Date/time that the workflow task is due
     attr_accessor :due_dts
 
+    # Date/time that the workflow task will expire and be closed.  This is set by system generated tasks.
+    attr_accessor :expiration_dts
+
     # Array of history records for the task
     attr_accessor :histories
 
@@ -79,6 +82,9 @@ module UltracartClient
     # Status of the workflow task
     attr_accessor :status
 
+    # Constant for the type of system generated task
+    attr_accessor :system_task_type
+
     # Tags
     attr_accessor :tags
 
@@ -129,6 +135,7 @@ module UltracartClient
         :'delay_until_dts' => :'delay_until_dts',
         :'dependant_workflow_task_uuid' => :'dependant_workflow_task_uuid',
         :'due_dts' => :'due_dts',
+        :'expiration_dts' => :'expiration_dts',
         :'histories' => :'histories',
         :'last_update_dts' => :'last_update_dts',
         :'merchant_id' => :'merchant_id',
@@ -141,6 +148,7 @@ module UltracartClient
         :'properties' => :'properties',
         :'related_workflow_task_uuid' => :'related_workflow_task_uuid',
         :'status' => :'status',
+        :'system_task_type' => :'system_task_type',
         :'tags' => :'tags',
         :'task_context' => :'task_context',
         :'task_details' => :'task_details',
@@ -162,6 +170,7 @@ module UltracartClient
         :'delay_until_dts' => :'String',
         :'dependant_workflow_task_uuid' => :'String',
         :'due_dts' => :'String',
+        :'expiration_dts' => :'String',
         :'histories' => :'Array<WorkflowTaskHistory>',
         :'last_update_dts' => :'String',
         :'merchant_id' => :'String',
@@ -174,6 +183,7 @@ module UltracartClient
         :'properties' => :'Array<Property>',
         :'related_workflow_task_uuid' => :'String',
         :'status' => :'String',
+        :'system_task_type' => :'String',
         :'tags' => :'Array<String>',
         :'task_context' => :'String',
         :'task_details' => :'String',
@@ -232,6 +242,10 @@ module UltracartClient
         self.due_dts = attributes[:'due_dts']
       end
 
+      if attributes.has_key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
       if attributes.has_key?(:'histories')
         if (value = attributes[:'histories']).is_a?(Array)
           self.histories = value
@@ -286,6 +300,10 @@ module UltracartClient
         self.status = attributes[:'status']
       end
 
+      if attributes.has_key?(:'system_task_type')
+        self.system_task_type = attributes[:'system_task_type']
+      end
+
       if attributes.has_key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -323,8 +341,10 @@ module UltracartClient
       return false unless object_type_validator.valid?(@object_type)
       priority_validator = EnumAttributeValidator.new('String', ['1 - low', '2 - medium', '3 - high', '4 - critical'])
       return false unless priority_validator.valid?(@priority)
-      status_validator = EnumAttributeValidator.new('String', ['open', 'closed', 'delayed', 'awaiting customer feedback'])
+      status_validator = EnumAttributeValidator.new('String', ['open', 'closed', 'delayed', 'awaiting customer feedback', 'closed - system', 'closed - customer', 'closed - expiration'])
       return false unless status_validator.valid?(@status)
+      system_task_type_validator = EnumAttributeValidator.new('String', ['order_accounts_receivable', 'order_fraud_review', 'auto_order_card_update_issue', 'auto_order_canceled_payment', 'item_low_stock', 'item_out_of_stock'])
+      return false unless system_task_type_validator.valid?(@system_task_type)
       true
     end
 
@@ -351,13 +371,23 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ['open', 'closed', 'delayed', 'awaiting customer feedback'])
+      validator = EnumAttributeValidator.new('String', ['open', 'closed', 'delayed', 'awaiting customer feedback', 'closed - system', 'closed - customer', 'closed - expiration'])
       unless validator.valid?(status)
         fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
       end
       @status = status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] system_task_type Object to be assigned
+    def system_task_type=(system_task_type)
+      validator = EnumAttributeValidator.new('String', ['order_accounts_receivable', 'order_fraud_review', 'auto_order_card_update_issue', 'auto_order_canceled_payment', 'item_low_stock', 'item_out_of_stock'])
+      unless validator.valid?(system_task_type)
+        fail ArgumentError, 'invalid value for "system_task_type", must be one of #{validator.allowable_values}.'
+      end
+      @system_task_type = system_task_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -373,6 +403,7 @@ module UltracartClient
           delay_until_dts == o.delay_until_dts &&
           dependant_workflow_task_uuid == o.dependant_workflow_task_uuid &&
           due_dts == o.due_dts &&
+          expiration_dts == o.expiration_dts &&
           histories == o.histories &&
           last_update_dts == o.last_update_dts &&
           merchant_id == o.merchant_id &&
@@ -385,6 +416,7 @@ module UltracartClient
           properties == o.properties &&
           related_workflow_task_uuid == o.related_workflow_task_uuid &&
           status == o.status &&
+          system_task_type == o.system_task_type &&
           tags == o.tags &&
           task_context == o.task_context &&
           task_details == o.task_details &&
@@ -401,7 +433,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [assigned_to_group, assigned_to_group_id, assigned_to_user, assigned_to_user_id, attachments, created_by, created_dts, delay_until_dts, dependant_workflow_task_uuid, due_dts, histories, last_update_dts, merchant_id, notes, object_email, object_id, object_type, object_url, priority, properties, related_workflow_task_uuid, status, tags, task_context, task_details, task_name, workflow_task_uuid].hash
+      [assigned_to_group, assigned_to_group_id, assigned_to_user, assigned_to_user_id, attachments, created_by, created_dts, delay_until_dts, dependant_workflow_task_uuid, due_dts, expiration_dts, histories, last_update_dts, merchant_id, notes, object_email, object_id, object_type, object_url, priority, properties, related_workflow_task_uuid, status, system_task_type, tags, task_context, task_details, task_name, workflow_task_uuid].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.186'
+  VERSION = '3.10.187'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.186
+  version: 3.10.187
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus