@seamapi/types 1.415.0 → 1.416.1

package/lib/seam/connect/openapi.d.ts

@@ -747,6 +747,7 @@ declare const _default: {
                 required: string[];
                 type: string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             acs_credential_provisioning_automation: {
                 properties: {
@@ -774,6 +775,7 @@ declare const _default: {
                 required: string[];
                 type: string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             acs_encoder: {
                 description: string;
@@ -1952,7 +1954,240 @@ declare const _default: {
                                 acs_credential_on_seam: {
                                     description: string;
                                     nullable: boolean;
-                                    oneOf: {
+                                    oneOf: ({
+                                        description: string;
+                                        properties: {
+                                            access_method: {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            };
+                                            acs_credential_id: {
+                                                description: string;
+                                                format: string;
+                                                type: string;
+                                            };
+                                            acs_credential_pool_id: {
+                                                format: string;
+                                                type: string;
+                                            };
+                                            acs_system_id: {
+                                                description: string;
+                                                format: string;
+                                                type: string;
+                                            };
+                                            acs_user_id: {
+                                                description: string;
+                                                format: string;
+                                                type: string;
+                                            };
+                                            assa_abloy_vostio_metadata: {
+                                                description: string;
+                                                properties: {
+                                                    auto_join: {
+                                                        type: string;
+                                                    };
+                                                    door_names: {
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    endpoint_id: {
+                                                        type: string;
+                                                    };
+                                                    key_id: {
+                                                        type: string;
+                                                    };
+                                                    key_issuing_request_id: {
+                                                        type: string;
+                                                    };
+                                                    override_guest_acs_entrance_ids: {
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                };
+                                                type: string;
+                                            };
+                                            card_number: {
+                                                description: string;
+                                                nullable: boolean;
+                                                type: string;
+                                            };
+                                            code: {
+                                                description: string;
+                                                nullable: boolean;
+                                                type: string;
+                                            };
+                                            created_at: {
+                                                description: string;
+                                                format: string;
+                                                type: string;
+                                            };
+                                            display_name: {
+                                                description: string;
+                                                minLength: number;
+                                                type: string;
+                                            };
+                                            ends_at: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            errors: {
+                                                description: string;
+                                                items: {
+                                                    properties: {
+                                                        error_code: {
+                                                            type: string;
+                                                        };
+                                                        message: {
+                                                            type: string;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    type: string;
+                                                };
+                                                type: string;
+                                            };
+                                            external_type: {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            };
+                                            external_type_display_name: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            is_issued: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            is_latest_desired_state_synced_with_provider: {
+                                                description: string;
+                                                nullable: boolean;
+                                                type: string;
+                                            };
+                                            is_managed: {
+                                                enum: boolean[];
+                                                type: string;
+                                            };
+                                            is_multi_phone_sync_credential: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            is_one_time_use: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            issued_at: {
+                                                description: string;
+                                                format: string;
+                                                nullable: boolean;
+                                                type: string;
+                                            };
+                                            latest_desired_state_synced_with_provider_at: {
+                                                description: string;
+                                                format: string;
+                                                nullable: boolean;
+                                                type: string;
+                                            };
+                                            parent_acs_credential_id: {
+                                                description: string;
+                                                format: string;
+                                                type: string;
+                                            };
+                                            starts_at: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            visionline_metadata: {
+                                                description: string;
+                                                properties: {
+                                                    auto_join: {
+                                                        type: string;
+                                                    };
+                                                    card_function_type: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                    card_id: {
+                                                        type: string;
+                                                    };
+                                                    common_acs_entrance_ids: {
+                                                        items: {
+                                                            format: string;
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    credential_id: {
+                                                        type: string;
+                                                    };
+                                                    guest_acs_entrance_ids: {
+                                                        items: {
+                                                            format: string;
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    is_valid: {
+                                                        type: string;
+                                                    };
+                                                    joiner_acs_credential_ids: {
+                                                        items: {
+                                                            format: string;
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            warnings: {
+                                                description: string;
+                                                items: {
+                                                    description: string;
+                                                    discriminator: {
+                                                        propertyName: string;
+                                                    };
+                                                    oneOf: {
+                                                        description: string;
+                                                        properties: {
+                                                            created_at: {
+                                                                description: string;
+                                                                format: string;
+                                                                type: string;
+                                                            };
+                                                            message: {
+                                                                description: string;
+                                                                type: string;
+                                                            };
+                                                            warning_code: {
+                                                                description: string;
+                                                                enum: string[];
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                    }[];
+                                                };
+                                                type: string;
+                                            };
+                                            workspace_id: {
+                                                description: string;
+                                                format: string;
+                                                type: string;
+                                            };
+                                        };
+                                        required: string[];
+                                        type: string;
+                                        'x-route-path': string;
+                                        'x-undocumented'?: never;
+                                    } | {
                                         description: string;
                                         properties: {
                                             access_method: {
@@ -2184,7 +2419,8 @@ declare const _default: {
                                         required: string[];
                                         type: string;
                                         'x-route-path': string;
-                                    }[];
+                                        'x-undocumented': string;
+                                    })[];
                                     'x-route-path': string;
                                 };
                                 warnings: {
@@ -2497,7 +2733,7 @@ declare const _default: {
                         };
                         result: {
                             description: string;
-                            oneOf: {
+                            oneOf: ({
                                 description: string;
                                 properties: {
                                     access_method: {
@@ -2729,7 +2965,241 @@ declare const _default: {
                                 required: string[];
                                 type: string;
                                 'x-route-path': string;
-                            }[];
+                                'x-undocumented'?: never;
+                            } | {
+                                description: string;
+                                properties: {
+                                    access_method: {
+                                        description: string;
+                                        enum: string[];
+                                        type: string;
+                                    };
+                                    acs_credential_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_credential_pool_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_system_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_user_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    assa_abloy_vostio_metadata: {
+                                        description: string;
+                                        properties: {
+                                            auto_join: {
+                                                type: string;
+                                            };
+                                            door_names: {
+                                                items: {
+                                                    type: string;
+                                                };
+                                                type: string;
+                                            };
+                                            endpoint_id: {
+                                                type: string;
+                                            };
+                                            key_id: {
+                                                type: string;
+                                            };
+                                            key_issuing_request_id: {
+                                                type: string;
+                                            };
+                                            override_guest_acs_entrance_ids: {
+                                                items: {
+                                                    type: string;
+                                                };
+                                                type: string;
+                                            };
+                                        };
+                                        type: string;
+                                    };
+                                    card_number: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    code: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    created_at: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    display_name: {
+                                        description: string;
+                                        minLength: number;
+                                        type: string;
+                                    };
+                                    ends_at: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    errors: {
+                                        description: string;
+                                        items: {
+                                            properties: {
+                                                error_code: {
+                                                    type: string;
+                                                };
+                                                message: {
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    external_type: {
+                                        description: string;
+                                        enum: string[];
+                                        type: string;
+                                    };
+                                    external_type_display_name: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    is_issued: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    is_latest_desired_state_synced_with_provider: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    is_managed: {
+                                        enum: boolean[];
+                                        type: string;
+                                    };
+                                    is_multi_phone_sync_credential: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    is_one_time_use: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    issued_at: {
+                                        description: string;
+                                        format: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    latest_desired_state_synced_with_provider_at: {
+                                        description: string;
+                                        format: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    parent_acs_credential_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    starts_at: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    visionline_metadata: {
+                                        description: string;
+                                        properties: {
+                                            auto_join: {
+                                                type: string;
+                                            };
+                                            card_function_type: {
+                                                enum: string[];
+                                                type: string;
+                                            };
+                                            card_id: {
+                                                type: string;
+                                            };
+                                            common_acs_entrance_ids: {
+                                                items: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                type: string;
+                                            };
+                                            credential_id: {
+                                                type: string;
+                                            };
+                                            guest_acs_entrance_ids: {
+                                                items: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                type: string;
+                                            };
+                                            is_valid: {
+                                                type: string;
+                                            };
+                                            joiner_acs_credential_ids: {
+                                                items: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                type: string;
+                                            };
+                                        };
+                                        required: string[];
+                                        type: string;
+                                    };
+                                    warnings: {
+                                        description: string;
+                                        items: {
+                                            description: string;
+                                            discriminator: {
+                                                propertyName: string;
+                                            };
+                                            oneOf: {
+                                                description: string;
+                                                properties: {
+                                                    created_at: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    message: {
+                                                        description: string;
+                                                        type: string;
+                                                    };
+                                                    warning_code: {
+                                                        description: string;
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            }[];
+                                        };
+                                        type: string;
+                                    };
+                                    workspace_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                                'x-route-path': string;
+                                'x-undocumented': string;
+                            })[];
                             nullable?: never;
                             properties?: never;
                             type?: never;
@@ -3366,6 +3836,10 @@ declare const _default: {
                         description: string;
                         type: string;
                     };
+                    customer_key: {
+                        description: string;
+                        type: string;
+                    };
                     errors: {
                         description: string;
                         items: {
@@ -10245,6 +10719,7 @@ declare const _default: {
                 required: string[];
                 type: string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             unmanaged_acs_credential: {
                 description: string;
@@ -10478,6 +10953,7 @@ declare const _default: {
                 required: string[];
                 type: string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             unmanaged_acs_user: {
                 description: string;
@@ -10929,6 +11405,7 @@ declare const _default: {
                 required: string[];
                 type: string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             unmanaged_device: {
                 description: string;

package/lib/seam/connect/openapi.js

@@ -1974,6 +1974,7 @@ export default {
                 ],
                 type: 'object',
                 'x-route-path': '/acs/credential_pools',
+                'x-undocumented': 'Will be removed.',
             },
             acs_credential_provisioning_automation: {
                 properties: {
@@ -1995,6 +1996,7 @@ export default {
                 ],
                 type: 'object',
                 'x-route-path': '/acs/credential_provisioning_automations',
+                'x-undocumented': 'Will be removed.',
             },
             acs_encoder: {
                 description: 'Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n   Configure the access parameters for the credential.\n2. Card encoding\n   Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).',
@@ -4192,6 +4194,7 @@ export default {
                                                 ],
                                                 type: 'object',
                                                 'x-route-path': '/acs/credentials/unmanaged',
+                                                'x-undocumented': 'Unreleased.',
                                             },
                                         ],
                                         'x-route-path': '/acs/credentials',
@@ -5251,6 +5254,7 @@ export default {
                                         ],
                                         type: 'object',
                                         'x-route-path': '/acs/credentials/unmanaged',
+                                        'x-undocumented': 'Unreleased.',
                                     },
                                 ],
                             },
@@ -6925,6 +6929,10 @@ export default {
                         description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
                         type: 'object',
                     },
+                    customer_key: {
+                        description: 'Your unique key for the customer associated with this connected account.',
+                        type: 'string',
+                    },
                     errors: {
                         description: 'Errors associated with the connected account.',
                         items: {
@@ -17389,6 +17397,7 @@ export default {
                 ],
                 type: 'object',
                 'x-route-path': '/acs/access_groups/unmanaged',
+                'x-undocumented': 'Unreleased.',
             },
             unmanaged_acs_credential: {
                 description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
@@ -17701,6 +17710,7 @@ export default {
                 ],
                 type: 'object',
                 'x-route-path': '/acs/credentials/unmanaged',
+                'x-undocumented': 'Unreleased.',
             },
             unmanaged_acs_user: {
                 description: 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
@@ -18291,6 +18301,7 @@ export default {
                 ],
                 type: 'object',
                 'x-route-path': '/acs/users/unmanaged',
+                'x-undocumented': 'Unreleased.',
             },
             unmanaged_device: {
                 description: 'Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',