criteo-api-retailmedia-sdk 0.0.240207__py3-none-any.whl → 0.0.240515__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 (131) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +181 -35
  3. criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +284 -0
  5. criteo_api_retailmedia_preview/api/campaign_api.py +1678 -902
  6. criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  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/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
  11. criteo_api_retailmedia_preview/model/add_remove_keywords_model.py +262 -0
  12. criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.py +262 -0
  13. criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.py +270 -0
  14. criteo_api_retailmedia_preview/model/approval_status_model.py +292 -0
  15. criteo_api_retailmedia_preview/model/async_accounts_report.py +421 -0
  16. criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
  17. criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
  18. criteo_api_retailmedia_preview/model/async_campaigns_report.py +74 -59
  19. criteo_api_retailmedia_preview/model/async_line_items_report.py +74 -60
  20. criteo_api_retailmedia_preview/model/audience_error.py +310 -0
  21. criteo_api_retailmedia_preview/model/{template_variable.py → audience_warning.py} +48 -46
  22. criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → batch_accepted_response.py} +11 -11
  23. criteo_api_retailmedia_preview/model/change_details.py +275 -0
  24. criteo_api_retailmedia_preview/model/{creative202210_list_response.py → creative_v2_list_response.py} +16 -16
  25. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → creative_v2_response.py} +16 -9
  26. criteo_api_retailmedia_preview/model/custom_attribute.py +275 -0
  27. criteo_api_retailmedia_preview/model/error_code_response.py +281 -0
  28. criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
  29. criteo_api_retailmedia_preview/model/{choice_variable_value.py → external_choice_variable_value.py} +3 -3
  30. criteo_api_retailmedia_preview/model/{color_variable_value.py → external_color_variable_value.py} +8 -14
  31. criteo_api_retailmedia_preview/model/{creative_update_model202207.py → external_creative_create_model_v2.py} +11 -11
  32. criteo_api_retailmedia_preview/model/{creative_create_model202207.py → external_creative_update_model_v2.py} +11 -11
  33. criteo_api_retailmedia_preview/model/{creative202210.py → external_creative_v2.py} +34 -28
  34. criteo_api_retailmedia_preview/model/{files_variable_value.py → external_files_variable_value.py} +4 -3
  35. criteo_api_retailmedia_preview/model/{text_variable_specification.py → external_hyperlink_variable_value.py} +7 -7
  36. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers.py → external_line_item_bid_multipliers_v2.py} +41 -29
  37. criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py +280 -0
  38. criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
  39. criteo_api_retailmedia_preview/model/{choice_variable_specification.py → external_line_item_page_v2.py} +36 -21
  40. criteo_api_retailmedia_preview/model/{page_type_environment.py → external_page_type_environment.py} +15 -9
  41. criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py +345 -0
  42. criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
  43. criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
  44. criteo_api_retailmedia_preview/model/{template_variable_value.py → external_template_variable_value.py} +36 -30
  45. criteo_api_retailmedia_preview/model/{text_variable_value.py → external_text_variable_value.py} +8 -14
  46. criteo_api_retailmedia_preview/model/external_video_variable_value.py +293 -0
  47. criteo_api_retailmedia_preview/model/{choice_option.py → fail_response.py} +21 -19
  48. criteo_api_retailmedia_preview/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
  49. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model.py → input_resource_of_preferred_line_item_create_model_v2.py} +13 -11
  50. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py +303 -0
  51. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model.py → installment.py} +13 -11
  52. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py → json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py} +8 -8
  53. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers.py → json_api_single_response_of_line_item_bid_multipliers_v2.py} +14 -14
  54. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
  55. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
  56. criteo_api_retailmedia_preview/model/keywords_model_resource.py +270 -0
  57. criteo_api_retailmedia_preview/model/keywords_model_response.py +274 -0
  58. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_request.py → line_item_bid_multipliers_v2_request.py} +8 -8
  59. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_response.py → line_item_bid_multipliers_v2_response.py} +16 -16
  60. criteo_api_retailmedia_preview/model/line_item_product_status.py +291 -0
  61. criteo_api_retailmedia_preview/model/loyalty_points.py +271 -0
  62. criteo_api_retailmedia_preview/model/match_type_model.py +291 -0
  63. criteo_api_retailmedia_preview/model/metadata.py +273 -0
  64. criteo_api_retailmedia_preview/model/negotiation_state_model.py +293 -0
  65. criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
  66. criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
  67. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_request.py → preferred_line_item_update_model_v2_request.py} +8 -8
  68. criteo_api_retailmedia_preview/model/{creative202210_response.py → preferred_line_item_v2_paged_list_response.py} +22 -16
  69. criteo_api_retailmedia_preview/model/{template_response.py → preferred_line_item_v2_response.py} +16 -16
  70. criteo_api_retailmedia_preview/model/price.py +267 -0
  71. criteo_api_retailmedia_preview/model/product.py +626 -0
  72. criteo_api_retailmedia_preview/model/product_importer_error.py +299 -0
  73. criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
  74. criteo_api_retailmedia_preview/model/product_metadata.py +269 -0
  75. criteo_api_retailmedia_preview/model/product_resource_outcome.py +266 -0
  76. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_response.py → product_shipping.py} +33 -25
  77. criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
  78. criteo_api_retailmedia_preview/model/product_shipping_weight.py +267 -0
  79. criteo_api_retailmedia_preview/model/product_tax.py +283 -0
  80. criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py +267 -0
  81. criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py +267 -0
  82. criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
  83. criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py +305 -0
  84. criteo_api_retailmedia_preview/model/promoted_product.py +270 -0
  85. criteo_api_retailmedia_preview/model/promoted_product_resource.py +270 -0
  86. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +262 -0
  87. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +278 -0
  88. criteo_api_retailmedia_preview/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
  89. criteo_api_retailmedia_preview/model/proposal_status_model_resource.py +270 -0
  90. criteo_api_retailmedia_preview/model/{template_list_response.py → proposal_status_model_response.py} +20 -27
  91. criteo_api_retailmedia_preview/model/report_detail_error.py +299 -0
  92. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_request.py → report_detail_errors.py} +23 -11
  93. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_resource.py → report_ok_response.py} +56 -21
  94. criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_creative_v2.py} +8 -8
  95. criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_line_item_bid_multipliers_v2.py} +8 -8
  96. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → resource_of_preferred_line_item_update_model_v2.py} +16 -22
  97. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers.py → resource_of_preferred_line_item_v2.py} +9 -9
  98. criteo_api_retailmedia_preview/model/resource_outcome.py +268 -0
  99. criteo_api_retailmedia_preview/model/retail_media_account.py +6 -6
  100. criteo_api_retailmedia_preview/model/retail_media_brands.py +257 -0
  101. criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → retail_media_contactlist_amendment.py} +16 -16
  102. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_resource.py → retail_media_contactlist_amendment_attributes.py} +34 -25
  103. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py +275 -0
  104. criteo_api_retailmedia_preview/model/{json_api_single_response_of_catalog_status.py → retail_media_contactlist_operation.py} +24 -20
  105. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → retail_media_contactlist_operation_response_attributes.py} +14 -18
  106. criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py +297 -0
  107. criteo_api_retailmedia_preview/model/review_state_model.py +294 -0
  108. criteo_api_retailmedia_preview/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
  109. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
  110. criteo_api_retailmedia_preview/model/set_bids_model.py +262 -0
  111. criteo_api_retailmedia_preview/model/set_bids_model_request.py +262 -0
  112. criteo_api_retailmedia_preview/model/set_bids_model_resource.py +270 -0
  113. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +47 -45
  114. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +68 -53
  115. criteo_api_retailmedia_preview/model/sync_line_items_report.py +70 -56
  116. criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
  117. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
  118. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py +262 -0
  119. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
  120. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
  121. criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
  122. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
  123. criteo_api_retailmedia_preview/models/__init__.py +106 -55
  124. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/METADATA +3 -3
  125. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/RECORD +127 -75
  126. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/WHEEL +1 -1
  127. criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
  128. criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_resource.py +0 -283
  129. criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
  130. criteo_api_retailmedia_preview/model/retail_media_externalv1_resource_outcome.py +0 -279
  131. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/top_level.txt +0 -0
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class PageTypeEnvironment(ModelNormal):
33
+ class ExternalPageTypeEnvironment(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -56,6 +56,8 @@ class PageTypeEnvironment(ModelNormal):
56
56
 
57
57
  allowed_values = {
58
58
  ('page_type',): {
59
+ 'None': None,
60
+ 'UNKNOWN': "Unknown",
59
61
  'SEARCH': "Search",
60
62
  'HOME': "Home",
61
63
  'BROWSE': "Browse",
@@ -65,8 +67,12 @@ class PageTypeEnvironment(ModelNormal):
65
67
  'CONFIRMATION': "Confirmation",
66
68
  'MERCHANDISING': "Merchandising",
67
69
  'DEALS': "Deals",
70
+ 'FAVORITES': "Favorites",
71
+ 'SEARCHBAR': "SearchBar",
72
+ 'CATEGORYMENU': "CategoryMenu",
68
73
  },
69
74
  ('environments',): {
75
+ 'None': None,
70
76
  'WEB': "Web",
71
77
  'MOBILE': "Mobile",
72
78
  'APP': "App",
@@ -101,8 +107,8 @@ class PageTypeEnvironment(ModelNormal):
101
107
  and the value is attribute type.
102
108
  """
103
109
  return {
104
- 'page_type': (str,), # noqa: E501
105
- 'environments': ([str],), # noqa: E501
110
+ 'page_type': (str, none_type,), # noqa: E501
111
+ 'environments': ([str], none_type,), # noqa: E501
106
112
  }
107
113
 
108
114
  @cached_property
@@ -123,7 +129,7 @@ class PageTypeEnvironment(ModelNormal):
123
129
  @classmethod
124
130
  @convert_js_args_to_python_args
125
131
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
126
- """PageTypeEnvironment - a model defined in OpenAPI
132
+ """ExternalPageTypeEnvironment - a model defined in OpenAPI
127
133
 
128
134
  Keyword Args:
129
135
  _check_type (bool): if True, values for parameters in openapi_types
@@ -156,8 +162,8 @@ class PageTypeEnvironment(ModelNormal):
156
162
  Animal class but this time we won't travel
157
163
  through its discriminator because we passed in
158
164
  _visited_composed_classes = (Animal,)
159
- page_type (str): Creative PageType. [optional] # noqa: E501
160
- environments ([str]): List of environments per PageType. [optional] # noqa: E501
165
+ page_type (str, none_type): Creative PageType. [optional] # noqa: E501
166
+ environments ([str], none_type): List of environments per PageType. [optional] # noqa: E501
161
167
  """
162
168
 
163
169
  _check_type = kwargs.pop('_check_type', True)
@@ -210,7 +216,7 @@ class PageTypeEnvironment(ModelNormal):
210
216
 
211
217
  @convert_js_args_to_python_args
212
218
  def __init__(self, *args, **kwargs): # noqa: E501
213
- """PageTypeEnvironment - a model defined in OpenAPI
219
+ """ExternalPageTypeEnvironment - a model defined in OpenAPI
214
220
 
215
221
  Keyword Args:
216
222
  _check_type (bool): if True, values for parameters in openapi_types
@@ -243,8 +249,8 @@ class PageTypeEnvironment(ModelNormal):
243
249
  Animal class but this time we won't travel
244
250
  through its discriminator because we passed in
245
251
  _visited_composed_classes = (Animal,)
246
- page_type (str): Creative PageType. [optional] # noqa: E501
247
- environments ([str]): List of environments per PageType. [optional] # noqa: E501
252
+ page_type (str, none_type): Creative PageType. [optional] # noqa: E501
253
+ environments ([str], none_type): List of environments per PageType. [optional] # noqa: E501
248
254
  """
249
255
 
250
256
  _check_type = kwargs.pop('_check_type', True)
@@ -0,0 +1,345 @@
1
+ """
2
+ Criteo API
3
+
4
+ Criteo API - RetailMedia # noqa: E501
5
+
6
+ The version of the OpenAPI document: Preview
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+
14
+ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
15
+ ApiTypeError,
16
+ ModelComposed,
17
+ ModelNormal,
18
+ ModelSimple,
19
+ cached_property,
20
+ change_keys_js_to_python,
21
+ convert_js_args_to_python_args,
22
+ date,
23
+ datetime,
24
+ file_type,
25
+ none_type,
26
+ validate_get_composed_info,
27
+ OpenApiModel
28
+ )
29
+ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
+
31
+
32
+ def lazy_import():
33
+ from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2
34
+ from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2
35
+ globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2
36
+ globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2
37
+
38
+
39
+ class ExternalPreferredLineItemCreateModelV2(ModelNormal):
40
+ """NOTE: This class is auto generated by OpenAPI Generator.
41
+ Ref: https://openapi-generator.tech
42
+
43
+ Do not edit the class manually.
44
+
45
+ Attributes:
46
+ allowed_values (dict): The key is the tuple path to the attribute
47
+ and the for var_name this is (var_name,). The value is a dict
48
+ with a capitalized key describing the allowed value and an allowed
49
+ value. These dicts store the allowed enum values.
50
+ attribute_map (dict): The key is attribute name
51
+ and the value is json key in definition.
52
+ discriminator_value_class_map (dict): A dict to go from the discriminator
53
+ variable value to the discriminator class name.
54
+ validations (dict): The key is the tuple path to the attribute
55
+ and the for var_name this is (var_name,). The value is a dict
56
+ that stores validations for max_length, min_length, max_items,
57
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
58
+ inclusive_minimum, and regex.
59
+ additional_properties_type (tuple): A tuple of classes accepted
60
+ as additional properties values.
61
+ """
62
+
63
+ allowed_values = {
64
+ ('pacing',): {
65
+ 'UNKNOWN': "unknown",
66
+ 'STANDARD': "standard",
67
+ 'ACCELERATED': "accelerated",
68
+ },
69
+ ('status',): {
70
+ 'UNKNOWN': "unknown",
71
+ 'ACTIVE': "active",
72
+ 'SCHEDULED': "scheduled",
73
+ 'DRAFT': "draft",
74
+ 'PAUSED': "paused",
75
+ 'BUDGETHIT': "budgetHit",
76
+ 'ENDED': "ended",
77
+ 'ARCHIVED': "archived",
78
+ 'NOFUNDS': "noFunds",
79
+ },
80
+ }
81
+
82
+ validations = {
83
+ ('name',): {
84
+ 'max_length': 255,
85
+ 'min_length': 0,
86
+ },
87
+ }
88
+
89
+ @cached_property
90
+ def additional_properties_type():
91
+ """
92
+ This must be a method because a model may have properties that are
93
+ of type self, this must run after the class is loaded
94
+ """
95
+ lazy_import()
96
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
97
+
98
+ _nullable = False
99
+
100
+ @cached_property
101
+ def openapi_types():
102
+ """
103
+ This must be a method because a model may have properties that are
104
+ of type self, this must run after the class is loaded
105
+
106
+ Returns
107
+ openapi_types (dict): The key is attribute name
108
+ and the value is attribute type.
109
+ """
110
+ lazy_import()
111
+ return {
112
+ 'name': (str,), # noqa: E501
113
+ 'start_date': (date,), # noqa: E501
114
+ 'end_date': (date,), # noqa: E501
115
+ 'pacing': (str,), # noqa: E501
116
+ 'page': (ExternalLineItemPageV2,), # noqa: E501
117
+ 'target_retailer_id': (str,), # noqa: E501
118
+ 'budget': (float,), # noqa: E501
119
+ 'status': (str,), # noqa: E501
120
+ 'capping': (ExternalLineItemCappingV2,), # noqa: E501
121
+ 'creative_id': (str, none_type,), # noqa: E501
122
+ }
123
+
124
+ @cached_property
125
+ def discriminator():
126
+ return None
127
+
128
+
129
+ attribute_map = {
130
+ 'name': 'name', # noqa: E501
131
+ 'start_date': 'startDate', # noqa: E501
132
+ 'end_date': 'endDate', # noqa: E501
133
+ 'pacing': 'pacing', # noqa: E501
134
+ 'page': 'page', # noqa: E501
135
+ 'target_retailer_id': 'targetRetailerId', # noqa: E501
136
+ 'budget': 'budget', # noqa: E501
137
+ 'status': 'status', # noqa: E501
138
+ 'capping': 'capping', # noqa: E501
139
+ 'creative_id': 'creativeId', # noqa: E501
140
+ }
141
+
142
+ read_only_vars = {
143
+ }
144
+
145
+ _composed_schemas = {}
146
+
147
+ @classmethod
148
+ @convert_js_args_to_python_args
149
+ def _from_openapi_data(cls, name, start_date, end_date, pacing, page, target_retailer_id, budget, *args, **kwargs): # noqa: E501
150
+ """ExternalPreferredLineItemCreateModelV2 - a model defined in OpenAPI
151
+
152
+ Args:
153
+ name (str):
154
+ start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
155
+ end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
156
+ pacing (str): Line Item Pacing Enum
157
+ page (ExternalLineItemPageV2):
158
+ target_retailer_id (str):
159
+ budget (float):
160
+
161
+ Keyword Args:
162
+ _check_type (bool): if True, values for parameters in openapi_types
163
+ will be type checked and a TypeError will be
164
+ raised if the wrong type is input.
165
+ Defaults to True
166
+ _path_to_item (tuple/list): This is a list of keys or values to
167
+ drill down to the model in received_data
168
+ when deserializing a response
169
+ _spec_property_naming (bool): True if the variable names in the input data
170
+ are serialized names, as specified in the OpenAPI document.
171
+ False if the variable names in the input data
172
+ are pythonic names, e.g. snake case (default)
173
+ _configuration (Configuration): the instance to use when
174
+ deserializing a file_type parameter.
175
+ If passed, type conversion is attempted
176
+ If omitted no type conversion is done.
177
+ _visited_composed_classes (tuple): This stores a tuple of
178
+ classes that we have traveled through so that
179
+ if we see that class again we will not use its
180
+ discriminator again.
181
+ When traveling through a discriminator, the
182
+ composed schema that is
183
+ is traveled through is added to this set.
184
+ For example if Animal has a discriminator
185
+ petType and we pass in "Dog", and the class Dog
186
+ allOf includes Animal, we move through Animal
187
+ once using the discriminator, and pick Dog.
188
+ Then in Dog, we will make an instance of the
189
+ Animal class but this time we won't travel
190
+ through its discriminator because we passed in
191
+ _visited_composed_classes = (Animal,)
192
+ status (str): Line Item Status Enum. [optional] # noqa: E501
193
+ capping (ExternalLineItemCappingV2): [optional] # noqa: E501
194
+ creative_id (str, none_type): [optional] # noqa: E501
195
+ """
196
+
197
+ _check_type = kwargs.pop('_check_type', True)
198
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
199
+ _path_to_item = kwargs.pop('_path_to_item', ())
200
+ _configuration = kwargs.pop('_configuration', None)
201
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
202
+
203
+ self = super(OpenApiModel, cls).__new__(cls)
204
+
205
+ if args:
206
+ for arg in args:
207
+ if isinstance(arg, dict):
208
+ kwargs.update(arg)
209
+ else:
210
+ raise ApiTypeError(
211
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
212
+ args,
213
+ self.__class__.__name__,
214
+ ),
215
+ path_to_item=_path_to_item,
216
+ valid_classes=(self.__class__,),
217
+ )
218
+
219
+ self._data_store = {}
220
+ self._check_type = _check_type
221
+ self._spec_property_naming = _spec_property_naming
222
+ self._path_to_item = _path_to_item
223
+ self._configuration = _configuration
224
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
225
+
226
+ self.name = name
227
+ self.start_date = start_date
228
+ self.end_date = end_date
229
+ self.pacing = pacing
230
+ self.page = page
231
+ self.target_retailer_id = target_retailer_id
232
+ self.budget = budget
233
+ for var_name, var_value in kwargs.items():
234
+ if var_name not in self.attribute_map and \
235
+ self._configuration is not None and \
236
+ self._configuration.discard_unknown_keys and \
237
+ self.additional_properties_type is None:
238
+ # discard variable.
239
+ continue
240
+ setattr(self, var_name, var_value)
241
+ return self
242
+
243
+ required_properties = set([
244
+ '_data_store',
245
+ '_check_type',
246
+ '_spec_property_naming',
247
+ '_path_to_item',
248
+ '_configuration',
249
+ '_visited_composed_classes',
250
+ ])
251
+
252
+ @convert_js_args_to_python_args
253
+ def __init__(self, name, start_date, end_date, pacing, page, target_retailer_id, budget, *args, **kwargs): # noqa: E501
254
+ """ExternalPreferredLineItemCreateModelV2 - a model defined in OpenAPI
255
+
256
+ Args:
257
+ name (str):
258
+ start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
259
+ end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
260
+ pacing (str): Line Item Pacing Enum
261
+ page (ExternalLineItemPageV2):
262
+ target_retailer_id (str):
263
+ budget (float):
264
+
265
+ Keyword Args:
266
+ _check_type (bool): if True, values for parameters in openapi_types
267
+ will be type checked and a TypeError will be
268
+ raised if the wrong type is input.
269
+ Defaults to True
270
+ _path_to_item (tuple/list): This is a list of keys or values to
271
+ drill down to the model in received_data
272
+ when deserializing a response
273
+ _spec_property_naming (bool): True if the variable names in the input data
274
+ are serialized names, as specified in the OpenAPI document.
275
+ False if the variable names in the input data
276
+ are pythonic names, e.g. snake case (default)
277
+ _configuration (Configuration): the instance to use when
278
+ deserializing a file_type parameter.
279
+ If passed, type conversion is attempted
280
+ If omitted no type conversion is done.
281
+ _visited_composed_classes (tuple): This stores a tuple of
282
+ classes that we have traveled through so that
283
+ if we see that class again we will not use its
284
+ discriminator again.
285
+ When traveling through a discriminator, the
286
+ composed schema that is
287
+ is traveled through is added to this set.
288
+ For example if Animal has a discriminator
289
+ petType and we pass in "Dog", and the class Dog
290
+ allOf includes Animal, we move through Animal
291
+ once using the discriminator, and pick Dog.
292
+ Then in Dog, we will make an instance of the
293
+ Animal class but this time we won't travel
294
+ through its discriminator because we passed in
295
+ _visited_composed_classes = (Animal,)
296
+ status (str): Line Item Status Enum. [optional] # noqa: E501
297
+ capping (ExternalLineItemCappingV2): [optional] # noqa: E501
298
+ creative_id (str, none_type): [optional] # noqa: E501
299
+ """
300
+
301
+ _check_type = kwargs.pop('_check_type', True)
302
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
303
+ _path_to_item = kwargs.pop('_path_to_item', ())
304
+ _configuration = kwargs.pop('_configuration', None)
305
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
306
+
307
+ if args:
308
+ for arg in args:
309
+ if isinstance(arg, dict):
310
+ kwargs.update(arg)
311
+ else:
312
+ raise ApiTypeError(
313
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
314
+ args,
315
+ self.__class__.__name__,
316
+ ),
317
+ path_to_item=_path_to_item,
318
+ valid_classes=(self.__class__,),
319
+ )
320
+
321
+ self._data_store = {}
322
+ self._check_type = _check_type
323
+ self._spec_property_naming = _spec_property_naming
324
+ self._path_to_item = _path_to_item
325
+ self._configuration = _configuration
326
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
327
+
328
+ self.name = name
329
+ self.start_date = start_date
330
+ self.end_date = end_date
331
+ self.pacing = pacing
332
+ self.page = page
333
+ self.target_retailer_id = target_retailer_id
334
+ self.budget = budget
335
+ for var_name, var_value in kwargs.items():
336
+ if var_name not in self.attribute_map and \
337
+ self._configuration is not None and \
338
+ self._configuration.discard_unknown_keys and \
339
+ self.additional_properties_type is None:
340
+ # discard variable.
341
+ continue
342
+ setattr(self, var_name, var_value)
343
+ if var_name in self.read_only_vars:
344
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
345
+ f"class with read only attributes.")
@@ -29,8 +29,14 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
29
29
  from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
