ultracart_api 4.0.96.rc → 4.0.98.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -4
  3. data/docs/ConversationApi.md +583 -5
  4. data/docs/ConversationAutocompleteRequest.md +20 -0
  5. data/docs/ConversationAutocompleteResponse.md +30 -0
  6. data/docs/ConversationCannedMessage.md +1 -1
  7. data/docs/ConversationDepartment.md +26 -0
  8. data/docs/ConversationDepartmentResponse.md +26 -0
  9. data/docs/ConversationDepartmentsResponse.md +26 -0
  10. data/docs/ConversationEngagement.md +30 -0
  11. data/docs/ConversationEngagementResponse.md +26 -0
  12. data/docs/ConversationEngagementsResponse.md +26 -0
  13. data/docs/ConversationJoinRequest.md +18 -0
  14. data/docs/ConversationParticipant.md +4 -0
  15. data/docs/ConversationSearchRequest.md +36 -0
  16. data/docs/ConversationSearchResponse.md +22 -0
  17. data/docs/ConversationWebchatQueueStatusQueueEntry.md +2 -0
  18. data/lib/ultracart_api/api/conversation_api.rb +550 -1
  19. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +228 -0
  20. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +276 -0
  21. data/lib/ultracart_api/models/conversation_canned_message.rb +1 -1
  22. data/lib/ultracart_api/models/conversation_department.rb +255 -0
  23. data/lib/ultracart_api/models/conversation_department_response.rb +256 -0
  24. data/lib/ultracart_api/models/conversation_departments_response.rb +258 -0
  25. data/lib/ultracart_api/models/conversation_engagement.rb +275 -0
  26. data/lib/ultracart_api/models/conversation_engagement_response.rb +256 -0
  27. data/lib/ultracart_api/models/conversation_engagements_response.rb +258 -0
  28. data/lib/ultracart_api/models/conversation_join_request.rb +219 -0
  29. data/lib/ultracart_api/models/conversation_participant.rb +19 -1
  30. data/lib/ultracart_api/models/conversation_search_request.rb +300 -0
  31. data/lib/ultracart_api/models/conversation_search_response.rb +237 -0
  32. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +10 -1
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +11 -0
  35. metadata +24 -2
@@ -0,0 +1,237 @@
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 ConversationSearchResponse
18
+ attr_accessor :range_begin
19
+
20
+ attr_accessor :range_end
21
+
22
+ attr_accessor :total
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'range_begin' => :'range_begin',
28
+ :'range_end' => :'range_end',
29
+ :'total' => :'total'
30
+ }
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'range_begin' => :'Integer',
42
+ :'range_end' => :'Integer',
43
+ :'total' => :'Integer'
44
+ }
45
+ end
46
+
47
+ # List of attributes with nullable: true
48
+ def self.openapi_nullable
49
+ Set.new([
50
+ ])
51
+ end
52
+
53
+ # Initializes the object
54
+ # @param [Hash] attributes Model attributes in the form of hash
55
+ def initialize(attributes = {})
56
+ if (!attributes.is_a?(Hash))
57
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationSearchResponse` initialize method"
58
+ end
59
+
60
+ # check to see if the attribute exists and convert string to symbol for hash key
61
+ attributes = attributes.each_with_object({}) { |(k, v), h|
62
+ if (!self.class.attribute_map.key?(k.to_sym))
63
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationSearchResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
64
+ end
65
+ h[k.to_sym] = v
66
+ }
67
+
68
+ if attributes.key?(:'range_begin')
69
+ self.range_begin = attributes[:'range_begin']
70
+ end
71
+
72
+ if attributes.key?(:'range_end')
73
+ self.range_end = attributes[:'range_end']
74
+ end
75
+
76
+ if attributes.key?(:'total')
77
+ self.total = attributes[:'total']
78
+ end
79
+ end
80
+
81
+ # Show invalid properties with the reasons. Usually used together with valid?
82
+ # @return Array for valid properties with the reasons
83
+ def list_invalid_properties
84
+ invalid_properties = Array.new
85
+ invalid_properties
86
+ end
87
+
88
+ # Check to see if the all the properties in the model are valid
89
+ # @return true if the model is valid
90
+ def valid?
91
+ true
92
+ end
93
+
94
+ # Checks equality by comparing each attribute.
95
+ # @param [Object] Object to be compared
96
+ def ==(o)
97
+ return true if self.equal?(o)
98
+ self.class == o.class &&
99
+ range_begin == o.range_begin &&
100
+ range_end == o.range_end &&
101
+ total == o.total
102
+ end
103
+
104
+ # @see the `==` method
105
+ # @param [Object] Object to be compared
106
+ def eql?(o)
107
+ self == o
108
+ end
109
+
110
+ # Calculates hash code according to all attributes.
111
+ # @return [Integer] Hash code
112
+ def hash
113
+ [range_begin, range_end, total].hash
114
+ end
115
+
116
+ # Builds the object from hash
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ # @return [Object] Returns the model itself
119
+ def self.build_from_hash(attributes)
120
+ new.build_from_hash(attributes)
121
+ end
122
+
123
+ # Builds the object from hash
124
+ # @param [Hash] attributes Model attributes in the form of hash
125
+ # @return [Object] Returns the model itself
126
+ def build_from_hash(attributes)
127
+ return nil unless attributes.is_a?(Hash)
128
+ attributes = attributes.transform_keys(&:to_sym)
129
+ self.class.openapi_types.each_pair do |key, type|
130
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
131
+ self.send("#{key}=", nil)
132
+ elsif type =~ /\AArray<(.*)>/i
133
+ # check to ensure the input is an array given that the attribute
134
+ # is documented as an array but the input is not
135
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
136
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
137
+ end
138
+ elsif !attributes[self.class.attribute_map[key]].nil?
139
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
140
+ end
141
+ end
142
+
143
+ self
144
+ end
145
+
146
+ # Deserializes the data based on type
147
+ # @param string type Data type
148
+ # @param string value Value to be deserialized
149
+ # @return [Object] Deserialized data
150
+ def _deserialize(type, value)
151
+ case type.to_sym
152
+ when :Time
153
+ Time.parse(value)
154
+ when :Date
155
+ Date.parse(value)
156
+ when :String
157
+ value.to_s
158
+ when :Integer
159
+ value.to_i
160
+ when :Float
161
+ value.to_f
162
+ when :Boolean
163
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
164
+ true
165
+ else
166
+ false
167
+ end
168
+ when :Object
169
+ # generic object (usually a Hash), return directly
170
+ value
171
+ when /\AArray<(?<inner_type>.+)>\z/
172
+ inner_type = Regexp.last_match[:inner_type]
173
+ value.map { |v| _deserialize(inner_type, v) }
174
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
175
+ k_type = Regexp.last_match[:k_type]
176
+ v_type = Regexp.last_match[:v_type]
177
+ {}.tap do |hash|
178
+ value.each do |k, v|
179
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
180
+ end
181
+ end
182
+ else # model
183
+ # models (e.g. Pet) or oneOf
184
+ klass = UltracartClient.const_get(type)
185
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
186
+ end
187
+ end
188
+
189
+ # Returns the string representation of the object
190
+ # @return [String] String presentation of the object
191
+ def to_s
192
+ to_hash.to_s
193
+ end
194
+
195
+ # to_body is an alias to to_hash (backward compatibility)
196
+ # @return [Hash] Returns the object in the form of hash
197
+ def to_body
198
+ to_hash
199
+ end
200
+
201
+ # Returns the object in the form of hash
202
+ # @return [Hash] Returns the object in the form of hash
203
+ def to_hash
204
+ hash = {}
205
+ self.class.attribute_map.each_pair do |attr, param|
206
+ value = self.send(attr)
207
+ if value.nil?
208
+ is_nullable = self.class.openapi_nullable.include?(attr)
209
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
210
+ end
211
+
212
+ hash[param] = _to_hash(value)
213
+ end
214
+ hash
215
+ end
216
+
217
+ # Outputs non-array value in the form of hash
218
+ # For object, use to_hash. Otherwise, just return the value
219
+ # @param [Object] value Any valid value
220
+ # @return [Hash] Returns the value in the form of hash
221
+ def _to_hash(value)
222
+ if value.is_a?(Array)
223
+ value.compact.map { |v| _to_hash(v) }
224
+ elsif value.is_a?(Hash)
225
+ {}.tap do |hash|
226
+ value.each { |k, v| hash[k] = _to_hash(v) }
227
+ end
228
+ elsif value.respond_to? :to_hash
229
+ value.to_hash
230
+ else
231
+ value
232
+ end
233
+ end
234
+
235
+ end
236
+
237
+ end
@@ -26,6 +26,8 @@ module UltracartClient
26
26
  # Date/time the customer joined the queue
27
27
  attr_accessor :join_dts
28
28
 
29
+ attr_accessor :participant_language_iso_code
30
+
29
31
  attr_accessor :question
30
32
 
31
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,6 +38,7 @@ module UltracartClient
36
38
  :'conversation_webchat_queue_uuid' => :'conversation_webchat_queue_uuid',
37
39
  :'email' => :'email',
38
40
  :'join_dts' => :'join_dts',
41
+ :'participant_language_iso_code' => :'participant_language_iso_code',
39
42
  :'question' => :'question'
40
43
  }
41
44
  end
@@ -53,6 +56,7 @@ module UltracartClient
53
56
  :'conversation_webchat_queue_uuid' => :'String',
54
57
  :'email' => :'String',
55
58
  :'join_dts' => :'String',
59
+ :'participant_language_iso_code' => :'String',
56
60
  :'question' => :'String'
57
61
  }
58
62
  end
@@ -98,6 +102,10 @@ module UltracartClient
98
102
  self.join_dts = attributes[:'join_dts']
99
103
  end
100
104
 
105
+ if attributes.key?(:'participant_language_iso_code')
106
+ self.participant_language_iso_code = attributes[:'participant_language_iso_code']
107
+ end
108
+
101
109
  if attributes.key?(:'question')
102
110
  self.question = attributes[:'question']
103
111
  end
@@ -126,6 +134,7 @@ module UltracartClient
126
134
  conversation_webchat_queue_uuid == o.conversation_webchat_queue_uuid &&
127
135
  email == o.email &&
128
136
  join_dts == o.join_dts &&
137
+ participant_language_iso_code == o.participant_language_iso_code &&
129
138
  question == o.question
130
139
  end
131
140
 
@@ -138,7 +147,7 @@ module UltracartClient
138
147
  # Calculates hash code according to all attributes.
139
148
  # @return [Integer] Hash code
140
149
  def hash
141
- [conversation_participant_arn, conversation_participant_name, conversation_webchat_queue_uuid, email, join_dts, question].hash
150
+ [conversation_participant_arn, conversation_participant_name, conversation_webchat_queue_uuid, email, join_dts, participant_language_iso_code, question].hash
142
151
  end
143
152
 
144
153
  # 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.0.96.rc'
14
+ VERSION = '4.0.98.rc'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -138,10 +138,18 @@ require 'ultracart_api/models/city_state_zip'
138
138
  require 'ultracart_api/models/conversation'
139
139
  require 'ultracart_api/models/conversation_agent_auth'
140
140
  require 'ultracart_api/models/conversation_agent_auth_response'
141
+ require 'ultracart_api/models/conversation_autocomplete_request'
142
+ require 'ultracart_api/models/conversation_autocomplete_response'
141
143
  require 'ultracart_api/models/conversation_canned_message'
142
144
  require 'ultracart_api/models/conversation_canned_message_response'
143
145
  require 'ultracart_api/models/conversation_canned_messages_response'
144
146
  require 'ultracart_api/models/conversation_canned_messages_search'
147
+ require 'ultracart_api/models/conversation_department'
148
+ require 'ultracart_api/models/conversation_department_response'
149
+ require 'ultracart_api/models/conversation_departments_response'
150
+ require 'ultracart_api/models/conversation_engagement'
151
+ require 'ultracart_api/models/conversation_engagement_response'
152
+ require 'ultracart_api/models/conversation_engagements_response'
145
153
  require 'ultracart_api/models/conversation_event_add_coupon'
146
154
  require 'ultracart_api/models/conversation_event_add_item'
147
155
  require 'ultracart_api/models/conversation_event_queue_position'
@@ -149,6 +157,7 @@ require 'ultracart_api/models/conversation_event_rr_web'
149
157
  require 'ultracart_api/models/conversation_event_read_message'
150
158
  require 'ultracart_api/models/conversation_event_typing'
151
159
  require 'ultracart_api/models/conversation_event_webchat_context'
160
+ require 'ultracart_api/models/conversation_join_request'
152
161
  require 'ultracart_api/models/conversation_message'
153
162
  require 'ultracart_api/models/conversation_message_translation'
154
163
  require 'ultracart_api/models/conversation_message_transport_status'
@@ -157,6 +166,8 @@ require 'ultracart_api/models/conversation_multimedia_upload_url'
157
166
  require 'ultracart_api/models/conversation_multimedia_upload_url_response'
158
167
  require 'ultracart_api/models/conversation_participant'
159
168
  require 'ultracart_api/models/conversation_response'
169
+ require 'ultracart_api/models/conversation_search_request'
170
+ require 'ultracart_api/models/conversation_search_response'
160
171
  require 'ultracart_api/models/conversation_start_request'
161
172
  require 'ultracart_api/models/conversation_start_response'
162
173
  require 'ultracart_api/models/conversation_summary'
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.0.96.rc
4
+ version: 4.0.98.rc
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-12-09 00:00:00.000000000 Z
11
+ date: 2022-12-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -188,10 +188,18 @@ files:
188
188
  - docs/ConversationAgentAuth.md
189
189
  - docs/ConversationAgentAuthResponse.md
190
190
  - docs/ConversationApi.md
191
+ - docs/ConversationAutocompleteRequest.md
192
+ - docs/ConversationAutocompleteResponse.md
191
193
  - docs/ConversationCannedMessage.md
192
194
  - docs/ConversationCannedMessageResponse.md
193
195
  - docs/ConversationCannedMessagesResponse.md
194
196
  - docs/ConversationCannedMessagesSearch.md
197
+ - docs/ConversationDepartment.md
198
+ - docs/ConversationDepartmentResponse.md
199
+ - docs/ConversationDepartmentsResponse.md
200
+ - docs/ConversationEngagement.md
201
+ - docs/ConversationEngagementResponse.md
202
+ - docs/ConversationEngagementsResponse.md
195
203
  - docs/ConversationEventAddCoupon.md
196
204
  - docs/ConversationEventAddItem.md
197
205
  - docs/ConversationEventQueuePosition.md
@@ -199,6 +207,7 @@ files:
199
207
  - docs/ConversationEventReadMessage.md
200
208
  - docs/ConversationEventTyping.md
201
209
  - docs/ConversationEventWebchatContext.md
210
+ - docs/ConversationJoinRequest.md
202
211
  - docs/ConversationMessage.md
203
212
  - docs/ConversationMessageTranslation.md
204
213
  - docs/ConversationMessageTransportStatus.md
@@ -207,6 +216,8 @@ files:
207
216
  - docs/ConversationMultimediaUploadUrlResponse.md
208
217
  - docs/ConversationParticipant.md
209
218
  - docs/ConversationResponse.md
219
+ - docs/ConversationSearchRequest.md
220
+ - docs/ConversationSearchResponse.md
210
221
  - docs/ConversationStartRequest.md
211
222
  - docs/ConversationStartResponse.md
212
223
  - docs/ConversationSummary.md
@@ -923,10 +934,18 @@ files:
923
934
  - lib/ultracart_api/models/conversation.rb
924
935
  - lib/ultracart_api/models/conversation_agent_auth.rb
925
936
  - lib/ultracart_api/models/conversation_agent_auth_response.rb
937
+ - lib/ultracart_api/models/conversation_autocomplete_request.rb
938
+ - lib/ultracart_api/models/conversation_autocomplete_response.rb
926
939
  - lib/ultracart_api/models/conversation_canned_message.rb
927
940
  - lib/ultracart_api/models/conversation_canned_message_response.rb
928
941
  - lib/ultracart_api/models/conversation_canned_messages_response.rb
929
942
  - lib/ultracart_api/models/conversation_canned_messages_search.rb
943
+ - lib/ultracart_api/models/conversation_department.rb
944
+ - lib/ultracart_api/models/conversation_department_response.rb
945
+ - lib/ultracart_api/models/conversation_departments_response.rb
946
+ - lib/ultracart_api/models/conversation_engagement.rb
947
+ - lib/ultracart_api/models/conversation_engagement_response.rb
948
+ - lib/ultracart_api/models/conversation_engagements_response.rb
930
949
  - lib/ultracart_api/models/conversation_event_add_coupon.rb
931
950
  - lib/ultracart_api/models/conversation_event_add_item.rb
932
951
  - lib/ultracart_api/models/conversation_event_queue_position.rb
@@ -934,6 +953,7 @@ files:
934
953
  - lib/ultracart_api/models/conversation_event_rr_web.rb
935
954
  - lib/ultracart_api/models/conversation_event_typing.rb
936
955
  - lib/ultracart_api/models/conversation_event_webchat_context.rb
956
+ - lib/ultracart_api/models/conversation_join_request.rb
937
957
  - lib/ultracart_api/models/conversation_message.rb
938
958
  - lib/ultracart_api/models/conversation_message_translation.rb
939
959
  - lib/ultracart_api/models/conversation_message_transport_status.rb
@@ -942,6 +962,8 @@ files:
942
962
  - lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb
943
963
  - lib/ultracart_api/models/conversation_participant.rb
944
964
  - lib/ultracart_api/models/conversation_response.rb
965
+ - lib/ultracart_api/models/conversation_search_request.rb
966
+ - lib/ultracart_api/models/conversation_search_response.rb
945
967
  - lib/ultracart_api/models/conversation_start_request.rb
946
968
  - lib/ultracart_api/models/conversation_start_response.rb
947
969
  - lib/ultracart_api/models/conversation_summary.rb