ultracart_api 4.0.222 → 4.0.224
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -4
- data/docs/EmailRateLimiter.md +22 -0
- data/docs/EmailRateLimitersResponse.md +26 -0
- data/docs/OrderQuery.md +2 -0
- data/docs/StorefrontApi.md +143 -0
- data/lib/ultracart_api/api/storefront_api.rb +136 -0
- data/lib/ultracart_api/models/email_rate_limiter.rb +237 -0
- data/lib/ultracart_api/models/email_rate_limiters_response.rb +258 -0
- data/lib/ultracart_api/models/order_query.rb +23 -1
- 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: c1ad3bfae084e794e421079a95329dcb2c586b1b5afc4d1fc33f9a50dd450f2b
|
4
|
+
data.tar.gz: 6b5f3091cc21bf74f613f603d6c52654c420b940db89c09dd2f82baf4d744378
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b5f67370f030ca6dcdd658f2a0032d273e2c182d63b6a27b699e6a9467ba065a2e06026741e82ef8af8667bf7627a88b226b8700971b40b751070c0169b16497
|
7
|
+
data.tar.gz: 9b21206f0b5f1b1072c4bf3324c22a5bdfa44611c26e6de25e48f31adf44bc0dae5b048c2dad3eab4dbfdef2060fb9f57b772ef4f597c0e909704dd3e6da1d1b
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.224
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.224.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.224.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.224'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -392,6 +392,7 @@ Class | Method | HTTP request | Description
|
|
392
392
|
*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
|
393
393
|
*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
|
394
394
|
*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
|
395
|
+
*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
|
395
396
|
*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
|
396
397
|
*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
|
397
398
|
*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
|
@@ -481,6 +482,7 @@ Class | Method | HTTP request | Description
|
|
481
482
|
*UltracartClient::StorefrontApi* | [**publish_library_item**](docs/StorefrontApi.md#publish_library_item) | **POST** /storefront/code_library/{library_item_oid}/publish | Publish library item.
|
482
483
|
*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
|
483
484
|
*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
|
485
|
+
*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)
|
484
486
|
*UltracartClient::StorefrontApi* | [**review**](docs/StorefrontApi.md#review) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review | Request a review of an email
|
485
487
|
*UltracartClient::StorefrontApi* | [**search**](docs/StorefrontApi.md#search) | **GET** /storefront/search | Searches for all matching values
|
486
488
|
*UltracartClient::StorefrontApi* | [**search2**](docs/StorefrontApi.md#search2) | **POST** /storefront/search | Searches for all matching values (using POST)
|
@@ -1004,6 +1006,8 @@ Class | Method | HTTP request | Description
|
|
1004
1006
|
- [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
|
1005
1007
|
- [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
|
1006
1008
|
- [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
|
1009
|
+
- [UltracartClient::EmailRateLimiter](docs/EmailRateLimiter.md)
|
1010
|
+
- [UltracartClient::EmailRateLimitersResponse](docs/EmailRateLimitersResponse.md)
|
1007
1011
|
- [UltracartClient::EmailSegment](docs/EmailSegment.md)
|
1008
1012
|
- [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
|
1009
1013
|
- [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
|
@@ -1509,6 +1513,8 @@ Not every change is committed to every SDK.
|
|
1509
1513
|
|
1510
1514
|
| Version | Date | Comments |
|
1511
1515
|
| --: | :-: | --- |
|
1516
|
+
| 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
|
1517
|
+
| 4.0.223 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
|
1512
1518
|
| 4.0.222 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
|
1513
1519
|
| 4.0.221 | 05/16/2024 | OrderPayment - constants for payment method Amazon Pay and Link |
|
1514
1520
|
| 4.0.220 | 05/15/2024 | conversation pbx voicemail mailbox indep. voice properties |
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::EmailRateLimiter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **available** | **Integer** | | [optional] |
|
8
|
+
| **limit** | **Integer** | | [optional] |
|
9
|
+
| **name** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ultracart_api'
|
15
|
+
|
16
|
+
instance = UltracartClient::EmailRateLimiter.new(
|
17
|
+
available: null,
|
18
|
+
limit: null,
|
19
|
+
name: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::EmailRateLimitersResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **rate_limiters** | [**Array<EmailRateLimiter>**](EmailRateLimiter.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::EmailRateLimitersResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
rate_limiters: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/OrderQuery.md
CHANGED
@@ -35,6 +35,7 @@
|
|
35
35
|
| **phone** | **String** | Phone | [optional] |
|
36
36
|
| **postal_code** | **String** | Postal code | [optional] |
|
37
37
|
| **purchase_order_number** | **String** | Purchase order number | [optional] |
|
38
|
+
| **query_target** | **String** | Query Target | [optional] |
|
38
39
|
| **refund_date_begin** | **String** | Date/time that the order was refunded | [optional] |
|
39
40
|
| **refund_date_end** | **String** | Date/time that the order was refunded | [optional] |
|
40
41
|
| **rma** | **String** | RMA number | [optional] |
|
@@ -84,6 +85,7 @@ instance = UltracartClient::OrderQuery.new(
|
|
84
85
|
phone: null,
|
85
86
|
postal_code: null,
|
86
87
|
purchase_order_number: null,
|
88
|
+
query_target: null,
|
87
89
|
refund_date_begin: null,
|
88
90
|
refund_date_end: null,
|
89
91
|
rma: null,
|
data/docs/StorefrontApi.md
CHANGED
@@ -47,6 +47,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
47
47
|
| [**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats |
|
48
48
|
| [**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats |
|
49
49
|
| [**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking |
|
50
|
+
| [**get_email_commseq_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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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) |
|
@@ -3230,6 +3232,77 @@ end
|
|
3230
3232
|
- **Accept**: application/json
|
3231
3233
|
|
3232
3234
|
|
3235
|
+
## get_email_commseq_rate_limiters
|
3236
|
+
|
3237
|
+
> <EmailRateLimitersResponse> get_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
3238
|
+
|
3239
|
+
Get email commseq rate limiters
|
3240
|
+
|
3241
|
+
### Examples
|
3242
|
+
|
3243
|
+
```ruby
|
3244
|
+
require 'time'
|
3245
|
+
require 'ultracart_api'
|
3246
|
+
require 'json'
|
3247
|
+
require 'yaml'
|
3248
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
3249
|
+
|
3250
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
3251
|
+
# As such, this might not be the best way to use this object.
|
3252
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
3253
|
+
|
3254
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
3255
|
+
storefront_oid = 56 # Integer |
|
3256
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
3257
|
+
|
3258
|
+
begin
|
3259
|
+
# Get email commseq rate limiters
|
3260
|
+
result = api_instance.get_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
3261
|
+
p result
|
3262
|
+
rescue UltracartClient::ApiError => e
|
3263
|
+
puts "Error when calling StorefrontApi->get_email_commseq_rate_limiters: #{e}"
|
3264
|
+
end
|
3265
|
+
```
|
3266
|
+
|
3267
|
+
#### Using the get_email_commseq_rate_limiters_with_http_info variant
|
3268
|
+
|
3269
|
+
This returns an Array which contains the response data, status code and headers.
|
3270
|
+
|
3271
|
+
> <Array(<EmailRateLimitersResponse>, Integer, Hash)> get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
|
3272
|
+
|
3273
|
+
```ruby
|
3274
|
+
begin
|
3275
|
+
# Get email commseq rate limiters
|
3276
|
+
data, status_code, headers = api_instance.get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
|
3277
|
+
p status_code # => 2xx
|
3278
|
+
p headers # => { ... }
|
3279
|
+
p data # => <EmailRateLimitersResponse>
|
3280
|
+
rescue UltracartClient::ApiError => e
|
3281
|
+
puts "Error when calling StorefrontApi->get_email_commseq_rate_limiters_with_http_info: #{e}"
|
3282
|
+
end
|
3283
|
+
```
|
3284
|
+
|
3285
|
+
### Parameters
|
3286
|
+
|
3287
|
+
| Name | Type | Description | Notes |
|
3288
|
+
| ---- | ---- | ----------- | ----- |
|
3289
|
+
| **storefront_oid** | **Integer** | | |
|
3290
|
+
| **commseq_uuid** | **String** | | |
|
3291
|
+
|
3292
|
+
### Return type
|
3293
|
+
|
3294
|
+
[**EmailRateLimitersResponse**](EmailRateLimitersResponse.md)
|
3295
|
+
|
3296
|
+
### Authorization
|
3297
|
+
|
3298
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3299
|
+
|
3300
|
+
### HTTP request headers
|
3301
|
+
|
3302
|
+
- **Content-Type**: Not defined
|
3303
|
+
- **Accept**: application/json
|
3304
|
+
|
3305
|
+
|
3233
3306
|
## get_email_commseq_sms_stats
|
3234
3307
|
|
3235
3308
|
> <EmailStatSmsSummaryResponse> get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
|
@@ -9604,6 +9677,76 @@ nil (empty response body)
|
|
9604
9677
|
- **Accept**: application/json
|
9605
9678
|
|
9606
9679
|
|
9680
|
+
## reset_email_commseq_rate_limiters
|
9681
|
+
|
9682
|
+
> reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
9683
|
+
|
9684
|
+
Reset email commseq rate limiters (only callable by UltraCart Support)
|
9685
|
+
|
9686
|
+
### Examples
|
9687
|
+
|
9688
|
+
```ruby
|
9689
|
+
require 'time'
|
9690
|
+
require 'ultracart_api'
|
9691
|
+
require 'json'
|
9692
|
+
require 'yaml'
|
9693
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
9694
|
+
|
9695
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
9696
|
+
# As such, this might not be the best way to use this object.
|
9697
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
9698
|
+
|
9699
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
9700
|
+
storefront_oid = 56 # Integer |
|
9701
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
9702
|
+
|
9703
|
+
begin
|
9704
|
+
# Reset email commseq rate limiters (only callable by UltraCart Support)
|
9705
|
+
api_instance.reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
|
9706
|
+
rescue UltracartClient::ApiError => e
|
9707
|
+
puts "Error when calling StorefrontApi->reset_email_commseq_rate_limiters: #{e}"
|
9708
|
+
end
|
9709
|
+
```
|
9710
|
+
|
9711
|
+
#### Using the reset_email_commseq_rate_limiters_with_http_info variant
|
9712
|
+
|
9713
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
9714
|
+
|
9715
|
+
> <Array(nil, Integer, Hash)> reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
|
9716
|
+
|
9717
|
+
```ruby
|
9718
|
+
begin
|
9719
|
+
# Reset email commseq rate limiters (only callable by UltraCart Support)
|
9720
|
+
data, status_code, headers = api_instance.reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
|
9721
|
+
p status_code # => 2xx
|
9722
|
+
p headers # => { ... }
|
9723
|
+
p data # => nil
|
9724
|
+
rescue UltracartClient::ApiError => e
|
9725
|
+
puts "Error when calling StorefrontApi->reset_email_commseq_rate_limiters_with_http_info: #{e}"
|
9726
|
+
end
|
9727
|
+
```
|
9728
|
+
|
9729
|
+
### Parameters
|
9730
|
+
|
9731
|
+
| Name | Type | Description | Notes |
|
9732
|
+
| ---- | ---- | ----------- | ----- |
|
9733
|
+
| **storefront_oid** | **Integer** | | |
|
9734
|
+
| **commseq_uuid** | **String** | | |
|
9735
|
+
|
9736
|
+
### Return type
|
9737
|
+
|
9738
|
+
nil (empty response body)
|
9739
|
+
|
9740
|
+
### Authorization
|
9741
|
+
|
9742
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
9743
|
+
|
9744
|
+
### HTTP request headers
|
9745
|
+
|
9746
|
+
- **Content-Type**: Not defined
|
9747
|
+
- **Accept**: application/json
|
9748
|
+
|
9749
|
+
|
9607
9750
|
## review
|
9608
9751
|
|
9609
9752
|
> <EmailCommseqEmailSendTestResponse> review(storefront_oid, commseq_email_uuid, email_commseq_email_review_request)
|
@@ -2955,6 +2955,74 @@ module UltracartClient
|
|
2955
2955
|
return data, status_code, headers
|
2956
2956
|
end
|
2957
2957
|
|
2958
|
+
# Get email commseq rate limiters
|
2959
|
+
# @param storefront_oid [Integer]
|
2960
|
+
# @param commseq_uuid [String]
|
2961
|
+
# @param [Hash] opts the optional parameters
|
2962
|
+
# @return [EmailRateLimitersResponse]
|
2963
|
+
def get_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
|
2964
|
+
data, _status_code, _headers = get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
|
2965
|
+
data
|
2966
|
+
end
|
2967
|
+
|
2968
|
+
# Get email commseq rate limiters
|
2969
|
+
# @param storefront_oid [Integer]
|
2970
|
+
# @param commseq_uuid [String]
|
2971
|
+
# @param [Hash] opts the optional parameters
|
2972
|
+
# @return [Array<(EmailRateLimitersResponse, Integer, Hash)>] EmailRateLimitersResponse data, response status code and response headers
|
2973
|
+
def get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
|
2974
|
+
if @api_client.config.debugging
|
2975
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_rate_limiters ...'
|
2976
|
+
end
|
2977
|
+
# verify the required parameter 'storefront_oid' is set
|
2978
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
2979
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_rate_limiters"
|
2980
|
+
end
|
2981
|
+
# verify the required parameter 'commseq_uuid' is set
|
2982
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
2983
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_rate_limiters"
|
2984
|
+
end
|
2985
|
+
# resource path
|
2986
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
|
2987
|
+
|
2988
|
+
# query parameters
|
2989
|
+
query_params = opts[:query_params] || {}
|
2990
|
+
|
2991
|
+
# header parameters
|
2992
|
+
header_params = opts[:header_params] || {}
|
2993
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2994
|
+
# HTTP header 'Accept' (if needed)
|
2995
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2996
|
+
|
2997
|
+
# form parameters
|
2998
|
+
form_params = opts[:form_params] || {}
|
2999
|
+
|
3000
|
+
# http body (model)
|
3001
|
+
post_body = opts[:debug_body]
|
3002
|
+
|
3003
|
+
# return_type
|
3004
|
+
return_type = opts[:debug_return_type] || 'EmailRateLimitersResponse'
|
3005
|
+
|
3006
|
+
# auth_names
|
3007
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
3008
|
+
|
3009
|
+
new_options = opts.merge(
|
3010
|
+
:operation => :"StorefrontApi.get_email_commseq_rate_limiters",
|
3011
|
+
:header_params => header_params,
|
3012
|
+
:query_params => query_params,
|
3013
|
+
:form_params => form_params,
|
3014
|
+
:body => post_body,
|
3015
|
+
:auth_names => auth_names,
|
3016
|
+
:return_type => return_type
|
3017
|
+
)
|
3018
|
+
|
3019
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3020
|
+
if @api_client.config.debugging
|
3021
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3022
|
+
end
|
3023
|
+
return data, status_code, headers
|
3024
|
+
end
|
3025
|
+
|
2958
3026
|
# Get email communication sequence sms stats
|
2959
3027
|
# @param storefront_oid [Integer]
|
2960
3028
|
# @param commseq_uuid [String]
|
@@ -9065,6 +9133,74 @@ module UltracartClient
|
|
9065
9133
|
return data, status_code, headers
|
9066
9134
|
end
|
9067
9135
|
|
9136
|
+
# Reset email commseq rate limiters (only callable by UltraCart Support)
|
9137
|
+
# @param storefront_oid [Integer]
|
9138
|
+
# @param commseq_uuid [String]
|
9139
|
+
# @param [Hash] opts the optional parameters
|
9140
|
+
# @return [nil]
|
9141
|
+
def reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
|
9142
|
+
reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
|
9143
|
+
nil
|
9144
|
+
end
|
9145
|
+
|
9146
|
+
# Reset email commseq rate limiters (only callable by UltraCart Support)
|
9147
|
+
# @param storefront_oid [Integer]
|
9148
|
+
# @param commseq_uuid [String]
|
9149
|
+
# @param [Hash] opts the optional parameters
|
9150
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
9151
|
+
def reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
|
9152
|
+
if @api_client.config.debugging
|
9153
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.reset_email_commseq_rate_limiters ...'
|
9154
|
+
end
|
9155
|
+
# verify the required parameter 'storefront_oid' is set
|
9156
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
9157
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
|
9158
|
+
end
|
9159
|
+
# verify the required parameter 'commseq_uuid' is set
|
9160
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
9161
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
|
9162
|
+
end
|
9163
|
+
# resource path
|
9164
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
|
9165
|
+
|
9166
|
+
# query parameters
|
9167
|
+
query_params = opts[:query_params] || {}
|
9168
|
+
|
9169
|
+
# header parameters
|
9170
|
+
header_params = opts[:header_params] || {}
|
9171
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
9172
|
+
# HTTP header 'Accept' (if needed)
|
9173
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9174
|
+
|
9175
|
+
# form parameters
|
9176
|
+
form_params = opts[:form_params] || {}
|
9177
|
+
|
9178
|
+
# http body (model)
|
9179
|
+
post_body = opts[:debug_body]
|
9180
|
+
|
9181
|
+
# return_type
|
9182
|
+
return_type = opts[:debug_return_type]
|
9183
|
+
|
9184
|
+
# auth_names
|
9185
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
9186
|
+
|
9187
|
+
new_options = opts.merge(
|
9188
|
+
:operation => :"StorefrontApi.reset_email_commseq_rate_limiters",
|
9189
|
+
:header_params => header_params,
|
9190
|
+
:query_params => query_params,
|
9191
|
+
:form_params => form_params,
|
9192
|
+
:body => post_body,
|
9193
|
+
:auth_names => auth_names,
|
9194
|
+
:return_type => return_type
|
9195
|
+
)
|
9196
|
+
|
9197
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
9198
|
+
if @api_client.config.debugging
|
9199
|
+
@api_client.config.logger.debug "API called: StorefrontApi#reset_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9200
|
+
end
|
9201
|
+
return data, status_code, headers
|
9202
|
+
end
|
9203
|
+
|
9068
9204
|
# Request a review of an email
|
9069
9205
|
# @param storefront_oid [Integer]
|
9070
9206
|
# @param commseq_email_uuid [String]
|
@@ -0,0 +1,237 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class EmailRateLimiter
|
18
|
+
attr_accessor :available
|
19
|
+
|
20
|
+
attr_accessor :limit
|
21
|
+
|
22
|
+
attr_accessor :name
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'available' => :'available',
|
28
|
+
:'limit' => :'limit',
|
29
|
+
:'name' => :'name'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Returns all the JSON keys this model knows about
|
34
|
+
def self.acceptable_attributes
|
35
|
+
attribute_map.values
|
36
|
+
end
|
37
|
+
|
38
|
+
# Attribute type mapping.
|
39
|
+
def self.openapi_types
|
40
|
+
{
|
41
|
+
:'available' => :'Integer',
|
42
|
+
:'limit' => :'Integer',
|
43
|
+
:'name' => :'String'
|
44
|
+
}
|
45
|
+
end
|
46
|
+
|
47
|
+
# List of attributes with nullable: true
|
48
|
+
def self.openapi_nullable
|
49
|
+
Set.new([
|
50
|
+
])
|
51
|
+
end
|
52
|
+
|
53
|
+
# Initializes the object
|
54
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
55
|
+
def initialize(attributes = {})
|
56
|
+
if (!attributes.is_a?(Hash))
|
57
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailRateLimiter` initialize method"
|
58
|
+
end
|
59
|
+
|
60
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
61
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
62
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
63
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailRateLimiter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
64
|
+
end
|
65
|
+
h[k.to_sym] = v
|
66
|
+
}
|
67
|
+
|
68
|
+
if attributes.key?(:'available')
|
69
|
+
self.available = attributes[:'available']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'limit')
|
73
|
+
self.limit = attributes[:'limit']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.key?(:'name')
|
77
|
+
self.name = attributes[:'name']
|
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
|
+
available == o.available &&
|
100
|
+
limit == o.limit &&
|
101
|
+
name == o.name
|
102
|
+
end
|
103
|
+
|
104
|
+
# @see the `==` method
|
105
|
+
# @param [Object] Object to be compared
|
106
|
+
def eql?(o)
|
107
|
+
self == o
|
108
|
+
end
|
109
|
+
|
110
|
+
# Calculates hash code according to all attributes.
|
111
|
+
# @return [Integer] Hash code
|
112
|
+
def hash
|
113
|
+
[available, limit, name].hash
|
114
|
+
end
|
115
|
+
|
116
|
+
# Builds the object from hash
|
117
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
118
|
+
# @return [Object] Returns the model itself
|
119
|
+
def self.build_from_hash(attributes)
|
120
|
+
new.build_from_hash(attributes)
|
121
|
+
end
|
122
|
+
|
123
|
+
# Builds the object from hash
|
124
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
125
|
+
# @return [Object] Returns the model itself
|
126
|
+
def build_from_hash(attributes)
|
127
|
+
return nil unless attributes.is_a?(Hash)
|
128
|
+
attributes = attributes.transform_keys(&:to_sym)
|
129
|
+
self.class.openapi_types.each_pair do |key, type|
|
130
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
131
|
+
self.send("#{key}=", nil)
|
132
|
+
elsif type =~ /\AArray<(.*)>/i
|
133
|
+
# check to ensure the input is an array given that the attribute
|
134
|
+
# is documented as an array but the input is not
|
135
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
136
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
137
|
+
end
|
138
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
139
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
self
|
144
|
+
end
|
145
|
+
|
146
|
+
# Deserializes the data based on type
|
147
|
+
# @param string type Data type
|
148
|
+
# @param string value Value to be deserialized
|
149
|
+
# @return [Object] Deserialized data
|
150
|
+
def _deserialize(type, value)
|
151
|
+
case type.to_sym
|
152
|
+
when :Time
|
153
|
+
Time.parse(value)
|
154
|
+
when :Date
|
155
|
+
Date.parse(value)
|
156
|
+
when :String
|
157
|
+
value.to_s
|
158
|
+
when :Integer
|
159
|
+
value.to_i
|
160
|
+
when :Float
|
161
|
+
value.to_f
|
162
|
+
when :Boolean
|
163
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
164
|
+
true
|
165
|
+
else
|
166
|
+
false
|
167
|
+
end
|
168
|
+
when :Object
|
169
|
+
# generic object (usually a Hash), return directly
|
170
|
+
value
|
171
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
172
|
+
inner_type = Regexp.last_match[:inner_type]
|
173
|
+
value.map { |v| _deserialize(inner_type, v) }
|
174
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
175
|
+
k_type = Regexp.last_match[:k_type]
|
176
|
+
v_type = Regexp.last_match[:v_type]
|
177
|
+
{}.tap do |hash|
|
178
|
+
value.each do |k, v|
|
179
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
180
|
+
end
|
181
|
+
end
|
182
|
+
else # model
|
183
|
+
# models (e.g. Pet) or oneOf
|
184
|
+
klass = UltracartClient.const_get(type)
|
185
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
186
|
+
end
|
187
|
+
end
|
188
|
+
|
189
|
+
# Returns the string representation of the object
|
190
|
+
# @return [String] String presentation of the object
|
191
|
+
def to_s
|
192
|
+
to_hash.to_s
|
193
|
+
end
|
194
|
+
|
195
|
+
# to_body is an alias to to_hash (backward compatibility)
|
196
|
+
# @return [Hash] Returns the object in the form of hash
|
197
|
+
def to_body
|
198
|
+
to_hash
|
199
|
+
end
|
200
|
+
|
201
|
+
# Returns the object in the form of hash
|
202
|
+
# @return [Hash] Returns the object in the form of hash
|
203
|
+
def to_hash
|
204
|
+
hash = {}
|
205
|
+
self.class.attribute_map.each_pair do |attr, param|
|
206
|
+
value = self.send(attr)
|
207
|
+
if value.nil?
|
208
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
209
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
210
|
+
end
|
211
|
+
|
212
|
+
hash[param] = _to_hash(value)
|
213
|
+
end
|
214
|
+
hash
|
215
|
+
end
|
216
|
+
|
217
|
+
# Outputs non-array value in the form of hash
|
218
|
+
# For object, use to_hash. Otherwise, just return the value
|
219
|
+
# @param [Object] value Any valid value
|
220
|
+
# @return [Hash] Returns the value in the form of hash
|
221
|
+
def _to_hash(value)
|
222
|
+
if value.is_a?(Array)
|
223
|
+
value.compact.map { |v| _to_hash(v) }
|
224
|
+
elsif value.is_a?(Hash)
|
225
|
+
{}.tap do |hash|
|
226
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
227
|
+
end
|
228
|
+
elsif value.respond_to? :to_hash
|
229
|
+
value.to_hash
|
230
|
+
else
|
231
|
+
value
|
232
|
+
end
|
233
|
+
end
|
234
|
+
|
235
|
+
end
|
236
|
+
|
237
|
+
end
|
@@ -0,0 +1,258 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class EmailRateLimitersResponse
|
18
|
+
attr_accessor :error
|
19
|
+
|
20
|
+
attr_accessor :metadata
|
21
|
+
|
22
|
+
attr_accessor :rate_limiters
|
23
|
+
|
24
|
+
# Indicates if API call was successful
|
25
|
+
attr_accessor :success
|
26
|
+
|
27
|
+
attr_accessor :warning
|
28
|
+
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
30
|
+
def self.attribute_map
|
31
|
+
{
|
32
|
+
:'error' => :'error',
|
33
|
+
:'metadata' => :'metadata',
|
34
|
+
:'rate_limiters' => :'rate_limiters',
|
35
|
+
:'success' => :'success',
|
36
|
+
:'warning' => :'warning'
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
# Returns all the JSON keys this model knows about
|
41
|
+
def self.acceptable_attributes
|
42
|
+
attribute_map.values
|
43
|
+
end
|
44
|
+
|
45
|
+
# Attribute type mapping.
|
46
|
+
def self.openapi_types
|
47
|
+
{
|
48
|
+
:'error' => :'Error',
|
49
|
+
:'metadata' => :'ResponseMetadata',
|
50
|
+
:'rate_limiters' => :'Array<EmailRateLimiter>',
|
51
|
+
:'success' => :'Boolean',
|
52
|
+
:'warning' => :'Warning'
|
53
|
+
}
|
54
|
+
end
|
55
|
+
|
56
|
+
# List of attributes with nullable: true
|
57
|
+
def self.openapi_nullable
|
58
|
+
Set.new([
|
59
|
+
])
|
60
|
+
end
|
61
|
+
|
62
|
+
# Initializes the object
|
63
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
64
|
+
def initialize(attributes = {})
|
65
|
+
if (!attributes.is_a?(Hash))
|
66
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailRateLimitersResponse` initialize method"
|
67
|
+
end
|
68
|
+
|
69
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
70
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
71
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
72
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailRateLimitersResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
73
|
+
end
|
74
|
+
h[k.to_sym] = v
|
75
|
+
}
|
76
|
+
|
77
|
+
if attributes.key?(:'error')
|
78
|
+
self.error = attributes[:'error']
|
79
|
+
end
|
80
|
+
|
81
|
+
if attributes.key?(:'metadata')
|
82
|
+
self.metadata = attributes[:'metadata']
|
83
|
+
end
|
84
|
+
|
85
|
+
if attributes.key?(:'rate_limiters')
|
86
|
+
if (value = attributes[:'rate_limiters']).is_a?(Array)
|
87
|
+
self.rate_limiters = value
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
if attributes.key?(:'success')
|
92
|
+
self.success = attributes[:'success']
|
93
|
+
end
|
94
|
+
|
95
|
+
if attributes.key?(:'warning')
|
96
|
+
self.warning = attributes[:'warning']
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
101
|
+
# @return Array for valid properties with the reasons
|
102
|
+
def list_invalid_properties
|
103
|
+
invalid_properties = Array.new
|
104
|
+
invalid_properties
|
105
|
+
end
|
106
|
+
|
107
|
+
# Check to see if the all the properties in the model are valid
|
108
|
+
# @return true if the model is valid
|
109
|
+
def valid?
|
110
|
+
true
|
111
|
+
end
|
112
|
+
|
113
|
+
# Checks equality by comparing each attribute.
|
114
|
+
# @param [Object] Object to be compared
|
115
|
+
def ==(o)
|
116
|
+
return true if self.equal?(o)
|
117
|
+
self.class == o.class &&
|
118
|
+
error == o.error &&
|
119
|
+
metadata == o.metadata &&
|
120
|
+
rate_limiters == o.rate_limiters &&
|
121
|
+
success == o.success &&
|
122
|
+
warning == o.warning
|
123
|
+
end
|
124
|
+
|
125
|
+
# @see the `==` method
|
126
|
+
# @param [Object] Object to be compared
|
127
|
+
def eql?(o)
|
128
|
+
self == o
|
129
|
+
end
|
130
|
+
|
131
|
+
# Calculates hash code according to all attributes.
|
132
|
+
# @return [Integer] Hash code
|
133
|
+
def hash
|
134
|
+
[error, metadata, rate_limiters, success, warning].hash
|
135
|
+
end
|
136
|
+
|
137
|
+
# Builds the object from hash
|
138
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
139
|
+
# @return [Object] Returns the model itself
|
140
|
+
def self.build_from_hash(attributes)
|
141
|
+
new.build_from_hash(attributes)
|
142
|
+
end
|
143
|
+
|
144
|
+
# Builds the object from hash
|
145
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
146
|
+
# @return [Object] Returns the model itself
|
147
|
+
def build_from_hash(attributes)
|
148
|
+
return nil unless attributes.is_a?(Hash)
|
149
|
+
attributes = attributes.transform_keys(&:to_sym)
|
150
|
+
self.class.openapi_types.each_pair do |key, type|
|
151
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
152
|
+
self.send("#{key}=", nil)
|
153
|
+
elsif type =~ /\AArray<(.*)>/i
|
154
|
+
# check to ensure the input is an array given that the attribute
|
155
|
+
# is documented as an array but the input is not
|
156
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
157
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
158
|
+
end
|
159
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
160
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
161
|
+
end
|
162
|
+
end
|
163
|
+
|
164
|
+
self
|
165
|
+
end
|
166
|
+
|
167
|
+
# Deserializes the data based on type
|
168
|
+
# @param string type Data type
|
169
|
+
# @param string value Value to be deserialized
|
170
|
+
# @return [Object] Deserialized data
|
171
|
+
def _deserialize(type, value)
|
172
|
+
case type.to_sym
|
173
|
+
when :Time
|
174
|
+
Time.parse(value)
|
175
|
+
when :Date
|
176
|
+
Date.parse(value)
|
177
|
+
when :String
|
178
|
+
value.to_s
|
179
|
+
when :Integer
|
180
|
+
value.to_i
|
181
|
+
when :Float
|
182
|
+
value.to_f
|
183
|
+
when :Boolean
|
184
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
185
|
+
true
|
186
|
+
else
|
187
|
+
false
|
188
|
+
end
|
189
|
+
when :Object
|
190
|
+
# generic object (usually a Hash), return directly
|
191
|
+
value
|
192
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
193
|
+
inner_type = Regexp.last_match[:inner_type]
|
194
|
+
value.map { |v| _deserialize(inner_type, v) }
|
195
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
196
|
+
k_type = Regexp.last_match[:k_type]
|
197
|
+
v_type = Regexp.last_match[:v_type]
|
198
|
+
{}.tap do |hash|
|
199
|
+
value.each do |k, v|
|
200
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
201
|
+
end
|
202
|
+
end
|
203
|
+
else # model
|
204
|
+
# models (e.g. Pet) or oneOf
|
205
|
+
klass = UltracartClient.const_get(type)
|
206
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
210
|
+
# Returns the string representation of the object
|
211
|
+
# @return [String] String presentation of the object
|
212
|
+
def to_s
|
213
|
+
to_hash.to_s
|
214
|
+
end
|
215
|
+
|
216
|
+
# to_body is an alias to to_hash (backward compatibility)
|
217
|
+
# @return [Hash] Returns the object in the form of hash
|
218
|
+
def to_body
|
219
|
+
to_hash
|
220
|
+
end
|
221
|
+
|
222
|
+
# Returns the object in the form of hash
|
223
|
+
# @return [Hash] Returns the object in the form of hash
|
224
|
+
def to_hash
|
225
|
+
hash = {}
|
226
|
+
self.class.attribute_map.each_pair do |attr, param|
|
227
|
+
value = self.send(attr)
|
228
|
+
if value.nil?
|
229
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
230
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
231
|
+
end
|
232
|
+
|
233
|
+
hash[param] = _to_hash(value)
|
234
|
+
end
|
235
|
+
hash
|
236
|
+
end
|
237
|
+
|
238
|
+
# Outputs non-array value in the form of hash
|
239
|
+
# For object, use to_hash. Otherwise, just return the value
|
240
|
+
# @param [Object] value Any valid value
|
241
|
+
# @return [Hash] Returns the value in the form of hash
|
242
|
+
def _to_hash(value)
|
243
|
+
if value.is_a?(Array)
|
244
|
+
value.compact.map { |v| _to_hash(v) }
|
245
|
+
elsif value.is_a?(Hash)
|
246
|
+
{}.tap do |hash|
|
247
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
248
|
+
end
|
249
|
+
elsif value.respond_to? :to_hash
|
250
|
+
value.to_hash
|
251
|
+
else
|
252
|
+
value
|
253
|
+
end
|
254
|
+
end
|
255
|
+
|
256
|
+
end
|
257
|
+
|
258
|
+
end
|
@@ -108,6 +108,9 @@ module UltracartClient
|
|
108
108
|
# Purchase order number
|
109
109
|
attr_accessor :purchase_order_number
|
110
110
|
|
111
|
+
# Query Target
|
112
|
+
attr_accessor :query_target
|
113
|
+
|
111
114
|
# Date/time that the order was refunded
|
112
115
|
attr_accessor :refund_date_begin
|
113
116
|
|
@@ -197,6 +200,7 @@ module UltracartClient
|
|
197
200
|
:'phone' => :'phone',
|
198
201
|
:'postal_code' => :'postal_code',
|
199
202
|
:'purchase_order_number' => :'purchase_order_number',
|
203
|
+
:'query_target' => :'query_target',
|
200
204
|
:'refund_date_begin' => :'refund_date_begin',
|
201
205
|
:'refund_date_end' => :'refund_date_end',
|
202
206
|
:'rma' => :'rma',
|
@@ -250,6 +254,7 @@ module UltracartClient
|
|
250
254
|
:'phone' => :'String',
|
251
255
|
:'postal_code' => :'String',
|
252
256
|
:'purchase_order_number' => :'String',
|
257
|
+
:'query_target' => :'String',
|
253
258
|
:'refund_date_begin' => :'String',
|
254
259
|
:'refund_date_end' => :'String',
|
255
260
|
:'rma' => :'String',
|
@@ -409,6 +414,10 @@ module UltracartClient
|
|
409
414
|
self.purchase_order_number = attributes[:'purchase_order_number']
|
410
415
|
end
|
411
416
|
|
417
|
+
if attributes.key?(:'query_target')
|
418
|
+
self.query_target = attributes[:'query_target']
|
419
|
+
end
|
420
|
+
|
412
421
|
if attributes.key?(:'refund_date_begin')
|
413
422
|
self.refund_date_begin = attributes[:'refund_date_begin']
|
414
423
|
end
|
@@ -525,6 +534,8 @@ module UltracartClient
|
|
525
534
|
return false unless payment_method_validator.valid?(@payment_method)
|
526
535
|
return false if !@phone.nil? && @phone.to_s.length > 25
|
527
536
|
return false if !@postal_code.nil? && @postal_code.to_s.length > 20
|
537
|
+
query_target_validator = EnumAttributeValidator.new('String', ["origin", "cache"])
|
538
|
+
return false unless query_target_validator.valid?(@query_target)
|
528
539
|
return false if !@rma.nil? && @rma.to_s.length > 30
|
529
540
|
return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
|
530
541
|
return false if !@state_region.nil? && @state_region.to_s.length > 32
|
@@ -641,6 +652,16 @@ module UltracartClient
|
|
641
652
|
@postal_code = postal_code
|
642
653
|
end
|
643
654
|
|
655
|
+
# Custom attribute writer method checking allowed values (enum).
|
656
|
+
# @param [Object] query_target Object to be assigned
|
657
|
+
def query_target=(query_target)
|
658
|
+
validator = EnumAttributeValidator.new('String', ["origin", "cache"])
|
659
|
+
unless validator.valid?(query_target)
|
660
|
+
fail ArgumentError, "invalid value for \"query_target\", must be one of #{validator.allowable_values}."
|
661
|
+
end
|
662
|
+
@query_target = query_target
|
663
|
+
end
|
664
|
+
|
644
665
|
# Custom attribute writer method with validation
|
645
666
|
# @param [Object] rma Value to be assigned
|
646
667
|
def rma=(rma)
|
@@ -707,6 +728,7 @@ module UltracartClient
|
|
707
728
|
phone == o.phone &&
|
708
729
|
postal_code == o.postal_code &&
|
709
730
|
purchase_order_number == o.purchase_order_number &&
|
731
|
+
query_target == o.query_target &&
|
710
732
|
refund_date_begin == o.refund_date_begin &&
|
711
733
|
refund_date_end == o.refund_date_end &&
|
712
734
|
rma == o.rma &&
|
@@ -729,7 +751,7 @@ module UltracartClient
|
|
729
751
|
# Calculates hash code according to all attributes.
|
730
752
|
# @return [Integer] Hash code
|
731
753
|
def hash
|
732
|
-
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_10, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, custom_field_8, custom_field_9, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
|
754
|
+
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_10, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, custom_field_8, custom_field_9, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, query_target, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
|
733
755
|
end
|
734
756
|
|
735
757
|
# Builds the object from hash
|
data/lib/ultracart_api.rb
CHANGED
@@ -435,6 +435,8 @@ require 'ultracart_api/models/email_plan_response'
|
|
435
435
|
require 'ultracart_api/models/email_postcard_stat'
|
436
436
|
require 'ultracart_api/models/email_postcard_tracking'
|
437
437
|
require 'ultracart_api/models/email_postcard_tracking_response'
|
438
|
+
require 'ultracart_api/models/email_rate_limiter'
|
439
|
+
require 'ultracart_api/models/email_rate_limiters_response'
|
438
440
|
require 'ultracart_api/models/email_segment'
|
439
441
|
require 'ultracart_api/models/email_segment_archive_response'
|
440
442
|
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: 4.0.
|
4
|
+
version: 4.0.224
|
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
|
@@ -488,6 +488,8 @@ files:
|
|
488
488
|
- docs/EmailPostcardStat.md
|
489
489
|
- docs/EmailPostcardTracking.md
|
490
490
|
- docs/EmailPostcardTrackingResponse.md
|
491
|
+
- docs/EmailRateLimiter.md
|
492
|
+
- docs/EmailRateLimitersResponse.md
|
491
493
|
- docs/EmailSegment.md
|
492
494
|
- docs/EmailSegmentArchiveResponse.md
|
493
495
|
- docs/EmailSegmentCustomer.md
|
@@ -1374,6 +1376,8 @@ files:
|
|
1374
1376
|
- lib/ultracart_api/models/email_postcard_stat.rb
|
1375
1377
|
- lib/ultracart_api/models/email_postcard_tracking.rb
|
1376
1378
|
- lib/ultracart_api/models/email_postcard_tracking_response.rb
|
1379
|
+
- lib/ultracart_api/models/email_rate_limiter.rb
|
1380
|
+
- lib/ultracart_api/models/email_rate_limiters_response.rb
|
1377
1381
|
- lib/ultracart_api/models/email_segment.rb
|
1378
1382
|
- lib/ultracart_api/models/email_segment_archive_response.rb
|
1379
1383
|
- lib/ultracart_api/models/email_segment_customer.rb
|