ultracart_api 4.0.199 → 4.0.201
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/ConversationAgentAuth.md +8 -0
- data/docs/CouponAmountOffItems.md +2 -0
- data/docs/CouponBuyOneGetOneLimit.md +2 -0
- data/docs/CouponDiscountItemWithItemPurchase.md +5 -1
- data/docs/CouponFreeItemWithItemPurchase.md +5 -1
- data/docs/CouponPercentOffItemsWithItemsPurchase.md +5 -1
- 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/Twilio.md +19 -1
- data/lib/ultracart_api/api/storefront_api.rb +156 -0
- data/lib/ultracart_api/models/conversation_agent_auth.rb +37 -1
- data/lib/ultracart_api/models/coupon_amount_off_items.rb +13 -1
- data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +13 -1
- data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +28 -4
- data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +28 -4
- data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +28 -4
- 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/twilio.rb +85 -4
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 64c2440e0524e4c5151fcdcc4efa334dea9c805e90fc8206b1a974f96295aabe
|
4
|
+
data.tar.gz: e980f4b50904a17e183c0de7d3bc11649befbf90e8c8e48248fd61dd1648e1a1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1b20ad3137a4aec685a0a888b6ff6121a52b25d13893d1f45cc78d7bdf1863ba311b3ae3390e2a0ee165fdad908b80d07d97a09ab73837d9d94059eda4d3a62c
|
7
|
+
data.tar.gz: 956bfccd5ff5ab8602923b6b4522cd42dd02c21b27408a9cf53539dd5e3de9eb7bb463e6533af836a9f39a08ee9fdaf1215a16e7141ef1de964439abcbb95968
|
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.
|
10
|
+
- Package version: 4.0.201
|
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.
|
27
|
+
gem install ./ultracart_api-4.0.201.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.201.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.
|
36
|
+
gem 'ultracart_api', '~> 4.0.201'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -342,6 +342,7 @@ Class | Method | HTTP request | Description
|
|
342
342
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
|
343
343
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
|
344
344
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
|
345
|
+
*UltracartClient::StorefrontApi* | [**get_email_commseq_sms_stats**](docs/StorefrontApi.md#get_email_commseq_sms_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats | Get email communication sequence sms stats
|
345
346
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
346
347
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
347
348
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/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
|
@@ -383,6 +384,7 @@ Class | Method | HTTP request | Description
|
|
383
384
|
*UltracartClient::StorefrontApi* | [**get_email_sending_domain_status**](docs/StorefrontApi.md#get_email_sending_domain_status) | **POST** /storefront/email/sending_domains/{domain}/status | Get email sending domain status
|
384
385
|
*UltracartClient::StorefrontApi* | [**get_email_sending_domains**](docs/StorefrontApi.md#get_email_sending_domains) | **GET** /storefront/email/sending_domains | Get email sending domains
|
385
386
|
*UltracartClient::StorefrontApi* | [**get_email_settings**](docs/StorefrontApi.md#get_email_settings) | **GET** /storefront/{storefront_oid}/email/settings | Get email settings
|
387
|
+
*UltracartClient::StorefrontApi* | [**get_email_sms_orders**](docs/StorefrontApi.md#get_email_sms_orders) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders | Get email sms orders
|
386
388
|
*UltracartClient::StorefrontApi* | [**get_email_template**](docs/StorefrontApi.md#get_email_template) | **GET** /storefront/{storefront_oid}/email/templates/{email_template_oid} | Get email template
|
387
389
|
*UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
|
388
390
|
*UltracartClient::StorefrontApi* | [**get_email_third_party_providers**](docs/StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
|
@@ -921,9 +923,14 @@ Class | Method | HTTP request | Description
|
|
921
923
|
- [UltracartClient::EmailSendingDomainsResponse](docs/EmailSendingDomainsResponse.md)
|
922
924
|
- [UltracartClient::EmailSettings](docs/EmailSettings.md)
|
923
925
|
- [UltracartClient::EmailSettingsResponse](docs/EmailSettingsResponse.md)
|
926
|
+
- [UltracartClient::EmailSmsOrder](docs/EmailSmsOrder.md)
|
927
|
+
- [UltracartClient::EmailSmsOrdersResponse](docs/EmailSmsOrdersResponse.md)
|
928
|
+
- [UltracartClient::EmailSmsStat](docs/EmailSmsStat.md)
|
924
929
|
- [UltracartClient::EmailStat](docs/EmailStat.md)
|
925
930
|
- [UltracartClient::EmailStatPostcardSummaryRequest](docs/EmailStatPostcardSummaryRequest.md)
|
926
931
|
- [UltracartClient::EmailStatPostcardSummaryResponse](docs/EmailStatPostcardSummaryResponse.md)
|
932
|
+
- [UltracartClient::EmailStatSmsSummaryRequest](docs/EmailStatSmsSummaryRequest.md)
|
933
|
+
- [UltracartClient::EmailStatSmsSummaryResponse](docs/EmailStatSmsSummaryResponse.md)
|
927
934
|
- [UltracartClient::EmailStatSummaryRequest](docs/EmailStatSummaryRequest.md)
|
928
935
|
- [UltracartClient::EmailStatSummaryResponse](docs/EmailStatSummaryResponse.md)
|
929
936
|
- [UltracartClient::EmailStepStat](docs/EmailStepStat.md)
|
@@ -1406,6 +1413,8 @@ Not every change is committed to every SDK.
|
|
1406
1413
|
|
1407
1414
|
| Version | Date | Comments |
|
1408
1415
|
| --: | :-: | --- |
|
1416
|
+
| 4.0.201 | 02/27/2024 | esp - sms statistic layer |
|
1417
|
+
| 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
|
1409
1418
|
| 4.0.199 | 01/16/2024 | order query - support searching by custom fields 8 through 10 |
|
1410
1419
|
| 4.0.198 | 01/12/2024 | workflow task - add properties array |
|
1411
1420
|
| 4.0.197 | 01/10/2024 | workflow tasks - support for searching by tags |
|
@@ -8,6 +8,10 @@
|
|
8
8
|
| **conversation_participant_name** | **String** | | [optional] |
|
9
9
|
| **jwt** | **String** | | [optional] |
|
10
10
|
| **merchant_id** | **String** | | [optional] |
|
11
|
+
| **pbx_jwt** | **String** | | [optional] |
|
12
|
+
| **pbx_voice_identity** | **String** | | [optional] |
|
13
|
+
| **pbx_voice_token** | **String** | | [optional] |
|
14
|
+
| **pbx_worker_token** | **String** | | [optional] |
|
11
15
|
| **twilio_accounts** | [**Array<ConversationTwilioAccount>**](ConversationTwilioAccount.md) | | [optional] |
|
12
16
|
| **websocket_url** | **String** | | [optional] |
|
13
17
|
|
@@ -21,6 +25,10 @@ instance = UltracartClient::ConversationAgentAuth.new(
|
|
21
25
|
conversation_participant_name: null,
|
22
26
|
jwt: null,
|
23
27
|
merchant_id: null,
|
28
|
+
pbx_jwt: null,
|
29
|
+
pbx_voice_identity: null,
|
30
|
+
pbx_voice_token: null,
|
31
|
+
pbx_worker_token: null,
|
24
32
|
twilio_accounts: null,
|
25
33
|
websocket_url: null
|
26
34
|
)
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **currency_code** | **String** | The ISO-4217 three letter currency code the customer is viewing prices in | [optional] |
|
8
8
|
| **discount_amount** | **Float** | The amount of shipping discount | [optional] |
|
9
|
+
| **item_tags** | **Array<String>** | An optional list of item tags which will receive a discount. | [optional] |
|
9
10
|
| **items** | **Array<String>** | A list of items which are eligible for the discount amount. | [optional] |
|
10
11
|
| **limit** | **Integer** | The limit of items which are eligible for the discount amount. | [optional] |
|
11
12
|
|
@@ -17,6 +18,7 @@ require 'ultracart_api'
|
|
17
18
|
instance = UltracartClient::CouponAmountOffItems.new(
|
18
19
|
currency_code: null,
|
19
20
|
discount_amount: null,
|
21
|
+
item_tags: null,
|
20
22
|
items: null,
|
21
23
|
limit: null
|
22
24
|
)
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **item_tags** | **Array<String>** | An optional list of item tags which will receive a discount. | [optional] |
|
7
8
|
| **items** | **Array<String>** | An optional list of items of which one must be purchased to receive free quantity of the same item. | [optional] |
|
8
9
|
| **limit** | **Integer** | The limit of free items that may be received when purchasing multiple items | [optional] |
|
9
10
|
|
@@ -13,6 +14,7 @@
|
|
13
14
|
require 'ultracart_api'
|
14
15
|
|
15
16
|
instance = UltracartClient::CouponBuyOneGetOneLimit.new(
|
17
|
+
item_tags: null,
|
16
18
|
items: null,
|
17
19
|
limit: null
|
18
20
|
)
|
@@ -6,9 +6,11 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **currency_code** | **String** | The ISO-4217 three letter currency code the customer is viewing prices in | [optional] |
|
8
8
|
| **discount_item** | **String** | The item that will be sold at the discount_price when required_purchase_item is purchased. | [optional] |
|
9
|
+
| **discount_item_tags** | **Array<String>** | An optional list of item tags which will receive a discount of one of the required purchased items is purchased. | [optional] |
|
9
10
|
| **discount_price** | **Float** | The price (unit cost) of the discounted item | [optional] |
|
10
11
|
| **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] |
|
11
12
|
| **required_purchase_item** | **String** | The item that must be purchased for the discount to be applied to the discount item. | [optional] |
|
13
|
+
| **required_purchase_items_tags** | **Array<String>** | An optional list of item tags which are required to be purchased. | [optional] |
|
12
14
|
|
13
15
|
## Example
|
14
16
|
|
@@ -18,9 +20,11 @@ require 'ultracart_api'
|
|
18
20
|
instance = UltracartClient::CouponDiscountItemWithItemPurchase.new(
|
19
21
|
currency_code: null,
|
20
22
|
discount_item: null,
|
23
|
+
discount_item_tags: null,
|
21
24
|
discount_price: null,
|
22
25
|
limit: null,
|
23
|
-
required_purchase_item: null
|
26
|
+
required_purchase_item: null,
|
27
|
+
required_purchase_items_tags: null
|
24
28
|
)
|
25
29
|
```
|
26
30
|
|
@@ -4,10 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **item_tags** | **Array<String>** | An optional list of item tags which will receive a discount of one of the required purchased items is purchased. | [optional] |
|
7
8
|
| **items** | **Array<String>** | A list of free items which will receive a discount if one of the required purchase items is purchased. | [optional] |
|
8
9
|
| **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] |
|
9
10
|
| **match_required_purchase_item_to_free_item** | **Boolean** | If true then the free item is matched 1:1 with the free item in the list. | [optional] |
|
10
11
|
| **required_purchase_items** | **Array<String>** | Required items (at least one from the list) that must be purchased for coupon to be valid | [optional] |
|
12
|
+
| **required_purchase_items_tags** | **Array<String>** | An optional list of item tags which are required to be purchased. | [optional] |
|
11
13
|
|
12
14
|
## Example
|
13
15
|
|
@@ -15,10 +17,12 @@
|
|
15
17
|
require 'ultracart_api'
|
16
18
|
|
17
19
|
instance = UltracartClient::CouponFreeItemWithItemPurchase.new(
|
20
|
+
item_tags: null,
|
18
21
|
items: null,
|
19
22
|
limit: null,
|
20
23
|
match_required_purchase_item_to_free_item: null,
|
21
|
-
required_purchase_items: null
|
24
|
+
required_purchase_items: null,
|
25
|
+
required_purchase_items_tags: null
|
22
26
|
)
|
23
27
|
```
|
24
28
|
|
@@ -5,9 +5,11 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **discount_percent** | **Float** | The percentage of subtotal discount | [optional] |
|
8
|
+
| **item_tags** | **Array<String>** | An optional list of item tags which will receive a discount of one of the required purchased items is purchased. | [optional] |
|
8
9
|
| **items** | **Array<String>** | A list of items which will receive a discount if one of the required purchase items is purchased. | [optional] |
|
9
10
|
| **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] |
|
10
11
|
| **required_purchase_items** | **Array<String>** | Required items (at least one from the list) that must be purchased for coupon to be valid | [optional] |
|
12
|
+
| **required_purchase_items_tags** | **Array<String>** | An optional list of item tags which are required to be purchased. | [optional] |
|
11
13
|
|
12
14
|
## Example
|
13
15
|
|
@@ -16,9 +18,11 @@ require 'ultracart_api'
|
|
16
18
|
|
17
19
|
instance = UltracartClient::CouponPercentOffItemsWithItemsPurchase.new(
|
18
20
|
discount_percent: null,
|
21
|
+
item_tags: null,
|
19
22
|
items: null,
|
20
23
|
limit: null,
|
21
|
-
required_purchase_items: null
|
24
|
+
required_purchase_items: null,
|
25
|
+
required_purchase_items_tags: null
|
22
26
|
)
|
23
27
|
```
|
24
28
|
|
@@ -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)
|
data/docs/Twilio.md
CHANGED
@@ -5,9 +5,18 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **account_sid** | **String** | | [optional] |
|
8
|
+
| **api_key_id** | **String** | | [optional] |
|
9
|
+
| **api_key_name** | **String** | | [optional] |
|
10
|
+
| **api_key_secret** | **String** | | [optional] |
|
8
11
|
| **auth_token** | **String** | | [optional] |
|
9
12
|
| **esp_twilio_uuid** | **String** | | [optional] |
|
13
|
+
| **inbound_twiml_app_sid** | **String** | | [optional] |
|
14
|
+
| **outbound_twiml_app_sid** | **String** | | [optional] |
|
10
15
|
| **phone_numbers** | **Array<String>** | | [optional] |
|
16
|
+
| **private_key_pem** | **String** | | [optional] |
|
17
|
+
| **public_key_pem** | **String** | | [optional] |
|
18
|
+
| **public_key_sid** | **String** | | [optional] |
|
19
|
+
| **twilio_workspace_sid** | **String** | | [optional] |
|
11
20
|
|
12
21
|
## Example
|
13
22
|
|
@@ -16,9 +25,18 @@ require 'ultracart_api'
|
|
16
25
|
|
17
26
|
instance = UltracartClient::Twilio.new(
|
18
27
|
account_sid: null,
|
28
|
+
api_key_id: null,
|
29
|
+
api_key_name: null,
|
30
|
+
api_key_secret: null,
|
19
31
|
auth_token: null,
|
20
32
|
esp_twilio_uuid: null,
|
21
|
-
|
33
|
+
inbound_twiml_app_sid: null,
|
34
|
+
outbound_twiml_app_sid: null,
|
35
|
+
phone_numbers: null,
|
36
|
+
private_key_pem: null,
|
37
|
+
public_key_pem: null,
|
38
|
+
public_key_sid: null,
|
39
|
+
twilio_workspace_sid: null
|
22
40
|
)
|
23
41
|
```
|
24
42
|
|