@seamapi/types 1.879.0 → 1.880.0

package/lib/seam/connect/models/action-attempts/assign-credential.d.ts

@@ -0,0 +1,547 @@
+import { z } from 'zod';
+export declare const assign_credential_action_attempt: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+    action_attempt_id: z.ZodString;
+} & {
+    status: z.ZodLiteral<"pending">;
+    result: z.ZodNull;
+    error: z.ZodNull;
+} & {
+    action_type: z.ZodLiteral<"ASSIGN_CREDENTIAL">;
+}, "strip", z.ZodTypeAny, {
+    status: "pending";
+    action_attempt_id: string;
+    error: null;
+    result: null;
+    action_type: "ASSIGN_CREDENTIAL";
+}, {
+    status: "pending";
+    action_attempt_id: string;
+    error: null;
+    result: null;
+    action_type: "ASSIGN_CREDENTIAL";
+}>, z.ZodObject<{
+    action_attempt_id: z.ZodString;
+} & {
+    status: z.ZodLiteral<"success">;
+    error: z.ZodNull;
+} & {
+    action_type: z.ZodLiteral<"ASSIGN_CREDENTIAL">;
+    result: z.ZodObject<{
+        workspace_id: z.ZodString;
+        access_method_id: z.ZodString;
+        display_name: z.ZodString;
+        mode: z.ZodEnum<["code", "card", "mobile_key", "cloud_key"]>;
+        created_at: z.ZodString;
+        issued_at: z.ZodNullable<z.ZodString>;
+        is_issued: z.ZodBoolean;
+        instant_key_url: z.ZodOptional<z.ZodString>;
+        client_session_token: z.ZodOptional<z.ZodString>;
+        is_encoding_required: z.ZodOptional<z.ZodBoolean>;
+        is_ready_for_encoding: z.ZodOptional<z.ZodBoolean>;
+        is_assignment_required: z.ZodOptional<z.ZodBoolean>;
+        is_ready_for_assignment: z.ZodOptional<z.ZodBoolean>;
+        code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        warnings: z.ZodArray<z.ZodDiscriminatedUnion<"warning_code", [z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            warning_code: z.ZodLiteral<"being_deleted">;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            warning_code: "being_deleted";
+        }, {
+            message: string;
+            created_at: string;
+            warning_code: "being_deleted";
+        }>, z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            warning_code: z.ZodLiteral<"updating_access_times">;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            warning_code: "updating_access_times";
+        }, {
+            message: string;
+            created_at: string;
+            warning_code: "updating_access_times";
+        }>, z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            warning_code: z.ZodLiteral<"pulled_backup_access_code">;
+            original_access_method_id: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            warning_code: "pulled_backup_access_code";
+            original_access_method_id?: string | undefined;
+        }, {
+            message: string;
+            created_at: string;
+            warning_code: "pulled_backup_access_code";
+            original_access_method_id?: string | undefined;
+        }>]>, "many">;
+        pending_mutations: z.ZodArray<z.ZodDiscriminatedUnion<"mutation_code", [z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            mutation_code: z.ZodLiteral<"provisioning_access">;
+            from: z.ZodObject<{
+                device_ids: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                device_ids: string[];
+            }, {
+                device_ids: string[];
+            }>;
+            to: z.ZodObject<{
+                device_ids: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                device_ids: string[];
+            }, {
+                device_ids: string[];
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            mutation_code: "provisioning_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        }, {
+            message: string;
+            created_at: string;
+            mutation_code: "provisioning_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        }>, z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            mutation_code: z.ZodLiteral<"revoking_access">;
+            from: z.ZodObject<{
+                device_ids: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                device_ids: string[];
+            }, {
+                device_ids: string[];
+            }>;
+            to: z.ZodObject<{
+                device_ids: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                device_ids: string[];
+            }, {
+                device_ids: string[];
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            mutation_code: "revoking_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        }, {
+            message: string;
+            created_at: string;
+            mutation_code: "revoking_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        }>, z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            mutation_code: z.ZodLiteral<"updating_access_times">;
+            from: z.ZodObject<{
+                starts_at: z.ZodNullable<z.ZodString>;
+                ends_at: z.ZodNullable<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                starts_at: string | null;
+                ends_at: string | null;
+            }, {
+                starts_at: string | null;
+                ends_at: string | null;
+            }>;
+            to: z.ZodObject<{
+                starts_at: z.ZodNullable<z.ZodString>;
+                ends_at: z.ZodNullable<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                starts_at: string | null;
+                ends_at: string | null;
+            }, {
+                starts_at: string | null;
+                ends_at: string | null;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            mutation_code: "updating_access_times";
+            from: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+            to: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+        }, {
+            message: string;
+            created_at: string;
+            mutation_code: "updating_access_times";
+            from: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+            to: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+        }>]>, "many">;
+        customization_profile_id: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        warnings: ({
+            message: string;
+            created_at: string;
+            warning_code: "being_deleted";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "updating_access_times";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "pulled_backup_access_code";
+            original_access_method_id?: string | undefined;
+        })[];
+        pending_mutations: ({
+            message: string;
+            created_at: string;
+            mutation_code: "provisioning_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "revoking_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "updating_access_times";
+            from: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+            to: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+        })[];
+        mode: "code" | "card" | "mobile_key" | "cloud_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | null | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        customization_profile_id?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+        is_ready_for_encoding?: boolean | undefined;
+        is_assignment_required?: boolean | undefined;
+        is_ready_for_assignment?: boolean | undefined;
+    }, {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        warnings: ({
+            message: string;
+            created_at: string;
+            warning_code: "being_deleted";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "updating_access_times";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "pulled_backup_access_code";
+            original_access_method_id?: string | undefined;
+        })[];
+        pending_mutations: ({
+            message: string;
+            created_at: string;
+            mutation_code: "provisioning_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "revoking_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "updating_access_times";
+            from: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+            to: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+        })[];
+        mode: "code" | "card" | "mobile_key" | "cloud_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | null | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        customization_profile_id?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+        is_ready_for_encoding?: boolean | undefined;
+        is_assignment_required?: boolean | undefined;
+        is_ready_for_assignment?: boolean | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    status: "success";
+    action_attempt_id: string;
+    error: null;
+    result: {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        warnings: ({
+            message: string;
+            created_at: string;
+            warning_code: "being_deleted";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "updating_access_times";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "pulled_backup_access_code";
+            original_access_method_id?: string | undefined;
+        })[];
+        pending_mutations: ({
+            message: string;
+            created_at: string;
+            mutation_code: "provisioning_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "revoking_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "updating_access_times";
+            from: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+            to: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+        })[];
+        mode: "code" | "card" | "mobile_key" | "cloud_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | null | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        customization_profile_id?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+        is_ready_for_encoding?: boolean | undefined;
+        is_assignment_required?: boolean | undefined;
+        is_ready_for_assignment?: boolean | undefined;
+    };
+    action_type: "ASSIGN_CREDENTIAL";
+}, {
+    status: "success";
+    action_attempt_id: string;
+    error: null;
+    result: {
+        display_name: string;
+        workspace_id: string;
+        created_at: string;
+        warnings: ({
+            message: string;
+            created_at: string;
+            warning_code: "being_deleted";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "updating_access_times";
+        } | {
+            message: string;
+            created_at: string;
+            warning_code: "pulled_backup_access_code";
+            original_access_method_id?: string | undefined;
+        })[];
+        pending_mutations: ({
+            message: string;
+            created_at: string;
+            mutation_code: "provisioning_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "revoking_access";
+            from: {
+                device_ids: string[];
+            };
+            to: {
+                device_ids: string[];
+            };
+        } | {
+            message: string;
+            created_at: string;
+            mutation_code: "updating_access_times";
+            from: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+            to: {
+                starts_at: string | null;
+                ends_at: string | null;
+            };
+        })[];
+        mode: "code" | "card" | "mobile_key" | "cloud_key";
+        access_method_id: string;
+        issued_at: string | null;
+        is_issued: boolean;
+        code?: string | null | undefined;
+        client_session_token?: string | undefined;
+        instant_key_url?: string | undefined;
+        customization_profile_id?: string | undefined;
+        is_encoding_required?: boolean | undefined;
+        is_ready_for_encoding?: boolean | undefined;
+        is_assignment_required?: boolean | undefined;
+        is_ready_for_assignment?: boolean | undefined;
+    };
+    action_type: "ASSIGN_CREDENTIAL";
+}>, z.ZodObject<{
+    action_attempt_id: z.ZodString;
+} & {
+    status: z.ZodLiteral<"error">;
+    result: z.ZodNull;
+} & {
+    action_type: z.ZodLiteral<"ASSIGN_CREDENTIAL">;
+    error: z.ZodUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"uncategorized_error">;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        type: "uncategorized_error";
+    }, {
+        message: string;
+        type: "uncategorized_error";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"action_attempt_expired">;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        type: "action_attempt_expired";
+    }, {
+        message: string;
+        type: "action_attempt_expired";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"credential_not_found">;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        type: "credential_not_found";
+    }, {
+        message: string;
+        type: "credential_not_found";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    status: "error";
+    action_attempt_id: string;
+    error: {
+        message: string;
+        type: "uncategorized_error";
+    } | {
+        message: string;
+        type: "action_attempt_expired";
+    } | {
+        message: string;
+        type: "credential_not_found";
+    };
+    result: null;
+    action_type: "ASSIGN_CREDENTIAL";
+}, {
+    status: "error";
+    action_attempt_id: string;
+    error: {
+        message: string;
+        type: "uncategorized_error";
+    } | {
+        message: string;
+        type: "action_attempt_expired";
+    } | {
+        message: string;
+        type: "credential_not_found";
+    };
+    result: null;
+    action_type: "ASSIGN_CREDENTIAL";
+}>]>;
+export type AssignCredentialActionAttempt = z.infer<typeof assign_credential_action_attempt>;

