ultracart_api 3.11.8 → 3.11.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22827b8ab1175d8ee56620c7095bbbdbb1ee5ba0004c0697fca1b08dd60118cb
-  data.tar.gz: 359bbebb71978e5237d4e3cc2268e23d3f52f6b0f41de86361e9b12f048b99d0
+  metadata.gz: b0950ee1da1d3f836549d10b831d4c557db58cad6b044f03fdf90133e26185a4
+  data.tar.gz: e88b1a3639950ddc61c2690b55e2e23c5dda001f083a0aefd22e525459bf41b1
 SHA512:
-  metadata.gz: 165fef5da88b5f5c60c025c11c733b8476ae07e8e4e8e633ffd284a4ed8fccb456c550e1e15c7658d4ce2f22cdc3e8843f382cad5a69ae8027d458af1f9304cd
-  data.tar.gz: '083759c532517a888e44f974a006a2b6c0d547e53b06a9e233afc7eaf63d5be6a550f63b84879f54e50b3a67aca273c9f439e236a2bf96bfc1a6956c4d0c9037'
+  metadata.gz: c07fcd71688a50d7a6de1399acba13ad8f900de29fbe6fdb76f74838341d375cf1fd03e7793c02b6c37c3a27df07f969761d3deaf9caaceedcd09b2a60899c7a
+  data.tar.gz: b68fa90b5910a352d812970b3e7c175b7dcdbe98dad993dd626616cbed07c3bbbf6af9ae927a5a9cc65a5dce52379950e1cfec89476bcd597f633109f88d9ab8

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.11.8
+- Package version: 3.11.9
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.8.gem
+gem install ./ultracart_api-3.11.9.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.8.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.9.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', '~> 3.11.8'
+    gem 'ultracart_api', '~> 3.11.9'
 
 ### Install from Git
 
@@ -151,6 +151,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
 *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 *UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
+*UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
 *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
 *UltracartClient::ConversationApi* | [**get_conversation_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
@@ -726,6 +727,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationAgentProfile](docs/ConversationAgentProfile.md)
  - [UltracartClient::ConversationAgentProfileResponse](docs/ConversationAgentProfileResponse.md)
