ultracart_api 3.10.206 → 3.10.207
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -4
- data/docs/EmailRateLimiter.md +10 -0
- data/docs/EmailRateLimitersResponse.md +12 -0
- data/docs/StorefrontApi.md +103 -0
- data/lib/ultracart_api/api/storefront_api.rb +117 -0
- data/lib/ultracart_api/models/email_rate_limiter.rb +202 -0
- data/lib/ultracart_api/models/email_rate_limiters_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 37cb036e0e5cd8b4094dfb946c40c4935a1d9d3a443b60b06fcc1e089fcc7c6f
|
4
|
+
data.tar.gz: 97b0bd759c9227b5d641d88929f898c5b635f8c0c25a8e22393be22e5d58d44f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eecf19f6320987886804b45238cf62fe4b1ac13f27dbba719a478a24f70475a62237d2215a87bc2ce404e783db6dc61a6341ace379beefedc6a931ab2a6c32c6
|
7
|
+
data.tar.gz: f30f3e1fffcd6e1aa6c163b040ba7ee231e230667a7e8773cc9a26b6bb36a0f273a923aa93e23b3e70ef07405006bca6decf5e578caecd9771b9b4f24dc9108d
|
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.
|
10
|
+
- Package version: 3.10.207
|
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.
|
27
|
+
gem install ./ultracart_api-3.10.207.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.207.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.
|
35
|
+
gem 'ultracart_api', '~> 3.10.207'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -386,6 +386,7 @@ Class | Method | HTTP request | Description
|
|
386
386
|
*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
|
387
387
|
*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
|
388
388
|
*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
|
389
|
+
*UltracartClient::StorefrontApi* | [**get_email_commseq_rate_limiters**](docs/StorefrontApi.md#get_email_commseq_rate_limiters) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters | Get email commseq rate limiters
|
389
390
|
*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
|
390
391
|
*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
|
391
392
|
*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
|
@@ -475,6 +476,7 @@ Class | Method | HTTP request | Description
|
|
475
476
|
*UltracartClient::StorefrontApi* | [**publish_library_item**](docs/StorefrontApi.md#publish_library_item) | **POST** /storefront/code_library/{library_item_oid}/publish | Publish library item.
|
476
477
|
*UltracartClient::StorefrontApi* | [**purchase_library_item**](docs/StorefrontApi.md#purchase_library_item) | **POST** /storefront/code_library/{library_item_oid}/purchase | Purchase public library item, which creates a copy of the item in your personal code library
|
477
478
|
*UltracartClient::StorefrontApi* | [**release_email_commseq_step_waiting**](docs/StorefrontApi.md#release_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid} | Release email communication sequence customers waiting at the specified step
|
479
|
+
*UltracartClient::StorefrontApi* | [**reset_email_commseq_rate_limiters**](docs/StorefrontApi.md#reset_email_commseq_rate_limiters) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters | Reset email commseq rate limiters (only callable by UltraCart Support)
|
478
480
|
*UltracartClient::StorefrontApi* | [**review**](docs/StorefrontApi.md#review) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review | Request a review of an email
|
479
481
|
*UltracartClient::StorefrontApi* | [**search**](docs/StorefrontApi.md#search) | **GET** /storefront/search | Searches for all matching values
|
480
482
|
*UltracartClient::StorefrontApi* | [**search2**](docs/StorefrontApi.md#search2) | **POST** /storefront/search | Searches for all matching values (using POST)
|
@@ -999,6 +1001,8 @@ Class | Method | HTTP request | Description
|
|
999
1001
|
- [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
|
1000
1002
|
- [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
|
1001
1003
|
- [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
|
1004
|
+
- [UltracartClient::EmailRateLimiter](docs/EmailRateLimiter.md)
|
1005
|
+
- [UltracartClient::EmailRateLimitersResponse](docs/EmailRateLimitersResponse.md)
|
1002
1006
|
- [UltracartClient::EmailSegment](docs/EmailSegment.md)
|
1003
1007
|
- [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
|
1004
1008
|
- [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
|
@@ -1501,6 +1505,7 @@ Not every change is committed to every SDK.
|
|
1501
1505
|
|
1502
1506
|
| Version | Date | Comments |
|
1503
1507
|
| --: | :-: | --- |
|
1508
|
+
| 3.10.207 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
|
1504
1509
|
| 3.10.206 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
|
1505
1510
|
| 3.10.205 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
|
1506
1511
|
| 3.10.204 | 05/16/2024 | OrderPayment - constants for payment method Amazon Pay and Link |
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::EmailRateLimiter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**available** | **Integer** | | [optional]
|
7
|
+
**limit** | **Integer** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::EmailRateLimitersResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**rate_limiters** | [**Array<EmailRateLimiter>**](EmailRateLimiter.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/StorefrontApi.md
CHANGED
@@ -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_rate_limiters**](StorefrontApi.md#get_email_commseq_rate_limiters) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters | Get email commseq rate limiters
|
50
51
|
[**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
|
51
52
|
[**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
|
52
53
|
[**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
|
@@ -136,6 +137,7 @@ Method | HTTP request | Description
|
|
136
137
|
[**publish_library_item**](StorefrontApi.md#publish_library_item) | **POST** /storefront/code_library/{library_item_oid}/publish | Publish library item.
|
137
138
|
[**purchase_library_item**](StorefrontApi.md#purchase_library_item) | **POST** /storefront/code_library/{library_item_oid}/purchase | Purchase public library item, which creates a copy of the item in your personal code library
|
138
139
|
[**release_email_commseq_step_waiting**](StorefrontApi.md#release_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid} | Release email communication sequence customers waiting at the specified step
|
140
|
+
[**reset_email_commseq_rate_limiters**](StorefrontApi.md#reset_email_commseq_rate_limiters) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters | Reset email commseq rate limiters (only callable by UltraCart Support)
|
139
141
|
[**review**](StorefrontApi.md#review) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review | Request a review of an email
|
140
142
|
[**search**](StorefrontApi.md#search) | **GET** /storefront/search | Searches for all matching values
|
141
143
|
[**search2**](StorefrontApi.md#search2) | **POST** /storefront/search | Searches for all matching values (using POST)
|
@@ -2358,6 +2360,57 @@ Name | Type | Description | Notes
|
|
2358
2360
|
|
2359
2361
|
|
2360
2362
|
|
2363
|
+
# **get_email_commseq_rate_limiters**
|
2364
|
+
> EmailRateLimitersResponse get_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
2365
|
+
|
2366
|
+
Get email commseq rate limiters
|
2367
|
+
|
2368
|
+
### Example
|
2369
|
+
```ruby
|
2370
|
+
# load the gem
|
2371
|
+
require 'ultracart_api'
|
2372
|
+
|
2373
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2374
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2375
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
2376
|
+
|
2377
|
+
|
2378
|
+
storefront_oid = 56 # Integer |
|
2379
|
+
|
2380
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
2381
|
+
|
2382
|
+
|
2383
|
+
begin
|
2384
|
+
#Get email commseq rate limiters
|
2385
|
+
result = api_instance.get_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
2386
|
+
p result
|
2387
|
+
rescue UltracartClient::ApiError => e
|
2388
|
+
puts "Exception when calling StorefrontApi->get_email_commseq_rate_limiters: #{e}"
|
2389
|
+
end
|
2390
|
+
```
|
2391
|
+
|
2392
|
+
### Parameters
|
2393
|
+
|
2394
|
+
Name | Type | Description | Notes
|
2395
|
+
------------- | ------------- | ------------- | -------------
|
2396
|
+
**storefront_oid** | **Integer**| |
|
2397
|
+
**commseq_uuid** | **String**| |
|
2398
|
+
|
2399
|
+
### Return type
|
2400
|
+
|
2401
|
+
[**EmailRateLimitersResponse**](EmailRateLimitersResponse.md)
|
2402
|
+
|
2403
|
+
### Authorization
|
2404
|
+
|
2405
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2406
|
+
|
2407
|
+
### HTTP request headers
|
2408
|
+
|
2409
|
+
- **Content-Type**: application/json
|
2410
|
+
- **Accept**: application/json
|
2411
|
+
|
2412
|
+
|
2413
|
+
|
2361
2414
|
# **get_email_commseq_sms_stats**
|
2362
2415
|
> EmailStatSmsSummaryResponse get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
|
2363
2416
|
|
@@ -6918,6 +6971,56 @@ nil (empty response body)
|
|
6918
6971
|
|
6919
6972
|
|
6920
6973
|
|
6974
|
+
# **reset_email_commseq_rate_limiters**
|
6975
|
+
> reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
6976
|
+
|
6977
|
+
Reset email commseq rate limiters (only callable by UltraCart Support)
|
6978
|
+
|
6979
|
+
### Example
|
6980
|
+
```ruby
|
6981
|
+
# load the gem
|
6982
|
+
require 'ultracart_api'
|
6983
|
+
|
6984
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
6985
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
6986
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
6987
|
+
|
6988
|
+
|
6989
|
+
storefront_oid = 56 # Integer |
|
6990
|
+
|
6991
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
6992
|
+
|
6993
|
+
|
6994
|
+
begin
|
6995
|
+
#Reset email commseq rate limiters (only callable by UltraCart Support)
|
6996
|
+
api_instance.reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
6997
|
+
rescue UltracartClient::ApiError => e
|
6998
|
+
puts "Exception when calling StorefrontApi->reset_email_commseq_rate_limiters: #{e}"
|
6999
|
+
end
|
7000
|
+
```
|
7001
|
+
|
7002
|
+
### Parameters
|
7003
|
+
|
7004
|
+
Name | Type | Description | Notes
|
7005
|
+
------------- | ------------- | ------------- | -------------
|
7006
|
+
**storefront_oid** | **Integer**| |
|
7007
|
+
**commseq_uuid** | **String**| |
|
7008
|
+
|
7009
|
+
### Return type
|
7010
|
+
|
7011
|
+
nil (empty response body)
|
7012
|
+
|
7013
|
+
### Authorization
|
7014
|
+
|
7015
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
7016
|
+
|
7017
|
+
### HTTP request headers
|
7018
|
+
|
7019
|
+
- **Content-Type**: application/json
|
7020
|
+
- **Accept**: application/json
|
7021
|
+
|
7022
|
+
|
7023
|
+
|
6921
7024
|
# **review**
|
6922
7025
|
> EmailCommseqEmailSendTestResponse review(storefront_oid, commseq_email_uuid, email_commseq_email_review_request)
|
6923
7026
|
|
@@ -2516,6 +2516,65 @@ module UltracartClient
|
|
2516
2516
|
end
|
2517
2517
|
return data, status_code, headers
|
2518
2518
|
end
|
2519
|
+
# Get email commseq rate limiters
|
2520
|
+
# @param storefront_oid
|
2521
|
+
# @param commseq_uuid
|
2522
|
+
# @param [Hash] opts the optional parameters
|
2523
|
+
# @return [EmailRateLimitersResponse]
|
2524
|
+
def get_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
|
2525
|
+
data, _status_code, _headers = get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
|
2526
|
+
data
|
2527
|
+
end
|
2528
|
+
|
2529
|
+
# Get email commseq rate limiters
|
2530
|
+
# @param storefront_oid
|
2531
|
+
# @param commseq_uuid
|
2532
|
+
# @param [Hash] opts the optional parameters
|
2533
|
+
# @return [Array<(EmailRateLimitersResponse, Fixnum, Hash)>] EmailRateLimitersResponse data, response status code and response headers
|
2534
|
+
def get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
|
2535
|
+
if @api_client.config.debugging
|
2536
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_rate_limiters ...'
|
2537
|
+
end
|
2538
|
+
# verify the required parameter 'storefront_oid' is set
|
2539
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
2540
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_rate_limiters"
|
2541
|
+
end
|
2542
|
+
# verify the required parameter 'commseq_uuid' is set
|
2543
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
2544
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_rate_limiters"
|
2545
|
+
end
|
2546
|
+
# resource path
|
2547
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)
|
2548
|
+
|
2549
|
+
# query parameters
|
2550
|
+
query_params = {}
|
2551
|
+
|
2552
|
+
# header parameters
|
2553
|
+
header_params = {}
|
2554
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2555
|
+
# HTTP header 'Accept' (if needed)
|
2556
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2557
|
+
# HTTP header 'Content-Type'
|
2558
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2559
|
+
|
2560
|
+
# form parameters
|
2561
|
+
form_params = {}
|
2562
|
+
|
2563
|
+
# http body (model)
|
2564
|
+
post_body = nil
|
2565
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
2566
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2567
|
+
:header_params => header_params,
|
2568
|
+
:query_params => query_params,
|
2569
|
+
:form_params => form_params,
|
2570
|
+
:body => post_body,
|
2571
|
+
:auth_names => auth_names,
|
2572
|
+
:return_type => 'EmailRateLimitersResponse')
|
2573
|
+
if @api_client.config.debugging
|
2574
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2575
|
+
end
|
2576
|
+
return data, status_code, headers
|
2577
|
+
end
|
2519
2578
|
# Get email communication sequence sms stats
|
2520
2579
|
# @param storefront_oid
|
2521
2580
|
# @param commseq_uuid
|
@@ -7708,6 +7767,64 @@ module UltracartClient
|
|
7708
7767
|
end
|
7709
7768
|
return data, status_code, headers
|
7710
7769
|
end
|
7770
|
+
# Reset email commseq rate limiters (only callable by UltraCart Support)
|
7771
|
+
# @param storefront_oid
|
7772
|
+
# @param commseq_uuid
|
7773
|
+
# @param [Hash] opts the optional parameters
|
7774
|
+
# @return [nil]
|
7775
|
+
def reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
|
7776
|
+
reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
|
7777
|
+
nil
|
7778
|
+
end
|
7779
|
+
|
7780
|
+
# Reset email commseq rate limiters (only callable by UltraCart Support)
|
7781
|
+
# @param storefront_oid
|
7782
|
+
# @param commseq_uuid
|
7783
|
+
# @param [Hash] opts the optional parameters
|
7784
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
7785
|
+
def reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
|
7786
|
+
if @api_client.config.debugging
|
7787
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.reset_email_commseq_rate_limiters ...'
|
7788
|
+
end
|
7789
|
+
# verify the required parameter 'storefront_oid' is set
|
7790
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
7791
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
|
7792
|
+
end
|
7793
|
+
# verify the required parameter 'commseq_uuid' is set
|
7794
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
7795
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
|
7796
|
+
end
|
7797
|
+
# resource path
|
7798
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)
|
7799
|
+
|
7800
|
+
# query parameters
|
7801
|
+
query_params = {}
|
7802
|
+
|
7803
|
+
# header parameters
|
7804
|
+
header_params = {}
|
7805
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
7806
|
+
# HTTP header 'Accept' (if needed)
|
7807
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7808
|
+
# HTTP header 'Content-Type'
|
7809
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7810
|
+
|
7811
|
+
# form parameters
|
7812
|
+
form_params = {}
|
7813
|
+
|
7814
|
+
# http body (model)
|
7815
|
+
post_body = nil
|
7816
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
7817
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
7818
|
+
:header_params => header_params,
|
7819
|
+
:query_params => query_params,
|
7820
|
+
:form_params => form_params,
|
7821
|
+
:body => post_body,
|
7822
|
+
:auth_names => auth_names)
|
7823
|
+
if @api_client.config.debugging
|
7824
|
+
@api_client.config.logger.debug "API called: StorefrontApi#reset_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7825
|
+
end
|
7826
|
+
return data, status_code, headers
|
7827
|
+
end
|
7711
7828
|
# Request a review of an email
|
7712
7829
|
# @param storefront_oid
|
7713
7830
|
# @param commseq_email_uuid
|
@@ -0,0 +1,202 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class EmailRateLimiter
|
17
|
+
attr_accessor :available
|
18
|
+
|
19
|
+
attr_accessor :limit
|
20
|
+
|
21
|
+
attr_accessor :name
|
22
|
+
|
23
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
24
|
+
def self.attribute_map
|
25
|
+
{
|
26
|
+
:'available' => :'available',
|
27
|
+
:'limit' => :'limit',
|
28
|
+
:'name' => :'name'
|
29
|
+
}
|
30
|
+
end
|
31
|
+
|
32
|
+
# Attribute type mapping.
|
33
|
+
def self.swagger_types
|
34
|
+
{
|
35
|
+
:'available' => :'Integer',
|
36
|
+
:'limit' => :'Integer',
|
37
|
+
:'name' => :'String'
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
# Initializes the object
|
42
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
43
|
+
def initialize(attributes = {})
|
44
|
+
return unless attributes.is_a?(Hash)
|
45
|
+
|
46
|
+
# convert string to symbol for hash key
|
47
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
48
|
+
|
49
|
+
if attributes.has_key?(:'available')
|
50
|
+
self.available = attributes[:'available']
|
51
|
+
end
|
52
|
+
|
53
|
+
if attributes.has_key?(:'limit')
|
54
|
+
self.limit = attributes[:'limit']
|
55
|
+
end
|
56
|
+
|
57
|
+
if attributes.has_key?(:'name')
|
58
|
+
self.name = attributes[:'name']
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
63
|
+
# @return Array for valid properties with the reasons
|
64
|
+
def list_invalid_properties
|
65
|
+
invalid_properties = Array.new
|
66
|
+
invalid_properties
|
67
|
+
end
|
68
|
+
|
69
|
+
# Check to see if the all the properties in the model are valid
|
70
|
+
# @return true if the model is valid
|
71
|
+
def valid?
|
72
|
+
true
|
73
|
+
end
|
74
|
+
|
75
|
+
# Checks equality by comparing each attribute.
|
76
|
+
# @param [Object] Object to be compared
|
77
|
+
def ==(o)
|
78
|
+
return true if self.equal?(o)
|
79
|
+
self.class == o.class &&
|
80
|
+
available == o.available &&
|
81
|
+
limit == o.limit &&
|
82
|
+
name == o.name
|
83
|
+
end
|
84
|
+
|
85
|
+
# @see the `==` method
|
86
|
+
# @param [Object] Object to be compared
|
87
|
+
def eql?(o)
|
88
|
+
self == o
|
89
|
+
end
|
90
|
+
|
91
|
+
# Calculates hash code according to all attributes.
|
92
|
+
# @return [Fixnum] Hash code
|
93
|
+
def hash
|
94
|
+
[available, limit, name].hash
|
95
|
+
end
|
96
|
+
|
97
|
+
# Builds the object from hash
|
98
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
99
|
+
# @return [Object] Returns the model itself
|
100
|
+
def build_from_hash(attributes)
|
101
|
+
return nil unless attributes.is_a?(Hash)
|
102
|
+
self.class.swagger_types.each_pair do |key, type|
|
103
|
+
if type =~ /\AArray<(.*)>/i
|
104
|
+
# check to ensure the input is an array given that the attribute
|
105
|
+
# is documented as an array but the input is not
|
106
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
107
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
108
|
+
end
|
109
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
110
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
111
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
112
|
+
end
|
113
|
+
|
114
|
+
self
|
115
|
+
end
|
116
|
+
|
117
|
+
# Deserializes the data based on type
|
118
|
+
# @param string type Data type
|
119
|
+
# @param string value Value to be deserialized
|
120
|
+
# @return [Object] Deserialized data
|
121
|
+
def _deserialize(type, value)
|
122
|
+
case type.to_sym
|
123
|
+
when :DateTime
|
124
|
+
DateTime.parse(value)
|
125
|
+
when :Date
|
126
|
+
Date.parse(value)
|
127
|
+
when :String
|
128
|
+
value.to_s
|
129
|
+
when :Integer
|
130
|
+
value.to_i
|
131
|
+
when :Float
|
132
|
+
value.to_f
|
133
|
+
when :BOOLEAN
|
134
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
135
|
+
true
|
136
|
+
else
|
137
|
+
false
|
138
|
+
end
|
139
|
+
when :Object
|
140
|
+
# generic object (usually a Hash), return directly
|
141
|
+
value
|
142
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
143
|
+
inner_type = Regexp.last_match[:inner_type]
|
144
|
+
value.map { |v| _deserialize(inner_type, v) }
|
145
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
146
|
+
k_type = Regexp.last_match[:k_type]
|
147
|
+
v_type = Regexp.last_match[:v_type]
|
148
|
+
{}.tap do |hash|
|
149
|
+
value.each do |k, v|
|
150
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
else # model
|
154
|
+
temp_model = UltracartClient.const_get(type).new
|
155
|
+
temp_model.build_from_hash(value)
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# Returns the string representation of the object
|
160
|
+
# @return [String] String presentation of the object
|
161
|
+
def to_s
|
162
|
+
to_hash.to_s
|
163
|
+
end
|
164
|
+
|
165
|
+
# to_body is an alias to to_hash (backward compatibility)
|
166
|
+
# @return [Hash] Returns the object in the form of hash
|
167
|
+
def to_body
|
168
|
+
to_hash
|
169
|
+
end
|
170
|
+
|
171
|
+
# Returns the object in the form of hash
|
172
|
+
# @return [Hash] Returns the object in the form of hash
|
173
|
+
def to_hash
|
174
|
+
hash = {}
|
175
|
+
self.class.attribute_map.each_pair do |attr, param|
|
176
|
+
value = self.send(attr)
|
177
|
+
next if value.nil?
|
178
|
+
hash[param] = _to_hash(value)
|
179
|
+
end
|
180
|
+
hash
|
181
|
+
end
|
182
|
+
|
183
|
+
# Outputs non-array value in the form of hash
|
184
|
+
# For object, use to_hash. Otherwise, just return the value
|
185
|
+
# @param [Object] value Any valid value
|
186
|
+
# @return [Hash] Returns the value in the form of hash
|
187
|
+
def _to_hash(value)
|
188
|
+
if value.is_a?(Array)
|
189
|
+
value.compact.map { |v| _to_hash(v) }
|
190
|
+
elsif value.is_a?(Hash)
|
191
|
+
{}.tap do |hash|
|
192
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
193
|
+
end
|
194
|
+
elsif value.respond_to? :to_hash
|
195
|
+
value.to_hash
|
196
|
+
else
|
197
|
+
value
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
end
|
202
|
+
end
|
@@ -0,0 +1,223 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class EmailRateLimitersResponse
|
17
|
+
attr_accessor :error
|
18
|
+
|
19
|
+
attr_accessor :metadata
|
20
|
+
|
21
|
+
attr_accessor :rate_limiters
|
22
|
+
|
23
|
+
# Indicates if API call was successful
|
24
|
+
attr_accessor :success
|
25
|
+
|
26
|
+
attr_accessor :warning
|
27
|
+
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
29
|
+
def self.attribute_map
|
30
|
+
{
|
31
|
+
:'error' => :'error',
|
32
|
+
:'metadata' => :'metadata',
|
33
|
+
:'rate_limiters' => :'rate_limiters',
|
34
|
+
:'success' => :'success',
|
35
|
+
:'warning' => :'warning'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Attribute type mapping.
|
40
|
+
def self.swagger_types
|
41
|
+
{
|
42
|
+
:'error' => :'Error',
|
43
|
+
:'metadata' => :'ResponseMetadata',
|
44
|
+
:'rate_limiters' => :'Array<EmailRateLimiter>',
|
45
|
+
:'success' => :'BOOLEAN',
|
46
|
+
:'warning' => :'Warning'
|
47
|
+
}
|
48
|
+
end
|
49
|
+
|
50
|
+
# Initializes the object
|
51
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
52
|
+
def initialize(attributes = {})
|
53
|
+
return unless attributes.is_a?(Hash)
|
54
|
+
|
55
|
+
# convert string to symbol for hash key
|
56
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
57
|
+
|
58
|
+
if attributes.has_key?(:'error')
|
59
|
+
self.error = attributes[:'error']
|
60
|
+
end
|
61
|
+
|
62
|
+
if attributes.has_key?(:'metadata')
|
63
|
+
self.metadata = attributes[:'metadata']
|
64
|
+
end
|
65
|
+
|
66
|
+
if attributes.has_key?(:'rate_limiters')
|
67
|
+
if (value = attributes[:'rate_limiters']).is_a?(Array)
|
68
|
+
self.rate_limiters = value
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.has_key?(:'success')
|
73
|
+
self.success = attributes[:'success']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.has_key?(:'warning')
|
77
|
+
self.warning = attributes[:'warning']
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
82
|
+
# @return Array for valid properties with the reasons
|
83
|
+
def list_invalid_properties
|
84
|
+
invalid_properties = Array.new
|
85
|
+
invalid_properties
|
86
|
+
end
|
87
|
+
|
88
|
+
# Check to see if the all the properties in the model are valid
|
89
|
+
# @return true if the model is valid
|
90
|
+
def valid?
|
91
|
+
true
|
92
|
+
end
|
93
|
+
|
94
|
+
# Checks equality by comparing each attribute.
|
95
|
+
# @param [Object] Object to be compared
|
96
|
+
def ==(o)
|
97
|
+
return true if self.equal?(o)
|
98
|
+
self.class == o.class &&
|
99
|
+
error == o.error &&
|
100
|
+
metadata == o.metadata &&
|
101
|
+
rate_limiters == o.rate_limiters &&
|
102
|
+
success == o.success &&
|
103
|
+
warning == o.warning
|
104
|
+
end
|
105
|
+
|
106
|
+
# @see the `==` method
|
107
|
+
# @param [Object] Object to be compared
|
108
|
+
def eql?(o)
|
109
|
+
self == o
|
110
|
+
end
|
111
|
+
|
112
|
+
# Calculates hash code according to all attributes.
|
113
|
+
# @return [Fixnum] Hash code
|
114
|
+
def hash
|
115
|
+
[error, metadata, rate_limiters, success, warning].hash
|
116
|
+
end
|
117
|
+
|
118
|
+
# Builds the object from hash
|
119
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
120
|
+
# @return [Object] Returns the model itself
|
121
|
+
def build_from_hash(attributes)
|
122
|
+
return nil unless attributes.is_a?(Hash)
|
123
|
+
self.class.swagger_types.each_pair do |key, type|
|
124
|
+
if type =~ /\AArray<(.*)>/i
|
125
|
+
# check to ensure the input is an array given that the attribute
|
126
|
+
# is documented as an array but the input is not
|
127
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
128
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
129
|
+
end
|
130
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
131
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
132
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
133
|
+
end
|
134
|
+
|
135
|
+
self
|
136
|
+
end
|
137
|
+
|
138
|
+
# Deserializes the data based on type
|
139
|
+
# @param string type Data type
|
140
|
+
# @param string value Value to be deserialized
|
141
|
+
# @return [Object] Deserialized data
|
142
|
+
def _deserialize(type, value)
|
143
|
+
case type.to_sym
|
144
|
+
when :DateTime
|
145
|
+
DateTime.parse(value)
|
146
|
+
when :Date
|
147
|
+
Date.parse(value)
|
148
|
+
when :String
|
149
|
+
value.to_s
|
150
|
+
when :Integer
|
151
|
+
value.to_i
|
152
|
+
when :Float
|
153
|
+
value.to_f
|
154
|
+
when :BOOLEAN
|
155
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
156
|
+
true
|
157
|
+
else
|
158
|
+
false
|
159
|
+
end
|
160
|
+
when :Object
|
161
|
+
# generic object (usually a Hash), return directly
|
162
|
+
value
|
163
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
164
|
+
inner_type = Regexp.last_match[:inner_type]
|
165
|
+
value.map { |v| _deserialize(inner_type, v) }
|
166
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
167
|
+
k_type = Regexp.last_match[:k_type]
|
168
|
+
v_type = Regexp.last_match[:v_type]
|
169
|
+
{}.tap do |hash|
|
170
|
+
value.each do |k, v|
|
171
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
172
|
+
end
|
173
|
+
end
|
174
|
+
else # model
|
175
|
+
temp_model = UltracartClient.const_get(type).new
|
176
|
+
temp_model.build_from_hash(value)
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# Returns the string representation of the object
|
181
|
+
# @return [String] String presentation of the object
|
182
|
+
def to_s
|
183
|
+
to_hash.to_s
|
184
|
+
end
|
185
|
+
|
186
|
+
# to_body is an alias to to_hash (backward compatibility)
|
187
|
+
# @return [Hash] Returns the object in the form of hash
|
188
|
+
def to_body
|
189
|
+
to_hash
|
190
|
+
end
|
191
|
+
|
192
|
+
# Returns the object in the form of hash
|
193
|
+
# @return [Hash] Returns the object in the form of hash
|
194
|
+
def to_hash
|
195
|
+
hash = {}
|
196
|
+
self.class.attribute_map.each_pair do |attr, param|
|
197
|
+
value = self.send(attr)
|
198
|
+
next if value.nil?
|
199
|
+
hash[param] = _to_hash(value)
|
200
|
+
end
|
201
|
+
hash
|
202
|
+
end
|
203
|
+
|
204
|
+
# Outputs non-array value in the form of hash
|
205
|
+
# For object, use to_hash. Otherwise, just return the value
|
206
|
+
# @param [Object] value Any valid value
|
207
|
+
# @return [Hash] Returns the value in the form of hash
|
208
|
+
def _to_hash(value)
|
209
|
+
if value.is_a?(Array)
|
210
|
+
value.compact.map { |v| _to_hash(v) }
|
211
|
+
elsif value.is_a?(Hash)
|
212
|
+
{}.tap do |hash|
|
213
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
214
|
+
end
|
215
|
+
elsif value.respond_to? :to_hash
|
216
|
+
value.to_hash
|
217
|
+
else
|
218
|
+
value
|
219
|
+
end
|
220
|
+
end
|
221
|
+
|
222
|
+
end
|
223
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -436,6 +436,8 @@ require 'ultracart_api/models/email_plan_response'
|
|
436
436
|
require 'ultracart_api/models/email_postcard_stat'
|
437
437
|
require 'ultracart_api/models/email_postcard_tracking'
|
438
438
|
require 'ultracart_api/models/email_postcard_tracking_response'
|
439
|
+
require 'ultracart_api/models/email_rate_limiter'
|
440
|
+
require 'ultracart_api/models/email_rate_limiters_response'
|
439
441
|
require 'ultracart_api/models/email_segment'
|
440
442
|
require 'ultracart_api/models/email_segment_archive_response'
|
441
443
|
require 'ultracart_api/models/email_segment_customer'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.10.
|
4
|
+
version: 3.10.207
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-05-
|
11
|
+
date: 2024-05-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -649,6 +649,8 @@ files:
|
|
649
649
|
- docs/EmailPostcardStat.md
|
650
650
|
- docs/EmailPostcardTracking.md
|
651
651
|
- docs/EmailPostcardTrackingResponse.md
|
652
|
+
- docs/EmailRateLimiter.md
|
653
|
+
- docs/EmailRateLimitersResponse.md
|
652
654
|
- docs/EmailSegment.md
|
653
655
|
- docs/EmailSegmentArchiveResponse.md
|
654
656
|
- docs/EmailSegmentCustomer.md
|
@@ -1536,6 +1538,8 @@ files:
|
|
1536
1538
|
- lib/ultracart_api/models/email_postcard_stat.rb
|
1537
1539
|
- lib/ultracart_api/models/email_postcard_tracking.rb
|
1538
1540
|
- lib/ultracart_api/models/email_postcard_tracking_response.rb
|
1541
|
+
- lib/ultracart_api/models/email_rate_limiter.rb
|
1542
|
+
- lib/ultracart_api/models/email_rate_limiters_response.rb
|
1539
1543
|
- lib/ultracart_api/models/email_segment.rb
|
1540
1544
|
- lib/ultracart_api/models/email_segment_archive_response.rb
|
1541
1545
|
- lib/ultracart_api/models/email_segment_customer.rb
|