From 4fd2ebcbc7e7aa21c22cb77fdb3e79ac7c394fcb Mon Sep 17 00:00:00 2001 From: Ian Montgomery <94383506+Ian-Montgomery-Klaviyo@users.noreply.github.com> Date: Mon, 16 Oct 2023 15:44:55 -0400 Subject: [PATCH] v7.0.0 release (#44) --- CHANGELOG.md | 48 +++ README.md | 402 +++++++++--------- api/accountsApi.ts | 8 +- api/campaignsApi.ts | 26 +- api/catalogsApi.ts | 68 +-- api/couponsApi.ts | 85 ++-- api/dataPrivacyApi.ts | 4 +- api/eventsApi.ts | 30 +- api/flowsApi.ts | 34 +- api/imagesApi.ts | 12 +- api/listsApi.ts | 26 +- api/metricsApi.ts | 8 +- api/profilesApi.ts | 30 +- api/segmentsApi.ts | 22 +- api/tagsApi.ts | 16 +- api/templatesApi.ts | 8 +- ...eQueryResourceObjectRelationshipsCoupon.ts | 6 +- model/emailMarketing.ts | 38 +- ...onse.ts => emailSubscriptionParameters.ts} | 14 +- ...eJobResponseCollectionCompoundDocument.ts} | 10 +- ...nseCollectionCompoundDocumentDataInner.ts} | 12 +- ...llectionCompoundDocumentDataInnerAllOf.ts} | 10 +- ...oundDocumentDataInnerAllOfRelationships.ts | 31 ++ ...DataInnerAllOfRelationshipsCouponCodes.ts} | 10 +- ...AllOfRelationshipsCouponCodesDataInner.ts} | 6 +- ...seCollectionDataInnerAllOfRelationships.ts | 31 -- ...onCodeCreateJobResponseCompoundDocument.ts | 38 ++ model/getCouponCodeResponseCollection.ts | 6 +- ...nCodeResponseCollectionCompoundDocument.ts | 45 ++ ...nseCollectionCompoundDocumentDataInner.ts} | 12 +- ...llectionCompoundDocumentDataInnerAllOf.ts} | 10 +- ...oundDocumentDataInnerAllOfRelationships.ts | 38 ++ ...umentDataInnerAllOfRelationshipsCoupon.ts} | 10 +- ...tDataInnerAllOfRelationshipsCouponData.ts} | 6 +- ...mentDataInnerAllOfRelationshipsProfile.ts} | 10 +- ...DataInnerAllOfRelationshipsProfileData.ts} | 6 +- ...seCollectionDataInnerAllOfRelationships.ts | 38 -- .../getCouponCodeResponseCompoundDocument.ts | 38 ++ ...tMemberResponseObjectResourceAttributes.ts | 7 - ...esponseObjectResourceExtendedAttributes.ts | 6 + model/marketingSubscriptionParameters.ts | 38 ++ model/models.ts | 105 +++-- model/postCouponCodeCreateJobResponseData.ts | 6 +- model/postCouponCodeResponseData.ts | 6 +- model/profileLocation.ts | 9 + ...profileResponseObjectResourceAttributes.ts | 7 - ...esponseObjectResourceExtendedAttributes.ts | 6 + ...seObjectResourceExtendedAttributesAllOf.ts | 7 + ...fileUpsertQueryResourceObjectAttributes.ts | 9 + model/sMSMarketing.ts | 26 +- ...sponse.ts => sMSSubscriptionParameters.ts} | 14 +- ...tMemberResponseObjectResourceAttributes.ts | 7 - ...esponseObjectResourceExtendedAttributes.ts | 6 + model/subscriptionChannels.ts | 24 +- package-lock.json | 8 +- package.json | 2 +- 56 files changed, 917 insertions(+), 628 deletions(-) rename model/{getCouponCodeResponse.ts => emailSubscriptionParameters.ts} (60%) rename model/{getCouponCodeCreateJobResponseCollection.ts => getCouponCodeCreateJobResponseCollectionCompoundDocument.ts} (67%) rename model/{getCouponCodeCreateJobResponseCollectionDataInner.ts => getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner.ts} (60%) rename model/{getCouponCodeCreateJobResponseCollectionDataInnerAllOf.ts => getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf.ts} (52%) create mode 100644 model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts rename model/{getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes.ts => getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes.ts} (57%) rename model/{getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner.ts => getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner.ts} (71%) delete mode 100644 model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships.ts create mode 100644 model/getCouponCodeCreateJobResponseCompoundDocument.ts create mode 100644 model/getCouponCodeResponseCollectionCompoundDocument.ts rename model/{getCouponCodeResponseCollectionDataInner.ts => getCouponCodeResponseCollectionCompoundDocumentDataInner.ts} (62%) rename model/{getCouponCodeResponseCollectionDataInnerAllOf.ts => getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf.ts} (54%) create mode 100644 model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts rename model/{getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon.ts => getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon.ts} (58%) rename model/{getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData.ts => getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData.ts} (72%) rename model/{getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile.ts => getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile.ts} (58%) rename model/{getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData.ts => getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData.ts} (72%) delete mode 100644 model/getCouponCodeResponseCollectionDataInnerAllOfRelationships.ts create mode 100644 model/getCouponCodeResponseCompoundDocument.ts create mode 100644 model/marketingSubscriptionParameters.ts rename model/{getCouponCodeCreateJobResponse.ts => sMSSubscriptionParameters.ts} (57%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d3f56e2..bdfee72e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,54 @@ # Changelog All notable changes to this project will be documented in this file. +## [7.0.0] - revision 2023-10-15 + +### Added + +#### Support for returning list suppressions via the [/profiles endpoint](https://developers.klaviyo.com/en/reference/get_profiles) + +We now support filtering on list suppression with the get profiles endpoint, which brings us to parity with v2 list suppression endpoint that was the previously recommended solution. + +Rules for suppression [filtering](https://developers.klaviyo.com/en/docs/filtering_): + +- You may not mix-and-match list and global filters +- You may only specify a single date filter +- You may or may not specify a reason +- You must specify a list_id to filter on any list suppression properties + +Examples: + +``` +{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z)'} +{filter: 'greater-than(subscriptions.email.marketing.list_suppressions.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.list_suppressions.list_id,”LIST_ID”') +{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.suppression.reason,"user_suppressed"') +``` +##### Optionally retrieve subscription status on Get List Profiles, Get Segment Profiles, Get Event Profile +Now you can retrieve subscription status on any endpoint that returns profiles, including `getListProfiles`, `getSegmentProfiles` and `getEventProfile`. Use `{additionalFieldsProfile: ['subscriptions']}` on these endpoints to include subscription information. + +### Breaking changes + +#### Subscription object not returned by default on Get Profile / Get Profiles + +The subscription object is no longer returned by default with get profile(s) requests. However, it can be included by adding `?additional-fields[profile]=subscriptions` to the request. This change will allow us to provide a more performant experience when making requests to `GetProfiles` without including the subscriptions object. + +#### Profile Subscription Fields Renamed + +In the interest of providing more clarity and information on the subscription object, we have renamed several fields, and added several as well. This will provide more context on a contact's subscriptions and consent, as well as boolean fields to see who you can or cannot message. + +For SMSMarketing: + +- `timestamp` is now `consentTimestamp` +- `lastUpdated` is a new field that mirrors `consenTimestamp` +- `canReceiveSmsMarketing` is a new field which is `True` if the profile is consented for SMS + +For EmailMarketing: + +- `timestamp` is now `consentTimestamp` +- `canReceiveEmailMarketing` is True if the profile does not have a global suppression +- `suppressions` is now `suppression` +- `lastUpdated` is a new field that is the most recent of all the dates on the object + ## [6.0.1] - revision 2023-09-15 ### Fixed - `Relationship` and its child attributes were incorrectly marked as optional for the following endpoints diff --git a/README.md b/README.md index fd5af02d..83aa54da 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Klaviyo Typescript SDK -- SDK version: 6.0.1 +- SDK version: 7.0.0 -- Revision: 2023-09-15 +- Revision: 2023-10-15 ## Helpful Resources @@ -12,8 +12,8 @@ ### Other Klaviyo Resources -- [API Reference](https://developers.klaviyo.com/en/v2023-09-15/reference/) -- [API Guides](https://developers.klaviyo.com/en/v2023-09-15/docs) +- [API Reference](https://developers.klaviyo.com/en/v2023-10-15/reference/) +- [API Guides](https://developers.klaviyo.com/en/v2023-10-15/docs) - [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers) ## Design & Approach @@ -47,7 +47,7 @@ This SDK is organized into the following resources: You can install this library using `npm`. -`npm install klaviyo-api@6.0.1` +`npm install klaviyo-api@7.0.0` ## source code @@ -319,7 +319,7 @@ console.log(profile.body.data.attributes.predictiveAnalytics) You can filter responses by passing a string into the optional parameter `filter`. Note that when filtering by a property it will be snake_case instead of camelCase, ie. `metric_id` -Read more about formatting your filter strings in our [developer documentation](https://developers.klaviyo.com/en/v2023-09-15/docs/filtering_) +Read more about formatting your filter strings in our [developer documentation](https://developers.klaviyo.com/en/v2023-10-15/docs/filtering_) Here is an example of a filter string for results between two date times: `less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)` @@ -433,7 +433,7 @@ console.log(profile.body.included) ### Relationships -The Klaviyo API has a series of endpoints to expose the relationships between different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-09-15/docs/relationships_). +The Klaviyo API has a series of endpoints to expose the relationships between different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-10-15/docs/relationships_). Here are some use cases and their examples: @@ -503,14 +503,14 @@ const events = await eventsApi.getEvents({fieldsEvent: ['event_properties'], sor ## AccountsApi _______________________________ -[Get Account](https://developers.klaviyo.com/en/v2023-09-15/reference/get_account) +[Get Account](https://developers.klaviyo.com/en/v2023-10-15/reference/get_account) ```typescript AccountsApi.getAccount(id: string, options) ``` _______________________________ -[Get Accounts](https://developers.klaviyo.com/en/v2023-09-15/reference/get_accounts) +[Get Accounts](https://developers.klaviyo.com/en/v2023-10-15/reference/get_accounts) ```typescript AccountsApi.getAccounts(options) @@ -519,161 +519,161 @@ _______________________________ ## CampaignsApi _______________________________ -[Create Campaign](https://developers.klaviyo.com/en/v2023-09-15/reference/create_campaign) +[Create Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign) ```typescript CampaignsApi.createCampaign(campaignCreateQuery: CampaignCreateQuery) ``` _______________________________ -[Create Campaign Clone](https://developers.klaviyo.com/en/v2023-09-15/reference/create_campaign_clone) +[Create Campaign Clone](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_clone) ```typescript CampaignsApi.createCampaignClone(campaignCloneQuery: CampaignCloneQuery) ``` _______________________________ -[Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-09-15/reference/create_campaign_message_assign_template) +[Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_message_assign_template) ```typescript CampaignsApi.createCampaignMessageAssignTemplate(campaignMessageAssignTemplateQuery: CampaignMessageAssignTemplateQuery) ``` _______________________________ -[Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-09-15/reference/create_campaign_recipient_estimation_job) +[Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_recipient_estimation_job) ```typescript CampaignsApi.createCampaignRecipientEstimationJob(campaignRecipientEstimationJobCreateQuery: CampaignRecipientEstimationJobCreateQuery) ``` _______________________________ -[Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-09-15/reference/create_campaign_send_job) +[Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_send_job) ```typescript CampaignsApi.createCampaignSendJob(campaignSendJobCreateQuery: CampaignSendJobCreateQuery) ``` _______________________________ -[Delete Campaign](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_campaign) +[Delete Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_campaign) ```typescript CampaignsApi.deleteCampaign(id: string) ``` _______________________________ -[Get Campaign](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign) +[Get Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign) ```typescript CampaignsApi.getCampaign(id: string, options) ``` _______________________________ -[Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_campaign_messages) +[Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_campaign_messages) ```typescript CampaignsApi.getCampaignCampaignMessages(id: string, options) ``` _______________________________ -[Get Campaign Message](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_message) +[Get Campaign Message](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message) ```typescript CampaignsApi.getCampaignMessage(id: string, options) ``` _______________________________ -[Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_message_campaign) +[Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_campaign) ```typescript CampaignsApi.getCampaignMessageCampaign(id: string, options) ``` _______________________________ -[Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_message_relationships_campaign) +[Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_relationships_campaign) ```typescript CampaignsApi.getCampaignMessageRelationshipsCampaign(id: string) ``` _______________________________ -[Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_message_relationships_template) +[Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_relationships_template) ```typescript CampaignsApi.getCampaignMessageRelationshipsTemplate(id: string) ``` _______________________________ -[Get Campaign Message Template](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_message_template) +[Get Campaign Message Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_template) ```typescript CampaignsApi.getCampaignMessageTemplate(id: string, options) ``` _______________________________ -[Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_recipient_estimation) +[Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_recipient_estimation) ```typescript CampaignsApi.getCampaignRecipientEstimation(id: string, options) ``` _______________________________ -[Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_recipient_estimation_job) +[Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_recipient_estimation_job) ```typescript CampaignsApi.getCampaignRecipientEstimationJob(id: string, options) ``` _______________________________ -[Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_relationships_campaign_messages) +[Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_relationships_campaign_messages) ```typescript CampaignsApi.getCampaignRelationshipsCampaignMessages(id: string) ``` _______________________________ -[Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_relationships_tags) +[Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_relationships_tags) ```typescript CampaignsApi.getCampaignRelationshipsTags(id: string) ``` _______________________________ -[Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_send_job) +[Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_send_job) ```typescript CampaignsApi.getCampaignSendJob(id: string, options) ``` _______________________________ -[Get Campaign Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaign_tags) +[Get Campaign Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_tags) ```typescript CampaignsApi.getCampaignTags(id: string, options) ``` _______________________________ -[Get Campaigns](https://developers.klaviyo.com/en/v2023-09-15/reference/get_campaigns) +[Get Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaigns) ```typescript CampaignsApi.getCampaigns(filter: string, options) ``` _______________________________ -[Update Campaign](https://developers.klaviyo.com/en/v2023-09-15/reference/update_campaign) +[Update Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/update_campaign) ```typescript CampaignsApi.updateCampaign(id: string, campaignPartialUpdateQuery: CampaignPartialUpdateQuery) ``` _______________________________ -[Update Campaign Message](https://developers.klaviyo.com/en/v2023-09-15/reference/update_campaign_message) +[Update Campaign Message](https://developers.klaviyo.com/en/v2023-10-15/reference/update_campaign_message) ```typescript CampaignsApi.updateCampaignMessage(id: string, campaignMessagePartialUpdateQuery: CampaignMessagePartialUpdateQuery) ``` _______________________________ -[Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-09-15/reference/update_campaign_send_job) +[Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-10-15/reference/update_campaign_send_job) ```typescript CampaignsApi.updateCampaignSendJob(id: string, campaignSendJobPartialUpdateQuery: CampaignSendJobPartialUpdateQuery) @@ -682,378 +682,378 @@ _______________________________ ## CatalogsApi _______________________________ -[Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2023-09-15/reference/create_back_in_stock_subscription) +[Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2023-10-15/reference/create_back_in_stock_subscription) ```typescript CatalogsApi.createBackInStockSubscription(serverBISSubscriptionCreateQuery: ServerBISSubscriptionCreateQuery) ``` _______________________________ -[Create Catalog Category](https://developers.klaviyo.com/en/v2023-09-15/reference/create_catalog_category) +[Create Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_category) ```typescript CatalogsApi.createCatalogCategory(catalogCategoryCreateQuery: CatalogCategoryCreateQuery) ``` _______________________________ -[Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-09-15/reference/create_catalog_category_relationships_items) +[Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_category_relationships_items) ```typescript CatalogsApi.createCatalogCategoryRelationshipsItems(id: string, catalogCategoryItemOp: CatalogCategoryItemOp) ``` _______________________________ -[Create Catalog Item](https://developers.klaviyo.com/en/v2023-09-15/reference/create_catalog_item) +[Create Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_item) ```typescript CatalogsApi.createCatalogItem(catalogItemCreateQuery: CatalogItemCreateQuery) ``` _______________________________ -[Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-09-15/reference/create_catalog_item_relationships_categories) +[Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_item_relationships_categories) ```typescript CatalogsApi.createCatalogItemRelationshipsCategories(id: string, catalogItemCategoryOp: CatalogItemCategoryOp) ``` _______________________________ -[Create Catalog Variant](https://developers.klaviyo.com/en/v2023-09-15/reference/create_catalog_variant) +[Create Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_variant) ```typescript CatalogsApi.createCatalogVariant(catalogVariantCreateQuery: CatalogVariantCreateQuery) ``` _______________________________ -[Delete Catalog Category](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_catalog_category) +[Delete Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_category) ```typescript CatalogsApi.deleteCatalogCategory(id: string) ``` _______________________________ -[Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_catalog_category_relationships_items) +[Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_category_relationships_items) ```typescript CatalogsApi.deleteCatalogCategoryRelationshipsItems(id: string, catalogCategoryItemOp: CatalogCategoryItemOp) ``` _______________________________ -[Delete Catalog Item](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_catalog_item) +[Delete Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_item) ```typescript CatalogsApi.deleteCatalogItem(id: string) ``` _______________________________ -[Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_catalog_item_relationships_categories) +[Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_item_relationships_categories) ```typescript CatalogsApi.deleteCatalogItemRelationshipsCategories(id: string, catalogItemCategoryOp: CatalogItemCategoryOp) ``` _______________________________ -[Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_catalog_variant) +[Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_variant) ```typescript CatalogsApi.deleteCatalogVariant(id: string) ``` _______________________________ -[Get Catalog Categories](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_categories) +[Get Catalog Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_categories) ```typescript CatalogsApi.getCatalogCategories(options) ``` _______________________________ -[Get Catalog Category](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_category) +[Get Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_category) ```typescript CatalogsApi.getCatalogCategory(id: string, options) ``` _______________________________ -[Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_category_items) +[Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_category_items) ```typescript CatalogsApi.getCatalogCategoryItems(id: string, options) ``` _______________________________ -[Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_category_relationships_items) +[Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_category_relationships_items) ```typescript CatalogsApi.getCatalogCategoryRelationshipsItems(id: string, options) ``` _______________________________ -[Get Catalog Item](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_item) +[Get Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item) ```typescript CatalogsApi.getCatalogItem(id: string, options) ``` _______________________________ -[Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_item_categories) +[Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item_categories) ```typescript CatalogsApi.getCatalogItemCategories(id: string, options) ``` _______________________________ -[Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_item_relationships_categories) +[Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item_relationships_categories) ```typescript CatalogsApi.getCatalogItemRelationshipsCategories(id: string, options) ``` _______________________________ -[Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_item_variants) +[Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item_variants) ```typescript CatalogsApi.getCatalogItemVariants(id: string, options) ``` _______________________________ -[Get Catalog Items](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_items) +[Get Catalog Items](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_items) ```typescript CatalogsApi.getCatalogItems(options) ``` _______________________________ -[Get Catalog Variant](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_variant) +[Get Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_variant) ```typescript CatalogsApi.getCatalogVariant(id: string, options) ``` _______________________________ -[Get Catalog Variants](https://developers.klaviyo.com/en/v2023-09-15/reference/get_catalog_variants) +[Get Catalog Variants](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_variants) ```typescript CatalogsApi.getCatalogVariants(options) ``` _______________________________ -[Get Create Categories Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_create_categories_job) +[Get Create Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_categories_job) ```typescript CatalogsApi.getCreateCategoriesJob(jobId: string, options) ``` _______________________________ -[Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_create_categories_jobs) +[Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_categories_jobs) ```typescript CatalogsApi.getCreateCategoriesJobs(options) ``` _______________________________ -[Get Create Items Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_create_items_job) +[Get Create Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_items_job) ```typescript CatalogsApi.getCreateItemsJob(jobId: string, options) ``` _______________________________ -[Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_create_items_jobs) +[Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_items_jobs) ```typescript CatalogsApi.getCreateItemsJobs(options) ``` _______________________________ -[Get Create Variants Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_create_variants_job) +[Get Create Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_variants_job) ```typescript CatalogsApi.getCreateVariantsJob(jobId: string, options) ``` _______________________________ -[Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_create_variants_jobs) +[Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_variants_jobs) ```typescript CatalogsApi.getCreateVariantsJobs(options) ``` _______________________________ -[Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_delete_categories_job) +[Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_categories_job) ```typescript CatalogsApi.getDeleteCategoriesJob(jobId: string, options) ``` _______________________________ -[Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_delete_categories_jobs) +[Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_categories_jobs) ```typescript CatalogsApi.getDeleteCategoriesJobs(options) ``` _______________________________ -[Get Delete Items Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_delete_items_job) +[Get Delete Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_items_job) ```typescript CatalogsApi.getDeleteItemsJob(jobId: string, options) ``` _______________________________ -[Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_delete_items_jobs) +[Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_items_jobs) ```typescript CatalogsApi.getDeleteItemsJobs(options) ``` _______________________________ -[Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_delete_variants_job) +[Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_variants_job) ```typescript CatalogsApi.getDeleteVariantsJob(jobId: string, options) ``` _______________________________ -[Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_delete_variants_jobs) +[Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_variants_jobs) ```typescript CatalogsApi.getDeleteVariantsJobs(options) ``` _______________________________ -[Get Update Categories Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_update_categories_job) +[Get Update Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_categories_job) ```typescript CatalogsApi.getUpdateCategoriesJob(jobId: string, options) ``` _______________________________ -[Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_update_categories_jobs) +[Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_categories_jobs) ```typescript CatalogsApi.getUpdateCategoriesJobs(options) ``` _______________________________ -[Get Update Items Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_update_items_job) +[Get Update Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_items_job) ```typescript CatalogsApi.getUpdateItemsJob(jobId: string, options) ``` _______________________________ -[Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_update_items_jobs) +[Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_items_jobs) ```typescript CatalogsApi.getUpdateItemsJobs(options) ``` _______________________________ -[Get Update Variants Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_update_variants_job) +[Get Update Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_variants_job) ```typescript CatalogsApi.getUpdateVariantsJob(jobId: string, options) ``` _______________________________ -[Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_update_variants_jobs) +[Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_variants_jobs) ```typescript CatalogsApi.getUpdateVariantsJobs(options) ``` _______________________________ -[Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_create_categories_job) +[Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_create_categories_job) ```typescript CatalogsApi.spawnCreateCategoriesJob(catalogCategoryCreateJobCreateQuery: CatalogCategoryCreateJobCreateQuery) ``` _______________________________ -[Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_create_items_job) +[Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_create_items_job) ```typescript CatalogsApi.spawnCreateItemsJob(catalogItemCreateJobCreateQuery: CatalogItemCreateJobCreateQuery) ``` _______________________________ -[Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_create_variants_job) +[Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_create_variants_job) ```typescript CatalogsApi.spawnCreateVariantsJob(catalogVariantCreateJobCreateQuery: CatalogVariantCreateJobCreateQuery) ``` _______________________________ -[Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_delete_categories_job) +[Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_delete_categories_job) ```typescript CatalogsApi.spawnDeleteCategoriesJob(catalogCategoryDeleteJobCreateQuery: CatalogCategoryDeleteJobCreateQuery) ``` _______________________________ -[Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_delete_items_job) +[Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_delete_items_job) ```typescript CatalogsApi.spawnDeleteItemsJob(catalogItemDeleteJobCreateQuery: CatalogItemDeleteJobCreateQuery) ``` _______________________________ -[Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_delete_variants_job) +[Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_delete_variants_job) ```typescript CatalogsApi.spawnDeleteVariantsJob(catalogVariantDeleteJobCreateQuery: CatalogVariantDeleteJobCreateQuery) ``` _______________________________ -[Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_update_categories_job) +[Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_update_categories_job) ```typescript CatalogsApi.spawnUpdateCategoriesJob(catalogCategoryUpdateJobCreateQuery: CatalogCategoryUpdateJobCreateQuery) ``` _______________________________ -[Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_update_items_job) +[Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_update_items_job) ```typescript CatalogsApi.spawnUpdateItemsJob(catalogItemUpdateJobCreateQuery: CatalogItemUpdateJobCreateQuery) ``` _______________________________ -[Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_update_variants_job) +[Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_update_variants_job) ```typescript CatalogsApi.spawnUpdateVariantsJob(catalogVariantUpdateJobCreateQuery: CatalogVariantUpdateJobCreateQuery) ``` _______________________________ -[Update Catalog Category](https://developers.klaviyo.com/en/v2023-09-15/reference/update_catalog_category) +[Update Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_category) ```typescript CatalogsApi.updateCatalogCategory(id: string, catalogCategoryUpdateQuery: CatalogCategoryUpdateQuery) ``` _______________________________ -[Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-09-15/reference/update_catalog_category_relationships_items) +[Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_category_relationships_items) ```typescript CatalogsApi.updateCatalogCategoryRelationshipsItems(id: string, catalogCategoryItemOp: CatalogCategoryItemOp) ``` _______________________________ -[Update Catalog Item](https://developers.klaviyo.com/en/v2023-09-15/reference/update_catalog_item) +[Update Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_item) ```typescript CatalogsApi.updateCatalogItem(id: string, catalogItemUpdateQuery: CatalogItemUpdateQuery) ``` _______________________________ -[Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-09-15/reference/update_catalog_item_relationships_categories) +[Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_item_relationships_categories) ```typescript CatalogsApi.updateCatalogItemRelationshipsCategories(id: string, catalogItemCategoryOp: CatalogItemCategoryOp) ``` _______________________________ -[Update Catalog Variant](https://developers.klaviyo.com/en/v2023-09-15/reference/update_catalog_variant) +[Update Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_variant) ```typescript CatalogsApi.updateCatalogVariant(id: string, catalogVariantUpdateQuery: CatalogVariantUpdateQuery) @@ -1062,119 +1062,119 @@ _______________________________ ## CouponsApi _______________________________ -[Create Coupon](https://developers.klaviyo.com/en/v2023-09-15/reference/create_coupon) +[Create Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/create_coupon) ```typescript CouponsApi.createCoupon(couponCreateQuery: CouponCreateQuery) ``` _______________________________ -[Create Coupon Code](https://developers.klaviyo.com/en/v2023-09-15/reference/create_coupon_code) +[Create Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/create_coupon_code) ```typescript CouponsApi.createCouponCode(couponCodeCreateQuery: CouponCodeCreateQuery) ``` _______________________________ -[Delete Coupon](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_coupon) +[Delete Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_coupon) ```typescript CouponsApi.deleteCoupon(id: string) ``` _______________________________ -[Delete Coupon Code](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_coupon_code) +[Delete Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_coupon_code) ```typescript CouponsApi.deleteCouponCode(id: string) ``` _______________________________ -[Get Coupon](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon) +[Get Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon) ```typescript CouponsApi.getCoupon(id: string, options) ``` _______________________________ -[Get Coupon Code](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_code) +[Get Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code) ```typescript CouponsApi.getCouponCode(id: string, options) ``` _______________________________ -[Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_code_bulk_create_job) +[Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code_bulk_create_job) ```typescript CouponsApi.getCouponCodeBulkCreateJob(jobId: string, options) ``` _______________________________ -[Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_code_bulk_create_jobs) +[Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code_bulk_create_jobs) ```typescript CouponsApi.getCouponCodeBulkCreateJobs(options) ``` _______________________________ -[Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_code_relationships_coupon) +[Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code_relationships_coupon) ```typescript CouponsApi.getCouponCodeRelationshipsCoupon(id: string, options) ``` _______________________________ -[Get Coupon Codes](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_codes) +[Get Coupon Codes](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_codes) ```typescript CouponsApi.getCouponCodes(options) ``` _______________________________ -[Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_codes_for_coupon) +[Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_codes_for_coupon) ```typescript CouponsApi.getCouponCodesForCoupon(id: string, options) ``` _______________________________ -[Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_for_coupon_code) +[Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_for_coupon_code) ```typescript CouponsApi.getCouponForCouponCode(id: string, options) ``` _______________________________ -[Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupon_relationships_coupon_codes) +[Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_relationships_coupon_codes) ```typescript CouponsApi.getCouponRelationshipsCouponCodes(id: string) ``` _______________________________ -[Get Coupons](https://developers.klaviyo.com/en/v2023-09-15/reference/get_coupons) +[Get Coupons](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupons) ```typescript CouponsApi.getCoupons(options) ``` _______________________________ -[Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-09-15/reference/spawn_coupon_code_bulk_create_job) +[Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_coupon_code_bulk_create_job) ```typescript CouponsApi.spawnCouponCodeBulkCreateJob(couponCodeCreateJobCreateQuery: CouponCodeCreateJobCreateQuery) ``` _______________________________ -[Update Coupon](https://developers.klaviyo.com/en/v2023-09-15/reference/update_coupon) +[Update Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/update_coupon) ```typescript CouponsApi.updateCoupon(id: string, couponUpdateQuery: CouponUpdateQuery) ``` _______________________________ -[Update Coupon Code](https://developers.klaviyo.com/en/v2023-09-15/reference/update_coupon_code) +[Update Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/update_coupon_code) ```typescript CouponsApi.updateCouponCode(id: string, couponCodeUpdateQuery: CouponCodeUpdateQuery) @@ -1183,7 +1183,7 @@ _______________________________ ## DataPrivacyApi _______________________________ -[Request Profile Deletion](https://developers.klaviyo.com/en/v2023-09-15/reference/request_profile_deletion) +[Request Profile Deletion](https://developers.klaviyo.com/en/v2023-10-15/reference/request_profile_deletion) ```typescript DataPrivacyApi.requestProfileDeletion(dataPrivacyCreateDeletionJobQuery: DataPrivacyCreateDeletionJobQuery) @@ -1192,49 +1192,49 @@ _______________________________ ## EventsApi _______________________________ -[Create Event](https://developers.klaviyo.com/en/v2023-09-15/reference/create_event) +[Create Event](https://developers.klaviyo.com/en/v2023-10-15/reference/create_event) ```typescript EventsApi.createEvent(eventCreateQueryV2: EventCreateQueryV2) ``` _______________________________ -[Get Event](https://developers.klaviyo.com/en/v2023-09-15/reference/get_event) +[Get Event](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event) ```typescript EventsApi.getEvent(id: string, options) ``` _______________________________ -[Get Event Metric](https://developers.klaviyo.com/en/v2023-09-15/reference/get_event_metric) +[Get Event Metric](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_metric) ```typescript EventsApi.getEventMetric(id: string, options) ``` _______________________________ -[Get Event Profile](https://developers.klaviyo.com/en/v2023-09-15/reference/get_event_profile) +[Get Event Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_profile) ```typescript EventsApi.getEventProfile(id: string, options) ``` _______________________________ -[Get Event Relationships Metric](https://developers.klaviyo.com/en/v2023-09-15/reference/get_event_relationships_metric) +[Get Event Relationships Metric](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_relationships_metric) ```typescript EventsApi.getEventRelationshipsMetric(id: string) ``` _______________________________ -[Get Event Relationships Profile](https://developers.klaviyo.com/en/v2023-09-15/reference/get_event_relationships_profile) +[Get Event Relationships Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_relationships_profile) ```typescript EventsApi.getEventRelationshipsProfile(id: string) ``` _______________________________ -[Get Events](https://developers.klaviyo.com/en/v2023-09-15/reference/get_events) +[Get Events](https://developers.klaviyo.com/en/v2023-10-15/reference/get_events) ```typescript EventsApi.getEvents(options) @@ -1243,119 +1243,119 @@ _______________________________ ## FlowsApi _______________________________ -[Get Flow](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow) +[Get Flow](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow) ```typescript FlowsApi.getFlow(id: string, options) ``` _______________________________ -[Get Flow Action](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_action) +[Get Flow Action](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action) ```typescript FlowsApi.getFlowAction(id: string, options) ``` _______________________________ -[Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_action_flow) +[Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_flow) ```typescript FlowsApi.getFlowActionFlow(id: string, options) ``` _______________________________ -[Get Flow Action Messages](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_action_messages) +[Get Flow Action Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_messages) ```typescript FlowsApi.getFlowActionMessages(id: string, options) ``` _______________________________ -[Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_action_relationships_flow) +[Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_relationships_flow) ```typescript FlowsApi.getFlowActionRelationshipsFlow(id: string) ``` _______________________________ -[Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_action_relationships_messages) +[Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_relationships_messages) ```typescript FlowsApi.getFlowActionRelationshipsMessages(id: string, options) ``` _______________________________ -[Get Flow Flow Actions](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_flow_actions) +[Get Flow Flow Actions](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_flow_actions) ```typescript FlowsApi.getFlowFlowActions(id: string, options) ``` _______________________________ -[Get Flow Message](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_message) +[Get Flow Message](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message) ```typescript FlowsApi.getFlowMessage(id: string, options) ``` _______________________________ -[Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_message_action) +[Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_action) ```typescript FlowsApi.getFlowMessageAction(id: string, options) ``` _______________________________ -[Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_message_relationships_action) +[Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_relationships_action) ```typescript FlowsApi.getFlowMessageRelationshipsAction(id: string) ``` _______________________________ -[Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_message_relationships_template) +[Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_relationships_template) ```typescript FlowsApi.getFlowMessageRelationshipsTemplate(id: string) ``` _______________________________ -[Get Flow Message Template](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_message_template) +[Get Flow Message Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_template) ```typescript FlowsApi.getFlowMessageTemplate(id: string, options) ``` _______________________________ -[Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_relationships_flow_actions) +[Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_relationships_flow_actions) ```typescript FlowsApi.getFlowRelationshipsFlowActions(id: string, options) ``` _______________________________ -[Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_relationships_tags) +[Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_relationships_tags) ```typescript FlowsApi.getFlowRelationshipsTags(id: string) ``` _______________________________ -[Get Flow Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flow_tags) +[Get Flow Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_tags) ```typescript FlowsApi.getFlowTags(id: string, options) ``` _______________________________ -[Get Flows](https://developers.klaviyo.com/en/v2023-09-15/reference/get_flows) +[Get Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flows) ```typescript FlowsApi.getFlows(options) ``` _______________________________ -[Update Flow Status](https://developers.klaviyo.com/en/v2023-09-15/reference/update_flow) +[Update Flow Status](https://developers.klaviyo.com/en/v2023-10-15/reference/update_flow) ```typescript FlowsApi.updateFlow(id: string, flowUpdateQuery: FlowUpdateQuery) @@ -1364,35 +1364,35 @@ _______________________________ ## ImagesApi _______________________________ -[Get Image](https://developers.klaviyo.com/en/v2023-09-15/reference/get_image) +[Get Image](https://developers.klaviyo.com/en/v2023-10-15/reference/get_image) ```typescript ImagesApi.getImage(id: string, options) ``` _______________________________ -[Get Images](https://developers.klaviyo.com/en/v2023-09-15/reference/get_images) +[Get Images](https://developers.klaviyo.com/en/v2023-10-15/reference/get_images) ```typescript ImagesApi.getImages(options) ``` _______________________________ -[Update Image](https://developers.klaviyo.com/en/v2023-09-15/reference/update_image) +[Update Image](https://developers.klaviyo.com/en/v2023-10-15/reference/update_image) ```typescript ImagesApi.updateImage(id: string, imagePartialUpdateQuery: ImagePartialUpdateQuery) ``` _______________________________ -[Upload Image From File](https://developers.klaviyo.com/en/v2023-09-15/reference/upload_image_from_file) +[Upload Image From File](https://developers.klaviyo.com/en/v2023-10-15/reference/upload_image_from_file) ```typescript ImagesApi.uploadImageFromFile(file: RequestFile, ) ``` _______________________________ -[Upload Image From URL](https://developers.klaviyo.com/en/v2023-09-15/reference/upload_image_from_url) +[Upload Image From URL](https://developers.klaviyo.com/en/v2023-10-15/reference/upload_image_from_url) ```typescript ImagesApi.uploadImageFromUrl(imageCreateQuery: ImageCreateQuery) @@ -1401,77 +1401,77 @@ _______________________________ ## ListsApi _______________________________ -[Create List](https://developers.klaviyo.com/en/v2023-09-15/reference/create_list) +[Create List](https://developers.klaviyo.com/en/v2023-10-15/reference/create_list) ```typescript ListsApi.createList(listCreateQuery: ListCreateQuery) ``` _______________________________ -[Add Profile To List](https://developers.klaviyo.com/en/v2023-09-15/reference/create_list_relationships) +[Add Profile To List](https://developers.klaviyo.com/en/v2023-10-15/reference/create_list_relationships) ```typescript ListsApi.createListRelationships(id: string, listMembersAddQuery: ListMembersAddQuery) ``` _______________________________ -[Delete List](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_list) +[Delete List](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_list) ```typescript ListsApi.deleteList(id: string) ``` _______________________________ -[Remove Profile From List](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_list_relationships) +[Remove Profile From List](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_list_relationships) ```typescript ListsApi.deleteListRelationships(id: string, listMembersDeleteQuery: ListMembersDeleteQuery) ``` _______________________________ -[Get List](https://developers.klaviyo.com/en/v2023-09-15/reference/get_list) +[Get List](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list) ```typescript ListsApi.getList(id: string, options) ``` _______________________________ -[Get List Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/get_list_profiles) +[Get List Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_profiles) ```typescript ListsApi.getListProfiles(id: string, options) ``` _______________________________ -[Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/get_list_relationships_profiles) +[Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_relationships_profiles) ```typescript ListsApi.getListRelationshipsProfiles(id: string, options) ``` _______________________________ -[Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_list_relationships_tags) +[Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_relationships_tags) ```typescript ListsApi.getListRelationshipsTags(id: string) ``` _______________________________ -[Get List Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_list_tags) +[Get List Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_tags) ```typescript ListsApi.getListTags(id: string, options) ``` _______________________________ -[Get Lists](https://developers.klaviyo.com/en/v2023-09-15/reference/get_lists) +[Get Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_lists) ```typescript ListsApi.getLists(options) ``` _______________________________ -[Update List](https://developers.klaviyo.com/en/v2023-09-15/reference/update_list) +[Update List](https://developers.klaviyo.com/en/v2023-10-15/reference/update_list) ```typescript ListsApi.updateList(id: string, listPartialUpdateQuery: ListPartialUpdateQuery) @@ -1480,21 +1480,21 @@ _______________________________ ## MetricsApi _______________________________ -[Get Metric](https://developers.klaviyo.com/en/v2023-09-15/reference/get_metric) +[Get Metric](https://developers.klaviyo.com/en/v2023-10-15/reference/get_metric) ```typescript MetricsApi.getMetric(id: string, options) ``` _______________________________ -[Get Metrics](https://developers.klaviyo.com/en/v2023-09-15/reference/get_metrics) +[Get Metrics](https://developers.klaviyo.com/en/v2023-10-15/reference/get_metrics) ```typescript MetricsApi.getMetrics(options) ``` _______________________________ -[Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-09-15/reference/query_metric_aggregates) +[Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-10-15/reference/query_metric_aggregates) ```typescript MetricsApi.queryMetricAggregates(metricAggregateQuery: MetricAggregateQuery) @@ -1503,98 +1503,98 @@ _______________________________ ## ProfilesApi _______________________________ -[Create Profile](https://developers.klaviyo.com/en/v2023-09-15/reference/create_profile) +[Create Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/create_profile) ```typescript ProfilesApi.createProfile(profileCreateQuery: ProfileCreateQuery) ``` _______________________________ -[Create or Update Push Token](https://developers.klaviyo.com/en/v2023-09-15/reference/create_push_token) +[Create or Update Push Token](https://developers.klaviyo.com/en/v2023-10-15/reference/create_push_token) ```typescript ProfilesApi.createPushToken(pushTokenCreateQuery: PushTokenCreateQuery) ``` _______________________________ -[Get Profile](https://developers.klaviyo.com/en/v2023-09-15/reference/get_profile) +[Get Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile) ```typescript ProfilesApi.getProfile(id: string, options) ``` _______________________________ -[Get Profile Lists](https://developers.klaviyo.com/en/v2023-09-15/reference/get_profile_lists) +[Get Profile Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_lists) ```typescript ProfilesApi.getProfileLists(id: string, options) ``` _______________________________ -[Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-09-15/reference/get_profile_relationships_lists) +[Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_relationships_lists) ```typescript ProfilesApi.getProfileRelationshipsLists(id: string) ``` _______________________________ -[Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-09-15/reference/get_profile_relationships_segments) +[Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_relationships_segments) ```typescript ProfilesApi.getProfileRelationshipsSegments(id: string) ``` _______________________________ -[Get Profile Segments](https://developers.klaviyo.com/en/v2023-09-15/reference/get_profile_segments) +[Get Profile Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_segments) ```typescript ProfilesApi.getProfileSegments(id: string, options) ``` _______________________________ -[Get Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/get_profiles) +[Get Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profiles) ```typescript ProfilesApi.getProfiles(options) ``` _______________________________ -[Merge Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/merge_profiles) +[Merge Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/merge_profiles) ```typescript ProfilesApi.mergeProfiles(profileMergeQuery: ProfileMergeQuery) ``` _______________________________ -[Subscribe Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/subscribe_profiles) +[Subscribe Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/subscribe_profiles) ```typescript ProfilesApi.subscribeProfiles(subscriptionCreateJobCreateQuery: SubscriptionCreateJobCreateQuery) ``` _______________________________ -[Suppress Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/suppress_profiles) +[Suppress Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/suppress_profiles) ```typescript ProfilesApi.suppressProfiles(suppressionCreateJobCreateQuery: SuppressionCreateJobCreateQuery) ``` _______________________________ -[Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/unsubscribe_profiles) +[Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/unsubscribe_profiles) ```typescript ProfilesApi.unsubscribeProfiles(subscriptionDeleteJobCreateQuery: SubscriptionDeleteJobCreateQuery) ``` _______________________________ -[Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/unsuppress_profiles) +[Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/unsuppress_profiles) ```typescript ProfilesApi.unsuppressProfiles(suppressionDeleteJobCreateQuery: SuppressionDeleteJobCreateQuery) ``` _______________________________ -[Update Profile](https://developers.klaviyo.com/en/v2023-09-15/reference/update_profile) +[Update Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/update_profile) ```typescript ProfilesApi.updateProfile(id: string, profilePartialUpdateQuery: ProfilePartialUpdateQuery) @@ -1603,49 +1603,49 @@ _______________________________ ## SegmentsApi _______________________________ -[Get Segment](https://developers.klaviyo.com/en/v2023-09-15/reference/get_segment) +[Get Segment](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment) ```typescript SegmentsApi.getSegment(id: string, options) ``` _______________________________ -[Get Segment Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/get_segment_profiles) +[Get Segment Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_profiles) ```typescript SegmentsApi.getSegmentProfiles(id: string, options) ``` _______________________________ -[Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-09-15/reference/get_segment_relationships_profiles) +[Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_relationships_profiles) ```typescript SegmentsApi.getSegmentRelationshipsProfiles(id: string, options) ``` _______________________________ -[Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_segment_relationships_tags) +[Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_relationships_tags) ```typescript SegmentsApi.getSegmentRelationshipsTags(id: string) ``` _______________________________ -[Get Segment Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_segment_tags) +[Get Segment Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_tags) ```typescript SegmentsApi.getSegmentTags(id: string, options) ``` _______________________________ -[Get Segments](https://developers.klaviyo.com/en/v2023-09-15/reference/get_segments) +[Get Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segments) ```typescript SegmentsApi.getSegments(options) ``` _______________________________ -[Update Segment](https://developers.klaviyo.com/en/v2023-09-15/reference/update_segment) +[Update Segment](https://developers.klaviyo.com/en/v2023-10-15/reference/update_segment) ```typescript SegmentsApi.updateSegment(id: string, segmentPartialUpdateQuery: SegmentPartialUpdateQuery) @@ -1654,182 +1654,182 @@ _______________________________ ## TagsApi _______________________________ -[Create Tag](https://developers.klaviyo.com/en/v2023-09-15/reference/create_tag) +[Create Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag) ```typescript TagsApi.createTag(tagCreateQuery: TagCreateQuery) ``` _______________________________ -[Create Tag Group](https://developers.klaviyo.com/en/v2023-09-15/reference/create_tag_group) +[Create Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_group) ```typescript TagsApi.createTagGroup(tagGroupCreateQuery: TagGroupCreateQuery) ``` _______________________________ -[Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-09-15/reference/create_tag_relationships_campaigns) +[Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_campaigns) ```typescript TagsApi.createTagRelationshipsCampaigns(id: string, tagCampaignOp: TagCampaignOp) ``` _______________________________ -[Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-09-15/reference/create_tag_relationships_flows) +[Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_flows) ```typescript TagsApi.createTagRelationshipsFlows(id: string, tagFlowOp: TagFlowOp) ``` _______________________________ -[Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-09-15/reference/create_tag_relationships_lists) +[Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_lists) ```typescript TagsApi.createTagRelationshipsLists(id: string, tagListOp: TagListOp) ``` _______________________________ -[Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-09-15/reference/create_tag_relationships_segments) +[Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_segments) ```typescript TagsApi.createTagRelationshipsSegments(id: string, tagSegmentOp: TagSegmentOp) ``` _______________________________ -[Delete Tag](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_tag) +[Delete Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag) ```typescript TagsApi.deleteTag(id: string) ``` _______________________________ -[Delete Tag Group](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_tag_group) +[Delete Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_group) ```typescript TagsApi.deleteTagGroup(id: string) ``` _______________________________ -[Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_tag_relationships_campaigns) +[Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_campaigns) ```typescript TagsApi.deleteTagRelationshipsCampaigns(id: string, tagCampaignOp: TagCampaignOp) ``` _______________________________ -[Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_tag_relationships_flows) +[Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_flows) ```typescript TagsApi.deleteTagRelationshipsFlows(id: string, tagFlowOp: TagFlowOp) ``` _______________________________ -[Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_tag_relationships_lists) +[Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_lists) ```typescript TagsApi.deleteTagRelationshipsLists(id: string, tagListOp: TagListOp) ``` _______________________________ -[Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_tag_relationships_segments) +[Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_segments) ```typescript TagsApi.deleteTagRelationshipsSegments(id: string, tagSegmentOp: TagSegmentOp) ``` _______________________________ -[Get Tag](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag) +[Get Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag) ```typescript TagsApi.getTag(id: string, options) ``` _______________________________ -[Get Tag Group](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_group) +[Get Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_group) ```typescript TagsApi.getTagGroup(id: string, options) ``` _______________________________ -[Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_group_relationships_tags) +[Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_group_relationships_tags) ```typescript TagsApi.getTagGroupRelationshipsTags(id: string) ``` _______________________________ -[Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_group_tags) +[Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_group_tags) ```typescript TagsApi.getTagGroupTags(id: string, options) ``` _______________________________ -[Get Tag Groups](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_groups) +[Get Tag Groups](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_groups) ```typescript TagsApi.getTagGroups(options) ``` _______________________________ -[Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_relationships_campaigns) +[Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_campaigns) ```typescript TagsApi.getTagRelationshipsCampaigns(id: string) ``` _______________________________ -[Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_relationships_flows) +[Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_flows) ```typescript TagsApi.getTagRelationshipsFlows(id: string) ``` _______________________________ -[Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_relationships_lists) +[Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_lists) ```typescript TagsApi.getTagRelationshipsLists(id: string) ``` _______________________________ -[Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_relationships_segments) +[Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_segments) ```typescript TagsApi.getTagRelationshipsSegments(id: string) ``` _______________________________ -[Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_relationships_tag_group) +[Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_tag_group) ```typescript TagsApi.getTagRelationshipsTagGroup(id: string) ``` _______________________________ -[Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tag_tag_group) +[Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_tag_group) ```typescript TagsApi.getTagTagGroup(id: string, options) ``` _______________________________ -[Get Tags](https://developers.klaviyo.com/en/v2023-09-15/reference/get_tags) +[Get Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tags) ```typescript TagsApi.getTags(options) ``` _______________________________ -[Update Tag](https://developers.klaviyo.com/en/v2023-09-15/reference/update_tag) +[Update Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/update_tag) ```typescript TagsApi.updateTag(id: string, tagUpdateQuery: TagUpdateQuery) ``` _______________________________ -[Update Tag Group](https://developers.klaviyo.com/en/v2023-09-15/reference/update_tag_group) +[Update Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/update_tag_group) ```typescript TagsApi.updateTagGroup(id: string, tagGroupUpdateQuery: TagGroupUpdateQuery) @@ -1838,49 +1838,49 @@ _______________________________ ## TemplatesApi _______________________________ -[Create Template](https://developers.klaviyo.com/en/v2023-09-15/reference/create_template) +[Create Template](https://developers.klaviyo.com/en/v2023-10-15/reference/create_template) ```typescript TemplatesApi.createTemplate(templateCreateQuery: TemplateCreateQuery) ``` _______________________________ -[Create Template Clone](https://developers.klaviyo.com/en/v2023-09-15/reference/create_template_clone) +[Create Template Clone](https://developers.klaviyo.com/en/v2023-10-15/reference/create_template_clone) ```typescript TemplatesApi.createTemplateClone(templateCloneQuery: TemplateCloneQuery) ``` _______________________________ -[Create Template Render](https://developers.klaviyo.com/en/v2023-09-15/reference/create_template_render) +[Create Template Render](https://developers.klaviyo.com/en/v2023-10-15/reference/create_template_render) ```typescript TemplatesApi.createTemplateRender(templateRenderQuery: TemplateRenderQuery) ``` _______________________________ -[Delete Template](https://developers.klaviyo.com/en/v2023-09-15/reference/delete_template) +[Delete Template](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_template) ```typescript TemplatesApi.deleteTemplate(id: string) ``` _______________________________ -[Get Template](https://developers.klaviyo.com/en/v2023-09-15/reference/get_template) +[Get Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_template) ```typescript TemplatesApi.getTemplate(id: string, options) ``` _______________________________ -[Get Templates](https://developers.klaviyo.com/en/v2023-09-15/reference/get_templates) +[Get Templates](https://developers.klaviyo.com/en/v2023-10-15/reference/get_templates) ```typescript TemplatesApi.getTemplates(options) ``` _______________________________ -[Update Template](https://developers.klaviyo.com/en/v2023-09-15/reference/update_template) +[Update Template](https://developers.klaviyo.com/en/v2023-10-15/reference/update_template) ```typescript TemplatesApi.updateTemplate(id: string, templateUpdateQuery: TemplateUpdateQuery) diff --git a/api/accountsApi.ts b/api/accountsApi.ts index 0190eaa5..8e7e0cec 100644 --- a/api/accountsApi.ts +++ b/api/accountsApi.ts @@ -38,8 +38,8 @@ export class AccountsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -71,7 +71,7 @@ export class AccountsApi { * Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `accounts:read` * @summary Get Account * @param id The ID of the account - * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getAccount (id: string, options: { fieldsAccount?: Array<'contact_information' | 'contact_information.default_sender_name' | 'contact_information.default_sender_email' | 'contact_information.website_url' | 'contact_information.organization_name' | 'contact_information.street_address' | 'contact_information.street_address.address1' | 'contact_information.street_address.address2' | 'contact_information.street_address.city' | 'contact_information.street_address.region' | 'contact_information.street_address.country' | 'contact_information.street_address.zip' | 'industry' | 'timezone' | 'preferred_currency' | 'public_api_key'>, } = {}): Promise<{ response: AxiosResponse; body: GetAccountResponse; }> { @@ -125,7 +125,7 @@ export class AccountsApi { * 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.

*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `accounts:read` * @summary Get Accounts - * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getAccounts (options: { fieldsAccount?: Array<'contact_information' | 'contact_information.default_sender_name' | 'contact_information.default_sender_email' | 'contact_information.website_url' | 'contact_information.organization_name' | 'contact_information.street_address' | 'contact_information.street_address.address1' | 'contact_information.street_address.address2' | 'contact_information.street_address.city' | 'contact_information.street_address.region' | 'contact_information.street_address.country' | 'contact_information.street_address.zip' | 'industry' | 'timezone' | 'preferred_currency' | 'public_api_key'>, } = {}): Promise<{ response: AxiosResponse; body: GetAccountResponseCollection; }> { diff --git a/api/campaignsApi.ts b/api/campaignsApi.ts index e7afb95c..f1115eae 100644 --- a/api/campaignsApi.ts +++ b/api/campaignsApi.ts @@ -64,8 +64,8 @@ export class CampaignsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -396,7 +396,7 @@ export class CampaignsApi { * Returns a specific campaign based on a required id.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign * @param id The campaign ID to be retrieved - * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCampaign (id: string, options: { fieldsCampaignMessage?: Array<'label' | 'channel' | 'content' | 'send_times' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language' | 'created_at' | 'updated_at'>, fieldsCampaign?: Array<'name' | 'status' | 'archived' | 'audiences' | 'audiences.included' | 'audiences.excluded' | 'send_options' | 'tracking_options' | 'send_strategy' | 'send_strategy.method' | 'send_strategy.options_static' | 'send_strategy.options_static.datetime' | 'send_strategy.options_static.is_local' | 'send_strategy.options_static.send_past_recipients_immediately' | 'send_strategy.options_throttled' | 'send_strategy.options_throttled.datetime' | 'send_strategy.options_throttled.throttle_percentage' | 'send_strategy.options_sto' | 'send_strategy.options_sto.date' | 'created_at' | 'scheduled_at' | 'updated_at' | 'send_time'>, fieldsTag?: Array<'name'>, include?: Array<'campaign-messages' | 'tags'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignResponseCompoundDocument; }> { @@ -462,7 +462,7 @@ export class CampaignsApi { * Return all messages that belong to the given campaign.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign Campaign Messages * @param id - * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCampaignCampaignMessages (id: string, options: { fieldsCampaignMessage?: Array<'label' | 'channel' | 'content' | 'send_times' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language' | 'created_at' | 'updated_at'>, fieldsCampaign?: Array<'name' | 'status' | 'archived' | 'audiences' | 'audiences.included' | 'audiences.excluded' | 'send_options' | 'tracking_options' | 'send_strategy' | 'send_strategy.method' | 'send_strategy.options_static' | 'send_strategy.options_static.datetime' | 'send_strategy.options_static.is_local' | 'send_strategy.options_static.send_past_recipients_immediately' | 'send_strategy.options_throttled' | 'send_strategy.options_throttled.datetime' | 'send_strategy.options_throttled.throttle_percentage' | 'send_strategy.options_sto' | 'send_strategy.options_sto.date' | 'created_at' | 'scheduled_at' | 'updated_at' | 'send_time'>, fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, include?: Array<'campaign' | 'template'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignMessageResponseCollectionCompoundDocument; }> { @@ -528,7 +528,7 @@ export class CampaignsApi { * Returns a specific message based on a required id.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign Message * @param id The message ID to be retrieved - * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCampaignMessage (id: string, options: { fieldsCampaignMessage?: Array<'label' | 'channel' | 'content' | 'send_times' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language' | 'created_at' | 'updated_at'>, fieldsCampaign?: Array<'name' | 'status' | 'archived' | 'audiences' | 'audiences.included' | 'audiences.excluded' | 'send_options' | 'tracking_options' | 'send_strategy' | 'send_strategy.method' | 'send_strategy.options_static' | 'send_strategy.options_static.datetime' | 'send_strategy.options_static.is_local' | 'send_strategy.options_static.send_past_recipients_immediately' | 'send_strategy.options_throttled' | 'send_strategy.options_throttled.datetime' | 'send_strategy.options_throttled.throttle_percentage' | 'send_strategy.options_sto' | 'send_strategy.options_sto.date' | 'created_at' | 'scheduled_at' | 'updated_at' | 'send_time'>, fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, include?: Array<'campaign' | 'template'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignMessageResponseCompoundDocument; }> { @@ -594,7 +594,7 @@ export class CampaignsApi { * Return the related campaign

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign Message Campaign * @param id - * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCampaignMessageCampaign (id: string, options: { fieldsCampaignMessage?: Array<'label' | 'channel' | 'content' | 'send_times' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language' | 'created_at' | 'updated_at'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignMessageResponse; }> { @@ -748,7 +748,7 @@ export class CampaignsApi { * Return the related template

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` * @summary Get Campaign Message Template * @param id - * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCampaignMessageTemplate (id: string, options: { fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetTemplateResponse; }> { @@ -802,7 +802,7 @@ export class CampaignsApi { * Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign Recipient Estimation * @param id The ID of the campaign for which to get the estimated number of recipients - * @param fieldsCampaignRecipientEstimation For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCampaignRecipientEstimation For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCampaignRecipientEstimation (id: string, options: { fieldsCampaignRecipientEstimation?: Array<'estimated_recipient_count'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignRecipientEstimationResponse; }> { @@ -856,7 +856,7 @@ export class CampaignsApi { * Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign Recipient Estimation Job * @param id The ID of the campaign to get recipient estimation status - * @param fieldsCampaignRecipientEstimationJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCampaignRecipientEstimationJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCampaignRecipientEstimationJob (id: string, options: { fieldsCampaignRecipientEstimationJob?: Array<'status'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignRecipientEstimationJobResponse; }> { @@ -1010,7 +1010,7 @@ export class CampaignsApi { * Get a campaign send job

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaign Send Job * @param id The ID of the campaign to send - * @param fieldsCampaignSendJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCampaignSendJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCampaignSendJob (id: string, options: { fieldsCampaignSendJob?: Array<'status'>, } = {}): Promise<{ response: AxiosResponse; body: GetCampaignSendJobResponse; }> { @@ -1064,7 +1064,7 @@ export class CampaignsApi { * Return all tags that belong to the given campaign.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` * @summary Get Campaign Tags * @param id - * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCampaignTags (id: string, options: { fieldsTag?: Array<'name'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCollection; }> { @@ -1117,8 +1117,8 @@ export class CampaignsApi { /** * Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,\'email\')` to list email campaigns, or `?filter=equals(messages.channel,\'sms\')` to list SMS campaigns.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` * @summary Get Campaigns - * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` + * @param fieldsCampaignMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCampaign For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCampaigns (filter: string, options: { fieldsCampaignMessage?: Array<'label' | 'channel' | 'content' | 'send_times' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language' | 'created_at' | 'updated_at'>, fieldsCampaign?: Array<'name' | 'status' | 'archived' | 'audiences' | 'audiences.included' | 'audiences.excluded' | 'send_options' | 'tracking_options' | 'send_strategy' | 'send_strategy.method' | 'send_strategy.options_static' | 'send_strategy.options_static.datetime' | 'send_strategy.options_static.is_local' | 'send_strategy.options_static.send_past_recipients_immediately' | 'send_strategy.options_throttled' | 'send_strategy.options_throttled.datetime' | 'send_strategy.options_throttled.throttle_percentage' | 'send_strategy.options_sto' | 'send_strategy.options_sto.date' | 'created_at' | 'scheduled_at' | 'updated_at' | 'send_time'>, fieldsTag?: Array<'name'>, include?: Array<'campaign-messages' | 'tags'>, pageCursor?: string, sort?: 'created_at' | '-created_at' | 'id' | '-id' | 'name' | '-name' | 'scheduled_at' | '-scheduled_at' | 'updated_at' | '-updated_at', } = {}): Promise<{ response: AxiosResponse; body: GetCampaignResponseCollectionCompoundDocument; }> { diff --git a/api/catalogsApi.ts b/api/catalogsApi.ts index 443e3425..d3f52a9a 100644 --- a/api/catalogsApi.ts +++ b/api/catalogsApi.ts @@ -95,8 +95,8 @@ export class CatalogsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -694,7 +694,7 @@ export class CatalogsApi { * Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Categories - * @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCatalogCategories (options: { fieldsCatalogCategory?: Array<'external_id' | 'name' | 'updated'>, filter?: string, pageCursor?: string, sort?: 'created' | '-created', } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryResponseCollection; }> { @@ -754,7 +754,7 @@ export class CatalogsApi { * Get a catalog category with the given category ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Category * @param id 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`. - * @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCatalogCategory (id: string, options: { fieldsCatalogCategory?: Array<'external_id' | 'name' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryResponse; }> { @@ -805,10 +805,10 @@ export class CatalogsApi { }, this.session.getRetryOptions()); } /** - * Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` + * Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Category Items * @param id - * @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCatalogCategoryItems (id: string, options: { fieldsCatalogItem?: Array<'external_id' | 'title' | 'description' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, filter?: string, include?: Array<'variants'>, pageCursor?: string, sort?: 'created' | '-created', } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemResponseCollectionCompoundDocument; }> { @@ -882,7 +882,7 @@ export class CatalogsApi { * Get all items in the given category ID. Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Category Relationships Items * @param id - * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCatalogCategoryRelationshipsItems (id: string, options: { pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryItemListResponseCollection; }> { @@ -933,10 +933,10 @@ export class CatalogsApi { }, this.session.getRetryOptions()); } /** - * Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` + * Get a specific catalog item with the given item ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Item * @param id 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`. - * @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCatalogItem (id: string, options: { fieldsCatalogItem?: Array<'external_id' | 'title' | 'description' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, include?: Array<'variants'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemResponseCompoundDocument; }> { @@ -998,7 +998,7 @@ export class CatalogsApi { * Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Item Categories * @param id - * @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCatalogItemCategories (id: string, options: { fieldsCatalogCategory?: Array<'external_id' | 'name' | 'updated'>, filter?: string, pageCursor?: string, sort?: 'created' | '-created', } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryResponseCollection; }> { @@ -1064,7 +1064,7 @@ export class CatalogsApi { * Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Item Relationships Categories * @param id - * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCatalogItemRelationshipsCategories (id: string, options: { pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemCategoryListResponseCollection; }> { @@ -1118,7 +1118,7 @@ export class CatalogsApi { * Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Item Variants * @param id - * @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCatalogItemVariants (id: string, options: { fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, filter?: string, pageCursor?: string, sort?: 'created' | '-created', } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantResponseCollection; }> { @@ -1181,10 +1181,10 @@ export class CatalogsApi { }, this.session.getRetryOptions()); } /** - * Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` + * Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Items - * @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCatalogItems (options: { fieldsCatalogItem?: Array<'external_id' | 'title' | 'description' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, filter?: string, include?: Array<'variants'>, pageCursor?: string, sort?: 'created' | '-created', } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemResponseCollectionCompoundDocument; }> { @@ -1252,7 +1252,7 @@ export class CatalogsApi { * Get a catalog item variant with the given variant ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Variant * @param id 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`. - * @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCatalogVariant (id: string, options: { fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantResponse; }> { @@ -1306,7 +1306,7 @@ export class CatalogsApi { * Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Catalog Variants - * @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getCatalogVariants (options: { fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, filter?: string, pageCursor?: string, sort?: 'created' | '-created', } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantResponseCollection; }> { @@ -1366,7 +1366,7 @@ export class CatalogsApi { * Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Create Categories Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogCategoryBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogCategoryBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCreateCategoriesJob (jobId: string, options: { fieldsCatalogCategoryBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCatalogCategory?: Array<'external_id' | 'name' | 'updated'>, include?: Array<'categories'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryCreateJobResponseCompoundDocument; }> { @@ -1428,7 +1428,7 @@ export class CatalogsApi { * Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Create Categories Jobs - * @param fieldsCatalogCategoryBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogCategoryBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCreateCategoriesJobs (options: { fieldsCatalogCategoryBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryCreateJobResponseCollectionCompoundDocument; }> { @@ -1484,7 +1484,7 @@ export class CatalogsApi { * Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Create Items Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogItemBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogItemBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCreateItemsJob (jobId: string, options: { fieldsCatalogItemBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCatalogItem?: Array<'external_id' | 'title' | 'description' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, include?: Array<'items'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemCreateJobResponseCompoundDocument; }> { @@ -1546,7 +1546,7 @@ export class CatalogsApi { * Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Create Items Jobs - * @param fieldsCatalogItemBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogItemBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCreateItemsJobs (options: { fieldsCatalogItemBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemCreateJobResponseCollectionCompoundDocument; }> { @@ -1602,7 +1602,7 @@ export class CatalogsApi { * Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Create Variants Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogVariantBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogVariantBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getCreateVariantsJob (jobId: string, options: { fieldsCatalogVariantBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, include?: Array<'variants'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantCreateJobResponseCompoundDocument; }> { @@ -1664,7 +1664,7 @@ export class CatalogsApi { * Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Create Variants Jobs - * @param fieldsCatalogVariantBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogVariantBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCreateVariantsJobs (options: { fieldsCatalogVariantBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantCreateJobResponseCollectionCompoundDocument; }> { @@ -1720,7 +1720,7 @@ export class CatalogsApi { * Get a catalog category bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Delete Categories Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogCategoryBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCatalogCategoryBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getDeleteCategoriesJob (jobId: string, options: { fieldsCatalogCategoryBulkDeleteJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryDeleteJobResponse; }> { @@ -1774,7 +1774,7 @@ export class CatalogsApi { * Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Delete Categories Jobs - * @param fieldsCatalogCategoryBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogCategoryBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getDeleteCategoriesJobs (options: { fieldsCatalogCategoryBulkDeleteJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryDeleteJobResponseCollection; }> { @@ -1830,7 +1830,7 @@ export class CatalogsApi { * Get a catalog item bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Delete Items Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogItemBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCatalogItemBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getDeleteItemsJob (jobId: string, options: { fieldsCatalogItemBulkDeleteJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemDeleteJobResponse; }> { @@ -1884,7 +1884,7 @@ export class CatalogsApi { * Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Delete Items Jobs - * @param fieldsCatalogItemBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogItemBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getDeleteItemsJobs (options: { fieldsCatalogItemBulkDeleteJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemDeleteJobResponseCollection; }> { @@ -1940,7 +1940,7 @@ export class CatalogsApi { * Get a catalog variant bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Delete Variants Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogVariantBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCatalogVariantBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getDeleteVariantsJob (jobId: string, options: { fieldsCatalogVariantBulkDeleteJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantDeleteJobResponse; }> { @@ -1994,7 +1994,7 @@ export class CatalogsApi { * Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Delete Variants Jobs - * @param fieldsCatalogVariantBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogVariantBulkDeleteJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getDeleteVariantsJobs (options: { fieldsCatalogVariantBulkDeleteJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantDeleteJobResponseCollection; }> { @@ -2050,7 +2050,7 @@ export class CatalogsApi { * Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Update Categories Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogCategoryBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogCategoryBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getUpdateCategoriesJob (jobId: string, options: { fieldsCatalogCategoryBulkUpdateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCatalogCategory?: Array<'external_id' | 'name' | 'updated'>, include?: Array<'categories'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryUpdateJobResponseCompoundDocument; }> { @@ -2112,7 +2112,7 @@ export class CatalogsApi { * Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Update Categories Jobs - * @param fieldsCatalogCategoryBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogCategoryBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getUpdateCategoriesJobs (options: { fieldsCatalogCategoryBulkUpdateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogCategoryUpdateJobResponseCollectionCompoundDocument; }> { @@ -2168,7 +2168,7 @@ export class CatalogsApi { * Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Update Items Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogItemBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogItemBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getUpdateItemsJob (jobId: string, options: { fieldsCatalogItemBulkUpdateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCatalogItem?: Array<'external_id' | 'title' | 'description' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, include?: Array<'items'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemUpdateJobResponseCompoundDocument; }> { @@ -2230,7 +2230,7 @@ export class CatalogsApi { * Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Update Items Jobs - * @param fieldsCatalogItemBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogItemBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getUpdateItemsJobs (options: { fieldsCatalogItemBulkUpdateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogItemUpdateJobResponseCollectionCompoundDocument; }> { @@ -2286,7 +2286,7 @@ export class CatalogsApi { * Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Update Variants Job * @param jobId ID of the job to retrieve. - * @param fieldsCatalogVariantBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsCatalogVariantBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getUpdateVariantsJob (jobId: string, options: { fieldsCatalogVariantBulkUpdateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCatalogVariant?: Array<'external_id' | 'title' | 'description' | 'sku' | 'inventory_policy' | 'inventory_quantity' | 'price' | 'url' | 'image_full_url' | 'image_thumbnail_url' | 'images' | 'custom_metadata' | 'published' | 'created' | 'updated'>, include?: Array<'variants'>, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantUpdateJobResponseCompoundDocument; }> { @@ -2348,7 +2348,7 @@ export class CatalogsApi { * Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` * @summary Get Update Variants Jobs - * @param fieldsCatalogVariantBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCatalogVariantBulkUpdateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getUpdateVariantsJobs (options: { fieldsCatalogVariantBulkUpdateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCatalogVariantUpdateJobResponseCollectionCompoundDocument; }> { diff --git a/api/couponsApi.ts b/api/couponsApi.ts index 11ed0351..4535d8ad 100644 --- a/api/couponsApi.ts +++ b/api/couponsApi.ts @@ -22,11 +22,12 @@ import { CouponCodeUpdateQuery } from '../model/couponCodeUpdateQuery'; import { CouponCreateQuery } from '../model/couponCreateQuery'; import { CouponUpdateQuery } from '../model/couponUpdateQuery'; import { GetAccounts4XXResponse } from '../model/getAccounts4XXResponse'; -import { GetCouponCodeCreateJobResponse } from '../model/getCouponCodeCreateJobResponse'; -import { GetCouponCodeCreateJobResponseCollection } from '../model/getCouponCodeCreateJobResponseCollection'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocument } from '../model/getCouponCodeCreateJobResponseCollectionCompoundDocument'; +import { GetCouponCodeCreateJobResponseCompoundDocument } from '../model/getCouponCodeCreateJobResponseCompoundDocument'; import { GetCouponCodeRelationshipCouponResponse } from '../model/getCouponCodeRelationshipCouponResponse'; -import { GetCouponCodeResponse } from '../model/getCouponCodeResponse'; import { GetCouponCodeResponseCollection } from '../model/getCouponCodeResponseCollection'; +import { GetCouponCodeResponseCollectionCompoundDocument } from '../model/getCouponCodeResponseCollectionCompoundDocument'; +import { GetCouponCodeResponseCompoundDocument } from '../model/getCouponCodeResponseCompoundDocument'; import { GetCouponRelationshipCouponCodesListResponseCollection } from '../model/getCouponRelationshipCouponCodesListResponseCollection'; import { GetCouponResponse } from '../model/getCouponResponse'; import { GetCouponResponseCollection } from '../model/getCouponResponseCollection'; @@ -54,8 +55,8 @@ export class CouponsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -285,7 +286,7 @@ export class CouponsApi { * Get a specific coupon with the given coupon ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` * @summary Get Coupon * @param id The internal id of a Coupon is equivalent to its external id stored within an integration. - * @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCoupon (id: string, options: { fieldsCoupon?: Array<'external_id' | 'description'>, } = {}): Promise<{ response: AxiosResponse; body: GetCouponResponse; }> { @@ -339,9 +340,9 @@ export class CouponsApi { * Returns a Coupon Code specified by the given identifier.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `coupon-codes:read` * @summary Get Coupon Code * @param id The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with. - * @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ - public async getCouponCode (id: string, options: { fieldsCouponCode?: Array<'unique_code' | 'expires_at' | 'status'>, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeResponse; }> { + public async getCouponCode (id: string, options: { fieldsCouponCode?: Array<'unique_code' | 'expires_at' | 'status'>, fieldsCoupon?: Array<'external_id' | 'description'>, include?: Array<'coupon'>, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCompoundDocument; }> { const localVarPath = this.basePath + '/api/coupon-codes/{id}/' .replace('{' + 'id' + '}', encodeURIComponent(String(id))); @@ -364,6 +365,14 @@ export class CouponsApi { localVarQueryParameters['fields[coupon-code]'] = ObjectSerializer.serialize(options.fieldsCouponCode, "Array<'unique_code' | 'expires_at' | 'status'>"); } + if (options.fieldsCoupon !== undefined) { + localVarQueryParameters['fields[coupon]'] = ObjectSerializer.serialize(options.fieldsCoupon, "Array<'external_id' | 'description'>"); + } + + if (options.include !== undefined) { + localVarQueryParameters['include'] = ObjectSerializer.serialize(options.include, "Array<'coupon'>"); + } + queryParamPreProcessor(localVarQueryParameters) let config: AxiosRequestConfig = { @@ -375,12 +384,12 @@ export class CouponsApi { this.session.applyToRequest(config) - return backOff<{ response: AxiosResponse; body: GetCouponCodeResponse; }>( () => { - return new Promise<{ response: AxiosResponse; body: GetCouponCodeResponse; }>((resolve, reject) => { + return backOff<{ response: AxiosResponse; body: GetCouponCodeResponseCompoundDocument; }>( () => { + return new Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCompoundDocument; }>((resolve, reject) => { axios(config) .then(axiosResponse => { let body; - body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeResponse"); + body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeResponseCompoundDocument"); resolve({ response: axiosResponse, body: body }); }) .catch(error => { @@ -393,9 +402,9 @@ export class CouponsApi { * Get a coupon code bulk create job with the given job ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` * @summary Get Coupon Code Bulk Create Job * @param jobId ID of the job to retrieve. - * @param fieldsCouponCodeBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCouponCodeBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ - public async getCouponCodeBulkCreateJob (jobId: string, options: { fieldsCouponCodeBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponse; }> { + public async getCouponCodeBulkCreateJob (jobId: string, options: { fieldsCouponCodeBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, fieldsCouponCode?: Array<'unique_code' | 'expires_at' | 'status'>, include?: Array<'coupon-codes'>, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCompoundDocument; }> { const localVarPath = this.basePath + '/api/coupon-code-bulk-create-jobs/{job_id}/' .replace('{' + 'job_id' + '}', encodeURIComponent(String(jobId))); @@ -418,6 +427,14 @@ export class CouponsApi { localVarQueryParameters['fields[coupon-code-bulk-create-job]'] = ObjectSerializer.serialize(options.fieldsCouponCodeBulkCreateJob, "Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>"); } + if (options.fieldsCouponCode !== undefined) { + localVarQueryParameters['fields[coupon-code]'] = ObjectSerializer.serialize(options.fieldsCouponCode, "Array<'unique_code' | 'expires_at' | 'status'>"); + } + + if (options.include !== undefined) { + localVarQueryParameters['include'] = ObjectSerializer.serialize(options.include, "Array<'coupon-codes'>"); + } + queryParamPreProcessor(localVarQueryParameters) let config: AxiosRequestConfig = { @@ -429,12 +446,12 @@ export class CouponsApi { this.session.applyToRequest(config) - return backOff<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponse; }>( () => { - return new Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponse; }>((resolve, reject) => { + return backOff<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCompoundDocument; }>( () => { + return new Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCompoundDocument; }>((resolve, reject) => { axios(config) .then(axiosResponse => { let body; - body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeCreateJobResponse"); + body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeCreateJobResponseCompoundDocument"); resolve({ response: axiosResponse, body: body }); }) .catch(error => { @@ -447,9 +464,9 @@ export class CouponsApi { * Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` * @summary Get Coupon Code Bulk Create Jobs - * @param fieldsCouponCodeBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCouponCodeBulkCreateJob For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ - public async getCouponCodeBulkCreateJobs (options: { fieldsCouponCodeBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCollection; }> { + public async getCouponCodeBulkCreateJobs (options: { fieldsCouponCodeBulkCreateJob?: Array<'job_id' | 'status' | 'created_at' | 'total_count' | 'completed_count' | 'failed_count' | 'completed_at' | 'errors' | 'expires_at'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCollectionCompoundDocument; }> { const localVarPath = this.basePath + '/api/coupon-code-bulk-create-jobs/'; let localVarQueryParameters: any = {}; @@ -485,12 +502,12 @@ export class CouponsApi { this.session.applyToRequest(config) - return backOff<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCollection; }>( () => { - return new Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCollection; }>((resolve, reject) => { + return backOff<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCollectionCompoundDocument; }>( () => { + return new Promise<{ response: AxiosResponse; body: GetCouponCodeCreateJobResponseCollectionCompoundDocument; }>((resolve, reject) => { axios(config) .then(axiosResponse => { let body; - body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeCreateJobResponseCollection"); + body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeCreateJobResponseCollectionCompoundDocument"); resolve({ response: axiosResponse, body: body }); }) .catch(error => { @@ -503,7 +520,7 @@ export class CouponsApi { * Gets a list of coupon code relationships associated with the given coupon id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` * @summary Get Coupon Code Relationships Coupon * @param id - * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCouponCodeRelationshipsCoupon (id: string, options: { pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponRelationshipCouponCodesListResponseCollection; }> { @@ -557,9 +574,9 @@ export class CouponsApi { * Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter params.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `coupon-codes:read` * @summary Get Coupon Codes - * @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ - public async getCouponCodes (options: { fieldsCouponCode?: Array<'unique_code' | 'expires_at' | 'status'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCollection; }> { + public async getCouponCodes (options: { fieldsCouponCode?: Array<'unique_code' | 'expires_at' | 'status'>, fieldsCoupon?: Array<'external_id' | 'description'>, filter?: string, include?: Array<'coupon'>, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCollectionCompoundDocument; }> { const localVarPath = this.basePath + '/api/coupon-codes/'; let localVarQueryParameters: any = {}; @@ -576,10 +593,18 @@ export class CouponsApi { localVarQueryParameters['fields[coupon-code]'] = ObjectSerializer.serialize(options.fieldsCouponCode, "Array<'unique_code' | 'expires_at' | 'status'>"); } + if (options.fieldsCoupon !== undefined) { + localVarQueryParameters['fields[coupon]'] = ObjectSerializer.serialize(options.fieldsCoupon, "Array<'external_id' | 'description'>"); + } + if (options.filter !== undefined) { localVarQueryParameters['filter'] = ObjectSerializer.serialize(options.filter, "string"); } + if (options.include !== undefined) { + localVarQueryParameters['include'] = ObjectSerializer.serialize(options.include, "Array<'coupon'>"); + } + if (options.pageCursor !== undefined) { localVarQueryParameters['page[cursor]'] = ObjectSerializer.serialize(options.pageCursor, "string"); } @@ -595,12 +620,12 @@ export class CouponsApi { this.session.applyToRequest(config) - return backOff<{ response: AxiosResponse; body: GetCouponCodeResponseCollection; }>( () => { - return new Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCollection; }>((resolve, reject) => { + return backOff<{ response: AxiosResponse; body: GetCouponCodeResponseCollectionCompoundDocument; }>( () => { + return new Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCollectionCompoundDocument; }>((resolve, reject) => { axios(config) .then(axiosResponse => { let body; - body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeResponseCollection"); + body = ObjectSerializer.deserialize(axiosResponse.data, "GetCouponCodeResponseCollectionCompoundDocument"); resolve({ response: axiosResponse, body: body }); }) .catch(error => { @@ -613,7 +638,7 @@ export class CouponsApi { * Gets a list of coupon codes associated with the given coupon id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:read` * @summary Get Coupon Codes For Coupon * @param id - * @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCouponCode For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCouponCodesForCoupon (id: string, options: { fieldsCouponCode?: Array<'unique_code' | 'expires_at' | 'status'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponCodeResponseCollection; }> { @@ -675,7 +700,7 @@ export class CouponsApi { * Gets a list of coupon codes associated with the given coupon id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` * @summary Get Coupon For Coupon Code * @param id - * @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getCouponForCouponCode (id: string, options: { fieldsCoupon?: Array<'external_id' | 'description'>, } = {}): Promise<{ response: AxiosResponse; body: GetCouponResponseCollection; }> { @@ -779,7 +804,7 @@ export class CouponsApi { * Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` * @summary Get Coupons - * @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsCoupon For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getCoupons (options: { fieldsCoupon?: Array<'external_id' | 'description'>, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetCouponResponseCollection; }> { diff --git a/api/dataPrivacyApi.ts b/api/dataPrivacyApi.ts index 4dc0c590..1807000b 100644 --- a/api/dataPrivacyApi.ts +++ b/api/dataPrivacyApi.ts @@ -37,8 +37,8 @@ export class DataPrivacyApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; diff --git a/api/eventsApi.ts b/api/eventsApi.ts index 86ce5cd5..0d2fe9ce 100644 --- a/api/eventsApi.ts +++ b/api/eventsApi.ts @@ -43,8 +43,8 @@ export class EventsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -122,12 +122,12 @@ export class EventsApi { }, this.session.getRetryOptions()); } /** - * Get an event with the given event ID. Include parameters can be provided to get the following related resource data: `metric`, `profile`

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `events:read` + * Get an event with the given event ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `events:read` * @summary Get Event * @param id ID of the event - * @param fieldsEvent For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsEvent For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ - public async getEvent (id: string, options: { fieldsEvent?: Array<'timestamp' | 'event_properties' | 'datetime' | 'uuid'>, fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail'>, include?: Array<'metric' | 'profile'>, } = {}): Promise<{ response: AxiosResponse; body: GetEventResponseCompoundDocument; }> { + public async getEvent (id: string, options: { fieldsEvent?: Array<'timestamp' | 'event_properties' | 'datetime' | 'uuid'>, fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties'>, include?: Array<'metric' | 'profile'>, } = {}): Promise<{ response: AxiosResponse; body: GetEventResponseCompoundDocument; }> { const localVarPath = this.basePath + '/api/events/{id}/' .replace('{' + 'id' + '}', encodeURIComponent(String(id))); @@ -155,7 +155,7 @@ export class EventsApi { } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties'>"); } if (options.include !== undefined) { @@ -191,7 +191,7 @@ export class EventsApi { * Get the metric for an event with the given event ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:read` `metrics:read` * @summary Get Event Metric * @param id - * @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getEventMetric (id: string, options: { fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, } = {}): Promise<{ response: AxiosResponse; body: GetMetricResponse; }> { @@ -245,9 +245,9 @@ export class EventsApi { * Get the profile associated with an event with the given event ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:read` `profiles:read` * @summary Get Event Profile * @param id - * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'subscriptions\', \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ - public async getEventProfile (id: string, options: { additionalFieldsProfile?: Array<'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, } = {}): Promise<{ response: AxiosResponse; body: GetProfileResponse; }> { + public async getEventProfile (id: string, options: { additionalFieldsProfile?: Array<'subscriptions' | 'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, } = {}): Promise<{ response: AxiosResponse; body: GetProfileResponse; }> { const localVarPath = this.basePath + '/api/events/{id}/profile/' .replace('{' + 'id' + '}', encodeURIComponent(String(id))); @@ -267,11 +267,11 @@ export class EventsApi { } if (options.additionalFieldsProfile !== undefined) { - localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'predictive_analytics'>"); + localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'subscriptions' | 'predictive_analytics'>"); } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); } queryParamPreProcessor(localVarQueryParameters) @@ -400,12 +400,12 @@ export class EventsApi { }, this.session.getRetryOptions()); } /** - * 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: `metric`, `profile` Returns a maximum of 200 events per page.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:read` + * Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Returns a maximum of 200 events per page.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:read` * @summary Get Events - * @param fieldsEvent For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsEvent For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ - public async getEvents (options: { fieldsEvent?: Array<'timestamp' | 'event_properties' | 'datetime' | 'uuid'>, fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail'>, filter?: string, include?: Array<'metric' | 'profile'>, pageCursor?: string, sort?: 'datetime' | '-datetime' | 'timestamp' | '-timestamp', } = {}): Promise<{ response: AxiosResponse; body: GetEventResponseCollectionCompoundDocument; }> { + public async getEvents (options: { fieldsEvent?: Array<'timestamp' | 'event_properties' | 'datetime' | 'uuid'>, fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties'>, filter?: string, include?: Array<'metric' | 'profile'>, pageCursor?: string, sort?: 'datetime' | '-datetime' | 'timestamp' | '-timestamp', } = {}): Promise<{ response: AxiosResponse; body: GetEventResponseCollectionCompoundDocument; }> { const localVarPath = this.basePath + '/api/events/'; let localVarQueryParameters: any = {}; @@ -427,7 +427,7 @@ export class EventsApi { } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties'>"); } if (options.filter !== undefined) { diff --git a/api/flowsApi.ts b/api/flowsApi.ts index dc8400c8..66caaf67 100644 --- a/api/flowsApi.ts +++ b/api/flowsApi.ts @@ -54,8 +54,8 @@ export class FlowsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -84,10 +84,10 @@ export class FlowsApi { } /** - * Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` + * Get a flow with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow * @param id - * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getFlow (id: string, options: { fieldsFlowAction?: Array<'action_type' | 'status' | 'created' | 'updated' | 'settings' | 'tracking_options' | 'send_options' | 'send_options.use_smart_sending' | 'send_options.is_transactional' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language'>, fieldsFlow?: Array<'name' | 'status' | 'archived' | 'created' | 'updated' | 'trigger_type'>, fieldsTag?: Array<'name'>, include?: Array<'flow-actions' | 'tags'>, } = {}): Promise<{ response: AxiosResponse; body: GetFlowResponseCompoundDocument; }> { @@ -150,10 +150,10 @@ export class FlowsApi { }, this.session.getRetryOptions()); } /** - * Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flow`, `flow-messages`

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` + * Get a flow action from a flow with the given flow action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Action * @param id - * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getFlowAction (id: string, options: { fieldsFlowAction?: Array<'action_type' | 'status' | 'created' | 'updated' | 'settings' | 'tracking_options' | 'send_options' | 'send_options.use_smart_sending' | 'send_options.is_transactional' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language'>, fieldsFlowMessage?: Array<'name' | 'channel' | 'content' | 'created' | 'updated'>, fieldsFlow?: Array<'name' | 'status' | 'archived' | 'created' | 'updated' | 'trigger_type'>, include?: Array<'flow' | 'flow-messages'>, } = {}): Promise<{ response: AxiosResponse; body: GetFlowActionResponseCompoundDocument; }> { @@ -219,7 +219,7 @@ export class FlowsApi { * Get the flow associated with the given action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow For Flow Action * @param id - * @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getFlowActionFlow (id: string, options: { fieldsFlow?: Array<'name' | 'status' | 'archived' | 'created' | 'updated' | 'trigger_type'>, } = {}): Promise<{ response: AxiosResponse; body: GetFlowResponse; }> { @@ -273,7 +273,7 @@ export class FlowsApi { * 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]`

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Action Messages * @param id - * @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageSize Default: 50. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageSize Default: 50. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getFlowActionMessages (id: string, options: { fieldsFlowMessage?: Array<'name' | 'channel' | 'content' | 'created' | 'updated'>, filter?: string, pageSize?: number, sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetFlowMessageResponseCollection; }> { @@ -389,7 +389,7 @@ export class FlowsApi { * Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Action Relationships Messages * @param id - * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getFlowActionRelationshipsMessages (id: string, options: { filter?: string, pageCursor?: string, pageSize?: number, sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetFlowActionFlowMessageRelationshipResponseCollection; }> { @@ -455,7 +455,7 @@ export class FlowsApi { * Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Flow Actions * @param id - * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getFlowFlowActions (id: string, options: { fieldsFlowAction?: Array<'action_type' | 'status' | 'created' | 'updated' | 'settings' | 'tracking_options' | 'send_options' | 'send_options.use_smart_sending' | 'send_options.is_transactional' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'action_type' | '-action_type' | 'created' | '-created' | 'id' | '-id' | 'status' | '-status' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetFlowActionResponseCollection; }> { @@ -522,10 +522,10 @@ export class FlowsApi { }, this.session.getRetryOptions()); } /** - * 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\'

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` + * Get the flow message of a flow with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Message * @param id - * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getFlowMessage (id: string, options: { fieldsFlowAction?: Array<'action_type' | 'status' | 'created' | 'updated' | 'settings' | 'tracking_options' | 'send_options' | 'send_options.use_smart_sending' | 'send_options.is_transactional' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language'>, fieldsFlowMessage?: Array<'name' | 'channel' | 'content' | 'created' | 'updated'>, fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, include?: Array<'flow-action' | 'template'>, } = {}): Promise<{ response: AxiosResponse; body: GetFlowMessageResponseCompoundDocument; }> { @@ -591,7 +591,7 @@ export class FlowsApi { * Get the flow action for a flow message with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Action For Message * @param id - * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getFlowMessageAction (id: string, options: { fieldsFlowAction?: Array<'action_type' | 'status' | 'created' | 'updated' | 'settings' | 'tracking_options' | 'send_options' | 'send_options.use_smart_sending' | 'send_options.is_transactional' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language'>, } = {}): Promise<{ response: AxiosResponse; body: GetFlowActionResponse; }> { @@ -745,7 +745,7 @@ export class FlowsApi { * Return the related template

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `templates:read` * @summary Get Flow Message Template * @param id - * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getFlowMessageTemplate (id: string, options: { fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetTemplateResponse; }> { @@ -799,7 +799,7 @@ export class FlowsApi { * Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Relationships Flow Actions * @param id - * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageSize Default: 50. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageSize Default: 50. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getFlowRelationshipsFlowActions (id: string, options: { filter?: string, pageSize?: number, sort?: 'created' | '-created' | 'id' | '-id' | 'status' | '-status' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetFlowFlowActionRelationshipListResponseCollection; }> { @@ -911,7 +911,7 @@ export class FlowsApi { * Return all tags associated with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` `tags:read` * @summary Get Flow Tags * @param id - * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getFlowTags (id: string, options: { fieldsTag?: Array<'name'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCollection; }> { @@ -965,7 +965,7 @@ export class FlowsApi { * Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flows - * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getFlows (options: { fieldsFlowAction?: Array<'action_type' | 'status' | 'created' | 'updated' | 'settings' | 'tracking_options' | 'send_options' | 'send_options.use_smart_sending' | 'send_options.is_transactional' | 'render_options' | 'render_options.shorten_links' | 'render_options.add_org_prefix' | 'render_options.add_info_link' | 'render_options.add_opt_out_language'>, fieldsFlow?: Array<'name' | 'status' | 'archived' | 'created' | 'updated' | 'trigger_type'>, fieldsTag?: Array<'name'>, filter?: string, include?: Array<'flow-actions' | 'tags'>, pageCursor?: string, pageSize?: number, sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'status' | '-status' | 'trigger_type' | '-trigger_type' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetFlowResponseCollectionCompoundDocument; }> { diff --git a/api/imagesApi.ts b/api/imagesApi.ts index d705236c..ebbb63f3 100644 --- a/api/imagesApi.ts +++ b/api/imagesApi.ts @@ -42,8 +42,8 @@ export class ImagesApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -75,7 +75,7 @@ export class ImagesApi { * Get the image with the given image ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:read` * @summary Get Image * @param id The ID of the image - * @param fieldsImage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsImage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getImage (id: string, options: { fieldsImage?: Array<'name' | 'image_url' | 'format' | 'size' | 'hidden' | 'updated_at'>, } = {}): Promise<{ response: AxiosResponse; body: GetImageResponse; }> { @@ -129,7 +129,7 @@ export class ImagesApi { * Get all images in an account.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:read` * @summary Get Images - * @param fieldsImage For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsImage For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getImages (options: { fieldsImage?: Array<'name' | 'image_url' | 'format' | 'size' | 'hidden' | 'updated_at'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'format' | '-format' | 'id' | '-id' | 'name' | '-name' | 'size' | '-size' | 'updated_at' | '-updated_at', } = {}): Promise<{ response: AxiosResponse; body: GetImageResponseCollection; }> { @@ -246,7 +246,7 @@ export class ImagesApi { }, this.session.getRetryOptions()); } /** - * Upload an image from a file. If you want to import an image from an existing url or a data uri, use the Create Image API instead. + * Upload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead. * @summary Upload Image From File * @param file The image file to upload. Supported image formats: jpeg,png,gif. Maximum image size: 5MB. * @param name A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.* @param hidden If true, this image is not shown in the asset library. @@ -306,7 +306,7 @@ export class ImagesApi { }, this.session.getRetryOptions()); } /** - * Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image API instead.

*Rate limits*:
Burst: `3/s`
Steady: `100/d` **Scopes:** `images:write` + * Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.

*Rate limits*:
Burst: `3/s`
Steady: `100/d` **Scopes:** `images:write` * @summary Upload Image From URL * @param imageCreateQuery diff --git a/api/listsApi.ts b/api/listsApi.ts index 783407b5..1c7281e3 100644 --- a/api/listsApi.ts +++ b/api/listsApi.ts @@ -48,8 +48,8 @@ export class ListsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -128,7 +128,7 @@ export class ListsApi { }, this.session.getRetryOptions()); } /** - * Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you\'re trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `list:write` `profiles:write` + * Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you\'re trying to give a profile consent to receive email marketing, SMS marketing, or both. This endpoint accepts a maximum of 1000 profiles per call.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `list:write` `profiles:write` * @summary Add Profile To List * @param id * @param listMembersAddQuery @@ -287,10 +287,10 @@ export class ListsApi { }, this.session.getRetryOptions()); } /** - * Get a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-09-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `list:read` + * Get a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `list:read` * @summary Get List * @param id Primary key that uniquely identifies this list. Generated by Klaviyo. - * @param additionalFieldsList Request additional fields not included by default in the response. Supported values: \'profile_count\'* @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param additionalFieldsList Request additional fields not included by default in the response. Supported values: \'profile_count\'* @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getList (id: string, options: { additionalFieldsList?: Array<'profile_count'>, fieldsList?: Array<'name' | 'created' | 'updated' | 'profile_count'>, fieldsTag?: Array<'name'>, include?: Array<'tags'>, } = {}): Promise<{ response: AxiosResponse; body: GetListRetrieveResponseCompoundDocument; }> { @@ -353,12 +353,12 @@ export class ListsApi { }, this.session.getRetryOptions()); } /** - * 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`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-09-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `list:read` `profiles:read` + * 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`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `list:read` `profiles:read` * @summary Get List Profiles * @param id - * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'subscriptions\', \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ - public async getListProfiles (id: string, options: { additionalFieldsProfile?: Array<'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'joined_group_at' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'joined_group_at' | '-joined_group_at', } = {}): Promise<{ response: AxiosResponse; body: GetListMemberResponseCollection; }> { + public async getListProfiles (id: string, options: { additionalFieldsProfile?: Array<'subscriptions' | 'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'joined_group_at' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'joined_group_at' | '-joined_group_at', } = {}): Promise<{ response: AxiosResponse; body: GetListMemberResponseCollection; }> { const localVarPath = this.basePath + '/api/lists/{id}/profiles/' .replace('{' + 'id' + '}', encodeURIComponent(String(id))); @@ -378,11 +378,11 @@ export class ListsApi { } if (options.additionalFieldsProfile !== undefined) { - localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'predictive_analytics'>"); + localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'subscriptions' | 'predictive_analytics'>"); } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'joined_group_at' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'joined_group_at' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); } if (options.filter !== undefined) { @@ -430,7 +430,7 @@ export class ListsApi { * Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `list:read` `profiles:read` * @summary Get List Relationships Profiles * @param id - * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 1000.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 1000.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getListRelationshipsProfiles (id: string, options: { filter?: string, pageCursor?: string, pageSize?: number, sort?: 'joined_group_at' | '-joined_group_at', } = {}): Promise<{ response: AxiosResponse; body: GetListRelationshipsResponseCollection; }> { @@ -546,7 +546,7 @@ export class ListsApi { * Return all tags associated with the given list ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `list:read` `tags:read` * @summary Get List Tags * @param id - * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getListTags (id: string, options: { fieldsTag?: Array<'name'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCollection; }> { @@ -600,7 +600,7 @@ export class ListsApi { * 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.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `list:read` * @summary Get Lists - * @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/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`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/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`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getLists (options: { fieldsList?: Array<'name' | 'created' | 'updated'>, fieldsTag?: Array<'name'>, filter?: string, include?: Array<'tags'>, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetListListResponseCollectionCompoundDocument; }> { diff --git a/api/metricsApi.ts b/api/metricsApi.ts index 1027c0b0..b428702d 100644 --- a/api/metricsApi.ts +++ b/api/metricsApi.ts @@ -40,8 +40,8 @@ export class MetricsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -73,7 +73,7 @@ export class MetricsApi { * Get a metric with the given metric ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `metrics:read` * @summary Get Metric * @param id Metric ID - * @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getMetric (id: string, options: { fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, } = {}): Promise<{ response: AxiosResponse; body: GetMetricResponse; }> { @@ -127,7 +127,7 @@ export class MetricsApi { * Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `metrics:read` * @summary Get Metrics - * @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsMetric For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getMetrics (options: { fieldsMetric?: Array<'name' | 'created' | 'updated' | 'integration'>, filter?: string, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetMetricResponseCollection; }> { diff --git a/api/profilesApi.ts b/api/profilesApi.ts index 323fc3a1..181736d1 100644 --- a/api/profilesApi.ts +++ b/api/profilesApi.ts @@ -53,8 +53,8 @@ export class ProfilesApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -182,12 +182,12 @@ export class ProfilesApi { }, this.session.getRetryOptions()); } /** - * Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` (memberships), `segments` (memberships)

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:read` + * Get the profile with the given profile ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:read` * @summary Get Profile * @param id - * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'predictive_analytics\'* @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'subscriptions\', \'predictive_analytics\'* @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ - public async getProfile (id: string, options: { additionalFieldsProfile?: Array<'predictive_analytics'>, fieldsList?: Array<'name' | 'created' | 'updated'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, fieldsSegment?: Array<'name' | 'created' | 'updated'>, include?: Array<'lists' | 'segments'>, } = {}): Promise<{ response: AxiosResponse; body: GetProfileResponseCompoundDocument; }> { + public async getProfile (id: string, options: { additionalFieldsProfile?: Array<'subscriptions' | 'predictive_analytics'>, fieldsList?: Array<'name' | 'created' | 'updated'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, fieldsSegment?: Array<'name' | 'created' | 'updated'>, include?: Array<'lists' | 'segments'>, } = {}): Promise<{ response: AxiosResponse; body: GetProfileResponseCompoundDocument; }> { const localVarPath = this.basePath + '/api/profiles/{id}/' .replace('{' + 'id' + '}', encodeURIComponent(String(id))); @@ -207,7 +207,7 @@ export class ProfilesApi { } if (options.additionalFieldsProfile !== undefined) { - localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'predictive_analytics'>"); + localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'subscriptions' | 'predictive_analytics'>"); } if (options.fieldsList !== undefined) { @@ -215,7 +215,7 @@ export class ProfilesApi { } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); } if (options.fieldsSegment !== undefined) { @@ -255,7 +255,7 @@ export class ProfilesApi { * Get list memberships for a profile with the given profile ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `list:read` `profiles:read` * @summary Get Profile Lists * @param id - * @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsList For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getProfileLists (id: string, options: { fieldsList?: Array<'name' | 'created' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetListResponseCollection; }> { @@ -409,7 +409,7 @@ export class ProfilesApi { * Get segment memberships for a profile with the given profile ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `profiles:read` `segments:read` * @summary Get Profile Segments * @param id - * @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getProfileSegments (id: string, options: { fieldsSegment?: Array<'name' | 'created' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetSegmentResponseCollection; }> { @@ -460,12 +460,12 @@ export class ProfilesApi { }, this.session.getRetryOptions()); } /** - * Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-09-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` + * Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` * @summary Get Profiles - * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/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>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'subscriptions\', \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/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>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ - public async getProfiles (options: { additionalFieldsProfile?: Array<'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'created' | '-created' | 'email' | '-email' | 'id' | '-id' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetProfileResponseCollectionCompoundDocument; }> { + public async getProfiles (options: { additionalFieldsProfile?: Array<'subscriptions' | 'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'created' | '-created' | 'email' | '-email' | 'id' | '-id' | 'updated' | '-updated' | 'subscriptions.email.marketing.list_suppressions.timestamp' | '-subscriptions.email.marketing.list_suppressions.timestamp' | 'subscriptions.email.marketing.suppression.timestamp' | '-subscriptions.email.marketing.suppression.timestamp', } = {}): Promise<{ response: AxiosResponse; body: GetProfileResponseCollectionCompoundDocument; }> { const localVarPath = this.basePath + '/api/profiles/'; let localVarQueryParameters: any = {}; @@ -479,11 +479,11 @@ export class ProfilesApi { } if (options.additionalFieldsProfile !== undefined) { - localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'predictive_analytics'>"); + localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'subscriptions' | 'predictive_analytics'>"); } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); } if (options.filter !== undefined) { @@ -499,7 +499,7 @@ export class ProfilesApi { } if (options.sort !== undefined) { - localVarQueryParameters['sort'] = ObjectSerializer.serialize(options.sort, "'created' | '-created' | 'email' | '-email' | 'id' | '-id' | 'updated' | '-updated'"); + localVarQueryParameters['sort'] = ObjectSerializer.serialize(options.sort, "'created' | '-created' | 'email' | '-email' | 'id' | '-id' | 'updated' | '-updated' | 'subscriptions.email.marketing.list_suppressions.timestamp' | '-subscriptions.email.marketing.list_suppressions.timestamp' | 'subscriptions.email.marketing.suppression.timestamp' | '-subscriptions.email.marketing.suppression.timestamp'"); } queryParamPreProcessor(localVarQueryParameters) diff --git a/api/segmentsApi.ts b/api/segmentsApi.ts index 9b86ceea..ec1a1ae2 100644 --- a/api/segmentsApi.ts +++ b/api/segmentsApi.ts @@ -44,8 +44,8 @@ export class SegmentsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -74,10 +74,10 @@ export class SegmentsApi { } /** - * Get a segment with the given segment ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-09-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` + * Get a segment with the given segment ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` * @summary Get Segment * @param id - * @param additionalFieldsSegment Request additional fields not included by default in the response. Supported values: \'profile_count\'* @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param additionalFieldsSegment Request additional fields not included by default in the response. Supported values: \'profile_count\'* @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getSegment (id: string, options: { additionalFieldsSegment?: Array<'profile_count'>, fieldsSegment?: Array<'name' | 'created' | 'updated' | 'profile_count'>, fieldsTag?: Array<'name'>, include?: Array<'tags'>, } = {}): Promise<{ response: AxiosResponse; body: GetSegmentRetrieveResponseCompoundDocument; }> { @@ -143,9 +143,9 @@ export class SegmentsApi { * Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:read` `segments:read` * @summary Get Segment Profiles * @param id - * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param additionalFieldsProfile Request additional fields not included by default in the response. Supported values: \'subscriptions\', \'predictive_analytics\'* @param fieldsProfile For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ - public async getSegmentProfiles (id: string, options: { additionalFieldsProfile?: Array<'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'joined_group_at' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'joined_group_at' | '-joined_group_at', } = {}): Promise<{ response: AxiosResponse; body: GetSegmentMemberResponseCollection; }> { + public async getSegmentProfiles (id: string, options: { additionalFieldsProfile?: Array<'subscriptions' | 'predictive_analytics'>, fieldsProfile?: Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'joined_group_at' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>, filter?: string, pageCursor?: string, pageSize?: number, sort?: 'joined_group_at' | '-joined_group_at', } = {}): Promise<{ response: AxiosResponse; body: GetSegmentMemberResponseCollection; }> { const localVarPath = this.basePath + '/api/segments/{id}/profiles/' .replace('{' + 'id' + '}', encodeURIComponent(String(id))); @@ -165,11 +165,11 @@ export class SegmentsApi { } if (options.additionalFieldsProfile !== undefined) { - localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'predictive_analytics'>"); + localVarQueryParameters['additional-fields[profile]'] = ObjectSerializer.serialize(options.additionalFieldsProfile, "Array<'subscriptions' | 'predictive_analytics'>"); } if (options.fieldsProfile !== undefined) { - localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'properties' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.timestamp' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppressions' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'joined_group_at' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); + localVarQueryParameters['fields[profile]'] = ObjectSerializer.serialize(options.fieldsProfile, "Array<'email' | 'phone_number' | 'external_id' | 'first_name' | 'last_name' | 'organization' | 'title' | 'image' | 'created' | 'updated' | 'last_event_date' | 'location' | 'location.address1' | 'location.address2' | 'location.city' | 'location.country' | 'location.latitude' | 'location.longitude' | 'location.region' | 'location.zip' | 'location.timezone' | 'location.ip' | 'properties' | 'joined_group_at' | 'subscriptions' | 'subscriptions.email' | 'subscriptions.email.marketing' | 'subscriptions.email.marketing.can_receive_email_marketing' | 'subscriptions.email.marketing.consent' | 'subscriptions.email.marketing.consent_timestamp' | 'subscriptions.email.marketing.last_updated' | 'subscriptions.email.marketing.method' | 'subscriptions.email.marketing.method_detail' | 'subscriptions.email.marketing.custom_method_detail' | 'subscriptions.email.marketing.double_optin' | 'subscriptions.email.marketing.suppression' | 'subscriptions.email.marketing.list_suppressions' | 'subscriptions.sms' | 'subscriptions.sms.marketing' | 'subscriptions.sms.marketing.can_receive_sms_marketing' | 'subscriptions.sms.marketing.consent' | 'subscriptions.sms.marketing.consent_timestamp' | 'subscriptions.sms.marketing.method' | 'subscriptions.sms.marketing.method_detail' | 'subscriptions.sms.marketing.last_updated' | 'predictive_analytics' | 'predictive_analytics.historic_clv' | 'predictive_analytics.predicted_clv' | 'predictive_analytics.total_clv' | 'predictive_analytics.historic_number_of_orders' | 'predictive_analytics.predicted_number_of_orders' | 'predictive_analytics.average_days_between_orders' | 'predictive_analytics.average_order_value' | 'predictive_analytics.churn_probability' | 'predictive_analytics.expected_date_of_next_order'>"); } if (options.filter !== undefined) { @@ -217,7 +217,7 @@ export class SegmentsApi { * Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:read` `segments:read` * @summary Get Segment Relationships Profiles * @param id - * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 1000.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 1000.* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getSegmentRelationshipsProfiles (id: string, options: { filter?: string, pageCursor?: string, pageSize?: number, sort?: 'joined_group_at' | '-joined_group_at', } = {}): Promise<{ response: AxiosResponse; body: GetSegmentRelationshipsResponseCollection; }> { @@ -333,7 +333,7 @@ export class SegmentsApi { * Return all tags associated with the given segment ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `segments:read` `tags:read` * @summary Get Segment Tags * @param id - * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getSegmentTags (id: string, options: { fieldsTag?: Array<'name'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCollection; }> { @@ -387,7 +387,7 @@ export class SegmentsApi { * Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `segments:read` * @summary Get Segments - * @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/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`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination + * @param fieldsSegment For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/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`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination */ public async getSegments (options: { fieldsSegment?: Array<'name' | 'created' | 'updated'>, fieldsTag?: Array<'name'>, filter?: string, include?: Array<'tags'>, pageCursor?: string, } = {}): Promise<{ response: AxiosResponse; body: GetSegmentListResponseCollectionCompoundDocument; }> { diff --git a/api/tagsApi.ts b/api/tagsApi.ts index 114bf0e0..3bda71bb 100644 --- a/api/tagsApi.ts +++ b/api/tagsApi.ts @@ -59,8 +59,8 @@ export class TagsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -731,7 +731,7 @@ export class TagsApi { * Retrieve the tag with the given tag ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` * @summary Get Tag * @param id The Tag ID - * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships + * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships */ public async getTag (id: string, options: { fieldsTagGroup?: Array<'name' | 'exclusive' | 'default'>, fieldsTag?: Array<'name'>, include?: Array<'tag-group'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCompoundDocument; }> { @@ -793,7 +793,7 @@ export class TagsApi { * Retrieve the tag group with the given tag group ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` * @summary Get Tag Group * @param id The Tag Group ID - * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getTagGroup (id: string, options: { fieldsTagGroup?: Array<'name' | 'exclusive' | 'default'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagGroupResponse; }> { @@ -897,7 +897,7 @@ export class TagsApi { * Return the tags for a given tag group ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` * @summary Get Tag Group Tags * @param id - * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getTagGroupTags (id: string, options: { fieldsTag?: Array<'name'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCollection; }> { @@ -951,7 +951,7 @@ export class TagsApi { * List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` * @summary Get Tag Groups - * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getTagGroups (options: { fieldsTagGroup?: Array<'name' | 'exclusive' | 'default'>, filter?: string, pageCursor?: string, sort?: 'id' | '-id' | 'name' | '-name', } = {}): Promise<{ response: AxiosResponse; body: GetTagGroupResponseCollection; }> { @@ -1261,7 +1261,7 @@ export class TagsApi { * Returns the tag group resource for a given tag ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` * @summary Get Tag Tag Group * @param id - * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getTagTagGroup (id: string, options: { fieldsTagGroup?: Array<'name' | 'exclusive' | 'default'>, } = {}): Promise<{ response: AxiosResponse; body: GetTagGroupResponse; }> { @@ -1315,7 +1315,7 @@ export class TagsApi { * List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` * @summary Get Tags - * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsTagGroup For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`* @param include For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getTags (options: { fieldsTagGroup?: Array<'name' | 'exclusive' | 'default'>, fieldsTag?: Array<'name'>, filter?: string, include?: Array<'tag-group'>, pageCursor?: string, sort?: 'id' | '-id' | 'name' | '-name', } = {}): Promise<{ response: AxiosResponse; body: GetTagResponseCollectionCompoundDocument; }> { diff --git a/api/templatesApi.ts b/api/templatesApi.ts index ae05ad7c..2e75eb6d 100644 --- a/api/templatesApi.ts +++ b/api/templatesApi.ts @@ -44,8 +44,8 @@ export class TemplatesApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = { - revision: "2023-09-15", - "User-Agent": "klaviyo-api-node/6.0.1" + revision: "2023-10-15", + "User-Agent": "klaviyo-api-node/7.0.0" }; protected _useQuerystring : boolean = false; @@ -276,7 +276,7 @@ export class TemplatesApi { * Get a template with the given template ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `templates:read` * @summary Get Template * @param id The ID of template - * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets + * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets */ public async getTemplate (id: string, options: { fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, } = {}): Promise<{ response: AxiosResponse; body: GetTemplateResponse; }> { @@ -330,7 +330,7 @@ export class TemplatesApi { * Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 10 results per page.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `templates:read` * @summary Get Templates - * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting + * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination* @param sort For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting */ public async getTemplates (options: { fieldsTemplate?: Array<'name' | 'editor_type' | 'html' | 'text' | 'created' | 'updated'>, filter?: string, pageCursor?: string, sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'updated' | '-updated', } = {}): Promise<{ response: AxiosResponse; body: GetTemplateResponseCollection; }> { diff --git a/model/couponCodeCreateQueryResourceObjectRelationshipsCoupon.ts b/model/couponCodeCreateQueryResourceObjectRelationshipsCoupon.ts index d0a7d062..dede06fc 100644 --- a/model/couponCodeCreateQueryResourceObjectRelationshipsCoupon.ts +++ b/model/couponCodeCreateQueryResourceObjectRelationshipsCoupon.ts @@ -10,10 +10,10 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData'; export class CouponCodeCreateQueryResourceObjectRelationshipsCoupon { - 'data': GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData; + 'data': GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData; static discriminator: string | undefined = undefined; @@ -21,7 +21,7 @@ export class CouponCodeCreateQueryResourceObjectRelationshipsCoupon { { "name": "data", "baseName": "data", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData" + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData" } ]; static getAttributeTypeMap() { diff --git a/model/emailMarketing.ts b/model/emailMarketing.ts index f787139e..dd50ff67 100644 --- a/model/emailMarketing.ts +++ b/model/emailMarketing.ts @@ -14,20 +14,28 @@ import { EmailMarketingListSuppression } from './emailMarketingListSuppression'; import { EmailMarketingSuppression } from './emailMarketingSuppression'; export class EmailMarketing { + /** + * Whether or not this profile has implicit consent to receive email marketing. True if it does profile does not have any global suppressions. + */ + 'canReceiveEmailMarketing': boolean; /** * The consent status for email marketing. */ 'consent': string; /** - * The timestamp when consent record or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). + * The timestamp when consent was recorded or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). */ - 'timestamp'?: Date; + 'consentTimestamp'?: Date; + /** + * The timestamp when a field on the email marketing object was last modified. + */ + 'lastUpdated'?: Date; /** * The method by which the profile was subscribed to email marketing. */ - 'method': string; + 'method'?: string; /** - * Additional details about the method by which the profile was subscribed to SMS marketing. This may be empty if no details were provided. + * Additional details about the method by which the profile was subscribed to email marketing. This may be empty if no details were provided. */ 'methodDetail'?: string = ''; /** @@ -39,9 +47,9 @@ export class EmailMarketing { */ 'doubleOptin'?: boolean; /** - * The global email marketing suppressions for this profile. + * The global email marketing suppression for this profile. */ - 'suppressions'?: Array; + 'suppression'?: Array; /** * The list suppressions for this profile. */ @@ -50,14 +58,24 @@ export class EmailMarketing { static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "canReceiveEmailMarketing", + "baseName": "can_receive_email_marketing", + "type": "boolean" + }, { "name": "consent", "baseName": "consent", "type": "string" }, { - "name": "timestamp", - "baseName": "timestamp", + "name": "consentTimestamp", + "baseName": "consent_timestamp", + "type": "Date" + }, + { + "name": "lastUpdated", + "baseName": "last_updated", "type": "Date" }, { @@ -81,8 +99,8 @@ export class EmailMarketing { "type": "boolean" }, { - "name": "suppressions", - "baseName": "suppressions", + "name": "suppression", + "baseName": "suppression", "type": "Array" }, { diff --git a/model/getCouponCodeResponse.ts b/model/emailSubscriptionParameters.ts similarity index 60% rename from model/getCouponCodeResponse.ts rename to model/emailSubscriptionParameters.ts index 7a21e254..8f866b21 100644 --- a/model/getCouponCodeResponse.ts +++ b/model/emailSubscriptionParameters.ts @@ -10,22 +10,22 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeResponseCollectionDataInner } from './getCouponCodeResponseCollectionDataInner'; +import { MarketingSubscriptionParameters } from './marketingSubscriptionParameters'; -export class GetCouponCodeResponse { - 'data': GetCouponCodeResponseCollectionDataInner; +export class EmailSubscriptionParameters { + 'marketing': MarketingSubscriptionParameters; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ { - "name": "data", - "baseName": "data", - "type": "GetCouponCodeResponseCollectionDataInner" + "name": "marketing", + "baseName": "marketing", + "type": "MarketingSubscriptionParameters" } ]; static getAttributeTypeMap() { - return GetCouponCodeResponse.attributeTypeMap; + return EmailSubscriptionParameters.attributeTypeMap; } } diff --git a/model/getCouponCodeCreateJobResponseCollection.ts b/model/getCouponCodeCreateJobResponseCollectionCompoundDocument.ts similarity index 67% rename from model/getCouponCodeCreateJobResponseCollection.ts rename to model/getCouponCodeCreateJobResponseCollectionCompoundDocument.ts index 7539eb76..3ebf274c 100644 --- a/model/getCouponCodeCreateJobResponseCollection.ts +++ b/model/getCouponCodeCreateJobResponseCollectionCompoundDocument.ts @@ -11,10 +11,10 @@ import { RequestFile } from './models'; import { CollectionLinks } from './collectionLinks'; -import { GetCouponCodeCreateJobResponseCollectionDataInner } from './getCouponCodeCreateJobResponseCollectionDataInner'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner'; -export class GetCouponCodeCreateJobResponseCollection { - 'data': Array; +export class GetCouponCodeCreateJobResponseCollectionCompoundDocument { + 'data': Array; 'links': CollectionLinks; static discriminator: string | undefined = undefined; @@ -23,7 +23,7 @@ export class GetCouponCodeCreateJobResponseCollection { { "name": "data", "baseName": "data", - "type": "Array" + "type": "Array" }, { "name": "links", @@ -32,7 +32,7 @@ export class GetCouponCodeCreateJobResponseCollection { } ]; static getAttributeTypeMap() { - return GetCouponCodeCreateJobResponseCollection.attributeTypeMap; + return GetCouponCodeCreateJobResponseCollectionCompoundDocument.attributeTypeMap; } } diff --git a/model/getCouponCodeCreateJobResponseCollectionDataInner.ts b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner.ts similarity index 60% rename from model/getCouponCodeCreateJobResponseCollectionDataInner.ts rename to model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner.ts index 6a8a4ee5..8f3cf4be 100644 --- a/model/getCouponCodeCreateJobResponseCollectionDataInner.ts +++ b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner.ts @@ -13,11 +13,11 @@ import { RequestFile } from './models'; import { CouponCodeBulkCreateJobEnum } from './couponCodeBulkCreateJobEnum'; import { CouponCodeCreateJobResponseObjectResource } from './couponCodeCreateJobResponseObjectResource'; import { CouponCodeCreateJobResponseObjectResourceAttributes } from './couponCodeCreateJobResponseObjectResourceAttributes'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; import { ObjectLinks } from './objectLinks'; -export class GetCouponCodeCreateJobResponseCollectionDataInner extends CouponCodeCreateJobResponseObjectResource { - 'relationships'?: GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships; +export class GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner extends CouponCodeCreateJobResponseObjectResource { + 'relationships'?: GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships; static discriminator: string | undefined = undefined; @@ -25,13 +25,13 @@ export class GetCouponCodeCreateJobResponseCollectionDataInner extends CouponCod { "name": "relationships", "baseName": "relationships", - "type": "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships" + "type": "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships" } ]; static getAttributeTypeMap() { - return super.getAttributeTypeMap().concat(GetCouponCodeCreateJobResponseCollectionDataInner.attributeTypeMap); + return super.getAttributeTypeMap().concat(GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner.attributeTypeMap); } } -export namespace GetCouponCodeCreateJobResponseCollectionDataInner { +export namespace GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner { } diff --git a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOf.ts b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf.ts similarity index 52% rename from model/getCouponCodeCreateJobResponseCollectionDataInnerAllOf.ts rename to model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf.ts index e50577c5..c43d9325 100644 --- a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOf.ts +++ b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf.ts @@ -10,10 +10,10 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; -export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOf { - 'relationships'?: GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships; +export class GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf { + 'relationships'?: GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships; static discriminator: string | undefined = undefined; @@ -21,11 +21,11 @@ export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOf { { "name": "relationships", "baseName": "relationships", - "type": "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships" + "type": "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships" } ]; static getAttributeTypeMap() { - return GetCouponCodeCreateJobResponseCollectionDataInnerAllOf.attributeTypeMap; + return GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf.attributeTypeMap; } } diff --git a/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts new file mode 100644 index 00000000..017c3431 --- /dev/null +++ b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts @@ -0,0 +1,31 @@ +/** + * Klaviyo API + * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + * + * Contact: developers@klaviyo.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { RequestFile } from './models'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes'; + +export class GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships { + 'couponCodes'?: GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "couponCodes", + "baseName": "coupon-codes", + "type": "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes" + } ]; + + static getAttributeTypeMap() { + return GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships.attributeTypeMap; + } +} + diff --git a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes.ts b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes.ts similarity index 57% rename from model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes.ts rename to model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes.ts index 96192d0d..dfceaa21 100644 --- a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes.ts +++ b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes.ts @@ -10,11 +10,11 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner'; import { RelationshipLinks } from './relationshipLinks'; -export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes { - 'data': Array; +export class GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes { + 'data': Array; 'links'?: RelationshipLinks; static discriminator: string | undefined = undefined; @@ -23,7 +23,7 @@ export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships { "name": "data", "baseName": "data", - "type": "Array" + "type": "Array" }, { "name": "links", @@ -32,7 +32,7 @@ export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships } ]; static getAttributeTypeMap() { - return GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes.attributeTypeMap; + return GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes.attributeTypeMap; } } diff --git a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner.ts b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner.ts similarity index 71% rename from model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner.ts rename to model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner.ts index cb5f3523..aab4891c 100644 --- a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner.ts +++ b/model/getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner.ts @@ -12,7 +12,7 @@ import { RequestFile } from './models'; import { CouponCodeEnum } from './couponCodeEnum'; -export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner { +export class GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner { 'type': CouponCodeEnum; /** * IDs of the created coupon codes. @@ -34,9 +34,9 @@ export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships } ]; static getAttributeTypeMap() { - return GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner.attributeTypeMap; + return GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner.attributeTypeMap; } } -export namespace GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner { +export namespace GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner { } diff --git a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships.ts b/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships.ts deleted file mode 100644 index 1525dd08..00000000 --- a/model/getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships.ts +++ /dev/null @@ -1,31 +0,0 @@ -/** - * Klaviyo API - * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. - * - * Contact: developers@klaviyo.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { RequestFile } from './models'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes'; - -export class GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships { - 'couponCodes'?: GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes; - - static discriminator: string | undefined = undefined; - - static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ - { - "name": "couponCodes", - "baseName": "coupon-codes", - "type": "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes" - } ]; - - static getAttributeTypeMap() { - return GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships.attributeTypeMap; - } -} - diff --git a/model/getCouponCodeCreateJobResponseCompoundDocument.ts b/model/getCouponCodeCreateJobResponseCompoundDocument.ts new file mode 100644 index 00000000..7b5aa99c --- /dev/null +++ b/model/getCouponCodeCreateJobResponseCompoundDocument.ts @@ -0,0 +1,38 @@ +/** + * Klaviyo API + * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + * + * Contact: developers@klaviyo.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { RequestFile } from './models'; +import { CouponCodeResponseObjectResource } from './couponCodeResponseObjectResource'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner'; + +export class GetCouponCodeCreateJobResponseCompoundDocument { + 'data': GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner; + 'included'?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "data", + "baseName": "data", + "type": "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner" + }, + { + "name": "included", + "baseName": "included", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return GetCouponCodeCreateJobResponseCompoundDocument.attributeTypeMap; + } +} + diff --git a/model/getCouponCodeResponseCollection.ts b/model/getCouponCodeResponseCollection.ts index a72f569f..53ab953c 100644 --- a/model/getCouponCodeResponseCollection.ts +++ b/model/getCouponCodeResponseCollection.ts @@ -11,10 +11,10 @@ import { RequestFile } from './models'; import { CollectionLinks } from './collectionLinks'; -import { GetCouponCodeResponseCollectionDataInner } from './getCouponCodeResponseCollectionDataInner'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInner } from './getCouponCodeResponseCollectionCompoundDocumentDataInner'; export class GetCouponCodeResponseCollection { - 'data': Array; + 'data': Array; 'links': CollectionLinks; static discriminator: string | undefined = undefined; @@ -23,7 +23,7 @@ export class GetCouponCodeResponseCollection { { "name": "data", "baseName": "data", - "type": "Array" + "type": "Array" }, { "name": "links", diff --git a/model/getCouponCodeResponseCollectionCompoundDocument.ts b/model/getCouponCodeResponseCollectionCompoundDocument.ts new file mode 100644 index 00000000..a232db01 --- /dev/null +++ b/model/getCouponCodeResponseCollectionCompoundDocument.ts @@ -0,0 +1,45 @@ +/** + * Klaviyo API + * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + * + * Contact: developers@klaviyo.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { RequestFile } from './models'; +import { CollectionLinks } from './collectionLinks'; +import { CouponResponseObjectResource } from './couponResponseObjectResource'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInner } from './getCouponCodeResponseCollectionCompoundDocumentDataInner'; + +export class GetCouponCodeResponseCollectionCompoundDocument { + 'data': Array; + 'links': CollectionLinks; + 'included'?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "data", + "baseName": "data", + "type": "Array" + }, + { + "name": "links", + "baseName": "links", + "type": "CollectionLinks" + }, + { + "name": "included", + "baseName": "included", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return GetCouponCodeResponseCollectionCompoundDocument.attributeTypeMap; + } +} + diff --git a/model/getCouponCodeResponseCollectionDataInner.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInner.ts similarity index 62% rename from model/getCouponCodeResponseCollectionDataInner.ts rename to model/getCouponCodeResponseCollectionCompoundDocumentDataInner.ts index 9b5942df..cccc039a 100644 --- a/model/getCouponCodeResponseCollectionDataInner.ts +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInner.ts @@ -13,11 +13,11 @@ import { RequestFile } from './models'; import { CouponCodeEnum } from './couponCodeEnum'; import { CouponCodeResponseObjectResource } from './couponCodeResponseObjectResource'; import { CouponCodeResponseObjectResourceAttributes } from './couponCodeResponseObjectResourceAttributes'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionDataInnerAllOfRelationships'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; import { ObjectLinks } from './objectLinks'; -export class GetCouponCodeResponseCollectionDataInner extends CouponCodeResponseObjectResource { - 'relationships'?: GetCouponCodeResponseCollectionDataInnerAllOfRelationships; +export class GetCouponCodeResponseCollectionCompoundDocumentDataInner extends CouponCodeResponseObjectResource { + 'relationships'?: GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships; static discriminator: string | undefined = undefined; @@ -25,13 +25,13 @@ export class GetCouponCodeResponseCollectionDataInner extends CouponCodeResponse { "name": "relationships", "baseName": "relationships", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationships" + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships" } ]; static getAttributeTypeMap() { - return super.getAttributeTypeMap().concat(GetCouponCodeResponseCollectionDataInner.attributeTypeMap); + return super.getAttributeTypeMap().concat(GetCouponCodeResponseCollectionCompoundDocumentDataInner.attributeTypeMap); } } -export namespace GetCouponCodeResponseCollectionDataInner { +export namespace GetCouponCodeResponseCollectionCompoundDocumentDataInner { } diff --git a/model/getCouponCodeResponseCollectionDataInnerAllOf.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf.ts similarity index 54% rename from model/getCouponCodeResponseCollectionDataInnerAllOf.ts rename to model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf.ts index dc79ebba..0b1070c5 100644 --- a/model/getCouponCodeResponseCollectionDataInnerAllOf.ts +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf.ts @@ -10,10 +10,10 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionDataInnerAllOfRelationships'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; -export class GetCouponCodeResponseCollectionDataInnerAllOf { - 'relationships'?: GetCouponCodeResponseCollectionDataInnerAllOfRelationships; +export class GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf { + 'relationships'?: GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships; static discriminator: string | undefined = undefined; @@ -21,11 +21,11 @@ export class GetCouponCodeResponseCollectionDataInnerAllOf { { "name": "relationships", "baseName": "relationships", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationships" + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships" } ]; static getAttributeTypeMap() { - return GetCouponCodeResponseCollectionDataInnerAllOf.attributeTypeMap; + return GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf.attributeTypeMap; } } diff --git a/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts new file mode 100644 index 00000000..bef0f358 --- /dev/null +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships.ts @@ -0,0 +1,38 @@ +/** + * Klaviyo API + * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + * + * Contact: developers@klaviyo.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { RequestFile } from './models'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile'; + +export class GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships { + 'coupon'?: GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon; + 'profile'?: GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "coupon", + "baseName": "coupon", + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon" + }, + { + "name": "profile", + "baseName": "profile", + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile" + } ]; + + static getAttributeTypeMap() { + return GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships.attributeTypeMap; + } +} + diff --git a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon.ts similarity index 58% rename from model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon.ts rename to model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon.ts index ee85f3f3..16e78ef1 100644 --- a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon.ts +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon.ts @@ -10,11 +10,11 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData'; import { RelationshipLinks } from './relationshipLinks'; -export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon { - 'data': GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData; +export class GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon { + 'data': GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData; 'links'?: RelationshipLinks; static discriminator: string | undefined = undefined; @@ -23,7 +23,7 @@ export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon { { "name": "data", "baseName": "data", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData" + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData" }, { "name": "links", @@ -32,7 +32,7 @@ export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon { } ]; static getAttributeTypeMap() { - return GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon.attributeTypeMap; + return GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon.attributeTypeMap; } } diff --git a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData.ts similarity index 72% rename from model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData.ts rename to model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData.ts index 3f2cc362..33bac9f1 100644 --- a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData.ts +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData.ts @@ -12,7 +12,7 @@ import { RequestFile } from './models'; import { CouponEnum } from './couponEnum'; -export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData { +export class GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData { 'type': CouponEnum; 'id': string; @@ -31,9 +31,9 @@ export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponDat } ]; static getAttributeTypeMap() { - return GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData.attributeTypeMap; + return GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData.attributeTypeMap; } } -export namespace GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData { +export namespace GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData { } diff --git a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile.ts similarity index 58% rename from model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile.ts rename to model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile.ts index 41093f9c..2eb77b01 100644 --- a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile.ts +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile.ts @@ -10,11 +10,11 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData'; import { RelationshipLinks } from './relationshipLinks'; -export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile { - 'data': GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData; +export class GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile { + 'data': GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData; 'links'?: RelationshipLinks; static discriminator: string | undefined = undefined; @@ -23,7 +23,7 @@ export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile { { "name": "data", "baseName": "data", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData" + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData" }, { "name": "links", @@ -32,7 +32,7 @@ export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile { } ]; static getAttributeTypeMap() { - return GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile.attributeTypeMap; + return GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile.attributeTypeMap; } } diff --git a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData.ts b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData.ts similarity index 72% rename from model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData.ts rename to model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData.ts index 8426d35b..879d6592 100644 --- a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData.ts +++ b/model/getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData.ts @@ -12,7 +12,7 @@ import { RequestFile } from './models'; import { ProfileEnum } from './profileEnum'; -export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData { +export class GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData { 'type': ProfileEnum; 'id': string; @@ -31,9 +31,9 @@ export class GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileDa } ]; static getAttributeTypeMap() { - return GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData.attributeTypeMap; + return GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData.attributeTypeMap; } } -export namespace GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData { +export namespace GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData { } diff --git a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationships.ts b/model/getCouponCodeResponseCollectionDataInnerAllOfRelationships.ts deleted file mode 100644 index 767142ef..00000000 --- a/model/getCouponCodeResponseCollectionDataInnerAllOfRelationships.ts +++ /dev/null @@ -1,38 +0,0 @@ -/** - * Klaviyo API - * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. - * - * Contact: developers@klaviyo.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { RequestFile } from './models'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile'; - -export class GetCouponCodeResponseCollectionDataInnerAllOfRelationships { - 'coupon'?: GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon; - 'profile'?: GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile; - - static discriminator: string | undefined = undefined; - - static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ - { - "name": "coupon", - "baseName": "coupon", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon" - }, - { - "name": "profile", - "baseName": "profile", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile" - } ]; - - static getAttributeTypeMap() { - return GetCouponCodeResponseCollectionDataInnerAllOfRelationships.attributeTypeMap; - } -} - diff --git a/model/getCouponCodeResponseCompoundDocument.ts b/model/getCouponCodeResponseCompoundDocument.ts new file mode 100644 index 00000000..35e95d00 --- /dev/null +++ b/model/getCouponCodeResponseCompoundDocument.ts @@ -0,0 +1,38 @@ +/** + * Klaviyo API + * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + * + * Contact: developers@klaviyo.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { RequestFile } from './models'; +import { CouponResponseObjectResource } from './couponResponseObjectResource'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInner } from './getCouponCodeResponseCollectionCompoundDocumentDataInner'; + +export class GetCouponCodeResponseCompoundDocument { + 'data': GetCouponCodeResponseCollectionCompoundDocumentDataInner; + 'included'?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "data", + "baseName": "data", + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInner" + }, + { + "name": "included", + "baseName": "included", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return GetCouponCodeResponseCompoundDocument.attributeTypeMap; + } +} + diff --git a/model/listMemberResponseObjectResourceAttributes.ts b/model/listMemberResponseObjectResourceAttributes.ts index b1b88156..b13ee242 100644 --- a/model/listMemberResponseObjectResourceAttributes.ts +++ b/model/listMemberResponseObjectResourceAttributes.ts @@ -11,7 +11,6 @@ import { RequestFile } from './models'; import { ProfileLocation } from './profileLocation'; -import { Subscriptions } from './subscriptions'; export class ListMemberResponseObjectResourceAttributes { /** @@ -63,7 +62,6 @@ export class ListMemberResponseObjectResourceAttributes { * An object containing key/value pairs for any custom properties assigned to this profile */ 'properties'?: object; - 'subscriptions'?: Subscriptions; /** * The datetime when this profile most recently joined the list. */ @@ -137,11 +135,6 @@ export class ListMemberResponseObjectResourceAttributes { "baseName": "properties", "type": "object" }, - { - "name": "subscriptions", - "baseName": "subscriptions", - "type": "Subscriptions" - }, { "name": "joinedGroupAt", "baseName": "joined_group_at", diff --git a/model/listMemberResponseObjectResourceExtendedAttributes.ts b/model/listMemberResponseObjectResourceExtendedAttributes.ts index 4ae09ece..82843cd9 100644 --- a/model/listMemberResponseObjectResourceExtendedAttributes.ts +++ b/model/listMemberResponseObjectResourceExtendedAttributes.ts @@ -16,11 +16,17 @@ import { ProfileLocation } from './profileLocation'; import { Subscriptions } from './subscriptions'; export class ListMemberResponseObjectResourceExtendedAttributes extends ListMemberResponseObjectResourceAttributes { + 'subscriptions'?: Subscriptions; 'predictiveAnalytics'?: PredictiveAnalytics; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "subscriptions", + "baseName": "subscriptions", + "type": "Subscriptions" + }, { "name": "predictiveAnalytics", "baseName": "predictive_analytics", diff --git a/model/marketingSubscriptionParameters.ts b/model/marketingSubscriptionParameters.ts new file mode 100644 index 00000000..4d1b1165 --- /dev/null +++ b/model/marketingSubscriptionParameters.ts @@ -0,0 +1,38 @@ +/** + * Klaviyo API + * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. + * + * Contact: developers@klaviyo.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { RequestFile } from './models'; + +export class MarketingSubscriptionParameters { + /** + * The Consent status to subscribe to for the \"Marketing\" type. Currently supports \"SUBSCRIBED\". + */ + 'consent': MarketingSubscriptionParameters.ConsentEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "consent", + "baseName": "consent", + "type": "MarketingSubscriptionParameters.ConsentEnum" + } ]; + + static getAttributeTypeMap() { + return MarketingSubscriptionParameters.attributeTypeMap; + } +} + +export namespace MarketingSubscriptionParameters { + export enum ConsentEnum { + Subscribed = 'SUBSCRIBED' + } +} diff --git a/model/models.ts b/model/models.ts index 78283522..9f365e67 100644 --- a/model/models.ts +++ b/model/models.ts @@ -190,6 +190,7 @@ export * from './emailMarketingListSuppression'; export * from './emailMarketingSuppression'; export * from './emailMessageContent'; export * from './emailSendOptionsSubObject'; +export * from './emailSubscriptionParameters'; export * from './emailTrackingOptions'; export * from './emailTrackingOptionsSubObject'; export * from './errorSource'; @@ -334,24 +335,25 @@ export * from './getCatalogVariantUpdateJobResponseCollectionCompoundDocumentDat export * from './getCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariants'; export * from './getCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariantsDataInner'; export * from './getCatalogVariantUpdateJobResponseCompoundDocument'; -export * from './getCouponCodeCreateJobResponse'; -export * from './getCouponCodeCreateJobResponseCollection'; -export * from './getCouponCodeCreateJobResponseCollectionDataInner'; -export * from './getCouponCodeCreateJobResponseCollectionDataInnerAllOf'; -export * from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships'; -export * from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes'; -export * from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner'; +export * from './getCouponCodeCreateJobResponseCollectionCompoundDocument'; +export * from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner'; +export * from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf'; +export * from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; +export * from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes'; +export * from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner'; +export * from './getCouponCodeCreateJobResponseCompoundDocument'; export * from './getCouponCodeRelationshipCouponResponse'; export * from './getCouponCodeRelationshipCouponResponseData'; -export * from './getCouponCodeResponse'; export * from './getCouponCodeResponseCollection'; -export * from './getCouponCodeResponseCollectionDataInner'; -export * from './getCouponCodeResponseCollectionDataInnerAllOf'; -export * from './getCouponCodeResponseCollectionDataInnerAllOfRelationships'; -export * from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon'; -export * from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData'; -export * from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile'; -export * from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData'; +export * from './getCouponCodeResponseCollectionCompoundDocument'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInner'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile'; +export * from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData'; +export * from './getCouponCodeResponseCompoundDocument'; export * from './getCouponRelationshipCouponCodesListResponseCollection'; export * from './getCouponRelationshipCouponCodesListResponseCollectionDataInner'; export * from './getCouponResponse'; @@ -509,6 +511,7 @@ export * from './listRetrieveResponseObjectResourceAttributes'; export * from './listRetrieveResponseObjectResourceExtended'; export * from './listRetrieveResponseObjectResourceExtendedAttributes'; export * from './listRetrieveResponseObjectResourceExtendedAttributesAllOf'; +export * from './marketingSubscriptionParameters'; export * from './metricAggregateEnum'; export * from './metricAggregateQuery'; export * from './metricAggregateQueryResourceObject'; @@ -650,6 +653,7 @@ export * from './sMSMarketing'; export * from './sMSMessageContent'; export * from './sMSRenderOptions'; export * from './sMSSendOptionsSubObject'; +export * from './sMSSubscriptionParameters'; export * from './sMSTrackingOptions'; export * from './sMSTrackingOptionsSubObject'; export * from './sTOScheduleOptions'; @@ -940,6 +944,7 @@ import { EmailMarketingListSuppression } from './emailMarketingListSuppression'; import { EmailMarketingSuppression } from './emailMarketingSuppression'; import { EmailMessageContent } from './emailMessageContent'; import { EmailSendOptionsSubObject } from './emailSendOptionsSubObject'; +import { EmailSubscriptionParameters } from './emailSubscriptionParameters'; import { EmailTrackingOptions } from './emailTrackingOptions'; import { EmailTrackingOptionsSubObject } from './emailTrackingOptionsSubObject'; import { ErrorSource } from './errorSource'; @@ -1084,24 +1089,25 @@ import { GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAl import { GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariants } from './getCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariants'; import { GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariantsDataInner } from './getCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariantsDataInner'; import { GetCatalogVariantUpdateJobResponseCompoundDocument } from './getCatalogVariantUpdateJobResponseCompoundDocument'; -import { GetCouponCodeCreateJobResponse } from './getCouponCodeCreateJobResponse'; -import { GetCouponCodeCreateJobResponseCollection } from './getCouponCodeCreateJobResponseCollection'; -import { GetCouponCodeCreateJobResponseCollectionDataInner } from './getCouponCodeCreateJobResponseCollectionDataInner'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOf } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOf'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocument } from './getCouponCodeCreateJobResponseCollectionCompoundDocument'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner'; +import { GetCouponCodeCreateJobResponseCompoundDocument } from './getCouponCodeCreateJobResponseCompoundDocument'; import { GetCouponCodeRelationshipCouponResponse } from './getCouponCodeRelationshipCouponResponse'; import { GetCouponCodeRelationshipCouponResponseData } from './getCouponCodeRelationshipCouponResponseData'; -import { GetCouponCodeResponse } from './getCouponCodeResponse'; import { GetCouponCodeResponseCollection } from './getCouponCodeResponseCollection'; -import { GetCouponCodeResponseCollectionDataInner } from './getCouponCodeResponseCollectionDataInner'; -import { GetCouponCodeResponseCollectionDataInnerAllOf } from './getCouponCodeResponseCollectionDataInnerAllOf'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionDataInnerAllOfRelationships'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData } from './getCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData'; +import { GetCouponCodeResponseCollectionCompoundDocument } from './getCouponCodeResponseCollectionCompoundDocument'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInner } from './getCouponCodeResponseCollectionCompoundDocumentDataInner'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData'; +import { GetCouponCodeResponseCompoundDocument } from './getCouponCodeResponseCompoundDocument'; import { GetCouponRelationshipCouponCodesListResponseCollection } from './getCouponRelationshipCouponCodesListResponseCollection'; import { GetCouponRelationshipCouponCodesListResponseCollectionDataInner } from './getCouponRelationshipCouponCodesListResponseCollectionDataInner'; import { GetCouponResponse } from './getCouponResponse'; @@ -1259,6 +1265,7 @@ import { ListRetrieveResponseObjectResourceAttributes } from './listRetrieveResp import { ListRetrieveResponseObjectResourceExtended } from './listRetrieveResponseObjectResourceExtended'; import { ListRetrieveResponseObjectResourceExtendedAttributes } from './listRetrieveResponseObjectResourceExtendedAttributes'; import { ListRetrieveResponseObjectResourceExtendedAttributesAllOf } from './listRetrieveResponseObjectResourceExtendedAttributesAllOf'; +import { MarketingSubscriptionParameters } from './marketingSubscriptionParameters'; import { MetricAggregateEnum } from './metricAggregateEnum'; import { MetricAggregateQuery } from './metricAggregateQuery'; import { MetricAggregateQueryResourceObject } from './metricAggregateQueryResourceObject'; @@ -1400,6 +1407,7 @@ import { SMSMarketing } from './sMSMarketing'; import { SMSMessageContent } from './sMSMessageContent'; import { SMSRenderOptions } from './sMSRenderOptions'; import { SMSSendOptionsSubObject } from './sMSSendOptionsSubObject'; +import { SMSSubscriptionParameters } from './sMSSubscriptionParameters'; import { SMSTrackingOptions } from './sMSTrackingOptions'; import { SMSTrackingOptionsSubObject } from './sMSTrackingOptionsSubObject'; import { STOScheduleOptions } from './sTOScheduleOptions'; @@ -1555,6 +1563,7 @@ let enumsMap: {[index: string]: any} = { "FlowResponseObjectResourceAttributes.TriggerTypeEnum": FlowResponseObjectResourceAttributes.TriggerTypeEnum, "ImageEnum": ImageEnum, "ListEnum": ListEnum, + "MarketingSubscriptionParameters.ConsentEnum": MarketingSubscriptionParameters.ConsentEnum, "MetricAggregateEnum": MetricAggregateEnum, "MetricAggregateQueryResourceObjectAttributes.MeasurementsEnum": MetricAggregateQueryResourceObjectAttributes.MeasurementsEnum, "MetricAggregateQueryResourceObjectAttributes.IntervalEnum": MetricAggregateQueryResourceObjectAttributes.IntervalEnum, @@ -1574,8 +1583,6 @@ let enumsMap: {[index: string]: any} = { "PushTokenEnum": PushTokenEnum, "SegmentEnum": SegmentEnum, "ServerBISSubscriptionCreateQueryResourceObjectAttributes.ChannelsEnum": ServerBISSubscriptionCreateQueryResourceObjectAttributes.ChannelsEnum, - "SubscriptionChannels.EmailEnum": SubscriptionChannels.EmailEnum, - "SubscriptionChannels.SmsEnum": SubscriptionChannels.SmsEnum, "TagEnum": TagEnum, "TagGroupEnum": TagGroupEnum, "TemplateEnum": TemplateEnum, @@ -1748,6 +1755,7 @@ let typeMap: {[index: string]: any} = { "EmailMarketingSuppression": EmailMarketingSuppression, "EmailMessageContent": EmailMessageContent, "EmailSendOptionsSubObject": EmailSendOptionsSubObject, + "EmailSubscriptionParameters": EmailSubscriptionParameters, "EmailTrackingOptions": EmailTrackingOptions, "EmailTrackingOptionsSubObject": EmailTrackingOptionsSubObject, "ErrorSource": ErrorSource, @@ -1888,24 +1896,25 @@ let typeMap: {[index: string]: any} = { "GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariants": GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariants, "GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariantsDataInner": GetCatalogVariantUpdateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsVariantsDataInner, "GetCatalogVariantUpdateJobResponseCompoundDocument": GetCatalogVariantUpdateJobResponseCompoundDocument, - "GetCouponCodeCreateJobResponse": GetCouponCodeCreateJobResponse, - "GetCouponCodeCreateJobResponseCollection": GetCouponCodeCreateJobResponseCollection, - "GetCouponCodeCreateJobResponseCollectionDataInner": GetCouponCodeCreateJobResponseCollectionDataInner, - "GetCouponCodeCreateJobResponseCollectionDataInnerAllOf": GetCouponCodeCreateJobResponseCollectionDataInnerAllOf, - "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships": GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships, - "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes": GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodes, - "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner": GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationshipsCouponCodesDataInner, + "GetCouponCodeCreateJobResponseCollectionCompoundDocument": GetCouponCodeCreateJobResponseCollectionCompoundDocument, + "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner": GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInner, + "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf": GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOf, + "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships": GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships, + "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes": GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodes, + "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner": GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponCodesDataInner, + "GetCouponCodeCreateJobResponseCompoundDocument": GetCouponCodeCreateJobResponseCompoundDocument, "GetCouponCodeRelationshipCouponResponse": GetCouponCodeRelationshipCouponResponse, "GetCouponCodeRelationshipCouponResponseData": GetCouponCodeRelationshipCouponResponseData, - "GetCouponCodeResponse": GetCouponCodeResponse, "GetCouponCodeResponseCollection": GetCouponCodeResponseCollection, - "GetCouponCodeResponseCollectionDataInner": GetCouponCodeResponseCollectionDataInner, - "GetCouponCodeResponseCollectionDataInnerAllOf": GetCouponCodeResponseCollectionDataInnerAllOf, - "GetCouponCodeResponseCollectionDataInnerAllOfRelationships": GetCouponCodeResponseCollectionDataInnerAllOfRelationships, - "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon": GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCoupon, - "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData": GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsCouponData, - "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile": GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfile, - "GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData": GetCouponCodeResponseCollectionDataInnerAllOfRelationshipsProfileData, + "GetCouponCodeResponseCollectionCompoundDocument": GetCouponCodeResponseCollectionCompoundDocument, + "GetCouponCodeResponseCollectionCompoundDocumentDataInner": GetCouponCodeResponseCollectionCompoundDocumentDataInner, + "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf": GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOf, + "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships": GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships, + "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon": GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCoupon, + "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData": GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsCouponData, + "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile": GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfile, + "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData": GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsProfileData, + "GetCouponCodeResponseCompoundDocument": GetCouponCodeResponseCompoundDocument, "GetCouponRelationshipCouponCodesListResponseCollection": GetCouponRelationshipCouponCodesListResponseCollection, "GetCouponRelationshipCouponCodesListResponseCollectionDataInner": GetCouponRelationshipCouponCodesListResponseCollectionDataInner, "GetCouponResponse": GetCouponResponse, @@ -2061,6 +2070,7 @@ let typeMap: {[index: string]: any} = { "ListRetrieveResponseObjectResourceExtended": ListRetrieveResponseObjectResourceExtended, "ListRetrieveResponseObjectResourceExtendedAttributes": ListRetrieveResponseObjectResourceExtendedAttributes, "ListRetrieveResponseObjectResourceExtendedAttributesAllOf": ListRetrieveResponseObjectResourceExtendedAttributesAllOf, + "MarketingSubscriptionParameters": MarketingSubscriptionParameters, "MetricAggregateQuery": MetricAggregateQuery, "MetricAggregateQueryResourceObject": MetricAggregateQueryResourceObject, "MetricAggregateQueryResourceObjectAttributes": MetricAggregateQueryResourceObjectAttributes, @@ -2193,6 +2203,7 @@ let typeMap: {[index: string]: any} = { "SMSMessageContent": SMSMessageContent, "SMSRenderOptions": SMSRenderOptions, "SMSSendOptionsSubObject": SMSSendOptionsSubObject, + "SMSSubscriptionParameters": SMSSubscriptionParameters, "SMSTrackingOptions": SMSTrackingOptions, "SMSTrackingOptionsSubObject": SMSTrackingOptionsSubObject, "STOScheduleOptions": STOScheduleOptions, diff --git a/model/postCouponCodeCreateJobResponseData.ts b/model/postCouponCodeCreateJobResponseData.ts index f5fc670a..cca9f090 100644 --- a/model/postCouponCodeCreateJobResponseData.ts +++ b/model/postCouponCodeCreateJobResponseData.ts @@ -12,13 +12,13 @@ import { RequestFile } from './models'; import { CouponCodeBulkCreateJobEnum } from './couponCodeBulkCreateJobEnum'; import { CouponCodeCreateJobResponseObjectResourceAttributes } from './couponCodeCreateJobResponseObjectResourceAttributes'; -import { GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships'; +import { GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; import { ObjectLinks } from './objectLinks'; export class PostCouponCodeCreateJobResponseData { 'type': CouponCodeBulkCreateJobEnum; 'attributes': CouponCodeCreateJobResponseObjectResourceAttributes; - 'relationships'?: GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships; + 'relationships'?: GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships; 'links': ObjectLinks; static discriminator: string | undefined = undefined; @@ -37,7 +37,7 @@ export class PostCouponCodeCreateJobResponseData { { "name": "relationships", "baseName": "relationships", - "type": "GetCouponCodeCreateJobResponseCollectionDataInnerAllOfRelationships" + "type": "GetCouponCodeCreateJobResponseCollectionCompoundDocumentDataInnerAllOfRelationships" }, { "name": "links", diff --git a/model/postCouponCodeResponseData.ts b/model/postCouponCodeResponseData.ts index f3d0d831..b78aa3a8 100644 --- a/model/postCouponCodeResponseData.ts +++ b/model/postCouponCodeResponseData.ts @@ -12,7 +12,7 @@ import { RequestFile } from './models'; import { CouponCodeEnum } from './couponCodeEnum'; import { CouponCodeResponseObjectResourceAttributes } from './couponCodeResponseObjectResourceAttributes'; -import { GetCouponCodeResponseCollectionDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionDataInnerAllOfRelationships'; +import { GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships } from './getCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships'; import { ObjectLinks } from './objectLinks'; export class PostCouponCodeResponseData { @@ -22,7 +22,7 @@ export class PostCouponCodeResponseData { */ 'id': string; 'attributes': CouponCodeResponseObjectResourceAttributes; - 'relationships'?: GetCouponCodeResponseCollectionDataInnerAllOfRelationships; + 'relationships'?: GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships; 'links': ObjectLinks; static discriminator: string | undefined = undefined; @@ -46,7 +46,7 @@ export class PostCouponCodeResponseData { { "name": "relationships", "baseName": "relationships", - "type": "GetCouponCodeResponseCollectionDataInnerAllOfRelationships" + "type": "GetCouponCodeResponseCollectionCompoundDocumentDataInnerAllOfRelationships" }, { "name": "links", diff --git a/model/profileLocation.ts b/model/profileLocation.ts index b21df391..3696646f 100644 --- a/model/profileLocation.ts +++ b/model/profileLocation.ts @@ -44,6 +44,10 @@ export class ProfileLocation { * Time zone name. We recommend using time zones from the IANA Time Zone Database. */ 'timezone'?: string; + /** + * IP Address + */ + 'ip'?: string; static discriminator: string | undefined = undefined; @@ -92,6 +96,11 @@ export class ProfileLocation { "name": "timezone", "baseName": "timezone", "type": "string" + }, + { + "name": "ip", + "baseName": "ip", + "type": "string" } ]; static getAttributeTypeMap() { diff --git a/model/profileResponseObjectResourceAttributes.ts b/model/profileResponseObjectResourceAttributes.ts index 529d3e86..8132239f 100644 --- a/model/profileResponseObjectResourceAttributes.ts +++ b/model/profileResponseObjectResourceAttributes.ts @@ -11,7 +11,6 @@ import { RequestFile } from './models'; import { ProfileLocation } from './profileLocation'; -import { Subscriptions } from './subscriptions'; export class ProfileResponseObjectResourceAttributes { /** @@ -63,7 +62,6 @@ export class ProfileResponseObjectResourceAttributes { * An object containing key/value pairs for any custom properties assigned to this profile */ 'properties'?: object; - 'subscriptions'?: Subscriptions; static discriminator: string | undefined = undefined; @@ -132,11 +130,6 @@ export class ProfileResponseObjectResourceAttributes { "name": "properties", "baseName": "properties", "type": "object" - }, - { - "name": "subscriptions", - "baseName": "subscriptions", - "type": "Subscriptions" } ]; static getAttributeTypeMap() { diff --git a/model/profileResponseObjectResourceExtendedAttributes.ts b/model/profileResponseObjectResourceExtendedAttributes.ts index 37c8f691..0cd2e76d 100644 --- a/model/profileResponseObjectResourceExtendedAttributes.ts +++ b/model/profileResponseObjectResourceExtendedAttributes.ts @@ -16,11 +16,17 @@ import { ProfileResponseObjectResourceAttributes } from './profileResponseObject import { Subscriptions } from './subscriptions'; export class ProfileResponseObjectResourceExtendedAttributes extends ProfileResponseObjectResourceAttributes { + 'subscriptions'?: Subscriptions; 'predictiveAnalytics'?: PredictiveAnalytics; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "subscriptions", + "baseName": "subscriptions", + "type": "Subscriptions" + }, { "name": "predictiveAnalytics", "baseName": "predictive_analytics", diff --git a/model/profileResponseObjectResourceExtendedAttributesAllOf.ts b/model/profileResponseObjectResourceExtendedAttributesAllOf.ts index b67c3329..347c2b24 100644 --- a/model/profileResponseObjectResourceExtendedAttributesAllOf.ts +++ b/model/profileResponseObjectResourceExtendedAttributesAllOf.ts @@ -11,13 +11,20 @@ import { RequestFile } from './models'; import { PredictiveAnalytics } from './predictiveAnalytics'; +import { Subscriptions } from './subscriptions'; export class ProfileResponseObjectResourceExtendedAttributesAllOf { + 'subscriptions'?: Subscriptions; 'predictiveAnalytics'?: PredictiveAnalytics; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "subscriptions", + "baseName": "subscriptions", + "type": "Subscriptions" + }, { "name": "predictiveAnalytics", "baseName": "predictive_analytics", diff --git a/model/profileUpsertQueryResourceObjectAttributes.ts b/model/profileUpsertQueryResourceObjectAttributes.ts index c85df1dc..efa0117a 100644 --- a/model/profileUpsertQueryResourceObjectAttributes.ts +++ b/model/profileUpsertQueryResourceObjectAttributes.ts @@ -31,6 +31,10 @@ export class ProfileUpsertQueryResourceObjectAttributes { */ 'anonymousId'?: string; /** + * Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo\'s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint. + */ + 'kx'?: string; + /** * Individual\'s first name */ 'firstName'?: string; @@ -80,6 +84,11 @@ export class ProfileUpsertQueryResourceObjectAttributes { "baseName": "anonymous_id", "type": "string" }, + { + "name": "kx", + "baseName": "_kx", + "type": "string" + }, { "name": "firstName", "baseName": "first_name", diff --git a/model/sMSMarketing.ts b/model/sMSMarketing.ts index 16f6f1a9..345043cb 100644 --- a/model/sMSMarketing.ts +++ b/model/sMSMarketing.ts @@ -12,14 +12,18 @@ import { RequestFile } from './models'; export class SMSMarketing { + /** + * Whether or not this profile is subscribed to receive SMS marketing. + */ + 'canReceiveSmsMarketing': boolean; /** * The consent status for SMS marketing. */ 'consent': string; /** - * The timestamp when consent record or updated for SMS marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). + * The timestamp when consent was recorded or updated for SMS marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). */ - 'timestamp': Date; + 'consentTimestamp': Date; /** * The method by which the profile was subscribed to SMS marketing. */ @@ -28,18 +32,27 @@ export class SMSMarketing { * Additional details about the method which the profile was subscribed to SMS marketing. This may be empty if no details were provided. */ 'methodDetail': string = ''; + /** + * The timestamp when the SMS consent record was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). + */ + 'lastUpdated': Date; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "canReceiveSmsMarketing", + "baseName": "can_receive_sms_marketing", + "type": "boolean" + }, { "name": "consent", "baseName": "consent", "type": "string" }, { - "name": "timestamp", - "baseName": "timestamp", + "name": "consentTimestamp", + "baseName": "consent_timestamp", "type": "Date" }, { @@ -51,6 +64,11 @@ export class SMSMarketing { "name": "methodDetail", "baseName": "method_detail", "type": "string" + }, + { + "name": "lastUpdated", + "baseName": "last_updated", + "type": "Date" } ]; static getAttributeTypeMap() { diff --git a/model/getCouponCodeCreateJobResponse.ts b/model/sMSSubscriptionParameters.ts similarity index 57% rename from model/getCouponCodeCreateJobResponse.ts rename to model/sMSSubscriptionParameters.ts index ea0c8849..1753f050 100644 --- a/model/getCouponCodeCreateJobResponse.ts +++ b/model/sMSSubscriptionParameters.ts @@ -10,22 +10,22 @@ */ import { RequestFile } from './models'; -import { GetCouponCodeCreateJobResponseCollectionDataInner } from './getCouponCodeCreateJobResponseCollectionDataInner'; +import { MarketingSubscriptionParameters } from './marketingSubscriptionParameters'; -export class GetCouponCodeCreateJobResponse { - 'data': GetCouponCodeCreateJobResponseCollectionDataInner; +export class SMSSubscriptionParameters { + 'marketing': MarketingSubscriptionParameters; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ { - "name": "data", - "baseName": "data", - "type": "GetCouponCodeCreateJobResponseCollectionDataInner" + "name": "marketing", + "baseName": "marketing", + "type": "MarketingSubscriptionParameters" } ]; static getAttributeTypeMap() { - return GetCouponCodeCreateJobResponse.attributeTypeMap; + return SMSSubscriptionParameters.attributeTypeMap; } } diff --git a/model/segmentMemberResponseObjectResourceAttributes.ts b/model/segmentMemberResponseObjectResourceAttributes.ts index b4716add..b35e0671 100644 --- a/model/segmentMemberResponseObjectResourceAttributes.ts +++ b/model/segmentMemberResponseObjectResourceAttributes.ts @@ -11,7 +11,6 @@ import { RequestFile } from './models'; import { ProfileLocation } from './profileLocation'; -import { Subscriptions } from './subscriptions'; export class SegmentMemberResponseObjectResourceAttributes { /** @@ -63,7 +62,6 @@ export class SegmentMemberResponseObjectResourceAttributes { * An object containing key/value pairs for any custom properties assigned to this profile */ 'properties'?: object; - 'subscriptions'?: Subscriptions; /** * The datetime when this profile most recently joined the segment. */ @@ -137,11 +135,6 @@ export class SegmentMemberResponseObjectResourceAttributes { "baseName": "properties", "type": "object" }, - { - "name": "subscriptions", - "baseName": "subscriptions", - "type": "Subscriptions" - }, { "name": "joinedGroupAt", "baseName": "joined_group_at", diff --git a/model/segmentMemberResponseObjectResourceExtendedAttributes.ts b/model/segmentMemberResponseObjectResourceExtendedAttributes.ts index 3fd4d1d7..bc3c5f4e 100644 --- a/model/segmentMemberResponseObjectResourceExtendedAttributes.ts +++ b/model/segmentMemberResponseObjectResourceExtendedAttributes.ts @@ -16,11 +16,17 @@ import { SegmentMemberResponseObjectResourceAttributes } from './segmentMemberRe import { Subscriptions } from './subscriptions'; export class SegmentMemberResponseObjectResourceExtendedAttributes extends SegmentMemberResponseObjectResourceAttributes { + 'subscriptions'?: Subscriptions; 'predictiveAnalytics'?: PredictiveAnalytics; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "subscriptions", + "baseName": "subscriptions", + "type": "Subscriptions" + }, { "name": "predictiveAnalytics", "baseName": "predictive_analytics", diff --git a/model/subscriptionChannels.ts b/model/subscriptionChannels.ts index 5dcf9ae2..f7957b12 100644 --- a/model/subscriptionChannels.ts +++ b/model/subscriptionChannels.ts @@ -10,16 +10,12 @@ */ import { RequestFile } from './models'; +import { EmailSubscriptionParameters } from './emailSubscriptionParameters'; +import { SMSSubscriptionParameters } from './sMSSubscriptionParameters'; export class SubscriptionChannels { - /** - * The communication types to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\". - */ - 'email'?: Array; - /** - * The communication types to subscribe to on the \"SMS\" Channel. Currently supports \"MARKETING\". - */ - 'sms'?: Array; + 'email'?: EmailSubscriptionParameters; + 'sms'?: SMSSubscriptionParameters; static discriminator: string | undefined = undefined; @@ -27,12 +23,12 @@ export class SubscriptionChannels { { "name": "email", "baseName": "email", - "type": "Array" + "type": "EmailSubscriptionParameters" }, { "name": "sms", "baseName": "sms", - "type": "Array" + "type": "SMSSubscriptionParameters" } ]; static getAttributeTypeMap() { @@ -40,11 +36,3 @@ export class SubscriptionChannels { } } -export namespace SubscriptionChannels { - export enum EmailEnum { - Marketing = 'MARKETING' - } - export enum SmsEnum { - Marketing = 'MARKETING' - } -} diff --git a/package-lock.json b/package-lock.json index 5069f16b..91987669 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "klaviyo-api", - "version": "6.0.1", + "version": "7.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -16,9 +16,9 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, "axios": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.5.0.tgz", - "integrity": "sha512-D4DdjDo5CY50Qms0qGQTTw6Q44jl7zRwY7bthds06pUGfChBCTcQs+N743eFWGEd6pRTMd6A+I87aWyFV5wiZQ==", + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.5.1.tgz", + "integrity": "sha512-Q28iYCWzNHjAm+yEAot5QaAMxhMghWLFVf7rRdwhUI+c2jix2DUXjAHXVi+s1ibs3mjPO/cCgbA++3BjD0vP/A==", "requires": { "follow-redirects": "^1.15.0", "form-data": "^4.0.0", diff --git a/package.json b/package.json index 06244c48..c95095f2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "klaviyo-api", - "version": "6.0.1", + "version": "7.0.0", "description": "A typescript client for the Klaviyo API", "repository": { "type": "git",