ultracart_api 3.11.51 → 3.11.54

data/lib/ultracart_api/api/conversation_api.rb

@@ -2793,6 +2793,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get pbx call record
+    # Retrieve a single PBX call record with full details 
+    # @param call_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxCallResponse]
+    def get_pbx_call(call_uuid, opts = {})
+      data, _status_code, _headers = get_pbx_call_with_http_info(call_uuid, opts)
+      data
+    end
+
+    # Get pbx call record
+    # Retrieve a single PBX call record with full details 
+    # @param call_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxCallResponse, Fixnum, Hash)>] ConversationPbxCallResponse data, response status code and response headers
+    def get_pbx_call_with_http_info(call_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_call ...'
+      end
+      # verify the required parameter 'call_uuid' is set
+      if @api_client.config.client_side_validation && call_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'call_uuid' when calling ConversationApi.get_pbx_call"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/call/{callUuid}'.sub('{' + 'callUuid' + '}', call_uuid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationPbxCallResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_pbx_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get pbx hardware phone
     # Retrieve a pbx hardware phone 
     # @param conversation_pbx_hardware_phone_uuid 
@@ -5143,6 +5198,70 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Search pbx call records
+    # Search and list PBX call records with filtering, sorting, and pagination 
+    # @param search_request Search Request
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_sort The sort order of the calls.
+    # @return [ConversationPbxCallSearchResponse]
+    def search_pbx_calls(search_request, opts = {})
+      data, _status_code, _headers = search_pbx_calls_with_http_info(search_request, opts)
+      data
+    end
+
+    # Search pbx call records
+    # Search and list PBX call records with filtering, sorting, and pagination 
+    # @param search_request Search Request
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_sort The sort order of the calls.
+    # @return [Array<(ConversationPbxCallSearchResponse, Fixnum, Hash)>] ConversationPbxCallSearchResponse data, response status code and response headers
+    def search_pbx_calls_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.search_pbx_calls ...'
+      end
+      # verify the required parameter 'search_request' is set
+      if @api_client.config.client_side_validation && search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_pbx_calls"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/call/search'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(search_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationPbxCallSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#search_pbx_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Unsubscribe any SMS participants in this conversation
     # Unsubscribe any SMS participants in this conversation 
     # @param conversation_uuid 

data/lib/ultracart_api/models/conversation_pbx_agent.rb

@@ -26,6 +26,9 @@ module UltracartClient
     # Conversation Pbx Agent unique identifier
     attr_accessor :conversation_pbx_agent_uuid
 
+    # The default phone number that this agent should dial out to the PSTN with.
+    attr_accessor :default_phone_number_uuid
+
     # Extension
     attr_accessor :extension
 
@@ -100,6 +103,7 @@ module UltracartClient
         :'call_routing_preference' => :'call_routing_preference',
         :'cellphone' => :'cellphone',
         :'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
+        :'default_phone_number_uuid' => :'default_phone_number_uuid',
         :'extension' => :'extension',
         :'full_name' => :'full_name',
         :'hardware_phone_uuids' => :'hardware_phone_uuids',
@@ -125,6 +129,7 @@ module UltracartClient
         :'call_routing_preference' => :'String',
         :'cellphone' => :'String',
         :'conversation_pbx_agent_uuid' => :'String',
+        :'default_phone_number_uuid' => :'String',
         :'extension' => :'Integer',
         :'full_name' => :'String',
         :'hardware_phone_uuids' => :'Array<String>',
@@ -167,6 +172,10 @@ module UltracartClient
         self.conversation_pbx_agent_uuid = attributes[:'conversation_pbx_agent_uuid']
       end
 
+      if attributes.has_key?(:'default_phone_number_uuid')
+        self.default_phone_number_uuid = attributes[:'default_phone_number_uuid']
+      end
+
       if attributes.has_key?(:'extension')
         self.extension = attributes[:'extension']
       end
@@ -369,6 +378,7 @@ module UltracartClient
           call_routing_preference == o.call_routing_preference &&
           cellphone == o.cellphone &&
           conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
+          default_phone_number_uuid == o.default_phone_number_uuid &&
           extension == o.extension &&
           full_name == o.full_name &&
           hardware_phone_uuids == o.hardware_phone_uuids &&
@@ -395,7 +405,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ai, call_routing_preference, cellphone, conversation_pbx_agent_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].hash
+      [ai, call_routing_preference, cellphone, conversation_pbx_agent_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].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_call.rb

