diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md index e6656d0..249676d 100644 --- a/test/snapshots/seam-blueprint.test.ts.md +++ b/test/snapshots/seam-blueprint.test.ts.md @@ -12313,7 +12313,7 @@ Generated by [AVA](https://avajs.dev). }, acs_encoder: { deprecationMessage: '', - description: '', + 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). See also [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', draftMessage: '', isDeprecated: false, isDraft: false, @@ -16239,7 +16239,7 @@ Generated by [AVA](https://avajs.dev). }, phone: { deprecationMessage: '', - description: 'Properties of the phone.', + description: 'Represents an app user\'s mobile phone.', draftMessage: '', isDeprecated: false, isDraft: false, @@ -16247,151 +16247,7 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_removal', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'capabilities_supported', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the device object was created.', + description: 'Date and time at which the `phone` was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -16403,7 +16259,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.', draftMessage: '', format: 'record', isDeprecated: false, @@ -16415,7 +16271,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier for the device.', + description: 'ID of the `phone`.', draftMessage: '', format: 'id', isDeprecated: false, @@ -16444,7 +16300,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'android_phone', + name: 'ios_phone', undocumentedMessage: '', }, { @@ -16454,14 +16310,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ios_phone', + name: 'android_phone', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.', + description: 'Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.', draftMessage: '', format: 'string', isDeprecated: false, @@ -16473,7 +16329,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.', + description: 'Errors associated with the `phone`.', draftMessage: '', format: 'list', isDeprecated: false, @@ -16485,57 +16341,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Indicates whether Seam manages the device.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Location information for the device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'location', - properties: [ - { - deprecationMessage: '', - description: 'Name of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'location_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Time zone of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'timezone', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Optional nickname to describe the device, settable through Seam', + description: 'Optional nickname to describe the phone, settable through Seam.', draftMessage: '', format: 'string', isDeprecated: false, @@ -16547,7 +16353,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Properties of the phone.', draftMessage: '', format: 'object', isDeprecated: false, @@ -16625,7 +16431,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.', + description: 'Warnings associated with the `phone`.', draftMessage: '', format: 'list', isDeprecated: false, @@ -16637,7 +16443,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier for the Seam workspace associated with the device.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.', draftMessage: '', format: 'id', isDeprecated: false, @@ -23767,6 +23573,63 @@ Generated by [AVA](https://avajs.dev). path: '/action_attempts', subroutes: [], }, + { + endpoints: [ + { + authMethods: [ + 'personal_access_token', + 'api_key', + ], + codeSamples: [], + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'get', + path: '/bridges/get', + request: { + methods: [ + 'POST', + ], + parameters: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isRequired: true, + isUndocumented: false, + jsonType: 'string', + name: 'bridge_id', + undocumentedMessage: '', + }, + ], + preferredMethod: 'POST', + semanticMethod: 'POST', + }, + response: { + description: 'OK', + resourceType: 'unknown', + responseKey: 'bridge', + responseType: 'resource', + }, + title: '', + undocumentedMessage: '', + workspaceScope: 'required', + }, + ], + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'bridges', + namespace: null, + path: '/bridges', + subroutes: [], + }, { endpoints: [ { diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap index 0e03d18..f502b26 100644 Binary files a/test/snapshots/seam-blueprint.test.ts.snap and b/test/snapshots/seam-blueprint.test.ts.snap differ