ultracart_api 4.0.85.rc → 4.0.87.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/docs/ConversationApi.md +72 -0
- data/docs/ConversationWebchatContext.md +26 -0
- data/docs/CouponPercentOffMsrpItems.md +5 -1
- data/docs/HitPageView.md +38 -0
- data/docs/HitPageViewMetaData.md +20 -0
- data/docs/HitSessionStart.md +50 -0
- data/docs/HitSessionUtm.md +46 -0
- data/lib/ultracart_api/api/conversation_api.rb +64 -0
- data/lib/ultracart_api/models/conversation_webchat_context.rb +257 -0
- data/lib/ultracart_api/models/conversation_websocket_message.rb +2 -2
- data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +24 -4
- data/lib/ultracart_api/models/hit_page_view.rb +311 -0
- data/lib/ultracart_api/models/hit_page_view_meta_data.rb +228 -0
- data/lib/ultracart_api/models/hit_session_start.rb +363 -0
- data/lib/ultracart_api/models/hit_session_utm.rb +345 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +11 -1
@@ -0,0 +1,345 @@
|
|
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 HitSessionUtm
|
18
|
+
attr_accessor :fb_ad_id
|
19
|
+
|
20
|
+
attr_accessor :fbclid
|
21
|
+
|
22
|
+
attr_accessor :gbraid
|
23
|
+
|
24
|
+
attr_accessor :gclid
|
25
|
+
|
26
|
+
attr_accessor :msclkid
|
27
|
+
|
28
|
+
attr_accessor :ttclid
|
29
|
+
|
30
|
+
attr_accessor :uc_message_id
|
31
|
+
|
32
|
+
attr_accessor :utm_campaign
|
33
|
+
|
34
|
+
attr_accessor :utm_content
|
35
|
+
|
36
|
+
attr_accessor :utm_id
|
37
|
+
|
38
|
+
attr_accessor :utm_medium
|
39
|
+
|
40
|
+
attr_accessor :utm_source
|
41
|
+
|
42
|
+
attr_accessor :utm_term
|
43
|
+
|
44
|
+
attr_accessor :vmcid
|
45
|
+
|
46
|
+
attr_accessor :wbraid
|
47
|
+
|
48
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
49
|
+
def self.attribute_map
|
50
|
+
{
|
51
|
+
:'fb_ad_id' => :'fb_ad_id',
|
52
|
+
:'fbclid' => :'fbclid',
|
53
|
+
:'gbraid' => :'gbraid',
|
54
|
+
:'gclid' => :'gclid',
|
55
|
+
:'msclkid' => :'msclkid',
|
56
|
+
:'ttclid' => :'ttclid',
|
57
|
+
:'uc_message_id' => :'uc_message_id',
|
58
|
+
:'utm_campaign' => :'utm_campaign',
|
59
|
+
:'utm_content' => :'utm_content',
|
60
|
+
:'utm_id' => :'utm_id',
|
61
|
+
:'utm_medium' => :'utm_medium',
|
62
|
+
:'utm_source' => :'utm_source',
|
63
|
+
:'utm_term' => :'utm_term',
|
64
|
+
:'vmcid' => :'vmcid',
|
65
|
+
:'wbraid' => :'wbraid'
|
66
|
+
}
|
67
|
+
end
|
68
|
+
|
69
|
+
# Returns all the JSON keys this model knows about
|
70
|
+
def self.acceptable_attributes
|
71
|
+
attribute_map.values
|
72
|
+
end
|
73
|
+
|
74
|
+
# Attribute type mapping.
|
75
|
+
def self.openapi_types
|
76
|
+
{
|
77
|
+
:'fb_ad_id' => :'String',
|
78
|
+
:'fbclid' => :'String',
|
79
|
+
:'gbraid' => :'String',
|
80
|
+
:'gclid' => :'String',
|
81
|
+
:'msclkid' => :'String',
|
82
|
+
:'ttclid' => :'String',
|
83
|
+
:'uc_message_id' => :'String',
|
84
|
+
:'utm_campaign' => :'String',
|
85
|
+
:'utm_content' => :'String',
|
86
|
+
:'utm_id' => :'String',
|
87
|
+
:'utm_medium' => :'String',
|
88
|
+
:'utm_source' => :'String',
|
89
|
+
:'utm_term' => :'String',
|
90
|
+
:'vmcid' => :'String',
|
91
|
+
:'wbraid' => :'String'
|
92
|
+
}
|
93
|
+
end
|
94
|
+
|
95
|
+
# List of attributes with nullable: true
|
96
|
+
def self.openapi_nullable
|
97
|
+
Set.new([
|
98
|
+
])
|
99
|
+
end
|
100
|
+
|
101
|
+
# Initializes the object
|
102
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
103
|
+
def initialize(attributes = {})
|
104
|
+
if (!attributes.is_a?(Hash))
|
105
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::HitSessionUtm` initialize method"
|
106
|
+
end
|
107
|
+
|
108
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
109
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
110
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
111
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::HitSessionUtm`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
112
|
+
end
|
113
|
+
h[k.to_sym] = v
|
114
|
+
}
|
115
|
+
|
116
|
+
if attributes.key?(:'fb_ad_id')
|
117
|
+
self.fb_ad_id = attributes[:'fb_ad_id']
|
118
|
+
end
|
119
|
+
|
120
|
+
if attributes.key?(:'fbclid')
|
121
|
+
self.fbclid = attributes[:'fbclid']
|
122
|
+
end
|
123
|
+
|
124
|
+
if attributes.key?(:'gbraid')
|
125
|
+
self.gbraid = attributes[:'gbraid']
|
126
|
+
end
|
127
|
+
|
128
|
+
if attributes.key?(:'gclid')
|
129
|
+
self.gclid = attributes[:'gclid']
|
130
|
+
end
|
131
|
+
|
132
|
+
if attributes.key?(:'msclkid')
|
133
|
+
self.msclkid = attributes[:'msclkid']
|
134
|
+
end
|
135
|
+
|
136
|
+
if attributes.key?(:'ttclid')
|
137
|
+
self.ttclid = attributes[:'ttclid']
|
138
|
+
end
|
139
|
+
|
140
|
+
if attributes.key?(:'uc_message_id')
|
141
|
+
self.uc_message_id = attributes[:'uc_message_id']
|
142
|
+
end
|
143
|
+
|
144
|
+
if attributes.key?(:'utm_campaign')
|
145
|
+
self.utm_campaign = attributes[:'utm_campaign']
|
146
|
+
end
|
147
|
+
|
148
|
+
if attributes.key?(:'utm_content')
|
149
|
+
self.utm_content = attributes[:'utm_content']
|
150
|
+
end
|
151
|
+
|
152
|
+
if attributes.key?(:'utm_id')
|
153
|
+
self.utm_id = attributes[:'utm_id']
|
154
|
+
end
|
155
|
+
|
156
|
+
if attributes.key?(:'utm_medium')
|
157
|
+
self.utm_medium = attributes[:'utm_medium']
|
158
|
+
end
|
159
|
+
|
160
|
+
if attributes.key?(:'utm_source')
|
161
|
+
self.utm_source = attributes[:'utm_source']
|
162
|
+
end
|
163
|
+
|
164
|
+
if attributes.key?(:'utm_term')
|
165
|
+
self.utm_term = attributes[:'utm_term']
|
166
|
+
end
|
167
|
+
|
168
|
+
if attributes.key?(:'vmcid')
|
169
|
+
self.vmcid = attributes[:'vmcid']
|
170
|
+
end
|
171
|
+
|
172
|
+
if attributes.key?(:'wbraid')
|
173
|
+
self.wbraid = attributes[:'wbraid']
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
178
|
+
# @return Array for valid properties with the reasons
|
179
|
+
def list_invalid_properties
|
180
|
+
invalid_properties = Array.new
|
181
|
+
invalid_properties
|
182
|
+
end
|
183
|
+
|
184
|
+
# Check to see if the all the properties in the model are valid
|
185
|
+
# @return true if the model is valid
|
186
|
+
def valid?
|
187
|
+
true
|
188
|
+
end
|
189
|
+
|
190
|
+
# Checks equality by comparing each attribute.
|
191
|
+
# @param [Object] Object to be compared
|
192
|
+
def ==(o)
|
193
|
+
return true if self.equal?(o)
|
194
|
+
self.class == o.class &&
|
195
|
+
fb_ad_id == o.fb_ad_id &&
|
196
|
+
fbclid == o.fbclid &&
|
197
|
+
gbraid == o.gbraid &&
|
198
|
+
gclid == o.gclid &&
|
199
|
+
msclkid == o.msclkid &&
|
200
|
+
ttclid == o.ttclid &&
|
201
|
+
uc_message_id == o.uc_message_id &&
|
202
|
+
utm_campaign == o.utm_campaign &&
|
203
|
+
utm_content == o.utm_content &&
|
204
|
+
utm_id == o.utm_id &&
|
205
|
+
utm_medium == o.utm_medium &&
|
206
|
+
utm_source == o.utm_source &&
|
207
|
+
utm_term == o.utm_term &&
|
208
|
+
vmcid == o.vmcid &&
|
209
|
+
wbraid == o.wbraid
|
210
|
+
end
|
211
|
+
|
212
|
+
# @see the `==` method
|
213
|
+
# @param [Object] Object to be compared
|
214
|
+
def eql?(o)
|
215
|
+
self == o
|
216
|
+
end
|
217
|
+
|
218
|
+
# Calculates hash code according to all attributes.
|
219
|
+
# @return [Integer] Hash code
|
220
|
+
def hash
|
221
|
+
[fb_ad_id, fbclid, gbraid, gclid, msclkid, ttclid, uc_message_id, utm_campaign, utm_content, utm_id, utm_medium, utm_source, utm_term, vmcid, wbraid].hash
|
222
|
+
end
|
223
|
+
|
224
|
+
# Builds the object from hash
|
225
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
226
|
+
# @return [Object] Returns the model itself
|
227
|
+
def self.build_from_hash(attributes)
|
228
|
+
new.build_from_hash(attributes)
|
229
|
+
end
|
230
|
+
|
231
|
+
# Builds the object from hash
|
232
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
233
|
+
# @return [Object] Returns the model itself
|
234
|
+
def build_from_hash(attributes)
|
235
|
+
return nil unless attributes.is_a?(Hash)
|
236
|
+
attributes = attributes.transform_keys(&:to_sym)
|
237
|
+
self.class.openapi_types.each_pair do |key, type|
|
238
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
239
|
+
self.send("#{key}=", nil)
|
240
|
+
elsif type =~ /\AArray<(.*)>/i
|
241
|
+
# check to ensure the input is an array given that the attribute
|
242
|
+
# is documented as an array but the input is not
|
243
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
244
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
245
|
+
end
|
246
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
247
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
248
|
+
end
|
249
|
+
end
|
250
|
+
|
251
|
+
self
|
252
|
+
end
|
253
|
+
|
254
|
+
# Deserializes the data based on type
|
255
|
+
# @param string type Data type
|
256
|
+
# @param string value Value to be deserialized
|
257
|
+
# @return [Object] Deserialized data
|
258
|
+
def _deserialize(type, value)
|
259
|
+
case type.to_sym
|
260
|
+
when :Time
|
261
|
+
Time.parse(value)
|
262
|
+
when :Date
|
263
|
+
Date.parse(value)
|
264
|
+
when :String
|
265
|
+
value.to_s
|
266
|
+
when :Integer
|
267
|
+
value.to_i
|
268
|
+
when :Float
|
269
|
+
value.to_f
|
270
|
+
when :Boolean
|
271
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
272
|
+
true
|
273
|
+
else
|
274
|
+
false
|
275
|
+
end
|
276
|
+
when :Object
|
277
|
+
# generic object (usually a Hash), return directly
|
278
|
+
value
|
279
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
280
|
+
inner_type = Regexp.last_match[:inner_type]
|
281
|
+
value.map { |v| _deserialize(inner_type, v) }
|
282
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
283
|
+
k_type = Regexp.last_match[:k_type]
|
284
|
+
v_type = Regexp.last_match[:v_type]
|
285
|
+
{}.tap do |hash|
|
286
|
+
value.each do |k, v|
|
287
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
288
|
+
end
|
289
|
+
end
|
290
|
+
else # model
|
291
|
+
# models (e.g. Pet) or oneOf
|
292
|
+
klass = UltracartClient.const_get(type)
|
293
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
294
|
+
end
|
295
|
+
end
|
296
|
+
|
297
|
+
# Returns the string representation of the object
|
298
|
+
# @return [String] String presentation of the object
|
299
|
+
def to_s
|
300
|
+
to_hash.to_s
|
301
|
+
end
|
302
|
+
|
303
|
+
# to_body is an alias to to_hash (backward compatibility)
|
304
|
+
# @return [Hash] Returns the object in the form of hash
|
305
|
+
def to_body
|
306
|
+
to_hash
|
307
|
+
end
|
308
|
+
|
309
|
+
# Returns the object in the form of hash
|
310
|
+
# @return [Hash] Returns the object in the form of hash
|
311
|
+
def to_hash
|
312
|
+
hash = {}
|
313
|
+
self.class.attribute_map.each_pair do |attr, param|
|
314
|
+
value = self.send(attr)
|
315
|
+
if value.nil?
|
316
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
317
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
318
|
+
end
|
319
|
+
|
320
|
+
hash[param] = _to_hash(value)
|
321
|
+
end
|
322
|
+
hash
|
323
|
+
end
|
324
|
+
|
325
|
+
# Outputs non-array value in the form of hash
|
326
|
+
# For object, use to_hash. Otherwise, just return the value
|
327
|
+
# @param [Object] value Any valid value
|
328
|
+
# @return [Hash] Returns the value in the form of hash
|
329
|
+
def _to_hash(value)
|
330
|
+
if value.is_a?(Array)
|
331
|
+
value.compact.map { |v| _to_hash(v) }
|
332
|
+
elsif value.is_a?(Hash)
|
333
|
+
{}.tap do |hash|
|
334
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
335
|
+
end
|
336
|
+
elsif value.respond_to? :to_hash
|
337
|
+
value.to_hash
|
338
|
+
else
|
339
|
+
value
|
340
|
+
end
|
341
|
+
end
|
342
|
+
|
343
|
+
end
|
344
|
+
|
345
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -155,6 +155,7 @@ require 'ultracart_api/models/conversation_start_request'
|
|
155
155
|
require 'ultracart_api/models/conversation_start_response'
|
156
156
|
require 'ultracart_api/models/conversation_summary'
|
157
157
|
require 'ultracart_api/models/conversation_twilio_account'
|
158
|
+
require 'ultracart_api/models/conversation_webchat_context'
|
158
159
|
require 'ultracart_api/models/conversation_webchat_queue_status'
|
159
160
|
require 'ultracart_api/models/conversation_webchat_queue_status_agent'
|
160
161
|
require 'ultracart_api/models/conversation_webchat_queue_status_queue_entry'
|
@@ -407,6 +408,10 @@ require 'ultracart_api/models/group_response'
|
|
407
408
|
require 'ultracart_api/models/group_user_membership'
|
408
409
|
require 'ultracart_api/models/groups_response'
|
409
410
|
require 'ultracart_api/models/http_header'
|
411
|
+
require 'ultracart_api/models/hit_page_view'
|
412
|
+
require 'ultracart_api/models/hit_page_view_meta_data'
|
413
|
+
require 'ultracart_api/models/hit_session_start'
|
414
|
+
require 'ultracart_api/models/hit_session_utm'
|
410
415
|
require 'ultracart_api/models/integration_log'
|
411
416
|
require 'ultracart_api/models/integration_log_file'
|
412
417
|
require 'ultracart_api/models/integration_log_log'
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.
|
4
|
+
version: 4.0.87.rc
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
@@ -205,6 +205,7 @@ files:
|
|
205
205
|
- docs/ConversationStartResponse.md
|
206
206
|
- docs/ConversationSummary.md
|
207
207
|
- docs/ConversationTwilioAccount.md
|
208
|
+
- docs/ConversationWebchatContext.md
|
208
209
|
- docs/ConversationWebchatQueueStatus.md
|
209
210
|
- docs/ConversationWebchatQueueStatusAgent.md
|
210
211
|
- docs/ConversationWebchatQueueStatusQueueEntry.md
|
@@ -461,6 +462,10 @@ files:
|
|
461
462
|
- docs/GroupUserMembership.md
|
462
463
|
- docs/GroupsResponse.md
|
463
464
|
- docs/HTTPHeader.md
|
465
|
+
- docs/HitPageView.md
|
466
|
+
- docs/HitPageViewMetaData.md
|
467
|
+
- docs/HitSessionStart.md
|
468
|
+
- docs/HitSessionUtm.md
|
464
469
|
- docs/IntegrationLog.md
|
465
470
|
- docs/IntegrationLogApi.md
|
466
471
|
- docs/IntegrationLogFile.md
|
@@ -928,6 +933,7 @@ files:
|
|
928
933
|
- lib/ultracart_api/models/conversation_start_response.rb
|
929
934
|
- lib/ultracart_api/models/conversation_summary.rb
|
930
935
|
- lib/ultracart_api/models/conversation_twilio_account.rb
|
936
|
+
- lib/ultracart_api/models/conversation_webchat_context.rb
|
931
937
|
- lib/ultracart_api/models/conversation_webchat_queue_status.rb
|
932
938
|
- lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb
|
933
939
|
- lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb
|
@@ -1179,6 +1185,10 @@ files:
|
|
1179
1185
|
- lib/ultracart_api/models/group_response.rb
|
1180
1186
|
- lib/ultracart_api/models/group_user_membership.rb
|
1181
1187
|
- lib/ultracart_api/models/groups_response.rb
|
1188
|
+
- lib/ultracart_api/models/hit_page_view.rb
|
1189
|
+
- lib/ultracart_api/models/hit_page_view_meta_data.rb
|
1190
|
+
- lib/ultracart_api/models/hit_session_start.rb
|
1191
|
+
- lib/ultracart_api/models/hit_session_utm.rb
|
1182
1192
|
- lib/ultracart_api/models/http_header.rb
|
1183
1193
|
- lib/ultracart_api/models/integration_log.rb
|
1184
1194
|
- lib/ultracart_api/models/integration_log_file.rb
|