version 5.1.0

Author: klaviyo-sdk

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
 
+## [5.1.0] - revision 2023-08-15
+### Added
+- Flow Message Templates
+- You can now retrieve the templates associated with flow messages using `Flows.get_flow_message_template()` or `Flows.get_flow_message_relationships_template()` . You’re also able to include the template HTML for a flow message using `Flows.get_flow_message(id, include=['template'])`.
+- Create or Update Push Tokens
+- We have added an endpoint to create or update push tokens, `Profiles.create_push_token()`. This endpoint can be used to migrate profiles and their push tokens from another platform to Klaviyo. If you’re looking to register push tokens from users’ devices, please use our mobile SDKs.
+
 ## [5.0.0] - revision 2023-07-15
 
 ### Changed
@@ -131,4 +138,4 @@ NOTE: For more granular API-specific changes, please see our [API Changelog](htt
   - client name: `Client` → `KlaviyoAPI`
   - Client variable name in readme examples: `client` → `klaviyo`
   - Some functions have changed name
-- New resources and endpoints: see [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) for full details
+- New resources and endpoints: see [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) for full details

README.md

@@ -30,7 +30,7 @@ class KlaviyoAPI:
     max_retries: int = 3
     test_host: str = ''
 
-    _REVISION = "2023-07-15"
+    _REVISION = "2023-08-15"
 
     _STATUS_CODE_CONNECTION_RESET_BY_PEER = 104
     _STATUS_CODE_TOO_MANY_REQUESTS = 429
@@ -206,6 +206,8 @@ def __post_init__(self):
         self.Flows.get_flow_message=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_message))
         self.Flows.get_flow_message_action=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_message_action))
         self.Flows.get_flow_message_relationships_action=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_message_relationships_action))
+        self.Flows.get_flow_message_relationships_template=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_message_relationships_template))
+        self.Flows.get_flow_message_template=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_message_template))
         self.Flows.get_flow_relationships_flow_actions=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_relationships_flow_actions))
         self.Flows.get_flow_relationships_tags=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_relationships_tags))
         self.Flows.get_flow_tags=self._page_cursor_update(self.retry_logic(self.Flows.get_flow_tags))
@@ -244,6 +246,7 @@ def __post_init__(self):
 
         ## Applying tenacity retry decorator to each endpoint in Profiles
         self.Profiles.create_profile=self._page_cursor_update(self.retry_logic(self.Profiles.create_profile))
+        self.Profiles.create_push_token=self._page_cursor_update(self.retry_logic(self.Profiles.create_push_token))
         self.Profiles.get_profile=self._page_cursor_update(self.retry_logic(self.Profiles.get_profile))
         self.Profiles.get_profile_lists=self._page_cursor_update(self.retry_logic(self.Profiles.get_profile_lists))
         self.Profiles.get_profile_relationships_lists=self._page_cursor_update(self.retry_logic(self.Profiles.get_profile_relationships_lists))

klaviyo_api/wrapper.py

@@ -7,15 +7,15 @@
 
     The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.  # noqa: E501
 
