ultracart_api 4.1.82 → 4.1.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aaed656cc976cd373c03c99e5256c57c34f96934b5f195e7c5bade723a61cf3
-  data.tar.gz: 5808b14252013fd02f424178ce1d21df042b5627feaba74b102b03bc8ef53e77
+  metadata.gz: 1177adf96617a66dfc650d8b776952341ecbb35bf8b47565f0599b9492d757c6
+  data.tar.gz: 61faba8f4763badcfcfec6426d61af2364af770e6e7ada5b1bc12b9864adb9e0
 SHA512:
-  metadata.gz: 2b08f8fc9f672f3755bf1395f567208a07a4a8064085a91487d2867f7fb97632017e31b273485ecb1762e05fc507fa36496f7cafd4d72d74030c05eeb5ab9e77
-  data.tar.gz: 7f5879c236d140b646dd17e7ce03939d80ed90cbc971b7590b61fc7e2cc19531b41eeeb082759092fe3bacf5c58987ab3da59c0a54b8908da5bcc163caeefa4a
+  metadata.gz: 2ae50759ae7726bf29ab35e75bf4aa900237e044b7761043eadd89977f33dc154bdc0d8c01ab841c1f97765e376488b01901d72e10fef8fd572545ae63c46803
+  data.tar.gz: 0f165c9562b4c27849ac7511e63514deea937bcab786ca240fa4ac5b90b7d4e6302ba8887df4bf0846fd60ef8766b497d06f755ae9a07aec75118b5a2ac1fe20

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.82
+- Package version: 4.1.83
 - 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.82'
