klaviyo-api-fetch
Version:
A native fetch API using hey-api ts codegen
834 lines (799 loc) • 269 kB
text/typescript
// This file is auto-generated by @hey-api/openapi-ts
import { type Options as ClientOptions, type TDataShape, type Client, formDataBodySerializer } from '@hey-api/client-fetch';
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';
import { client as _heyApiClient } from './client.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<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>) => {
return (options.client ?? _heyApiClient).get<GetAccountsResponse, GetAccountsError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetAccountResponse2, GetAccountError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignsResponse, GetCampaignsError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).post<CreateCampaignResponse, CreateCampaignError, 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>) => {
return (options.client ?? _heyApiClient).delete<DeleteCampaignResponse, DeleteCampaignError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignResponse2, GetCampaignError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).patch<UpdateCampaignResponse, UpdateCampaignError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignMessageResponse, GetCampaignMessageError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).patch<UpdateCampaignMessageResponse, UpdateCampaignMessageError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignSendJobResponse2, GetCampaignSendJobError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).patch<CancelCampaignSendResponse, CancelCampaignSendError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignRecipientEstimationJobResponse2, GetCampaignRecipientEstimationJobError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignRecipientEstimationResponse2, GetCampaignRecipientEstimationError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).post<CreateCampaignCloneResponse, CreateCampaignCloneError, 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>) => {
return (options.client ?? _heyApiClient).post<AssignTemplateToCampaignMessageResponse, AssignTemplateToCampaignMessageError, 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>) => {
return (options.client ?? _heyApiClient).post<SendCampaignResponse, SendCampaignError, 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>) => {
return (options.client ?? _heyApiClient).post<RefreshCampaignRecipientEstimationResponse, RefreshCampaignRecipientEstimationError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignForCampaignMessageResponse, GetCampaignForCampaignMessageError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetCampaignIdForCampaignMessageResponse, GetCampaignIdForCampaignMessageError, 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>) => {
return (options.client ?? _heyApiClient).get<GetTemplateForCampaignMessageResponse, GetTemplateForCampaignMessageError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetTemplateIdForCampaignMessageResponse, GetTemplateIdForCampaignMessageError, 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>) => {
return (options.client ?? _heyApiClient).get<GetImageForCampaignMessageResponse, GetImageForCampaignMessageError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetImageIdForCampaignMessageResponse, GetImageIdForCampaignMessageError, 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>) => {
return (options.client ?? _heyApiClient).patch<UpdateImageForCampaignMessageResponse, UpdateImageForCampaignMessageError, 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>) => {
return (options.client ?? _heyApiClient).get<GetTagsForCampaignResponse, GetTagsForCampaignError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetTagIdsForCampaignResponse, GetTagIdsForCampaignError, 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>) => {
return (options.client ?? _heyApiClient).get<GetMessagesForCampaignResponse, GetMessagesForCampaignError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).get<GetMessageIdsForCampaignResponse, GetMessageIdsForCampaignError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCatalogItemsResponse, GetCatalogItemsError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).post<CreateCatalogItemResponse, CreateCatalogItemError, 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>) => {
return (options.client ?? _heyApiClient).delete<DeleteCatalogItemResponse, DeleteCatalogItemError, 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>) => {
return (options.client ?? _heyApiClient).get<GetCatalogItemResponse, GetCatalogItemError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
querySerializer: {
array: {
explode: false,
style: 'form'
}
},
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>) => {
return (options.client ?? _heyApiClient).patch<UpdateCatalogItemResponse, UpdateCatalogItemError, ThrowOnError>({
security: [
{
name: 'Authorization',
type: 'apiKey'
}
],
url: '/api