Merge pull request #1 from klaviyo/20221025-jonb-segment-profiles-fix

removed autogen setup.cfg, regenerated with new spec (get_segment_pro…

Author: jon-batscha

README.md

@@ -1,6 +1,6 @@
 # Klaviyo Python SDK
 
-- SDK version: 1.0.1
+- SDK version: 1.0.2
 - API revision: 2022-10-17
 
 ## Helpful Resources
@@ -1740,10 +1740,11 @@ klaviyo.Segments.get_segment(id, fields_segment=fields_segment);
 
 ## Keyword Arguments
 
+# fields_profile | [str]
 # filter | str
 # page_cursor | str
 
-klaviyo.Segments.get_segment_profiles(segment_id, filter=filter, page_cursor=page_cursor);
+klaviyo.Segments.get_segment_profiles(segment_id, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor);
 ```
 
 

openapi_client/__init__.py

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

openapi_client/api/events_api.py

@@ -916,7 +916,7 @@ def get_event_relationships(
     ):
         """Get Event Relationships  # noqa: E501
 
-        Get metrics or profile [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Events Read` `Profiles Read`  # noqa: E501
+        Get metrics or profile [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Events Read` `Metrics Read` `Profiles Read`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

openapi_client/api/flows_api.py

@@ -1362,7 +1362,7 @@ def get_flow_action_messages(
     ):
         """Get Messages For Flow Action  # noqa: E501
 
-        Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: `id`,  `name`, `created`, `updated` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination). Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows Read`  # noqa: E501
+        Get all flow messages associated with the given action ID.  Flow messages can be sorted by the following fields, in ascending and descending order:  ascending: `id`,  `name`, `created`, `updated` descending: `-id`,  `-name`, `-created`, `-updated`  Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).  Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination). Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows Read`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

openapi_client/api/lists_api.py

@@ -1071,7 +1071,7 @@ def get_list_profiles(
     ):
         """Get List Profiles  # noqa: E501
 
-        Get all profiles within a list with the given list ID. Use filters to narrow your results. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Read` `Profiles Read`  # noqa: E501
+        Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Read` `Profiles Read`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -1244,7 +1244,7 @@ def get_lists(
     ):
         """Get Lists  # noqa: E501
 
-        Get all lists in an account. Use filters to narrow your results. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Read`  # noqa: E501
+        Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Read`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -1254,7 +1254,7 @@ def get_lists(
 
         Keyword Args:
             fields_list ([str]): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets. [optional]
-            filter (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`. [optional]
+            filter (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`. [optional]
             page_cursor (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.

openapi_client/api/profiles_api.py

@@ -1038,7 +1038,7 @@ def get_profile_relationships(
     ):
         """Get Profile Relationships  # noqa: E501
 
-        Get list membership or segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Profiles Read` `Segments Read`  # noqa: E501
+        Get list membership or segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Lists Read` `Profiles Read` `Segments Read`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

openapi_client/api/segments_api.py

@@ -103,7 +103,7 @@ def __init__(self, api_client=None):
         )
         self.get_segment_profiles_endpoint = _Endpoint(
             settings={
-                'response_type': None,
+                'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
                 'auth': [
                     'Klaviyo-API-Key'
                 ],
@@ -115,6 +115,7 @@ def __init__(self, api_client=None):
             params_map={
                 'all': [
                     'segment_id',
+                    'fields_profile',
                     'filter',
                     'page_cursor',
                 ],
@@ -124,6 +125,7 @@ def __init__(self, api_client=None):
                 'nullable': [
                 ],
                 'enum': [
+                    'fields_profile',
                 ],
                 'validation': [
                 ]
@@ -132,26 +134,57 @@ def __init__(self, api_client=None):
                 'validations': {
                 },
                 'allowed_values': {
+                    ('fields_profile',): {
+
+                        "EMAIL": "email",
+                        "PHONE_NUMBER": "phone_number",
+                        "EXTERNAL_ID": "external_id",
+                        "ANONYMOUS_ID": "anonymous_id",
+                        "FIRST_NAME": "first_name",
+                        "LAST_NAME": "last_name",
+                        "ORGANIZATION": "organization",
+                        "TITLE": "title",
+                        "IMAGE": "image",
+                        "CREATED": "created",
+                        "UPDATED": "updated",
+                        "LAST_EVENT_DATE": "last_event_date",
+                        "LOCATION": "location",
+                        "LOCATION.ADDRESS1": "location.address1",
+                        "LOCATION.ADDRESS2": "location.address2",
+                        "LOCATION.CITY": "location.city",
+                        "LOCATION.COUNTRY": "location.country",
+                        "LOCATION.LATITUDE": "location.latitude",
+                        "LOCATION.LONGITUDE": "location.longitude",
+                        "LOCATION.REGION": "location.region",
+                        "LOCATION.ZIP": "location.zip",
+                        "LOCATION.TIMEZONE": "location.timezone",
+                        "PROPERTIES": "properties"
+                    },
                 },
                 'openapi_types': {
                     'segment_id':
                         (str,),
+                    'fields_profile':
+                        ([str],),
                     'filter':
                         (str,),
                     'page_cursor':
                         (str,),
                 },
                 'attribute_map': {
                     'segment_id': 'segment_id',
+                    'fields_profile': 'fields[profile]',
                     'filter': 'filter',
                     'page_cursor': 'page[cursor]',
                 },
                 'location_map': {
                     'segment_id': 'path',
+                    'fields_profile': 'query',
                     'filter': 'query',
                     'page_cursor': 'query',
                 },
                 'collection_format_map': {
+                    'fields_profile': 'csv',
                 }
             },
             headers_map={
@@ -457,6 +490,7 @@ def get_segment_profiles(
             segment_id (str): 
 
         Keyword Args:
+            fields_profile ([str]): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets. [optional]
             filter (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#pagination. [optional]
             _return_http_data_only (bool): response data without head status
@@ -491,7 +525,7 @@ def get_segment_profiles(
             async_req (bool): execute request asynchronously
 
         Returns:
-            None
+            {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -628,7 +662,7 @@ def get_segments(
 
         Keyword Args:
             fields_segment ([str]): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets. [optional]
-            filter (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`. [optional]
+            filter (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`. [optional]
             page_cursor (str): For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.

openapi_client/api_client.py

@@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'klaviyo-python-sdk-beta/1.0.1'
+        self.user_agent = 'klaviyo-python-sdk-beta/1.0.2'
 
     def __enter__(self):
         return self

openapi_client/configuration.py

@@ -410,7 +410,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2022-10-17\n"\
-               "SDK Package Version: 1.0.1".\
+               "SDK Package Version: 1.0.2".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):