@hubspot/app-connect-sdk 1.0.0-alpha.1

package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts

@@ -0,0 +1,687 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace ConversationsCustomChannels {
+  export namespace Basic {
+    export type CreateInput = Schemas.PublicChannelIntegrationChannelCreate;
+
+    export type CreateOutput = Schemas.PublicChannelIntegrationChannel;
+
+    export interface ListInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      defaultPageLength?: number;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      sort?: string[];
+    }
+
+    export type ListOutput =
+      Schemas.CollectionResponseWithTotalPublicChannelIntegrationChannel;
+  }
+
+  export namespace ChannelAccounts {
+    export interface CreateInput {
+      channelId: number;
+      data: Schemas.PublicChannelAccountEgg;
+    }
+
+    export type CreateOutput = Schemas.PublicChannelAccount;
+
+    export interface ListInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      channelId: number;
+      defaultPageLength?: number;
+      deliveryIdentifierType?: (
+        | 'CHANNEL_SPECIFIC_OPAQUE_ID'
+        | 'HS_EMAIL_ADDRESS'
+        | 'HS_PHONE_NUMBER'
+        | 'HS_SHORT_CODE'
+      )[];
+      deliveryIdentifierValue?: string[];
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      sort?: string[];
+    }
+
+    export type ListOutput =
+      Schemas.CollectionResponseWithTotalPublicChannelAccount;
+
+    export interface UpdateInput {
+      channelAccountId: number;
+      channelId: number;
+      data: Schemas.PublicChannelAccountUpdateRequest;
+    }
+
+    export type UpdateOutput = Schemas.PublicChannelAccount;
+
+    export interface UpdateStagingTokenInput {
+      accountToken: string;
+      channelId: number;
+      data: Schemas.PublicChannelAccountStagingTokenUpdateRequest;
+    }
+
+    export type UpdateStagingTokenOutput =
+      Schemas.PublicChannelAccountStagingToken;
+  }
+
+  export namespace Channels {
+    export interface DeleteInput {
+      channelId: number;
+    }
+
+    export type DeleteOutput = void;
+
+    export interface Get2Input {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      channelAccountId: number;
+      channelId: number;
+    }
+
+    export type Get2Output = Schemas.PublicChannelAccount;
+
+    export interface GetInput {
+      channelId: number;
+    }
+
+    export type GetOutput = Schemas.PublicChannelIntegrationChannel;
+
+    export interface UpdateInput {
+      channelId: number;
+      data: Schemas.PublicChannelIntegrationChannelPatch;
+    }
+
+    export type UpdateOutput = Schemas.PublicChannelIntegrationChannel;
+  }
+
+  export namespace Messages {
+    export interface CreateInput {
+      channelId: number;
+      data: Schemas.ChannelIntegrationMessageEgg;
+    }
+
+    export type CreateOutput = Schemas.PublicConversationsMessage;
+
+    export interface GetInput {
+      channelId: number;
+      messageId: string;
+    }
+
+    export type GetOutput = Schemas.PublicConversationsMessage;
+
+    export interface UpdateInput {
+      channelId: number;
+      data: Schemas.PublicChannelIntegrationMessageUpdateRequest;
+      messageId: string;
+    }
+
+    export type UpdateOutput = Schemas.PublicConversationsMessage;
+  }
+
+  export namespace Schemas {
+    export interface ChannelIntegrationMessageEgg {
+      associateWithContactId?: number;
+      attachments: (
+        | Schemas.FileAttachment
+        | Schemas.LocationAttachment
+        | Schemas.ContactAttachment
+        | Schemas.UnsupportedContentAttachment
+        | Schemas.MessageHeaderAttachment
+        | Schemas.QuickRepliesAttachment
+        | Schemas.SocialMetadataIntegrationAttachment
+      )[];
+      channelAccountId: string;
+      inReplyToId?: string;
+      integrationIdempotencyId?: string;
+      integrationThreadId?: string;
+      messageDirection: 'INCOMING' | 'OUTGOING';
+      recipients: Schemas.ChannelIntegrationParticipant[];
+      richText?: string;
+      senders: Schemas.ChannelIntegrationParticipant[];
+      text: string;
+      timestamp: string;
+    }
+
+    export interface ChannelIntegrationParticipant {
+      deliveryIdentifier: Schemas.PublicDeliveryIdentifier;
+      name?: string;
+      senderActorId?: string;
+    }
+
+    export interface CollectionResponseWithTotalPublicChannelAccount {
+      paging?: Schemas.Paging;
+      results: Schemas.PublicChannelAccount[];
+      total: number;
+    }
+
+    export interface CollectionResponseWithTotalPublicChannelIntegrationChannel {
+      paging?: Schemas.Paging;
+      results: Schemas.PublicChannelIntegrationChannel[];
+      total: number;
+    }
+
+    export interface ContactAddress {
+      city?: string;
+      country?: string;
+      countryCode?: string;
+      state?: string;
+      street?: string;
+      type?: 'HOME' | 'WORK';
+      zip?: string;
+    }
+
+    export interface ContactAttachment {
+      contactProfile: Schemas.ContactProfile;
+      type: 'CONTACT';
+    }
+
+    export interface ContactEmail {
+      email: string;
+      type?: 'HOME' | 'WORK';
+    }
+
+    export interface ContactName {
+      firstName?: string;
+      lastName?: string;
+      middleName?: string;
+      prefix?: string;
+      suffix?: string;
+    }
+
+    export interface ContactOrg {
+      company?: string;
+      department?: string;
+      title?: string;
+    }
+
+    export interface ContactPhone {
+      phone: string;
+      type?: 'CELL' | 'HOME' | 'MAIN' | 'WORK';
+    }
+
+    export interface ContactProfile {
+      addresses: Schemas.ContactAddress[];
+      emails: Schemas.ContactEmail[];
+      name?: Schemas.ContactName;
+      org?: Schemas.ContactOrg;
+      phones: Schemas.ContactPhone[];
+      urls: Schemas.ContactUrl[];
+    }
+
+    export interface ContactUrl {
+      type?: 'HOME' | 'WORK';
+      url: string;
+    }
+
+    export interface FileAttachment {
+      fileId: string;
+      fileUsageType?:
+        | 'AUDIO'
+        | 'IMAGE'
+        | 'OTHER'
+        | 'STICKER'
+        | 'VOICE_RECORDING';
+      type: 'FILE';
+    }
+
+    export interface LocationAttachment {
+      address?: string;
+      latitude: number;
+      longitude: number;
+      name?: string;
+      type: 'LOCATION';
+      url?: string;
+    }
+
+    export interface MessageHeaderAttachment {
+      fileId?: number;
+      text?: string;
+      type: 'MESSAGE_HEADER';
+    }
+
+    /**
+     * Specifies the paging information needed to retrieve the next set of results in a paginated API response
+     */
+    export interface NextPage {
+      /**
+       * A paging cursor token for retrieving subsequent pages.
+       */
+      after: string;
+      /**
+       * A URL that can be used to retrieve the next page results.
+       */
+      link?: string;
+    }
+
+    export interface Paging {
+      next?: Schemas.NextPage;
+      prev?: Schemas.PreviousPage;
+    }
+
+    /**
+     * specifies the paging information needed to retrieve the previous set of results in a paginated API response
+     */
+    export interface PreviousPage {
+      /**
+       * A paging cursor token for retrieving previous pages.
+       */
+      before: string;
+      /**
+       * A URL that can be used to retrieve the previous pages' results.
+       */
+      link?: string;
+    }
+
+    export interface PublicChannelAccount {
+      active: boolean;
+      archived: boolean;
+      archivedAt?: string;
+      authorized: boolean;
+      channelId: string;
+      createdAt: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      id: string;
+      inboxId: string;
+      name: string;
+    }
+
+    export interface PublicChannelAccountEgg {
+      authorized: boolean;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      inboxId: string;
+      name: string;
+    }
+
+    export interface PublicChannelAccountStagingToken {
+      accountName?: string;
+      accountToken: string;
+      createdAt: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      genericChannelId: number;
+      inboxId: number;
+      userId: number;
+    }
+
+    export interface PublicChannelAccountStagingTokenUpdateRequest {
+      accountName?: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+    }
+
+    export interface PublicChannelAccountUpdateRequest {
+      authorized?: boolean;
+      name?: string;
+    }
+
+    export interface PublicChannelIntegrationChannel {
+      capabilities: Record<string, Record<string, never>>;
+      channelAccountConnectionRedirectUrl?: string;
+      channelDescription?: string;
+      channelLogoUrl?: string;
+      createdAt: string;
+      id: string;
+      name: string;
+      webhookUrl?: string;
+    }
+
+    export interface PublicChannelIntegrationChannelCreate {
+      capabilities: Record<string, Record<string, never>>;
+      channelAccountConnectionRedirectUrl?: string;
+      channelDescription?: string;
+      channelLogoUrl?: string;
+      name: string;
+      webhookUrl?: string;
+    }
+
+    export interface PublicChannelIntegrationChannelPatch {
+      capabilities: Record<string, Record<string, never>>;
+      channelAccountConnectionRedirectUrl: Record<string, never>;
+      channelDescription: Record<string, never>;
+      channelLogoUrl: Record<string, never>;
+      name: Record<string, never>;
+      webhookUrl: Record<string, never>;
+    }
+
+    export interface PublicChannelIntegrationMessageUpdateRequest {
+      errorMessage?: string;
+      /**
+       * Valid status are SENT, FAILED, and READ
+       */
+      statusType: 'FAILED' | 'READ' | 'SENT';
+    }
+
+    export interface PublicClient {
+      clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN';
+      integrationAppId?: number;
+    }
+
+    export interface PublicContact {
+      contactProfile: Schemas.ContactProfile;
+      type: 'CONTACT';
+    }
+
+    export interface PublicConversationsMessage {
+      archived: boolean;
+      attachments: (
+        | Schemas.PublicFile
+        | Schemas.PublicLocation
+        | Schemas.PublicContact
+        | Schemas.PublicUnsupportedContent
+        | Schemas.PublicMessageHeader
+        | Schemas.PublicQuickReplies
+        | Schemas.PublicWhatsAppTemplateMetadata
+        | Schemas.PublicSocialMetadataAttachment
+      )[];
+      channelAccountId: string;
+      channelId: string;
+      client: Schemas.PublicClient;
+      conversationsThreadId: string;
+      createdAt: string;
+      createdBy: string;
+      direction: 'INCOMING' | 'OUTGOING';
+      id: string;
+      inReplyToId?: string;
+      recipients: Schemas.PublicRecipient[];
+      richText?: string;
+      senders: Schemas.PublicSender[];
+      status?: Schemas.PublicMessageStatus;
+      subject?: string;
+      text: string;
+      truncationStatus:
+        | 'NOT_TRUNCATED'
+        | 'TRUNCATED'
+        | 'TRUNCATED_TO_MOST_RECENT_REPLY';
+      type: 'MESSAGE';
+      updatedAt?: string;
+    }
+
+    export interface PublicDeliveryIdentifier {
+      type:
+        | 'CHANNEL_SPECIFIC_OPAQUE_ID'
+        | 'HS_EMAIL_ADDRESS'
+        | 'HS_PHONE_NUMBER'
+        | 'HS_SHORT_CODE';
+      value: string;
+    }
+
+    export interface PublicFile {
+      fileId: string;
+      fileUsageType:
+        | 'AUDIO'
+        | 'IMAGE'
+        | 'OTHER'
+        | 'STICKER'
+        | 'VOICE_RECORDING';
+      name?: string;
+      type: 'FILE';
+      url?: string;
+    }
+
+    export interface PublicLocation {
+      address?: string;
+      latitude: number;
+      longitude: number;
+      name?: string;
+      type: 'LOCATION';
+      url?: string;
+    }
+
+    export interface PublicMessageFailureDetails {
+      errorMessage?: string;
+      errorMessageTokens: Record<string, string>;
+    }
+
+    export interface PublicMessageHeader {
+      fileId?: number;
+      text?: string;
+      type: 'MESSAGE_HEADER';
+    }
+
+    export interface PublicMessageStatus {
+      failureDetails?: Schemas.PublicMessageFailureDetails;
+      statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT';
+    }
+
+    export interface PublicQuickReplies {
+      allowMultiSelect: boolean;
+      allowUserInput: boolean;
+      quickReplies: Schemas.QuickReply[];
+      type: 'QUICK_REPLIES';
+    }
+
+    export interface PublicRecipient {
+      actorId?: string;
+      deliveryIdentifier: Schemas.PublicDeliveryIdentifier;
+      name?: string;
+      recipientField?: string;
+    }
+
+    export interface PublicSender {
+      actorId?: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      name?: string;
+      senderField?: string;
+    }
+
+    export interface PublicSocialMetadataAttachment {
+      socialMetadata: Schemas.SocialMetadata;
+      type: 'SOCIAL_MEDIA_METADATA';
+    }
+
+    export interface PublicUnsupportedContent {
+      type: 'UNSUPPORTED_CONTENT';
+    }
+
+    export interface PublicWhatsAppTemplateMetadata {
+      contentId?: number;
+      crmObjectIds: Record<string, number>;
+      mappedTemplateId?: number;
+      parameters: Record<string, string>;
+      rootMicId?: number;
+      type: 'WHATSAPP_TEMPLATE_METADATA';
+    }
+
+    export interface QuickRepliesAttachment {
+      quickReplies: Schemas.QuickReply[];
+      type: 'QUICK_REPLIES';
+    }
+
+    export interface QuickReply {
+      label?: string;
+      value: string;
+      valueType: 'TEXT' | 'URL';
+    }
+
+    export interface SocialMetadata {
+      description?: string;
+      id?: string;
+      mediaTitle?: string;
+      mediaType:
+        | 'ARTICLE'
+        | 'AUDIO'
+        | 'CAROUSEL'
+        | 'DOCUMENT'
+        | 'GIF'
+        | 'LINK'
+        | 'NONE'
+        | 'PHOTO'
+        | 'POLL'
+        | 'STORY'
+        | 'VIDEO';
+      mediaUrl?: string;
+      mediaUrlString?: string;
+      thumbnailUrl?: string;
+    }
+
+    export interface SocialMetadataIntegrationAttachment {
+      socialMetadata: Schemas.SocialMetadata;
+      type: 'SOCIAL_MEDIA_METADATA';
+    }
+
+    export interface UnsupportedContentAttachment {
+      type: 'UNSUPPORTED_CONTENT';
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversationsCustomChannels } from '@hubspot/api-client-core';
+   * client.send(conversationsCustomChannels.basic.create(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * @apiPath /conversations/custom-channels/2026-03
+     * @apiMethod POST
+     */
+    create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
+    /**
+     * @apiPath /conversations/custom-channels/2026-03
+     * @apiMethod GET
+     */
+    list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversationsCustomChannels } from '@hubspot/api-client-core';
+   * client.send(conversationsCustomChannels.channelAccounts.create(input));
+   * ```
+   */
+  export interface ChannelAccountsAPI {
+    /**
+     * Create a channel account
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/channel-accounts
+     * @apiMethod POST
+     * @requiredScopes channel-integration-read, channel-integration-write
+     */
+    create: (
+      input: ChannelAccounts.CreateInput
+    ) => Operation<ChannelAccounts.CreateOutput>;
+    /**
+     * Get accounts for a channel
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/channel-accounts
+     * @apiMethod GET
+     * @requiredScopes channel-integration-read, channel-integration-write
+     */
+    list: (
+      input: ChannelAccounts.ListInput
+    ) => Operation<ChannelAccounts.ListOutput>;
+    /**
+     * Update a channel account
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}
+     * @apiMethod PATCH
+     * @requiredScopes channel-integration-read, channel-integration-write
+     */
+    update: (
+      input: ChannelAccounts.UpdateInput
+    ) => Operation<ChannelAccounts.UpdateOutput>;
+    /**
+     * Update a channel account staging token
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}
+     * @apiMethod PATCH
+     * @requiredScopes channel-integration-read, channel-integration-write
+     */
+    updateStagingToken: (
+      input: ChannelAccounts.UpdateStagingTokenInput
+    ) => Operation<ChannelAccounts.UpdateStagingTokenOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversationsCustomChannels } from '@hubspot/api-client-core';
+   * client.send(conversationsCustomChannels.channels.delete(input));
+   * ```
+   */
+  export interface ChannelsAPI {
+    /**
+     * Archive a custom channel
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}
+     * @apiMethod DELETE
+     */
+    delete: (input: Channels.DeleteInput) => Operation<Channels.DeleteOutput>;
+    /**
+     * Get a custom channel
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}
+     * @apiMethod GET
+     */
+    get: (input: Channels.GetInput) => Operation<Channels.GetOutput>;
+    /**
+     * Get a channel account by id
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}
+     * @apiMethod GET
+     * @requiredScopes channel-integration-read, channel-integration-write
+     */
+    get2: (input: Channels.Get2Input) => Operation<Channels.Get2Output>;
+    /**
+     * Update a custom channel
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}
+     * @apiMethod PATCH
+     */
+    update: (input: Channels.UpdateInput) => Operation<Channels.UpdateOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversationsCustomChannels } from '@hubspot/api-client-core';
+   * client.send(conversationsCustomChannels.messages.create(input));
+   * ```
+   */
+  export interface MessagesAPI {
+    /**
+     * Publish a message
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/messages
+     * @apiMethod POST
+     * @requiredScopes channel-integration-write
+     */
+    create: (input: Messages.CreateInput) => Operation<Messages.CreateOutput>;
+    /**
+     * Get a message
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/messages/{messageId}
+     * @apiMethod GET
+     * @requiredScopes channel-integration-read
+     */
+    get: (input: Messages.GetInput) => Operation<Messages.GetOutput>;
+    /**
+     * Update a message
+     * @apiPath /conversations/custom-channels/2026-03/{channelId}/messages/{messageId}
+     * @apiMethod PATCH
+     * @requiredScopes channel-integration-write
+     */
+    update: (input: Messages.UpdateInput) => Operation<Messages.UpdateOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversationsCustomChannels } from '@hubspot/api-client-core';
+   * client.send(conversationsCustomChannels.basic.create(input));
+   * ```
+   */
+  export interface API {
+    basic: BasicAPI;
+    channelAccounts: ChannelAccountsAPI;
+    channels: ChannelsAPI;
+    messages: MessagesAPI;
+  }
+}