ultracart_api 4.1.71 → 4.1.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3509f1bbed3d909218c3b613ee45440ce00c259d88e6b5ea29511af2b45ee3c5
4
- data.tar.gz: 95c8c23311dc0fd905f76a946d6bb0d0948fb8b347294a4bb4dd286c149210e2
3
+ metadata.gz: 4bf651f3c35e969505f1e9aa6fde9a7b7c32671fe1163754aa36d32033d2c028
4
+ data.tar.gz: 79da60e733be44597252b9dd0c064deb3a305ed85589972da9591886d19802dc
5
5
  SHA512:
6
- metadata.gz: b887af1f00b28af8be4fa98638e323092c11d3afc2607c68473f6ce6e1e195012817e3873a1a2f1b98f5680eb551a35390f68e95470107be7c90f95673d247f2
7
- data.tar.gz: a28cfe2dbc3be03c66b3f698a7ec445544458bc4ef5c746f8271f3d4aa0207ea2fedb59bb98aa24cbc7abfc5a9f20324e9d5e6baee35ab4c16dc923ca160070a
6
+ metadata.gz: ce8cde54f86df8d62aa28cee6a142c3f9f651196714fb3d96091ed01fc2fdc51a3fbe3b609e66abbec1099ff0721769c890771cb9ef39e46601d66c29c70e366
7
+ data.tar.gz: f0f27c480eba36cb43c190a6fe71d13274b72f5bdf9f63b02c23b456eaf4eec570d193d0c863572a5cd46a645a34c072089b96741dae033ac23a19e5c7f7330f
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.71
10
+ - Package version: 4.1.72
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.71'
19
+ gem 'ultracart_api', '4.1.72'
20
20
  ```
21
21
 
22
22
  install:
@@ -205,6 +205,7 @@ Class | Method | HTTP request | Description
205
205
  *UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
206
206
  *UltracartClient::ConversationApi* | [**get_pbx_time_range**](docs/ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange
207
207
  *UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
208
+ *UltracartClient::ConversationApi* | [**get_pbx_voicemail_capabilities**](docs/ConversationApi.md#get_pbx_voicemail_capabilities) | **GET** /conversation/pbx/voicemail/capabilities | Get pbx voicemail capabilities
208
209
  *UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
209
210
  *UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
210
211
  *UltracartClient::ConversationApi* | [**get_user_pbx_audio**](docs/ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio
@@ -913,6 +914,7 @@ Class | Method | HTTP request | Description
913
914
  - [UltracartClient::ConversationPbxTimeRangeConfig](docs/ConversationPbxTimeRangeConfig.md)
914
915
  - [UltracartClient::ConversationPbxTimeRangeResponse](docs/ConversationPbxTimeRangeResponse.md)
915
916
  - [UltracartClient::ConversationPbxTimeRangesResponse](docs/ConversationPbxTimeRangesResponse.md)
917
+ - [UltracartClient::ConversationPbxVoicemailCapabilitiesResponse](docs/ConversationPbxVoicemailCapabilitiesResponse.md)
916
918
  - [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
917
919
  - [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
918
920
  - [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
@@ -1687,6 +1689,7 @@ Not every change is committed to every SDK.
1687
1689
 
1688
1690
  | Version | Date | Comments |
1689
1691
  | --: | :-: | --- |
1692
+ | 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |
1690
1693
  | 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |
1691
1694
  | 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
1692
1695
  | 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
@@ -77,6 +77,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
77
77
  | [**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds |
78
78
  | [**get_pbx_time_range**](ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange |
79
79
  | [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges |
80
+ | [**get_pbx_voicemail_capabilities**](ConversationApi.md#get_pbx_voicemail_capabilities) | **GET** /conversation/pbx/voicemail/capabilities | Get pbx voicemail capabilities |
80
81
  | [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox |
81
82
  | [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes |
82
83
  | [**get_user_pbx_audio**](ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio |
@@ -4024,6 +4025,57 @@ This endpoint does not need any parameter.
4024
4025
  - **Accept**: application/json
4025
4026
 
4026
4027
 
4028
+ ## get_pbx_voicemail_capabilities
4029
+
4030
+ > <ConversationPbxVoicemailCapabilitiesResponse> get_pbx_voicemail_capabilities
4031
+
4032
+ Get pbx voicemail capabilities
4033
+
4034
+ Retrieve voicemail notification capabilities including available channels
4035
+
4036
+
4037
+ ### Examples
4038
+
4039
+
4040
+ (No example for this operation).
4041
+
4042
+
4043
+ #### Using the get_pbx_voicemail_capabilities_with_http_info variant
4044
+
4045
+ This returns an Array which contains the response data, status code and headers.
4046
+
4047
+ > <Array(<ConversationPbxVoicemailCapabilitiesResponse>, Integer, Hash)> get_pbx_voicemail_capabilities_with_http_info
4048
+
4049
+ ```ruby
4050
+ begin
4051
+ # Get pbx voicemail capabilities
4052
+ data, status_code, headers = api_instance.get_pbx_voicemail_capabilities_with_http_info
4053
+ p status_code # => 2xx
4054
+ p headers # => { ... }
4055
+ p data # => <ConversationPbxVoicemailCapabilitiesResponse>
4056
+ rescue UltracartClient::ApiError => e
4057
+ puts "Error when calling ConversationApi->get_pbx_voicemail_capabilities_with_http_info: #{e}"
4058
+ end
4059
+ ```
4060
+
4061
+ ### Parameters
4062
+
4063
+ This endpoint does not need any parameter.
4064
+
4065
+ ### Return type
4066
+
4067
+ [**ConversationPbxVoicemailCapabilitiesResponse**](ConversationPbxVoicemailCapabilitiesResponse.md)
4068
+
4069
+ ### Authorization
4070
+
4071
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4072
+
4073
+ ### HTTP request headers
4074
+
4075
+ - **Content-Type**: Not defined
4076
+ - **Accept**: application/json
4077
+
4078
+
4027
4079
  ## get_pbx_voicemail_mailbox
4028
4080
 
4029
4081
  > <ConversationPbxVoicemailMailboxResponse> get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
@@ -0,0 +1,28 @@
1
+ # UltracartClient::ConversationPbxVoicemailCapabilitiesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
10
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
11
+ | **zoho_desk_available** | **Boolean** | True if Zoho Desk is connected to UltraCart | [optional] |
12
+ | **zoho_desk_departments** | [**Array&lt;ConversationVirtualAgentCapabilityZohoDeskDepartment&gt;**](ConversationVirtualAgentCapabilityZohoDeskDepartment.md) | Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::ConversationPbxVoicemailCapabilitiesResponse.new(
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null,
24
+ zoho_desk_available: null,
25
+ zoho_desk_departments: null
26
+ )
27
+ ```
28
+
@@ -6,7 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional] |
8
8
  | **merchant_id** | **String** | Merchant Id | [optional] |