package/lib/seam/connect/models/action-attempts/assign-credential.js

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+import { access_method } from '../access-grants/access-method.js';
+import { common_action_attempt_errors, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, } from './common.js';
+const action_type = z
+    .literal('ASSIGN_CREDENTIAL')
+    .describe('Action attempt to track the status of assigning an existing credential to an access method.');
+const credential_not_found_error = z
+    .object({
+    type: z
+        .literal('credential_not_found')
+        .describe('Error type to indicate that no matching credential was found.'),
+    message: z
+        .string()
+        .describe('Detailed description of the error. Provides insights into the issue and potentially how to rectify it.'),
+})
+    .describe('Error to indicate that no matching credential was found.');
+const error = z.union([
+    ...common_action_attempt_errors,
+    credential_not_found_error,
+]);
+const result = access_method.describe('Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential.');
+export const assign_credential_action_attempt = z.discriminatedUnion('status', [
+    common_pending_action_attempt
+        .extend({
+        action_type,
+    })
+        .describe('Assigning a credential to an access method is pending.'),
+    common_succeeded_action_attempt
+        .extend({
+        action_type,
+        result,
+    })
+        .describe('Assigning a credential to an access method succeeded.'),
+    common_failed_action_attempt
+        .extend({ action_type, error })
+        .describe('Assigning a credential to an access method failed.'),
+]);
+//# sourceMappingURL=assign-credential.js.map

