ultracart_api 3.11.22 → 3.11.23
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 +17 -4
- data/docs/ConversationApi.md +213 -0
- data/docs/ConversationDeleteKnowledgeBaseDocumentResponse.md +12 -0
- data/docs/ConversationInsertKnowledgeBaseDocumentRequest.md +8 -0
- data/docs/ConversationInsertKnowledgeBaseDocumentResponse.md +14 -0
- data/docs/ConversationKnowledgeBaseDocument.md +14 -0
- data/docs/ConversationKnowledgeBaseDocumentUploadUrl.md +9 -0
- data/docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md +12 -0
- data/docs/ConversationKnowledgeBaseDocumentsResponse.md +12 -0
- data/docs/CustomReportAccountConfig.md +1 -0
- data/docs/CustomReportUsageBreakdown.md +9 -0
- data/docs/CustomerApi.md +4 -5
- data/docs/ItemApi.md +3 -3
- data/docs/OrderApi.md +2 -2
- data/lib/ultracart_api/api/conversation_api.rb +238 -0
- data/lib/ultracart_api/api/customer_api.rb +6 -7
- data/lib/ultracart_api/api/item_api.rb +3 -3
- data/lib/ultracart_api/api/order_api.rb +2 -2
- data/lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb +184 -0
- data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb +241 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document.rb +239 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb +193 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb +224 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +12 -1
- data/lib/ultracart_api/models/custom_report_usage_breakdown.rb +194 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +8 -0
- metadata +18 -2
@@ -0,0 +1,194 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class CustomReportUsageBreakdown
|
17
|
+
attr_accessor :usage
|
18
|
+
|
19
|
+
# Date/time that usage occurred
|
20
|
+
attr_accessor :usage_date
|
21
|
+
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
23
|
+
def self.attribute_map
|
24
|
+
{
|
25
|
+
:'usage' => :'usage',
|
26
|
+
:'usage_date' => :'usage_date'
|
27
|
+
}
|
28
|
+
end
|
29
|
+
|
30
|
+
# Attribute type mapping.
|
31
|
+
def self.swagger_types
|
32
|
+
{
|
33
|
+
:'usage' => :'Float',
|
34
|
+
:'usage_date' => :'String'
|
35
|
+
}
|
36
|
+
end
|
37
|
+
|
38
|
+
# Initializes the object
|
39
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
40
|
+
def initialize(attributes = {})
|
41
|
+
return unless attributes.is_a?(Hash)
|
42
|
+
|
43
|
+
# convert string to symbol for hash key
|
44
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
45
|
+
|
46
|
+
if attributes.has_key?(:'usage')
|
47
|
+
self.usage = attributes[:'usage']
|
48
|
+
end
|
49
|
+
|
50
|
+
if attributes.has_key?(:'usage_date')
|
51
|
+
self.usage_date = attributes[:'usage_date']
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
56
|
+
# @return Array for valid properties with the reasons
|
57
|
+
def list_invalid_properties
|
58
|
+
invalid_properties = Array.new
|
59
|
+
invalid_properties
|
60
|
+
end
|
61
|
+
|
62
|
+
# Check to see if the all the properties in the model are valid
|
63
|
+
# @return true if the model is valid
|
64
|
+
def valid?
|
65
|
+
true
|
66
|
+
end
|
67
|
+
|
68
|
+
# Checks equality by comparing each attribute.
|
69
|
+
# @param [Object] Object to be compared
|
70
|
+
def ==(o)
|
71
|
+
return true if self.equal?(o)
|
72
|
+
self.class == o.class &&
|
73
|
+
usage == o.usage &&
|
74
|
+
usage_date == o.usage_date
|
75
|
+
end
|
76
|
+
|
77
|
+
# @see the `==` method
|
78
|
+
# @param [Object] Object to be compared
|
79
|
+
def eql?(o)
|
80
|
+
self == o
|
81
|
+
end
|
82
|
+
|
83
|
+
# Calculates hash code according to all attributes.
|
84
|
+
# @return [Fixnum] Hash code
|
85
|
+
def hash
|
86
|
+
[usage, usage_date].hash
|
87
|
+
end
|
88
|
+
|
89
|
+
# Builds the object from hash
|
90
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
91
|
+
# @return [Object] Returns the model itself
|
92
|
+
def build_from_hash(attributes)
|
93
|
+
return nil unless attributes.is_a?(Hash)
|
94
|
+
self.class.swagger_types.each_pair do |key, type|
|
95
|
+
if type =~ /\AArray<(.*)>/i
|
96
|
+
# check to ensure the input is an array given that the attribute
|
97
|
+
# is documented as an array but the input is not
|
98
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
99
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
100
|
+
end
|
101
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
102
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
103
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
104
|
+
end
|
105
|
+
|
106
|
+
self
|
107
|
+
end
|
108
|
+
|
109
|
+
# Deserializes the data based on type
|
110
|
+
# @param string type Data type
|
111
|
+
# @param string value Value to be deserialized
|
112
|
+
# @return [Object] Deserialized data
|
113
|
+
def _deserialize(type, value)
|
114
|
+
case type.to_sym
|
115
|
+
when :DateTime
|
116
|
+
DateTime.parse(value)
|
117
|
+
when :Date
|
118
|
+
Date.parse(value)
|
119
|
+
when :String
|
120
|
+
value.to_s
|
121
|
+
when :Integer
|
122
|
+
value.to_i
|
123
|
+
when :Float
|
124
|
+
value.to_f
|
125
|
+
when :BOOLEAN
|
126
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
127
|
+
true
|
128
|
+
else
|
129
|
+
false
|
130
|
+
end
|
131
|
+
when :Object
|
132
|
+
# generic object (usually a Hash), return directly
|
133
|
+
value
|
134
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
135
|
+
inner_type = Regexp.last_match[:inner_type]
|
136
|
+
value.map { |v| _deserialize(inner_type, v) }
|
137
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
138
|
+
k_type = Regexp.last_match[:k_type]
|
139
|
+
v_type = Regexp.last_match[:v_type]
|
140
|
+
{}.tap do |hash|
|
141
|
+
value.each do |k, v|
|
142
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
143
|
+
end
|
144
|
+
end
|
145
|
+
else # model
|
146
|
+
temp_model = UltracartClient.const_get(type).new
|
147
|
+
temp_model.build_from_hash(value)
|
148
|
+
end
|
149
|
+
end
|
150
|
+
|
151
|
+
# Returns the string representation of the object
|
152
|
+
# @return [String] String presentation of the object
|
153
|
+
def to_s
|
154
|
+
to_hash.to_s
|
155
|
+
end
|
156
|
+
|
157
|
+
# to_body is an alias to to_hash (backward compatibility)
|
158
|
+
# @return [Hash] Returns the object in the form of hash
|
159
|
+
def to_body
|
160
|
+
to_hash
|
161
|
+
end
|
162
|
+
|
163
|
+
# Returns the object in the form of hash
|
164
|
+
# @return [Hash] Returns the object in the form of hash
|
165
|
+
def to_hash
|
166
|
+
hash = {}
|
167
|
+
self.class.attribute_map.each_pair do |attr, param|
|
168
|
+
value = self.send(attr)
|
169
|
+
next if value.nil?
|
170
|
+
hash[param] = _to_hash(value)
|
171
|
+
end
|
172
|
+
hash
|
173
|
+
end
|
174
|
+
|
175
|
+
# Outputs non-array value in the form of hash
|
176
|
+
# For object, use to_hash. Otherwise, just return the value
|
177
|
+
# @param [Object] value Any valid value
|
178
|
+
# @return [Hash] Returns the value in the form of hash
|
179
|
+
def _to_hash(value)
|
180
|
+
if value.is_a?(Array)
|
181
|
+
value.compact.map { |v| _to_hash(v) }
|
182
|
+
elsif value.is_a?(Hash)
|
183
|
+
{}.tap do |hash|
|
184
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
185
|
+
end
|
186
|
+
elsif value.respond_to? :to_hash
|
187
|
+
value.to_hash
|
188
|
+
else
|
189
|
+
value
|
190
|
+
end
|
191
|
+
end
|
192
|
+
|
193
|
+
end
|
194
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -157,6 +157,7 @@ require 'ultracart_api/models/conversation_canned_message'
|
|
157
157
|
require 'ultracart_api/models/conversation_canned_message_response'
|
158
158
|
require 'ultracart_api/models/conversation_canned_messages_response'
|
159
159
|
require 'ultracart_api/models/conversation_canned_messages_search'
|
160
|
+
require 'ultracart_api/models/conversation_delete_knowledge_base_document_response'
|
160
161
|
require 'ultracart_api/models/conversation_department'
|
161
162
|
require 'ultracart_api/models/conversation_department_member'
|
162
163
|
require 'ultracart_api/models/conversation_department_members_response'
|
@@ -176,7 +177,13 @@ require 'ultracart_api/models/conversation_event_rr_web'
|
|
176
177
|
require 'ultracart_api/models/conversation_event_read_message'
|
177
178
|
require 'ultracart_api/models/conversation_event_typing'
|
178
179
|
require 'ultracart_api/models/conversation_event_webchat_context'
|
180
|
+
require 'ultracart_api/models/conversation_insert_knowledge_base_document_request'
|
181
|
+
require 'ultracart_api/models/conversation_insert_knowledge_base_document_response'
|
179
182
|
require 'ultracart_api/models/conversation_join_request'
|
183
|
+
require 'ultracart_api/models/conversation_knowledge_base_document'
|
184
|
+
require 'ultracart_api/models/conversation_knowledge_base_document_upload_url'
|
185
|
+
require 'ultracart_api/models/conversation_knowledge_base_document_upload_url_response'
|
186
|
+
require 'ultracart_api/models/conversation_knowledge_base_documents_response'
|
180
187
|
require 'ultracart_api/models/conversation_location_country'
|
181
188
|
require 'ultracart_api/models/conversation_location_state_province'
|
182
189
|
require 'ultracart_api/models/conversation_locations_response'
|
@@ -343,6 +350,7 @@ require 'ultracart_api/models/custom_report_parameter_option'
|
|
343
350
|
require 'ultracart_api/models/custom_report_query'
|
344
351
|
require 'ultracart_api/models/custom_report_response'
|
345
352
|
require 'ultracart_api/models/custom_report_tooltip'
|
353
|
+
require 'ultracart_api/models/custom_report_usage_breakdown'
|
346
354
|
require 'ultracart_api/models/custom_reports_execution_report_data'
|
347
355
|
require 'ultracart_api/models/custom_reports_execution_request'
|
348
356
|
require 'ultracart_api/models/custom_reports_execution_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: 3.11.
|
4
|
+
version: 3.11.23
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-10-
|
11
|
+
date: 2025-10-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -366,6 +366,7 @@ files:
|
|
366
366
|
- docs/ConversationCannedMessageResponse.md
|
367
367
|
- docs/ConversationCannedMessagesResponse.md
|
368
368
|
- docs/ConversationCannedMessagesSearch.md
|
369
|
+
- docs/ConversationDeleteKnowledgeBaseDocumentResponse.md
|
369
370
|
- docs/ConversationDepartment.md
|
370
371
|
- docs/ConversationDepartmentMember.md
|
371
372
|
- docs/ConversationDepartmentMembersResponse.md
|
@@ -385,7 +386,13 @@ files:
|
|
385
386
|
- docs/ConversationEventReadMessage.md
|
386
387
|
- docs/ConversationEventTyping.md
|
387
388
|
- docs/ConversationEventWebchatContext.md
|
389
|
+
- docs/ConversationInsertKnowledgeBaseDocumentRequest.md
|
390
|
+
- docs/ConversationInsertKnowledgeBaseDocumentResponse.md
|
388
391
|
- docs/ConversationJoinRequest.md
|
392
|
+
- docs/ConversationKnowledgeBaseDocument.md
|
393
|
+
- docs/ConversationKnowledgeBaseDocumentUploadUrl.md
|
394
|
+
- docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md
|
395
|
+
- docs/ConversationKnowledgeBaseDocumentsResponse.md
|
389
396
|
- docs/ConversationLocationCountry.md
|
390
397
|
- docs/ConversationLocationStateProvince.md
|
391
398
|
- docs/ConversationLocationsResponse.md
|
@@ -553,6 +560,7 @@ files:
|
|
553
560
|
- docs/CustomReportQuery.md
|
554
561
|
- docs/CustomReportResponse.md
|
555
562
|
- docs/CustomReportTooltip.md
|
563
|
+
- docs/CustomReportUsageBreakdown.md
|
556
564
|
- docs/CustomReportsExecutionReportData.md
|
557
565
|
- docs/CustomReportsExecutionRequest.md
|
558
566
|
- docs/CustomReportsExecutionResponse.md
|
@@ -1297,6 +1305,7 @@ files:
|
|
1297
1305
|
- lib/ultracart_api/models/conversation_canned_message_response.rb
|
1298
1306
|
- lib/ultracart_api/models/conversation_canned_messages_response.rb
|
1299
1307
|
- lib/ultracart_api/models/conversation_canned_messages_search.rb
|
1308
|
+
- lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb
|
1300
1309
|
- lib/ultracart_api/models/conversation_department.rb
|
1301
1310
|
- lib/ultracart_api/models/conversation_department_member.rb
|
1302
1311
|
- lib/ultracart_api/models/conversation_department_members_response.rb
|
@@ -1316,7 +1325,13 @@ files:
|
|
1316
1325
|
- lib/ultracart_api/models/conversation_event_rr_web.rb
|
1317
1326
|
- lib/ultracart_api/models/conversation_event_typing.rb
|
1318
1327
|
- lib/ultracart_api/models/conversation_event_webchat_context.rb
|
1328
|
+
- lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb
|
1329
|
+
- lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb
|
1319
1330
|
- lib/ultracart_api/models/conversation_join_request.rb
|
1331
|
+
- lib/ultracart_api/models/conversation_knowledge_base_document.rb
|
1332
|
+
- lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb
|
1333
|
+
- lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb
|
1334
|
+
- lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb
|
1320
1335
|
- lib/ultracart_api/models/conversation_location_country.rb
|
1321
1336
|
- lib/ultracart_api/models/conversation_location_state_province.rb
|
1322
1337
|
- lib/ultracart_api/models/conversation_locations_response.rb
|
@@ -1483,6 +1498,7 @@ files:
|
|
1483
1498
|
- lib/ultracart_api/models/custom_report_query.rb
|
1484
1499
|
- lib/ultracart_api/models/custom_report_response.rb
|
1485
1500
|
- lib/ultracart_api/models/custom_report_tooltip.rb
|
1501
|
+
- lib/ultracart_api/models/custom_report_usage_breakdown.rb
|
1486
1502
|
- lib/ultracart_api/models/custom_reports_execution_report_data.rb
|
1487
1503
|
- lib/ultracart_api/models/custom_reports_execution_request.rb
|
1488
1504
|
- lib/ultracart_api/models/custom_reports_execution_response.rb
|