ultracart_api 4.0.200 → 4.0.202
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 +88 -4
- data/docs/ConversationApi.md +3565 -549
- data/docs/ConversationPbxAgent.md +34 -0
- data/docs/ConversationPbxAgentResponse.md +26 -0
- data/docs/ConversationPbxAgentsResponse.md +26 -0
- data/docs/ConversationPbxAudio.md +34 -0
- data/docs/ConversationPbxAudioResponse.md +26 -0
- data/docs/ConversationPbxAudiosResponse.md +26 -0
- data/docs/ConversationPbxCustomerSnapshotRequest.md +32 -0
- data/docs/ConversationPbxCustomerSnapshotResponse.md +30 -0
- data/docs/ConversationPbxMenu.md +36 -0
- data/docs/ConversationPbxMenuMapping.md +24 -0
- data/docs/ConversationPbxMenuResponse.md +26 -0
- data/docs/ConversationPbxMenusResponse.md +26 -0
- data/docs/ConversationPbxPhoneNumber.md +26 -0
- data/docs/ConversationPbxPhoneNumberResponse.md +26 -0
- data/docs/ConversationPbxPhoneNumbersResponse.md +26 -0
- data/docs/ConversationPbxQueue.md +52 -0
- data/docs/ConversationPbxQueueMembers.md +20 -0
- data/docs/ConversationPbxQueueResponse.md +26 -0
- data/docs/ConversationPbxQueuesResponse.md +26 -0
- data/docs/ConversationPbxTimeBased.md +24 -0
- data/docs/ConversationPbxTimeBasedMapping.md +24 -0
- data/docs/ConversationPbxTimeBasedMappingConfig.md +20 -0
- data/docs/ConversationPbxTimeBasedResponse.md +26 -0
- data/docs/ConversationPbxTimeBasedsResponse.md +26 -0
- data/docs/ConversationPbxTimeRange.md +26 -0
- data/docs/ConversationPbxTimeRangeConfig.md +28 -0
- data/docs/ConversationPbxTimeRangeResponse.md +26 -0
- data/docs/ConversationPbxTimeRangesResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMailbox.md +38 -0
- data/docs/ConversationPbxVoicemailMailboxResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMailboxesResponse.md +26 -0
- data/docs/EmailSmsOrder.md +24 -0
- data/docs/EmailSmsOrdersResponse.md +26 -0
- data/docs/EmailSmsStat.md +76 -0
- data/docs/EmailStatSmsSummaryRequest.md +20 -0
- data/docs/EmailStatSmsSummaryResponse.md +26 -0
- data/docs/PricingTier.md +2 -0
- data/docs/StorefrontApi.md +152 -0
- data/docs/WorkflowApi.md +69 -0
- data/docs/WorkflowTaskTagsResponse.md +26 -0
- data/lib/ultracart_api/api/conversation_api.rb +3422 -649
- data/lib/ultracart_api/api/storefront_api.rb +156 -0
- data/lib/ultracart_api/api/workflow_api.rb +58 -0
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +360 -0
- data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_audio.rb +390 -0
- data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +283 -0
- data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +278 -0
- data/lib/ultracart_api/models/conversation_pbx_menu.rb +402 -0
- data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +250 -0
- data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +335 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +539 -0
- data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +232 -0
- data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based.rb +246 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +310 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +231 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_time_range.rb +322 -0
- data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +270 -0
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +440 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +258 -0
- data/lib/ultracart_api/models/email_sms_order.rb +249 -0
- data/lib/ultracart_api/models/email_sms_orders_response.rb +258 -0
- data/lib/ultracart_api/models/email_sms_stat.rb +511 -0
- data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +230 -0
- data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +258 -0
- data/lib/ultracart_api/models/pricing_tier.rb +11 -1
- data/lib/ultracart_api/models/workflow_task_tags_response.rb +259 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +37 -0
- metadata +76 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxTimeBasedsResponse
|
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
|
+
| **time_baseds** | [**Array<ConversationPbxTimeBased>**](ConversationPbxTimeBased.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxTimeBasedsResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
time_baseds: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxTimeRange
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **configs** | [**Array<ConversationPbxTimeRangeConfig>**](ConversationPbxTimeRangeConfig.md) | Configurations for all ranges in this time range | [optional] |
|
8
|
+
| **conversation_pbx_time_range_uuid** | **String** | Conversation Pbx Time Range UUID | [optional] |
|
9
|
+
| **merchant_id** | **String** | Merchant Id | [optional] |
|
10
|
+
| **time_range_name** | **String** | Time range name | [optional] |
|
11
|
+
| **timezone** | **String** | Timezone | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxTimeRange.new(
|
19
|
+
configs: null,
|
20
|
+
conversation_pbx_time_range_uuid: null,
|
21
|
+
merchant_id: null,
|
22
|
+
time_range_name: null,
|
23
|
+
timezone: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# UltracartClient::ConversationPbxTimeRangeConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **end_date** | **String** | End date | [optional] |
|
8
|
+
| **end_day_of_week** | **Integer** | End day of week | [optional] |
|
9
|
+
| **end_time** | **String** | End time | [optional] |
|
10
|
+
| **start_date** | **String** | Start date | [optional] |
|
11
|
+
| **start_day_of_week** | **Integer** | Start day of week | [optional] |
|
12
|
+
| **start_time** | **String** | Start time | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ultracart_api'
|
18
|
+
|
19
|
+
instance = UltracartClient::ConversationPbxTimeRangeConfig.new(
|
20
|
+
end_date: null,
|
21
|
+
end_day_of_week: null,
|
22
|
+
end_time: null,
|
23
|
+
start_date: null,
|
24
|
+
start_day_of_week: null,
|
25
|
+
start_time: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxTimeRangeResponse
|
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
|
+
| **time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxTimeRangeResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
time_range: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxTimeRangesResponse
|
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
|
+
| **time_ranges** | [**Array<ConversationPbxTimeRange>**](ConversationPbxTimeRange.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxTimeRangesResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
time_ranges: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMailbox
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional] |
|
8
|
+
| **merchant_id** | **String** | Merchant Id | [optional] |
|
9
|
+
| **send_notices_to_email** | **String** | Send notices to email | [optional] |
|
10
|
+
| **user_id** | **Integer** | User Id | [optional] |
|
11
|
+
| **voicemail_follow_play_audio_uuid** | **String** | Voicemail follow play audio UUID | [optional] |
|
12
|
+
| **voicemail_followup_say** | **String** | Voicemail followup say | [optional] |
|
13
|
+
| **voicemail_mailbox_id** | **String** | Voicemail mailbox id | [optional] |
|
14
|
+
| **voicemail_mailbox_type** | **String** | Voicemail mailbox type | [optional] |
|
15
|
+
| **voicemail_prompt_play_audio_uuid** | **String** | Voicemail prompt play audio UUID | [optional] |
|
16
|
+
| **voicemail_prompt_say** | **String** | Voicemail prompt say | [optional] |
|
17
|
+
| **voicemail_say_voice** | **String** | Voicemail say voice | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'ultracart_api'
|
23
|
+
|
24
|
+
instance = UltracartClient::ConversationPbxVoicemailMailbox.new(
|
25
|
+
conversation_pbx_voicemail_mailbox_uuid: null,
|
26
|
+
merchant_id: null,
|
27
|
+
send_notices_to_email: null,
|
28
|
+
user_id: null,
|
29
|
+
voicemail_follow_play_audio_uuid: null,
|
30
|
+
voicemail_followup_say: null,
|
31
|
+
voicemail_mailbox_id: null,
|
32
|
+
voicemail_mailbox_type: null,
|
33
|
+
voicemail_prompt_play_audio_uuid: null,
|
34
|
+
voicemail_prompt_say: null,
|
35
|
+
voicemail_say_voice: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMailboxResponse
|
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_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxVoicemailMailboxResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
voicemail_mailbox: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMailboxesResponse
|
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_mailboxes** | [**Array<ConversationPbxVoicemailMailbox>**](ConversationPbxVoicemailMailbox.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxVoicemailMailboxesResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
voicemail_mailboxes: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# UltracartClient::EmailSmsOrder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | email | [optional] |
|
8
|
+
| **order_dts** | **String** | order_dts | [optional] |
|
9
|
+
| **order_id** | **String** | order_id | [optional] |
|
10
|
+
| **total** | [**Currency**](Currency.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ultracart_api'
|
16
|
+
|
17
|
+
instance = UltracartClient::EmailSmsOrder.new(
|
18
|
+
email: null,
|
19
|
+
order_dts: null,
|
20
|
+
order_id: null,
|
21
|
+
total: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::EmailSmsOrdersResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **orders** | [**Array<EmailSmsOrder>**](EmailSmsOrder.md) | | [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::EmailSmsOrdersResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
orders: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# UltracartClient::EmailSmsStat
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **click_count** | **Integer** | Count of clicked emails | [optional] |
|
8
|
+
| **click_count_formatted** | **String** | Count of clicked emails, formatted | [optional] |
|
9
|
+
| **conversion_count** | **Integer** | Count of conversions | [optional] |
|
10
|
+
| **conversion_count_formatted** | **String** | Count of conversions, formatted | [optional] |
|
11
|
+
| **deleted** | **Boolean** | True if campaign/flow has been archived | [optional] |
|
12
|
+
| **delivered_count** | **Integer** | Count of delivered emails | [optional] |
|
13
|
+
| **delivered_count_formatted** | **String** | Count of delivered emails, formatted | [optional] |
|
14
|
+
| **merchant_id** | **String** | Merchant ID | [optional] |
|
15
|
+
| **name** | **String** | List or segment name | [optional] |
|
16
|
+
| **order_count** | **Integer** | Count of orders | [optional] |
|
17
|
+
| **order_count_formatted** | **String** | Count of orders, formatted | [optional] |
|
18
|
+
| **profit** | **Float** | Profit | [optional] |
|
19
|
+
| **profit_formatted** | **String** | Profit, formatted | [optional] |
|
20
|
+
| **revenue** | **Float** | Revenue | [optional] |
|
21
|
+
| **revenue_formatted** | **String** | Revenue, formatted | [optional] |
|
22
|
+
| **send_count** | **Integer** | Count of emails sent | [optional] |
|
23
|
+
| **send_count_formatted** | **String** | Count of emails sent, formatted | [optional] |
|
24
|
+
| **skipped_count** | **Integer** | Count of skipped emails | [optional] |
|
25
|
+
| **skipped_count_formatted** | **String** | Count of skipped emails, formatted | [optional] |
|
26
|
+
| **stat_type** | **String** | Campaign, Flow or None (for anything else) | [optional] |
|
27
|
+
| **status** | **String** | Status of campaign or flow | [optional] |
|
28
|
+
| **status_dts** | **String** | Status dts of campaign or flow | [optional] |
|
29
|
+
| **step_uuid** | **String** | Step UUID if the statistics are at the step/email level | [optional] |
|
30
|
+
| **steps** | [**Array<EmailSmsStat>**](EmailSmsStat.md) | | [optional] |
|
31
|
+
| **storefront_oid** | **Integer** | Storefront oid | [optional] |
|
32
|
+
| **unsubscribe_count** | **Integer** | Count of emails classified as unsubscribe | [optional] |
|
33
|
+
| **unsubscribe_count_formatted** | **String** | Count of emails classified as unsubscribe, formatted | [optional] |
|
34
|
+
| **uuid** | **String** | List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation. | [optional] |
|
35
|
+
| **view_count** | **Integer** | Count of views | [optional] |
|
36
|
+
| **view_count_formatted** | **String** | Count of views, formatted | [optional] |
|
37
|
+
|
38
|
+
## Example
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
require 'ultracart_api'
|
42
|
+
|
43
|
+
instance = UltracartClient::EmailSmsStat.new(
|
44
|
+
click_count: null,
|
45
|
+
click_count_formatted: null,
|
46
|
+
conversion_count: null,
|
47
|
+
conversion_count_formatted: null,
|
48
|
+
deleted: null,
|
49
|
+
delivered_count: null,
|
50
|
+
delivered_count_formatted: null,
|
51
|
+
merchant_id: null,
|
52
|
+
name: null,
|
53
|
+
order_count: null,
|
54
|
+
order_count_formatted: null,
|
55
|
+
profit: null,
|
56
|
+
profit_formatted: null,
|
57
|
+
revenue: null,
|
58
|
+
revenue_formatted: null,
|
59
|
+
send_count: null,
|
60
|
+
send_count_formatted: null,
|
61
|
+
skipped_count: null,
|
62
|
+
skipped_count_formatted: null,
|
63
|
+
stat_type: null,
|
64
|
+
status: null,
|
65
|
+
status_dts: null,
|
66
|
+
step_uuid: null,
|
67
|
+
steps: null,
|
68
|
+
storefront_oid: null,
|
69
|
+
unsubscribe_count: null,
|
70
|
+
unsubscribe_count_formatted: null,
|
71
|
+
uuid: null,
|
72
|
+
view_count: null,
|
73
|
+
view_count_formatted: null
|
74
|
+
)
|
75
|
+
```
|
76
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::EmailStatSmsSummaryRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **commseq_step_uuids** | **Array<String>** | | [optional] |
|
8
|
+
| **days** | **Integer** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::EmailStatSmsSummaryRequest.new(
|
16
|
+
commseq_step_uuids: null,
|
17
|
+
days: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::EmailStatSmsSummaryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **stats** | [**Array<EmailSmsStat>**](EmailSmsStat.md) | | [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::EmailStatSmsSummaryResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
stats: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/PricingTier.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **approval_notification** | [**PricingTierNotification**](PricingTierNotification.md) | | [optional] |
|
12
12
|
| **auto_approve_cod** | **Boolean** | Auto approve COD | [optional] |
|
13
13
|
| **auto_approve_purchase_order** | **Boolean** | Auto approve purchase order | [optional] |
|
14
|
+
| **currency_code** | **String** | Any currency code specified on this pricing tier will force a shopping cart into that currency | [optional] |
|
14
15
|
| **default_on_wholesale_signup** | **Boolean** | Default on wholesale signup | [optional] |
|
15
16
|
| **default_percentage_discount** | **Float** | Default percentage discount | [optional] |
|
16
17
|
| **default_shipping_method_oid** | **Integer** | Default shipping method oid | [optional] |
|
@@ -51,6 +52,7 @@ instance = UltracartClient::PricingTier.new(
|
|
51
52
|
approval_notification: null,
|
52
53
|
auto_approve_cod: null,
|
53
54
|
auto_approve_purchase_order: null,
|
55
|
+
currency_code: null,
|
54
56
|
default_on_wholesale_signup: null,
|
55
57
|
default_percentage_discount: null,
|
56
58
|
default_shipping_method_oid: null,
|
data/docs/StorefrontApi.md
CHANGED
@@ -47,6 +47,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
47
47
|
| [**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats |
|
48
48
|
| [**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats |
|
49
49
|
| [**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking |
|
50
|
+
| [**get_email_commseq_sms_stats**](StorefrontApi.md#get_email_commseq_sms_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats | Get email communication sequence sms stats |
|
50
51
|
| [**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall |
|
51
52
|
| [**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats |
|
52
53
|
| [**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step |
|
@@ -88,6 +89,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
88
89
|
| [**get_email_sending_domain_status**](StorefrontApi.md#get_email_sending_domain_status) | **POST** /storefront/email/sending_domains/{domain}/status | Get email sending domain status |
|
89
90
|
| [**get_email_sending_domains**](StorefrontApi.md#get_email_sending_domains) | **GET** /storefront/email/sending_domains | Get email sending domains |
|
90
91
|
| [**get_email_settings**](StorefrontApi.md#get_email_settings) | **GET** /storefront/{storefront_oid}/email/settings | Get email settings |
|
92
|
+
| [**get_email_sms_orders**](StorefrontApi.md#get_email_sms_orders) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders | Get email sms orders |
|
91
93
|
| [**get_email_template**](StorefrontApi.md#get_email_template) | **GET** /storefront/{storefront_oid}/email/templates/{email_template_oid} | Get email template |
|
92
94
|
| [**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates |
|
93
95
|
| [**get_email_third_party_providers**](StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers |
|
@@ -3228,6 +3230,79 @@ end
|
|
3228
3230
|
- **Accept**: application/json
|
3229
3231
|
|
3230
3232
|
|
3233
|
+
## get_email_commseq_sms_stats
|
3234
|
+
|
3235
|
+
> <EmailStatSmsSummaryResponse> get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
|
3236
|
+
|
3237
|
+
Get email communication sequence sms stats
|
3238
|
+
|
3239
|
+
### Examples
|
3240
|
+
|
3241
|
+
```ruby
|
3242
|
+
require 'time'
|
3243
|
+
require 'ultracart_api'
|
3244
|
+
require 'json'
|
3245
|
+
require 'yaml'
|
3246
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
3247
|
+
|
3248
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
3249
|
+
# As such, this might not be the best way to use this object.
|
3250
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
3251
|
+
|
3252
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
3253
|
+
storefront_oid = 56 # Integer |
|
3254
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
3255
|
+
stats_request = UltracartClient::EmailStatSmsSummaryRequest.new # EmailStatSmsSummaryRequest | StatsRequest
|
3256
|
+
|
3257
|
+
begin
|
3258
|
+
# Get email communication sequence sms stats
|
3259
|
+
result = api_instance.get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
|
3260
|
+
p result
|
3261
|
+
rescue UltracartClient::ApiError => e
|
3262
|
+
puts "Error when calling StorefrontApi->get_email_commseq_sms_stats: #{e}"
|
3263
|
+
end
|
3264
|
+
```
|
3265
|
+
|
3266
|
+
#### Using the get_email_commseq_sms_stats_with_http_info variant
|
3267
|
+
|
3268
|
+
This returns an Array which contains the response data, status code and headers.
|
3269
|
+
|
3270
|
+
> <Array(<EmailStatSmsSummaryResponse>, Integer, Hash)> get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request)
|
3271
|
+
|
3272
|
+
```ruby
|
3273
|
+
begin
|
3274
|
+
# Get email communication sequence sms stats
|
3275
|
+
data, status_code, headers = api_instance.get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request)
|
3276
|
+
p status_code # => 2xx
|
3277
|
+
p headers # => { ... }
|
3278
|
+
p data # => <EmailStatSmsSummaryResponse>
|
3279
|
+
rescue UltracartClient::ApiError => e
|
3280
|
+
puts "Error when calling StorefrontApi->get_email_commseq_sms_stats_with_http_info: #{e}"
|
3281
|
+
end
|
3282
|
+
```
|
3283
|
+
|
3284
|
+
### Parameters
|
3285
|
+
|
3286
|
+
| Name | Type | Description | Notes |
|
3287
|
+
| ---- | ---- | ----------- | ----- |
|
3288
|
+
| **storefront_oid** | **Integer** | | |
|
3289
|
+
| **commseq_uuid** | **String** | | |
|
3290
|
+
| **stats_request** | [**EmailStatSmsSummaryRequest**](EmailStatSmsSummaryRequest.md) | StatsRequest | |
|
3291
|
+
|
3292
|
+
### Return type
|
3293
|
+
|
3294
|
+
[**EmailStatSmsSummaryResponse**](EmailStatSmsSummaryResponse.md)
|
3295
|
+
|
3296
|
+
### Authorization
|
3297
|
+
|
3298
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3299
|
+
|
3300
|
+
### HTTP request headers
|
3301
|
+
|
3302
|
+
- **Content-Type**: application/json
|
3303
|
+
- **Accept**: application/json
|
3304
|
+
|
3305
|
+
|
3231
3306
|
## get_email_commseq_stat_overall
|
3232
3307
|
|
3233
3308
|
> <EmailCommseqStatResponse> get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
|
@@ -6153,6 +6228,83 @@ end
|
|
6153
6228
|
- **Accept**: application/json
|
6154
6229
|
|
6155
6230
|
|
6231
|
+
## get_email_sms_orders
|
6232
|
+
|
6233
|
+
> <EmailSmsOrdersResponse> get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
6234
|
+
|
6235
|
+
Get email sms orders
|
6236
|
+
|
6237
|
+
### Examples
|
6238
|
+
|
6239
|
+
```ruby
|
6240
|
+
require 'time'
|
6241
|
+
require 'ultracart_api'
|
6242
|
+
require 'json'
|
6243
|
+
require 'yaml'
|
6244
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
6245
|
+
|
6246
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
6247
|
+
# As such, this might not be the best way to use this object.
|
6248
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
6249
|
+
|
6250
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
6251
|
+
storefront_oid = 56 # Integer |
|
6252
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
6253
|
+
commseq_step_uuid = 'commseq_step_uuid_example' # String |
|
6254
|
+
opts = {
|
6255
|
+
days: 56 # Integer |
|
6256
|
+
}
|
6257
|
+
|
6258
|
+
begin
|
6259
|
+
# Get email sms orders
|
6260
|
+
result = api_instance.get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
6261
|
+
p result
|
6262
|
+
rescue UltracartClient::ApiError => e
|
6263
|
+
puts "Error when calling StorefrontApi->get_email_sms_orders: #{e}"
|
6264
|
+
end
|
6265
|
+
```
|
6266
|
+
|
6267
|
+
#### Using the get_email_sms_orders_with_http_info variant
|
6268
|
+
|
6269
|
+
This returns an Array which contains the response data, status code and headers.
|
6270
|
+
|
6271
|
+
> <Array(<EmailSmsOrdersResponse>, Integer, Hash)> get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
6272
|
+
|
6273
|
+
```ruby
|
6274
|
+
begin
|
6275
|
+
# Get email sms orders
|
6276
|
+
data, status_code, headers = api_instance.get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
6277
|
+
p status_code # => 2xx
|
6278
|
+
p headers # => { ... }
|
6279
|
+
p data # => <EmailSmsOrdersResponse>
|
6280
|
+
rescue UltracartClient::ApiError => e
|
6281
|
+
puts "Error when calling StorefrontApi->get_email_sms_orders_with_http_info: #{e}"
|
6282
|
+
end
|
6283
|
+
```
|
6284
|
+
|
6285
|
+
### Parameters
|
6286
|
+
|
6287
|
+
| Name | Type | Description | Notes |
|
6288
|
+
| ---- | ---- | ----------- | ----- |
|
6289
|
+
| **storefront_oid** | **Integer** | | |
|
6290
|
+
| **commseq_uuid** | **String** | | |
|
6291
|
+
| **commseq_step_uuid** | **String** | | |
|
6292
|
+
| **days** | **Integer** | | [optional] |
|
6293
|
+
|
6294
|
+
### Return type
|
6295
|
+
|
6296
|
+
[**EmailSmsOrdersResponse**](EmailSmsOrdersResponse.md)
|
6297
|
+
|
6298
|
+
### Authorization
|
6299
|
+
|
6300
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
6301
|
+
|
6302
|
+
### HTTP request headers
|
6303
|
+
|
6304
|
+
- **Content-Type**: Not defined
|
6305
|
+
- **Accept**: application/json
|
6306
|
+
|
6307
|
+
|
6156
6308
|
## get_email_template
|
6157
6309
|
|
6158
6310
|
> <EmailTemplate> get_email_template(storefront_oid, email_template_oid)
|