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

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

@@ -0,0 +1,1423 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../types.ts';
+
+export namespace Webhooks {
+  export namespace Advanced {
+    export type CreateCrmSnapshotsInput = Schemas.CrmObjectSnapshotBatchRequest;
+
+    export type CreateCrmSnapshotsOutput =
+      Schemas.CrmObjectSnapshotBatchResponse;
+
+    export type CreateSubscriptionFilterInput = Schemas.FilterCreateRequest;
+
+    export type CreateSubscriptionFilterOutput = Schemas.FilterCreateResponse;
+  }
+
+  export namespace Basic {
+    export interface CreateEventSubscriptionInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+      data: Schemas.SubscriptionCreateRequest;
+    }
+
+    export type CreateEventSubscriptionOutput = Schemas.SubscriptionResponse;
+
+    export type CreateJournalSubscriptionInput =
+      Schemas.SubscriptionUpsertRequest;
+
+    export type CreateJournalSubscriptionOutput =
+      Schemas.SubscriptionResponse_1;
+
+    export interface DeleteEventSubscriptionInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+      /**
+       * The identifier for the subscription.
+       */
+      subscriptionId: number;
+    }
+
+    export type DeleteEventSubscriptionOutput = void;
+
+    export interface DeleteJournalSubscriptionForPortalInput {
+      /**
+       * The unique identifier of the portal whose webhook journal subscription is to be deleted.
+       */
+      portalId: number;
+    }
+
+    export type DeleteJournalSubscriptionForPortalOutput = void;
+
+    export interface DeleteJournalSubscriptionInput {
+      /**
+       * The unique identifier of the subscription to delete.
+       */
+      subscriptionId: number;
+    }
+
+    export type DeleteJournalSubscriptionOutput = void;
+
+    export interface DeleteSettingsInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+    }
+
+    export type DeleteSettingsOutput = void;
+
+    export interface DeleteSubscriptionFilterInput {
+      /**
+       * The unique identifier of the filter to delete.
+       */
+      filterId: number;
+    }
+
+    export type DeleteSubscriptionFilterOutput = void;
+
+    export interface GetEarliestJournalEntryInput {
+      /**
+       * The ID of the portal installation to filter the journal entries. It is an integer.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestJournalEntryOutput = void;
+
+    export interface GetEarliestLocalJournalEntryInput {
+      /**
+       * The ID of the portal installation to filter the journal entries by. This parameter is optional and should be an integer.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestLocalJournalEntryOutput = void;
+
+    export interface GetEventSubscriptionInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+      /**
+       * The identifier for the subscription.
+       */
+      subscriptionId: number;
+    }
+
+    export type GetEventSubscriptionOutput = Schemas.SubscriptionResponse;
+
+    export interface GetJournalStatusInput {
+      /**
+       * The unique identifier (UUID) of the status to retrieve.
+       */
+      statusId: string;
+    }
+
+    export type GetJournalStatusOutput = Schemas.SnapshotStatusResponse;
+
+    export interface GetJournalSubscriptionInput {
+      /**
+       * The unique identifier of the subscription to retrieve. It must be an integer.
+       */
+      subscriptionId: number;
+    }
+
+    export type GetJournalSubscriptionOutput = Schemas.SubscriptionResponse_1;
+
+    export interface GetLatestJournalEntryInput {
+      /**
+       * The ID of the portal installation to filter the journal entries. It is an integer value.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLatestJournalEntryOutput = void;
+
+    export interface GetLatestLocalJournalEntryInput {
+      /**
+       * The ID of the portal for which to retrieve the latest journal entries. This parameter is optional and should be an integer.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLatestLocalJournalEntryOutput = void;
+
+    export interface GetLocalJournalStatusInput {
+      /**
+       * The unique identifier (UUID) of the status to retrieve.
+       */
+      statusId: string;
+    }
+
+    export type GetLocalJournalStatusOutput = Schemas.SnapshotStatusResponse;
+
+    export interface GetNextJournalEntriesInput {
+      /**
+       * The ID of the portal installation to filter the webhook journal entries. This is an optional parameter.
+       */
+      installPortalId?: number;
+      /**
+       * The offset from which to start retrieving the next batch of webhook journal entries. This parameter is required and identifies the starting point for the batch retrieval.
+       */
+      offset: string;
+    }
+
+    export type GetNextJournalEntriesOutput = void;
+
+    export interface GetNextLocalJournalEntriesInput {
+      /**
+       * The ID of the portal where the webhook is installed. This is an integer value.
+       */
+      installPortalId?: number;
+      /**
+       * The starting point for retrieving the next set of journal entries. This is a string value.
+       */
+      offset: string;
+    }
+
+    export type GetNextLocalJournalEntriesOutput = void;
+
+    export interface GetSettingsInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+    }
+
+    export type GetSettingsOutput = Schemas.SettingsResponse;
+
+    export interface GetSubscriptionFilterInput {
+      /**
+       * The unique identifier of the filter to retrieve.
+       */
+      filterId: number;
+    }
+
+    export type GetSubscriptionFilterOutput = Schemas.FilterResponse;
+
+    export interface ListEventSubscriptionsInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+    }
+
+    export type ListEventSubscriptionsOutput = Schemas.SubscriptionListResponse;
+
+    export type ListJournalSubscriptionsOutput =
+      Schemas.CollectionResponseSubscriptionResponseNoPaging;
+
+    export interface ListSubscriptionFiltersInput {
+      /**
+       * The unique identifier of the subscription for which to retrieve filters.
+       */
+      subscriptionId: number;
+    }
+
+    export type ListSubscriptionFiltersOutput = Schemas.FilterResponse[];
+
+    export interface UpdateEventSubscriptionInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+      data: Schemas.SubscriptionPatchRequest;
+      /**
+       * The identifier for the subscription.
+       */
+      subscriptionId: number;
+    }
+
+    export type UpdateEventSubscriptionOutput = Schemas.SubscriptionResponse;
+
+    export interface UpdateSettingsInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+      data: Schemas.SettingsChangeRequest;
+    }
+
+    export type UpdateSettingsOutput = Schemas.SettingsResponse;
+  }
+
+  export namespace Batch {
+    export interface CreateBatchEventSubscriptionsInput {
+      /**
+       * The identifier for the app.
+       */
+      appId: number;
+      data: Schemas.BatchInputSubscriptionBatchUpdateRequest;
+    }
+
+    export type CreateBatchEventSubscriptionsOutput =
+      Schemas.BatchResponseSubscriptionResponse;
+
+    export interface GetEarliestJournalBatchInput {
+      /**
+       * The maximum number of journal entries to retrieve in the batch. This must be an integer with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation to filter the webhook journal entries by. This is an integer value.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestJournalBatchOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetEarliestLocalJournalBatchInput {
+      /**
+       * The number of earliest entries to retrieve from the webhook journal. Must be an integer with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal where the webhooks are installed. This is an integer value.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestLocalJournalBatchOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetJournalBatchByRequestInput {
+      data: Schemas.BatchInputString;
+      /**
+       * The ID of the portal where the webhooks are installed. This is an integer value.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetJournalBatchByRequestOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetJournalBatchFromOffsetInput {
+      /**
+       * The number of journal entries to fetch in the batch. This is an integer value with a minimum of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation. This is an integer value used to specify the portal context for the request.
+       */
+      installPortalId?: number;
+      /**
+       * The starting point for fetching the next batch of journal entries. This is a string value that indicates the offset position.
+       */
+      offset: string;
+    }
+
+    export type GetJournalBatchFromOffsetOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetLatestJournalBatchInput {
+      /**
+       * The number of journal entries to retrieve. This is a required integer parameter with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation. This is an integer value used to identify the specific portal.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLatestJournalBatchOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetLatestLocalJournalBatchInput {
+      /**
+       * The number of journal entries to retrieve. Must be an integer with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation. This parameter is optional and used to filter the journal entries by a specific portal.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLatestLocalJournalBatchOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetLocalJournalBatchByRequestInput {
+      data: Schemas.BatchInputString;
+      /**
+       * The ID of the portal where the webhooks are installed. This parameter is optional and is used to specify the target portal.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLocalJournalBatchByRequestOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetLocalJournalBatchFromOffsetInput {
+      /**
+       * The number of journal entries to retrieve. This is an integer value with a minimum of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation. This is an integer value used to specify the portal context for the request.
+       */
+      installPortalId?: number;
+      /**
+       * The starting point for fetching the batch of journal entries. This is a string value that indicates the offset position.
+       */
+      offset: string;
+    }
+
+    export type GetLocalJournalBatchFromOffsetOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+  }
+
+  export namespace Schemas {
+    export interface ActionOverrideRequest {
+      /**
+       * An array of strings, each representing an associated object type ID relevant to the action override.
+       */
+      associatedObjectTypeIds?: string[];
+      /**
+       * An array of integers representing list IDs that are associated with the action override. The integers are in int64 format.
+       */
+      listIds?: number[];
+      /**
+       * An array of integers, each representing an object ID for which the action override is applicable. The integers are in int64 format.
+       */
+      objectIds?: number[];
+      /**
+       * An array of strings representing the properties to be overridden in the action. Each string corresponds to a property name.
+       */
+      properties?: string[];
+    }
+
+    export interface AppLifecycleEventSubscriptionUpsertRequest {
+      eventTypeId: string;
+      properties: string[];
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+    }
+
+    export interface AssociationSubscriptionUpsertRequest {
+      actions: (
+        | 'ADDED_TO_LIST'
+        | 'APP_INSTALL'
+        | 'APP_UNINSTALL'
+        | 'ASSOCIATION_ADDED'
+        | 'ASSOCIATION_REMOVED'
+        | 'CREATE'
+        | 'DELETE'
+        | 'GDPR_DELETE'
+        | 'MERGE'
+        | 'REMOVED_FROM_LIST'
+        | 'RESTORE'
+        | 'SNAPSHOT'
+        | 'UPDATE'
+      )[];
+      associatedObjectTypeIds: string[];
+      objectIds: number[];
+      objectTypeId: string;
+      portalId: number;
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+    }
+
+    export interface BatchInputString {
+      /**
+       * An array of strings to be processed. This property is required.
+       */
+      inputs: string[];
+    }
+
+    export interface BatchInputSubscriptionBatchUpdateRequest {
+      /**
+       * An array of SubscriptionBatchUpdateRequest objects, each representing a subscription to be updated. This property is required.
+       */
+      inputs: Schemas.SubscriptionBatchUpdateRequest[];
+    }
+
+    export interface BatchResponseJournalFetchResponse {
+      /**
+       * The date and time when the batch operation was completed, in ISO 8601 format.
+       */
+      completedAt: string;
+      /**
+       * A map of link names to associated URIs related to the batch operation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The date and time when the batch operation was requested, in ISO 8601 format.
+       */
+      requestedAt?: string;
+      /**
+       * An array of results from the batch operation, each represented as a JournalFetchResponse object.
+       */
+      results: Schemas.JournalFetchResponse[];
+      /**
+       * The date and time when the batch operation started, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BatchResponseSubscriptionResponse {
+      /**
+       * The date and time when the batch operation was completed, in ISO 8601 format.
+       */
+      completedAt: string;
+      /**
+       * A map of link names to associated URIs providing additional information about the batch operation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The date and time when the batch operation was requested, in ISO 8601 format.
+       */
+      requestedAt?: string;
+      /**
+       * An array containing the results of the batch operation, with each item representing an individual subscription response.
+       */
+      results: Schemas.SubscriptionResponse[];
+      /**
+       * The date and time when the batch operation started, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface CollectionResponseSubscriptionResponseNoPaging {
+      /**
+       * An array of SubscriptionResponse objects, each representing a subscription's details such as actions, appId, createdAt, and other relevant properties.
+       */
+      results: Schemas.SubscriptionResponse_1[];
+    }
+
+    export interface Condition {
+      /**
+       * A string indicating the type of filter being applied. Valid value is 'CRM_OBJECT_PROPERTY'.
+       */
+      filterType: 'CRM_OBJECT_PROPERTY';
+      /**
+       * A string specifying the operation to be performed in the condition. Valid values include 'EQ', 'N_EQ', 'LT', 'GT', 'LTE', 'GTE', 'CONTAINS', 'STARTS_WITH', 'ENDS_WITH', 'IN', 'NOT_IN', 'IS_EMPTY', and 'IS_NOT_EMPTY'.
+       */
+      operator:
+        | 'CONTAINS'
+        | 'ENDS_WITH'
+        | 'EQ'
+        | 'GT'
+        | 'GTE'
+        | 'IN'
+        | 'IS_EMPTY'
+        | 'IS_NOT_EMPTY'
+        | 'LT'
+        | 'LTE'
+        | 'N_EQ'
+        | 'NOT_IN'
+        | 'STARTS_WITH';
+      /**
+       * A string representing the specific property of the CRM object that the condition applies to.
+       */
+      property: string;
+      /**
+       * A string representing the value to be compared against the specified property when using single-value operators.
+       */
+      value?: string;
+      /**
+       * An array of strings used to specify multiple values for comparison when using operators that support multiple values, such as 'IN' or 'NOT_IN'.
+       */
+      values?: string[];
+    }
+
+    export interface CrmObjectSnapshotBatchRequest {
+      /**
+       * An array of CrmObjectSnapshotRequest objects, each representing a request to create a snapshot for a specific CRM object. This property is required.
+       */
+      snapshotRequests: Schemas.CrmObjectSnapshotRequest[];
+    }
+
+    export interface CrmObjectSnapshotBatchResponse {
+      /**
+       * An array of CrmObjectSnapshotResponse objects, each representing the result of a snapshot operation for a specific CRM object. This property is required.
+       */
+      snapshotResponses: Schemas.CrmObjectSnapshotResponse[];
+    }
+
+    export interface CrmObjectSnapshotRequest {
+      /**
+       * An integer representing the unique identifier of the CRM object for which the snapshot is requested.
+       */
+      objectId: number;
+      /**
+       * A string representing the type identifier of the CRM object, specifying what kind of object it is within HubSpot.
+       */
+      objectTypeId: string;
+      /**
+       * An integer representing the unique identifier of the HubSpot account (portal) where the CRM object resides.
+       */
+      portalId: number;
+      /**
+       * An array of strings, each representing a property of the CRM object that should be included in the snapshot.
+       */
+      properties: string[];
+    }
+
+    export interface CrmObjectSnapshotResponse {
+      /**
+       * An integer representing the unique identifier of the CRM object for which the snapshot is taken.
+       */
+      objectId: number;
+      /**
+       * A string indicating the type of the CRM object, such as contact, company, or deal.
+       */
+      objectTypeId: string;
+      /**
+       * An integer representing the unique identifier of the HubSpot portal associated with the CRM object.
+       */
+      portalId: number;
+      /**
+       * A UUID string representing the status identifier of the snapshot request, indicating the current state of the snapshot process.
+       */
+      snapshotStatusId: string;
+    }
+
+    /**
+     * Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
+     */
+    export interface Filter {
+      /**
+       * An array of conditions that define the criteria for the filter. Each condition specifies a property, an operator, and optionally a value or values.
+       */
+      conditions: Schemas.Condition[];
+    }
+
+    export interface FilterCreateRequest {
+      filter: Schemas.Filter;
+      /**
+       * The unique identifier of the subscription to which the filter will be applied. It is an integer formatted as int64.
+       */
+      subscriptionId: number;
+    }
+
+    export interface FilterCreateResponse {
+      /**
+       * The unique identifier for the created filter. It is an integer formatted as int64.
+       */
+      filterId: number;
+    }
+
+    export interface FilterResponse {
+      /**
+       * A Unix timestamp in milliseconds indicating when the filter was created.
+       */
+      createdAt: number;
+      filter: Schemas.Filter;
+      /**
+       * The unique identifier for the filter. It is an integer in int64 format.
+       */
+      id: number;
+    }
+
+    export interface GdprPrivacyDeletionSubscriptionUpsertRequest {
+      actions: (
+        | 'ADDED_TO_LIST'
+        | 'APP_INSTALL'
+        | 'APP_UNINSTALL'
+        | 'ASSOCIATION_ADDED'
+        | 'ASSOCIATION_REMOVED'
+        | 'CREATE'
+        | 'DELETE'
+        | 'GDPR_DELETE'
+        | 'MERGE'
+        | 'REMOVED_FROM_LIST'
+        | 'RESTORE'
+        | 'SNAPSHOT'
+        | 'UPDATE'
+      )[];
+      objectTypeId: string;
+      portalId: number;
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+    }
+
+    export interface JournalFetchResponse {
+      /**
+       * The unique identifier for the current offset of the journal entry, formatted as a UUID.
+       */
+      currentOffset: string;
+      /**
+       * The date and time when the URL will expire, in ISO 8601 format.
+       */
+      expiresAt: string;
+      /**
+       * The URL where the journal entry can be accessed. It is a string.
+       */
+      url: string;
+    }
+
+    export interface ListMembershipSubscriptionUpsertRequest {
+      actions: (
+        | 'ADDED_TO_LIST'
+        | 'APP_INSTALL'
+        | 'APP_UNINSTALL'
+        | 'ASSOCIATION_ADDED'
+        | 'ASSOCIATION_REMOVED'
+        | 'CREATE'
+        | 'DELETE'
+        | 'GDPR_DELETE'
+        | 'MERGE'
+        | 'REMOVED_FROM_LIST'
+        | 'RESTORE'
+        | 'SNAPSHOT'
+        | 'UPDATE'
+      )[];
+      listIds: number[];
+      objectIds: number[];
+      portalId: number;
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+    }
+
+    export interface ObjectSubscriptionUpsertRequest {
+      actions: (
+        | 'ADDED_TO_LIST'
+        | 'APP_INSTALL'
+        | 'APP_UNINSTALL'
+        | 'ASSOCIATION_ADDED'
+        | 'ASSOCIATION_REMOVED'
+        | 'CREATE'
+        | 'DELETE'
+        | 'GDPR_DELETE'
+        | 'MERGE'
+        | 'REMOVED_FROM_LIST'
+        | 'RESTORE'
+        | 'SNAPSHOT'
+        | 'UPDATE'
+      )[];
+      objectIds: number[];
+      objectTypeId: string;
+      portalId: number;
+      properties: string[];
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+    }
+
+    export interface SettingsChangeRequest {
+      /**
+       * The URL to which webhook events will be sent. It is a string.
+       */
+      targetUrl: string;
+      throttling: Schemas.ThrottlingSettings;
+    }
+
+    export interface SettingsResponse {
+      /**
+       * The date and time when the webhook settings were created, in ISO 8601 format.
+       */
+      createdAt: string;
+      /**
+       * The URL to which the webhook events will be sent. It is a string.
+       */
+      targetUrl: string;
+      throttling: Schemas.ThrottlingSettings;
+      /**
+       * The date and time when the webhook settings were last updated, in ISO 8601 format.
+       */
+      updatedAt?: string;
+    }
+
+    export interface SnapshotStatusResponse {
+      /**
+       * The timestamp indicating when the snapshot operation was completed, represented as a Unix timestamp in milliseconds.
+       */
+      completedAt?: number;
+      /**
+       * A code representing the error that occurred, if any. Possible values are 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'.
+       */
+      errorCode?:
+        | 'INTERNAL_ERROR'
+        | 'PERMISSION_DENIED'
+        | 'TIMEOUT'
+        | 'VALIDATION_ERROR';
+      /**
+       * The unique identifier for the snapshot operation, represented as a UUID.
+       */
+      id: string;
+      /**
+       * The timestamp indicating when the snapshot operation was initiated, represented as a Unix timestamp in milliseconds.
+       */
+      initiatedAt: number;
+      /**
+       * A descriptive message providing additional information about the snapshot operation or error.
+       */
+      message?: string;
+      /**
+       * The current status of the snapshot. Valid values include 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', and 'EXPIRED'.
+       */
+      status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING';
+    }
+
+    export interface SubscriptionBatchUpdateRequest {
+      /**
+       * A boolean indicating whether the subscription is active.
+       */
+      active: boolean;
+      /**
+       * The unique identifier for the subscription. It is an integer.
+       */
+      id: number;
+    }
+
+    export interface SubscriptionCreateRequest {
+      /**
+       * A boolean indicating whether the subscription is active.
+       */
+      active: boolean;
+      /**
+       * A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.
+       */
+      eventType:
+        | 'company.associationChange'
+        | 'company.creation'
+        | 'company.deletion'
+        | 'company.merge'
+        | 'company.propertyChange'
+        | 'company.restore'
+        | 'contact.associationChange'
+        | 'contact.creation'
+        | 'contact.deletion'
+        | 'contact.merge'
+        | 'contact.privacyDeletion'
+        | 'contact.propertyChange'
+        | 'contact.restore'
+        | 'conversation.creation'
+        | 'conversation.deletion'
+        | 'conversation.newMessage'
+        | 'conversation.privacyDeletion'
+        | 'conversation.propertyChange'
+        | 'deal.associationChange'
+        | 'deal.creation'
+        | 'deal.deletion'
+        | 'deal.merge'
+        | 'deal.propertyChange'
+        | 'deal.restore'
+        | 'event.completed'
+        | 'line_item.associationChange'
+        | 'line_item.creation'
+        | 'line_item.deletion'
+        | 'line_item.merge'
+        | 'line_item.propertyChange'
+        | 'line_item.restore'
+        | 'object.associationChange'
+        | 'object.creation'
+        | 'object.deletion'
+        | 'object.merge'
+        | 'object.propertyChange'
+        | 'object.restore'
+        | 'product.creation'
+        | 'product.deletion'
+        | 'product.merge'
+        | 'product.propertyChange'
+        | 'product.restore'
+        | 'ticket.associationChange'
+        | 'ticket.creation'
+        | 'ticket.deletion'
+        | 'ticket.merge'
+        | 'ticket.propertyChange'
+        | 'ticket.restore';
+      /**
+       * A string providing a human-readable name for the event type.
+       */
+      eventTypeName?: string;
+      /**
+       * A string representing the ID of the object type associated with the subscription.
+       */
+      objectTypeId?: string;
+      /**
+       * A string indicating the specific property name related to the event type, if applicable.
+       */
+      propertyName?: string;
+    }
+
+    export interface SubscriptionListResponse {
+      /**
+       * An array of subscription responses, each detailing a specific subscription's properties and status.
+       */
+      results: Schemas.SubscriptionResponse[];
+    }
+
+    export interface SubscriptionPatchRequest {
+      /**
+       * A boolean indicating whether the subscription is active. If true, the subscription is active; if false, it is inactive.
+       */
+      active?: boolean;
+    }
+
+    export interface SubscriptionResponse {
+      /**
+       * A boolean indicating whether the subscription is currently active.
+       */
+      active: boolean;
+      /**
+       * The date and time when the subscription was created, in ISO 8601 format.
+       */
+      createdAt: string;
+      /**
+       * The type of event that triggers the subscription. Valid values include various property changes, creations, deletions, merges, restores, and association changes for different HubSpot objects.
+       */
+      eventType:
+        | 'company.associationChange'
+        | 'company.creation'
+        | 'company.deletion'
+        | 'company.merge'
+        | 'company.propertyChange'
+        | 'company.restore'
+        | 'contact.associationChange'
+        | 'contact.creation'
+        | 'contact.deletion'
+        | 'contact.merge'
+        | 'contact.privacyDeletion'
+        | 'contact.propertyChange'
+        | 'contact.restore'
+        | 'conversation.creation'
+        | 'conversation.deletion'
+        | 'conversation.newMessage'
+        | 'conversation.privacyDeletion'
+        | 'conversation.propertyChange'
+        | 'deal.associationChange'
+        | 'deal.creation'
+        | 'deal.deletion'
+        | 'deal.merge'
+        | 'deal.propertyChange'
+        | 'deal.restore'
+        | 'event.completed'
+        | 'line_item.associationChange'
+        | 'line_item.creation'
+        | 'line_item.deletion'
+        | 'line_item.merge'
+        | 'line_item.propertyChange'
+        | 'line_item.restore'
+        | 'object.associationChange'
+        | 'object.creation'
+        | 'object.deletion'
+        | 'object.merge'
+        | 'object.propertyChange'
+        | 'object.restore'
+        | 'product.creation'
+        | 'product.deletion'
+        | 'product.merge'
+        | 'product.propertyChange'
+        | 'product.restore'
+        | 'ticket.associationChange'
+        | 'ticket.creation'
+        | 'ticket.deletion'
+        | 'ticket.merge'
+        | 'ticket.propertyChange'
+        | 'ticket.restore';
+      /**
+       * The name of the event type for the subscription.
+       */
+      eventTypeName?: string;
+      /**
+       * The unique identifier for the subscription. It is an integer formatted as int64.
+       */
+      id: string;
+      /**
+       * The identifier for the object type associated with the subscription. It is a string.
+       */
+      objectTypeId?: string;
+      /**
+       * The name of the property associated with the subscription event, if applicable.
+       */
+      propertyName?: string;
+      /**
+       * The date and time when the subscription was last updated, in ISO 8601 format.
+       */
+      updatedAt?: string;
+    }
+
+    export interface SubscriptionResponse_1 {
+      /**
+       * An object containing action overrides, where each key is an action and the value is an ActionOverrideRequest object.
+       */
+      actionOverrides?: Record<string, Schemas.ActionOverrideRequest>;
+      /**
+       * A list of actions that trigger the subscription. Possible values include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
+       */
+      actions: (
+        | 'ADDED_TO_LIST'
+        | 'APP_INSTALL'
+        | 'APP_UNINSTALL'
+        | 'ASSOCIATION_ADDED'
+        | 'ASSOCIATION_REMOVED'
+        | 'CREATE'
+        | 'DELETE'
+        | 'GDPR_DELETE'
+        | 'MERGE'
+        | 'REMOVED_FROM_LIST'
+        | 'RESTORE'
+        | 'SNAPSHOT'
+        | 'UPDATE'
+      )[];
+      /**
+       * The unique identifier for the app associated with the subscription. It is an integer formatted as int64.
+       */
+      appId: number;
+      /**
+       * A list of associated object type IDs. Each ID is a string.
+       */
+      associatedObjectTypeIds?: string[];
+      /**
+       * The date and time when the subscription was created, in ISO 8601 format.
+       */
+      createdAt: string;
+      /**
+       * The ID of the user who created the subscription. It is an integer formatted as int64.
+       */
+      createdBy?: number;
+      /**
+       * The date and time when the subscription was deleted, in ISO 8601 format, if applicable.
+       */
+      deletedAt?: string;
+      /**
+       * The unique identifier for the subscription. It is an integer formatted as int64.
+       */
+      id: number;
+      /**
+       * A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.
+       */
+      listIds?: number[];
+      /**
+       * A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.
+       */
+      objectIds?: number[];
+      /**
+       * The identifier for the object type associated with the subscription. It is a string.
+       */
+      objectTypeId: string;
+      /**
+       * The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.
+       */
+      portalId?: number;
+      /**
+       * A list of property names associated with the subscription. Each property is a string.
+       */
+      properties?: string[];
+      /**
+       * The type of subscription, which can be one of the following: 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.
+       */
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+      /**
+       * The date and time when the subscription was last updated, in ISO 8601 format.
+       */
+      updatedAt: string;
+    }
+
+    export type SubscriptionUpsertRequest =
+      | Schemas.ObjectSubscriptionUpsertRequest
+      | Schemas.AssociationSubscriptionUpsertRequest
+      | Schemas.AppLifecycleEventSubscriptionUpsertRequest
+      | Schemas.ListMembershipSubscriptionUpsertRequest
+      | Schemas.GdprPrivacyDeletionSubscriptionUpsertRequest;
+
+    export interface ThrottlingSettings {
+      /**
+       * The maximum number of concurrent requests allowed. This is an integer value.
+       */
+      maxConcurrentRequests: number;
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { webhooks } from '@hubspot/api-client-core';
+   * client.send(webhooks.advanced.createCrmSnapshots(input));
+   * ```
+   */
+  export interface AdvancedAPI {
+    /**
+     * Create Snapshot
+     * @apiPath /webhooks-journal/snapshots/2026-03/crm
+     * @apiMethod POST
+     * @requiredScopes webhooks-journal-snapshot-management
+     */
+    createCrmSnapshots: (
+      input: Advanced.CreateCrmSnapshotsInput
+    ) => Operation<Advanced.CreateCrmSnapshotsOutput>;
+    /**
+     * Create Filter
+     * @apiPath /webhooks-journal/subscriptions/2026-03/filters
+     * @apiMethod POST
+     * @requiredScopes webhooks-journal-subscription-management
+     */
+    createSubscriptionFilter: (
+      input: Advanced.CreateSubscriptionFilterInput
+    ) => Operation<Advanced.CreateSubscriptionFilterOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { webhooks } from '@hubspot/api-client-core';
+   * client.send(webhooks.basic.createEventSubscription(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Create an event subscription
+     * @apiPath /webhooks/2026-03/{appId}/subscriptions
+     * @apiMethod POST
+     * @requiredScopes developers-write, private-apps-write
+     */
+    createEventSubscription: (
+      input: Basic.CreateEventSubscriptionInput
+    ) => Operation<Basic.CreateEventSubscriptionOutput>;
+    /**
+     * Create Subscription
+     * @apiPath /webhooks-journal/subscriptions/2026-03
+     * @apiMethod POST
+     * @requiredScopes webhooks-journal-subscription-management
+     */
+    createJournalSubscription: (
+      input: Basic.CreateJournalSubscriptionInput
+    ) => Operation<Basic.CreateJournalSubscriptionOutput>;
+    /**
+     * Delete event subscription
+     * @apiPath /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}
+     * @apiMethod DELETE
+     * @requiredScopes developers-write, private-apps-write
+     */
+    deleteEventSubscription: (
+      input: Basic.DeleteEventSubscriptionInput
+    ) => Operation<Basic.DeleteEventSubscriptionOutput>;
+    /**
+     * Delete subscription
+     * @apiPath /webhooks-journal/subscriptions/2026-03/{subscriptionId}
+     * @apiMethod DELETE
+     * @requiredScopes webhooks-journal-subscription-management
+     */
+    deleteJournalSubscription: (
+      input: Basic.DeleteJournalSubscriptionInput
+    ) => Operation<Basic.DeleteJournalSubscriptionOutput>;
+    /**
+     * Delete subscription
+     * @apiPath /webhooks-journal/subscriptions/2026-03/portals/{portalId}
+     * @apiMethod DELETE
+     * @requiredScopes webhooks-journal-subscription-management
+     */
+    deleteJournalSubscriptionForPortal: (
+      input: Basic.DeleteJournalSubscriptionForPortalInput
+    ) => Operation<Basic.DeleteJournalSubscriptionForPortalOutput>;
+    /**
+     * Delete webhook settings
+     * @apiPath /webhooks/2026-03/{appId}/settings
+     * @apiMethod DELETE
+     * @requiredScopes developers-write, private-apps-write
+     */
+    deleteSettings: (
+      input: Basic.DeleteSettingsInput
+    ) => Operation<Basic.DeleteSettingsOutput>;
+    /**
+     * Delete filter
+     * @apiPath /webhooks-journal/subscriptions/2026-03/filters/{filterId}
+     * @apiMethod DELETE
+     * @requiredScopes webhooks-journal-subscription-management
+     */
+    deleteSubscriptionFilter: (
+      input: Basic.DeleteSubscriptionFilterInput
+    ) => Operation<Basic.DeleteSubscriptionFilterOutput>;
+    /**
+     * Retrieve earliest
+     * @apiPath /webhooks-journal/journal/2026-03/earliest
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getEarliestJournalEntry: (
+      input?: Basic.GetEarliestJournalEntryInput
+    ) => Operation<Basic.GetEarliestJournalEntryOutput>;
+    /**
+     * Retrieve earliest
+     * @apiPath /webhooks-journal/journal-local/2026-03/earliest
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getEarliestLocalJournalEntry: (
+      input?: Basic.GetEarliestLocalJournalEntryInput
+    ) => Operation<Basic.GetEarliestLocalJournalEntryOutput>;
+    /**
+     * Read an event subscription
+     * @apiPath /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}
+     * @apiMethod GET
+     * @requiredScopes developers-read, private-apps-read
+     */
+    getEventSubscription: (
+      input: Basic.GetEventSubscriptionInput
+    ) => Operation<Basic.GetEventSubscriptionOutput>;
+    /**
+     * Retrieve status
+     * @apiPath /webhooks-journal/journal/2026-03/status/{statusId}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-snapshot-management
+     */
+    getJournalStatus: (
+      input: Basic.GetJournalStatusInput
+    ) => Operation<Basic.GetJournalStatusOutput>;
+    /**
+     * Retrieve subscription
+     * @apiPath /webhooks-journal/subscriptions/2026-03/{subscriptionId}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-subscription-read
+     */
+    getJournalSubscription: (
+      input: Basic.GetJournalSubscriptionInput
+    ) => Operation<Basic.GetJournalSubscriptionOutput>;
+    /**
+     * Retrieve latest journal
+     * @apiPath /webhooks-journal/journal/2026-03/latest
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getLatestJournalEntry: (
+      input?: Basic.GetLatestJournalEntryInput
+    ) => Operation<Basic.GetLatestJournalEntryOutput>;
+    /**
+     * Retrieve latest journal
+     * @apiPath /webhooks-journal/journal-local/2026-03/latest
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getLatestLocalJournalEntry: (
+      input?: Basic.GetLatestLocalJournalEntryInput
+    ) => Operation<Basic.GetLatestLocalJournalEntryOutput>;
+    /**
+     * Retrieve status
+     * @apiPath /webhooks-journal/journal-local/2026-03/status/{statusId}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-snapshot-management
+     */
+    getLocalJournalStatus: (
+      input: Basic.GetLocalJournalStatusInput
+    ) => Operation<Basic.GetLocalJournalStatusOutput>;
+    /**
+     * Retrieve Next Batch
+     * @apiPath /webhooks-journal/journal/2026-03/offset/{offset}/next
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getNextJournalEntries: (
+      input: Basic.GetNextJournalEntriesInput
+    ) => Operation<Basic.GetNextJournalEntriesOutput>;
+    /**
+     * Retrieve Next Batch
+     * @apiPath /webhooks-journal/journal-local/2026-03/offset/{offset}/next
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getNextLocalJournalEntries: (
+      input: Basic.GetNextLocalJournalEntriesInput
+    ) => Operation<Basic.GetNextLocalJournalEntriesOutput>;
+    /**
+     * Read webhook settings
+     * @apiPath /webhooks/2026-03/{appId}/settings
+     * @apiMethod GET
+     * @requiredScopes developers-read, private-apps-read
+     */
+    getSettings: (
+      input: Basic.GetSettingsInput
+    ) => Operation<Basic.GetSettingsOutput>;
+    /**
+     * Retrieve filter
+     * @apiPath /webhooks-journal/subscriptions/2026-03/filters/{filterId}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-subscription-read
+     */
+    getSubscriptionFilter: (
+      input: Basic.GetSubscriptionFilterInput
+    ) => Operation<Basic.GetSubscriptionFilterOutput>;
+    /**
+     * Read event subscriptions
+     * @apiPath /webhooks/2026-03/{appId}/subscriptions
+     * @apiMethod GET
+     * @requiredScopes developers-read, private-apps-read
+     */
+    listEventSubscriptions: (
+      input: Basic.ListEventSubscriptionsInput
+    ) => Operation<Basic.ListEventSubscriptionsOutput>;
+    /**
+     * List subscriptions
+     * @apiPath /webhooks-journal/subscriptions/2026-03
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-subscription-read
+     */
+    listJournalSubscriptions: () => Operation<Basic.ListJournalSubscriptionsOutput>;
+    /**
+     * Retrieve Filters
+     * @apiPath /webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-subscription-read
+     */
+    listSubscriptionFilters: (
+      input: Basic.ListSubscriptionFiltersInput
+    ) => Operation<Basic.ListSubscriptionFiltersOutput>;
+    /**
+     * Update an event subscription
+     * @apiPath /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}
+     * @apiMethod PATCH
+     * @requiredScopes developers-write, private-apps-write
+     */
+    updateEventSubscription: (
+      input: Basic.UpdateEventSubscriptionInput
+    ) => Operation<Basic.UpdateEventSubscriptionOutput>;
+    /**
+     * Update webhook settings
+     * @apiPath /webhooks/2026-03/{appId}/settings
+     * @apiMethod PUT
+     * @requiredScopes developers-write, private-apps-write
+     */
+    updateSettings: (
+      input: Basic.UpdateSettingsInput
+    ) => Operation<Basic.UpdateSettingsOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { webhooks } from '@hubspot/api-client-core';
+   * client.send(webhooks.batch.createBatchEventSubscriptions(input));
+   * ```
+   */
+  export interface BatchAPI {
+    /**
+     * Batch create event subscriptions
+     * @apiPath /webhooks/2026-03/{appId}/subscriptions/batch/update
+     * @apiMethod POST
+     * @requiredScopes developers-write, private-apps-write
+     */
+    createBatchEventSubscriptions: (
+      input: Batch.CreateBatchEventSubscriptionsInput
+    ) => Operation<Batch.CreateBatchEventSubscriptionsOutput>;
+    /**
+     * Retrieve Batch
+     * @apiPath /webhooks-journal/journal/2026-03/batch/earliest/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getEarliestJournalBatch: (
+      input: Batch.GetEarliestJournalBatchInput
+    ) => Operation<Batch.GetEarliestJournalBatchOutput>;
+    /**
+     * Retrieve Batch
+     * @apiPath /webhooks-journal/journal-local/2026-03/batch/earliest/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getEarliestLocalJournalBatch: (
+      input: Batch.GetEarliestLocalJournalBatchInput
+    ) => Operation<Batch.GetEarliestLocalJournalBatchOutput>;
+    /**
+     * Batch read
+     * @apiPath /webhooks-journal/journal/2026-03/batch/read
+     * @apiMethod POST
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getJournalBatchByRequest: (
+      input: Batch.GetJournalBatchByRequestInput
+    ) => Operation<Batch.GetJournalBatchByRequestOutput>;
+    /**
+     * Fetch Batch Entries
+     * @apiPath /webhooks-journal/journal/2026-03/batch/{offset}/next/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getJournalBatchFromOffset: (
+      input: Batch.GetJournalBatchFromOffsetInput
+    ) => Operation<Batch.GetJournalBatchFromOffsetOutput>;
+    /**
+     * Retrieve latest batch
+     * @apiPath /webhooks-journal/journal/2026-03/batch/latest/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getLatestJournalBatch: (
+      input: Batch.GetLatestJournalBatchInput
+    ) => Operation<Batch.GetLatestJournalBatchOutput>;
+    /**
+     * Retrieve latest batch
+     * @apiPath /webhooks-journal/journal-local/2026-03/batch/latest/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getLatestLocalJournalBatch: (
+      input: Batch.GetLatestLocalJournalBatchInput
+    ) => Operation<Batch.GetLatestLocalJournalBatchOutput>;
+    /**
+     * Batch read
+     * @apiPath /webhooks-journal/journal-local/2026-03/batch/read
+     * @apiMethod POST
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getLocalJournalBatchByRequest: (
+      input: Batch.GetLocalJournalBatchByRequestInput
+    ) => Operation<Batch.GetLocalJournalBatchByRequestOutput>;
+    /**
+     * Retrieve batch
+     * @apiPath /webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getLocalJournalBatchFromOffset: (
+      input: Batch.GetLocalJournalBatchFromOffsetInput
+    ) => Operation<Batch.GetLocalJournalBatchFromOffsetOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { webhooks } from '@hubspot/api-client-core';
+   * client.send(webhooks.advanced.createCrmSnapshots(input));
+   * ```
+   */
+  export interface API {
+    advanced: AdvancedAPI;
+    basic: BasicAPI;
+    batch: BatchAPI;
+  }
+}