@nizam-os/carrier-sdk 2.5.0 → 2.5.2

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

@@ -22,6 +22,8 @@ export interface AssetListItem {
     organization_id?: string | undefined;
     /** Current primary operator (active assignment, role=primary). */
     current_primary_operator_id?: string | undefined;
+    /** Creation timestamp (ISO-8601 UTC). */
+    created_at?: string | undefined;
     /** Relevance score (descending) when the request carried `q`; 0 for plain listings. Scores are only comparable within a single response. */
     rank?: number | undefined;
     /** Highlighted match fragment when the request carried `q&highlight=true`. Matched terms are wrapped in `<mark>…</mark>`. */

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

@@ -0,0 +1,15 @@
+/**
+ * Acknowledgement of a bulk admin action that fanned out one job per work item.
+ */
+export interface BulkJobSubmission {
+    job_ids?: string[] | undefined;
+    /** Number of jobs created (one per matched service account). */
+    count?: number | undefined;
+    object?: BulkJobSubmission.Object_ | undefined;
+}
+export declare namespace BulkJobSubmission {
+    const Object_: {
+        readonly BulkJobSubmission: "bulk_job_submission";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/BulkJobSubmission.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkJobSubmission = void 0;
+var BulkJobSubmission;
+(function (BulkJobSubmission) {
+    BulkJobSubmission.Object_ = {
+        BulkJobSubmission: "bulk_job_submission",
+    };
+})(BulkJobSubmission || (exports.BulkJobSubmission = BulkJobSubmission = {}));

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

@@ -0,0 +1,66 @@
+/**
+ * A long-running, retryable, operator-visible unit of work — bulk imports, exports, backfills, cache rebuilds. The job row is the persistent handle; the executing engine (Temporal workflow or lease worker, declared per kind) reports progress into it. Cancellation is cooperative: already-running work continues until the engine's next checkpoint.
+ */
+export interface Job {
+    /** Stable job id. */
+    id?: string | undefined;
+    /** Owning organization. */
+    organization_id?: string | undefined;
+    /** What kind of work this job performs; the kind also fixes the executing engine. */
+    kind?: Job.Kind | undefined;
+    /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
+    status?: Job.Status | undefined;
+    /** User who submitted the job. Null only if that user was since deleted. */
+    requested_by_id?: string | undefined;
+    /** Input handle the job consumes (kind-specific), e.g. an uploaded import file. */
+    source_uri?: string | undefined;
+    /** Artifact produced by a completed job (kind-specific), e.g. a result report. */
+    report_uri?: string | undefined;
+    /** Total work items, once the engine has sized the work. Null while unknown. */
+    rows_total?: number | undefined;
+    /** Work items processed so far (monotonic). */
+    rows_processed?: number | undefined;
+    /** Work items that failed so far (monotonic). */
+    rows_failed?: number | undefined;
+    /** Operator-facing failure reason. Set only when status is `failed`. */
+    error_summary?: string | undefined;
+    /** Temporal workflow id (Temporal-engine kinds only) — cross-reference into the Temporal UI. */
+    workflow_id?: string | undefined;
+    /** Temporal run id of the latest attempt (changes across workflow retries). */
+    run_id?: string | undefined;
+    /** Engine execution attempts spent so far. */
+    attempt_count?: number | undefined;
+    /** Retry budget: a failed job with attempt_count >= max_attempts is dead-lettered. */
+    max_attempts?: number | undefined;
+    /** When the first engine attempt started. Null while pending (and for jobs cancelled before starting). */
+    started_at?: string | undefined;
+    /** When the job reached a terminal status. */
+    finished_at?: string | undefined;
+    /** Submission time. */
+    created_at?: string | undefined;
+    /** Last state/progress change. */
+    updated_at?: string | undefined;
+    object?: Job.Object_ | undefined;
+}
+export declare namespace Job {
+    /** What kind of work this job performs; the kind also fixes the executing engine. */
+    const Kind: {
+        readonly MembershipCacheRebuild: "membership_cache_rebuild";
+        readonly ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration";
+    };
+    type Kind = (typeof Kind)[keyof typeof Kind];
+    /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
+    const Status: {
+        readonly Pending: "pending";
+        readonly Running: "running";
+        readonly Cancelling: "cancelling";
+        readonly Completed: "completed";
+        readonly Failed: "failed";
+        readonly Cancelled: "cancelled";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Object_: {
+        readonly Job: "job";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/Job.js

@@ -0,0 +1,24 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+var Job;
+(function (Job) {
+    /** What kind of work this job performs; the kind also fixes the executing engine. */
+    Job.Kind = {
+        MembershipCacheRebuild: "membership_cache_rebuild",
+        ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration",
+    };
+    /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
+    Job.Status = {
+        Pending: "pending",
+        Running: "running",
+        Cancelling: "cancelling",
+        Completed: "completed",
+        Failed: "failed",
+        Cancelled: "cancelled",
+    };
+    Job.Object_ = {
+        Job: "job",
+    };
+})(Job || (exports.Job = Job = {}));

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

@@ -0,0 +1,14 @@
+/**
+ * Acknowledgement that a job was submitted to its engine.
+ */
+export interface JobSubmission {
+    /** The created job — poll/cancel it via /v1/jobs/{id}. */
+    job_id?: string | undefined;
+    object?: JobSubmission.Object_ | undefined;
+}
+export declare namespace JobSubmission {
+    const Object_: {
+        readonly JobSubmission: "job_submission";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/JobSubmission.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobSubmission = void 0;
+var JobSubmission;
+(function (JobSubmission) {
+    JobSubmission.Object_ = {
+        JobSubmission: "job_submission",
+    };
+})(JobSubmission || (exports.JobSubmission = JobSubmission = {}));

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

@@ -0,0 +1,27 @@
+import type * as NizamCarrier from "../index.js";
+/**
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
+ */
+export interface ListResponseJob {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    object?: ListResponseJob.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamCarrier.Job[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponseJob {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponseJob.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponseJob = void 0;
+var ListResponseJob;
+(function (ListResponseJob) {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    ListResponseJob.Object_ = {
+        List: "list",
+    };
+})(ListResponseJob || (exports.ListResponseJob = ListResponseJob = {}));

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

@@ -4,6 +4,7 @@ export * from "./ApiFieldError.js";
 export * from "./Asset.js";
 export * from "./AssetListItem.js";
 export * from "./Assignment.js";
+export * from "./BulkJobSubmission.js";
 export * from "./BusinessCategory.js";
 export * from "./CloseAssignmentRequest.js";
 export * from "./Country.js";
@@ -18,12 +19,15 @@ export * from "./Currency.js";
 export * from "./InternalUserUpdateRequest.js";
 export * from "./Invite.js";
 export * from "./InviteUserRequest.js";
+export * from "./Job.js";
+export * from "./JobSubmission.js";
 export * from "./Language.js";
 export * from "./ListResponseActivityResource.js";
 export * from "./ListResponseAssetListItem.js";
 export * from "./ListResponseBusinessCategory.js";
 export * from "./ListResponseCountry.js";
 export * from "./ListResponseCurrency.js";
+export * from "./ListResponseJob.js";
 export * from "./ListResponseLanguage.js";
 export * from "./ListResponseMembership.js";
 export * from "./ListResponseOrganization.js";

package/dist/api/types/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./ApiFieldError.js"), exports);
 __exportStar(require("./Asset.js"), exports);
 __exportStar(require("./AssetListItem.js"), exports);
 __exportStar(require("./Assignment.js"), exports);
+__exportStar(require("./BulkJobSubmission.js"), exports);
 __exportStar(require("./BusinessCategory.js"), exports);
 __exportStar(require("./CloseAssignmentRequest.js"), exports);
 __exportStar(require("./Country.js"), exports);
@@ -34,12 +35,15 @@ __exportStar(require("./Currency.js"), exports);
 __exportStar(require("./InternalUserUpdateRequest.js"), exports);
 __exportStar(require("./Invite.js"), exports);
 __exportStar(require("./InviteUserRequest.js"), exports);
+__exportStar(require("./Job.js"), exports);
+__exportStar(require("./JobSubmission.js"), exports);
 __exportStar(require("./Language.js"), exports);
 __exportStar(require("./ListResponseActivityResource.js"), exports);
 __exportStar(require("./ListResponseAssetListItem.js"), exports);
 __exportStar(require("./ListResponseBusinessCategory.js"), exports);
 __exportStar(require("./ListResponseCountry.js"), exports);
 __exportStar(require("./ListResponseCurrency.js"), exports);
+__exportStar(require("./ListResponseJob.js"), exports);
 __exportStar(require("./ListResponseLanguage.js"), exports);
 __exportStar(require("./ListResponseMembership.js"), exports);
 __exportStar(require("./ListResponseOrganization.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/carrier-sdk",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "description": "Nizam Carrier API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,