-    The version of the OpenAPI document: 2023-07-15
+    The version of the OpenAPI document: 2023-08-15
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """
 
 
-__version__ = "5.0.0"
+__version__ = "5.1.0"
 
 # import apis into sdk package
 from openapi_client.api.accounts_api import AccountsApi
@@ -165,6 +165,7 @@
 from openapi_client.models.data_privacy_deletion_job_enum import DataPrivacyDeletionJobEnum
 from openapi_client.models.data_privacy_profile_query_resource_object import DataPrivacyProfileQueryResourceObject
 from openapi_client.models.data_privacy_profile_query_resource_object_attributes import DataPrivacyProfileQueryResourceObjectAttributes
+from openapi_client.models.device_metadata import DeviceMetadata
 from openapi_client.models.event_create_query_v2 import EventCreateQueryV2
 from openapi_client.models.event_create_query_v2_resource_object import EventCreateQueryV2ResourceObject
 from openapi_client.models.event_create_query_v2_resource_object_attributes import EventCreateQueryV2ResourceObjectAttributes
@@ -220,6 +221,13 @@
 from openapi_client.models.profile_suppression_create_query_resource_object_attributes import ProfileSuppressionCreateQueryResourceObjectAttributes
 from openapi_client.models.profile_suppression_delete_query_resource_object import ProfileSuppressionDeleteQueryResourceObject
 from openapi_client.models.profile_suppression_delete_query_resource_object_attributes import ProfileSuppressionDeleteQueryResourceObjectAttributes
+from openapi_client.models.profile_upsert_query_resource_object import ProfileUpsertQueryResourceObject
+from openapi_client.models.profile_upsert_query_resource_object_attributes import ProfileUpsertQueryResourceObjectAttributes
+from openapi_client.models.push_token_create_query import PushTokenCreateQuery
+from openapi_client.models.push_token_create_query_resource_object import PushTokenCreateQueryResourceObject
+from openapi_client.models.push_token_create_query_resource_object_attributes import PushTokenCreateQueryResourceObjectAttributes
+from openapi_client.models.push_token_create_query_resource_object_attributes_profile import PushTokenCreateQueryResourceObjectAttributesProfile
+from openapi_client.models.push_token_enum import PushTokenEnum
 from openapi_client.models.render_options_sub_object import RenderOptionsSubObject
 from openapi_client.models.sto_schedule_options import STOScheduleOptions
 from openapi_client.models.segment_enum import SegmentEnum

openapi_client/__init__.py

@@ -5,7 +5,7 @@
 
     The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.  # noqa: E501
 
-    The version of the OpenAPI document: 2023-07-15
+    The version of the OpenAPI document: 2023-08-15
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -48,7 +48,7 @@ def __init__(self, api_client=None):
         self.api_client = api_client
 
     @validate_arguments
-    def get_account(self, id : Annotated[StrictStr, Field(..., description="The ID of the account")], fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> Dict[str, object]:  # noqa: E501
+    def get_account(self, id : Annotated[StrictStr, Field(..., description="The ID of the account")], fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> Dict[str, object]:  # noqa: E501
         """Get Account  # noqa: E501
 
         Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`  # noqa: E501
@@ -60,7 +60,7 @@ def get_account(self, id : Annotated[StrictStr, Field(..., description="The ID o
 
         :param id: The ID of the account (required)
         :type id: str
-        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
+        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
         :type fields_account: List[str]
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -79,7 +79,7 @@ def get_account(self, id : Annotated[StrictStr, Field(..., description="The ID o
         return self.get_account_with_http_info(id, fields_account, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def get_account_with_http_info(self, id : Annotated[StrictStr, Field(..., description="The ID of the account")], fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def get_account_with_http_info(self, id : Annotated[StrictStr, Field(..., description="The ID of the account")], fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Get Account  # noqa: E501
 
         Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`  # noqa: E501
@@ -91,7 +91,7 @@ def get_account_with_http_info(self, id : Annotated[StrictStr, Field(..., descri
 
         :param id: The ID of the account (required)
         :type id: str
-        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
+        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
         :type fields_account: List[str]
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -201,17 +201,17 @@ def get_account_with_http_info(self, id : Annotated[StrictStr, Field(..., descri
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_accounts(self, fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> Dict[str, object]:  # noqa: E501
+    def get_accounts(self, fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> Dict[str, object]:  # noqa: E501
         """Get Accounts  # noqa: E501
 
-        Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.\"<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`  # noqa: E501
+        Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.  You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`  # 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_accounts(fields_account, async_req=True)
         >>> result = thread.get()
 
-        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
+        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
         :type fields_account: List[str]
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -230,17 +230,17 @@ def get_accounts(self, fields_account : Annotated[Optional[conlist(StrictStr)],
         return self.get_accounts_with_http_info(fields_account, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def get_accounts_with_http_info(self, fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def get_accounts_with_http_info(self, fields_account : Annotated[Optional[conlist(StrictStr)], Field(description="For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Get Accounts  # noqa: E501
 
-        Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.\"<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`  # noqa: E501
+        Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.  You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`  # 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_accounts_with_http_info(fields_account, async_req=True)
         >>> result = thread.get()
 
-        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
+        :param fields_account: For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
         :type fields_account: List[str]
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional