minikai 1.0.1

package/dist/cjs/api/resources/records/client/Client.d.ts

@@ -0,0 +1,448 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Minikai from "../../../index.js";
+export declare namespace RecordsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class RecordsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RecordsClient.Options>;
+    constructor(options: RecordsClient.Options);
+    /**
+     * List a Mini's Records.
+     *
+     * @param {Minikai.GetRecordsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.getRecords({
+     *         miniId: "miniId"
+     *     })
+     */
+    getRecords(request: Minikai.GetRecordsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.CursorPaginatedListOfRecordDto>;
+    private __getRecords;
+    /**
+     * Create a Record.
+     *
+     * @param {Minikai.CreateRecordCommand} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     *
+     * @example
+     *     await client.records.createRecord()
+     */
+    createRecord(request?: Minikai.CreateRecordCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __createRecord;
+    /**
+     * Export a Mini's Records as a CSV file.
+     *
+     * @param {Minikai.ExportRecordsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.exportRecords({
+     *         miniId: "miniId"
+     *     })
+     */
+    exportRecords(request: Minikai.ExportRecordsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __exportRecords;
+    /**
+     * Full-text search across a Mini's Records.
+     *
+     * @param {Minikai.SearchRecordsFullTextQuery} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     *
+     * @example
+     *     await client.records.searchRecords({
+     *         miniId: "miniId"
+     *     })
+     */
+    searchRecords(request: Minikai.SearchRecordsFullTextQuery, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.SearchResultOfRecordDto>;
+    private __searchRecords;
+    /**
+     * List a Record's version history.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.GetRecordVersionsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.getRecordVersions("recordId", {
+     *         miniId: "miniId"
+     *     })
+     */
+    getRecordVersions(recordId: string, request: Minikai.GetRecordVersionsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.CursorPaginatedListOfRecordVersionDto>;
+    private __getRecordVersions;
+    /**
+     * Update a Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.UpdateRecordCommand} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.updateRecord("recordId", {
+     *         title: "title"
+     *     })
+     */
+    updateRecord(recordId: string, request: Minikai.UpdateRecordCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __updateRecord;
+    /**
+     * Delete a Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.DeleteRecordRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.deleteRecord("recordId")
+     */
+    deleteRecord(recordId: string, request?: Minikai.DeleteRecordRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteRecord;
+    /**
+     * Restore a deleted Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.RestoreRecordRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.restoreRecord("recordId", {
+     *         miniId: "miniId"
+     *     })
+     */
+    restoreRecord(recordId: string, request: Minikai.RestoreRecordRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __restoreRecord;
+    /**
+     * Create a draft Record.
+     *
+     * @param {Minikai.CreateDraftRecordCommand} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     *
+     * @example
+     *     await client.records.createDraftRecord()
+     */
+    createDraftRecord(request?: Minikai.CreateDraftRecordCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __createDraftRecord;
+    /**
+     * Update a draft Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.UpdateDraftRecordCommand} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.updateDraftRecord("recordId")
+     */
+    updateDraftRecord(recordId: string, request?: Minikai.UpdateDraftRecordCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __updateDraftRecord;
+    /**
+     * Discard a draft Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.DisposeDraftRecordRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.disposeDraftRecord("recordId", {
+     *         miniId: "miniId"
+     *     })
+     */
+    disposeDraftRecord(recordId: string, request: Minikai.DisposeDraftRecordRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __disposeDraftRecord;
+    /**
+     * Submit a draft Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.SubmitDraftRecordRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.submitDraftRecord("recordId", {
+     *         miniId: "miniId"
+     *     })
+     */
+    submitDraftRecord(recordId: string, request: Minikai.SubmitDraftRecordRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __submitDraftRecord;
+    /**
+     * Create or update many Records in one request.
+     *
+     * @param {Minikai.UpsertRecordsByExternalUriCommand} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.records.batchUpsertRecords({
+     *         items: [{
+     *                 title: "title",
+     *                 miniId: "miniId"
+     *             }]
+     *     })
+     */
+    batchUpsertRecords(request: Minikai.UpsertRecordsByExternalUriCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.BatchUpsertResult>;
+    private __batchUpsertRecords;
+    /**
+     * Add attachments to many Records in one request.
+     *
+     * @param {Minikai.BatchAddAttachmentsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.records.batchAddAttachments({
+     *         files: ["files"],
+     *         items: "items"
+     *     })
+     */
+    batchAddAttachments(request: Minikai.BatchAddAttachmentsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.BatchAttachmentResult>;
+    private __batchAddAttachments;
+    /**
+     * @deprecated
+     *
+     * Deprecated. Create Records with attachments in one request. Use POST /Records/batch followed by POST /Records/batch/attachments instead.
+     *
+     * @param {Minikai.BatchUploadRecordsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.records.batchUploadRecords({
+     *         files: ["files"],
+     *         items: "items"
+     *     })
+     */
+    batchUploadRecords(request: Minikai.BatchUploadRecordsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.BatchUploadResult>;
+    private __batchUploadRecords;
+    /**
+     * @deprecated
+     *
+     * Deprecated. Look up Records by external URI. Use GET /Records with the externalUris query parameter instead.
+     *
+     * @param {Minikai.GetRecordsByExternalRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.getRecordsByExternal({
+     *         miniId: "miniId",
+     *         body: ["string"]
+     *     })
+     */
+    getRecordsByExternal(request: Minikai.GetRecordsByExternalRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.PaginatedListOfRecordDto>;
+    private __getRecordsByExternal;
+    /**
+     * @deprecated
+     *
+     * Deprecated. Create or update Records by external URI. Use POST /Records/batch instead.
+     *
+     * @param {Minikai.UpsertRecordsByExternalUriCommand} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.records.upsertRecordsByExternalUri({
+     *         items: [{
+     *                 title: "title",
+     *                 miniId: "miniId"
+     *             }]
+     *     })
+     */
+    upsertRecordsByExternalUri(request: Minikai.UpsertRecordsByExternalUriCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.BatchUpsertResult>;
+    private __upsertRecordsByExternalUri;
+    /**
+     * Add attachments to a Record.
+     *
+     * @param {string} recordId
+     * @param {Minikai.AddAttachmentsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.records.addAttachments("recordId", {
+     *         files: ["files"]
+     *     })
+     */
+    addAttachments(recordId: string, request: Minikai.AddAttachmentsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string[]>;
+    private __addAttachments;
+    /**
+     * Replace a Record's attachments.
+     *
+     * @param {string} recordId
+     * @param {Minikai.UpdateAttachmentsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.records.updateAttachments("recordId", {
+     *         files: ["files"]
+     *     })
+     */
+    updateAttachments(recordId: string, request: Minikai.UpdateAttachmentsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string[]>;
+    private __updateAttachments;
+    /**
+     * Remove attachments from a Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.RemoveAttachmentsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.removeAttachments("recordId", {
+     *         body: ["string"]
+     *     })
+     */
+    removeAttachments(recordId: string, request: Minikai.RemoveAttachmentsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __removeAttachments;
+    /**
+     * Download a Record's attachment.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {string} attachmentId
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.downloadAttachment("recordId", "attachmentId")
+     */
+    downloadAttachment(recordId: string, attachmentId: string, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __downloadAttachment;
+    /**
+     * Link a Record to other Records.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.RecordRelationDto[]} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.addRelations("recordId", [{}])
+     */
+    addRelations(recordId: string, request: Minikai.RecordRelationDto[], requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string[]>;
+    private __addRelations;
+    /**
+     * Replace a Record's relations.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {Minikai.RecordRelationDto[]} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.updateRelations("recordId", [{}])
+     */
+    updateRelations(recordId: string, request: Minikai.RecordRelationDto[], requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string[]>;
+    private __updateRelations;
+    /**
+     * Remove relations from a Record.
+     *
+     * @param {string} recordId - Either the Minikai-assigned Guid for this resource (e.g. `abc12345-1234-1234-1234-123456789abc`) or the resource's `externalUri`, URL-encoded (e.g. `https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291`). Responses always return the canonical Guid in the `id` field.
+     * @param {string[]} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     *
+     * @example
+     *     await client.records.removeRelations("recordId", ["string"])
+     */
+    removeRelations(recordId: string, request: string[], requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __removeRelations;
+    /**
+     * List the labels used by a Mini's Records.
+     *
+     * @param {Minikai.GetLabelsRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.getLabels({
+     *         miniId: "miniId"
+     *     })
+     */
+    getLabels(request: Minikai.GetLabelsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string[]>;
+    private __getLabels;
+    /**
+     * List the users who created a Mini's Records.
+     *
+     * @param {Minikai.GetCreatedByRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.getCreatedBy({
+     *         miniId: "miniId"
+     *     })
+     */
+    getCreatedBy(request: Minikai.GetCreatedByRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.UserDto[]>;
+    private __getCreatedBy;
+    /**
+     * List the users who updated a Mini's Records.
+     *
+     * @param {Minikai.GetUpdatedByRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.getUpdatedBy({
+     *         miniId: "miniId"
+     *     })
+     */
+    getUpdatedBy(request: Minikai.GetUpdatedByRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<Minikai.UserDto[]>;
+    private __getUpdatedBy;
+    /**
+     * List the states present on a Mini's Records.
+     *
+     * @param {Minikai.GetStatesRequest} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.records.getStates({
+     *         miniId: "miniId"
+     *     })
+     */
+    getStates(request: Minikai.GetStatesRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string[]>;
+    private __getStates;
+}