criteo-api-retailmedia-sdk 0.0.240808__py3-none-any.whl → 0.0.241029__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.
Files changed (60) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +148 -0
  3. criteo_api_retailmedia_preview/api/analytics_api.py +3 -3
  4. criteo_api_retailmedia_preview/api/audience_api.py +89 -232
  5. criteo_api_retailmedia_preview/api/campaign_api.py +0 -564
  6. criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +186 -0
  7. criteo_api_retailmedia_preview/api_client.py +1 -1
  8. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  9. criteo_api_retailmedia_preview/configuration.py +1 -1
  10. criteo_api_retailmedia_preview/model/bot_message.py +277 -0
  11. criteo_api_retailmedia_preview/model/botmessage.py +329 -0
  12. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_list_response.py → entity_resource_collection_outcome_of_retail_media_account.py} +8 -8
  13. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_resource.py → entity_resource_of_retail_media_account.py} +9 -18
  14. criteo_api_retailmedia_preview/model/external_account.py +4 -0
  15. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2.py → external_retail_media_account.py} +54 -32
  16. criteo_api_retailmedia_preview/model/{value_resource_input_of_line_item_budget_overrides.py → http_validation_error.py} +17 -10
  17. criteo_api_retailmedia_preview/model/inbot_discussion.py +272 -0
  18. criteo_api_retailmedia_preview/model/{rm_legacy_segment_customer_list.py → inbot_discussion_body_model.py} +17 -17
  19. criteo_api_retailmedia_preview/model/{rm_legacy_audience_user_behavior_details_v2.py → inbot_discussion_data_instance_model.py} +17 -17
  20. criteo_api_retailmedia_preview/model/{value_resource_input_of_campaign_budget_overrides.py → location_inner.py} +10 -13
  21. criteo_api_retailmedia_preview/model/message.py +273 -0
  22. criteo_api_retailmedia_preview/model/message_body_model.py +275 -0
  23. criteo_api_retailmedia_preview/model/{value_resource_of_line_item_budget_overrides.py → message_data_instance_model.py} +27 -14
  24. criteo_api_retailmedia_preview/model/message_error.py +275 -0
  25. criteo_api_retailmedia_preview/model/product.py +4 -0
  26. criteo_api_retailmedia_preview/model/{rm_legacy_segment_user_behavior_v1.py → product_recommendation.py} +46 -47
  27. criteo_api_retailmedia_preview/model/report_detail_warning.py +285 -0
  28. criteo_api_retailmedia_preview/model/report_detail_warnings.py +281 -0
  29. criteo_api_retailmedia_preview/model/report_ok_response.py +16 -2
  30. criteo_api_retailmedia_preview/model/retail_media_account.py +6 -2
  31. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +6 -2
  32. criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +275 -0
  33. criteo_api_retailmedia_preview/model/rm_audience_entity_v1.py +307 -0
  34. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_resource.py → rm_audience_entity_v1_resource.py} +8 -8
  35. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_list_response.py → rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py} +14 -8
  36. criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +271 -0
  37. criteo_api_retailmedia_preview/model/{value_resource_of_campaign_budget_overrides.py → rm_audience_search_entity_v1_resource.py} +16 -9
  38. criteo_api_retailmedia_preview/model/rm_audience_search_input_v1.py +269 -0
  39. criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +271 -0
  40. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +17 -9
  41. criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +7 -7
  42. criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +1 -1
  43. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +5 -5
  44. criteo_api_retailmedia_preview/model/{rm_user_behavior_v1.py → rm_events_v1.py} +3 -3
  45. criteo_api_retailmedia_preview/model/validation_error.py +287 -0
  46. criteo_api_retailmedia_preview/models/__init__.py +27 -23
  47. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/METADATA +3 -3
  48. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/RECORD +50 -45
  49. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/WHEEL +1 -1
  50. criteo_api_retailmedia_preview/model/campaign_budget_overrides.py +0 -276
  51. criteo_api_retailmedia_preview/model/campaign_daily_budget_override.py +0 -283
  52. criteo_api_retailmedia_preview/model/campaign_monthly_budget_override.py +0 -283
  53. criteo_api_retailmedia_preview/model/daily_line_item_budget_override.py +0 -281
  54. criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +0 -276
  55. criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py +0 -283
  56. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1.py +0 -291
  57. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v2.py +0 -311
  58. criteo_api_retailmedia_preview/model/value_resource_outcome_of_campaign_budget_overrides.py +0 -274
  59. criteo_api_retailmedia_preview/model/value_resource_outcome_of_line_item_budget_overrides.py +0 -274
  60. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/top_level.txt +0 -0
@@ -60,10 +60,6 @@ from criteo_api_retailmedia_preview.model.sku_search_request_slim_preview_reques
60
60
  from criteo_api_retailmedia_preview.model.sku_search_request_slim_v2_preview_request import SkuSearchRequestSlimV2PreviewRequest
61
61
  from criteo_api_retailmedia_preview.model.sku_slim_data_preview_list_response import SkuSlimDataPreviewListResponse
62
62
  from criteo_api_retailmedia_preview.model.sku_slim_data_v2_list_response import SkuSlimDataV2ListResponse
63
- from criteo_api_retailmedia_preview.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides
64
- from criteo_api_retailmedia_preview.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides
65
- from criteo_api_retailmedia_preview.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides
66
- from criteo_api_retailmedia_preview.model.value_resource_outcome_of_line_item_budget_overrides import ValueResourceOutcomeOfLineItemBudgetOverrides
67
63
  from criteo_api_retailmedia_preview.model.value_resource_outcome_of_recommended_keywords_result import ValueResourceOutcomeOfRecommendedKeywordsResult
68
64
 
69
65
 
@@ -1207,58 +1203,6 @@ class CampaignApi(object):
1207
1203
  },
1208
1204
  api_client=api_client
1209
1205
  )
1210
- self.get_campaign_budget_overrides_endpoint = _Endpoint(
1211
- settings={
1212
- 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
1213
- 'auth': [
1214
- 'oauth',
1215
- 'oauth'
1216
- ],
1217
- 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides',
1218
- 'operation_id': 'get_campaign_budget_overrides',
1219
- 'http_method': 'GET',
1220
- 'servers': None,
1221
- },
1222
- params_map={
1223
- 'all': [
1224
- 'campaign_id',
1225
- ],
1226
- 'required': [
1227
- 'campaign_id',
1228
- ],
1229
- 'nullable': [
1230
- ],
1231
- 'enum': [
1232
- ],
1233
- 'validation': [
1234
- ]
1235
- },
1236
- root_map={
1237
- 'validations': {
1238
- },
1239
- 'allowed_values': {
1240
- },
1241
- 'openapi_types': {
1242
- 'campaign_id':
1243
- (int,),
1244
- },
1245
- 'attribute_map': {
1246
- 'campaign_id': 'campaignId',
1247
- },
1248
- 'location_map': {
1249
- 'campaign_id': 'path',
1250
- },
1251
- 'collection_format_map': {
1252
- }
1253
- },
1254
- headers_map={
1255
- 'accept': [
1256
- 'application/json'
1257
- ],
1258
- 'content_type': [],
1259
- },
1260
- api_client=api_client
1261
- )
1262
1206
  self.get_insertion_order_history_change_data_capture_v2_endpoint = _Endpoint(
1263
1207
  settings={
1264
1208
  'response_type': (PageOfInsertionOrderHistoryChangeDataCaptureV2,),
@@ -1338,58 +1282,6 @@ class CampaignApi(object):
1338
1282
  },
1339
1283
  api_client=api_client
1340
1284
  )
