ultracart_api 3.4.12 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7063e9772931a88f569176858a4e4dcfdedaa6774dfcc6070c01f4ad0ee67e4
-  data.tar.gz: e214680964f066ca4c030047eb71abf8a4949dcf96954bf91b51afb304e29b20
+  metadata.gz: a244f30a45d82996bf3cdedda60c37aa05608acb2e2c373b9d198a914adff55f
+  data.tar.gz: e9677070c832354ca98e9c8043559473ff4a0d303e6add1d34a2cd893e449408
 SHA512:
-  metadata.gz: 0cd1f07deaf3c96c42d0682c8bc89185f61c73ff2085a64abd96afe2e983524965433bfdc9ae4586c3c300574a8e3fa67ff680ff4763b6a154d049604dd5ea20
-  data.tar.gz: a577a0b839e3bc484f620b53874817ac9168a6a0409b30d31826a3c1141e28cec6ccae8a3cc1e744bf3942b869a5abf280216aa7ba2f2e96a0f44dcaf035d61a
+  metadata.gz: 2c0c1ad66bfb6e2593216208341aab5ca045431bc9aa004483ff5288503e1013e5e9e1a211bd04a3141cf8ebd10a36c799904cef4a3686db8e6f920bf1e7d4f8
+  data.tar.gz: db33323db36da46150dea5535637a82a1331ac0f00106de25583e8406a8a3e537d0325440803cbfc63d1ace5355a3c91001fda14d9b6aabcd8b5319fc41c73e3

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.4.12
+- Package version: 3.5.2
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.4.12.gem
+gem install ./ultracart_api-3.5.2.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.4.12.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.5.2.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', '~> 3.4.12'
+    gem 'ultracart_api', '~> 3.5.2'
 
 ### Install from Git
 
