klaviyo-api-fetch 1.0.0 → 1.0.1
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 +2794 -1417
- package/dist/index.d.ts +2794 -1417
- 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 +313 -15
- package/src/types.gen.ts +2823 -1446
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, 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, 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,126 @@ 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 data source record job.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m`
|
|
2685
|
+
*
|
|
2686
|
+
* **Scopes:**
|
|
2687
|
+
* `custom-objects:write`
|
|
2688
|
+
*/
|
|
2689
|
+
export const bulkCreateDataSourceRecords = <ThrowOnError extends boolean = false>(options: Options<BulkCreateDataSourceRecordsData, ThrowOnError>) => {
|
|
2690
|
+
return (options.client ?? _heyApiClient).post<BulkCreateDataSourceRecordsResponse, BulkCreateDataSourceRecordsError, ThrowOnError>({
|
|
2691
|
+
security: [
|
|
2692
|
+
{
|
|
2693
|
+
name: 'Authorization',
|
|
2694
|
+
type: 'apiKey'
|
|
2695
|
+
}
|
|
2696
|
+
],
|
|
2697
|
+
url: '/api/data-source-record-bulk-create-jobs',
|
|
2698
|
+
...options,
|
|
2699
|
+
headers: {
|
|
2700
|
+
'Content-Type': 'application/vnd.api+json',
|
|
2701
|
+
...options?.headers
|
|
2702
|
+
}
|
|
2703
|
+
});
|
|
2704
|
+
};
|
|
2705
|
+
|
|
2586
2706
|
/**
|
|
2587
2707
|
* Request Profile Deletion
|
|
2588
2708
|
* 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.
|
|
@@ -3695,7 +3815,7 @@ export const deleteList = <ThrowOnError extends boolean = false>(options: Option
|
|
|
3695
3815
|
|
|
3696
3816
|
/**
|
|
3697
3817
|
* 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-
|
|
3818
|
+
* 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-07-15/docs/rate_limits_and_error_handling) guide.
|
|
3699
3819
|
*
|
|
3700
3820
|
* **Scopes:**
|
|
3701
3821
|
* `lists:read`
|
|
@@ -3795,7 +3915,7 @@ export const getTagIdsForList = <ThrowOnError extends boolean = false>(options:
|
|
|
3795
3915
|
* Get Profiles for List
|
|
3796
3916
|
* Get all profiles within a list with the given list ID.
|
|
3797
3917
|
*
|
|
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-
|
|
3918
|
+
* 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-07-15/docs/rate_limits_and_error_handling) guide.
|
|
3799
3919
|
*
|
|
3800
3920
|
* **Scopes:**
|
|
3801
3921
|
* `lists:read`
|
|
@@ -3854,7 +3974,7 @@ export const removeProfilesFromList = <ThrowOnError extends boolean = false>(opt
|
|
|
3854
3974
|
|
|
3855
3975
|
/**
|
|
3856
3976
|
* 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-
|
|
3977
|
+
* 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-07-15/docs/rate_limits_and_error_handling) guide.
|
|
3858
3978
|
*
|
|
3859
3979
|
* **Scopes:**
|
|
3860
3980
|
* `lists:read`
|
|
@@ -4113,7 +4233,7 @@ export const deleteCustomMetric = <ThrowOnError extends boolean = false>(options
|
|
|
4113
4233
|
* `metrics:read`
|
|
4114
4234
|
*/
|
|
4115
4235
|
export const getCustomMetric = <ThrowOnError extends boolean = false>(options: Options<GetCustomMetricData, ThrowOnError>) => {
|
|
4116
|
-
return (options.client ?? _heyApiClient).get<
|
|
4236
|
+
return (options.client ?? _heyApiClient).get<GetCustomMetricResponse2, GetCustomMetricError, ThrowOnError>({
|
|
4117
4237
|
security: [
|
|
4118
4238
|
{
|
|
4119
4239
|
name: 'Authorization',
|
|
@@ -4155,6 +4275,82 @@ export const updateCustomMetric = <ThrowOnError extends boolean = false>(options
|
|
|
4155
4275
|
});
|
|
4156
4276
|
};
|
|
4157
4277
|
|
|
4278
|
+
/**
|
|
4279
|
+
* Get Mapped Metrics
|
|
4280
|
+
* Get all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4281
|
+
*
|
|
4282
|
+
* **Scopes:**
|
|
4283
|
+
* `metrics:read`
|
|
4284
|
+
*/
|
|
4285
|
+
export const getMappedMetrics = <ThrowOnError extends boolean = false>(options: Options<GetMappedMetricsData, ThrowOnError>) => {
|
|
4286
|
+
return (options.client ?? _heyApiClient).get<GetMappedMetricsResponse, GetMappedMetricsError, ThrowOnError>({
|
|
4287
|
+
security: [
|
|
4288
|
+
{
|
|
4289
|
+
name: 'Authorization',
|
|
4290
|
+
type: 'apiKey'
|
|
4291
|
+
}
|
|
4292
|
+
],
|
|
4293
|
+
querySerializer: {
|
|
4294
|
+
array: {
|
|
4295
|
+
explode: false,
|
|
4296
|
+
style: 'form'
|
|
4297
|
+
}
|
|
4298
|
+
},
|
|
4299
|
+
url: '/api/mapped-metrics',
|
|
4300
|
+
...options
|
|
4301
|
+
});
|
|
4302
|
+
};
|
|
4303
|
+
|
|
4304
|
+
/**
|
|
4305
|
+
* Get Mapped Metric
|
|
4306
|
+
* Get the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4307
|
+
*
|
|
4308
|
+
* **Scopes:**
|
|
4309
|
+
* `metrics:read`
|
|
4310
|
+
*/
|
|
4311
|
+
export const getMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetMappedMetricData, ThrowOnError>) => {
|
|
4312
|
+
return (options.client ?? _heyApiClient).get<GetMappedMetricResponse, GetMappedMetricError, ThrowOnError>({
|
|
4313
|
+
security: [
|
|
4314
|
+
{
|
|
4315
|
+
name: 'Authorization',
|
|
4316
|
+
type: 'apiKey'
|
|
4317
|
+
}
|
|
4318
|
+
],
|
|
4319
|
+
querySerializer: {
|
|
4320
|
+
array: {
|
|
4321
|
+
explode: false,
|
|
4322
|
+
style: 'form'
|
|
4323
|
+
}
|
|
4324
|
+
},
|
|
4325
|
+
url: '/api/mapped-metrics/{id}',
|
|
4326
|
+
...options
|
|
4327
|
+
});
|
|
4328
|
+
};
|
|
4329
|
+
|
|
4330
|
+
/**
|
|
4331
|
+
* Update Mapped Metric
|
|
4332
|
+
* Update the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `30/d`
|
|
4333
|
+
*
|
|
4334
|
+
* **Scopes:**
|
|
4335
|
+
* `metrics:write`
|
|
4336
|
+
*/
|
|
4337
|
+
export const updateMappedMetric = <ThrowOnError extends boolean = false>(options: Options<UpdateMappedMetricData, ThrowOnError>) => {
|
|
4338
|
+
return (options.client ?? _heyApiClient).patch<UpdateMappedMetricResponse, UpdateMappedMetricError, ThrowOnError>({
|
|
4339
|
+
security: [
|
|
4340
|
+
{
|
|
4341
|
+
name: 'Authorization',
|
|
4342
|
+
type: 'apiKey'
|
|
4343
|
+
}
|
|
4344
|
+
],
|
|
4345
|
+
url: '/api/mapped-metrics/{id}',
|
|
4346
|
+
...options,
|
|
4347
|
+
headers: {
|
|
4348
|
+
'Content-Type': 'application/vnd.api+json',
|
|
4349
|
+
...options?.headers
|
|
4350
|
+
}
|
|
4351
|
+
});
|
|
4352
|
+
};
|
|
4353
|
+
|
|
4158
4354
|
/**
|
|
4159
4355
|
* Query Metric Aggregates
|
|
4160
4356
|
* 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 +4569,105 @@ export const getMetricIdsForCustomMetric = <ThrowOnError extends boolean = false
|
|
|
4373
4569
|
});
|
|
4374
4570
|
};
|
|
4375
4571
|
|
|
4572
|
+
/**
|
|
4573
|
+
* Get Metric for Mapped Metric
|
|
4574
|
+
* Get the metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4575
|
+
*
|
|
4576
|
+
* **Scopes:**
|
|
4577
|
+
* `metrics:read`
|
|
4578
|
+
*/
|
|
4579
|
+
export const getMetricForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetMetricForMappedMetricData, ThrowOnError>) => {
|
|
4580
|
+
return (options.client ?? _heyApiClient).get<GetMetricForMappedMetricResponse, GetMetricForMappedMetricError, ThrowOnError>({
|
|
4581
|
+
security: [
|
|
4582
|
+
{
|
|
4583
|
+
name: 'Authorization',
|
|
4584
|
+
type: 'apiKey'
|
|
4585
|
+
}
|
|
4586
|
+
],
|
|
4587
|
+
querySerializer: {
|
|
4588
|
+
array: {
|
|
4589
|
+
explode: false,
|
|
4590
|
+
style: 'form'
|
|
4591
|
+
}
|
|
4592
|
+
},
|
|
4593
|
+
url: '/api/mapped-metrics/{id}/metric',
|
|
4594
|
+
...options
|
|
4595
|
+
});
|
|
4596
|
+
};
|
|
4597
|
+
|
|
4598
|
+
/**
|
|
4599
|
+
* Get Metric ID for Mapped Metric
|
|
4600
|
+
* Get the ID of the metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4601
|
+
*
|
|
4602
|
+
* **Scopes:**
|
|
4603
|
+
* `metrics:read`
|
|
4604
|
+
*/
|
|
4605
|
+
export const getMetricIdForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetMetricIdForMappedMetricData, ThrowOnError>) => {
|
|
4606
|
+
return (options.client ?? _heyApiClient).get<GetMetricIdForMappedMetricResponse, GetMetricIdForMappedMetricError, ThrowOnError>({
|
|
4607
|
+
security: [
|
|
4608
|
+
{
|
|
4609
|
+
name: 'Authorization',
|
|
4610
|
+
type: 'apiKey'
|
|
4611
|
+
}
|
|
4612
|
+
],
|
|
4613
|
+
url: '/api/mapped-metrics/{id}/relationships/metric',
|
|
4614
|
+
...options
|
|
4615
|
+
});
|
|
4616
|
+
};
|
|
4617
|
+
|
|
4618
|
+
/**
|
|
4619
|
+
* Get Custom Metric for Mapped Metric
|
|
4620
|
+
* Get the custom metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4621
|
+
*
|
|
4622
|
+
* **Scopes:**
|
|
4623
|
+
* `metrics:read`
|
|
4624
|
+
*/
|
|
4625
|
+
export const getCustomMetricForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetCustomMetricForMappedMetricData, ThrowOnError>) => {
|
|
4626
|
+
return (options.client ?? _heyApiClient).get<GetCustomMetricForMappedMetricResponse, GetCustomMetricForMappedMetricError, ThrowOnError>({
|
|
4627
|
+
security: [
|
|
4628
|
+
{
|
|
4629
|
+
name: 'Authorization',
|
|
4630
|
+
type: 'apiKey'
|
|
4631
|
+
}
|
|
4632
|
+
],
|
|
4633
|
+
querySerializer: {
|
|
4634
|
+
array: {
|
|
4635
|
+
explode: false,
|
|
4636
|
+
style: 'form'
|
|
4637
|
+
}
|
|
4638
|
+
},
|
|
4639
|
+
url: '/api/mapped-metrics/{id}/custom-metric',
|
|
4640
|
+
...options
|
|
4641
|
+
});
|
|
4642
|
+
};
|
|
4643
|
+
|
|
4644
|
+
/**
|
|
4645
|
+
* Get Custom Metric ID for Mapped Metric
|
|
4646
|
+
* Get the ID of the custom metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
|
|
4647
|
+
*
|
|
4648
|
+
* **Scopes:**
|
|
4649
|
+
* `metrics:read`
|
|
4650
|
+
*/
|
|
4651
|
+
export const getCustomMetricIdForMappedMetric = <ThrowOnError extends boolean = false>(options: Options<GetCustomMetricIdForMappedMetricData, ThrowOnError>) => {
|
|
4652
|
+
return (options.client ?? _heyApiClient).get<GetCustomMetricIdForMappedMetricResponse, GetCustomMetricIdForMappedMetricError, ThrowOnError>({
|
|
4653
|
+
security: [
|
|
4654
|
+
{
|
|
4655
|
+
name: 'Authorization',
|
|
4656
|
+
type: 'apiKey'
|
|
4657
|
+
}
|
|
4658
|
+
],
|
|
4659
|
+
url: '/api/mapped-metrics/{id}/relationships/custom-metric',
|
|
4660
|
+
...options
|
|
4661
|
+
});
|
|
4662
|
+
};
|
|
4663
|
+
|
|
4376
4664
|
/**
|
|
4377
4665
|
* Get Profiles
|
|
4378
4666
|
* Get all profiles in an account.
|
|
4379
4667
|
*
|
|
4380
4668
|
* 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
4669
|
*
|
|
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-
|
|
4670
|
+
* 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-07-15/docs/rate_limits_and_error_handling) guide.
|
|
4383
4671
|
*
|
|
4384
4672
|
* **Scopes:**
|
|
4385
4673
|
* `profiles:read`
|
|
@@ -4441,7 +4729,7 @@ export const createProfile = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
4441
4729
|
* Get Profile
|
|
4442
4730
|
* Get the profile with the given profile ID.
|
|
4443
4731
|
*
|
|
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-
|
|
4732
|
+
* 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-07-15/docs/rate_limits_and_error_handling) guide.
|
|
4445
4733
|
*
|
|
4446
4734
|
* **Scopes:**
|
|
4447
4735
|
* `profiles:read`
|
|
@@ -4956,11 +5244,15 @@ export const bulkSubscribeProfiles = <ThrowOnError extends boolean = false>(opti
|
|
|
4956
5244
|
|
|
4957
5245
|
/**
|
|
4958
5246
|
* Bulk Unsubscribe Profiles
|
|
5247
|
+
* > 🚧
|
|
5248
|
+
* >
|
|
5249
|
+
* > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.
|
|
5250
|
+
*
|
|
4959
5251
|
* 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
5252
|
*
|
|
4961
|
-
* To remove someone from a list without changing their subscription status, use [Remove
|
|
5253
|
+
* 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
5254
|
*
|
|
4963
|
-
* Maximum number of
|
|
5255
|
+
* Maximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`
|
|
4964
5256
|
*
|
|
4965
5257
|
* **Scopes:**
|
|
4966
5258
|
* `lists:write`
|
|
@@ -5612,7 +5904,7 @@ export const deleteSegment = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
5612
5904
|
|
|
5613
5905
|
/**
|
|
5614
5906
|
* 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-
|
|
5907
|
+
* 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-07-15/docs/rate_limits_and_error_handling) guide.
|
|
5616
5908
|
*
|
|
5617
5909
|
* **Scopes:**
|
|
5618
5910
|
* `segments:read`
|
|
@@ -6793,7 +7085,9 @@ export const cloneTemplate = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
6793
7085
|
|
|
6794
7086
|
/**
|
|
6795
7087
|
* Get Tracking Settings
|
|
6796
|
-
* Get all tracking settings in an account. Returns an array with a single tracking setting
|
|
7088
|
+
* Get all UTM tracking settings in an account. Returns an array with a single tracking setting.
|
|
7089
|
+
*
|
|
7090
|
+
* 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
7091
|
*
|
|
6798
7092
|
* **Scopes:**
|
|
6799
7093
|
* `tracking-settings:read`
|
|
@@ -6819,7 +7113,9 @@ export const getTrackingSettings = <ThrowOnError extends boolean = false>(option
|
|
|
6819
7113
|
|
|
6820
7114
|
/**
|
|
6821
7115
|
* Get Tracking Setting
|
|
6822
|
-
* Get the tracking setting with the given account ID
|
|
7116
|
+
* Get the UTM tracking setting with the given account ID.
|
|
7117
|
+
*
|
|
7118
|
+
* 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
7119
|
*
|
|
6824
7120
|
* **Scopes:**
|
|
6825
7121
|
* `tracking-settings:read`
|
|
@@ -6845,7 +7141,9 @@ export const getTrackingSetting = <ThrowOnError extends boolean = false>(options
|
|
|
6845
7141
|
|
|
6846
7142
|
/**
|
|
6847
7143
|
* Update Tracking Setting
|
|
6848
|
-
* Update the tracking setting with the given account ID
|
|
7144
|
+
* Update the UTM tracking setting with the given account ID.
|
|
7145
|
+
*
|
|
7146
|
+
* 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
7147
|
*
|
|
6850
7148
|
* **Scopes:**
|
|
6851
7149
|
* `tracking-settings:write`
|
|
@@ -7230,7 +7528,7 @@ export const createClientSubscription = <ThrowOnError extends boolean = false>(o
|
|
|
7230
7528
|
* 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
7529
|
* You must have push notifications enabled to use this endpoint.
|
|
7232
7530
|
*
|
|
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: `
|
|
7531
|
+
* 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
7532
|
*/
|
|
7235
7533
|
export const createClientPushToken = <ThrowOnError extends boolean = false>(options: Options<CreateClientPushTokenData, ThrowOnError>) => {
|
|
7236
7534
|
return (options.client ?? _heyApiClient).post<unknown, CreateClientPushTokenError, ThrowOnError>({
|