ultracart_api 4.1.12 → 4.1.14

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.
@@ -1,405 +1,297 @@
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
-
16
- > <ChargebackDisputeResponse> delete_chargeback(chargeback_dispute_oid)
17
-
18
- Delete a chargeback
19
-
20
- Delete a chargeback on the UltraCart account.
21
-
22
- ### Examples
23
-
24
- ```ruby
25
- require 'time'
26
- require 'ultracart_api'
27
- require 'json'
28
- require 'yaml'
29
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
30
-
31
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
32
- # As such, this might not be the best way to use this object.
33
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
34
-
35
- api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
36
- chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
37
-
38
- begin
39
- # Delete a chargeback
40
- result = api_instance.delete_chargeback(chargeback_dispute_oid)
41
- p result
42
- rescue UltracartClient::ApiError => e
43
- puts "Error when calling ChargebackApi->delete_chargeback: #{e}"
44
- end
45
- ```
46
-
47
- #### Using the delete_chargeback_with_http_info variant
48
-
49
- This returns an Array which contains the response data, status code and headers.
50
-
51
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> delete_chargeback_with_http_info(chargeback_dispute_oid)
52
-
53
- ```ruby
54
- begin
55
- # Delete a chargeback
56
- data, status_code, headers = api_instance.delete_chargeback_with_http_info(chargeback_dispute_oid)
57
- p status_code # => 2xx
58
- p headers # => { ... }
59
- p data # => <ChargebackDisputeResponse>
60
- rescue UltracartClient::ApiError => e
61
- puts "Error when calling ChargebackApi->delete_chargeback_with_http_info: #{e}"
62
- end
63
- ```
64
-
65
- ### Parameters
66
-
67
- | Name | Type | Description | Notes |
68
- | ---- | ---- | ----------- | ----- |
69
- | **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to delete. | |
70
-
71
- ### Return type
72
-
73
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
74
-
75
- ### Authorization
76
-
77
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
78
-
79
- ### HTTP request headers
80
-
81
- - **Content-Type**: Not defined
82
- - **Accept**: application/json
83
-
84
-
85
- ## get_chargeback_dispute
86
-
87
- > <ChargebackDisputeResponse> get_chargeback_dispute(chargeback_dispute_oid, opts)
88
-
89
- Retrieve a chargeback
90
-
91
- Retrieves a single chargeback using the specified chargeback dispute oid.
92
-
93
- ### Examples
94
-
95
- ```ruby
96
- require 'time'
97
- require 'ultracart_api'
98
- require 'json'
99
- require 'yaml'
100
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
101
-
102
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
103
- # As such, this might not be the best way to use this object.
104
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
105
-
106
- api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
107
- chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
108
- opts = {
109
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
110
- }
111
-
112
- begin
113
- # Retrieve a chargeback
114
- result = api_instance.get_chargeback_dispute(chargeback_dispute_oid, opts)
115
- p result
116
- rescue UltracartClient::ApiError => e
117
- puts "Error when calling ChargebackApi->get_chargeback_dispute: #{e}"
118
- end
119
- ```
120
-
121
- #### Using the get_chargeback_dispute_with_http_info variant
122
-
123
- This returns an Array which contains the response data, status code and headers.
124
-
125
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
126
-
127
- ```ruby
128
- begin
129
- # Retrieve a chargeback
130
- data, status_code, headers = api_instance.get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
131
- p status_code # => 2xx
132
- p headers # => { ... }
133
- p data # => <ChargebackDisputeResponse>
134
- rescue UltracartClient::ApiError => e
135
- puts "Error when calling ChargebackApi->get_chargeback_dispute_with_http_info: #{e}"
136
- end
137
- ```
138
-
139
- ### Parameters
140
-
141
- | Name | Type | Description | Notes |
142
- | ---- | ---- | ----------- | ----- |
143
- | **chargeback_dispute_oid** | **Integer** | The chargeback dispute oid to retrieve. | |
144
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
145
-
146
- ### Return type
147
-
148
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
149
-
150
- ### Authorization
151
-
152
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
153
-
154
- ### HTTP request headers
155
-
156
- - **Content-Type**: Not defined
157
- - **Accept**: application/json
158
-
159
-
160
- ## get_chargeback_disputes
161
-
162
- > <ChargebackDisputesResponse> get_chargeback_disputes(opts)
163
-
164
- Retrieve chargebacks
165
-
166
- 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.
167
-
168
- ### Examples
169
-
170
- ```ruby
171
- require 'time'
172
- require 'ultracart_api'
173
- require 'json'
174
- require 'yaml'
175
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
176
-
177
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
178
- # As such, this might not be the best way to use this object.
179
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
180
-
181
- api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
182
- opts = {
183
- order_id: 'order_id_example', # String | Order Id
184
- case_number: 'case_number_example', # String | Case number
185
- status: 'status_example', # String | Status
186
- expiration_dts_start: 'expiration_dts_start_example', # String | Expiration dts start
187
- expiration_dts_end: 'expiration_dts_end_example', # String | Expiration dts end
188
- chargeback_dts_start: 'chargeback_dts_start_example', # String | Chargeback dts start
189
- chargeback_dts_end: 'chargeback_dts_end_example', # String | Chargeback dts end
190
- _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
191
- _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
192
- _since: '_since_example', # String | Fetch chargebacks that have been created/modified since this date/time.
193
- _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.
194
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
195
- }
196
-
197
- begin
198
- # Retrieve chargebacks
199
- result = api_instance.get_chargeback_disputes(opts)
200
- p result
201
- rescue UltracartClient::ApiError => e
202
- puts "Error when calling ChargebackApi->get_chargeback_disputes: #{e}"
203
- end
204
- ```
205
-
206
- #### Using the get_chargeback_disputes_with_http_info variant
207
-
208
- This returns an Array which contains the response data, status code and headers.
209
-
210
- > <Array(<ChargebackDisputesResponse>, Integer, Hash)> get_chargeback_disputes_with_http_info(opts)
211
-
212
- ```ruby
213
- begin
214
- # Retrieve chargebacks
215
- data, status_code, headers = api_instance.get_chargeback_disputes_with_http_info(opts)
216
- p status_code # => 2xx
217
- p headers # => { ... }
218
- p data # => <ChargebackDisputesResponse>
219
- rescue UltracartClient::ApiError => e
220
- puts "Error when calling ChargebackApi->get_chargeback_disputes_with_http_info: #{e}"
221
- end
222
- ```
223
-
224
- ### Parameters
225
-
226
- | Name | Type | Description | Notes |
227
- | ---- | ---- | ----------- | ----- |
228
- | **order_id** | **String** | Order Id | [optional] |
229
- | **case_number** | **String** | Case number | [optional] |
230
- | **status** | **String** | Status | [optional] |
231
- | **expiration_dts_start** | **String** | Expiration dts start | [optional] |
232
- | **expiration_dts_end** | **String** | Expiration dts end | [optional] |
233
- | **chargeback_dts_start** | **String** | Chargeback dts start | [optional] |
234
- | **chargeback_dts_end** | **String** | Chargeback dts end | [optional] |
235
- | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
236
- | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
237
- | **_since** | **String** | Fetch chargebacks that have been created/modified since this date/time. | [optional] |
238
- | **_sort** | **String** | The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
239
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
240
-
241
- ### Return type
242
-
243
- [**ChargebackDisputesResponse**](ChargebackDisputesResponse.md)
244
-
245
- ### Authorization
246
-
247
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
248
-
249
- ### HTTP request headers
250
-
251
- - **Content-Type**: Not defined
252
- - **Accept**: application/json
253
-
254
-
255
- ## insert_chargeback
256
-
257
- > <ChargebackDisputeResponse> insert_chargeback(chargeback, opts)
258
-
259
- Insert a chargeback
260
-
261
- Insert a chargeback on the UltraCart account.
262
-
263
- ### Examples
264
-
265
- ```ruby
266
- require 'time'
267
- require 'ultracart_api'
268
- require 'json'
269
- require 'yaml'
270
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
271
-
272
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
273
- # As such, this might not be the best way to use this object.
274
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
275
-
276
- api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
277
- chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
278
- opts = {
279
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
280
- }
281
-
282
- begin
283
- # Insert a chargeback
284
- result = api_instance.insert_chargeback(chargeback, opts)
285
- p result
286
- rescue UltracartClient::ApiError => e
287
- puts "Error when calling ChargebackApi->insert_chargeback: #{e}"
288
- end
289
- ```
290
-
291
- #### Using the insert_chargeback_with_http_info variant
292
-
293
- This returns an Array which contains the response data, status code and headers.
294
-
295
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> insert_chargeback_with_http_info(chargeback, opts)
296
-
297
- ```ruby
298
- begin
299
- # Insert a chargeback
300
- data, status_code, headers = api_instance.insert_chargeback_with_http_info(chargeback, opts)
301
- p status_code # => 2xx
302
- p headers # => { ... }
303
- p data # => <ChargebackDisputeResponse>
304
- rescue UltracartClient::ApiError => e
305
- puts "Error when calling ChargebackApi->insert_chargeback_with_http_info: #{e}"
306
- end
307
- ```
308
-
309
- ### Parameters
310
-
311
- | Name | Type | Description | Notes |
312
- | ---- | ---- | ----------- | ----- |
313
- | **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to insert | |
314
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
315
-
316
- ### Return type
317
-
318
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
319
-
320
- ### Authorization
321
-
322
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
323
-
324
- ### HTTP request headers
325
-
326
- - **Content-Type**: application/json; charset=UTF-8
327
- - **Accept**: application/json
328
-
329
-
330
- ## update_chargeback
331
-
332
- > <ChargebackDisputeResponse> update_chargeback(chargeback_dispute_oid, chargeback, opts)
333
-
334
- Update a chargeback
335
-
336
- Update a chargeback on the UltraCart account.
337
-
338
- ### Examples
339
-
340
- ```ruby
341
- require 'time'
342
- require 'ultracart_api'
343
- require 'json'
344
- require 'yaml'
345
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
346
-
347
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
348
- # As such, this might not be the best way to use this object.
349
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
350
-
351
- api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
352
- chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to update.
353
- chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
354
- opts = {
355
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
356
- }
357
-
358
- begin
359
- # Update a chargeback
360
- result = api_instance.update_chargeback(chargeback_dispute_oid, chargeback, opts)
361
- p result
362
- rescue UltracartClient::ApiError => e
363
- puts "Error when calling ChargebackApi->update_chargeback: #{e}"
364
- end
365
- ```
366
-
367
- #### Using the update_chargeback_with_http_info variant
368
-
369
- This returns an Array which contains the response data, status code and headers.
370
-
371
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
372
-
373
- ```ruby
374
- begin
375
- # Update a chargeback
376
- data, status_code, headers = api_instance.update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
377
- p status_code # => 2xx
378
- p headers # => { ... }
379
- p data # => <ChargebackDisputeResponse>
380
- rescue UltracartClient::ApiError => e
381
- puts "Error when calling ChargebackApi->update_chargeback_with_http_info: #{e}"
382
- end
383
- ```
384
-
385
- ### Parameters
386
-
387
- | Name | Type | Description | Notes |
388
- | ---- | ---- | ----------- | ----- |
389
- | **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to update. | |
390
- | **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to update | |
391
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
392
-
393
- ### Return type
394
-
395
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
396
-
397
- ### Authorization
398
-
399
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
400
-
401
- ### HTTP request headers
402
-
403
- - **Content-Type**: application/json; charset=UTF-8
404
- - **Accept**: application/json
405
-
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
+
16
+ > <ChargebackDisputeResponse> delete_chargeback(chargeback_dispute_oid)
17
+
18
+ Delete a chargeback
19
+
20
+ Delete a chargeback on the UltraCart account.
21
+
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ # Internal API. No samples are provided as merchants will never need this api method
27
+ ```
28
+
29
+
30
+ #### Using the delete_chargeback_with_http_info variant
31
+
32
+ This returns an Array which contains the response data, status code and headers.
33
+
34
+ > <Array(<ChargebackDisputeResponse>, Integer, Hash)> delete_chargeback_with_http_info(chargeback_dispute_oid)
35
+
36
+ ```ruby
37
+ begin
38
+ # Delete a chargeback
39
+ data, status_code, headers = api_instance.delete_chargeback_with_http_info(chargeback_dispute_oid)
40
+ p status_code # => 2xx
41
+ p headers # => { ... }
42
+ p data # => <ChargebackDisputeResponse>
43
+ rescue UltracartClient::ApiError => e
44
+ puts "Error when calling ChargebackApi->delete_chargeback_with_http_info: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ | Name | Type | Description | Notes |
51
+ | ---- | ---- | ----------- | ----- |
52
+ | **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to delete. | |
53
+
54
+ ### Return type
55
+
56
+ [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
57
+
58
+ ### Authorization
59
+
60
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: Not defined
65
+ - **Accept**: application/json
66
+
67
+
68
+ ## get_chargeback_dispute
69
+
70
+ > <ChargebackDisputeResponse> get_chargeback_dispute(chargeback_dispute_oid, opts)
71
+
72
+ Retrieve a chargeback
73
+
74
+ Retrieves a single chargeback using the specified chargeback dispute oid.
75
+
76
+
77
+ ### Examples
78
+
79
+ ```ruby
80
+ # Internal API. No samples are provided as merchants will never need this api method
81
+ ```
82
+
83
+
84
+ #### Using the get_chargeback_dispute_with_http_info variant
85
+
86
+ This returns an Array which contains the response data, status code and headers.
87
+
88
+ > <Array(<ChargebackDisputeResponse>, Integer, Hash)> get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
89
+
90
+ ```ruby
91
+ begin
92
+ # Retrieve a chargeback
93
+ data, status_code, headers = api_instance.get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
94
+ p status_code # => 2xx
95
+ p headers # => { ... }
96
+ p data # => <ChargebackDisputeResponse>
97
+ rescue UltracartClient::ApiError => e
98
+ puts "Error when calling ChargebackApi->get_chargeback_dispute_with_http_info: #{e}"
99
+ end
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ | Name | Type | Description | Notes |
105
+ | ---- | ---- | ----------- | ----- |
106
+ | **chargeback_dispute_oid** | **Integer** | The chargeback dispute oid to retrieve. | |
107
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
108
+
109
+ ### Return type
110
+
111
+ [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
112
+
113
+ ### Authorization
114
+
115
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: Not defined
120
+ - **Accept**: application/json
121
+
122
+
123
+ ## get_chargeback_disputes
124
+
125
+ > <ChargebackDisputesResponse> get_chargeback_disputes(opts)
126
+
127
+ Retrieve chargebacks
128
+
129
+ 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.
130
+
131
+
132
+ ### Examples
133
+
134
+ ```ruby
135
+ # Internal API. No samples are provided as merchants will never need this api method
136
+ ```
137
+
138
+
139
+ #### Using the get_chargeback_disputes_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(<ChargebackDisputesResponse>, Integer, Hash)> get_chargeback_disputes_with_http_info(opts)
144
+
145
+ ```ruby
146
+ begin
147
+ # Retrieve chargebacks
148
+ data, status_code, headers = api_instance.get_chargeback_disputes_with_http_info(opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => <ChargebackDisputesResponse>
152
+ rescue UltracartClient::ApiError => e
153
+ puts "Error when calling ChargebackApi->get_chargeback_disputes_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **order_id** | **String** | Order Id | [optional] |
162
+ | **case_number** | **String** | Case number | [optional] |
163
+ | **status** | **String** | Status | [optional] |
164
+ | **expiration_dts_start** | **String** | Expiration dts start | [optional] |
165
+ | **expiration_dts_end** | **String** | Expiration dts end | [optional] |
166
+ | **chargeback_dts_start** | **String** | Chargeback dts start | [optional] |
167
+ | **chargeback_dts_end** | **String** | Chargeback dts end | [optional] |
168
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
169
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
170
+ | **_since** | **String** | Fetch chargebacks that have been created/modified since this date/time. | [optional] |
171
+ | **_sort** | **String** | The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
172
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
173
+
174
+ ### Return type
175
+
176
+ [**ChargebackDisputesResponse**](ChargebackDisputesResponse.md)
177
+
178
+ ### Authorization
179
+
180
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
181
+
182
+ ### HTTP request headers
183
+
184
+ - **Content-Type**: Not defined
185
+ - **Accept**: application/json
186
+
187
+
188
+ ## insert_chargeback
189
+
190
+ > <ChargebackDisputeResponse> insert_chargeback(chargeback, opts)
191
+
192
+ Insert a chargeback
193
+
194
+ Insert a chargeback on the UltraCart account.
195
+
196
+
197
+ ### Examples
198
+
199
+ ```ruby
200
+ # Internal API. No samples are provided as merchants will never need this api method
201
+ ```
202
+
203
+
204
+ #### Using the insert_chargeback_with_http_info variant
205
+
206
+ This returns an Array which contains the response data, status code and headers.
207
+
208
+ > <Array(<ChargebackDisputeResponse>, Integer, Hash)> insert_chargeback_with_http_info(chargeback, opts)
209
+
210
+ ```ruby
211
+ begin
212
+ # Insert a chargeback
213
+ data, status_code, headers = api_instance.insert_chargeback_with_http_info(chargeback, opts)
214
+ p status_code # => 2xx
215
+ p headers # => { ... }
216
+ p data # => <ChargebackDisputeResponse>
217
+ rescue UltracartClient::ApiError => e
218
+ puts "Error when calling ChargebackApi->insert_chargeback_with_http_info: #{e}"
219
+ end
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+ | Name | Type | Description | Notes |
225
+ | ---- | ---- | ----------- | ----- |
226
+ | **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to insert | |
227
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
228
+
229
+ ### Return type
230
+
231
+ [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
232
+
233
+ ### Authorization
234
+
235
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
236
+
237
+ ### HTTP request headers
238
+
239
+ - **Content-Type**: application/json; charset=UTF-8
240
+ - **Accept**: application/json
241
+
242
+
243
+ ## update_chargeback
244
+
245
+ > <ChargebackDisputeResponse> update_chargeback(chargeback_dispute_oid, chargeback, opts)
246
+
247
+ Update a chargeback
248
+
249
+ Update a chargeback on the UltraCart account.
250
+
251
+
252
+ ### Examples
253
+
254
+ ```ruby
255
+ # Internal API. No samples are provided as merchants will never need this api method
256
+ ```
257
+
258
+
259
+ #### Using the update_chargeback_with_http_info variant
260
+
261
+ This returns an Array which contains the response data, status code and headers.
262
+
263
+ > <Array(<ChargebackDisputeResponse>, Integer, Hash)> update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
264
+
265
+ ```ruby
266
+ begin
267
+ # Update a chargeback
268
+ data, status_code, headers = api_instance.update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
269
+ p status_code # => 2xx
270
+ p headers # => { ... }
271
+ p data # => <ChargebackDisputeResponse>
272
+ rescue UltracartClient::ApiError => e
273
+ puts "Error when calling ChargebackApi->update_chargeback_with_http_info: #{e}"
274
+ end
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ | Name | Type | Description | Notes |
280
+ | ---- | ---- | ----------- | ----- |
281
+ | **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to update. | |
282
+ | **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to update | |
283
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
284
+
285
+ ### Return type
286
+
287
+ [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
288
+
289
+ ### Authorization
290
+
291
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: application/json; charset=UTF-8
296
+ - **Accept**: application/json
297
+