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

package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts

@@ -0,0 +1,669 @@
+import { Operation } from "../../types.js";
+
+//#region src/server/api-client-core/apis/crm/schemas-types.generated.d.ts
+declare namespace CRMSchemas {
+  namespace Advanced {
+    interface CreateAssociationInput {
+      data: Schemas.AssociationDefinitionEgg;
+      objectType: string;
+    }
+    type CreateAssociationOutput = Schemas.AssociationDefinition;
+  }
+  namespace Basic {
+    type CreateInput = Schemas.ObjectSchemaEgg;
+    type CreateOutput = Schemas.ObjectSchema;
+    interface DeleteAssociationInput {
+      associationIdentifier: string;
+      objectType: string;
+    }
+    type DeleteAssociationOutput = void;
+    interface DeleteInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      objectType: string;
+    }
+    type DeleteOutput = void;
+    interface GetInput {
+      includeAssociationDefinitions?: boolean;
+      includeAuditMetadata?: boolean;
+      includePropertyDefinitions?: boolean;
+      objectType: string;
+    }
+    type GetOutput = Schemas.ObjectSchema;
+    interface ListInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      includeAssociationDefinitions?: boolean;
+      includeAuditMetadata?: boolean;
+      includePropertyDefinitions?: boolean;
+    }
+    type ListOutput = Schemas.CollectionResponseObjectSchemaNoPaging;
+    interface UpdateInput {
+      data: Schemas.ObjectTypeDefinitionPatch;
+      objectType: string;
+    }
+    type UpdateOutput = Schemas.ObjectTypeDefinition;
+  }
+  namespace Batch {
+    type GetInput = Schemas.ObjectSchemaBatchReadRequest;
+    type GetOutput = Schemas.CollectionResponseObjectSchemaNoPaging;
+  }
+  namespace Schemas {
+    /**
+     * The definition of an association
+     */
+    interface AssociationDefinition {
+      /**
+       * When the association was defined.
+       */
+      createdAt?: string;
+      /**
+       * ID of the primary object type to link from.
+       */
+      fromObjectTypeId: string;
+      /**
+       * A unique ID for this association.
+       */
+      id: string;
+      /**
+       * A unique name for this association.
+       */
+      name?: string;
+      /**
+       * ID of the target object type ID to link to.
+       */
+      toObjectTypeId: string;
+      /**
+       * When the association was last updated.
+       */
+      updatedAt?: string;
+    }
+    interface AssociationDefinitionEgg {
+      /**
+       * ID of the primary object type to link from.
+       */
+      fromObjectTypeId: string;
+      /**
+       * A unique name for this association.
+       */
+      name?: string;
+      /**
+       * ID of the target object type ID to link to.
+       */
+      toObjectTypeId: string;
+    }
+    interface CollectionResponseObjectSchemaNoPaging {
+      results: Schemas.ObjectSchema[];
+    }
+    interface ObjectSchema {
+      allowsSensitiveProperties: boolean;
+      archived: boolean;
+      /**
+       * Associations defined for a given object type.
+       */
+      associations: Schemas.AssociationDefinition[];
+      /**
+       * When the object schema was created.
+       */
+      createdAt?: string;
+      createdByUserId?: number;
+      description?: string;
+      /**
+       * An assigned unique ID for the object, including portal ID and object name.
+       */
+      fullyQualifiedName: string;
+      /**
+       * A unique ID for this schema's object type. Will be defined as {meta-type}-{unique ID}.
+       */
+      id: string;
+      labels: Schemas.ObjectTypeDefinitionLabels;
+      /**
+       * A unique name for the schema's object type.
+       */
+      name: string;
+      objectTypeId: string;
+      /**
+       * The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
+       */
+      primaryDisplayProperty?: string;
+      /**
+       * Properties defined for this object type.
+       */
+      properties: Schemas.Property[];
+      /**
+       * The names of properties that should be **required** when creating an object of this type.
+       */
+      requiredProperties: string[];
+      /**
+       * Names of properties that will be indexed for this object type in by HubSpot's product search.
+       */
+      searchableProperties: string[];
+      /**
+       * The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
+       */
+      secondaryDisplayProperties: string[];
+      /**
+       * When the object schema was last updated.
+       */
+      updatedAt?: string;
+      updatedByUserId?: number;
+    }
+    interface ObjectSchemaBatchReadRequest {
+      /**
+       * Indicates whether to include association definitions in the response.
+       */
+      includeAssociationDefinitions: boolean;
+      /**
+       * Indicates whether to include audit metadata in the response.
+       */
+      includeAuditMetadata: boolean;
+      /**
+       * Indicates whether to include property definitions in the response.
+       */
+      includePropertyDefinitions: boolean;
+      inputs: string[];
+    }
+    interface ObjectSchemaEgg {
+      /**
+       * Determines if the object type can include properties that are marked as sensitive.
+       */
+      allowsSensitiveProperties: boolean;
+      /**
+       * Associations defined for this object type.
+       */
+      associatedObjects: string[];
+      /**
+       * A brief explanation of the object type.
+       */
+      description?: string;
+      labels: Schemas.ObjectTypeDefinitionLabels;
+      /**
+       * A unique name for this object. For internal use only.
+       */
+      name: string;
+      /**
+       * The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
+       */
+      primaryDisplayProperty?: string;
+      /**
+       * Properties defined for this object type.
+       */
+      properties: Schemas.ObjectTypePropertyCreate[];
+      /**
+       * The names of properties that should be **required** when creating an object of this type.
+       */
+      requiredProperties: string[];
+      /**
+       * Names of properties that will be indexed for this object type in by HubSpot's product search.
+       */
+      searchableProperties: string[];
+      /**
+       * The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
+       */
+      secondaryDisplayProperties: string[];
+    }
+    interface ObjectTypeDefinition {
+      /**
+       * Indicates whether the object type allows properties that contain sensitive data.
+       */
+      allowsSensitiveProperties: boolean;
+      /**
+       * Indicates whether the object type is archived.
+       */
+      archived: boolean;
+      /**
+       * When the object type was created.
+       */
+      createdAt?: string;
+      /**
+       * A description of the object type.
+       */
+      description?: string;
+      /**
+       * An assigned unique ID for the object, including portal ID and object name.
+       */
+      fullyQualifiedName: string;
+      /**
+       * A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.
+       */
+      id: string;
+      labels: Schemas.ObjectTypeDefinitionLabels;
+      /**
+       * A unique name for this object. For internal use only.
+       */
+      name: string;
+      /**
+       * A unique identifier for the object type.
+       */
+      objectTypeId: string;
+      /**
+       * The ID of the account that this object type is specific to.
+       */
+      portalId?: number;
+      /**
+       * The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
+       */
+      primaryDisplayProperty?: string;
+      /**
+       * The names of properties that should be **required** when creating an object of this type.
+       */
+      requiredProperties: string[];
+      /**
+       * Names of properties that will be indexed for this object type in by HubSpot's product search.
+       */
+      searchableProperties: string[];
+      /**
+       * The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
+       */
+      secondaryDisplayProperties: string[];
+      /**
+       * When the object type was last updated.
+       */
+      updatedAt?: string;
+    }
+    interface ObjectTypeDefinitionLabels {
+      /**
+       * The word for multiple objects. (There’s no way to change this later.)
+       */
+      plural?: string;
+      /**
+       * The word for one object. (There’s no way to change this later.)
+       */
+      singular?: string;
+    }
+    interface ObjectTypeDefinitionPatch {
+      /**
+       * Determines if the object type can include properties that are marked as sensitive.
+       */
+      allowsSensitiveProperties?: boolean;
+      /**
+       * Indicates whether the description of the object type should be cleared.
+       */
+      clearDescription: boolean;
+      /**
+       * A brief explanation of the object type.
+       */
+      description?: string;
+      labels?: Schemas.ObjectTypeDefinitionLabels;
+      /**
+       * The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
+       */
+      primaryDisplayProperty?: string;
+      /**
+       * The names of properties that should be **required** when creating an object of this type.
+       */
+      requiredProperties?: string[];
+      /**
+       * Specifies if the object type can be restored after being deleted.
+       */
+      restorable?: boolean;
+      /**
+       * Names of properties that will be indexed for this object type in by HubSpot's product search.
+       */
+      searchableProperties?: string[];
+      /**
+       * The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
+       */
+      secondaryDisplayProperties?: string[];
+    }
+    interface ObjectTypePropertyCreate {
+      /**
+       * A description of the property that will be shown as help text in HubSpot.
+       */
+      description?: string;
+      /**
+       * The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed **after** any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * Specifies the reference type for external options associated with the property.
+       */
+      externalOptionsReferenceType?: string;
+      /**
+       * Controls how the property appears in HubSpot.
+       */
+      fieldType: string;
+      /**
+       * Whether the property can be used in a HubSpot form.
+       */
+      formField?: boolean;
+      /**
+       * The name of the group this property belongs to.
+       */
+      groupName?: string;
+      /**
+       * Whether or not the property's value must be unique. Once set, this can't be changed.
+       */
+      hasUniqueValue?: boolean;
+      /**
+       * Hidden options won't be shown in HubSpot.
+       */
+      hidden?: boolean;
+      /**
+       * A human-readable property label that will be shown in HubSpot.
+       */
+      label: string;
+      /**
+       * The internal property name, which must be used when referencing the property from the API.
+       */
+      name: string;
+      /**
+       * Controls how numeric properties are formatted in the HubSpot UI
+       */
+      numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';
+      /**
+       * A list of available options for the property. This field is only required for enumerated properties.
+       */
+      options?: Schemas.OptionInput[];
+      /**
+       * Controls how the property options will be sorted in the HubSpot UI.
+       */
+      optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER';
+      /**
+       * Defines the options this property will return, e.g. OWNER would return name of users on the portal.
+       */
+      referencedObjectType?: string;
+      /**
+       * Allow users to search for information entered to this field (limited to 3 properties)
+       */
+      searchableInGlobalSearch?: boolean;
+      /**
+       * Whether the property will display the currency symbol in the HubSpot UI.
+       */
+      showCurrencySymbol?: boolean;
+      /**
+       * Controls how text properties are formatted in the HubSpot UI
+       */
+      textDisplayHint?: 'domain_name' | 'email' | 'ip_address' | 'multi_line' | 'phone_number' | 'physical_address' | 'postal_code' | 'unformatted_single_line';
+      /**
+       * The data type of the property.
+       */
+      type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';
+    }
+    /**
+     * A HubSpot property option
+     */
+    interface Option {
+      /**
+       * A description of the option.
+       */
+      description?: string;
+      /**
+       * Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * Hidden options will not be displayed in HubSpot.
+       */
+      hidden: boolean;
+      /**
+       * A human-readable option label that will be shown in HubSpot.
+       */
+      label: string;
+      /**
+       * The internal value of the option, which must be used when setting the property value through the API.
+       */
+      value: string;
+    }
+    interface OptionInput {
+      /**
+       * A description of the option.
+       */
+      description?: string;
+      /**
+       * Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.
+       */
+      displayOrder: number;
+      /**
+       * Hidden options won't be shown in HubSpot.
+       */
+      hidden: boolean;
+      /**
+       * A human-readable option label that will be shown in HubSpot.
+       */
+      label: string;
+      /**
+       * The internal value of the option, which must be used when setting the property value through the API.
+       */
+      value: string;
+    }
+    /**
+     * A HubSpot property
+     */
+    interface Property {
+      /**
+       * Whether or not the property is archived.
+       */
+      archived?: boolean;
+      /**
+       * When the property was archived.
+       */
+      archivedAt?: string;
+      /**
+       * For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
+       */
+      calculated?: boolean;
+      /**
+       * The formula used for calculated properties.
+       */
+      calculationFormula?: string;
+      /**
+       * When the property was created
+       */
+      createdAt?: string;
+      /**
+       * The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
+       */
+      createdUserId?: string;
+      /**
+       * The name of the related currency property.
+       */
+      currencyPropertyName?: string;
+      /**
+       * Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
+       */
+      dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
+      /**
+       * Controls how date properties are displayed in the HubSpot UI, with options such as 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'.
+       */
+      dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until';
+      /**
+       * A description of the property that will be shown as help text in HubSpot.
+       */
+      description: string;
+      /**
+       * The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed **after** any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * For default properties, true indicates that the options are stored externally to the property settings.
+       */
+      externalOptions?: boolean;
+      /**
+       * Controls how the property appears in HubSpot.
+       */
+      fieldType: string;
+      /**
+       * Whether or not the property can be used in a HubSpot form.
+       */
+      formField?: boolean;
+      /**
+       * The name of the property group the property belongs to.
+       */
+      groupName: string;
+      /**
+       * Whether or not the property's value must be unique. Once set, this can't be changed.
+       */
+      hasUniqueValue?: boolean;
+      /**
+       * Hidden options won't be shown in HubSpot.
+       */
+      hidden?: boolean;
+      /**
+       * This will be true for default object properties built into HubSpot.
+       */
+      hubspotDefined?: boolean;
+      /**
+       * A human-readable property label that will be shown in HubSpot.
+       */
+      label: string;
+      modificationMetadata?: Schemas.PropertyModificationMetadata;
+      /**
+       * The internal property name, which must be used when referencing the property via the API.
+       */
+      name: string;
+      /**
+       * Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".
+       */
+      numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';
+      /**
+       * A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.
+       */
+      options: Schemas.Option[];
+      /**
+       * If this property is related to other object(s), they'll be listed here.
+       */
+      referencedObjectType?: string;
+      /**
+       * When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
+       */
+      sensitiveDataCategories?: string[];
+      /**
+       * Whether the property will display the currency symbol set in the account settings.
+       */
+      showCurrencySymbol?: boolean;
+      /**
+       * The property data type.
+       */
+      type: string;
+      /**
+       * When the object type was last updated.
+       */
+      updatedAt?: string;
+      /**
+       * The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.
+       */
+      updatedUserId?: string;
+    }
+    interface PropertyModificationMetadata {
+      /**
+       * Indicates whether the property can be archived.
+       */
+      archivable: boolean;
+      /**
+       * Indicates whether the property's definition is read-only.
+       */
+      readOnlyDefinition: boolean;
+      /**
+       * Indicates whether the property's options are read-only.
+       */
+      readOnlyOptions?: boolean;
+      /**
+       * Indicates whether the property's value is read-only.
+       */
+      readOnlyValue: boolean;
+    }
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmSchemas } from '@hubspot/api-client-core';
+   * client.send(crmSchemas.advanced.createAssociation(input));
+   * ```
+   */
+  interface AdvancedAPI {
+    /**
+     * Create an association for a specified object type.
+     * @apiPath /crm-object-schemas/2026-03/schemas/{objectType}/associations
+     * @apiMethod POST
+     * @requiredScopes custom-object-access, custom-object-write
+     */
+    createAssociation: (input: Advanced.CreateAssociationInput) => Operation<Advanced.CreateAssociationOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmSchemas } from '@hubspot/api-client-core';
+   * client.send(crmSchemas.basic.create(input));
+   * ```
+   */
+  interface BasicAPI {
+    /**
+     * Create a new custom object schema.
+     * @apiPath /crm-object-schemas/2026-03/schemas
+     * @apiMethod POST
+     * @requiredScopes custom-object-access, custom-object-write
+     */
+    create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
+    /**
+     * Delete the schema of a specified custom object.
+     * @apiPath /crm-object-schemas/2026-03/schemas/{objectType}
+     * @apiMethod DELETE
+     * @requiredScopes custom-object-delete
+     */
+    delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
+    /**
+     * Delete an existing association for a specified object type.
+     * @apiPath /crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}
+     * @apiMethod DELETE
+     * @requiredScopes custom-object-delete
+     */
+    deleteAssociation: (input: Basic.DeleteAssociationInput) => Operation<Basic.DeleteAssociationOutput>;
+    /**
+     * Retrieve the schema of a specified custom object.
+     * @apiPath /crm-object-schemas/2026-03/schemas/{objectType}
+     * @apiMethod GET
+     * @requiredScopes custom-object-read, oauth-access
+     */
+    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    /**
+     * Retrieve all custom object schemas.
+     * @apiPath /crm-object-schemas/2026-03/schemas
+     * @apiMethod GET
+     * @requiredScopes custom-object-read
+     */
+    list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
+    /**
+     * Update the schema of a specified custom object.
+     * @apiPath /crm-object-schemas/2026-03/schemas/{objectType}
+     * @apiMethod PATCH
+     * @requiredScopes custom-object-access, custom-object-write
+     */
+    update: (input: Basic.UpdateInput) => Operation<Basic.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmSchemas } from '@hubspot/api-client-core';
+   * client.send(crmSchemas.batch.get(input));
+   * ```
+   */
+  interface BatchAPI {
+    /**
+     * Retrieve multiple custom object schemas in a batch request.
+     * @apiPath /crm-object-schemas/2026-03/schemas/batch/read
+     * @apiMethod POST
+     * @requiredScopes custom-object-read, oauth-access
+     */
+    get: (input: Batch.GetInput) => Operation<Batch.GetOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmSchemas } from '@hubspot/api-client-core';
+   * client.send(crmSchemas.advanced.createAssociation(input));
+   * ```
+   */
+  interface API {
+    advanced: AdvancedAPI;
+    basic: BasicAPI;
+    batch: BatchAPI;
+  }
+}
+//#endregion
+export { CRMSchemas };
+//# sourceMappingURL=schemas-types.generated.d.ts.map

package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts

@@ -0,0 +1,7 @@
+import { CRMSchemas } from "./schemas-types.generated.js";
+
+//#region src/server/api-client-core/apis/crm/schemas.generated.d.ts
+declare const crmSchemas: CRMSchemas.API;
+//#endregion
+export { crmSchemas };
+//# sourceMappingURL=schemas.generated.d.ts.map