package/lib/seam/connect/models/action-attempts/assign-credential.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assign-credential.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/assign-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AACjE,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,GAAG,CAAC;KAClB,OAAO,CAAC,mBAAmB,CAAC;KAC5B,QAAQ,CACP,6FAA6F,CAC9F,CAAA;AAEH,MAAM,0BAA0B,GAAG,CAAC;KACjC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC;SACJ,OAAO,CAAC,sBAAsB,CAAC;SAC/B,QAAQ,CACP,+DAA+D,CAChE;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CACP,wGAAwG,CACzG;CACJ,CAAC;KACD,QAAQ,CAAC,0DAA0D,CAAC,CAAA;AAEvE,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IACpB,GAAG,4BAA4B;IAC/B,0BAA0B;CAC3B,CAAC,CAAA;AAEF,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CACnC,kIAAkI,CACnI,CAAA;AAED,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC7E,6BAA6B;SAC1B,MAAM,CAAC;QACN,WAAW;KACZ,CAAC;SACD,QAAQ,CAAC,wDAAwD,CAAC;IACrE,+BAA+B;SAC5B,MAAM,CAAC;QACN,WAAW;QACX,MAAM;KACP,CAAC;SACD,QAAQ,CAAC,uDAAuD,CAAC;IACpE,4BAA4B;SACzB,MAAM,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAC9B,QAAQ,CAAC,oDAAoD,CAAC;CAClE,CAAC,CAAA"}