ultracart_api 4.0.202 → 4.0.203

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e939a6711a94c20f3f4210b4c3a327d16fd53c492226a2bb7d12956d416e5a7
-  data.tar.gz: dd888c02f5c6df31e4f711ea06e87643a4899a1fa6a6889a922fb8136f3c97e6
+  metadata.gz: 2741f3ab5cd18a9833cadc8808fba3d863b042f81b7f5c681c838691c53239c6
+  data.tar.gz: b0ef5867ded4987ffd1df0286c5a33f21e1396c39444877a14b1bcb1e954140c
 SHA512:
-  metadata.gz: 7d6f11387fe4b45c7714eda8c849f56ebe8cb9f4ce55c376b5e53b01f50ee2e884a7c5aee881cbf3889fa40e1c8c37736451f855f4871cc3ab0029035c7f434f
-  data.tar.gz: c829fb8296b79c36e0aff60a6031b7827279fcaeb3a7c58c35aff565648bf44a3b9ff437c7ce18dd4d2d0226d1ebaab1c38196f04453df428bdb378de3d4372f
+  metadata.gz: 907343341ebb75dbf1292d6833886ba79d0340c23fcebfb0011595c9c2cc87689852e5367721de2604d160834f83b11b94a9c8f7421009c71d84038d0496e57b
+  data.tar.gz: 9a49b85125ae2377508cdcc2627bdf74191d91998ce2dab74f5fa4e1b62c3444817d2b048db46abf7ac275a616b0b9f7682fbc547ea19c119c8cf0c4db027ca1

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.202
+- Package version: 4.0.203
 - 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.202.gem
+gem install ./ultracart_api-4.0.203.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.202.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.203.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.202'
+    gem 'ultracart_api', '~> 4.0.203'
 
 ### Install from Git
 
