ultracart_api 4.1.210 → 4.1.212

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01b5f98446f4cd7a17870cd2492a7909f7e890cee3d71e968937e3ea161e861
-  data.tar.gz: 4845b8436645b593f800f84e32313d14384e619d1d58c4dd0cddd066d2102648
+  metadata.gz: daa7439a4c2c9d9b5c10024beb9d848a7b728c9ff5d057a22923f9381802cf38
+  data.tar.gz: 5acd544d65144e915ecf68e29428ec9fd3ba8012fecbe54a992afa54b8fae08c
 SHA512:
-  metadata.gz: 8eae36df126bd5b1af621ae04b4db5243b507394ba0dc2d47a8f6c900b71a40a4a0c03fc66fa57839384b5da16e6f5bd0d20d9a0876ab16ff6cc12c7f4dac357
-  data.tar.gz: 9600f18f9314f9fcc61264cafdb0ccf00748f099d08c376a5148d5cc02cd927e0628eb565969dc3ba5f756f49f474866b2d19da8c1eb4e25aba4a8e075d3f035
+  metadata.gz: 9137149162a374efa7ab54e06cd729eae0046b7d82d08248d3e8fbfbb368098e57469ae74ce9a2cf3428e19acdddefe24c902a827c78abda8f0f89f0cb37ec91
+  data.tar.gz: 05c4be8139c905ef860a89b6c19ff9b3ed2557eef3975b3298a4720f538b37cda040b24861a92f5f3e9aea5270814ee6323f698b961c58af95f10119da73bae8

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.210
+- Package version: 4.1.212
 - 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.210'
