ultracart_api 3.10.183 → 3.10.184

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 81f310499fb963d5d9c5af3926c4acb4f178f90fcfe909bac74e66f2a4eae5bd
4
- data.tar.gz: 4114b3b40507807ab8d059042f638bdd9a7e17256ffc345b4be8e1a28eef8c6c
3
+ metadata.gz: ba0237ca1a29a8480879fbc92a515dafac4148bd5fad55f31b60d89a974ca66e
4
+ data.tar.gz: 4650228e62f3bad8ce0a54dd2377ffd4b852b03330c13a82b69e8fff3cdba049
5
5
  SHA512:
6
- metadata.gz: b5e16e4ceaaa31e70838a712e5352fb2efc5f69caad8fcecc191bed6ed3194006549ed7efc43605576552a4807d1eb3a48da05d776991f91ae059c90a2c60c21
7
- data.tar.gz: be083ee5966d4dc959f6b2ac8f24ba7c4849a7f7e86fc7df5a48e7322d58579a259a463bd7b13e9feb3413c74d0d501e8f2fd68b98c7e3462297912b28389bc4
6
+ metadata.gz: 878bd09e688c2874f60d6cdec718e41ec25503e04b26f9b941faec87348d14eeb0c150171ecaa43f6723d3c38eef42667abf760a127022f5495db0067d31c24e
7
+ data.tar.gz: 1ffca98ff56b1994ace8b7259f3a3720408a22a7c64258fff427b30572dc60688fb8e54fa3d97a3163b5d5538dc868d7ee73c2d08bfaf82960c9ba17bcfeea07
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.10.183
10
+ - Package version: 3.10.184
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.10.183.gem
27
+ gem install ./ultracart_api-3.10.184.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.183.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.184.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.10.183'
35
+ gem 'ultracart_api', '~> 3.10.184'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -336,6 +336,7 @@ Class | Method | HTTP request | Description
336
336
  *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
337
337
  *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
338
338
  *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
339
+ *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
339
340
  *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
340
341
  *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
341
342
  *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
@@ -377,6 +378,7 @@ Class | Method | HTTP request | Description
377
378
  *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