@@ -562,6 +562,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::WebhookApi* | [**insert_webhook**](docs/WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook
 *UltracartClient::WebhookApi* | [**resend_event**](docs/WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint.
 *UltracartClient::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
+*UltracartClient::WorkflowApi* | [**get_workflow_agent_websocket_authorization**](docs/WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization
 *UltracartClient::WorkflowApi* | [**get_workflow_assignment_groups**](docs/WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
 *UltracartClient::WorkflowApi* | [**get_workflow_assignment_users**](docs/WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to
 *UltracartClient::WorkflowApi* | [**get_workflow_me**](docs/WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself
@@ -1398,6 +1399,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
  - [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
  - [UltracartClient::Weight](docs/Weight.md)
+ - [UltracartClient::WorkflowAgentAuth](docs/WorkflowAgentAuth.md)
+ - [UltracartClient::WorkflowAgentAuthResponse](docs/WorkflowAgentAuthResponse.md)
  - [UltracartClient::WorkflowAttachment](docs/WorkflowAttachment.md)
  - [UltracartClient::WorkflowAttachmentUploadUrl](docs/WorkflowAttachmentUploadUrl.md)
  - [UltracartClient::WorkflowAttachmentUploadUrlResponse](docs/WorkflowAttachmentUploadUrlResponse.md)
@@ -1488,6 +1491,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.203 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 4.0.202 | 03/08/2024 | added getWorkflowTaskTags method |
 | 4.0.201 | 02/27/2024 | esp - sms statistic layer |
 | 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |

data/docs/ConversationPbxQueue.md

@@ -22,6 +22,8 @@
 | **twilio_taskrouter_workflow_sid** | **String** | Twilio taskrouter workflow sid | [optional] |
 | **twilio_workspace_queue_sid** | **String** | Twilio workspace queue sid | [optional] |
 | **voicemail** | **Boolean** | If true, this queue has a voicemail associated with it | [optional] |
+| **wait_critical_seconds** | **Integer** | Wait time in seconds before critical | [optional] |
+| **wait_warning_seconds** | **Integer** | Wait time in seconds before warning | [optional] |
 
 ## Example
 
@@ -46,7 +48,9 @@ instance = UltracartClient::ConversationPbxQueue.new(
   say_voice: null,
   twilio_taskrouter_workflow_sid: null,
   twilio_workspace_queue_sid: null,
-  voicemail: null
+  voicemail: null,
+  wait_critical_seconds: null,
+  wait_warning_seconds: null
 )
 ```
 

data/docs/WorkflowAgentAuth.md

@@ -0,0 +1,22 @@
+# UltracartClient::WorkflowAgentAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowAgentAuth.new(
+  jwt: null,
+  merchant_id: null,
+  websocket_url: null
+)
+```
+

data/docs/WorkflowAgentAuthResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::WorkflowAgentAuthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_auth** | [**WorkflowAgentAuth**](WorkflowAgentAuth.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WorkflowAgentAuthResponse.new(
+  agent_auth: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/WorkflowApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**get_workflow_agent_websocket_authorization**](WorkflowApi.md#get_workflow_agent_websocket_authorization) | **PUT** /workflow/agent/auth | Get agent websocket authorization |
 | [**get_workflow_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to |
 | [**get_workflow_assignment_users**](WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to |
 | [**get_workflow_me**](WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself |
@@ -16,6 +17,74 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task |
 
 
+## get_workflow_agent_websocket_authorization
+
+> <WorkflowAgentAuthResponse> get_workflow_agent_websocket_authorization
+
+Get agent websocket authorization
+
+Retrieve a JWT to authorize an agent to make a websocket connection. 
+
+### 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::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Get agent websocket authorization
+  result = api_instance.get_workflow_agent_websocket_authorization
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization: #{e}"
+end
+```
+
+#### Using the get_workflow_agent_websocket_authorization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WorkflowAgentAuthResponse>, Integer, Hash)> get_workflow_agent_websocket_authorization_with_http_info
+
+```ruby
+begin
+  # Get agent websocket authorization
+  data, status_code, headers = api_instance.get_workflow_agent_websocket_authorization_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WorkflowAgentAuthResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WorkflowApi->get_workflow_agent_websocket_authorization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkflowAgentAuthResponse**](WorkflowAgentAuthResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_workflow_assignment_groups
 
 > <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)

data/lib/ultracart_api/api/workflow_api.rb

@@ -32,6 +32,64 @@ module UltracartClient
       UltracartClient::WorkflowApi.new(api_client)
     end
 
+    # Get agent websocket authorization
+    # Retrieve a JWT to authorize an agent to make a websocket connection. 
+    # @param [Hash] opts the optional parameters
+    # @return [WorkflowAgentAuthResponse]
+    def get_workflow_agent_websocket_authorization(opts = {})
+      data, _status_code, _headers = get_workflow_agent_websocket_authorization_with_http_info(opts)
+      data
+    end
+
+    # Get agent websocket authorization
+    # Retrieve a JWT to authorize an agent to make a websocket connection. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WorkflowAgentAuthResponse, Integer, Hash)>] WorkflowAgentAuthResponse data, response status code and response headers
+    def get_workflow_agent_websocket_authorization_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_agent_websocket_authorization ...'
+      end
+      # resource path
+      local_var_path = '/workflow/agent/auth'
+
+      # 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] || 'WorkflowAgentAuthResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowApi.get_workflow_agent_websocket_authorization",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve a list of groups that workflow tasks can be assigned to
     # Retrieve a list of groups that workflow tasks can be assigned to 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/conversation_pbx_queue.rb

@@ -68,6 +68,12 @@ module UltracartClient
     # If true, this queue has a voicemail associated with it
     attr_accessor :voicemail
 
+    # Wait time in seconds before critical
+    attr_accessor :wait_critical_seconds
+
+    # Wait time in seconds before warning
+    attr_accessor :wait_warning_seconds
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -88,7 +94,9 @@ module UltracartClient
         :'say_voice' => :'say_voice',
         :'twilio_taskrouter_workflow_sid' => :'twilio_taskrouter_workflow_sid',
         :'twilio_workspace_queue_sid' => :'twilio_workspace_queue_sid',
-        :'voicemail' => :'voicemail'
+        :'voicemail' => :'voicemail',
+        :'wait_critical_seconds' => :'wait_critical_seconds',
+        :'wait_warning_seconds' => :'wait_warning_seconds'
       }
     end
 
@@ -117,7 +125,9 @@ module UltracartClient
         :'say_voice' => :'String',
         :'twilio_taskrouter_workflow_sid' => :'String',
         :'twilio_workspace_queue_sid' => :'String',
-        :'voicemail' => :'Boolean'
+        :'voicemail' => :'Boolean',
+        :'wait_critical_seconds' => :'Integer',
+        :'wait_warning_seconds' => :'Integer'
       }
     end
 
@@ -213,6 +223,14 @@ module UltracartClient
       if attributes.key?(:'voicemail')
         self.voicemail = attributes[:'voicemail']
       end
+
+      if attributes.key?(:'wait_critical_seconds')
+        self.wait_critical_seconds = attributes[:'wait_critical_seconds']
+      end
+
+      if attributes.key?(:'wait_warning_seconds')
+        self.wait_warning_seconds = attributes[:'wait_warning_seconds']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -400,7 +418,9 @@ module UltracartClient
           say_voice == o.say_voice &&
           twilio_taskrouter_workflow_sid == o.twilio_taskrouter_workflow_sid &&
           twilio_workspace_queue_sid == o.twilio_workspace_queue_sid &&
-          voicemail == o.voicemail
+          voicemail == o.voicemail &&
+          wait_critical_seconds == o.wait_critical_seconds &&
+          wait_warning_seconds == o.wait_warning_seconds
     end
 
     # @see the `==` method
@@ -412,7 +432,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [announce_queue_position, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail].hash
+      [announce_queue_position, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/workflow_agent_auth.rb

@@ -0,0 +1,237 @@
+=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 WorkflowAgentAuth
+    attr_accessor :jwt
+
+    attr_accessor :merchant_id
+
+    attr_accessor :websocket_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'jwt' => :'jwt',
+        :'merchant_id' => :'merchant_id',
+        :'websocket_url' => :'websocket_url'
+      }
+    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
+      {
+        :'jwt' => :'String',
+        :'merchant_id' => :'String',
+        :'websocket_url' => :'String'
+      }
+    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::WorkflowAgentAuth` 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::WorkflowAgentAuth`. 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?(:'jwt')
+        self.jwt = attributes[:'jwt']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'websocket_url')
+        self.websocket_url = attributes[:'websocket_url']
+      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 &&
+          jwt == o.jwt &&
+          merchant_id == o.merchant_id &&
+          websocket_url == o.websocket_url
+    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
+      [jwt, merchant_id, websocket_url].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/workflow_agent_auth_response.rb

@@ -0,0 +1,256 @@
+=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 WorkflowAgentAuthResponse
+    attr_accessor :agent_auth
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'agent_auth' => :'agent_auth',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'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
+      {
+        :'agent_auth' => :'WorkflowAgentAuth',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'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::WorkflowAgentAuthResponse` 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::WorkflowAgentAuthResponse`. 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?(:'agent_auth')
+        self.agent_auth = attributes[:'agent_auth']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      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 &&
+          agent_auth == o.agent_auth &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          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
+      [agent_auth, error, metadata, success, 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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.202'
+  VERSION = '4.0.203'
 end

data/lib/ultracart_api.rb

@@ -839,6 +839,8 @@ require 'ultracart_api/models/webhook_sample_request'
 require 'ultracart_api/models/webhook_sample_request_response'
 require 'ultracart_api/models/webhooks_response'
 require 'ultracart_api/models/weight'
+require 'ultracart_api/models/workflow_agent_auth'
+require 'ultracart_api/models/workflow_agent_auth_response'
 require 'ultracart_api/models/workflow_attachment'
 require 'ultracart_api/models/workflow_attachment_upload_url'
 require 'ultracart_api/models/workflow_attachment_upload_url_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.202
+  version: 4.0.203
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -903,6 +903,8 @@ files:
 - docs/WebhookSampleRequestResponse.md
 - docs/WebhooksResponse.md
 - docs/Weight.md
+- docs/WorkflowAgentAuth.md
+- docs/WorkflowAgentAuthResponse.md
 - docs/WorkflowApi.md
 - docs/WorkflowAttachment.md
 - docs/WorkflowAttachmentUploadUrl.md
@@ -1767,6 +1769,8 @@ files:
 - lib/ultracart_api/models/webhook_sample_request_response.rb
 - lib/ultracart_api/models/webhooks_response.rb
 - lib/ultracart_api/models/weight.rb
+- lib/ultracart_api/models/workflow_agent_auth.rb
+- lib/ultracart_api/models/workflow_agent_auth_response.rb
 - lib/ultracart_api/models/workflow_attachment.rb
 - lib/ultracart_api/models/workflow_attachment_upload_url.rb
 - lib/ultracart_api/models/workflow_attachment_upload_url_response.rb