ultracart_api 4.0.203 → 4.0.205

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2741f3ab5cd18a9833cadc8808fba3d863b042f81b7f5c681c838691c53239c6
4
- data.tar.gz: b0ef5867ded4987ffd1df0286c5a33f21e1396c39444877a14b1bcb1e954140c
3
+ metadata.gz: 2c97ffce8e30d6e1cd3674d587a4141c7621a5cb74ac0eb63bcaff320a3eb75b
4
+ data.tar.gz: bb257658c5852df73047f5620743da7e74b0f61e058923438976856a910882e6
5
5
  SHA512:
6
- metadata.gz: 907343341ebb75dbf1292d6833886ba79d0340c23fcebfb0011595c9c2cc87689852e5367721de2604d160834f83b11b94a9c8f7421009c71d84038d0496e57b
7
- data.tar.gz: 9a49b85125ae2377508cdcc2627bdf74191d91998ce2dab74f5fa4e1b62c3444817d2b048db46abf7ac275a616b0b9f7682fbc547ea19c119c8cf0c4db027ca1
6
+ metadata.gz: d3919d841c4dc6c2b115afe2e6ce9636908d88aeada0f84019ccc41e82d1261b5d8c1bbe57f01f156c1b65ffbb4a6cf0d00a8474e7c2318300e29581e2e2ece5
7
+ data.tar.gz: c6cd847a966df100e03531c3b4044afb603971faa76430d905e39ab9eaae752b9784484ccecc1aa13312839cabee6b9a1673486f3ce0e57279d590cc836e619b
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.0.203
10
+ - Package version: 4.0.205
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.203.gem
27
+ gem install ./ultracart_api-4.0.205.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.203.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.205.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.203'
36
+ gem 'ultracart_api', '~> 4.0.205'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -199,6 +199,7 @@ Class | Method | HTTP request | Description
199
199
  *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
200
200
  *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
201
201
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
202
+ *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
202
203
  *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
203
204
  *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
204
205
  *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
