ultracart_api 4.0.208 → 4.0.210
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 +4 -4
- data/README.md +19 -4
- data/docs/AutoOrder.md +2 -0
- data/docs/AutoOrderItem.md +4 -0
- data/docs/ConversationApi.md +575 -0
- data/docs/ConversationPbxVoicemailMessage.md +42 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +36 -0
- data/docs/ItemApi.md +73 -0
- data/docs/WorkflowTask.md +2 -2
- data/docs/WorkflowTasksRequest.md +4 -0
- data/lib/ultracart_api/api/conversation_api.rb +524 -0
- data/lib/ultracart_api/api/item_api.rb +75 -0
- data/lib/ultracart_api/models/auto_order.rb +11 -1
- data/lib/ultracart_api/models/auto_order_item.rb +21 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +374 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +344 -0
- data/lib/ultracart_api/models/workflow_task.rb +2 -2
- data/lib/ultracart_api/models/workflow_tasks_request.rb +21 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **voicemail_message** | [**ConversationPbxVoicemailMessage**](ConversationPbxVoicemailMessage.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxVoicemailMessageResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
voicemail_message: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummariesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **voicemail_message_summaries** | [**Array<ConversationPbxVoicemailMessageSummary>**](ConversationPbxVoicemailMessageSummary.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxVoicemailMessageSummariesResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
voicemail_message_summaries: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_sid** | **String** | Call SID | [optional] |
|
8
|
+
| **duration** | **Integer** | Duration in seconds | [optional] |
|
9
|
+
| **from** | **String** | From phone number in E.164 | [optional] |
|
10
|
+
| **from_caller_id** | **String** | From caller id (if available) | [optional] |
|
11
|
+
| **listened** | **Boolean** | True if the voicemail has been listened to in the user interface | [optional] |
|
12
|
+
| **merchant_id** | **String** | Merchant ID | [optional] |
|
13
|
+
| **recording_sid** | **String** | Recording SID | [optional] |
|
14
|
+
| **recording_size_bytes** | **Integer** | Recording size in bytes | [optional] |
|
15
|
+
| **recording_status** | **String** | Recording Status | [optional] |
|
16
|
+
| **voicemail_dts** | **String** | Voicemail date/time | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'ultracart_api'
|
22
|
+
|
23
|
+
instance = UltracartClient::ConversationPbxVoicemailMessageSummary.new(
|
24
|
+
call_sid: null,
|
25
|
+
duration: null,
|
26
|
+
from: null,
|
27
|
+
from_caller_id: null,
|
28
|
+
listened: null,
|
29
|
+
merchant_id: null,
|
30
|
+
recording_sid: null,
|
31
|
+
recording_size_bytes: null,
|
32
|
+
recording_status: null,
|
33
|
+
voicemail_dts: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/ItemApi.md
CHANGED
@@ -20,6 +20,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
20
20
|
| [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library |
|
21
21
|
| [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
|
22
22
|
| [**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review |
|
23
|
+
| [**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute |
|
23
24
|
| [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
|
24
25
|
| [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
|
25
26
|
| [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
|
@@ -1226,6 +1227,78 @@ end
|
|
1226
1227
|
- **Accept**: application/json
|
1227
1228
|
|
1228
1229
|
|
1230
|
+
## insert_update_item_content_attribute
|
1231
|
+
|
1232
|
+
> insert_update_item_content_attribute(merchant_item_oid, item_attribute)
|
1233
|
+
|
1234
|
+
Upsert an item content attribute
|
1235
|
+
|
1236
|
+
Update an item content attribute, creating it new if it does not yet exist.
|
1237
|
+
|
1238
|
+
### Examples
|
1239
|
+
|
1240
|
+
```ruby
|
1241
|
+
require 'time'
|
1242
|
+
require 'ultracart_api'
|
1243
|
+
require 'json'
|
1244
|
+
require 'yaml'
|
1245
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1246
|
+
|
1247
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1248
|
+
# As such, this might not be the best way to use this object.
|
1249
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1250
|
+
|
1251
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1252
|
+
merchant_item_oid = 56 # Integer | The item oid to modify.
|
1253
|
+
item_attribute = UltracartClient::ItemContentAttribute.new # ItemContentAttribute | Item content attribute to upsert
|
1254
|
+
|
1255
|
+
begin
|
1256
|
+
# Upsert an item content attribute
|
1257
|
+
api_instance.insert_update_item_content_attribute(merchant_item_oid, item_attribute)
|
1258
|
+
rescue UltracartClient::ApiError => e
|
1259
|
+
puts "Error when calling ItemApi->insert_update_item_content_attribute: #{e}"
|
1260
|
+
end
|
1261
|
+
```
|
1262
|
+
|
1263
|
+
#### Using the insert_update_item_content_attribute_with_http_info variant
|
1264
|
+
|
1265
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1266
|
+
|
1267
|
+
> <Array(nil, Integer, Hash)> insert_update_item_content_attribute_with_http_info(merchant_item_oid, item_attribute)
|
1268
|
+
|
1269
|
+
```ruby
|
1270
|
+
begin
|
1271
|
+
# Upsert an item content attribute
|
1272
|
+
data, status_code, headers = api_instance.insert_update_item_content_attribute_with_http_info(merchant_item_oid, item_attribute)
|
1273
|
+
p status_code # => 2xx
|
1274
|
+
p headers # => { ... }
|
1275
|
+
p data # => nil
|
1276
|
+
rescue UltracartClient::ApiError => e
|
1277
|
+
puts "Error when calling ItemApi->insert_update_item_content_attribute_with_http_info: #{e}"
|
1278
|
+
end
|
1279
|
+
```
|
1280
|
+
|
1281
|
+
### Parameters
|
1282
|
+
|
1283
|
+
| Name | Type | Description | Notes |
|
1284
|
+
| ---- | ---- | ----------- | ----- |
|
1285
|
+
| **merchant_item_oid** | **Integer** | The item oid to modify. | |
|
1286
|
+
| **item_attribute** | [**ItemContentAttribute**](ItemContentAttribute.md) | Item content attribute to upsert | |
|
1287
|
+
|
1288
|
+
### Return type
|
1289
|
+
|
1290
|
+
nil (empty response body)
|
1291
|
+
|
1292
|
+
### Authorization
|
1293
|
+
|
1294
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1295
|
+
|
1296
|
+
### HTTP request headers
|
1297
|
+
|
1298
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1299
|
+
- **Accept**: application/json
|
1300
|
+
|
1301
|
+
|
1229
1302
|
## update_digital_item
|
1230
1303
|
|
1231
1304
|
> <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)
|
data/docs/WorkflowTask.md
CHANGED
@@ -16,14 +16,14 @@
|
|
16
16
|
| **dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional] |
|
17
17
|
| **due_dts** | **String** | Date/time that the workflow task is due | [optional] |
|
18
18
|
| **expiration_dts** | **String** | Date/time that the workflow task will expire and be closed. This is set by system generated tasks. | [optional] |
|
19
|
-
| **global_task_number** | **Integer** | Global task
|
19
|
+
| **global_task_number** | **Integer** | Global task number | [optional] |
|
20
20
|
| **histories** | [**Array<WorkflowTaskHistory>**](WorkflowTaskHistory.md) | Array of history records for the task | [optional] |
|
21
21
|
| **last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional] |
|
22
22
|
| **merchant_id** | **String** | Merchant ID | [optional] |
|
23
23
|
| **notes** | [**Array<WorkflowNote>**](WorkflowNote.md) | Notes on the Workflow Task | [optional] |
|
24
24
|
| **object_email** | **String** | Object is associated with customer email | [optional] |
|
25
25
|
| **object_id** | **String** | Object ID | [optional] |
|
26
|
-
| **object_task_number** | **Integer** | Object specific task
|
26
|
+
| **object_task_number** | **Integer** | Object specific task number | [optional] |
|
27
27
|
| **object_type** | **String** | Object Type | [optional] |
|
28
28
|
| **object_url** | **String** | Object URL | [optional] |
|
29
29
|
| **priority** | **String** | Priority | [optional] |
|
@@ -4,8 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **assigned_to_group** | **String** | Assigned to group | [optional] |
|
7
8
|
| **assigned_to_group_id** | **Integer** | Assigned to group ID | [optional] |
|
8
9
|
| **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] |
|
10
|
+
| **assigned_to_user** | **String** | Assigned to user | [optional] |
|
9
11
|
| **assigned_to_user_id** | **Integer** | Assigned to user ID | [optional] |
|
10
12
|
| **created_by** | [**WorkflowUser**](WorkflowUser.md) | | [optional] |
|
11
13
|
| **created_dts_begin** | **String** | Date/time that the workflow task was created | [optional] |
|
@@ -29,8 +31,10 @@
|
|
29
31
|
require 'ultracart_api'
|
30
32
|
|
31
33
|
instance = UltracartClient::WorkflowTasksRequest.new(
|
34
|
+
assigned_to_group: null,
|
32
35
|
assigned_to_group_id: null,
|
33
36
|
assigned_to_me: null,
|
37
|
+
assigned_to_user: null,
|
34
38
|
assigned_to_user_id: null,
|
35
39
|
created_by: null,
|
36
40
|
created_dts_begin: null,
|