1341
- self.get_line_item_budget_overrides_endpoint = _Endpoint(
1342
- settings={
1343
- 'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,),
1344
- 'auth': [
1345
- 'oauth',
1346
- 'oauth'
1347
- ],
1348
- 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides',
1349
- 'operation_id': 'get_line_item_budget_overrides',
1350
- 'http_method': 'GET',
1351
- 'servers': None,
1352
- },
1353
- params_map={
1354
- 'all': [
1355
- 'line_item_id',
1356
- ],
1357
- 'required': [
1358
- 'line_item_id',
1359
- ],
1360
- 'nullable': [
1361
- ],
1362
- 'enum': [
1363
- ],
1364
- 'validation': [
1365
- ]
1366
- },
1367
- root_map={
1368
- 'validations': {
1369
- },
1370
- 'allowed_values': {
1371
- },
1372
- 'openapi_types': {
1373
- 'line_item_id':
1374
- (str,),
1375
- },
1376
- 'attribute_map': {
1377
- 'line_item_id': 'lineItemId',
1378
- },
1379
- 'location_map': {
1380
- 'line_item_id': 'path',
1381
- },
1382
- 'collection_format_map': {
1383
- }
1384
- },
1385
- headers_map={
1386
- 'accept': [
1387
- 'application/json'
1388
- ],
1389
- 'content_type': [],
1390
- },
1391
- api_client=api_client
1392
- )
1393
1285
  self.get_recommended_keywords_endpoint = _Endpoint(
1394
1286
  settings={
1395
1287
  'response_type': (ValueResourceOutcomeOfRecommendedKeywordsResult,),
@@ -2625,128 +2517,6 @@ class CampaignApi(object):
2625
2517
  },
2626
2518
  api_client=api_client
2627
2519
  )
2628
- self.update_campaign_budget_overrides_endpoint = _Endpoint(
2629
- settings={
2630
- 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
2631
- 'auth': [
2632
- 'oauth',
2633
- 'oauth'
2634
- ],
2635
- 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides',
2636
- 'operation_id': 'update_campaign_budget_overrides',
2637
- 'http_method': 'PUT',
2638
- 'servers': None,
2639
- },
2640
- params_map={
2641
- 'all': [
2642
- 'campaign_id',
2643
- 'value_resource_input_of_campaign_budget_overrides',
2644
- ],
2645
- 'required': [
2646
- 'campaign_id',
2647
- ],
2648
- 'nullable': [
2649
- ],
2650
- 'enum': [
2651
- ],
2652
- 'validation': [
2653
- ]
2654
- },
2655
- root_map={
2656
- 'validations': {
2657
- },
2658
- 'allowed_values': {
2659
- },
2660
- 'openapi_types': {
2661
- 'campaign_id':
2662
- (int,),
2663
- 'value_resource_input_of_campaign_budget_overrides':
2664
- (ValueResourceInputOfCampaignBudgetOverrides,),
2665
- },
2666
- 'attribute_map': {
2667
- 'campaign_id': 'campaignId',
2668
- },
2669
- 'location_map': {
2670
- 'campaign_id': 'path',
2671
- 'value_resource_input_of_campaign_budget_overrides': 'body',
2672
- },
2673
- 'collection_format_map': {
2674
- }
2675
- },
2676
- headers_map={
2677
- 'accept': [
2678
- 'application/json'
2679
- ],
2680
- 'content_type': [
2681
- 'application/json-patch+json',
2682
- 'application/json',
2683
- 'text/json',
2684
- 'application/*+json'
2685
- ]
2686
- },
2687
- api_client=api_client
2688
- )
2689
- self.update_line_item_budget_overrides_endpoint = _Endpoint(
2690
- settings={
2691
- 'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,),
2692
- 'auth': [
2693
- 'oauth',
2694
- 'oauth'
2695
- ],
2696
- 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides',
2697
- 'operation_id': 'update_line_item_budget_overrides',
2698
- 'http_method': 'PUT',
2699
- 'servers': None,
2700
- },
2701
- params_map={
2702
- 'all': [
2703
- 'line_item_id',
2704
- 'value_resource_input_of_line_item_budget_overrides',
2705
- ],
2706
- 'required': [
2707
- 'line_item_id',
2708
- ],
2709
- 'nullable': [
2710
- ],
2711
- 'enum': [
2712
- ],
2713
- 'validation': [
2714
- ]
2715
- },
2716
- root_map={
2717
- 'validations': {
2718
- },
2719
- 'allowed_values': {
2720
- },
2721
- 'openapi_types': {
2722
- 'line_item_id':
2723
- (str,),
2724
- 'value_resource_input_of_line_item_budget_overrides':
2725
- (ValueResourceInputOfLineItemBudgetOverrides,),
2726
- },
2727
- 'attribute_map': {
2728
- 'line_item_id': 'lineItemId',
2729
- },
2730
- 'location_map': {
2731
- 'line_item_id': 'path',
2732
- 'value_resource_input_of_line_item_budget_overrides': 'body',
2733
- },
2734
- 'collection_format_map': {
2735
- }
2736
- },
2737
- headers_map={
2738
- 'accept': [
2739
- 'application/json'
2740
- ],
2741
- 'content_type': [
2742
- 'application/json-patch+json',
2743
- 'application/json',
2744
- 'text/json',
2745
- 'application/*+json'
2746
- ]
2747
- },
2748
- api_client=api_client
2749
- )
2750
2520
 
