criteo-api-retailmedia-sdk 2024.4.0.250409__py3-none-any.whl → 2024.4.0.250606__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.

Potentially problematic release.


This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.

Files changed (39) hide show
  1. {criteo_api_retailmedia_sdk-2024.4.0.250409.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250606.dist-info}/METADATA +3 -3
  2. {criteo_api_retailmedia_sdk-2024.4.0.250409.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250606.dist-info}/RECORD +15 -39
  3. {criteo_api_retailmedia_sdk-2024.4.0.250409.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250606.dist-info}/WHEEL +1 -1
  4. criteo_api_retailmedia_v2024_04/__init__.py +1 -1
  5. criteo_api_retailmedia_v2024_04/api/balance_api.py +10 -913
  6. criteo_api_retailmedia_v2024_04/api/campaign_api.py +102 -988
  7. criteo_api_retailmedia_v2024_04/api_client.py +1 -1
  8. criteo_api_retailmedia_v2024_04/configuration.py +1 -1
  9. criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py +4 -4
  10. criteo_api_retailmedia_v2024_04/model/async_line_items_report.py +4 -4
  11. criteo_api_retailmedia_v2024_04/model/async_revenue_report.py +4 -4
  12. criteo_api_retailmedia_v2024_04/model/external_common_line_item.py +4 -0
  13. criteo_api_retailmedia_v2024_04/model/external_line_item_page202110.py +3 -3
  14. criteo_api_retailmedia_v2024_04/models/__init__.py +0 -24
  15. criteo_api_retailmedia_v2024_04/model/add_funds_to_balance_request.py +0 -269
  16. criteo_api_retailmedia_v2024_04/model/balance_response.py +0 -281
  17. criteo_api_retailmedia_v2024_04/model/balance_response_paged_list_response.py +0 -287
  18. criteo_api_retailmedia_v2024_04/model/change_dates_of_balance_request.py +0 -269
  19. criteo_api_retailmedia_v2024_04/model/change_details.py +0 -275
  20. criteo_api_retailmedia_v2024_04/model/create_balance_request.py +0 -269
  21. criteo_api_retailmedia_v2024_04/model/external_add_funds_to_balance.py +0 -279
  22. criteo_api_retailmedia_v2024_04/model/external_balance_response.py +0 -375
  23. criteo_api_retailmedia_v2024_04/model/external_change_dates_of_balance.py +0 -281
  24. criteo_api_retailmedia_v2024_04/model/external_create_balance.py +0 -314
  25. criteo_api_retailmedia_v2024_04/model/external_promoted_product202110.py +0 -263
  26. criteo_api_retailmedia_v2024_04/model/external_update_balance_model.py +0 -283
  27. criteo_api_retailmedia_v2024_04/model/insertion_order_history_change_data_capture.py +0 -303
  28. criteo_api_retailmedia_v2024_04/model/metadata.py +0 -273
  29. criteo_api_retailmedia_v2024_04/model/page_of_insertion_order_history_change_data_capture.py +0 -276
  30. criteo_api_retailmedia_v2024_04/model/promoted_product202110_list_request.py +0 -269
  31. criteo_api_retailmedia_v2024_04/model/promoted_product202110_paged_list_response.py +0 -287
  32. criteo_api_retailmedia_v2024_04/model/resource_of_add_funds_to_balance.py +0 -277
  33. criteo_api_retailmedia_v2024_04/model/resource_of_balance_response.py +0 -277
  34. criteo_api_retailmedia_v2024_04/model/resource_of_change_dates_of_balance.py +0 -277
  35. criteo_api_retailmedia_v2024_04/model/resource_of_create_balance.py +0 -277
  36. criteo_api_retailmedia_v2024_04/model/resource_of_promoted_product202110.py +0 -277
  37. criteo_api_retailmedia_v2024_04/model/resource_of_update_balance_model.py +0 -277
  38. criteo_api_retailmedia_v2024_04/model/update_balance_model_request.py +0 -269
  39. {criteo_api_retailmedia_sdk-2024.4.0.250409.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250606.dist-info}/top_level.txt +0 -0
@@ -21,13 +21,7 @@ from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401
21
21
  none_type,
22
22
  validate_and_convert_types
23
23
  )
24
- from criteo_api_retailmedia_v2024_04.model.add_funds_to_balance_request import AddFundsToBalanceRequest
25
24
  from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse
26
- from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse
27
- from criteo_api_retailmedia_v2024_04.model.balance_response_paged_list_response import BalanceResponsePagedListResponse
28
- from criteo_api_retailmedia_v2024_04.model.change_dates_of_balance_request import ChangeDatesOfBalanceRequest
29
- from criteo_api_retailmedia_v2024_04.model.create_balance_request import CreateBalanceRequest
30
- from criteo_api_retailmedia_v2024_04.model.update_balance_model_request import UpdateBalanceModelRequest
31
25
 
