ultracart_api 4.0.180 → 4.0.182

data/docs/WorkflowGroupsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::WorkflowGroupsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **groups** | [**Array<WorkflowGroup>**](WorkflowGroup.md) | groups | [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::WorkflowGroupsResponse.new(
+  error: null,
+  groups: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/WorkflowNote.md

@@ -0,0 +1,28 @@
+# UltracartClient::WorkflowNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attachments** | [**Array<WorkflowAttachment>**](WorkflowAttachment.md) | Attachments to the Workflow Task | [optional] |
+| **edit_dts** | **String** | Date/time that the note was edited | [optional] |
+| **note** | **String** | Note | [optional] |
+| **note_dts** | **String** | Date/time that the note was written | [optional] |
+| **original_note** | **String** | Note originally written before any edits | [optional] |
+| **user** | [**WorkflowUser**](WorkflowUser.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowNote.new(
+  attachments: null,
+  edit_dts: null,
+  note: null,
+  note_dts: null,
+  original_note: null,
+  user: null
+)
+```
+

data/docs/WorkflowTask.md

@@ -0,0 +1,60 @@
+# UltracartClient::WorkflowTask
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assigned_to_group** | **String** | Assigned to group | [optional] |
+| **assigned_to_group_id** | **Integer** | Assigned to group ID | [optional] |
+| **assigned_to_user** | **String** | Assigned to user | [optional] |
+| **assigned_to_user_id** | **Integer** | Assigned to user ID | [optional] |
+| **attachments** | [**Array<WorkflowAttachment>**](WorkflowAttachment.md) | Attachments to the Workflow Task | [optional] |
+| **created_by** | [**WorkflowUser**](WorkflowUser.md) |  | [optional] |
+| **created_dts** | **String** | Date/time that the workflow task was created | [optional] |
+| **delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional] |
+| **due_dts** | **String** | Date/time that the workflow task is due | [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] |
+| **notes** | [**Array<WorkflowNote>**](WorkflowNote.md) | Notes on the Workflow Task | [optional] |
+| **object_email** | **String** | Object is associated with customer email | [optional] |
+| **object_id** | **String** | Object ID | [optional] |
+| **object_type** | **String** | Object Type | [optional] |
+| **object_url** | **String** | Object URL | [optional] |
+| **priority** | **String** | Priority | [optional] |
+| **status** | **String** | Status of the workflow task | [optional] |
+| **task_details** | **String** | Task Details | [optional] |
+| **task_name** | **String** | Task Name | [optional] |
+| **workflow_task_uuid** | **String** | Workflow Task UUID | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowTask.new(
+  assigned_to_group: null,
+  assigned_to_group_id: null,
+  assigned_to_user: null,
+  assigned_to_user_id: null,
+  attachments: null,
+  created_by: null,
+  created_dts: null,
+  delay_until_dts: null,
+  due_dts: null,
+  histories: null,
+  last_update_dts: null,
+  merchant_id: null,
+  notes: null,
+  object_email: null,
+  object_id: null,
+  object_type: null,
+  object_url: null,
+  priority: null,
+  status: null,
+  task_details: null,
+  task_name: null,
+  workflow_task_uuid: null
+)
+```
+

data/docs/WorkflowTaskHistory.md

@@ -0,0 +1,24 @@
+# UltracartClient::WorkflowTaskHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **activity_dts** | **String** | Date/time that the workflow task history record was created | [optional] |
+| **description** | **String** | Description of the activity | [optional] |
+| **ip_address** | **String** | IP Address that originated the activity | [optional] |
+| **user** | [**WorkflowUser**](WorkflowUser.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowTaskHistory.new(
+  activity_dts: null,
+  description: null,
+  ip_address: null,
+  user: null
+)
+```
+

data/docs/WorkflowTaskResponse.md

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

data/docs/WorkflowTasksRequest.md

@@ -0,0 +1,48 @@
+# UltracartClient::WorkflowTasksRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assigned_to_group_id** | **Integer** | Assigned to group ID | [optional] |
+| **assigned_to_me** | **Boolean** | Tasks are assigned to me either by direct user id or a group that the user is a member of | [optional] |
+| **assigned_to_user_id** | **Integer** | Assigned to user ID | [optional] |
+| **created_by** | [**WorkflowUser**](WorkflowUser.md) |  | [optional] |
+| **created_dts_begin** | **String** | Date/time that the workflow task was created | [optional] |
+| **created_dts_end** | **String** | Date/time that the workflow task was created | [optional] |
+| **delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional] |
+| **due_dts_begin** | **String** | Date/time that the workflow task is due | [optional] |
+| **due_dts_end** | **String** | Date/time that the workflow task is due | [optional] |
+| **last_update_dts_begin** | **String** | Date/time that the workflow task was last updated | [optional] |
+| **last_update_dts_end** | **String** | Date/time that the workflow task was last updated | [optional] |
+| **object_email** | **String** | Object is associated with customer email | [optional] |
+| **object_type** | **String** | Object Type | [optional] |
+| **priority** | **String** | Priority | [optional] |
+| **status** | **String** | Status of the workflow task | [optional] |
+| **unassigned** | **Boolean** | Tasks that are unassigned to a user or group | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowTasksRequest.new(
+  assigned_to_group_id: null,
+  assigned_to_me: null,
+  assigned_to_user_id: null,
+  created_by: null,
+  created_dts_begin: null,
+  created_dts_end: null,
+  delay_until_dts: null,
+  due_dts_begin: null,
+  due_dts_end: null,
+  last_update_dts_begin: null,
+  last_update_dts_end: null,
+  object_email: null,
+  object_type: null,
+  priority: null,
+  status: null,
+  unassigned: null
+)
+```
+

data/docs/WorkflowTasksResponse.md

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

data/docs/WorkflowUser.md

@@ -0,0 +1,22 @@
+# UltracartClient::WorkflowUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** | The user | [optional] |
+| **user_icon_url** | **String** | The user icon URL if available | [optional] |
+| **user_id** | **Integer** | User ID | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowUser.new(
+  user: null,
+  user_icon_url: null,
+  user_id: null
+)
+```
+

data/docs/WorkflowUsersResponse.md

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

data/lib/ultracart_api/api/conversation_api.rb

@@ -898,8 +898,8 @@ module UltracartClient
       return data, status_code, headers
     end
 
-    # Get a presigned conersation multimedia upload URL
-    # Get a presigned conersation multimedia upload URL 
+    # Get a presigned conversation multimedia upload URL
+    # Get a presigned conversation multimedia upload URL 
     # @param extension [String] 
     # @param [Hash] opts the optional parameters
     # @return [ConversationMultimediaUploadUrlResponse]
@@ -908,8 +908,8 @@ module UltracartClient
       data
     end
 
-    # Get a presigned conersation multimedia upload URL
-    # Get a presigned conersation multimedia upload URL 
+    # Get a presigned conversation multimedia upload URL
+    # Get a presigned conversation multimedia upload URL 
     # @param extension [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConversationMultimediaUploadUrlResponse, Integer, Hash)>] ConversationMultimediaUploadUrlResponse data, response status code and response headers