ultracart_api 4.0.200 → 4.0.201

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e7d9d5945f50c36b3ebec036356c903284a199af3c42572c671ee37d7f6d3b40
4
- data.tar.gz: 965cdb1b7253207045e15fcccf8dd8567b3a61bf982ef2b23a22540643bb64a5
3
+ metadata.gz: 64c2440e0524e4c5151fcdcc4efa334dea9c805e90fc8206b1a974f96295aabe
4
+ data.tar.gz: e980f4b50904a17e183c0de7d3bc11649befbf90e8c8e48248fd61dd1648e1a1
5
5
  SHA512:
6
- metadata.gz: 0e495fa5e5a3cb4f862739b49d26e1fee876dc0661e1fb8f7da6fe86afc6f6fd36b45959ec4d48e554aecc3cb3eeddec05835fd5b388aa87fbad1073e4fd9900
7
- data.tar.gz: 13dcadddc06dbc121c706edf58a6dfecf8583a37216b91416f7d18c1f820558044707fb599621d6130305b272bd4f9d8648033ae71c62fc895176736fdb07c7d
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.200
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.200.gem
27
+ gem install ./ultracart_api-4.0.201.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.200.gem` to install the development dependencies)
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.200'
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,7 @@ 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 |
1409
1417
  | 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
1410
1418
  | 4.0.199 | 01/16/2024 | order query - support searching by custom fields 8 through 10 |
1411
1419
  | 4.0.198 | 01/12/2024 | workflow task - add properties array |
@@ -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,
@@ -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)
@@ -2955,6 +2955,85 @@ module UltracartClient
2955
2955
  return data, status_code, headers
2956
2956
  end
2957
2957
 
2958
+ # Get email communication sequence sms stats
2959
+ # @param storefront_oid [Integer]
2960
+ # @param commseq_uuid [String]
2961
+ # @param stats_request [EmailStatSmsSummaryRequest] StatsRequest
2962
+ # @param [Hash] opts the optional parameters
2963
+ # @return [EmailStatSmsSummaryResponse]
2964
+ def get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request, opts = {})
2965
+ data, _status_code, _headers = get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts)
2966
+ data
2967
+ end
2968
+
2969
+ # Get email communication sequence sms stats
2970
+ # @param storefront_oid [Integer]
2971
+ # @param commseq_uuid [String]
2972
+ # @param stats_request [EmailStatSmsSummaryRequest] StatsRequest
2973
+ # @param [Hash] opts the optional parameters
2974
+ # @return [Array<(EmailStatSmsSummaryResponse, Integer, Hash)>] EmailStatSmsSummaryResponse data, response status code and response headers
2975
+ def get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {})
2976
+ if @api_client.config.debugging
2977
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_sms_stats ...'
2978
+ end
2979
+ # verify the required parameter 'storefront_oid' is set
2980
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2981
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_sms_stats"
2982
+ end
2983
+ # verify the required parameter 'commseq_uuid' is set
2984
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
2985
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_sms_stats"
2986
+ end
2987
+ # verify the required parameter 'stats_request' is set
2988
+ if @api_client.config.client_side_validation && stats_request.nil?
2989
+ fail ArgumentError, "Missing the required parameter 'stats_request' when calling StorefrontApi.get_email_commseq_sms_stats"
2990
+ end
2991
+ # resource path
2992
+ local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
2993
+
2994
+ # query parameters
2995
+ query_params = opts[:query_params] || {}
2996
+
2997
+ # header parameters
2998
+ header_params = opts[:header_params] || {}
2999
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3000
+ # HTTP header 'Accept' (if needed)
3001
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3002
+ # HTTP header 'Content-Type'
3003
+ content_type = @api_client.select_header_content_type(['application/json'])
3004
+ if !content_type.nil?
3005
+ header_params['Content-Type'] = content_type
3006
+ end
3007
+
3008
+ # form parameters
3009
+ form_params = opts[:form_params] || {}
3010
+
3011
+ # http body (model)
3012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(stats_request)
3013
+
3014
+ # return_type
3015
+ return_type = opts[:debug_return_type] || 'EmailStatSmsSummaryResponse'
3016
+
3017
+ # auth_names
3018
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
3019
+
3020
+ new_options = opts.merge(
3021
+ :operation => :"StorefrontApi.get_email_commseq_sms_stats",
3022
+ :header_params => header_params,
3023
+ :query_params => query_params,
3024
+ :form_params => form_params,
3025
+ :body => post_body,
3026
+ :auth_names => auth_names,
3027
+ :return_type => return_type
3028
+ )
3029
+
3030
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3031
+ if @api_client.config.debugging
3032
+ @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_sms_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3033
+ end
3034
+ return data, status_code, headers
3035
+ end
3036
+
2958
3037
  # Get communication sequence stats overall
2959
3038
  # @param storefront_oid [Integer]
2960
3039
  # @param commseq_uuid [String]
@@ -5736,6 +5815,83 @@ module UltracartClient
5736
5815
  return data, status_code, headers
5737
5816
  end
5738
5817
 
5818
+ # Get email sms orders
5819
+ # @param storefront_oid [Integer]
5820
+ # @param commseq_uuid [String]
5821
+ # @param commseq_step_uuid [String]
5822
+ # @param [Hash] opts the optional parameters
5823
+ # @option opts [Integer] :days
5824
+ # @return [EmailSmsOrdersResponse]
5825
+ def get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
5826
+ data, _status_code, _headers = get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
5827
+ data
5828
+ end
5829
+
5830
+ # Get email sms orders
5831
+ # @param storefront_oid [Integer]
5832
+ # @param commseq_uuid [String]
5833
+ # @param commseq_step_uuid [String]
5834
+ # @param [Hash] opts the optional parameters
5835
+ # @option opts [Integer] :days
5836
+ # @return [Array<(EmailSmsOrdersResponse, Integer, Hash)>] EmailSmsOrdersResponse data, response status code and response headers
5837
+ def get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
5838
+ if @api_client.config.debugging
5839
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_sms_orders ...'
5840
+ end
5841
+ # verify the required parameter 'storefront_oid' is set
5842
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5843
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_sms_orders"
5844
+ end
5845
+ # verify the required parameter 'commseq_uuid' is set
5846
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
5847
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_sms_orders"
5848
+ end
5849
+ # verify the required parameter 'commseq_step_uuid' is set
5850
+ if @api_client.config.client_side_validation && commseq_step_uuid.nil?
5851
+ fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_sms_orders"
5852
+ end
5853
+ # resource path
5854
+ local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))
5855
+
5856
+ # query parameters
5857
+ query_params = opts[:query_params] || {}
5858
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5859
+
5860
+ # header parameters
5861
+ header_params = opts[:header_params] || {}
5862
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5863
+ # HTTP header 'Accept' (if needed)
5864
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5865
+
5866
+ # form parameters
5867
+ form_params = opts[:form_params] || {}
5868
+
5869
+ # http body (model)
5870
+ post_body = opts[:debug_body]
5871
+
5872
+ # return_type
5873
+ return_type = opts[:debug_return_type] || 'EmailSmsOrdersResponse'
5874
+
5875
+ # auth_names
5876
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
5877
+
5878
+ new_options = opts.merge(
5879
+ :operation => :"StorefrontApi.get_email_sms_orders",
5880
+ :header_params => header_params,
5881
+ :query_params => query_params,
5882
+ :form_params => form_params,
5883
+ :body => post_body,
5884
+ :auth_names => auth_names,
5885
+ :return_type => return_type
5886
+ )
5887
+
5888
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5889
+ if @api_client.config.debugging
5890
+ @api_client.config.logger.debug "API called: StorefrontApi#get_email_sms_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5891
+ end
5892
+ return data, status_code, headers
5893
+ end
5894
+
5739
5895
  # Get email template
5740
5896
  # @param storefront_oid [Integer]
5741
5897
  # @param email_template_oid [Integer]