ultracart_api 3.10.164 → 3.10.165

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae0641b855392607eac5b66570a16983d242eb563387ff9b6e84a214d46c38ca
-  data.tar.gz: 5d7e48508430828b1839ae8ea994a9333e16b7f0030a0e0249688805215dccc5
+  metadata.gz: 7e356c6b6d5cca18c2446d11738ddb8261f01cafec6dc402bf730754eff97636
+  data.tar.gz: 5d8739254538f67793bdf0a705a61a544cb802f8e3e7f61294a8b3e1cf6c8769
 SHA512:
-  metadata.gz: 6963bbe1c784f1deefdfe4685865b9e177c79a37949a25500b3b61f192c71da9c0fe36da7c52103190c8f2ce513c3a793a35879dfa4f5ddf6dd0273431e02a42
-  data.tar.gz: 18e7b23a129352e9e79a1c6ad52a123f8b2d8499c0491384e6a82fec507f7a75a8f820cede247228ea462f57e32f1a0c2ac3f6431bbbac423855325100c097f4
+  metadata.gz: 7eb7757469f28d0f0c6dc6edcf86f4bd991fdfbf188c4ebe3341dd4bbf0139c14411d8d41d14868a23716788bf9a3734d6b591933b7e87f87469742b0d446fa9
+  data.tar.gz: 367f1f9800e19b7829b1ef19f1112a1750504090c4fe04ff403d4b748dd642a66cdb2143c03eb270f632ba94532a6cb6be00424382a5d63e8313937467613130

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.164
+- Package version: 3.10.165
 - 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.164.gem
+gem install ./ultracart_api-3.10.165.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.164.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.165.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.164'
+    gem 'ultracart_api', '~> 3.10.165'
 
 ### Install from Git
 
