klaviyo-api-fetch 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -0
- package/dist/index.d.mts +5864 -3128
- package/dist/index.d.ts +5864 -3128
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/client.gen.ts +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +367 -17
- package/src/types.gen.ts +8634 -5680
package/package.json
CHANGED
package/src/client.gen.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
|
-
import type { ClientOptions } from './types.gen';
|
|
3
|
+
import type { ClientOptions } from './types.gen.js';
|
|
4
4
|
import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
|
|
5
5
|
|
|
6
6
|
/**
|
package/src/index.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
-
export * from './types.gen';
|
|
3
|
-
export * from './sdk.gen';
|
|
2
|
+
export * from './types.gen.js';
|
|
3
|
+
export * from './sdk.gen.js';
|
package/src/sdk.gen.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
3
|
import { type Options as ClientOptions, type TDataShape, type Client, formDataBodySerializer } from '@hey-api/client-fetch';
|
|
4
|
-
import type { GetAccountsData, GetAccountsResponse, GetAccountsError, GetAccountData, GetAccountResponse2, GetAccountError, GetCampaignsData, GetCampaignsResponse, GetCampaignsError, CreateCampaignData, CreateCampaignResponse, CreateCampaignError, DeleteCampaignData, DeleteCampaignResponse, DeleteCampaignError, GetCampaignData, GetCampaignResponse2, GetCampaignError, UpdateCampaignData, UpdateCampaignResponse, UpdateCampaignError, GetCampaignMessageData, GetCampaignMessageResponse, GetCampaignMessageError, UpdateCampaignMessageData, UpdateCampaignMessageResponse, UpdateCampaignMessageError, GetCampaignSendJobData, GetCampaignSendJobResponse2, GetCampaignSendJobError, CancelCampaignSendData, CancelCampaignSendResponse, CancelCampaignSendError, GetCampaignRecipientEstimationJobData, GetCampaignRecipientEstimationJobResponse2, GetCampaignRecipientEstimationJobError, GetCampaignRecipientEstimationData, GetCampaignRecipientEstimationResponse2, GetCampaignRecipientEstimationError, CreateCampaignCloneData, CreateCampaignCloneResponse, CreateCampaignCloneError, AssignTemplateToCampaignMessageData, AssignTemplateToCampaignMessageResponse, AssignTemplateToCampaignMessageError, SendCampaignData, SendCampaignResponse, SendCampaignError, RefreshCampaignRecipientEstimationData, RefreshCampaignRecipientEstimationResponse, RefreshCampaignRecipientEstimationError, GetCampaignForCampaignMessageData, GetCampaignForCampaignMessageResponse, GetCampaignForCampaignMessageError, GetCampaignIdForCampaignMessageData, GetCampaignIdForCampaignMessageResponse, GetCampaignIdForCampaignMessageError, GetTemplateForCampaignMessageData, GetTemplateForCampaignMessageResponse, GetTemplateForCampaignMessageError, GetTemplateIdForCampaignMessageData, GetTemplateIdForCampaignMessageResponse, GetTemplateIdForCampaignMessageError, GetImageForCampaignMessageData, GetImageForCampaignMessageResponse, GetImageForCampaignMessageError, GetImageIdForCampaignMessageData, GetImageIdForCampaignMessageResponse, GetImageIdForCampaignMessageError, UpdateImageForCampaignMessageData, UpdateImageForCampaignMessageResponse, UpdateImageForCampaignMessageError, GetTagsForCampaignData, GetTagsForCampaignResponse, GetTagsForCampaignError, GetTagIdsForCampaignData, GetTagIdsForCampaignResponse, GetTagIdsForCampaignError, GetMessagesForCampaignData, GetMessagesForCampaignResponse, GetMessagesForCampaignError, GetMessageIdsForCampaignData, GetMessageIdsForCampaignResponse, GetMessageIdsForCampaignError, GetCatalogItemsData, GetCatalogItemsResponse, GetCatalogItemsError, CreateCatalogItemData, CreateCatalogItemResponse, CreateCatalogItemError, DeleteCatalogItemData, DeleteCatalogItemResponse, DeleteCatalogItemError, GetCatalogItemData, GetCatalogItemResponse, GetCatalogItemError, UpdateCatalogItemData, UpdateCatalogItemResponse, UpdateCatalogItemError, GetCatalogVariantsData, GetCatalogVariantsResponse, GetCatalogVariantsError, CreateCatalogVariantData, CreateCatalogVariantResponse, CreateCatalogVariantError, DeleteCatalogVariantData, DeleteCatalogVariantResponse, DeleteCatalogVariantError, GetCatalogVariantData, GetCatalogVariantResponse2, GetCatalogVariantError, UpdateCatalogVariantData, UpdateCatalogVariantResponse, UpdateCatalogVariantError, GetCatalogCategoriesData, GetCatalogCategoriesResponse, GetCatalogCategoriesError, CreateCatalogCategoryData, CreateCatalogCategoryResponse, CreateCatalogCategoryError, DeleteCatalogCategoryData, DeleteCatalogCategoryResponse, DeleteCatalogCategoryError, GetCatalogCategoryData, GetCatalogCategoryResponse2, GetCatalogCategoryError, UpdateCatalogCategoryData, UpdateCatalogCategoryResponse, UpdateCatalogCategoryError, GetBulkCreateCatalogItemsJobsData, GetBulkCreateCatalogItemsJobsResponse, GetBulkCreateCatalogItemsJobsError, BulkCreateCatalogItemsData, BulkCreateCatalogItemsResponse, BulkCreateCatalogItemsError, GetBulkCreateCatalogItemsJobData, GetBulkCreateCatalogItemsJobResponse, GetBulkCreateCatalogItemsJobError, GetBulkUpdateCatalogItemsJobsData, GetBulkUpdateCatalogItemsJobsResponse, GetBulkUpdateCatalogItemsJobsError, BulkUpdateCatalogItemsData, BulkUpdateCatalogItemsResponse, BulkUpdateCatalogItemsError, GetBulkUpdateCatalogItemsJobData, GetBulkUpdateCatalogItemsJobResponse, GetBulkUpdateCatalogItemsJobError, GetBulkDeleteCatalogItemsJobsData, GetBulkDeleteCatalogItemsJobsResponse, GetBulkDeleteCatalogItemsJobsError, BulkDeleteCatalogItemsData, BulkDeleteCatalogItemsResponse, BulkDeleteCatalogItemsError, GetBulkDeleteCatalogItemsJobData, GetBulkDeleteCatalogItemsJobResponse, GetBulkDeleteCatalogItemsJobError, GetBulkCreateVariantsJobsData, GetBulkCreateVariantsJobsResponse, GetBulkCreateVariantsJobsError, BulkCreateCatalogVariantsData, BulkCreateCatalogVariantsResponse, BulkCreateCatalogVariantsError, GetBulkCreateVariantsJobData, GetBulkCreateVariantsJobResponse, GetBulkCreateVariantsJobError, GetBulkUpdateVariantsJobsData, GetBulkUpdateVariantsJobsResponse, GetBulkUpdateVariantsJobsError, BulkUpdateCatalogVariantsData, BulkUpdateCatalogVariantsResponse, BulkUpdateCatalogVariantsError, GetBulkUpdateVariantsJobData, GetBulkUpdateVariantsJobResponse, GetBulkUpdateVariantsJobError, GetBulkDeleteVariantsJobsData, GetBulkDeleteVariantsJobsResponse, GetBulkDeleteVariantsJobsError, BulkDeleteCatalogVariantsData, BulkDeleteCatalogVariantsResponse, BulkDeleteCatalogVariantsError, GetBulkDeleteVariantsJobData, GetBulkDeleteVariantsJobResponse, GetBulkDeleteVariantsJobError, GetBulkCreateCategoriesJobsData, GetBulkCreateCategoriesJobsResponse, GetBulkCreateCategoriesJobsError, BulkCreateCatalogCategoriesData, BulkCreateCatalogCategoriesResponse, BulkCreateCatalogCategoriesError, GetBulkCreateCategoriesJobData, GetBulkCreateCategoriesJobResponse, GetBulkCreateCategoriesJobError, GetBulkUpdateCategoriesJobsData, GetBulkUpdateCategoriesJobsResponse, GetBulkUpdateCategoriesJobsError, BulkUpdateCatalogCategoriesData, BulkUpdateCatalogCategoriesResponse, BulkUpdateCatalogCategoriesError, GetBulkUpdateCategoriesJobData, GetBulkUpdateCategoriesJobResponse, GetBulkUpdateCategoriesJobError, GetBulkDeleteCategoriesJobsData, GetBulkDeleteCategoriesJobsResponse, GetBulkDeleteCategoriesJobsError, BulkDeleteCatalogCategoriesData, BulkDeleteCatalogCategoriesResponse, BulkDeleteCatalogCategoriesError, GetBulkDeleteCategoriesJobData, GetBulkDeleteCategoriesJobResponse, GetBulkDeleteCategoriesJobError, CreateBackInStockSubscriptionData, CreateBackInStockSubscriptionError, GetItemsForCatalogCategoryData, GetItemsForCatalogCategoryResponse, GetItemsForCatalogCategoryError, RemoveItemsFromCatalogCategoryData, RemoveItemsFromCatalogCategoryResponse, RemoveItemsFromCatalogCategoryError, GetItemIdsForCatalogCategoryData, GetItemIdsForCatalogCategoryResponse, GetItemIdsForCatalogCategoryError, UpdateItemsForCatalogCategoryData, UpdateItemsForCatalogCategoryResponse, UpdateItemsForCatalogCategoryError, AddItemsToCatalogCategoryData, AddItemsToCatalogCategoryResponse, AddItemsToCatalogCategoryError, GetVariantsForCatalogItemData, GetVariantsForCatalogItemResponse, GetVariantsForCatalogItemError, GetVariantIdsForCatalogItemData, GetVariantIdsForCatalogItemResponse, GetVariantIdsForCatalogItemError, GetCategoriesForCatalogItemData, GetCategoriesForCatalogItemResponse, GetCategoriesForCatalogItemError, RemoveCategoriesFromCatalogItemData, RemoveCategoriesFromCatalogItemResponse, RemoveCategoriesFromCatalogItemError, GetCategoryIdsForCatalogItemData, GetCategoryIdsForCatalogItemResponse, GetCategoryIdsForCatalogItemError, UpdateCategoriesForCatalogItemData, UpdateCategoriesForCatalogItemResponse, UpdateCategoriesForCatalogItemError, AddCategoriesToCatalogItemData, AddCategoriesToCatalogItemResponse, AddCategoriesToCatalogItemError, GetCouponsData, GetCouponsResponse, GetCouponsError, CreateCouponData, CreateCouponResponse, CreateCouponError, DeleteCouponData, DeleteCouponResponse, DeleteCouponError, GetCouponData, GetCouponResponse2, GetCouponError, UpdateCouponData, UpdateCouponResponse, UpdateCouponError, GetCouponCodesData, GetCouponCodesResponse, GetCouponCodesError, CreateCouponCodeData, CreateCouponCodeResponse, CreateCouponCodeError, DeleteCouponCodeData, DeleteCouponCodeResponse, DeleteCouponCodeError, GetCouponCodeData, GetCouponCodeResponse, GetCouponCodeError, UpdateCouponCodeData, UpdateCouponCodeResponse, UpdateCouponCodeError, GetBulkCreateCouponCodeJobsData, GetBulkCreateCouponCodeJobsResponse, GetBulkCreateCouponCodeJobsError, BulkCreateCouponCodesData, BulkCreateCouponCodesResponse, BulkCreateCouponCodesError, GetBulkCreateCouponCodesJobData, GetBulkCreateCouponCodesJobResponse, GetBulkCreateCouponCodesJobError, GetCouponForCouponCodeData, GetCouponForCouponCodeResponse, GetCouponForCouponCodeError, GetCouponIdForCouponCodeData, GetCouponIdForCouponCodeResponse, GetCouponIdForCouponCodeError, GetCouponCodesForCouponData, GetCouponCodesForCouponResponse, GetCouponCodesForCouponError, GetCouponCodeIdsForCouponData, GetCouponCodeIdsForCouponResponse, GetCouponCodeIdsForCouponError, RequestProfileDeletionData, RequestProfileDeletionError, GetEventsData, GetEventsResponse, GetEventsError, CreateEventData, CreateEventError, GetEventData, GetEventResponse, GetEventError, BulkCreateEventsData, BulkCreateEventsError, GetMetricForEventData, GetMetricForEventResponse, GetMetricForEventError, GetMetricIdForEventData, GetMetricIdForEventResponse, GetMetricIdForEventError, GetProfileForEventData, GetProfileForEventResponse, GetProfileForEventError, GetProfileIdForEventData, GetProfileIdForEventResponse, GetProfileIdForEventError, GetFlowsData, GetFlowsResponse, GetFlowsError, CreateFlowData, CreateFlowResponse, CreateFlowError, DeleteFlowData, DeleteFlowResponse, DeleteFlowError, GetFlowData, GetFlowResponse2, GetFlowError, UpdateFlowData, UpdateFlowResponse, UpdateFlowError, GetFlowActionData, GetFlowActionResponse2, GetFlowActionError, GetFlowMessageData, GetFlowMessageResponse, GetFlowMessageError, GetActionsForFlowData, GetActionsForFlowResponse, GetActionsForFlowError, GetActionIdsForFlowData, GetActionIdsForFlowResponse, GetActionIdsForFlowError, GetTagsForFlowData, GetTagsForFlowResponse, GetTagsForFlowError, GetTagIdsForFlowData, GetTagIdsForFlowResponse, GetTagIdsForFlowError, GetFlowForFlowActionData, GetFlowForFlowActionResponse, GetFlowForFlowActionError, GetFlowIdForFlowActionData, GetFlowIdForFlowActionResponse, GetFlowIdForFlowActionError, GetFlowActionMessagesData, GetFlowActionMessagesResponse, GetFlowActionMessagesError, GetMessageIdsForFlowActionData, GetMessageIdsForFlowActionResponse, GetMessageIdsForFlowActionError, GetActionForFlowMessageData, GetActionForFlowMessageResponse, GetActionForFlowMessageError, GetActionIdForFlowMessageData, GetActionIdForFlowMessageResponse, GetActionIdForFlowMessageError, GetTemplateForFlowMessageData, GetTemplateForFlowMessageResponse, GetTemplateForFlowMessageError, GetTemplateIdForFlowMessageData, GetTemplateIdForFlowMessageResponse, GetTemplateIdForFlowMessageError, GetFormsData, GetFormsResponse, GetFormsError, DeleteFormData, DeleteFormResponse, DeleteFormError, GetFormData, GetFormResponse2, GetFormError, GetFormVersionData, GetFormVersionResponse2, GetFormVersionError, GetVersionsForFormData, GetVersionsForFormResponse, GetVersionsForFormError, GetVersionIdsForFormData, GetVersionIdsForFormResponse, GetVersionIdsForFormError, GetFormForFormVersionData, GetFormForFormVersionResponse, GetFormForFormVersionError, GetFormIdForFormVersionData, GetFormIdForFormVersionResponse, GetFormIdForFormVersionError, GetImagesData, GetImagesResponse, GetImagesError, UploadImageFromUrlData, UploadImageFromUrlResponse, UploadImageFromUrlError, GetImageData, GetImageResponse2, GetImageError, UpdateImageData, UpdateImageResponse, UpdateImageError, UploadImageFromFileData, UploadImageFromFileResponse, UploadImageFromFileError, GetListsData, GetListsResponse, GetListsError, CreateListData, CreateListResponse, CreateListError, DeleteListData, DeleteListResponse, DeleteListError, GetListData, GetListResponse, GetListError, UpdateListData, UpdateListResponse, UpdateListError, GetTagsForListData, GetTagsForListResponse, GetTagsForListError, GetTagIdsForListData, GetTagIdsForListResponse, GetTagIdsForListError, GetProfilesForListData, GetProfilesForListResponse, GetProfilesForListError, RemoveProfilesFromListData, RemoveProfilesFromListResponse, RemoveProfilesFromListError, GetProfileIdsForListData, GetProfileIdsForListResponse, GetProfileIdsForListError, AddProfilesToListData, AddProfilesToListResponse, AddProfilesToListError, GetFlowsTriggeredByListData, GetFlowsTriggeredByListResponse, GetFlowsTriggeredByListError, GetIdsForFlowsTriggeredByListData, GetIdsForFlowsTriggeredByListResponse, GetIdsForFlowsTriggeredByListError, GetMetricsData, GetMetricsResponse, GetMetricsError, GetMetricData, GetMetricResponse2, GetMetricError, GetMetricPropertyData, GetMetricPropertyResponse, GetMetricPropertyError, GetCustomMetricsData, GetCustomMetricsResponse, GetCustomMetricsError, CreateCustomMetricData, CreateCustomMetricResponse, CreateCustomMetricError, DeleteCustomMetricData, DeleteCustomMetricResponse, DeleteCustomMetricError, GetCustomMetricData, GetCustomMetricResponse, GetCustomMetricError, UpdateCustomMetricData, UpdateCustomMetricResponse, UpdateCustomMetricError, QueryMetricAggregatesData, QueryMetricAggregatesResponse, QueryMetricAggregatesError, GetFlowsTriggeredByMetricData, GetFlowsTriggeredByMetricResponse, GetFlowsTriggeredByMetricError, GetIdsForFlowsTriggeredByMetricData, GetIdsForFlowsTriggeredByMetricResponse, GetIdsForFlowsTriggeredByMetricError, GetPropertiesForMetricData, GetPropertiesForMetricResponse, GetPropertiesForMetricError, GetPropertyIdsForMetricData, GetPropertyIdsForMetricResponse, GetPropertyIdsForMetricError, GetMetricForMetricPropertyData, GetMetricForMetricPropertyResponse, GetMetricForMetricPropertyError, GetMetricIdForMetricPropertyData, GetMetricIdForMetricPropertyResponse, GetMetricIdForMetricPropertyError, GetMetricsForCustomMetricData, GetMetricsForCustomMetricResponse, GetMetricsForCustomMetricError, GetMetricIdsForCustomMetricData, GetMetricIdsForCustomMetricResponse, GetMetricIdsForCustomMetricError, GetProfilesData, GetProfilesResponse, GetProfilesError, CreateProfileData, CreateProfileResponse, CreateProfileError, GetProfileData, GetProfileResponse2, GetProfileError, UpdateProfileData, UpdateProfileResponse, UpdateProfileError, GetBulkImportProfilesJobsData, GetBulkImportProfilesJobsResponse, GetBulkImportProfilesJobsError, BulkImportProfilesData, BulkImportProfilesResponse, BulkImportProfilesError, GetBulkImportProfilesJobData, GetBulkImportProfilesJobResponse, GetBulkImportProfilesJobError, GetBulkSuppressProfilesJobsData, GetBulkSuppressProfilesJobsResponse, GetBulkSuppressProfilesJobsError, BulkSuppressProfilesData, BulkSuppressProfilesResponse, BulkSuppressProfilesError, GetBulkSuppressProfilesJobData, GetBulkSuppressProfilesJobResponse, GetBulkSuppressProfilesJobError, GetBulkUnsuppressProfilesJobsData, GetBulkUnsuppressProfilesJobsResponse, GetBulkUnsuppressProfilesJobsError, BulkUnsuppressProfilesData, BulkUnsuppressProfilesResponse, BulkUnsuppressProfilesError, GetBulkUnsuppressProfilesJobData, GetBulkUnsuppressProfilesJobResponse, GetBulkUnsuppressProfilesJobError, GetPushTokensData, GetPushTokensResponse, GetPushTokensError, CreatePushTokenData, CreatePushTokenError, DeletePushTokenData, DeletePushTokenResponse, DeletePushTokenError, GetPushTokenData, GetPushTokenResponse, GetPushTokenError, CreateOrUpdateProfileData, CreateOrUpdateProfileResponse, CreateOrUpdateProfileError, MergeProfilesData, MergeProfilesResponse, MergeProfilesError, BulkSubscribeProfilesData, BulkSubscribeProfilesError, BulkUnsubscribeProfilesData, BulkUnsubscribeProfilesError, GetPushTokensForProfileData, GetPushTokensForProfileResponse, GetPushTokensForProfileError, GetPushTokenIdsForProfileData, GetPushTokenIdsForProfileResponse, GetPushTokenIdsForProfileError, GetListsForProfileData, GetListsForProfileResponse, GetListsForProfileError, GetListIdsForProfileData, GetListIdsForProfileResponse, GetListIdsForProfileError, GetSegmentsForProfileData, GetSegmentsForProfileResponse, GetSegmentsForProfileError, GetSegmentIdsForProfileData, GetSegmentIdsForProfileResponse, GetSegmentIdsForProfileError, GetListForBulkImportProfilesJobData, GetListForBulkImportProfilesJobResponse, GetListForBulkImportProfilesJobError, GetListIdsForBulkImportProfilesJobData, GetListIdsForBulkImportProfilesJobResponse, GetListIdsForBulkImportProfilesJobError, GetProfilesForBulkImportProfilesJobData, GetProfilesForBulkImportProfilesJobResponse, GetProfilesForBulkImportProfilesJobError, GetProfileIdsForBulkImportProfilesJobData, GetProfileIdsForBulkImportProfilesJobResponse, GetProfileIdsForBulkImportProfilesJobError, GetErrorsForBulkImportProfilesJobData, GetErrorsForBulkImportProfilesJobResponse, GetErrorsForBulkImportProfilesJobError, GetProfileForPushTokenData, GetProfileForPushTokenResponse, GetProfileForPushTokenError, GetProfileIdForPushTokenData, GetProfileIdForPushTokenResponse, GetProfileIdForPushTokenError, QueryCampaignValuesData, QueryCampaignValuesResponse, QueryCampaignValuesError, QueryFlowValuesData, QueryFlowValuesResponse, QueryFlowValuesError, QueryFlowSeriesData, QueryFlowSeriesResponse, QueryFlowSeriesError, QueryFormValuesData, QueryFormValuesResponse, QueryFormValuesError, QueryFormSeriesData, QueryFormSeriesResponse, QueryFormSeriesError, QuerySegmentValuesData, QuerySegmentValuesResponse, QuerySegmentValuesError, QuerySegmentSeriesData, QuerySegmentSeriesResponse, QuerySegmentSeriesError, GetReviewsData, GetReviewsResponse, GetReviewsError, GetReviewData, GetReviewResponse, GetReviewError, UpdateReviewData, UpdateReviewResponse, UpdateReviewError, GetSegmentsData, GetSegmentsResponse, GetSegmentsError, CreateSegmentData, CreateSegmentResponse, CreateSegmentError, DeleteSegmentData, DeleteSegmentResponse, DeleteSegmentError, GetSegmentData, GetSegmentResponse, GetSegmentError, UpdateSegmentData, UpdateSegmentResponse, UpdateSegmentError, GetTagsForSegmentData, GetTagsForSegmentResponse, GetTagsForSegmentError, GetTagIdsForSegmentData, GetTagIdsForSegmentResponse, GetTagIdsForSegmentError, GetProfilesForSegmentData, GetProfilesForSegmentResponse, GetProfilesForSegmentError, GetProfileIdsForSegmentData, GetProfileIdsForSegmentResponse, GetProfileIdsForSegmentError, GetFlowsTriggeredBySegmentData, GetFlowsTriggeredBySegmentResponse, GetFlowsTriggeredBySegmentError, GetIdsForFlowsTriggeredBySegmentData, GetIdsForFlowsTriggeredBySegmentResponse, GetIdsForFlowsTriggeredBySegmentError, GetTagsData, GetTagsResponse, GetTagsError, CreateTagData, CreateTagResponse, CreateTagError, DeleteTagData, DeleteTagResponse, DeleteTagError, GetTagData, GetTagResponse, GetTagError, UpdateTagData, UpdateTagResponse, UpdateTagError, GetTagGroupsData, GetTagGroupsResponse, GetTagGroupsError, CreateTagGroupData, CreateTagGroupResponse, CreateTagGroupError, DeleteTagGroupData, DeleteTagGroupResponse2, DeleteTagGroupError, GetTagGroupData, GetTagGroupResponse2, GetTagGroupError, UpdateTagGroupData, UpdateTagGroupResponse, UpdateTagGroupError, RemoveTagFromFlowsData, RemoveTagFromFlowsResponse, RemoveTagFromFlowsError, GetFlowIdsForTagData, GetFlowIdsForTagResponse, GetFlowIdsForTagError, TagFlowsData, TagFlowsResponse, TagFlowsError, RemoveTagFromCampaignsData, RemoveTagFromCampaignsResponse, RemoveTagFromCampaignsError, GetCampaignIdsForTagData, GetCampaignIdsForTagResponse, GetCampaignIdsForTagError, TagCampaignsData, TagCampaignsResponse, TagCampaignsError, RemoveTagFromListsData, RemoveTagFromListsResponse, RemoveTagFromListsError, GetListIdsForTagData, GetListIdsForTagResponse, GetListIdsForTagError, TagListsData, TagListsResponse, TagListsError, RemoveTagFromSegmentsData, RemoveTagFromSegmentsResponse, RemoveTagFromSegmentsError, GetSegmentIdsForTagData, GetSegmentIdsForTagResponse, GetSegmentIdsForTagError, TagSegmentsData, TagSegmentsResponse, TagSegmentsError, GetTagGroupForTagData, GetTagGroupForTagResponse, GetTagGroupForTagError, GetTagGroupIdForTagData, GetTagGroupIdForTagResponse, GetTagGroupIdForTagError, GetTagsForTagGroupData, GetTagsForTagGroupResponse, GetTagsForTagGroupError, GetTagIdsForTagGroupData, GetTagIdsForTagGroupResponse, GetTagIdsForTagGroupError, GetTemplatesData, GetTemplatesResponse, GetTemplatesError, CreateTemplateData, CreateTemplateResponse, CreateTemplateError, DeleteTemplateData, DeleteTemplateResponse, DeleteTemplateError, GetTemplateData, GetTemplateResponse2, GetTemplateError, UpdateTemplateData, UpdateTemplateResponse, UpdateTemplateError, GetAllUniversalContentData, GetAllUniversalContentResponse, GetAllUniversalContentError, CreateUniversalContentData, CreateUniversalContentResponse, CreateUniversalContentError, DeleteUniversalContentData, DeleteUniversalContentResponse, DeleteUniversalContentError, GetUniversalContentData, GetUniversalContentResponse2, GetUniversalContentError, UpdateUniversalContentData, UpdateUniversalContentResponse, UpdateUniversalContentError, RenderTemplateData, RenderTemplateResponse, RenderTemplateError, CloneTemplateData, CloneTemplateResponse, CloneTemplateError, GetTrackingSettingsData, GetTrackingSettingsResponse, GetTrackingSettingsError, GetTrackingSettingData, GetTrackingSettingResponse2, GetTrackingSettingError, UpdateTrackingSettingData, UpdateTrackingSettingResponse, UpdateTrackingSettingError, GetWebFeedsData, GetWebFeedsResponse, GetWebFeedsError, CreateWebFeedData, CreateWebFeedResponse, CreateWebFeedError, DeleteWebFeedData, DeleteWebFeedResponse, DeleteWebFeedError, GetWebFeedData, GetWebFeedResponse2, GetWebFeedError, UpdateWebFeedData, UpdateWebFeedResponse, UpdateWebFeedError, GetWebhooksData, GetWebhooksResponse, GetWebhooksError, CreateWebhookData, CreateWebhookResponse, CreateWebhookError, DeleteWebhookData, DeleteWebhookResponse, DeleteWebhookError, GetWebhookData, GetWebhookResponse, GetWebhookError, UpdateWebhookData, UpdateWebhookResponse, UpdateWebhookError, GetWebhookTopicsData, GetWebhookTopicsResponse, GetWebhookTopicsError, GetWebhookTopicData, GetWebhookTopicResponse2, GetWebhookTopicError, GetClientReviewValuesReportsData, GetClientReviewValuesReportsResponse, GetClientReviewValuesReportsError, GetClientReviewsData, GetClientReviewsResponse, GetClientReviewsError, CreateClientReviewData, CreateClientReviewError, CreateClientSubscriptionData, CreateClientSubscriptionError, CreateClientPushTokenData, CreateClientPushTokenError, UnregisterClientPushTokenData, UnregisterClientPushTokenError, CreateClientEventData, CreateClientEventError, CreateClientProfileData, CreateClientProfileError, BulkCreateClientEventsData, BulkCreateClientEventsError, CreateClientBackInStockSubscriptionData, CreateClientBackInStockSubscriptionError } from './types.gen';
|
|
5
|
-
import { client as _heyApiClient } from './client.gen';
|
|
4
|
+
import type { GetAccountsData, GetAccountsResponse, GetAccountsError, GetAccountData, GetAccountResponse2, GetAccountError, GetCampaignsData, GetCampaignsResponse, GetCampaignsError, CreateCampaignData, CreateCampaignResponse, CreateCampaignError, DeleteCampaignData, DeleteCampaignResponse, DeleteCampaignError, GetCampaignData, GetCampaignResponse2, GetCampaignError, UpdateCampaignData, UpdateCampaignResponse, UpdateCampaignError, GetCampaignMessageData, GetCampaignMessageResponse, GetCampaignMessageError, UpdateCampaignMessageData, UpdateCampaignMessageResponse, UpdateCampaignMessageError, GetCampaignSendJobData, GetCampaignSendJobResponse2, GetCampaignSendJobError, CancelCampaignSendData, CancelCampaignSendResponse, CancelCampaignSendError, GetCampaignRecipientEstimationJobData, GetCampaignRecipientEstimationJobResponse2, GetCampaignRecipientEstimationJobError, GetCampaignRecipientEstimationData, GetCampaignRecipientEstimationResponse2, GetCampaignRecipientEstimationError, CreateCampaignCloneData, CreateCampaignCloneResponse, CreateCampaignCloneError, AssignTemplateToCampaignMessageData, AssignTemplateToCampaignMessageResponse, AssignTemplateToCampaignMessageError, SendCampaignData, SendCampaignResponse, SendCampaignError, RefreshCampaignRecipientEstimationData, RefreshCampaignRecipientEstimationResponse, RefreshCampaignRecipientEstimationError, GetCampaignForCampaignMessageData, GetCampaignForCampaignMessageResponse, GetCampaignForCampaignMessageError, GetCampaignIdForCampaignMessageData, GetCampaignIdForCampaignMessageResponse, GetCampaignIdForCampaignMessageError, GetTemplateForCampaignMessageData, GetTemplateForCampaignMessageResponse, GetTemplateForCampaignMessageError, GetTemplateIdForCampaignMessageData, GetTemplateIdForCampaignMessageResponse, GetTemplateIdForCampaignMessageError, GetImageForCampaignMessageData, GetImageForCampaignMessageResponse, GetImageForCampaignMessageError, GetImageIdForCampaignMessageData, GetImageIdForCampaignMessageResponse, GetImageIdForCampaignMessageError, UpdateImageForCampaignMessageData, UpdateImageForCampaignMessageResponse, UpdateImageForCampaignMessageError, GetTagsForCampaignData, GetTagsForCampaignResponse, GetTagsForCampaignError, GetTagIdsForCampaignData, GetTagIdsForCampaignResponse, GetTagIdsForCampaignError, GetMessagesForCampaignData, GetMessagesForCampaignResponse, GetMessagesForCampaignError, GetMessageIdsForCampaignData, GetMessageIdsForCampaignResponse, GetMessageIdsForCampaignError, GetCatalogItemsData, GetCatalogItemsResponse, GetCatalogItemsError, CreateCatalogItemData, CreateCatalogItemResponse, CreateCatalogItemError, DeleteCatalogItemData, DeleteCatalogItemResponse, DeleteCatalogItemError, GetCatalogItemData, GetCatalogItemResponse, GetCatalogItemError, UpdateCatalogItemData, UpdateCatalogItemResponse, UpdateCatalogItemError, GetCatalogVariantsData, GetCatalogVariantsResponse, GetCatalogVariantsError, CreateCatalogVariantData, CreateCatalogVariantResponse, CreateCatalogVariantError, DeleteCatalogVariantData, DeleteCatalogVariantResponse, DeleteCatalogVariantError, GetCatalogVariantData, GetCatalogVariantResponse2, GetCatalogVariantError, UpdateCatalogVariantData, UpdateCatalogVariantResponse, UpdateCatalogVariantError, GetCatalogCategoriesData, GetCatalogCategoriesResponse, GetCatalogCategoriesError, CreateCatalogCategoryData, CreateCatalogCategoryResponse, CreateCatalogCategoryError, DeleteCatalogCategoryData, DeleteCatalogCategoryResponse, DeleteCatalogCategoryError, GetCatalogCategoryData, GetCatalogCategoryResponse2, GetCatalogCategoryError, UpdateCatalogCategoryData, UpdateCatalogCategoryResponse, UpdateCatalogCategoryError, GetBulkCreateCatalogItemsJobsData, GetBulkCreateCatalogItemsJobsResponse, GetBulkCreateCatalogItemsJobsError, BulkCreateCatalogItemsData, BulkCreateCatalogItemsResponse, BulkCreateCatalogItemsError, GetBulkCreateCatalogItemsJobData, GetBulkCreateCatalogItemsJobResponse, GetBulkCreateCatalogItemsJobError, GetBulkUpdateCatalogItemsJobsData, GetBulkUpdateCatalogItemsJobsResponse, GetBulkUpdateCatalogItemsJobsError, BulkUpdateCatalogItemsData, BulkUpdateCatalogItemsResponse, BulkUpdateCatalogItemsError, GetBulkUpdateCatalogItemsJobData, GetBulkUpdateCatalogItemsJobResponse, GetBulkUpdateCatalogItemsJobError, GetBulkDeleteCatalogItemsJobsData, GetBulkDeleteCatalogItemsJobsResponse, GetBulkDeleteCatalogItemsJobsError, BulkDeleteCatalogItemsData, BulkDeleteCatalogItemsResponse, BulkDeleteCatalogItemsError, GetBulkDeleteCatalogItemsJobData, GetBulkDeleteCatalogItemsJobResponse, GetBulkDeleteCatalogItemsJobError, GetBulkCreateVariantsJobsData, GetBulkCreateVariantsJobsResponse, GetBulkCreateVariantsJobsError, BulkCreateCatalogVariantsData, BulkCreateCatalogVariantsResponse, BulkCreateCatalogVariantsError, GetBulkCreateVariantsJobData, GetBulkCreateVariantsJobResponse, GetBulkCreateVariantsJobError, GetBulkUpdateVariantsJobsData, GetBulkUpdateVariantsJobsResponse, GetBulkUpdateVariantsJobsError, BulkUpdateCatalogVariantsData, BulkUpdateCatalogVariantsResponse, BulkUpdateCatalogVariantsError, GetBulkUpdateVariantsJobData, GetBulkUpdateVariantsJobResponse, GetBulkUpdateVariantsJobError, GetBulkDeleteVariantsJobsData, GetBulkDeleteVariantsJobsResponse, GetBulkDeleteVariantsJobsError, BulkDeleteCatalogVariantsData, BulkDeleteCatalogVariantsResponse, BulkDeleteCatalogVariantsError, GetBulkDeleteVariantsJobData, GetBulkDeleteVariantsJobResponse, GetBulkDeleteVariantsJobError, GetBulkCreateCategoriesJobsData, GetBulkCreateCategoriesJobsResponse, GetBulkCreateCategoriesJobsError, BulkCreateCatalogCategoriesData, BulkCreateCatalogCategoriesResponse, BulkCreateCatalogCategoriesError, GetBulkCreateCategoriesJobData, GetBulkCreateCategoriesJobResponse, GetBulkCreateCategoriesJobError, GetBulkUpdateCategoriesJobsData, GetBulkUpdateCategoriesJobsResponse, GetBulkUpdateCategoriesJobsError, BulkUpdateCatalogCategoriesData, BulkUpdateCatalogCategoriesResponse, BulkUpdateCatalogCategoriesError, GetBulkUpdateCategoriesJobData, GetBulkUpdateCategoriesJobResponse, GetBulkUpdateCategoriesJobError, GetBulkDeleteCategoriesJobsData, GetBulkDeleteCategoriesJobsResponse, GetBulkDeleteCategoriesJobsError, BulkDeleteCatalogCategoriesData, BulkDeleteCatalogCategoriesResponse, BulkDeleteCatalogCategoriesError, GetBulkDeleteCategoriesJobData, GetBulkDeleteCategoriesJobResponse, GetBulkDeleteCategoriesJobError, CreateBackInStockSubscriptionData, CreateBackInStockSubscriptionError, GetItemsForCatalogCategoryData, GetItemsForCatalogCategoryResponse, GetItemsForCatalogCategoryError, RemoveItemsFromCatalogCategoryData, RemoveItemsFromCatalogCategoryResponse, RemoveItemsFromCatalogCategoryError, GetItemIdsForCatalogCategoryData, GetItemIdsForCatalogCategoryResponse, GetItemIdsForCatalogCategoryError, UpdateItemsForCatalogCategoryData, UpdateItemsForCatalogCategoryResponse, UpdateItemsForCatalogCategoryError, AddItemsToCatalogCategoryData, AddItemsToCatalogCategoryResponse, AddItemsToCatalogCategoryError, GetVariantsForCatalogItemData, GetVariantsForCatalogItemResponse, GetVariantsForCatalogItemError, GetVariantIdsForCatalogItemData, GetVariantIdsForCatalogItemResponse, GetVariantIdsForCatalogItemError, GetCategoriesForCatalogItemData, GetCategoriesForCatalogItemResponse, GetCategoriesForCatalogItemError, RemoveCategoriesFromCatalogItemData, RemoveCategoriesFromCatalogItemResponse, RemoveCategoriesFromCatalogItemError, GetCategoryIdsForCatalogItemData, GetCategoryIdsForCatalogItemResponse, GetCategoryIdsForCatalogItemError, UpdateCategoriesForCatalogItemData, UpdateCategoriesForCatalogItemResponse, UpdateCategoriesForCatalogItemError, AddCategoriesToCatalogItemData, AddCategoriesToCatalogItemResponse, AddCategoriesToCatalogItemError, GetCouponsData, GetCouponsResponse, GetCouponsError, CreateCouponData, CreateCouponResponse, CreateCouponError, DeleteCouponData, DeleteCouponResponse, DeleteCouponError, GetCouponData, GetCouponResponse2, GetCouponError, UpdateCouponData, UpdateCouponResponse, UpdateCouponError, GetCouponCodesData, GetCouponCodesResponse, GetCouponCodesError, CreateCouponCodeData, CreateCouponCodeResponse, CreateCouponCodeError, DeleteCouponCodeData, DeleteCouponCodeResponse, DeleteCouponCodeError, GetCouponCodeData, GetCouponCodeResponse, GetCouponCodeError, UpdateCouponCodeData, UpdateCouponCodeResponse, UpdateCouponCodeError, GetBulkCreateCouponCodeJobsData, GetBulkCreateCouponCodeJobsResponse, GetBulkCreateCouponCodeJobsError, BulkCreateCouponCodesData, BulkCreateCouponCodesResponse, BulkCreateCouponCodesError, GetBulkCreateCouponCodesJobData, GetBulkCreateCouponCodesJobResponse, GetBulkCreateCouponCodesJobError, GetCouponForCouponCodeData, GetCouponForCouponCodeResponse, GetCouponForCouponCodeError, GetCouponIdForCouponCodeData, GetCouponIdForCouponCodeResponse, GetCouponIdForCouponCodeError, GetCouponCodesForCouponData, GetCouponCodesForCouponResponse, GetCouponCodesForCouponError, GetCouponCodeIdsForCouponData, GetCouponCodeIdsForCouponResponse, GetCouponCodeIdsForCouponError, GetDataSourcesData, GetDataSourcesResponse, GetDataSourcesError, CreateDataSourceData, CreateDataSourceResponse, CreateDataSourceError, DeleteDataSourceData, DeleteDataSourceResponse, DeleteDataSourceError, GetDataSourceData, GetDataSourceResponse2, GetDataSourceError, BulkCreateDataSourceRecordsData, BulkCreateDataSourceRecordsResponse, BulkCreateDataSourceRecordsError, RequestProfileDeletionData, RequestProfileDeletionError, GetEventsData, GetEventsResponse, GetEventsError, CreateEventData, CreateEventError, GetEventData, GetEventResponse, GetEventError, BulkCreateEventsData, BulkCreateEventsError, GetMetricForEventData, GetMetricForEventResponse, GetMetricForEventError, GetMetricIdForEventData, GetMetricIdForEventResponse, GetMetricIdForEventError, GetProfileForEventData, GetProfileForEventResponse, GetProfileForEventError, GetProfileIdForEventData, GetProfileIdForEventResponse, GetProfileIdForEventError, GetFlowsData, GetFlowsResponse, GetFlowsError, CreateFlowData, CreateFlowResponse, CreateFlowError, DeleteFlowData, DeleteFlowResponse, DeleteFlowError, GetFlowData, GetFlowResponse2, GetFlowError, UpdateFlowData, UpdateFlowResponse, UpdateFlowError, GetFlowActionData, GetFlowActionResponse, GetFlowActionError, UpdateFlowActionData, UpdateFlowActionResponse, UpdateFlowActionError, GetFlowMessageData, GetFlowMessageResponse, GetFlowMessageError, GetActionsForFlowData, GetActionsForFlowResponse, GetActionsForFlowError, GetActionIdsForFlowData, GetActionIdsForFlowResponse, GetActionIdsForFlowError, GetTagsForFlowData, GetTagsForFlowResponse, GetTagsForFlowError, GetTagIdsForFlowData, GetTagIdsForFlowResponse, GetTagIdsForFlowError, GetFlowForFlowActionData, GetFlowForFlowActionResponse, GetFlowForFlowActionError, GetFlowIdForFlowActionData, GetFlowIdForFlowActionResponse, GetFlowIdForFlowActionError, GetFlowActionMessagesData, GetFlowActionMessagesResponse, GetFlowActionMessagesError, GetMessageIdsForFlowActionData, GetMessageIdsForFlowActionResponse, GetMessageIdsForFlowActionError, GetActionForFlowMessageData, GetActionForFlowMessageResponse, GetActionForFlowMessageError, GetActionIdForFlowMessageData, GetActionIdForFlowMessageResponse, GetActionIdForFlowMessageError, GetTemplateForFlowMessageData, GetTemplateForFlowMessageResponse, GetTemplateForFlowMessageError, GetTemplateIdForFlowMessageData, GetTemplateIdForFlowMessageResponse, GetTemplateIdForFlowMessageError, GetFormsData, GetFormsResponse, GetFormsError, CreateFormData, CreateFormResponse, CreateFormError, DeleteFormData, DeleteFormResponse, DeleteFormError, GetFormData, GetFormResponse2, GetFormError, GetFormVersionData, GetFormVersionResponse2, GetFormVersionError, GetVersionsForFormData, GetVersionsForFormResponse, GetVersionsForFormError, GetVersionIdsForFormData, GetVersionIdsForFormResponse, GetVersionIdsForFormError, GetFormForFormVersionData, GetFormForFormVersionResponse, GetFormForFormVersionError, GetFormIdForFormVersionData, GetFormIdForFormVersionResponse, GetFormIdForFormVersionError, GetImagesData, GetImagesResponse, GetImagesError, UploadImageFromUrlData, UploadImageFromUrlResponse, UploadImageFromUrlError, GetImageData, GetImageResponse2, GetImageError, UpdateImageData, UpdateImageResponse, UpdateImageError, UploadImageFromFileData, UploadImageFromFileResponse, UploadImageFromFileError, GetListsData, GetListsResponse, GetListsError, CreateListData, CreateListResponse, CreateListError, DeleteListData, DeleteListResponse, DeleteListError, GetListData, GetListResponse, GetListError, UpdateListData, UpdateListResponse, UpdateListError, GetTagsForListData, GetTagsForListResponse, GetTagsForListError, GetTagIdsForListData, GetTagIdsForListResponse, GetTagIdsForListError, GetProfilesForListData, GetProfilesForListResponse, GetProfilesForListError, RemoveProfilesFromListData, RemoveProfilesFromListResponse, RemoveProfilesFromListError, GetProfileIdsForListData, GetProfileIdsForListResponse, GetProfileIdsForListError, AddProfilesToListData, AddProfilesToListResponse, AddProfilesToListError, GetFlowsTriggeredByListData, GetFlowsTriggeredByListResponse, GetFlowsTriggeredByListError, GetIdsForFlowsTriggeredByListData, GetIdsForFlowsTriggeredByListResponse, GetIdsForFlowsTriggeredByListError, GetMetricsData, GetMetricsResponse, GetMetricsError, GetMetricData, GetMetricResponse2, GetMetricError, GetMetricPropertyData, GetMetricPropertyResponse, GetMetricPropertyError, GetCustomMetricsData, GetCustomMetricsResponse, GetCustomMetricsError, CreateCustomMetricData, CreateCustomMetricResponse, CreateCustomMetricError, DeleteCustomMetricData, DeleteCustomMetricResponse, DeleteCustomMetricError, GetCustomMetricData, GetCustomMetricResponse2, GetCustomMetricError, UpdateCustomMetricData, UpdateCustomMetricResponse, UpdateCustomMetricError, GetMappedMetricsData, GetMappedMetricsResponse, GetMappedMetricsError, GetMappedMetricData, GetMappedMetricResponse, GetMappedMetricError, UpdateMappedMetricData, UpdateMappedMetricResponse, UpdateMappedMetricError, QueryMetricAggregatesData, QueryMetricAggregatesResponse, QueryMetricAggregatesError, GetFlowsTriggeredByMetricData, GetFlowsTriggeredByMetricResponse, GetFlowsTriggeredByMetricError, GetIdsForFlowsTriggeredByMetricData, GetIdsForFlowsTriggeredByMetricResponse, GetIdsForFlowsTriggeredByMetricError, GetPropertiesForMetricData, GetPropertiesForMetricResponse, GetPropertiesForMetricError, GetPropertyIdsForMetricData, GetPropertyIdsForMetricResponse, GetPropertyIdsForMetricError, GetMetricForMetricPropertyData, GetMetricForMetricPropertyResponse, GetMetricForMetricPropertyError, GetMetricIdForMetricPropertyData, GetMetricIdForMetricPropertyResponse, GetMetricIdForMetricPropertyError, GetMetricsForCustomMetricData, GetMetricsForCustomMetricResponse, GetMetricsForCustomMetricError, GetMetricIdsForCustomMetricData, GetMetricIdsForCustomMetricResponse, GetMetricIdsForCustomMetricError, GetMetricForMappedMetricData, GetMetricForMappedMetricResponse, GetMetricForMappedMetricError, GetMetricIdForMappedMetricData, GetMetricIdForMappedMetricResponse, GetMetricIdForMappedMetricError, GetCustomMetricForMappedMetricData, GetCustomMetricForMappedMetricResponse, GetCustomMetricForMappedMetricError, GetCustomMetricIdForMappedMetricData, GetCustomMetricIdForMappedMetricResponse, GetCustomMetricIdForMappedMetricError, GetProfilesData, GetProfilesResponse, GetProfilesError, CreateProfileData, CreateProfileResponse, CreateProfileError, GetProfileData, GetProfileResponse2, GetProfileError, UpdateProfileData, UpdateProfileResponse, UpdateProfileError, GetBulkImportProfilesJobsData, GetBulkImportProfilesJobsResponse, GetBulkImportProfilesJobsError, BulkImportProfilesData, BulkImportProfilesResponse, BulkImportProfilesError, GetBulkImportProfilesJobData, GetBulkImportProfilesJobResponse, GetBulkImportProfilesJobError, GetBulkSuppressProfilesJobsData, GetBulkSuppressProfilesJobsResponse, GetBulkSuppressProfilesJobsError, BulkSuppressProfilesData, BulkSuppressProfilesResponse, BulkSuppressProfilesError, GetBulkSuppressProfilesJobData, GetBulkSuppressProfilesJobResponse, GetBulkSuppressProfilesJobError, GetBulkUnsuppressProfilesJobsData, GetBulkUnsuppressProfilesJobsResponse, GetBulkUnsuppressProfilesJobsError, BulkUnsuppressProfilesData, BulkUnsuppressProfilesResponse, BulkUnsuppressProfilesError, GetBulkUnsuppressProfilesJobData, GetBulkUnsuppressProfilesJobResponse, GetBulkUnsuppressProfilesJobError, GetPushTokensData, GetPushTokensResponse, GetPushTokensError, CreatePushTokenData, CreatePushTokenError, DeletePushTokenData, DeletePushTokenResponse, DeletePushTokenError, GetPushTokenData, GetPushTokenResponse, GetPushTokenError, CreateOrUpdateProfileData, CreateOrUpdateProfileResponse, CreateOrUpdateProfileError, MergeProfilesData, MergeProfilesResponse, MergeProfilesError, BulkSubscribeProfilesData, BulkSubscribeProfilesError, BulkUnsubscribeProfilesData, BulkUnsubscribeProfilesError, GetPushTokensForProfileData, GetPushTokensForProfileResponse, GetPushTokensForProfileError, GetPushTokenIdsForProfileData, GetPushTokenIdsForProfileResponse, GetPushTokenIdsForProfileError, GetListsForProfileData, GetListsForProfileResponse, GetListsForProfileError, GetListIdsForProfileData, GetListIdsForProfileResponse, GetListIdsForProfileError, GetSegmentsForProfileData, GetSegmentsForProfileResponse, GetSegmentsForProfileError, GetSegmentIdsForProfileData, GetSegmentIdsForProfileResponse, GetSegmentIdsForProfileError, GetListForBulkImportProfilesJobData, GetListForBulkImportProfilesJobResponse, GetListForBulkImportProfilesJobError, GetListIdsForBulkImportProfilesJobData, GetListIdsForBulkImportProfilesJobResponse, GetListIdsForBulkImportProfilesJobError, GetProfilesForBulkImportProfilesJobData, GetProfilesForBulkImportProfilesJobResponse, GetProfilesForBulkImportProfilesJobError, GetProfileIdsForBulkImportProfilesJobData, GetProfileIdsForBulkImportProfilesJobResponse, GetProfileIdsForBulkImportProfilesJobError, GetErrorsForBulkImportProfilesJobData, GetErrorsForBulkImportProfilesJobResponse, GetErrorsForBulkImportProfilesJobError, GetProfileForPushTokenData, GetProfileForPushTokenResponse, GetProfileForPushTokenError, GetProfileIdForPushTokenData, GetProfileIdForPushTokenResponse, GetProfileIdForPushTokenError, QueryCampaignValuesData, QueryCampaignValuesResponse, QueryCampaignValuesError, QueryFlowValuesData, QueryFlowValuesResponse, QueryFlowValuesError, QueryFlowSeriesData, QueryFlowSeriesResponse, QueryFlowSeriesError, QueryFormValuesData, QueryFormValuesResponse, QueryFormValuesError, QueryFormSeriesData, QueryFormSeriesResponse, QueryFormSeriesError, QuerySegmentValuesData, QuerySegmentValuesResponse, QuerySegmentValuesError, QuerySegmentSeriesData, QuerySegmentSeriesResponse, QuerySegmentSeriesError, GetReviewsData, GetReviewsResponse, GetReviewsError, GetReviewData, GetReviewResponse, GetReviewError, UpdateReviewData, UpdateReviewResponse, UpdateReviewError, GetSegmentsData, GetSegmentsResponse, GetSegmentsError, CreateSegmentData, CreateSegmentResponse, CreateSegmentError, DeleteSegmentData, DeleteSegmentResponse, DeleteSegmentError, GetSegmentData, GetSegmentResponse, GetSegmentError, UpdateSegmentData, UpdateSegmentResponse, UpdateSegmentError, GetTagsForSegmentData, GetTagsForSegmentResponse, GetTagsForSegmentError, GetTagIdsForSegmentData, GetTagIdsForSegmentResponse, GetTagIdsForSegmentError, GetProfilesForSegmentData, GetProfilesForSegmentResponse, GetProfilesForSegmentError, GetProfileIdsForSegmentData, GetProfileIdsForSegmentResponse, GetProfileIdsForSegmentError, GetFlowsTriggeredBySegmentData, GetFlowsTriggeredBySegmentResponse, GetFlowsTriggeredBySegmentError, GetIdsForFlowsTriggeredBySegmentData, GetIdsForFlowsTriggeredBySegmentResponse, GetIdsForFlowsTriggeredBySegmentError, GetTagsData, GetTagsResponse, GetTagsError, CreateTagData, CreateTagResponse, CreateTagError, DeleteTagData, DeleteTagResponse, DeleteTagError, GetTagData, GetTagResponse, GetTagError, UpdateTagData, UpdateTagResponse, UpdateTagError, GetTagGroupsData, GetTagGroupsResponse, GetTagGroupsError, CreateTagGroupData, CreateTagGroupResponse, CreateTagGroupError, DeleteTagGroupData, DeleteTagGroupResponse2, DeleteTagGroupError, GetTagGroupData, GetTagGroupResponse2, GetTagGroupError, UpdateTagGroupData, UpdateTagGroupResponse, UpdateTagGroupError, RemoveTagFromFlowsData, RemoveTagFromFlowsResponse, RemoveTagFromFlowsError, GetFlowIdsForTagData, GetFlowIdsForTagResponse, GetFlowIdsForTagError, TagFlowsData, TagFlowsResponse, TagFlowsError, RemoveTagFromCampaignsData, RemoveTagFromCampaignsResponse, RemoveTagFromCampaignsError, GetCampaignIdsForTagData, GetCampaignIdsForTagResponse, GetCampaignIdsForTagError, TagCampaignsData, TagCampaignsResponse, TagCampaignsError, RemoveTagFromListsData, RemoveTagFromListsResponse, RemoveTagFromListsError, GetListIdsForTagData, GetListIdsForTagResponse, GetListIdsForTagError, TagListsData, TagListsResponse, TagListsError, RemoveTagFromSegmentsData, RemoveTagFromSegmentsResponse, RemoveTagFromSegmentsError, GetSegmentIdsForTagData, GetSegmentIdsForTagResponse, GetSegmentIdsForTagError, TagSegmentsData, TagSegmentsResponse, TagSegmentsError, GetTagGroupForTagData, GetTagGroupForTagResponse, GetTagGroupForTagError, GetTagGroupIdForTagData, GetTagGroupIdForTagResponse, GetTagGroupIdForTagError, GetTagsForTagGroupData, GetTagsForTagGroupResponse, GetTagsForTagGroupError, GetTagIdsForTagGroupData, GetTagIdsForTagGroupResponse, GetTagIdsForTagGroupError, GetTemplatesData, GetTemplatesResponse, GetTemplatesError, CreateTemplateData, CreateTemplateResponse, CreateTemplateError, DeleteTemplateData, DeleteTemplateResponse, DeleteTemplateError, GetTemplateData, GetTemplateResponse2, GetTemplateError, UpdateTemplateData, UpdateTemplateResponse, UpdateTemplateError, GetAllUniversalContentData, GetAllUniversalContentResponse, GetAllUniversalContentError, CreateUniversalContentData, CreateUniversalContentResponse, CreateUniversalContentError, DeleteUniversalContentData, DeleteUniversalContentResponse, DeleteUniversalContentError, GetUniversalContentData, GetUniversalContentResponse2, GetUniversalContentError, UpdateUniversalContentData, UpdateUniversalContentResponse, UpdateUniversalContentError, RenderTemplateData, RenderTemplateResponse, RenderTemplateError, CloneTemplateData, CloneTemplateResponse, CloneTemplateError, GetTrackingSettingsData, GetTrackingSettingsResponse, GetTrackingSettingsError, GetTrackingSettingData, GetTrackingSettingResponse2, GetTrackingSettingError, UpdateTrackingSettingData, UpdateTrackingSettingResponse, UpdateTrackingSettingError, GetWebFeedsData, GetWebFeedsResponse, GetWebFeedsError, CreateWebFeedData, CreateWebFeedResponse, CreateWebFeedError, DeleteWebFeedData, DeleteWebFeedResponse, DeleteWebFeedError, GetWebFeedData, GetWebFeedResponse2, GetWebFeedError, UpdateWebFeedData, UpdateWebFeedResponse, UpdateWebFeedError, GetWebhooksData, GetWebhooksResponse, GetWebhooksError, CreateWebhookData, CreateWebhookResponse, CreateWebhookError, DeleteWebhookData, DeleteWebhookResponse, DeleteWebhookError, GetWebhookData, GetWebhookResponse, GetWebhookError, UpdateWebhookData, UpdateWebhookResponse, UpdateWebhookError, GetWebhookTopicsData, GetWebhookTopicsResponse, GetWebhookTopicsError, GetWebhookTopicData, GetWebhookTopicResponse2, GetWebhookTopicError, GetClientReviewValuesReportsData, GetClientReviewValuesReportsResponse, GetClientReviewValuesReportsError, GetClientReviewsData, GetClientReviewsResponse, GetClientReviewsError, CreateClientReviewData, CreateClientReviewError, CreateClientSubscriptionData, CreateClientSubscriptionError, CreateClientPushTokenData, CreateClientPushTokenError, UnregisterClientPushTokenData, UnregisterClientPushTokenError, CreateClientEventData, CreateClientEventError, CreateClientProfileData, CreateClientProfileError, BulkCreateClientEventsData, BulkCreateClientEventsError, CreateClientBackInStockSubscriptionData, CreateClientBackInStockSubscriptionError } from './types.gen.js';
|
|
5
|
+
import { client as _heyApiClient } from './client.gen.js';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
@@ -2583,6 +2583,130 @@ export const getCouponCodeIdsForCoupon = <ThrowOnError extends boolean = false>(
|
|
|
2583
2583
|
});
|
|
2584
2584
|
};
|
|
2585
2585
|
|
|
2586
|
+
/**
|
|
2587
|
+
* Get Data Sources
|
|
2588
|
+
* Get all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
2589
|
+
*
|
|
2590
|
+
* **Scopes:**
|
|
2591
|
+
* `custom-objects:read`
|
|
2592
|
+
*/
|
|
2593
|
+
export const getDataSources = <ThrowOnError extends boolean = false>(options: Options<GetDataSourcesData, ThrowOnError>) => {
|
|
2594
|
+
return (options.client ?? _heyApiClient).get<GetDataSourcesResponse, GetDataSourcesError, ThrowOnError>({
|
|
2595
|
+
security: [
|
|
2596
|
+
{
|
|
2597
|
+
name: 'Authorization',
|
|
2598
|
+
type: 'apiKey'
|
|
2599
|
+
}
|
|
2600
|
+
],
|
|
2601
|
+
querySerializer: {
|
|
2602
|
+
array: {
|
|
2603
|
+
explode: false,
|
|
2604
|
+
style: 'form'
|
|
2605
|
+
}
|
|
2606
|
+
},
|
|
2607
|
+
url: '/api/data-sources',
|
|
2608
|
+
...options
|
|
2609
|
+
});
|
|
2610
|
+
};
|
|
2611
|
+
|
|
2612
|
+
/**
|
|
2613
|
+
* Create Data Source
|
|
2614
|
+
* Create a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
2615
|
+
*
|
|
2616
|
+
* **Scopes:**
|
|
2617
|
+
* `custom-objects:write`
|
|
2618
|
+
*/
|
|
2619
|
+
export const createDataSource = <ThrowOnError extends boolean = false>(options: Options<CreateDataSourceData, ThrowOnError>) => {
|
|
2620
|
+
return (options.client ?? _heyApiClient).post<CreateDataSourceResponse, CreateDataSourceError, ThrowOnError>({
|
|
2621
|
+
security: [
|
|
2622
|
+
{
|
|
2623
|
+
name: 'Authorization',
|
|
2624
|
+
type: 'apiKey'
|
|
2625
|
+
}
|
|
2626
|
+
],
|
|
2627
|
+
url: '/api/data-sources',
|
|
2628
|
+
...options,
|
|
2629
|
+
headers: {
|
|
2630
|
+
'Content-Type': 'application/vnd.api+json',
|
|
2631
|
+
...options?.headers
|
|
2632
|
+
}
|
|
2633
|
+
});
|
|
2634
|
+
};
|
|
2635
|
+
|
|
2636
|
+
/**
|
|
2637
|
+
* Delete Data Source
|
|
2638
|
+
* Delete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
2639
|
+
*
|
|
2640
|
+
* **Scopes:**
|
|
2641
|
+
* `custom-objects:write`
|
|
2642
|
+
*/
|
|
2643
|
+
export const deleteDataSource = <ThrowOnError extends boolean = false>(options: Options<DeleteDataSourceData, ThrowOnError>) => {
|
|
2644
|
+
return (options.client ?? _heyApiClient).delete<DeleteDataSourceResponse, DeleteDataSourceError, ThrowOnError>({
|
|
2645
|
+
security: [
|
|
2646
|
+
{
|
|
2647
|
+
name: 'Authorization',
|
|
2648
|
+
type: 'apiKey'
|
|
2649
|
+
}
|
|
2650
|
+
],
|
|
2651
|
+
url: '/api/data-sources/{id}',
|
|
2652
|
+
...options
|
|
2653
|
+
});
|
|
2654
|
+
};
|
|
2655
|
+
|
|
2656
|
+
/**
|
|
2657
|
+
* Get Data Source
|
|
2658
|
+
* Retrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
2659
|
+
*
|
|
2660
|
+
* **Scopes:**
|
|
2661
|
+
* `custom-objects:read`
|
|
2662
|
+
*/
|
|
2663
|
+
export const getDataSource = <ThrowOnError extends boolean = false>(options: Options<GetDataSourceData, ThrowOnError>) => {
|
|
2664
|
+
return (options.client ?? _heyApiClient).get<GetDataSourceResponse2, GetDataSourceError, ThrowOnError>({
|
|
2665
|
+
security: [
|
|
2666
|
+
{
|
|
2667
|
+
name: 'Authorization',
|
|
2668
|
+
type: 'apiKey'
|
|
2669
|
+
}
|
|
2670
|
+
],
|
|
2671
|
+
querySerializer: {
|
|
2672
|
+
array: {
|
|
2673
|
+
explode: false,
|
|
2674
|
+
style: 'form'
|
|
2675
|
+
}
|
|
2676
|
+
},
|
|
2677
|
+
url: '/api/data-sources/{id}',
|
|
2678
|
+
...options
|
|
2679
|
+
});
|
|
2680
|
+
};
|
|
2681
|
+
|
|
2682
|
+
/**
|
|
2683
|
+
* Bulk Create Data Source Records
|
|
2684
|
+
* Create a bulk data source record import job to create a batch of records.
|
|
2685
|
+
*
|
|
2686
|
+
* Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB.
|
|
2687
|
+
*
|
|
2688
|
+
* To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m`
|
|
2689
|
+
*
|
|
2690
|
+
* **Scopes:**
|
|
2691
|
+
* `custom-objects:write`
|
|
2692
|
+
*/
|
|
2693
|
+
export const bulkCreateDataSourceRecords = <ThrowOnError extends boolean = false>(options: Options<BulkCreateDataSourceRecordsData, ThrowOnError>) => {
|
|
2694
|
+
return (options.client ?? _heyApiClient).post<BulkCreateDataSourceRecordsResponse, BulkCreateDataSourceRecordsError, ThrowOnError>({
|
|
2695
|
+
security: [
|
|
2696
|
+
{
|
|
2697
|
+
name: 'Authorization',
|
|
2698
|
+
type: 'apiKey'
|
|
2699
|
+
}
|
|
2700
|
+
],
|
|
2701
|
+
url: '/api/data-source-record-bulk-create-jobs',
|
|
2702
|
+
...options,
|
|
2703
|
+
headers: {
|
|
2704
|
+
'Content-Type': 'application/vnd.api+json',
|
|
2705
|
+
...options?.headers
|
|
2706
|
+
}
|
|
2707
|
+
});
|
|
2708
|
+
};
|
|
2709
|
+
|
|
2586
2710
|
/**
|
|
2587
2711
|
* Request Profile Deletion
|
|
2588
2712
|
* Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error.
|
|
@@ -2970,7 +3094,7 @@ export const updateFlow = <ThrowOnError extends boolean = false>(options: Option
|
|
|
2970
3094
|
* `flows:read`
|
|
2971
3095
|
*/
|
|
2972
3096
|
export const getFlowAction = <ThrowOnError extends boolean = false>(options: Options<GetFlowActionData, ThrowOnError>) => {
|
|
2973
|
-
return (options.client ?? _heyApiClient).get<
|
|
3097
|
+
return (options.client ?? _heyApiClient).get<GetFlowActionResponse, GetFlowActionError, ThrowOnError>({
|
|
2974
3098
|
security: [
|
|
2975
3099
|
{
|
|
2976
3100
|
name: 'Authorization',
|
|
@@ -2988,9 +3112,33 @@ export const getFlowAction = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2988
3112
|
});
|
|
2989
3113
|
};
|
|
2990
3114
|
|
|
3115
|
+
/**
|
|
3116
|
+
* Update Flow Action
|
|
3117
|
+
* Update a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
3118
|
+
*
|
|
3119
|
+
* **Scopes:**
|
|
3120
|
+
* `flows:write`
|
|
3121
|
+
*/
|
|
3122
|
+
export const updateFlowAction = <ThrowOnError extends boolean = false>(options: Options<UpdateFlowActionData, ThrowOnError>) => {
|
|
3123
|
+
return (options.client ?? _heyApiClient).patch<UpdateFlowActionResponse, UpdateFlowActionError, ThrowOnError>({
|
|
3124
|
+
security: [
|
|
3125
|
+
{
|
|
3126
|
+
name: 'Authorization',
|
|
3127
|
+
type: 'apiKey'
|
|
3128
|
+
}
|
|
3129
|
+
],
|
|
3130
|
+
url: '/api/flow-actions/{id}',
|
|
3131
|
+
...options,
|
|
3132
|
+
headers: {
|
|
3133
|
+
'Content-Type': 'application/vnd.api+json',
|
|
3134
|
+
...options?.headers
|
|
3135
|
+
}
|
|
3136
|
+
});
|
|
3137
|
+
};
|
|
3138
|
+
|
|
2991
3139
|
/**
|
|
2992
3140
|
* Get Flow Message
|
|
2993
|
-
* Get
|
|
3141
|
+
* Get a flow message from a flow with the given flow message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
2994
3142
|
*
|
|
2995
3143
|
* **Scopes:**
|
|
2996
3144
|
* `flows:read`
|
|
@@ -3326,6 +3474,30 @@ export const getForms = <ThrowOnError extends boolean = false>(options: Options<
|
|
|
3326
3474
|
});
|
|
3327
3475
|
};
|
|
3328
3476
|
|
|
3477
|
+
/**
|
|
3478
|
+
* Create Form
|
|
3479
|
+
* Create a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
3480
|
+
*
|
|
3481
|
+
* **Scopes:**
|
|
3482
|
+
* `forms:write`
|
|
3483
|
+
*/
|
|
3484
|
+
export const createForm = <ThrowOnError extends boolean = false>(options: Options<CreateFormData, ThrowOnError>) => {
|
|
3485
|
+
return (options.client ?? _heyApiClient).post<CreateFormResponse, CreateFormError, ThrowOnError>({
|
|
3486
|
+
security: [
|
|
3487
|
+
{
|
|
3488
|
+
name: 'Authorization',
|
|
3489
|
+
type: 'apiKey'
|
|
3490
|
+
}
|
|
3491
|
+
],
|
|
3492
|
+
url: '/api/forms',
|
|
3493
|
+
...options,
|
|
3494
|
+
headers: {
|
|
3495
|
+
'Content-Type': 'application/vnd.api+json',
|
|
3496
|
+
...options?.headers
|
|
3497
|
+
}
|
|
3498
|
+
});
|
|
3499
|
+
};
|
|
3500
|
+
|
|
3329
3501
|
/**
|
|
3330
3502
|
* Delete Form
|
|
3331
3503
|
* Delete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
@@ -3695,7 +3867,7 @@ export const deleteList = <ThrowOnError extends boolean = false>(options: Option
|
|
|
3695
3867
|
|
|
3696
3868
|
/**
|
|
3697
3869
|
* Get List
|
|
3698
|
-
* Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>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/v2025-
|
|
3870
|
+
* Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>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/v2025-10-15/docs/rate_limits_and_error_handling) guide.
|
|
3699
3871
|
*
|
|
3700
3872
|
* **Scopes:**
|
|
3701
3873
|
* `lists:read`
|
|
@@ -3795,7 +3967,7 @@ export const getTagIdsForList = <ThrowOnError extends boolean = false>(options:
|
|
|
3795
3967
|
* Get Profiles for List
|
|
3796
3968
|
* Get all profiles within a list with the given list ID.
|
|
3797
3969
|
*
|
|
3798
|
-
* 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`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>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/v2025-
|
|
3970
|
+
* 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`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>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/v2025-10-15/docs/rate_limits_and_error_handling) guide.
|
|
3799
3971
|
*
|
|
3800
3972
|
* **Scopes:**
|
|
3801
3973
|
* `lists:read`
|
|
@@ -3854,7 +4026,7 @@ export const removeProfilesFromList = <ThrowOnError extends boolean = false>(opt
|
|
|
3854
4026
|
|
|
3855
4027
|
/**
|
|
3856
4028
|
* Get Profile IDs for List
|
|
3857
|
-
* Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>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/v2025-
|
|
4029
|
+
* Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>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/v2025-10-15/docs/rate_limits_and_error_handling) guide.
|
|
3858
4030
|
*
|
|
3859
4031
|
* **Scopes:**
|
|
3860
4032
|
* `lists:read`
|
|
@@ -4113,7 +4285,7 @@ export const deleteCustomMetric = <ThrowOnError extends boolean = false>(options
|
|
|
4113
4285
|
* `metrics:read`
|
|
4114
4286
|
*/
|
|
4115
4287
|
export const getCustomMetric = <ThrowOnError extends boolean = false>(options: Options<GetCustomMetricData, ThrowOnError>) => {
|
|
4116
|
-
return (options.client ?? _heyApiClient).get<
|
|
4288
|
+
return (options.client ?? _heyApiClient).get<GetCustomMetricResponse2, GetCustomMetricError, ThrowOnError>({
|
|
4117
4289
|
security: [
|
|
4118
4290
|
{
|
|
4119
4291
|
name: 'Authorization',
|
|
@@ -4155,6 +4327,82 @@ export const updateCustomMetric = <ThrowOnError extends boolean = false>(options
|
|
|
4155
4327
|
});
|
|
4156
4328
|
};
|
|
4157
4329
|
|
|
4330
|
+
/**
|
|
4331
|
+
* Get Mapped Metrics
|
|
4332
|
+
* Get all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4333
|
+
*
|
|
4334
|
+
* **Scopes:**
|
|
4335
|
+
* `metrics:read`
|
|
4336
|
+
*/
|
|
4337
|
+
export const getMappedMetrics = <ThrowOnError extends boolean = false>(options: Options<GetMappedMetricsData, ThrowOnError>) => {
|
|
4338
|
+
return (options.client ?? _heyApiClient).get<GetMappedMetricsResponse, GetMappedMetricsError, ThrowOnError>({
|
|
4339
|
+
security: [
|
|
4340
|
+
{
|
|
4341
|
+
name: 'Authorization',
|
|
4342
|
+
type: 'apiKey'
|
|
4343
|
+
}
|
|
4344
|
+
],
|
|
4345
|
+
querySerializer: {
|
|
4346
|
+
array: {
|
|
4347
|
+
explode: false,
|
|
4348
|
+
style: 'form'
|
|
4349
|
+
}
|
|
4350
|
+
},
|
|
4351
|
+
url: '/api/mapped-metrics',
|
|
4352
|
+
...options
|
|
4353
|
+
});
|
|
4354
|
+
};
|
|
4355
|
+
|
|
4356
|
+
/**
|
|
4357
|
+
* Get Mapped Metric
|
|
4358
|
+
* Get the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4359
|
+
*
|
|
4360
|
+
* **Scopes:**
|
|
4361
|
+
* `metrics:read`
|
|
4362
|
+
*/
|
|
4363
|
+
export const getMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetMappedMetricData, ThrowOnError>) => {
|
|
4364
|
+
return (options.client ?? _heyApiClient).get<GetMappedMetricResponse, GetMappedMetricError, ThrowOnError>({
|
|
4365
|
+
security: [
|
|
4366
|
+
{
|
|
4367
|
+
name: 'Authorization',
|
|
4368
|
+
type: 'apiKey'
|
|
4369
|
+
}
|
|
4370
|
+
],
|
|
4371
|
+
querySerializer: {
|
|
4372
|
+
array: {
|
|
4373
|
+
explode: false,
|
|
4374
|
+
style: 'form'
|
|
4375
|
+
}
|
|
4376
|
+
},
|
|
4377
|
+
url: '/api/mapped-metrics/{id}',
|
|
4378
|
+
...options
|
|
4379
|
+
});
|
|
4380
|
+
};
|
|
4381
|
+
|
|
4382
|
+
/**
|
|
4383
|
+
* Update Mapped Metric
|
|
4384
|
+
* Update the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `30/d`
|
|
4385
|
+
*
|
|
4386
|
+
* **Scopes:**
|
|
4387
|
+
* `metrics:write`
|
|
4388
|
+
*/
|
|
4389
|
+
export const updateMappedMetric = <ThrowOnError extends boolean = false>(options: Options<UpdateMappedMetricData, ThrowOnError>) => {
|
|
4390
|
+
return (options.client ?? _heyApiClient).patch<UpdateMappedMetricResponse, UpdateMappedMetricError, ThrowOnError>({
|
|
4391
|
+
security: [
|
|
4392
|
+
{
|
|
4393
|
+
name: 'Authorization',
|
|
4394
|
+
type: 'apiKey'
|
|
4395
|
+
}
|
|
4396
|
+
],
|
|
4397
|
+
url: '/api/mapped-metrics/{id}',
|
|
4398
|
+
...options,
|
|
4399
|
+
headers: {
|
|
4400
|
+
'Content-Type': 'application/vnd.api+json',
|
|
4401
|
+
...options?.headers
|
|
4402
|
+
}
|
|
4403
|
+
});
|
|
4404
|
+
};
|
|
4405
|
+
|
|
4158
4406
|
/**
|
|
4159
4407
|
* Query Metric Aggregates
|
|
4160
4408
|
* Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request.
|
|
@@ -4373,13 +4621,105 @@ export const getMetricIdsForCustomMetric = <ThrowOnError extends boolean = false
|
|
|
4373
4621
|
});
|
|
4374
4622
|
};
|
|
4375
4623
|
|
|
4624
|
+
/**
|
|
4625
|
+
* Get Metric for Mapped Metric
|
|
4626
|
+
* Get the metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4627
|
+
*
|
|
4628
|
+
* **Scopes:**
|
|
4629
|
+
* `metrics:read`
|
|
4630
|
+
*/
|
|
4631
|
+
export const getMetricForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetMetricForMappedMetricData, ThrowOnError>) => {
|
|
4632
|
+
return (options.client ?? _heyApiClient).get<GetMetricForMappedMetricResponse, GetMetricForMappedMetricError, ThrowOnError>({
|
|
4633
|
+
security: [
|
|
4634
|
+
{
|
|
4635
|
+
name: 'Authorization',
|
|
4636
|
+
type: 'apiKey'
|
|
4637
|
+
}
|
|
4638
|
+
],
|
|
4639
|
+
querySerializer: {
|
|
4640
|
+
array: {
|
|
4641
|
+
explode: false,
|
|
4642
|
+
style: 'form'
|
|
4643
|
+
}
|
|
4644
|
+
},
|
|
4645
|
+
url: '/api/mapped-metrics/{id}/metric',
|
|
4646
|
+
...options
|
|
4647
|
+
});
|
|
4648
|
+
};
|
|
4649
|
+
|
|
4650
|
+
/**
|
|
4651
|
+
* Get Metric ID for Mapped Metric
|
|
4652
|
+
* Get the ID of the metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4653
|
+
*
|
|
4654
|
+
* **Scopes:**
|
|
4655
|
+
* `metrics:read`
|
|
4656
|
+
*/
|
|
4657
|
+
export const getMetricIdForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetMetricIdForMappedMetricData, ThrowOnError>) => {
|
|
4658
|
+
return (options.client ?? _heyApiClient).get<GetMetricIdForMappedMetricResponse, GetMetricIdForMappedMetricError, ThrowOnError>({
|
|
4659
|
+
security: [
|
|
4660
|
+
{
|
|
4661
|
+
name: 'Authorization',
|
|
4662
|
+
type: 'apiKey'
|
|
4663
|
+
}
|
|
4664
|
+
],
|
|
4665
|
+
url: '/api/mapped-metrics/{id}/relationships/metric',
|
|
4666
|
+
...options
|
|
4667
|
+
});
|
|
4668
|
+
};
|
|
4669
|
+
|
|
4670
|
+
/**
|
|
4671
|
+
* Get Custom Metric for Mapped Metric
|
|
4672
|
+
* Get the custom metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4673
|
+
*
|
|
4674
|
+
* **Scopes:**
|
|
4675
|
+
* `metrics:read`
|
|
4676
|
+
*/
|
|
4677
|
+
export const getCustomMetricForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetCustomMetricForMappedMetricData, ThrowOnError>) => {
|
|
4678
|
+
return (options.client ?? _heyApiClient).get<GetCustomMetricForMappedMetricResponse, GetCustomMetricForMappedMetricError, ThrowOnError>({
|
|
4679
|
+
security: [
|
|
4680
|
+
{
|
|
4681
|
+
name: 'Authorization',
|
|
4682
|
+
type: 'apiKey'
|
|
4683
|
+
}
|
|
4684
|
+
],
|
|
4685
|
+
querySerializer: {
|
|
4686
|
+
array: {
|
|
4687
|
+
explode: false,
|
|
4688
|
+
style: 'form'
|
|
4689
|
+
}
|
|
4690
|
+
},
|
|
4691
|
+
url: '/api/mapped-metrics/{id}/custom-metric',
|
|
4692
|
+
...options
|
|
4693
|
+
});
|
|
4694
|
+
};
|
|
4695
|
+
|
|
4696
|
+
/**
|
|
4697
|
+
* Get Custom Metric ID for Mapped Metric
|
|
4698
|
+
* Get the ID of the custom metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4699
|
+
*
|
|
4700
|
+
* **Scopes:**
|
|
4701
|
+
* `metrics:read`
|
|
4702
|
+
*/
|
|
4703
|
+
export const getCustomMetricIdForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetCustomMetricIdForMappedMetricData, ThrowOnError>) => {
|
|
4704
|
+
return (options.client ?? _heyApiClient).get<GetCustomMetricIdForMappedMetricResponse, GetCustomMetricIdForMappedMetricError, ThrowOnError>({
|
|
4705
|
+
security: [
|
|
4706
|
+
{
|
|
4707
|
+
name: 'Authorization',
|
|
4708
|
+
type: 'apiKey'
|
|
4709
|
+
}
|
|
4710
|
+
],
|
|
4711
|
+
url: '/api/mapped-metrics/{id}/relationships/custom-metric',
|
|
4712
|
+
...options
|
|
4713
|
+
});
|
|
4714
|
+
};
|
|
4715
|
+
|
|
4376
4716
|
/**
|
|
4377
4717
|
* Get Profiles
|
|
4378
4718
|
* Get all profiles in an account.
|
|
4379
4719
|
*
|
|
4380
4720
|
* 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`
|
|
4381
4721
|
*
|
|
4382
|
-
* Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>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/v2025-
|
|
4722
|
+
* Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>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/v2025-10-15/docs/rate_limits_and_error_handling) guide.
|
|
4383
4723
|
*
|
|
4384
4724
|
* **Scopes:**
|
|
4385
4725
|
* `profiles:read`
|
|
@@ -4441,7 +4781,7 @@ export const createProfile = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
4441
4781
|
* Get Profile
|
|
4442
4782
|
* Get the profile with the given profile ID.
|
|
4443
4783
|
*
|
|
4444
|
-
* Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
|
4784
|
+
* Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-10-15/docs/rate_limits_and_error_handling) guide.
|
|
4445
4785
|
*
|
|
4446
4786
|
* **Scopes:**
|
|
4447
4787
|
* `profiles:read`
|
|
@@ -4956,11 +5296,15 @@ export const bulkSubscribeProfiles = <ThrowOnError extends boolean = false>(opti
|
|
|
4956
5296
|
|
|
4957
5297
|
/**
|
|
4958
5298
|
* Bulk Unsubscribe Profiles
|
|
5299
|
+
* > 🚧
|
|
5300
|
+
* >
|
|
5301
|
+
* > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.
|
|
5302
|
+
*
|
|
4959
5303
|
* Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).
|
|
4960
5304
|
*
|
|
4961
|
-
* To remove someone from a list without changing their subscription status, use [Remove
|
|
5305
|
+
* To remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list).
|
|
4962
5306
|
*
|
|
4963
|
-
* Maximum number of
|
|
5307
|
+
* Maximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`
|
|
4964
5308
|
*
|
|
4965
5309
|
* **Scopes:**
|
|
4966
5310
|
* `lists:write`
|
|
@@ -5612,7 +5956,7 @@ export const deleteSegment = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
5612
5956
|
|
|
5613
5957
|
/**
|
|
5614
5958
|
* Get Segment
|
|
5615
|
-
* Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>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/v2025-
|
|
5959
|
+
* Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>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/v2025-10-15/docs/rate_limits_and_error_handling) guide.
|
|
5616
5960
|
*
|
|
5617
5961
|
* **Scopes:**
|
|
5618
5962
|
* `segments:read`
|
|
@@ -6793,7 +7137,9 @@ export const cloneTemplate = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
6793
7137
|
|
|
6794
7138
|
/**
|
|
6795
7139
|
* Get Tracking Settings
|
|
6796
|
-
* Get all tracking settings in an account. Returns an array with a single tracking setting
|
|
7140
|
+
* Get all UTM tracking settings in an account. Returns an array with a single tracking setting.
|
|
7141
|
+
*
|
|
7142
|
+
* More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
|
|
6797
7143
|
*
|
|
6798
7144
|
* **Scopes:**
|
|
6799
7145
|
* `tracking-settings:read`
|
|
@@ -6819,7 +7165,9 @@ export const getTrackingSettings = <ThrowOnError extends boolean = false>(option
|
|
|
6819
7165
|
|
|
6820
7166
|
/**
|
|
6821
7167
|
* Get Tracking Setting
|
|
6822
|
-
* Get the tracking setting with the given account ID
|
|
7168
|
+
* Get the UTM tracking setting with the given account ID.
|
|
7169
|
+
*
|
|
7170
|
+
* More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
|
|
6823
7171
|
*
|
|
6824
7172
|
* **Scopes:**
|
|
6825
7173
|
* `tracking-settings:read`
|
|
@@ -6845,7 +7193,9 @@ export const getTrackingSetting = <ThrowOnError extends boolean = false>(options
|
|
|
6845
7193
|
|
|
6846
7194
|
/**
|
|
6847
7195
|
* Update Tracking Setting
|
|
6848
|
-
* Update the tracking setting with the given account ID
|
|
7196
|
+
* Update the UTM tracking setting with the given account ID.
|
|
7197
|
+
*
|
|
7198
|
+
* More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
|
|
6849
7199
|
*
|
|
6850
7200
|
* **Scopes:**
|
|
6851
7201
|
* `tracking-settings:write`
|
|
@@ -7230,7 +7580,7 @@ export const createClientSubscription = <ThrowOnError extends boolean = false>(o
|
|
|
7230
7580
|
* This endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.
|
|
7231
7581
|
* You must have push notifications enabled to use this endpoint.
|
|
7232
7582
|
*
|
|
7233
|
-
* To migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead.<br><br>*Rate limits*:<br>Burst: `
|
|
7583
|
+
* To migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead.<br><br>*Rate limits*:<br>Burst: `150/s`<br>Steady: `1400/m`
|
|
7234
7584
|
*/
|
|
7235
7585
|
export const createClientPushToken = <ThrowOnError extends boolean = false>(options: Options<CreateClientPushTokenData, ThrowOnError>) => {
|
|
7236
7586
|
return (options.client ?? _heyApiClient).post<unknown, CreateClientPushTokenError, ThrowOnError>({
|