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

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

@@ -0,0 +1,1126 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../types.ts';
+
+export namespace Conversations {
+  export namespace Basic {
+    export interface CreateMessageInput {
+      data: Schemas.PublicMessageEgg;
+      threadId: number;
+    }
+
+    export type CreateMessageOutput = Schemas.PublicMessage;
+
+    export interface DeleteAssigneeInput {
+      threadId: number;
+    }
+
+    export type DeleteAssigneeOutput = void;
+
+    export interface DeleteThreadInput {
+      threadId: number;
+    }
+
+    export type DeleteThreadOutput = void;
+
+    export interface GetActorInput {
+      actorId: string;
+      property?: string;
+    }
+
+    export type GetActorOutput = Schemas.PublicActor;
+
+    export interface GetChannelAccountInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      channelAccountId: number;
+    }
+
+    export type GetChannelAccountOutput = Schemas.PublicChannelAccount;
+
+    export interface GetChannelInput {
+      channelId: number;
+    }
+
+    export type GetChannelOutput = Schemas.PublicChannel;
+
+    export interface GetInboxInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      inboxId: number;
+    }
+
+    export type GetInboxOutput = Schemas.PublicInbox;
+
+    export interface GetMessageContentInput {
+      messageId: string;
+      property?: string;
+      threadId: number;
+    }
+
+    export type GetMessageContentOutput = Schemas.PublicMessageContent;
+
+    export interface GetMessageInput {
+      messageId: string;
+      property?: string;
+      threadId: number;
+    }
+
+    export type GetMessageOutput = Schemas.PublicMessage;
+
+    export interface GetMessagesInput {
+      /**
+       * 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;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      property?: string;
+      sort?: string[];
+      threadId: number;
+    }
+
+    export type GetMessagesOutput =
+      Schemas.CollectionResponsePublicMessageForwardPaging;
+
+    export interface GetThreadInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      association?: 'TICKET'[];
+      property?: string;
+      threadId: number;
+    }
+
+    export type GetThreadOutput = Schemas.PublicThread;
+
+    export interface GetThreadsInput {
+      /**
+       * 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;
+      associatedContactId?: number;
+      associatedTicketId?: number;
+      association?: 'TICKET'[];
+      inboxId?: number[];
+      latestMessageTimestampAfter?: string;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      property?: string;
+      sort?: string[];
+      threadStatus?: 'CLOSED' | 'OPEN';
+    }
+
+    export type GetThreadsOutput =
+      Schemas.CollectionResponsePublicThreadForwardPaging;
+
+    export interface ListChannelAccountsInput {
+      /**
+       * 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;
+      inboxId?: number[];
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      sort?: string[];
+    }
+
+    export type ListChannelAccountsOutput =
+      Schemas.CollectionResponseWithTotalPublicChannelAccount;
+
+    export interface ListChannelsInput {
+      /**
+       * 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 ListChannelsOutput =
+      Schemas.CollectionResponseWithTotalPublicChannel;
+
+    export interface ListInboxesInput {
+      /**
+       * 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;
+      defaultPageLength?: number;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      sort?: string[];
+    }
+
+    export type ListInboxesOutput =
+      Schemas.CollectionResponseWithTotalPublicInbox;
+
+    export interface UpdateAssigneeInput {
+      data: Schemas.PublicThreadAssignRequest;
+      threadId: number;
+    }
+
+    export type UpdateAssigneeOutput = Schemas.PublicThread;
+
+    export interface UpdateThreadInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      data: Schemas.PublicThreadUpdateRequest;
+      threadId: number;
+    }
+
+    export type UpdateThreadOutput = Schemas.PublicThread;
+  }
+
+  export namespace Batch {
+    export interface BatchRetrieveActorsInput {
+      data: Schemas.BatchInputString;
+      property?: string;
+    }
+
+    export type BatchRetrieveActorsOutput = Schemas.BatchResponsePublicActor;
+  }
+
+  export namespace Schemas {
+    export interface AgentActor {
+      avatar?: string;
+      email?: string;
+      id: string;
+      name?: string;
+      type: 'AGENT';
+    }
+
+    export interface BatchInputString {
+      inputs: string[];
+    }
+
+    export interface BatchResponsePublicActor {
+      completedAt: string;
+      errors?: Schemas.StandardError[];
+      links?: Record<string, string>;
+      numErrors?: number;
+      requestedAt?: string;
+      results: (
+        | Schemas.AgentActor
+        | Schemas.BotActor
+        | Schemas.IntegratorActor
+        | Schemas.SystemActor
+        | Schemas.VisitorActor
+        | Schemas.EmailActor
+        | Schemas.LlmActor
+      )[];
+      startedAt: string;
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BotActor {
+      avatar?: string;
+      id: string;
+      name?: string;
+      type: 'BOT';
+    }
+
+    export interface CollectionResponsePublicMessageForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: (
+        | Schemas.PublicConversationsMessage
+        | Schemas.PublicComment
+        | Schemas.PublicWelcomeMessage
+        | Schemas.PublicAssignmentMessage
+        | Schemas.PublicThreadStatusChange
+        | Schemas.PublicThreadInboxChange
+      )[];
+    }
+
+    export interface CollectionResponsePublicThreadForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.PublicThread[];
+    }
+
+    export interface CollectionResponseWithTotalPublicChannel {
+      paging?: Schemas.Paging;
+      results: Schemas.PublicChannel[];
+      total: number;
+    }
+
+    export interface CollectionResponseWithTotalPublicChannelAccount {
+      paging?: Schemas.Paging;
+      results: Schemas.PublicChannelAccount[];
+      total: number;
+    }
+
+    export interface CollectionResponseWithTotalPublicInbox {
+      paging?: Schemas.Paging;
+      results: Schemas.PublicInbox[];
+      total: number;
+    }
+
+    export interface ContactAddress {
+      city?: string;
+      country?: string;
+      countryCode?: string;
+      state?: string;
+      street?: string;
+      type?: 'HOME' | 'WORK';
+      zip?: string;
+    }
+
+    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 EmailActor {
+      email: string;
+      id: string;
+      type: 'EMAIL';
+    }
+
+    export interface ErrorDetail {
+      /**
+       * The status code associated with the error detail
+       */
+      code?: string;
+      /**
+       * Context about the error condition
+       */
+      context?: Record<string, string[]>;
+      /**
+       * The name of the field or parameter in which the error was found.
+       */
+      in?: string;
+      /**
+       * A human readable message describing the error along with remediation steps where appropriate
+       */
+      message: string;
+      /**
+       * A specific category that contains more specific detail about the error
+       */
+      subCategory?: string;
+    }
+
+    export interface ForwardPaging {
+      next?: Schemas.NextPage;
+    }
+
+    export interface IntegratorActor {
+      avatar?: string;
+      id: string;
+      name: string;
+      type: 'INTEGRATOR';
+    }
+
+    export interface LlmActor {
+      avatar?: string;
+      id: string;
+      name?: string;
+      type: 'LLM';
+    }
+
+    /**
+     * 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 type PublicActor =
+      | Schemas.AgentActor
+      | Schemas.BotActor
+      | Schemas.IntegratorActor
+      | Schemas.SystemActor
+      | Schemas.VisitorActor
+      | Schemas.EmailActor
+      | Schemas.LlmActor;
+
+    export interface PublicAssignmentMessage {
+      archived: boolean;
+      assignedFrom?: string;
+      assignedTo?: string;
+      client: Schemas.PublicClient;
+      conversationsThreadId: string;
+      createdAt: string;
+      createdBy: string;
+      id: string;
+      recipients: Schemas.PublicRecipient[];
+      senders: Schemas.PublicSender[];
+      type: 'ASSIGNMENT';
+      updatedAt?: string;
+    }
+
+    export interface PublicChannel {
+      /**
+       * The ID of the channel.
+       */
+      id: string;
+      /**
+       * The name of the channel.
+       */
+      name: string;
+    }
+
+    export interface PublicChannelAccount {
+      /**
+       * Whether the channel account is turned on.
+       */
+      active: boolean;
+      archived: boolean;
+      archivedAt?: string;
+      authorized: boolean;
+      /**
+       * The ID of the channel that the channel account is an instance of.
+       */
+      channelId: string;
+      createdAt: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      /**
+       * The ID of the channel account.
+       */
+      id: string;
+      /**
+       * The ID of the conversations inbox that contains the channel account.
+       */
+      inboxId: string;
+      /**
+       * The name of the channel account.
+       */
+      name: string;
+    }
+
+    export interface PublicClient {
+      /**
+       * The type of the client.
+       */
+      clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN';
+      /**
+       * The ID of the client if the client is an integration.
+       */
+      integrationAppId?: number;
+    }
+
+    export interface PublicComment {
+      archived: boolean;
+      attachments: (
+        | Schemas.PublicFile
+        | Schemas.PublicLocation
+        | Schemas.PublicContact
+        | Schemas.PublicUnsupportedContent
+        | Schemas.PublicMessageHeader
+        | Schemas.PublicQuickReplies
+        | Schemas.PublicWhatsAppTemplateMetadata
+        | Schemas.PublicSocialMetadataAttachment
+      )[];
+      client: Schemas.PublicClient;
+      conversationsThreadId: string;
+      createdAt: string;
+      createdBy: string;
+      id: string;
+      recipients: Schemas.PublicRecipient[];
+      richText: string;
+      senders: Schemas.PublicSender[];
+      text: string;
+      type: 'COMMENT';
+      updatedAt?: string;
+    }
+
+    export interface PublicCommentEgg {
+      attachments: (
+        | Schemas.PublicFileEgg
+        | Schemas.PublicQuickRepliesEgg
+        | Schemas.PublicSocialMediaEgg
+      )[];
+      richText?: string;
+      text: string;
+      type: 'COMMENT';
+    }
+
+    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 PublicConversationsMessageEgg {
+      attachments: (
+        | Schemas.PublicFileEgg
+        | Schemas.PublicQuickRepliesEgg
+        | Schemas.PublicSocialMediaEgg
+      )[];
+      channelAccountId: string;
+      channelId: string;
+      recipients: Schemas.PublicRecipientEgg[];
+      richText?: string;
+      senderActorId: string;
+      subject?: string;
+      text: string;
+      type: 'MESSAGE';
+    }
+
+    export interface PublicDeliveryIdentifier {
+      /**
+       * The type of identifier. HS_EMAIL_ADDRESS for email addresses; HS_PHONE_NUMBER for a phone number; CHANNEL_SPECIFIC_OPAQUE_ID for channels that use their own proprietary identifiers, like Facebook Messenger or LiveChat.
+       */
+      type:
+        | 'CHANNEL_SPECIFIC_OPAQUE_ID'
+        | 'HS_EMAIL_ADDRESS'
+        | 'HS_PHONE_NUMBER'
+        | 'HS_SHORT_CODE';
+      /**
+       * A string representation of the PublicDeliveryIdentifier, either an an E.164 phone number, an email address, or a channel-specific identifier.
+       */
+      value: string;
+    }
+
+    export interface PublicFile {
+      fileId: string;
+      fileUsageType:
+        | 'AUDIO'
+        | 'IMAGE'
+        | 'OTHER'
+        | 'STICKER'
+        | 'VOICE_RECORDING';
+      name?: string;
+      type: 'FILE';
+      url?: string;
+    }
+
+    export interface PublicFileEgg {
+      fileId: string;
+      type: 'FILE';
+    }
+
+    export interface PublicInbox {
+      archived: boolean;
+      archivedAt?: string;
+      /**
+       * When the inbox was created.
+       */
+      createdAt: string;
+      /**
+       * The ID of the inbox.
+       */
+      id: string;
+      /**
+       * The name of the inbox.
+       */
+      name: string;
+      /**
+       * Specifies whether this refers to a Conversations Inbox or to the Help Desk. Valid values are INBOX or HELP_DESK
+       */
+      type: 'HELP_DESK' | 'INBOX';
+      updatedAt: string;
+    }
+
+    export interface PublicLocation {
+      address?: string;
+      latitude: number;
+      longitude: number;
+      name?: string;
+      type: 'LOCATION';
+      url?: string;
+    }
+
+    export type PublicMessage =
+      | Schemas.PublicConversationsMessage
+      | Schemas.PublicComment
+      | Schemas.PublicWelcomeMessage
+      | Schemas.PublicAssignmentMessage
+      | Schemas.PublicThreadStatusChange
+      | Schemas.PublicThreadInboxChange;
+
+    export interface PublicMessageContent {
+      richText?: string;
+      text?: string;
+    }
+
+    export type PublicMessageEgg =
+      | Schemas.PublicConversationsMessageEgg
+      | Schemas.PublicCommentEgg;
+
+    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 PublicQuickRepliesEgg {
+      quickReplies: Schemas.QuickReply[];
+      type: 'QUICK_REPLIES';
+    }
+
+    export interface PublicRecipient {
+      actorId?: string;
+      deliveryIdentifier: Schemas.PublicDeliveryIdentifier;
+      name?: string;
+      recipientField?: string;
+    }
+
+    export interface PublicRecipientEgg {
+      actorId?: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      deliveryIdentifiers: Schemas.PublicDeliveryIdentifier[];
+      name?: string;
+      recipientField?: string;
+    }
+
+    export interface PublicSender {
+      actorId?: string;
+      deliveryIdentifier?: Schemas.PublicDeliveryIdentifier;
+      name?: string;
+      senderField?: string;
+    }
+
+    export interface PublicSocialMediaEgg {
+      socialMetadata: Schemas.SocialMetadata;
+      type: 'SOCIAL_MEDIA_METADATA';
+    }
+
+    export interface PublicSocialMetadataAttachment {
+      socialMetadata: Schemas.SocialMetadata;
+      type: 'SOCIAL_MEDIA_METADATA';
+    }
+
+    export interface PublicThread {
+      /**
+       * Whether this thread is archived.
+       */
+      archived: boolean;
+      assignedTo?: string;
+      /**
+       * The ID of the associated Contact in the CRM. If the Contact for the thread has not yet been added or created, the `associatedContactId` returned will be a visitorID and cannot be used to search for the Contact in the CRM.
+       */
+      associatedContactId: string;
+      /**
+       * When the thread was closed. Only set if the thread is closed.
+       */
+      closedAt?: string;
+      /**
+       * When the thread was created.
+       */
+      createdAt: string;
+      /**
+       * The unique ID of the thread.
+       */
+      id: string;
+      /**
+       * The ID of the conversations inbox containing the thread.
+       */
+      inboxId: string;
+      /**
+       * The time that the latest message was sent on the thread.
+       */
+      latestMessageReceivedTimestamp?: string;
+      /**
+       * The time that the latest message was sent on the thread.
+       */
+      latestMessageSentTimestamp?: string;
+      /**
+       * The time that the latest message was sent or received on the thread.
+       */
+      latestMessageTimestamp?: string;
+      originalChannelAccountId: string;
+      originalChannelId: string;
+      /**
+       * Whether the thread is marked as spam.
+       */
+      spam: boolean;
+      /**
+       * The thread's status: `OPEN` or `CLOSED`.
+       */
+      status: 'CLOSED' | 'OPEN';
+      threadAssociations?: Schemas.PublicThreadAssociations;
+    }
+
+    export interface PublicThreadAssignRequest {
+      actorId: string;
+    }
+
+    export interface PublicThreadAssociations {
+      associatedTicketId?: string;
+    }
+
+    export interface PublicThreadInboxChange {
+      archived: boolean;
+      client: Schemas.PublicClient;
+      conversationsThreadId: string;
+      createdAt: string;
+      createdBy: string;
+      fromInboxId: string;
+      id: string;
+      recipients: Schemas.PublicRecipient[];
+      senders: Schemas.PublicSender[];
+      toInboxId: string;
+      type: 'THREAD_INBOX_CHANGE';
+      updatedAt?: string;
+    }
+
+    export interface PublicThreadStatusChange {
+      archived: boolean;
+      client: Schemas.PublicClient;
+      conversationsThreadId: string;
+      createdAt: string;
+      createdBy: string;
+      id: string;
+      newStatus: 'CLOSED' | 'OPEN';
+      recipients: Schemas.PublicRecipient[];
+      senders: Schemas.PublicSender[];
+      type: 'THREAD_STATUS_CHANGE';
+      updatedAt?: string;
+    }
+
+    export interface PublicThreadUpdateRequest {
+      /**
+       * Whether this thread is archived. Set to false to restore the thread.
+       */
+      archived?: boolean;
+      /**
+       * The thread's status: `OPEN` or `CLOSED`.
+       */
+      status?: 'CLOSED' | 'OPEN';
+    }
+
+    export interface PublicUnsupportedContent {
+      type: 'UNSUPPORTED_CONTENT';
+    }
+
+    export interface PublicWelcomeMessage {
+      archived: boolean;
+      channelAccountId: string;
+      channelId: string;
+      client: Schemas.PublicClient;
+      conversationsThreadId: string;
+      createdAt: string;
+      createdBy: string;
+      id: string;
+      recipients: Schemas.PublicRecipient[];
+      richText?: string;
+      senders: Schemas.PublicSender[];
+      text: string;
+      type: 'WELCOME_MESSAGE';
+      updatedAt?: string;
+    }
+
+    export interface PublicWhatsAppTemplateMetadata {
+      contentId?: number;
+      crmObjectIds: Record<string, number>;
+      mappedTemplateId?: number;
+      parameters: Record<string, string>;
+      rootMicId?: number;
+      type: 'WHATSAPP_TEMPLATE_METADATA';
+    }
+
+    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;
+    }
+
+    /**
+     * Ye olde error
+     */
+    export interface StandardError {
+      /**
+       * The main category of the error.
+       */
+      category: string;
+      /**
+       * Context about the error condition
+       */
+      context: Record<string, string[]>;
+      /**
+       * The detailed error objects.
+       */
+      errors: Schemas.ErrorDetail[];
+      /**
+       * A unique ID for the error instance.
+       */
+      id?: string;
+      /**
+       * URLs linking to documentation or resources associated with the error.
+       */
+      links: Record<string, string>;
+      /**
+       * A human readable message describing the error along with remediation steps where appropriate
+       */
+      message: string;
+      /**
+       * The HTTP status code associated with the error.
+       */
+      status: string;
+      /**
+       * A specific category that contains more specific detail about the error
+       */
+      subCategory?: Record<string, never>;
+    }
+
+    export interface SystemActor {
+      id: string;
+      type: 'SYSTEM';
+    }
+
+    export interface VisitorActor {
+      avatar?: string;
+      email?: string;
+      id: string;
+      name?: string;
+      type: 'VISITOR';
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversations } from '@hubspot/api-client-core';
+   * client.send(conversations.basic.createMessage(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Create message
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}/messages
+     * @apiMethod POST
+     * @requiredScopes conversations.write
+     */
+    createMessage: (
+      input: Basic.CreateMessageInput
+    ) => Operation<Basic.CreateMessageOutput>;
+    /**
+     * Delete Assignee
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}/assignee
+     * @apiMethod DELETE
+     * @requiredScopes conversations.write
+     */
+    deleteAssignee: (
+      input: Basic.DeleteAssigneeInput
+    ) => Operation<Basic.DeleteAssigneeOutput>;
+    /**
+     * Delete thread
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}
+     * @apiMethod DELETE
+     * @requiredScopes conversations.write
+     */
+    deleteThread: (
+      input: Basic.DeleteThreadInput
+    ) => Operation<Basic.DeleteThreadOutput>;
+    /**
+     * Retrieve actor
+     * @apiPath /conversations/conversations/2026-09-beta/actors/{actorId}
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getActor: (input: Basic.GetActorInput) => Operation<Basic.GetActorOutput>;
+    /**
+     * Retrieve channel
+     * @apiPath /conversations/conversations/2026-09-beta/channels/{channelId}
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getChannel: (
+      input: Basic.GetChannelInput
+    ) => Operation<Basic.GetChannelOutput>;
+    /**
+     * Retrieve channel account
+     * @apiPath /conversations/conversations/2026-09-beta/channel-accounts/{channelAccountId}
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getChannelAccount: (
+      input: Basic.GetChannelAccountInput
+    ) => Operation<Basic.GetChannelAccountOutput>;
+    /**
+     * Retrieve inbox
+     * @apiPath /conversations/conversations/2026-09-beta/inboxes/{inboxId}
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getInbox: (input: Basic.GetInboxInput) => Operation<Basic.GetInboxOutput>;
+    /**
+     * Retrieve message
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}/messages/{messageId}
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getMessage: (
+      input: Basic.GetMessageInput
+    ) => Operation<Basic.GetMessageOutput>;
+    /**
+     * Retrieve message content
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}/messages/{messageId}/original-content
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getMessageContent: (
+      input: Basic.GetMessageContentInput
+    ) => Operation<Basic.GetMessageContentOutput>;
+    /**
+     * Retrieve messages
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}/messages
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getMessages: (
+      input: Basic.GetMessagesInput
+    ) => Operation<Basic.GetMessagesOutput>;
+    /**
+     * Retrieve thread
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getThread: (
+      input: Basic.GetThreadInput
+    ) => Operation<Basic.GetThreadOutput>;
+    /**
+     * Retrieve threads
+     * @apiPath /conversations/conversations/2026-09-beta/threads
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    getThreads: (
+      input?: Basic.GetThreadsInput
+    ) => Operation<Basic.GetThreadsOutput>;
+    /**
+     * List channel accounts
+     * @apiPath /conversations/conversations/2026-09-beta/channel-accounts
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    listChannelAccounts: (
+      input?: Basic.ListChannelAccountsInput
+    ) => Operation<Basic.ListChannelAccountsOutput>;
+    /**
+     * List Channels
+     * @apiPath /conversations/conversations/2026-09-beta/channels
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    listChannels: (
+      input?: Basic.ListChannelsInput
+    ) => Operation<Basic.ListChannelsOutput>;
+    /**
+     * List inboxes
+     * @apiPath /conversations/conversations/2026-09-beta/inboxes
+     * @apiMethod GET
+     * @requiredScopes conversations.read
+     */
+    listInboxes: (
+      input?: Basic.ListInboxesInput
+    ) => Operation<Basic.ListInboxesOutput>;
+    /**
+     * Update assignee
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}/assignee
+     * @apiMethod PUT
+     * @requiredScopes conversations.write
+     */
+    updateAssignee: (
+      input: Basic.UpdateAssigneeInput
+    ) => Operation<Basic.UpdateAssigneeOutput>;
+    /**
+     * Update thread
+     * @apiPath /conversations/conversations/2026-09-beta/threads/{threadId}
+     * @apiMethod PATCH
+     * @requiredScopes conversations.write
+     */
+    updateThread: (
+      input: Basic.UpdateThreadInput
+    ) => Operation<Basic.UpdateThreadOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversations } from '@hubspot/api-client-core';
+   * client.send(conversations.batch.batchRetrieveActors(input));
+   * ```
+   */
+  export interface BatchAPI {
+    /**
+     * Batch retrieve actors
+     * @apiPath /conversations/conversations/2026-09-beta/actors/batch/read
+     * @apiMethod POST
+     * @requiredScopes conversations.read
+     */
+    batchRetrieveActors: (
+      input: Batch.BatchRetrieveActorsInput
+    ) => Operation<Batch.BatchRetrieveActorsOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { conversations } from '@hubspot/api-client-core';
+   * client.send(conversations.basic.createMessage(input));
+   * ```
+   */
+  export interface API {
+    basic: BasicAPI;
+    batch: BatchAPI;
+  }
+}