Merge pull request #13 from klaviyo/20230301-weekly

added page_size

Author: jon-batscha

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
 
+## 1.3.0
+
+### Added
+- `page_size`:  you can now set page_size when paging through endpoints that return profiles
+
 ## 1.2.1
 
 ### Bug Fixes

README.md

@@ -1,6 +1,6 @@
 # Klaviyo Python SDK
 
-- SDK version: 1.2.1
+- SDK version: 1.3.0
 - API revision: 2023-02-22
 
 ## Helpful Resources
@@ -177,7 +177,7 @@ klaviyo.Campaigns.create_campaign_clone(body)
 
 
 
-#### [Create Campaign Message Assign Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
+#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
 
 ```python
 ## Positional Arguments
@@ -1743,8 +1743,9 @@ klaviyo.Lists.get_list(id, fields_list=fields_list)
 # fields_profile | [str]
 # filter | str
 # page_cursor | str
+# page_size | int
 
-klaviyo.Lists.get_list_profiles(list_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor)
+klaviyo.Lists.get_list_profiles(list_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size)
 ```
 
 
@@ -1960,8 +1961,9 @@ klaviyo.Profiles.get_profile_segments(profile_id, fields_segment=fields_segment)
 # filter | str
 # page_cursor | str
 # sort | str
+# page_size | int
 
-klaviyo.Profiles.get_profiles(fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, sort=sort)
+klaviyo.Profiles.get_profiles(fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, sort=sort, page_size=page_size)
 ```
 
 
@@ -2066,8 +2068,9 @@ klaviyo.Segments.get_segment(id, fields_segment=fields_segment)
 # fields_profile | [str]
 # filter | str
 # page_cursor | str
+# page_size | int
 
-klaviyo.Segments.get_segment_profiles(segment_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor)
+klaviyo.Segments.get_segment_profiles(segment_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size)
 ```
 
 

openapi_client/__init__.py

@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "1.2.1"
+__version__ = "1.3.0"
 
 # import ApiClient
 from openapi_client.api_client import ApiClient

openapi_client/api/campaigns_api.py

@@ -1328,7 +1328,7 @@ def create_campaign_message_assign_template(
         campaign_message_assign_template_query,
         **kwargs
     ):