@@ -507,6 +507,14 @@ 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_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_task**](docs/WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
+*UltracartClient::WorkflowApi* | [**get_workflow_task_attachment_upload_url**](docs/WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL
+*UltracartClient::WorkflowApi* | [**get_workflow_task_by_object_type**](docs/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
+*UltracartClient::WorkflowApi* | [**get_workflow_tasks**](docs/WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
+*UltracartClient::WorkflowApi* | [**insert_workflow_task**](docs/WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
+*UltracartClient::WorkflowApi* | [**update_workflow_task**](docs/WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task
 
 
 ## Documentation for Models
@@ -1293,6 +1301,19 @@ Class | Method | HTTP request | Description
  - [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
  - [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
  - [UltracartClient::Weight](docs/Weight.md)
+ - [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
+ - [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
+ - [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
+ - [UltracartClient::WorkflowGroup](docs/WorkflowGroup.md)
+ - [UltracartClient::WorkflowGroupsResponse](docs/WorkflowGroupsResponse.md)
+ - [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
+ - [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
+ - [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
+ - [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
+ - [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
+ - [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
+ - [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
+ - [UltracartClient::WorkflowUsersResponse](docs/WorkflowUsersResponse.md)
 
 
 ## Documentation for Authorization
@@ -1365,6 +1386,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.165 | 10/23/2023 | workflow tasks api |
 | 3.10.164 | 10/23/2023 | workflow tasks api |
 | 3.10.163 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
 | 3.10.162 | 09/28/2023 | dw bi - add aggregation constant of none |

data/docs/WorkflowApi.md

@@ -0,0 +1,436 @@
+# UltracartClient::WorkflowApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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_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_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_assignment_groups**
+> WorkflowGroupsResponse get_workflow_assignment_groups(opts)
+
+Retrieve a list of groups that workflow tasks can be assigned to
+
+Retrieve a list of groups that workflow tasks can be assigned to 
+
+### 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)
+
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
+  _offset: 0 # Integer | Pagination of the record set.  Offset is a zero based index.
+}
+
+begin
+  #Retrieve a list of groups that workflow tasks can be assigned to
+  result = api_instance.get_workflow_assignment_groups(opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_assignment_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+
+### Return type
+
+[**WorkflowGroupsResponse**](WorkflowGroupsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_workflow_assignment_users**
+> WorkflowUsersResponse get_workflow_assignment_users(opts)
+
+Retrieve a list of users that workflow tasks can be assigned to
+
+Retrieve a list of users that workflow tasks can be assigned to 
+
+### 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)
+
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
+  _offset: 0 # Integer | Pagination of the record set.  Offset is a zero based index.
+}
+
+begin
+  #Retrieve a list of users that workflow tasks can be assigned to
+  result = api_instance.get_workflow_assignment_users(opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_assignment_users: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+
+### Return type
+
+[**WorkflowUsersResponse**](WorkflowUsersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_workflow_task**
+> WorkflowTaskResponse get_workflow_task(task_uuid)
+
+Retrieve a workflow task
+
+Retrieve a workflow task 
+
+### 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)
+
+
+task_uuid = 'task_uuid_example' # String | 
+
+
+begin
+  #Retrieve a workflow task
+  result = api_instance.get_workflow_task(task_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_task: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_uuid** | **String**|  | 
+
+### Return type
+
+[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_workflow_task_attachment_upload_url**
+> WorkflowAttachmentUploadUrlResponse get_workflow_task_attachment_upload_url(extension)
+
+Get a presigned workflow task attachment upload URL
+
+Get a presigned workflow task attachment upload URL 
+
+### 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)
+
+
+extension = 'extension_example' # String | 
+
+
+begin
+  #Get a presigned workflow task attachment upload URL
+  result = api_instance.get_workflow_task_attachment_upload_url(extension)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_task_attachment_upload_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **extension** | **String**|  | 
+
+### Return type
+
+[**WorkflowAttachmentUploadUrlResponse**](WorkflowAttachmentUploadUrlResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_workflow_task_by_object_type**
+> WorkflowTaskResponse get_workflow_task_by_object_type(object_type, object_id)
+
+Retrieve a workflow task by object type and id
+
+Retrieve a workflow task by object type and id 
+
+### 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)
+
+
+object_type = 'object_type_example' # String | 
+
+object_id = 'object_id_example' # String | 
+
+
+begin
+  #Retrieve a workflow task by object type and id
+  result = api_instance.get_workflow_task_by_object_type(object_type, object_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_task_by_object_type: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **object_type** | **String**|  | 
+ **object_id** | **String**|  | 
+
+### Return type
+
+[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_workflow_tasks**
+> WorkflowTasksResponse get_workflow_tasks(workflow_tasks_query, opts)
+
+Search workflow tasks
+
+Retrieves a set of workflow tasks from the account based on a query object. 
+
+### 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)
+
+
+workflow_tasks_query = UltracartClient::WorkflowTasksRequest.new # WorkflowTasksRequest | Workflow tasks query
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
+  _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _sort: '_sort_example' # String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+}
+
+begin
+  #Search workflow tasks
+  result = api_instance.get_workflow_tasks(workflow_tasks_query, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_tasks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workflow_tasks_query** | [**WorkflowTasksRequest**](WorkflowTasksRequest.md)| Workflow tasks query | 
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+ **_sort** | **String**| The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] 
+
+### Return type
+
+[**WorkflowTasksResponse**](WorkflowTasksResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **insert_workflow_task**
+> WorkflowTaskResponse insert_workflow_task(workflow_task)
+
+Insert a workflow task
+
+Insert a workflow task 
+
+### 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)
+
+
+workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | workflow task
+
+
+begin
+  #Insert a workflow task
+  result = api_instance.insert_workflow_task(workflow_task)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->insert_workflow_task: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workflow_task** | [**WorkflowTask**](WorkflowTask.md)| workflow task | 
+
+### Return type
+
+[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_workflow_task**
+> WorkflowTaskResponse update_workflow_task(task_uuid, workflow_task)
+
+Update a workflow task
+
+Update a workflow task 
+
+### 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)
+
+
+task_uuid = 'task_uuid_example' # String | 
+
+workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | Workflow task
+
+
+begin
+  #Update a workflow task
+  result = api_instance.update_workflow_task(task_uuid, workflow_task)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->update_workflow_task: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_uuid** | **String**|  | 
+ **workflow_task** | [**WorkflowTask**](WorkflowTask.md)| Workflow task | 
+
+### Return type
+
+[**WorkflowTaskResponse**](WorkflowTaskResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/WorkflowAttachment.md

@@ -0,0 +1,12 @@
+# UltracartClient::WorkflowAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**download_key** | **String** | Temporary download URL | [optional] 
+**file_name** | **String** | File name | [optional] 
+**file_uuid** | **String** | File UUID | [optional] 
+**mime_type** | **String** | Mime Type | [optional] 
+**upload_key** | **String** | Temporary upload key | [optional] 
+
+

data/docs/WorkflowAttachmentUploadUrl.md

@@ -0,0 +1,9 @@
+# UltracartClient::WorkflowAttachmentUploadUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/WorkflowAttachmentUploadUrlResponse.md

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

data/docs/WorkflowGroup.md

@@ -0,0 +1,9 @@
+# UltracartClient::WorkflowGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **String** | The group | [optional] 
+**group_id** | **Integer** | Group ID | [optional] 
+
+

data/docs/WorkflowGroupsResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/WorkflowNote.md

@@ -0,0 +1,13 @@
+# 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] 
+
+

data/docs/WorkflowTask.md

@@ -0,0 +1,29 @@
+# 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] 
+
+

data/docs/WorkflowTaskHistory.md

@@ -0,0 +1,11 @@
+# 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] 
+
+

data/docs/WorkflowTaskResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/WorkflowTasksRequest.md

@@ -0,0 +1,23 @@
+# 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] 
+
+