2751
2521
  def add_remove_keywords(
2752
2522
  self,
@@ -4359,89 +4129,6 @@ class CampaignApi(object):
4359
4129
  line_item_id
4360
4130
  return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
4361
4131
 
4362
- def get_campaign_budget_overrides(
4363
- self,
4364
- campaign_id,
4365
- **kwargs
4366
- ):
4367
- """get_campaign_budget_overrides # noqa: E501
4368
-
4369
- Get current campaign budget overrides by given external campaign id. # noqa: E501
4370
- This method makes a synchronous HTTP request by default. To make an
4371
- asynchronous HTTP request, please pass async_req=True
4372
-
4373
- >>> thread = api.get_campaign_budget_overrides(campaign_id, async_req=True)
4374
- >>> result = thread.get()
4375
-
4376
- Args:
4377
- campaign_id (int): External campaign id.
4378
-
4379
- Keyword Args:
4380
- _return_http_data_only (bool): response data without head status
4381
- code and headers. Default is True.
4382
- _preload_content (bool): if False, the urllib3.HTTPResponse object
4383
- will be returned without reading/decoding response data.
4384
- Default is True.
4385
- _request_timeout (int/float/tuple): timeout setting for this request. If
4386
- one number provided, it will be total request timeout. It can also
4387
- be a pair (tuple) of (connection, read) timeouts.
4388
- Default is None.
4389
- _check_input_type (bool): specifies if type checking
4390
- should be done one the data sent to the server.
4391
- Default is True.
4392
- _check_return_type (bool): specifies if type checking
4393
- should be done one the data received from the server.
4394
- Default is True.
4395
- _spec_property_naming (bool): True if the variable names in the input data
4396
- are serialized names, as specified in the OpenAPI document.
4397
- False if the variable names in the input data
4398
- are pythonic names, e.g. snake case (default)
4399
- _content_type (str/None): force body content-type.
4400
- Default is None and content-type will be predicted by allowed
4401
- content-types and body.
4402
- _host_index (int/None): specifies the index of the server
4403
- that we want to use.
4404
- Default is read from the configuration.
4405
- _request_auths (list): set to override the auth_settings for an a single
4406
- request; this effectively ignores the authentication
4407
- in the spec for a single request.
4408
- Default is None
4409
- async_req (bool): execute request asynchronously
4410
-
4411
- Returns:
4412
- ValueResourceOutcomeOfCampaignBudgetOverrides
4413
- If the method is called asynchronously, returns the request
4414
- thread.
4415
- """
4416
- kwargs['async_req'] = kwargs.get(
4417
- 'async_req', False
4418
- )
4419
- kwargs['_return_http_data_only'] = kwargs.get(
4420
- '_return_http_data_only', True
4421
- )
4422
- kwargs['_preload_content'] = kwargs.get(
4423
- '_preload_content', True
4424
- )
4425
- kwargs['_request_timeout'] = kwargs.get(
4426
- '_request_timeout', None
4427
- )
4428
- kwargs['_check_input_type'] = kwargs.get(
4429
- '_check_input_type', True
4430
- )
4431
- kwargs['_check_return_type'] = kwargs.get(
4432
- '_check_return_type', True
4433
- )
4434
- kwargs['_spec_property_naming'] = kwargs.get(
4435
- '_spec_property_naming', False
4436
- )
4437
- kwargs['_content_type'] = kwargs.get(
4438
- '_content_type')
4439
- kwargs['_host_index'] = kwargs.get('_host_index')
4440
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4441
- kwargs['campaign_id'] = \
4442
- campaign_id
4443
- return self.get_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs)
4444
-
4445
4132
  def get_insertion_order_history_change_data_capture_v2(
4446
4133
  self,
4447
4134
  insertion_order_id,
@@ -4528,89 +4215,6 @@ class CampaignApi(object):
4528
4215
  insertion_order_id
4529
4216
  return self.get_insertion_order_history_change_data_capture_v2_endpoint.call_with_http_info(**kwargs)
4530
4217
 
4531
- def get_line_item_budget_overrides(
4532
- self,
4533
- line_item_id,
4534
- **kwargs
4535
- ):
4536
- """get_line_item_budget_overrides # noqa: E501
4537
-
4538
- Gets a collection of monthly and daily budget overrides for the provided line item. # noqa: E501
4539
- This method makes a synchronous HTTP request by default. To make an
4540
- asynchronous HTTP request, please pass async_req=True
4541
-
4542
- >>> thread = api.get_line_item_budget_overrides(line_item_id, async_req=True)
4543
- >>> result = thread.get()
4544
-
4545
- Args:
4546
- line_item_id (str): The line item id to get budget overrides for.
4547
-
4548
- Keyword Args:
4549
- _return_http_data_only (bool): response data without head status
4550
- code and headers. Default is True.
4551
- _preload_content (bool): if False, the urllib3.HTTPResponse object
4552
- will be returned without reading/decoding response data.
4553
- Default is True.
4554
- _request_timeout (int/float/tuple): timeout setting for this request. If
4555
- one number provided, it will be total request timeout. It can also
4556
- be a pair (tuple) of (connection, read) timeouts.
4557
- Default is None.
4558
- _check_input_type (bool): specifies if type checking
4559
- should be done one the data sent to the server.
4560
- Default is True.
4561
- _check_return_type (bool): specifies if type checking
4562
- should be done one the data received from the server.
4563
- Default is True.
4564
- _spec_property_naming (bool): True if the variable names in the input data
4565
- are serialized names, as specified in the OpenAPI document.
4566
- False if the variable names in the input data
4567
- are pythonic names, e.g. snake case (default)
4568
- _content_type (str/None): force body content-type.
4569
- Default is None and content-type will be predicted by allowed
4570
- content-types and body.
4571
- _host_index (int/None): specifies the index of the server
4572
- that we want to use.
4573
- Default is read from the configuration.
4574
- _request_auths (list): set to override the auth_settings for an a single
4575
- request; this effectively ignores the authentication
4576
- in the spec for a single request.
4577
- Default is None
4578
- async_req (bool): execute request asynchronously
4579
-
4580
- Returns:
4581
- ValueResourceOutcomeOfLineItemBudgetOverrides
4582
- If the method is called asynchronously, returns the request
4583
- thread.
4584
- """
4585
- kwargs['async_req'] = kwargs.get(
4586
- 'async_req', False
4587
- )
4588
- kwargs['_return_http_data_only'] = kwargs.get(
4589
- '_return_http_data_only', True
4590
- )
4591
- kwargs['_preload_content'] = kwargs.get(
4592
- '_preload_content', True
4593
- )
4594
- kwargs['_request_timeout'] = kwargs.get(
4595
- '_request_timeout', None
4596
- )
4597
- kwargs['_check_input_type'] = kwargs.get(
4598
- '_check_input_type', True
4599
- )
4600
- kwargs['_check_return_type'] = kwargs.get(
4601
- '_check_return_type', True
4602
- )
4603
- kwargs['_spec_property_naming'] = kwargs.get(
4604
- '_spec_property_naming', False
4605
- )
4606
- kwargs['_content_type'] = kwargs.get(
4607
- '_content_type')
4608
- kwargs['_host_index'] = kwargs.get('_host_index')
4609
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4610
- kwargs['line_item_id'] = \
4611
- line_item_id
4612
- return self.get_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs)
4613
-
4614
4218
  def get_recommended_keywords(
4615
4219
  self,
4616
4220
  external_line_item_id,
@@ -6228,171 +5832,3 @@ class CampaignApi(object):
6228
5832
  line_item_id
6229
5833
  return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
6230
5834
 
6231
- def update_campaign_budget_overrides(
6232
- self,
6233
- campaign_id,
6234
- **kwargs
6235
- ):
6236
- """update_campaign_budget_overrides # noqa: E501
6237
-
6238
- Update campaign budget overrides by given external campaign id and new campaign budget overrides settings. # noqa: E501
6239
- This method makes a synchronous HTTP request by default. To make an
6240
- asynchronous HTTP request, please pass async_req=True
6241
-
6242
- >>> thread = api.update_campaign_budget_overrides(campaign_id, async_req=True)
6243
- >>> result = thread.get()
6244
-
6245
- Args:
6246
- campaign_id (int): External campaign id.
6247
-
6248
- Keyword Args:
6249
- value_resource_input_of_campaign_budget_overrides (ValueResourceInputOfCampaignBudgetOverrides): New campaign budget overrides settings value resource input.. [optional]
6250
- _return_http_data_only (bool): response data without head status
6251
- code and headers. Default is True.
6252
- _preload_content (bool): if False, the urllib3.HTTPResponse object
6253
- will be returned without reading/decoding response data.
6254
- Default is True.
6255
- _request_timeout (int/float/tuple): timeout setting for this request. If
6256
- one number provided, it will be total request timeout. It can also
6257
- be a pair (tuple) of (connection, read) timeouts.
6258
- Default is None.
6259
- _check_input_type (bool): specifies if type checking
6260
- should be done one the data sent to the server.
6261
- Default is True.
6262
- _check_return_type (bool): specifies if type checking
6263
- should be done one the data received from the server.
6264
- Default is True.
6265
- _spec_property_naming (bool): True if the variable names in the input data
6266
- are serialized names, as specified in the OpenAPI document.
6267
- False if the variable names in the input data
6268
- are pythonic names, e.g. snake case (default)
6269
- _content_type (str/None): force body content-type.
6270
- Default is None and content-type will be predicted by allowed
6271
- content-types and body.
6272
- _host_index (int/None): specifies the index of the server
6273
- that we want to use.
6274
- Default is read from the configuration.
6275
- _request_auths (list): set to override the auth_settings for an a single
6276
- request; this effectively ignores the authentication
6277
- in the spec for a single request.
6278
- Default is None
6279
- async_req (bool): execute request asynchronously
6280
-
6281
- Returns:
6282
- ValueResourceOutcomeOfCampaignBudgetOverrides
6283
- If the method is called asynchronously, returns the request
6284
- thread.
6285
- """
6286
- kwargs['async_req'] = kwargs.get(
6287
- 'async_req', False
6288
- )
6289
- kwargs['_return_http_data_only'] = kwargs.get(
6290
- '_return_http_data_only', True
6291
- )
6292
- kwargs['_preload_content'] = kwargs.get(
6293
- '_preload_content', True
6294
- )
6295
- kwargs['_request_timeout'] = kwargs.get(
6296
- '_request_timeout', None
6297
- )
6298
- kwargs['_check_input_type'] = kwargs.get(
6299
- '_check_input_type', True
6300
- )
6301
- kwargs['_check_return_type'] = kwargs.get(
6302
- '_check_return_type', True
6303
- )
6304
- kwargs['_spec_property_naming'] = kwargs.get(
6305
- '_spec_property_naming', False
6306
- )
6307
- kwargs['_content_type'] = kwargs.get(
6308
- '_content_type')
6309
- kwargs['_host_index'] = kwargs.get('_host_index')
6310
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
6311
- kwargs['campaign_id'] = \
6312
- campaign_id
6313
- return self.update_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs)
6314
-
6315
- def update_line_item_budget_overrides(
6316
- self,
6317
- line_item_id,
6318
- **kwargs
6319
- ):
6320
- """update_line_item_budget_overrides # noqa: E501
6321
-
6322
- Update line item budget overrides by given external line item id and new line item budget overrides settings. # noqa: E501
6323
- This method makes a synchronous HTTP request by default. To make an
6324
- asynchronous HTTP request, please pass async_req=True
6325
-
6326
- >>> thread = api.update_line_item_budget_overrides(line_item_id, async_req=True)
6327
- >>> result = thread.get()
6328
-
6329
- Args:
6330
- line_item_id (str): Line item external id.
6331
-
6332
- Keyword Args:
6333
- value_resource_input_of_line_item_budget_overrides (ValueResourceInputOfLineItemBudgetOverrides): New line item budget overrides settings value resource input.. [optional]
6334
- _return_http_data_only (bool): response data without head status
6335
- code and headers. Default is True.
6336
- _preload_content (bool): if False, the urllib3.HTTPResponse object
6337
- will be returned without reading/decoding response data.
6338
- Default is True.
6339
- _request_timeout (int/float/tuple): timeout setting for this request. If
6340
- one number provided, it will be total request timeout. It can also
6341
- be a pair (tuple) of (connection, read) timeouts.
6342
- Default is None.
6343
- _check_input_type (bool): specifies if type checking
6344
- should be done one the data sent to the server.
6345
- Default is True.
6346
- _check_return_type (bool): specifies if type checking
6347
- should be done one the data received from the server.
6348
- Default is True.
6349
- _spec_property_naming (bool): True if the variable names in the input data
6350
- are serialized names, as specified in the OpenAPI document.
6351
- False if the variable names in the input data
6352
- are pythonic names, e.g. snake case (default)
6353
- _content_type (str/None): force body content-type.
6354
- Default is None and content-type will be predicted by allowed
6355
- content-types and body.
6356
- _host_index (int/None): specifies the index of the server
6357
- that we want to use.
6358
- Default is read from the configuration.
6359
- _request_auths (list): set to override the auth_settings for an a single
6360
- request; this effectively ignores the authentication
6361
- in the spec for a single request.
6362
- Default is None
6363
- async_req (bool): execute request asynchronously
6364
-
6365
- Returns:
6366
- ValueResourceOutcomeOfLineItemBudgetOverrides
6367
- If the method is called asynchronously, returns the request
6368
- thread.
6369
- """
6370
- kwargs['async_req'] = kwargs.get(
6371
- 'async_req', False
6372
- )
6373
- kwargs['_return_http_data_only'] = kwargs.get(
6374
- '_return_http_data_only', True
6375
- )
6376
- kwargs['_preload_content'] = kwargs.get(
6377
- '_preload_content', True
6378
- )
6379
- kwargs['_request_timeout'] = kwargs.get(
6380
- '_request_timeout', None
6381
- )
6382
- kwargs['_check_input_type'] = kwargs.get(
6383
- '_check_input_type', True
6384
- )
6385
- kwargs['_check_return_type'] = kwargs.get(
6386
- '_check_return_type', True
6387
- )
6388
- kwargs['_spec_property_naming'] = kwargs.get(
6389
- '_spec_property_naming', False
6390
- )
6391
- kwargs['_content_type'] = kwargs.get(
6392
- '_content_type')
6393
- kwargs['_host_index'] = kwargs.get('_host_index')
6394
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
6395
- kwargs['line_item_id'] = \
6396
- line_item_id
6397
- return self.update_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs)
6398
-