+ def lazy_import():
33
+ from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2
34
+ from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2
35
+ globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2
36
+ globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2
32
37
 
33
- class ExternalCatalogStatus(ModelNormal):
38
+
39
+ class ExternalPreferredLineItemUpdateModelV2(ModelNormal):
34
40
  """NOTE: This class is auto generated by OpenAPI Generator.
35
41
  Ref: https://openapi-generator.tech
36
42
 
@@ -57,14 +63,27 @@ class ExternalCatalogStatus(ModelNormal):
57
63
  allowed_values = {
58
64
  ('status',): {
59
65
  'UNKNOWN': "unknown",
60
- 'PENDING': "pending",
61
- 'SUCCESS': "success",
62
- 'FAILURE': "failure",
63
- 'EXPIRED': "expired",
66
+ 'ACTIVE': "active",
67
+ 'SCHEDULED': "scheduled",
68
+ 'DRAFT': "draft",
69
+ 'PAUSED': "paused",
70
+ 'BUDGETHIT': "budgetHit",
71
+ 'ENDED': "ended",
72
+ 'ARCHIVED': "archived",
73
+ 'NOFUNDS': "noFunds",
74
+ },
75
+ ('pacing',): {
76
+ 'UNKNOWN': "unknown",
77
+ 'STANDARD': "standard",
78
+ 'ACCELERATED': "accelerated",
64
79
  },
65
80
  }
66
81
 
67
82
  validations = {
83
+ ('name',): {
84
+ 'max_length': 255,
85
+ 'min_length': 0,
86
+ },
68
87
  }
69
88
 
70
89
  @cached_property
@@ -73,6 +92,7 @@ class ExternalCatalogStatus(ModelNormal):
73
92
  This must be a method because a model may have properties that are
74
93
  of type self, this must run after the class is loaded
75
94
  """
95
+ lazy_import()
76
96
  return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
77
97
 
78
98
  _nullable = False
@@ -87,14 +107,17 @@ class ExternalCatalogStatus(ModelNormal):
87
107
  openapi_types (dict): The key is attribute name
88
108
  and the value is attribute type.
89
109
  """
110
+ lazy_import()
90
111
  return {
112
+ 'name': (str,), # noqa: E501
113
+ 'start_date': (date,), # noqa: E501
114
+ 'end_date': (date,), # noqa: E501
91
115
  'status': (str,), # noqa: E501
92
- 'currency': (str,), # noqa: E501
93
- 'row_count': (int, none_type,), # noqa: E501
94
- 'file_size_bytes': (int, none_type,), # noqa: E501
95
- 'md5_checksum': (str, none_type,), # noqa: E501
96
- 'created_at': (datetime,), # noqa: E501
97
- 'message': (str, none_type,), # noqa: E501
116
+ 'pacing': (str,), # noqa: E501
117
+ 'capping': (ExternalLineItemCappingV2,), # noqa: E501
118
+ 'page': (ExternalLineItemPageV2,), # noqa: E501
119
+ 'budget': (float,), # noqa: E501
120
+ 'creative_id': (str, none_type,), # noqa: E501
98
121
  }
99
122
 
100
123
  @cached_property
@@ -103,13 +126,15 @@ class ExternalCatalogStatus(ModelNormal):
103
126
 
104
127
 
105
128
  attribute_map = {
129
+ 'name': 'name', # noqa: E501
130
+ 'start_date': 'startDate', # noqa: E501
131
+ 'end_date': 'endDate', # noqa: E501
106
132
  'status': 'status', # noqa: E501
107
- 'currency': 'currency', # noqa: E501
108
- 'row_count': 'rowCount', # noqa: E501
109
- 'file_size_bytes': 'fileSizeBytes', # noqa: E501
110
- 'md5_checksum': 'md5Checksum', # noqa: E501
111
- 'created_at': 'createdAt', # noqa: E501
112
- 'message': 'message', # noqa: E501
133
+ 'pacing': 'pacing', # noqa: E501
134
+ 'capping': 'capping', # noqa: E501
135
+ 'page': 'page', # noqa: E501
136
+ 'budget': 'budget', # noqa: E501
137
+ 'creative_id': 'creativeId', # noqa: E501
113
138
  }
114
139
 
115
140
  read_only_vars = {
@@ -119,17 +144,14 @@ class ExternalCatalogStatus(ModelNormal):
119
144
 
120
145
  @classmethod
121
146
  @convert_js_args_to_python_args
122
- def _from_openapi_data(cls, status, currency, row_count, file_size_bytes, md5_checksum, created_at, message, *args, **kwargs): # noqa: E501
123
- """ExternalCatalogStatus - a model defined in OpenAPI
147
+ def _from_openapi_data(cls, name, start_date, end_date, status, *args, **kwargs): # noqa: E501
148
+ """ExternalPreferredLineItemUpdateModelV2 - a model defined in OpenAPI
124
149
 
125
150
  Args:
126
- status (str): An enumeration of the status of the catalog.
127
- currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
128
- row_count (int, none_type): An indication of the number of products contained in this catalog. Available when this catalog reaches a success status.
129
- file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
130
- md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status.
131
- created_at (datetime): The time this catalog was created. Represented as a UTC ISO8601 string.
132
- message (str, none_type): An optional information message intended for developer consumption.
151
+ name (str):
152
+ start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
153
+ end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
154
+ status (str): Line Item Status Enum
133
155
 
134
156
  Keyword Args:
135
157
  _check_type (bool): if True, values for parameters in openapi_types
@@ -162,6 +184,11 @@ class ExternalCatalogStatus(ModelNormal):
162
184
  Animal class but this time we won't travel
163
185
  through its discriminator because we passed in
164
186
  _visited_composed_classes = (Animal,)
187
+ pacing (str): [optional] if omitted the server will use the default value of "accelerated" # noqa: E501
188
+ capping (ExternalLineItemCappingV2): [optional] # noqa: E501
189
+ page (ExternalLineItemPageV2): [optional] # noqa: E501
190
+ budget (float): [optional] # noqa: E501
191
+ creative_id (str, none_type): [optional] # noqa: E501
165
192
  """
166
193
 
167
194
  _check_type = kwargs.pop('_check_type', True)
@@ -193,13 +220,10 @@ class ExternalCatalogStatus(ModelNormal):
193
220
  self._configuration = _configuration
194
221
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
195
222
 
223
+ self.name = name
224
+ self.start_date = start_date
225
+ self.end_date = end_date
196
226
  self.status = status
197
- self.currency = currency
198
- self.row_count = row_count
199
- self.file_size_bytes = file_size_bytes
200
- self.md5_checksum = md5_checksum
201
- self.created_at = created_at
202
- self.message = message
203
227
  for var_name, var_value in kwargs.items():
204
228
  if var_name not in self.attribute_map and \
205
229
  self._configuration is not None and \
@@ -220,17 +244,14 @@ class ExternalCatalogStatus(ModelNormal):
220
244
  ])
221
245
 
222
246
  @convert_js_args_to_python_args
223
- def __init__(self, status, currency, row_count, file_size_bytes, md5_checksum, created_at, message, *args, **kwargs): # noqa: E501
224
- """ExternalCatalogStatus - a model defined in OpenAPI
247
+ def __init__(self, name, start_date, end_date, status, *args, **kwargs): # noqa: E501
248
+ """ExternalPreferredLineItemUpdateModelV2 - a model defined in OpenAPI
225
249
 
226
250
  Args:
227
- status (str): An enumeration of the status of the catalog.
228
- currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
229
- row_count (int, none_type): An indication of the number of products contained in this catalog. Available when this catalog reaches a success status.
230
- file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
231
- md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status.
232
- created_at (datetime): The time this catalog was created. Represented as a UTC ISO8601 string.
233
- message (str, none_type): An optional information message intended for developer consumption.
251
+ name (str):
252
+ start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
253
+ end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
254
+ status (str): Line Item Status Enum
234
255
 
235
256
  Keyword Args:
236
257
  _check_type (bool): if True, values for parameters in openapi_types
@@ -263,6 +284,11 @@ class ExternalCatalogStatus(ModelNormal):
263
284
  Animal class but this time we won't travel
264
285
  through its discriminator because we passed in
265
286
  _visited_composed_classes = (Animal,)
287
+ pacing (str): [optional] if omitted the server will use the default value of "accelerated" # noqa: E501
288
+ capping (ExternalLineItemCappingV2): [optional] # noqa: E501
289
+ page (ExternalLineItemPageV2): [optional] # noqa: E501
290
+ budget (float): [optional] # noqa: E501
291
+ creative_id (str, none_type): [optional] # noqa: E501
266
292
  """
267
293
 
268
294
  _check_type = kwargs.pop('_check_type', True)
@@ -292,13 +318,10 @@ class ExternalCatalogStatus(ModelNormal):
292
318
  self._configuration = _configuration
293
319
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
294
320
 
321
+ self.name = name
322
+ self.start_date = start_date
323
+ self.end_date = end_date
295
324
  self.status = status
296
- self.currency = currency
297
- self.row_count = row_count
298
- self.file_size_bytes = file_size_bytes
299
- self.md5_checksum = md5_checksum
300
- self.created_at = created_at
301
- self.message = message
302
325
  for var_name, var_value in kwargs.items():
303
326
  if var_name not in self.attribute_map and \
304
327
  self._configuration is not None and \