ultracart_api 4.1.41 → 4.1.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595b3033ad472ccc0aa3d78aa1f6a70d651bfd8eba98e9be117be4472661a6b1
-  data.tar.gz: 8194ad91b9acfedc80fc3252b03b14634a67d163ca01cdf68c4aac84c8c7d549
+  metadata.gz: 1b5be4e83294986018fcf1b28a119d5faabd60ebfc33c2ac6ffcd19da37f75c5
+  data.tar.gz: 858d0f8222143ff75e606f9f5f568880be04c179fcf40b87196582a6f2d3306a
 SHA512:
-  metadata.gz: '0582649d3d7650856dda1b5abadf50c80763fe54f77618cbed053f0ec1b546e99833d256907715ec5134b0ed41d9423fa57a75500d9087af3cdd9d0bb1b9f129'
-  data.tar.gz: ed20b91310e7e0c24eba78318399b3b4421e1e965abaae0c2336a90e823730e90b40bb0ca2e2d899e5e8acf2ce5a12ced62698764284da883bafc14ad8dca8c7
+  metadata.gz: 0f53accc7bc75142f38d3cb6fa7e09e6243b5427c08639614527c9640e3312669db8dfb6979c99378d08525117d5a3f718ba4025f1f5e47911c9e934053d6226
+  data.tar.gz: 55d1f763e38fd26e1edbd952d9ee45c095b6a26509644b047ff4a3eedadf071438e65224dfa1507a3f66fed359cba9c1b807b0dc9f8f5816808c08ea3a79d55e

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.41
+- Package version: 4.1.43
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.41'
+gem 'ultracart_api', '4.1.43'
 ```
 
 install:
@@ -1621,6 +1621,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.43 | 01/14/2026 | coupons - generate one time coupons prefix support (optional) |
+| 4.1.42 | 01/13/2026 | conversations - pbx methods for phone number purchasing |
 | 4.1.41 | 01/13/2026 | conversations - pbx methods for phone number purchasing |
 | 4.1.40 | 01/07/2026 | convseration - AI agent profile voice settings |
 | 4.1.39 | 12/31/2025 | conversations AI - queue AI settings |

data/docs/ConversationPbxAddress.md

@@ -14,6 +14,7 @@
 | **postal_code** | **String** | Postal code | [optional] |
 | **region** | **String** | State/Province/Region | [optional] |
 | **street** | **String** | Street address | [optional] |
+| **valid** | **Boolean** | Whether the address is valid (validated or verified) | [optional] |
 | **validated** | **Boolean** | Whether the address has been validated by Twilio | [optional] |
 | **verified** | **Boolean** | Whether the address has been verified by Twilio | [optional] |
 
@@ -33,6 +34,7 @@ instance = UltracartClient::ConversationPbxAddress.new(
   postal_code: null,
   region: null,
   street: null,
+  valid: null,
   validated: null,
   verified: null
 )

data/docs/ConversationPbxAvailablePhoneNumber.md

@@ -9,6 +9,7 @@
 | **friendly_name** | **String** | Friendly formatted phone number | [optional] |
 | **locality** | **String** | City/Locality | [optional] |
 | **mms** | **Boolean** | MMS capability | [optional] |
+| **monthly_cost** | **Float** | Monthly cost for this phone number | [optional] |
 | **phone_number** | **String** | Phone number in E.164 format | [optional] |
 | **region** | **String** | State/Province/Region | [optional] |
 | **sms** | **Boolean** | SMS capability | [optional] |
@@ -25,6 +26,7 @@ instance = UltracartClient::ConversationPbxAvailablePhoneNumber.new(
   friendly_name: null,
   locality: null,
   mms: null,
+  monthly_cost: null,
   phone_number: null,
   region: null,
   sms: null,

data/docs/ConversationPbxPhoneNumber.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **action** | **String** | Action | [optional] |
 | **action_target** | **String** | Action target.  This is the UUID associated with the configuration object of that particular type. | [optional] |
+| **address_sid** | **String** | Twilio Address SID linked to this phone number for regulatory compliance | [optional] |
 | **conversation_pbx_phone_number_uuid** | **String** | Conversation Pbx Phone Number UUID | [optional] |
 | **deletion_protected** | **Boolean** | If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console. | [optional] |
 | **merchant_id** | **String** | Merchant Id | [optional] |
@@ -19,6 +20,7 @@ require 'ultracart_api'
 instance = UltracartClient::ConversationPbxPhoneNumber.new(
   action: null,
   action_target: null,
+  address_sid: null,
   conversation_pbx_phone_number_uuid: null,
   deletion_protected: null,
   merchant_id: null,

data/docs/CouponCodesRequest.md

@@ -8,6 +8,7 @@
 | **expiration_dts** | **String** | Expiration Date | [optional] |
 | **expiration_seconds** | **Integer** | Expiration seconds | [optional] |
 | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **prefix** | **String** | Optional prefix for generated codes | [optional] |
 | **quantity** | **Integer** | Quantity | [optional] |
 | **success** | **Boolean** | Indicates if API call was successful | [optional] |
 | **warning** | [**Warning**](Warning.md) |  | [optional] |
@@ -22,6 +23,7 @@ instance = UltracartClient::CouponCodesRequest.new(
   expiration_dts: null,
   expiration_seconds: null,
   metadata: null,
+  prefix: null,
   quantity: null,
   success: null,
   warning: null

data/lib/ultracart_api/models/conversation_pbx_address.rb

@@ -45,6 +45,9 @@ module UltracartClient
     # Street address
     attr_accessor :street
 
+    # Whether the address is valid (validated or verified)
+    attr_accessor :valid
+
     # Whether the address has been validated by Twilio
     attr_accessor :validated
 
@@ -64,6 +67,7 @@ module UltracartClient
         :'postal_code' => :'postal_code',
         :'region' => :'region',
         :'street' => :'street',
+        :'valid' => :'valid',
         :'validated' => :'validated',
         :'verified' => :'verified'
       }
@@ -87,6 +91,7 @@ module UltracartClient
         :'postal_code' => :'String',
         :'region' => :'String',
         :'street' => :'String',
+        :'valid' => :'Boolean',
         :'validated' => :'Boolean',
         :'verified' => :'Boolean'
       }
@@ -153,6 +158,10 @@ module UltracartClient
         self.street = attributes[:'street']
       end
 
+      if attributes.key?(:'valid')
+        self.valid = attributes[:'valid']
+      end
+
       if attributes.key?(:'validated')
         self.validated = attributes[:'validated']
       end
@@ -340,6 +349,7 @@ module UltracartClient
           postal_code == o.postal_code &&
           region == o.region &&
           street == o.street &&
+          valid == o.valid &&
           validated == o.validated &&
           verified == o.verified
     end
@@ -353,7 +363,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address_sid, city, conversation_pbx_address_uuid, country_code, customer_name, friendly_name, merchant_id, postal_code, region, street, validated, verified].hash
+      [address_sid, city, conversation_pbx_address_uuid, country_code, customer_name, friendly_name, merchant_id, postal_code, region, street, valid, validated, verified].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_available_phone_number.rb

@@ -30,6 +30,9 @@ module UltracartClient
     # MMS capability
     attr_accessor :mms
 
+    # Monthly cost for this phone number
+    attr_accessor :monthly_cost
+
     # Phone number in E.164 format
     attr_accessor :phone_number
 
@@ -72,6 +75,7 @@ module UltracartClient
         :'friendly_name' => :'friendly_name',
         :'locality' => :'locality',
         :'mms' => :'mms',
+        :'monthly_cost' => :'monthly_cost',
         :'phone_number' => :'phone_number',
         :'region' => :'region',
         :'sms' => :'sms',
@@ -92,6 +96,7 @@ module UltracartClient
         :'friendly_name' => :'String',
         :'locality' => :'String',
         :'mms' => :'Boolean',
+        :'monthly_cost' => :'Float',
         :'phone_number' => :'String',
         :'region' => :'String',
         :'sms' => :'Boolean',
@@ -140,6 +145,10 @@ module UltracartClient
         self.mms = attributes[:'mms']
       end
 
+      if attributes.key?(:'monthly_cost')
+        self.monthly_cost = attributes[:'monthly_cost']
+      end
+
       if attributes.key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
       end
@@ -267,6 +276,7 @@ module UltracartClient
           friendly_name == o.friendly_name &&
           locality == o.locality &&
           mms == o.mms &&
+          monthly_cost == o.monthly_cost &&
           phone_number == o.phone_number &&
           region == o.region &&
           sms == o.sms &&
@@ -282,7 +292,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address_requirements, country, friendly_name, locality, mms, phone_number, region, sms, voice].hash
+      [address_requirements, country, friendly_name, locality, mms, monthly_cost, phone_number, region, sms, voice].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_phone_number.rb

@@ -21,6 +21,9 @@ module UltracartClient
     # Action target.  This is the UUID associated with the configuration object of that particular type.
     attr_accessor :action_target
 
+    # Twilio Address SID linked to this phone number for regulatory compliance
+    attr_accessor :address_sid
+
     # Conversation Pbx Phone Number UUID
     attr_accessor :conversation_pbx_phone_number_uuid
 
@@ -60,6 +63,7 @@ module UltracartClient
       {
         :'action' => :'action',
         :'action_target' => :'action_target',
+        :'address_sid' => :'address_sid',
         :'conversation_pbx_phone_number_uuid' => :'conversation_pbx_phone_number_uuid',
         :'deletion_protected' => :'deletion_protected',
         :'merchant_id' => :'merchant_id',
@@ -77,6 +81,7 @@ module UltracartClient
       {
         :'action' => :'String',
         :'action_target' => :'String',
+        :'address_sid' => :'String',
         :'conversation_pbx_phone_number_uuid' => :'String',
         :'deletion_protected' => :'Boolean',
         :'merchant_id' => :'String',
@@ -113,6 +118,10 @@ module UltracartClient
         self.action_target = attributes[:'action_target']
       end
 
+      if attributes.key?(:'address_sid')
+        self.address_sid = attributes[:'address_sid']
+      end
+
       if attributes.key?(:'conversation_pbx_phone_number_uuid')
         self.conversation_pbx_phone_number_uuid = attributes[:'conversation_pbx_phone_number_uuid']
       end
@@ -142,6 +151,10 @@ module UltracartClient
         invalid_properties.push('invalid value for "action_target", the character length must be smaller than or equal to 50.')
       end
 
+      if !@address_sid.nil? && @address_sid.to_s.length > 50
+        invalid_properties.push('invalid value for "address_sid", the character length must be smaller than or equal to 50.')
+      end
+
       if !@conversation_pbx_phone_number_uuid.nil? && @conversation_pbx_phone_number_uuid.to_s.length > 50
         invalid_properties.push('invalid value for "conversation_pbx_phone_number_uuid", the character length must be smaller than or equal to 50.')
       end
@@ -164,6 +177,7 @@ module UltracartClient
       return false unless action_validator.valid?(@action)
       return false if !@action.nil? && @action.to_s.length > 30
       return false if !@action_target.nil? && @action_target.to_s.length > 50
+      return false if !@address_sid.nil? && @address_sid.to_s.length > 50
       return false if !@conversation_pbx_phone_number_uuid.nil? && @conversation_pbx_phone_number_uuid.to_s.length > 50
       return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
       return false if !@phone_number.nil? && @phone_number.to_s.length > 50
@@ -190,6 +204,16 @@ module UltracartClient
       @action_target = action_target
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] address_sid Value to be assigned
+    def address_sid=(address_sid)
+      if !address_sid.nil? && address_sid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "address_sid", the character length must be smaller than or equal to 50.'
+      end
+
+      @address_sid = address_sid
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] conversation_pbx_phone_number_uuid Value to be assigned
     def conversation_pbx_phone_number_uuid=(conversation_pbx_phone_number_uuid)
@@ -227,6 +251,7 @@ module UltracartClient
       self.class == o.class &&
           action == o.action &&
           action_target == o.action_target &&
+          address_sid == o.address_sid &&
           conversation_pbx_phone_number_uuid == o.conversation_pbx_phone_number_uuid &&
           deletion_protected == o.deletion_protected &&
           merchant_id == o.merchant_id &&
@@ -242,7 +267,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, action_target, conversation_pbx_phone_number_uuid, deletion_protected, merchant_id, phone_number].hash
+      [action, action_target, address_sid, conversation_pbx_phone_number_uuid, deletion_protected, merchant_id, phone_number].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_codes_request.rb

@@ -25,6 +25,9 @@ module UltracartClient
 
     attr_accessor :metadata
 
+    # Optional prefix for generated codes
+    attr_accessor :prefix
+
     # Quantity
     attr_accessor :quantity
 
@@ -40,6 +43,7 @@ module UltracartClient
         :'expiration_dts' => :'expiration_dts',
         :'expiration_seconds' => :'expiration_seconds',
         :'metadata' => :'metadata',
+        :'prefix' => :'prefix',
         :'quantity' => :'quantity',
         :'success' => :'success',
         :'warning' => :'warning'
@@ -58,6 +62,7 @@ module UltracartClient
         :'expiration_dts' => :'String',
         :'expiration_seconds' => :'Integer',
         :'metadata' => :'ResponseMetadata',
+        :'prefix' => :'String',
         :'quantity' => :'Integer',
         :'success' => :'Boolean',
         :'warning' => :'Warning'
@@ -101,6 +106,10 @@ module UltracartClient
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.key?(:'prefix')
+        self.prefix = attributes[:'prefix']
+      end
+
       if attributes.key?(:'quantity')
         self.quantity = attributes[:'quantity']
       end
@@ -118,15 +127,30 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@prefix.nil? && @prefix.to_s.length > 12
+        invalid_properties.push('invalid value for "prefix", the character length must be smaller than or equal to 12.')
+      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 !@prefix.nil? && @prefix.to_s.length > 12
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] prefix Value to be assigned
+    def prefix=(prefix)
+      if !prefix.nil? && prefix.to_s.length > 12
+        fail ArgumentError, 'invalid value for "prefix", the character length must be smaller than or equal to 12.'
+      end
+
+      @prefix = prefix
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -136,6 +160,7 @@ module UltracartClient
           expiration_dts == o.expiration_dts &&
           expiration_seconds == o.expiration_seconds &&
           metadata == o.metadata &&
+          prefix == o.prefix &&
           quantity == o.quantity &&
           success == o.success &&
           warning == o.warning
@@ -150,7 +175,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error, expiration_dts, expiration_seconds, metadata, quantity, success, warning].hash
+      [error, expiration_dts, expiration_seconds, metadata, prefix, quantity, success, warning].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.1.41'
+  VERSION = '4.1.43'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.41
+  version: 4.1.43
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-13 00:00:00.000000000 Z
+date: 2026-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus