ultracart_api 4.0.222 → 4.0.224

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f43fa3609ef1a8bfb708e2f7171a7de29537209b0684f085ae91d239bd8a9c
-  data.tar.gz: 393ecdd261b6ffe8167dd7cc216e158fa794364bdb597cc7011e97fb86955897
+  metadata.gz: c1ad3bfae084e794e421079a95329dcb2c586b1b5afc4d1fc33f9a50dd450f2b
+  data.tar.gz: 6b5f3091cc21bf74f613f603d6c52654c420b940db89c09dd2f82baf4d744378
 SHA512:
-  metadata.gz: d065cf6dfd3e342cc9778dcaa7a55dc8beb44734337798c0777acfd1a9c97879b197b4893fc300277f5f144e5ac419332ef75d4e95e10bb52b17691fa3388ae6
-  data.tar.gz: bf996a803fb3f0eee1a1fb0c807d860a346ea44f388e371ce1745fc17a0ed3c286555dc63e82278c3ab418be4659ce60338e8dc0cbccfdd4b6b81a15a0c34c2c
+  metadata.gz: b5f67370f030ca6dcdd658f2a0032d273e2c182d63b6a27b699e6a9467ba065a2e06026741e82ef8af8667bf7627a88b226b8700971b40b751070c0169b16497
+  data.tar.gz: 9b21206f0b5f1b1072c4bf3324c22a5bdfa44611c26e6de25e48f31adf44bc0dae5b048c2dad3eab4dbfdef2060fb9f57b772ef4f597c0e909704dd3e6da1d1b

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.222
+- Package version: 4.0.224
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.222.gem
+gem install ./ultracart_api-4.0.224.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.222.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.224.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.222'
+    gem 'ultracart_api', '~> 4.0.224'
 
 ### Install from Git
 
@@ -392,6 +392,7 @@ Class | Method | HTTP request | Description
 *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
 *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
 *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