@@ -0,0 +1,403 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationPbxCall
+    # Twilio account SID
+    attr_accessor :account_sid
+
+    # List of agents who participated in this call
+    attr_accessor :agents
+
+    # List of AI agent engagements during the call
+    attr_accessor :ai_agent_engagements
+
+    # Twilio call SID for the primary (customer) call leg
+    attr_accessor :call_sid
+
+    # Unique identifier for this call record
+    attr_accessor :call_uuid
+
+    attr_accessor :caller
+
+    # Twilio conference SID if this call used conferencing
+    attr_accessor :conference_sid
+
+    # Timestamp when the call record was created
+    attr_accessor :created_at_dts
+
+    # Customer name associated with this call
+    attr_accessor :customer_name
+
+    # UltraCart customer profile OID if the caller was matched to a customer
+    attr_accessor :customer_profile_oid
+
+    # Call disposition describing how the call ended
+    attr_accessor :disposition
+
+    # Email address of the caller if known
+    attr_accessor :email
+
+    attr_accessor :financial
+
+    # List of hold events during the call
+    attr_accessor :holds
+
+    # Merchant identifier
+    attr_accessor :merchant_id
+
+    # List of all Twilio recording SIDs associated with this call
+    attr_accessor :recording_sids
+
+    # List of recordings made during the call
+    attr_accessor :recordings
+
+    attr_accessor :routing
+
+    # Final status of the call
+    attr_accessor :status
+
+    attr_accessor :timeline
+
+    # List of transfer events during the call
+    attr_accessor :transfers
+
+    # Timestamp when the call record was last updated
+    attr_accessor :updated_at_dts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_sid' => :'account_sid',
+        :'agents' => :'agents',
+        :'ai_agent_engagements' => :'ai_agent_engagements',
+        :'call_sid' => :'call_sid',
+        :'call_uuid' => :'call_uuid',
+        :'caller' => :'caller',
+        :'conference_sid' => :'conference_sid',
+        :'created_at_dts' => :'created_at_dts',
+        :'customer_name' => :'customer_name',
+        :'customer_profile_oid' => :'customer_profile_oid',
+        :'disposition' => :'disposition',
+        :'email' => :'email',
+        :'financial' => :'financial',
+        :'holds' => :'holds',
+        :'merchant_id' => :'merchant_id',
+        :'recording_sids' => :'recording_sids',
+        :'recordings' => :'recordings',
+        :'routing' => :'routing',
+        :'status' => :'status',
+        :'timeline' => :'timeline',
+        :'transfers' => :'transfers',
+        :'updated_at_dts' => :'updated_at_dts'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'account_sid' => :'String',
+        :'agents' => :'Array<ConversationPbxCallAgent>',
+        :'ai_agent_engagements' => :'Array<ConversationPbxCallAiEngagement>',
+        :'call_sid' => :'String',
+        :'call_uuid' => :'String',
+        :'caller' => :'ConversationPbxCallCaller',
+        :'conference_sid' => :'String',
+        :'created_at_dts' => :'String',
+        :'customer_name' => :'String',
+        :'customer_profile_oid' => :'String',
+        :'disposition' => :'String',
+        :'email' => :'String',
+        :'financial' => :'ConversationPbxCallFinancial',
+        :'holds' => :'Array<ConversationPbxCallHold>',
+        :'merchant_id' => :'String',
+        :'recording_sids' => :'Array<String>',
+        :'recordings' => :'Array<ConversationPbxCallRecording>',
+        :'routing' => :'ConversationPbxCallRouting',
+        :'status' => :'String',
+        :'timeline' => :'ConversationPbxCallTimeline',
+        :'transfers' => :'Array<ConversationPbxCallTransfer>',
+        :'updated_at_dts' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'account_sid')
+        self.account_sid = attributes[:'account_sid']
+      end
+
+      if attributes.has_key?(:'agents')
+        if (value = attributes[:'agents']).is_a?(Array)
+          self.agents = value
+        end
+      end
+
+      if attributes.has_key?(:'ai_agent_engagements')
+        if (value = attributes[:'ai_agent_engagements']).is_a?(Array)
+          self.ai_agent_engagements = value
+        end
+      end
+
+      if attributes.has_key?(:'call_sid')
+        self.call_sid = attributes[:'call_sid']
+      end
+
+      if attributes.has_key?(:'call_uuid')
+        self.call_uuid = attributes[:'call_uuid']
+      end
+
+      if attributes.has_key?(:'caller')
+        self.caller = attributes[:'caller']
+      end
+
+      if attributes.has_key?(:'conference_sid')
+        self.conference_sid = attributes[:'conference_sid']
+      end
+
+      if attributes.has_key?(:'created_at_dts')
+        self.created_at_dts = attributes[:'created_at_dts']
+      end
+
+      if attributes.has_key?(:'customer_name')
+        self.customer_name = attributes[:'customer_name']
+      end
+
+      if attributes.has_key?(:'customer_profile_oid')
+        self.customer_profile_oid = attributes[:'customer_profile_oid']
+      end
+
+      if attributes.has_key?(:'disposition')
+        self.disposition = attributes[:'disposition']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'financial')
+        self.financial = attributes[:'financial']
+      end
+
+      if attributes.has_key?(:'holds')
+        if (value = attributes[:'holds']).is_a?(Array)
+          self.holds = value
+        end
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'recording_sids')
+        if (value = attributes[:'recording_sids']).is_a?(Array)
+          self.recording_sids = value
+        end
+      end
+
+      if attributes.has_key?(:'recordings')
+        if (value = attributes[:'recordings']).is_a?(Array)
+          self.recordings = value
+        end
+      end
+
+      if attributes.has_key?(:'routing')
+        self.routing = attributes[:'routing']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'timeline')
+        self.timeline = attributes[:'timeline']
+      end
+
+      if attributes.has_key?(:'transfers')
+        if (value = attributes[:'transfers']).is_a?(Array)
+          self.transfers = value
+        end
+      end
+
+      if attributes.has_key?(:'updated_at_dts')
+        self.updated_at_dts = attributes[:'updated_at_dts']
+      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 &&
+          account_sid == o.account_sid &&
+          agents == o.agents &&
+          ai_agent_engagements == o.ai_agent_engagements &&
+          call_sid == o.call_sid &&
+          call_uuid == o.call_uuid &&
+          caller == o.caller &&
+          conference_sid == o.conference_sid &&
+          created_at_dts == o.created_at_dts &&
+          customer_name == o.customer_name &&
+          customer_profile_oid == o.customer_profile_oid &&
+          disposition == o.disposition &&
+          email == o.email &&
+          financial == o.financial &&
+          holds == o.holds &&
+          merchant_id == o.merchant_id &&
+          recording_sids == o.recording_sids &&
+          recordings == o.recordings &&
+          routing == o.routing &&
+          status == o.status &&
+          timeline == o.timeline &&
+          transfers == o.transfers &&
+          updated_at_dts == o.updated_at_dts
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [account_sid, agents, ai_agent_engagements, call_sid, call_uuid, caller, conference_sid, created_at_dts, customer_name, customer_profile_oid, disposition, email, financial, holds, merchant_id, recording_sids, recordings, routing, status, timeline, transfers, updated_at_dts].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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