378
379
  *UltracartClient::StorefrontApi* | [**get_email_sending_domains**](docs/StorefrontApi.md#get_email_sending_domains) | **GET** /storefront/email/sending_domains | Get email sending domains
379
380
  *UltracartClient::StorefrontApi* | [**get_email_settings**](docs/StorefrontApi.md#get_email_settings) | **GET** /storefront/{storefront_oid}/email/settings | Get email settings
381
+ *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
380
382
  *UltracartClient::StorefrontApi* | [**get_email_template**](docs/StorefrontApi.md#get_email_template) | **GET** /storefront/{storefront_oid}/email/templates/{email_template_oid} | Get email template
381
383
  *UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
382
384
  *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
@@ -916,9 +918,14 @@ Class | Method | HTTP request | Description
916
918
  - [UltracartClient::EmailSendingDomainsResponse](docs/EmailSendingDomainsResponse.md)
917
919
  - [UltracartClient::EmailSettings](docs/EmailSettings.md)
918
920
  - [UltracartClient::EmailSettingsResponse](docs/EmailSettingsResponse.md)
921
+ - [UltracartClient::EmailSmsOrder](docs/EmailSmsOrder.md)
922
+ - [UltracartClient::EmailSmsOrdersResponse](docs/EmailSmsOrdersResponse.md)
923
+ - [UltracartClient::EmailSmsStat](docs/EmailSmsStat.md)
919
924
  - [UltracartClient::EmailStat](docs/EmailStat.md)
920
925
  - [UltracartClient::EmailStatPostcardSummaryRequest](docs/EmailStatPostcardSummaryRequest.md)
921
926
  - [UltracartClient::EmailStatPostcardSummaryResponse](docs/EmailStatPostcardSummaryResponse.md)
927
+ - [UltracartClient::EmailStatSmsSummaryRequest](docs/EmailStatSmsSummaryRequest.md)
928
+ - [UltracartClient::EmailStatSmsSummaryResponse](docs/EmailStatSmsSummaryResponse.md)
922
929
  - [UltracartClient::EmailStatSummaryRequest](docs/EmailStatSummaryRequest.md)
923
930
  - [UltracartClient::EmailStatSummaryResponse](docs/EmailStatSummaryResponse.md)
924
931
  - [UltracartClient::EmailStepStat](docs/EmailStepStat.md)
@@ -1398,6 +1405,7 @@ Not every change is committed to every SDK.
1398
1405
 
1399
1406
  | Version | Date | Comments |
1400
1407
  | --: | :-: | --- |
1408
+ | 3.10.184 | 02/27/2024 | esp - sms statistic layer |
1401
1409
  | 3.10.183 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
1402
1410
  | 3.10.182 | 01/16/2024 | order query - support searching by custom fields 8 through 10 |
1403
1411
  | 3.10.181 | 01/12/2024 | workflow task - add properties array |
@@ -0,0 +1,11 @@
1
+ # UltracartClient::EmailSmsOrder
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | email | [optional]
7
+ **order_dts** | **String** | order_dts | [optional]
8
+ **order_id** | **String** | order_id | [optional]
9
+ **total** | [**Currency**](Currency.md) | | [optional]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailSmsOrdersResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **orders** | [**Array<EmailSmsOrder>**](EmailSmsOrder.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,37 @@
1
+ # UltracartClient::EmailSmsStat
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **click_count** | **Integer** | Count of clicked emails | [optional]
7
+ **click_count_formatted** | **String** | Count of clicked emails, formatted | [optional]
8
+ **conversion_count** | **Integer** | Count of conversions | [optional]
9
+ **conversion_count_formatted** | **String** | Count of conversions, formatted | [optional]
10
+ **deleted** | **BOOLEAN** | True if campaign/flow has been archived | [optional]
11
+ **delivered_count** | **Integer** | Count of delivered emails | [optional]
12
+ **delivered_count_formatted** | **String** | Count of delivered emails, formatted | [optional]
13
+ **merchant_id** | **String** | Merchant ID | [optional]
14
+ **name** | **String** | List or segment name | [optional]
15
+ **order_count** | **Integer** | Count of orders | [optional]
16
+ **order_count_formatted** | **String** | Count of orders, formatted | [optional]
17
+ **profit** | **Float** | Profit | [optional]
18
+ **profit_formatted** | **String** | Profit, formatted | [optional]
19
+ **revenue** | **Float** | Revenue | [optional]
20
+ **revenue_formatted** | **String** | Revenue, formatted | [optional]
21
+ **send_count** | **Integer** | Count of emails sent | [optional]
22
+ **send_count_formatted** | **String** | Count of emails sent, formatted | [optional]
23
+ **skipped_count** | **Integer** | Count of skipped emails | [optional]
24
+ **skipped_count_formatted** | **String** | Count of skipped emails, formatted | [optional]
25
+ **stat_type** | **String** | Campaign, Flow or None (for anything else) | [optional]
26
+ **status** | **String** | Status of campaign or flow | [optional]
27
+ **status_dts** | **String** | Status dts of campaign or flow | [optional]
28
+ **step_uuid** | **String** | Step UUID if the statistics are at the step/email level | [optional]
29
+ **steps** | [**Array<EmailSmsStat>**](EmailSmsStat.md) | | [optional]
30
+ **storefront_oid** | **Integer** | Storefront oid | [optional]
31
+ **unsubscribe_count** | **Integer** | Count of emails classified as unsubscribe | [optional]
32
+ **unsubscribe_count_formatted** | **String** | Count of emails classified as unsubscribe, formatted | [optional]
33
+ **uuid** | **String** | List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation. | [optional]
34
+ **view_count** | **Integer** | Count of views | [optional]
35
+ **view_count_formatted** | **String** | Count of views, formatted | [optional]
36
+
37
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::EmailStatSmsSummaryRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **commseq_step_uuids** | **Array<String>** | | [optional]
7
+ **days** | **Integer** | | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailStatSmsSummaryResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **stats** | [**Array<EmailSmsStat>**](EmailSmsStat.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
data/docs/PricingTier.md CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **approval_notification** | [**PricingTierNotification**](PricingTierNotification.md) | | [optional]
11
11
  **auto_approve_cod** | **BOOLEAN** | Auto approve COD | [optional]
12
12
  **auto_approve_purchase_order** | **BOOLEAN** | Auto approve purchase order | [optional]
13
+ **currency_code** | **String** | Any currency code specified on this pricing tier will force a shopping cart into that currency | [optional]
13
14
  **default_on_wholesale_signup** | **BOOLEAN** | Default on wholesale signup | [optional]
14
15
  **default_percentage_discount** | **Float** | Default percentage discount | [optional]
15
16
  **default_shipping_method_oid** | **Integer** | Default shipping method oid | [optional]
@@ -47,6 +47,7 @@ Method | HTTP request | Description
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 @@ Method | HTTP request | Description
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
@@ -2356,6 +2358,60 @@ Name | Type | Description | Notes
2356
2358
 
2357
2359
 
2358
2360
 
2361
+ # **get_email_commseq_sms_stats**
2362
+ > EmailStatSmsSummaryResponse get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
2363
+
2364
+ Get email communication sequence sms stats
2365
+
2366
+ ### Example
2367
+ ```ruby
2368
+ # load the gem
2369
+ require 'ultracart_api'
2370
+
2371
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2372
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2373
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
2374
+
2375
+
2376
+ storefront_oid = 56 # Integer |
2377
+
2378
+ commseq_uuid = 'commseq_uuid_example' # String |
2379
+
2380
+ stats_request = UltracartClient::EmailStatSmsSummaryRequest.new # EmailStatSmsSummaryRequest | StatsRequest
2381
+
2382
+
2383
+ begin
2384
+ #Get email communication sequence sms stats
2385
+ result = api_instance.get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
2386
+ p result
2387
+ rescue UltracartClient::ApiError => e
2388
+ puts "Exception when calling StorefrontApi->get_email_commseq_sms_stats: #{e}"
2389
+ end
2390
+ ```
2391
+
2392
+ ### Parameters
2393
+
2394
+ Name | Type | Description | Notes
2395
+ ------------- | ------------- | ------------- | -------------
2396
+ **storefront_oid** | **Integer**| |
2397
+ **commseq_uuid** | **String**| |
2398
+ **stats_request** | [**EmailStatSmsSummaryRequest**](EmailStatSmsSummaryRequest.md)| StatsRequest |
2399
+
2400
+ ### Return type
2401
+
2402
+ [**EmailStatSmsSummaryResponse**](EmailStatSmsSummaryResponse.md)
2403
+
2404
+ ### Authorization
2405
+
2406
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2407
+
2408
+ ### HTTP request headers
2409
+
2410
+ - **Content-Type**: application/json
2411
+ - **Accept**: application/json
2412
+
2413
+
2414
+
2359
2415
  # **get_email_commseq_stat_overall**
2360
2416
  > EmailCommseqStatResponse get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
2361
2417
 
@@ -4449,6 +4505,64 @@ Name | Type | Description | Notes
4449
4505
 
4450
4506
 
4451
4507
 
4508
+ # **get_email_sms_orders**
4509
+ > EmailSmsOrdersResponse get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
4510
+
4511
+ Get email sms orders
4512
+
4513
+ ### Example
4514
+ ```ruby
4515
+ # load the gem
4516
+ require 'ultracart_api'
4517
+
4518
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4519
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4520
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
4521
+
4522
+
4523
+ storefront_oid = 56 # Integer |
4524
+
4525
+ commseq_uuid = 'commseq_uuid_example' # String |
4526
+
4527
+ commseq_step_uuid = 'commseq_step_uuid_example' # String |
4528
+
4529
+ opts = {
4530
+ days: 56 # Integer |
4531
+ }
4532
+
4533
+ begin
4534
+ #Get email sms orders
4535
+ result = api_instance.get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
4536
+ p result
4537
+ rescue UltracartClient::ApiError => e
4538
+ puts "Exception when calling StorefrontApi->get_email_sms_orders: #{e}"
4539
+ end
4540
+ ```
4541
+
4542
+ ### Parameters
4543
+
4544
+ Name | Type | Description | Notes
4545
+ ------------- | ------------- | ------------- | -------------
4546
+ **storefront_oid** | **Integer**| |
4547
+ **commseq_uuid** | **String**| |
4548
+ **commseq_step_uuid** | **String**| |
4549
+ **days** | **Integer**| | [optional]
4550
+
4551
+ ### Return type
4552
+
4553
+ [**EmailSmsOrdersResponse**](EmailSmsOrdersResponse.md)
4554
+
4555
+ ### Authorization
4556
+
4557
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4558
+
4559
+ ### HTTP request headers
4560
+
4561
+ - **Content-Type**: application/json
4562
+ - **Accept**: application/json
4563
+
4564
+
4565
+
4452
4566
  # **get_email_template**
4453
4567
  > EmailTemplate get_email_template(storefront_oid, email_template_oid)
4454
4568
 
@@ -2516,6 +2516,71 @@ module UltracartClient
2516
2516
  end
2517
2517
  return data, status_code, headers
2518
2518
  end
2519
+ # Get email communication sequence sms stats
2520
+ # @param storefront_oid
2521
+ # @param commseq_uuid
2522
+ # @param stats_request StatsRequest
2523
+ # @param [Hash] opts the optional parameters
2524
+ # @return [EmailStatSmsSummaryResponse]
2525
+ def get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request, opts = {})
2526
+ data, _status_code, _headers = get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts)
2527
+ data
2528
+ end
2529
+
2530
+ # Get email communication sequence sms stats
2531
+ # @param storefront_oid
2532
+ # @param commseq_uuid
2533
+ # @param stats_request StatsRequest
2534
+ # @param [Hash] opts the optional parameters
2535
+ # @return [Array<(EmailStatSmsSummaryResponse, Fixnum, Hash)>] EmailStatSmsSummaryResponse data, response status code and response headers
2536
+ def get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {})
2537
+ if @api_client.config.debugging
2538
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_sms_stats ...'
2539
+ end
2540
+ # verify the required parameter 'storefront_oid' is set
2541
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2542
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_sms_stats"
2543
+ end
2544
+ # verify the required parameter 'commseq_uuid' is set
2545
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
2546
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_sms_stats"
2547
+ end
2548
+ # verify the required parameter 'stats_request' is set
2549
+ if @api_client.config.client_side_validation && stats_request.nil?
2550
+ fail ArgumentError, "Missing the required parameter 'stats_request' when calling StorefrontApi.get_email_commseq_sms_stats"
2551
+ end
2552
+ # resource path
2553
+ local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)
2554
+
2555
+ # query parameters
2556
+ query_params = {}
2557
+
2558
+ # header parameters
2559
+ header_params = {}
2560
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2561
+ # HTTP header 'Accept' (if needed)
2562
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2563
+ # HTTP header 'Content-Type'
2564
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2565
+
2566
+ # form parameters
2567
+ form_params = {}
2568
+
2569
+ # http body (model)
2570
+ post_body = @api_client.object_to_http_body(stats_request)
2571
+ auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
2572
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2573
+ :header_params => header_params,
2574
+ :query_params => query_params,
2575
+ :form_params => form_params,
2576
+ :body => post_body,
2577
+ :auth_names => auth_names,
2578
+ :return_type => 'EmailStatSmsSummaryResponse')
2579
+ if @api_client.config.debugging
2580
+ @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_sms_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2581
+ end
2582
+ return data, status_code, headers
2583
+ end
2519
2584
  # Get communication sequence stats overall
2520
2585
  # @param storefront_oid
2521
2586
  # @param commseq_uuid
@@ -4908,6 +4973,74 @@ module UltracartClient
4908
4973
  end
4909
4974
  return data, status_code, headers
4910
4975
  end
4976
+ # Get email sms orders
4977
+ # @param storefront_oid
4978
+ # @param commseq_uuid
4979
+ # @param commseq_step_uuid
4980
+ # @param [Hash] opts the optional parameters
4981
+ # @option opts [Integer] :days
4982
+ # @return [EmailSmsOrdersResponse]
4983
+ def get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
4984
+ data, _status_code, _headers = get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
4985
+ data
4986
+ end
4987
+
4988
+ # Get email sms orders
4989
+ # @param storefront_oid
4990
+ # @param commseq_uuid
4991
+ # @param commseq_step_uuid
4992
+ # @param [Hash] opts the optional parameters
4993
+ # @option opts [Integer] :days
4994
+ # @return [Array<(EmailSmsOrdersResponse, Fixnum, Hash)>] EmailSmsOrdersResponse data, response status code and response headers
4995
+ def get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
4996
+ if @api_client.config.debugging
4997
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_sms_orders ...'
4998
+ end
4999
+ # verify the required parameter 'storefront_oid' is set
5000
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5001
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_sms_orders"
5002
+ end
5003
+ # verify the required parameter 'commseq_uuid' is set
5004
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
5005
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_sms_orders"
5006
+ end
5007
+ # verify the required parameter 'commseq_step_uuid' is set
5008
+ if @api_client.config.client_side_validation && commseq_step_uuid.nil?
5009
+ fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_sms_orders"
5010
+ end
5011
+ # resource path
5012
+ local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s)
5013
+
5014
+ # query parameters
5015
+ query_params = {}
5016
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5017
+
5018
+ # header parameters
5019
+ header_params = {}
5020
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5021
+ # HTTP header 'Accept' (if needed)
5022
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5023
+ # HTTP header 'Content-Type'
5024
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5025
+
5026
+ # form parameters
5027
+ form_params = {}
5028
+
5029
+ # http body (model)
5030
+ post_body = nil
5031
+ auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
5032
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5033
+ :header_params => header_params,
5034
+ :query_params => query_params,
5035
+ :form_params => form_params,
5036
+ :body => post_body,
5037
+ :auth_names => auth_names,
5038
+ :return_type => 'EmailSmsOrdersResponse')
5039
+ if @api_client.config.debugging
5040
+ @api_client.config.logger.debug "API called: StorefrontApi#get_email_sms_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5041
+ end
5042
+ return data, status_code, headers
5043
+ end
4911
5044
  # Get email template
4912
5045
  # @param storefront_oid
4913
5046
  # @param email_template_oid