+gem 'ultracart_api', '4.1.83'
 ```
 
 install:
@@ -1728,6 +1728,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
 | 4.1.82 | 04/27/2026 | converation - agent status and availability |
 | 4.1.81 | 04/27/2026 | conversations - agent status and availability |
 | 4.1.80 | 04/22/2026 | customer - e.164 read only fields on billing/shipping child objects |

data/docs/AutoOrderItemCancelRequest.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id. | [optional] |
+| **append_items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | Specifying these items allows for an easier immutable item contact.  Validation will occur before any operations take place.  After the end/remove operation is successful, append these additional item(s) to the auto order.  The changes will be available in the response if the expansion includes items. | [optional] |
+| **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id.  For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed. | [optional] |
 | **mode** | **String** | Cancellation mode.  'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting.  'remove' hard-deletes the item from the auto order.  Defaults to 'end' (the less destructive option) when omitted. | [optional] |
 
 ## Example
@@ -13,6 +14,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::AutoOrderItemCancelRequest.new(
+  append_items: null,
   auto_order_item_oid: null,
   mode: null
 )

data/docs/ConversationAgentStatusEvent.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **agent_identifier** | **String** | Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk. | [optional] |
 | **agent_name** | **String** | Agent display name at the time of the event | [optional] |
 | **agent_type** | **String** | Agent type | [optional] |
 | **agent_user_id** | **String** | Agent user id (links across channels) | [optional] |
@@ -27,6 +28,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationAgentStatusEvent.new(
+  agent_identifier: null,
   agent_name: null,
   agent_type: null,
   agent_user_id: null,

data/docs/ConversationPbxCallAgent.md

@@ -7,6 +7,7 @@
 | **agent_extension** | **String** | Agent's phone extension | [optional] |
 | **agent_id** | **String** | Unique identifier for the agent | [optional] |
 | **agent_name** | **String** | Display name of the agent | [optional] |
+| **agent_user_id** | **String** | UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login). | [optional] |
 | **answered** | **Boolean** | Whether the agent answered the call | [optional] |
 | **call_sid** | **String** | Twilio call SID for the agent's call leg | [optional] |
 | **joined_at_dts** | **String** | Timestamp when the agent joined the call | [optional] |
@@ -23,6 +24,7 @@ instance = UltracartClient::ConversationPbxCallAgent.new(
   agent_extension: null,
   agent_id: null,
   agent_name: null,
+  agent_user_id: null,
   answered: null,
   call_sid: null,
   joined_at_dts: null,

data/lib/ultracart_api/models/auto_order_item_cancel_request.rb

@@ -15,7 +15,10 @@ require 'time'
 
 module UltracartClient
   class AutoOrderItemCancelRequest
-    # Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id.
+    # Specifying these items allows for an easier immutable item contact.  Validation will occur before any operations take place.  After the end/remove operation is successful, append these additional item(s) to the auto order.  The changes will be available in the response if the expansion includes items.
+    attr_accessor :append_items
+
+    # Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id.  For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed.
     attr_accessor :auto_order_item_oid
 
     # Cancellation mode.  'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting.  'remove' hard-deletes the item from the auto order.  Defaults to 'end' (the less destructive option) when omitted.
@@ -46,6 +49,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'append_items' => :'append_items',
         :'auto_order_item_oid' => :'auto_order_item_oid',
         :'mode' => :'mode'
       }
@@ -59,6 +63,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'append_items' => :'Array<AutoOrderItem>',
         :'auto_order_item_oid' => :'Integer',
         :'mode' => :'String'
       }
@@ -85,6 +90,12 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'append_items')
+        if (value = attributes[:'append_items']).is_a?(Array)
+          self.append_items = value
+        end
+      end
+
       if attributes.key?(:'auto_order_item_oid')
         self.auto_order_item_oid = attributes[:'auto_order_item_oid']
       end
@@ -124,6 +135,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          append_items == o.append_items &&
           auto_order_item_oid == o.auto_order_item_oid &&
           mode == o.mode
     end
@@ -137,7 +149,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auto_order_item_oid, mode].hash
+      [append_items, auto_order_item_oid, mode].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_agent_status_event.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class ConversationAgentStatusEvent
+    # Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk.
+    attr_accessor :agent_identifier
+
     # Agent display name at the time of the event
     attr_accessor :agent_name
 
@@ -88,6 +91,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'agent_identifier' => :'agent_identifier',
         :'agent_name' => :'agent_name',
         :'agent_type' => :'agent_type',
         :'agent_user_id' => :'agent_user_id',
@@ -115,6 +119,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'agent_identifier' => :'String',
         :'agent_name' => :'String',
         :'agent_type' => :'String',
         :'agent_user_id' => :'String',
@@ -155,6 +160,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'agent_identifier')
+        self.agent_identifier = attributes[:'agent_identifier']
+      end
+
       if attributes.key?(:'agent_name')
         self.agent_name = attributes[:'agent_name']
       end
@@ -358,6 +367,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          agent_identifier == o.agent_identifier &&
           agent_name == o.agent_name &&
           agent_type == o.agent_type &&
           agent_user_id == o.agent_user_id &&
@@ -385,7 +395,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent_name, agent_type, agent_user_id, channel, custom_status_name, custom_status_uuid, duration_in_previous_seconds, event_dts, event_uuid, merchant_id, new_routing_effect, new_status, parent_merchant_id, previous_routing_effect, previous_status, trigger].hash
+      [agent_identifier, agent_name, agent_type, agent_user_id, channel, custom_status_name, custom_status_uuid, duration_in_previous_seconds, event_dts, event_uuid, merchant_id, new_routing_effect, new_status, parent_merchant_id, previous_routing_effect, previous_status, trigger].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_call_agent.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # Display name of the agent
     attr_accessor :agent_name
 
+    # UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login).
+    attr_accessor :agent_user_id
+
     # Whether the agent answered the call
     attr_accessor :answered
 
@@ -48,6 +51,7 @@ module UltracartClient
         :'agent_extension' => :'agent_extension',
         :'agent_id' => :'agent_id',
         :'agent_name' => :'agent_name',
+        :'agent_user_id' => :'agent_user_id',
         :'answered' => :'answered',
         :'call_sid' => :'call_sid',
         :'joined_at_dts' => :'joined_at_dts',
@@ -68,6 +72,7 @@ module UltracartClient
         :'agent_extension' => :'String',
         :'agent_id' => :'String',
         :'agent_name' => :'String',
+        :'agent_user_id' => :'String',
         :'answered' => :'Boolean',
         :'call_sid' => :'String',
         :'joined_at_dts' => :'String',
@@ -110,6 +115,10 @@ module UltracartClient
         self.agent_name = attributes[:'agent_name']
       end
 
+      if attributes.key?(:'agent_user_id')
+        self.agent_user_id = attributes[:'agent_user_id']
+      end
+
       if attributes.key?(:'answered')
         self.answered = attributes[:'answered']
       end
@@ -156,6 +165,7 @@ module UltracartClient
           agent_extension == o.agent_extension &&
           agent_id == o.agent_id &&
           agent_name == o.agent_name &&
+          agent_user_id == o.agent_user_id &&
           answered == o.answered &&
           call_sid == o.call_sid &&
           joined_at_dts == o.joined_at_dts &&
@@ -173,7 +183,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent_extension, agent_id, agent_name, answered, call_sid, joined_at_dts, left_at_dts, role, worker_sid].hash
+      [agent_extension, agent_id, agent_name, agent_user_id, answered, call_sid, joined_at_dts, left_at_dts, role, worker_sid].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.82'
+  VERSION = '4.1.83'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.82
+  version: 4.1.83
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 2026-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus