ultracart-rest-sdk 4.1.18__py3-none-any.whl → 4.1.20__py3-none-any.whl
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.
- ultracart/__init__.py +1 -1
- ultracart/api/datawarehouse_api.py +585 -0
- ultracart/api_client.py +1 -1
- ultracart/apis/__init__.py +0 -1
- ultracart/configuration.py +1 -1
- ultracart/model/conversation_virtual_agent_capabilities.py +20 -2
- ultracart/model/conversation_virtual_agent_capability_zoho_desk_department.py +268 -0
- ultracart/model/custom_dashboard.py +6 -0
- ultracart/model/custom_dashboard_execution_parameter.py +276 -0
- ultracart/model/{chargeback_dispute.py → custom_dashboard_schedule.py} +23 -143
- ultracart/model/{chargeback_dispute_response.py → custom_dashboard_schedule_response.py} +9 -9
- ultracart/model/{chargeback_disputes_response.py → custom_dashboard_schedules_response.py} +9 -9
- ultracart/model/custom_report.py +4 -0
- ultracart/model/custom_report_execution_parameter.py +4 -0
- ultracart/model/email_campaign.py +8 -0
- ultracart/model/order_payment.py +2 -0
- ultracart/models/__init__.py +5 -3
- {ultracart_rest_sdk-4.1.18.dist-info → ultracart_rest_sdk-4.1.20.dist-info}/METADATA +1 -1
- {ultracart_rest_sdk-4.1.18.dist-info → ultracart_rest_sdk-4.1.20.dist-info}/RECORD +22 -21
- ultracart/api/chargeback_api.py +0 -818
- {ultracart_rest_sdk-4.1.18.dist-info → ultracart_rest_sdk-4.1.20.dist-info}/LICENSE +0 -0
- {ultracart_rest_sdk-4.1.18.dist-info → ultracart_rest_sdk-4.1.20.dist-info}/WHEEL +0 -0
- {ultracart_rest_sdk-4.1.18.dist-info → ultracart_rest_sdk-4.1.20.dist-info}/top_level.txt +0 -0
ultracart/api/chargeback_api.py
DELETED
|
@@ -1,818 +0,0 @@
|
|
|
1
|
-
"""
|
|
2
|
-
UltraCart Rest API V2
|
|
3
|
-
|
|
4
|
-
UltraCart REST API Version 2 # noqa: E501
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 2.0.0
|
|
7
|
-
Contact: support@ultracart.com
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
"""
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
import re # noqa: F401
|
|
13
|
-
import sys # noqa: F401
|
|
14
|
-
|
|
15
|
-
from ultracart.api_client import ApiClient, Endpoint as _Endpoint
|
|
16
|
-
from ultracart.model_utils import ( # noqa: F401
|
|
17
|
-
check_allowed_values,
|
|
18
|
-
check_validations,
|
|
19
|
-
date,
|
|
20
|
-
datetime,
|
|
21
|
-
file_type,
|
|
22
|
-
none_type,
|
|
23
|
-
validate_and_convert_types
|
|
24
|
-
)
|
|
25
|
-
from ultracart.model.chargeback_dispute import ChargebackDispute
|
|
26
|
-
from ultracart.model.chargeback_dispute_response import ChargebackDisputeResponse
|
|
27
|
-
from ultracart.model.chargeback_disputes_response import ChargebackDisputesResponse
|
|
28
|
-
from ultracart.model.error_response import ErrorResponse
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
class ChargebackApi(object):
|
|
32
|
-
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
33
|
-
Ref: https://openapi-generator.tech
|
|
34
|
-
|
|
35
|
-
Do not edit the class manually.
|
|
36
|
-
"""
|
|
37
|
-
|
|
38
|
-
@classmethod
|
|
39
|
-
def fromApiKey(cls, apiKey, verify_ssl = True, debug = False):
|
|
40
|
-
config = Configuration()
|
|
41
|
-
config.api_key['x-ultracart-simple-key'] = apiKey
|
|
42
|
-
config.debug = debug
|
|
43
|
-
config.verify_ssl = verify_ssl
|
|
44
|
-
|
|
45
|
-
api_client = ApiClient(configuration=config, header_name='X-UltraCart-Api-Version', header_value='2017-03-01')
|
|
46
|
-
return ChargebackApi(api_client)
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
def __init__(self, api_client=None):
|
|
50
|
-
if api_client is None:
|
|
51
|
-
api_client = ApiClient()
|
|
52
|
-
self.api_client = api_client
|
|
53
|
-
self.delete_chargeback_endpoint = _Endpoint(
|
|
54
|
-
settings={
|
|
55
|
-
'response_type': (ChargebackDisputeResponse,),
|
|
56
|
-
'auth': [
|
|
57
|
-
'ultraCartOauth',
|
|
58
|
-
'ultraCartSimpleApiKey'
|
|
59
|
-
],
|
|
60
|
-
'endpoint_path': '/chargeback/chargebacks/{chargeback_dispute_oid}',
|
|
61
|
-
'operation_id': 'delete_chargeback',
|
|
62
|
-
'http_method': 'DELETE',
|
|
63
|
-
'servers': None,
|
|
64
|
-
},
|
|
65
|
-
params_map={
|
|
66
|
-
'all': [
|
|
67
|
-
'chargeback_dispute_oid',
|
|
68
|
-
],
|
|
69
|
-
'required': [
|
|
70
|
-
'chargeback_dispute_oid',
|
|
71
|
-
],
|
|
72
|
-
'nullable': [
|
|
73
|
-
],
|
|
74
|
-
'enum': [
|
|
75
|
-
],
|
|
76
|
-
'validation': [
|
|
77
|
-
]
|
|
78
|
-
},
|
|
79
|
-
root_map={
|
|
80
|
-
'validations': {
|
|
81
|
-
},
|
|
82
|
-
'allowed_values': {
|
|
83
|
-
},
|
|
84
|
-
'openapi_types': {
|
|
85
|
-
'chargeback_dispute_oid':
|
|
86
|
-
(int,),
|
|
87
|
-
},
|
|
88
|
-
'attribute_map': {
|
|
89
|
-
'chargeback_dispute_oid': 'chargeback_dispute_oid',
|
|
90
|
-
},
|
|
91
|
-
'location_map': {
|
|
92
|
-
'chargeback_dispute_oid': 'path',
|
|
93
|
-
},
|
|
94
|
-
'collection_format_map': {
|
|
95
|
-
}
|
|
96
|
-
},
|
|
97
|
-
headers_map={
|
|
98
|
-
'accept': [
|
|
99
|
-
'application/json'
|
|
100
|
-
],
|
|
101
|
-
'content_type': [],
|
|
102
|
-
},
|
|
103
|
-
api_client=api_client
|
|
104
|
-
)
|
|
105
|
-
self.get_chargeback_dispute_endpoint = _Endpoint(
|
|
106
|
-
settings={
|
|
107
|
-
'response_type': (ChargebackDisputeResponse,),
|
|
108
|
-
'auth': [
|
|
109
|
-
'ultraCartOauth',
|
|
110
|
-
'ultraCartSimpleApiKey'
|
|
111
|
-
],
|
|
112
|
-
'endpoint_path': '/chargeback/chargebacks/{chargeback_dispute_oid}',
|
|
113
|
-
'operation_id': 'get_chargeback_dispute',
|
|
114
|
-
'http_method': 'GET',
|
|
115
|
-
'servers': None,
|
|
116
|
-
},
|
|
117
|
-
params_map={
|
|
118
|
-
'all': [
|
|
119
|
-
'chargeback_dispute_oid',
|
|
120
|
-
'expand',
|
|
121
|
-
],
|
|
122
|
-
'required': [
|
|
123
|
-
'chargeback_dispute_oid',
|
|
124
|
-
],
|
|
125
|
-
'nullable': [
|
|
126
|
-
],
|
|
127
|
-
'enum': [
|
|
128
|
-
],
|
|
129
|
-
'validation': [
|
|
130
|
-
]
|
|
131
|
-
},
|
|
132
|
-
root_map={
|
|
133
|
-
'validations': {
|
|
134
|
-
},
|
|
135
|
-
'allowed_values': {
|
|
136
|
-
},
|
|
137
|
-
'openapi_types': {
|
|
138
|
-
'chargeback_dispute_oid':
|
|
139
|
-
(int,),
|
|
140
|
-
'expand':
|
|
141
|
-
(str,),
|
|
142
|
-
},
|
|
143
|
-
'attribute_map': {
|
|
144
|
-
'chargeback_dispute_oid': 'chargeback_dispute_oid',
|
|
145
|
-
'expand': '_expand',
|
|
146
|
-
},
|
|
147
|
-
'location_map': {
|
|
148
|
-
'chargeback_dispute_oid': 'path',
|
|
149
|
-
'expand': 'query',
|
|
150
|
-
},
|
|
151
|
-
'collection_format_map': {
|
|
152
|
-
}
|
|
153
|
-
},
|
|
154
|
-
headers_map={
|
|
155
|
-
'accept': [
|
|
156
|
-
'application/json'
|
|
157
|
-
],
|
|
158
|
-
'content_type': [],
|
|
159
|
-
},
|
|
160
|
-
api_client=api_client
|
|
161
|
-
)
|
|
162
|
-
self.get_chargeback_disputes_endpoint = _Endpoint(
|
|
163
|
-
settings={
|
|
164
|
-
'response_type': (ChargebackDisputesResponse,),
|
|
165
|
-
'auth': [
|
|
166
|
-
'ultraCartOauth',
|
|
167
|
-
'ultraCartSimpleApiKey'
|
|
168
|
-
],
|
|
169
|
-
'endpoint_path': '/chargeback/chargebacks',
|
|
170
|
-
'operation_id': 'get_chargeback_disputes',
|
|
171
|
-
'http_method': 'GET',
|
|
172
|
-
'servers': None,
|
|
173
|
-
},
|
|
174
|
-
params_map={
|
|
175
|
-
'all': [
|
|
176
|
-
'order_id',
|
|
177
|
-
'case_number',
|
|
178
|
-
'status',
|
|
179
|
-
'expiration_dts_start',
|
|
180
|
-
'expiration_dts_end',
|
|
181
|
-
'chargeback_dts_start',
|
|
182
|
-
'chargeback_dts_end',
|
|
183
|
-
'limit',
|
|
184
|
-
'offset',
|
|
185
|
-
'since',
|
|
186
|
-
'sort',
|
|
187
|
-
'expand',
|
|
188
|
-
],
|
|
189
|
-
'required': [],
|
|
190
|
-
'nullable': [
|
|
191
|
-
],
|
|
192
|
-
'enum': [
|
|
193
|
-
],
|
|
194
|
-
'validation': [
|
|
195
|
-
]
|
|
196
|
-
},
|
|
197
|
-
root_map={
|
|
198
|
-
'validations': {
|
|
199
|
-
},
|
|
200
|
-
'allowed_values': {
|
|
201
|
-
},
|
|
202
|
-
'openapi_types': {
|
|
203
|
-
'order_id':
|
|
204
|
-
(str,),
|
|
205
|
-
'case_number':
|
|
206
|
-
(str,),
|
|
207
|
-
'status':
|
|
208
|
-
(str,),
|
|
209
|
-
'expiration_dts_start':
|
|
210
|
-
(str,),
|
|
211
|
-
'expiration_dts_end':
|
|
212
|
-
(str,),
|
|
213
|
-
'chargeback_dts_start':
|
|
214
|
-
(str,),
|
|
215
|
-
'chargeback_dts_end':
|
|
216
|
-
(str,),
|
|
217
|
-
'limit':
|
|
218
|
-
(int,),
|
|
219
|
-
'offset':
|
|
220
|
-
(int,),
|
|
221
|
-
'since':
|
|
222
|
-
(str,),
|
|
223
|
-
'sort':
|
|
224
|
-
(str,),
|
|
225
|
-
'expand':
|
|
226
|
-
(str,),
|
|
227
|
-
},
|
|
228
|
-
'attribute_map': {
|
|
229
|
-
'order_id': 'order_id',
|
|
230
|
-
'case_number': 'case_number',
|
|
231
|
-
'status': 'status',
|
|
232
|
-
'expiration_dts_start': 'expiration_dts_start',
|
|
233
|
-
'expiration_dts_end': 'expiration_dts_end',
|
|
234
|
-
'chargeback_dts_start': 'chargeback_dts_start',
|
|
235
|
-
'chargeback_dts_end': 'chargeback_dts_end',
|
|
236
|
-
'limit': '_limit',
|
|
237
|
-
'offset': '_offset',
|
|
238
|
-
'since': '_since',
|
|
239
|
-
'sort': '_sort',
|
|
240
|
-
'expand': '_expand',
|
|
241
|
-
},
|
|
242
|
-
'location_map': {
|
|
243
|
-
'order_id': 'query',
|
|
244
|
-
'case_number': 'query',
|
|
245
|
-
'status': 'query',
|
|
246
|
-
'expiration_dts_start': 'query',
|
|
247
|
-
'expiration_dts_end': 'query',
|
|
248
|
-
'chargeback_dts_start': 'query',
|
|
249
|
-
'chargeback_dts_end': 'query',
|
|
250
|
-
'limit': 'query',
|
|
251
|
-
'offset': 'query',
|
|
252
|
-
'since': 'query',
|
|
253
|
-
'sort': 'query',
|
|
254
|
-
'expand': 'query',
|
|
255
|
-
},
|
|
256
|
-
'collection_format_map': {
|
|
257
|
-
}
|
|
258
|
-
},
|
|
259
|
-
headers_map={
|
|
260
|
-
'accept': [
|
|
261
|
-
'application/json'
|
|
262
|
-
],
|
|
263
|
-
'content_type': [],
|
|
264
|
-
},
|
|
265
|
-
api_client=api_client
|
|
266
|
-
)
|
|
267
|
-
self.insert_chargeback_endpoint = _Endpoint(
|
|
268
|
-
settings={
|
|
269
|
-
'response_type': (ChargebackDisputeResponse,),
|
|
270
|
-
'auth': [
|
|
271
|
-
'ultraCartOauth',
|
|
272
|
-
'ultraCartSimpleApiKey'
|
|
273
|
-
],
|
|
274
|
-
'endpoint_path': '/chargeback/chargebacks',
|
|
275
|
-
'operation_id': 'insert_chargeback',
|
|
276
|
-
'http_method': 'POST',
|
|
277
|
-
'servers': None,
|
|
278
|
-
},
|
|
279
|
-
params_map={
|
|
280
|
-
'all': [
|
|
281
|
-
'chargeback',
|
|
282
|
-
'expand',
|
|
283
|
-
],
|
|
284
|
-
'required': [
|
|
285
|
-
'chargeback',
|
|
286
|
-
],
|
|
287
|
-
'nullable': [
|
|
288
|
-
],
|
|
289
|
-
'enum': [
|
|
290
|
-
],
|
|
291
|
-
'validation': [
|
|
292
|
-
]
|
|
293
|
-
},
|
|
294
|
-
root_map={
|
|
295
|
-
'validations': {
|
|
296
|
-
},
|
|
297
|
-
'allowed_values': {
|
|
298
|
-
},
|
|
299
|
-
'openapi_types': {
|
|
300
|
-
'chargeback':
|
|
301
|
-
(ChargebackDispute,),
|
|
302
|
-
'expand':
|
|
303
|
-
(str,),
|
|
304
|
-
},
|
|
305
|
-
'attribute_map': {
|
|
306
|
-
'expand': '_expand',
|
|
307
|
-
},
|
|
308
|
-
'location_map': {
|
|
309
|
-
'chargeback': 'body',
|
|
310
|
-
'expand': 'query',
|
|
311
|
-
},
|
|
312
|
-
'collection_format_map': {
|
|
313
|
-
}
|
|
314
|
-
},
|
|
315
|
-
headers_map={
|
|
316
|
-
'accept': [
|
|
317
|
-
'application/json'
|
|
318
|
-
],
|
|
319
|
-
'content_type': [
|
|
320
|
-
'application/json; charset=UTF-8'
|
|
321
|
-
]
|
|
322
|
-
},
|
|
323
|
-
api_client=api_client
|
|
324
|
-
)
|
|
325
|
-
self.update_chargeback_endpoint = _Endpoint(
|
|
326
|
-
settings={
|
|
327
|
-
'response_type': (ChargebackDisputeResponse,),
|
|
328
|
-
'auth': [
|
|
329
|
-
'ultraCartOauth',
|
|
330
|
-
'ultraCartSimpleApiKey'
|
|
331
|
-
],
|
|
332
|
-
'endpoint_path': '/chargeback/chargebacks/{chargeback_dispute_oid}',
|
|
333
|
-
'operation_id': 'update_chargeback',
|
|
334
|
-
'http_method': 'PUT',
|
|
335
|
-
'servers': None,
|
|
336
|
-
},
|
|
337
|
-
params_map={
|
|
338
|
-
'all': [
|
|
339
|
-
'chargeback_dispute_oid',
|
|
340
|
-
'chargeback',
|
|
341
|
-
'expand',
|
|
342
|
-
],
|
|
343
|
-
'required': [
|
|
344
|
-
'chargeback_dispute_oid',
|
|
345
|
-
'chargeback',
|
|
346
|
-
],
|
|
347
|
-
'nullable': [
|
|
348
|
-
],
|
|
349
|
-
'enum': [
|
|
350
|
-
],
|
|
351
|
-
'validation': [
|
|
352
|
-
]
|
|
353
|
-
},
|
|
354
|
-
root_map={
|
|
355
|
-
'validations': {
|
|
356
|
-
},
|
|
357
|
-
'allowed_values': {
|
|
358
|
-
},
|
|
359
|
-
'openapi_types': {
|
|
360
|
-
'chargeback_dispute_oid':
|
|
361
|
-
(int,),
|
|
362
|
-
'chargeback':
|
|
363
|
-
(ChargebackDispute,),
|
|
364
|
-
'expand':
|
|
365
|
-
(str,),
|
|
366
|
-
},
|
|
367
|
-
'attribute_map': {
|
|
368
|
-
'chargeback_dispute_oid': 'chargeback_dispute_oid',
|
|
369
|
-
'expand': '_expand',
|
|
370
|
-
},
|
|
371
|
-
'location_map': {
|
|
372
|
-
'chargeback_dispute_oid': 'path',
|
|
373
|
-
'chargeback': 'body',
|
|
374
|
-
'expand': 'query',
|
|
375
|
-
},
|
|
376
|
-
'collection_format_map': {
|
|
377
|
-
}
|
|
378
|
-
},
|
|
379
|
-
headers_map={
|
|
380
|
-
'accept': [
|
|
381
|
-
'application/json'
|
|
382
|
-
],
|
|
383
|
-
'content_type': [
|
|
384
|
-
'application/json; charset=UTF-8'
|
|
385
|
-
]
|
|
386
|
-
},
|
|
387
|
-
api_client=api_client
|
|
388
|
-
)
|
|
389
|
-
|
|
390
|
-
def delete_chargeback(
|
|
391
|
-
self,
|
|
392
|
-
chargeback_dispute_oid,
|
|
393
|
-
**kwargs
|
|
394
|
-
):
|
|
395
|
-
"""Delete a chargeback # noqa: E501
|
|
396
|
-
|
|
397
|
-
Delete a chargeback on the UltraCart account. # noqa: E501
|
|
398
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
399
|
-
asynchronous HTTP request, please pass async_req=True
|
|
400
|
-
|
|
401
|
-
>>> thread = api.delete_chargeback(chargeback_dispute_oid, async_req=True)
|
|
402
|
-
>>> result = thread.get()
|
|
403
|
-
|
|
404
|
-
Args:
|
|
405
|
-
chargeback_dispute_oid (int): The chargeback_dispute_oid to delete.
|
|
406
|
-
|
|
407
|
-
Keyword Args:
|
|
408
|
-
_return_http_data_only (bool): response data without head status
|
|
409
|
-
code and headers. Default is True.
|
|
410
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
411
|
-
will be returned without reading/decoding response data.
|
|
412
|
-
Default is True.
|
|
413
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
414
|
-
one number provided, it will be total request timeout. It can also
|
|
415
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
416
|
-
Default is None.
|
|
417
|
-
_check_input_type (bool): specifies if type checking
|
|
418
|
-
should be done one the data sent to the server.
|
|
419
|
-
Default is True.
|
|
420
|
-
_check_return_type (bool): specifies if type checking
|
|
421
|
-
should be done one the data received from the server.
|
|
422
|
-
Default is True.
|
|
423
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
424
|
-
are serialized names, as specified in the OpenAPI document.
|
|
425
|
-
False if the variable names in the input data
|
|
426
|
-
are pythonic names, e.g. snake case (default)
|
|
427
|
-
_content_type (str/None): force body content-type.
|
|
428
|
-
Default is None and content-type will be predicted by allowed
|
|
429
|
-
content-types and body.
|
|
430
|
-
_host_index (int/None): specifies the index of the server
|
|
431
|
-
that we want to use.
|
|
432
|
-
Default is read from the configuration.
|
|
433
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
434
|
-
request; this effectively ignores the authentication
|
|
435
|
-
in the spec for a single request.
|
|
436
|
-
Default is None
|
|
437
|
-
async_req (bool): execute request asynchronously
|
|
438
|
-
|
|
439
|
-
Returns:
|
|
440
|
-
ChargebackDisputeResponse
|
|
441
|
-
If the method is called asynchronously, returns the request
|
|
442
|
-
thread.
|
|
443
|
-
"""
|
|
444
|
-
kwargs['async_req'] = kwargs.get(
|
|
445
|
-
'async_req', False
|
|
446
|
-
)
|
|
447
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
448
|
-
'_return_http_data_only', True
|
|
449
|
-
)
|
|
450
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
451
|
-
'_preload_content', True
|
|
452
|
-
)
|
|
453
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
454
|
-
'_request_timeout', None
|
|
455
|
-
)
|
|
456
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
457
|
-
'_check_input_type', True
|
|
458
|
-
)
|
|
459
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
460
|
-
'_check_return_type', True
|
|
461
|
-
)
|
|
462
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
463
|
-
'_spec_property_naming', False
|
|
464
|
-
)
|
|
465
|
-
kwargs['_content_type'] = kwargs.get(
|
|
466
|
-
'_content_type')
|
|
467
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
468
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
469
|
-
kwargs['chargeback_dispute_oid'] = \
|
|
470
|
-
chargeback_dispute_oid
|
|
471
|
-
return self.delete_chargeback_endpoint.call_with_http_info(**kwargs)
|
|
472
|
-
|
|
473
|
-
def get_chargeback_dispute(
|
|
474
|
-
self,
|
|
475
|
-
chargeback_dispute_oid,
|
|
476
|
-
**kwargs
|
|
477
|
-
):
|
|
478
|
-
"""Retrieve a chargeback # noqa: E501
|
|
479
|
-
|
|
480
|
-
Retrieves a single chargeback using the specified chargeback dispute oid. # noqa: E501
|
|
481
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
482
|
-
asynchronous HTTP request, please pass async_req=True
|
|
483
|
-
|
|
484
|
-
>>> thread = api.get_chargeback_dispute(chargeback_dispute_oid, async_req=True)
|
|
485
|
-
>>> result = thread.get()
|
|
486
|
-
|
|
487
|
-
Args:
|
|
488
|
-
chargeback_dispute_oid (int): The chargeback dispute oid to retrieve.
|
|
489
|
-
|
|
490
|
-
Keyword Args:
|
|
491
|
-
expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
|
|
492
|
-
_return_http_data_only (bool): response data without head status
|
|
493
|
-
code and headers. Default is True.
|
|
494
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
495
|
-
will be returned without reading/decoding response data.
|
|
496
|
-
Default is True.
|
|
497
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
498
|
-
one number provided, it will be total request timeout. It can also
|
|
499
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
500
|
-
Default is None.
|
|
501
|
-
_check_input_type (bool): specifies if type checking
|
|
502
|
-
should be done one the data sent to the server.
|
|
503
|
-
Default is True.
|
|
504
|
-
_check_return_type (bool): specifies if type checking
|
|
505
|
-
should be done one the data received from the server.
|
|
506
|
-
Default is True.
|
|
507
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
508
|
-
are serialized names, as specified in the OpenAPI document.
|
|
509
|
-
False if the variable names in the input data
|
|
510
|
-
are pythonic names, e.g. snake case (default)
|
|
511
|
-
_content_type (str/None): force body content-type.
|
|
512
|
-
Default is None and content-type will be predicted by allowed
|
|
513
|
-
content-types and body.
|
|
514
|
-
_host_index (int/None): specifies the index of the server
|
|
515
|
-
that we want to use.
|
|
516
|
-
Default is read from the configuration.
|
|
517
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
518
|
-
request; this effectively ignores the authentication
|
|
519
|
-
in the spec for a single request.
|
|
520
|
-
Default is None
|
|
521
|
-
async_req (bool): execute request asynchronously
|
|
522
|
-
|
|
523
|
-
Returns:
|
|
524
|
-
ChargebackDisputeResponse
|
|
525
|
-
If the method is called asynchronously, returns the request
|
|
526
|
-
thread.
|
|
527
|
-
"""
|
|
528
|
-
kwargs['async_req'] = kwargs.get(
|
|
529
|
-
'async_req', False
|
|
530
|
-
)
|
|
531
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
532
|
-
'_return_http_data_only', True
|
|
533
|
-
)
|
|
534
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
535
|
-
'_preload_content', True
|
|
536
|
-
)
|
|
537
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
538
|
-
'_request_timeout', None
|
|
539
|
-
)
|
|
540
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
541
|
-
'_check_input_type', True
|
|
542
|
-
)
|
|
543
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
544
|
-
'_check_return_type', True
|
|
545
|
-
)
|
|
546
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
547
|
-
'_spec_property_naming', False
|
|
548
|
-
)
|
|
549
|
-
kwargs['_content_type'] = kwargs.get(
|
|
550
|
-
'_content_type')
|
|
551
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
552
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
553
|
-
kwargs['chargeback_dispute_oid'] = \
|
|
554
|
-
chargeback_dispute_oid
|
|
555
|
-
return self.get_chargeback_dispute_endpoint.call_with_http_info(**kwargs)
|
|
556
|
-
|
|
557
|
-
def get_chargeback_disputes(
|
|
558
|
-
self,
|
|
559
|
-
**kwargs
|
|
560
|
-
):
|
|
561
|
-
"""Retrieve chargebacks # noqa: E501
|
|
562
|
-
|
|
563
|
-
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. # noqa: E501
|
|
564
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
565
|
-
asynchronous HTTP request, please pass async_req=True
|
|
566
|
-
|
|
567
|
-
>>> thread = api.get_chargeback_disputes(async_req=True)
|
|
568
|
-
>>> result = thread.get()
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
Keyword Args:
|
|
572
|
-
order_id (str): Order Id. [optional]
|
|
573
|
-
case_number (str): Case number. [optional]
|
|
574
|
-
status (str): Status. [optional]
|
|
575
|
-
expiration_dts_start (str): Expiration dts start. [optional]
|
|
576
|
-
expiration_dts_end (str): Expiration dts end. [optional]
|
|
577
|
-
chargeback_dts_start (str): Chargeback dts start. [optional]
|
|
578
|
-
chargeback_dts_end (str): Chargeback dts end. [optional]
|
|
579
|
-
limit (int): The maximum number of records to return on this one API call. (Max 200). [optional] if omitted the server will use the default value of 100
|
|
580
|
-
offset (int): Pagination of the record set. Offset is a zero based index.. [optional] if omitted the server will use the default value of 0
|
|
581
|
-
since (str): Fetch chargebacks that have been created/modified since this date/time.. [optional]
|
|
582
|
-
sort (str): The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.. [optional]
|
|
583
|
-
expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
|
|
584
|
-
_return_http_data_only (bool): response data without head status
|
|
585
|
-
code and headers. Default is True.
|
|
586
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
587
|
-
will be returned without reading/decoding response data.
|
|
588
|
-
Default is True.
|
|
589
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
590
|
-
one number provided, it will be total request timeout. It can also
|
|
591
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
592
|
-
Default is None.
|
|
593
|
-
_check_input_type (bool): specifies if type checking
|
|
594
|
-
should be done one the data sent to the server.
|
|
595
|
-
Default is True.
|
|
596
|
-
_check_return_type (bool): specifies if type checking
|
|
597
|
-
should be done one the data received from the server.
|
|
598
|
-
Default is True.
|
|
599
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
600
|
-
are serialized names, as specified in the OpenAPI document.
|
|
601
|
-
False if the variable names in the input data
|
|
602
|
-
are pythonic names, e.g. snake case (default)
|
|
603
|
-
_content_type (str/None): force body content-type.
|
|
604
|
-
Default is None and content-type will be predicted by allowed
|
|
605
|
-
content-types and body.
|
|
606
|
-
_host_index (int/None): specifies the index of the server
|
|
607
|
-
that we want to use.
|
|
608
|
-
Default is read from the configuration.
|
|
609
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
610
|
-
request; this effectively ignores the authentication
|
|
611
|
-
in the spec for a single request.
|
|
612
|
-
Default is None
|
|
613
|
-
async_req (bool): execute request asynchronously
|
|
614
|
-
|
|
615
|
-
Returns:
|
|
616
|
-
ChargebackDisputesResponse
|
|
617
|
-
If the method is called asynchronously, returns the request
|
|
618
|
-
thread.
|
|
619
|
-
"""
|
|
620
|
-
kwargs['async_req'] = kwargs.get(
|
|
621
|
-
'async_req', False
|
|
622
|
-
)
|
|
623
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
624
|
-
'_return_http_data_only', True
|
|
625
|
-
)
|
|
626
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
627
|
-
'_preload_content', True
|
|
628
|
-
)
|
|
629
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
630
|
-
'_request_timeout', None
|
|
631
|
-
)
|
|
632
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
633
|
-
'_check_input_type', True
|
|
634
|
-
)
|
|
635
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
636
|
-
'_check_return_type', True
|
|
637
|
-
)
|
|
638
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
639
|
-
'_spec_property_naming', False
|
|
640
|
-
)
|
|
641
|
-
kwargs['_content_type'] = kwargs.get(
|
|
642
|
-
'_content_type')
|
|
643
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
644
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
645
|
-
return self.get_chargeback_disputes_endpoint.call_with_http_info(**kwargs)
|
|
646
|
-
|
|
647
|
-
def insert_chargeback(
|
|
648
|
-
self,
|
|
649
|
-
chargeback,
|
|
650
|
-
**kwargs
|
|
651
|
-
):
|
|
652
|
-
"""Insert a chargeback # noqa: E501
|
|
653
|
-
|
|
654
|
-
Insert a chargeback on the UltraCart account. # noqa: E501
|
|
655
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
656
|
-
asynchronous HTTP request, please pass async_req=True
|
|
657
|
-
|
|
658
|
-
>>> thread = api.insert_chargeback(chargeback, async_req=True)
|
|
659
|
-
>>> result = thread.get()
|
|
660
|
-
|
|
661
|
-
Args:
|
|
662
|
-
chargeback (ChargebackDispute): Chargeback to insert
|
|
663
|
-
|
|
664
|
-
Keyword Args:
|
|
665
|
-
expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
|
|
666
|
-
_return_http_data_only (bool): response data without head status
|
|
667
|
-
code and headers. Default is True.
|
|
668
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
669
|
-
will be returned without reading/decoding response data.
|
|
670
|
-
Default is True.
|
|
671
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
672
|
-
one number provided, it will be total request timeout. It can also
|
|
673
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
674
|
-
Default is None.
|
|
675
|
-
_check_input_type (bool): specifies if type checking
|
|
676
|
-
should be done one the data sent to the server.
|
|
677
|
-
Default is True.
|
|
678
|
-
_check_return_type (bool): specifies if type checking
|
|
679
|
-
should be done one the data received from the server.
|
|
680
|
-
Default is True.
|
|
681
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
682
|
-
are serialized names, as specified in the OpenAPI document.
|
|
683
|
-
False if the variable names in the input data
|
|
684
|
-
are pythonic names, e.g. snake case (default)
|
|
685
|
-
_content_type (str/None): force body content-type.
|
|
686
|
-
Default is None and content-type will be predicted by allowed
|
|
687
|
-
content-types and body.
|
|
688
|
-
_host_index (int/None): specifies the index of the server
|
|
689
|
-
that we want to use.
|
|
690
|
-
Default is read from the configuration.
|
|
691
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
692
|
-
request; this effectively ignores the authentication
|
|
693
|
-
in the spec for a single request.
|
|
694
|
-
Default is None
|
|
695
|
-
async_req (bool): execute request asynchronously
|
|
696
|
-
|
|
697
|
-
Returns:
|
|
698
|
-
ChargebackDisputeResponse
|
|
699
|
-
If the method is called asynchronously, returns the request
|
|
700
|
-
thread.
|
|
701
|
-
"""
|
|
702
|
-
kwargs['async_req'] = kwargs.get(
|
|
703
|
-
'async_req', False
|
|
704
|
-
)
|
|
705
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
706
|
-
'_return_http_data_only', True
|
|
707
|
-
)
|
|
708
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
709
|
-
'_preload_content', True
|
|
710
|
-
)
|
|
711
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
712
|
-
'_request_timeout', None
|
|
713
|
-
)
|
|
714
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
715
|
-
'_check_input_type', True
|
|
716
|
-
)
|
|
717
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
718
|
-
'_check_return_type', True
|
|
719
|
-
)
|
|
720
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
721
|
-
'_spec_property_naming', False
|
|
722
|
-
)
|
|
723
|
-
kwargs['_content_type'] = kwargs.get(
|
|
724
|
-
'_content_type')
|
|
725
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
726
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
727
|
-
kwargs['chargeback'] = \
|
|
728
|
-
chargeback
|
|
729
|
-
return self.insert_chargeback_endpoint.call_with_http_info(**kwargs)
|
|
730
|
-
|
|
731
|
-
def update_chargeback(
|
|
732
|
-
self,
|
|
733
|
-
chargeback_dispute_oid,
|
|
734
|
-
chargeback,
|
|
735
|
-
**kwargs
|
|
736
|
-
):
|
|
737
|
-
"""Update a chargeback # noqa: E501
|
|
738
|
-
|
|
739
|
-
Update a chargeback on the UltraCart account. # noqa: E501
|
|
740
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
741
|
-
asynchronous HTTP request, please pass async_req=True
|
|
742
|
-
|
|
743
|
-
>>> thread = api.update_chargeback(chargeback_dispute_oid, chargeback, async_req=True)
|
|
744
|
-
>>> result = thread.get()
|
|
745
|
-
|
|
746
|
-
Args:
|
|
747
|
-
chargeback_dispute_oid (int): The chargeback_dispute_oid to update.
|
|
748
|
-
chargeback (ChargebackDispute): Chargeback to update
|
|
749
|
-
|
|
750
|
-
Keyword Args:
|
|
751
|
-
expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
|
|
752
|
-
_return_http_data_only (bool): response data without head status
|
|
753
|
-
code and headers. Default is True.
|
|
754
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
755
|
-
will be returned without reading/decoding response data.
|
|
756
|
-
Default is True.
|
|
757
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
758
|
-
one number provided, it will be total request timeout. It can also
|
|
759
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
760
|
-
Default is None.
|
|
761
|
-
_check_input_type (bool): specifies if type checking
|
|
762
|
-
should be done one the data sent to the server.
|
|
763
|
-
Default is True.
|
|
764
|
-
_check_return_type (bool): specifies if type checking
|
|
765
|
-
should be done one the data received from the server.
|
|
766
|
-
Default is True.
|
|
767
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
768
|
-
are serialized names, as specified in the OpenAPI document.
|
|
769
|
-
False if the variable names in the input data
|
|
770
|
-
are pythonic names, e.g. snake case (default)
|
|
771
|
-
_content_type (str/None): force body content-type.
|
|
772
|
-
Default is None and content-type will be predicted by allowed
|
|
773
|
-
content-types and body.
|
|
774
|
-
_host_index (int/None): specifies the index of the server
|
|
775
|
-
that we want to use.
|
|
776
|
-
Default is read from the configuration.
|
|
777
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
778
|
-
request; this effectively ignores the authentication
|
|
779
|
-
in the spec for a single request.
|
|
780
|
-
Default is None
|
|
781
|
-
async_req (bool): execute request asynchronously
|
|
782
|
-
|
|
783
|
-
Returns:
|
|
784
|
-
ChargebackDisputeResponse
|
|
785
|
-
If the method is called asynchronously, returns the request
|
|
786
|
-
thread.
|
|
787
|
-
"""
|
|
788
|
-
kwargs['async_req'] = kwargs.get(
|
|
789
|
-
'async_req', False
|
|
790
|
-
)
|
|
791
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
792
|
-
'_return_http_data_only', True
|
|
793
|
-
)
|
|
794
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
795
|
-
'_preload_content', True
|
|
796
|
-
)
|
|
797
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
798
|
-
'_request_timeout', None
|
|
799
|
-
)
|
|
800
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
801
|
-
'_check_input_type', True
|
|
802
|
-
)
|
|
803
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
804
|
-
'_check_return_type', True
|
|
805
|
-
)
|
|
806
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
807
|
-
'_spec_property_naming', False
|
|
808
|
-
)
|
|
809
|
-
kwargs['_content_type'] = kwargs.get(
|
|
810
|
-
'_content_type')
|
|
811
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
812
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
813
|
-
kwargs['chargeback_dispute_oid'] = \
|
|
814
|
-
chargeback_dispute_oid
|
|
815
|
-
kwargs['chargeback'] = \
|
|
816
|
-
chargeback
|
|
817
|
-
return self.update_chargeback_endpoint.call_with_http_info(**kwargs)
|
|
818
|
-
|