+gem 'ultracart_api', '4.1.212'
 ```
 
 install:
@@ -572,6 +572,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_secret_kinds**](docs/SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects
 *UltracartClient::SfvbApi* | [**get_sfvb_secret_request**](docs/SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request
 *UltracartClient::SfvbApi* | [**get_sfvb_secret_requests**](docs/SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests
+*UltracartClient::SfvbApi* | [**get_sfvb_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
 *UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
 *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
 *UltracartClient::SfvbApi* | [**get_sfvb_test_orders**](docs/SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders
@@ -2106,6 +2107,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbSecretRequestCreate](docs/SfvbSecretRequestCreate.md)
  - [UltracartClient::SfvbSecretRequestsResponse](docs/SfvbSecretRequestsResponse.md)
  - [UltracartClient::SfvbSecretSink](docs/SfvbSecretSink.md)
+ - [UltracartClient::SfvbSequence](docs/SfvbSequence.md)
+ - [UltracartClient::SfvbSequenceBranch](docs/SfvbSequenceBranch.md)
+ - [UltracartClient::SfvbSequenceStep](docs/SfvbSequenceStep.md)
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
  - [UltracartClient::SfvbServerLogDetail](docs/SfvbServerLogDetail.md)
  - [UltracartClient::SfvbServerLogEntry](docs/SfvbServerLogEntry.md)
@@ -2323,6 +2327,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.212 | 10/27/2026 | conversation - pbx agent startup activity |
+| 4.1.211 | 10/27/2026 | sfvb internal testing |
 | 4.1.210 | 10/27/2026 | sfvb internal testing |
 | 4.1.209 | 10/27/2026 | sfvb internal testing |
 | 4.1.208 | 10/26/2026 | sfvb internal testing |

data/docs/ConversationAgentAuth.md

@@ -17,6 +17,7 @@
 | **parent_merchant_id** | **String** | The parent merchant ID for PBX. For non-linked merchants, equals merchant_id. | [optional] |
 | **pbx_admin** | **Boolean** |  | [optional] |
 | **pbx_jwt** | **String** |  | [optional] |
+| **pbx_startup_activity** | **String** | Status the agent starts in when the CRM loads | [optional] |
 | **pbx_supervisor** | **Boolean** |  | [optional] |
 | **pbx_user** | **Boolean** |  | [optional] |
 | **pbx_voice_identity** | **String** |  | [optional] |
@@ -46,6 +47,7 @@ instance = UltracartClient::ConversationAgentAuth.new(
   parent_merchant_id: null,
   pbx_admin: null,
   pbx_jwt: null,
+  pbx_startup_activity: null,
   pbx_supervisor: null,
   pbx_user: null,
   pbx_voice_identity: null,

data/docs/ConversationPbxAgent.md

@@ -19,6 +19,7 @@
 | **preferred_hardware_phone_uuid** | **String** | The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone | [optional] |
 | **record_outgoing_automatically** | **Boolean** | True if outgoing calls should be automatically recorded | [optional] |
 | **shared_conversation_pbx_voicemail_mailbox_uuid** | **String** | Shared Conversation Pbx Voicemail Mailbox UUID | [optional] |
+| **startup_activity** | **String** | Status the agent starts in when the CRM loads. Missing means available. | [optional] |
 | **twilio_taskrouter_worker_id** | **String** | Twilio taskrouter worker Id | [optional] |
 | **unavailable_play_audio_uuid** | **String** | Unavailable play audio UUID | [optional] |
 | **unavailable_say** | **String** | Unavailable say | [optional] |
@@ -49,6 +50,7 @@ instance = UltracartClient::ConversationPbxAgent.new(
   preferred_hardware_phone_uuid: null,
   record_outgoing_automatically: null,
   shared_conversation_pbx_voicemail_mailbox_uuid: null,
+  startup_activity: null,
   twilio_taskrouter_worker_id: null,
   unavailable_play_audio_uuid: null,
   unavailable_say: null,

data/docs/SfvbApi.md

@@ -100,6 +100,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_secret_kinds**](SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects |
 | [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
 | [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
+| [**get_sfvb_sequence**](SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree |
 | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
 | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
 | [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
@@ -5415,6 +5416,61 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_sfvb_sequence
+
+> <SfvbSequence> get_sfvb_sequence(storefront_oid, sequence_uuid, opts)
+
+Get a campaign's or flow's steps as a tree
+
+The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_sequence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSequence>, Integer, Hash)> get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts)
+
+```ruby
+begin
+  # Get a campaign's or flow's steps as a tree
+  data, status_code, headers = api_instance.get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSequence>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_sequence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **sequence_uuid** | **String** |  |  |
+| **waiting** | **Boolean** | Include how many customers are waiting on each step | [optional] |
+
+### Return type
+
+[**SfvbSequence**](SfvbSequence.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_server_log
 
 > <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)

data/docs/SfvbSequence.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbSequence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **communication_sequence_uuid** | **String** | The sequence uuid. | [optional] |
+| **live** | **Boolean** | True when its emails and postcards reach customers now. | [optional] |
+| **notes** | **Array<String>** | Anything the read could not do, such as waiting counts that were unavailable. | [optional] |
+| **owner_name** | **String** | The campaign or flow name. | [optional] |
+| **owner_status** | **String** | The campaign or flow status. | [optional] |
+| **owner_type** | **String** | campaign or flow. | [optional] |
+| **owner_uuid** | **String** | The campaign or flow uuid. | [optional] |
+| **steps** | [**Array<SfvbSequenceStep>**](SfvbSequenceStep.md) | The steps from the start, in order.  A branching step holds its sides in branches. | [optional] |
+| **waiting_included** | **Boolean** | True when number_waiting was filled in. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequence.new(
+  communication_sequence_uuid: null,
+  live: null,
+  notes: null,
+  owner_name: null,
+  owner_status: null,
+  owner_type: null,
+  owner_uuid: null,
+  steps: null,
+  waiting_included: null
+)
+```
+

data/docs/SfvbSequenceBranch.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSequenceBranch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | yes or no for a condition, left or right for a split or an InboxGeek step. | [optional] |
+| **steps** | [**Array<SfvbSequenceStep>**](SfvbSequenceStep.md) | The steps on this side, in order. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceBranch.new(
+  label: null,
+  steps: null
+)
+```
+

data/docs/SfvbSequenceStep.md

@@ -0,0 +1,50 @@
+# UltracartClient::SfvbSequenceStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **branches** | [**Array<SfvbSequenceBranch>**](SfvbSequenceBranch.md) | Its two sides, for a condition, split or InboxGeek step.  Absent for every other type. | [optional] |
+| **config_error** | **Boolean** | True when the step's settings could not be read. | [optional] |
+| **config_json** | **String** | The step's settings as the admin stores them.  A webhook's header and parameter values are masked. | [optional] |
+| **config_merchant_notes** | **String** | A note stored inside the step's settings, when there is one. | [optional] |
+| **disabled** | **Boolean** | True when the step is switched off in its settings. | [optional] |
+| **email_uuids** | **Array<String>** | The emails it sends.  One for an email step, one per variant for an experiment. | [optional] |
+| **filter_profile_equation_json** | **String** | The step's audience filter as stored, when it has one. | [optional] |
+| **item_ids** | **Array<String>** | The items it names, for a cart or rate limiter step. | [optional] |
+| **label** | **String** | The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know. | [optional] |
+| **list_uuids** | **Array<String>** | The lists it subscribes or unsubscribes, for a list step. | [optional] |
+| **merchant_notes** | **String** | The note stored on the step. | [optional] |
+| **name** | **String** | The step's own display name from its settings, when it has one. | [optional] |
+| **number_waiting** | **Integer** | How many customers are waiting on this step now.  Only when waiting counts were asked for. | [optional] |
+| **postcard_uuid** | **String** | The postcard it sends, for a postcard step. | [optional] |
+| **step_uuid** | **String** | The step uuid. | [optional] |
+| **type** | **String** | The step type, such as email, wait, condition or webhook. | [optional] |
+| **unreachable** | **Boolean** | True for a step no branch leads to.  Listed at the end so nothing is hidden. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSequenceStep.new(
+  branches: null,
+  config_error: null,
+  config_json: null,
+  config_merchant_notes: null,
+  disabled: null,
+  email_uuids: null,
+  filter_profile_equation_json: null,
+  item_ids: null,
+  label: null,
+  list_uuids: null,
+  merchant_notes: null,
+  name: null,
+  number_waiting: null,
+  postcard_uuid: null,
+  step_uuid: null,
+  type: null,
+  unreachable: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -6886,6 +6886,79 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a campaign's or flow's steps as a tree
+    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :waiting Include how many customers are waiting on each step
+    # @return [SfvbSequence]
+    def get_sfvb_sequence(storefront_oid, sequence_uuid, opts = {})
+      data, _status_code, _headers = get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts)
+      data
+    end
+
+    # Get a campaign's or flow's steps as a tree
+    # The communication sequence named by a campaign's or flow's communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin's label, its settings (a webhook's header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :waiting Include how many customers are waiting on each step
+    # @return [Array<(SfvbSequence, Integer, Hash)>] SfvbSequence data, response status code and response headers
+    def get_sfvb_sequence_with_http_info(storefront_oid, sequence_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_sequence ...'
+      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 SfvbApi.get_sfvb_sequence"
+      end
+      # verify the required parameter 'sequence_uuid' is set
+      if @api_client.config.client_side_validation && sequence_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.get_sfvb_sequence"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'waiting'] = opts[:'waiting'] if !opts[:'waiting'].nil?
+
+      # 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] || 'SfvbSequence'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_sequence",
+        :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: SfvbApi#get_sfvb_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get one storefront render log
     # One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/conversation_agent_auth.rb

@@ -45,6 +45,9 @@ module UltracartClient
 
     attr_accessor :pbx_jwt
 
+    # Status the agent starts in when the CRM loads
+    attr_accessor :pbx_startup_activity
+
     attr_accessor :pbx_supervisor
 
     attr_accessor :pbx_user
@@ -64,6 +67,28 @@ module UltracartClient
 
     attr_accessor :websocket_url
 
+    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
       {
@@ -80,6 +105,7 @@ module UltracartClient
         :'parent_merchant_id' => :'parent_merchant_id',
         :'pbx_admin' => :'pbx_admin',
         :'pbx_jwt' => :'pbx_jwt',
+        :'pbx_startup_activity' => :'pbx_startup_activity',
         :'pbx_supervisor' => :'pbx_supervisor',
         :'pbx_user' => :'pbx_user',
         :'pbx_voice_identity' => :'pbx_voice_identity',
@@ -113,6 +139,7 @@ module UltracartClient
         :'parent_merchant_id' => :'String',
         :'pbx_admin' => :'Boolean',
         :'pbx_jwt' => :'String',
+        :'pbx_startup_activity' => :'String',
         :'pbx_supervisor' => :'Boolean',
         :'pbx_user' => :'Boolean',
         :'pbx_voice_identity' => :'String',
@@ -202,6 +229,10 @@ module UltracartClient
         self.pbx_jwt = attributes[:'pbx_jwt']
       end
 
+      if attributes.key?(:'pbx_startup_activity')
+        self.pbx_startup_activity = attributes[:'pbx_startup_activity']
+      end
+
       if attributes.key?(:'pbx_supervisor')
         self.pbx_supervisor = attributes[:'pbx_supervisor']
       end
@@ -251,9 +282,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      pbx_startup_activity_validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      return false unless pbx_startup_activity_validator.valid?(@pbx_startup_activity)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pbx_startup_activity Object to be assigned
+    def pbx_startup_activity=(pbx_startup_activity)
+      validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      unless validator.valid?(pbx_startup_activity)
+        fail ArgumentError, "invalid value for \"pbx_startup_activity\", must be one of #{validator.allowable_values}."
+      end
+      @pbx_startup_activity = pbx_startup_activity
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -272,6 +315,7 @@ module UltracartClient
           parent_merchant_id == o.parent_merchant_id &&
           pbx_admin == o.pbx_admin &&
           pbx_jwt == o.pbx_jwt &&
+          pbx_startup_activity == o.pbx_startup_activity &&
           pbx_supervisor == o.pbx_supervisor &&
           pbx_user == o.pbx_user &&
           pbx_voice_identity == o.pbx_voice_identity &&
@@ -292,7 +336,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chat_admin, chat_user, conversation_participant_arn, conversation_participant_name, customer_profile, default_phone_number, group_ids, jwt, merchant_id, merchants, parent_merchant_id, pbx_admin, pbx_jwt, pbx_supervisor, pbx_user, pbx_voice_identity, pbx_voice_token, pbx_worker_token, pbx_worker_token_v2, twilio_accounts, user_id, websocket_url].hash
+      [chat_admin, chat_user, conversation_participant_arn, conversation_participant_name, customer_profile, default_phone_number, group_ids, jwt, merchant_id, merchants, parent_merchant_id, pbx_admin, pbx_jwt, pbx_startup_activity, pbx_supervisor, pbx_user, pbx_voice_identity, pbx_voice_token, pbx_worker_token, pbx_worker_token_v2, twilio_accounts, user_id, websocket_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -60,6 +60,9 @@ module UltracartClient
     # Shared Conversation Pbx Voicemail Mailbox UUID
     attr_accessor :shared_conversation_pbx_voicemail_mailbox_uuid
 
+    # Status the agent starts in when the CRM loads. Missing means available.
+    attr_accessor :startup_activity
+
     # Twilio taskrouter worker Id
     attr_accessor :twilio_taskrouter_worker_id
 
@@ -124,6 +127,7 @@ module UltracartClient
         :'preferred_hardware_phone_uuid' => :'preferred_hardware_phone_uuid',
         :'record_outgoing_automatically' => :'record_outgoing_automatically',
         :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'shared_conversation_pbx_voicemail_mailbox_uuid',
+        :'startup_activity' => :'startup_activity',
         :'twilio_taskrouter_worker_id' => :'twilio_taskrouter_worker_id',
         :'unavailable_play_audio_uuid' => :'unavailable_play_audio_uuid',
         :'unavailable_say' => :'unavailable_say',
@@ -158,6 +162,7 @@ module UltracartClient
         :'preferred_hardware_phone_uuid' => :'String',
         :'record_outgoing_automatically' => :'Boolean',
         :'shared_conversation_pbx_voicemail_mailbox_uuid' => :'String',
+        :'startup_activity' => :'String',
         :'twilio_taskrouter_worker_id' => :'String',
         :'unavailable_play_audio_uuid' => :'String',
         :'unavailable_say' => :'String',
@@ -252,6 +257,10 @@ module UltracartClient
         self.shared_conversation_pbx_voicemail_mailbox_uuid = attributes[:'shared_conversation_pbx_voicemail_mailbox_uuid']
       end
 
+      if attributes.key?(:'startup_activity')
+        self.startup_activity = attributes[:'startup_activity']
+      end
+
       if attributes.key?(:'twilio_taskrouter_worker_id')
         self.twilio_taskrouter_worker_id = attributes[:'twilio_taskrouter_worker_id']
       end
@@ -333,6 +342,8 @@ module UltracartClient
       return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
       return false if !@personal_conversation_pbx_voicemail_mailbox_uuid.nil? && @personal_conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
       return false if !@shared_conversation_pbx_voicemail_mailbox_uuid.nil? && @shared_conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
+      startup_activity_validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      return false unless startup_activity_validator.valid?(@startup_activity)
       return false if !@twilio_taskrouter_worker_id.nil? && @twilio_taskrouter_worker_id.to_s.length > 100
       return false if !@unavailable_play_audio_uuid.nil? && @unavailable_play_audio_uuid.to_s.length > 50
       unavailable_say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
@@ -392,6 +403,16 @@ module UltracartClient
       @shared_conversation_pbx_voicemail_mailbox_uuid = shared_conversation_pbx_voicemail_mailbox_uuid
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] startup_activity Object to be assigned
+    def startup_activity=(startup_activity)
+      validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
+      unless validator.valid?(startup_activity)
+        fail ArgumentError, "invalid value for \"startup_activity\", must be one of #{validator.allowable_values}."
+      end
+      @startup_activity = startup_activity
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] twilio_taskrouter_worker_id Value to be assigned
     def twilio_taskrouter_worker_id=(twilio_taskrouter_worker_id)
