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

package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts

@@ -0,0 +1,550 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace CRMPublicAppCrmCards {
+  export namespace Advanced {
+    export interface MigrateViewsInput {
+      /**
+       * The appId of the app containing the Legacy CRM Card(s)
+       */
+      appId: number;
+      data: Schemas.CardMigrateViewsRequest;
+    }
+
+    export type MigrateViewsOutput = Schemas.CardMigrateViewsResponse;
+  }
+
+  export namespace Basic {
+    export interface CreateInput {
+      /**
+       * The appId of the app containing the Legacy CRM Card(s)
+       */
+      appId: number;
+      data: Schemas.CardCreateRequest;
+    }
+
+    export type CreateOutput = Schemas.PublicCardResponse;
+
+    export interface DeleteInput {
+      /**
+       * The appId of the app containing the Legacy CRM Card(s)
+       */
+      appId: number;
+      /**
+       * The id of the Legacy CRM Card
+       */
+      cardId: string;
+    }
+
+    export type DeleteOutput = void;
+
+    export interface GetByIdInput {
+      /**
+       * The appId of the app containing the Legacy CRM Card(s)
+       */
+      appId: number;
+      /**
+       * The id of the Legacy CRM Card
+       */
+      cardId: string;
+    }
+
+    export type GetByIdOutput = Schemas.PublicCardResponse;
+
+    export interface GetInput {
+      /**
+       * The appId of the app containing the Legacy CRM Card(s)
+       */
+      appId: number;
+    }
+
+    export type GetOutput = Schemas.PublicCardListResponse;
+
+    export type GetSampleResponseOutput = Schemas.IntegratorCardPayloadResponse;
+
+    export interface UpdateInput {
+      /**
+       * The appId of the app containing the Legacy CRM Card(s)
+       */
+      appId: number;
+      /**
+       * The id of the Legacy CRM Card
+       */
+      cardId: string;
+      data: Schemas.CardPatchRequest;
+    }
+
+    export type UpdateOutput = Schemas.PublicCardResponse;
+  }
+
+  export namespace Schemas {
+    export interface ActionConfirmationBody {
+      /**
+       * The label for the button that cancels the action.
+       */
+      cancelButtonLabel: string;
+      /**
+       * The label for the button that confirms the action.
+       */
+      confirmButtonLabel: string;
+      /**
+       * The message displayed to the user to confirm the action.
+       */
+      prompt: string;
+    }
+
+    export interface ActionHookActionBody {
+      confirmation?: Schemas.ActionConfirmationBody;
+      /**
+       * The HTTP method to be used when making the call, which can be set to GET, POST, PUT, DELETE, or PATCH. If using GET or DELETE
+       */
+      httpMethod:
+        | 'CONNECT'
+        | 'DELETE'
+        | 'GET'
+        | 'HEAD'
+        | 'OPTIONS'
+        | 'PATCH'
+        | 'POST'
+        | 'PUT'
+        | 'TRACE';
+      /**
+       * The label for this property as you'd like it displayed to users.
+       */
+      label?: string;
+      /**
+       * A list of property names that will be included on the action. See the documentation for more information
+       */
+      propertyNamesIncluded: string[];
+      /**
+       * The type of status.
+       */
+      type: 'ACTION_HOOK';
+      /**
+       * The URL endpoint that will be called when the action is triggered.
+       */
+      url: string;
+    }
+
+    export interface CardActions {
+      /**
+       * A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.
+       */
+      baseUrls: string[];
+    }
+
+    export interface CardAuditResponse {
+      /**
+       * The type of action performed, with possible values: CREATE, DELETE, UPDATE.
+       */
+      actionType: 'CREATE' | 'DELETE' | 'UPDATE';
+      /**
+       * The ID of the application associated with the card.
+       */
+      applicationId: number;
+      /**
+       * The source of authentication for the action, with possible values: APP, EXTERNAL, INTERNAL.
+       */
+      authSource: 'APP' | 'EXTERNAL' | 'INTERNAL';
+      /**
+       * The timestamp indicating when the change occurred.
+       */
+      changedAt: number;
+      /**
+       * The ID of the user who initiated the action.
+       */
+      initiatingUserId: number;
+      /**
+       * The ID of the card.
+       */
+      objectTypeId: number;
+    }
+
+    export interface CardCreateRequest {
+      actions: Schemas.CardActions;
+      display: Schemas.CardDisplayBody;
+      fetch: Schemas.CardFetchBody;
+      /**
+       * The top-level title for this card. Displayed to users in the CRM UI.
+       */
+      title: string;
+    }
+
+    export interface CardDisplayBody {
+      /**
+       * Card display properties. These will will be rendered as "label : value" pairs in the card UI. See the [example card](#) in the overview docs for more details.
+       */
+      properties: Schemas.CardDisplayProperty[];
+    }
+
+    export interface CardDisplayProperty {
+      /**
+       * Type of data represented by this property.
+       */
+      dataType:
+        | 'BOOLEAN'
+        | 'CURRENCY'
+        | 'DATE'
+        | 'DATETIME'
+        | 'EMAIL'
+        | 'LINK'
+        | 'NUMERIC'
+        | 'STATUS'
+        | 'STRING';
+      /**
+       * The label for this property as you'd like it displayed to users.
+       */
+      label: string;
+      /**
+       * An internal identifier for this property. This value must be unique TODO.
+       */
+      name: string;
+      /**
+       * An array of available options that can be displayed. Only used in when `dataType` is `STATUS`.
+       */
+      options: Schemas.DisplayOption[];
+    }
+
+    export interface CardFetchBody {
+      /**
+       * A deprecated field to determine the type of card returned.
+       */
+      cardType: 'EXTERNAL' | 'SERVERLESS';
+      /**
+       * An array of CRM object types where this card should be displayed. HubSpot will call your data fetch URL whenever a user visits a record page of the types defined here.
+       */
+      objectTypes: Schemas.CardObjectTypeBody[];
+      /**
+       * A deprecated field to specify serverless functionality with the card
+       */
+      serverlessFunction?: string;
+      /**
+       * URL to a service endpoints that will respond with card details. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
+       */
+      targetUrl: string;
+    }
+
+    export interface CardFetchBodyPatch {
+      /**
+       * A deprecated field to determine the type of card returned.
+       */
+      cardType?: 'EXTERNAL' | 'SERVERLESS';
+      /**
+       * An array of CRM object types where this card should be displayed. HubSpot will call your target URL whenever a user visits a record page of the types defined here.
+       */
+      objectTypes: Schemas.CardObjectTypeBody[];
+      /**
+       * A deprecated field to specify serverless functionality with the card
+       */
+      serverlessFunction?: string;
+      /**
+       * URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
+       */
+      targetUrl?: string;
+    }
+
+    export interface CardMigrateViewsRequest {
+      allowDuplicateAppCardIds: boolean;
+      appCardId: number;
+      helpdeskAppCardId?: number;
+      legacyCrmCardId: number;
+    }
+
+    export interface CardMigrateViewsResponse {
+      endedAt?: number;
+      /**
+       * A human readable message describing the progress of the migration.
+       */
+      message: string;
+      /**
+       * The number of portals that remain to be swapped from the Legacy CRM Card to the App Card
+       */
+      remainingPortalCount?: number;
+      /**
+       * The timestamp for when the migration started.
+       */
+      startedAt?: number;
+      /**
+       * The total number of portals that have access to the Legacy CRM Card
+       */
+      totalPortalCount?: number;
+    }
+
+    export interface CardObjectTypeBody {
+      /**
+       * A CRM object type where this card should be displayed.
+       */
+      name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets';
+      /**
+       * An array of properties that should be sent to this card's target URL when the data fetch request is made. Must be valid properties for the corresponding CRM object type.
+       */
+      propertiesToSend: string[];
+    }
+
+    export interface CardPatchRequest {
+      actions?: Schemas.CardActions;
+      display?: Schemas.CardDisplayBody;
+      fetch?: Schemas.CardFetchBodyPatch;
+      /**
+       * The top-level title for this card. Displayed to users in the CRM UI.
+       */
+      title?: string;
+    }
+
+    export interface DisplayOption {
+      /**
+       * The text that will be displayed to users for this option.
+       */
+      label: string;
+      /**
+       * JSON-friendly unique name for option.
+       */
+      name: string;
+      /**
+       * The type of status.
+       */
+      type: 'DANGER' | 'DEFAULT' | 'INFO' | 'SUCCESS' | 'WARNING';
+    }
+
+    export interface IFrameActionBody {
+      /**
+       * The height of the iframe in pixels.
+       */
+      height: number;
+      /**
+       * The label for this property as you'd like it displayed to users.
+       */
+      label?: string;
+      /**
+       * A list of property names that will be included on the url of the iframe.
+       */
+      propertyNamesIncluded: string[];
+      /**
+       * The type of status.
+       */
+      type: 'IFRAME';
+      /**
+       * The URL endpoint that will be loaded in the iframe when triggered.
+       */
+      url: string;
+      /**
+       * The width of the iframe in pixels.
+       */
+      width: number;
+    }
+
+    export interface IntegratorCardPayloadResponse {
+      /**
+       * URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a `See more [x]` link if there are more than five items in your response, where `[x]` is the value of `itemLabel`.
+       */
+      allItemsLinkUrl?: string;
+      /**
+       * The label to be used for the `allItemsLinkUrl` link (e.g. 'See more tickets'). If not provided, this falls back to the card's title.
+       */
+      cardLabel?: string;
+      /**
+       * The number version of the response.
+       */
+      responseVersion: 'v1' | 'v3';
+      /**
+       * A list of up to five valid card sub categories.
+       */
+      sections: Schemas.IntegratorObjectResult[];
+      topLevelActions?: Schemas.TopLevelActions;
+      /**
+       * The total number of card properties that will be sent in this response.
+       */
+      totalCount: number;
+    }
+
+    export interface IntegratorObjectResult {
+      /**
+       * A list of actions associated with the card, which can include action hooks, confirmation action hooks, or iframes.
+       */
+      actions: (Schemas.ActionHookActionBody | Schemas.IFrameActionBody)[];
+      /**
+       * The unique identifier for the card.
+       */
+      id: string;
+      /**
+       * A URL used on the title of the card
+       */
+      linkUrl?: string;
+      /**
+       * The top-level title for this card. Displayed to users in the CRM UI.
+       */
+      title: string;
+      /**
+       * A collection of tokens representing specific properties related to the card.
+       */
+      tokens: Schemas.ObjectToken[];
+    }
+
+    export interface ObjectToken {
+      /**
+       * Type of data represented by this property.
+       */
+      dataType?:
+        | 'BOOLEAN'
+        | 'CURRENCY'
+        | 'DATE'
+        | 'DATETIME'
+        | 'EMAIL'
+        | 'LINK'
+        | 'NUMERIC'
+        | 'STATUS'
+        | 'STRING';
+      /**
+       * The label for this property as you'd like it displayed to users.
+       */
+      label?: string;
+      /**
+       * An internal identifier for this property. This value must be unique TODO.
+       */
+      name?: string;
+      /**
+       * The value of the property
+       */
+      value: string;
+    }
+
+    export interface PublicCardFetchBody {
+      /**
+       * An array of CRM object types where this card should be displayed. HubSpot will call your target URL whenever a user visits a record page of the types defined here.
+       */
+      objectTypes: Schemas.CardObjectTypeBody[];
+      /**
+       * URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
+       */
+      targetUrl: string;
+    }
+
+    export interface PublicCardListResponse {
+      /**
+       * A list of card responses
+       */
+      results: Schemas.PublicCardResponse[];
+    }
+
+    export interface PublicCardResponse {
+      actions: Schemas.CardActions;
+      /**
+       * A list of actions performed on the card, including creation, deletion, and updates.
+       */
+      auditHistory: Schemas.CardAuditResponse[];
+      /**
+       * The date and time when the card was created.
+       */
+      createdAt?: string;
+      display: Schemas.CardDisplayBody;
+      fetch: Schemas.PublicCardFetchBody;
+      /**
+       * The unique id of the card.
+       */
+      id: string;
+      /**
+       * The top-level title for this card. Displayed to users in the CRM UI.
+       */
+      title: string;
+      /**
+       * The date and time when the card was last updated.
+       */
+      updatedAt?: string;
+    }
+
+    export interface TopLevelActions {
+      /**
+       * Defines the primary action for a card, which can be either an action hook or an iframe.
+       */
+      primary?: Schemas.ActionHookActionBody | Schemas.IFrameActionBody;
+      /**
+       * Specifies a list of secondary actions for a card, each of which can be an action hook or an iframe.
+       */
+      secondary: (Schemas.ActionHookActionBody | Schemas.IFrameActionBody)[];
+      settings?: Schemas.IFrameActionBody;
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmPublicAppCrmCards } from '@hubspot/api-client-core';
+   * client.send(crmPublicAppCrmCards.advanced.migrateViews(input));
+   * ```
+   */
+  export interface AdvancedAPI {
+    /**
+     * Migrate Card Views
+     * @apiPath /crm/extensions/cards-dev/2026-03/{appId}/views/migrate
+     * @apiMethod POST
+     * @requiredScopes developers-write
+     */
+    migrateViews: (
+      input: Advanced.MigrateViewsInput
+    ) => Operation<Advanced.MigrateViewsOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmPublicAppCrmCards } from '@hubspot/api-client-core';
+   * client.send(crmPublicAppCrmCards.basic.create(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Create a new card
+     * @apiPath /crm/extensions/cards-dev/2026-03/{appId}
+     * @apiMethod POST
+     * @requiredScopes developers-write
+     */
+    create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
+    /**
+     * Delete a card
+     * @apiPath /crm/extensions/cards-dev/2026-03/{appId}/{cardId}
+     * @apiMethod DELETE
+     * @requiredScopes developers-write
+     */
+    delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
+    /**
+     * Get all cards
+     * @apiPath /crm/extensions/cards-dev/2026-03/{appId}
+     * @apiMethod GET
+     * @requiredScopes developers-read, private-apps-read
+     */
+    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    /**
+     * Get a card.
+     * @apiPath /crm/extensions/cards-dev/2026-03/{appId}/{cardId}
+     * @apiMethod GET
+     * @requiredScopes developers-read, private-apps-read
+     */
+    getById: (input: Basic.GetByIdInput) => Operation<Basic.GetByIdOutput>;
+    /**
+     * Get sample card detail response
+     * @apiPath /crm/extensions/cards-dev/2026-03/sample-response
+     * @apiMethod GET
+     */
+    getSampleResponse: () => Operation<Basic.GetSampleResponseOutput>;
+    /**
+     * Update a card
+     * @apiPath /crm/extensions/cards-dev/2026-03/{appId}/{cardId}
+     * @apiMethod PATCH
+     * @requiredScopes developers-write
+     */
+    update: (input: Basic.UpdateInput) => Operation<Basic.UpdateOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmPublicAppCrmCards } from '@hubspot/api-client-core';
+   * client.send(crmPublicAppCrmCards.advanced.migrateViews(input));
+   * ```
+   */
+  export interface API {
+    advanced: AdvancedAPI;
+    basic: BasicAPI;
+  }
+}

package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts

@@ -0,0 +1,46 @@
+import { op } from '../../op.ts';
+import type { CRMPublicAppCrmCards } from './public-app-crm-cards-types.generated.ts';
+
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+export * from './public-app-crm-cards-types.generated.ts';
+
+const advanced: CRMPublicAppCrmCards.AdvancedAPI = {
+  migrateViews: (input) =>
+    op.post('/crm/extensions/cards-dev/2026-03/{appId}/views/migrate', {
+      pathParams: { appId: input.appId },
+      body: input.data,
+    }),
+};
+
+const basic: CRMPublicAppCrmCards.BasicAPI = {
+  create: (input) =>
+    op.post('/crm/extensions/cards-dev/2026-03/{appId}', {
+      pathParams: { appId: input.appId },
+      body: input.data,
+    }),
+  delete: (input) =>
+    op.del('/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', {
+      pathParams: { appId: input.appId, cardId: input.cardId },
+    }),
+  get: (input) =>
+    op.get('/crm/extensions/cards-dev/2026-03/{appId}', {
+      pathParams: { appId: input.appId },
+    }),
+  getById: (input) =>
+    op.get('/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', {
+      pathParams: { appId: input.appId, cardId: input.cardId },
+    }),
+  getSampleResponse: () =>
+    op.get('/crm/extensions/cards-dev/2026-03/sample-response'),
+  update: (input) =>
+    op.patch('/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', {
+      pathParams: { appId: input.appId, cardId: input.cardId },
+      body: input.data,
+    }),
+};
+
+export const crmPublicAppCrmCards: CRMPublicAppCrmCards.API = {
+  advanced: advanced,
+  basic: basic,
+};