ultracart_api 3.10.196 → 3.10.197

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803da8ea91fc29479152b108e448463384fb0628ef534c607c52b26ce4e6e34c
-  data.tar.gz: 8750f128d900ef7873cb9cea1cdfeb173bcc7ebc4ed16025efb816856b5a49b0
+  metadata.gz: c1519448a2581646c1df92149e1448ae75f3b72230a89d0ba5eac03a7c37fb4d
+  data.tar.gz: 9f47e4439c01751013389cfcdad0c617fbac28ea900b9b041d0645e3338d7b0b
 SHA512:
-  metadata.gz: d86333aca0a9ee3046fa6747f094c321a393366d4c81c3b8ec33a74ae0258f723dfac75bd5f4516ebeb78d953ccc20f3ebd5c4c8c8240459712c679a9a5f1478
-  data.tar.gz: a371a8599c34f89604d33bbbfb63e41a94bfb234214e0444247cb925f8b3902665f542db442f2e738f079712e3fb044b7315ecff2ab7fb666b02f76d60bc9896
+  metadata.gz: 706698fe8f099dad4c01ac6f849f0a14858f3b1dd93be73aa75442083767f6958d4a6b3fbb18606b372a009564e1472f890bdcc5cb31e6d50dfb52154c94d370
+  data.tar.gz: c68f10c2ba06208aabc682dc2d9045818c98007f1d25d3a26e3a3c2f623057827f1106292b663686ffdff1597f2d4910d0fd0d0a931ed6408963dca3fc74fea6

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.10.196
+- Package version: 3.10.197
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.196.gem
+gem install ./ultracart_api-3.10.197.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.196.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.197.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.10.196'
+    gem 'ultracart_api', '~> 3.10.197'
 
 ### Install from Git
 
@@ -171,6 +171,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
 *UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
 *UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
+*UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
 *UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
 *UltracartClient::ConversationApi* | [**get_pbx_menu**](docs/ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
 *UltracartClient::ConversationApi* | [**get_pbx_menus**](docs/ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
@@ -760,6 +761,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationPbxAudioResponse](docs/ConversationPbxAudioResponse.md)
  - [UltracartClient::ConversationPbxAudioUploadUrl](docs/ConversationPbxAudioUploadUrl.md)
  - [UltracartClient::ConversationPbxAudioUploadUrlResponse](docs/ConversationPbxAudioUploadUrlResponse.md)
+ - [UltracartClient::ConversationPbxAudioUsageResponse](docs/ConversationPbxAudioUsageResponse.md)
  - [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
@@ -1503,6 +1505,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.197 | 05/02/2024 | conversation - new method to load pbx audio usage |
 | 3.10.196 | 05/02/2024 | autoorder - fields to record merge association and tstamp |
 | 3.10.195 | 05/01/2024 | getConversationPbxAudioUploadUrl - fix the response obj def |
 | 3.10.194 | 04/24/2024 | esp - add fields for external generation on email |

data/docs/ConversationApi.md

@@ -42,6 +42,7 @@ Method | HTTP request | Description
 [**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
 [**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
 [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
+[**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
 [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
 [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
 [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
@@ -1947,6 +1948,56 @@ Name | Type | Description  | Notes
 
 
 
+# **get_pbx_audio_usage**
+> ConversationPbxAudioUsageResponse get_pbx_audio_usage(conversation_pbx_audio_uuid)
+
+Get pbx audio usage
+
+Retrieve a pbx audio usage 
+
+### 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)
+
+
+conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String | 
+
+
+begin
+  #Get pbx audio usage
+  result = api_instance.get_pbx_audio_usage(conversation_pbx_audio_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_pbx_audio_usage: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_pbx_audio_uuid** | **String**|  | 
+
+### Return type
+
+[**ConversationPbxAudioUsageResponse**](ConversationPbxAudioUsageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_pbx_audios**
 > ConversationPbxAudiosResponse get_pbx_audios
 

data/docs/ConversationPbxAudioUsageResponse.md

@@ -0,0 +1,14 @@
+# UltracartClient::ConversationPbxAudioUsageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**menus** | [**Array<ConversationPbxMenu>**](ConversationPbxMenu.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**queues** | [**Array<ConversationPbxQueue>**](ConversationPbxQueue.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**voicemail_mailboxes** | [**Array<ConversationPbxVoicemailMailbox>**](ConversationPbxVoicemailMailbox.md) |  | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -2068,6 +2068,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get pbx audio usage
+    # Retrieve a pbx audio usage 
+    # @param conversation_pbx_audio_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudioUsageResponse]
+    def get_pbx_audio_usage(conversation_pbx_audio_uuid, opts = {})
+      data, _status_code, _headers = get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts)
+      data
+    end
+
+    # Get pbx audio usage
+    # Retrieve a pbx audio usage 
+    # @param conversation_pbx_audio_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudioUsageResponse, Fixnum, Hash)>] ConversationPbxAudioUsageResponse data, response status code and response headers
+    def get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audio_usage ...'
+      end
+      # verify the required parameter 'conversation_pbx_audio_uuid' is set
+      if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_pbx_audio_usage"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}/usage'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_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 => 'ConversationPbxAudioUsageResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audio_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get pbx audios
     # Retrieve pbx audios 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/conversation_pbx_audio_usage_response.rb

@@ -0,0 +1,245 @@
+=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 ConversationPbxAudioUsageResponse
+    attr_accessor :error
+
+    attr_accessor :menus
+
+    attr_accessor :metadata
+
+    attr_accessor :queues
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :voicemail_mailboxes
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'menus' => :'menus',
+        :'metadata' => :'metadata',
+        :'queues' => :'queues',
+        :'success' => :'success',
+        :'voicemail_mailboxes' => :'voicemail_mailboxes',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'menus' => :'Array<ConversationPbxMenu>',
+        :'metadata' => :'ResponseMetadata',
+        :'queues' => :'Array<ConversationPbxQueue>',
+        :'success' => :'BOOLEAN',
+        :'voicemail_mailboxes' => :'Array<ConversationPbxVoicemailMailbox>',
+        :'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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'menus')
+        if (value = attributes[:'menus']).is_a?(Array)
+          self.menus = value
+        end
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'queues')
+        if (value = attributes[:'queues']).is_a?(Array)
+          self.queues = value
+        end
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'voicemail_mailboxes')
+        if (value = attributes[:'voicemail_mailboxes']).is_a?(Array)
+          self.voicemail_mailboxes = value
+        end
+      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 &&
+          error == o.error &&
+          menus == o.menus &&
+          metadata == o.metadata &&
+          queues == o.queues &&
+          success == o.success &&
+          voicemail_mailboxes == o.voicemail_mailboxes &&
+          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
+      [error, menus, metadata, queues, success, voicemail_mailboxes, 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.10.196'
+  VERSION = '3.10.197'
 end

data/lib/ultracart_api.rb

@@ -194,6 +194,7 @@ require 'ultracart_api/models/conversation_pbx_audio'
 require 'ultracart_api/models/conversation_pbx_audio_response'
 require 'ultracart_api/models/conversation_pbx_audio_upload_url'
 require 'ultracart_api/models/conversation_pbx_audio_upload_url_response'
+require 'ultracart_api/models/conversation_pbx_audio_usage_response'
 require 'ultracart_api/models/conversation_pbx_audios_response'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_request'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_response'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.196
+  version: 3.10.197
 platform: ruby
 authors:
 - UltraCart
@@ -404,6 +404,7 @@ files:
 - docs/ConversationPbxAudioResponse.md
 - docs/ConversationPbxAudioUploadUrl.md
 - docs/ConversationPbxAudioUploadUrlResponse.md
+- docs/ConversationPbxAudioUsageResponse.md
 - docs/ConversationPbxAudiosResponse.md
 - docs/ConversationPbxCustomerSnapshotRequest.md
 - docs/ConversationPbxCustomerSnapshotResponse.md
@@ -1293,6 +1294,7 @@ files:
 - lib/ultracart_api/models/conversation_pbx_audio_response.rb
 - lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb
 - lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb
+- lib/ultracart_api/models/conversation_pbx_audio_usage_response.rb
 - lib/ultracart_api/models/conversation_pbx_audios_response.rb
 - lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb
 - lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb