ultracart_api 3.10.185 → 3.10.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0bfed278660ff0931d314508f6b6fa073c94e8d6ce6f7697f2ed69e8020b3f4
-  data.tar.gz: 87f30fcdc5f037605e997e810f27ec6eb96d9b38ea133d94b4e9a76c3f9b7c17
+  metadata.gz: e17cdf0aa137f414487fec5c4da52010db9191af8fe8bde623fb046dab7201ca
+  data.tar.gz: 4c006506465353652a478aba76972ddb75014be2a4f8d732e4ec7bd84284cc0a
 SHA512:
-  metadata.gz: 49fe0ad10fdba32f328dc65af38162dc9b1443fc5e0cc550436e812f6658875d66fae3395dd629221c367aec77e28da5246f36471b5bb3bd5e85dd6ea99ab40b
-  data.tar.gz: 3e0ecb14a96afbef1d0fb3c98d23fe27f00632c6deb555708c0eb809abebbfa1caacef4f7438882474fec79aa7ca7109f1e0a9068a9dad186d16e251602309a9
+  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.185
+- 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.185.gem
+gem install ./ultracart_api-3.10.187.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.185.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.185'
+    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
@@ -556,6 +557,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::WebhookApi* | [**insert_webhook**](docs/WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook
 *UltracartClient::WebhookApi* | [**resend_event**](docs/WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint.
 *UltracartClient::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
+*UltracartClient::WorkflowApi* | [**get_workflow_agent_websocket_authorization**](docs/WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization
 *UltracartClient::WorkflowApi* | [**get_workflow_assignment_groups**](docs/WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
 *UltracartClient::WorkflowApi* | [**get_workflow_assignment_users**](docs/WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to
 *UltracartClient::WorkflowApi* | [**get_workflow_me**](docs/WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself
@@ -1393,6 +1395,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
  - [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
  - [UltracartClient::Weight](docs/Weight.md)
+ - [UltracartClient::WorkflowAgentAuth](docs/WorkflowAgentAuth.md)
+ - [UltracartClient::WorkflowAgentAuthResponse](docs/WorkflowAgentAuthResponse.md)
  - [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
  - [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
  - [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
@@ -1480,6 +1484,8 @@ 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 |
 | 3.10.183 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |

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/ConversationPbxQueue.md

@@ -21,5 +21,7 @@ Name | Type | Description | Notes
 **twilio_taskrouter_workflow_sid** | **String** | Twilio taskrouter workflow sid | [optional] 
 **twilio_workspace_queue_sid** | **String** | Twilio workspace queue sid | [optional] 
 **voicemail** | **BOOLEAN** | If true, this queue has a voicemail associated with it | [optional] 
+**wait_critical_seconds** | **Integer** | Wait time in seconds before critical | [optional] 
+**wait_warning_seconds** | **Integer** | Wait time in seconds before warning | [optional] 
 
 

data/docs/WorkflowAgentAuth.md

@@ -0,0 +1,10 @@
+# UltracartClient::WorkflowAgentAuth
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jwt** | **String** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**websocket_url** | **String** |  | [optional] 
+
+

data/docs/WorkflowAgentAuthResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::WorkflowAgentAuthResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_auth** | [**WorkflowAgentAuth**](WorkflowAgentAuth.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/WorkflowApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**get_workflow_agent_websocket_authorization**](WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization
 [**get_workflow_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
 [**get_workflow_assignment_users**](WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to
 [**get_workflow_me**](WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself
@@ -16,6 +17,51 @@ Method | HTTP request | Description
 [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task
 
 
+# **get_workflow_agent_websocket_authorization**
+> WorkflowAgentAuthResponse get_workflow_agent_websocket_authorization
+
+Get agent websocket authorization
+
+Retrieve a JWT to authorize an agent to make a websocket connection. 
+
+### 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::WorkflowApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get agent websocket authorization
+  result = api_instance.get_workflow_agent_websocket_authorization
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_agent_websocket_authorization: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkflowAgentAuthResponse**](WorkflowAgentAuthResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_workflow_assignment_groups**
 > WorkflowGroupsResponse get_workflow_assignment_groups(opts)
 

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/api/workflow_api.rb

@@ -32,6 +32,55 @@ module UltracartClient
       UltracartClient::WorkflowApi.new(api_client)
     end
 
+    # Get agent websocket authorization
+    # Retrieve a JWT to authorize an agent to make a websocket connection. 
+    # @param [Hash] opts the optional parameters
+    # @return [WorkflowAgentAuthResponse]
+    def get_workflow_agent_websocket_authorization(opts = {})
+      data, _status_code, _headers = get_workflow_agent_websocket_authorization_with_http_info(opts)
+      data
+    end
+
+    # Get agent websocket authorization
+    # Retrieve a JWT to authorize an agent to make a websocket connection. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WorkflowAgentAuthResponse, Fixnum, Hash)>] WorkflowAgentAuthResponse data, response status code and response headers
+    def get_workflow_agent_websocket_authorization_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_agent_websocket_authorization ...'
+      end
+      # resource path
+      local_var_path = '/workflow/agent/auth'
+
+      # 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,
+        :return_type => 'WorkflowAgentAuthResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve a list of groups that workflow tasks can be assigned to
     # Retrieve a list of groups that workflow tasks can be assigned to 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/conversation_pbx_queue.rb

@@ -67,6 +67,12 @@ module UltracartClient
     # If true, this queue has a voicemail associated with it
     attr_accessor :voicemail
 
+    # Wait time in seconds before critical
+    attr_accessor :wait_critical_seconds
+
+    # Wait time in seconds before warning
+    attr_accessor :wait_warning_seconds
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -87,7 +93,9 @@ module UltracartClient
         :'say_voice' => :'say_voice',
         :'twilio_taskrouter_workflow_sid' => :'twilio_taskrouter_workflow_sid',
         :'twilio_workspace_queue_sid' => :'twilio_workspace_queue_sid',
-        :'voicemail' => :'voicemail'
+        :'voicemail' => :'voicemail',
+        :'wait_critical_seconds' => :'wait_critical_seconds',
+        :'wait_warning_seconds' => :'wait_warning_seconds'
       }
     end
 
@@ -111,7 +119,9 @@ module UltracartClient
         :'say_voice' => :'String',
         :'twilio_taskrouter_workflow_sid' => :'String',
         :'twilio_workspace_queue_sid' => :'String',
-        :'voicemail' => :'BOOLEAN'
+        :'voicemail' => :'BOOLEAN',
+        :'wait_critical_seconds' => :'Integer',
+        :'wait_warning_seconds' => :'Integer'
       }
     end
 
@@ -194,6 +204,14 @@ module UltracartClient
       if attributes.has_key?(:'voicemail')
         self.voicemail = attributes[:'voicemail']
       end
+
+      if attributes.has_key?(:'wait_critical_seconds')
+        self.wait_critical_seconds = attributes[:'wait_critical_seconds']
+      end
+
+      if attributes.has_key?(:'wait_warning_seconds')
+        self.wait_warning_seconds = attributes[:'wait_warning_seconds']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -381,7 +399,9 @@ module UltracartClient
           say_voice == o.say_voice &&
           twilio_taskrouter_workflow_sid == o.twilio_taskrouter_workflow_sid &&
           twilio_workspace_queue_sid == o.twilio_workspace_queue_sid &&
-          voicemail == o.voicemail
+          voicemail == o.voicemail &&
+          wait_critical_seconds == o.wait_critical_seconds &&
+          wait_warning_seconds == o.wait_warning_seconds
     end
 
     # @see the `==` method
@@ -393,7 +413,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [announce_queue_position, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail].hash
+      [announce_queue_position, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/workflow_agent_auth.rb

@@ -0,0 +1,202 @@
+=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 WorkflowAgentAuth
+    attr_accessor :jwt
+
+    attr_accessor :merchant_id
+
+    attr_accessor :websocket_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'jwt' => :'jwt',
+        :'merchant_id' => :'merchant_id',
+        :'websocket_url' => :'websocket_url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'jwt' => :'String',
+        :'merchant_id' => :'String',
+        :'websocket_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?(:'jwt')
+        self.jwt = attributes[:'jwt']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'websocket_url')
+        self.websocket_url = attributes[:'websocket_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 &&
+          jwt == o.jwt &&
+          merchant_id == o.merchant_id &&
+          websocket_url == o.websocket_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
+      [jwt, merchant_id, websocket_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/workflow_agent_auth_response.rb

@@ -0,0 +1,221 @@
+=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 WorkflowAgentAuthResponse
+    attr_accessor :agent_auth
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'agent_auth' => :'agent_auth',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'agent_auth' => :'WorkflowAgentAuth',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    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?(:'agent_auth')
+        self.agent_auth = attributes[:'agent_auth']
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          agent_auth == o.agent_auth &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [agent_auth, error, metadata, success, warning].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/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.185'
+  VERSION = '3.10.187'
 end

data/lib/ultracart_api.rb

@@ -840,6 +840,8 @@ require 'ultracart_api/models/webhook_sample_request'
 require 'ultracart_api/models/webhook_sample_request_response'
 require 'ultracart_api/models/webhooks_response'
 require 'ultracart_api/models/weight'
+require 'ultracart_api/models/workflow_agent_auth'
+require 'ultracart_api/models/workflow_agent_auth_response'
 require 'ultracart_api/models/workflow_attachment'
 require 'ultracart_api/models/workflow_attachment_upload_url'
 require 'ultracart_api/models/workflow_attachment_upload_url_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.185
+  version: 3.10.187
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1064,6 +1064,8 @@ files:
 - docs/WebhookSampleRequestResponse.md
 - docs/WebhooksResponse.md
 - docs/Weight.md
+- docs/WorkflowAgentAuth.md
+- docs/WorkflowAgentAuthResponse.md
 - docs/WorkflowApi.md
 - docs/WorkflowAttachment.md
 - docs/WorkflowAttachmentUploadUrl.md
@@ -1929,6 +1931,8 @@ files:
 - lib/ultracart_api/models/webhook_sample_request_response.rb
 - lib/ultracart_api/models/webhooks_response.rb
 - lib/ultracart_api/models/weight.rb
+- lib/ultracart_api/models/workflow_agent_auth.rb
+- lib/ultracart_api/models/workflow_agent_auth_response.rb
 - lib/ultracart_api/models/workflow_attachment.rb
 - lib/ultracart_api/models/workflow_attachment_upload_url.rb
 - lib/ultracart_api/models/workflow_attachment_upload_url_response.rb