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

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

@@ -0,0 +1,705 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace CRMProperties {
+  export namespace Basic {
+    export interface Create2Input {
+      data: Schemas.PropertyGroupCreate;
+      objectType: string;
+    }
+
+    export type Create2Output = Schemas.PropertyGroup;
+
+    export interface CreateInput {
+      data: Schemas.PropertyCreate;
+      objectType: string;
+    }
+
+    export type CreateOutput = Schemas.Property;
+
+    export interface Delete2Input {
+      objectType: string;
+      propertyName: string;
+    }
+
+    export type Delete2Output = void;
+
+    export interface DeleteInput {
+      groupName: string;
+      objectType: string;
+    }
+
+    export type DeleteOutput = void;
+
+    export interface Get2Input {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
+      locale?: string;
+      objectType: string;
+      properties?: string;
+      propertyName: string;
+    }
+
+    export type Get2Output = Schemas.Property;
+
+    export interface GetInput {
+      groupName: string;
+      locale?: string;
+      objectType: string;
+    }
+
+    export type GetOutput = Schemas.PropertyGroup;
+
+    export interface List2Input {
+      locale?: string;
+      objectType: string;
+    }
+
+    export type List2Output = Schemas.CollectionResponsePropertyGroupNoPaging;
+
+    export interface ListInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
+      locale?: string;
+      objectType: string;
+      properties?: string;
+    }
+
+    export type ListOutput = Schemas.CollectionResponsePropertyNoPaging;
+
+    export interface Update2Input {
+      data: Schemas.PropertyUpdate;
+      objectType: string;
+      propertyName: string;
+    }
+
+    export type Update2Output = Schemas.Property;
+
+    export interface UpdateInput {
+      data: Schemas.PropertyGroupUpdate;
+      groupName: string;
+      objectType: string;
+    }
+
+    export type UpdateOutput = Schemas.PropertyGroup;
+  }
+
+  export namespace Batch {
+    export interface CreateInput {
+      data: Schemas.BatchInputPropertyCreate;
+      objectType: string;
+    }
+
+    export type CreateOutput = Schemas.BatchResponseProperty;
+
+    export interface DeleteInput {
+      data: Schemas.BatchInputPropertyName;
+      objectType: string;
+    }
+
+    export type DeleteOutput = void;
+
+    export interface GetInput {
+      data: Schemas.BatchReadInputPropertyName;
+      locale?: string;
+      objectType: string;
+    }
+
+    export type GetOutput = Schemas.BatchResponseProperty;
+  }
+
+  export namespace Schemas {
+    export interface BatchInputPropertyCreate {
+      inputs: Schemas.PropertyCreate[];
+    }
+
+    export interface BatchInputPropertyName {
+      inputs: Schemas.PropertyName[];
+    }
+
+    export interface BatchReadInputPropertyName {
+      /**
+       * Specifies whether the property is archived.
+       */
+      archived: boolean;
+      /**
+       * Indicates the sensitivity level of the data, such as 'non_sensitive', 'sensitive', or 'highly_sensitive'.
+       */
+      dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
+      inputs: Schemas.PropertyName[];
+    }
+
+    export interface BatchResponseProperty {
+      /**
+       * The timestamp indicating when the batch operation was completed.
+       */
+      completedAt: string;
+      /**
+       * A collection of URLs linking to documentation or resources related to the batch operation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The timestamp indicating when the batch operation was requested.
+       */
+      requestedAt?: string;
+      results: Schemas.Property[];
+      /**
+       * The timestamp indicating when the batch operation began processing.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch operation, with possible values being CANCELED, COMPLETE, PENDING, or PROCESSING.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface CollectionResponsePropertyGroupNoPaging {
+      results: Schemas.PropertyGroup[];
+    }
+
+    export interface CollectionResponsePropertyNoPaging {
+      results: Schemas.Property[];
+    }
+
+    /**
+     * A HubSpot property option
+     */
+    export 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;
+    }
+
+    export 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
+     */
+    export 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;
+      /**
+       * Represents a formula that is used to compute a calculated property.
+       */
+      calculationFormula?: string;
+      /**
+       * The timestamp when the property was created, in ISO 8601 format.
+       */
+      createdAt?: string;
+      /**
+       * The internal user 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';
+      /**
+       * Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or '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;
+      /**
+       * Properties are shown in order, starting with the lowest positive integer value.
+       */
+      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;
+      /**
+       * Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.
+       */
+      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 or not the property will display the currency symbol set in the account settings.
+       */
+      showCurrencySymbol?: boolean;
+      /**
+       * The property data type.
+       */
+      type: string;
+      /**
+       * The timestamp when the property was last updated, in ISO 8601 format.
+       */
+      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;
+    }
+
+    export interface PropertyCreate {
+      /**
+       * Represents a formula that is used to compute a calculated property.
+       */
+      calculationFormula?: string;
+      currencyPropertyName?: string;
+      /**
+       * Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive.
+       */
+      dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
+      /**
+       * A description of the property that will be shown as help text in HubSpot.
+       */
+      description?: string;
+      /**
+       * Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * Applicable only for 'enumeration' type properties.  Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'.  Otherwise false.
+       */
+      externalOptions?: boolean;
+      /**
+       * Controls how the property appears in HubSpot.
+       */
+      fieldType:
+        | 'booleancheckbox'
+        | 'calculation_equation'
+        | 'checkbox'
+        | 'date'
+        | 'file'
+        | 'html'
+        | 'number'
+        | 'phonenumber'
+        | 'radio'
+        | 'select'
+        | 'text'
+        | 'textarea';
+      /**
+       * 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;
+      /**
+       * If true, the property won't be visible and can't be used 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 via the API.
+       */
+      name: string;
+      numberDisplayHint?:
+        | 'currency'
+        | 'duration'
+        | 'formatted'
+        | 'percentage'
+        | 'probability'
+        | 'unformatted';
+      /**
+       * A list of valid options for the property. This field is required for enumerated properties.
+       */
+      options?: Schemas.OptionInput[];
+      /**
+       * Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.
+       */
+      referencedObjectType?: string;
+      showCurrencySymbol?: boolean;
+      /**
+       * The data type of the property.
+       */
+      type:
+        | 'bool'
+        | 'date'
+        | 'datetime'
+        | 'enumeration'
+        | 'number'
+        | 'phone_number'
+        | 'string';
+    }
+
+    export interface PropertyGroup {
+      /**
+       * Indicates whether the property group is archived.
+       */
+      archived: boolean;
+      /**
+       * Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * A human-readable label that will be shown in HubSpot.
+       */
+      label: string;
+      /**
+       * The internal property group name, which must be used when referencing the property group via the API.
+       */
+      name: string;
+    }
+
+    export interface PropertyGroupCreate {
+      /**
+       * Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * A human-readable label that will be shown in HubSpot.
+       */
+      label: string;
+      /**
+       * The internal property group name, which must be used when referencing the property group via the API.
+       */
+      name: string;
+    }
+
+    export interface PropertyGroupUpdate {
+      /**
+       * Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * A human-readable label that will be shown in HubSpot.
+       */
+      label?: string;
+    }
+
+    export interface PropertyModificationMetadata {
+      /**
+       * Specifies whether the property can be archived.
+       */
+      archivable: boolean;
+      /**
+       * Indicates whether the property's definition is read-only and cannot be modified.
+       */
+      readOnlyDefinition: boolean;
+      /**
+       * Indicates whether the property's options are read-only and cannot be modified.
+       */
+      readOnlyOptions?: boolean;
+      /**
+       * Indicates whether the property's value is read-only and cannot be modified.
+       */
+      readOnlyValue: boolean;
+    }
+
+    export interface PropertyName {
+      /**
+       * The name of the property to read or modify.
+       */
+      name: string;
+    }
+
+    export interface PropertyUpdate {
+      /**
+       * Represents a formula that is used to compute a calculated property.
+       */
+      calculationFormula?: string;
+      currencyPropertyName?: string;
+      /**
+       * A description of the property that will be shown as help text in HubSpot.
+       */
+      description?: string;
+      /**
+       * Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.
+       */
+      displayOrder?: number;
+      /**
+       * Controls how the property appears in HubSpot.
+       */
+      fieldType?:
+        | 'booleancheckbox'
+        | 'calculation_equation'
+        | 'checkbox'
+        | 'date'
+        | 'file'
+        | 'html'
+        | 'number'
+        | 'phonenumber'
+        | 'radio'
+        | 'select'
+        | 'text'
+        | 'textarea';
+      /**
+       * 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;
+      /**
+       * If true, the property won't be visible and can't be used in HubSpot.
+       */
+      hidden?: boolean;
+      /**
+       * A human-readable property label that will be shown in HubSpot.
+       */
+      label?: string;
+      numberDisplayHint?:
+        | 'currency'
+        | 'duration'
+        | 'formatted'
+        | 'percentage'
+        | 'probability'
+        | 'unformatted';
+      /**
+       * A list of valid options for the property.
+       */
+      options?: Schemas.OptionInput[];
+      showCurrencySymbol?: boolean;
+      /**
+       * The data type of the property.
+       */
+      type?:
+        | 'bool'
+        | 'date'
+        | 'datetime'
+        | 'enumeration'
+        | 'number'
+        | 'phone_number'
+        | 'string';
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmProperties } from '@hubspot/api-client-core';
+   * client.send(crmProperties.basic.create(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Create a property
+     * @apiPath /crm/properties/2026-03/{objectType}
+     * @apiMethod POST
+     * @requiredScopes properties-settings-write
+     */
+    create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
+    /**
+     * Create a property group
+     * @apiPath /crm/properties/2026-03/{objectType}/groups
+     * @apiMethod POST
+     * @requiredScopes properties-settings-write
+     */
+    create2: (input: Basic.Create2Input) => Operation<Basic.Create2Output>;
+    /**
+     * Archive a property group
+     * @apiPath /crm/properties/2026-03/{objectType}/groups/{groupName}
+     * @apiMethod DELETE
+     * @requiredScopes properties-settings-write
+     */
+    delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
+    /**
+     * Archive a property
+     * @apiPath /crm/properties/2026-03/{objectType}/{propertyName}
+     * @apiMethod DELETE
+     * @requiredScopes properties-settings-write
+     */
+    delete2: (input: Basic.Delete2Input) => Operation<Basic.Delete2Output>;
+    /**
+     * Read a property group
+     * @apiPath /crm/properties/2026-03/{objectType}/groups/{groupName}
+     * @apiMethod GET
+     * @requiredScopes properties-settings-read
+     */
+    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    /**
+     * Read a property
+     * @apiPath /crm/properties/2026-03/{objectType}/{propertyName}
+     * @apiMethod GET
+     * @requiredScopes properties-settings-read
+     */
+    get2: (input: Basic.Get2Input) => Operation<Basic.Get2Output>;
+    /**
+     * Read all properties
+     * @apiPath /crm/properties/2026-03/{objectType}
+     * @apiMethod GET
+     * @requiredScopes properties-settings-read
+     */
+    list: (input: Basic.ListInput) => Operation<Basic.ListOutput>;
+    /**
+     * Read all property groups
+     * @apiPath /crm/properties/2026-03/{objectType}/groups
+     * @apiMethod GET
+     * @requiredScopes properties-settings-read
+     */
+    list2: (input: Basic.List2Input) => Operation<Basic.List2Output>;
+    /**
+     * Update a property group
+     * @apiPath /crm/properties/2026-03/{objectType}/groups/{groupName}
+     * @apiMethod PATCH
+     * @requiredScopes properties-settings-write
+     */
+    update: (input: Basic.UpdateInput) => Operation<Basic.UpdateOutput>;
+    /**
+     * Update a property
+     * @apiPath /crm/properties/2026-03/{objectType}/{propertyName}
+     * @apiMethod PATCH
+     * @requiredScopes properties-settings-write
+     */
+    update2: (input: Basic.Update2Input) => Operation<Basic.Update2Output>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmProperties } from '@hubspot/api-client-core';
+   * client.send(crmProperties.batch.create(input));
+   * ```
+   */
+  export interface BatchAPI {
+    /**
+     * Create a batch of properties
+     * @apiPath /crm/properties/2026-03/{objectType}/batch/create
+     * @apiMethod POST
+     * @requiredScopes properties-settings-write
+     */
+    create: (input: Batch.CreateInput) => Operation<Batch.CreateOutput>;
+    /**
+     * Archive a batch of properties
+     * @apiPath /crm/properties/2026-03/{objectType}/batch/archive
+     * @apiMethod POST
+     * @requiredScopes properties-settings-write
+     */
+    delete: (input: Batch.DeleteInput) => Operation<Batch.DeleteOutput>;
+    /**
+     * Read a batch of properties
+     * @apiPath /crm/properties/2026-03/{objectType}/batch/read
+     * @apiMethod POST
+     * @requiredScopes properties-settings-read
+     */
+    get: (input: Batch.GetInput) => Operation<Batch.GetOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmProperties } from '@hubspot/api-client-core';
+   * client.send(crmProperties.basic.create(input));
+   * ```
+   */
+  export interface API {
+    basic: BasicAPI;
+    batch: BatchAPI;
+  }
+}