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
@@ -8,7 +8,7 @@
8
8
  """
9
9
 
10
10
 
11
- __version__ = "0.0.240808"
11
+ __version__ = "0.0.241029"
12
12
 
13
13
  # import ApiClient
14
14
  from criteo_api_retailmedia_preview.api_client import ApiClient
@@ -21,6 +21,7 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
21
21
  none_type,
22
22
  validate_and_convert_types
23
23
  )
24
+ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retail_media_account import EntityResourceCollectionOutcomeOfRetailMediaAccount
24
25
  from criteo_api_retailmedia_preview.model.grant_consent_input import GrantConsentInput
25
26
  from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
26
27
  from criteo_api_retailmedia_preview.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount
@@ -101,6 +102,68 @@ class AccountsApi(object):
101
102
  },
102
103
  api_client=api_client
103
104
  )
105
+ self.get_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint = _Endpoint(
106
+ settings={
107
+ 'response_type': (EntityResourceCollectionOutcomeOfRetailMediaAccount,),
108
+ 'auth': [
109
+ 'oauth',
110
+ 'oauth'
111
+ ],
112
+ 'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts',
113
+ 'operation_id': 'get_api_external_v1_account_private_market_child_accounts_by_account_id',
114
+ 'http_method': 'GET',
115
+ 'servers': None,
116
+ },
117
+ params_map={
118
+ 'all': [
119
+ 'account_id',
120
+ 'offset',
121
+ 'limit',
122
+ ],
123
+ 'required': [
124
+ 'account_id',
125
+ ],
126
+ 'nullable': [
127
+ ],
128
+ 'enum': [
129
+ ],
130
+ 'validation': [
131
+ ]
132
+ },
133
+ root_map={
134
+ 'validations': {
135
+ },
136
+ 'allowed_values': {
137
+ },
138
+ 'openapi_types': {
139
+ 'account_id':
140
+ (str,),
141
+ 'offset':
142
+ (int,),
143
+ 'limit':
144
+ (int,),
145
+ },
146
+ 'attribute_map': {
147
+ 'account_id': 'accountId',
148
+ 'offset': 'offset',
149
+ 'limit': 'limit',
150
+ },
151
+ 'location_map': {
152
+ 'account_id': 'path',
153
+ 'offset': 'query',
154
+ 'limit': 'query',
155
+ },
156
+ 'collection_format_map': {
157
+ }
158
+ },
159
+ headers_map={
160
+ 'accept': [
161
+ 'application/json'
162
+ ],
163
+ 'content_type': [],
164
+ },
165
+ api_client=api_client
166
+ )
104
167
  self.get_api_v1_external_accounts_endpoint = _Endpoint(
105
168
  settings={
106
169
  'response_type': (JsonApiPageResponseOfAccount,),
@@ -369,6 +432,91 @@ class AccountsApi(object):
369
432
  account_id
370
433
  return self.create_private_market_demand_seller_account_endpoint.call_with_http_info(**kwargs)
371
434
 
435
+ def get_api_external_v1_account_private_market_child_accounts_by_account_id(
436
+ self,
437
+ account_id,
438
+ **kwargs
439
+ ):
440
+ """get_api_external_v1_account_private_market_child_accounts_by_account_id # noqa: E501
441
+
442
+ Gets page of private market child accounts that are associated with the given account # noqa: E501
443
+ This method makes a synchronous HTTP request by default. To make an
444
+ asynchronous HTTP request, please pass async_req=True
445
+
446
+ >>> thread = api.get_api_external_v1_account_private_market_child_accounts_by_account_id(account_id, async_req=True)
447
+ >>> result = thread.get()
448
+
449
+ Args:
450
+ account_id (str): Account Id
451
+
452
+ Keyword Args:
453
+ offset (int): The (zero-based) offset into the collection of accounts. The default is 0.. [optional] if omitted the server will use the default value of 0
454
+ limit (int): The number of accounts to be returned. The default is 25.. [optional] if omitted the server will use the default value of 25
455
+ _return_http_data_only (bool): response data without head status
456
+ code and headers. Default is True.
457
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
458
+ will be returned without reading/decoding response data.
459
+ Default is True.
460
+ _request_timeout (int/float/tuple): timeout setting for this request. If
461
+ one number provided, it will be total request timeout. It can also
462
+ be a pair (tuple) of (connection, read) timeouts.
463
+ Default is None.
464
+ _check_input_type (bool): specifies if type checking
465
+ should be done one the data sent to the server.
466
+ Default is True.
467
+ _check_return_type (bool): specifies if type checking
468
+ should be done one the data received from the server.
469
+ Default is True.
470
+ _spec_property_naming (bool): True if the variable names in the input data
471
+ are serialized names, as specified in the OpenAPI document.
472
+ False if the variable names in the input data
473
+ are pythonic names, e.g. snake case (default)
474
+ _content_type (str/None): force body content-type.
475
+ Default is None and content-type will be predicted by allowed
476
+ content-types and body.
477
+ _host_index (int/None): specifies the index of the server
478
+ that we want to use.
479
+ Default is read from the configuration.
480
+ _request_auths (list): set to override the auth_settings for an a single
481
+ request; this effectively ignores the authentication
482
+ in the spec for a single request.
483
+ Default is None
484
+ async_req (bool): execute request asynchronously
485
+
486
+ Returns:
487
+ EntityResourceCollectionOutcomeOfRetailMediaAccount
488
+ If the method is called asynchronously, returns the request
489
+ thread.
490
+ """
491
+ kwargs['async_req'] = kwargs.get(
492
+ 'async_req', False
493
+ )
494
+ kwargs['_return_http_data_only'] = kwargs.get(
495
+ '_return_http_data_only', True
496
+ )
497
+ kwargs['_preload_content'] = kwargs.get(
498
+ '_preload_content', True
499
+ )
500
+ kwargs['_request_timeout'] = kwargs.get(
501
+ '_request_timeout', None
502
+ )
503
+ kwargs['_check_input_type'] = kwargs.get(
504
+ '_check_input_type', True
505
+ )
506
+ kwargs['_check_return_type'] = kwargs.get(
507
+ '_check_return_type', True
508
+ )
509
+ kwargs['_spec_property_naming'] = kwargs.get(
510
+ '_spec_property_naming', False
511
+ )
512
+ kwargs['_content_type'] = kwargs.get(
513
+ '_content_type')
514
+ kwargs['_host_index'] = kwargs.get('_host_index')
515
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
516
+ kwargs['account_id'] = \
517
+ account_id
518
+ return self.get_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint.call_with_http_info(**kwargs)
519
+
372
520
  def get_api_v1_external_accounts(
373
521
  self,
374
522
  **kwargs
@@ -507,7 +507,7 @@ class AnalyticsApi(object):
507
507
  ):
508
508
  """generate_async_accounts_report # noqa: E501
509
509
 
510
- Returns an asynchronous Accounts Report # noqa: E501
510
+ Returns an asynchronous Accounts Report This endpoint is subject to specific rate limits. # noqa: E501
511
511
  This method makes a synchronous HTTP request by default. To make an
512
512
  asynchronous HTTP request, please pass async_req=True
513
513
 
@@ -590,7 +590,7 @@ class AnalyticsApi(object):
590
590
  ):
591
591
  """generate_async_campaigns_report # noqa: E501
592
592
 
593
- Return an asynchronous Campaigns Report # noqa: E501
593
+ Return an asynchronous Campaigns Report This endpoint is subject to specific rate limits. # noqa: E501
594
594
  This method makes a synchronous HTTP request by default. To make an
595
595
  asynchronous HTTP request, please pass async_req=True
596
596
 
@@ -673,7 +673,7 @@ class AnalyticsApi(object):
673
673
  ):
674
674
  """generate_async_line_items_report # noqa: E501
675
675
 
676
- Returns an asynchronous Line Items Report # noqa: E501
676
+ Returns an asynchronous Line Items Report This endpoint is subject to specific rate limits. # noqa: E501
677
677
  This method makes a synchronous HTTP request by default. To make an
678
678
  asynchronous HTTP request, please pass async_req=True
679
679