9
+ | **send_notices_to_channel** | **String** | Send notices to channel | [optional] |
9
10
  | **send_notices_to_email** | **String** | Send notices to email | [optional] |
11
+ | **send_notices_to_zoho_desk_department_id** | **String** | Send notices to Zoho Desk department id | [optional] |
10
12
  | **user_id** | **Integer** | User Id | [optional] |
11
13
  | **voicemail_followup_play_audio_uuid** | **String** | Voicemail follow play audio UUID | [optional] |
12
14
  | **voicemail_followup_say** | **String** | Voicemail followup say | [optional] |
@@ -25,7 +27,9 @@ require 'ultracart_api'
25
27
  instance = UltracartClient::ConversationPbxVoicemailMailbox.new(
26
28
  conversation_pbx_voicemail_mailbox_uuid: null,
27
29
  merchant_id: null,
30
+ send_notices_to_channel: null,
28
31
  send_notices_to_email: null,
32
+ send_notices_to_zoho_desk_department_id: null,
29
33
  user_id: null,
30
34
  voicemail_followup_play_audio_uuid: null,
31
35
  voicemail_followup_say: null,
@@ -4647,6 +4647,64 @@ module UltracartClient
4647
4647
  return data, status_code, headers
4648
4648
  end
4649
4649
 
4650
+ # Get pbx voicemail capabilities
4651
+ # Retrieve voicemail notification capabilities including available channels
4652
+ # @param [Hash] opts the optional parameters
4653
+ # @return [ConversationPbxVoicemailCapabilitiesResponse]
4654
+ def get_pbx_voicemail_capabilities(opts = {})
4655
+ data, _status_code, _headers = get_pbx_voicemail_capabilities_with_http_info(opts)
4656
+ data
4657
+ end
4658
+
4659
+ # Get pbx voicemail capabilities
4660
+ # Retrieve voicemail notification capabilities including available channels
4661
+ # @param [Hash] opts the optional parameters
4662
+ # @return [Array<(ConversationPbxVoicemailCapabilitiesResponse, Integer, Hash)>] ConversationPbxVoicemailCapabilitiesResponse data, response status code and response headers
4663
+ def get_pbx_voicemail_capabilities_with_http_info(opts = {})
4664
+ if @api_client.config.debugging
4665
+ @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_voicemail_capabilities ...'
4666
+ end
4667
+ # resource path
4668
+ local_var_path = '/conversation/pbx/voicemail/capabilities'
4669
+
4670
+ # query parameters
4671
+ query_params = opts[:query_params] || {}
4672
+
4673
+ # header parameters
4674
+ header_params = opts[:header_params] || {}
4675
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4676
+ # HTTP header 'Accept' (if needed)
4677
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4678
+
4679
+ # form parameters
4680
+ form_params = opts[:form_params] || {}
4681
+
4682
+ # http body (model)
4683
+ post_body = opts[:debug_body]
4684
+
4685
+ # return_type
4686
+ return_type = opts[:debug_return_type] || 'ConversationPbxVoicemailCapabilitiesResponse'
4687
+
4688
+ # auth_names
4689
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4690
+
4691
+ new_options = opts.merge(
4692
+ :operation => :"ConversationApi.get_pbx_voicemail_capabilities",
4693
+ :header_params => header_params,
4694
+ :query_params => query_params,
4695
+ :form_params => form_params,
4696
+ :body => post_body,
4697
+ :auth_names => auth_names,
4698
+ :return_type => return_type
4699
+ )
4700
+
4701
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4702
+ if @api_client.config.debugging
4703
+ @api_client.config.logger.debug "API called: ConversationApi#get_pbx_voicemail_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4704
+ end
4705
+ return data, status_code, headers
4706
+ end
4707
+
4650
4708
  # Get pbx voicemailMailbox
4651
4709
  # Retrieve a pbx voicemailMailbox
4652
4710
  # @param conversation_pbx_voicemail_mailbox_uuid [String]
@@ -0,0 +1,269 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module UltracartClient
17
+ class ConversationPbxVoicemailCapabilitiesResponse
18
+ attr_accessor :error
19
+
20
+ attr_accessor :metadata
21
+
22
+ # Indicates if API call was successful
23
+ attr_accessor :success
24
+
25
+ attr_accessor :warning
26
+
27
+ # True if Zoho Desk is connected to UltraCart
28
+ attr_accessor :zoho_desk_available
29
+
30
+ # Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart
31
+ attr_accessor :zoho_desk_departments
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+ :'error' => :'error',
37
+ :'metadata' => :'metadata',
38
+ :'success' => :'success',
39
+ :'warning' => :'warning',
40
+ :'zoho_desk_available' => :'zoho_desk_available',
41
+ :'zoho_desk_departments' => :'zoho_desk_departments'
42
+ }
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'error' => :'Error',
54
+ :'metadata' => :'ResponseMetadata',
55
+ :'success' => :'Boolean',
56
+ :'warning' => :'Warning',
57
+ :'zoho_desk_available' => :'Boolean',
58
+ :'zoho_desk_departments' => :'Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>'
59
+ }
60
+ end
61
+
62
+ # List of attributes with nullable: true
63
+ def self.openapi_nullable
64
+ Set.new([
65
+ ])
66
+ end
67
+
68
+ # Initializes the object
69
+ # @param [Hash] attributes Model attributes in the form of hash
70
+ def initialize(attributes = {})
71
+ if (!attributes.is_a?(Hash))
72
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationPbxVoicemailCapabilitiesResponse` initialize method"
73
+ end
74
+
75
+ # check to see if the attribute exists and convert string to symbol for hash key
76
+ attributes = attributes.each_with_object({}) { |(k, v), h|
77
+ if (!self.class.attribute_map.key?(k.to_sym))
78
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationPbxVoicemailCapabilitiesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
79
+ end
80
+ h[k.to_sym] = v
81
+ }
82
+
83
+ if attributes.key?(:'error')
84
+ self.error = attributes[:'error']
85
+ end
86
+
87
+ if attributes.key?(:'metadata')
88
+ self.metadata = attributes[:'metadata']
89
+ end
90
+
91
+ if attributes.key?(:'success')
92
+ self.success = attributes[:'success']
93
+ end
94
+
95
+ if attributes.key?(:'warning')
96
+ self.warning = attributes[:'warning']
97
+ end
98
+
99
+ if attributes.key?(:'zoho_desk_available')
100
+ self.zoho_desk_available = attributes[:'zoho_desk_available']
101
+ end
102
+
103
+ if attributes.key?(:'zoho_desk_departments')
104
+ if (value = attributes[:'zoho_desk_departments']).is_a?(Array)
105
+ self.zoho_desk_departments = value
106
+ end
107
+ end
108
+ end
109
+
110
+ # Show invalid properties with the reasons. Usually used together with valid?
111
+ # @return Array for valid properties with the reasons
112
+ def list_invalid_properties
113
+ invalid_properties = Array.new
114
+ invalid_properties
115
+ end
116
+
117
+ # Check to see if the all the properties in the model are valid
118
+ # @return true if the model is valid
119
+ def valid?
120
+ true
121
+ end
122
+
123
+ # Checks equality by comparing each attribute.
124
+ # @param [Object] Object to be compared
125
+ def ==(o)
126
+ return true if self.equal?(o)
127
+ self.class == o.class &&
128
+ error == o.error &&
129
+ metadata == o.metadata &&
130
+ success == o.success &&
131
+ warning == o.warning &&
132
+ zoho_desk_available == o.zoho_desk_available &&
133
+ zoho_desk_departments == o.zoho_desk_departments
134
+ end
135
+
136
+ # @see the `==` method
137
+ # @param [Object] Object to be compared
138
+ def eql?(o)
139
+ self == o
140
+ end
141
+
142
+ # Calculates hash code according to all attributes.
143
+ # @return [Integer] Hash code
144
+ def hash
145
+ [error, metadata, success, warning, zoho_desk_available, zoho_desk_departments].hash
146
+ end
147
+
148
+ # Builds the object from hash
149
+ # @param [Hash] attributes Model attributes in the form of hash
150
+ # @return [Object] Returns the model itself
151
+ def self.build_from_hash(attributes)
152
+ new.build_from_hash(attributes)
153
+ end
154
+
155
+ # Builds the object from hash
156
+ # @param [Hash] attributes Model attributes in the form of hash
157
+ # @return [Object] Returns the model itself
158
+ def build_from_hash(attributes)
159
+ return nil unless attributes.is_a?(Hash)
160
+ attributes = attributes.transform_keys(&:to_sym)
161
+ self.class.openapi_types.each_pair do |key, type|
162
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
163
+ self.send("#{key}=", nil)
164
+ elsif type =~ /\AArray<(.*)>/i
165
+ # check to ensure the input is an array given that the attribute
166
+ # is documented as an array but the input is not
167
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
168
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
169
+ end
170
+ elsif !attributes[self.class.attribute_map[key]].nil?
171
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
172
+ end
173
+ end
174
+
175
+ self
176
+ end
177
+
178
+ # Deserializes the data based on type
179
+ # @param string type Data type
180
+ # @param string value Value to be deserialized
181
+ # @return [Object] Deserialized data
182
+ def _deserialize(type, value)
183
+ case type.to_sym
184
+ when :Time
185
+ Time.parse(value)
186
+ when :Date
187
+ Date.parse(value)
188
+ when :String
189
+ value.to_s
190
+ when :Integer
191
+ value.to_i
192
+ when :Float
193
+ value.to_f
194
+ when :Boolean
195
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
196
+ true
197
+ else
198
+ false
199
+ end
200
+ when :Object
201
+ # generic object (usually a Hash), return directly
202
+ value
203
+ when /\AArray<(?<inner_type>.+)>\z/
204
+ inner_type = Regexp.last_match[:inner_type]
205
+ value.map { |v| _deserialize(inner_type, v) }
206
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
207
+ k_type = Regexp.last_match[:k_type]
208
+ v_type = Regexp.last_match[:v_type]
209
+ {}.tap do |hash|
210
+ value.each do |k, v|
211
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
212
+ end
213
+ end
214
+ else # model
215
+ # models (e.g. Pet) or oneOf
216
+ klass = UltracartClient.const_get(type)
217
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
218
+ end
219
+ end
220
+
221
+ # Returns the string representation of the object
222
+ # @return [String] String presentation of the object
223
+ def to_s
224
+ to_hash.to_s
225
+ end
226
+
227
+ # to_body is an alias to to_hash (backward compatibility)
228
+ # @return [Hash] Returns the object in the form of hash
229
+ def to_body
230
+ to_hash
231
+ end
232
+
233
+ # Returns the object in the form of hash
234
+ # @return [Hash] Returns the object in the form of hash
235
+ def to_hash
236
+ hash = {}
237
+ self.class.attribute_map.each_pair do |attr, param|
238
+ value = self.send(attr)
239
+ if value.nil?
240
+ is_nullable = self.class.openapi_nullable.include?(attr)
241
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
242
+ end
243
+
244
+ hash[param] = _to_hash(value)
245
+ end
246
+ hash
247
+ end
248
+
249
+ # Outputs non-array value in the form of hash
250
+ # For object, use to_hash. Otherwise, just return the value
251
+ # @param [Object] value Any valid value
252
+ # @return [Hash] Returns the value in the form of hash
253
+ def _to_hash(value)
254
+ if value.is_a?(Array)
255
+ value.compact.map { |v| _to_hash(v) }
256
+ elsif value.is_a?(Hash)
257
+ {}.tap do |hash|
258
+ value.each { |k, v| hash[k] = _to_hash(v) }
259
+ end
260
+ elsif value.respond_to? :to_hash
261
+ value.to_hash
262
+ else
263
+ value
264
+ end
265
+ end
266
+
267
+ end
268
+
269
+ end
@@ -21,9 +21,15 @@ module UltracartClient
21
21
  # Merchant Id
22
22
  attr_accessor :merchant_id
23
23
 
24
+ # Send notices to channel
25
+ attr_accessor :send_notices_to_channel
26
+
24
27
  # Send notices to email
25
28
  attr_accessor :send_notices_to_email
26
29
 
30
+ # Send notices to Zoho Desk department id
31
+ attr_accessor :send_notices_to_zoho_desk_department_id
32
+
27
33
  # User Id
28
34
  attr_accessor :user_id
29
35
 
@@ -78,7 +84,9 @@ module UltracartClient
78
84
  {
79
85
  :'conversation_pbx_voicemail_mailbox_uuid' => :'conversation_pbx_voicemail_mailbox_uuid',
80
86
  :'merchant_id' => :'merchant_id',
87
+ :'send_notices_to_channel' => :'send_notices_to_channel',
81
88
  :'send_notices_to_email' => :'send_notices_to_email',
89
+ :'send_notices_to_zoho_desk_department_id' => :'send_notices_to_zoho_desk_department_id',
82
90
  :'user_id' => :'user_id',
83
91
  :'voicemail_followup_play_audio_uuid' => :'voicemail_followup_play_audio_uuid',
84
92
  :'voicemail_followup_say' => :'voicemail_followup_say',
@@ -101,7 +109,9 @@ module UltracartClient
101
109
  {
102
110
  :'conversation_pbx_voicemail_mailbox_uuid' => :'String',
103
111
  :'merchant_id' => :'String',
112
+ :'send_notices_to_channel' => :'String',
104
113
  :'send_notices_to_email' => :'String',
114
+ :'send_notices_to_zoho_desk_department_id' => :'String',
105
115
  :'user_id' => :'Integer',
106
116
  :'voicemail_followup_play_audio_uuid' => :'String',
107
117
  :'voicemail_followup_say' => :'String',
@@ -143,10 +153,18 @@ module UltracartClient
143
153
  self.merchant_id = attributes[:'merchant_id']
144
154
  end
145
155
 
156
+ if attributes.key?(:'send_notices_to_channel')
157
+ self.send_notices_to_channel = attributes[:'send_notices_to_channel']
158
+ end
159
+
146
160
  if attributes.key?(:'send_notices_to_email')
147
161
  self.send_notices_to_email = attributes[:'send_notices_to_email']
148
162
  end
149
163
 
164
+ if attributes.key?(:'send_notices_to_zoho_desk_department_id')
165
+ self.send_notices_to_zoho_desk_department_id = attributes[:'send_notices_to_zoho_desk_department_id']
166
+ end
167
+
150
168
  if attributes.key?(:'user_id')
151
169
  self.user_id = attributes[:'user_id']
152
170
  end
@@ -196,10 +214,18 @@ module UltracartClient
196
214
  invalid_properties.push('invalid value for "merchant_id", the character length must be smaller than or equal to 5.')
197
215
  end
198
216
 
217
+ if !@send_notices_to_channel.nil? && @send_notices_to_channel.to_s.length > 50
218
+ invalid_properties.push('invalid value for "send_notices_to_channel", the character length must be smaller than or equal to 50.')
219
+ end
220
+
199
221
  if !@send_notices_to_email.nil? && @send_notices_to_email.to_s.length > 250
200
222
  invalid_properties.push('invalid value for "send_notices_to_email", the character length must be smaller than or equal to 250.')
201
223
  end
202
224
 
225
+ if !@send_notices_to_zoho_desk_department_id.nil? && @send_notices_to_zoho_desk_department_id.to_s.length > 50
226
+ invalid_properties.push('invalid value for "send_notices_to_zoho_desk_department_id", the character length must be smaller than or equal to 50.')
227
+ end
228
+
203
229
  if !@voicemail_followup_play_audio_uuid.nil? && @voicemail_followup_play_audio_uuid.to_s.length > 50
204
230
  invalid_properties.push('invalid value for "voicemail_followup_play_audio_uuid", the character length must be smaller than or equal to 50.')
205
231
  end
@@ -232,7 +258,11 @@ module UltracartClient
232
258
  def valid?
233
259
  return false if !@conversation_pbx_voicemail_mailbox_uuid.nil? && @conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
234
260
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
261
+ send_notices_to_channel_validator = EnumAttributeValidator.new('String', ["none", "email", "zoho_desk_ticket", "ultracart_task"])
262
+ return false unless send_notices_to_channel_validator.valid?(@send_notices_to_channel)
263
+ return false if !@send_notices_to_channel.nil? && @send_notices_to_channel.to_s.length > 50
235
264
  return false if !@send_notices_to_email.nil? && @send_notices_to_email.to_s.length > 250
265
+ return false if !@send_notices_to_zoho_desk_department_id.nil? && @send_notices_to_zoho_desk_department_id.to_s.length > 50
236
266
  return false if !@voicemail_followup_play_audio_uuid.nil? && @voicemail_followup_play_audio_uuid.to_s.length > 50
237
267
  voicemail_followup_say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
238
268
  return false unless voicemail_followup_say_voice_validator.valid?(@voicemail_followup_say_voice)
@@ -268,6 +298,16 @@ module UltracartClient
268
298
  @merchant_id = merchant_id
269
299
  end
270
300
 
301
+ # Custom attribute writer method checking allowed values (enum).
302
+ # @param [Object] send_notices_to_channel Object to be assigned
303
+ def send_notices_to_channel=(send_notices_to_channel)
304
+ validator = EnumAttributeValidator.new('String', ["none", "email", "zoho_desk_ticket", "ultracart_task"])
305
+ unless validator.valid?(send_notices_to_channel)
306
+ fail ArgumentError, "invalid value for \"send_notices_to_channel\", must be one of #{validator.allowable_values}."
307
+ end
308
+ @send_notices_to_channel = send_notices_to_channel
309
+ end
310
+
271
311
  # Custom attribute writer method with validation
272
312
  # @param [Object] send_notices_to_email Value to be assigned
273
313
  def send_notices_to_email=(send_notices_to_email)
@@ -278,6 +318,16 @@ module UltracartClient
278
318
  @send_notices_to_email = send_notices_to_email
279
319
  end
280
320
 
321
+ # Custom attribute writer method with validation
322
+ # @param [Object] send_notices_to_zoho_desk_department_id Value to be assigned
323
+ def send_notices_to_zoho_desk_department_id=(send_notices_to_zoho_desk_department_id)
324
+ if !send_notices_to_zoho_desk_department_id.nil? && send_notices_to_zoho_desk_department_id.to_s.length > 50
325
+ fail ArgumentError, 'invalid value for "send_notices_to_zoho_desk_department_id", the character length must be smaller than or equal to 50.'
326
+ end
327
+
328
+ @send_notices_to_zoho_desk_department_id = send_notices_to_zoho_desk_department_id
329
+ end
330
+
281
331
  # Custom attribute writer method with validation
282
332
  # @param [Object] voicemail_followup_play_audio_uuid Value to be assigned
283
333
  def voicemail_followup_play_audio_uuid=(voicemail_followup_play_audio_uuid)
@@ -345,7 +395,9 @@ module UltracartClient
345
395
  self.class == o.class &&
346
396
  conversation_pbx_voicemail_mailbox_uuid == o.conversation_pbx_voicemail_mailbox_uuid &&
347
397
  merchant_id == o.merchant_id &&
398
+ send_notices_to_channel == o.send_notices_to_channel &&
348
399
  send_notices_to_email == o.send_notices_to_email &&
400
+ send_notices_to_zoho_desk_department_id == o.send_notices_to_zoho_desk_department_id &&
349
401
  user_id == o.user_id &&
350
402
  voicemail_followup_play_audio_uuid == o.voicemail_followup_play_audio_uuid &&
351
403
  voicemail_followup_say == o.voicemail_followup_say &&
@@ -366,7 +418,7 @@ module UltracartClient
366
418
  # Calculates hash code according to all attributes.
367
419
  # @return [Integer] Hash code
368
420
  def hash
369
- [conversation_pbx_voicemail_mailbox_uuid, merchant_id, send_notices_to_email, user_id, voicemail_followup_play_audio_uuid, voicemail_followup_say, voicemail_followup_say_voice, voicemail_mailbox_id, voicemail_mailbox_type, voicemail_prompt_play_audio_uuid, voicemail_prompt_say, voicemail_prompt_say_voice].hash
421
+ [conversation_pbx_voicemail_mailbox_uuid, merchant_id, send_notices_to_channel, send_notices_to_email, send_notices_to_zoho_desk_department_id, user_id, voicemail_followup_play_audio_uuid, voicemail_followup_say, voicemail_followup_say_voice, voicemail_mailbox_id, voicemail_mailbox_type, voicemail_prompt_play_audio_uuid, voicemail_prompt_say, voicemail_prompt_say_voice].hash
370
422
  end
371
423
 
372
424
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.71'
14
+ VERSION = '4.1.72'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -268,6 +268,7 @@ require 'ultracart_api/models/conversation_pbx_time_range'
268
268
  require 'ultracart_api/models/conversation_pbx_time_range_config'
269
269
  require 'ultracart_api/models/conversation_pbx_time_range_response'
270
270
  require 'ultracart_api/models/conversation_pbx_time_ranges_response'
271
+ require 'ultracart_api/models/conversation_pbx_voicemail_capabilities_response'
271
272
  require 'ultracart_api/models/conversation_pbx_voicemail_mailbox'
272
273
  require 'ultracart_api/models/conversation_pbx_voicemail_mailbox_response'
273
274
  require 'ultracart_api/models/conversation_pbx_voicemail_mailboxes_response'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.71
4
+ version: 4.1.72
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-04-06 00:00:00.000000000 Z
11
+ date: 2026-04-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -317,6 +317,7 @@ files:
317
317
  - docs/ConversationPbxTimeRangeConfig.md
318
318
  - docs/ConversationPbxTimeRangeResponse.md
319
319
  - docs/ConversationPbxTimeRangesResponse.md
320
+ - docs/ConversationPbxVoicemailCapabilitiesResponse.md
320
321
  - docs/ConversationPbxVoicemailMailbox.md
321
322
  - docs/ConversationPbxVoicemailMailboxResponse.md
322
323
  - docs/ConversationPbxVoicemailMailboxesResponse.md
@@ -1307,6 +1308,7 @@ files:
1307
1308
  - lib/ultracart_api/models/conversation_pbx_time_range_config.rb
1308
1309
  - lib/ultracart_api/models/conversation_pbx_time_range_response.rb
1309
1310
  - lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb
1311
+ - lib/ultracart_api/models/conversation_pbx_voicemail_capabilities_response.rb
1310
1312
  - lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb
1311
1313
  - lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb
1312
1314
  - lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb