ultracart_api 4.0.203 → 4.0.204

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2741f3ab5cd18a9833cadc8808fba3d863b042f81b7f5c681c838691c53239c6
-  data.tar.gz: b0ef5867ded4987ffd1df0286c5a33f21e1396c39444877a14b1bcb1e954140c
+  metadata.gz: cdcbb03fdcded697195997c256609bdb9d663f40b6f9df73b2d414d25596491d
+  data.tar.gz: '09c586cf32123cd87bfac438ca903c0f2d8e0cd3da4e2aa9a82d1c0c689fada2'
 SHA512:
-  metadata.gz: 907343341ebb75dbf1292d6833886ba79d0340c23fcebfb0011595c9c2cc87689852e5367721de2604d160834f83b11b94a9c8f7421009c71d84038d0496e57b
-  data.tar.gz: 9a49b85125ae2377508cdcc2627bdf74191d91998ce2dab74f5fa4e1b62c3444817d2b048db46abf7ac275a616b0b9f7682fbc547ea19c119c8cf0c4db027ca1
+  metadata.gz: 28dc158ef75f566e72e87a7b754c7275575eb5f196d4069b12df18903806870ecc4c65ec11f47ecea437551507f62d4f99e5776fb022ee01089d15dbf21217da
+  data.tar.gz: d938415376be7ff6108688521b9447560a8be3f93220c2f40e781a5631cbd9b90323ae62d1f1cf24130fec5f931af2885783fa5af77c0fafebc5aaa662e1c121

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.203
+- Package version: 4.0.204
 - 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.203.gem
+gem install ./ultracart_api-4.0.204.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.203.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.204.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.203'
+    gem 'ultracart_api', '~> 4.0.204'
 
 ### Install from Git
 
@@ -199,6 +199,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
@@ -1491,6 +1492,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.204 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
 | 4.0.203 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 4.0.202 | 03/08/2024 | added getWorkflowTaskTags method |
 | 4.0.201 | 02/27/2024 | esp - sms statistic layer |

data/docs/ConversationApi.md

@@ -65,6 +65,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
@@ -4375,6 +4376,76 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## reset_conversation_pbx_queue_statistics
+
+> reset_conversation_pbx_queue_statistics(queue_uuid)
+
+reset statistics within the queue
+
+reset statistics within the queue 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+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 "Error when calling ConversationApi->reset_conversation_pbx_queue_statistics: #{e}"
+end
+```
+
+#### Using the reset_conversation_pbx_queue_statistics_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid)
+
+```ruby
+begin
+  # reset statistics within the queue
+  data, status_code, headers = api_instance.reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->reset_conversation_pbx_queue_statistics_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## search_conversation_canned_messages
 
 > <ConversationCannedMessagesResponse> search_conversation_canned_messages(search_request)

data/docs/WorkflowTask.md

@@ -14,6 +14,7 @@
 | **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] |
@@ -26,6 +27,7 @@
 | **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] |
@@ -48,6 +50,7 @@ instance = UltracartClient::WorkflowTask.new(
   delay_until_dts: null,
   dependant_workflow_task_uuid: null,
   due_dts: null,
+  expiration_dts: null,
   histories: null,
   last_update_dts: null,
   merchant_id: null,
@@ -60,6 +63,7 @@ instance = UltracartClient::WorkflowTask.new(
   properties: null,
   related_workflow_task_uuid: null,
   status: null,
+  system_task_type: null,
   tags: null,
   task_context: null,
   task_details: null,

data/lib/ultracart_api/api/conversation_api.rb

@@ -3923,6 +3923,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # reset statistics within the queue
+    # reset statistics within the queue 
+    # @param queue_uuid [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, 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' + '}', CGI.escape(queue_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.reset_conversation_pbx_queue_statistics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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 [ConversationCannedMessagesSearch] Search request

data/lib/ultracart_api/models/workflow_task.rb

@@ -44,6 +44,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
 
@@ -80,6 +83,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
 
@@ -130,6 +136,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',
@@ -142,6 +149,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',
@@ -168,6 +176,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',
@@ -180,6 +189,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',
@@ -251,6 +261,10 @@ module UltracartClient
         self.due_dts = attributes[:'due_dts']
       end
 
+      if attributes.key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
       if attributes.key?(:'histories')
         if (value = attributes[:'histories']).is_a?(Array)
           self.histories = value
@@ -305,6 +319,10 @@ module UltracartClient
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'system_task_type')
+        self.system_task_type = attributes[:'system_task_type']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -342,8 +360,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
 
@@ -370,13 +390,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)
@@ -392,6 +422,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 &&
@@ -404,6 +435,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 &&
@@ -420,7 +452,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.203'
+  VERSION = '4.0.204'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.203
+  version: 4.0.204
 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