@@ -452,6 +473,7 @@ module UltracartClient
           preferred_hardware_phone_uuid == o.preferred_hardware_phone_uuid &&
           record_outgoing_automatically == o.record_outgoing_automatically &&
           shared_conversation_pbx_voicemail_mailbox_uuid == o.shared_conversation_pbx_voicemail_mailbox_uuid &&
+          startup_activity == o.startup_activity &&
           twilio_taskrouter_worker_id == o.twilio_taskrouter_worker_id &&
           unavailable_play_audio_uuid == o.unavailable_play_audio_uuid &&
           unavailable_say == o.unavailable_say &&
@@ -471,7 +493,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ai, call_routing_preference, cellphone, conversation_pbx_agent_uuid, cos_uuid, default_phone_number_uuid, extension, full_name, hardware_phone_uuids, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, preferred_hardware_phone_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail, zoho_desk_outbound_department_id, zoho_desk_outbound_ticket_enabled].hash
+      [ai, call_routing_preference, cellphone, conversation_pbx_agent_uuid, cos_uuid, default_phone_number_uuid, extension, full_name, hardware_phone_uuids, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, preferred_hardware_phone_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, startup_activity, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail, zoho_desk_outbound_department_id, zoho_desk_outbound_ticket_enabled].hash
     end
 
     # Builds the object from hash