minikai 1.8.0 → 1.18.0

package/README.md

@@ -14,6 +14,7 @@ The Minikai TypeScript library provides convenient access to the Minikai APIs fr
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
 - [File Uploads](#file-uploads)
+- [Binary Response](#binary-response)
 - [Advanced](#advanced)
   - [Subpackage Exports](#subpackage-exports)
   - [Additional Headers](#additional-headers)
@@ -140,6 +141,395 @@ The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-D
 For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
 
 
+## Binary Response
+
+You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
+
+```typescript
+const response = await client.minis.downloadMiniProfilePicture(...);
+const stream: ReadableStream<Uint8Array> = response.stream();
+// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
+// const blob: Blob = response.blob();
+// const bytes: Uint8Array = response.bytes();
+// You can only use the response body once, so you must choose one of the above methods.
+// If you want to check if the response body has been used, you can use the following property.
+const bodyUsed = response.bodyUsed;
+```
+<details>
+<summary>Save binary response to a file</summary>
+
+<blockquote>
+<details>
+<summary>Node.js</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+import { createWriteStream } from 'fs';
+import { Readable } from 'stream';
+import { pipeline } from 'stream/promises';
+
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const stream = response.stream();
+const nodeStream = Readable.fromWeb(stream);
+const writeStream = createWriteStream('path/to/file');
+
+await pipeline(nodeStream, writeStream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await writeFile('path/to/file', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await writeFile('output.bin', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const bytes = await response.bytes();
+await writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bun</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const stream = response.stream();
+await Bun.write('path/to/file', stream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Bun.write('path/to/file', arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const blob = await response.blob();
+await Bun.write('path/to/file', blob);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const bytes = await response.bytes();
+await Bun.write('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Deno</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const stream = response.stream();
+const file = await Deno.open('path/to/file', { write: true, create: true });
+await stream.pipeTo(file.writable);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const bytes = await response.bytes();
+await Deno.writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Browser</summary>
+
+<blockquote>
+<details>
+<summary>Blob (most-efficient)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const blob = await response.blob();
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const stream = response.stream();
+const reader = stream.getReader();
+const chunks = [];
+
+while (true) {
+  const { done, value } = await reader.read();
+  if (done) break;
+  chunks.push(value);
+}
+
+const blob = new Blob(chunks);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const blob = new Blob([arrayBuffer]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const bytes = await response.bytes();
+const blob = new Blob([bytes]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<details>
+<summary>Convert binary response to text</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const stream = response.stream();
+const text = await new Response(stream).text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const text = new TextDecoder().decode(arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const blob = await response.blob();
+const text = await blob.text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.minis.downloadMiniProfilePicture(...);
+
+const bytes = await response.bytes();
+const text = new TextDecoder().decode(bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+
 ## Advanced
 
 ### Subpackage Exports

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "minikai",
-        "X-Fern-SDK-Version": "1.8.0",
-        "User-Agent": "minikai/1.8.0",
+        "X-Fern-SDK-Version": "1.18.0",
+        "User-Agent": "minikai/1.18.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -40,7 +40,7 @@ export declare class LabelsClient {
     createLabel(request: Minikai.CreateLabelCommand, requestOptions?: LabelsClient.RequestOptions): core.HttpResponsePromise<Minikai.LabelDto>;
     private __createLabel;
     /**
-     * Update a label.
+     * Update a label. Records and Minis reference labels by name, so changing the name moves them onto the new one in the background: the response carries a rename state that clears once they have all moved, and further edits are refused until then.
      *
      * @param {string} id
      * @param {Minikai.UpdateLabelCommand} request
@@ -57,7 +57,7 @@ export declare class LabelsClient {
     updateLabel(id: string, request: Minikai.UpdateLabelCommand, requestOptions?: LabelsClient.RequestOptions): core.HttpResponsePromise<Minikai.LabelDto>;
     private __updateLabel;
     /**
-     * Delete a label.
+     * Delete a label. Refused with a 409 while any record or Mini still carries it, naming how many. Remove it from them first.
      *
      * @param {string} id
      * @param {LabelsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/labels/client/Client.js

@@ -166,7 +166,7 @@ class LabelsClient {
         });
     }
     /**
-     * Update a label.
+     * Update a label. Records and Minis reference labels by name, so changing the name moves them onto the new one in the background: the response carries a rename state that clears once they have all moved, and further edits are refused until then.
      *
      * @param {string} id
      * @param {Minikai.UpdateLabelCommand} request
@@ -223,7 +223,7 @@ class LabelsClient {
         });
     }
     /**
-     * Delete a label.
+     * Delete a label. Refused with a 409 while any record or Mini still carries it, naming how many. Remove it from them first.
      *
      * @param {string} id
      * @param {LabelsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/labels/client/requests/UpdateLabelCommand.d.ts

@@ -1,3 +1,4 @@
+import type * as Minikai from "../../../../index.js";
 /**
  * @example
  *     {
@@ -10,6 +11,6 @@ export interface UpdateLabelCommand {
     description?: string | null;
     colour?: string | null;
     icon?: string | null;
-    resourceType?: string | null;
+    resourceType?: Minikai.LabelResourceType | null;
     labelGroupId?: string | null;
 }

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

@@ -176,7 +176,7 @@ export declare class MinisClient {
      * Retrieve a single version of a Mini.
      *
      * @param {string} id - 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} versionId - 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} versionId
      * @param {MinisClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Minikai.NotFoundError}
@@ -217,4 +217,11 @@ export declare class MinisClient {
      */
     deleteMiniProfilePicture(id: string, requestOptions?: MinisClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteMiniProfilePicture;
+    /**
+     * Download a Mini's profile picture by its stored picture id.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     */
+    downloadMiniProfilePicture(id: string, pictureId: string, requestOptions?: MinisClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __downloadMiniProfilePicture;
 }

package/dist/cjs/api/resources/minis/client/Client.js

@@ -656,7 +656,7 @@ class MinisClient {
      * Retrieve a single version of a Mini.
      *
      * @param {string} id - 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} versionId - 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} versionId
      * @param {MinisClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Minikai.NotFoundError}
@@ -810,5 +810,48 @@ class MinisClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/api/v1/Minis/{id}/profile-picture");
         });
     }
+    /**
+     * Download a Mini's profile picture by its stored picture id.
+     *
+     * @throws {@link Minikai.NotFoundError}
+     */
+    downloadMiniProfilePicture(id, pictureId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__downloadMiniProfilePicture(id, pictureId, requestOptions));
+    }
+    __downloadMiniProfilePicture(id, pictureId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MinikaiEnvironment.Default, `api/v1/Minis/${core.url.encodePathParam(id)}/profile-picture/${core.url.encodePathParam(pictureId)}`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "binary-response",
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new Minikai.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.MinikaiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/api/v1/Minis/{id}/profile-picture/{pictureId}");
+        });
+    }
 }
 exports.MinisClient = MinisClient;

package/dist/cjs/api/resources/minis/client/requests/SearchMinisFullTextQuery.d.ts

@@ -6,7 +6,7 @@ import type * as Minikai from "../../../../index.js";
 export interface SearchMinisFullTextQuery {
     text?: string;
     labels?: string[] | null;
-    agentType?: string | null;
+    agentType?: Minikai.AgentType | null;
     cursor?: string | null;
     limit?: unknown;
     sort?: Minikai.SearchSort;

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

@@ -37,7 +37,9 @@ export declare class RecordsClient {
     createRecord(request?: Minikai.CreateRecordCommand, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<string>;
     private __createRecord;
     /**
-     * Export a Mini's Records as a CSV file.
+     * @deprecated
+     *
+     * Deprecated. Export a single Mini's Records as a CSV file. Use POST /api/v1/Records/export, which exports one or more Minis in a single file.
      *
      * @param {Minikai.ExportRecordsRequest} request
      * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -49,6 +51,21 @@ export declare class RecordsClient {
      */
     exportRecords(request: Minikai.ExportRecordsRequest, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __exportRecords;
+    /**
+     * Export Records across one or more Minis as a single CSV file, with a Mini Name column identifying the person on each row. Pass one Mini id to export a single Mini. Mini ids outside your organisation or access are omitted.
+     *
+     * @param {Minikai.ExportRecordsForMinisQuery} request
+     * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Minikai.BadRequestError}
+     *
+     * @example
+     *     await client.records.exportRecordsForMinis({
+     *         miniIds: ["miniIds"]
+     *     })
+     */
+    exportRecordsForMinis(request: Minikai.ExportRecordsForMinisQuery, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __exportRecordsForMinis;
     /**
      * Full-text search across a Mini's Records.
      *
@@ -356,16 +373,9 @@ export declare class RecordsClient {
     /**
      * 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>;
+    downloadAttachment(recordId: string, attachmentId: string, requestOptions?: RecordsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
     private __downloadAttachment;
     /**
      * Link a Record to other Records.
@@ -421,6 +431,8 @@ export declare class RecordsClient {
      * @param {Minikai.GetLabelsRequest} request
      * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Minikai.BadRequestError}
+     *
      * @example
      *     await client.records.getLabels({
      *         miniId: "miniId"
@@ -434,6 +446,8 @@ export declare class RecordsClient {
      * @param {Minikai.GetCreatedByRequest} request
      * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Minikai.BadRequestError}
+     *
      * @example
      *     await client.records.getCreatedBy({
      *         miniId: "miniId"
@@ -447,6 +461,8 @@ export declare class RecordsClient {
      * @param {Minikai.GetUpdatedByRequest} request
      * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Minikai.BadRequestError}
+     *
      * @example
      *     await client.records.getUpdatedBy({
      *         miniId: "miniId"
@@ -460,6 +476,8 @@ export declare class RecordsClient {
      * @param {Minikai.GetStatesRequest} request
      * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Minikai.BadRequestError}
+     *
      * @example
      *     await client.records.getStates({
      *         miniId: "miniId"