+ - [UltracartClient::ConversationAgentProfilesResponse](docs/ConversationAgentProfilesResponse.md)
  - [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
  - [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
  - [UltracartClient::ConversationAutocompleteValue](docs/ConversationAutocompleteValue.md)
@@ -1522,6 +1524,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
 | 3.11.8 | 04/22/2025 | order property fields for created_by and created_dts |
 | 3.11.7 | 04/21/2025 | conversation agent additional fields |
 | 3.11.6 | 04/16/2025 | added channel partner order item properties |

data/docs/ConversationAgentProfilesResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationAgentProfilesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_profiles** | [**Array<ConversationAgentProfile>**](ConversationAgentProfile.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] 
+
+

data/docs/ConversationApi.md

@@ -17,6 +17,7 @@ Method | HTTP request | Description
 [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
 [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
+[**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
 [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
 [**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
@@ -726,6 +727,51 @@ This endpoint does not need any parameter.
 
 
 
+# **get_agent_profiles**
+> ConversationAgentProfilesResponse get_agent_profiles
+
+Get agent profiles
+
+Retrieve the agents profile 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get agent profiles
+  result = api_instance.get_agent_profiles
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_agent_profiles: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationAgentProfilesResponse**](ConversationAgentProfilesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_agent_websocket_authorization**
 > ConversationAgentAuthResponse get_agent_websocket_authorization
 

data/docs/WebhookApi.md

@@ -186,6 +186,14 @@ api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false,
 webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
 
 opts = { 
+  request_id: 'request_id_example', # String | 
+  begin_date: 'begin_date_example', # String | 
+  end_date: 'end_date_example', # String | 
+  status: 'status_example', # String | 
+  event: 'event_example', # String | 
+  order_id: 'order_id_example', # String | 
+  request: 'request_example', # String | 
+  duration: 56, # Integer | 
   _limit: 100, # Integer | The maximum number of records to return on this one API call.
   _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
   _since: '_since_example' # String | Fetch log summaries that have been delivered since this date/time.
@@ -205,6 +213,14 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **webhook_oid** | **Integer**| The webhook oid to retrieve log summaries for. | 
+ **request_id** | **String**|  | [optional] 
+ **begin_date** | **String**|  | [optional] 
+ **end_date** | **String**|  | [optional] 
+ **status** | **String**|  | [optional] 
+ **event** | **String**|  | [optional] 
+ **order_id** | **String**|  | [optional] 
+ **request** | **String**|  | [optional] 
+ **duration** | **Integer**|  | [optional] 
  **_limit** | **Integer**| The maximum number of records to return on this one API call. | [optional] [default to 100]
  **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
  **_since** | **String**| Fetch log summaries that have been delivered since this date/time. | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -735,6 +735,55 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get agent profiles
+    # Retrieve the agents profile 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAgentProfilesResponse]
+    def get_agent_profiles(opts = {})
+      data, _status_code, _headers = get_agent_profiles_with_http_info(opts)
+      data
+    end
+
+    # Get agent profiles
+    # Retrieve the agents profile 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAgentProfilesResponse, Fixnum, Hash)>] ConversationAgentProfilesResponse data, response status code and response headers
+    def get_agent_profiles_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profiles ...'
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles'
+
+      # 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 => 'ConversationAgentProfilesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_agent_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get agent websocket authorization
     # Retrieve a JWT to authorize an agent to make a websocket connection. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/api/webhook_api.rb

@@ -206,6 +206,14 @@ module UltracartClient
     # Retrieves the log summary information for a given webhook.  This is useful for displaying all the various logs that can be viewed. 
     # @param webhook_oid The webhook oid to retrieve log summaries for.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :request_id 
+    # @option opts [String] :begin_date 
+    # @option opts [String] :end_date 
+    # @option opts [String] :status 
+    # @option opts [String] :event 
+    # @option opts [String] :order_id 
+    # @option opts [String] :request 
+    # @option opts [Integer] :duration 
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (default to 100)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
     # @option opts [String] :_since Fetch log summaries that have been delivered since this date/time.
@@ -219,6 +227,14 @@ module UltracartClient
     # Retrieves the log summary information for a given webhook.  This is useful for displaying all the various logs that can be viewed. 
     # @param webhook_oid The webhook oid to retrieve log summaries for.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :request_id 
+    # @option opts [String] :begin_date 
+    # @option opts [String] :end_date 
+    # @option opts [String] :status 
+    # @option opts [String] :event 
+    # @option opts [String] :order_id 
+    # @option opts [String] :request 
+    # @option opts [Integer] :duration 
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call.
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
     # @option opts [String] :_since Fetch log summaries that have been delivered since this date/time.
@@ -236,6 +252,14 @@ module UltracartClient
 
       # query parameters
       query_params = {}
+      query_params[:'requestId'] = opts[:'request_id'] if !opts[:'request_id'].nil?
+      query_params[:'beginDate'] = opts[:'begin_date'] if !opts[:'begin_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
+      query_params[:'orderId'] = opts[:'order_id'] if !opts[:'order_id'].nil?
+      query_params[:'request'] = opts[:'request'] if !opts[:'request'].nil?
+      query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
       query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
       query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
       query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?

data/lib/ultracart_api/models/conversation_agent_profiles_response.rb

@@ -0,0 +1,223 @@
+=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 ConversationAgentProfilesResponse
+    attr_accessor :agent_profiles
+
+    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_profiles' => :'agent_profiles',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'agent_profiles' => :'Array<ConversationAgentProfile>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    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?(:'agent_profiles')
+        if (value = attributes[:'agent_profiles']).is_a?(Array)
+          self.agent_profiles = value
+        end
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_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_profiles == o.agent_profiles &&
+          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 [Fixnum] Hash code
+    def hash
+      [agent_profiles, 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 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

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.11.8'
+  VERSION = '3.11.9'
 end

data/lib/ultracart_api.rb

@@ -152,6 +152,7 @@ require 'ultracart_api/models/conversation_agent_auth'
 require 'ultracart_api/models/conversation_agent_auth_response'
 require 'ultracart_api/models/conversation_agent_profile'
 require 'ultracart_api/models/conversation_agent_profile_response'
+require 'ultracart_api/models/conversation_agent_profiles_response'
 require 'ultracart_api/models/conversation_autocomplete_request'
 require 'ultracart_api/models/conversation_autocomplete_response'
 require 'ultracart_api/models/conversation_autocomplete_value'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.8
+  version: 3.11.9
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-22 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -361,6 +361,7 @@ files:
 - docs/ConversationAgentAuthResponse.md
 - docs/ConversationAgentProfile.md
 - docs/ConversationAgentProfileResponse.md
+- docs/ConversationAgentProfilesResponse.md
 - docs/ConversationApi.md
 - docs/ConversationAutocompleteRequest.md
 - docs/ConversationAutocompleteResponse.md
@@ -1262,6 +1263,7 @@ files:
 - lib/ultracart_api/models/conversation_agent_auth_response.rb
 - lib/ultracart_api/models/conversation_agent_profile.rb
 - lib/ultracart_api/models/conversation_agent_profile_response.rb
+- lib/ultracart_api/models/conversation_agent_profiles_response.rb
 - lib/ultracart_api/models/conversation_autocomplete_request.rb
 - lib/ultracart_api/models/conversation_autocomplete_response.rb
 - lib/ultracart_api/models/conversation_autocomplete_value.rb