ultracart_api 3.10.191 → 3.10.193
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 +4 -4
- data/README.md +19 -4
- data/docs/AutoOrder.md +1 -0
- data/docs/AutoOrderItem.md +2 -0
- data/docs/ConversationApi.md +408 -0
- data/docs/ConversationPbxVoicemailMessage.md +20 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +17 -0
- data/docs/ItemApi.md +53 -0
- data/docs/WorkflowTask.md +2 -2
- data/docs/WorkflowTasksRequest.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +448 -0
- data/lib/ultracart_api/api/item_api.rb +60 -0
- data/lib/ultracart_api/models/auto_order.rb +11 -1
- data/lib/ultracart_api/models/auto_order_item.rb +21 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +339 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +309 -0
- data/lib/ultracart_api/models/workflow_task.rb +2 -2
- data/lib/ultracart_api/models/workflow_tasks_request.rb +21 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
@@ -64,6 +64,9 @@ module UltracartClient
|
|
64
64
|
|
65
65
|
attr_accessor :management
|
66
66
|
|
67
|
+
# UltraCart merchant ID owning this order
|
68
|
+
attr_accessor :merchant_id
|
69
|
+
|
67
70
|
# The next time that the auto order will be attempted for processing
|
68
71
|
attr_accessor :next_attempt
|
69
72
|
|
@@ -126,6 +129,7 @@ module UltracartClient
|
|
126
129
|
:'items' => :'items',
|
127
130
|
:'logs' => :'logs',
|
128
131
|
:'management' => :'management',
|
132
|
+
:'merchant_id' => :'merchant_id',
|
129
133
|
:'next_attempt' => :'next_attempt',
|
130
134
|
:'original_order' => :'original_order',
|
131
135
|
:'original_order_id' => :'original_order_id',
|
@@ -156,6 +160,7 @@ module UltracartClient
|
|
156
160
|
:'items' => :'Array<AutoOrderItem>',
|
157
161
|
:'logs' => :'Array<AutoOrderLog>',
|
158
162
|
:'management' => :'AutoOrderManagement',
|
163
|
+
:'merchant_id' => :'String',
|
159
164
|
:'next_attempt' => :'String',
|
160
165
|
:'original_order' => :'Order',
|
161
166
|
:'original_order_id' => :'String',
|
@@ -248,6 +253,10 @@ module UltracartClient
|
|
248
253
|
self.management = attributes[:'management']
|
249
254
|
end
|
250
255
|
|
256
|
+
if attributes.has_key?(:'merchant_id')
|
257
|
+
self.merchant_id = attributes[:'merchant_id']
|
258
|
+
end
|
259
|
+
|
251
260
|
if attributes.has_key?(:'next_attempt')
|
252
261
|
self.next_attempt = attributes[:'next_attempt']
|
253
262
|
end
|
@@ -326,6 +335,7 @@ module UltracartClient
|
|
326
335
|
items == o.items &&
|
327
336
|
logs == o.logs &&
|
328
337
|
management == o.management &&
|
338
|
+
merchant_id == o.merchant_id &&
|
329
339
|
next_attempt == o.next_attempt &&
|
330
340
|
original_order == o.original_order &&
|
331
341
|
original_order_id == o.original_order_id &&
|
@@ -344,7 +354,7 @@ module UltracartClient
|
|
344
354
|
# Calculates hash code according to all attributes.
|
345
355
|
# @return [Fixnum] Hash code
|
346
356
|
def hash
|
347
|
-
[add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
|
357
|
+
[add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, merchant_id, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
|
348
358
|
end
|
349
359
|
|
350
360
|
# Builds the object from hash
|
@@ -35,6 +35,9 @@ module UltracartClient
|
|
35
35
|
# Primary key of AutoOrderItem
|
36
36
|
attr_accessor :auto_order_item_oid
|
37
37
|
|
38
|
+
# Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item
|
39
|
+
attr_accessor :calculated_next_shipment_dts
|
40
|
+
|
38
41
|
# Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
|
39
42
|
attr_accessor :first_order_dts
|
40
43
|
|
@@ -50,6 +53,9 @@ module UltracartClient
|
|
50
53
|
# The life time value of this item including the original purchase
|
51
54
|
attr_accessor :life_time_value
|
52
55
|
|
56
|
+
# Calculated next item id
|
57
|
+
attr_accessor :next_item_id
|
58
|
+
|
53
59
|
# The date/time of when the next pre-shipment notice should be sent
|
54
60
|
attr_accessor :next_preshipment_notice_dts
|
55
61
|
|
@@ -123,11 +129,13 @@ module UltracartClient
|
|
123
129
|
:'arbitrary_unit_cost' => :'arbitrary_unit_cost',
|
124
130
|
:'arbitrary_unit_cost_remaining_orders' => :'arbitrary_unit_cost_remaining_orders',
|
125
131
|
:'auto_order_item_oid' => :'auto_order_item_oid',
|
132
|
+
:'calculated_next_shipment_dts' => :'calculated_next_shipment_dts',
|
126
133
|
:'first_order_dts' => :'first_order_dts',
|
127
134
|
:'frequency' => :'frequency',
|
128
135
|
:'future_schedules' => :'future_schedules',
|
129
136
|
:'last_order_dts' => :'last_order_dts',
|
130
137
|
:'life_time_value' => :'life_time_value',
|
138
|
+
:'next_item_id' => :'next_item_id',
|
131
139
|
:'next_preshipment_notice_dts' => :'next_preshipment_notice_dts',
|
132
140
|
:'next_shipment_dts' => :'next_shipment_dts',
|
133
141
|
:'no_order_after_dts' => :'no_order_after_dts',
|
@@ -155,11 +163,13 @@ module UltracartClient
|
|
155
163
|
:'arbitrary_unit_cost' => :'Float',
|
156
164
|
:'arbitrary_unit_cost_remaining_orders' => :'Integer',
|
157
165
|
:'auto_order_item_oid' => :'Integer',
|
166
|
+
:'calculated_next_shipment_dts' => :'String',
|
158
167
|
:'first_order_dts' => :'String',
|
159
168
|
:'frequency' => :'String',
|
160
169
|
:'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
|
161
170
|
:'last_order_dts' => :'String',
|
162
171
|
:'life_time_value' => :'Float',
|
172
|
+
:'next_item_id' => :'String',
|
163
173
|
:'next_preshipment_notice_dts' => :'String',
|
164
174
|
:'next_shipment_dts' => :'String',
|
165
175
|
:'no_order_after_dts' => :'String',
|
@@ -213,6 +223,10 @@ module UltracartClient
|
|
213
223
|
self.auto_order_item_oid = attributes[:'auto_order_item_oid']
|
214
224
|
end
|
215
225
|
|
226
|
+
if attributes.has_key?(:'calculated_next_shipment_dts')
|
227
|
+
self.calculated_next_shipment_dts = attributes[:'calculated_next_shipment_dts']
|
228
|
+
end
|
229
|
+
|
216
230
|
if attributes.has_key?(:'first_order_dts')
|
217
231
|
self.first_order_dts = attributes[:'first_order_dts']
|
218
232
|
end
|
@@ -235,6 +249,10 @@ module UltracartClient
|
|
235
249
|
self.life_time_value = attributes[:'life_time_value']
|
236
250
|
end
|
237
251
|
|
252
|
+
if attributes.has_key?(:'next_item_id')
|
253
|
+
self.next_item_id = attributes[:'next_item_id']
|
254
|
+
end
|
255
|
+
|
238
256
|
if attributes.has_key?(:'next_preshipment_notice_dts')
|
239
257
|
self.next_preshipment_notice_dts = attributes[:'next_preshipment_notice_dts']
|
240
258
|
end
|
@@ -331,11 +349,13 @@ module UltracartClient
|
|
331
349
|
arbitrary_unit_cost == o.arbitrary_unit_cost &&
|
332
350
|
arbitrary_unit_cost_remaining_orders == o.arbitrary_unit_cost_remaining_orders &&
|
333
351
|
auto_order_item_oid == o.auto_order_item_oid &&
|
352
|
+
calculated_next_shipment_dts == o.calculated_next_shipment_dts &&
|
334
353
|
first_order_dts == o.first_order_dts &&
|
335
354
|
frequency == o.frequency &&
|
336
355
|
future_schedules == o.future_schedules &&
|
337
356
|
last_order_dts == o.last_order_dts &&
|
338
357
|
life_time_value == o.life_time_value &&
|
358
|
+
next_item_id == o.next_item_id &&
|
339
359
|
next_preshipment_notice_dts == o.next_preshipment_notice_dts &&
|
340
360
|
next_shipment_dts == o.next_shipment_dts &&
|
341
361
|
no_order_after_dts == o.no_order_after_dts &&
|
@@ -361,7 +381,7 @@ module UltracartClient
|
|
361
381
|
# Calculates hash code according to all attributes.
|
362
382
|
# @return [Fixnum] Hash code
|
363
383
|
def hash
|
364
|
-
[arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
|
384
|
+
[arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, calculated_next_shipment_dts, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_item_id, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
|
365
385
|
end
|
366
386
|
|
367
387
|
# Builds the object from hash
|
@@ -30,7 +30,7 @@ module UltracartClient
|
|
30
30
|
{
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
|
-
:'phone_number' => :'
|
33
|
+
:'phone_number' => :'phone_number',
|
34
34
|
:'success' => :'success',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
@@ -63,8 +63,8 @@ module UltracartClient
|
|
63
63
|
self.metadata = attributes[:'metadata']
|
64
64
|
end
|
65
65
|
|
66
|
-
if attributes.has_key?(:'
|
67
|
-
self.phone_number = attributes[:'
|
66
|
+
if attributes.has_key?(:'phone_number')
|
67
|
+
self.phone_number = attributes[:'phone_number']
|
68
68
|
end
|
69
69
|
|
70
70
|
if attributes.has_key?(:'success')
|
@@ -30,7 +30,7 @@ module UltracartClient
|
|
30
30
|
{
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
|
-
:'phone_numbers' => :'
|
33
|
+
:'phone_numbers' => :'phone_numbers',
|
34
34
|
:'success' => :'success',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
@@ -63,8 +63,8 @@ module UltracartClient
|
|
63
63
|
self.metadata = attributes[:'metadata']
|
64
64
|
end
|
65
65
|
|
66
|
-
if attributes.has_key?(:'
|
67
|
-
if (value = attributes[:'
|
66
|
+
if attributes.has_key?(:'phone_numbers')
|
67
|
+
if (value = attributes[:'phone_numbers']).is_a?(Array)
|
68
68
|
self.phone_numbers = value
|
69
69
|
end
|
70
70
|
end
|
@@ -31,7 +31,7 @@ module UltracartClient
|
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
33
|
:'success' => :'success',
|
34
|
-
:'time_based' => :'
|
34
|
+
:'time_based' => :'time_based',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
37
37
|
end
|
@@ -67,8 +67,8 @@ module UltracartClient
|
|
67
67
|
self.success = attributes[:'success']
|
68
68
|
end
|
69
69
|
|
70
|
-
if attributes.has_key?(:'
|
71
|
-
self.time_based = attributes[:'
|
70
|
+
if attributes.has_key?(:'time_based')
|
71
|
+
self.time_based = attributes[:'time_based']
|
72
72
|
end
|
73
73
|
|
74
74
|
if attributes.has_key?(:'warning')
|
@@ -31,7 +31,7 @@ module UltracartClient
|
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
33
|
:'success' => :'success',
|
34
|
-
:'time_baseds' => :'
|
34
|
+
:'time_baseds' => :'time_baseds',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
37
37
|
end
|
@@ -67,8 +67,8 @@ module UltracartClient
|
|
67
67
|
self.success = attributes[:'success']
|
68
68
|
end
|
69
69
|
|
70
|
-
if attributes.has_key?(:'
|
71
|
-
if (value = attributes[:'
|
70
|
+
if attributes.has_key?(:'time_baseds')
|
71
|
+
if (value = attributes[:'time_baseds']).is_a?(Array)
|
72
72
|
self.time_baseds = value
|
73
73
|
end
|
74
74
|
end
|
@@ -31,7 +31,7 @@ module UltracartClient
|
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
33
|
:'success' => :'success',
|
34
|
-
:'time_range' => :'
|
34
|
+
:'time_range' => :'time_range',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
37
37
|
end
|
@@ -67,8 +67,8 @@ module UltracartClient
|
|
67
67
|
self.success = attributes[:'success']
|
68
68
|
end
|
69
69
|
|
70
|
-
if attributes.has_key?(:'
|
71
|
-
self.time_range = attributes[:'
|
70
|
+
if attributes.has_key?(:'time_range')
|
71
|
+
self.time_range = attributes[:'time_range']
|
72
72
|
end
|
73
73
|
|
74
74
|
if attributes.has_key?(:'warning')
|
@@ -31,7 +31,7 @@ module UltracartClient
|
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
33
|
:'success' => :'success',
|
34
|
-
:'time_ranges' => :'
|
34
|
+
:'time_ranges' => :'time_ranges',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
37
37
|
end
|
@@ -67,8 +67,8 @@ module UltracartClient
|
|
67
67
|
self.success = attributes[:'success']
|
68
68
|
end
|
69
69
|
|
70
|
-
if attributes.has_key?(:'
|
71
|
-
if (value = attributes[:'
|
70
|
+
if attributes.has_key?(:'time_ranges')
|
71
|
+
if (value = attributes[:'time_ranges']).is_a?(Array)
|
72
72
|
self.time_ranges = value
|
73
73
|
end
|
74
74
|
end
|
@@ -47,6 +47,28 @@ module UltracartClient
|
|
47
47
|
# Voicemail say voice
|
48
48
|
attr_accessor :voicemail_say_voice
|
49
49
|
|
50
|
+
class EnumAttributeValidator
|
51
|
+
attr_reader :datatype
|
52
|
+
attr_reader :allowable_values
|
53
|
+
|
54
|
+
def initialize(datatype, allowable_values)
|
55
|
+
@allowable_values = allowable_values.map do |value|
|
56
|
+
case datatype.to_s
|
57
|
+
when /Integer/i
|
58
|
+
value.to_i
|
59
|
+
when /Float/i
|
60
|
+
value.to_f
|
61
|
+
else
|
62
|
+
value
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
def valid?(value)
|
68
|
+
!value || allowable_values.include?(value)
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
50
72
|
# Attribute mapping from ruby-style variable name to JSON key.
|
51
73
|
def self.attribute_map
|
52
74
|
{
|
@@ -181,6 +203,8 @@ module UltracartClient
|
|
181
203
|
return false if !@send_notices_to_email.nil? && @send_notices_to_email.to_s.length > 250
|
182
204
|
return false if !@voicemail_follow_play_audio_uuid.nil? && @voicemail_follow_play_audio_uuid.to_s.length > 50
|
183
205
|
return false if !@voicemail_mailbox_id.nil? && @voicemail_mailbox_id.to_s.length > 50
|
206
|
+
voicemail_mailbox_type_validator = EnumAttributeValidator.new('String', ['agent', 'shared'])
|
207
|
+
return false unless voicemail_mailbox_type_validator.valid?(@voicemail_mailbox_type)
|
184
208
|
return false if !@voicemail_mailbox_type.nil? && @voicemail_mailbox_type.to_s.length > 50
|
185
209
|
return false if !@voicemail_prompt_play_audio_uuid.nil? && @voicemail_prompt_play_audio_uuid.to_s.length > 50
|
186
210
|
return false if !@voicemail_say_voice.nil? && @voicemail_say_voice.to_s.length > 50
|
@@ -237,13 +261,13 @@ module UltracartClient
|
|
237
261
|
@voicemail_mailbox_id = voicemail_mailbox_id
|
238
262
|
end
|
239
263
|
|
240
|
-
# Custom attribute writer method
|
241
|
-
# @param [Object] voicemail_mailbox_type
|
264
|
+
# Custom attribute writer method checking allowed values (enum).
|
265
|
+
# @param [Object] voicemail_mailbox_type Object to be assigned
|
242
266
|
def voicemail_mailbox_type=(voicemail_mailbox_type)
|
243
|
-
|
244
|
-
|
267
|
+
validator = EnumAttributeValidator.new('String', ['agent', 'shared'])
|
268
|
+
unless validator.valid?(voicemail_mailbox_type)
|
269
|
+
fail ArgumentError, 'invalid value for "voicemail_mailbox_type", must be one of #{validator.allowable_values}.'
|
245
270
|
end
|
246
|
-
|
247
271
|
@voicemail_mailbox_type = voicemail_mailbox_type
|
248
272
|
end
|
249
273
|
|
@@ -31,7 +31,7 @@ module UltracartClient
|
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
33
|
:'success' => :'success',
|
34
|
-
:'voicemail_mailbox' => :'
|
34
|
+
:'voicemail_mailbox' => :'voicemail_mailbox',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
37
37
|
end
|
@@ -67,8 +67,8 @@ module UltracartClient
|
|
67
67
|
self.success = attributes[:'success']
|
68
68
|
end
|
69
69
|
|
70
|
-
if attributes.has_key?(:'
|
71
|
-
self.voicemail_mailbox = attributes[:'
|
70
|
+
if attributes.has_key?(:'voicemail_mailbox')
|
71
|
+
self.voicemail_mailbox = attributes[:'voicemail_mailbox']
|
72
72
|
end
|
73
73
|
|
74
74
|
if attributes.has_key?(:'warning')
|
@@ -31,7 +31,7 @@ module UltracartClient
|
|
31
31
|
:'error' => :'error',
|
32
32
|
:'metadata' => :'metadata',
|
33
33
|
:'success' => :'success',
|
34
|
-
:'voicemail_mailboxes' => :'
|
34
|
+
:'voicemail_mailboxes' => :'voicemail_mailboxes',
|
35
35
|
:'warning' => :'warning'
|
36
36
|
}
|
37
37
|
end
|
@@ -67,8 +67,8 @@ module UltracartClient
|
|
67
67
|
self.success = attributes[:'success']
|
68
68
|
end
|
69
69
|
|
70
|
-
if attributes.has_key?(:'
|
71
|
-
if (value = attributes[:'
|
70
|
+
if attributes.has_key?(:'voicemail_mailboxes')
|
71
|
+
if (value = attributes[:'voicemail_mailboxes']).is_a?(Array)
|
72
72
|
self.voicemail_mailboxes = value
|
73
73
|
end
|
74
74
|
end
|