ultracart_api 4.1.71 → 4.1.73

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.
@@ -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.73'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -219,6 +219,7 @@ require 'ultracart_api/models/conversation_pbx_call'
219
219
  require 'ultracart_api/models/conversation_pbx_call_agent'
220
220
  require 'ultracart_api/models/conversation_pbx_call_ai_cost'
221
221
  require 'ultracart_api/models/conversation_pbx_call_ai_engagement'
222
+ require 'ultracart_api/models/conversation_pbx_call_ai_summary'
222
223
  require 'ultracart_api/models/conversation_pbx_call_ai_tool_call'
223
224
  require 'ultracart_api/models/conversation_pbx_call_ai_whisper'
224
225
  require 'ultracart_api/models/conversation_pbx_call_caller'
@@ -268,6 +269,7 @@ require 'ultracart_api/models/conversation_pbx_time_range'
268
269
  require 'ultracart_api/models/conversation_pbx_time_range_config'
269
270
  require 'ultracart_api/models/conversation_pbx_time_range_response'
270
271
  require 'ultracart_api/models/conversation_pbx_time_ranges_response'
272
+ require 'ultracart_api/models/conversation_pbx_voicemail_capabilities_response'
271
273
  require 'ultracart_api/models/conversation_pbx_voicemail_mailbox'
272
274
  require 'ultracart_api/models/conversation_pbx_voicemail_mailbox_response'
273
275
  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.73
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-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -268,6 +268,7 @@ files:
268
268
  - docs/ConversationPbxCallAgent.md
269
269
  - docs/ConversationPbxCallAiCost.md
270
270
  - docs/ConversationPbxCallAiEngagement.md
271
+ - docs/ConversationPbxCallAiSummary.md
271
272
  - docs/ConversationPbxCallAiToolCall.md
272
273
  - docs/ConversationPbxCallAiWhisper.md
273
274
  - docs/ConversationPbxCallCaller.md
@@ -317,6 +318,7 @@ files:
317
318
  - docs/ConversationPbxTimeRangeConfig.md
318
319
  - docs/ConversationPbxTimeRangeResponse.md
319
320
  - docs/ConversationPbxTimeRangesResponse.md
321
+ - docs/ConversationPbxVoicemailCapabilitiesResponse.md
320
322
  - docs/ConversationPbxVoicemailMailbox.md
321
323
  - docs/ConversationPbxVoicemailMailboxResponse.md
322
324
  - docs/ConversationPbxVoicemailMailboxesResponse.md
@@ -1258,6 +1260,7 @@ files:
1258
1260
  - lib/ultracart_api/models/conversation_pbx_call_agent.rb
1259
1261
  - lib/ultracart_api/models/conversation_pbx_call_ai_cost.rb
1260
1262
  - lib/ultracart_api/models/conversation_pbx_call_ai_engagement.rb
1263
+ - lib/ultracart_api/models/conversation_pbx_call_ai_summary.rb
1261
1264
  - lib/ultracart_api/models/conversation_pbx_call_ai_tool_call.rb
1262
1265
  - lib/ultracart_api/models/conversation_pbx_call_ai_whisper.rb
1263
1266
  - lib/ultracart_api/models/conversation_pbx_call_caller.rb
@@ -1307,6 +1310,7 @@ files:
1307
1310
  - lib/ultracart_api/models/conversation_pbx_time_range_config.rb
1308
1311
  - lib/ultracart_api/models/conversation_pbx_time_range_response.rb
1309
1312
  - lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb
1313
+ - lib/ultracart_api/models/conversation_pbx_voicemail_capabilities_response.rb
1310
1314
  - lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb
1311
1315
  - lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb
1312
1316
  - lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb