ultracart_api 4.1.110 → 4.1.112
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -2
- data/docs/AnrokConfig.md +24 -0
- data/docs/EmailCustomerLookupResponse.md +28 -0
- data/docs/EmailDispatchLog.md +26 -0
- data/docs/EmailDispatchLogDetail.md +32 -0
- data/docs/EmailDispatchLogDetailResponse.md +26 -0
- data/docs/EmailDispatchLogsResponse.md +32 -0
- data/docs/StorefrontApi.md +233 -0
- data/docs/TaxApi.md +158 -0
- data/docs/TaxProviderAnrok.md +24 -0
- data/docs/TaxProvidersResponse.md +2 -0
- data/lib/ultracart_api/api/storefront_api.rb +322 -0
- data/lib/ultracart_api/api/tax_api.rb +185 -0
- data/lib/ultracart_api/models/anrok_config.rb +250 -0
- data/lib/ultracart_api/models/email_customer_lookup_response.rb +267 -0
- data/lib/ultracart_api/models/email_dispatch_log.rb +260 -0
- data/lib/ultracart_api/models/email_dispatch_log_detail.rb +290 -0
- data/lib/ultracart_api/models/email_dispatch_log_detail_response.rb +256 -0
- data/lib/ultracart_api/models/email_dispatch_logs_response.rb +289 -0
- data/lib/ultracart_api/models/tax_provider_anrok.rb +249 -0
- data/lib/ultracart_api/models/tax_providers_response.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +7 -0
- metadata +16 -2
data/docs/TaxApi.md
CHANGED
|
@@ -9,6 +9,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
9
9
|
| [**delete_tax_provider_self_county**](TaxApi.md#delete_tax_provider_self_county) | **DELETE** /tax/providers/self/county/{county} | Deletes a Self tax provider county |
|
|
10
10
|
| [**delete_tax_provider_self_postal_code**](TaxApi.md#delete_tax_provider_self_postal_code) | **DELETE** /tax/providers/self/postalCode/{postal_code} | Deletes a Self tax provider postalCode |
|
|
11
11
|
| [**delete_tax_provider_self_state**](TaxApi.md#delete_tax_provider_self_state) | **DELETE** /tax/providers/self/state/{stateCode} | Deletes a Self tax provider state |
|
|
12
|
+
| [**get_tax_provider_anrok**](TaxApi.md#get_tax_provider_anrok) | **GET** /tax/providers/anrok | Retrieve the Anrok tax provider |
|
|
13
|
+
| [**get_tax_provider_anrok_test**](TaxApi.md#get_tax_provider_anrok_test) | **GET** /tax/providers/anrok/test | Attempts to connect to Anrok and returns back the response |
|
|
12
14
|
| [**get_tax_provider_avalara**](TaxApi.md#get_tax_provider_avalara) | **GET** /tax/providers/avalara | Retrieve the Avalara tax provider |
|
|
13
15
|
| [**get_tax_provider_avalara_companies**](TaxApi.md#get_tax_provider_avalara_companies) | **POST** /tax/providers/avalara/companies | Returns Avalara Tax companies configured by the merchant |
|
|
14
16
|
| [**get_tax_provider_avalara_test**](TaxApi.md#get_tax_provider_avalara_test) | **GET** /tax/providers/avalara/test | Attempts to connect to Avalara and returns back the response |
|
|
@@ -22,6 +24,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
22
24
|
| [**get_tax_provider_ultra_cart**](TaxApi.md#get_tax_provider_ultra_cart) | **GET** /tax/providers/ultracart | Retrieve the UltraCart tax provider |
|
|
23
25
|
| [**get_tax_providers**](TaxApi.md#get_tax_providers) | **GET** /tax/providers | Retrieve tax methods |
|
|
24
26
|
| [**set_active_tax_provider**](TaxApi.md#set_active_tax_provider) | **POST** /tax/providers/setActive/{providerName} | Toggle a tax provider to active |
|
|
27
|
+
| [**update_tax_provider_anrok**](TaxApi.md#update_tax_provider_anrok) | **POST** /tax/providers/anrok | Update the Anrok tax provider |
|
|
25
28
|
| [**update_tax_provider_avalara**](TaxApi.md#update_tax_provider_avalara) | **POST** /tax/providers/avalara | Update the Avalara tax provider |
|
|
26
29
|
| [**update_tax_provider_self**](TaxApi.md#update_tax_provider_self) | **POST** /tax/providers/self | Update the Self tax provider |
|
|
27
30
|
| [**update_tax_provider_self_city**](TaxApi.md#update_tax_provider_self_city) | **POST** /tax/providers/self/city/{city} | Updates a Self tax provider city |
|
|
@@ -309,6 +312,108 @@ nil (empty response body)
|
|
|
309
312
|
- **Accept**: application/json
|
|
310
313
|
|
|
311
314
|
|
|
315
|
+
## get_tax_provider_anrok
|
|
316
|
+
|
|
317
|
+
> <TaxProviderAnrok> get_tax_provider_anrok
|
|
318
|
+
|
|
319
|
+
Retrieve the Anrok tax provider
|
|
320
|
+
|
|
321
|
+
Retrieves the Anrok tax provider.
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
### Examples
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
(No example for this operation).
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
#### Using the get_tax_provider_anrok_with_http_info variant
|
|
331
|
+
|
|
332
|
+
This returns an Array which contains the response data, status code and headers.
|
|
333
|
+
|
|
334
|
+
> <Array(<TaxProviderAnrok>, Integer, Hash)> get_tax_provider_anrok_with_http_info
|
|
335
|
+
|
|
336
|
+
```ruby
|
|
337
|
+
begin
|
|
338
|
+
# Retrieve the Anrok tax provider
|
|
339
|
+
data, status_code, headers = api_instance.get_tax_provider_anrok_with_http_info
|
|
340
|
+
p status_code # => 2xx
|
|
341
|
+
p headers # => { ... }
|
|
342
|
+
p data # => <TaxProviderAnrok>
|
|
343
|
+
rescue UltracartClient::ApiError => e
|
|
344
|
+
puts "Error when calling TaxApi->get_tax_provider_anrok_with_http_info: #{e}"
|
|
345
|
+
end
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### Parameters
|
|
349
|
+
|
|
350
|
+
This endpoint does not need any parameter.
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
[**TaxProviderAnrok**](TaxProviderAnrok.md)
|
|
355
|
+
|
|
356
|
+
### Authorization
|
|
357
|
+
|
|
358
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: Not defined
|
|
363
|
+
- **Accept**: application/json
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
## get_tax_provider_anrok_test
|
|
367
|
+
|
|
368
|
+
> <TaxProviderTestResult> get_tax_provider_anrok_test
|
|
369
|
+
|
|
370
|
+
Attempts to connect to Anrok and returns back the response
|
|
371
|
+
|
|
372
|
+
Attempts to connect to Anrok and returns back the response.
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
### Examples
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
(No example for this operation).
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
#### Using the get_tax_provider_anrok_test_with_http_info variant
|
|
382
|
+
|
|
383
|
+
This returns an Array which contains the response data, status code and headers.
|
|
384
|
+
|
|
385
|
+
> <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_anrok_test_with_http_info
|
|
386
|
+
|
|
387
|
+
```ruby
|
|
388
|
+
begin
|
|
389
|
+
# Attempts to connect to Anrok and returns back the response
|
|
390
|
+
data, status_code, headers = api_instance.get_tax_provider_anrok_test_with_http_info
|
|
391
|
+
p status_code # => 2xx
|
|
392
|
+
p headers # => { ... }
|
|
393
|
+
p data # => <TaxProviderTestResult>
|
|
394
|
+
rescue UltracartClient::ApiError => e
|
|
395
|
+
puts "Error when calling TaxApi->get_tax_provider_anrok_test_with_http_info: #{e}"
|
|
396
|
+
end
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Parameters
|
|
400
|
+
|
|
401
|
+
This endpoint does not need any parameter.
|
|
402
|
+
|
|
403
|
+
### Return type
|
|
404
|
+
|
|
405
|
+
[**TaxProviderTestResult**](TaxProviderTestResult.md)
|
|
406
|
+
|
|
407
|
+
### Authorization
|
|
408
|
+
|
|
409
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
410
|
+
|
|
411
|
+
### HTTP request headers
|
|
412
|
+
|
|
413
|
+
- **Content-Type**: Not defined
|
|
414
|
+
- **Accept**: application/json
|
|
415
|
+
|
|
416
|
+
|
|
312
417
|
## get_tax_provider_avalara
|
|
313
418
|
|
|
314
419
|
> <TaxProviderAvalara> get_tax_provider_avalara
|
|
@@ -995,6 +1100,59 @@ end
|
|
|
995
1100
|
- **Accept**: application/json
|
|
996
1101
|
|
|
997
1102
|
|
|
1103
|
+
## update_tax_provider_anrok
|
|
1104
|
+
|
|
1105
|
+
> <TaxProviderAnrok> update_tax_provider_anrok(tax_provider_anrok)
|
|
1106
|
+
|
|
1107
|
+
Update the Anrok tax provider
|
|
1108
|
+
|
|
1109
|
+
Update the Anrok tax provider.
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
### Examples
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
(No example for this operation).
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
#### Using the update_tax_provider_anrok_with_http_info variant
|
|
1119
|
+
|
|
1120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1121
|
+
|
|
1122
|
+
> <Array(<TaxProviderAnrok>, Integer, Hash)> update_tax_provider_anrok_with_http_info(tax_provider_anrok)
|
|
1123
|
+
|
|
1124
|
+
```ruby
|
|
1125
|
+
begin
|
|
1126
|
+
# Update the Anrok tax provider
|
|
1127
|
+
data, status_code, headers = api_instance.update_tax_provider_anrok_with_http_info(tax_provider_anrok)
|
|
1128
|
+
p status_code # => 2xx
|
|
1129
|
+
p headers # => { ... }
|
|
1130
|
+
p data # => <TaxProviderAnrok>
|
|
1131
|
+
rescue UltracartClient::ApiError => e
|
|
1132
|
+
puts "Error when calling TaxApi->update_tax_provider_anrok_with_http_info: #{e}"
|
|
1133
|
+
end
|
|
1134
|
+
```
|
|
1135
|
+
|
|
1136
|
+
### Parameters
|
|
1137
|
+
|
|
1138
|
+
| Name | Type | Description | Notes |
|
|
1139
|
+
| ---- | ---- | ----------- | ----- |
|
|
1140
|
+
| **tax_provider_anrok** | [**TaxProviderAnrok**](TaxProviderAnrok.md) | TaxProviderAnrok object | |
|
|
1141
|
+
|
|
1142
|
+
### Return type
|
|
1143
|
+
|
|
1144
|
+
[**TaxProviderAnrok**](TaxProviderAnrok.md)
|
|
1145
|
+
|
|
1146
|
+
### Authorization
|
|
1147
|
+
|
|
1148
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1149
|
+
|
|
1150
|
+
### HTTP request headers
|
|
1151
|
+
|
|
1152
|
+
- **Content-Type**: application/json
|
|
1153
|
+
- **Accept**: application/json
|
|
1154
|
+
|
|
1155
|
+
|
|
998
1156
|
## update_tax_provider_avalara
|
|
999
1157
|
|
|
1000
1158
|
> <TaxProviderAvalara> update_tax_provider_avalara(tax_provider_avalara)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::TaxProviderAnrok
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **configuration** | [**AnrokConfig**](AnrokConfig.md) | | [optional] |
|
|
8
|
+
| **description** | **String** | Description | [optional] |
|
|
9
|
+
| **selected** | **Boolean** | Selected | [optional] |
|
|
10
|
+
| **title** | **String** | Title | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::TaxProviderAnrok.new(
|
|
18
|
+
configuration: null,
|
|
19
|
+
description: null,
|
|
20
|
+
selected: null,
|
|
21
|
+
title: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **anrok** | [**TaxProviderAnrok**](TaxProviderAnrok.md) | | [optional] |
|
|
7
8
|
| **avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | | [optional] |
|
|
8
9
|
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
10
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
@@ -20,6 +21,7 @@
|
|
|
20
21
|
require 'ultracart_api'
|
|
21
22
|
|
|
22
23
|
instance = UltracartClient::TaxProvidersResponse.new(
|
|
24
|
+
anrok: null,
|
|
23
25
|
avalara: null,
|
|
24
26
|
error: null,
|
|
25
27
|
metadata: null,
|
|
@@ -3601,6 +3601,91 @@ module UltracartClient
|
|
|
3601
3601
|
return data, status_code, headers
|
|
3602
3602
|
end
|
|
3603
3603
|
|
|
3604
|
+
# Get a customer's dispatch-log journey across all flows/campaigns
|
|
3605
|
+
# Paginated, date-boundable journey of every flow/campaign step a customer moved through (AP1/AP2), time-sorted. Rows are lean; fetch a row's detail via getEmailStepDispatchLogDetail. scanForward=false (default) returns recent-first; true returns chronological progression. Page forward until 'more' is false.
|
|
3606
|
+
# @param storefront_oid [Integer]
|
|
3607
|
+
# @param email_customer_uuid [String]
|
|
3608
|
+
# @param [Hash] opts the optional parameters
|
|
3609
|
+
# @option opts [String] :since
|
|
3610
|
+
# @option opts [String] :_until
|
|
3611
|
+
# @option opts [Integer] :page_number
|
|
3612
|
+
# @option opts [Integer] :page_size
|
|
3613
|
+
# @option opts [Boolean] :scan_forward
|
|
3614
|
+
# @return [EmailDispatchLogsResponse]
|
|
3615
|
+
def get_email_customer_dispatch_logs(storefront_oid, email_customer_uuid, opts = {})
|
|
3616
|
+
data, _status_code, _headers = get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts)
|
|
3617
|
+
data
|
|
3618
|
+
end
|
|
3619
|
+
|
|
3620
|
+
# Get a customer's dispatch-log journey across all flows/campaigns
|
|
3621
|
+
# Paginated, date-boundable journey of every flow/campaign step a customer moved through (AP1/AP2), time-sorted. Rows are lean; fetch a row's detail via getEmailStepDispatchLogDetail. scanForward=false (default) returns recent-first; true returns chronological progression. Page forward until 'more' is false.
|
|
3622
|
+
# @param storefront_oid [Integer]
|
|
3623
|
+
# @param email_customer_uuid [String]
|
|
3624
|
+
# @param [Hash] opts the optional parameters
|
|
3625
|
+
# @option opts [String] :since
|
|
3626
|
+
# @option opts [String] :_until
|
|
3627
|
+
# @option opts [Integer] :page_number
|
|
3628
|
+
# @option opts [Integer] :page_size
|
|
3629
|
+
# @option opts [Boolean] :scan_forward
|
|
3630
|
+
# @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
|
|
3631
|
+
def get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts = {})
|
|
3632
|
+
if @api_client.config.debugging
|
|
3633
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_customer_dispatch_logs ...'
|
|
3634
|
+
end
|
|
3635
|
+
# verify the required parameter 'storefront_oid' is set
|
|
3636
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3637
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_customer_dispatch_logs"
|
|
3638
|
+
end
|
|
3639
|
+
# verify the required parameter 'email_customer_uuid' is set
|
|
3640
|
+
if @api_client.config.client_side_validation && email_customer_uuid.nil?
|
|
3641
|
+
fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.get_email_customer_dispatch_logs"
|
|
3642
|
+
end
|
|
3643
|
+
# resource path
|
|
3644
|
+
local_var_path = '/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/dispatch_logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))
|
|
3645
|
+
|
|
3646
|
+
# query parameters
|
|
3647
|
+
query_params = opts[:query_params] || {}
|
|
3648
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
3649
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
3650
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
|
|
3651
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3652
|
+
query_params[:'scanForward'] = opts[:'scan_forward'] if !opts[:'scan_forward'].nil?
|
|
3653
|
+
|
|
3654
|
+
# header parameters
|
|
3655
|
+
header_params = opts[:header_params] || {}
|
|
3656
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3657
|
+
# HTTP header 'Accept' (if needed)
|
|
3658
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3659
|
+
|
|
3660
|
+
# form parameters
|
|
3661
|
+
form_params = opts[:form_params] || {}
|
|
3662
|
+
|
|
3663
|
+
# http body (model)
|
|
3664
|
+
post_body = opts[:debug_body]
|
|
3665
|
+
|
|
3666
|
+
# return_type
|
|
3667
|
+
return_type = opts[:debug_return_type] || 'EmailDispatchLogsResponse'
|
|
3668
|
+
|
|
3669
|
+
# auth_names
|
|
3670
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3671
|
+
|
|
3672
|
+
new_options = opts.merge(
|
|
3673
|
+
:operation => :"StorefrontApi.get_email_customer_dispatch_logs",
|
|
3674
|
+
:header_params => header_params,
|
|
3675
|
+
:query_params => query_params,
|
|
3676
|
+
:form_params => form_params,
|
|
3677
|
+
:body => post_body,
|
|
3678
|
+
:auth_names => auth_names,
|
|
3679
|
+
:return_type => return_type
|
|
3680
|
+
)
|
|
3681
|
+
|
|
3682
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3683
|
+
if @api_client.config.debugging
|
|
3684
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_customer_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3685
|
+
end
|
|
3686
|
+
return data, status_code, headers
|
|
3687
|
+
end
|
|
3688
|
+
|
|
3604
3689
|
# Get customers editor URL
|
|
3605
3690
|
# @param storefront_oid [Integer]
|
|
3606
3691
|
# @param email_customer_uuid [String]
|
|
@@ -3870,6 +3955,73 @@ module UltracartClient
|
|
|
3870
3955
|
return data, status_code, headers
|
|
3871
3956
|
end
|
|
3872
3957
|
|
|
3958
|
+
# Resolve a customer email to its ESP customer UUID
|
|
3959
|
+
# Entry-hop resolver for the customer-journey screen (AP0). Returns the esp_customer_uuid for a merchant's customer email, or a null uuid when the email is not on file.
|
|
3960
|
+
# @param storefront_oid [Integer]
|
|
3961
|
+
# @param [Hash] opts the optional parameters
|
|
3962
|
+
# @option opts [String] :email
|
|
3963
|
+
# @return [EmailCustomerLookupResponse]
|
|
3964
|
+
def get_email_dispatch_log_customer_lookup(storefront_oid, opts = {})
|
|
3965
|
+
data, _status_code, _headers = get_email_dispatch_log_customer_lookup_with_http_info(storefront_oid, opts)
|
|
3966
|
+
data
|
|
3967
|
+
end
|
|
3968
|
+
|
|
3969
|
+
# Resolve a customer email to its ESP customer UUID
|
|
3970
|
+
# Entry-hop resolver for the customer-journey screen (AP0). Returns the esp_customer_uuid for a merchant's customer email, or a null uuid when the email is not on file.
|
|
3971
|
+
# @param storefront_oid [Integer]
|
|
3972
|
+
# @param [Hash] opts the optional parameters
|
|
3973
|
+
# @option opts [String] :email
|
|
3974
|
+
# @return [Array<(EmailCustomerLookupResponse, Integer, Hash)>] EmailCustomerLookupResponse data, response status code and response headers
|
|
3975
|
+
def get_email_dispatch_log_customer_lookup_with_http_info(storefront_oid, opts = {})
|
|
3976
|
+
if @api_client.config.debugging
|
|
3977
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dispatch_log_customer_lookup ...'
|
|
3978
|
+
end
|
|
3979
|
+
# verify the required parameter 'storefront_oid' is set
|
|
3980
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3981
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dispatch_log_customer_lookup"
|
|
3982
|
+
end
|
|
3983
|
+
# resource path
|
|
3984
|
+
local_var_path = '/storefront/{storefront_oid}/email/dispatch_logs/customer_lookup'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
3985
|
+
|
|
3986
|
+
# query parameters
|
|
3987
|
+
query_params = opts[:query_params] || {}
|
|
3988
|
+
query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
|
|
3989
|
+
|
|
3990
|
+
# header parameters
|
|
3991
|
+
header_params = opts[:header_params] || {}
|
|
3992
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3993
|
+
# HTTP header 'Accept' (if needed)
|
|
3994
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3995
|
+
|
|
3996
|
+
# form parameters
|
|
3997
|
+
form_params = opts[:form_params] || {}
|
|
3998
|
+
|
|
3999
|
+
# http body (model)
|
|
4000
|
+
post_body = opts[:debug_body]
|
|
4001
|
+
|
|
4002
|
+
# return_type
|
|
4003
|
+
return_type = opts[:debug_return_type] || 'EmailCustomerLookupResponse'
|
|
4004
|
+
|
|
4005
|
+
# auth_names
|
|
4006
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4007
|
+
|
|
4008
|
+
new_options = opts.merge(
|
|
4009
|
+
:operation => :"StorefrontApi.get_email_dispatch_log_customer_lookup",
|
|
4010
|
+
:header_params => header_params,
|
|
4011
|
+
:query_params => query_params,
|
|
4012
|
+
:form_params => form_params,
|
|
4013
|
+
:body => post_body,
|
|
4014
|
+
:auth_names => auth_names,
|
|
4015
|
+
:return_type => return_type
|
|
4016
|
+
)
|
|
4017
|
+
|
|
4018
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4019
|
+
if @api_client.config.debugging
|
|
4020
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_dispatch_log_customer_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4021
|
+
end
|
|
4022
|
+
return data, status_code, headers
|
|
4023
|
+
end
|
|
4024
|
+
|
|
3873
4025
|
# Get email dispatch logs
|
|
3874
4026
|
# @param storefront_oid [Integer]
|
|
3875
4027
|
# @param commseq_uuid [String]
|
|
@@ -6103,6 +6255,176 @@ module UltracartClient
|
|
|
6103
6255
|
return data, status_code, headers
|
|
6104
6256
|
end
|
|
6105
6257
|
|
|
6258
|
+
# Get the full detail of a single dispatch-log record
|
|
6259
|
+
# Fetches and gunzips the full detail payload of one dispatch-log record (AP5 drill-down), identified by its step plus the log_dts and esp_customer_uuid shown on the list row.
|
|
6260
|
+
# @param storefront_oid [Integer]
|
|
6261
|
+
# @param commseq_uuid [String]
|
|
6262
|
+
# @param commseq_step_uuid [String]
|
|
6263
|
+
# @param [Hash] opts the optional parameters
|
|
6264
|
+
# @option opts [String] :log_dts
|
|
6265
|
+
# @option opts [String] :esp_customer_uuid
|
|
6266
|
+
# @return [EmailDispatchLogDetailResponse]
|
|
6267
|
+
def get_email_step_dispatch_log_detail(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
6268
|
+
data, _status_code, _headers = get_email_step_dispatch_log_detail_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
6269
|
+
data
|
|
6270
|
+
end
|
|
6271
|
+
|
|
6272
|
+
# Get the full detail of a single dispatch-log record
|
|
6273
|
+
# Fetches and gunzips the full detail payload of one dispatch-log record (AP5 drill-down), identified by its step plus the log_dts and esp_customer_uuid shown on the list row.
|
|
6274
|
+
# @param storefront_oid [Integer]
|
|
6275
|
+
# @param commseq_uuid [String]
|
|
6276
|
+
# @param commseq_step_uuid [String]
|
|
6277
|
+
# @param [Hash] opts the optional parameters
|
|
6278
|
+
# @option opts [String] :log_dts
|
|
6279
|
+
# @option opts [String] :esp_customer_uuid
|
|
6280
|
+
# @return [Array<(EmailDispatchLogDetailResponse, Integer, Hash)>] EmailDispatchLogDetailResponse data, response status code and response headers
|
|
6281
|
+
def get_email_step_dispatch_log_detail_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
6282
|
+
if @api_client.config.debugging
|
|
6283
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_step_dispatch_log_detail ...'
|
|
6284
|
+
end
|
|
6285
|
+
# verify the required parameter 'storefront_oid' is set
|
|
6286
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
6287
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_step_dispatch_log_detail"
|
|
6288
|
+
end
|
|
6289
|
+
# verify the required parameter 'commseq_uuid' is set
|
|
6290
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
|
6291
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_step_dispatch_log_detail"
|
|
6292
|
+
end
|
|
6293
|
+
# verify the required parameter 'commseq_step_uuid' is set
|
|
6294
|
+
if @api_client.config.client_side_validation && commseq_step_uuid.nil?
|
|
6295
|
+
fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_step_dispatch_log_detail"
|
|
6296
|
+
end
|
|
6297
|
+
# resource path
|
|
6298
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs/detail'.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))
|
|
6299
|
+
|
|
6300
|
+
# query parameters
|
|
6301
|
+
query_params = opts[:query_params] || {}
|
|
6302
|
+
query_params[:'log_dts'] = opts[:'log_dts'] if !opts[:'log_dts'].nil?
|
|
6303
|
+
query_params[:'esp_customer_uuid'] = opts[:'esp_customer_uuid'] if !opts[:'esp_customer_uuid'].nil?
|
|
6304
|
+
|
|
6305
|
+
# header parameters
|
|
6306
|
+
header_params = opts[:header_params] || {}
|
|
6307
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
6308
|
+
# HTTP header 'Accept' (if needed)
|
|
6309
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6310
|
+
|
|
6311
|
+
# form parameters
|
|
6312
|
+
form_params = opts[:form_params] || {}
|
|
6313
|
+
|
|
6314
|
+
# http body (model)
|
|
6315
|
+
post_body = opts[:debug_body]
|
|
6316
|
+
|
|
6317
|
+
# return_type
|
|
6318
|
+
return_type = opts[:debug_return_type] || 'EmailDispatchLogDetailResponse'
|
|
6319
|
+
|
|
6320
|
+
# auth_names
|
|
6321
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
6322
|
+
|
|
6323
|
+
new_options = opts.merge(
|
|
6324
|
+
:operation => :"StorefrontApi.get_email_step_dispatch_log_detail",
|
|
6325
|
+
:header_params => header_params,
|
|
6326
|
+
:query_params => query_params,
|
|
6327
|
+
:form_params => form_params,
|
|
6328
|
+
:body => post_body,
|
|
6329
|
+
:auth_names => auth_names,
|
|
6330
|
+
:return_type => return_type
|
|
6331
|
+
)
|
|
6332
|
+
|
|
6333
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6334
|
+
if @api_client.config.debugging
|
|
6335
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_step_dispatch_log_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6336
|
+
end
|
|
6337
|
+
return data, status_code, headers
|
|
6338
|
+
end
|
|
6339
|
+
|
|
6340
|
+
# Get a paginated, date-boundable dispatch-log feed for a step
|
|
6341
|
+
# Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
6342
|
+
# @param storefront_oid [Integer]
|
|
6343
|
+
# @param commseq_uuid [String]
|
|
6344
|
+
# @param commseq_step_uuid [String]
|
|
6345
|
+
# @param [Hash] opts the optional parameters
|
|
6346
|
+
# @option opts [String] :since
|
|
6347
|
+
# @option opts [String] :_until
|
|
6348
|
+
# @option opts [Integer] :page_number
|
|
6349
|
+
# @option opts [Integer] :page_size
|
|
6350
|
+
# @return [EmailDispatchLogsResponse]
|
|
6351
|
+
def get_email_step_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
6352
|
+
data, _status_code, _headers = get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
6353
|
+
data
|
|
6354
|
+
end
|
|
6355
|
+
|
|
6356
|
+
# Get a paginated, date-boundable dispatch-log feed for a step
|
|
6357
|
+
# Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
6358
|
+
# @param storefront_oid [Integer]
|
|
6359
|
+
# @param commseq_uuid [String]
|
|
6360
|
+
# @param commseq_step_uuid [String]
|
|
6361
|
+
# @param [Hash] opts the optional parameters
|
|
6362
|
+
# @option opts [String] :since
|
|
6363
|
+
# @option opts [String] :_until
|
|
6364
|
+
# @option opts [Integer] :page_number
|
|
6365
|
+
# @option opts [Integer] :page_size
|
|
6366
|
+
# @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
|
|
6367
|
+
def get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
6368
|
+
if @api_client.config.debugging
|
|
6369
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_step_dispatch_logs ...'
|
|
6370
|
+
end
|
|
6371
|
+
# verify the required parameter 'storefront_oid' is set
|
|
6372
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
6373
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_step_dispatch_logs"
|
|
6374
|
+
end
|
|
6375
|
+
# verify the required parameter 'commseq_uuid' is set
|
|
6376
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
|
6377
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_step_dispatch_logs"
|
|
6378
|
+
end
|
|
6379
|
+
# verify the required parameter 'commseq_step_uuid' is set
|
|
6380
|
+
if @api_client.config.client_side_validation && commseq_step_uuid.nil?
|
|
6381
|
+
fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_step_dispatch_logs"
|
|
6382
|
+
end
|
|
6383
|
+
# resource path
|
|
6384
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs'.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))
|
|
6385
|
+
|
|
6386
|
+
# query parameters
|
|
6387
|
+
query_params = opts[:query_params] || {}
|
|
6388
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
6389
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
6390
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
|
|
6391
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
6392
|
+
|
|
6393
|
+
# header parameters
|
|
6394
|
+
header_params = opts[:header_params] || {}
|
|
6395
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
6396
|
+
# HTTP header 'Accept' (if needed)
|
|
6397
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6398
|
+
|
|
6399
|
+
# form parameters
|
|
6400
|
+
form_params = opts[:form_params] || {}
|
|
6401
|
+
|
|
6402
|
+
# http body (model)
|
|
6403
|
+
post_body = opts[:debug_body]
|
|
6404
|
+
|
|
6405
|
+
# return_type
|
|
6406
|
+
return_type = opts[:debug_return_type] || 'EmailDispatchLogsResponse'
|
|
6407
|
+
|
|
6408
|
+
# auth_names
|
|
6409
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
6410
|
+
|
|
6411
|
+
new_options = opts.merge(
|
|
6412
|
+
:operation => :"StorefrontApi.get_email_step_dispatch_logs",
|
|
6413
|
+
:header_params => header_params,
|
|
6414
|
+
:query_params => query_params,
|
|
6415
|
+
:form_params => form_params,
|
|
6416
|
+
:body => post_body,
|
|
6417
|
+
:auth_names => auth_names,
|
|
6418
|
+
:return_type => return_type
|
|
6419
|
+
)
|
|
6420
|
+
|
|
6421
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6422
|
+
if @api_client.config.debugging
|
|
6423
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_step_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6424
|
+
end
|
|
6425
|
+
return data, status_code, headers
|
|
6426
|
+
end
|
|
6427
|
+
|
|
6106
6428
|
# Get email template
|
|
6107
6429
|
# @param storefront_oid [Integer]
|
|
6108
6430
|
# @param email_template_oid [Integer]
|