diff --git a/package-lock.json b/package-lock.json index 65909f0..5ae0164 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1307,9 +1307,9 @@ "license": "MIT" }, "node_modules/@seamapi/types": { - "version": "1.804.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.804.0.tgz", - "integrity": "sha512-bU2U/YdZTOzvC8Ol6KSyHONLDWAfBZycZ39qELZlGph9/7EB0B9PQ3fUhznwkngwQGeBPW2KoLeoF3BInGNm8w==", + "version": "1.809.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.809.0.tgz", + "integrity": "sha512-xBrXorx5njf53vwoHSgEzXxL4Bul82kxKOzRVNs/K37VU4YcaLKQc1Q7ONuFPP/PfDSWP2pCOiRgzx99nrPiHQ==", "dev": true, "license": "MIT", "engines": { diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md index 8a79bc6..0240c65 100644 --- a/test/snapshots/seam-blueprint.test.ts.md +++ b/test/snapshots/seam-blueprint.test.ts.md @@ -31517,7 +31517,7 @@ Generated by [AVA](https://avajs.dev). ␊ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.␊ ␊ - To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).`, draftMessage: '', isDeprecated: false, isDraft: false, @@ -34145,7 +34145,7 @@ Generated by [AVA](https://avajs.dev). ␊ See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).␊ ␊ - To 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).`, + To 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#access-control-systems).`, draftMessage: '', isDeprecated: false, isDraft: false, @@ -36450,7 +36450,7 @@ Generated by [AVA](https://avajs.dev). ␊ An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.␊ ␊ - For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).`, draftMessage: '', isDeprecated: false, isDraft: false, @@ -38392,7 +38392,7 @@ Generated by [AVA](https://avajs.dev). ␊ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.␊ ␊ - To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).`, draftMessage: '', format: 'record', isDeprecated: false, @@ -38437,7 +38437,7 @@ Generated by [AVA](https://avajs.dev). ␊ See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).␊ ␊ - To 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).`, + To 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#access-control-systems).`, draftMessage: '', format: 'record', isDeprecated: false, @@ -38489,7 +38489,7 @@ Generated by [AVA](https://avajs.dev). ␊ An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.␊ ␊ - For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).`, draftMessage: '', format: 'record', isDeprecated: false, @@ -40980,6 +40980,90 @@ Generated by [AVA](https://avajs.dev). routePath: '/customers', undocumentedMessage: 'Internal resource.', }, + { + deprecationMessage: '', + description: `Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.␊ + ␊ + With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.␊ + ␊ + Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the customer portal link was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Customer key for the customer portal.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'customer_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the customer portal link expires.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'expires_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'URL for the customer portal.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'customer_portal', + routePath: '/customers', + undocumentedMessage: '', + }, { deprecationMessage: '', description: 'A customization profile.', @@ -70203,6 +70287,20 @@ Generated by [AVA](https://avajs.dev). name: 'starts_at', undocumentedMessage: '', }, + { + deprecationMessage: '', + description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).', + draftMessage: '', + format: 'boolean', + hasDefault: false, + isDeprecated: false, + isDraft: false, + isRequired: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'use_backup_access_code_pool', + undocumentedMessage: '', + }, ], preferredMethod: 'PUT', semanticMethod: 'PUT', @@ -72112,10 +72210,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Creates a new Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'create', parentPath: '/access_grants', @@ -72561,10 +72659,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Delete an Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'delete', parentPath: '/access_grants', @@ -72610,10 +72708,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Get an Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get', parentPath: '/access_grants', @@ -72676,10 +72774,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets all related resources for one or more Access Grants.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get_related', parentPath: '/access_grants', @@ -72972,10 +73070,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets an Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: true, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'list', parentPath: '/access_grants', @@ -73181,10 +73279,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Adds additional requested access methods to an existing Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'request_access_methods', parentPath: '/access_grants', @@ -73334,10 +73432,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Updates an existing Access Grant\'s time window.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'update', parentPath: '/access_grants', @@ -73418,7 +73516,7 @@ Generated by [AVA](https://avajs.dev). }, ], isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'access_grants', namespacePath: null, @@ -73436,10 +73534,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Get an unmanaged Access Grant (where is_managed = false).', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get', parentPath: '/access_grants/unmanaged', @@ -73489,10 +73587,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets unmanaged Access Grants (where is_managed = false).', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: true, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'list', parentPath: '/access_grants/unmanaged', @@ -73617,10 +73715,10 @@ Generated by [AVA](https://avajs.dev). This endpoint can only be used to convert unmanaged access grants to managed ones by setting \`is_managed\` to \`true\`. It cannot be used to convert managed access grants back to unmanaged.␊ ␊ When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.`, - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'update', parentPath: '/access_grants/unmanaged', @@ -73687,7 +73785,7 @@ Generated by [AVA](https://avajs.dev). }, ], isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'unmanaged', namespacePath: null, @@ -73705,10 +73803,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Deletes an access method.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'delete', parentPath: '/access_methods', @@ -73846,10 +73944,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets an access method.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get', parentPath: '/access_methods', @@ -73899,10 +73997,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets all related resources for one or more Access Methods.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get_related', parentPath: '/access_methods', @@ -74180,10 +74278,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Lists all access methods, usually filtered by Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'list', parentPath: '/access_methods', @@ -74313,10 +74411,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets an unmanaged access method (where is_managed = false).', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get', parentPath: '/access_methods/unmanaged', @@ -74366,10 +74464,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'list', parentPath: '/access_methods/unmanaged', @@ -74454,7 +74552,7 @@ Generated by [AVA](https://avajs.dev). }, ], isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'unmanaged', namespacePath: null, @@ -75521,7 +75619,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).', + description: 'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides).', draftMessage: '', format: 'string', hasDefault: false, @@ -85016,7 +85114,7 @@ Generated by [AVA](https://avajs.dev). actionAttemptType: null, batchResourceTypes: null, description: 'OK', - resourceType: 'unknown', + resourceType: 'customer_portal', responseKey: 'customer_portal', responseType: 'resource', }, @@ -117453,10 +117551,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'add_acs_entrances', parentPath: '/spaces', @@ -117517,10 +117615,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Adds devices to a specific space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'add_devices', parentPath: '/spaces', @@ -117581,10 +117679,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Creates a new space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'create', parentPath: '/spaces', @@ -117691,10 +117789,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Deletes a space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'delete', parentPath: '/spaces', @@ -117740,10 +117838,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets a space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get', parentPath: '/spaces', @@ -117807,10 +117905,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Gets all related resources for one or more Spaces.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'get_related', parentPath: '/spaces', @@ -118055,10 +118153,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Returns a list of all spaces.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: true, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'list', parentPath: '/spaces', @@ -118179,10 +118277,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'remove_acs_entrances', parentPath: '/spaces', @@ -118243,10 +118341,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Removes devices from a specific space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'remove_devices', parentPath: '/spaces', @@ -118307,10 +118405,10 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Updates an existing space.', - draftMessage: 'Early access.', + draftMessage: '', hasPagination: false, isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'update', parentPath: '/spaces', @@ -118425,7 +118523,7 @@ Generated by [AVA](https://avajs.dev). }, ], isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, name: 'spaces', namespacePath: null, diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap index c62ada7..0ce0efb 100644 Binary files a/test/snapshots/seam-blueprint.test.ts.snap and b/test/snapshots/seam-blueprint.test.ts.snap differ