-        """Create Campaign Message Assign Template  # noqa: E501
+        """Assign Campaign Message Template  # noqa: E501
 
         Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Campaigns Write`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an

openapi_client/api/catalogs_api.py

@@ -4324,7 +4324,7 @@ def delete_catalog_category(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -4498,7 +4498,7 @@ def delete_catalog_item(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -4672,7 +4672,7 @@ def delete_catalog_variant(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -4837,7 +4837,7 @@ def get_catalog_category(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             fields_catalog_category ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
@@ -4921,7 +4921,7 @@ def get_catalog_category_items(
         >>> result = thread.get()
 
         Args:
-            category_id (str): The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            category_id (str): The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             fields_catalog_item ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
@@ -5098,7 +5098,7 @@ def get_catalog_item(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             fields_catalog_item ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
@@ -5184,7 +5184,7 @@ def get_catalog_item_categories(
         >>> result = thread.get()
 
         Args:
-            item_id (str): The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            item_id (str): The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             fields_catalog_category ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
@@ -5359,7 +5359,7 @@ def get_catalog_item_variants(
         >>> result = thread.get()
 
         Args:
-            item_id (str): The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            item_id (str): The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             fields_catalog_variant ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
@@ -5530,7 +5530,7 @@ def get_catalog_variant(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
 
         Keyword Args:
             fields_catalog_variant ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
@@ -7941,7 +7941,7 @@ def update_catalog_category(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
             catalog_category_update_query (CatalogCategoryUpdateQuery):
 
         Keyword Args:
@@ -8119,7 +8119,7 @@ def update_catalog_item(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
             catalog_item_update_query (CatalogItemUpdateQuery):
 
         Keyword Args:
@@ -8297,7 +8297,7 @@ def update_catalog_variant(
         >>> result = thread.get()
 
         Args:
-            id (str): The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
+            id (str): The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
             catalog_variant_update_query (CatalogVariantUpdateQuery):
 
         Keyword Args:

openapi_client/api/flows_api.py

@@ -2208,7 +2208,7 @@ def update_flow(
         >>> result = thread.get()
 
         Args:
-            id (str): 
+            id (str): ID of the Flow to update. Ex: XVTP5Q
             flow_update_query (FlowUpdateQuery):
 
         Keyword Args:

openapi_client/api/lists_api.py

@@ -364,6 +364,7 @@ def __init__(self, api_client=None):
                     'fields_profile',
                     'filter',
                     'page_cursor',
+                    'page_size',
                 ],
                 'required': [
                     'list_id',
@@ -416,18 +417,22 @@ def __init__(self, api_client=None):
                         (str,),
                     'page_cursor':
                         (str,),
+                    'page_size':
+                        (int,),
                 },
                 'attribute_map': {
                     'list_id': 'list_id',
                     'fields_profile': 'fields[profile]',
                     'filter': 'filter',
                     'page_cursor': 'page[cursor]',
+                    'page_size': 'page[size]',
                 },
                 'location_map': {
                     'list_id': 'path',
                     'fields_profile': 'query',
                     'filter': 'query',
                     'page_cursor': 'query',
+                    'page_size': 'query',
                 },
                 'collection_format_map': {
                     'fields_profile': 'csv',
@@ -1150,6 +1155,7 @@ def get_list_profiles(
             fields_profile ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
             filter (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`. [optional]
             page_cursor (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination. [optional]
+            page_size (int): [optional]
             _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

openapi_client/api/profiles_api.py

@@ -424,6 +424,7 @@ def __init__(self, api_client=None):
                     'filter',
                     'page_cursor',
                     'sort',
+                    'page_size',
                 ],
                 'required': [],
                 'nullable': [
@@ -472,7 +473,9 @@ def __init__(self, api_client=None):
                         "EMAIL": "email",
                         "-EMAIL": "-email",
                         "ID": "id",
-                        "-ID": "-id"
+                        "-ID": "-id",
+                        "UPDATED": "updated",
+                        "-UPDATED": "-updated"
                     },
                 },
                 'openapi_types': {
@@ -484,18 +487,22 @@ def __init__(self, api_client=None):
                         (str,),
                     'sort':
                         (str,),
+                    'page_size':
+                        (int,),
                 },
                 'attribute_map': {
                     'fields_profile': 'fields[profile]',
                     'filter': 'filter',
                     'page_cursor': 'page[cursor]',
                     'sort': 'sort',
+                    'page_size': 'page[size]',
                 },
                 'location_map': {
                     'fields_profile': 'query',
                     'filter': 'query',
                     'page_cursor': 'query',
                     'sort': 'query',
+                    'page_size': 'query',
                 },
                 'collection_format_map': {
                     'fields_profile': 'csv',
@@ -1207,7 +1214,7 @@ def get_profiles(
     ):
         """Get Profiles  # noqa: E501
 
-        Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `email` You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Profiles Read`  # noqa: E501
+        Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email` You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Profiles Read`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -1217,9 +1224,10 @@ def get_profiles(
 
         Keyword Args:
             fields_profile ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
-            filter (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`anonymous_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`. [optional]
+            filter (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`anonymous_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`. [optional]
             page_cursor (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination. [optional]
             sort (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting. [optional]
+            page_size (int): [optional]
             _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

openapi_client/api/segments_api.py

@@ -118,6 +118,7 @@ def __init__(self, api_client=None):
                     'fields_profile',
                     'filter',
                     'page_cursor',
+                    'page_size',
                 ],
                 'required': [
                     'segment_id',
@@ -170,18 +171,22 @@ def __init__(self, api_client=None):
                         (str,),
                     'page_cursor':
                         (str,),
+                    'page_size':
+                        (int,),
                 },
                 'attribute_map': {
                     'segment_id': 'segment_id',
                     'fields_profile': 'fields[profile]',
                     'filter': 'filter',
                     'page_cursor': 'page[cursor]',
+                    'page_size': 'page[size]',
                 },
                 'location_map': {
                     'segment_id': 'path',
                     'fields_profile': 'query',
                     'filter': 'query',
                     'page_cursor': 'query',
+                    'page_size': 'query',
                 },
                 'collection_format_map': {
                     'fields_profile': 'csv',
@@ -556,6 +561,7 @@ def get_segment_profiles(
             fields_profile ([str]): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets. [optional]
             filter (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`. [optional]
             page_cursor (str): For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination. [optional]
+            page_size (int): [optional]
             _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