criteo-api-commercegrid-sdk-experimental 0.0.261030__tar.gz

criteo_api_commercegrid_sdk_experimental-0.0.261030/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: criteo-api-commercegrid-sdk-experimental
+Version: 0.0.261030
+Summary: Criteo API SDK
+Home-page: https://github.com/criteo/criteo-api-python-sdk
+Author: Criteo
+Author-email: 
+Keywords: Criteo,OpenAPI-Generator,Criteo API SDK
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: python-dateutil
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Criteo API SDK for Python
+
+IMPORTANT: This Python package links to Criteo production environment. Any test applied here will thus impact real data.
+
+## Installation & Usage
+### pip install
+
+
+```sh
+pip install criteo-api-commercegrid-sdk-experimental==0.0.261030
+```
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-commercegrid-sdk-experimental==0.0.261030`)
+
+Then import the package:
+```python
+import criteo_api_commercegrid_experimental
+```
+
+Full documentation on [Github](https://github.com/criteo/criteo-api-python-sdk).
+
+## Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

criteo_api_commercegrid_sdk_experimental-0.0.261030/README.md

@@ -0,0 +1,110 @@
+# Criteo API SDK for Python
+
+## Introduction
+API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients.
+These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues.
+
+More information on how to use Criteo API and these SDKs can be found at: [https://developers.criteo.com/](https://developers.criteo.com/).
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- Package version: 0.0.261030
+
+## Requirements
+
+Python 2.7 and 3.5+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install criteo-api-commercegrid-sdk-experimental==0.0.261030
+```
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-commercegrid-sdk-experimental==0.0.261030`)
+
+Then import the package:
+```python
+import criteo_api_commercegrid_experimental
+```
+
+### Manual Installation using [Setuptools](http://pypi.python.org/pypi/setuptools)
+
+Download the code or clone the repository locally, then execute the following command:
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import criteo_api_commercegrid_experimental
+```
+
+## Example
+There are multiple examples for the different OAuth flows that the SDK supports.
+- See [test/example_application_with_client_credentials.py](test/example_application_with_client_credentials.py) for an example with Client Credentials.
+- See [test/example_application_with_auth_code.py](test/example_application_with_auth_code.py) for an example with Authorization Code.
+Once you follow the authorization code flow, you will have a refresh token that has to be used to regenerate access token for future usage. 
+    - See [test/example_application_with_refresh_token.py](test/example_application_with_refresh_token.py) for an example with Refresh Token .
+
+## Documentation for API Endpoints
+
+The developers documentation is available at: *https://developers.criteo.com*.
+
+All URIs are relative to *https://api.criteo.com*.
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*GatewayApi* | [**get_current_application**](docs/GatewayApi.md#get_current_application) | **GET** /experimental/commerce-grid/me | /experimental/commerce-grid/me
+*SegmentApi* | [**add_remove_contact_list_by_audience_segment**](docs/SegmentApi.md#add_remove_contact_list_by_audience_segment) | **POST** /experimental/commerce-grid/audience-segments/{audience-segment-id}/contact-list/add-remove | /experimental/commerce-grid/audience-segments/{audience-segment-id}/contact-list/add-remove
+*SegmentApi* | [**bulk_create_audience_segments**](docs/SegmentApi.md#bulk_create_audience_segments) | **POST** /experimental/commerce-grid/audience-segments/create | /experimental/commerce-grid/audience-segments/create
+*SegmentApi* | [**bulk_delete_audience_segments**](docs/SegmentApi.md#bulk_delete_audience_segments) | **POST** /experimental/commerce-grid/audience-segments/delete | /experimental/commerce-grid/audience-segments/delete
+*SegmentApi* | [**bulk_update_audience_segments**](docs/SegmentApi.md#bulk_update_audience_segments) | **PATCH** /experimental/commerce-grid/audience-segments | /experimental/commerce-grid/audience-segments
+*SegmentApi* | [**clear_contact_list_by_audience_segment**](docs/SegmentApi.md#clear_contact_list_by_audience_segment) | **POST** /experimental/commerce-grid/audience-segments/{audience-segment-id}/contact-list/clear | /experimental/commerce-grid/audience-segments/{audience-segment-id}/contact-list/clear
+*SegmentApi* | [**get_audience_segment_contact_list_statistics**](docs/SegmentApi.md#get_audience_segment_contact_list_statistics) | **GET** /experimental/commerce-grid/audience-segments/{audience-segment-id}/contact-list/statistics | /experimental/commerce-grid/audience-segments/{audience-segment-id}/contact-list/statistics
+*SegmentApi* | [**search_audience_segments**](docs/SegmentApi.md#search_audience_segments) | **POST** /experimental/commerce-grid/audience-segments/search | /experimental/commerce-grid/audience-segments/search
+
+
+## Documentation For Models
+
+ - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md)
+ - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md)
+ - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md)
+ - [AudienceError](docs/AudienceError.md)
+ - [AudienceWarning](docs/AudienceWarning.md)
+ - [CgAudienceSegmentBulkCreateInputV1](docs/CgAudienceSegmentBulkCreateInputV1.md)
+ - [CgAudienceSegmentBulkDeleteInputV1](docs/CgAudienceSegmentBulkDeleteInputV1.md)
+ - [CgAudienceSegmentBulkUpdateInputV1](docs/CgAudienceSegmentBulkUpdateInputV1.md)
+ - [CgAudienceSegmentCreateEntityV1](docs/CgAudienceSegmentCreateEntityV1.md)
+ - [CgAudienceSegmentCreateEntityV1Resource](docs/CgAudienceSegmentCreateEntityV1Resource.md)
+ - [CgAudienceSegmentDeleteEntityV1Resource](docs/CgAudienceSegmentDeleteEntityV1Resource.md)
+ - [CgAudienceSegmentEntityV1](docs/CgAudienceSegmentEntityV1.md)
+ - [CgAudienceSegmentEntityV1CgAudienceSegmentSearchMetadataV1ListResponse](docs/CgAudienceSegmentEntityV1CgAudienceSegmentSearchMetadataV1ListResponse.md)
+ - [CgAudienceSegmentEntityV1ListResponse](docs/CgAudienceSegmentEntityV1ListResponse.md)
+ - [CgAudienceSegmentEntityV1Resource](docs/CgAudienceSegmentEntityV1Resource.md)
+ - [CgAudienceSegmentIdEntityV1ListResponse](docs/CgAudienceSegmentIdEntityV1ListResponse.md)
+ - [CgAudienceSegmentIdEntityV1Resource](docs/CgAudienceSegmentIdEntityV1Resource.md)
+ - [CgAudienceSegmentSearchEntityV1](docs/CgAudienceSegmentSearchEntityV1.md)
+ - [CgAudienceSegmentSearchEntityV1Resource](docs/CgAudienceSegmentSearchEntityV1Resource.md)
+ - [CgAudienceSegmentSearchInputV1](docs/CgAudienceSegmentSearchInputV1.md)
+ - [CgAudienceSegmentSearchMetadataV1](docs/CgAudienceSegmentSearchMetadataV1.md)
+ - [CgAudienceSegmentUpdateEntityV1](docs/CgAudienceSegmentUpdateEntityV1.md)
+ - [CgAudienceSegmentUpdateEntityV1Resource](docs/CgAudienceSegmentUpdateEntityV1Resource.md)
+ - [CgContactListCreateV1](docs/CgContactListCreateV1.md)
+ - [CgContactListStatisticsEntityV1](docs/CgContactListStatisticsEntityV1.md)
+ - [CgContactListStatisticsEntityV1Resource](docs/CgContactListStatisticsEntityV1Resource.md)
+ - [CgContactListStatisticsEntityV1Response](docs/CgContactListStatisticsEntityV1Response.md)
+ - [CommerceGridContactlistAmendment](docs/CommerceGridContactlistAmendment.md)
+ - [CommerceGridContactlistAmendmentAttributes](docs/CommerceGridContactlistAmendmentAttributes.md)
+ - [CommerceGridContactlistAmendmentRequest](docs/CommerceGridContactlistAmendmentRequest.md)
+ - [CommerceGridContactlistOperation](docs/CommerceGridContactlistOperation.md)
+ - [CommerceGridContactlistOperationResponseAttributes](docs/CommerceGridContactlistOperationResponseAttributes.md)
+ - [CommerceGridContactlistOperationResponseAttributesAttributes](docs/CommerceGridContactlistOperationResponseAttributesAttributes.md)
+ - [CommonProblem](docs/CommonProblem.md)
+ - [NillableString](docs/NillableString.md)
+
+
+## Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

criteo_api_commercegrid_sdk_experimental-0.0.261030/criteo_api_commercegrid_experimental/__init__.py

@@ -0,0 +1,31 @@
+"""
+    Criteo API
+
+    Criteo API - CommerceGrid  # noqa: E501
+
+    The version of the OpenAPI document: Experimental
+    Generated by: https://openapi-generator.tech
+"""
+
+
+__version__ = "0.0.261030"
+
+# import ApiClient
+from criteo_api_commercegrid_experimental.api_client import ApiClient
+from criteo_api_commercegrid_experimental.criteo_api_client import CriteoApiClient
+from criteo_api_commercegrid_experimental.api_client_builder import ApiClientBuilder
+from criteo_api_commercegrid_experimental import flow_constants
+
+# import Configuration
+from criteo_api_commercegrid_experimental.configuration import Configuration
+
+# import exceptions
+from criteo_api_commercegrid_experimental.exceptions import OpenApiException
+from criteo_api_commercegrid_experimental.exceptions import ApiAttributeError
+from criteo_api_commercegrid_experimental.exceptions import ApiTypeError
+from criteo_api_commercegrid_experimental.exceptions import ApiValueError
+from criteo_api_commercegrid_experimental.exceptions import ApiKeyError
+from criteo_api_commercegrid_experimental.exceptions import ApiException
+
+
+

criteo_api_commercegrid_sdk_experimental-0.0.261030/criteo_api_commercegrid_experimental/api/__init__.py

@@ -0,0 +1,3 @@
+# do not import all apis into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all apis from one package, import them with
+# from criteo_api_commercegrid_experimental.apis import GatewayApi

criteo_api_commercegrid_sdk_experimental-0.0.261030/criteo_api_commercegrid_experimental/api/gateway_api.py

@@ -0,0 +1,161 @@
+"""
+    Criteo API
+
+    Criteo API - CommerceGrid  # noqa: E501
+
+    The version of the OpenAPI document: Experimental
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_commercegrid_experimental.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_commercegrid_experimental.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from criteo_api_commercegrid_experimental.model.application_summary_model_response import ApplicationSummaryModelResponse
+
+
+class GatewayApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.get_current_application_endpoint = _Endpoint(
+            settings={
+                'response_type': (ApplicationSummaryModelResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/experimental/commerce-grid/me',
+                'operation_id': 'get_current_application',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+    def get_current_application(
+        self,
+        **kwargs
+    ):
+        """/experimental/commerce-grid/me  # noqa: E501
+
+        Get information about the currently logged application  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_current_application(async_req=True)
+        >>> result = thread.get()
+
+
+        Keyword Args:
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            ApplicationSummaryModelResponse
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        return self.get_current_application_endpoint.call_with_http_info(**kwargs)
+