Skip to content

Commit 2988529

Browse files
committed
updated spec
1 parent 0d78651 commit 2988529

12 files changed

Lines changed: 63 additions & 85 deletions

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,7 +1005,7 @@ klaviyo.Client.create_client_event(company_id, body)
10051005

10061006

10071007

1008-
#### [Create Client Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_profile)
1008+
#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_profile)
10091009

10101010
```python
10111011
## Positional Arguments
@@ -2135,10 +2135,9 @@ klaviyo.Templates.create_template(body)
21352135
```python
21362136
## Positional Arguments
21372137

2138-
# id | str
21392138
# body | dict
21402139

2141-
klaviyo.Templates.create_template_clone(id, body)
2140+
klaviyo.Templates.create_template_clone(body)
21422141
```
21432142

21442143

@@ -2149,10 +2148,9 @@ klaviyo.Templates.create_template_clone(id, body)
21492148
```python
21502149
## Positional Arguments
21512150

2152-
# id | str
21532151
# body | dict
21542152

2155-
klaviyo.Templates.create_template_render(id, body)
2153+
klaviyo.Templates.create_template_render(body)
21562154
```
21572155

21582156

openapi_client/api/catalogs_api.py

Lines changed: 18 additions & 18 deletions
Large diffs are not rendered by default.

openapi_client/api/client_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ def create_client_event(
214214
):
215215
"""Create Client Event # noqa: E501
216216
217-
Create a new event to track a profile's activity. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create [events] from server-based applications, please use [POST /api/events](https://developers.klaviyo.com/en/v2022-10-17/reference/create_event)<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Write` # noqa: E501
217+
Create a new event to track a profile's activity. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create events from server-based applications, please use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event)<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Write` # noqa: E501
218218
This method makes a synchronous HTTP request by default. To make an
219219
asynchronous HTTP request, please pass async_req=True
220220
@@ -299,7 +299,7 @@ def create_client_profile(
299299
onsite_profile_create_query,
300300
**kwargs
301301
):
302-
"""Create Client Profile # noqa: E501
302+
"""Create or Update Client Profile # noqa: E501
303303
304304
Create and update properties about a profile without tracking an associated event. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create profiles from server applications (e.g. custom server-side scripts / applications), please use [POST /api/profiles](https://developers.klaviyo.com/en/reference/create_profile)<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Profiles Write` # noqa: E501
305305
This method makes a synchronous HTTP request by default. To make an

openapi_client/api/events_api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -660,7 +660,7 @@ def get_event(
660660
):
661661
"""Get Event # noqa: E501
662662
663-
Get an event with the given event ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `metrics`, `profiles`<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Events Read` # noqa: E501
663+
Get an event with the given event ID. Include parameters can be provided to get the following related resource data: `metrics`, `profiles`<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Events Read` # noqa: E501
664664
This method makes a synchronous HTTP request by default. To make an
665665
asynchronous HTTP request, please pass async_req=True
666666
@@ -916,7 +916,7 @@ def get_event_relationships(
916916
):
917917
"""Get Event Relationships # noqa: E501
918918
919-
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
919+
Get metrics or profile [relationships](https://developers.klaviyo.com/en/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
920920
This method makes a synchronous HTTP request by default. To make an
921921
asynchronous HTTP request, please pass async_req=True
922922
@@ -1001,7 +1001,7 @@ def get_events(
10011001
):
10021002
"""Get Events # noqa: E501
10031003
1004-
Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Use filters to narrow your results to specific metrics. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `metrics`, `profiles` Returns a maximum of 200 events 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: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read` # noqa: E501
1004+
Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Include parameters can be provided to get the following related resource data: `metrics`, `profiles` Returns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Events Read` # noqa: E501
10051005
This method makes a synchronous HTTP request by default. To make an
10061006
asynchronous HTTP request, please pass async_req=True
10071007

openapi_client/api/flows_api.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1146,7 +1146,7 @@ def get_flow(
11461146
):
11471147
"""Get Flow # noqa: E501
11481148
1149-
Get a flow with the given flow ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
1149+
Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
11501150
This method makes a synchronous HTTP request by default. To make an
11511151
asynchronous HTTP request, please pass async_req=True
11521152
@@ -1403,7 +1403,7 @@ def get_flow_action_messages(
14031403
):
14041404
"""Get Messages For Flow Action # noqa: E501
14051405
1406-
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
1406+
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` Returns a maximum of 50 flows per request, which can be paginated with offset 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
14071407
This method makes a synchronous HTTP request by default. To make an
14081408
asynchronous HTTP request, please pass async_req=True
14091409
@@ -1490,7 +1490,7 @@ def get_flow_action_relationships(
14901490
):
14911491
"""Get Flow Action Relationships # noqa: E501
14921492
1493-
Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for flow messages associated with the given flow action ID. Flow message relationships can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow message relationships 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
1493+
Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow messages associated with the given flow action ID. Flow message relationships can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 50 flow message relationships per request, which can be paginated with offset 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
14941494
This method makes a synchronous HTTP request by default. To make an
14951495
asynchronous HTTP request, please pass async_req=True
14961496
@@ -1578,7 +1578,7 @@ def get_flow_flow_actions(
15781578
):
15791579
"""Get Flow Actions For Flow # noqa: E501
15801580
1581-
Get all flow actions associated with the given flow ID. Flow actions can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated`, `action_type` 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
1581+
Get all flow actions associated with the given flow ID. Flow actions can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated`, `action_type` Returns a maximum of 50 flows per request, which can be paginated with offset 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
15821582
This method makes a synchronous HTTP request by default. To make an
15831583
asynchronous HTTP request, please pass async_req=True
15841584
@@ -1664,7 +1664,7 @@ def get_flow_message(
16641664
):
16651665
"""Get Flow Message # noqa: E501
16661666
1667-
Get the flow message of a flow with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
1667+
Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
16681668
This method makes a synchronous HTTP request by default. To make an
16691669
asynchronous HTTP request, please pass async_req=True
16701670
@@ -1750,7 +1750,7 @@ def get_flow_message_action(
17501750
):
17511751
"""Get Flow Action For Message # noqa: E501
17521752
1753-
Get the flow action for a flow message with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
1753+
Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
17541754
This method makes a synchronous HTTP request by default. To make an
17551755
asynchronous HTTP request, please pass async_req=True
17561756
@@ -1835,7 +1835,7 @@ def get_flow_message_relationships(
18351835
):
18361836
"""Get Flow Message Relationships # noqa: E501
18371837
1838-
Get the [relationship](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
1838+
Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
18391839
This method makes a synchronous HTTP request by default. To make an
18401840
asynchronous HTTP request, please pass async_req=True
18411841
@@ -2091,7 +2091,7 @@ def get_flows(
20912091
):
20922092
"""Get Flows # noqa: E501
20932093
2094-
Get all flows in an account. Flows can be sorted by the following fields, in ascending and descending order: `id`, `name`, `status`, `trigger_type`, `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). Include parameters can be provided to get the following related resource data: `flow-actions` 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)<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` # noqa: E501
2094+
Get all flows in an account. Flows can be sorted by the following fields, in ascending and descending order: `id`, `name`, `status`, `trigger_type`, `created`, `updated` Include parameters can be provided to get the following related resource data: `flow-actions` Returns a maximum of 50 flows per request, which can be paginated with offset 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
20952095
This method makes a synchronous HTTP request by default. To make an
20962096
asynchronous HTTP request, please pass async_req=True
20972097

openapi_client/api/lists_api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1136,7 +1136,7 @@ def get_list_profiles(
11361136
):
11371137
"""Get List Profiles # noqa: E501
11381138
1139-
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
1139+
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. 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: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read` # noqa: E501
11401140
This method makes a synchronous HTTP request by default. To make an
11411141
asynchronous HTTP request, please pass async_req=True
11421142
@@ -1223,7 +1223,7 @@ def get_list_relationships(
12231223
):
12241224
"""Get List Relationships # noqa: E501
12251225
1226-
Get profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a list with the given list ID. 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
1226+
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID. 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: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read` # noqa: E501
12271227
This method makes a synchronous HTTP request by default. To make an
12281228
asynchronous HTTP request, please pass async_req=True
12291229
@@ -1393,7 +1393,7 @@ def get_lists(
13931393
):
13941394
"""Get Lists # noqa: E501
13951395
1396-
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
1396+
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.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` # noqa: E501
13971397
This method makes a synchronous HTTP request by default. To make an
13981398
asynchronous HTTP request, please pass async_req=True
13991399

0 commit comments

Comments
 (0)