32
26
 
33
27
  class BalanceApi(object):
@@ -109,923 +103,28 @@ class BalanceApi(object):
109
103
  },
110
104
  api_client=api_client
111
105
  )
112
- self.get_api_v1_external_account_balances_by_account_id_endpoint = _Endpoint(
113
- settings={
114
- 'response_type': (BalanceResponsePagedListResponse,),
115
- 'auth': [
116
- 'oauth',
117
- 'oauth'
118
- ],
119
- 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances',
120
- 'operation_id': 'get_api_v1_external_account_balances_by_account_id',
121
- 'http_method': 'GET',
122
- 'servers': None,
123
- },
124
- params_map={
125
- 'all': [
126
- 'account_id',
127
- 'limit_to_id',
128
- 'page_index',
129
- 'page_size',
130
- ],
131
- 'required': [
132
- 'account_id',
133
- ],
134
- 'nullable': [
135
- ],
136
- 'enum': [
137
- ],
138
- 'validation': [
139
- ]
140
- },
141
- root_map={
142
- 'validations': {
143
- },
144
- 'allowed_values': {
145
- },
146
- 'openapi_types': {
147
- 'account_id':
148
- (str,),
149
- 'limit_to_id':
150
- ([str],),
151
- 'page_index':
152
- (int,),
153
- 'page_size':
154
- (int,),
155
- },
156
- 'attribute_map': {
157
- 'account_id': 'account-id',
158
- 'limit_to_id': 'limitToId',
159
- 'page_index': 'pageIndex',
160
- 'page_size': 'pageSize',
161
- },
162
- 'location_map': {
163
- 'account_id': 'path',
164
- 'limit_to_id': 'query',
165
- 'page_index': 'query',
166
- 'page_size': 'query',
167
- },
168
- 'collection_format_map': {
169
- 'limit_to_id': 'multi',
170
- }
171
- },
172
- headers_map={
173
- 'accept': [
174
- 'application/json'
175
- ],
176
- 'content_type': [],
177
- },
178
- api_client=api_client
179
- )
180
- self.get_api_v1_external_account_by_account_id_and_balance_id_endpoint = _Endpoint(
181
- settings={
182
- 'response_type': (BalanceResponse,),
183
- 'auth': [
184
- 'oauth',
185
- 'oauth'
186
- ],
187
- 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}',
188
- 'operation_id': 'get_api_v1_external_account_by_account_id_and_balance_id',
189
- 'http_method': 'GET',
190
- 'servers': None,
191
- },
192
- params_map={
193
- 'all': [
194
- 'account_id',
195
- 'balance_id',
196
- ],
197
- 'required': [
198
- 'account_id',
199
- 'balance_id',
200
- ],
201
- 'nullable': [
202
- ],
203
- 'enum': [
204
- ],
205
- 'validation': [
206
- ]
207
- },
208
- root_map={
209
- 'validations': {
210
- },
211
- 'allowed_values': {
212
- },
213
- 'openapi_types': {
214
- 'account_id':
215
- (str,),
216
- 'balance_id':
217
- (str,),
218
- },
219
- 'attribute_map': {
220
- 'account_id': 'account-id',
221
- 'balance_id': 'balanceId',
222
- },
223
- 'location_map': {
224
- 'account_id': 'path',
225
- 'balance_id': 'path',
226
- },
227
- 'collection_format_map': {
228
- }
229
- },
230
- headers_map={
231
- 'accept': [
232
- 'application/json'
233
- ],
234
- 'content_type': [],
235
- },
236
- api_client=api_client
237
- )
238
- self.patch_api_v1_external_account_by_account_id_and_balance_id_endpoint = _Endpoint(
239
- settings={
240
- 'response_type': (BalanceResponse,),
241
- 'auth': [
242
- 'oauth',
243
- 'oauth'
244
- ],
245
- 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}',
246
- 'operation_id': 'patch_api_v1_external_account_by_account_id_and_balance_id',
247
- 'http_method': 'PATCH',
248
- 'servers': None,
249
- },
250
- params_map={
251
- 'all': [
252
- 'account_id',
253
- 'balance_id',
254
- 'update_balance_model_request',
255
- ],
256
- 'required': [
257
- 'account_id',
258
- 'balance_id',
259
- ],
260
- 'nullable': [
261
- ],
262
- 'enum': [
263
- ],
264
- 'validation': [
265
- ]
266
- },
267
- root_map={
268
- 'validations': {
269
- },
270
- 'allowed_values': {
271
- },
272
- 'openapi_types': {
273
- 'account_id':
274
- (str,),
275
- 'balance_id':
276
- (str,),
277
- 'update_balance_model_request':
278
- (UpdateBalanceModelRequest,),
279
- },
280
- 'attribute_map': {
281
- 'account_id': 'account-id',
282
- 'balance_id': 'balanceId',
283
- },
284
- 'location_map': {
285
- 'account_id': 'path',
286
- 'balance_id': 'path',
287
- 'update_balance_model_request': 'body',
288
- },
289
- 'collection_format_map': {
290
- }
291
- },
292
- headers_map={
293
- 'accept': [
294
- 'application/json'
295
- ],
296
- 'content_type': [
297
- 'application/json'
298
- ]
299
- },
300
- api_client=api_client
301
- )
302
- self.post_api_v1_external_account_add_funds_by_account_id_and_balance_id_endpoint = _Endpoint(
303
- settings={
304
- 'response_type': (BalanceResponse,),
305
- 'auth': [
306
- 'oauth',
307
- 'oauth'
308
- ],
309
- 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/add-funds',
310
- 'operation_id': 'post_api_v1_external_account_add_funds_by_account_id_and_balance_id',
311
- 'http_method': 'POST',
312
- 'servers': None,
313
- },
314
- params_map={
315
- 'all': [
316
- 'account_id',
317
- 'balance_id',
318
- 'add_funds_to_balance_request',
319
- ],
320
- 'required': [
321
- 'account_id',
322
- 'balance_id',
323
- ],
324
- 'nullable': [
325
- ],
326
- 'enum': [
327
- ],
328
- 'validation': [
329
- ]
330
- },
331
- root_map={
332
- 'validations': {
333
- },
334
- 'allowed_values': {
335
- },
336
- 'openapi_types': {
337
- 'account_id':
338
- (str,),
339
- 'balance_id':
340
- (str,),
341
- 'add_funds_to_balance_request':
342
- (AddFundsToBalanceRequest,),
343
- },
344
- 'attribute_map': {
345
- 'account_id': 'account-id',
346
- 'balance_id': 'balanceId',
347
- },
348
- 'location_map': {
349
- 'account_id': 'path',
350
- 'balance_id': 'path',
351
- 'add_funds_to_balance_request': 'body',
352
- },
353
- 'collection_format_map': {
354
- }
355
- },
356
- headers_map={
357
- 'accept': [
358
- 'application/json'
359
- ],
360
- 'content_type': [
361
- 'application/json'
362
- ]
363
- },
364
- api_client=api_client
365
- )
366
- self.post_api_v1_external_account_balances_by_account_id_endpoint = _Endpoint(
367
- settings={
368
- 'response_type': (BalanceResponse,),
369
- 'auth': [
370
- 'oauth',
371
- 'oauth'
372
- ],
373
- 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances',
374
- 'operation_id': 'post_api_v1_external_account_balances_by_account_id',
375
- 'http_method': 'POST',
376
- 'servers': None,
377
- },
378
- params_map={
379
- 'all': [
380
- 'account_id',
381
- 'create_balance_request',
382
- ],
383
- 'required': [
384
- 'account_id',
385
- ],
386
- 'nullable': [
387
- ],
388
- 'enum': [
389
- ],
390
- 'validation': [
391
- ]
392
- },
393
- root_map={
394
- 'validations': {
395
- },
396
- 'allowed_values': {
397
- },
398
- 'openapi_types': {
399
- 'account_id':
400
- (str,),
401
- 'create_balance_request':
402
- (CreateBalanceRequest,),
403
- },
404
- 'attribute_map': {
405
- 'account_id': 'account-id',
406
- },
407
- 'location_map': {
408
- 'account_id': 'path',
409
- 'create_balance_request': 'body',
410
- },
411
- 'collection_format_map': {
412
- }
413
- },
414
- headers_map={
415
- 'accept': [
416
- 'application/json'
417
- ],
418
- 'content_type': [
419
- 'application/json'
420
- ]
421
- },
422
- api_client=api_client
423
- )
424
- self.post_api_v1_external_account_change_dates_by_account_id_and_balance_id_endpoint = _Endpoint(
425
- settings={
426
- 'response_type': (BalanceResponse,),
427
- 'auth': [
428
- 'oauth',
429
- 'oauth'
430
- ],
431
- 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/change-dates',
432
- 'operation_id': 'post_api_v1_external_account_change_dates_by_account_id_and_balance_id',
433
- 'http_method': 'POST',
434
- 'servers': None,
435
- },
436
- params_map={
437
- 'all': [
438
- 'account_id',
439
- 'balance_id',
440
- 'change_dates_of_balance_request',
441
- ],
442
- 'required': [
443
- 'account_id',
444
- 'balance_id',
445
- ],
446
- 'nullable': [
447
- ],
448
- 'enum': [
449
- ],
450
- 'validation': [
451
- ]
452
- },
453
- root_map={
454
- 'validations': {
455
- },
456
- 'allowed_values': {
457
- },
458
- 'openapi_types': {
459
- 'account_id':
460
- (str,),
461
- 'balance_id':
462
- (str,),
463
- 'change_dates_of_balance_request':
464
- (ChangeDatesOfBalanceRequest,),
465
- },
466
- 'attribute_map': {
467
- 'account_id': 'account-id',
468
- 'balance_id': 'balanceId',
469
- },
470
- 'location_map': {
471
- 'account_id': 'path',
472
- 'balance_id': 'path',
473
- 'change_dates_of_balance_request': 'body',
474
- },
475
- 'collection_format_map': {
476
- }
477
- },
478
- headers_map={
479
- 'accept': [
480
- 'application/json'
481
- ],
482
- 'content_type': [
483
- 'application/json'
484
- ]
485
- },
486
- api_client=api_client
487
- )
488
-
489
- def get_api202110_external_balance_campaigns_by_balance_id(
490
- self,
491
- balance_id,
492
- **kwargs
493
- ):
494
- """get_api202110_external_balance_campaigns_by_balance_id # noqa: E501
495
-
496
- Gets page of campaigns for the given balanceId # noqa: E501
497
- This method makes a synchronous HTTP request by default. To make an
498
- asynchronous HTTP request, please pass async_req=True
499
-
500
- >>> thread = api.get_api202110_external_balance_campaigns_by_balance_id(balance_id, async_req=True)
501
- >>> result = thread.get()
502
-
503
- Args:
504
- balance_id (str): The balance to get campaigns from
505
-
506
- Keyword Args:
507
- limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
508
- page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
509
- page_size (int): The maximum number of items you would like to receive in this request. [optional]
510
- _return_http_data_only (bool): response data without head status
511
- code and headers. Default is True.
512
- _preload_content (bool): if False, the urllib3.HTTPResponse object
513
- will be returned without reading/decoding response data.
514
- Default is True.
515
- _request_timeout (int/float/tuple): timeout setting for this request. If
516
- one number provided, it will be total request timeout. It can also
517
- be a pair (tuple) of (connection, read) timeouts.
518
- Default is None.
519
- _check_input_type (bool): specifies if type checking
520
- should be done one the data sent to the server.
521
- Default is True.
522
- _check_return_type (bool): specifies if type checking
523
- should be done one the data received from the server.
524
- Default is True.
525
- _spec_property_naming (bool): True if the variable names in the input data
526
- are serialized names, as specified in the OpenAPI document.
527
- False if the variable names in the input data
528
- are pythonic names, e.g. snake case (default)
529
- _content_type (str/None): force body content-type.
530
- Default is None and content-type will be predicted by allowed
531
- content-types and body.
532
- _host_index (int/None): specifies the index of the server
533
- that we want to use.
534
- Default is read from the configuration.
535
- _request_auths (list): set to override the auth_settings for an a single
536
- request; this effectively ignores the authentication
537
- in the spec for a single request.
538
- Default is None
539
- async_req (bool): execute request asynchronously
540
-
541
- Returns:
542
- BalanceCampaign202110PagedListResponse
543
- If the method is called asynchronously, returns the request
544
- thread.
545
- """
546
- kwargs['async_req'] = kwargs.get(
547
- 'async_req', False
548
- )
549
- kwargs['_return_http_data_only'] = kwargs.get(
550
- '_return_http_data_only', True
551
- )
552
- kwargs['_preload_content'] = kwargs.get(
553
- '_preload_content', True
554
- )
555
- kwargs['_request_timeout'] = kwargs.get(
556
- '_request_timeout', None
557
- )
558
- kwargs['_check_input_type'] = kwargs.get(
559
- '_check_input_type', True
560
- )
561
- kwargs['_check_return_type'] = kwargs.get(
562
- '_check_return_type', True
563
- )
564
- kwargs['_spec_property_naming'] = kwargs.get(
565
- '_spec_property_naming', False
566
- )
567
- kwargs['_content_type'] = kwargs.get(
568
- '_content_type')
569
- kwargs['_host_index'] = kwargs.get('_host_index')
570
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
571
- kwargs['balance_id'] = \
572
- balance_id
573
- return self.get_api202110_external_balance_campaigns_by_balance_id_endpoint.call_with_http_info(**kwargs)
574
-
575
- def get_api_v1_external_account_balances_by_account_id(
576
- self,
577
- account_id,
578
- **kwargs
579
- ):
580
- """get_api_v1_external_account_balances_by_account_id # noqa: E501
581
-
582
- Get page of balances for the given accountId. # noqa: E501
583
- This method makes a synchronous HTTP request by default. To make an
584
- asynchronous HTTP request, please pass async_req=True
585
-
586
- >>> thread = api.get_api_v1_external_account_balances_by_account_id(account_id, async_req=True)
587
- >>> result = thread.get()
588
-
589
- Args:
590
- account_id (str): The account to get page of balances for
591
-
592
- Keyword Args:
593
- limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
594
- page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
595
- page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
596
- _return_http_data_only (bool): response data without head status
597
- code and headers. Default is True.
598
- _preload_content (bool): if False, the urllib3.HTTPResponse object
599
- will be returned without reading/decoding response data.
600
- Default is True.
601
- _request_timeout (int/float/tuple): timeout setting for this request. If
602
- one number provided, it will be total request timeout. It can also
603
- be a pair (tuple) of (connection, read) timeouts.
604
- Default is None.
605
- _check_input_type (bool): specifies if type checking
606
- should be done one the data sent to the server.
607
- Default is True.
608
- _check_return_type (bool): specifies if type checking
609
- should be done one the data received from the server.
610
- Default is True.
611
- _spec_property_naming (bool): True if the variable names in the input data
612
- are serialized names, as specified in the OpenAPI document.
613
- False if the variable names in the input data
614
- are pythonic names, e.g. snake case (default)
615
- _content_type (str/None): force body content-type.
616
- Default is None and content-type will be predicted by allowed
617
- content-types and body.
618
- _host_index (int/None): specifies the index of the server
619
- that we want to use.
620
- Default is read from the configuration.
621
- _request_auths (list): set to override the auth_settings for an a single
622
- request; this effectively ignores the authentication
623
- in the spec for a single request.
624
- Default is None
625
- async_req (bool): execute request asynchronously
626
-
627
- Returns:
628
- BalanceResponsePagedListResponse
629
- If the method is called asynchronously, returns the request
630
- thread.
631
- """
632
- kwargs['async_req'] = kwargs.get(
633
- 'async_req', False
634
- )
635
- kwargs['_return_http_data_only'] = kwargs.get(
636
- '_return_http_data_only', True
637
- )
638
- kwargs['_preload_content'] = kwargs.get(
639
- '_preload_content', True
640
- )
641
- kwargs['_request_timeout'] = kwargs.get(
642
- '_request_timeout', None
643
- )
644
- kwargs['_check_input_type'] = kwargs.get(
645
- '_check_input_type', True
646
- )
647
- kwargs['_check_return_type'] = kwargs.get(
648
- '_check_return_type', True
649
- )
650
- kwargs['_spec_property_naming'] = kwargs.get(
651
- '_spec_property_naming', False
652
- )
653
- kwargs['_content_type'] = kwargs.get(
654
- '_content_type')
655
- kwargs['_host_index'] = kwargs.get('_host_index')
656
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
657
- kwargs['account_id'] = \
658
- account_id
659
- return self.get_api_v1_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
660
-
661
- def get_api_v1_external_account_by_account_id_and_balance_id(
662
- self,
663
- account_id,
664
- balance_id,
665
- **kwargs
666
- ):
667
- """get_api_v1_external_account_by_account_id_and_balance_id # noqa: E501
668
-
669
- Get a balance for the given account id and balance id # noqa: E501
670
- This method makes a synchronous HTTP request by default. To make an
671
- asynchronous HTTP request, please pass async_req=True
672
-
673
- >>> thread = api.get_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id, async_req=True)
674
- >>> result = thread.get()
675
-
676
- Args:
677
- account_id (str): The account of the balance
678
- balance_id (str): The balance id
679
-
680
- Keyword Args:
681
- _return_http_data_only (bool): response data without head status
682
- code and headers. Default is True.
683
- _preload_content (bool): if False, the urllib3.HTTPResponse object
684
- will be returned without reading/decoding response data.
685
- Default is True.
686
- _request_timeout (int/float/tuple): timeout setting for this request. If
687
- one number provided, it will be total request timeout. It can also
688
- be a pair (tuple) of (connection, read) timeouts.
689
- Default is None.
690
- _check_input_type (bool): specifies if type checking
691
- should be done one the data sent to the server.
692
- Default is True.
693
- _check_return_type (bool): specifies if type checking
694
- should be done one the data received from the server.
695
- Default is True.
696
- _spec_property_naming (bool): True if the variable names in the input data
697
- are serialized names, as specified in the OpenAPI document.
698
- False if the variable names in the input data
699
- are pythonic names, e.g. snake case (default)
700
- _content_type (str/None): force body content-type.
701
- Default is None and content-type will be predicted by allowed
702
- content-types and body.
703
- _host_index (int/None): specifies the index of the server
704
- that we want to use.
705
- Default is read from the configuration.
706
- _request_auths (list): set to override the auth_settings for an a single
707
- request; this effectively ignores the authentication
708
- in the spec for a single request.
709
- Default is None
710
- async_req (bool): execute request asynchronously
711
-
712
- Returns:
713
- BalanceResponse
714
- If the method is called asynchronously, returns the request
715
- thread.
716
- """
717
- kwargs['async_req'] = kwargs.get(
718
- 'async_req', False
719
- )
720
- kwargs['_return_http_data_only'] = kwargs.get(
721
- '_return_http_data_only', True
722
- )
723
- kwargs['_preload_content'] = kwargs.get(
724
- '_preload_content', True
725
- )
726
- kwargs['_request_timeout'] = kwargs.get(
727
- '_request_timeout', None
728
- )
729
- kwargs['_check_input_type'] = kwargs.get(
730
- '_check_input_type', True
731
- )
732
- kwargs['_check_return_type'] = kwargs.get(
733
- '_check_return_type', True
734
- )
735
- kwargs['_spec_property_naming'] = kwargs.get(
736
- '_spec_property_naming', False
737
- )
738
- kwargs['_content_type'] = kwargs.get(
739
- '_content_type')
740
- kwargs['_host_index'] = kwargs.get('_host_index')
741
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
742
- kwargs['account_id'] = \
743
- account_id
744
- kwargs['balance_id'] = \
745
- balance_id
746
- return self.get_api_v1_external_account_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs)
747
-
748
- def patch_api_v1_external_account_by_account_id_and_balance_id(
749
- self,
750
- account_id,
751
- balance_id,
752
- **kwargs
753
- ):
754
- """patch_api_v1_external_account_by_account_id_and_balance_id # noqa: E501
755
-
756
- Modify a balance for the given account id # noqa: E501
757
- This method makes a synchronous HTTP request by default. To make an
758
- asynchronous HTTP request, please pass async_req=True
759
-
760
- >>> thread = api.patch_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id, async_req=True)
761
- >>> result = thread.get()
762
-
763
- Args:
764
- account_id (str): The account of the balance
765
- balance_id (str): The balance to change the dates
766
-
767
- Keyword Args:
768
- update_balance_model_request (UpdateBalanceModelRequest): [optional]
769
- _return_http_data_only (bool): response data without head status
770
- code and headers. Default is True.
771
- _preload_content (bool): if False, the urllib3.HTTPResponse object
772
- will be returned without reading/decoding response data.
773
- Default is True.
774
- _request_timeout (int/float/tuple): timeout setting for this request. If
775
- one number provided, it will be total request timeout. It can also
776
- be a pair (tuple) of (connection, read) timeouts.
777
- Default is None.
778
- _check_input_type (bool): specifies if type checking
779
- should be done one the data sent to the server.
780
- Default is True.
781
- _check_return_type (bool): specifies if type checking
782
- should be done one the data received from the server.
783
- Default is True.
784
- _spec_property_naming (bool): True if the variable names in the input data
785
- are serialized names, as specified in the OpenAPI document.
786
- False if the variable names in the input data
787
- are pythonic names, e.g. snake case (default)
788
- _content_type (str/None): force body content-type.
789
- Default is None and content-type will be predicted by allowed
790
- content-types and body.
791
- _host_index (int/None): specifies the index of the server
792
- that we want to use.
793
- Default is read from the configuration.
794
- _request_auths (list): set to override the auth_settings for an a single
795
- request; this effectively ignores the authentication
796
- in the spec for a single request.
797
- Default is None
798
- async_req (bool): execute request asynchronously
799
-
800
- Returns:
801
- BalanceResponse
802
- If the method is called asynchronously, returns the request
803
- thread.
804
- """
805
- kwargs['async_req'] = kwargs.get(
806
- 'async_req', False
807
- )
808
- kwargs['_return_http_data_only'] = kwargs.get(
809
- '_return_http_data_only', True
810
- )
811
- kwargs['_preload_content'] = kwargs.get(
812
- '_preload_content', True
813
- )
814
- kwargs['_request_timeout'] = kwargs.get(
815
- '_request_timeout', None
816
- )
817
- kwargs['_check_input_type'] = kwargs.get(
818
- '_check_input_type', True
819
- )
820
- kwargs['_check_return_type'] = kwargs.get(
821
- '_check_return_type', True
822
- )
823
- kwargs['_spec_property_naming'] = kwargs.get(
824
- '_spec_property_naming', False
825
- )
826
- kwargs['_content_type'] = kwargs.get(
827
- '_content_type')
828
- kwargs['_host_index'] = kwargs.get('_host_index')
829
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
830
- kwargs['account_id'] = \
831
- account_id
832
- kwargs['balance_id'] = \
833
- balance_id
834
- return self.patch_api_v1_external_account_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs)
835
-
836
- def post_api_v1_external_account_add_funds_by_account_id_and_balance_id(
837
- self,
838
- account_id,
839
- balance_id,
840
- **kwargs
841
- ):
842
- """post_api_v1_external_account_add_funds_by_account_id_and_balance_id # noqa: E501
843
-
844
- Add funds to a balance for the given account id # noqa: E501
845
- This method makes a synchronous HTTP request by default. To make an
846
- asynchronous HTTP request, please pass async_req=True
847
-
848
- >>> thread = api.post_api_v1_external_account_add_funds_by_account_id_and_balance_id(account_id, balance_id, async_req=True)
849
- >>> result = thread.get()
850
-
851
- Args:
852
- account_id (str): The account of the balance
853
- balance_id (str): The balance to add funds to
854
-
855
- Keyword Args:
856
- add_funds_to_balance_request (AddFundsToBalanceRequest): [optional]
857
- _return_http_data_only (bool): response data without head status
858
- code and headers. Default is True.
859
- _preload_content (bool): if False, the urllib3.HTTPResponse object
860
- will be returned without reading/decoding response data.
861
- Default is True.
862
- _request_timeout (int/float/tuple): timeout setting for this request. If
863
- one number provided, it will be total request timeout. It can also
864
- be a pair (tuple) of (connection, read) timeouts.
865
- Default is None.
866
- _check_input_type (bool): specifies if type checking
867
- should be done one the data sent to the server.
868
- Default is True.
869
- _check_return_type (bool): specifies if type checking
870
- should be done one the data received from the server.
871
- Default is True.
872
- _spec_property_naming (bool): True if the variable names in the input data
873
- are serialized names, as specified in the OpenAPI document.
874
- False if the variable names in the input data
875
- are pythonic names, e.g. snake case (default)
876
- _content_type (str/None): force body content-type.
877
- Default is None and content-type will be predicted by allowed
878
- content-types and body.
879
- _host_index (int/None): specifies the index of the server
880
- that we want to use.
881
- Default is read from the configuration.
882
- _request_auths (list): set to override the auth_settings for an a single
883
- request; this effectively ignores the authentication
884
- in the spec for a single request.
885
- Default is None
886
- async_req (bool): execute request asynchronously
887
-
888
- Returns:
889
- BalanceResponse
890
- If the method is called asynchronously, returns the request
891
- thread.
892
- """
893
- kwargs['async_req'] = kwargs.get(
894
- 'async_req', False
895
- )
896
- kwargs['_return_http_data_only'] = kwargs.get(
897
- '_return_http_data_only', True
898
- )
899
- kwargs['_preload_content'] = kwargs.get(
900
- '_preload_content', True
901
- )
902
- kwargs['_request_timeout'] = kwargs.get(
903
- '_request_timeout', None
904
- )
905
- kwargs['_check_input_type'] = kwargs.get(
906
- '_check_input_type', True
907
- )
908
- kwargs['_check_return_type'] = kwargs.get(
909
- '_check_return_type', True
910
- )
911
- kwargs['_spec_property_naming'] = kwargs.get(
912
- '_spec_property_naming', False
913
- )
914
- kwargs['_content_type'] = kwargs.get(
915
- '_content_type')
916
- kwargs['_host_index'] = kwargs.get('_host_index')
917
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
918
- kwargs['account_id'] = \
919
- account_id
920
- kwargs['balance_id'] = \
921
- balance_id
922
- return self.post_api_v1_external_account_add_funds_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs)
923
-
924
- def post_api_v1_external_account_balances_by_account_id(
925
- self,
926
- account_id,
927
- **kwargs
928
- ):
929
- """post_api_v1_external_account_balances_by_account_id # noqa: E501
930
-
931
- Create balance for the given account id # noqa: E501
932
- This method makes a synchronous HTTP request by default. To make an
933
- asynchronous HTTP request, please pass async_req=True
934
-
935
- >>> thread = api.post_api_v1_external_account_balances_by_account_id(account_id, async_req=True)
936
- >>> result = thread.get()
937
-
938
- Args:
939
- account_id (str): The account to create balances for
940
-
941
- Keyword Args:
942
- create_balance_request (CreateBalanceRequest): [optional]
943
- _return_http_data_only (bool): response data without head status
944
- code and headers. Default is True.
945
- _preload_content (bool): if False, the urllib3.HTTPResponse object
946
- will be returned without reading/decoding response data.
947
- Default is True.
948
- _request_timeout (int/float/tuple): timeout setting for this request. If
949
- one number provided, it will be total request timeout. It can also
950
- be a pair (tuple) of (connection, read) timeouts.
951
- Default is None.
952
- _check_input_type (bool): specifies if type checking
953
- should be done one the data sent to the server.
954
- Default is True.
955
- _check_return_type (bool): specifies if type checking
956
- should be done one the data received from the server.
957
- Default is True.
958
- _spec_property_naming (bool): True if the variable names in the input data
959
- are serialized names, as specified in the OpenAPI document.
960
- False if the variable names in the input data
961
- are pythonic names, e.g. snake case (default)
962
- _content_type (str/None): force body content-type.
963
- Default is None and content-type will be predicted by allowed
964
- content-types and body.
965
- _host_index (int/None): specifies the index of the server
966
- that we want to use.
967
- Default is read from the configuration.
968
- _request_auths (list): set to override the auth_settings for an a single
969
- request; this effectively ignores the authentication
970
- in the spec for a single request.
971
- Default is None
972
- async_req (bool): execute request asynchronously
973
-
974
- Returns:
975
- BalanceResponse
976
- If the method is called asynchronously, returns the request
977
- thread.
978
- """
979
- kwargs['async_req'] = kwargs.get(
980
- 'async_req', False
981
- )
982
- kwargs['_return_http_data_only'] = kwargs.get(
983
- '_return_http_data_only', True
984
- )
985
- kwargs['_preload_content'] = kwargs.get(
986
- '_preload_content', True
987
- )
988
- kwargs['_request_timeout'] = kwargs.get(
989
- '_request_timeout', None
990
- )
991
- kwargs['_check_input_type'] = kwargs.get(
992
- '_check_input_type', True
993
- )
994
- kwargs['_check_return_type'] = kwargs.get(
995
- '_check_return_type', True
996
- )
997
- kwargs['_spec_property_naming'] = kwargs.get(
998
- '_spec_property_naming', False
999
- )
1000
- kwargs['_content_type'] = kwargs.get(
1001
- '_content_type')
1002
- kwargs['_host_index'] = kwargs.get('_host_index')
1003
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1004
- kwargs['account_id'] = \
1005
- account_id
1006
- return self.post_api_v1_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
1007
106
 
