criteo-api-retailmedia-sdk 0.0.250902__py3-none-any.whl → 0.0.250915__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 (21) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +3 -12
  3. criteo_api_retailmedia_preview/api/analytics_api.py +18 -63
  4. criteo_api_retailmedia_preview/api/audience_api.py +25 -88
  5. criteo_api_retailmedia_preview/api/balance_api.py +176 -186
  6. criteo_api_retailmedia_preview/api/billing_api.py +2 -7
  7. criteo_api_retailmedia_preview/api/campaign_api.py +913 -974
  8. criteo_api_retailmedia_preview/api/catalog_api.py +6 -22
  9. criteo_api_retailmedia_preview/api_client.py +1 -1
  10. criteo_api_retailmedia_preview/configuration.py +1 -1
  11. criteo_api_retailmedia_preview/models/__init__.py +0 -6
  12. {criteo_api_retailmedia_sdk-0.0.250902.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/METADATA +3 -3
  13. {criteo_api_retailmedia_sdk-0.0.250902.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/RECORD +15 -21
  14. criteo_api_retailmedia_preview/model/error_code_response.py +0 -281
  15. criteo_api_retailmedia_preview/model/fail_response.py +0 -283
  16. criteo_api_retailmedia_preview/model/outcome.py +0 -268
  17. criteo_api_retailmedia_preview/model/product_importer_error.py +0 -299
  18. criteo_api_retailmedia_preview/model/product_importer_warning.py +0 -299
  19. criteo_api_retailmedia_preview/model/report_outcome.py +0 -275
  20. {criteo_api_retailmedia_sdk-0.0.250902.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/WHEEL +0 -0
  21. {criteo_api_retailmedia_sdk-0.0.250902.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/top_level.txt +0 -0
@@ -40,108 +40,89 @@ class BalanceApi(object):
40
40
  if api_client is None:
41
41
  api_client = ApiClient()
42
42
  self.api_client = api_client
43
- self.get_api_external_v2_account_balances_by_account_id_endpoint = _Endpoint(
43
+ self.change_dates_by_account_and_balance_id_endpoint = _Endpoint(
44
44
  settings={
45
- 'response_type': (BalanceResponseV2PagedListResponse,),
45
+ 'response_type': (BalanceResponseV2Response,),
46
46
  'auth': [
47
47
  'oauth',
48
48
  'oauth'
49
49
  ],
50
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances',
51
- 'operation_id': 'get_api_external_v2_account_balances_by_account_id',
52
- 'http_method': 'GET',
50
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates',
51
+ 'operation_id': 'change_dates_by_account_and_balance_id',
52
+ 'http_method': 'POST',
53
53
  'servers': None,
54
54
  },
55
55
  params_map={
56
56
  'all': [
57
57
  'account_id',
58
- 'limit_to_id',
59
- 'page_index',
60
- 'page_size',
58
+ 'balance_id',
59
+ 'change_dates_of_balance_v2_request',
61
60
  ],
62
61
  'required': [
63
62
  'account_id',
63
+ 'balance_id',
64
64
  ],
65
65
  'nullable': [
66
66
  ],
67
67
  'enum': [
68
68
  ],
69
69
  'validation': [
70
- 'page_index',
71
- 'page_size',
72
70
  ]
73
71
  },
74
72
  root_map={
75
73
  'validations': {
76
- ('page_index',): {
77
-
78
- 'inclusive_maximum': 2147483647,
79
- 'inclusive_minimum': 0,
80
- },
81
- ('page_size',): {
82
-
83
- 'inclusive_maximum': 2147483647,
84
- 'inclusive_minimum': 1,
85
- },
86
74
  },
87
75
  'allowed_values': {
88
76
  },
89
77
  'openapi_types': {
90
78
  'account_id':
91
79
  (str,),
92
- 'limit_to_id':
93
- ([str],),
94
- 'page_index':
95
- (int,),
96
- 'page_size':
97
- (int,),
80
+ 'balance_id':
81
+ (str,),
82
+ 'change_dates_of_balance_v2_request':
83
+ (ChangeDatesOfBalanceV2Request,),
98
84
  },
99
85
  'attribute_map': {
100
86
  'account_id': 'account-id',
101
- 'limit_to_id': 'limitToId',
102
- 'page_index': 'pageIndex',
103
- 'page_size': 'pageSize',
87
+ 'balance_id': 'balance-id',
104
88
  },
105
89
  'location_map': {
106
90
  'account_id': 'path',
107
- 'limit_to_id': 'query',
108
- 'page_index': 'query',
109
- 'page_size': 'query',
91
+ 'balance_id': 'path',
92
+ 'change_dates_of_balance_v2_request': 'body',
110
93
  },
111
94
  'collection_format_map': {
112
- 'limit_to_id': 'multi',
113
95
  }
114
96
  },
115
97
  headers_map={
116
98
  'accept': [
117
- 'text/plain',
118
- 'application/json',
119
- 'text/json'
99
+ 'application/json'
120
100
  ],
121
- 'content_type': [],
101
+ 'content_type': [
102
+ 'application/json'
103
+ ]
122
104
  },
123
105
  api_client=api_client
124
106
  )
125
- self.get_api_external_v2_account_by_account_id_balancesbalance_id_endpoint = _Endpoint(
107
+ self.create_balance_by_account_id_endpoint = _Endpoint(
126
108
  settings={
127
109
  'response_type': (BalanceResponseV2Response,),
128
110
  'auth': [
129
111
  'oauth',
130
112
  'oauth'
131
113
  ],
132
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}',
133
- 'operation_id': 'get_api_external_v2_account_by_account_id_balancesbalance_id',
134
- 'http_method': 'GET',
114
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances',
115
+ 'operation_id': 'create_balance_by_account_id',
116
+ 'http_method': 'POST',
135
117
  'servers': None,
136
118
  },
137
119
  params_map={
138
120
  'all': [
139
121
  'account_id',
140
- 'balance_id',
122
+ 'create_balance_v2_request',
141
123
  ],
142
124
  'required': [
143
125
  'account_id',
144
- 'balance_id',
145
126
  ],
146
127
  'nullable': [
147
128
  ],
@@ -158,50 +139,48 @@ class BalanceApi(object):
158
139
  'openapi_types': {
159
140
  'account_id':
160
141
  (str,),
161
- 'balance_id':
162
- (str,),
142
+ 'create_balance_v2_request':
143
+ (CreateBalanceV2Request,),
163
144
  },
164
145
  'attribute_map': {
165
146
  'account_id': 'account-id',
166
- 'balance_id': 'balance-id',
167
147
  },
168
148
  'location_map': {
169
149
  'account_id': 'path',
170
- 'balance_id': 'path',
150
+ 'create_balance_v2_request': 'body',
171
151
  },
172
152
  'collection_format_map': {
173
153
  }
174
154
  },
175
155
  headers_map={
176
156
  'accept': [
177
- 'text/plain',
178
- 'application/json',
179
- 'text/json'
157
+ 'application/json'
180
158
  ],
181
- 'content_type': [],
159
+ 'content_type': [
160
+ 'application/json'
161
+ ]
182
162
  },
183
163
  api_client=api_client
184
164
  )
185
- self.get_balance_history_endpoint = _Endpoint(
165
+ self.get_balance_by_account_and_balance_id_endpoint = _Endpoint(
186
166
  settings={
187
- 'response_type': (PageOfBalanceHistoryChangeDataCaptureV1,),
167
+ 'response_type': (BalanceResponseV2Response,),
188
168
  'auth': [
189
169
  'oauth',
190
170
  'oauth'
191
171
  ],
192
- 'endpoint_path': '/preview/retail-media/balances/{balanceId}/history',
193
- 'operation_id': 'get_balance_history',
172
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}',
173
+ 'operation_id': 'get_balance_by_account_and_balance_id',
194
174
  'http_method': 'GET',
195
175
  'servers': None,
196
176
  },
197
177
  params_map={
198
178
  'all': [
179
+ 'account_id',
199
180
  'balance_id',
200
- 'limit',
201
- 'limit_to_change_types',
202
- 'offset',
203
181
  ],
204
182
  'required': [
183
+ 'account_id',
205
184
  'balance_id',
206
185
  ],
207
186
  'nullable': [
@@ -209,46 +188,26 @@ class BalanceApi(object):
209
188
  'enum': [
210
189
  ],
211
190
  'validation': [
212
- 'limit',
213
- 'offset',
214
191
  ]
215
192
  },
216
193
  root_map={
217
194
  'validations': {
218
- ('limit',): {
219
-
220
- 'inclusive_maximum': 100,
221
- 'inclusive_minimum': 1,
222
- },
223
- ('offset',): {
224
-
225
- 'inclusive_maximum': 2147483647,
226
- 'inclusive_minimum': 0,
227
- },
228
195
  },
229
196
  'allowed_values': {
230
197
  },
231
198
  'openapi_types': {
232
- 'balance_id':
199
+ 'account_id':
233
200
  (str,),
234
- 'limit':
235
- (int,),
236
- 'limit_to_change_types':
201
+ 'balance_id':
237
202
  (str,),
238
- 'offset':
239
- (int,),
240
203
  },
241
204
  'attribute_map': {
242
- 'balance_id': 'balanceId',
243
- 'limit': 'limit',
244
- 'limit_to_change_types': 'limitToChangeTypes',
245
- 'offset': 'offset',
205
+ 'account_id': 'account-id',
206
+ 'balance_id': 'balance-id',
246
207
  },
247
208
  'location_map': {
209
+ 'account_id': 'path',
248
210
  'balance_id': 'path',
249
- 'limit': 'query',
250
- 'limit_to_change_types': 'query',
251
- 'offset': 'query',
252
211
  },
253
212
  'collection_format_map': {
254
213
  }
@@ -261,26 +220,26 @@ class BalanceApi(object):
261
220
  },
262
221
  api_client=api_client
263
222
  )
264
- self.patch_api_external_v2_account_by_account_id_balancesbalance_id_endpoint = _Endpoint(
223
+ self.get_balance_history_endpoint = _Endpoint(
265
224
  settings={
266
- 'response_type': (BalanceResponseV2Response,),
225
+ 'response_type': (PageOfBalanceHistoryChangeDataCaptureV1,),
267
226
  'auth': [
268
227
  'oauth',
269
228
  'oauth'
270
229
  ],
271
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}',
272
- 'operation_id': 'patch_api_external_v2_account_by_account_id_balancesbalance_id',
273
- 'http_method': 'PATCH',
230
+ 'endpoint_path': '/preview/retail-media/balances/{balanceId}/history',
231
+ 'operation_id': 'get_balance_history',
232
+ 'http_method': 'GET',
274
233
  'servers': None,
275
234
  },
276
235
  params_map={
277
236
  'all': [
278
- 'account_id',
279
237
  'balance_id',
280
- 'update_balance_model_v2_request',
238
+ 'limit',
239
+ 'limit_to_change_types',
240
+ 'offset',
281
241
  ],
282
242
  'required': [
283
- 'account_id',
284
243
  'balance_id',
285
244
  ],
286
245
  'nullable': [
@@ -288,61 +247,76 @@ class BalanceApi(object):
288
247
  'enum': [
289
248
  ],
290
249
  'validation': [
250
+ 'limit',
251
+ 'offset',
291
252
  ]
292
253
  },
293
254
  root_map={
294
255
  'validations': {
256
+ ('limit',): {
257
+
258
+ 'inclusive_maximum': 100,
259
+ 'inclusive_minimum': 1,
260
+ },
261
+ ('offset',): {
262
+
263
+ 'inclusive_maximum': 2147483647,
264
+ 'inclusive_minimum': 0,
265
+ },
295
266
  },
296
267
  'allowed_values': {
297
268
  },
298
269
  'openapi_types': {
299
- 'account_id':
300
- (str,),
301
270
  'balance_id':
302
271
  (str,),
303
- 'update_balance_model_v2_request':
304
- (UpdateBalanceModelV2Request,),
272
+ 'limit':
273
+ (int,),
274
+ 'limit_to_change_types':
275
+ (str,),
276
+ 'offset':
277
+ (int,),
305
278
  },
306
279
  'attribute_map': {
307
- 'account_id': 'account-id',
308
- 'balance_id': 'balance-id',
280
+ 'balance_id': 'balanceId',
281
+ 'limit': 'limit',
282
+ 'limit_to_change_types': 'limitToChangeTypes',
283
+ 'offset': 'offset',
309
284
  },
310
285
  'location_map': {
311
- 'account_id': 'path',
312
286
  'balance_id': 'path',
313
- 'update_balance_model_v2_request': 'body',
287
+ 'limit': 'query',
288
+ 'limit_to_change_types': 'query',
289
+ 'offset': 'query',
314
290
  },
315
291
  'collection_format_map': {
316
292
  }
317
293
  },
318
294
  headers_map={
319
295
  'accept': [
320
- 'text/plain',
321
- 'application/json',
322
- 'text/json'
323
- ],
324
- 'content_type': [
325
296
  'application/json'
326
- ]
297
+ ],
298
+ 'content_type': [],
327
299
  },
328
300
  api_client=api_client
329
301
  )
330
- self.post_api_external_v2_account_balances_by_account_id_endpoint = _Endpoint(
302
+ self.get_balances_by_account_id_endpoint = _Endpoint(
331
303
  settings={
332
- 'response_type': (BalanceResponseV2Response,),
304
+ 'response_type': (BalanceResponseV2PagedListResponse,),
333
305
  'auth': [
334
306
  'oauth',
335
307
  'oauth'
336
308
  ],
337
309
  'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances',
338
- 'operation_id': 'post_api_external_v2_account_balances_by_account_id',
339
- 'http_method': 'POST',
310
+ 'operation_id': 'get_balances_by_account_id',
311
+ 'http_method': 'GET',
340
312
  'servers': None,
341
313
  },
342
314
  params_map={
343
315
  'all': [
344
316
  'account_id',
345
- 'create_balance_v2_request',
317
+ 'limit_to_id',
318
+ 'page_index',
319
+ 'page_size',
346
320
  ],
347
321
  'required': [
348
322
  'account_id',
@@ -352,58 +326,76 @@ class BalanceApi(object):
352
326
  'enum': [
353
327
  ],
354
328
  'validation': [
329
+ 'page_index',
330
+ 'page_size',
355
331
  ]
356
332
  },
357
333
  root_map={
358
334
  'validations': {
335
+ ('page_index',): {
336
+
337
+ 'inclusive_maximum': 2147483647,
338
+ 'inclusive_minimum': 0,
339
+ },
340
+ ('page_size',): {
341
+
342
+ 'inclusive_maximum': 2147483647,
343
+ 'inclusive_minimum': 1,
344
+ },
359
345
  },
360
346
  'allowed_values': {
361
347
  },
362
348
  'openapi_types': {
363
349
  'account_id':
364
350
  (str,),
365
- 'create_balance_v2_request':
366
- (CreateBalanceV2Request,),
351
+ 'limit_to_id':
352
+ ([str],),
353
+ 'page_index':
354
+ (int,),
355
+ 'page_size':
356
+ (int,),
367
357
  },
368
358
  'attribute_map': {
369
359
  'account_id': 'account-id',
360
+ 'limit_to_id': 'limitToId',
361
+ 'page_index': 'pageIndex',
362
+ 'page_size': 'pageSize',
370
363
  },
371
364
  'location_map': {
372
365
  'account_id': 'path',
373
- 'create_balance_v2_request': 'body',
366
+ 'limit_to_id': 'query',
367
+ 'page_index': 'query',
368
+ 'page_size': 'query',
374
369
  },
375
370
  'collection_format_map': {
371
+ 'limit_to_id': 'multi',
376
372
  }
377
373
  },
378
374
  headers_map={
379
375
  'accept': [
380
- 'text/plain',
381
- 'application/json',
382
- 'text/json'
383
- ],
384
- 'content_type': [
385
376
  'application/json'
386
- ]
377
+ ],
378
+ 'content_type': [],
387
379
  },
388
380
  api_client=api_client
389
381
  )
390
- self.post_api_external_v2_account_change_dates_by_account_id_balancesbalance_id_endpoint = _Endpoint(
382
+ self.modify_balance_by_account_and_balance_id_endpoint = _Endpoint(
391
383
  settings={
392
384
  'response_type': (BalanceResponseV2Response,),
393
385
  'auth': [
394
386
  'oauth',
395
387
  'oauth'
396
388
  ],
397
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates',
398
- 'operation_id': 'post_api_external_v2_account_change_dates_by_account_id_balancesbalance_id',
399
- 'http_method': 'POST',
389
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}',
390
+ 'operation_id': 'modify_balance_by_account_and_balance_id',
391
+ 'http_method': 'PATCH',
400
392
  'servers': None,
401
393
  },
402
394
  params_map={
403
395
  'all': [
404
396
  'account_id',
405
397
  'balance_id',
406
- 'change_dates_of_balance_v2_request',
398
+ 'update_balance_model_v2_request',
407
399
  ],
408
400
  'required': [
409
401
  'account_id',
@@ -426,8 +418,8 @@ class BalanceApi(object):
426
418
  (str,),
427
419
  'balance_id':
428
420
  (str,),
429
- 'change_dates_of_balance_v2_request':
430
- (ChangeDatesOfBalanceV2Request,),
421
+ 'update_balance_model_v2_request':
422
+ (UpdateBalanceModelV2Request,),
431
423
  },
432
424
  'attribute_map': {
433
425
  'account_id': 'account-id',
@@ -436,16 +428,14 @@ class BalanceApi(object):
436
428
  'location_map': {
437
429
  'account_id': 'path',
438
430
  'balance_id': 'path',
439
- 'change_dates_of_balance_v2_request': 'body',
431
+ 'update_balance_model_v2_request': 'body',
440
432
  },
441
433
  'collection_format_map': {
442
434
  }
443
435
  },
444
436
  headers_map={
445
437
  'accept': [
446
- 'text/plain',
447
- 'application/json',
448
- 'text/json'
438
+ 'application/json'
449
439
  ],
450
440
  'content_type': [
451
441
  'application/json'
@@ -454,27 +444,27 @@ class BalanceApi(object):
454
444
  api_client=api_client
455
445
  )
456
446
 
457
- def get_api_external_v2_account_balances_by_account_id(
447
+ def change_dates_by_account_and_balance_id(
458
448
  self,
459
449
  account_id,
450
+ balance_id,
460
451
  **kwargs
461
452
  ):
462
- """get_api_external_v2_account_balances_by_account_id # noqa: E501
453
+ """change_dates_by_account_and_balance_id # noqa: E501
463
454
 
464
- Gets page of balance objects for the given account id # noqa: E501
455
+ Change dates of a balance for the given account id # noqa: E501
465
456
  This method makes a synchronous HTTP request by default. To make an
466
457
  asynchronous HTTP request, please pass async_req=True
467
458
 
468
- >>> thread = api.get_api_external_v2_account_balances_by_account_id(account_id, async_req=True)
459
+ >>> thread = api.change_dates_by_account_and_balance_id(account_id, balance_id, async_req=True)
469
460
  >>> result = thread.get()
470
461
 
471
462
  Args:
472
- account_id (str): The account to get balances for
463
+ account_id (str): The account of the balance
464
+ balance_id (str): The balance to change the dates
473
465
 
474
466
  Keyword Args:
475
- limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
476
- 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
477
- 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
467
+ change_dates_of_balance_v2_request (ChangeDatesOfBalanceV2Request): An object that represents the available options to modify schedule of a balance.. [optional]
478
468
  _return_http_data_only (bool): response data without head status
479
469
  code and headers. Default is True.
480
470
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -507,7 +497,7 @@ class BalanceApi(object):
507
497
  async_req (bool): execute request asynchronously
508
498
 
509
499
  Returns:
510
- BalanceResponseV2PagedListResponse
500
+ BalanceResponseV2Response
511
501
  If the method is called asynchronously, returns the request
512
502
  thread.
513
503
  """
@@ -538,28 +528,29 @@ class BalanceApi(object):
538
528
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
539
529
  kwargs['account_id'] = \
540
530
  account_id
541
- return self.get_api_external_v2_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
531
+ kwargs['balance_id'] = \
532
+ balance_id
533
+ return self.change_dates_by_account_and_balance_id_endpoint.call_with_http_info(**kwargs)
542
534
 
543
- def get_api_external_v2_account_by_account_id_balancesbalance_id(
535
+ def create_balance_by_account_id(
544
536
  self,
545
537
  account_id,
546
- balance_id,
547
538
  **kwargs
548
539
  ):
549
- """get_api_external_v2_account_by_account_id_balancesbalance_id # noqa: E501
540
+ """create_balance_by_account_id # noqa: E501
550
541
 
551
- Get a balance for the given account id and balance id # noqa: E501
542
+ Create balance for the given account id # noqa: E501
552
543
  This method makes a synchronous HTTP request by default. To make an
553
544
  asynchronous HTTP request, please pass async_req=True
554
545
 
555
- >>> thread = api.get_api_external_v2_account_by_account_id_balancesbalance_id(account_id, balance_id, async_req=True)
546
+ >>> thread = api.create_balance_by_account_id(account_id, async_req=True)
556
547
  >>> result = thread.get()
557
548
 
558
549
  Args:
559
- account_id (str): The account of the balance
560
- balance_id (str): The balance id
550
+ account_id (str): The account to create balances for
561
551
 
562
552
  Keyword Args:
553
+ create_balance_v2_request (CreateBalanceV2Request): An object that represents the available options to set when creating a Retail Media Balance. [optional]
563
554
  _return_http_data_only (bool): response data without head status
564
555
  code and headers. Default is True.
565
556
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -623,31 +614,28 @@ class BalanceApi(object):
623
614
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
624
615
  kwargs['account_id'] = \
625
616
  account_id
626
- kwargs['balance_id'] = \
627
- balance_id
628
- return self.get_api_external_v2_account_by_account_id_balancesbalance_id_endpoint.call_with_http_info(**kwargs)
617
+ return self.create_balance_by_account_id_endpoint.call_with_http_info(**kwargs)
629
618
 
630
- def get_balance_history(
619
+ def get_balance_by_account_and_balance_id(
631
620
  self,
621
+ account_id,
632
622
  balance_id,
633
623
  **kwargs
634
624
  ):
635
- """get_balance_history # noqa: E501
625
+ """get_balance_by_account_and_balance_id # noqa: E501
636
626
 
637
- Gets the balance's historical change data. # noqa: E501
627
+ Get a balance for the given account id and balance id # noqa: E501
638
628
  This method makes a synchronous HTTP request by default. To make an
639
629
  asynchronous HTTP request, please pass async_req=True
640
630
 
641
- >>> thread = api.get_balance_history(balance_id, async_req=True)
631
+ >>> thread = api.get_balance_by_account_and_balance_id(account_id, balance_id, async_req=True)
642
632
  >>> result = thread.get()
643
633
 
644
634
  Args:
645
- balance_id (str): Balance id.
635
+ account_id (str): The account of the balance
636
+ balance_id (str): The balance id
646
637
 
647
638
  Keyword Args:
648
- limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25
649
- limit_to_change_types (str): Comma separated change types string that will be queried.. [optional]
650
- offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
651
639
  _return_http_data_only (bool): response data without head status
652
640
  code and headers. Default is True.
653
641
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -680,7 +668,7 @@ class BalanceApi(object):
680
668
  async_req (bool): execute request asynchronously
681
669
 
682
670
  Returns:
683
- PageOfBalanceHistoryChangeDataCaptureV1
671
+ BalanceResponseV2Response
684
672
  If the method is called asynchronously, returns the request
685
673
  thread.
686
674
  """
@@ -709,31 +697,33 @@ class BalanceApi(object):
709
697
  '_content_type')
710
698
  kwargs['_host_index'] = kwargs.get('_host_index')
711
699
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
700
+ kwargs['account_id'] = \
701
+ account_id
712
702
  kwargs['balance_id'] = \
713
703
  balance_id
714
- return self.get_balance_history_endpoint.call_with_http_info(**kwargs)
704
+ return self.get_balance_by_account_and_balance_id_endpoint.call_with_http_info(**kwargs)
715
705
 
716
- def patch_api_external_v2_account_by_account_id_balancesbalance_id(
706
+ def get_balance_history(
717
707
  self,
718
- account_id,
719
708
  balance_id,
720
709
  **kwargs
721
710
  ):
722
- """patch_api_external_v2_account_by_account_id_balancesbalance_id # noqa: E501
711
+ """get_balance_history # noqa: E501
723
712
 
724
- Modify a balance for the given account id # noqa: E501
713
+ Gets the balance's historical change data. # noqa: E501
725
714
  This method makes a synchronous HTTP request by default. To make an
726
715
  asynchronous HTTP request, please pass async_req=True
727
716
 
728
- >>> thread = api.patch_api_external_v2_account_by_account_id_balancesbalance_id(account_id, balance_id, async_req=True)
717
+ >>> thread = api.get_balance_history(balance_id, async_req=True)
729
718
  >>> result = thread.get()
730
719
 
731
720
  Args:
732
- account_id (str): The account of the balance
733
- balance_id (str): The balance to change the dates
721
+ balance_id (str): Balance id.
734
722
 
735
723
  Keyword Args:
736
- update_balance_model_v2_request (UpdateBalanceModelV2Request): An object that represents the available options to modify a balance.. [optional]
724
+ limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25
725
+ limit_to_change_types (str): Comma separated change types string that will be queried.. [optional]
726
+ offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
737
727
  _return_http_data_only (bool): response data without head status
738
728
  code and headers. Default is True.
739
729
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -766,7 +756,7 @@ class BalanceApi(object):
766
756
  async_req (bool): execute request asynchronously
767
757
 
768
758
  Returns:
769
- BalanceResponseV2Response
759
+ PageOfBalanceHistoryChangeDataCaptureV1
770
760
  If the method is called asynchronously, returns the request
771
761
  thread.
772
762
  """
@@ -795,31 +785,31 @@ class BalanceApi(object):
795
785
  '_content_type')
796
786
  kwargs['_host_index'] = kwargs.get('_host_index')
797
787
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
798
- kwargs['account_id'] = \
799
- account_id
800
788
  kwargs['balance_id'] = \
801
789
  balance_id
802
- return self.patch_api_external_v2_account_by_account_id_balancesbalance_id_endpoint.call_with_http_info(**kwargs)
790
+ return self.get_balance_history_endpoint.call_with_http_info(**kwargs)
803
791
 
804
- def post_api_external_v2_account_balances_by_account_id(
792
+ def get_balances_by_account_id(
805
793
  self,
806
794
  account_id,
807
795
  **kwargs
808
796
  ):
809
- """post_api_external_v2_account_balances_by_account_id # noqa: E501
797
+ """get_balances_by_account_id # noqa: E501
810
798
 
811
- Create balance for the given account id # noqa: E501
799
+ Gets page of balance objects for the given account id # noqa: E501
812
800
  This method makes a synchronous HTTP request by default. To make an
813
801
  asynchronous HTTP request, please pass async_req=True
814
802
 
815
- >>> thread = api.post_api_external_v2_account_balances_by_account_id(account_id, async_req=True)
803
+ >>> thread = api.get_balances_by_account_id(account_id, async_req=True)
816
804
  >>> result = thread.get()
817
805
 
818
806
  Args:
819
- account_id (str): The account to create balances for
807
+ account_id (str): The account to get balances for
820
808
 
821
809
  Keyword Args:
822
- create_balance_v2_request (CreateBalanceV2Request): An object that represents the available options to set when creating a Retail Media Balance. [optional]
810
+ limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
811
+ 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
812
+ 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
823
813
  _return_http_data_only (bool): response data without head status
824
814
  code and headers. Default is True.
825
815
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -852,7 +842,7 @@ class BalanceApi(object):
852
842
  async_req (bool): execute request asynchronously
853
843
 
854
844
  Returns:
855
- BalanceResponseV2Response
845
+ BalanceResponseV2PagedListResponse
856
846
  If the method is called asynchronously, returns the request
857
847
  thread.
858
848
  """
@@ -883,21 +873,21 @@ class BalanceApi(object):
883
873
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
884
874
  kwargs['account_id'] = \
885
875
  account_id
886
- return self.post_api_external_v2_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
876
+ return self.get_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
887
877
 
888
- def post_api_external_v2_account_change_dates_by_account_id_balancesbalance_id(
878
+ def modify_balance_by_account_and_balance_id(
889
879
  self,
890
880
  account_id,
891
881
  balance_id,
892
882
  **kwargs
893
883
  ):
894
- """post_api_external_v2_account_change_dates_by_account_id_balancesbalance_id # noqa: E501
884
+ """modify_balance_by_account_and_balance_id # noqa: E501
895
885
 
896
- Change dates of a balance for the given account id # noqa: E501
886
+ Modify a balance for the given account id # noqa: E501
897
887
  This method makes a synchronous HTTP request by default. To make an
898
888
  asynchronous HTTP request, please pass async_req=True
899
889
 
900
- >>> thread = api.post_api_external_v2_account_change_dates_by_account_id_balancesbalance_id(account_id, balance_id, async_req=True)
890
+ >>> thread = api.modify_balance_by_account_and_balance_id(account_id, balance_id, async_req=True)
901
891
  >>> result = thread.get()
902
892
 
903
893
  Args:
@@ -905,7 +895,7 @@ class BalanceApi(object):
905
895
  balance_id (str): The balance to change the dates
906
896
 
907
897
  Keyword Args:
908
- change_dates_of_balance_v2_request (ChangeDatesOfBalanceV2Request): An object that represents the available options to modify schedule of a balance.. [optional]
898
+ update_balance_model_v2_request (UpdateBalanceModelV2Request): An object that represents the available options to modify a balance.. [optional]
909
899
  _return_http_data_only (bool): response data without head status
910
900
  code and headers. Default is True.
911
901
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -971,5 +961,5 @@ class BalanceApi(object):
971
961
  account_id
972
962
  kwargs['balance_id'] = \
973
963
  balance_id
974
- return self.post_api_external_v2_account_change_dates_by_account_id_balancesbalance_id_endpoint.call_with_http_info(**kwargs)
964
+ return self.modify_balance_by_account_and_balance_id_endpoint.call_with_http_info(**kwargs)
975
965