ultracart_api 4.0.201 → 4.0.203

data/docs/ConversationPbxTimeBasedsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxTimeBasedsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **time_baseds** | [**Array<ConversationPbxTimeBased>**](ConversationPbxTimeBased.md) |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeBasedsResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  time_baseds: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxTimeRange.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxTimeRange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **configs** | [**Array<ConversationPbxTimeRangeConfig>**](ConversationPbxTimeRangeConfig.md) | Configurations for all ranges in this time range | [optional] |
+| **conversation_pbx_time_range_uuid** | **String** | Conversation Pbx Time Range UUID | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **time_range_name** | **String** | Time range name | [optional] |
+| **timezone** | **String** | Timezone | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeRange.new(
+  configs: null,
+  conversation_pbx_time_range_uuid: null,
+  merchant_id: null,
+  time_range_name: null,
+  timezone: null
+)
+```
+

data/docs/ConversationPbxTimeRangeConfig.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationPbxTimeRangeConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_date** | **String** | End date | [optional] |
+| **end_day_of_week** | **Integer** | End day of week | [optional] |
+| **end_time** | **String** | End time | [optional] |
+| **start_date** | **String** | Start date | [optional] |
+| **start_day_of_week** | **Integer** | Start day of week | [optional] |
+| **start_time** | **String** | Start time | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeRangeConfig.new(
+  end_date: null,
+  end_day_of_week: null,
+  end_time: null,
+  start_date: null,
+  start_day_of_week: null,
+  start_time: null
+)
+```
+

data/docs/ConversationPbxTimeRangeResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxTimeRangeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md) |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeRangeResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  time_range: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxTimeRangesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxTimeRangesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **time_ranges** | [**Array<ConversationPbxTimeRange>**](ConversationPbxTimeRange.md) |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeRangesResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  time_ranges: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxVoicemailMailbox.md

@@ -0,0 +1,38 @@
+# UltracartClient::ConversationPbxVoicemailMailbox
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **send_notices_to_email** | **String** | Send notices to email | [optional] |
+| **user_id** | **Integer** | User Id | [optional] |
+| **voicemail_follow_play_audio_uuid** | **String** | Voicemail follow play audio UUID | [optional] |
+| **voicemail_followup_say** | **String** | Voicemail followup say | [optional] |
+| **voicemail_mailbox_id** | **String** | Voicemail mailbox id | [optional] |
+| **voicemail_mailbox_type** | **String** | Voicemail mailbox type | [optional] |
+| **voicemail_prompt_play_audio_uuid** | **String** | Voicemail prompt play audio UUID | [optional] |
+| **voicemail_prompt_say** | **String** | Voicemail prompt say | [optional] |
+| **voicemail_say_voice** | **String** | Voicemail say voice | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxVoicemailMailbox.new(
+  conversation_pbx_voicemail_mailbox_uuid: null,
+  merchant_id: null,
+  send_notices_to_email: null,
+  user_id: null,
+  voicemail_follow_play_audio_uuid: null,
+  voicemail_followup_say: null,
+  voicemail_mailbox_id: null,
+  voicemail_mailbox_type: null,
+  voicemail_prompt_play_audio_uuid: null,
+  voicemail_prompt_say: null,
+  voicemail_say_voice: null
+)
+```
+

data/docs/ConversationPbxVoicemailMailboxResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxVoicemailMailboxResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **voicemail_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md) |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxVoicemailMailboxResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  voicemail_mailbox: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxVoicemailMailboxesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxVoicemailMailboxesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **voicemail_mailboxes** | [**Array<ConversationPbxVoicemailMailbox>**](ConversationPbxVoicemailMailbox.md) |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxVoicemailMailboxesResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  voicemail_mailboxes: null,
+  warning: null
+)
+```
+

data/docs/WorkflowAgentAuth.md

@@ -0,0 +1,22 @@
+# UltracartClient::WorkflowAgentAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowAgentAuth.new(
+  jwt: null,
+  merchant_id: null,
+  websocket_url: null
+)
+```
+

data/docs/WorkflowAgentAuthResponse.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowAgentAuthResponse.new(
+  agent_auth: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/WorkflowApi.md

@@ -4,17 +4,87 @@ 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 |
 | [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task |
 | [**get_workflow_task_attachment_upload_url**](WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL |
 | [**get_workflow_task_by_object_type**](WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id |
+| [**get_workflow_task_tags**](WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags |
 | [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks |
 | [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task |
 | [**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. 
+
+### 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::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Get agent websocket authorization
+  result = api_instance.get_workflow_agent_websocket_authorization
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization: #{e}"
+end
+```
+
+#### Using the get_workflow_agent_websocket_authorization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WorkflowAgentAuthResponse>, Integer, Hash)> get_workflow_agent_websocket_authorization_with_http_info
+
+```ruby
+begin
+  # Get agent websocket authorization
+  data, status_code, headers = api_instance.get_workflow_agent_websocket_authorization_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WorkflowAgentAuthResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## get_workflow_assignment_groups
 
 > <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)
@@ -448,6 +518,74 @@ end
 - **Accept**: application/json
 
 
+## get_workflow_task_tags
+
+> <WorkflowTaskTagsResponse> get_workflow_task_tags
+
+Get a list of existing workflow task tags
+
+Retrieves a unique list of all the existing workflow task tags. 
+
+### 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::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Get a list of existing workflow task tags
+  result = api_instance.get_workflow_task_tags
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WorkflowApi->get_workflow_task_tags: #{e}"
+end
+```
+
+#### Using the get_workflow_task_tags_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WorkflowTaskTagsResponse>, Integer, Hash)> get_workflow_task_tags_with_http_info
+
+```ruby
+begin
+  # Get a list of existing workflow task tags
+  data, status_code, headers = api_instance.get_workflow_task_tags_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WorkflowTaskTagsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WorkflowApi->get_workflow_task_tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkflowTaskTagsResponse**](WorkflowTaskTagsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_workflow_tasks
 
 > <WorkflowTasksResponse> get_workflow_tasks(workflow_tasks_query, opts)

data/docs/WorkflowTaskTagsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::WorkflowTaskTagsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **tags** | **Array<String>** | Tags | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowTaskTagsResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  tags: null,
+  warning: null
+)
+```
+