ultracart_api 4.0.201 → 4.0.203

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
@@ -416,6 +474,64 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a list of existing workflow task tags
+    # Retrieves a unique list of all the existing workflow task tags. 
+    # @param [Hash] opts the optional parameters
+    # @return [WorkflowTaskTagsResponse]
+    def get_workflow_task_tags(opts = {})
+      data, _status_code, _headers = get_workflow_task_tags_with_http_info(opts)
+      data
+    end
+
+    # Get a list of existing workflow task tags
+    # Retrieves a unique list of all the existing workflow task tags. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WorkflowTaskTagsResponse, Integer, Hash)>] WorkflowTaskTagsResponse data, response status code and response headers
+    def get_workflow_task_tags_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_task_tags ...'
+      end
+      # resource path
+      local_var_path = '/workflow/tasks/tags'
+
+      # 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] || 'WorkflowTaskTagsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowApi.get_workflow_task_tags",
+        :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: WorkflowApi#get_workflow_task_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search workflow tasks
     # Retrieves a set of workflow tasks from the account based on a query object. 
     # @param workflow_tasks_query [WorkflowTasksRequest] Workflow tasks query

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -0,0 +1,360 @@
+=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 ConversationPbxAgent
+    # Cellphone number of agent in E.164 format
+    attr_accessor :cellphone
+
+    # Conversation Pbx Agent unique identifier
+    attr_accessor :conversation_pbx_agent_uuid
+
+    # Conversation Pbx Voicemail Mailbox UUID
+    attr_accessor :conversation_pbx_voicemail_mailbox_uuid
+
+    # True if calls to this agent should be forwarded to their cellphone
+    attr_accessor :forward_calls_to_cellphone
+
+    # Merchant Id
+    attr_accessor :merchant_id
+
+    # True if outgoing calls should be automatically recorded
+    attr_accessor :record_outgoing_automatically
+
+    # Twilio taskrouter worker Id
+    attr_accessor :twilio_taskrouter_worker_id
+
+    # User Id
+    attr_accessor :user_id
+
+    # True if this agent has voicemail configured
+    attr_accessor :voicemail
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cellphone' => :'cellphone',
+        :'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
+        :'conversation_pbx_voicemail_mailbox_uuid' => :'conversation_pbx_voicemail_mailbox_uuid',
+        :'forward_calls_to_cellphone' => :'forward_calls_to_cellphone',
+        :'merchant_id' => :'merchant_id',
+        :'record_outgoing_automatically' => :'record_outgoing_automatically',
+        :'twilio_taskrouter_worker_id' => :'twilio_taskrouter_worker_id',
+        :'user_id' => :'user_id',
+        :'voicemail' => :'voicemail'
+      }
+    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
+      {
+        :'cellphone' => :'String',
+        :'conversation_pbx_agent_uuid' => :'String',
+        :'conversation_pbx_voicemail_mailbox_uuid' => :'String',
+        :'forward_calls_to_cellphone' => :'Boolean',
+        :'merchant_id' => :'String',
+        :'record_outgoing_automatically' => :'Boolean',
+        :'twilio_taskrouter_worker_id' => :'String',
+        :'user_id' => :'Integer',
+        :'voicemail' => :'Boolean'
+      }
+    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::ConversationPbxAgent` 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::ConversationPbxAgent`. 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?(:'cellphone')
+        self.cellphone = attributes[:'cellphone']
+      end
+
+      if attributes.key?(:'conversation_pbx_agent_uuid')
+        self.conversation_pbx_agent_uuid = attributes[:'conversation_pbx_agent_uuid']
+      end
+
+      if attributes.key?(:'conversation_pbx_voicemail_mailbox_uuid')
+        self.conversation_pbx_voicemail_mailbox_uuid = attributes[:'conversation_pbx_voicemail_mailbox_uuid']
+      end
+
+      if attributes.key?(:'forward_calls_to_cellphone')
+        self.forward_calls_to_cellphone = attributes[:'forward_calls_to_cellphone']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'record_outgoing_automatically')
+        self.record_outgoing_automatically = attributes[:'record_outgoing_automatically']
+      end
+
+      if attributes.key?(:'twilio_taskrouter_worker_id')
+        self.twilio_taskrouter_worker_id = attributes[:'twilio_taskrouter_worker_id']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'voicemail')
+        self.voicemail = attributes[:'voicemail']
+      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
+      if !@cellphone.nil? && @cellphone.to_s.length > 50
+        invalid_properties.push('invalid value for "cellphone", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@conversation_pbx_voicemail_mailbox_uuid.nil? && @conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
+        invalid_properties.push('invalid value for "conversation_pbx_voicemail_mailbox_uuid", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@merchant_id.nil? && @merchant_id.to_s.length > 5
+        invalid_properties.push('invalid value for "merchant_id", the character length must be smaller than or equal to 5.')
+      end
+
+      if !@twilio_taskrouter_worker_id.nil? && @twilio_taskrouter_worker_id.to_s.length > 100
+        invalid_properties.push('invalid value for "twilio_taskrouter_worker_id", the character length must be smaller than or equal to 100.')
+      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 !@cellphone.nil? && @cellphone.to_s.length > 50
+      return false if !@conversation_pbx_voicemail_mailbox_uuid.nil? && @conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
+      return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
+      return false if !@twilio_taskrouter_worker_id.nil? && @twilio_taskrouter_worker_id.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cellphone Value to be assigned
+    def cellphone=(cellphone)
+      if !cellphone.nil? && cellphone.to_s.length > 50
+        fail ArgumentError, 'invalid value for "cellphone", the character length must be smaller than or equal to 50.'
+      end
+
+      @cellphone = cellphone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] conversation_pbx_voicemail_mailbox_uuid Value to be assigned
+    def conversation_pbx_voicemail_mailbox_uuid=(conversation_pbx_voicemail_mailbox_uuid)
+      if !conversation_pbx_voicemail_mailbox_uuid.nil? && conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "conversation_pbx_voicemail_mailbox_uuid", the character length must be smaller than or equal to 50.'
+      end
+
+      @conversation_pbx_voicemail_mailbox_uuid = conversation_pbx_voicemail_mailbox_uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] merchant_id Value to be assigned
+    def merchant_id=(merchant_id)
+      if !merchant_id.nil? && merchant_id.to_s.length > 5
+        fail ArgumentError, 'invalid value for "merchant_id", the character length must be smaller than or equal to 5.'
+      end
+
+      @merchant_id = merchant_id
+    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)
+      if !twilio_taskrouter_worker_id.nil? && twilio_taskrouter_worker_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "twilio_taskrouter_worker_id", the character length must be smaller than or equal to 100.'
+      end
+
+      @twilio_taskrouter_worker_id = twilio_taskrouter_worker_id
+    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 &&
+          cellphone == o.cellphone &&
+          conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
+          conversation_pbx_voicemail_mailbox_uuid == o.conversation_pbx_voicemail_mailbox_uuid &&
+          forward_calls_to_cellphone == o.forward_calls_to_cellphone &&
+          merchant_id == o.merchant_id &&
+          record_outgoing_automatically == o.record_outgoing_automatically &&
+          twilio_taskrouter_worker_id == o.twilio_taskrouter_worker_id &&
+          user_id == o.user_id &&
+          voicemail == o.voicemail
+    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
+      [cellphone, conversation_pbx_agent_uuid, conversation_pbx_voicemail_mailbox_uuid, forward_calls_to_cellphone, merchant_id, record_outgoing_automatically, twilio_taskrouter_worker_id, user_id, voicemail].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