@nizam-os/operator-sdk 3.0.0 → 4.0.0

package/dist/api/resources/files/client/Client.d.ts

@@ -41,6 +41,7 @@ export declare class FilesClient {
      * @throws {@link NizamOperatorRuntime.BadRequestError}
      * @throws {@link NizamOperatorRuntime.UnauthorizedError}
      * @throws {@link NizamOperatorRuntime.ForbiddenError}
+     * @throws {@link NizamOperatorRuntime.ConflictError}
      * @throws {@link NizamOperatorRuntime.ContentTooLargeError}
      * @throws {@link NizamOperatorRuntime.UnprocessableEntityError}
      * @throws {@link NizamOperatorRuntime.TooManyRequestsError}
@@ -48,6 +49,7 @@ export declare class FilesClient {
      *
      * @example
      *     await client.files.initiateFileUpload({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         kind: "profile_picture",
      *         subject_type: "task_attempt",
      *         subject_id: "b3c4d5e6-7f8a-9b0c-1d2e-3f4a5b6c7d8e",

package/dist/api/resources/files/client/Client.js

@@ -137,6 +137,7 @@ class FilesClient {
      * @throws {@link NizamOperatorRuntime.BadRequestError}
      * @throws {@link NizamOperatorRuntime.UnauthorizedError}
      * @throws {@link NizamOperatorRuntime.ForbiddenError}
+     * @throws {@link NizamOperatorRuntime.ConflictError}
      * @throws {@link NizamOperatorRuntime.ContentTooLargeError}
      * @throws {@link NizamOperatorRuntime.UnprocessableEntityError}
      * @throws {@link NizamOperatorRuntime.TooManyRequestsError}
@@ -144,6 +145,7 @@ class FilesClient {
      *
      * @example
      *     await client.files.initiateFileUpload({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         kind: "profile_picture",
      *         subject_type: "task_attempt",
      *         subject_id: "b3c4d5e6-7f8a-9b0c-1d2e-3f4a5b6c7d8e",
@@ -157,8 +159,9 @@ class FilesClient {
         return core.HttpResponsePromise.fromPromise(this.__initiateFileUpload(request, requestOptions));
     }
     async __initiateFileUpload(request, requestOptions) {
+        const { "Idempotency-Key": idempotencyKey, ..._body } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
-        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "Idempotency-Key": idempotencyKey }), requestOptions?.headers);
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
@@ -168,7 +171,7 @@ class FilesClient {
             contentType: "application/json",
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
             requestType: "json",
-            body: request,
+            body: _body,
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
             maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
             abortSignal: requestOptions?.abortSignal,
@@ -189,6 +192,8 @@ class FilesClient {
                     throw new NizamOperatorRuntime.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 403:
                     throw new NizamOperatorRuntime.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 409:
+                    throw new NizamOperatorRuntime.ConflictError(_response.error.body, _response.rawResponse);
                 case 413:
                     throw new NizamOperatorRuntime.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 422:

package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.d.ts

@@ -1,6 +1,7 @@
 /**
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         kind: "profile_picture",
  *         subject_type: "task_attempt",
  *         subject_id: "b3c4d5e6-7f8a-9b0c-1d2e-3f4a5b6c7d8e",
@@ -11,6 +12,8 @@
  *     }
  */
 export interface InitiateFileUploadRequest {
+    /** Optional. Supply a UUID (canonical 8-4-4-4-12 form; lowercase v4 recommended) to make this operation idempotent: the same key on a retry replays the original outcome instead of creating a second resource. 2xx successes and deliberate 4xx domain rejections are cached and replayed for 24h when the request body matches; transient 5xx responses are never cached, so a retry with the same key re-executes. A malformed key is rejected with 400 `idempotency.invalid_key`; reusing a key with a different request body is 409 `idempotency.key_conflict`; a key still in flight is 409 `idempotency.in_progress`. Omit the header and the operation behaves like any other write. */
+    "Idempotency-Key"?: string;
     /** What the bytes are for the platform — fixes the policy applied to them. */
     kind: InitiateFileUploadRequest.Kind;
     /** Type of the business entity this file documents (optional at upload time; can also be attached later). */

package/dist/api/resources/taskAttempts/client/Client.d.ts

@@ -42,6 +42,7 @@ export declare class TaskAttemptsClient {
      * @throws {@link NizamOperatorRuntime.UnauthorizedError}
      * @throws {@link NizamOperatorRuntime.ForbiddenError}
      * @throws {@link NizamOperatorRuntime.NotFoundError}
+     * @throws {@link NizamOperatorRuntime.ConflictError}
      * @throws {@link NizamOperatorRuntime.ContentTooLargeError}
      * @throws {@link NizamOperatorRuntime.UnprocessableEntityError}
      * @throws {@link NizamOperatorRuntime.TooManyRequestsError}
@@ -49,6 +50,7 @@ export declare class TaskAttemptsClient {
      *
      * @example
      *     await client.taskAttempts.captureTaskAttemptPhoto({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         attemptId: "00000000-0000-0000-0000-000000000000",
      *         filename: "delivery-door.jpg",
      *         content_type: "image/jpeg",

package/dist/api/resources/taskAttempts/client/Client.js

@@ -135,6 +135,7 @@ class TaskAttemptsClient {
      * @throws {@link NizamOperatorRuntime.UnauthorizedError}
      * @throws {@link NizamOperatorRuntime.ForbiddenError}
      * @throws {@link NizamOperatorRuntime.NotFoundError}
+     * @throws {@link NizamOperatorRuntime.ConflictError}
      * @throws {@link NizamOperatorRuntime.ContentTooLargeError}
      * @throws {@link NizamOperatorRuntime.UnprocessableEntityError}
      * @throws {@link NizamOperatorRuntime.TooManyRequestsError}
@@ -142,6 +143,7 @@ class TaskAttemptsClient {
      *
      * @example
      *     await client.taskAttempts.captureTaskAttemptPhoto({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         attemptId: "00000000-0000-0000-0000-000000000000",
      *         filename: "delivery-door.jpg",
      *         content_type: "image/jpeg",
@@ -157,9 +159,9 @@ class TaskAttemptsClient {
         return core.HttpResponsePromise.fromPromise(this.__captureTaskAttemptPhoto(request, requestOptions));
     }
     async __captureTaskAttemptPhoto(request, requestOptions) {
-        const { attemptId, ..._body } = request;
+        const { attemptId, "Idempotency-Key": idempotencyKey, ..._body } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
-        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "Idempotency-Key": idempotencyKey }), requestOptions?.headers);
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
@@ -192,6 +194,8 @@ class TaskAttemptsClient {
                     throw new NizamOperatorRuntime.ForbiddenError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new NizamOperatorRuntime.NotFoundError(_response.error.body, _response.rawResponse);
+                case 409:
+                    throw new NizamOperatorRuntime.ConflictError(_response.error.body, _response.rawResponse);
                 case 413:
                     throw new NizamOperatorRuntime.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 422:

package/dist/api/resources/taskAttempts/client/requests/CaptureTaskAttemptPhotoRequest.d.ts

@@ -1,6 +1,7 @@
 /**
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         attemptId: "00000000-0000-0000-0000-000000000000",
  *         filename: "delivery-door.jpg",
  *         content_type: "image/jpeg",
@@ -14,6 +15,8 @@
  */
 export interface CaptureTaskAttemptPhotoRequest {
     attemptId: string;
+    /** Optional. Supply a UUID (canonical 8-4-4-4-12 form; lowercase v4 recommended) to make this operation idempotent: the same key on a retry replays the original outcome instead of creating a second resource. 2xx successes and deliberate 4xx domain rejections are cached and replayed for 24h when the request body matches; transient 5xx responses are never cached, so a retry with the same key re-executes. A malformed key is rejected with 400 `idempotency.invalid_key`; reusing a key with a different request body is 409 `idempotency.key_conflict`; a key still in flight is 409 `idempotency.in_progress`. Omit the header and the operation behaves like any other write. */
+    "Idempotency-Key"?: string;
     /** Original filename. */
     filename: string;
     /** Declared MIME type — POD photos accept image/jpeg, image/png, image/webp, image/heic, image/heif. */

package/dist/api/types/Device.d.ts

@@ -5,9 +5,9 @@ export interface Device {
     /** Device id. */
     id?: string | undefined;
     /** Push transport. */
-    platform?: string | undefined;
+    platform?: Device.Platform | undefined;
     /** Registration lifecycle. */
-    status?: string | undefined;
+    status?: Device.Status | undefined;
     /** When the device was first registered. */
     registered_at?: string | undefined;
     /** When the registration was last refreshed (last seen). */
@@ -16,6 +16,21 @@ export interface Device {
     object?: Device.Object_ | undefined;
 }
 export declare namespace Device {
+    /** Push transport. */
+    const Platform: {
+        readonly Ios: "ios";
+        readonly Android: "android";
+        readonly Web: "web";
+    };
+    type Platform = (typeof Platform)[keyof typeof Platform];
+    /** Registration lifecycle. */
+    const Status: {
+        readonly Active: "active";
+        readonly Suspended: "suspended";
+        readonly Inactive: "inactive";
+        readonly Expired: "expired";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
     /** Object type discriminator. */
     const Object_: {
         readonly Device: "device";

package/dist/api/types/Device.js

@@ -4,6 +4,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Device = void 0;
 var Device;
 (function (Device) {
+    /** Push transport. */
+    Device.Platform = {
+        Ios: "ios",
+        Android: "android",
+        Web: "web",
+    };
+    /** Registration lifecycle. */
+    Device.Status = {
+        Active: "active",
+        Suspended: "suspended",
+        Inactive: "inactive",
+        Expired: "expired",
+    };
     /** Object type discriminator. */
     Device.Object_ = {
         Device: "device",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/operator-sdk",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Nizam Operator API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,