@adspireai/adspire-node-sdk 1.0.324 → 1.0.326

package/dist-public/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { LoginUserData, LoginUserResponses, LoginUserErrors, GetMeData, GetMeResponses, GetMeErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetBrandAssetsData, GetBrandAssetsResponses, GetBrandAssetsErrors, UpdateBrandAssetsData, UpdateBrandAssetsResponses, UpdateBrandAssetsErrors, ListBrandChannelsData, ListBrandChannelsResponses, ListBrandChannelsErrors, SyncBrandChannelsData, SyncBrandChannelsResponses, SyncBrandChannelsErrors, ListBrandsData, ListBrandsResponses, ListBrandsErrors, CreateBrandData, CreateBrandResponses, CreateBrandErrors, DeleteBrandData, DeleteBrandResponses, DeleteBrandErrors, GetBrandData, GetBrandResponses, GetBrandErrors, UpdateBrandData, UpdateBrandResponses, UpdateBrandErrors, GetBrandGraphData, GetBrandGraphResponses, GetBrandGraphErrors, UpdateBrandGraphGroupData, UpdateBrandGraphGroupResponses, UpdateBrandGraphGroupErrors, ListBrandPromptsData, ListBrandPromptsResponses, ListBrandPromptsErrors, CreateBrandPromptData, CreateBrandPromptResponses, CreateBrandPromptErrors, DeleteBrandPromptData, DeleteBrandPromptResponses, DeleteBrandPromptErrors, GetBrandPromptData, GetBrandPromptResponses, GetBrandPromptErrors, UpdateBrandPromptData, UpdateBrandPromptResponses, UpdateBrandPromptErrors, ListCampaignsData, ListCampaignsResponses, ListCampaignsErrors, CreateCampaignData, CreateCampaignResponses, CreateCampaignErrors, ListBrandCampaignsData, ListBrandCampaignsResponses, DeleteCampaignData, DeleteCampaignResponses, DeleteCampaignErrors, GetCampaignData, GetCampaignResponses, GetCampaignErrors, UpdateCampaignData, UpdateCampaignResponses, UpdateCampaignErrors, ListCompaniesData, ListCompaniesResponses, CreateCompanyData, CreateCompanyResponses, CreateCompanyErrors, AutocompleteCompaniesData, AutocompleteCompaniesResponses, DeleteCompanyData, DeleteCompanyResponses, DeleteCompanyErrors, GetCompanyData, GetCompanyResponses, GetCompanyErrors, UpdateCompanyData, UpdateCompanyResponses, UpdateCompanyErrors, ListWebhookEventsData, ListWebhookEventsResponses, ListWebhookEventsErrors, CreateWebhookEventData, CreateWebhookEventResponses, CreateWebhookEventErrors, DeleteWebhookEventData, DeleteWebhookEventResponses, DeleteWebhookEventErrors, GetWebhookEventData, GetWebhookEventResponses, GetWebhookEventErrors, UpdateWebhookEventData, UpdateWebhookEventResponses, UpdateWebhookEventErrors, ListWhiteboardCommentsData, ListWhiteboardCommentsResponses, ListWhiteboardCommentsErrors, CreateWhiteboardCommentData, CreateWhiteboardCommentResponses, CreateWhiteboardCommentErrors, DeleteWhiteboardCommentData, DeleteWhiteboardCommentResponses, DeleteWhiteboardCommentErrors, GetWhiteboardCommentData, GetWhiteboardCommentResponses, GetWhiteboardCommentErrors, UpdateWhiteboardCommentData, UpdateWhiteboardCommentResponses, UpdateWhiteboardCommentErrors, ListWhiteboardsData, ListWhiteboardsResponses, ListWhiteboardsErrors, CreateWhiteboardData, CreateWhiteboardResponses, CreateWhiteboardErrors, DeleteWhiteboardData, DeleteWhiteboardResponses, DeleteWhiteboardErrors, GetWhiteboardData, GetWhiteboardResponses, GetWhiteboardErrors, UpdateWhiteboardData, UpdateWhiteboardResponses, UpdateWhiteboardErrors, ListWhiteboardPostCommentsData, ListWhiteboardPostCommentsResponses, ListWhiteboardPostCommentsErrors, CreateWhiteboardPostCommentData, CreateWhiteboardPostCommentResponses, CreateWhiteboardPostCommentErrors, DeleteWhiteboardPostCommentData, DeleteWhiteboardPostCommentResponses, DeleteWhiteboardPostCommentErrors, GetWhiteboardPostCommentData, GetWhiteboardPostCommentResponses, GetWhiteboardPostCommentErrors, UpdateWhiteboardPostCommentData, UpdateWhiteboardPostCommentResponses, UpdateWhiteboardPostCommentErrors, ListWhiteboardPostsData, ListWhiteboardPostsResponses, ListWhiteboardPostsErrors, CreateWhiteboardPostData, CreateWhiteboardPostResponses, CreateWhiteboardPostErrors, DeleteWhiteboardPostData, DeleteWhiteboardPostResponses, DeleteWhiteboardPostErrors, GetWhiteboardPostData, GetWhiteboardPostResponses, GetWhiteboardPostErrors, UpdateWhiteboardPostData, UpdateWhiteboardPostResponses, UpdateWhiteboardPostErrors, ReorderWhiteboardPostsData, ReorderWhiteboardPostsResponses, ReorderWhiteboardPostsErrors, DuplicateWhiteboardPostData, DuplicateWhiteboardPostResponses, DuplicateWhiteboardPostErrors, ListWhiteboardPreviewsData, ListWhiteboardPreviewsResponses, ListWhiteboardPreviewsErrors, CreateWhiteboardPreviewData, CreateWhiteboardPreviewResponses, CreateWhiteboardPreviewErrors, DiscardPreviousWhiteboardPreviewsData, DiscardPreviousWhiteboardPreviewsResponses, DiscardPreviousWhiteboardPreviewsErrors, DeleteWhiteboardPreviewData, DeleteWhiteboardPreviewResponses, DeleteWhiteboardPreviewErrors } from './types.gen';
+import type { LoginUserData, LoginUserResponses, LoginUserErrors, GetMeData, GetMeResponses, GetMeErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetBrandAssetsData, GetBrandAssetsResponses, GetBrandAssetsErrors, UpdateBrandAssetsData, UpdateBrandAssetsResponses, UpdateBrandAssetsErrors, ListBrandChannelsData, ListBrandChannelsResponses, ListBrandChannelsErrors, SyncBrandChannelsData, SyncBrandChannelsResponses, SyncBrandChannelsErrors, ListBrandCompetitorsData, ListBrandCompetitorsResponses, ListBrandCompetitorsErrors, CreateBrandCompetitorData, CreateBrandCompetitorResponses, CreateBrandCompetitorErrors, DeleteBrandCompetitorData, DeleteBrandCompetitorResponses, DeleteBrandCompetitorErrors, GetBrandCompetitorData, GetBrandCompetitorResponses, GetBrandCompetitorErrors, UpdateBrandCompetitorData, UpdateBrandCompetitorResponses, UpdateBrandCompetitorErrors, ListBrandsData, ListBrandsResponses, ListBrandsErrors, CreateBrandData, CreateBrandResponses, CreateBrandErrors, DeleteBrandData, DeleteBrandResponses, DeleteBrandErrors, GetBrandData, GetBrandResponses, GetBrandErrors, UpdateBrandData, UpdateBrandResponses, UpdateBrandErrors, GetBrandGraphData, GetBrandGraphResponses, GetBrandGraphErrors, UpdateBrandGraphGroupData, UpdateBrandGraphGroupResponses, UpdateBrandGraphGroupErrors, ListBrandPromptsData, ListBrandPromptsResponses, ListBrandPromptsErrors, CreateBrandPromptData, CreateBrandPromptResponses, CreateBrandPromptErrors, DeleteBrandPromptData, DeleteBrandPromptResponses, DeleteBrandPromptErrors, GetBrandPromptData, GetBrandPromptResponses, GetBrandPromptErrors, UpdateBrandPromptData, UpdateBrandPromptResponses, UpdateBrandPromptErrors, ListCampaignsData, ListCampaignsResponses, ListCampaignsErrors, CreateCampaignData, CreateCampaignResponses, CreateCampaignErrors, ListBrandCampaignsData, ListBrandCampaignsResponses, DeleteCampaignData, DeleteCampaignResponses, DeleteCampaignErrors, GetCampaignData, GetCampaignResponses, GetCampaignErrors, UpdateCampaignData, UpdateCampaignResponses, UpdateCampaignErrors, ListCompaniesData, ListCompaniesResponses, CreateCompanyData, CreateCompanyResponses, CreateCompanyErrors, AutocompleteCompaniesData, AutocompleteCompaniesResponses, DeleteCompanyData, DeleteCompanyResponses, DeleteCompanyErrors, GetCompanyData, GetCompanyResponses, GetCompanyErrors, UpdateCompanyData, UpdateCompanyResponses, UpdateCompanyErrors, ListWebhookEventsData, ListWebhookEventsResponses, ListWebhookEventsErrors, CreateWebhookEventData, CreateWebhookEventResponses, CreateWebhookEventErrors, DeleteWebhookEventData, DeleteWebhookEventResponses, DeleteWebhookEventErrors, GetWebhookEventData, GetWebhookEventResponses, GetWebhookEventErrors, UpdateWebhookEventData, UpdateWebhookEventResponses, UpdateWebhookEventErrors, ListWhiteboardCommentsData, ListWhiteboardCommentsResponses, ListWhiteboardCommentsErrors, CreateWhiteboardCommentData, CreateWhiteboardCommentResponses, CreateWhiteboardCommentErrors, DeleteWhiteboardCommentData, DeleteWhiteboardCommentResponses, DeleteWhiteboardCommentErrors, GetWhiteboardCommentData, GetWhiteboardCommentResponses, GetWhiteboardCommentErrors, UpdateWhiteboardCommentData, UpdateWhiteboardCommentResponses, UpdateWhiteboardCommentErrors, ListWhiteboardsData, ListWhiteboardsResponses, ListWhiteboardsErrors, CreateWhiteboardData, CreateWhiteboardResponses, CreateWhiteboardErrors, DeleteWhiteboardData, DeleteWhiteboardResponses, DeleteWhiteboardErrors, GetWhiteboardData, GetWhiteboardResponses, GetWhiteboardErrors, UpdateWhiteboardData, UpdateWhiteboardResponses, UpdateWhiteboardErrors, ListWhiteboardPostCommentsData, ListWhiteboardPostCommentsResponses, ListWhiteboardPostCommentsErrors, CreateWhiteboardPostCommentData, CreateWhiteboardPostCommentResponses, CreateWhiteboardPostCommentErrors, DeleteWhiteboardPostCommentData, DeleteWhiteboardPostCommentResponses, DeleteWhiteboardPostCommentErrors, GetWhiteboardPostCommentData, GetWhiteboardPostCommentResponses, GetWhiteboardPostCommentErrors, UpdateWhiteboardPostCommentData, UpdateWhiteboardPostCommentResponses, UpdateWhiteboardPostCommentErrors, ListWhiteboardPostsData, ListWhiteboardPostsResponses, ListWhiteboardPostsErrors, CreateWhiteboardPostData, CreateWhiteboardPostResponses, CreateWhiteboardPostErrors, DeleteWhiteboardPostData, DeleteWhiteboardPostResponses, DeleteWhiteboardPostErrors, GetWhiteboardPostData, GetWhiteboardPostResponses, GetWhiteboardPostErrors, UpdateWhiteboardPostData, UpdateWhiteboardPostResponses, UpdateWhiteboardPostErrors, ReorderWhiteboardPostsData, ReorderWhiteboardPostsResponses, ReorderWhiteboardPostsErrors, DuplicateWhiteboardPostData, DuplicateWhiteboardPostResponses, DuplicateWhiteboardPostErrors, ListWhiteboardPreviewsData, ListWhiteboardPreviewsResponses, ListWhiteboardPreviewsErrors, CreateWhiteboardPreviewData, CreateWhiteboardPreviewResponses, CreateWhiteboardPreviewErrors, DiscardPreviousWhiteboardPreviewsData, DiscardPreviousWhiteboardPreviewsResponses, DiscardPreviousWhiteboardPreviewsErrors, DeleteWhiteboardPreviewData, DeleteWhiteboardPreviewResponses, DeleteWhiteboardPreviewErrors } from './types.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
@@ -48,6 +48,31 @@ export declare const listBrandChannels: <ThrowOnError extends boolean = false>(o
  * Sync channels for a brand. Existing channels are updated when an id is provided; omitted unused channels are deleted.
  */
 export declare const syncBrandChannels: <ThrowOnError extends boolean = false>(options: Options<SyncBrandChannelsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<SyncBrandChannelsResponses, SyncBrandChannelsErrors, ThrowOnError, "fields">;
+/**
+ * List competitors for a brand
+ * Returns every competitor of the brand with its social profiles, oldest first.
+ */
+export declare const listBrandCompetitors: <ThrowOnError extends boolean = false>(options: Options<ListBrandCompetitorsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<ListBrandCompetitorsResponses, ListBrandCompetitorsErrors, ThrowOnError, "fields">;
+/**
+ * Create brand competitor
+ * Creates a competitor for the brand together with its social profiles. At least one profile is required.
+ */
+export declare const createBrandCompetitor: <ThrowOnError extends boolean = false>(options: Options<CreateBrandCompetitorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<CreateBrandCompetitorResponses, CreateBrandCompetitorErrors, ThrowOnError, "fields">;
+/**
+ * Delete brand competitor
+ * Deletes the competitor together with its social profiles and collected signals.
+ */
+export declare const deleteBrandCompetitor: <ThrowOnError extends boolean = false>(options: Options<DeleteBrandCompetitorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteBrandCompetitorResponses, DeleteBrandCompetitorErrors, ThrowOnError, "fields">;
+/**
+ * Show brand competitor
+ * Returns one competitor of the brand with its social profiles.
+ */
+export declare const getBrandCompetitor: <ThrowOnError extends boolean = false>(options: Options<GetBrandCompetitorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetBrandCompetitorResponses, GetBrandCompetitorErrors, ThrowOnError, "fields">;
+/**
+ * Update brand competitor
+ * Replaces the competitor's details and syncs its social profiles. Optional fields left out are cleared. Profiles sent with an id are updated, profiles without one are added, and profiles left out are deleted.
+ */
+export declare const updateBrandCompetitor: <ThrowOnError extends boolean = false>(options: Options<UpdateBrandCompetitorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<UpdateBrandCompetitorResponses, UpdateBrandCompetitorErrors, ThrowOnError, "fields">;
 /**
  * List brands
  * Retrieve all brand records for the authenticated user's active workspace