klaviyo-api-fetch
Version:
A native fetch API using hey-api ts codegen
614 lines (577 loc) • 255 kB
text/typescript
// This file is auto-generated by @hey-api/openapi-ts
import { client } from './client.gen.js';
import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape } from './client/index.js';
import type { AddCategoriesToCatalogItemData, AddCategoriesToCatalogItemErrors, AddCategoriesToCatalogItemResponses, AddItemsToCatalogCategoryData, AddItemsToCatalogCategoryErrors, AddItemsToCatalogCategoryResponses, AddProfilesToListData, AddProfilesToListErrors, AddProfilesToListResponses, AssignTemplateToCampaignMessageData, AssignTemplateToCampaignMessageErrors, AssignTemplateToCampaignMessageResponses, BulkCreateCatalogCategoriesData, BulkCreateCatalogCategoriesErrors, BulkCreateCatalogCategoriesResponses, BulkCreateCatalogItemsData, BulkCreateCatalogItemsErrors, BulkCreateCatalogItemsResponses, BulkCreateCatalogVariantsData, BulkCreateCatalogVariantsErrors, BulkCreateCatalogVariantsResponses, BulkCreateClientEventsData, BulkCreateClientEventsErrors, BulkCreateClientEventsResponses, BulkCreateCouponCodesData, BulkCreateCouponCodesErrors, BulkCreateCouponCodesResponses, BulkCreateDataSourceRecordsData, BulkCreateDataSourceRecordsErrors, BulkCreateDataSourceRecordsResponses, BulkCreateEventsData, BulkCreateEventsErrors, BulkCreateEventsResponses, BulkDeleteCatalogCategoriesData, BulkDeleteCatalogCategoriesErrors, BulkDeleteCatalogCategoriesResponses, BulkDeleteCatalogItemsData, BulkDeleteCatalogItemsErrors, BulkDeleteCatalogItemsResponses, BulkDeleteCatalogVariantsData, BulkDeleteCatalogVariantsErrors, BulkDeleteCatalogVariantsResponses, BulkImportProfilesData, BulkImportProfilesErrors, BulkImportProfilesResponses, BulkSubscribeProfilesData, BulkSubscribeProfilesErrors, BulkSubscribeProfilesResponses, BulkSuppressProfilesData, BulkSuppressProfilesErrors, BulkSuppressProfilesResponses, BulkUnsubscribeProfilesData, BulkUnsubscribeProfilesErrors, BulkUnsubscribeProfilesResponses, BulkUnsuppressProfilesData, BulkUnsuppressProfilesErrors, BulkUnsuppressProfilesResponses, BulkUpdateCatalogCategoriesData, BulkUpdateCatalogCategoriesErrors, BulkUpdateCatalogCategoriesResponses, BulkUpdateCatalogItemsData, BulkUpdateCatalogItemsErrors, BulkUpdateCatalogItemsResponses, BulkUpdateCatalogVariantsData, BulkUpdateCatalogVariantsErrors, BulkUpdateCatalogVariantsResponses, CancelCampaignSendData, CancelCampaignSendErrors, CancelCampaignSendResponses, CloneTemplateData, CloneTemplateErrors, CloneTemplateResponses, CreateBackInStockSubscriptionData, CreateBackInStockSubscriptionErrors, CreateBackInStockSubscriptionResponses, CreateCampaignCloneData, CreateCampaignCloneErrors, CreateCampaignCloneResponses, CreateCampaignData, CreateCampaignErrors, CreateCampaignResponses, CreateCatalogCategoryData, CreateCatalogCategoryErrors, CreateCatalogCategoryResponses, CreateCatalogItemData, CreateCatalogItemErrors, CreateCatalogItemResponses, CreateCatalogVariantData, CreateCatalogVariantErrors, CreateCatalogVariantResponses, CreateClientBackInStockSubscriptionData, CreateClientBackInStockSubscriptionErrors, CreateClientBackInStockSubscriptionResponses, CreateClientEventData, CreateClientEventErrors, CreateClientEventResponses, CreateClientProfileData, CreateClientProfileErrors, CreateClientProfileResponses, CreateClientPushTokenData, CreateClientPushTokenErrors, CreateClientPushTokenResponses, CreateClientReviewData, CreateClientReviewErrors, CreateClientReviewResponses, CreateClientSubscriptionData, CreateClientSubscriptionErrors, CreateClientSubscriptionResponses, CreateCouponCodeData, CreateCouponCodeErrors, CreateCouponCodeResponses, CreateCouponData, CreateCouponErrors, CreateCouponResponses, CreateCustomMetricData, CreateCustomMetricErrors, CreateCustomMetricResponses, CreateDataSourceData, CreateDataSourceErrors, CreateDataSourceRecordData, CreateDataSourceRecordErrors, CreateDataSourceRecordResponses, CreateDataSourceResponses, CreateEventData, CreateEventErrors, CreateEventResponses, CreateFlowData, CreateFlowErrors, CreateFlowResponses, CreateFormData, CreateFormErrors, CreateFormResponses, CreateListData, CreateListErrors, CreateListResponses, CreateOrUpdateProfileData, CreateOrUpdateProfileErrors, CreateOrUpdateProfileResponses, CreateProfileData, CreateProfileErrors, CreateProfileResponses, CreatePushTokenData, CreatePushTokenErrors, CreatePushTokenResponses, CreateSegmentData, CreateSegmentErrors, CreateSegmentResponses, CreateTagData, CreateTagErrors, CreateTagGroupData, CreateTagGroupErrors, CreateTagGroupResponses, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateResponses, CreateUniversalContentData, CreateUniversalContentErrors, CreateUniversalContentResponses, CreateWebFeedData, CreateWebFeedErrors, CreateWebFeedResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, DeleteCampaignData, DeleteCampaignErrors, DeleteCampaignResponses, DeleteCatalogCategoryData, DeleteCatalogCategoryErrors, DeleteCatalogCategoryResponses, DeleteCatalogItemData, DeleteCatalogItemErrors, DeleteCatalogItemResponses, DeleteCatalogVariantData, DeleteCatalogVariantErrors, DeleteCatalogVariantResponses, DeleteCouponCodeData, DeleteCouponCodeErrors, DeleteCouponCodeResponses, DeleteCouponData, DeleteCouponErrors, DeleteCouponResponses, DeleteCustomMetricData, DeleteCustomMetricErrors, DeleteCustomMetricResponses, DeleteDataSourceData, DeleteDataSourceErrors, DeleteDataSourceResponses, DeleteFlowData, DeleteFlowErrors, DeleteFlowResponses, DeleteFormData, DeleteFormErrors, DeleteFormResponses, DeleteListData, DeleteListErrors, DeleteListResponses, DeletePushTokenData, DeletePushTokenErrors, DeletePushTokenResponses, DeleteSegmentData, DeleteSegmentErrors, DeleteSegmentResponses, DeleteTagData, DeleteTagErrors, DeleteTagGroupData, DeleteTagGroupErrors, DeleteTagGroupResponses, DeleteTagResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeleteUniversalContentData, DeleteUniversalContentErrors, DeleteUniversalContentResponses, DeleteWebFeedData, DeleteWebFeedErrors, DeleteWebFeedResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, GetAccountData, GetAccountErrors, GetAccountResponses, GetAccountsData, GetAccountsErrors, GetAccountsResponses, GetActionForFlowMessageData, GetActionForFlowMessageErrors, GetActionForFlowMessageResponses, GetActionIdForFlowMessageData, GetActionIdForFlowMessageErrors, GetActionIdForFlowMessageResponses, GetActionIdsForFlowData, GetActionIdsForFlowErrors, GetActionIdsForFlowResponses, GetActionsForFlowData, GetActionsForFlowErrors, GetActionsForFlowResponses, GetAllUniversalContentData, GetAllUniversalContentErrors, GetAllUniversalContentResponses, GetBulkCreateCatalogItemsJobData, GetBulkCreateCatalogItemsJobErrors, GetBulkCreateCatalogItemsJobResponses, GetBulkCreateCatalogItemsJobsData, GetBulkCreateCatalogItemsJobsErrors, GetBulkCreateCatalogItemsJobsResponses, GetBulkCreateCategoriesJobData, GetBulkCreateCategoriesJobErrors, GetBulkCreateCategoriesJobResponses, GetBulkCreateCategoriesJobsData, GetBulkCreateCategoriesJobsErrors, GetBulkCreateCategoriesJobsResponses, GetBulkCreateCouponCodeJobsData, GetBulkCreateCouponCodeJobsErrors, GetBulkCreateCouponCodeJobsResponses, GetBulkCreateCouponCodesJobData, GetBulkCreateCouponCodesJobErrors, GetBulkCreateCouponCodesJobResponses, GetBulkCreateVariantsJobData, GetBulkCreateVariantsJobErrors, GetBulkCreateVariantsJobResponses, GetBulkCreateVariantsJobsData, GetBulkCreateVariantsJobsErrors, GetBulkCreateVariantsJobsResponses, GetBulkDeleteCatalogItemsJobData, GetBulkDeleteCatalogItemsJobErrors, GetBulkDeleteCatalogItemsJobResponses, GetBulkDeleteCatalogItemsJobsData, GetBulkDeleteCatalogItemsJobsErrors, GetBulkDeleteCatalogItemsJobsResponses, GetBulkDeleteCategoriesJobData, GetBulkDeleteCategoriesJobErrors, GetBulkDeleteCategoriesJobResponses, GetBulkDeleteCategoriesJobsData, GetBulkDeleteCategoriesJobsErrors, GetBulkDeleteCategoriesJobsResponses, GetBulkDeleteVariantsJobData, GetBulkDeleteVariantsJobErrors, GetBulkDeleteVariantsJobResponses, GetBulkDeleteVariantsJobsData, GetBulkDeleteVariantsJobsErrors, GetBulkDeleteVariantsJobsResponses, GetBulkImportProfilesJobData, GetBulkImportProfilesJobErrors, GetBulkImportProfilesJobResponses, GetBulkImportProfilesJobsData, GetBulkImportProfilesJobsErrors, GetBulkImportProfilesJobsResponses, GetBulkSuppressProfilesJobData, GetBulkSuppressProfilesJobErrors, GetBulkSuppressProfilesJobResponses, GetBulkSuppressProfilesJobsData, GetBulkSuppressProfilesJobsErrors, GetBulkSuppressProfilesJobsResponses, GetBulkUnsuppressProfilesJobData, GetBulkUnsuppressProfilesJobErrors, GetBulkUnsuppressProfilesJobResponses, GetBulkUnsuppressProfilesJobsData, GetBulkUnsuppressProfilesJobsErrors, GetBulkUnsuppressProfilesJobsResponses, GetBulkUpdateCatalogItemsJobData, GetBulkUpdateCatalogItemsJobErrors, GetBulkUpdateCatalogItemsJobResponses, GetBulkUpdateCatalogItemsJobsData, GetBulkUpdateCatalogItemsJobsErrors, GetBulkUpdateCatalogItemsJobsResponses, GetBulkUpdateCategoriesJobData, GetBulkUpdateCategoriesJobErrors, GetBulkUpdateCategoriesJobResponses, GetBulkUpdateCategoriesJobsData, GetBulkUpdateCategoriesJobsErrors, GetBulkUpdateCategoriesJobsResponses, GetBulkUpdateVariantsJobData, GetBulkUpdateVariantsJobErrors, GetBulkUpdateVariantsJobResponses, GetBulkUpdateVariantsJobsData, GetBulkUpdateVariantsJobsErrors, GetBulkUpdateVariantsJobsResponses, GetCampaignData, GetCampaignErrors, GetCampaignForCampaignMessageData, GetCampaignForCampaignMessageErrors, GetCampaignForCampaignMessageResponses, GetCampaignIdForCampaignMessageData, GetCampaignIdForCampaignMessageErrors, GetCampaignIdForCampaignMessageResponses, GetCampaignIdsForTagData, GetCampaignIdsForTagErrors, GetCampaignIdsForTagResponses, GetCampaignMessageData, GetCampaignMessageErrors, GetCampaignMessageResponses, GetCampaignRecipientEstimationData, GetCampaignRecipientEstimationErrors, GetCampaignRecipientEstimationJobData, GetCampaignRecipientEstimationJobErrors, GetCampaignRecipientEstimationJobResponses, GetCampaignRecipientEstimationResponses, GetCampaignResponses, GetCampaignsData, GetCampaignSendJobData, GetCampaignSendJobErrors, GetCampaignSendJobResponses, GetCampaignsErrors, GetCampaignsResponses, GetCatalogCategoriesData, GetCatalogCategoriesErrors, GetCatalogCategoriesResponses, GetCatalogCategoryData, GetCatalogCategoryErrors, GetCatalogCategoryResponses, GetCatalogItemData, GetCatalogItemErrors, GetCatalogItemResponses, GetCatalogItemsData, GetCatalogItemsErrors, GetCatalogItemsResponses, GetCatalogVariantData, GetCatalogVariantErrors, GetCatalogVariantResponses, GetCatalogVariantsData, GetCatalogVariantsErrors, GetCatalogVariantsResponses, GetCategoriesForCatalogItemData, GetCategoriesForCatalogItemErrors, GetCategoriesForCatalogItemResponses, GetCategoryIdsForCatalogItemData, GetCategoryIdsForCatalogItemErrors, GetCategoryIdsForCatalogItemResponses, GetClientReviewsData, GetClientReviewsErrors, GetClientReviewsResponses, GetClientReviewValuesReportsData, GetClientReviewValuesReportsErrors, GetClientReviewValuesReportsResponses, GetCouponCodeData, GetCouponCodeErrors, GetCouponCodeIdsForCouponData, GetCouponCodeIdsForCouponErrors, GetCouponCodeIdsForCouponResponses, GetCouponCodeResponses, GetCouponCodesData, GetCouponCodesErrors, GetCouponCodesForCouponData, GetCouponCodesForCouponErrors, GetCouponCodesForCouponResponses, GetCouponCodesResponses, GetCouponData, GetCouponErrors, GetCouponForCouponCodeData, GetCouponForCouponCodeErrors, GetCouponForCouponCodeResponses, GetCouponIdForCouponCodeData, GetCouponIdForCouponCodeErrors, GetCouponIdForCouponCodeResponses, GetCouponResponses, GetCouponsData, GetCouponsErrors, GetCouponsResponses, GetCustomMetricData, GetCustomMetricErrors, GetCustomMetricForMappedMetricData, GetCustomMetricForMappedMetricErrors, GetCustomMetricForMappedMetricResponses, GetCustomMetricIdForMappedMetricData, GetCustomMetricIdForMappedMetricErrors, GetCustomMetricIdForMappedMetricResponses, GetCustomMetricResponses, GetCustomMetricsData, GetCustomMetricsErrors, GetCustomMetricsResponses, GetDataSourceData, GetDataSourceErrors, GetDataSourceResponses, GetDataSourcesData, GetDataSourcesErrors, GetDataSourcesResponses, GetErrorsForBulkImportProfilesJobData, GetErrorsForBulkImportProfilesJobErrors, GetErrorsForBulkImportProfilesJobResponses, GetEventData, GetEventErrors, GetEventResponses, GetEventsData, GetEventsErrors, GetEventsResponses, GetFlowActionData, GetFlowActionErrors, GetFlowActionMessagesData, GetFlowActionMessagesErrors, GetFlowActionMessagesResponses, GetFlowActionResponses, GetFlowData, GetFlowErrors, GetFlowForFlowActionData, GetFlowForFlowActionErrors, GetFlowForFlowActionResponses, GetFlowIdForFlowActionData, GetFlowIdForFlowActionErrors, GetFlowIdForFlowActionResponses, GetFlowIdsForTagData, GetFlowIdsForTagErrors, GetFlowIdsForTagResponses, GetFlowMessageData, GetFlowMessageErrors, GetFlowMessageResponses, GetFlowResponses, GetFlowsData, GetFlowsErrors, GetFlowsResponses, GetFlowsTriggeredByListData, GetFlowsTriggeredByListErrors, GetFlowsTriggeredByListResponses, GetFlowsTriggeredByMetricData, GetFlowsTriggeredByMetricErrors, GetFlowsTriggeredByMetricResponses, GetFlowsTriggeredBySegmentData, GetFlowsTriggeredBySegmentErrors, GetFlowsTriggeredBySegmentResponses, GetFormData, GetFormErrors, GetFormForFormVersionData, GetFormForFormVersionErrors, GetFormForFormVersionResponses, GetFormIdForFormVersionData, GetFormIdForFormVersionErrors, GetFormIdForFormVersionResponses, GetFormResponses, GetFormsData, GetFormsErrors, GetFormsResponses, GetFormVersionData, GetFormVersionErrors, GetFormVersionResponses, GetIdsForFlowsTriggeredByListData, GetIdsForFlowsTriggeredByListErrors, GetIdsForFlowsTriggeredByListResponses, GetIdsForFlowsTriggeredByMetricData, GetIdsForFlowsTriggeredByMetricErrors, GetIdsForFlowsTriggeredByMetricResponses, GetIdsForFlowsTriggeredBySegmentData, GetIdsForFlowsTriggeredBySegmentErrors, GetIdsForFlowsTriggeredBySegmentResponses, GetImageData, GetImageErrors, GetImageForCampaignMessageData, GetImageForCampaignMessageErrors, GetImageForCampaignMessageResponses, GetImageIdForCampaignMessageData, GetImageIdForCampaignMessageErrors, GetImageIdForCampaignMessageResponses, GetImageResponses, GetImagesData, GetImagesErrors, GetImagesResponses, GetItemIdsForCatalogCategoryData, GetItemIdsForCatalogCategoryErrors, GetItemIdsForCatalogCategoryResponses, GetItemsForCatalogCategoryData, GetItemsForCatalogCategoryErrors, GetItemsForCatalogCategoryResponses, GetListData, GetListErrors, GetListForBulkImportProfilesJobData, GetListForBulkImportProfilesJobErrors, GetListForBulkImportProfilesJobResponses, GetListIdsForBulkImportProfilesJobData, GetListIdsForBulkImportProfilesJobErrors, GetListIdsForBulkImportProfilesJobResponses, GetListIdsForProfileData, GetListIdsForProfileErrors, GetListIdsForProfileResponses, GetListIdsForTagData, GetListIdsForTagErrors, GetListIdsForTagResponses, GetListResponses, GetListsData, GetListsErrors, GetListsForProfileData, GetListsForProfileErrors, GetListsForProfileResponses, GetListsResponses, GetMappedMetricData, GetMappedMetricErrors, GetMappedMetricResponses, GetMappedMetricsData, GetMappedMetricsErrors, GetMappedMetricsResponses, GetMessageIdsForCampaignData, GetMessageIdsForCampaignErrors, GetMessageIdsForCampaignResponses, GetMessageIdsForFlowActionData, GetMessageIdsForFlowActionErrors, GetMessageIdsForFlowActionResponses, GetMessagesForCampaignData, GetMessagesForCampaignErrors, GetMessagesForCampaignResponses, GetMetricData, GetMetricErrors, GetMetricForEventData, GetMetricForEventErrors, GetMetricForEventResponses, GetMetricForMappedMetricData, GetMetricForMappedMetricErrors, GetMetricForMappedMetricResponses, GetMetricForMetricPropertyData, GetMetricForMetricPropertyErrors, GetMetricForMetricPropertyResponses, GetMetricIdForEventData, GetMetricIdForEventErrors, GetMetricIdForEventResponses, GetMetricIdForMappedMetricData, GetMetricIdForMappedMetricErrors, GetMetricIdForMappedMetricResponses, GetMetricIdForMetricPropertyData, GetMetricIdForMetricPropertyErrors, GetMetricIdForMetricPropertyResponses, GetMetricIdsForCustomMetricData, GetMetricIdsForCustomMetricErrors, GetMetricIdsForCustomMetricResponses, GetMetricPropertyData, GetMetricPropertyErrors, GetMetricPropertyResponses, GetMetricResponses, GetMetricsData, GetMetricsErrors, GetMetricsForCustomMetricData, GetMetricsForCustomMetricErrors, GetMetricsForCustomMetricResponses, GetMetricsResponses, GetProfileData, GetProfileErrors, GetProfileForEventData, GetProfileForEventErrors, GetProfileForEventResponses, GetProfileForPushTokenData, GetProfileForPushTokenErrors, GetProfileForPushTokenResponses, GetProfileIdForEventData, GetProfileIdForEventErrors, GetProfileIdForEventResponses, GetProfileIdForPushTokenData, GetProfileIdForPushTokenErrors, GetProfileIdForPushTokenResponses, GetProfileIdsForBulkImportProfilesJobData, GetProfileIdsForBulkImportProfilesJobErrors, GetProfileIdsForBulkImportProfilesJobResponses, GetProfileIdsForListData, GetProfileIdsForListErrors, GetProfileIdsForListResponses, GetProfileIdsForSegmentData, GetProfileIdsForSegmentErrors, GetProfileIdsForSegmentResponses, GetProfileResponses, GetProfilesData, GetProfilesErrors, GetProfilesForBulkImportProfilesJobData, GetProfilesForBulkImportProfilesJobErrors, GetProfilesForBulkImportProfilesJobResponses, GetProfilesForListData, GetProfilesForListErrors, GetProfilesForListResponses, GetProfilesForSegmentData, GetProfilesForSegmentErrors, GetProfilesForSegmentResponses, GetProfilesResponses, GetPropertiesForMetricData, GetPropertiesForMetricErrors, GetPropertiesForMetricResponses, GetPropertyIdsForMetricData, GetPropertyIdsForMetricErrors, GetPropertyIdsForMetricResponses, GetPushTokenData, GetPushTokenErrors, GetPushTokenIdsForProfileData, GetPushTokenIdsForProfileErrors, GetPushTokenIdsForProfileResponses, GetPushTokenResponses, GetPushTokensData, GetPushTokensErrors, GetPushTokensForProfileData, GetPushTokensForProfileErrors, GetPushTokensForProfileResponses, GetPushTokensResponses, GetReviewData, GetReviewErrors, GetReviewResponses, GetReviewsData, GetReviewsErrors, GetReviewsResponses, GetSegmentData, GetSegmentErrors, GetSegmentIdsForProfileData, GetSegmentIdsForProfileErrors, GetSegmentIdsForProfileResponses, GetSegmentIdsForTagData, GetSegmentIdsForTagErrors, GetSegmentIdsForTagResponses, GetSegmentResponses, GetSegmentsData, GetSegmentsErrors, GetSegmentsForProfileData, GetSegmentsForProfileErrors, GetSegmentsForProfileResponses, GetSegmentsResponses, GetTagData, GetTagErrors, GetTagGroupData, GetTagGroupErrors, GetTagGroupForTagData, GetTagGroupForTagErrors, GetTagGroupForTagResponses, GetTagGroupIdForTagData, GetTagGroupIdForTagErrors, GetTagGroupIdForTagResponses, GetTagGroupResponses, GetTagGroupsData, GetTagGroupsErrors, GetTagGroupsResponses, GetTagIdsForCampaignData, GetTagIdsForCampaignErrors, GetTagIdsForCampaignResponses, GetTagIdsForFlowData, GetTagIdsForFlowErrors, GetTagIdsForFlowResponses, GetTagIdsForListData, GetTagIdsForListErrors, GetTagIdsForListResponses, GetTagIdsForSegmentData, GetTagIdsForSegmentErrors, GetTagIdsForSegmentResponses, GetTagIdsForTagGroupData, GetTagIdsForTagGroupErrors, GetTagIdsForTagGroupResponses, GetTagResponses, GetTagsData, GetTagsErrors, GetTagsForCampaignData, GetTagsForCampaignErrors, GetTagsForCampaignResponses, GetTagsForFlowData, GetTagsForFlowErrors, GetTagsForFlowResponses, GetTagsForListData, GetTagsForListErrors, GetTagsForListResponses, GetTagsForSegmentData, GetTagsForSegmentErrors, GetTagsForSegmentResponses, GetTagsForTagGroupData, GetTagsForTagGroupErrors, GetTagsForTagGroupResponses, GetTagsResponses, GetTemplateData, GetTemplateErrors, GetTemplateForCampaignMessageData, GetTemplateForCampaignMessageErrors, GetTemplateForCampaignMessageResponses, GetTemplateForFlowMessageData, GetTemplateForFlowMessageErrors, GetTemplateForFlowMessageResponses, GetTemplateIdForCampaignMessageData, GetTemplateIdForCampaignMessageErrors, GetTemplateIdForCampaignMessageResponses, GetTemplateIdForFlowMessageData, GetTemplateIdForFlowMessageErrors, GetTemplateIdForFlowMessageResponses, GetTemplateResponses, GetTemplatesData, GetTemplatesErrors, GetTemplatesResponses, GetTrackingSettingData, GetTrackingSettingErrors, GetTrackingSettingResponses, GetTrackingSettingsData, GetTrackingSettingsErrors, GetTrackingSettingsResponses, GetUniversalContentData, GetUniversalContentErrors, GetUniversalContentResponses, GetVariantIdsForCatalogItemData, GetVariantIdsForCatalogItemErrors, GetVariantIdsForCatalogItemResponses, GetVariantsForCatalogItemData, GetVariantsForCatalogItemErrors, GetVariantsForCatalogItemResponses, GetVersionIdsForFormData, GetVersionIdsForFormErrors, GetVersionIdsForFormResponses, GetVersionsForFormData, GetVersionsForFormErrors, GetVersionsForFormResponses, GetWebFeedData, GetWebFeedErrors, GetWebFeedResponses, GetWebFeedsData, GetWebFeedsErrors, GetWebFeedsResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GetWebhooksData, GetWebhooksErrors, GetWebhooksResponses, GetWebhookTopicData, GetWebhookTopicErrors, GetWebhookTopicResponses, GetWebhookTopicsData, GetWebhookTopicsErrors, GetWebhookTopicsResponses, MergeProfilesData, MergeProfilesErrors, MergeProfilesResponses, QueryCampaignValuesData, QueryCampaignValuesErrors, QueryCampaignValuesResponses, QueryFlowSeriesData, QueryFlowSeriesErrors, QueryFlowSeriesResponses, QueryFlowValuesData, QueryFlowValuesErrors, QueryFlowValuesResponses, QueryFormSeriesData, QueryFormSeriesErrors, QueryFormSeriesResponses, QueryFormValuesData, QueryFormValuesErrors, QueryFormValuesResponses, QueryMetricAggregatesData, QueryMetricAggregatesErrors, QueryMetricAggregatesResponses, QuerySegmentSeriesData, QuerySegmentSeriesErrors, QuerySegmentSeriesResponses, QuerySegmentValuesData, QuerySegmentValuesErrors, QuerySegmentValuesResponses, RefreshCampaignRecipientEstimationData, RefreshCampaignRecipientEstimationErrors, RefreshCampaignRecipientEstimationResponses, RemoveCategoriesFromCatalogItemData, RemoveCategoriesFromCatalogItemErrors, RemoveCategoriesFromCatalogItemResponses, RemoveItemsFromCatalogCategoryData, RemoveItemsFromCatalogCategoryErrors, RemoveItemsFromCatalogCategoryResponses, RemoveProfilesFromListData, RemoveProfilesFromListErrors, RemoveProfilesFromListResponses, RemoveTagFromCampaignsData, RemoveTagFromCampaignsErrors, RemoveTagFromCampaignsResponses, RemoveTagFromFlowsData, RemoveTagFromFlowsErrors, RemoveTagFromFlowsResponses, RemoveTagFromListsData, RemoveTagFromListsErrors, RemoveTagFromListsResponses, RemoveTagFromSegmentsData, RemoveTagFromSegmentsErrors, RemoveTagFromSegmentsResponses, RenderTemplateData, RenderTemplateErrors, RenderTemplateResponses, RequestProfileDeletionData, RequestProfileDeletionErrors, RequestProfileDeletionResponses, SendCampaignData, SendCampaignErrors, SendCampaignResponses, TagCampaignsData, TagCampaignsErrors, TagCampaignsResponses, TagFlowsData, TagFlowsErrors, TagFlowsResponses, TagListsData, TagListsErrors, TagListsResponses, TagSegmentsData, TagSegmentsErrors, TagSegmentsResponses, UnregisterClientPushTokenData, UnregisterClientPushTokenErrors, UnregisterClientPushTokenResponses, UpdateCampaignData, UpdateCampaignErrors, UpdateCampaignMessageData, UpdateCampaignMessageErrors, UpdateCampaignMessageResponses, UpdateCampaignResponses, UpdateCatalogCategoryData, UpdateCatalogCategoryErrors, UpdateCatalogCategoryResponses, UpdateCatalogItemData, UpdateCatalogItemErrors, UpdateCatalogItemResponses, UpdateCatalogVariantData, UpdateCatalogVariantErrors, UpdateCatalogVariantResponses, UpdateCategoriesForCatalogItemData, UpdateCategoriesForCatalogItemErrors, UpdateCategoriesForCatalogItemResponses, UpdateCouponCodeData, UpdateCouponCodeErrors, UpdateCouponCodeResponses, UpdateCouponData, UpdateCouponErrors, UpdateCouponResponses, UpdateCustomMetricData, UpdateCustomMetricErrors, UpdateCustomMetricResponses, UpdateFlowActionData, UpdateFlowActionErrors, UpdateFlowActionResponses, UpdateFlowData, UpdateFlowErrors, UpdateFlowResponses, UpdateImageData, UpdateImageErrors, UpdateImageForCampaignMessageData, UpdateImageForCampaignMessageErrors, UpdateImageForCampaignMessageResponses, UpdateImageResponses, UpdateItemsForCatalogCategoryData, UpdateItemsForCatalogCategoryErrors, UpdateItemsForCatalogCategoryResponses, UpdateListData, UpdateListErrors, UpdateListResponses, UpdateMappedMetricData, UpdateMappedMetricErrors, UpdateMappedMetricResponses, UpdateProfileData, UpdateProfileErrors, UpdateProfileResponses, UpdateReviewData, UpdateReviewErrors, UpdateReviewResponses, UpdateSegmentData, UpdateSegmentErrors, UpdateSegmentResponses, UpdateTagData, UpdateTagErrors, UpdateTagGroupData, UpdateTagGroupErrors, UpdateTagGroupResponses, UpdateTagResponses, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateTrackingSettingData, UpdateTrackingSettingErrors, UpdateTrackingSettingResponses, UpdateUniversalContentData, UpdateUniversalContentErrors, UpdateUniversalContentResponses, UpdateWebFeedData, UpdateWebFeedErrors, UpdateWebFeedResponses, UpdateWebhookData, UpdateWebhookErrors, UpdateWebhookResponses, UploadImageFromFileData, UploadImageFromFileErrors, UploadImageFromFileResponses, UploadImageFromUrlData, UploadImageFromUrlErrors, UploadImageFromUrlResponses } from './types.gen.js';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
/**
* Get Accounts
*
* Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.
*
* You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`
*
* **Scopes:**
* `accounts:read`
*/
export const getAccounts = <ThrowOnError extends boolean = false>(options: Options<GetAccountsData, ThrowOnError>) => (options.client ?? client).get<GetAccountsResponses, GetAccountsErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[account]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/accounts',
...options
});
/**
* Get Account
*
* Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`
*
* **Scopes:**
* `accounts:read`
*/
export const getAccount = <ThrowOnError extends boolean = false>(options: Options<GetAccountData, ThrowOnError>) => (options.client ?? client).get<GetAccountResponses, GetAccountErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[account]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/accounts/{id}',
...options
});
/**
* Get Campaigns
*
* Returns some or all campaigns based on filters.
*
* A channel filter is required to list campaigns. Please provide either:
* `?filter=equals(messages.channel,'email')` to list email campaigns, or
* `?filter=equals(messages.channel,'sms')` to list SMS campaigns.
* `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaigns = <ThrowOnError extends boolean = false>(options: Options<GetCampaignsData, ThrowOnError>) => (options.client ?? client).get<GetCampaignsResponses, GetCampaignsErrors, ThrowOnError>({
querySerializer: { parameters: {
'fields[campaign-message]': { array: { explode: false } },
'fields[campaign]': { array: { explode: false } },
'fields[tag]': { array: { explode: false } },
include: { array: { explode: false } }
} },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns',
...options
});
/**
* Create Campaign
*
* Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const createCampaign = <ThrowOnError extends boolean = false>(options: Options<CreateCampaignData, ThrowOnError>) => (options.client ?? client).post<CreateCampaignResponses, CreateCampaignErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Delete Campaign
*
* Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const deleteCampaign = <ThrowOnError extends boolean = false>(options: Options<DeleteCampaignData, ThrowOnError>) => (options.client ?? client).delete<DeleteCampaignResponses, DeleteCampaignErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}',
...options
});
/**
* Get Campaign
*
* Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaign = <ThrowOnError extends boolean = false>(options: Options<GetCampaignData, ThrowOnError>) => (options.client ?? client).get<GetCampaignResponses, GetCampaignErrors, ThrowOnError>({
querySerializer: { parameters: {
'fields[campaign-message]': { array: { explode: false } },
'fields[campaign]': { array: { explode: false } },
'fields[tag]': { array: { explode: false } },
include: { array: { explode: false } }
} },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}',
...options
});
/**
* Update Campaign
*
* Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const updateCampaign = <ThrowOnError extends boolean = false>(options: Options<UpdateCampaignData, ThrowOnError>) => (options.client ?? client).patch<UpdateCampaignResponses, UpdateCampaignErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Get Campaign Message
*
* Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetCampaignMessageResponses, GetCampaignMessageErrors, ThrowOnError>({
querySerializer: { parameters: {
'fields[campaign-message]': { array: { explode: false } },
'fields[campaign]': { array: { explode: false } },
'fields[image]': { array: { explode: false } },
'fields[template]': { array: { explode: false } },
include: { array: { explode: false } }
} },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}',
...options
});
/**
* Update Campaign Message
*
* Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const updateCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<UpdateCampaignMessageData, ThrowOnError>) => (options.client ?? client).patch<UpdateCampaignMessageResponses, UpdateCampaignMessageErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Get Campaign Send Job
*
* Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaignSendJob = <ThrowOnError extends boolean = false>(options: Options<GetCampaignSendJobData, ThrowOnError>) => (options.client ?? client).get<GetCampaignSendJobResponses, GetCampaignSendJobErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[campaign-send-job]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-send-jobs/{id}',
...options
});
/**
* Cancel Campaign Send
*
* Permanently cancel the campaign, setting the status to CANCELED or
* revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const cancelCampaignSend = <ThrowOnError extends boolean = false>(options: Options<CancelCampaignSendData, ThrowOnError>) => (options.client ?? client).patch<CancelCampaignSendResponses, CancelCampaignSendErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-send-jobs/{id}',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Get Campaign Recipient Estimation Job
*
* Retrieve the status of a recipient estimation job triggered
* with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaignRecipientEstimationJob = <ThrowOnError extends boolean = false>(options: Options<GetCampaignRecipientEstimationJobData, ThrowOnError>) => (options.client ?? client).get<GetCampaignRecipientEstimationJobResponses, GetCampaignRecipientEstimationJobErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[campaign-recipient-estimation-job]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-recipient-estimation-jobs/{id}',
...options
});
/**
* Get Campaign Recipient Estimation
*
* Get the estimated recipient count for a campaign with the provided campaign ID.
* You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaignRecipientEstimation = <ThrowOnError extends boolean = false>(options: Options<GetCampaignRecipientEstimationData, ThrowOnError>) => (options.client ?? client).get<GetCampaignRecipientEstimationResponses, GetCampaignRecipientEstimationErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[campaign-recipient-estimation]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-recipient-estimations/{id}',
...options
});
/**
* Create Campaign Clone
*
* Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const createCampaignClone = <ThrowOnError extends boolean = false>(options: Options<CreateCampaignCloneData, ThrowOnError>) => (options.client ?? client).post<CreateCampaignCloneResponses, CreateCampaignCloneErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-clone',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Assign Template to Campaign Message
*
* Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const assignTemplateToCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<AssignTemplateToCampaignMessageData, ThrowOnError>) => (options.client ?? client).post<AssignTemplateToCampaignMessageResponses, AssignTemplateToCampaignMessageErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-message-assign-template',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Send Campaign
*
* Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const sendCampaign = <ThrowOnError extends boolean = false>(options: Options<SendCampaignData, ThrowOnError>) => (options.client ?? client).post<SendCampaignResponses, SendCampaignErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-send-jobs',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Refresh Campaign Recipient Estimation
*
* Trigger an asynchronous job to update the estimated number of recipients
* for the given campaign ID. Use the `Get Campaign Recipient Estimation
* Job` endpoint to retrieve the status of this estimation job. Use the
* `Get Campaign Recipient Estimation` endpoint to retrieve the estimated
* recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
*/
export const refreshCampaignRecipientEstimation = <ThrowOnError extends boolean = false>(options: Options<RefreshCampaignRecipientEstimationData, ThrowOnError>) => (options.client ?? client).post<RefreshCampaignRecipientEstimationResponses, RefreshCampaignRecipientEstimationErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-recipient-estimation-jobs',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Get Campaign for Campaign Message
*
* Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaignForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetCampaignForCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetCampaignForCampaignMessageResponses, GetCampaignForCampaignMessageErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[campaign]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/campaign',
...options
});
/**
* Get Campaign ID for Campaign Message
*
* Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getCampaignIdForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetCampaignIdForCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetCampaignIdForCampaignMessageResponses, GetCampaignIdForCampaignMessageErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/relationships/campaign',
...options
});
/**
* Get Template for Campaign Message
*
* Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
* `templates:read`
*/
export const getTemplateForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetTemplateForCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetTemplateForCampaignMessageResponses, GetTemplateForCampaignMessageErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[template]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/template',
...options
});
/**
* Get Template ID for Campaign Message
*
* Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
* `templates:read`
*/
export const getTemplateIdForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetTemplateIdForCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetTemplateIdForCampaignMessageResponses, GetTemplateIdForCampaignMessageErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/relationships/template',
...options
});
/**
* Get Image for Campaign Message
*
* Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
* `images:read`
*/
export const getImageForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetImageForCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetImageForCampaignMessageResponses, GetImageForCampaignMessageErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[image]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/image',
...options
});
/**
* Get Image ID for Campaign Message
*
* Returns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
* `images:read`
*/
export const getImageIdForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<GetImageIdForCampaignMessageData, ThrowOnError>) => (options.client ?? client).get<GetImageIdForCampaignMessageResponses, GetImageIdForCampaignMessageErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/relationships/image',
...options
});
/**
* Update Image for Campaign Message
*
* Update a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:write`
* `images:read`
*/
export const updateImageForCampaignMessage = <ThrowOnError extends boolean = false>(options: Options<UpdateImageForCampaignMessageData, ThrowOnError>) => (options.client ?? client).patch<UpdateImageForCampaignMessageResponses, UpdateImageForCampaignMessageErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaign-messages/{id}/relationships/image',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Get Tags for Campaign
*
* Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
*
* **Scopes:**
* `campaigns:read`
* `tags:read`
*/
export const getTagsForCampaign = <ThrowOnError extends boolean = false>(options: Options<GetTagsForCampaignData, ThrowOnError>) => (options.client ?? client).get<GetTagsForCampaignResponses, GetTagsForCampaignErrors, ThrowOnError>({
querySerializer: { parameters: { 'fields[tag]': { array: { explode: false } } } },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}/tags',
...options
});
/**
* Get Tag IDs for Campaign
*
* Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`
*
* **Scopes:**
* `campaigns:read`
* `tags:read`
*/
export const getTagIdsForCampaign = <ThrowOnError extends boolean = false>(options: Options<GetTagIdsForCampaignData, ThrowOnError>) => (options.client ?? client).get<GetTagIdsForCampaignResponses, GetTagIdsForCampaignErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}/relationships/tags',
...options
});
/**
* Get Messages for Campaign
*
* Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getMessagesForCampaign = <ThrowOnError extends boolean = false>(options: Options<GetMessagesForCampaignData, ThrowOnError>) => (options.client ?? client).get<GetMessagesForCampaignResponses, GetMessagesForCampaignErrors, ThrowOnError>({
querySerializer: { parameters: {
'fields[campaign-message]': { array: { explode: false } },
'fields[campaign]': { array: { explode: false } },
'fields[image]': { array: { explode: false } },
'fields[template]': { array: { explode: false } },
include: { array: { explode: false } }
} },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}/campaign-messages',
...options
});
/**
* Get Message IDs for Campaign
*
* Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`
*
* **Scopes:**
* `campaigns:read`
*/
export const getMessageIdsForCampaign = <ThrowOnError extends boolean = false>(options: Options<GetMessageIdsForCampaignData, ThrowOnError>) => (options.client ?? client).get<GetMessageIdsForCampaignResponses, GetMessageIdsForCampaignErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/campaigns/{id}/relationships/campaign-messages',
...options
});
/**
* Get Catalog Items
*
* Get all catalog items in an account.
*
* Catalog items can be sorted by the following fields, in ascending and descending order:
* `created`
*
* Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.
*
* Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`
*
* **Scopes:**
* `catalogs:read`
*/
export const getCatalogItems = <ThrowOnError extends boolean = false>(options: Options<GetCatalogItemsData, ThrowOnError>) => (options.client ?? client).get<GetCatalogItemsResponses, GetCatalogItemsErrors, ThrowOnError>({
querySerializer: { parameters: {
'fields[catalog-item]': { array: { explode: false } },
'fields[catalog-variant]': { array: { explode: false } },
include: { array: { explode: false } }
} },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/catalog-items',
...options
});
/**
* Create Catalog Item
*
* Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`
*
* **Scopes:**
* `catalogs:write`
*/
export const createCatalogItem = <ThrowOnError extends boolean = false>(options: Options<CreateCatalogItemData, ThrowOnError>) => (options.client ?? client).post<CreateCatalogItemResponses, CreateCatalogItemErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/catalog-items',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Delete Catalog Item
*
* Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`
*
* **Scopes:**
* `catalogs:write`
*/
export const deleteCatalogItem = <ThrowOnError extends boolean = false>(options: Options<DeleteCatalogItemData, ThrowOnError>) => (options.client ?? client).delete<DeleteCatalogItemResponses, DeleteCatalogItemErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/catalog-items/{id}',
...options
});
/**
* Get Catalog Item
*
* Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`
*
* **Scopes:**
* `catalogs:read`
*/
export const getCatalogItem = <ThrowOnError extends boolean = false>(options: Options<GetCatalogItemData, ThrowOnError>) => (options.client ?? client).get<GetCatalogItemResponses, GetCatalogItemErrors, ThrowOnError>({
querySerializer: { parameters: {
'fields[catalog-item]': { array: { explode: false } },
'fields[catalog-variant]': { array: { explode: false } },
include: { array: { explode: false } }
} },
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/catalog-items/{id}',
...options
});
/**
* Update Catalog Item
*
* Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`
*
* **Scopes:**
* `catalogs:write`
*/
export const updateCatalogItem = <ThrowOnError extends boolean = false>(options: Options<UpdateCatalogItemData, ThrowOnError>) => (options.client ?? client).patch<UpdateCatalogItemResponses, UpdateCatalogItemErrors, ThrowOnError>({
security: [{ name: 'Authorization', type: 'apiKey' }],
url: '/api/catalog-items/{id}',
...options,
headers: {
'Content-Type': 'application/vnd.api+json',
...options.headers
}
});
/**
* Get Catalog Variants
*
* Get all variants in an account.
*
* Variants can be sorted by the following fields, in ascending and descending order:
* `created`
*
* Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.
*
* Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`
*
* **Scopes:**
* `catalogs:read`