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

package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts

@@ -0,0 +1,893 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace CommunicationPreferencesSubscriptions {
+  export namespace Batch {
+    export interface GetUnsubscribeAllStatusesInput {
+      /**
+       * The ID of the business unit to filter the results. This is an optional parameter.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel to filter the unsubscribe statuses. This parameter is required and currently supports 'EMAIL' as a valid value.
+       */
+      channel: 'EMAIL';
+      data: Schemas.BatchInputString;
+    }
+
+    export type GetUnsubscribeAllStatusesOutput =
+      Schemas.BatchResponsePublicWideStatusBulkResponse;
+
+    export interface ReadInput {
+      /**
+       * An optional integer representing the business unit ID. This parameter helps to filter the results based on the specific business unit.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel to filter the subscription statuses. Must be 'EMAIL'.
+       */
+      channel: 'EMAIL';
+      data: Schemas.BatchInputString;
+    }
+
+    export type ReadOutput = Schemas.BatchResponsePublicStatusBulkResponse;
+
+    export interface UnsubscribeAllInput {
+      /**
+       * An optional integer representing the business unit ID for which the operation is being performed.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel from which subscribers will be unsubscribed. This parameter is required and currently supports only 'EMAIL'.
+       */
+      channel: 'EMAIL';
+      data: Schemas.BatchInputString;
+      /**
+       * A boolean indicating whether to include detailed information in the response. Defaults to false.
+       */
+      verbose?: boolean;
+    }
+
+    export type UnsubscribeAllOutput =
+      Schemas.BatchResponsePublicBulkOptOutFromAllResponse;
+
+    export type UpdateStatusesInput = Schemas.BatchInputPublicStatusRequest;
+
+    export type UpdateStatusesOutput = Schemas.BatchResponsePublicStatus;
+  }
+
+  export namespace Definitions {
+    export interface ListInput {
+      /**
+       * An integer representing the ID of the business unit for which to retrieve subscription definitions.
+       */
+      businessUnitId?: number;
+      /**
+       * A boolean indicating whether to include translations of the communication preferences definitions in the response.
+       */
+      includeTranslations?: boolean;
+    }
+
+    export type ListOutput =
+      Schemas.ActionResponseWithResultsSubscriptionDefinition;
+
+    export interface UnsubscribeAllInput {
+      /**
+       * The ID of the business unit associated with the request. This is an optional integer parameter.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel to unsubscribe from. Must be 'EMAIL'.
+       */
+      channel: 'EMAIL';
+      /**
+       * The unique identifier of the subscriber to unsubscribe from all communication preferences.
+       */
+      subscriberIdString: string;
+      /**
+       * A boolean indicating whether to include detailed information in the response. Defaults to false.
+       */
+      verbose?: boolean;
+    }
+
+    export type UnsubscribeAllOutput =
+      Schemas.ActionResponseWithResultsPublicStatus;
+  }
+
+  export namespace Schemas {
+    export interface ActionResponseWithResultsPublicStatus {
+      /**
+       * The date and time when the operation was completed.
+       */
+      completedAt: string;
+      /**
+       * A list of errors that occurred during the operation.
+       */
+      errors?: Schemas.StandardError[];
+      /**
+       * Contains URLs related to the response, such as documentation or resources.
+       */
+      links?: Record<string, string>;
+      /**
+       * The number of errors that occurred during the operation.
+       */
+      numErrors?: number;
+      /**
+       * The date and time when the request was made.
+       */
+      requestedAt?: string;
+      /**
+       * An array of results from the operation.
+       */
+      results: Schemas.PublicStatus[];
+      /**
+       * The date and time when the operation started.
+       */
+      startedAt: string;
+      /**
+       * Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface ActionResponseWithResultsPublicWideStatus {
+      /**
+       * The date and time when the operation was completed.
+       */
+      completedAt: string;
+      /**
+       * An array of error objects detailing any issues encountered during the operation.
+       */
+      errors?: Schemas.StandardError[];
+      /**
+       * An object containing related links, where each key is a link name and each value is a URL.
+       */
+      links?: Record<string, string>;
+      /**
+       * The number of errors encountered during the operation.
+       */
+      numErrors?: number;
+      /**
+       * The date and time when the request was made.
+       */
+      requestedAt?: string;
+      /**
+       * An array containing the results of the operation.
+       */
+      results: Schemas.PublicWideStatus[];
+      /**
+       * The date and time when the operation started.
+       */
+      startedAt: string;
+      /**
+       * The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface ActionResponseWithResultsSubscriptionDefinition {
+      /**
+       * The date and time when the operation was completed.
+       */
+      completedAt: string;
+      /**
+       * An array of errors that occurred during the operation.
+       */
+      errors?: Schemas.StandardError[];
+      /**
+       * A collection of related links associated with the operation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The number of errors encountered during the operation.
+       */
+      numErrors?: number;
+      /**
+       * The date and time when the operation was requested.
+       */
+      requestedAt?: string;
+      /**
+       * An array containing the results of the operation.
+       */
+      results: Schemas.SubscriptionDefinition[];
+      /**
+       * The date and time when the operation started.
+       */
+      startedAt: string;
+      /**
+       * The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BatchInputPublicStatusRequest {
+      /**
+       * An array of PublicStatusRequest objects, each representing a subscription status update request. This property is required.
+       */
+      inputs: Schemas.PublicStatusRequest[];
+    }
+
+    export interface BatchInputString {
+      /**
+       * A list of strings representing the inputs for batch operations.
+       */
+      inputs: string[];
+    }
+
+    export interface BatchResponsePublicBulkOptOutFromAllResponse {
+      /**
+       * The date and time when the bulk opt-out operation was completed.
+       */
+      completedAt: string;
+      /**
+       * An array of error objects detailing any issues encountered during the bulk opt-out operation.
+       */
+      errors?: Schemas.StandardError[];
+      /**
+       * A collection of URLs linking to related resources or documentation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The total number of errors encountered during the bulk opt-out operation.
+       */
+      numErrors?: number;
+      /**
+       * The date and time when the bulk opt-out request was made.
+       */
+      requestedAt?: string;
+      /**
+       * An array containing the results of the bulk opt-out from all communications operation.
+       */
+      results: Schemas.PublicBulkOptOutFromAllResponse[];
+      /**
+       * The date and time when the bulk opt-out operation began.
+       */
+      startedAt: string;
+      /**
+       * The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BatchResponsePublicStatus {
+      /**
+       * The date and time when the batch operation was completed.
+       */
+      completedAt: string;
+      /**
+       * An array of error objects detailing any issues encountered.
+       */
+      errors?: Schemas.StandardError[];
+      /**
+       * URLs linking to related resources or documentation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The number of errors encountered during the batch operation.
+       */
+      numErrors?: number;
+      /**
+       * The date and time when the request was made.
+       */
+      requestedAt?: string;
+      /**
+       * An array containing the results of the batch operation.
+       */
+      results: Schemas.PublicStatus[];
+      /**
+       * The date and time when the batch operation started.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BatchResponsePublicStatusBulkResponse {
+      /**
+       * The date and time when the batch process was completed.
+       */
+      completedAt: string;
+      /**
+       * A collection of related links associated with the batch response.
+       */
+      links?: Record<string, string>;
+      /**
+       * The date and time when the batch request was made.
+       */
+      requestedAt?: string;
+      /**
+       * The array of results from the batch process, each containing subscription status information.
+       */
+      results: Schemas.PublicStatusBulkResponse[];
+      /**
+       * The date and time when the batch process began.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BatchResponsePublicWideStatusBulkResponse {
+      /**
+       * The date and time when the batch process was completed.
+       */
+      completedAt: string;
+      /**
+       * A collection of related links associated with the batch response.
+       */
+      links?: Record<string, string>;
+      /**
+       * The date and time when the batch request was made.
+       */
+      requestedAt?: string;
+      /**
+       * The array of results from the batch process, each containing subscription status information.
+       */
+      results: Schemas.PublicWideStatusBulkResponse[];
+      /**
+       * The date and time when the batch process began.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    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 LinkGenerationRequest {
+      /**
+       * The language in which the generated link should be presented, represented as a string.
+       */
+      language?: string;
+      /**
+       * A string representing the unique identifier of the subscriber. This property is required.
+       */
+      subscriberIdString: string;
+      /**
+       * The unique identifier for the subscription, represented as an integer in int64 format.
+       */
+      subscriptionId?: number;
+    }
+
+    export interface LinkGenerationResponse {
+      /**
+       * The URL where the subscriber can manage their communication preferences.
+       */
+      managePreferencesUrl: string;
+      /**
+       * A string representing the unique identifier of the subscriber.
+       */
+      subscriberIdString: string;
+      /**
+       * A string containing the URL for unsubscribing the subscriber from all communications.
+       */
+      unsubscribeAllUrl: string;
+      /**
+       * A string containing the URL to unsubscribe the subscriber from a single communication.
+       */
+      unsubscribeSingleUrl?: string;
+    }
+
+    export interface PartialPublicStatusRequest {
+      /**
+       * The type of communication channel, with 'EMAIL' as the only supported option.
+       */
+      channel: 'EMAIL';
+      /**
+       * The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
+       */
+      legalBasis?:
+        | 'CONSENT_WITH_NOTICE'
+        | 'LEGITIMATE_INTEREST_CLIENT'
+        | 'LEGITIMATE_INTEREST_OTHER'
+        | 'LEGITIMATE_INTEREST_PQL'
+        | 'NON_GDPR'
+        | 'PERFORMANCE_OF_CONTRACT'
+        | 'PROCESS_AND_STORE';
+      /**
+       * An explanation for the legal basis used for communication.
+       */
+      legalBasisExplanation?: string;
+      /**
+       * The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
+       */
+      statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+      /**
+       * The unique identifier of the subscription to be updated.
+       */
+      subscriptionId: number;
+    }
+
+    export interface PublicBulkOptOutFromAllResponse {
+      /**
+       * An array of subscription status objects for the contact.
+       */
+      statuses?: Schemas.PublicStatus[];
+      /**
+       * The email address of the contact.
+       */
+      subscriberIdString: string;
+    }
+
+    export interface PublicStatus {
+      /**
+       * The ID of the business unit associated with the subscription.
+       */
+      businessUnitId?: number;
+      /**
+       * The type of communication channel, with 'EMAIL' as the only supported option.
+       */
+      channel: 'EMAIL';
+      /**
+       * The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
+       */
+      legalBasis?:
+        | 'CONSENT_WITH_NOTICE'
+        | 'LEGITIMATE_INTEREST_CLIENT'
+        | 'LEGITIMATE_INTEREST_OTHER'
+        | 'LEGITIMATE_INTEREST_PQL'
+        | 'NON_GDPR'
+        | 'PERFORMANCE_OF_CONTRACT'
+        | 'PROCESS_AND_STORE';
+      /**
+       * An explanation for the legal basis used for communication.
+       */
+      legalBasisExplanation?: string;
+      /**
+       * The reason for the successful change in subscription status, such as 'RESUBSCRIBE_OCCURRED' or 'NO_STATUS_CHANGE'.
+       */
+      setStatusSuccessReason?:
+        | 'NO_STATUS_CHANGE'
+        | 'REQUESTED_CHANGE_OCCURRED'
+        | 'RESUBSCRIBE_OCCURRED'
+        | 'UNSUBSCRIBE_FROM_ALL_OCCURRED';
+      /**
+       * The origin or method through which the subscription status was set.
+       */
+      source: string;
+      /**
+       * The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
+       */
+      status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+      /**
+       * The contact's email address.
+       */
+      subscriberIdString: string;
+      /**
+       * The unique identifier of the subscription.
+       */
+      subscriptionId: number;
+      /**
+       * The name of the subscription.
+       */
+      subscriptionName?: string;
+      /**
+       * The date and time when the subscription status was last updated.
+       */
+      timestamp: string;
+    }
+
+    export interface PublicStatusBulkResponse {
+      /**
+       * An array of subscription status objects for the contact.
+       */
+      statuses: Schemas.PublicStatus[];
+      /**
+       * The email address of the contact.
+       */
+      subscriberIdString: string;
+    }
+
+    export interface PublicStatusRequest {
+      /**
+       * The type of communication channel. Currently, only `EMAIL` is supported.
+       */
+      channel: 'EMAIL';
+      /**
+       * The legal basis for communication.
+       */
+      legalBasis?:
+        | 'CONSENT_WITH_NOTICE'
+        | 'LEGITIMATE_INTEREST_CLIENT'
+        | 'LEGITIMATE_INTEREST_OTHER'
+        | 'LEGITIMATE_INTEREST_PQL'
+        | 'NON_GDPR'
+        | 'PERFORMANCE_OF_CONTRACT'
+        | 'PROCESS_AND_STORE';
+      /**
+       * The explanation for the legal basis.
+       */
+      legalBasisExplanation?: string;
+      /**
+       * The status of the contact's subscription.
+       */
+      statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+      /**
+       * The contact's email address.
+       */
+      subscriberIdString: string;
+      /**
+       * The ID of the subscription to update.
+       */
+      subscriptionId: number;
+    }
+
+    export interface PublicSubscriptionTranslation {
+      /**
+       * The timestamp indicating when the subscription translation was created.
+       */
+      createdAt: number;
+      /**
+       * A text description of the subscription translation.
+       */
+      description: string;
+      /**
+       * The code representing the language of the subscription translation.
+       */
+      languageCode: string;
+      /**
+       * The name of the subscription translation.
+       */
+      name: string;
+      /**
+       * The unique identifier for the subscription associated with the translation.
+       */
+      subscriptionId: number;
+      /**
+       * The timestamp indicating when the subscription translation was last updated.
+       */
+      updatedAt: number;
+    }
+
+    export interface PublicWideStatus {
+      /**
+       * The ID of the business unit associated with the status.
+       */
+      businessUnitId?: number;
+      /**
+       * The type of communication channel, with 'EMAIL' as the only supported option.
+       */
+      channel: 'EMAIL';
+      /**
+       * The subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
+       */
+      status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+      /**
+       * The email address of the contact.
+       */
+      subscriberIdString: string;
+      /**
+       * The date and time when the status was recorded.
+       */
+      timestamp: string;
+      /**
+       * The type of wide status, which can be 'PORTAL_WIDE' or 'BUSINESS_UNIT_WIDE'.
+       */
+      wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE';
+    }
+
+    export interface PublicWideStatusBulkResponse {
+      /**
+       * The contact's email address.
+       */
+      subscriberIdString: string;
+      /**
+       * An array containing the wide status results for the operation.
+       */
+      wideStatuses: Schemas.PublicWideStatus[];
+    }
+
+    /**
+     * Ye olde error
+     */
+    export interface StandardError {
+      /**
+       * A string that categorizes the type of error.
+       */
+      category: string;
+      /**
+       * An object containing additional context about the error condition, with keys as context names and values as arrays of strings.
+       */
+      context: Record<string, string[]>;
+      /**
+       * An array of ErrorDetail objects providing further information about the error.
+       */
+      errors: Schemas.ErrorDetail[];
+      /**
+       * A string representing the unique identifier of the error.
+       */
+      id?: string;
+      /**
+       * An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps.
+       */
+      links: Record<string, string>;
+      /**
+       * A string containing a human-readable message describing the error.
+       */
+      message: string;
+      /**
+       * A string indicating the status of the error.
+       */
+      status: string;
+      /**
+       * An object providing more specific categorization of the error.
+       */
+      subCategory?: Record<string, never>;
+    }
+
+    export interface SubscriptionDefinition {
+      /**
+       * The ID of the business unit associated with the subscription.
+       */
+      businessUnitId?: number;
+      /**
+       * The method of communication for the subscription.
+       */
+      communicationMethod?: string;
+      /**
+       * The date and time when the subscription was created.
+       */
+      createdAt: string;
+      /**
+       * A description of the subscription.
+       */
+      description: string;
+      /**
+       * The unique identifier for the subscription.
+       */
+      id: string;
+      /**
+       * Indicates whether the subscription is active.
+       */
+      isActive: boolean;
+      /**
+       * Indicates whether the subscription is the default option.
+       */
+      isDefault: boolean;
+      /**
+       * Indicates whether the subscription is internal.
+       */
+      isInternal: boolean;
+      /**
+       * The name of the subscription.
+       */
+      name: string;
+      /**
+       * The purpose of the subscription.
+       */
+      purpose?: string;
+      /**
+       * A list of translations associated with the subscription.
+       */
+      subscriptionTranslations?: Schemas.PublicSubscriptionTranslation[];
+      /**
+       * The date and time when the subscription was last updated.
+       */
+      updatedAt: string;
+    }
+  }
+
+  export namespace Status {
+    export interface GenerateLinksInput {
+      /**
+       * The identifier of the business unit. Defaults to 0 if not specified.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel for which the links are generated. Must be 'EMAIL'.
+       */
+      channel: 'EMAIL';
+      data: Schemas.LinkGenerationRequest;
+    }
+
+    export type GenerateLinksOutput = Schemas.LinkGenerationResponse;
+
+    export interface GetStatusesInput {
+      /**
+       * The ID of the business unit to filter the subscription status by. This is an optional parameter.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only 'EMAIL'.
+       */
+      channel: 'EMAIL';
+      /**
+       * The unique identifier of the subscriber whose communication preferences status is being retrieved.
+       */
+      subscriberIdString: string;
+    }
+
+    export type GetStatusesOutput =
+      Schemas.ActionResponseWithResultsPublicStatus;
+
+    export interface GetUnsubscribeAllStatusInput {
+      /**
+       * The ID of the business unit to which the subscriber belongs. This is an optional parameter.
+       */
+      businessUnitId?: number;
+      /**
+       * The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.
+       */
+      channel: 'EMAIL';
+      /**
+       * The unique identifier of the subscriber to unsubscribe from all communication preferences.
+       */
+      subscriberIdString: string;
+      /**
+       * A boolean indicating whether to include detailed information in the response. Defaults to false.
+       */
+      verbose?: boolean;
+    }
+
+    export type GetUnsubscribeAllStatusOutput =
+      Schemas.ActionResponseWithResultsPublicWideStatus;
+
+    export interface UpdateStatusInput {
+      data: Schemas.PartialPublicStatusRequest;
+      /**
+       * The unique identifier of the subscriber whose communication preferences status is being updated.
+       */
+      subscriberIdString: string;
+    }
+
+    export type UpdateStatusOutput =
+      Schemas.ActionResponseWithResultsPublicStatus;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { communicationPreferencesSubscriptions } from '@hubspot/api-client-core';
+   * client.send(communicationPreferencesSubscriptions.batch.getUnsubscribeAllStatuses(input));
+   * ```
+   */
+  export interface BatchAPI {
+    /**
+     * Batch retrieve contacts who have opted out of all communications
+     * @apiPath /communication-preferences/2026-03/statuses/batch/unsubscribe-all/read
+     * @apiMethod POST
+     * @requiredScopes subscription-status-batch-read
+     */
+    getUnsubscribeAllStatuses: (
+      input: Batch.GetUnsubscribeAllStatusesInput
+    ) => Operation<Batch.GetUnsubscribeAllStatusesOutput>;
+    /**
+     * Batch retrieve subscription statuses
+     * @apiPath /communication-preferences/2026-03/statuses/batch/read
+     * @apiMethod POST
+     * @requiredScopes subscription-status-batch-read
+     */
+    read: (input: Batch.ReadInput) => Operation<Batch.ReadOutput>;
+    /**
+     * Batch unsubscribe contacts from all subscriptions
+     * @apiPath /communication-preferences/2026-03/statuses/batch/unsubscribe-all
+     * @apiMethod POST
+     * @requiredScopes subscription-status-batch-write
+     */
+    unsubscribeAll: (
+      input: Batch.UnsubscribeAllInput
+    ) => Operation<Batch.UnsubscribeAllOutput>;
+    /**
+     * Batch update subscription status
+     * @apiPath /communication-preferences/2026-03/statuses/batch/write
+     * @apiMethod POST
+     * @requiredScopes subscription-status-batch-write
+     */
+    updateStatuses: (
+      input: Batch.UpdateStatusesInput
+    ) => Operation<Batch.UpdateStatusesOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { communicationPreferencesSubscriptions } from '@hubspot/api-client-core';
+   * client.send(communicationPreferencesSubscriptions.definitions.list(input));
+   * ```
+   */
+  export interface DefinitionsAPI {
+    /**
+     * Retrieve all subscription status definitions
+     * @apiPath /communication-preferences/2026-03/definitions
+     * @apiMethod GET
+     * @requiredScopes subscriptions-definition-read
+     */
+    list: (input?: Definitions.ListInput) => Operation<Definitions.ListOutput>;
+    /**
+     * Unsubscribe a contact from all subscriptions
+     * @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all
+     * @apiMethod POST
+     * @requiredScopes subscriptions-status-write
+     */
+    unsubscribeAll: (
+      input: Definitions.UnsubscribeAllInput
+    ) => Operation<Definitions.UnsubscribeAllOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { communicationPreferencesSubscriptions } from '@hubspot/api-client-core';
+   * client.send(communicationPreferencesSubscriptions.status.generateLinks(input));
+   * ```
+   */
+  export interface StatusAPI {
+    /**
+     * Generate subscription links
+     * @apiPath /communication-preferences/2026-03/links/generate
+     * @apiMethod POST
+     * @requiredScopes subscriptions-status-read, subscriptions-status-write
+     */
+    generateLinks: (
+      input: Status.GenerateLinksInput
+    ) => Operation<Status.GenerateLinksOutput>;
+    /**
+     * Get subscription preferences for a specific contact
+     * @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}
+     * @apiMethod GET
+     * @requiredScopes subscriptions-status-read
+     */
+    getStatuses: (
+      input: Status.GetStatusesInput
+    ) => Operation<Status.GetStatusesOutput>;
+    /**
+     * Retrieve a contact's unsubscribed status
+     * @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all
+     * @apiMethod GET
+     * @requiredScopes subscriptions-status-read
+     */
+    getUnsubscribeAllStatus: (
+      input: Status.GetUnsubscribeAllStatusInput
+    ) => Operation<Status.GetUnsubscribeAllStatusOutput>;
+    /**
+     * Update a contact's subscription status
+     * @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}
+     * @apiMethod POST
+     * @requiredScopes subscriptions-status-write
+     */
+    updateStatus: (
+      input: Status.UpdateStatusInput
+    ) => Operation<Status.UpdateStatusOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { communicationPreferencesSubscriptions } from '@hubspot/api-client-core';
+   * client.send(communicationPreferencesSubscriptions.batch.getUnsubscribeAllStatuses(input));
+   * ```
+   */
+  export interface API {
+    batch: BatchAPI;
+    definitions: DefinitionsAPI;
+    status: StatusAPI;
+  }
+}