+*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
 *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
 *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
 *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
 *UltracartClient::StorefrontApi* | [**publish_library_item**](docs/StorefrontApi.md#publish_library_item) | **POST** /storefront/code_library/{library_item_oid}/publish | Publish library item.
 *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
 *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
+*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)
 *UltracartClient::StorefrontApi* | [**review**](docs/StorefrontApi.md#review) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review | Request a review of an email
 *UltracartClient::StorefrontApi* | [**search**](docs/StorefrontApi.md#search) | **GET** /storefront/search | Searches for all matching values
 *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
  - [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
  - [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
  - [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
+ - [UltracartClient::EmailRateLimiter](docs/EmailRateLimiter.md)
+ - [UltracartClient::EmailRateLimitersResponse](docs/EmailRateLimitersResponse.md)
  - [UltracartClient::EmailSegment](docs/EmailSegment.md)
  - [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
  - [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
@@ -1509,6 +1513,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
+| 4.0.223 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
 | 4.0.222 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
 | 4.0.221 | 05/16/2024 | OrderPayment - constants for payment method Amazon Pay and Link |
 | 4.0.220 | 05/15/2024 | conversation pbx voicemail mailbox indep. voice properties |

data/docs/EmailRateLimiter.md

@@ -0,0 +1,22 @@
+# UltracartClient::EmailRateLimiter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailRateLimiter.new(
+  available: null,
+  limit: null,
+  name: null
+)
+```
+

data/docs/EmailRateLimitersResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::EmailRateLimitersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **rate_limiters** | [**Array<EmailRateLimiter>**](EmailRateLimiter.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailRateLimitersResponse.new(
+  error: null,
+  metadata: null,
+  rate_limiters: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/OrderQuery.md

@@ -35,6 +35,7 @@
 | **phone** | **String** | Phone | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
 | **purchase_order_number** | **String** | Purchase order number | [optional] |
+| **query_target** | **String** | Query Target | [optional] |
 | **refund_date_begin** | **String** | Date/time that the order was refunded | [optional] |
 | **refund_date_end** | **String** | Date/time that the order was refunded | [optional] |
 | **rma** | **String** | RMA number | [optional] |
@@ -84,6 +85,7 @@ instance = UltracartClient::OrderQuery.new(
   phone: null,
   postal_code: null,
   purchase_order_number: null,
+  query_target: null,
   refund_date_begin: null,
   refund_date_end: null,
   rma: null,

data/docs/StorefrontApi.md

@@ -47,6 +47,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
 | [**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 |
 | [**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 |
+| [**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 |
 | [**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 |
 | [**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 |
 | [**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*
 | [**publish_library_item**](StorefrontApi.md#publish_library_item) | **POST** /storefront/code_library/{library_item_oid}/publish | Publish library item. |
 | [**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 |
 | [**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 |
+| [**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) |
 | [**review**](StorefrontApi.md#review) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review | Request a review of an email |
 | [**search**](StorefrontApi.md#search) | **GET** /storefront/search | Searches for all matching values |
 | [**search2**](StorefrontApi.md#search2) | **POST** /storefront/search | Searches for all matching values (using POST) |
@@ -3230,6 +3232,77 @@ end
 - **Accept**: application/json
 
 
+## get_email_commseq_rate_limiters
+
+> <EmailRateLimitersResponse> get_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
+
+Get email commseq rate limiters
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+storefront_oid = 56 # Integer | 
+commseq_uuid = 'commseq_uuid_example' # String | 
+
+begin
+  # Get email commseq rate limiters
+  result = api_instance.get_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_commseq_rate_limiters: #{e}"
+end
+```
+
+#### Using the get_email_commseq_rate_limiters_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailRateLimitersResponse>, Integer, Hash)> get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
+
+```ruby
+begin
+  # Get email commseq rate limiters
+  data, status_code, headers = api_instance.get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailRateLimitersResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_commseq_rate_limiters_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **commseq_uuid** | **String** |  |  |
+
+### Return type
+
+[**EmailRateLimitersResponse**](EmailRateLimitersResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_email_commseq_sms_stats
 
 > <EmailStatSmsSummaryResponse> get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request)
@@ -9604,6 +9677,76 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## reset_email_commseq_rate_limiters
+
+> reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
+
+Reset email commseq rate limiters (only callable by UltraCart Support)
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+storefront_oid = 56 # Integer | 
+commseq_uuid = 'commseq_uuid_example' # String | 
+
+begin
+  # Reset email commseq rate limiters (only callable by UltraCart Support)
+  api_instance.reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->reset_email_commseq_rate_limiters: #{e}"
+end
+```
+
+#### Using the reset_email_commseq_rate_limiters_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
+
+```ruby
+begin
+  # Reset email commseq rate limiters (only callable by UltraCart Support)
+  data, status_code, headers = api_instance.reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->reset_email_commseq_rate_limiters_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **commseq_uuid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## review
 
 > <EmailCommseqEmailSendTestResponse> review(storefront_oid, commseq_email_uuid, email_commseq_email_review_request)

data/lib/ultracart_api/api/storefront_api.rb

@@ -2955,6 +2955,74 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get email commseq rate limiters
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailRateLimitersResponse]
+    def get_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
+      data, _status_code, _headers = get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
+      data
+    end
+
+    # Get email commseq rate limiters
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailRateLimitersResponse, Integer, Hash)>] EmailRateLimitersResponse data, response status code and response headers
+    def get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_rate_limiters ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_rate_limiters"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_rate_limiters"
+      end
+      # resource path
+      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))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailRateLimitersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_commseq_rate_limiters",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email communication sequence sms stats
     # @param storefront_oid [Integer] 
     # @param commseq_uuid [String] 
@@ -9065,6 +9133,74 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Reset email commseq rate limiters (only callable by UltraCart Support)
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
+      reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
+      nil
+    end
+
+    # Reset email commseq rate limiters (only callable by UltraCart Support)
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.reset_email_commseq_rate_limiters ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
+      end
+      # resource path
+      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))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.reset_email_commseq_rate_limiters",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#reset_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Request a review of an email
     # @param storefront_oid [Integer] 
     # @param commseq_email_uuid [String] 

data/lib/ultracart_api/models/email_rate_limiter.rb

@@ -0,0 +1,237 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailRateLimiter
+    attr_accessor :available
+
+    attr_accessor :limit
+
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'available' => :'available',
+        :'limit' => :'limit',
+        :'name' => :'name'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'available' => :'Integer',
+        :'limit' => :'Integer',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailRateLimiter` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          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
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'available')
+        self.available = attributes[:'available']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          available == o.available &&
+          limit == o.limit &&
+          name == o.name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [available, limit, name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/email_rate_limiters_response.rb

@@ -0,0 +1,258 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailRateLimitersResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :rate_limiters
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'rate_limiters' => :'rate_limiters',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'rate_limiters' => :'Array<EmailRateLimiter>',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailRateLimitersResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          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
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'rate_limiters')
+        if (value = attributes[:'rate_limiters']).is_a?(Array)
+          self.rate_limiters = value
+        end
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error &&
+          metadata == o.metadata &&
+          rate_limiters == o.rate_limiters &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [error, metadata, rate_limiters, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/order_query.rb

@@ -108,6 +108,9 @@ module UltracartClient
     # Purchase order number
     attr_accessor :purchase_order_number
 
+    # Query Target
+    attr_accessor :query_target
+
     # Date/time that the order was refunded
     attr_accessor :refund_date_begin
 
@@ -197,6 +200,7 @@ module UltracartClient
         :'phone' => :'phone',
         :'postal_code' => :'postal_code',
         :'purchase_order_number' => :'purchase_order_number',
+        :'query_target' => :'query_target',
         :'refund_date_begin' => :'refund_date_begin',
         :'refund_date_end' => :'refund_date_end',
         :'rma' => :'rma',
@@ -250,6 +254,7 @@ module UltracartClient
         :'phone' => :'String',
         :'postal_code' => :'String',
         :'purchase_order_number' => :'String',
+        :'query_target' => :'String',
         :'refund_date_begin' => :'String',
         :'refund_date_end' => :'String',
         :'rma' => :'String',
@@ -409,6 +414,10 @@ module UltracartClient
         self.purchase_order_number = attributes[:'purchase_order_number']
       end
 
+      if attributes.key?(:'query_target')
+        self.query_target = attributes[:'query_target']
+      end
+
       if attributes.key?(:'refund_date_begin')
         self.refund_date_begin = attributes[:'refund_date_begin']
       end
@@ -525,6 +534,8 @@ module UltracartClient
       return false unless payment_method_validator.valid?(@payment_method)
       return false if !@phone.nil? && @phone.to_s.length > 25
       return false if !@postal_code.nil? && @postal_code.to_s.length > 20
+      query_target_validator = EnumAttributeValidator.new('String', ["origin", "cache"])
+      return false unless query_target_validator.valid?(@query_target)
       return false if !@rma.nil? && @rma.to_s.length > 30
       return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
       return false if !@state_region.nil? && @state_region.to_s.length > 32
@@ -641,6 +652,16 @@ module UltracartClient
       @postal_code = postal_code
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] query_target Object to be assigned
+    def query_target=(query_target)
+      validator = EnumAttributeValidator.new('String', ["origin", "cache"])
+      unless validator.valid?(query_target)
+        fail ArgumentError, "invalid value for \"query_target\", must be one of #{validator.allowable_values}."
+      end
+      @query_target = query_target
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] rma Value to be assigned
     def rma=(rma)
@@ -707,6 +728,7 @@ module UltracartClient
           phone == o.phone &&
           postal_code == o.postal_code &&
           purchase_order_number == o.purchase_order_number &&
+          query_target == o.query_target &&
           refund_date_begin == o.refund_date_begin &&
           refund_date_end == o.refund_date_end &&
           rma == o.rma &&
@@ -729,7 +751,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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
+      [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
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.222'
+  VERSION = '4.0.224'
 end

data/lib/ultracart_api.rb

@@ -435,6 +435,8 @@ require 'ultracart_api/models/email_plan_response'
 require 'ultracart_api/models/email_postcard_stat'
 require 'ultracart_api/models/email_postcard_tracking'
 require 'ultracart_api/models/email_postcard_tracking_response'
+require 'ultracart_api/models/email_rate_limiter'
+require 'ultracart_api/models/email_rate_limiters_response'
 require 'ultracart_api/models/email_segment'
 require 'ultracart_api/models/email_segment_archive_response'
 require 'ultracart_api/models/email_segment_customer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.222
+  version: 4.0.224
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -488,6 +488,8 @@ files:
 - docs/EmailPostcardStat.md
 - docs/EmailPostcardTracking.md
 - docs/EmailPostcardTrackingResponse.md
+- docs/EmailRateLimiter.md
+- docs/EmailRateLimitersResponse.md
 - docs/EmailSegment.md
 - docs/EmailSegmentArchiveResponse.md
 - docs/EmailSegmentCustomer.md
@@ -1374,6 +1376,8 @@ files:
 - lib/ultracart_api/models/email_postcard_stat.rb
 - lib/ultracart_api/models/email_postcard_tracking.rb
 - lib/ultracart_api/models/email_postcard_tracking_response.rb
+- lib/ultracart_api/models/email_rate_limiter.rb
+- lib/ultracart_api/models/email_rate_limiters_response.rb
 - lib/ultracart_api/models/email_segment.rb
 - lib/ultracart_api/models/email_segment_archive_response.rb
 - lib/ultracart_api/models/email_segment_customer.rb