@@ -569,6 +570,7 @@ Class | Method | HTTP request | Description
569
570
  *UltracartClient::WorkflowApi* | [**get_workflow_task**](docs/WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
570
571
  *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
571
572
  *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
573
+ *UltracartClient::WorkflowApi* | [**get_workflow_task_open_count**](docs/WorkflowApi.md#get_workflow_task_open_count) | **GET** /workflow/tasks/open_count | Retrieve workflow task open count
572
574
  *UltracartClient::WorkflowApi* | [**get_workflow_task_tags**](docs/WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags
573
575
  *UltracartClient::WorkflowApi* | [**get_workflow_tasks**](docs/WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
574
576
  *UltracartClient::WorkflowApi* | [**insert_workflow_task**](docs/WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
@@ -1409,6 +1411,7 @@ Class | Method | HTTP request | Description
1409
1411
  - [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
1410
1412
  - [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
1411
1413
  - [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
1414
+ - [UltracartClient::WorkflowTaskOpenCountResponse](docs/WorkflowTaskOpenCountResponse.md)
1412
1415
  - [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
1413
1416
  - [UltracartClient::WorkflowTaskTagsResponse](docs/WorkflowTaskTagsResponse.md)
1414
1417
  - [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
@@ -1491,6 +1494,8 @@ Not every change is committed to every SDK.
1491
1494
 
1492
1495
  | Version | Date | Comments |
1493
1496
  | --: | :-: | --- |
1497
+ | 4.0.205 | 03/19/2024 | workflow task - method to obtain open task count |
1498
+ | 4.0.204 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
1494
1499
  | 4.0.203 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
1495
1500
  | 4.0.202 | 03/08/2024 | added getWorkflowTaskTags method |
1496
1501
  | 4.0.201 | 02/27/2024 | esp - sms statistic layer |
@@ -65,6 +65,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
65
65
  | [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
66
66
  | [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
67
67
  | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
68
+ | [**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 |
68
69
  | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
69
70
  | [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
70
71
  | [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
@@ -4375,6 +4376,76 @@ nil (empty response body)
4375
4376
  - **Accept**: application/json
4376
4377
 
4377
4378
 
4379
+ ## reset_conversation_pbx_queue_statistics
4380
+
4381
+ > reset_conversation_pbx_queue_statistics(queue_uuid)
4382
+
4383
+ reset statistics within the queue
4384
+
4385
+ reset statistics within the queue
4386
+
4387
+ ### Examples
4388
+
4389
+ ```ruby
4390
+ require 'time'
4391
+ require 'ultracart_api'
4392
+ require 'json'
4393
+ require 'yaml'
4394
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
4395
+
4396
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
4397
+ # As such, this might not be the best way to use this object.
4398
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
4399
+
4400
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
4401
+ queue_uuid = 'queue_uuid_example' # String |
4402
+
4403
+ begin
4404
+ # reset statistics within the queue
4405
+ api_instance.reset_conversation_pbx_queue_statistics(queue_uuid)
4406
+ rescue UltracartClient::ApiError => e
4407
+ puts "Error when calling ConversationApi->reset_conversation_pbx_queue_statistics: #{e}"
4408
+ end
4409
+ ```
4410
+
4411
+ #### Using the reset_conversation_pbx_queue_statistics_with_http_info variant
4412
+
4413
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
4414
+
4415
+ > <Array(nil, Integer, Hash)> reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid)
4416
+
4417
+ ```ruby
4418
+ begin
4419
+ # reset statistics within the queue
4420
+ data, status_code, headers = api_instance.reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid)
4421
+ p status_code # => 2xx
4422
+ p headers # => { ... }
4423
+ p data # => nil
4424
+ rescue UltracartClient::ApiError => e
4425
+ puts "Error when calling ConversationApi->reset_conversation_pbx_queue_statistics_with_http_info: #{e}"
4426
+ end
4427
+ ```
4428
+
4429
+ ### Parameters
4430
+
4431
+ | Name | Type | Description | Notes |
4432
+ | ---- | ---- | ----------- | ----- |
4433
+ | **queue_uuid** | **String** | | |
4434
+
4435
+ ### Return type
4436
+
4437
+ nil (empty response body)
4438
+
4439
+ ### Authorization
4440
+
4441
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4442
+
4443
+ ### HTTP request headers
4444
+
4445
+ - **Content-Type**: Not defined
4446
+ - **Accept**: application/json
4447
+
4448
+
4378
4449
  ## search_conversation_canned_messages
4379
4450
 
4380
4451
  > <ConversationCannedMessagesResponse> search_conversation_canned_messages(search_request)
data/docs/WorkflowApi.md CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
11
11
  | [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task |
12
12
  | [**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 |
13
13
  | [**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 |
14
+ | [**get_workflow_task_open_count**](WorkflowApi.md#get_workflow_task_open_count) | **GET** /workflow/tasks/open_count | Retrieve workflow task open count |
14
15
  | [**get_workflow_task_tags**](WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags |
15
16
  | [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks |
16
17
  | [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task |
@@ -518,6 +519,74 @@ end
518
519
  - **Accept**: application/json
519
520
 
520
521
 
522
+ ## get_workflow_task_open_count
523
+
524
+ > <WorkflowTaskOpenCountResponse> get_workflow_task_open_count
525
+
526
+ Retrieve workflow task open count
527
+
528
+ Retrieve workflow task open count
529
+
530
+ ### Examples
531
+
532
+ ```ruby
533
+ require 'time'
534
+ require 'ultracart_api'
535
+ require 'json'
536
+ require 'yaml'
537
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
538
+
539
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
540
+ # As such, this might not be the best way to use this object.
541
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
542
+
543
+ api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
544
+
545
+ begin
546
+ # Retrieve workflow task open count
547
+ result = api_instance.get_workflow_task_open_count
548
+ p result
549
+ rescue UltracartClient::ApiError => e
550
+ puts "Error when calling WorkflowApi->get_workflow_task_open_count: #{e}"
551
+ end
552
+ ```
553
+
554
+ #### Using the get_workflow_task_open_count_with_http_info variant
555
+
556
+ This returns an Array which contains the response data, status code and headers.
557
+
558
+ > <Array(<WorkflowTaskOpenCountResponse>, Integer, Hash)> get_workflow_task_open_count_with_http_info
559
+
560
+ ```ruby
561
+ begin
562
+ # Retrieve workflow task open count
563
+ data, status_code, headers = api_instance.get_workflow_task_open_count_with_http_info
564
+ p status_code # => 2xx
565
+ p headers # => { ... }
566
+ p data # => <WorkflowTaskOpenCountResponse>
567
+ rescue UltracartClient::ApiError => e
568
+ puts "Error when calling WorkflowApi->get_workflow_task_open_count_with_http_info: #{e}"
569
+ end
570
+ ```
571
+
572
+ ### Parameters
573
+
574
+ This endpoint does not need any parameter.
575
+
576
+ ### Return type
577
+
578
+ [**WorkflowTaskOpenCountResponse**](WorkflowTaskOpenCountResponse.md)
579
+
580
+ ### Authorization
581
+
582
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: Not defined
587
+ - **Accept**: application/json
588
+
589
+
521
590
  ## get_workflow_task_tags
522
591
 
523
592
  > <WorkflowTaskTagsResponse> get_workflow_task_tags
data/docs/WorkflowTask.md CHANGED
@@ -14,6 +14,7 @@
14
14
  | **delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional] |
15
15
  | **dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional] |
16
16
  | **due_dts** | **String** | Date/time that the workflow task is due | [optional] |
17
+ | **expiration_dts** | **String** | Date/time that the workflow task will expire and be closed. This is set by system generated tasks. | [optional] |
17
18
  | **histories** | [**Array&lt;WorkflowTaskHistory&gt;**](WorkflowTaskHistory.md) | Array of history records for the task | [optional] |
18
19
  | **last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional] |
19
20
  | **merchant_id** | **String** | Merchant ID | [optional] |
@@ -26,6 +27,7 @@
26
27
  | **properties** | [**Array&lt;Property&gt;**](Property.md) | Properties | [optional] |
27
28
  | **related_workflow_task_uuid** | **String** | Related Workflow Task UUID | [optional] |
28
29
  | **status** | **String** | Status of the workflow task | [optional] |
30
+ | **system_task_type** | **String** | Constant for the type of system generated task | [optional] |
29
31
  | **tags** | **Array&lt;String&gt;** | Tags | [optional] |
30
32
  | **task_context** | **String** | User friendly string of the task context | [optional] |
31
33
  | **task_details** | **String** | Task Details | [optional] |
@@ -48,6 +50,7 @@ instance = UltracartClient::WorkflowTask.new(
48
50
  delay_until_dts: null,
49
51
  dependant_workflow_task_uuid: null,
50
52
  due_dts: null,
53
+ expiration_dts: null,
51
54
  histories: null,
52
55
  last_update_dts: null,
53
56
  merchant_id: null,
@@ -60,6 +63,7 @@ instance = UltracartClient::WorkflowTask.new(
60
63
  properties: null,
61
64
  related_workflow_task_uuid: null,
62
65
  status: null,
66
+ system_task_type: null,
63
67
  tags: null,
64
68
  task_context: null,
65
69
  task_details: null,
@@ -0,0 +1,26 @@
1
+ # UltracartClient::WorkflowTaskOpenCountResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **open_count** | **Integer** | Open Task Count | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::WorkflowTaskOpenCountResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ open_count: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **error** | [**Error**](Error.md) | | [optional] |
8
8
  | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **my_user_id** | **Integer** | User ID of myself | [optional] |
9
10
  | **success** | **Boolean** | Indicates if API call was successful | [optional] |
10
11
  | **users** | [**Array&lt;WorkflowUser&gt;**](WorkflowUser.md) | users | [optional] |
11
12
  | **warning** | [**Warning**](Warning.md) | | [optional] |
@@ -18,6 +19,7 @@ require 'ultracart_api'
18
19
  instance = UltracartClient::WorkflowUsersResponse.new(
19
20
  error: null,
20
21
  metadata: null,
22
+ my_user_id: null,
21
23
  success: null,
22
24
  users: null,
23
25
  warning: null
@@ -3923,6 +3923,70 @@ module UltracartClient
3923
3923
  return data, status_code, headers
3924
3924
  end
3925
3925
 
3926
+ # reset statistics within the queue
3927
+ # reset statistics within the queue
3928
+ # @param queue_uuid [String]
3929
+ # @param [Hash] opts the optional parameters
3930
+ # @return [nil]
3931
+ def reset_conversation_pbx_queue_statistics(queue_uuid, opts = {})
3932
+ reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts)
3933
+ nil
3934
+ end
3935
+
3936
+ # reset statistics within the queue
3937
+ # reset statistics within the queue
3938
+ # @param queue_uuid [String]
3939
+ # @param [Hash] opts the optional parameters
3940
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
3941
+ def reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts = {})
3942
+ if @api_client.config.debugging
3943
+ @api_client.config.logger.debug 'Calling API: ConversationApi.reset_conversation_pbx_queue_statistics ...'
3944
+ end
3945
+ # verify the required parameter 'queue_uuid' is set
3946
+ if @api_client.config.client_side_validation && queue_uuid.nil?
3947
+ fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.reset_conversation_pbx_queue_statistics"
3948
+ end
3949
+ # resource path
3950
+ local_var_path = '/conversation/pbx/queues/{queue_uuid}/reset_statistics'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s))
3951
+
3952
+ # query parameters
3953
+ query_params = opts[:query_params] || {}
3954
+
3955
+ # header parameters
3956
+ header_params = opts[:header_params] || {}
3957
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3958
+ # HTTP header 'Accept' (if needed)
3959
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3960
+
3961
+ # form parameters
3962
+ form_params = opts[:form_params] || {}
3963
+
3964
+ # http body (model)
3965
+ post_body = opts[:debug_body]
3966
+
3967
+ # return_type
3968
+ return_type = opts[:debug_return_type]
3969
+
3970
+ # auth_names
3971
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3972
+
3973
+ new_options = opts.merge(
3974
+ :operation => :"ConversationApi.reset_conversation_pbx_queue_statistics",
3975
+ :header_params => header_params,
3976
+ :query_params => query_params,
3977
+ :form_params => form_params,
3978
+ :body => post_body,
3979
+ :auth_names => auth_names,
3980
+ :return_type => return_type
3981
+ )
3982
+
3983
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3984
+ if @api_client.config.debugging
3985
+ @api_client.config.logger.debug "API called: ConversationApi#reset_conversation_pbx_queue_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3986
+ end
3987
+ return data, status_code, headers
3988
+ end
3989
+
3926
3990
  # Search for canned messages by short_code
3927
3991
  # Search for canned messages by short_code
3928
3992
  # @param search_request [ConversationCannedMessagesSearch] Search request
@@ -474,6 +474,64 @@ module UltracartClient
474
474
  return data, status_code, headers
475
475
  end
476
476
 
477
+ # Retrieve workflow task open count
478
+ # Retrieve workflow task open count
479
+ # @param [Hash] opts the optional parameters
480
+ # @return [WorkflowTaskOpenCountResponse]
481
+ def get_workflow_task_open_count(opts = {})
482
+ data, _status_code, _headers = get_workflow_task_open_count_with_http_info(opts)
483
+ data
484
+ end
485
+
486
+ # Retrieve workflow task open count
487
+ # Retrieve workflow task open count
488
+ # @param [Hash] opts the optional parameters
489
+ # @return [Array<(WorkflowTaskOpenCountResponse, Integer, Hash)>] WorkflowTaskOpenCountResponse data, response status code and response headers
490
+ def get_workflow_task_open_count_with_http_info(opts = {})
491
+ if @api_client.config.debugging
492
+ @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_task_open_count ...'
493
+ end
494
+ # resource path
495
+ local_var_path = '/workflow/tasks/open_count'
496
+
497
+ # query parameters
498
+ query_params = opts[:query_params] || {}
499
+
500
+ # header parameters
501
+ header_params = opts[:header_params] || {}
502
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
503
+ # HTTP header 'Accept' (if needed)
504
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
505
+
506
+ # form parameters
507
+ form_params = opts[:form_params] || {}
508
+
509
+ # http body (model)
510
+ post_body = opts[:debug_body]
511
+
512
+ # return_type
513
+ return_type = opts[:debug_return_type] || 'WorkflowTaskOpenCountResponse'
514
+
515
+ # auth_names
516
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
517
+
518
+ new_options = opts.merge(
519
+ :operation => :"WorkflowApi.get_workflow_task_open_count",
520
+ :header_params => header_params,
521
+ :query_params => query_params,
522
+ :form_params => form_params,
523
+ :body => post_body,
524
+ :auth_names => auth_names,
525
+ :return_type => return_type
526
+ )
527
+
528
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
529
+ if @api_client.config.debugging
530
+ @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_task_open_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
531
+ end
532
+ return data, status_code, headers
533
+ end
534
+
477
535
  # Get a list of existing workflow task tags
478
536
  # Retrieves a unique list of all the existing workflow task tags.
479
537
  # @param [Hash] opts the optional parameters
@@ -44,6 +44,9 @@ module UltracartClient
44
44
  # Date/time that the workflow task is due
45
45
  attr_accessor :due_dts
46
46
 
47
+ # Date/time that the workflow task will expire and be closed. This is set by system generated tasks.
48
+ attr_accessor :expiration_dts
49
+
47
50
  # Array of history records for the task
48
51
  attr_accessor :histories
49
52
 
@@ -80,6 +83,9 @@ module UltracartClient
80
83
  # Status of the workflow task
81
84
  attr_accessor :status
82
85
 
86
+ # Constant for the type of system generated task
87
+ attr_accessor :system_task_type
88
+
83
89
  # Tags
84
90
  attr_accessor :tags
85
91
 
@@ -130,6 +136,7 @@ module UltracartClient
130
136
  :'delay_until_dts' => :'delay_until_dts',
131
137
  :'dependant_workflow_task_uuid' => :'dependant_workflow_task_uuid',
132
138
  :'due_dts' => :'due_dts',
139
+ :'expiration_dts' => :'expiration_dts',
133
140
  :'histories' => :'histories',
134
141
  :'last_update_dts' => :'last_update_dts',
135
142
  :'merchant_id' => :'merchant_id',
@@ -142,6 +149,7 @@ module UltracartClient
142
149
  :'properties' => :'properties',
143
150
  :'related_workflow_task_uuid' => :'related_workflow_task_uuid',
144
151
  :'status' => :'status',
152
+ :'system_task_type' => :'system_task_type',
145
153
  :'tags' => :'tags',
146
154
  :'task_context' => :'task_context',
147
155
  :'task_details' => :'task_details',
@@ -168,6 +176,7 @@ module UltracartClient
168
176
  :'delay_until_dts' => :'String',
169
177
  :'dependant_workflow_task_uuid' => :'String',
170
178
  :'due_dts' => :'String',
179
+ :'expiration_dts' => :'String',
171
180
  :'histories' => :'Array<WorkflowTaskHistory>',
172
181
  :'last_update_dts' => :'String',
173
182
  :'merchant_id' => :'String',
@@ -180,6 +189,7 @@ module UltracartClient
180
189
  :'properties' => :'Array<Property>',
181
190
  :'related_workflow_task_uuid' => :'String',
182
191
  :'status' => :'String',
192
+ :'system_task_type' => :'String',
183
193
  :'tags' => :'Array<String>',
184
194
  :'task_context' => :'String',
185
195
  :'task_details' => :'String',
@@ -251,6 +261,10 @@ module UltracartClient
251
261
  self.due_dts = attributes[:'due_dts']
252
262
  end
253
263
 
264
+ if attributes.key?(:'expiration_dts')
265
+ self.expiration_dts = attributes[:'expiration_dts']
266
+ end
267
+
254
268
  if attributes.key?(:'histories')
255
269
  if (value = attributes[:'histories']).is_a?(Array)
256
270
  self.histories = value
@@ -305,6 +319,10 @@ module UltracartClient
305
319
  self.status = attributes[:'status']
306
320
  end
307
321
 
322
+ if attributes.key?(:'system_task_type')
323
+ self.system_task_type = attributes[:'system_task_type']
324
+ end
325
+
308
326
  if attributes.key?(:'tags')
309
327
  if (value = attributes[:'tags']).is_a?(Array)
310
328
  self.tags = value
@@ -342,8 +360,10 @@ module UltracartClient
342
360
  return false unless object_type_validator.valid?(@object_type)
343
361
  priority_validator = EnumAttributeValidator.new('String', ["1 - low", "2 - medium", "3 - high", "4 - critical"])
344
362
  return false unless priority_validator.valid?(@priority)
345
- status_validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback"])
363
+ status_validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback", "closed - system", "closed - customer", "closed - expiration"])
346
364
  return false unless status_validator.valid?(@status)
365
+ 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"])
366
+ return false unless system_task_type_validator.valid?(@system_task_type)
347
367
  true
348
368
  end
349
369
 
@@ -370,13 +390,23 @@ module UltracartClient
370
390
  # Custom attribute writer method checking allowed values (enum).
371
391
  # @param [Object] status Object to be assigned
372
392
  def status=(status)
373
- validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback"])
393
+ validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback", "closed - system", "closed - customer", "closed - expiration"])
374
394
  unless validator.valid?(status)
375
395
  fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
376
396
  end
377
397
  @status = status
378
398
  end
379
399
 
400
+ # Custom attribute writer method checking allowed values (enum).
401
+ # @param [Object] system_task_type Object to be assigned
402
+ def system_task_type=(system_task_type)
403
+ 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"])
404
+ unless validator.valid?(system_task_type)
405
+ fail ArgumentError, "invalid value for \"system_task_type\", must be one of #{validator.allowable_values}."
406
+ end
407
+ @system_task_type = system_task_type
408
+ end
409
+
380
410
  # Checks equality by comparing each attribute.
381
411
  # @param [Object] Object to be compared
382
412
  def ==(o)
@@ -392,6 +422,7 @@ module UltracartClient
392
422
  delay_until_dts == o.delay_until_dts &&
393
423
  dependant_workflow_task_uuid == o.dependant_workflow_task_uuid &&
394
424
  due_dts == o.due_dts &&
425
+ expiration_dts == o.expiration_dts &&
395
426
  histories == o.histories &&
396
427
  last_update_dts == o.last_update_dts &&
397
428
  merchant_id == o.merchant_id &&
@@ -404,6 +435,7 @@ module UltracartClient
404
435
  properties == o.properties &&
405
436
  related_workflow_task_uuid == o.related_workflow_task_uuid &&
406
437
  status == o.status &&
438
+ system_task_type == o.system_task_type &&
407
439
  tags == o.tags &&
408
440
  task_context == o.task_context &&
409
441
  task_details == o.task_details &&
@@ -420,7 +452,7 @@ module UltracartClient
420
452
  # Calculates hash code according to all attributes.
421
453
  # @return [Integer] Hash code
422
454
  def hash
423
- [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
455
+ [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
424
456
  end
425
457
 
426
458
  # Builds the object from hash
@@ -0,0 +1,257 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module UltracartClient
17
+ class WorkflowTaskOpenCountResponse
18
+ attr_accessor :error
19
+
20
+ attr_accessor :metadata
21
+
22
+ # Open Task Count
23
+ attr_accessor :open_count
24
+
25
+ # Indicates if API call was successful
26
+ attr_accessor :success
27
+
28
+ attr_accessor :warning
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+ :'error' => :'error',
34
+ :'metadata' => :'metadata',
35
+ :'open_count' => :'open_count',
36
+ :'success' => :'success',
37
+ :'warning' => :'warning'
38
+ }
39
+ end
40
+
41
+ # Returns all the JSON keys this model knows about
42
+ def self.acceptable_attributes
43
+ attribute_map.values
44
+ end
45
+
46
+ # Attribute type mapping.
47
+ def self.openapi_types
48
+ {
49
+ :'error' => :'Error',
50
+ :'metadata' => :'ResponseMetadata',
51
+ :'open_count' => :'Integer',
52
+ :'success' => :'Boolean',
53
+ :'warning' => :'Warning'
54
+ }
55
+ end
56
+
57
+ # List of attributes with nullable: true
58
+ def self.openapi_nullable
59
+ Set.new([
60
+ ])
61
+ end
62
+
63
+ # Initializes the object
64
+ # @param [Hash] attributes Model attributes in the form of hash
65
+ def initialize(attributes = {})
66
+ if (!attributes.is_a?(Hash))
67
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::WorkflowTaskOpenCountResponse` initialize method"
68
+ end
69
+
70
+ # check to see if the attribute exists and convert string to symbol for hash key
71
+ attributes = attributes.each_with_object({}) { |(k, v), h|
72
+ if (!self.class.attribute_map.key?(k.to_sym))
73
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::WorkflowTaskOpenCountResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
74
+ end
75
+ h[k.to_sym] = v
76
+ }
77
+
78
+ if attributes.key?(:'error')
79
+ self.error = attributes[:'error']
80
+ end
81
+
82
+ if attributes.key?(:'metadata')
83
+ self.metadata = attributes[:'metadata']
84
+ end
85
+
86
+ if attributes.key?(:'open_count')
87
+ self.open_count = attributes[:'open_count']
88
+ end
89
+
90
+ if attributes.key?(:'success')
91
+ self.success = attributes[:'success']
92
+ end
93
+
94
+ if attributes.key?(:'warning')
95
+ self.warning = attributes[:'warning']
96
+ end
97
+ end
98
+
99
+ # Show invalid properties with the reasons. Usually used together with valid?
100
+ # @return Array for valid properties with the reasons
101
+ def list_invalid_properties
102
+ invalid_properties = Array.new
103
+ invalid_properties
104
+ end
105
+
106
+ # Check to see if the all the properties in the model are valid
107
+ # @return true if the model is valid
108
+ def valid?
109
+ true
110
+ end
111
+
112
+ # Checks equality by comparing each attribute.
113
+ # @param [Object] Object to be compared
114
+ def ==(o)
115
+ return true if self.equal?(o)
116
+ self.class == o.class &&
117
+ error == o.error &&
118
+ metadata == o.metadata &&
119
+ open_count == o.open_count &&
120
+ success == o.success &&
121
+ warning == o.warning
122
+ end
123
+
124
+ # @see the `==` method
125
+ # @param [Object] Object to be compared
126
+ def eql?(o)
127
+ self == o
128
+ end
129
+
130
+ # Calculates hash code according to all attributes.
131
+ # @return [Integer] Hash code
132
+ def hash
133
+ [error, metadata, open_count, success, warning].hash
134
+ end
135
+
136
+ # Builds the object from hash
137
+ # @param [Hash] attributes Model attributes in the form of hash
138
+ # @return [Object] Returns the model itself
139
+ def self.build_from_hash(attributes)
140
+ new.build_from_hash(attributes)
141
+ end
142
+
143
+ # Builds the object from hash
144
+ # @param [Hash] attributes Model attributes in the form of hash
145
+ # @return [Object] Returns the model itself
146
+ def build_from_hash(attributes)
147
+ return nil unless attributes.is_a?(Hash)
148
+ attributes = attributes.transform_keys(&:to_sym)
149
+ self.class.openapi_types.each_pair do |key, type|
150
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
151
+ self.send("#{key}=", nil)
152
+ elsif type =~ /\AArray<(.*)>/i
153
+ # check to ensure the input is an array given that the attribute
154
+ # is documented as an array but the input is not
155
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
156
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
157
+ end
158
+ elsif !attributes[self.class.attribute_map[key]].nil?
159
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
160
+ end
161
+ end
162
+
163
+ self
164
+ end
165
+
166
+ # Deserializes the data based on type
167
+ # @param string type Data type
168
+ # @param string value Value to be deserialized
169
+ # @return [Object] Deserialized data
170
+ def _deserialize(type, value)
171
+ case type.to_sym
172
+ when :Time
173
+ Time.parse(value)
174
+ when :Date
175
+ Date.parse(value)
176
+ when :String
177
+ value.to_s
178
+ when :Integer
179
+ value.to_i
180
+ when :Float
181
+ value.to_f
182
+ when :Boolean
183
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
184
+ true
185
+ else
186
+ false
187
+ end
188
+ when :Object
189
+ # generic object (usually a Hash), return directly
190
+ value
191
+ when /\AArray<(?<inner_type>.+)>\z/
192
+ inner_type = Regexp.last_match[:inner_type]
193
+ value.map { |v| _deserialize(inner_type, v) }
194
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
195
+ k_type = Regexp.last_match[:k_type]
196
+ v_type = Regexp.last_match[:v_type]
197
+ {}.tap do |hash|
198
+ value.each do |k, v|
199
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
200
+ end
201
+ end
202
+ else # model
203
+ # models (e.g. Pet) or oneOf
204
+ klass = UltracartClient.const_get(type)
205
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
206
+ end
207
+ end
208
+
209
+ # Returns the string representation of the object
210
+ # @return [String] String presentation of the object
211
+ def to_s
212
+ to_hash.to_s
213
+ end
214
+
215
+ # to_body is an alias to to_hash (backward compatibility)
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_body
218
+ to_hash
219
+ end
220
+
221
+ # Returns the object in the form of hash
222
+ # @return [Hash] Returns the object in the form of hash
223
+ def to_hash
224
+ hash = {}
225
+ self.class.attribute_map.each_pair do |attr, param|
226
+ value = self.send(attr)
227
+ if value.nil?
228
+ is_nullable = self.class.openapi_nullable.include?(attr)
229
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
230
+ end
231
+
232
+ hash[param] = _to_hash(value)
233
+ end
234
+ hash
235
+ end
236
+
237
+ # Outputs non-array value in the form of hash
238
+ # For object, use to_hash. Otherwise, just return the value
239
+ # @param [Object] value Any valid value
240
+ # @return [Hash] Returns the value in the form of hash
241
+ def _to_hash(value)
242
+ if value.is_a?(Array)
243
+ value.compact.map { |v| _to_hash(v) }
244
+ elsif value.is_a?(Hash)
245
+ {}.tap do |hash|
246
+ value.each { |k, v| hash[k] = _to_hash(v) }
247
+ end
248
+ elsif value.respond_to? :to_hash
249
+ value.to_hash
250
+ else
251
+ value
252
+ end
253
+ end
254
+
255
+ end
256
+
257
+ end
@@ -19,6 +19,9 @@ module UltracartClient
19
19
 
20
20
  attr_accessor :metadata
21
21
 
22
+ # User ID of myself
23
+ attr_accessor :my_user_id
24
+
22
25
  # Indicates if API call was successful
23
26
  attr_accessor :success
24
27
 
@@ -32,6 +35,7 @@ module UltracartClient
32
35
  {
33
36
  :'error' => :'error',
34
37
  :'metadata' => :'metadata',
38
+ :'my_user_id' => :'my_user_id',
35
39
  :'success' => :'success',
36
40
  :'users' => :'users',
37
41
  :'warning' => :'warning'
@@ -48,6 +52,7 @@ module UltracartClient
48
52
  {
49
53
  :'error' => :'Error',
50
54
  :'metadata' => :'ResponseMetadata',
55
+ :'my_user_id' => :'Integer',
51
56
  :'success' => :'Boolean',
52
57
  :'users' => :'Array<WorkflowUser>',
53
58
  :'warning' => :'Warning'
@@ -83,6 +88,10 @@ module UltracartClient
83
88
  self.metadata = attributes[:'metadata']
84
89
  end
85
90
 
91
+ if attributes.key?(:'my_user_id')
92
+ self.my_user_id = attributes[:'my_user_id']
93
+ end
94
+
86
95
  if attributes.key?(:'success')
87
96
  self.success = attributes[:'success']
88
97
  end
@@ -118,6 +127,7 @@ module UltracartClient
118
127
  self.class == o.class &&
119
128
  error == o.error &&
120
129
  metadata == o.metadata &&
130
+ my_user_id == o.my_user_id &&
121
131
  success == o.success &&
122
132
  users == o.users &&
123
133
  warning == o.warning
@@ -132,7 +142,7 @@ module UltracartClient
132
142
  # Calculates hash code according to all attributes.
133
143
  # @return [Integer] Hash code
134
144
  def hash
135
- [error, metadata, success, users, warning].hash
145
+ [error, metadata, my_user_id, success, users, warning].hash
136
146
  end
137
147
 
138
148
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.0.203'
14
+ VERSION = '4.0.205'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -849,6 +849,7 @@ require 'ultracart_api/models/workflow_groups_response'
849
849
  require 'ultracart_api/models/workflow_note'
850
850
  require 'ultracart_api/models/workflow_task'
851
851
  require 'ultracart_api/models/workflow_task_history'
852
+ require 'ultracart_api/models/workflow_task_open_count_response'
852
853
  require 'ultracart_api/models/workflow_task_response'
853
854
  require 'ultracart_api/models/workflow_task_tags_response'
854
855
  require 'ultracart_api/models/workflow_tasks_request'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.203
4
+ version: 4.0.205
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-15 00:00:00.000000000 Z
11
+ date: 2024-03-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -914,6 +914,7 @@ files:
914
914
  - docs/WorkflowNote.md
915
915
  - docs/WorkflowTask.md
916
916
  - docs/WorkflowTaskHistory.md
917
+ - docs/WorkflowTaskOpenCountResponse.md
917
918
  - docs/WorkflowTaskResponse.md
918
919
  - docs/WorkflowTaskTagsResponse.md
919
920
  - docs/WorkflowTasksRequest.md
@@ -1779,6 +1780,7 @@ files:
1779
1780
  - lib/ultracart_api/models/workflow_note.rb
1780
1781
  - lib/ultracart_api/models/workflow_task.rb
1781
1782
  - lib/ultracart_api/models/workflow_task_history.rb
1783
+ - lib/ultracart_api/models/workflow_task_open_count_response.rb
1782
1784
  - lib/ultracart_api/models/workflow_task_response.rb
1783
1785
  - lib/ultracart_api/models/workflow_task_tags_response.rb
1784
1786
  - lib/ultracart_api/models/workflow_tasks_request.rb