@linkt/sdk 0.2.0

package/resources/sheet/schema.d.mts

@@ -0,0 +1,207 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Schema extends APIResource {
+    /**
+     * Add custom fields to a sheet's entity schema.
+     *
+     * Custom fields extend the default schema to capture additional data points for
+     * entities in this sheet.
+     */
+    addFields(sheetID: string, body: SchemaAddFieldsParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Remove custom fields from a sheet's entity schema.
+     *
+     * Only custom fields can be removed; default fields cannot be deleted. Existing
+     * entity data in removed fields remains in the database but becomes inaccessible.
+     */
+    deleteFields(sheetID: string, body: SchemaDeleteFieldsParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get the schema for a specific sheet.
+     *
+     * Returns the sheet's current schema including default fields and any custom
+     * fields that have been added.
+     */
+    get(sheetID: string, options?: RequestOptions): APIPromise<SchemaGetResponse>;
+    /**
+     * Get the default schemas for all entity types.
+     *
+     * Returns JSON Schema definitions for company, person, job_board, and
+     * school_district entity types. Use this to understand the standard fields
+     * available before adding custom fields.
+     */
+    getDefault(options?: RequestOptions): APIPromise<SchemaGetDefaultResponse>;
+    /**
+     * Get the available field type definitions.
+     *
+     * Returns JSON Schema definitions for field types that can be used when adding
+     * custom fields to sheets.
+     */
+    getFieldDefinitions(options?: RequestOptions): APIPromise<SchemaGetFieldDefinitionsResponse>;
+}
+/**
+ * JSON schema for the sheet.
+ */
+export interface SchemaGetResponse {
+    /**
+     * The title of the schema
+     */
+    title: string;
+    /**
+     * The type of the schema
+     */
+    type: string;
+    /**
+     * Definitions for nested schemas
+     */
+    $defs?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The properties of the schema
+     */
+    properties?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Required fields in the schema
+     */
+    required?: Array<string>;
+}
+/**
+ * List of default schemas for sheets.
+ */
+export interface SchemaGetDefaultResponse {
+    schemas: {
+        [key: string]: SchemaGetDefaultResponse.Schemas;
+    };
+}
+export declare namespace SchemaGetDefaultResponse {
+    /**
+     * JSON schema for the sheet.
+     */
+    interface Schemas {
+        /**
+         * The title of the schema
+         */
+        title: string;
+        /**
+         * The type of the schema
+         */
+        type: string;
+        /**
+         * Definitions for nested schemas
+         */
+        $defs?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The properties of the schema
+         */
+        properties?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Required fields in the schema
+         */
+        required?: Array<string>;
+    }
+}
+/**
+ * List of default field definitions for sheets.
+ */
+export interface SchemaGetFieldDefinitionsResponse {
+    fields: {
+        [key: string]: SchemaGetFieldDefinitionsResponse.Fields;
+    };
+}
+export declare namespace SchemaGetFieldDefinitionsResponse {
+    /**
+     * JSON schema for the sheet.
+     */
+    interface Fields {
+        /**
+         * The title of the schema
+         */
+        title: string;
+        /**
+         * The type of the schema
+         */
+        type: string;
+        /**
+         * Definitions for nested schemas
+         */
+        $defs?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The properties of the schema
+         */
+        properties?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Required fields in the schema
+         */
+        required?: Array<string>;
+    }
+}
+export interface SchemaAddFieldsParams {
+    fields: Array<SchemaAddFieldsParams.Field>;
+}
+export declare namespace SchemaAddFieldsParams {
+    /**
+     * Definition for a custom field in a sheet.
+     */
+    interface Field {
+        /**
+         * Field type
+         */
+        field_type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'reference' | 'enum';
+        /**
+         * Field name
+         */
+        name: string;
+        /**
+         * Additional JSON schema properties
+         */
+        additional_props?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Schema for array items when field_type is ARRAY
+         */
+        array_items?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * Field description
+         */
+        description?: string;
+        /**
+         * List of allowed values when field_type is ENUM
+         */
+        enum_values?: Array<unknown> | null;
+        /**
+         * Properties for object fields when field_type is OBJECT
+         */
+        properties?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * Referenced model name when field_type is REFERENCE
+         */
+        reference_model?: string | null;
+        /**
+         * Whether field is required - always false for custom fields
+         */
+        required?: boolean;
+    }
+}
+export interface SchemaDeleteFieldsParams {
+    fields: Array<string>;
+}
+export declare namespace Schema {
+    export { type SchemaGetResponse as SchemaGetResponse, type SchemaGetDefaultResponse as SchemaGetDefaultResponse, type SchemaGetFieldDefinitionsResponse as SchemaGetFieldDefinitionsResponse, type SchemaAddFieldsParams as SchemaAddFieldsParams, type SchemaDeleteFieldsParams as SchemaDeleteFieldsParams, };
+}
+//# sourceMappingURL=schema.d.mts.map

package/resources/sheet/schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.mts","sourceRoot":"","sources":["../../src/resources/sheet/schema.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQzG;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7E;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI1E;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAA;KAAE,CAAC;CAC9D;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEnC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iCAAiC,CAAC,MAAM,CAAA;KAAE,CAAC;CACrE;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEnC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,KAAK,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;CAC5C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAC;QAEpG;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,gBAAgB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE9C;;WAEG;QACH,WAAW,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEhD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE/C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/sheet/schema.d.ts

@@ -0,0 +1,207 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Schema extends APIResource {
+    /**
+     * Add custom fields to a sheet's entity schema.
+     *
+     * Custom fields extend the default schema to capture additional data points for
+     * entities in this sheet.
+     */
+    addFields(sheetID: string, body: SchemaAddFieldsParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Remove custom fields from a sheet's entity schema.
+     *
+     * Only custom fields can be removed; default fields cannot be deleted. Existing
+     * entity data in removed fields remains in the database but becomes inaccessible.
+     */
+    deleteFields(sheetID: string, body: SchemaDeleteFieldsParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get the schema for a specific sheet.
+     *
+     * Returns the sheet's current schema including default fields and any custom
+     * fields that have been added.
+     */
+    get(sheetID: string, options?: RequestOptions): APIPromise<SchemaGetResponse>;
+    /**
+     * Get the default schemas for all entity types.
+     *
+     * Returns JSON Schema definitions for company, person, job_board, and
+     * school_district entity types. Use this to understand the standard fields
+     * available before adding custom fields.
+     */
+    getDefault(options?: RequestOptions): APIPromise<SchemaGetDefaultResponse>;
+    /**
+     * Get the available field type definitions.
+     *
+     * Returns JSON Schema definitions for field types that can be used when adding
+     * custom fields to sheets.
+     */
+    getFieldDefinitions(options?: RequestOptions): APIPromise<SchemaGetFieldDefinitionsResponse>;
+}
+/**
+ * JSON schema for the sheet.
+ */
+export interface SchemaGetResponse {
+    /**
+     * The title of the schema
+     */
+    title: string;
+    /**
+     * The type of the schema
+     */
+    type: string;
+    /**
+     * Definitions for nested schemas
+     */
+    $defs?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The properties of the schema
+     */
+    properties?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Required fields in the schema
+     */
+    required?: Array<string>;
+}
+/**
+ * List of default schemas for sheets.
+ */
+export interface SchemaGetDefaultResponse {
+    schemas: {
+        [key: string]: SchemaGetDefaultResponse.Schemas;
+    };
+}
+export declare namespace SchemaGetDefaultResponse {
+    /**
+     * JSON schema for the sheet.
+     */
+    interface Schemas {
+        /**
+         * The title of the schema
+         */
+        title: string;
+        /**
+         * The type of the schema
+         */
+        type: string;
+        /**
+         * Definitions for nested schemas
+         */
+        $defs?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The properties of the schema
+         */
+        properties?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Required fields in the schema
+         */
+        required?: Array<string>;
+    }
+}
+/**
+ * List of default field definitions for sheets.
+ */
+export interface SchemaGetFieldDefinitionsResponse {
+    fields: {
+        [key: string]: SchemaGetFieldDefinitionsResponse.Fields;
+    };
+}
+export declare namespace SchemaGetFieldDefinitionsResponse {
+    /**
+     * JSON schema for the sheet.
+     */
+    interface Fields {
+        /**
+         * The title of the schema
+         */
+        title: string;
+        /**
+         * The type of the schema
+         */
+        type: string;
+        /**
+         * Definitions for nested schemas
+         */
+        $defs?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The properties of the schema
+         */
+        properties?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Required fields in the schema
+         */
+        required?: Array<string>;
+    }
+}
+export interface SchemaAddFieldsParams {
+    fields: Array<SchemaAddFieldsParams.Field>;
+}
+export declare namespace SchemaAddFieldsParams {
+    /**
+     * Definition for a custom field in a sheet.
+     */
+    interface Field {
+        /**
+         * Field type
+         */
+        field_type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'reference' | 'enum';
+        /**
+         * Field name
+         */
+        name: string;
+        /**
+         * Additional JSON schema properties
+         */
+        additional_props?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Schema for array items when field_type is ARRAY
+         */
+        array_items?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * Field description
+         */
+        description?: string;
+        /**
+         * List of allowed values when field_type is ENUM
+         */
+        enum_values?: Array<unknown> | null;
+        /**
+         * Properties for object fields when field_type is OBJECT
+         */
+        properties?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * Referenced model name when field_type is REFERENCE
+         */
+        reference_model?: string | null;
+        /**
+         * Whether field is required - always false for custom fields
+         */
+        required?: boolean;
+    }
+}
+export interface SchemaDeleteFieldsParams {
+    fields: Array<string>;
+}
+export declare namespace Schema {
+    export { type SchemaGetResponse as SchemaGetResponse, type SchemaGetDefaultResponse as SchemaGetDefaultResponse, type SchemaGetFieldDefinitionsResponse as SchemaGetFieldDefinitionsResponse, type SchemaAddFieldsParams as SchemaAddFieldsParams, type SchemaDeleteFieldsParams as SchemaDeleteFieldsParams, };
+}
+//# sourceMappingURL=schema.d.ts.map

package/resources/sheet/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/resources/sheet/schema.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQzG;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7E;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI1E;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAA;KAAE,CAAC;CAC9D;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEnC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iCAAiC,CAAC,MAAM,CAAA;KAAE,CAAC;CACrE;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEnC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,KAAK,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;CAC5C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAC;QAEpG;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,gBAAgB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE9C;;WAEG;QACH,WAAW,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEhD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE/C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/sheet/schema.js

@@ -0,0 +1,65 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class Schema extends resource_1.APIResource {
+    /**
+     * Add custom fields to a sheet's entity schema.
+     *
+     * Custom fields extend the default schema to capture additional data points for
+     * entities in this sheet.
+     */
+    addFields(sheetID, body, options) {
+        return this._client.put((0, path_1.path) `/v1/sheet/schema/${sheetID}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Remove custom fields from a sheet's entity schema.
+     *
+     * Only custom fields can be removed; default fields cannot be deleted. Existing
+     * entity data in removed fields remains in the database but becomes inaccessible.
+     */
+    deleteFields(sheetID, body, options) {
+        return this._client.delete((0, path_1.path) `/v1/sheet/schema/${sheetID}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get the schema for a specific sheet.
+     *
+     * Returns the sheet's current schema including default fields and any custom
+     * fields that have been added.
+     */
+    get(sheetID, options) {
+        return this._client.get((0, path_1.path) `/v1/sheet/schema/${sheetID}`, options);
+    }
+    /**
+     * Get the default schemas for all entity types.
+     *
+     * Returns JSON Schema definitions for company, person, job_board, and
+     * school_district entity types. Use this to understand the standard fields
+     * available before adding custom fields.
+     */
+    getDefault(options) {
+        return this._client.get('/v1/sheet/schema/default', options);
+    }
+    /**
+     * Get the available field type definitions.
+     *
+     * Returns JSON Schema definitions for field types that can be used when adding
+     * custom fields to sheets.
+     */
+    getFieldDefinitions(options) {
+        return this._client.get('/v1/sheet/schema/field', options);
+    }
+}
+exports.Schema = Schema;
+//# sourceMappingURL=schema.js.map

package/resources/sheet/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/resources/sheet/schema.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;OAKG;IACH,SAAS,CAAC,OAAe,EAAE,IAA2B,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,OAAO,EAAE,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,OAAe,EAAE,IAA8B,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,oBAAoB,OAAO,EAAE,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,OAAe,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AA3DD,wBA2DC"}

package/resources/sheet/schema.mjs

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Schema extends APIResource {
+    /**
+     * Add custom fields to a sheet's entity schema.
+     *
+     * Custom fields extend the default schema to capture additional data points for
+     * entities in this sheet.
+     */
+    addFields(sheetID, body, options) {
+        return this._client.put(path `/v1/sheet/schema/${sheetID}`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Remove custom fields from a sheet's entity schema.
+     *
+     * Only custom fields can be removed; default fields cannot be deleted. Existing
+     * entity data in removed fields remains in the database but becomes inaccessible.
+     */
+    deleteFields(sheetID, body, options) {
+        return this._client.delete(path `/v1/sheet/schema/${sheetID}`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get the schema for a specific sheet.
+     *
+     * Returns the sheet's current schema including default fields and any custom
+     * fields that have been added.
+     */
+    get(sheetID, options) {
+        return this._client.get(path `/v1/sheet/schema/${sheetID}`, options);
+    }
+    /**
+     * Get the default schemas for all entity types.
+     *
+     * Returns JSON Schema definitions for company, person, job_board, and
+     * school_district entity types. Use this to understand the standard fields
+     * available before adding custom fields.
+     */
+    getDefault(options) {
+        return this._client.get('/v1/sheet/schema/default', options);
+    }
+    /**
+     * Get the available field type definitions.
+     *
+     * Returns JSON Schema definitions for field types that can be used when adding
+     * custom fields to sheets.
+     */
+    getFieldDefinitions(options) {
+        return this._client.get('/v1/sheet/schema/field', options);
+    }
+}
+//# sourceMappingURL=schema.mjs.map

package/resources/sheet/schema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.mjs","sourceRoot":"","sources":["../../src/resources/sheet/schema.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,SAAS,CAAC,OAAe,EAAE,IAA2B,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,OAAO,EAAE,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,OAAe,EAAE,IAA8B,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,oBAAoB,OAAO,EAAE,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,OAAe,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}