ultracart_api 4.0.213 → 4.0.215

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b3f3dec98b4283bf562c8c44f574993622b804f547d5c21c5994f49656ddc34
-  data.tar.gz: 89fb687420b9bd534b77fb95eef0974dcdad2979a7d96acee5bd76ffc6dd67bc
+  metadata.gz: 521074a5d1a6dfd7258769ecc711b401db9cb5143f60b2b4431b7c611b5319b6
+  data.tar.gz: 316beb1ac49bfdb9a0218808603b1477ca22173fee876a95642be0a66f46ab6a
 SHA512:
-  metadata.gz: 58ef39492149158a900b50850bb4493a0526814411e3d7354330e79856f0c714bfc4021c6b809dba60935cdb3cb4ed4a813a461d271064ffb36519146d18ee5d
-  data.tar.gz: 6224ed3b2c68694784d0078650eb81eca7951326b96d55d2995677ee23be2e520a7c1d85504b15e62a39f19abd16e1bf4f379254170de7e5312b0979138ea5ba
+  metadata.gz: 7a32b0a4ea581e23941c3092a01665869759756b16a7b5bcf174dcd8f9f04667cefb6248b75416c91a15ace75328b57d0ea1f4e3dde9687706f934e089e9eff1
+  data.tar.gz: 7a36687d83a28ba2064ff07584efb048fb244e4fce17687724e7e6086bb49cb2edd8c8a39b5eaa7358e0752922ac1e4544cb2518f259a260c3abb7ecf2b25b1e

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.213
+- Package version: 4.0.215
 - 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.213.gem
+gem install ./ultracart_api-4.0.215.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.213.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.215.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.213'
+    gem 'ultracart_api', '~> 4.0.215'
 
 ### Install from Git
 
@@ -177,6 +177,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
 *UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
 *UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
+*UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
 *UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
 *UltracartClient::ConversationApi* | [**get_pbx_menu**](docs/ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
 *UltracartClient::ConversationApi* | [**get_pbx_menus**](docs/ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
@@ -765,6 +766,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationPbxAudioResponse](docs/ConversationPbxAudioResponse.md)
  - [UltracartClient::ConversationPbxAudioUploadUrl](docs/ConversationPbxAudioUploadUrl.md)
  - [UltracartClient::ConversationPbxAudioUploadUrlResponse](docs/ConversationPbxAudioUploadUrlResponse.md)
+ - [UltracartClient::ConversationPbxAudioUsageResponse](docs/ConversationPbxAudioUsageResponse.md)
  - [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
@@ -1511,6 +1513,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.215 | 05/08/2024 | added echeck fields to channel partner order import |
+| 4.0.214 | 05/02/2024 | conversation - new method to load pbx audio usage |
 | 4.0.213 | 05/02/2024 | autoorder - fields to record merge association and tstamp |
 | 4.0.212 | 05/01/2024 | getConversationPbxAudioUploadUrl - fix the response obj def |
 | 4.0.211 | 04/24/2024 | esp - add fields for external generation on email |

data/docs/ChannelPartnerOrder.md

@@ -43,6 +43,16 @@
 | **custom_field6** | **String** | Custom field 6 | [optional] |
 | **custom_field7** | **String** | Custom field 7 | [optional] |
 | **delivery_date** | **String** | Date the customer is requesting delivery on. Typically used for perishable product delivery. | [optional] |
+| **echeck_bank_aba_code** | **String** | eCheck bank ABA code | [optional] |
+| **echeck_bank_account_name** | **String** | eCheck bank account name | [optional] |
+| **echeck_bank_account_number** | **String** | eCheck bank account number | [optional] |
+| **echeck_bank_account_type** | **String** | eCheck bank account type | [optional] |
+| **echeck_bank_name** | **String** | eCheck bank name | [optional] |
+| **echeck_bank_owner_type** | **String** | eCheck bank owner type | [optional] |
+| **echeck_customer_tax_id** | **String** | eCheck customer tax id | [optional] |
+| **echeck_drivers_license_dob** | **String** | eCheck drivers license dob | [optional] |
+| **echeck_drivers_license_number** | **String** | eCheck drivers license number | [optional] |
+| **echeck_drivers_license_state** | **String** | eCheck drivers license state | [optional] |
 | **email** | **String** | Email | [optional] |
 | **gift** | **Boolean** | True if this order is a gift | [optional] |
 | **gift_email** | **String** | Email address of the gift recipient | [optional] |
@@ -131,6 +141,16 @@ instance = UltracartClient::ChannelPartnerOrder.new(
   custom_field6: null,
   custom_field7: null,
   delivery_date: null,
+  echeck_bank_aba_code: null,
+  echeck_bank_account_name: null,
+  echeck_bank_account_number: null,
+  echeck_bank_account_type: null,
+  echeck_bank_name: null,
+  echeck_bank_owner_type: null,
+  echeck_customer_tax_id: null,
+  echeck_drivers_license_dob: null,
+  echeck_drivers_license_number: null,
+  echeck_drivers_license_state: null,
   email: null,
   gift: null,
   gift_email: null,

data/docs/ConversationApi.md

@@ -42,6 +42,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails |
 | [**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents |
 | [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio |
+| [**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage |
 | [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios |
 | [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu |
 | [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus |
@@ -2768,6 +2769,77 @@ end
 - **Accept**: application/json
 
 
+## get_pbx_audio_usage
+
+> <ConversationPbxAudioUsageResponse> get_pbx_audio_usage(conversation_pbx_audio_uuid)
+
+Get pbx audio usage
+
+Retrieve a pbx audio usage 
+
+### 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::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String | 
+
+begin
+  # Get pbx audio usage
+  result = api_instance.get_pbx_audio_usage(conversation_pbx_audio_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_pbx_audio_usage: #{e}"
+end
+```
+
+#### Using the get_pbx_audio_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAudioUsageResponse>, Integer, Hash)> get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid)
+
+```ruby
+begin
+  # Get pbx audio usage
+  data, status_code, headers = api_instance.get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAudioUsageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_pbx_audio_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_audio_uuid** | **String** |  |  |
+
+### Return type
+
+[**ConversationPbxAudioUsageResponse**](ConversationPbxAudioUsageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_pbx_audios
 
 > <ConversationPbxAudiosResponse> get_pbx_audios

data/docs/ConversationPbxAudio.md

@@ -11,6 +11,7 @@
 | **filename** | **String** | Filename | [optional] |
 | **merchant_id** | **String** | Merchant Id | [optional] |
 | **mime_type** | **String** | Mime Type | [optional] |
+| **url** | **String** | URL | [optional] |
 | **user_id** | **Integer** | User Id | [optional] |
 | **version** | **Integer** | Version | [optional] |
 
@@ -27,6 +28,7 @@ instance = UltracartClient::ConversationPbxAudio.new(
   filename: null,
   merchant_id: null,
   mime_type: null,
+  url: null,
   user_id: null,
   version: null
 )

data/docs/ConversationPbxAudioUsageResponse.md

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

data/docs/OrderUtm.md

@@ -17,6 +17,12 @@
 | **fbclid** | **String** |  | [optional] |
 | **gbraid** | **String** |  | [optional] |
 | **glcid** | **String** |  | [optional] |
+| **itm_campaign** | **String** |  | [optional] |
+| **itm_content** | **String** |  | [optional] |
+| **itm_id** | **String** |  | [optional] |
+| **itm_medium** | **String** |  | [optional] |
+| **itm_source** | **String** |  | [optional] |
+| **itm_term** | **String** |  | [optional] |
 | **msclkid** | **String** |  | [optional] |
 | **ttclid** | **String** |  | [optional] |
 | **uc_message_id** | **String** |  | [optional] |
@@ -48,6 +54,12 @@ instance = UltracartClient::OrderUtm.new(
   fbclid: null,
   gbraid: null,
   glcid: null,
+  itm_campaign: null,
+  itm_content: null,
+  itm_id: null,
+  itm_medium: null,
+  itm_source: null,
+  itm_term: null,
   msclkid: null,
   ttclid: null,
   uc_message_id: null,

data/lib/ultracart_api/api/conversation_api.rb

@@ -2431,6 +2431,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get pbx audio usage
+    # Retrieve a pbx audio usage 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudioUsageResponse]
+    def get_pbx_audio_usage(conversation_pbx_audio_uuid, opts = {})
+      data, _status_code, _headers = get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts)
+      data
+    end
+
+    # Get pbx audio usage
+    # Retrieve a pbx audio usage 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudioUsageResponse, Integer, Hash)>] ConversationPbxAudioUsageResponse data, response status code and response headers
+    def get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audio_usage ...'
+      end
+      # verify the required parameter 'conversation_pbx_audio_uuid' is set
+      if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_pbx_audio_usage"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}/usage'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_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] || 'ConversationPbxAudioUsageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_pbx_audio_usage",
+        :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: ConversationApi#get_pbx_audio_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get pbx audios
     # Retrieve pbx audios 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/channel_partner_order.rb

@@ -132,6 +132,36 @@ module UltracartClient
     # Date the customer is requesting delivery on. Typically used for perishable product delivery.
     attr_accessor :delivery_date
 
+    # eCheck bank ABA code
+    attr_accessor :echeck_bank_aba_code
+
+    # eCheck bank account name
+    attr_accessor :echeck_bank_account_name
+
+    # eCheck bank account number
+    attr_accessor :echeck_bank_account_number
+
+    # eCheck bank account type
+    attr_accessor :echeck_bank_account_type
+
+    # eCheck bank name
+    attr_accessor :echeck_bank_name
+
+    # eCheck bank owner type
+    attr_accessor :echeck_bank_owner_type
+
+    # eCheck customer tax id
+    attr_accessor :echeck_customer_tax_id
+
+    # eCheck drivers license dob
+    attr_accessor :echeck_drivers_license_dob
+
+    # eCheck drivers license number
+    attr_accessor :echeck_drivers_license_number
+
+    # eCheck drivers license state
+    attr_accessor :echeck_drivers_license_state
+
     # Email
     attr_accessor :email
 
@@ -321,6 +351,16 @@ module UltracartClient
         :'custom_field6' => :'custom_field6',
         :'custom_field7' => :'custom_field7',
         :'delivery_date' => :'delivery_date',
+        :'echeck_bank_aba_code' => :'echeck_bank_aba_code',
+        :'echeck_bank_account_name' => :'echeck_bank_account_name',
+        :'echeck_bank_account_number' => :'echeck_bank_account_number',
+        :'echeck_bank_account_type' => :'echeck_bank_account_type',
+        :'echeck_bank_name' => :'echeck_bank_name',
+        :'echeck_bank_owner_type' => :'echeck_bank_owner_type',
+        :'echeck_customer_tax_id' => :'echeck_customer_tax_id',
+        :'echeck_drivers_license_dob' => :'echeck_drivers_license_dob',
+        :'echeck_drivers_license_number' => :'echeck_drivers_license_number',
+        :'echeck_drivers_license_state' => :'echeck_drivers_license_state',
         :'email' => :'email',
         :'gift' => :'gift',
         :'gift_email' => :'gift_email',
@@ -413,6 +453,16 @@ module UltracartClient
         :'custom_field6' => :'String',
         :'custom_field7' => :'String',
         :'delivery_date' => :'String',
+        :'echeck_bank_aba_code' => :'String',
+        :'echeck_bank_account_name' => :'String',
+        :'echeck_bank_account_number' => :'String',
+        :'echeck_bank_account_type' => :'String',
+        :'echeck_bank_name' => :'String',
+        :'echeck_bank_owner_type' => :'String',
+        :'echeck_customer_tax_id' => :'String',
+        :'echeck_drivers_license_dob' => :'String',
+        :'echeck_drivers_license_number' => :'String',
+        :'echeck_drivers_license_state' => :'String',
         :'email' => :'String',
         :'gift' => :'Boolean',
         :'gift_email' => :'String',
@@ -637,6 +687,46 @@ module UltracartClient
         self.delivery_date = attributes[:'delivery_date']
       end
 
+      if attributes.key?(:'echeck_bank_aba_code')
+        self.echeck_bank_aba_code = attributes[:'echeck_bank_aba_code']
+      end
+
+      if attributes.key?(:'echeck_bank_account_name')
+        self.echeck_bank_account_name = attributes[:'echeck_bank_account_name']
+      end
+
+      if attributes.key?(:'echeck_bank_account_number')
+        self.echeck_bank_account_number = attributes[:'echeck_bank_account_number']
+      end
+
+      if attributes.key?(:'echeck_bank_account_type')
+        self.echeck_bank_account_type = attributes[:'echeck_bank_account_type']
+      end
+
+      if attributes.key?(:'echeck_bank_name')
+        self.echeck_bank_name = attributes[:'echeck_bank_name']
+      end
+
+      if attributes.key?(:'echeck_bank_owner_type')
+        self.echeck_bank_owner_type = attributes[:'echeck_bank_owner_type']
+      end
+
+      if attributes.key?(:'echeck_customer_tax_id')
+        self.echeck_customer_tax_id = attributes[:'echeck_customer_tax_id']
+      end
+
+      if attributes.key?(:'echeck_drivers_license_dob')
+        self.echeck_drivers_license_dob = attributes[:'echeck_drivers_license_dob']
+      end
+
+      if attributes.key?(:'echeck_drivers_license_number')
+        self.echeck_drivers_license_number = attributes[:'echeck_drivers_license_number']
+      end
+
+      if attributes.key?(:'echeck_drivers_license_state')
+        self.echeck_drivers_license_state = attributes[:'echeck_drivers_license_state']
+      end
+
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
@@ -988,10 +1078,14 @@ module UltracartClient
       return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
       return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
       return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
+      echeck_bank_account_type_validator = EnumAttributeValidator.new('String', ["Checking", "Savings"])
+      return false unless echeck_bank_account_type_validator.valid?(@echeck_bank_account_type)
+      echeck_bank_owner_type_validator = EnumAttributeValidator.new('String', ["Business", "Personal"])
+      return false unless echeck_bank_owner_type_validator.valid?(@echeck_bank_owner_type)
       return false if !@email.nil? && @email.to_s.length > 100
       return false if !@gift_email.nil? && @gift_email.to_s.length > 100
       return false if !@gift_message.nil? && @gift_message.to_s.length > 10000
-      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer"])
+      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer"])
       return false unless payment_method_validator.valid?(@payment_method)
       return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
       return false if !@shipto_address1.nil? && @shipto_address1.to_s.length > 50
@@ -1210,6 +1304,26 @@ module UltracartClient
       @custom_field7 = custom_field7
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] echeck_bank_account_type Object to be assigned
+    def echeck_bank_account_type=(echeck_bank_account_type)
+      validator = EnumAttributeValidator.new('String', ["Checking", "Savings"])
+      unless validator.valid?(echeck_bank_account_type)
+        fail ArgumentError, "invalid value for \"echeck_bank_account_type\", must be one of #{validator.allowable_values}."
+      end
+      @echeck_bank_account_type = echeck_bank_account_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] echeck_bank_owner_type Object to be assigned
+    def echeck_bank_owner_type=(echeck_bank_owner_type)
+      validator = EnumAttributeValidator.new('String', ["Business", "Personal"])
+      unless validator.valid?(echeck_bank_owner_type)
+        fail ArgumentError, "invalid value for \"echeck_bank_owner_type\", must be one of #{validator.allowable_values}."
+      end
+      @echeck_bank_owner_type = echeck_bank_owner_type
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] email Value to be assigned
     def email=(email)
@@ -1243,7 +1357,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer"])
+      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer"])
       unless validator.valid?(payment_method)
         fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
       end
@@ -1434,6 +1548,16 @@ module UltracartClient
           custom_field6 == o.custom_field6 &&
           custom_field7 == o.custom_field7 &&
           delivery_date == o.delivery_date &&
+          echeck_bank_aba_code == o.echeck_bank_aba_code &&
+          echeck_bank_account_name == o.echeck_bank_account_name &&
+          echeck_bank_account_number == o.echeck_bank_account_number &&
+          echeck_bank_account_type == o.echeck_bank_account_type &&
+          echeck_bank_name == o.echeck_bank_name &&
+          echeck_bank_owner_type == o.echeck_bank_owner_type &&
+          echeck_customer_tax_id == o.echeck_customer_tax_id &&
+          echeck_drivers_license_dob == o.echeck_drivers_license_dob &&
+          echeck_drivers_license_number == o.echeck_drivers_license_number &&
+          echeck_drivers_license_state == o.echeck_drivers_license_state &&
           email == o.email &&
           gift == o.gift &&
           gift_email == o.gift_email &&
@@ -1487,7 +1611,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
+      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_audio.rb

@@ -36,6 +36,9 @@ module UltracartClient
     # Mime Type
     attr_accessor :mime_type
 
+    # URL
+    attr_accessor :url
+
     # User Id
     attr_accessor :user_id
 
@@ -52,6 +55,7 @@ module UltracartClient
         :'filename' => :'filename',
         :'merchant_id' => :'merchant_id',
         :'mime_type' => :'mime_type',
+        :'url' => :'url',
         :'user_id' => :'user_id',
         :'version' => :'version'
       }
@@ -72,6 +76,7 @@ module UltracartClient
         :'filename' => :'String',
         :'merchant_id' => :'String',
         :'mime_type' => :'String',
+        :'url' => :'String',
         :'user_id' => :'Integer',
         :'version' => :'Integer'
       }
@@ -126,6 +131,10 @@ module UltracartClient
         self.mime_type = attributes[:'mime_type']
       end
 
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -250,6 +259,7 @@ module UltracartClient
           filename == o.filename &&
           merchant_id == o.merchant_id &&
           mime_type == o.mime_type &&
+          url == o.url &&
           user_id == o.user_id &&
           version == o.version
     end
@@ -263,7 +273,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [audio_s3_listing_key, conversation_pbx_audio_uuid, default_hold_music, description, filename, merchant_id, mime_type, user_id, version].hash
+      [audio_s3_listing_key, conversation_pbx_audio_uuid, default_hold_music, description, filename, merchant_id, mime_type, url, user_id, version].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_audio_usage_response.rb

@@ -0,0 +1,280 @@
+=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 ConversationPbxAudioUsageResponse
+    attr_accessor :error
+
+    attr_accessor :menus
+
+    attr_accessor :metadata
+
+    attr_accessor :queues
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :voicemail_mailboxes
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'menus' => :'menus',
+        :'metadata' => :'metadata',
+        :'queues' => :'queues',
+        :'success' => :'success',
+        :'voicemail_mailboxes' => :'voicemail_mailboxes',
+        :'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',
+        :'menus' => :'Array<ConversationPbxMenu>',
+        :'metadata' => :'ResponseMetadata',
+        :'queues' => :'Array<ConversationPbxQueue>',
+        :'success' => :'Boolean',
+        :'voicemail_mailboxes' => :'Array<ConversationPbxVoicemailMailbox>',
+        :'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::ConversationPbxAudioUsageResponse` 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::ConversationPbxAudioUsageResponse`. 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?(:'menus')
+        if (value = attributes[:'menus']).is_a?(Array)
+          self.menus = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'queues')
+        if (value = attributes[:'queues']).is_a?(Array)
+          self.queues = value
+        end
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'voicemail_mailboxes')
+        if (value = attributes[:'voicemail_mailboxes']).is_a?(Array)
+          self.voicemail_mailboxes = value
+        end
+      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 &&
+          menus == o.menus &&
+          metadata == o.metadata &&
+          queues == o.queues &&
+          success == o.success &&
+          voicemail_mailboxes == o.voicemail_mailboxes &&
+          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, menus, metadata, queues, success, voicemail_mailboxes, 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_utm.rb

@@ -42,6 +42,18 @@ module UltracartClient
 
     attr_accessor :glcid
 
+    attr_accessor :itm_campaign
+
+    attr_accessor :itm_content
+
+    attr_accessor :itm_id
+
+    attr_accessor :itm_medium
+
+    attr_accessor :itm_source
+
+    attr_accessor :itm_term
+
     attr_accessor :msclkid
 
     attr_accessor :ttclid
@@ -80,6 +92,12 @@ module UltracartClient
         :'fbclid' => :'fbclid',
         :'gbraid' => :'gbraid',
         :'glcid' => :'glcid',
+        :'itm_campaign' => :'itm_campaign',
+        :'itm_content' => :'itm_content',
+        :'itm_id' => :'itm_id',
+        :'itm_medium' => :'itm_medium',
+        :'itm_source' => :'itm_source',
+        :'itm_term' => :'itm_term',
         :'msclkid' => :'msclkid',
         :'ttclid' => :'ttclid',
         :'uc_message_id' => :'uc_message_id',
@@ -115,6 +133,12 @@ module UltracartClient
         :'fbclid' => :'String',
         :'gbraid' => :'String',
         :'glcid' => :'String',
+        :'itm_campaign' => :'String',
+        :'itm_content' => :'String',
+        :'itm_id' => :'String',
+        :'itm_medium' => :'String',
+        :'itm_source' => :'String',
+        :'itm_term' => :'String',
         :'msclkid' => :'String',
         :'ttclid' => :'String',
         :'uc_message_id' => :'String',
@@ -202,6 +226,30 @@ module UltracartClient
         self.glcid = attributes[:'glcid']
       end
 
+      if attributes.key?(:'itm_campaign')
+        self.itm_campaign = attributes[:'itm_campaign']
+      end
+
+      if attributes.key?(:'itm_content')
+        self.itm_content = attributes[:'itm_content']
+      end
+
+      if attributes.key?(:'itm_id')
+        self.itm_id = attributes[:'itm_id']
+      end
+
+      if attributes.key?(:'itm_medium')
+        self.itm_medium = attributes[:'itm_medium']
+      end
+
+      if attributes.key?(:'itm_source')
+        self.itm_source = attributes[:'itm_source']
+      end
+
+      if attributes.key?(:'itm_term')
+        self.itm_term = attributes[:'itm_term']
+      end
+
       if attributes.key?(:'msclkid')
         self.msclkid = attributes[:'msclkid']
       end
@@ -278,6 +326,12 @@ module UltracartClient
           fbclid == o.fbclid &&
           gbraid == o.gbraid &&
           glcid == o.glcid &&
+          itm_campaign == o.itm_campaign &&
+          itm_content == o.itm_content &&
+          itm_id == o.itm_id &&
+          itm_medium == o.itm_medium &&
+          itm_source == o.itm_source &&
+          itm_term == o.itm_term &&
           msclkid == o.msclkid &&
           ttclid == o.ttclid &&
           uc_message_id == o.uc_message_id &&
@@ -300,7 +354,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attribution_first_click_subtotal, attribution_first_click_total, attribution_last_click_subtotal, attribution_last_click_total, attribution_linear_subtotal, attribution_linear_total, attribution_position_based_subtotal, attribution_position_based_total, click_dts, facebook_ad_id, fbclid, gbraid, glcid, msclkid, ttclid, uc_message_id, utm_campaign, utm_content, utm_id, utm_medium, utm_source, utm_term, vmcid, wbraid].hash
+      [attribution_first_click_subtotal, attribution_first_click_total, attribution_last_click_subtotal, attribution_last_click_total, attribution_linear_subtotal, attribution_linear_total, attribution_position_based_subtotal, attribution_position_based_total, click_dts, facebook_ad_id, fbclid, gbraid, glcid, itm_campaign, itm_content, itm_id, itm_medium, itm_source, itm_term, msclkid, ttclid, uc_message_id, utm_campaign, utm_content, utm_id, utm_medium, utm_source, utm_term, vmcid, wbraid].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.213'
+  VERSION = '4.0.215'
 end

data/lib/ultracart_api.rb

@@ -193,6 +193,7 @@ require 'ultracart_api/models/conversation_pbx_audio'
 require 'ultracart_api/models/conversation_pbx_audio_response'
 require 'ultracart_api/models/conversation_pbx_audio_upload_url'
 require 'ultracart_api/models/conversation_pbx_audio_upload_url_response'
+require 'ultracart_api/models/conversation_pbx_audio_usage_response'
 require 'ultracart_api/models/conversation_pbx_audios_response'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_request'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.213
+  version: 4.0.215
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -243,6 +243,7 @@ files:
 - docs/ConversationPbxAudioResponse.md
 - docs/ConversationPbxAudioUploadUrl.md
 - docs/ConversationPbxAudioUploadUrlResponse.md
+- docs/ConversationPbxAudioUsageResponse.md
 - docs/ConversationPbxAudiosResponse.md
 - docs/ConversationPbxCustomerSnapshotRequest.md
 - docs/ConversationPbxCustomerSnapshotResponse.md
@@ -1131,6 +1132,7 @@ files:
 - lib/ultracart_api/models/conversation_pbx_audio_response.rb
 - lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb
 - lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb
+- lib/ultracart_api/models/conversation_pbx_audio_usage_response.rb
 - lib/ultracart_api/models/conversation_pbx_audios_response.rb
 - lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb
 - lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb