attio-js/dist/commonjs/sdk/objects.d.ts

Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.

import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import { GetV2ObjectsResponse } from "../models/operations/getv2objects.js";
import { GetV2ObjectsObjectRequest, GetV2ObjectsObjectResponse } from "../models/operations/getv2objectsobject.js";
import { PatchV2ObjectsObjectRequest, PatchV2ObjectsObjectResponse } from "../models/operations/patchv2objectsobject.js";
import { PostV2ObjectsRequest, PostV2ObjectsResponse } from "../models/operations/postv2objects.js";
export declare class Objects extends ClientSDK {
    /**
     * List objects
     *
     * @remarks
     * Lists all system-defined and user-defined objects in your workspace.
     *
     * Required scopes: `object_configuration:read`.
     */
    list(options?: RequestOptions): Promise<GetV2ObjectsResponse>;
    /**
     * Create an object
     *
     * @remarks
     * Creates a new custom object in your workspace.
     *
     * Required scopes: `object_configuration:read-write`.
     */
    create(request: PostV2ObjectsRequest, options?: RequestOptions): Promise<PostV2ObjectsResponse>;
    /**
     * Get an object
     *
     * @remarks
     * Gets a single object by its `object_id` or slug.
     *
     * Required scopes: `object_configuration:read`.
     */
    get(request: GetV2ObjectsObjectRequest, options?: RequestOptions): Promise<GetV2ObjectsObjectResponse>;
    /**
     * Update an object
     *
     * @remarks
     * Updates a single object. The object to be updated is identified by its `object_id`.
     *
     * Required scopes: `object_configuration:read-write`.
     */
    partialUpdate(request: PatchV2ObjectsObjectRequest, options?: RequestOptions): Promise<PatchV2ObjectsObjectResponse>;
}
//# sourceMappingURL=objects.d.ts.map