1008
- def post_api_v1_external_account_change_dates_by_account_id_and_balance_id(
107
+ def get_api202110_external_balance_campaigns_by_balance_id(
1009
108
  self,
1010
- account_id,
1011
109
  balance_id,
1012
110
  **kwargs
1013
111
  ):
1014
- """post_api_v1_external_account_change_dates_by_account_id_and_balance_id # noqa: E501
112
+ """get_api202110_external_balance_campaigns_by_balance_id # noqa: E501
1015
113
 
1016
- Change dates of a balance for the given account id # noqa: E501
114
+ Gets page of campaigns for the given balanceId # noqa: E501
1017
115
  This method makes a synchronous HTTP request by default. To make an
1018
116
  asynchronous HTTP request, please pass async_req=True
1019
117
 
1020
- >>> thread = api.post_api_v1_external_account_change_dates_by_account_id_and_balance_id(account_id, balance_id, async_req=True)
118
+ >>> thread = api.get_api202110_external_balance_campaigns_by_balance_id(balance_id, async_req=True)
1021
119
  >>> result = thread.get()
1022
120
 
1023
121
  Args:
1024
- account_id (str): The account of the balance
1025
- balance_id (str): The balance to change the dates
122
+ balance_id (str): The balance to get campaigns from
1026
123
 
1027
124
  Keyword Args:
1028
- change_dates_of_balance_request (ChangeDatesOfBalanceRequest): [optional]
125
+ limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
126
+ page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
127
+ page_size (int): The maximum number of items you would like to receive in this request. [optional]
1029
128
  _return_http_data_only (bool): response data without head status
1030
129
  code and headers. Default is True.
1031
130
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1058,7 +157,7 @@ class BalanceApi(object):
1058
157
  async_req (bool): execute request asynchronously
1059
158
 
1060
159
  Returns:
1061
- BalanceResponse
160
+ BalanceCampaign202110PagedListResponse
1062
161
  If the method is called asynchronously, returns the request
1063
162
  thread.
1064
163
  """
@@ -1087,9 +186,7 @@ class BalanceApi(object):
1087
186
  '_content_type')
1088
187
  kwargs['_host_index'] = kwargs.get('_host_index')
1089
188
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1090
- kwargs['account_id'] = \
1091
- account_id
1092
189
  kwargs['balance_id'] = \
1093
190
  balance_id
1094
- return self.post_api_v1_external_account_change_dates_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs)
191
+ return self.get_api202110_external_balance_campaigns_by_balance_id_endpoint.call_with_http_info(**kwargs)
1095
192