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

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

@@ -0,0 +1,906 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../types.ts';
+
+export namespace WebhooksJournal {
+  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 type CreateJournalSubscriptionInput =
+      Schemas.SubscriptionUpsertRequest;
+
+    export type CreateJournalSubscriptionOutput = Schemas.SubscriptionResponse;
+
+    export interface DeleteJournalSubscriptionForPortalInput {
+      /**
+       * The unique identifier of the portal for which the webhook journal subscription is to be deleted.
+       */
+      portalId: number;
+    }
+
+    export type DeleteJournalSubscriptionForPortalOutput = void;
+
+    export interface DeleteJournalSubscriptionInput {
+      /**
+       * The unique identifier of the subscription to delete. It must be provided as an integer.
+       */
+      subscriptionId: number;
+    }
+
+    export type DeleteJournalSubscriptionOutput = 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 by. This is an integer value.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestJournalEntryOutput = void;
+
+    export interface GetEarliestLocalJournalEntryInput {
+      /**
+       * The ID of the portal for which to retrieve the earliest webhook journal entries. This parameter is optional and should be an integer.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestLocalJournalEntryOutput = void;
+
+    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.
+       */
+      subscriptionId: number;
+    }
+
+    export type GetJournalSubscriptionOutput = Schemas.SubscriptionResponse;
+
+    export interface GetLatestJournalEntryInput {
+      /**
+       * The unique identifier of the portal installation for which to retrieve the latest journal entries. This parameter is optional and should be an integer.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLatestJournalEntryOutput = void;
+
+    export interface GetLatestLocalJournalEntryInput {
+      /**
+       * The ID of the portal for which to retrieve the latest journal entries. This is an integer value.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLatestLocalJournalEntryOutput = void;
+
+    export interface GetLocalJournalStatusInput {
+      /**
+       * The unique identifier of the status to retrieve. It should be in UUID format.
+       */
+      statusId: string;
+    }
+
+    export type GetLocalJournalStatusOutput = Schemas.SnapshotStatusResponse;
+
+    export interface GetNextJournalEntriesInput {
+      /**
+       * The ID of the portal where the webhooks are installed. This is an integer value.
+       */
+      installPortalId?: number;
+      /**
+       * The offset string indicating the starting point for retrieving the next set of journal entries.
+       */
+      offset: string;
+    }
+
+    export type GetNextJournalEntriesOutput = void;
+
+    export interface GetNextLocalJournalEntriesInput {
+      /**
+       * The ID of the portal installation to filter the webhook journal entries. This is an integer value.
+       */
+      installPortalId?: number;
+      /**
+       * The starting point for retrieving the next set of webhook journal entries. This is a string value that represents the current position in the journal.
+       */
+      offset: string;
+    }
+
+    export type GetNextLocalJournalEntriesOutput = void;
+
+    export interface GetSubscriptionFilterInput {
+      /**
+       * The unique identifier of the filter to retrieve. It is an integer value.
+       */
+      filterId: number;
+    }
+
+    export type GetSubscriptionFilterOutput = Schemas.FilterResponse;
+
+    export type ListJournalSubscriptionsOutput =
+      Schemas.CollectionResponseSubscriptionResponseNoPaging;
+
+    export interface ListSubscriptionFiltersInput {
+      /**
+       * The unique identifier of the subscription for which to retrieve filters. This is an integer value.
+       */
+      subscriptionId: number;
+    }
+
+    export type ListSubscriptionFiltersOutput = Schemas.FilterResponse[];
+  }
+
+  export namespace Batch {
+    export interface GetEarliestJournalBatchInput {
+      /**
+       * The number of earliest journal entries to retrieve. This must be an integer with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation. This is an integer value that specifies which portal's data to access.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestJournalBatchOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetEarliestLocalJournalBatchInput {
+      /**
+       * The number of earliest webhook journal entries to retrieve. This is a required integer parameter with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation to filter the webhook journal entries. This is an optional integer parameter.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetEarliestLocalJournalBatchOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetJournalBatchByRequestInput {
+      data: Schemas.BatchInputString;
+      /**
+       * An integer representing the ID of the portal installation for which the webhooks journal data should be retrieved.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetJournalBatchByRequestOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetJournalBatchFromOffsetInput {
+      /**
+       * The number of journal entries to retrieve. This must be an integer with a minimum value of 1.
+       */
+      count: number;
+      /**
+       * The ID of the portal installation. This is an integer value.
+       */
+      installPortalId?: number;
+      /**
+       * The starting point for fetching the journal entries. This is a string value.
+       */
+      offset: string;
+    }
+
+    export type GetJournalBatchFromOffsetOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetLatestJournalBatchInput {
+      /**
+       * The maximum 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 specify the portal context for the request.
+       */
+      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 where the webhook journal is installed. This parameter is optional and used to specify the target 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 for the operation.
+       */
+      installPortalId?: number;
+    }
+
+    export type GetLocalJournalBatchByRequestOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+
+    export interface GetLocalJournalBatchFromOffsetInput {
+      /**
+       * The number of journal entries to retrieve in this batch. 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 optional parameter.
+       */
+      installPortalId?: number;
+      /**
+       * The starting point for the batch retrieval, specified as a string.
+       */
+      offset: string;
+    }
+
+    export type GetLocalJournalBatchFromOffsetOutput =
+      Schemas.BatchResponseJournalFetchResponse;
+  }
+
+  export namespace Schemas {
+    export interface ActionOverrideRequest {
+      /**
+       * An array of strings representing the type IDs of associated objects relevant to the action override.
+       */
+      associatedObjectTypeIds?: string[];
+      /**
+       * An array of integers, each representing a unique identifier for a list involved in the action override.
+       */
+      listIds?: number[];
+      /**
+       * An array of integers, each representing a unique identifier for an object involved in the action override.
+       */
+      objectIds?: number[];
+      /**
+       * An array of strings representing the properties to be overridden in the action request.
+       */
+      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 that are to be processed in the batch operation. This property is required.
+       */
+      inputs: string[];
+    }
+
+    export interface BatchResponseJournalFetchResponse {
+      completedAt: string;
+      links?: Record<string, string>;
+      requestedAt?: string;
+      results: Schemas.JournalFetchResponse[];
+      startedAt: string;
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface CollectionResponseSubscriptionResponseNoPaging {
+      /**
+       * An array of subscription responses, each conforming to the SubscriptionResponse schema. This array contains the details of each subscription returned by the API.
+       */
+      results: Schemas.SubscriptionResponse[];
+    }
+
+    export interface Condition {
+      /**
+       * A string indicating the type of filter. Valid value is 'CRM_OBJECT_PROPERTY'.
+       */
+      filterType: 'CRM_OBJECT_PROPERTY';
+      /**
+       * A string specifying the operation to be performed for 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 property of the CRM object to which the condition applies.
+       */
+      property: string;
+      /**
+       * A string representing the value to be compared against the property for the condition.
+       */
+      value?: string;
+      /**
+       * An array of strings representing multiple values to be used in the condition, applicable for operators like 'IN' or 'NOT_IN'.
+       */
+      values?: string[];
+    }
+
+    export interface CrmObjectSnapshotBatchRequest {
+      snapshotRequests: Schemas.CrmObjectSnapshotRequest[];
+    }
+
+    export interface CrmObjectSnapshotBatchResponse {
+      snapshotResponses: Schemas.CrmObjectSnapshotResponse[];
+    }
+
+    export interface CrmObjectSnapshotRequest {
+      objectId: number;
+      objectTypeId: string;
+      portalId: number;
+      properties: string[];
+    }
+
+    export interface CrmObjectSnapshotResponse {
+      objectId: number;
+      objectTypeId: string;
+      portalId: number;
+      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 filter type, operator, property, and optionally a value or values to match against.
+       */
+      conditions: Schemas.Condition[];
+    }
+
+    export interface FilterCreateRequest {
+      filter: Schemas.Filter;
+      /**
+       * The unique identifier of the subscription to which the filter will be added. It is an integer in int64 format.
+       */
+      subscriptionId: number;
+    }
+
+    export interface FilterCreateResponse {
+      /**
+       * The unique identifier for the created filter. It is an integer formatted as int64.
+       */
+      filterId: number;
+    }
+
+    export interface FilterResponse {
+      /**
+       * The timestamp indicating when the filter was created, represented as an integer in int64 format.
+       */
+      createdAt: number;
+      filter: Schemas.Filter;
+      /**
+       * The unique identifier for the filter. It is an integer formatted as int64.
+       */
+      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 {
+      currentOffset: string;
+      expiresAt: 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 SnapshotStatusResponse {
+      /**
+       * The timestamp when the snapshot was completed, represented as an integer in int64 format. This field may be null if the snapshot is not yet completed.
+       */
+      completedAt?: number;
+      /**
+       * An optional code indicating 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';
+      /**
+       * A unique identifier for the snapshot, represented as a UUID.
+       */
+      id: string;
+      /**
+       * The timestamp when the snapshot was initiated, represented as an integer in int64 format.
+       */
+      initiatedAt: number;
+      /**
+       * A descriptive message providing additional information about the snapshot status 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 SubscriptionResponse {
+      actionOverrides?: Record<string, Schemas.ActionOverrideRequest>;
+      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 of the app associated with the subscription, represented as a 64-bit integer.
+       */
+      appId: number;
+      associatedObjectTypeIds?: string[];
+      createdAt: string;
+      createdBy?: number;
+      deletedAt?: string;
+      /**
+       * The unique identifier for the subscription, represented as a 64-bit integer.
+       */
+      id: number;
+      listIds?: number[];
+      objectIds?: number[];
+      objectTypeId: string;
+      portalId?: number;
+      properties?: string[];
+      /**
+       * The type of subscription, which can be one of 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.
+       */
+      subscriptionType:
+        | 'APP_LIFECYCLE_EVENT'
+        | 'ASSOCIATION'
+        | 'EVENT'
+        | 'GDPR_PRIVACY_DELETION'
+        | 'LIST_MEMBERSHIP'
+        | 'OBJECT';
+      updatedAt: string;
+    }
+
+    export type SubscriptionUpsertRequest =
+      | Schemas.ObjectSubscriptionUpsertRequest
+      | Schemas.AssociationSubscriptionUpsertRequest
+      | Schemas.AppLifecycleEventSubscriptionUpsertRequest
+      | Schemas.ListMembershipSubscriptionUpsertRequest
+      | Schemas.GdprPrivacyDeletionSubscriptionUpsertRequest;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { webhooksJournal } from '@hubspot/api-client-core';
+   * client.send(webhooksJournal.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 { webhooksJournal } from '@hubspot/api-client-core';
+   * client.send(webhooksJournal.basic.createJournalSubscription(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Create Subscription
+     * @apiPath /webhooks-journal/subscriptions/2026-03
+     * @apiMethod POST
+     * @requiredScopes webhooks-journal-subscription-management
+     */
+    createJournalSubscription: (
+      input: Basic.CreateJournalSubscriptionInput
+    ) => Operation<Basic.CreateJournalSubscriptionOutput>;
+    /**
+     * 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 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 entry
+     * @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>;
+    /**
+     * 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
+     * @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 Entries
+     * @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>;
+    /**
+     * Retrieve filter
+     * @apiPath /webhooks-journal/subscriptions/2026-03/filters/{filterId}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-subscription-read
+     */
+    getSubscriptionFilter: (
+      input: Basic.GetSubscriptionFilterInput
+    ) => Operation<Basic.GetSubscriptionFilterOutput>;
+    /**
+     * 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>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { webhooksJournal } from '@hubspot/api-client-core';
+   * client.send(webhooksJournal.batch.getEarliestJournalBatch(input));
+   * ```
+   */
+  export interface BatchAPI {
+    /**
+     * Fetch Earliest Batch
+     * @apiPath /webhooks-journal/journal/2026-03/batch/earliest/{count}
+     * @apiMethod GET
+     * @requiredScopes webhooks-journal-data-access
+     */
+    getEarliestJournalBatch: (
+      input: Batch.GetEarliestJournalBatchInput
+    ) => Operation<Batch.GetEarliestJournalBatchOutput>;
+    /**
+     * Fetch earliest 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
+     * @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 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>;
+    /**
+     * Fetch 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 { webhooksJournal } from '@hubspot/api-client-core';
+   * client.send(webhooksJournal.advanced.createCrmSnapshots(input));
+   * ```
+   */
+  export interface API {
+    advanced: AdvancedAPI;
+    basic: BasicAPI;
+    batch: BatchAPI;
+  }
+}