@@ -344,6 +344,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**search_shared_items**](docs/StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
 *UltracartClient::StorefrontApi* | [**send_email_test**](docs/StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
 *UltracartClient::StorefrontApi* | [**send_postcard_test**](docs/StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
+*UltracartClient::StorefrontApi* | [**send_webhook_test**](docs/StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
 *UltracartClient::StorefrontApi* | [**start_email_campaign**](docs/StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
 *UltracartClient::StorefrontApi* | [**subscribe_to_email_list**](docs/StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
 *UltracartClient::StorefrontApi* | [**unfavorite_screen_recording**](docs/StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
@@ -640,6 +641,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
  - [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
  - [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
+ - [UltracartClient::EmailCommseqWebhookSendTestRequest](docs/EmailCommseqWebhookSendTestRequest.md)
  - [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
  - [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
  - [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
@@ -1114,6 +1116,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.5.1 | 08/11/2021 | email webhook test method | 
+| 3.5.0 | 08/11/2021 | RestOrderChannelPartner.store_completed was incorrectly defaulting to true | 
+| 3.4.13 | 08/10/2021 | configuration api - changed some field types form string to number | 
 | 3.4.12 | 08/10/2021 | email engine - added webhook editor values for internal ui  | 
 | 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names | 
 | 3.4.8 | 08/04/2021 | configuration api - payments config refactoring | 

data/docs/EmailCommseqWebhookSendTestRequest.md

@@ -0,0 +1,14 @@
+# UltracartClient::EmailCommseqWebhookSendTestRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cart_id** | **String** |  | [optional] 
+**cart_item_ids** | **Array<String>** |  | [optional] 
+**email** | **String** |  | [optional] 
+**esp_commseq_step_uuid** | **String** |  | [optional] 
+**esp_commseq_uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**order_id** | **String** |  | [optional] 
+
+

data/docs/OrderChannelPartner.md

@@ -7,11 +7,11 @@ Name | Type | Description | Notes
 **channel_partner_code** | **String** | The code of the channel partner | [optional] 
 **channel_partner_data** | **String** | Additional data provided by the channel partner, read-only | [optional] 
 **channel_partner_oid** | **Integer** | Channel partner object identifier, read-only and available on existing channel orders only. | [optional] 
-**channel_partner_order_id** | **String** | The order ID assigned by the channel partner for this order | [optional] 
+**channel_partner_order_id** | **String** | The order ID assigned by the channel partner for this order. | [optional] 
 **ignore_invalid_shipping_method** | **BOOLEAN** | Set to true to ignore invalid shipping method being specified.  Only applicable on inserting orders. | [optional] 
 **no_realtime_payment_processing** | **BOOLEAN** | Indicates this order should be placed in Account Receivable for later payment processing | [optional] 
 **skip_payment_processing** | **BOOLEAN** | Indicates this order was already paid for via a channel purchase and no payment collection should be attempted | [optional] 
-**store_completed** | **BOOLEAN** | Instructs UltraCart to skip shipping department and mark this order as fully complete.  Set this flag if you have already shipped product for this order. | [optional] 
+**store_completed** | **BOOLEAN** | Instructs UltraCart to skip shipping department and mark this order as fully complete.  This flag defaults to true.  Set this flag to false to shipped product for this order. | [optional] 
 **store_if_payment_declines** | **BOOLEAN** | If true, any failed payment will place the order in Accounts Receivable rather than rejecting it. | [optional] 
 **treat_warnings_as_errors** | **BOOLEAN** | Any warnings are raised as errors and halt the import of the order | [optional] 
 

data/docs/PaymentsConfigurationCOD.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with COD | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
 **surcharge_accounting_code** | **String** | Optional field, if surcharge is set, this is the accounting code the surcharge is tagged with when sent to Quickbooks | [optional] 
-**surcharge_fee** | **String** | Additional cost for using COD | [optional] 
-**surcharge_percentage** | **String** | Additional percentage cost for using COD | [optional] 
+**surcharge_fee** | **Float** | Additional cost for using COD | [optional] 
+**surcharge_percentage** | **Float** | Additional percentage cost for using COD | [optional] 
 
 

data/docs/PaymentsConfigurationCreditCard.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **configured_gateway_details** | **String** | Human readable description of the credit card gateway currently configured | [optional] 
 **failed_attempts** | **Integer** | The number of failed attempts before the order is placed into Accounts Receivable for manual intervention | [optional] 
 **hide_connect_single_gateway** | **BOOLEAN** | This internal flag aids the UI in determining which buttons to show. | [optional] 
-**restrictions** | [**Array<PaymentsConfigurationRestrictions>**](PaymentsConfigurationRestrictions.md) | Restrictions for this payment method | [optional] 
 **send_customer_billing_update_on_decline** | **BOOLEAN** | UltraCart will send customers emails to update their credit card if the card is declined | [optional] 
 **supported_cards** | [**Array<PaymentsConfigurationCreditCardType>**](PaymentsConfigurationCreditCardType.md) | A list of credit cards the merchant wishes to accept. | [optional] 
 **test_methods** | [**Array<PaymentsConfigurationTestMethod>**](PaymentsConfigurationTestMethod.md) | An array of test methods for placing test orders.  The cards defined here may be real or fake, but any order placed with them will be marked as Test orders | [optional] 

data/docs/PaymentsConfigurationCreditCardType.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional] 
 **processing_fee** | **Float** | Optional additional fee applied to order for this card | [optional] 
 **processing_percentage** | **Float** | Optional additional fee applied to order for this card | [optional] 
+**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
 **surcharge_accounting_code** | **String** | Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders | [optional] 
 **transaction_fee** | **Float** | An optional additional fee to charge the customer for using this card. | [optional] 
 **transaction_percentage** | **Float** | An optional transaction percentage to charge the customer for using this card | [optional] 

data/docs/PaymentsConfigurationPayPal.md

@@ -19,8 +19,8 @@ Name | Type | Description | Notes
 **landing_page** | **String** | PayPal landing page | [optional] 
 **mode** | **String** | The PayPal mode | [optional] 
 **private_key_password** | **String** | PayPal API private key password | [optional] 
-**processing_fee** | **String** | Optional additional fee to charge if PayPal is used.  It is rare for this to be used. | [optional] 
-**processing_percentage** | **String** | The processing percentage charged by PayPal | [optional] 
+**processing_fee** | **Float** | Optional additional fee to charge if PayPal is used.  It is rare for this to be used. | [optional] 
+**processing_percentage** | **Float** | The processing percentage charged by PayPal | [optional] 
 **push_paypal** | **BOOLEAN** | True if the internal UI should recommend opening a PayPal account | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
 **send_recurring** | **BOOLEAN** | True if UltraCart should send recurring orders to PayPal.  There are restrictions to what PayPal will accept for recurring orders.  Be careful. | [optional] 

data/docs/PaymentsConfigurationWireTransfer.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
 **routing_number** | **String** | Routing number | [optional] 
 **surcharge_accounting_code** | **String** | If a surcharge is present and this merchant is integrated with Quickbooks, this is the accounting code for the surcharge amount | [optional] 
-**surcharge_fee** | **String** | surcharge_fee | [optional] 
-**surcharge_percentage** | **String** | surcharge_percentage | [optional] 
+**surcharge_fee** | **Float** | surcharge_fee | [optional] 
+**surcharge_percentage** | **Float** | surcharge_percentage | [optional] 
 
 

data/docs/StorefrontApi.md

@@ -134,6 +134,7 @@ Method | HTTP request | Description
 [**search_shared_items**](StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
 [**send_email_test**](StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
 [**send_postcard_test**](StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
+[**send_webhook_test**](StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
 [**start_email_campaign**](StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
 [**subscribe_to_email_list**](StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
 [**unfavorite_screen_recording**](StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
@@ -6851,6 +6852,57 @@ Name | Type | Description  | Notes
 
 
 
+# **send_webhook_test**
+> EmailCommseqEmailSendTestResponse send_webhook_test(storefront_oid, email_commseq_webhook_test_request)
+
+Send webhook test
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+email_commseq_webhook_test_request = UltracartClient::EmailCommseqWebhookSendTestRequest.new # EmailCommseqWebhookSendTestRequest | Email commseq webhook test request
+
+
+begin
+  #Send webhook test
+  result = api_instance.send_webhook_test(storefront_oid, email_commseq_webhook_test_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->send_webhook_test: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **email_commseq_webhook_test_request** | [**EmailCommseqWebhookSendTestRequest**](EmailCommseqWebhookSendTestRequest.md)| Email commseq webhook test request | 
+
+### Return type
+
+[**EmailCommseqEmailSendTestResponse**](EmailCommseqEmailSendTestResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **start_email_campaign**
 > BaseResponse start_email_campaign(storefront_oid, email_campaign_uuid)
 

data/lib/ultracart_api.rb

@@ -238,6 +238,7 @@ require 'ultracart_api/models/email_commseq_stat_response'
 require 'ultracart_api/models/email_commseq_step'
 require 'ultracart_api/models/email_commseq_step_log'
 require 'ultracart_api/models/email_commseq_step_logs_response'
+require 'ultracart_api/models/email_commseq_webhook_send_test_request'
 require 'ultracart_api/models/email_commseqs_response'
 require 'ultracart_api/models/email_customer'
 require 'ultracart_api/models/email_customer_editor_url_response'

data/lib/ultracart_api/api/storefront_api.rb

@@ -7661,6 +7661,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Send webhook test
+    # @param storefront_oid 
+    # @param email_commseq_webhook_test_request Email commseq webhook test request
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEmailSendTestResponse]
+    def send_webhook_test(storefront_oid, email_commseq_webhook_test_request, opts = {})
+      data, _status_code, _headers = send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts)
+      data
+    end
+
+    # Send webhook test
+    # @param storefront_oid 
+    # @param email_commseq_webhook_test_request Email commseq webhook test request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEmailSendTestResponse, Fixnum, Hash)>] EmailCommseqEmailSendTestResponse data, response status code and response headers
+    def send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.send_webhook_test ...'
+      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.send_webhook_test"
+      end
+      # verify the required parameter 'email_commseq_webhook_test_request' is set
+      if @api_client.config.client_side_validation && email_commseq_webhook_test_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_commseq_webhook_test_request' when calling StorefrontApi.send_webhook_test"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/webhooks/test'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(email_commseq_webhook_test_request)
+      auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailCommseqEmailSendTestResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#send_webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Start email campaign
     # @param storefront_oid 
     # @param email_campaign_uuid 

data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb

@@ -0,0 +1,240 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class EmailCommseqWebhookSendTestRequest
+    attr_accessor :cart_id
+
+    attr_accessor :cart_item_ids
+
+    attr_accessor :email
+
+    attr_accessor :esp_commseq_step_uuid
+
+    attr_accessor :esp_commseq_uuid
+
+    attr_accessor :name
+
+    attr_accessor :order_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cart_id' => :'cart_id',
+        :'cart_item_ids' => :'cart_item_ids',
+        :'email' => :'email',
+        :'esp_commseq_step_uuid' => :'esp_commseq_step_uuid',
+        :'esp_commseq_uuid' => :'esp_commseq_uuid',
+        :'name' => :'name',
+        :'order_id' => :'order_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cart_id' => :'String',
+        :'cart_item_ids' => :'Array<String>',
+        :'email' => :'String',
+        :'esp_commseq_step_uuid' => :'String',
+        :'esp_commseq_uuid' => :'String',
+        :'name' => :'String',
+        :'order_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'cart_id')
+        self.cart_id = attributes[:'cart_id']
+      end
+
+      if attributes.has_key?(:'cart_item_ids')
+        if (value = attributes[:'cart_item_ids']).is_a?(Array)
+          self.cart_item_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'esp_commseq_step_uuid')
+        self.esp_commseq_step_uuid = attributes[:'esp_commseq_step_uuid']
+      end
+
+      if attributes.has_key?(:'esp_commseq_uuid')
+        self.esp_commseq_uuid = attributes[:'esp_commseq_uuid']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      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 &&
+          cart_id == o.cart_id &&
+          cart_item_ids == o.cart_item_ids &&
+          email == o.email &&
+          esp_commseq_step_uuid == o.esp_commseq_step_uuid &&
+          esp_commseq_uuid == o.esp_commseq_uuid &&
+          name == o.name &&
+          order_id == o.order_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [cart_id, cart_item_ids, email, esp_commseq_step_uuid, esp_commseq_uuid, name, order_id].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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_channel_partner.rb

@@ -26,7 +26,7 @@ module UltracartClient
     # Channel partner object identifier, read-only and available on existing channel orders only.
     attr_accessor :channel_partner_oid
 
-    # The order ID assigned by the channel partner for this order
+    # The order ID assigned by the channel partner for this order.
     attr_accessor :channel_partner_order_id
 
     # Set to true to ignore invalid shipping method being specified.  Only applicable on inserting orders.
@@ -38,7 +38,7 @@ module UltracartClient
     # Indicates this order was already paid for via a channel purchase and no payment collection should be attempted
     attr_accessor :skip_payment_processing
 
-    # Instructs UltraCart to skip shipping department and mark this order as fully complete.  Set this flag if you have already shipped product for this order.
+    # Instructs UltraCart to skip shipping department and mark this order as fully complete.  This flag defaults to true.  Set this flag to false to shipped product for this order.
     attr_accessor :store_completed
 
     # If true, any failed payment will place the order in Accounts Receivable rather than rejecting it.
@@ -138,15 +138,30 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@channel_partner_order_id.nil? && @channel_partner_order_id.to_s.length > 50
+        invalid_properties.push('invalid value for "channel_partner_order_id", the character length must be smaller than or equal to 50.')
+      end
+
       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?
+      return false if !@channel_partner_order_id.nil? && @channel_partner_order_id.to_s.length > 50
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] channel_partner_order_id Value to be assigned
+    def channel_partner_order_id=(channel_partner_order_id)
+      if !channel_partner_order_id.nil? && channel_partner_order_id.to_s.length > 50
+        fail ArgumentError, 'invalid value for "channel_partner_order_id", the character length must be smaller than or equal to 50.'
+      end
+
+      @channel_partner_order_id = channel_partner_order_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ultracart_api/models/payments_configuration_cod.rb

@@ -50,8 +50,8 @@ module UltracartClient
         :'approved_customers_only' => :'BOOLEAN',
         :'restrictions' => :'PaymentsConfigurationRestrictions',
         :'surcharge_accounting_code' => :'String',
-        :'surcharge_fee' => :'String',
-        :'surcharge_percentage' => :'String'
+        :'surcharge_fee' => :'Float',
+        :'surcharge_percentage' => :'Float'
       }
     end
 

data/lib/ultracart_api/models/payments_configuration_credit_card.rb

@@ -35,9 +35,6 @@ module UltracartClient
     # This internal flag aids the UI in determining which buttons to show.
     attr_accessor :hide_connect_single_gateway
 
-    # Restrictions for this payment method
-    attr_accessor :restrictions
-
     # UltraCart will send customers emails to update their credit card if the card is declined
     attr_accessor :send_customer_billing_update_on_decline
 
@@ -57,7 +54,6 @@ module UltracartClient
         :'configured_gateway_details' => :'configured_gateway_details',
         :'failed_attempts' => :'failed_attempts',
         :'hide_connect_single_gateway' => :'hide_connect_single_gateway',
-        :'restrictions' => :'restrictions',
         :'send_customer_billing_update_on_decline' => :'send_customer_billing_update_on_decline',
         :'supported_cards' => :'supported_cards',
         :'test_methods' => :'test_methods'
@@ -74,7 +70,6 @@ module UltracartClient
         :'configured_gateway_details' => :'String',
         :'failed_attempts' => :'Integer',
         :'hide_connect_single_gateway' => :'BOOLEAN',
-        :'restrictions' => :'Array<PaymentsConfigurationRestrictions>',
         :'send_customer_billing_update_on_decline' => :'BOOLEAN',
         :'supported_cards' => :'Array<PaymentsConfigurationCreditCardType>',
         :'test_methods' => :'Array<PaymentsConfigurationTestMethod>'
@@ -117,12 +112,6 @@ module UltracartClient
         self.hide_connect_single_gateway = attributes[:'hide_connect_single_gateway']
       end
 
-      if attributes.has_key?(:'restrictions')
-        if (value = attributes[:'restrictions']).is_a?(Array)
-          self.restrictions = value
-        end
-      end
-
       if attributes.has_key?(:'send_customer_billing_update_on_decline')
         self.send_customer_billing_update_on_decline = attributes[:'send_customer_billing_update_on_decline']
       end
@@ -165,7 +154,6 @@ module UltracartClient
           configured_gateway_details == o.configured_gateway_details &&
           failed_attempts == o.failed_attempts &&
           hide_connect_single_gateway == o.hide_connect_single_gateway &&
-          restrictions == o.restrictions &&
           send_customer_billing_update_on_decline == o.send_customer_billing_update_on_decline &&
           supported_cards == o.supported_cards &&
           test_methods == o.test_methods
@@ -180,7 +168,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_credit_card, billed_by, charge_during_checkout, collect_cvv2, configured_gateway_details, failed_attempts, hide_connect_single_gateway, restrictions, send_customer_billing_update_on_decline, supported_cards, test_methods].hash
+      [accept_credit_card, billed_by, charge_during_checkout, collect_cvv2, configured_gateway_details, failed_attempts, hide_connect_single_gateway, send_customer_billing_update_on_decline, supported_cards, test_methods].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb

@@ -35,6 +35,8 @@ module UltracartClient
     # Optional additional fee applied to order for this card
     attr_accessor :processing_percentage
 
+    attr_accessor :restrictions
+
     # Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders
     attr_accessor :surcharge_accounting_code
 
@@ -76,6 +78,7 @@ module UltracartClient
         :'enabled' => :'enabled',
         :'processing_fee' => :'processing_fee',
         :'processing_percentage' => :'processing_percentage',
+        :'restrictions' => :'restrictions',
         :'surcharge_accounting_code' => :'surcharge_accounting_code',
         :'transaction_fee' => :'transaction_fee',
         :'transaction_percentage' => :'transaction_percentage'
@@ -92,6 +95,7 @@ module UltracartClient
         :'enabled' => :'BOOLEAN',
         :'processing_fee' => :'Float',
         :'processing_percentage' => :'Float',
+        :'restrictions' => :'PaymentsConfigurationRestrictions',
         :'surcharge_accounting_code' => :'String',
         :'transaction_fee' => :'Float',
         :'transaction_percentage' => :'Float'
@@ -134,6 +138,10 @@ module UltracartClient
         self.processing_percentage = attributes[:'processing_percentage']
       end
 
+      if attributes.has_key?(:'restrictions')
+        self.restrictions = attributes[:'restrictions']
+      end
+
       if attributes.has_key?(:'surcharge_accounting_code')
         self.surcharge_accounting_code = attributes[:'surcharge_accounting_code']
       end
@@ -184,6 +192,7 @@ module UltracartClient
           enabled == o.enabled &&
           processing_fee == o.processing_fee &&
           processing_percentage == o.processing_percentage &&
+          restrictions == o.restrictions &&
           surcharge_accounting_code == o.surcharge_accounting_code &&
           transaction_fee == o.transaction_fee &&
           transaction_percentage == o.transaction_percentage
@@ -198,7 +207,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accounting_code, card_type_icon, credit_card, deposit_to_account, enabled, processing_fee, processing_percentage, surcharge_accounting_code, transaction_fee, transaction_percentage].hash
+      [accounting_code, card_type_icon, credit_card, deposit_to_account, enabled, processing_fee, processing_percentage, restrictions, surcharge_accounting_code, transaction_fee, transaction_percentage].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/payments_configuration_pay_pal.rb

@@ -176,8 +176,8 @@ module UltracartClient
         :'landing_page' => :'String',
         :'mode' => :'String',
         :'private_key_password' => :'String',
-        :'processing_fee' => :'String',
-        :'processing_percentage' => :'String',
+        :'processing_fee' => :'Float',
+        :'processing_percentage' => :'Float',
         :'push_paypal' => :'BOOLEAN',
         :'restrictions' => :'PaymentsConfigurationRestrictions',
         :'send_recurring' => :'BOOLEAN',

data/lib/ultracart_api/models/payments_configuration_restrictions.rb

@@ -54,6 +54,28 @@ module UltracartClient
 
     attr_accessor :themes
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -173,9 +195,117 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      restriction_alaska_hawaii_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_alaska_hawaii_validator.valid?(@restriction_alaska_hawaii)
+      restriction_apo_fpo_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_apo_fpo_validator.valid?(@restriction_apo_fpo)
+      restriction_canada_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_canada_validator.valid?(@restriction_canada)
+      restriction_continental_us_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_continental_us_validator.valid?(@restriction_continental_us)
+      restriction_domestic_only_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_domestic_only_validator.valid?(@restriction_domestic_only)
+      restriction_international_only_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_international_only_validator.valid?(@restriction_international_only)
+      restriction_po_box_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_po_box_validator.valid?(@restriction_po_box)
+      restriction_puerto_rico_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_puerto_rico_validator.valid?(@restriction_puerto_rico)
+      restriction_us_territories_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      return false unless restriction_us_territories_validator.valid?(@restriction_us_territories)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_alaska_hawaii Object to be assigned
+    def restriction_alaska_hawaii=(restriction_alaska_hawaii)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_alaska_hawaii)
+        fail ArgumentError, 'invalid value for "restriction_alaska_hawaii", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_alaska_hawaii = restriction_alaska_hawaii
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_apo_fpo Object to be assigned
+    def restriction_apo_fpo=(restriction_apo_fpo)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_apo_fpo)
+        fail ArgumentError, 'invalid value for "restriction_apo_fpo", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_apo_fpo = restriction_apo_fpo
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_canada Object to be assigned
+    def restriction_canada=(restriction_canada)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_canada)
+        fail ArgumentError, 'invalid value for "restriction_canada", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_canada = restriction_canada
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_continental_us Object to be assigned
+    def restriction_continental_us=(restriction_continental_us)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_continental_us)
+        fail ArgumentError, 'invalid value for "restriction_continental_us", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_continental_us = restriction_continental_us
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_domestic_only Object to be assigned
+    def restriction_domestic_only=(restriction_domestic_only)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_domestic_only)
+        fail ArgumentError, 'invalid value for "restriction_domestic_only", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_domestic_only = restriction_domestic_only
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_international_only Object to be assigned
+    def restriction_international_only=(restriction_international_only)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_international_only)
+        fail ArgumentError, 'invalid value for "restriction_international_only", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_international_only = restriction_international_only
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_po_box Object to be assigned
+    def restriction_po_box=(restriction_po_box)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_po_box)
+        fail ArgumentError, 'invalid value for "restriction_po_box", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_po_box = restriction_po_box
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_puerto_rico Object to be assigned
+    def restriction_puerto_rico=(restriction_puerto_rico)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_puerto_rico)
+        fail ArgumentError, 'invalid value for "restriction_puerto_rico", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_puerto_rico = restriction_puerto_rico
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] restriction_us_territories Object to be assigned
+    def restriction_us_territories=(restriction_us_territories)
+      validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
+      unless validator.valid?(restriction_us_territories)
+        fail ArgumentError, 'invalid value for "restriction_us_territories", must be one of #{validator.allowable_values}.'
+      end
+      @restriction_us_territories = restriction_us_territories
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb

@@ -75,8 +75,8 @@ module UltracartClient
         :'restrictions' => :'PaymentsConfigurationRestrictions',
         :'routing_number' => :'String',
         :'surcharge_accounting_code' => :'String',
-        :'surcharge_fee' => :'String',
-        :'surcharge_percentage' => :'String'
+        :'surcharge_fee' => :'Float',
+        :'surcharge_percentage' => :'Float'
       }
     end
 

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.4.12'
+  VERSION = '3.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.4.12
+  version: 3.5.2
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -429,6 +429,7 @@ files:
 - docs/EmailCommseqStep.md
 - docs/EmailCommseqStepLog.md
 - docs/EmailCommseqStepLogsResponse.md
+- docs/EmailCommseqWebhookSendTestRequest.md
 - docs/EmailCommseqsResponse.md
 - docs/EmailCustomer.md
 - docs/EmailCustomerEditorUrlResponse.md
@@ -1092,6 +1093,7 @@ files:
 - lib/ultracart_api/models/email_commseq_step.rb
 - lib/ultracart_api/models/email_commseq_step_log.rb
 - lib/ultracart_api/models/email_commseq_step_logs_response.rb
+- lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb
 - lib/ultracart_api/models/email_commseqs_response.rb
 - lib/ultracart_api/models/email_customer.rb
 - lib/ultracart_api/models/email_customer_editor_url_response.rb