ultracart_api 3.11.19 → 3.11.21
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 +20 -12
- data/docs/CustomDashboardSchedule.md +12 -0
- data/docs/{ChargebackDisputesResponse.md → CustomDashboardScheduleResponse.md} +2 -2
- data/docs/CustomDashboardSchedulesResponse.md +12 -0
- data/docs/CustomReport.md +1 -0
- data/docs/CustomReportAccountConfig.md +1 -0
- data/docs/CustomReportAnalysisRequest.md +9 -0
- data/docs/{ChargebackDisputeResponse.md → CustomReportAnalysisResponse.md} +2 -2
- data/docs/CustomReportChartPngUploadResponse.md +13 -0
- data/docs/DatawarehouseApi.md +320 -0
- data/docs/EmailCampaign.md +2 -0
- data/docs/ItemTag.md +1 -1
- data/docs/OrderApi.md +58 -0
- data/docs/ReplaceOrderItemIdRequest.md +11 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +359 -0
- data/lib/ultracart_api/api/order_api.rb +64 -0
- data/lib/ultracart_api/models/custom_dashboard_schedule.rb +223 -0
- data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_dashboard_schedule_response.rb} +11 -11
- data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedules_response.rb} +14 -13
- data/lib/ultracart_api/models/custom_report.rb +10 -1
- data/lib/ultracart_api/models/custom_report_account_config.rb +10 -1
- data/lib/ultracart_api/models/custom_report_analysis_request.rb +193 -0
- data/lib/ultracart_api/models/custom_report_analysis_response.rb +221 -0
- data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +230 -0
- data/lib/ultracart_api/models/email_campaign.rb +21 -1
- data/lib/ultracart_api/models/item_tag.rb +1 -1
- data/lib/ultracart_api/models/order_payment.rb +2 -2
- data/lib/ultracart_api/models/replace_order_item_id_request.rb +245 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +7 -4
- metadata +16 -10
- data/docs/ChargebackApi.md +0 -301
- data/docs/ChargebackDispute.md +0 -30
- data/lib/ultracart_api/api/chargeback_api.rb +0 -356
- data/lib/ultracart_api/models/chargeback_dispute.rb +0 -614
@@ -0,0 +1,245 @@
|
|
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 ReplaceOrderItemIdRequest
|
17
|
+
# Index of the item on the order (one based index)
|
18
|
+
attr_accessor :item_index
|
19
|
+
|
20
|
+
# Item ID
|
21
|
+
attr_accessor :merchant_item_id
|
22
|
+
|
23
|
+
# Order ID
|
24
|
+
attr_accessor :order_id
|
25
|
+
|
26
|
+
# Replacement Item ID
|
27
|
+
attr_accessor :replacement_merchant_item_id
|
28
|
+
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
30
|
+
def self.attribute_map
|
31
|
+
{
|
32
|
+
:'item_index' => :'item_index',
|
33
|
+
:'merchant_item_id' => :'merchant_item_id',
|
34
|
+
:'order_id' => :'order_id',
|
35
|
+
:'replacement_merchant_item_id' => :'replacement_merchant_item_id'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Attribute type mapping.
|
40
|
+
def self.swagger_types
|
41
|
+
{
|
42
|
+
:'item_index' => :'Integer',
|
43
|
+
:'merchant_item_id' => :'String',
|
44
|
+
:'order_id' => :'String',
|
45
|
+
:'replacement_merchant_item_id' => :'String'
|
46
|
+
}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Initializes the object
|
50
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
51
|
+
def initialize(attributes = {})
|
52
|
+
return unless attributes.is_a?(Hash)
|
53
|
+
|
54
|
+
# convert string to symbol for hash key
|
55
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
56
|
+
|
57
|
+
if attributes.has_key?(:'item_index')
|
58
|
+
self.item_index = attributes[:'item_index']
|
59
|
+
end
|
60
|
+
|
61
|
+
if attributes.has_key?(:'merchant_item_id')
|
62
|
+
self.merchant_item_id = attributes[:'merchant_item_id']
|
63
|
+
end
|
64
|
+
|
65
|
+
if attributes.has_key?(:'order_id')
|
66
|
+
self.order_id = attributes[:'order_id']
|
67
|
+
end
|
68
|
+
|
69
|
+
if attributes.has_key?(:'replacement_merchant_item_id')
|
70
|
+
self.replacement_merchant_item_id = attributes[:'replacement_merchant_item_id']
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
75
|
+
# @return Array for valid properties with the reasons
|
76
|
+
def list_invalid_properties
|
77
|
+
invalid_properties = Array.new
|
78
|
+
if !@merchant_item_id.nil? && @merchant_item_id.to_s.length > 20
|
79
|
+
invalid_properties.push('invalid value for "merchant_item_id", the character length must be smaller than or equal to 20.')
|
80
|
+
end
|
81
|
+
|
82
|
+
if !@replacement_merchant_item_id.nil? && @replacement_merchant_item_id.to_s.length > 20
|
83
|
+
invalid_properties.push('invalid value for "replacement_merchant_item_id", the character length must be smaller than or equal to 20.')
|
84
|
+
end
|
85
|
+
|
86
|
+
invalid_properties
|
87
|
+
end
|
88
|
+
|
89
|
+
# Check to see if the all the properties in the model are valid
|
90
|
+
# @return true if the model is valid
|
91
|
+
def valid?
|
92
|
+
return false if !@merchant_item_id.nil? && @merchant_item_id.to_s.length > 20
|
93
|
+
return false if !@replacement_merchant_item_id.nil? && @replacement_merchant_item_id.to_s.length > 20
|
94
|
+
true
|
95
|
+
end
|
96
|
+
|
97
|
+
# Custom attribute writer method with validation
|
98
|
+
# @param [Object] merchant_item_id Value to be assigned
|
99
|
+
def merchant_item_id=(merchant_item_id)
|
100
|
+
if !merchant_item_id.nil? && merchant_item_id.to_s.length > 20
|
101
|
+
fail ArgumentError, 'invalid value for "merchant_item_id", the character length must be smaller than or equal to 20.'
|
102
|
+
end
|
103
|
+
|
104
|
+
@merchant_item_id = merchant_item_id
|
105
|
+
end
|
106
|
+
|
107
|
+
# Custom attribute writer method with validation
|
108
|
+
# @param [Object] replacement_merchant_item_id Value to be assigned
|
109
|
+
def replacement_merchant_item_id=(replacement_merchant_item_id)
|
110
|
+
if !replacement_merchant_item_id.nil? && replacement_merchant_item_id.to_s.length > 20
|
111
|
+
fail ArgumentError, 'invalid value for "replacement_merchant_item_id", the character length must be smaller than or equal to 20.'
|
112
|
+
end
|
113
|
+
|
114
|
+
@replacement_merchant_item_id = replacement_merchant_item_id
|
115
|
+
end
|
116
|
+
|
117
|
+
# Checks equality by comparing each attribute.
|
118
|
+
# @param [Object] Object to be compared
|
119
|
+
def ==(o)
|
120
|
+
return true if self.equal?(o)
|
121
|
+
self.class == o.class &&
|
122
|
+
item_index == o.item_index &&
|
123
|
+
merchant_item_id == o.merchant_item_id &&
|
124
|
+
order_id == o.order_id &&
|
125
|
+
replacement_merchant_item_id == o.replacement_merchant_item_id
|
126
|
+
end
|
127
|
+
|
128
|
+
# @see the `==` method
|
129
|
+
# @param [Object] Object to be compared
|
130
|
+
def eql?(o)
|
131
|
+
self == o
|
132
|
+
end
|
133
|
+
|
134
|
+
# Calculates hash code according to all attributes.
|
135
|
+
# @return [Fixnum] Hash code
|
136
|
+
def hash
|
137
|
+
[item_index, merchant_item_id, order_id, replacement_merchant_item_id].hash
|
138
|
+
end
|
139
|
+
|
140
|
+
# Builds the object from hash
|
141
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
142
|
+
# @return [Object] Returns the model itself
|
143
|
+
def build_from_hash(attributes)
|
144
|
+
return nil unless attributes.is_a?(Hash)
|
145
|
+
self.class.swagger_types.each_pair do |key, type|
|
146
|
+
if type =~ /\AArray<(.*)>/i
|
147
|
+
# check to ensure the input is an array given that the attribute
|
148
|
+
# is documented as an array but the input is not
|
149
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
150
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
151
|
+
end
|
152
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
153
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
154
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
155
|
+
end
|
156
|
+
|
157
|
+
self
|
158
|
+
end
|
159
|
+
|
160
|
+
# Deserializes the data based on type
|
161
|
+
# @param string type Data type
|
162
|
+
# @param string value Value to be deserialized
|
163
|
+
# @return [Object] Deserialized data
|
164
|
+
def _deserialize(type, value)
|
165
|
+
case type.to_sym
|
166
|
+
when :DateTime
|
167
|
+
DateTime.parse(value)
|
168
|
+
when :Date
|
169
|
+
Date.parse(value)
|
170
|
+
when :String
|
171
|
+
value.to_s
|
172
|
+
when :Integer
|
173
|
+
value.to_i
|
174
|
+
when :Float
|
175
|
+
value.to_f
|
176
|
+
when :BOOLEAN
|
177
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
178
|
+
true
|
179
|
+
else
|
180
|
+
false
|
181
|
+
end
|
182
|
+
when :Object
|
183
|
+
# generic object (usually a Hash), return directly
|
184
|
+
value
|
185
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
186
|
+
inner_type = Regexp.last_match[:inner_type]
|
187
|
+
value.map { |v| _deserialize(inner_type, v) }
|
188
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
189
|
+
k_type = Regexp.last_match[:k_type]
|
190
|
+
v_type = Regexp.last_match[:v_type]
|
191
|
+
{}.tap do |hash|
|
192
|
+
value.each do |k, v|
|
193
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
194
|
+
end
|
195
|
+
end
|
196
|
+
else # model
|
197
|
+
temp_model = UltracartClient.const_get(type).new
|
198
|
+
temp_model.build_from_hash(value)
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
202
|
+
# Returns the string representation of the object
|
203
|
+
# @return [String] String presentation of the object
|
204
|
+
def to_s
|
205
|
+
to_hash.to_s
|
206
|
+
end
|
207
|
+
|
208
|
+
# to_body is an alias to to_hash (backward compatibility)
|
209
|
+
# @return [Hash] Returns the object in the form of hash
|
210
|
+
def to_body
|
211
|
+
to_hash
|
212
|
+
end
|
213
|
+
|
214
|
+
# Returns the object in the form of hash
|
215
|
+
# @return [Hash] Returns the object in the form of hash
|
216
|
+
def to_hash
|
217
|
+
hash = {}
|
218
|
+
self.class.attribute_map.each_pair do |attr, param|
|
219
|
+
value = self.send(attr)
|
220
|
+
next if value.nil?
|
221
|
+
hash[param] = _to_hash(value)
|
222
|
+
end
|
223
|
+
hash
|
224
|
+
end
|
225
|
+
|
226
|
+
# Outputs non-array value in the form of hash
|
227
|
+
# For object, use to_hash. Otherwise, just return the value
|
228
|
+
# @param [Object] value Any valid value
|
229
|
+
# @return [Hash] Returns the value in the form of hash
|
230
|
+
def _to_hash(value)
|
231
|
+
if value.is_a?(Array)
|
232
|
+
value.compact.map { |v| _to_hash(v) }
|
233
|
+
elsif value.is_a?(Hash)
|
234
|
+
{}.tap do |hash|
|
235
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
236
|
+
end
|
237
|
+
elsif value.respond_to? :to_hash
|
238
|
+
value.to_hash
|
239
|
+
else
|
240
|
+
value
|
241
|
+
end
|
242
|
+
end
|
243
|
+
|
244
|
+
end
|
245
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -137,9 +137,6 @@ require 'ultracart_api/models/channel_partner_ship_to_preference_response'
|
|
137
137
|
require 'ultracart_api/models/channel_partner_ship_to_preferences_response'
|
138
138
|
require 'ultracart_api/models/channel_partner_shipping_estimate'
|
139
139
|
require 'ultracart_api/models/channel_partners_response'
|
140
|
-
require 'ultracart_api/models/chargeback_dispute'
|
141
|
-
require 'ultracart_api/models/chargeback_dispute_response'
|
142
|
-
require 'ultracart_api/models/chargeback_disputes_response'
|
143
140
|
require 'ultracart_api/models/checkout_allowed_countries_response'
|
144
141
|
require 'ultracart_api/models/checkout_handoff_request'
|
145
142
|
require 'ultracart_api/models/checkout_handoff_response'
|
@@ -328,10 +325,16 @@ require 'ultracart_api/models/custom_dashboard_execution_parameter'
|
|
328
325
|
require 'ultracart_api/models/custom_dashboard_page'
|
329
326
|
require 'ultracart_api/models/custom_dashboard_page_report'
|
330
327
|
require 'ultracart_api/models/custom_dashboard_response'
|
328
|
+
require 'ultracart_api/models/custom_dashboard_schedule'
|
329
|
+
require 'ultracart_api/models/custom_dashboard_schedule_response'
|
330
|
+
require 'ultracart_api/models/custom_dashboard_schedules_response'
|
331
331
|
require 'ultracart_api/models/custom_dashboards_response'
|
332
332
|
require 'ultracart_api/models/custom_report'
|
333
333
|
require 'ultracart_api/models/custom_report_account_config'
|
334
334
|
require 'ultracart_api/models/custom_report_account_config_response'
|
335
|
+
require 'ultracart_api/models/custom_report_analysis_request'
|
336
|
+
require 'ultracart_api/models/custom_report_analysis_response'
|
337
|
+
require 'ultracart_api/models/custom_report_chart_png_upload_response'
|
335
338
|
require 'ultracart_api/models/custom_report_execution_parameter'
|
336
339
|
require 'ultracart_api/models/custom_report_execution_request'
|
337
340
|
require 'ultracart_api/models/custom_report_execution_response'
|
@@ -738,6 +741,7 @@ require 'ultracart_api/models/property'
|
|
738
741
|
require 'ultracart_api/models/publish_library_item_request'
|
739
742
|
require 'ultracart_api/models/register_affiliate_click_request'
|
740
743
|
require 'ultracart_api/models/register_affiliate_click_response'
|
744
|
+
require 'ultracart_api/models/replace_order_item_id_request'
|
741
745
|
require 'ultracart_api/models/report'
|
742
746
|
require 'ultracart_api/models/report_auth'
|
743
747
|
require 'ultracart_api/models/report_auth_response'
|
@@ -909,7 +913,6 @@ require 'ultracart_api/models/workflow_users_response'
|
|
909
913
|
require 'ultracart_api/api/affiliate_api'
|
910
914
|
require 'ultracart_api/api/auto_order_api'
|
911
915
|
require 'ultracart_api/api/channel_partner_api'
|
912
|
-
require 'ultracart_api/api/chargeback_api'
|
913
916
|
require 'ultracart_api/api/checkout_api'
|
914
917
|
require 'ultracart_api/api/conversation_api'
|
915
918
|
require 'ultracart_api/api/coupon_api'
|
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.21
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-09-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -344,10 +344,6 @@ files:
|
|
344
344
|
- docs/ChannelPartnerShipToPreferencesResponse.md
|
345
345
|
- docs/ChannelPartnerShippingEstimate.md
|
346
346
|
- docs/ChannelPartnersResponse.md
|
347
|
-
- docs/ChargebackApi.md
|
348
|
-
- docs/ChargebackDispute.md
|
349
|
-
- docs/ChargebackDisputeResponse.md
|
350
|
-
- docs/ChargebackDisputesResponse.md
|
351
347
|
- docs/CheckoutAllowedCountriesResponse.md
|
352
348
|
- docs/CheckoutApi.md
|
353
349
|
- docs/CheckoutHandoffRequest.md
|
@@ -539,10 +535,16 @@ files:
|
|
539
535
|
- docs/CustomDashboardPage.md
|
540
536
|
- docs/CustomDashboardPageReport.md
|
541
537
|
- docs/CustomDashboardResponse.md
|
538
|
+
- docs/CustomDashboardSchedule.md
|
539
|
+
- docs/CustomDashboardScheduleResponse.md
|
540
|
+
- docs/CustomDashboardSchedulesResponse.md
|
542
541
|
- docs/CustomDashboardsResponse.md
|
543
542
|
- docs/CustomReport.md
|
544
543
|
- docs/CustomReportAccountConfig.md
|
545
544
|
- docs/CustomReportAccountConfigResponse.md
|
545
|
+
- docs/CustomReportAnalysisRequest.md
|
546
|
+
- docs/CustomReportAnalysisResponse.md
|
547
|
+
- docs/CustomReportChartPngUploadResponse.md
|
546
548
|
- docs/CustomReportExecutionParameter.md
|
547
549
|
- docs/CustomReportExecutionRequest.md
|
548
550
|
- docs/CustomReportExecutionResponse.md
|
@@ -957,6 +959,7 @@ files:
|
|
957
959
|
- docs/PublishLibraryItemRequest.md
|
958
960
|
- docs/RegisterAffiliateClickRequest.md
|
959
961
|
- docs/RegisterAffiliateClickResponse.md
|
962
|
+
- docs/ReplaceOrderItemIdRequest.md
|
960
963
|
- docs/Report.md
|
961
964
|
- docs/ReportAuth.md
|
962
965
|
- docs/ReportAuthResponse.md
|
@@ -1134,7 +1137,6 @@ files:
|
|
1134
1137
|
- lib/ultracart_api/api/affiliate_api.rb
|
1135
1138
|
- lib/ultracart_api/api/auto_order_api.rb
|
1136
1139
|
- lib/ultracart_api/api/channel_partner_api.rb
|
1137
|
-
- lib/ultracart_api/api/chargeback_api.rb
|
1138
1140
|
- lib/ultracart_api/api/checkout_api.rb
|
1139
1141
|
- lib/ultracart_api/api/conversation_api.rb
|
1140
1142
|
- lib/ultracart_api/api/coupon_api.rb
|
@@ -1275,9 +1277,6 @@ files:
|
|
1275
1277
|
- lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb
|
1276
1278
|
- lib/ultracart_api/models/channel_partner_shipping_estimate.rb
|
1277
1279
|
- lib/ultracart_api/models/channel_partners_response.rb
|
1278
|
-
- lib/ultracart_api/models/chargeback_dispute.rb
|
1279
|
-
- lib/ultracart_api/models/chargeback_dispute_response.rb
|
1280
|
-
- lib/ultracart_api/models/chargeback_disputes_response.rb
|
1281
1280
|
- lib/ultracart_api/models/checkout_allowed_countries_response.rb
|
1282
1281
|
- lib/ultracart_api/models/checkout_handoff_request.rb
|
1283
1282
|
- lib/ultracart_api/models/checkout_handoff_response.rb
|
@@ -1466,10 +1465,16 @@ files:
|
|
1466
1465
|
- lib/ultracart_api/models/custom_dashboard_page.rb
|
1467
1466
|
- lib/ultracart_api/models/custom_dashboard_page_report.rb
|
1468
1467
|
- lib/ultracart_api/models/custom_dashboard_response.rb
|
1468
|
+
- lib/ultracart_api/models/custom_dashboard_schedule.rb
|
1469
|
+
- lib/ultracart_api/models/custom_dashboard_schedule_response.rb
|
1470
|
+
- lib/ultracart_api/models/custom_dashboard_schedules_response.rb
|
1469
1471
|
- lib/ultracart_api/models/custom_dashboards_response.rb
|
1470
1472
|
- lib/ultracart_api/models/custom_report.rb
|
1471
1473
|
- lib/ultracart_api/models/custom_report_account_config.rb
|
1472
1474
|
- lib/ultracart_api/models/custom_report_account_config_response.rb
|
1475
|
+
- lib/ultracart_api/models/custom_report_analysis_request.rb
|
1476
|
+
- lib/ultracart_api/models/custom_report_analysis_response.rb
|
1477
|
+
- lib/ultracart_api/models/custom_report_chart_png_upload_response.rb
|
1473
1478
|
- lib/ultracart_api/models/custom_report_execution_parameter.rb
|
1474
1479
|
- lib/ultracart_api/models/custom_report_execution_request.rb
|
1475
1480
|
- lib/ultracart_api/models/custom_report_execution_response.rb
|
@@ -1876,6 +1881,7 @@ files:
|
|
1876
1881
|
- lib/ultracart_api/models/publish_library_item_request.rb
|
1877
1882
|
- lib/ultracart_api/models/register_affiliate_click_request.rb
|
1878
1883
|
- lib/ultracart_api/models/register_affiliate_click_response.rb
|
1884
|
+
- lib/ultracart_api/models/replace_order_item_id_request.rb
|
1879
1885
|
- lib/ultracart_api/models/report.rb
|
1880
1886
|
- lib/ultracart_api/models/report_auth.rb
|
1881
1887
|
- lib/ultracart_api/models/report_auth_response.rb
|
data/docs/ChargebackApi.md
DELETED
@@ -1,301 +0,0 @@
|
|
1
|
-
# UltracartClient::ChargebackApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**delete_chargeback**](ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
8
|
-
[**get_chargeback_dispute**](ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
|
9
|
-
[**get_chargeback_disputes**](ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
|
10
|
-
[**insert_chargeback**](ChargebackApi.md#insert_chargeback) | **POST** /chargeback/chargebacks | Insert a chargeback
|
11
|
-
[**update_chargeback**](ChargebackApi.md#update_chargeback) | **PUT** /chargeback/chargebacks/{chargeback_dispute_oid} | Update a chargeback
|
12
|
-
|
13
|
-
|
14
|
-
# **delete_chargeback**
|
15
|
-
> ChargebackDisputeResponse delete_chargeback(chargeback_dispute_oid)
|
16
|
-
|
17
|
-
Delete a chargeback
|
18
|
-
|
19
|
-
Delete a chargeback on the UltraCart account.
|
20
|
-
|
21
|
-
### Example
|
22
|
-
```ruby
|
23
|
-
# load the gem
|
24
|
-
require 'ultracart_api'
|
25
|
-
|
26
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
27
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
28
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
29
|
-
|
30
|
-
|
31
|
-
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
|
32
|
-
|
33
|
-
|
34
|
-
begin
|
35
|
-
#Delete a chargeback
|
36
|
-
result = api_instance.delete_chargeback(chargeback_dispute_oid)
|
37
|
-
p result
|
38
|
-
rescue UltracartClient::ApiError => e
|
39
|
-
puts "Exception when calling ChargebackApi->delete_chargeback: #{e}"
|
40
|
-
end
|
41
|
-
```
|
42
|
-
|
43
|
-
### Parameters
|
44
|
-
|
45
|
-
Name | Type | Description | Notes
|
46
|
-
------------- | ------------- | ------------- | -------------
|
47
|
-
**chargeback_dispute_oid** | **Integer**| The chargeback_dispute_oid to delete. |
|
48
|
-
|
49
|
-
### Return type
|
50
|
-
|
51
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
52
|
-
|
53
|
-
### Authorization
|
54
|
-
|
55
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
56
|
-
|
57
|
-
### HTTP request headers
|
58
|
-
|
59
|
-
- **Content-Type**: application/json
|
60
|
-
- **Accept**: application/json
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
# **get_chargeback_dispute**
|
65
|
-
> ChargebackDisputeResponse get_chargeback_dispute(chargeback_dispute_oid, opts)
|
66
|
-
|
67
|
-
Retrieve a chargeback
|
68
|
-
|
69
|
-
Retrieves a single chargeback using the specified chargeback dispute oid.
|
70
|
-
|
71
|
-
### Example
|
72
|
-
```ruby
|
73
|
-
# load the gem
|
74
|
-
require 'ultracart_api'
|
75
|
-
|
76
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
77
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
78
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
79
|
-
|
80
|
-
|
81
|
-
chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
|
82
|
-
|
83
|
-
opts = {
|
84
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
85
|
-
}
|
86
|
-
|
87
|
-
begin
|
88
|
-
#Retrieve a chargeback
|
89
|
-
result = api_instance.get_chargeback_dispute(chargeback_dispute_oid, opts)
|
90
|
-
p result
|
91
|
-
rescue UltracartClient::ApiError => e
|
92
|
-
puts "Exception when calling ChargebackApi->get_chargeback_dispute: #{e}"
|
93
|
-
end
|
94
|
-
```
|
95
|
-
|
96
|
-
### Parameters
|
97
|
-
|
98
|
-
Name | Type | Description | Notes
|
99
|
-
------------- | ------------- | ------------- | -------------
|
100
|
-
**chargeback_dispute_oid** | **Integer**| The chargeback dispute oid to retrieve. |
|
101
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
102
|
-
|
103
|
-
### Return type
|
104
|
-
|
105
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
106
|
-
|
107
|
-
### Authorization
|
108
|
-
|
109
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
110
|
-
|
111
|
-
### HTTP request headers
|
112
|
-
|
113
|
-
- **Content-Type**: application/json
|
114
|
-
- **Accept**: application/json
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
# **get_chargeback_disputes**
|
119
|
-
> ChargebackDisputesResponse get_chargeback_disputes(opts)
|
120
|
-
|
121
|
-
Retrieve chargebacks
|
122
|
-
|
123
|
-
Retrieves chargebacks from the account. If no parameters are specified, all chargebacks will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
124
|
-
|
125
|
-
### Example
|
126
|
-
```ruby
|
127
|
-
# load the gem
|
128
|
-
require 'ultracart_api'
|
129
|
-
|
130
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
131
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
132
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
133
|
-
|
134
|
-
|
135
|
-
opts = {
|
136
|
-
order_id: 'order_id_example', # String | Order Id
|
137
|
-
case_number: 'case_number_example', # String | Case number
|
138
|
-
status: 'status_example', # String | Status
|
139
|
-
expiration_dts_start: 'expiration_dts_start_example', # String | Expiration dts start
|
140
|
-
expiration_dts_end: 'expiration_dts_end_example', # String | Expiration dts end
|
141
|
-
chargeback_dts_start: 'chargeback_dts_start_example', # String | Chargeback dts start
|
142
|
-
chargeback_dts_end: 'chargeback_dts_end_example', # String | Chargeback dts end
|
143
|
-
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
144
|
-
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
145
|
-
_since: '_since_example', # String | Fetch chargebacks that have been created/modified since this date/time.
|
146
|
-
_sort: '_sort_example', # String | The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
147
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
148
|
-
}
|
149
|
-
|
150
|
-
begin
|
151
|
-
#Retrieve chargebacks
|
152
|
-
result = api_instance.get_chargeback_disputes(opts)
|
153
|
-
p result
|
154
|
-
rescue UltracartClient::ApiError => e
|
155
|
-
puts "Exception when calling ChargebackApi->get_chargeback_disputes: #{e}"
|
156
|
-
end
|
157
|
-
```
|
158
|
-
|
159
|
-
### Parameters
|
160
|
-
|
161
|
-
Name | Type | Description | Notes
|
162
|
-
------------- | ------------- | ------------- | -------------
|
163
|
-
**order_id** | **String**| Order Id | [optional]
|
164
|
-
**case_number** | **String**| Case number | [optional]
|
165
|
-
**status** | **String**| Status | [optional]
|
166
|
-
**expiration_dts_start** | **String**| Expiration dts start | [optional]
|
167
|
-
**expiration_dts_end** | **String**| Expiration dts end | [optional]
|
168
|
-
**chargeback_dts_start** | **String**| Chargeback dts start | [optional]
|
169
|
-
**chargeback_dts_end** | **String**| Chargeback dts end | [optional]
|
170
|
-
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
171
|
-
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
172
|
-
**_since** | **String**| Fetch chargebacks that have been created/modified since this date/time. | [optional]
|
173
|
-
**_sort** | **String**| The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
174
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
175
|
-
|
176
|
-
### Return type
|
177
|
-
|
178
|
-
[**ChargebackDisputesResponse**](ChargebackDisputesResponse.md)
|
179
|
-
|
180
|
-
### Authorization
|
181
|
-
|
182
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
183
|
-
|
184
|
-
### HTTP request headers
|
185
|
-
|
186
|
-
- **Content-Type**: application/json
|
187
|
-
- **Accept**: application/json
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
# **insert_chargeback**
|
192
|
-
> ChargebackDisputeResponse insert_chargeback(chargeback, opts)
|
193
|
-
|
194
|
-
Insert a chargeback
|
195
|
-
|
196
|
-
Insert a chargeback on the UltraCart account.
|
197
|
-
|
198
|
-
### Example
|
199
|
-
```ruby
|
200
|
-
# load the gem
|
201
|
-
require 'ultracart_api'
|
202
|
-
|
203
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
204
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
205
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
206
|
-
|
207
|
-
|
208
|
-
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
|
209
|
-
|
210
|
-
opts = {
|
211
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
212
|
-
}
|
213
|
-
|
214
|
-
begin
|
215
|
-
#Insert a chargeback
|
216
|
-
result = api_instance.insert_chargeback(chargeback, opts)
|
217
|
-
p result
|
218
|
-
rescue UltracartClient::ApiError => e
|
219
|
-
puts "Exception when calling ChargebackApi->insert_chargeback: #{e}"
|
220
|
-
end
|
221
|
-
```
|
222
|
-
|
223
|
-
### Parameters
|
224
|
-
|
225
|
-
Name | Type | Description | Notes
|
226
|
-
------------- | ------------- | ------------- | -------------
|
227
|
-
**chargeback** | [**ChargebackDispute**](ChargebackDispute.md)| Chargeback to insert |
|
228
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
229
|
-
|
230
|
-
### Return type
|
231
|
-
|
232
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
233
|
-
|
234
|
-
### Authorization
|
235
|
-
|
236
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
237
|
-
|
238
|
-
### HTTP request headers
|
239
|
-
|
240
|
-
- **Content-Type**: application/json; charset=UTF-8
|
241
|
-
- **Accept**: application/json
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
# **update_chargeback**
|
246
|
-
> ChargebackDisputeResponse update_chargeback(chargeback, chargeback_dispute_oid, opts)
|
247
|
-
|
248
|
-
Update a chargeback
|
249
|
-
|
250
|
-
Update a chargeback on the UltraCart account.
|
251
|
-
|
252
|
-
### Example
|
253
|
-
```ruby
|
254
|
-
# load the gem
|
255
|
-
require 'ultracart_api'
|
256
|
-
|
257
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
258
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
259
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
260
|
-
|
261
|
-
|
262
|
-
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
|
263
|
-
|
264
|
-
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to update.
|
265
|
-
|
266
|
-
opts = {
|
267
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
268
|
-
}
|
269
|
-
|
270
|
-
begin
|
271
|
-
#Update a chargeback
|
272
|
-
result = api_instance.update_chargeback(chargeback, chargeback_dispute_oid, opts)
|
273
|
-
p result
|
274
|
-
rescue UltracartClient::ApiError => e
|
275
|
-
puts "Exception when calling ChargebackApi->update_chargeback: #{e}"
|
276
|
-
end
|
277
|
-
```
|
278
|
-
|
279
|
-
### Parameters
|
280
|
-
|
281
|
-
Name | Type | Description | Notes
|
282
|
-
------------- | ------------- | ------------- | -------------
|
283
|
-
**chargeback** | [**ChargebackDispute**](ChargebackDispute.md)| Chargeback to update |
|
284
|
-
**chargeback_dispute_oid** | **Integer**| The chargeback_dispute_oid to update. |
|
285
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
286
|
-
|
287
|
-
### Return type
|
288
|
-
|
289
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
290
|
-
|
291
|
-
### Authorization
|
292
|
-
|
293
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
294
|
-
|
295
|
-
### HTTP request headers
|
296
|
-
|
297
|
-
- **Content-Type**: application/json; charset=UTF-8
|
298
|
-
- **Accept**: application/json
|
299
|
-
|
300
|
-
|
301
|
-
|