diff --git a/package-lock.json b/package-lock.json index da349290..506af239 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,7 +13,7 @@ "@seamapi/blueprint": "^1.12.0", "@seamapi/fake-seam-connect": "2.0.6", "@seamapi/smith": "^1.1.0", - "@seamapi/types": "1.1076.0", + "@seamapi/types": "1.1079.0", "change-case": "^5.4.4", "execa": "^10.0.1", "prettier": "^3.9.6" @@ -882,9 +882,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.1076.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1076.0.tgz", - "integrity": "sha512-o2C89vg7cZixTH7rg4VRxCFsiL1w/evT2Cdnvd97EE4UhClyEEhyPYZLwXi64S8/2YSQr+hmr5Ay62vLX9OVWA==", + "version": "1.1079.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1079.0.tgz", + "integrity": "sha512-wa/byoJgYbFaHezpkeMxOEKp7h55owe/mmV9foLrM/hev6KnmdOezgh7HszEmH+chavfhDe9onYPoIyhQsOybA==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 3e4f5da5..d7cecc59 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,7 @@ "@seamapi/blueprint": "^1.12.0", "@seamapi/fake-seam-connect": "2.0.6", "@seamapi/smith": "^1.1.0", - "@seamapi/types": "1.1076.0", + "@seamapi/types": "1.1079.0", "change-case": "^5.4.4", "execa": "^10.0.1", "prettier": "^3.9.6" diff --git a/src/Resources/AccessCode.php b/src/Resources/AccessCode.php index 65259abe..4c147f77 100644 --- a/src/Resources/AccessCode.php +++ b/src/Resources/AccessCode.php @@ -2,15 +2,15 @@ namespace Seam\Resources { /** - * Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate. * - * Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time. + * Seam supports programming two types of access codes: [ongoing](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time. * - * In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. + * In addition, for certain devices, Seam also supports [offline access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. * - * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. + * For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */ class AccessCode { @@ -99,7 +99,7 @@ public function __construct( */ public string|null $display_status, /** - * Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * @var list<\Seam\Resources\AccessCode\Errors> */ @@ -135,7 +135,7 @@ public function __construct( */ public array $pending_mutations, /** - * Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). + * Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). * * @var value-of<\Seam\Resources\AccessCode\Status>|string|null * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. @@ -148,7 +148,7 @@ public function __construct( */ public string|null $type, /** - * Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * @var list<\Seam\Resources\AccessCode\Warnings> */ @@ -250,7 +250,7 @@ public function __construct( } /** - * Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -306,8 +306,8 @@ public static function from_json(mixed $json): Errors|null => \Seam\Resources\AccessCode\Errors\FailedToUpdate::from_json( $json, ), - \Seam\Resources\AccessCode\Errors\ErrorCode::FAILED_TO_EXPIRE - => \Seam\Resources\AccessCode\Errors\FailedToExpire::from_json( + \Seam\Resources\AccessCode\Errors\ErrorCode::FAILED_TO_REMOVE + => \Seam\Resources\AccessCode\Errors\FailedToRemove::from_json( $json, ), \Seam\Resources\AccessCode\Errors\ErrorCode::ACCOUNT_DISCONNECTED @@ -455,7 +455,7 @@ public function __construct( } /** - * Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -1026,9 +1026,9 @@ public function __construct( /** * This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active. */ - final class FailedToExpire extends \Seam\Resources\AccessCode\Errors + final class FailedToRemove extends \Seam\Resources\AccessCode\Errors { - public static function from_json(mixed $json): FailedToExpire|null + public static function from_json(mixed $json): FailedToRemove|null { if (!$json) { return null; @@ -1097,7 +1097,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1147,7 +1147,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1197,7 +1197,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1247,7 +1247,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1432,7 +1432,7 @@ public function __construct( } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ final class EmptyBackupAccessCodePool extends \Seam\Resources\AccessCode\Errors @@ -1648,7 +1648,7 @@ public function __construct( } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class BridgeDisconnected extends \Seam\Resources\AccessCode\Errors { @@ -1683,7 +1683,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ public bool|null $is_bridge_error = null, /** @@ -1707,7 +1707,7 @@ enum ErrorCode: string case CODE_CONSTRAINTS_VIOLATED = "code_constraints_violated"; case FAILED_TO_ISSUE = "failed_to_issue"; case FAILED_TO_UPDATE = "failed_to_update"; - case FAILED_TO_EXPIRE = "failed_to_expire"; + case FAILED_TO_REMOVE = "failed_to_remove"; case ACCOUNT_DISCONNECTED = "account_disconnected"; case SALTO_KS_SUBSCRIPTION_LIMIT_EXCEEDED = "salto_ks_subscription_limit_exceeded"; case INSUFFICIENT_PERMISSIONS = "insufficient_permissions"; diff --git a/src/Resources/AccessGrant.php b/src/Resources/AccessGrant.php index 786864ef..140bc1be 100644 --- a/src/Resources/AccessGrant.php +++ b/src/Resources/AccessGrant.php @@ -87,7 +87,7 @@ public function __construct( */ public string|null $ends_at, /** - * Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). * * @var list<\Seam\Resources\AccessGrant\Errors> */ @@ -128,7 +128,7 @@ public function __construct( */ public string|null $user_identity_id, /** - * Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). * * @var list<\Seam\Resources\AccessGrant\Warnings> */ @@ -163,7 +163,7 @@ public function __construct( namespace Seam\Resources\AccessGrant { /** - * Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -323,7 +323,7 @@ public function __construct( } /** - * Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -712,7 +712,7 @@ enum Mode: string namespace Seam\Resources\AccessGrant\Warnings { /** - * Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. + * Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted. */ final class BeingDeleted extends \Seam\Resources\AccessGrant\Warnings { @@ -853,7 +853,7 @@ public function __construct( } /** - * Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. + * Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated. */ final class UpdatingAccessTimes extends \Seam\Resources\AccessGrant\Warnings { diff --git a/src/Resources/AccessMethod.php b/src/Resources/AccessMethod.php index 7bca38cc..1a64dcf9 100644 --- a/src/Resources/AccessMethod.php +++ b/src/Resources/AccessMethod.php @@ -70,7 +70,7 @@ public function __construct( */ public string|null $display_status, /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). * * @var list<\Seam\Resources\AccessMethod\Errors> */ @@ -90,13 +90,13 @@ public function __construct( */ public string|null $mode, /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. * * @var list<\Seam\Resources\AccessMethod\PendingMutations> */ public array $pending_mutations, /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). * * @var list<\Seam\Resources\AccessMethod\Warnings> */ @@ -143,7 +143,7 @@ public function __construct( namespace Seam\Resources\AccessMethod { /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -190,7 +190,7 @@ public function __construct( } /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. Known mutation_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. Known mutation_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class PendingMutations { @@ -245,7 +245,7 @@ public function __construct( } /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -322,7 +322,7 @@ enum Mode: string namespace Seam\Resources\AccessMethod\Errors { /** - * Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued. + * Indicates that Seam was unable to issue this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued. */ final class FailedToIssue extends \Seam\Resources\AccessMethod\Errors { @@ -713,7 +713,7 @@ public function __construct( namespace Seam\Resources\AccessMethod\Warnings { /** - * Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. + * Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted. */ final class BeingDeleted extends \Seam\Resources\AccessMethod\Warnings { @@ -754,7 +754,7 @@ public function __construct( } /** - * Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. + * Indicates that the access times for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) are being updated. */ final class UpdatingAccessTimes extends \Seam\Resources\AccessMethod\Warnings @@ -845,7 +845,7 @@ public function __construct( } /** - * Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds. + * Indicates that Seam has not yet issued this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds. */ final class DelayInIssuing extends \Seam\Resources\AccessMethod\Warnings { @@ -886,7 +886,7 @@ public function __construct( } /** - * Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant. + * Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant. */ final class UserIdentityMissingEmailAddress extends \Seam\Resources\AccessMethod\Warnings @@ -929,7 +929,7 @@ public function __construct( } /** - * Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant. + * Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant. */ final class UserIdentityMissingPhoneNumber extends \Seam\Resources\AccessMethod\Warnings diff --git a/src/Resources/AcsAccessGroup.php b/src/Resources/AcsAccessGroup.php index 463cd3d6..81767956 100644 --- a/src/Resources/AcsAccessGroup.php +++ b/src/Resources/AcsAccessGroup.php @@ -4,9 +4,9 @@ /** * Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. * - * Some access control systems use [access group](https://docs.seam.co/low-level-apis/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. + * Some access control systems use [access group](https://www.seam.co/docs/low-level-apis/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/device-and-system-integration-guides#access-control-systems). + * To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ class AcsAccessGroup { @@ -353,7 +353,7 @@ enum ExternalType: string namespace Seam\Resources\AcsAccessGroup\Errors { /** - * Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + * Indicates that the [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ final class FailedToCreateOnAcsSystem extends \Seam\Resources\AcsAccessGroup\Errors diff --git a/src/Resources/AcsCredential.php b/src/Resources/AcsCredential.php index 87f5c279..bdd61e78 100644 --- a/src/Resources/AcsCredential.php +++ b/src/Resources/AcsCredential.php @@ -2,13 +2,13 @@ namespace Seam\Resources { /** - * Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs. * * For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. * - * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. + * For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */ class AcsCredential { @@ -81,33 +81,33 @@ public static function from_json(mixed $json): AcsCredential|null public function __construct( /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. * * @var value-of<\Seam\Resources\AcsCredential\AccessMethod>|string|null */ public string|null $access_method, /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_credential_id, /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_system_id, /** - * ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $connected_account_id, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ public string|null $created_at, /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $display_name, /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\AcsCredential\Errors> */ @@ -117,13 +117,13 @@ public function __construct( */ public true|null $is_managed, /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\AcsCredential\Warnings> */ public array $warnings, /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $workspace_id, /** @@ -131,77 +131,77 @@ public function __construct( */ public string|null $acs_credential_pool_id = null, /** - * ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $acs_user_id = null, /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\AcsCredential\AkilesMetadata|null $akiles_metadata = null, /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\AcsCredential\AssaAbloyVostioMetadata|null $assa_abloy_vostio_metadata = null, /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_number = null, /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $code = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */ public string|null $ends_at = null, /** - * Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. + * Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. * * @var value-of<\Seam\Resources\AcsCredential\ExternalType>|string|null */ public string|null $external_type = null, /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $external_type_display_name = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ public bool|null $is_issued = null, /** - * Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. + * Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */ public bool|null $is_latest_desired_state_synced_with_provider = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */ public bool|null $is_multi_phone_sync_credential = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */ public bool|null $is_one_time_use = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ public string|null $issued_at = null, /** - * Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. + * Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */ public string|null $latest_desired_state_synced_with_provider_at = null, /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $parent_acs_credential_id = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $starts_at = null, /** - * ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $user_identity_id = null, /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\AcsCredential\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -210,7 +210,7 @@ public function __construct( namespace Seam\Resources\AcsCredential { /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AkilesMetadata { @@ -231,7 +231,7 @@ public function __construct( } /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AssaAbloyVostioMetadata { @@ -285,7 +285,7 @@ public function __construct( } /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Errors { @@ -312,7 +312,7 @@ public function __construct( } /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class VisionlineMetadata { @@ -379,7 +379,7 @@ public function __construct( } /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -486,7 +486,7 @@ enum CardFunctionType: string namespace Seam\Resources\AcsCredential\Warnings { /** - * Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued. + * Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is waiting to be issued. */ final class WaitingToBeIssued extends \Seam\Resources\AcsCredential\Warnings { @@ -527,7 +527,7 @@ public function __construct( } /** - * Indicates that the schedule of one of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)'s children was modified externally. + * Indicates that the schedule of one of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials)'s children was modified externally. */ final class ScheduleExternallyModified extends \Seam\Resources\AcsCredential\Warnings @@ -570,7 +570,7 @@ public function __construct( } /** - * Indicates that the schedule of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past. + * Indicates that the schedule of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past. */ final class ScheduleModified extends \Seam\Resources\AcsCredential\Warnings { @@ -611,7 +611,7 @@ public function __construct( } /** - * Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted. + * Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is being deleted. */ final class BeingDeleted extends \Seam\Resources\AcsCredential\Warnings { @@ -652,7 +652,7 @@ public function __construct( } /** - * An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential. + * An unknown issue occurred while syncing the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential. */ final class UnknownIssueWithAcsCredential extends \Seam\Resources\AcsCredential\Warnings @@ -695,7 +695,7 @@ public function __construct( } /** - * Access permissions for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential. + * Access permissions for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential. */ final class NeedsToBeReissued extends \Seam\Resources\AcsCredential\Warnings { diff --git a/src/Resources/AcsEncoder.php b/src/Resources/AcsEncoder.php index 16fe4738..4b869a5d 100644 --- a/src/Resources/AcsEncoder.php +++ b/src/Resources/AcsEncoder.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents a hardware device that encodes [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps: * @@ -13,9 +13,9 @@ * * Separately, 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. * - * See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/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/device-and-system-integration-guides#access-control-systems). + * To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ class AcsEncoder { @@ -40,33 +40,33 @@ public static function from_json(mixed $json): AcsEncoder|null public function __construct( /** - * ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * ID of the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ public string|null $acs_encoder_id, /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ public string|null $acs_system_id, /** - * ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * ID of the connected account that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ public string|null $connected_account_id, /** - * Date and time at which the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created. + * Date and time at which the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created. */ public string|null $created_at, /** - * Display name for the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Display name for the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ public string|null $display_name, /** - * Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). * * @var list<\Seam\Resources\AcsEncoder\Errors> */ public array $errors, /** - * ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * ID of the workspace that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ public string|null $workspace_id, ) {} @@ -75,7 +75,7 @@ public function __construct( namespace Seam\Resources\AcsEncoder { /** - * Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ class Errors { diff --git a/src/Resources/AcsEntrance.php b/src/Resources/AcsEntrance.php index d12132df..35b5716e 100644 --- a/src/Resources/AcsEntrance.php +++ b/src/Resources/AcsEntrance.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */ @@ -105,27 +105,27 @@ public static function from_json(mixed $json): AcsEntrance|null public function __construct( /** - * ID of the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public string|null $acs_entrance_id, /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public string|null $acs_system_id, /** - * ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public string|null $connected_account_id, /** - * Date and time at which the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was created. + * Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created. */ public string|null $created_at, /** - * Display name for the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public string|null $display_name, /** - * Errors associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). * * @var list<\Seam\Resources\AcsEntrance\Errors> */ @@ -137,25 +137,25 @@ public function __construct( */ public array|null $space_ids, /** - * Warnings associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). * * @var list<\Seam\Resources\AcsEntrance\Warnings> */ public array $warnings, /** - * Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\AkilesMetadata|null $akiles_metadata = null, /** - * ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\AssaAbloyVostioMetadata|null $assa_abloy_vostio_metadata = null, /** - * Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\AvigilonAltaMetadata|null $avigilon_alta_metadata = null, /** - * Brivo-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\BrivoMetadata|null $brivo_metadata = null, /** @@ -179,35 +179,35 @@ public function __construct( */ public bool|null $can_unlock_with_mobile_key = null, /** - * dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\DormakabaAmbianceMetadata|null $dormakaba_ambiance_metadata = null, /** - * dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\DormakabaCommunityMetadata|null $dormakaba_community_metadata = null, /** - * Hotek-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\HotekMetadata|null $hotek_metadata = null, /** - * Indicates whether the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) is currently locked. + * Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked. */ public bool|null $is_locked = null, /** - * Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\LatchMetadata|null $latch_metadata = null, /** - * Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\SaltoKsMetadata|null $salto_ks_metadata = null, /** - * Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\SaltoSpaceMetadata|null $salto_space_metadata = null, /** - * Visionline-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public \Seam\Resources\AcsEntrance\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -216,7 +216,7 @@ public function __construct( namespace Seam\Resources\AcsEntrance { /** - * Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class AkilesMetadata { @@ -263,7 +263,7 @@ public function __construct( } /** - * ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class AssaAbloyVostioMetadata { @@ -309,7 +309,7 @@ public function __construct( } /** - * Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class AvigilonAltaMetadata { @@ -363,7 +363,7 @@ public function __construct( } /** - * Brivo-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class BrivoMetadata { @@ -396,7 +396,7 @@ public function __construct( } /** - * dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class DormakabaAmbianceMetadata { @@ -420,7 +420,7 @@ public function __construct( } /** - * dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class DormakabaCommunityMetadata { @@ -444,7 +444,7 @@ public function __construct( } /** - * Errors associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class Errors { @@ -477,7 +477,7 @@ public function __construct( } /** - * Hotek-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class HotekMetadata { @@ -510,7 +510,7 @@ public function __construct( } /** - * Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class LatchMetadata { @@ -548,7 +548,7 @@ public function __construct( } /** - * Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class SaltoKsMetadata { @@ -606,7 +606,7 @@ public function __construct( } /** - * Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class SaltoSpaceMetadata { @@ -654,7 +654,7 @@ public function __construct( } /** - * Visionline-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ class VisionlineMetadata { @@ -698,7 +698,7 @@ public function __construct( } /** - * Warnings associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { diff --git a/src/Resources/AcsSystem.php b/src/Resources/AcsSystem.php index 88a89b3c..33afa84d 100644 --- a/src/Resources/AcsSystem.php +++ b/src/Resources/AcsSystem.php @@ -2,11 +2,11 @@ namespace Seam\Resources { /** - * Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * - * Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users/object) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the `acs_user`s. + * Within an `acs_system`, create [`acs_user`s](https://www.seam.co/docs/api/acs/users/object) and [`acs_credential`s](https://www.seam.co/docs/api/acs/credentials/object) to grant access to the `acs_user`s. * - * For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs). + * For details about the resources associated with an access control system, see the [access control systems namespace](https://www.seam.co/docs/api/acs/object). */ class AcsSystem { @@ -58,36 +58,36 @@ public static function from_json(mixed $json): AcsSystem|null public function __construct( /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public string|null $acs_system_id, /** - * ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public string|null $connected_account_id, /** - * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * @var list|null * @deprecated Use `connected_account_id`. */ public array|null $connected_account_ids, /** - * Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. + * Date and time at which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) was created. */ public string|null $created_at, /** - * Errors associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Errors associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * @var list<\Seam\Resources\AcsSystem\Errors> */ public array $errors, /** - * Alternative text for the [access control system](https://docs.seam.co/low-level-apis/access-systems) image. + * Alternative text for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) image. */ public string|null $image_alt_text, /** - * URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * URL for the image that represents the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public string|null $image_url, /** @@ -95,43 +95,43 @@ public function __construct( */ public bool|null $is_credential_manager, /** - * Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Location information for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public \Seam\Resources\AcsSystem\Location|null $location, /** - * Name of the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public string|null $name, /** - * Warnings associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Warnings associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * @var list<\Seam\Resources\AcsSystem\Warnings> */ public array $warnings, /** - * ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the workspace that contains the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public string|null $workspace_id, /** - * Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Number of access groups in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public float|null $acs_access_group_count = null, /** - * Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Number of users in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public float|null $acs_user_count = null, /** - * ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the default credential manager `acs_system` for this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public string|null $default_credential_manager_acs_system_id = null, /** - * Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. + * Brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type. * * @var value-of<\Seam\Resources\AcsSystem\ExternalType>|string|null */ public string|null $external_type = null, /** - * Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. + * Display name that corresponds to the brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type. */ public string|null $external_type_display_name = null, /** @@ -144,7 +144,7 @@ public function __construct( */ public string|null $system_type_display_name = null, /** - * Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ public \Seam\Resources\AcsSystem\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -153,7 +153,7 @@ public function __construct( namespace Seam\Resources\AcsSystem { /** - * Errors associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -232,7 +232,7 @@ public function __construct( } /** - * Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Location information for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ class Location { @@ -246,14 +246,14 @@ public static function from_json(mixed $json): Location|null public function __construct( /** - * Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. + * Time zone in which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is located. */ public string|null $time_zone, ) {} } /** - * Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ class VisionlineMetadata { @@ -271,7 +271,7 @@ public static function from_json(mixed $json): VisionlineMetadata|null public function __construct( /** - * IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network. + * IP address or hostname of the main Visionline server relative to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) on the local network. */ public string|null $lan_address = null, /** @@ -286,7 +286,7 @@ public function __construct( } /** - * Warnings associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -389,9 +389,9 @@ enum SystemType: string namespace Seam\Resources\AcsSystem\Errors { /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. - * This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). - * See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + * This error might also occur if Seam Bridge is connected to the wrong [workspace](https://www.seam.co/docs/core-concepts/workspaces). + * See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class SeamBridgeDisconnected extends \Seam\Resources\AcsSystem\Errors { @@ -433,8 +433,8 @@ public function __construct( } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. - * See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + * See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class BridgeDisconnected extends \Seam\Resources\AcsSystem\Errors { @@ -467,7 +467,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to the [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ public bool|null $is_bridge_error = null, ) { @@ -480,9 +480,9 @@ public function __construct( } /** - * Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). - * For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). - * See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable). + * Indicates that [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://www.seam.co/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). + * For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). + * See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable). */ final class VisionlineInstanceUnreachable extends \Seam\Resources\AcsSystem\Errors @@ -568,7 +568,7 @@ public function __construct( } /** - * Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://docs.seam.co/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system. + * Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system. */ final class InsufficientPermissions extends \Seam\Resources\AcsSystem\Errors { @@ -610,7 +610,7 @@ public function __construct( } /** - * Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. + * Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. */ final class AcsSystemDisconnected extends \Seam\Resources\AcsSystem\Errors { @@ -652,7 +652,7 @@ public function __construct( } /** - * Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. + * Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) to restore access. */ final class AccountDisconnected extends \Seam\Resources\AcsSystem\Errors { @@ -693,7 +693,7 @@ public function __construct( } /** - * Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. + * Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. */ final class SaltoKsCertificationExpired extends \Seam\Resources\AcsSystem\Errors @@ -837,7 +837,7 @@ public function __construct( } /** - * Indicates the [access control system](https://docs.seam.co/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ final class TimeZoneDoesNotMatchLocation extends \Seam\Resources\AcsSystem\Warnings @@ -928,7 +928,7 @@ public function __construct( } /** - * Indicates that Seam encountered an unexpected error while syncing this [access control system](https://docs.seam.co/low-level-apis/access-systems), so its users, credentials, and access groups may be out of date. Seam retries on every sync cycle and clears this warning once a sync succeeds; if it persists, contact [support](mailto:support@seam.co). + * Indicates that Seam encountered an unexpected error while syncing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems), so its users, credentials, and access groups may be out of date. Seam retries on every sync cycle and clears this warning once a sync succeeds; if it persists, contact [support](mailto:support@seam.co). */ final class UnknownIssueWithAcsSystem extends \Seam\Resources\AcsSystem\Warnings diff --git a/src/Resources/AcsUser.php b/src/Resources/AcsUser.php index c063569a..5842baa9 100644 --- a/src/Resources/AcsUser.php +++ b/src/Resources/AcsUser.php @@ -2,11 +2,11 @@ namespace Seam\Resources { /** - * Represents a [user](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access system](https://docs.seam.co/low-level-apis/access-systems). + * Represents a [user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * 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/device-and-system-integration-guides#access-control-systems). + * For details about how to configure users in your access system, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ class AcsUser { @@ -74,27 +74,27 @@ public static function from_json(mixed $json): AcsUser|null public function __construct( /** - * ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the [access system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $acs_system_id, /** - * ID of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $acs_user_id, /** - * The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * The ID of the connected account that is associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $connected_account_id, /** - * Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. + * Date and time at which the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created. */ public string|null $created_at, /** - * Display name for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $display_name, /** - * Errors associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @var list<\Seam\Resources\AcsUser\Errors> */ @@ -104,17 +104,17 @@ public function __construct( */ public true|null $is_managed, /** - * Warnings associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @var list<\Seam\Resources\AcsUser\Warnings> */ public array $warnings, /** - * ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the workspace that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $workspace_id, /** - * `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/low-level-apis/access-systems/user-management) access. + * `starts_at` and `ends_at` timestamps for the [access system user's](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access. */ public \Seam\Resources\AcsUser\AccessSchedule|null $access_schedule = null, /** @@ -122,21 +122,21 @@ public function __construct( */ public string|null $email = null, /** - * Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $email_address = null, /** - * Brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type. + * Brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type. * * @var value-of<\Seam\Resources\AcsUser\ExternalType>|string|null */ public string|null $external_type = null, /** - * Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type. + * Display name that corresponds to the brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type. */ public string|null $external_type_display_name = null, /** - * Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $full_name = null, /** @@ -144,41 +144,41 @@ public function __construct( */ public string|null $hid_acs_system_id = null, /** - * Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users). + * Indicates whether the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is currently [suspended](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users). */ public bool|null $is_suspended = null, /** - * Pending mutations associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. + * Pending mutations associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. * * @var list<\Seam\Resources\AcsUser\PendingMutations>|null */ public array|null $pending_mutations = null, /** - * Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ public string|null $phone_number = null, /** - * Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Salto KS-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public \Seam\Resources\AcsUser\SaltoKsMetadata|null $salto_ks_metadata = null, /** - * Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Salto Space-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public \Seam\Resources\AcsUser\SaltoSpaceMetadata|null $salto_space_metadata = null, /** - * Email address of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Email address of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $user_identity_email_address = null, /** - * Full name of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Full name of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $user_identity_full_name = null, /** - * ID of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ public string|null $user_identity_id = null, /** - * Phone number of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * Phone number of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ public string|null $user_identity_phone_number = null, ) {} @@ -187,7 +187,7 @@ public function __construct( namespace Seam\Resources\AcsUser { /** - * `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/low-level-apis/access-systems/user-management) access. + * `starts_at` and `ends_at` timestamps for the [access system user's](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access. */ class AccessSchedule { @@ -215,7 +215,7 @@ public function __construct( } /** - * Errors associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -280,7 +280,7 @@ public function __construct( } /** - * Pending mutations associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. Known mutation_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Pending mutations associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. Known mutation_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class PendingMutations { @@ -359,7 +359,7 @@ public function __construct( } /** - * Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Salto KS-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ class SaltoKsMetadata { @@ -380,7 +380,7 @@ public function __construct( } /** - * Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Salto Space-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ class SaltoSpaceMetadata { @@ -408,7 +408,7 @@ public function __construct( } /** - * Warnings associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -484,7 +484,7 @@ enum ExternalType: string namespace Seam\Resources\AcsUser\Errors { /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems) outside of Seam. */ final class DeletedExternally extends \Seam\Resources\AcsUser\Errors { @@ -523,7 +523,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. */ final class SaltoKsSubscriptionLimitExceeded extends \Seam\Resources\AcsUser\Errors @@ -564,7 +564,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ final class FailedToCreateOnAcsSystem extends \Seam\Resources\AcsUser\Errors { @@ -604,7 +604,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not updated on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ final class FailedToUpdateOnAcsSystem extends \Seam\Resources\AcsUser\Errors { @@ -644,7 +644,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ final class FailedToDeleteOnAcsSystem extends \Seam\Resources\AcsUser\Errors { @@ -684,7 +684,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). */ final class LatchConflictWithResidentUser extends \Seam\Resources\AcsUser\Errors @@ -1502,7 +1502,7 @@ public function __construct( namespace Seam\Resources\AcsUser\Warnings { /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. */ final class BeingDeleted extends \Seam\Resources\AcsUser\Warnings { @@ -1541,7 +1541,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. */ final class SaltoKsUserNotSubscribed extends \Seam\Resources\AcsUser\Warnings @@ -1582,7 +1582,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked. */ final class AcsUserInactive extends \Seam\Resources\AcsUser\Warnings { @@ -1621,7 +1621,7 @@ public function __construct( } /** - * An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. + * An unknown issue occurred while syncing the state of this [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. */ final class UnknownIssueWithAcsUser extends \Seam\Resources\AcsUser\Warnings { @@ -1661,7 +1661,7 @@ public function __construct( } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. */ final class LatchResidentUser extends \Seam\Resources\AcsUser\Warnings { diff --git a/src/Resources/ActionAttempt.php b/src/Resources/ActionAttempt.php index 63505195..540d7f0c 100644 --- a/src/Resources/ActionAttempt.php +++ b/src/Resources/ActionAttempt.php @@ -2078,15 +2078,15 @@ public static function from_json( public function __construct( /** - * A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_number, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ public string|null $created_at, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) will stop being usable. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */ public string|null $ends_at, /** @@ -2094,11 +2094,11 @@ public function __construct( */ public bool|null $is_issued, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */ public string|null $starts_at, /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnEncoder\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -2182,46 +2182,46 @@ public static function from_json(mixed $json): AcsCredentialOnSeam|null public function __construct( /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. * * @var value-of<\Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\AccessMethod>|string|null */ public string|null $access_method, /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_credential_id, /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_system_id, /** - * ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $connected_account_id, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ public string|null $created_at, /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $display_name, /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\Errors> */ public array $errors, public bool|null $is_managed, /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\Warnings> */ public array $warnings, /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $workspace_id, /** @@ -2229,77 +2229,77 @@ public function __construct( */ public string|null $acs_credential_pool_id = null, /** - * ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $acs_user_id = null, /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\AkilesMetadata|null $akiles_metadata = null, /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\AssaAbloyVostioMetadata|null $assa_abloy_vostio_metadata = null, /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_number = null, /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $code = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */ public string|null $ends_at = null, /** - * Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. + * Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. * * @var value-of<\Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\ExternalType>|string|null */ public string|null $external_type = null, /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $external_type_display_name = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ public bool|null $is_issued = null, /** - * Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. + * Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */ public bool|null $is_latest_desired_state_synced_with_provider = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */ public bool|null $is_multi_phone_sync_credential = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */ public bool|null $is_one_time_use = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ public string|null $issued_at = null, /** - * Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. + * Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */ public string|null $latest_desired_state_synced_with_provider_at = null, /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $parent_acs_credential_id = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $starts_at = null, /** - * ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $user_identity_id = null, /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -2338,7 +2338,7 @@ public function __construct( namespace Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnEncoder { /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class VisionlineMetadata { @@ -2365,57 +2365,57 @@ public static function from_json(mixed $json): VisionlineMetadata|null public function __construct( /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is cancelled. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */ public bool|null $cancelled = null, /** - * Format of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var value-of<\Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnEncoder\VisionlineMetadata\CardFormat>|string|null */ public string|null $card_format = null, /** - * Holder of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_holder = null, /** - * Card ID for the Visionline card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_id = null, /** - * IDs of the common [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list|null */ public array|null $common_acs_entrance_ids = null, /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is discarded. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */ public bool|null $discarded = null, /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is expired. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */ public bool|null $expired = null, /** - * IDs of the guest [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list|null */ public array|null $guest_acs_entrance_ids = null, /** - * Number of issued cards associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public float|null $number_of_issued_cards = null, /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is overridden. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */ public bool|null $overridden = null, /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is overwritten. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */ public bool|null $overwritten = null, /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is pending auto-update. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */ public bool|null $pending_auto_update = null, ) {} @@ -2432,7 +2432,7 @@ enum CardFormat: string namespace Seam\Resources\ActionAttempt\ScanCredential\Success\Result\AcsCredentialOnSeam { /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AkilesMetadata { @@ -2453,7 +2453,7 @@ public function __construct( } /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AssaAbloyVostioMetadata { @@ -2507,7 +2507,7 @@ public function __construct( } /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Errors { @@ -2534,7 +2534,7 @@ public function __construct( } /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class VisionlineMetadata { @@ -2601,7 +2601,7 @@ public function __construct( } /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Warnings { @@ -2975,46 +2975,46 @@ public static function from_json(mixed $json): Result|null public function __construct( /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. * * @var value-of<\Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\AccessMethod>|string|null */ public string|null $access_method, /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_credential_id, /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_system_id, /** - * ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $connected_account_id, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ public string|null $created_at, /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $display_name, /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\Errors> */ public array $errors, public bool|null $is_managed, /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\Warnings> */ public array $warnings, /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $workspace_id, /** @@ -3022,77 +3022,77 @@ public function __construct( */ public string|null $acs_credential_pool_id = null, /** - * ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $acs_user_id = null, /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\AkilesMetadata|null $akiles_metadata = null, /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\AssaAbloyVostioMetadata|null $assa_abloy_vostio_metadata = null, /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_number = null, /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $code = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */ public string|null $ends_at = null, /** - * Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. + * Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. * * @var value-of<\Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\ExternalType>|string|null */ public string|null $external_type = null, /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $external_type_display_name = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ public bool|null $is_issued = null, /** - * Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. + * Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */ public bool|null $is_latest_desired_state_synced_with_provider = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */ public bool|null $is_multi_phone_sync_credential = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */ public bool|null $is_one_time_use = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ public string|null $issued_at = null, /** - * Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. + * Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */ public string|null $latest_desired_state_synced_with_provider_at = null, /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $parent_acs_credential_id = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $starts_at = null, /** - * ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $user_identity_id = null, /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\EncodeCredential\Success\Result\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -3101,7 +3101,7 @@ public function __construct( namespace Seam\Resources\ActionAttempt\EncodeCredential\Success\Result { /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AkilesMetadata { @@ -3122,7 +3122,7 @@ public function __construct( } /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AssaAbloyVostioMetadata { @@ -3176,7 +3176,7 @@ public function __construct( } /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Errors { @@ -3203,7 +3203,7 @@ public function __construct( } /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class VisionlineMetadata { @@ -3270,7 +3270,7 @@ public function __construct( } /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Warnings { @@ -3643,33 +3643,33 @@ public static function from_json(mixed $json): Result|null public function __construct( /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. * * @var value-of<\Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\AccessMethod>|string|null */ public string|null $access_method, /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_credential_id, /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $acs_system_id, /** - * ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $connected_account_id, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ public string|null $created_at, /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $display_name, /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\Errors> */ @@ -3679,13 +3679,13 @@ public function __construct( */ public true|null $is_managed, /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @var list<\Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\Warnings> */ public array $warnings, /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $workspace_id, /** @@ -3693,77 +3693,77 @@ public function __construct( */ public string|null $acs_credential_pool_id = null, /** - * ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $acs_user_id = null, /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\AkilesMetadata|null $akiles_metadata = null, /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\AssaAbloyVostioMetadata|null $assa_abloy_vostio_metadata = null, /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $card_number = null, /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $code = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */ public string|null $ends_at = null, /** - * Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. + * Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. * * @var value-of<\Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\ExternalType>|string|null */ public string|null $external_type = null, /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ public string|null $external_type_display_name = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ public bool|null $is_issued = null, /** - * Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. + * Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */ public bool|null $is_latest_desired_state_synced_with_provider = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */ public bool|null $is_multi_phone_sync_credential = null, /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */ public bool|null $is_one_time_use = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ public string|null $issued_at = null, /** - * Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. + * Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */ public string|null $latest_desired_state_synced_with_provider_at = null, /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public string|null $parent_acs_credential_id = null, /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $starts_at = null, /** - * ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. + * ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */ public string|null $user_identity_id = null, /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ public \Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result\VisionlineMetadata|null $visionline_metadata = null, ) {} @@ -3772,7 +3772,7 @@ public function __construct( namespace Seam\Resources\ActionAttempt\ScanToAssignCredential\Success\Result { /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AkilesMetadata { @@ -3793,7 +3793,7 @@ public function __construct( } /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class AssaAbloyVostioMetadata { @@ -3847,7 +3847,7 @@ public function __construct( } /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Errors { @@ -3874,7 +3874,7 @@ public function __construct( } /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class VisionlineMetadata { @@ -3941,7 +3941,7 @@ public function __construct( } /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ class Warnings { @@ -4299,7 +4299,7 @@ public function __construct( */ public string|null $display_status, /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). * * @var list<\Seam\Resources\ActionAttempt\AssignCredential\Success\Result\Errors> */ @@ -4319,13 +4319,13 @@ public function __construct( */ public string|null $mode, /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. * * @var list<\Seam\Resources\ActionAttempt\AssignCredential\Success\Result\PendingMutations> */ public array $pending_mutations, /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). * * @var list<\Seam\Resources\ActionAttempt\AssignCredential\Success\Result\Warnings> */ @@ -4372,7 +4372,7 @@ public function __construct( namespace Seam\Resources\ActionAttempt\AssignCredential\Success\Result { /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ class Errors { @@ -4407,7 +4407,7 @@ public function __construct( } /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. */ class PendingMutations { @@ -4460,7 +4460,7 @@ public function __construct( } /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ class Warnings { diff --git a/src/Resources/Batch.php b/src/Resources/Batch.php index 7f5c92a0..58c7ae73 100644 --- a/src/Resources/Batch.php +++ b/src/Resources/Batch.php @@ -42,15 +42,15 @@ public static function from_json(mixed $json): Batch|null public function __construct( /** - * Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate. * - * Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time. + * Seam supports programming two types of access codes: [ongoing](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time. * - * In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. + * In addition, for certain devices, Seam also supports [offline access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. * - * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. + * For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */ public mixed $access_codes = null, /** @@ -64,23 +64,23 @@ public function __construct( /** * Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. * - * Some access control systems use [access group](https://docs.seam.co/low-level-apis/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. + * Some access control systems use [access group](https://www.seam.co/docs/low-level-apis/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/device-and-system-integration-guides#access-control-systems). + * To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ public mixed $acs_access_groups = null, /** - * Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs. * * For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. * - * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. + * For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */ public mixed $acs_credentials = null, /** - * Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents a hardware device that encodes [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps: * @@ -91,31 +91,31 @@ public function __construct( * * Separately, 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. * - * See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/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/device-and-system-integration-guides#access-control-systems). + * To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ public mixed $acs_encoders = null, /** - * Represents an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */ public mixed $acs_entrances = null, /** - * Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * - * Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users/object) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the `acs_user`s. + * Within an `acs_system`, create [`acs_user`s](https://www.seam.co/docs/api/acs/users/object) and [`acs_credential`s](https://www.seam.co/docs/api/acs/credentials/object) to grant access to the `acs_user`s. * - * For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs). + * For details about the resources associated with an access control system, see the [access control systems namespace](https://www.seam.co/docs/api/acs/object). */ public mixed $acs_systems = null, /** - * Represents a [user](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access system](https://docs.seam.co/low-level-apis/access-systems). + * Represents a [user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * 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/device-and-system-integration-guides#access-control-systems). + * For details about how to configure users in your access system, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ public mixed $acs_users = null, /** @@ -123,11 +123,11 @@ public function __construct( * * When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action. * - * See also [Action Attempts](https://docs.seam.co/core-concepts/action-attempts). + * See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */ public mixed $action_attempts = null, /** - * Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. + * Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. * * You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides. * @@ -135,11 +135,11 @@ public function __construct( * * A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own. * - * See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). + * See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ public mixed $client_sessions = null, /** - * Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API. * @@ -153,11 +153,11 @@ public function __construct( */ public mixed $connect_webviews = null, /** - * Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. + * Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */ public mixed $connected_accounts = null, /** - * Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam. + * Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam. */ public mixed $devices = null, /** @@ -173,7 +173,7 @@ public function __construct( */ public mixed $instant_keys = null, /** - * Represents a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. + * Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */ public mixed $noise_thresholds = null, /** @@ -185,11 +185,11 @@ public function __construct( */ public mixed $thermostat_daily_programs = null, /** - * Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. + * Represents a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */ public mixed $thermostat_schedules = null, /** - * Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. * @@ -199,19 +199,19 @@ public function __construct( * * Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes: * - * - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks) + * - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks) */ public mixed $unmanaged_access_codes = null, /** - * Represents an [unmanaged device](https://docs.seam.co/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/low-level-apis/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/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * Represents an [unmanaged device](https://www.seam.co/docs/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://www.seam.co/docs/low-level-apis/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://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ public mixed $unmanaged_devices = null, /** - * Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. + * Represents a [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */ public mixed $user_identities = null, /** - * Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). + * Represents a Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://www.seam.co/docs/core-concepts/workspaces#production-workspaces). */ public mixed $workspaces = null, ) {} diff --git a/src/Resources/ClientSession.php b/src/Resources/ClientSession.php index d9664152..f7c43dd7 100644 --- a/src/Resources/ClientSession.php +++ b/src/Resources/ClientSession.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. + * Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. * * You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides. * @@ -10,7 +10,7 @@ * * A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own. * - * See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). + * See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ class ClientSession { @@ -41,39 +41,39 @@ public function __construct( */ public string|null $client_session_id, /** - * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * * @var list|null */ public array|null $connect_webview_ids, /** - * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * * @var list|null */ public array|null $connected_account_ids, /** - * Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. + * Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) was created. */ public string|null $created_at, /** - * Number of devices associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Number of devices associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ public float|null $device_count, /** - * Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) expires. + * Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) expires. */ public string|null $expires_at, /** - * Client session token associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Client session token associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ public string|null $token, /** - * Your user ID for the user associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Your user ID for the user associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ public string|null $user_identifier_key, /** - * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. + * IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. * * @var list|null * @deprecated Use `user_identity_id` instead. @@ -84,11 +84,11 @@ public function __construct( */ public string|null $workspace_id, /** - * Customer key associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Customer key associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ public string|null $customer_key = null, /** - * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. + * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. */ public string|null $user_identity_id = null, ) {} diff --git a/src/Resources/ConnectWebview.php b/src/Resources/ConnectWebview.php index 4cfcd0c0..7445796f 100644 --- a/src/Resources/ConnectWebview.php +++ b/src/Resources/ConnectWebview.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API. * @@ -55,7 +55,7 @@ public function __construct( */ public array|null $accepted_capabilities, /** - * List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). * * @var list|null */ @@ -69,7 +69,7 @@ public function __construct( */ public string|null $authorized_at, /** - * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. + * Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */ public bool|null $automatically_manage_new_devices, /** @@ -85,7 +85,7 @@ public function __construct( */ public string|null $created_at, /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. * * @var array|\stdClass|null */ @@ -109,7 +109,7 @@ public function __construct( */ public bool|null $login_successful, /** - * Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * Selected provider of the Connect Webview, one of the [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ public string|null $selected_provider, /** @@ -123,7 +123,7 @@ public function __construct( */ public string|null $url, /** - * Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. + * Indicates whether Seam should [finish syncing all devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */ public bool|null $wait_for_device_creation, /** diff --git a/src/Resources/ConnectedAccount.php b/src/Resources/ConnectedAccount.php index 04da53ca..bde91d28 100644 --- a/src/Resources/ConnectedAccount.php +++ b/src/Resources/ConnectedAccount.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. + * Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */ class ConnectedAccount { @@ -63,7 +63,7 @@ public function __construct( */ public string|null $account_type_display_name, /** - * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API. + * Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API. */ public bool|null $automatically_manage_new_devices, /** @@ -71,7 +71,7 @@ public function __construct( */ public string|null $connected_account_id, /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. * * @var array|\stdClass|null */ @@ -199,7 +199,7 @@ public function __construct( */ public string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ public bool|null $is_bridge_error = null, /** @@ -368,7 +368,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ bool|null $is_bridge_error = null, /** @@ -387,7 +387,7 @@ public function __construct( } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class BridgeDisconnected extends \Seam\Resources\ConnectedAccount\Errors @@ -423,7 +423,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ bool|null $is_bridge_error = null, /** @@ -488,7 +488,7 @@ public function __construct( */ public \Seam\Resources\ConnectedAccount\Errors\SaltoKsSubscriptionLimitExceeded\SaltoKsMetadata|null $salto_ks_metadata, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ bool|null $is_bridge_error = null, /** @@ -544,7 +544,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ bool|null $is_bridge_error = null, /** diff --git a/src/Resources/Device.php b/src/Resources/Device.php index e020ce89..400936ab 100644 --- a/src/Resources/Device.php +++ b/src/Resources/Device.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam. + * Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam. */ class Device { @@ -86,7 +86,7 @@ public static function from_json(mixed $json): Device|null public function __construct( /** - * 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags). + * 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags). * * @var list|null */ @@ -100,7 +100,7 @@ public function __construct( */ public string|null $created_at, /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. * * @var array|\stdClass|null */ @@ -126,7 +126,7 @@ public function __construct( */ public array $errors, /** - * Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). */ public true|null $is_managed, /** @@ -895,13 +895,13 @@ public function __construct( */ public \Seam\Resources\Device\Properties\AccessoryKeypad|null $accessory_keypad = null, /** - * Active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */ public \Seam\Resources\Device\Properties\ActiveThermostatSchedule|null $active_thermostat_schedule = null, /** - * ID of the active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $active_thermostat_schedule_id = null, /** @@ -939,7 +939,7 @@ public function __construct( */ public array|null $available_climate_preset_modes = null, /** - * Available [climate presets](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. + * Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. * * @var list<\Seam\Resources\Device\Properties\AvailableClimatePresets>|null */ @@ -961,7 +961,7 @@ public function __construct( */ public \Seam\Resources\Device\Properties\AvigilonAltaMetadata|null $avigilon_alta_metadata = null, /** - * Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). + * Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://www.seam.co/docs/api/devices/update). */ public bool|null $backup_access_code_pool_enabled = null, /** @@ -1017,7 +1017,7 @@ public function __construct( */ public \Seam\Resources\Device\Properties\EcobeeMetadata|null $ecobee_metadata = null, /** - * Key of the [fallback climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + * Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */ public string|null $fallback_climate_preset_key = null, /** @@ -1114,19 +1114,19 @@ public function __construct( */ public float|null $max_active_codes_supported = null, /** - * Maximum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. */ public float|null $max_cooling_set_point_celsius = null, /** - * Maximum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. */ public float|null $max_cooling_set_point_fahrenheit = null, /** - * Maximum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. */ public float|null $max_heating_set_point_celsius = null, /** - * Maximum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. */ public float|null $max_heating_set_point_fahrenheit = null, /** @@ -1138,27 +1138,27 @@ public function __construct( */ public float|null $max_unique_climate_presets_per_thermostat_weekly_program = null, /** - * Minimum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. */ public float|null $min_cooling_set_point_celsius = null, /** - * Minimum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. */ public float|null $min_cooling_set_point_fahrenheit = null, /** - * Minimum [temperature difference](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode. + * Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode. */ public float|null $min_heating_cooling_delta_celsius = null, /** - * Minimum [temperature difference](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode. + * Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode. */ public float|null $min_heating_cooling_delta_fahrenheit = null, /** - * Minimum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. */ public float|null $min_heating_set_point_celsius = null, /** - * Minimum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. */ public float|null $min_heating_set_point_fahrenheit = null, /** @@ -1262,7 +1262,7 @@ public function __construct( */ public bool|null $supports_accessory_keypad = null, /** - * Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). + * Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes). */ public bool|null $supports_backup_access_code_pool = null, /** @@ -1290,7 +1290,7 @@ public function __construct( */ public float|null $temperature_fahrenheit = null, /** - * Current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ public \Seam\Resources\Device\Properties\TemperatureThreshold|null $temperature_threshold = null, /** @@ -1298,13 +1298,13 @@ public function __construct( */ public float|null $thermostat_daily_program_period_precision_minutes = null, /** - * Configured [daily programs](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + * Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. * * @var list<\Seam\Resources\Device\Properties\ThermostatDailyPrograms>|null */ public array|null $thermostat_daily_programs = null, /** - * Current [weekly program](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + * Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */ public \Seam\Resources\Device\Properties\ThermostatWeeklyProgram|null $thermostat_weekly_program = null, /** @@ -1571,7 +1571,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1625,7 +1625,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1678,7 +1678,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1731,7 +1731,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1936,7 +1936,7 @@ public function __construct( } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ final class EmptyBackupAccessCodePool extends \Seam\Resources\Device\Errors { @@ -2169,7 +2169,7 @@ public function __construct( } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class BridgeDisconnected extends \Seam\Resources\Device\Errors { @@ -2204,7 +2204,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ public bool|null $is_bridge_error = null, /** @@ -4405,7 +4405,7 @@ public function __construct( } /** - * Active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */ @@ -4442,37 +4442,37 @@ public static function from_json( public function __construct( /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $climate_preset_key, /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ public string|null $created_at, /** - * ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. + * ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device. */ public string|null $device_id, /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $ends_at, /** - * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * * @var list<\Seam\Resources\Device\Properties\ActiveThermostatSchedule\Errors> */ public array $errors, /** - * User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $name, /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $starts_at, /** - * ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $thermostat_schedule_id, /** @@ -4480,18 +4480,18 @@ public function __construct( */ public string|null $workspace_id, /** - * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. + * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */ public bool|null $is_override_allowed = null, /** - * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ public int|null $max_override_period_minutes = null, ) {} } /** - * Available [climate presets](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. + * Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. */ class AvailableClimatePresets { @@ -4531,27 +4531,27 @@ public static function from_json( public function __construct( /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */ public bool|null $can_delete, /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */ public bool|null $can_edit, /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */ public bool|null $can_use_with_thermostat_daily_programs, /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $climate_preset_key, /** - * Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $display_name, /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * * @deprecated Use 'thermostat_schedule.is_override_allowed' */ @@ -4563,11 +4563,11 @@ public function __construct( */ public string|null $climate_preset_mode = null, /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_celsius = null, /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_fahrenheit = null, /** @@ -4575,27 +4575,27 @@ public function __construct( */ public \Seam\Resources\Device\Properties\AvailableClimatePresets\EcobeeMetadata|null $ecobee_metadata = null, /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. * * @var value-of<\Seam\Resources\Device\Properties\AvailableClimatePresets\FanModeSetting>|string|null */ public string|null $fan_mode_setting = null, /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_celsius = null, /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_fahrenheit = null, /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. * * @var value-of<\Seam\Resources\Device\Properties\AvailableClimatePresets\HvacModeSetting>|string|null */ public string|null $hvac_mode_setting = null, /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $name = null, ) {} @@ -4642,19 +4642,19 @@ public static function from_json( public function __construct( /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */ public bool|null $can_delete = null, /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */ public bool|null $can_edit = null, /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */ public bool|null $can_use_with_thermostat_daily_programs = null, /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $climate_preset_key = null, /** @@ -4664,15 +4664,15 @@ public function __construct( */ public string|null $climate_preset_mode = null, /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_celsius = null, /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_fahrenheit = null, /** - * Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $display_name = null, /** @@ -4680,33 +4680,33 @@ public function __construct( */ public \Seam\Resources\Device\Properties\CurrentClimateSetting\EcobeeMetadata|null $ecobee_metadata = null, /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. * * @var value-of<\Seam\Resources\Device\Properties\CurrentClimateSetting\FanModeSetting>|string|null */ public string|null $fan_mode_setting = null, /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_celsius = null, /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_fahrenheit = null, /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. * * @var value-of<\Seam\Resources\Device\Properties\CurrentClimateSetting\HvacModeSetting>|string|null */ public string|null $hvac_mode_setting = null, /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * * @deprecated Use 'thermostat_schedule.is_override_allowed' */ public bool|null $manual_override_allowed = null, /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $name = null, ) {} @@ -4753,19 +4753,19 @@ public static function from_json( public function __construct( /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */ public bool|null $can_delete = null, /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */ public bool|null $can_edit = null, /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */ public bool|null $can_use_with_thermostat_daily_programs = null, /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $climate_preset_key = null, /** @@ -4775,15 +4775,15 @@ public function __construct( */ public string|null $climate_preset_mode = null, /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_celsius = null, /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_fahrenheit = null, /** - * Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $display_name = null, /** @@ -4791,40 +4791,40 @@ public function __construct( */ public \Seam\Resources\Device\Properties\DefaultClimateSetting\EcobeeMetadata|null $ecobee_metadata = null, /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. * * @var value-of<\Seam\Resources\Device\Properties\DefaultClimateSetting\FanModeSetting>|string|null */ public string|null $fan_mode_setting = null, /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_celsius = null, /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_fahrenheit = null, /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. * * @var value-of<\Seam\Resources\Device\Properties\DefaultClimateSetting\HvacModeSetting>|string|null */ public string|null $hvac_mode_setting = null, /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * * @deprecated Use 'thermostat_schedule.is_override_allowed' */ public bool|null $manual_override_allowed = null, /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ public string|null $name = null, ) {} } /** - * Current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ class TemperatureThreshold { @@ -4843,26 +4843,26 @@ public static function from_json(mixed $json): TemperatureThreshold|null public function __construct( /** - * Lower limit in °C within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ public float|null $lower_limit_celsius, /** - * Lower limit in °F within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ public float|null $lower_limit_fahrenheit, /** - * Upper limit in °C within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ public float|null $upper_limit_celsius, /** - * Upper limit in °F within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ public float|null $upper_limit_fahrenheit, ) {} } /** - * Configured [daily programs](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + * Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */ class ThermostatDailyPrograms { @@ -4921,7 +4921,7 @@ public function __construct( } /** - * Current [weekly program](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + * Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */ class ThermostatWeeklyProgram { @@ -5548,7 +5548,7 @@ public function __construct( namespace Seam\Resources\Device\Properties\ActiveThermostatSchedule { /** - * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ class Errors { @@ -5813,7 +5813,7 @@ public static function from_json(mixed $json): Periods|null public function __construct( /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ public string|null $climate_preset_key, /** diff --git a/src/Resources/Event.php b/src/Resources/Event.php index 78f04b77..2b4879f6 100644 --- a/src/Resources/Event.php +++ b/src/Resources/Event.php @@ -454,7 +454,7 @@ public function __construct( namespace Seam\Resources\Event { /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was created. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was created. */ final class AccessCodeCreated extends \Seam\Resources\Event { @@ -541,7 +541,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was changed. */ final class AccessCodeChanged extends \Seam\Resources\Event { @@ -647,7 +647,7 @@ public function __construct( } /** - * The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device. + * The name of an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was changed on the device. */ final class AccessCodeNameChanged extends \Seam\Resources\Event { @@ -758,7 +758,7 @@ public function __construct( } /** - * The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device. + * The pin code of an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was changed on the device. */ final class AccessCodeCodeChanged extends \Seam\Resources\Event { @@ -869,7 +869,7 @@ public function __construct( } /** - * The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device. + * The time frame of an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was changed on the device. */ final class AccessCodeTimeFrameChanged extends \Seam\Resources\Event { @@ -980,7 +980,7 @@ public function __construct( } /** - * Mutations were requested on an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device. + * Mutations were requested on an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device. */ final class AccessCodeMutationsRequested extends \Seam\Resources\Event { @@ -1082,7 +1082,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) on a device. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was [scheduled natively](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) on a device. */ final class AccessCodeScheduledOnDevice extends \Seam\Resources\Event { @@ -1175,7 +1175,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was set on a device. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was set on a device. */ final class AccessCodeSetOnDevice extends \Seam\Resources\Event { @@ -1268,7 +1268,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was removed from a device. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was removed from a device. */ final class AccessCodeRemovedFromDevice extends \Seam\Resources\Event { @@ -1356,7 +1356,7 @@ public function __construct( } /** - * There was an unusually long delay in setting an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) on a device. + * There was an unusually long delay in setting an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) on a device. */ final class AccessCodeDelayInSettingOnDevice extends \Seam\Resources\Event { @@ -1528,7 +1528,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be set on a device. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) failed to be set on a device. */ final class AccessCodeFailedToSetOnDevice extends \Seam\Resources\Event { @@ -1700,7 +1700,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was deleted. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was deleted. */ final class AccessCodeDeleted extends \Seam\Resources\Event { @@ -1792,7 +1792,7 @@ public function __construct( } /** - * There was an unusually long delay in removing an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) from a device. + * There was an unusually long delay in removing an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) from a device. */ final class AccessCodeDelayInRemovingFromDevice extends \Seam\Resources\Event @@ -1965,7 +1965,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be removed from a device. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) failed to be removed from a device. */ final class AccessCodeFailedToRemoveFromDevice extends \Seam\Resources\Event { @@ -2137,7 +2137,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was modified outside of Seam. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was modified outside of Seam. */ final class AccessCodeModifiedExternalToSeam extends \Seam\Resources\Event { @@ -2225,7 +2225,7 @@ public function __construct( } /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was deleted outside of Seam. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was deleted outside of Seam. */ final class AccessCodeDeletedExternalToSeam extends \Seam\Resources\Event { @@ -2313,7 +2313,7 @@ public function __construct( } /** - * A [backup access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. + * A [backup access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. */ final class AccessCodeBackupAccessCodePulled extends \Seam\Resources\Event { @@ -2406,7 +2406,7 @@ public function __construct( } /** - * An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. + * An [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. */ final class AccessCodeUnmanagedConvertedToManaged extends \Seam\Resources\Event @@ -2495,7 +2495,7 @@ public function __construct( } /** - * An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. + * An [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. */ final class AccessCodeUnmanagedFailedToConvertToManaged extends \Seam\Resources\Event @@ -2668,7 +2668,7 @@ public function __construct( } /** - * An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. + * An [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. */ final class AccessCodeUnmanagedCreated extends \Seam\Resources\Event { @@ -2756,7 +2756,7 @@ public function __construct( } /** - * An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. + * An [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. */ final class AccessCodeUnmanagedRemoved extends \Seam\Resources\Event { @@ -3059,7 +3059,7 @@ public function __construct( */ public string|null $access_grant_id, /** - * ID of the affected [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public string|null $acs_entrance_id, /** @@ -3127,7 +3127,7 @@ public function __construct( */ public string|null $access_grant_id, /** - * ID of the affected [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ public string|null $acs_entrance_id, /** @@ -3952,7 +3952,7 @@ public function __construct( } /** - * An [access system](https://docs.seam.co/low-level-apis/access-systems) was connected. + * An [access system](https://www.seam.co/docs/low-level-apis/access-systems) was connected. */ final class AcsSystemConnected extends \Seam\Resources\Event { @@ -4019,7 +4019,7 @@ public function __construct( } /** - * An [access system](https://docs.seam.co/low-level-apis/access-systems) was added. + * An [access system](https://www.seam.co/docs/low-level-apis/access-systems) was added. */ final class AcsSystemAdded extends \Seam\Resources\Event { @@ -4086,7 +4086,7 @@ public function __construct( } /** - * An [access system](https://docs.seam.co/low-level-apis/access-systems) was disconnected. + * An [access system](https://www.seam.co/docs/low-level-apis/access-systems) was disconnected. */ final class AcsSystemDisconnected extends \Seam\Resources\Event { @@ -4210,7 +4210,7 @@ public function __construct( } /** - * An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was deleted. + * An [access system credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was deleted. */ final class AcsCredentialDeleted extends \Seam\Resources\Event { @@ -4282,7 +4282,7 @@ public function __construct( } /** - * An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was issued. + * An [access system credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was issued. */ final class AcsCredentialIssued extends \Seam\Resources\Event { @@ -4354,7 +4354,7 @@ public function __construct( } /** - * An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was reissued. + * An [access system credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was reissued. */ final class AcsCredentialReissued extends \Seam\Resources\Event { @@ -4427,7 +4427,7 @@ public function __construct( } /** - * An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore. + * An [access system credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore. */ final class AcsCredentialInvalidated extends \Seam\Resources\Event { @@ -4500,7 +4500,7 @@ public function __construct( } /** - * An [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. + * An [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created. */ final class AcsUserCreated extends \Seam\Resources\Event { @@ -4572,7 +4572,7 @@ public function __construct( } /** - * An [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted. + * An [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted. */ final class AcsUserDeleted extends \Seam\Resources\Event { @@ -4644,7 +4644,7 @@ public function __construct( } /** - * An [access system encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was added. + * An [access system encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was added. */ final class AcsEncoderAdded extends \Seam\Resources\Event { @@ -4716,7 +4716,7 @@ public function __construct( } /** - * An [access system encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was removed. + * An [access system encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was removed. */ final class AcsEncoderRemoved extends \Seam\Resources\Event { @@ -4861,7 +4861,7 @@ public function __construct( } /** - * An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added. + * An [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was added. */ final class AcsEntranceAdded extends \Seam\Resources\Event { @@ -4933,7 +4933,7 @@ public function __construct( } /** - * An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed. + * An [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed. */ final class AcsEntranceRemoved extends \Seam\Resources\Event { @@ -6704,7 +6704,7 @@ public function __construct( } /** - * A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * A managed device was successfully converted to an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). */ final class DeviceConvertedToUnmanaged extends \Seam\Resources\Event { @@ -6792,7 +6792,7 @@ public function __construct( } /** - * An [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device. + * An [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device. */ final class DeviceUnmanagedConvertedToManaged extends \Seam\Resources\Event { @@ -6880,7 +6880,7 @@ public function __construct( } /** - * The status of an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. + * The status of an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. */ final class DeviceUnmanagedConnected extends \Seam\Resources\Event { @@ -7118,7 +7118,7 @@ public function __construct( } /** - * The status of an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`. + * The status of an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`. */ final class DeviceUnmanagedDisconnected extends \Seam\Resources\Event { @@ -7918,7 +7918,7 @@ public function __construct( } /** - * A [Salto device](https://docs.seam.co/device-and-system-integration-guides/salto-locks) activated privacy mode. + * A [Salto device](https://www.seam.co/docs/device-and-system-integration-guides/salto-locks) activated privacy mode. */ final class DeviceSaltoPrivacyModeActivated extends \Seam\Resources\Event { @@ -8006,7 +8006,7 @@ public function __construct( } /** - * A [Salto device](https://docs.seam.co/device-and-system-integration-guides/salto-locks) deactivated privacy mode. + * A [Salto device](https://www.seam.co/docs/device-and-system-integration-guides/salto-locks) deactivated privacy mode. */ final class DeviceSaltoPrivacyModeDeactivated extends \Seam\Resources\Event { @@ -8791,7 +8791,7 @@ public function __construct( } /** - * Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/capability-guides/noise-sensors#what-is-a-threshold) were detected. + * Extended periods of noise or noise exceeding a [threshold](https://www.seam.co/docs/capability-guides/noise-sensors#what-is-a-threshold) were detected. */ final class NoiseSensorNoiseThresholdTriggered extends \Seam\Resources\Event { @@ -8913,7 +8913,7 @@ public function __construct( } /** - * A [lock](https://docs.seam.co/low-level-apis/smart-locks) was locked. + * A [lock](https://www.seam.co/docs/low-level-apis/smart-locks) was locked. */ final class LockLocked extends \Seam\Resources\Event { @@ -9037,7 +9037,7 @@ public function __construct( } /** - * A [lock](https://docs.seam.co/low-level-apis/smart-locks) was unlocked. + * A [lock](https://www.seam.co/docs/low-level-apis/smart-locks) was unlocked. */ final class LockUnlocked extends \Seam\Resources\Event { @@ -9087,7 +9087,7 @@ public function __construct( */ string|null $event_type, /** - * Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. + * Method by which the lock was unlocked. `keycode`: an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. * * @var value-of<\Seam\Resources\Event\LockUnlocked\Method>|string|null */ @@ -9161,7 +9161,7 @@ public function __construct( } /** - * The [lock](https://docs.seam.co/low-level-apis/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device. + * The [lock](https://www.seam.co/docs/low-level-apis/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device. */ final class LockAccessDenied extends \Seam\Resources\Event { @@ -9262,7 +9262,7 @@ public function __construct( } /** - * A thermostat [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) was activated. + * A thermostat [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) was activated. */ final class ThermostatClimatePresetActivated extends \Seam\Resources\Event { @@ -9366,7 +9366,7 @@ public function __construct( } /** - * A [thermostat](https://docs.seam.co/capability-guides/thermostats) was adjusted manually. + * A [thermostat](https://www.seam.co/docs/capability-guides/thermostats) was adjusted manually. */ final class ThermostatManuallyAdjusted extends \Seam\Resources\Event { @@ -9445,11 +9445,11 @@ public function __construct( */ public array|\stdClass|null $connected_account_custom_metadata = null, /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_celsius = null, /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $cooling_set_point_fahrenheit = null, /** @@ -9467,21 +9467,21 @@ public function __construct( */ string|null $event_description = null, /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. * * @var value-of<\Seam\Resources\Event\ThermostatManuallyAdjusted\FanModeSetting>|string|null */ public string|null $fan_mode_setting = null, /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_celsius = null, /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ public float|null $heating_set_point_fahrenheit = null, /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. * * @var value-of<\Seam\Resources\Event\ThermostatManuallyAdjusted\HvacModeSetting>|string|null */ @@ -9499,7 +9499,7 @@ public function __construct( } /** - * A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). + * A [thermostat's](https://www.seam.co/docs/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). */ final class ThermostatTemperatureThresholdExceeded extends \Seam\Resources\Event @@ -9618,7 +9618,7 @@ public function __construct( } /** - * A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). + * A [thermostat's](https://www.seam.co/docs/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). */ final class ThermostatTemperatureThresholdNoLongerExceeded extends \Seam\Resources\Event @@ -9737,7 +9737,7 @@ public function __construct( } /** - * A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * A [thermostat's](https://www.seam.co/docs/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ final class ThermostatTemperatureReachedSetPoint extends \Seam\Resources\Event @@ -9848,7 +9848,7 @@ public function __construct( } /** - * A [thermostat's](https://docs.seam.co/capability-guides/thermostats) reported temperature changed by at least 1 °C. + * A [thermostat's](https://www.seam.co/docs/capability-guides/thermostats) reported temperature changed by at least 1 °C. */ final class ThermostatTemperatureChanged extends \Seam\Resources\Event { diff --git a/src/Resources/NoiseThreshold.php b/src/Resources/NoiseThreshold.php index 94f75866..108c6976 100644 --- a/src/Resources/NoiseThreshold.php +++ b/src/Resources/NoiseThreshold.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. + * Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */ class NoiseThreshold { @@ -49,7 +49,7 @@ public function __construct( */ public string|null $starts_daily_at, /** - * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). + * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors). */ public float|null $noise_threshold_nrs = null, ) {} diff --git a/src/Resources/Phone.php b/src/Resources/Phone.php index 1573cb51..16e5033e 100644 --- a/src/Resources/Phone.php +++ b/src/Resources/Phone.php @@ -41,7 +41,7 @@ public function __construct( */ public string|null $created_at, /** - * Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. + * Optional [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. * * @var array|\stdClass|null */ diff --git a/src/Resources/ThermostatDailyProgram.php b/src/Resources/ThermostatDailyProgram.php index e19bb791..93ae45cd 100644 --- a/src/Resources/ThermostatDailyProgram.php +++ b/src/Resources/ThermostatDailyProgram.php @@ -80,7 +80,7 @@ public static function from_json(mixed $json): Periods|null public function __construct( /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ public string|null $climate_preset_key, /** diff --git a/src/Resources/ThermostatSchedule.php b/src/Resources/ThermostatSchedule.php index 225123db..5f65f61f 100644 --- a/src/Resources/ThermostatSchedule.php +++ b/src/Resources/ThermostatSchedule.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. + * Represents a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */ class ThermostatSchedule { @@ -36,37 +36,37 @@ public static function from_json(mixed $json): ThermostatSchedule|null public function __construct( /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $climate_preset_key, /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ public string|null $created_at, /** - * ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. + * ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device. */ public string|null $device_id, /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $ends_at, /** - * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * * @var list<\Seam\Resources\ThermostatSchedule\Errors> */ public array $errors, /** - * User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $name, /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ public string|null $starts_at, /** - * ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ public string|null $thermostat_schedule_id, /** @@ -74,11 +74,11 @@ public function __construct( */ public string|null $workspace_id, /** - * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. + * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */ public bool|null $is_override_allowed = null, /** - * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ public int|null $max_override_period_minutes = null, ) {} @@ -87,7 +87,7 @@ public function __construct( namespace Seam\Resources\ThermostatSchedule { /** - * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ class Errors { diff --git a/src/Resources/UnmanagedAccessCode.php b/src/Resources/UnmanagedAccessCode.php index 4ac1b504..f2252eaf 100644 --- a/src/Resources/UnmanagedAccessCode.php +++ b/src/Resources/UnmanagedAccessCode.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. * @@ -12,7 +12,7 @@ * * Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes: * - * - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks) + * - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks) */ class UnmanagedAccessCode { @@ -85,7 +85,7 @@ public function __construct( */ public string|null $display_status, /** - * Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * @var list<\Seam\Resources\UnmanagedAccessCode\Errors> */ @@ -112,7 +112,7 @@ public function __construct( */ public string|null $type, /** - * Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * @var list<\Seam\Resources\UnmanagedAccessCode\Warnings> */ @@ -206,7 +206,7 @@ public function __construct( } /** - * Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -262,8 +262,8 @@ public static function from_json(mixed $json): Errors|null => \Seam\Resources\UnmanagedAccessCode\Errors\FailedToUpdate::from_json( $json, ), - \Seam\Resources\UnmanagedAccessCode\Errors\ErrorCode::FAILED_TO_EXPIRE - => \Seam\Resources\UnmanagedAccessCode\Errors\FailedToExpire::from_json( + \Seam\Resources\UnmanagedAccessCode\Errors\ErrorCode::FAILED_TO_REMOVE + => \Seam\Resources\UnmanagedAccessCode\Errors\FailedToRemove::from_json( $json, ), \Seam\Resources\UnmanagedAccessCode\Errors\ErrorCode::ACCOUNT_DISCONNECTED @@ -344,7 +344,7 @@ public function __construct( } /** - * Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -916,10 +916,10 @@ public function __construct( /** * This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active. */ - final class FailedToExpire extends + final class FailedToRemove extends \Seam\Resources\UnmanagedAccessCode\Errors { - public static function from_json(mixed $json): FailedToExpire|null + public static function from_json(mixed $json): FailedToRemove|null { if (!$json) { return null; @@ -989,7 +989,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1039,7 +1039,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1089,7 +1089,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1139,7 +1139,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1326,7 +1326,7 @@ public function __construct( } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ final class EmptyBackupAccessCodePool extends \Seam\Resources\UnmanagedAccessCode\Errors @@ -1544,7 +1544,7 @@ public function __construct( } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class BridgeDisconnected extends \Seam\Resources\UnmanagedAccessCode\Errors @@ -1580,7 +1580,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ public bool|null $is_bridge_error = null, /** @@ -1604,7 +1604,7 @@ enum ErrorCode: string case CODE_CONSTRAINTS_VIOLATED = "code_constraints_violated"; case FAILED_TO_ISSUE = "failed_to_issue"; case FAILED_TO_UPDATE = "failed_to_update"; - case FAILED_TO_EXPIRE = "failed_to_expire"; + case FAILED_TO_REMOVE = "failed_to_remove"; case ACCOUNT_DISCONNECTED = "account_disconnected"; case SALTO_KS_SUBSCRIPTION_LIMIT_EXCEEDED = "salto_ks_subscription_limit_exceeded"; case INSUFFICIENT_PERMISSIONS = "insufficient_permissions"; diff --git a/src/Resources/UnmanagedAccessGrant.php b/src/Resources/UnmanagedAccessGrant.php index dd1d7703..03ecfcea 100644 --- a/src/Resources/UnmanagedAccessGrant.php +++ b/src/Resources/UnmanagedAccessGrant.php @@ -83,7 +83,7 @@ public function __construct( */ public string|null $ends_at, /** - * Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). * * @var list<\Seam\Resources\UnmanagedAccessGrant\Errors> */ @@ -120,7 +120,7 @@ public function __construct( */ public string|null $starts_at, /** - * Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). * * @var list<\Seam\Resources\UnmanagedAccessGrant\Warnings> */ @@ -143,7 +143,7 @@ public function __construct( namespace Seam\Resources\UnmanagedAccessGrant { /** - * Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -303,7 +303,7 @@ public function __construct( } /** - * Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -692,7 +692,7 @@ enum Mode: string namespace Seam\Resources\UnmanagedAccessGrant\Warnings { /** - * Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. + * Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted. */ final class BeingDeleted extends \Seam\Resources\UnmanagedAccessGrant\Warnings @@ -834,7 +834,7 @@ public function __construct( } /** - * Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. + * Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated. */ final class UpdatingAccessTimes extends \Seam\Resources\UnmanagedAccessGrant\Warnings diff --git a/src/Resources/UnmanagedAccessMethod.php b/src/Resources/UnmanagedAccessMethod.php index 948a97cb..91e4ab13 100644 --- a/src/Resources/UnmanagedAccessMethod.php +++ b/src/Resources/UnmanagedAccessMethod.php @@ -71,7 +71,7 @@ public function __construct( */ public string|null $display_status, /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). * * @var list<\Seam\Resources\UnmanagedAccessMethod\Errors> */ @@ -91,13 +91,13 @@ public function __construct( */ public string|null $mode, /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. * * @var list<\Seam\Resources\UnmanagedAccessMethod\PendingMutations> */ public array $pending_mutations, /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). * * @var list<\Seam\Resources\UnmanagedAccessMethod\Warnings> */ @@ -132,7 +132,7 @@ public function __construct( namespace Seam\Resources\UnmanagedAccessMethod { /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Known error_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Errors { @@ -179,7 +179,7 @@ public function __construct( } /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. Known mutation_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. Known mutation_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class PendingMutations { @@ -234,7 +234,7 @@ public function __construct( } /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Known warning_code values use subclasses; unknown values use this base class and retain their raw discriminator. */ class Warnings { @@ -311,7 +311,7 @@ enum Mode: string namespace Seam\Resources\UnmanagedAccessMethod\Errors { /** - * Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued. + * Indicates that Seam was unable to issue this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued. */ final class FailedToIssue extends \Seam\Resources\UnmanagedAccessMethod\Errors @@ -703,7 +703,7 @@ public function __construct( namespace Seam\Resources\UnmanagedAccessMethod\Warnings { /** - * Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. + * Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted. */ final class BeingDeleted extends \Seam\Resources\UnmanagedAccessMethod\Warnings @@ -745,7 +745,7 @@ public function __construct( } /** - * Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. + * Indicates that the access times for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) are being updated. */ final class UpdatingAccessTimes extends \Seam\Resources\UnmanagedAccessMethod\Warnings @@ -836,7 +836,7 @@ public function __construct( } /** - * Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds. + * Indicates that Seam has not yet issued this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds. */ final class DelayInIssuing extends \Seam\Resources\UnmanagedAccessMethod\Warnings @@ -878,7 +878,7 @@ public function __construct( } /** - * Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant. + * Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant. */ final class UserIdentityMissingEmailAddress extends \Seam\Resources\UnmanagedAccessMethod\Warnings @@ -921,7 +921,7 @@ public function __construct( } /** - * Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant. + * Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant. */ final class UserIdentityMissingPhoneNumber extends \Seam\Resources\UnmanagedAccessMethod\Warnings diff --git a/src/Resources/UnmanagedDevice.php b/src/Resources/UnmanagedDevice.php index a04b784e..e1f0f38b 100644 --- a/src/Resources/UnmanagedDevice.php +++ b/src/Resources/UnmanagedDevice.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents an [unmanaged device](https://docs.seam.co/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/low-level-apis/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/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * Represents an [unmanaged device](https://www.seam.co/docs/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://www.seam.co/docs/low-level-apis/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://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ class UnmanagedDevice { @@ -80,7 +80,7 @@ public static function from_json(mixed $json): UnmanagedDevice|null public function __construct( /** - * 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags). + * 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags). * * @var list|null */ @@ -94,7 +94,7 @@ public function __construct( */ public string|null $created_at, /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. * * @var array|\stdClass|null */ @@ -696,7 +696,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -750,7 +750,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -804,7 +804,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -858,7 +858,7 @@ public function __construct( */ string|null $error_code, /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ public true|null $is_connected_account_error, /** @@ -1064,7 +1064,7 @@ public function __construct( } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ final class EmptyBackupAccessCodePool extends \Seam\Resources\UnmanagedDevice\Errors @@ -1302,7 +1302,7 @@ public function __construct( } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected). */ final class BridgeDisconnected extends \Seam\Resources\UnmanagedDevice\Errors @@ -1338,7 +1338,7 @@ public function __construct( */ string|null $message, /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ public bool|null $is_bridge_error = null, /** diff --git a/src/Resources/UserIdentity.php b/src/Resources/UserIdentity.php index 9cda66e0..d836acad 100644 --- a/src/Resources/UserIdentity.php +++ b/src/Resources/UserIdentity.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. + * Represents a [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */ class UserIdentity { diff --git a/src/Resources/Webhook.php b/src/Resources/Webhook.php index e1f4f04a..cd93c7bf 100644 --- a/src/Resources/Webhook.php +++ b/src/Resources/Webhook.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. + * Represents a [webhook](https://www.seam.co/docs/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. */ class Webhook { @@ -21,7 +21,7 @@ public static function from_json(mixed $json): Webhook|null public function __construct( /** - * URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). + * URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ public string|null $url, /** @@ -29,13 +29,13 @@ public function __construct( */ public string|null $webhook_id, /** - * Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive. + * Types of events that the [webhook](https://www.seam.co/docs/developer-tools/webhooks) should receive. * * @var list|null */ public array|null $event_types = null, /** - * Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks). + * Secret associated with the [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ public string|null $secret = null, ) {} diff --git a/src/Resources/Workspace.php b/src/Resources/Workspace.php index 49390158..bd66af9c 100644 --- a/src/Resources/Workspace.php +++ b/src/Resources/Workspace.php @@ -2,7 +2,7 @@ namespace Seam\Resources { /** - * Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). + * Represents a Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://www.seam.co/docs/core-concepts/workspaces#production-workspaces). */ class Workspace { @@ -34,13 +34,13 @@ public static function from_json(mixed $json): Workspace|null public function __construct( /** - * Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). + * Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces). * * @deprecated Use `connect_partner_name` instead. */ public string|null $company_name, /** - * Seam Connect partner name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). + * Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ public string|null $connect_partner_name, public \Seam\Resources\Workspace\ConnectWebviewCustomization|null $connect_webview_customization, @@ -49,15 +49,15 @@ public function __construct( */ public bool|null $is_publishable_key_auth_enabled, /** - * Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Indicates whether the workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ public bool|null $is_sandbox, /** - * Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. + * Indicates whether the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */ public bool|null $is_suspended, /** - * Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). + * Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ public string|null $name, /** @@ -69,7 +69,7 @@ public function __construct( */ public string|null $workspace_id, /** - * Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. + * Publishable key for the [workspace](https://www.seam.co/docs/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. */ public string|null $publishable_key = null, ) {} @@ -97,25 +97,25 @@ public static function from_json( public function __construct( /** - * URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * URL of the inviter logo for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ public string|null $inviter_logo_url = null, /** - * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). * * @var value-of<\Seam\Resources\Workspace\ConnectWebviewCustomization\LogoShape>|string|null */ public string|null $logo_shape = null, /** - * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ public string|null $primary_button_color = null, /** - * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ public string|null $primary_button_text_color = null, /** - * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ public string|null $success_message = null, ) {} diff --git a/src/Routes/AccessCodesClient.php b/src/Routes/AccessCodesClient.php index 23007b64..f5b3c062 100644 --- a/src/Routes/AccessCodesClient.php +++ b/src/Routes/AccessCodesClient.php @@ -29,18 +29,18 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [access code](https://docs.seam.co/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value. + * Creates a new [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value. * * @param string $device_id ID of the device for which you want to create the new access code. - * @param bool $allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * @param bool $allow_external_modification Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. * @param bool $attempt_for_offline_device * @param string $code Code to be used for access. - * @param string $common_code_key Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes). + * @param string $common_code_key Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes). * @param string $ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - * @param bool $is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. - * @param bool $is_offline_access_code Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes). - * @param bool $is_one_time_use Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. - * @param string $max_time_rounding Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. + * @param bool $is_external_modification_allowed Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * @param bool $is_offline_access_code Indicates whether the access code is an [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes). + * @param bool $is_one_time_use Indicates whether the [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. + * @param string $max_time_rounding Maximum rounding adjustment. To create a daily-bound [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. * @param string $name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. @@ -48,10 +48,10 @@ public function __construct(ClientInterface $client, array $defaults) To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). - * @param bool $prefer_native_scheduling Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. + * @param bool $prefer_native_scheduling Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. * @param float $preferred_code_length Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. * @param string $starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - * @param bool $use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/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/api/access_codes/pull_backup_access_code). + * @param bool $use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code). * @param bool $use_offline_access_code * @return AccessCode OK */ @@ -148,7 +148,7 @@ public function create( } /** - * Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. + * Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. * * Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock. * @@ -156,17 +156,17 @@ public function create( * * If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`. * - * See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes). + * See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes). * - * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. + * For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. * * @param list $device_ids IDs of the devices for which you want to create the new access codes. - * @param bool $allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * @param bool $allow_external_modification Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. * @param bool $attempt_for_offline_device * @param string $behavior_when_code_cannot_be_shared Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. * @param string $code Code to be used for access. * @param string $ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - * @param bool $is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * @param bool $is_external_modification_allowed Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. * @param string $name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. @@ -174,10 +174,10 @@ public function create( To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). - * @param bool $prefer_native_scheduling Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. + * @param bool $prefer_native_scheduling Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. * @param float $preferred_code_length Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length. * @param string $starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - * @param bool $use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/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/api/access_codes/pull_backup_access_code). + * @param bool $use_backup_access_code_pool Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code). * @return array OK */ public function create_multiple( @@ -260,7 +260,7 @@ public function create_multiple( } /** - * Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * @param string $access_code_id ID of the access code that you want to delete. * @param string $device_id ID of the device for which you want to delete the access code. @@ -283,7 +283,7 @@ public function delete( } /** - * Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID. + * Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID. * * @param string $device_id ID of the device for which you want to generate a code. * @return AccessCode OK @@ -306,7 +306,7 @@ public function generate_code(string $device_id): AccessCode } /** - * Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * You must specify either `access_code_id` or both `device_id` and `code`. * @@ -349,7 +349,7 @@ public function get( } /** - * Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. * @@ -443,7 +443,7 @@ public function list( } /** - * Retrieves a backup access code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). + * Retrieves a backup access code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes). * * A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access. * @@ -519,17 +519,17 @@ public function report_device_constraints( } /** - * Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * - * See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes). + * See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes). * * @param string $access_code_id ID of the access code that you want to update. - * @param bool $allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * @param bool $allow_external_modification Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. * @param bool $attempt_for_offline_device * @param string $code Code to be used for access. * @param string $device_id ID of the device containing the access code that you want to update. * @param string $ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - * @param bool $is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * @param bool $is_external_modification_allowed Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. * @param bool $is_managed Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. * @param string $name Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. @@ -539,7 +539,7 @@ public function report_device_constraints( To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). * @param string $starts_at Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - * @param string $type Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). + * @param string $type Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). * @return void OK */ public function update( @@ -601,11 +601,11 @@ public function update( } /** - * Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. + * Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. * * Specify the `common_code_key` to identify the set of access codes that you want to update. * - * See also [Update Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes). + * See also [Update Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes). * * @param string $common_code_key Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. * @param string $ends_at Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. diff --git a/src/Routes/AccessCodesSimulateClient.php b/src/Routes/AccessCodesSimulateClient.php index a94074c3..377f4f0f 100644 --- a/src/Routes/AccessCodesSimulateClient.php +++ b/src/Routes/AccessCodesSimulateClient.php @@ -25,7 +25,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates the creation of an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the creation of an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $code Code of the simulated unmanaged access code. * @param string $device_id ID of the device for which you want to simulate the creation of an unmanaged access code. diff --git a/src/Routes/AccessCodesUnmanagedClient.php b/src/Routes/AccessCodesUnmanagedClient.php index 4c0739fc..e3f02587 100644 --- a/src/Routes/AccessCodesUnmanagedClient.php +++ b/src/Routes/AccessCodesUnmanagedClient.php @@ -26,16 +26,16 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Converts an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Converts an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it. * * Note that not all device providers support converting an unmanaged access code to a managed access code. * * @param string $access_code_id ID of the unmanaged access code that you want to convert to a managed access code. - * @param bool $allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. + * @param bool $allow_external_modification Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. * @param bool $force Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. - * @param bool $is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. + * @param bool $is_external_modification_allowed Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. * @return void OK */ public function convert_to_managed( @@ -69,7 +69,7 @@ public function convert_to_managed( } /** - * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * @param string $access_code_id ID of the unmanaged access code that you want to delete. * @return void OK @@ -86,7 +86,7 @@ public function delete(string $access_code_id): void } /** - * Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * You must specify either `access_code_id` or both `device_id` and `code`. * @@ -129,7 +129,7 @@ public function get( } /** - * Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * @param string $device_id ID of the device for which you want to list unmanaged access codes. * @param float $limit Numerical limit on the number of unmanaged access codes to return. @@ -184,13 +184,13 @@ public function list( } /** - * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * @param string $access_code_id ID of the unmanaged access code that you want to update. * @param bool $is_managed - * @param bool $allow_external_modification Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. + * @param bool $allow_external_modification Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. * @param bool $force Indicates whether to force the unmanaged access code update. - * @param bool $is_external_modification_allowed Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. + * @param bool $is_external_modification_allowed Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. * @return void OK */ public function update( diff --git a/src/Routes/AccessGrantsClient.php b/src/Routes/AccessGrantsClient.php index a2f35af9..ab8dc4aa 100644 --- a/src/Routes/AccessGrantsClient.php +++ b/src/Routes/AccessGrantsClient.php @@ -28,13 +28,13 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request. + * Creates a new [Access Grant](https://www.seam.co/docs/use-cases/granting-access). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request. * * @param list|\stdClass> $requested_access_methods * @param string $access_grant_key Unique key for the access grant within the workspace. - * @param list $acs_entrance_ids Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted. + * @param list $acs_entrance_ids Set of IDs of the [entrances](https://www.seam.co/docs/api/acs/systems/list) to which access is being granted. * @param string $customization_profile_id ID of the customization profile to apply to the Access Grant and its access methods. - * @param list $device_ids Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted. + * @param list $device_ids Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted. * @param string|NullValue $ends_at Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. * @param mixed $location * @param list $location_ids diff --git a/src/Routes/AccessMethodsClient.php b/src/Routes/AccessMethodsClient.php index de472eaf..a97f885d 100644 --- a/src/Routes/AccessMethodsClient.php +++ b/src/Routes/AccessMethodsClient.php @@ -107,7 +107,7 @@ public function delete( } /** - * Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Encodes an existing access method onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). * * @param string $access_method_id ID of the `access_method` to encode onto a card. * @param string $acs_encoder_id ID of the `acs_encoder` to use to encode the `access_method`. @@ -278,7 +278,7 @@ public function list( } /** - * Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation. + * Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation. * * @param string $access_method_id ID of the cloud_key `access_method` to use for the unlock operation. * @param string $acs_entrance_id ID of the entrance to unlock. diff --git a/src/Routes/AcsAccessGroupsClient.php b/src/Routes/AcsAccessGroupsClient.php index d52d009a..1404b753 100644 --- a/src/Routes/AcsAccessGroupsClient.php +++ b/src/Routes/AcsAccessGroupsClient.php @@ -27,7 +27,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group to which you want to add an access system user. * @param string $acs_user_id ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. @@ -55,7 +55,7 @@ public function add_user( } /** - * Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group that you want to delete. * @return void OK @@ -72,7 +72,7 @@ public function delete(string $acs_access_group_id): void } /** - * Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group that you want to get. * @return AcsAccessGroup OK @@ -95,7 +95,7 @@ public function get(string $acs_access_group_id): AcsAccessGroup } /** - * Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_system_id ID of the access system for which you want to retrieve all access groups. * @param string $acs_user_id ID of the access system user for which you want to retrieve all access groups. @@ -141,7 +141,7 @@ public function list( } /** - * Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a list of all accessible entrances for a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group for which you want to retrieve all accessible entrances. * @return array OK @@ -172,7 +172,7 @@ public function list_accessible_entrances( } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group for which you want to retrieve all access system users. * @return array OK @@ -196,7 +196,7 @@ public function list_users(string $acs_access_group_id): array } /** - * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group from which you want to remove an access system user. * @param string $acs_user_id ID of the access system user that you want to remove from an access group. diff --git a/src/Routes/AcsCredentialsClient.php b/src/Routes/AcsCredentialsClient.php index fb53a62d..5e572d85 100644 --- a/src/Routes/AcsCredentialsClient.php +++ b/src/Routes/AcsCredentialsClient.php @@ -27,7 +27,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Assigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param string $acs_credential_id ID of the credential that you want to assign to an access system user. * @param string $acs_user_id ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. @@ -55,17 +55,17 @@ public function assign( } /** - * Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential. + * Creates a new [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential. * * @param string $access_method Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. * @param string $acs_system_id ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. * @param string $acs_user_id ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. - * @param list $allowed_acs_entrance_ids Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access. + * @param list $allowed_acs_entrance_ids Set of IDs of the [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access. * @param mixed $assa_abloy_vostio_metadata Vostio-specific metadata for the new credential. - * @param string $code 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/device-and-system-integration-guides). + * @param string $code 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://www.seam.co/docs/device-and-system-integration-guides). * @param string $credential_manager_acs_system_id ACS system ID of the credential manager for the new credential. * @param string $ends_at Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - * @param bool $is_multi_phone_sync_credential Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + * @param bool $is_multi_phone_sync_credential Indicates whether the new credential is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). * @param mixed $salto_space_metadata Salto Space-specific metadata for the new credential. * @param string $starts_at Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. * @param string $user_identity_id ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. @@ -147,7 +147,7 @@ public function create( } /** - * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @param string $acs_credential_id ID of the credential that you want to delete. * @return void OK @@ -164,7 +164,7 @@ public function delete(string $acs_credential_id): void } /** - * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @param string $acs_credential_id ID of the credential that you want to get. * @return AcsCredential OK @@ -187,7 +187,7 @@ public function get(string $acs_credential_id): AcsCredential } /** - * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @param string $acs_system_id ID of the access system for which you want to retrieve all credentials. * @param string $acs_user_id ID of the access system user for which you want to retrieve all credentials. @@ -257,7 +257,7 @@ public function list( } /** - * Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access. + * Returns a list of all [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a [credential](https://www.seam.co/docs/api/acs/credentials/object) grants access. * * @param string $acs_credential_id ID of the credential for which you want to retrieve all entrances to which the credential grants access. * @return array OK @@ -287,7 +287,7 @@ public function list_accessible_entrances(string $acs_credential_id): array } /** - * Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Unassigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param string $acs_credential_id ID of the credential that you want to unassign from an access system user. * @param string $acs_user_id ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. @@ -315,7 +315,7 @@ public function unassign( } /** - * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Updates the code and ends at date and time for a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @param string $acs_credential_id ID of the credential that you want to update. * @param string $code Replacement access (PIN) code for the credential that you want to update. diff --git a/src/Routes/AcsEncodersClient.php b/src/Routes/AcsEncodersClient.php index 48bd8e42..98a8df21 100644 --- a/src/Routes/AcsEncodersClient.php +++ b/src/Routes/AcsEncodersClient.php @@ -29,7 +29,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id` + * Encodes an existing [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id` * * @param string $acs_encoder_id ID of the `acs_encoder` to use to encode the `acs_credential`. * @param string $access_method_id ID of the `access_method` to encode onto a card. @@ -74,7 +74,7 @@ public function encode_credential( } /** - * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). * * @param string $acs_encoder_id ID of the encoder that you want to get. * @return AcsEncoder OK @@ -97,7 +97,7 @@ public function get(string $acs_encoder_id): AcsEncoder } /** - * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). * * @param list $acs_encoder_ids IDs of the encoders that you want to retrieve. * @param string $acs_system_id ID of the access system for which you want to retrieve all encoders. @@ -150,7 +150,7 @@ public function list( } /** - * Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Scans an encoded [acs_credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). * * @param string $acs_encoder_id ID of the encoder to use for the scan. * @param mixed $salto_ks_metadata Salto KS-specific metadata for the scan action. @@ -190,7 +190,7 @@ public function scan_credential( } /** - * Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`. + * Scans a physical card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`. * * @param string $acs_encoder_id ID of the `acs_encoder` to use to scan the credential. * @param string $acs_user_id ID of the `acs_user` to assign the scanned credential to. diff --git a/src/Routes/AcsEncodersSimulateClient.php b/src/Routes/AcsEncodersSimulateClient.php index 7afc7c84..afac2fdc 100644 --- a/src/Routes/AcsEncodersSimulateClient.php +++ b/src/Routes/AcsEncodersSimulateClient.php @@ -23,7 +23,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $acs_encoder_id ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. * @param string $acs_credential_id ID of the `acs_credential` that will fail to be encoded onto a card in the next request. @@ -53,7 +53,7 @@ public function next_credential_encode_will_fail( } /** - * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $acs_encoder_id ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. * @param string $scenario Scenario to simulate. @@ -78,7 +78,7 @@ public function next_credential_encode_will_succeed( } /** - * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $acs_encoder_id ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. * @param string $acs_credential_id_on_seam @@ -110,7 +110,7 @@ public function next_credential_scan_will_fail( } /** - * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $acs_encoder_id ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. * @param string $acs_credential_id_on_seam ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. diff --git a/src/Routes/AcsEntrancesClient.php b/src/Routes/AcsEntrancesClient.php index 85cc23fe..3bfb4d4a 100644 --- a/src/Routes/AcsEntrancesClient.php +++ b/src/Routes/AcsEntrancesClient.php @@ -29,7 +29,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). * * @param string $acs_entrance_id ID of the entrance that you want to get. * @return AcsEntrance OK @@ -52,7 +52,7 @@ public function get(string $acs_entrance_id): AcsEntrance } /** - * Grants a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Grants a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). * * @param string $acs_entrance_id ID of the entrance to which you want to grant an access system user access. * @param string $acs_user_id ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. @@ -80,7 +80,7 @@ public function grant_access( } /** - * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). * * @param string $access_method_id ID of the access method for which you want to retrieve all entrances to which it grants access. * @param string $acs_credential_id ID of the credential for which you want to retrieve all entrances. @@ -163,7 +163,7 @@ public function list( } /** - * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). * * @param string $acs_entrance_id ID of the entrance for which you want to list all credentials that grant access. * @param list $include_if Conditions that credentials must meet to be included in the returned list. @@ -199,7 +199,7 @@ public function list_credentials_with_access( } /** - * Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation. + * Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation. * * @param string $acs_credential_id ID of the cloud_key credential to use for the unlock operation. * @param string $acs_entrance_id ID of the entrance to unlock. diff --git a/src/Routes/AcsSystemsClient.php b/src/Routes/AcsSystemsClient.php index c6093452..079736be 100644 --- a/src/Routes/AcsSystemsClient.php +++ b/src/Routes/AcsSystemsClient.php @@ -25,7 +25,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems). + * Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * @param string $acs_system_id ID of the access system that you want to get. * @return AcsSystem OK @@ -48,7 +48,7 @@ public function get(string $acs_system_id): AcsSystem } /** - * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems). + * Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems). * * To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace. * @@ -87,7 +87,7 @@ public function list( } /** - * Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/low-level-apis/access-systems). + * Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body. * diff --git a/src/Routes/AcsUsersClient.php b/src/Routes/AcsUsersClient.php index d995fe52..cc9d24ac 100644 --- a/src/Routes/AcsUsersClient.php +++ b/src/Routes/AcsUsersClient.php @@ -27,7 +27,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group to which you want to add an access system user. * @param string $acs_user_id ID of the access system user that you want to add to an access group. @@ -48,15 +48,15 @@ public function add_to_access_group( } /** - * Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param string $acs_system_id ID of the access system to which you want to add the new access system user. * @param string $full_name Full name of the new access system user. * @param mixed $access_schedule `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. * @param list $acs_access_group_ids Array of access group IDs to indicate the access groups to which you want to add the new access system user. * @param string $email - * @param string $email_address Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). - * @param string $phone_number Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * @param string $email_address Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). + * @param string $phone_number Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). * @param string $user_identity_id ID of the user identity with which you want to associate the new access system user. * @return AcsUser OK */ @@ -105,7 +105,7 @@ public function create( } /** - * Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Deletes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). * * @param string $acs_system_id ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id. * @param string $acs_user_id ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id @@ -144,7 +144,7 @@ public function delete( } /** - * Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param string $acs_user_id ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id. * @param string $acs_system_id ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id. @@ -189,7 +189,7 @@ public function get( } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param string $acs_system_id ID of the `acs_system` for which you want to retrieve all access system users. * @param string $created_before Timestamp by which to limit returned access system users. Returns users created before this timestamp. @@ -261,7 +261,7 @@ public function list( } /** - * Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access. + * Lists the [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) has access. * * @param string $acs_system_id ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id. * @param string $acs_user_id ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id. @@ -313,7 +313,7 @@ public function list_accessible_entrances( } /** - * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * * @param string $acs_access_group_id ID of the access group from which you want to remove an access system user. * @param string $acs_user_id ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. @@ -343,7 +343,7 @@ public function remove_from_access_group( } /** - * Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Revokes access to all [entrances](https://www.seam.co/docs/api/acs/entrances/object) for a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param string $acs_system_id ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id. * @param string $acs_user_id ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. @@ -384,7 +384,7 @@ public function revoke_access_to_all_entrances( } /** - * [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them. + * [Suspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://www.seam.co/docs/api/acs/users/unsuspend) them. * * @param string $acs_system_id ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. * @param string $acs_user_id ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. @@ -423,7 +423,7 @@ public function suspend( } /** - * [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. + * [Unsuspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). While [suspending an access system user](https://www.seam.co/docs/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. * * @param string $acs_system_id ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. * @param string $acs_user_id ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. @@ -462,16 +462,16 @@ public function unsuspend( } /** - * Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * * @param mixed $access_schedule `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. * @param string $acs_system_id ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. * @param string $acs_user_id ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. * @param string $email - * @param string $email_address Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). - * @param string $full_name Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * @param string $email_address Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). + * @param string $full_name Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). * @param string $hid_acs_system_id ID of the HID access control system associated with the user. - * @param string $phone_number Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * @param string $phone_number Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). * @param string $user_identity_id ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. * @return void OK */ diff --git a/src/Routes/ActionAttemptsClient.php b/src/Routes/ActionAttemptsClient.php index fe4fa397..59eaceee 100644 --- a/src/Routes/ActionAttemptsClient.php +++ b/src/Routes/ActionAttemptsClient.php @@ -27,7 +27,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts). + * Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts). * * @param string $action_attempt_id ID of the action attempt that you want to get. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. @@ -58,7 +58,7 @@ public function get( } /** - * Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. + * Returns a list of the [action attempts](https://www.seam.co/docs/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. * * @param list $action_attempt_ids IDs of the action attempts that you want to retrieve. * @param string $device_id ID of the device to filter action attempts by. diff --git a/src/Routes/ClientSessionsClient.php b/src/Routes/ClientSessionsClient.php index c0137296..76e01761 100644 --- a/src/Routes/ClientSessionsClient.php +++ b/src/Routes/ClientSessionsClient.php @@ -26,16 +26,16 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * - * @param list $connect_webview_ids IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) for which you want to create a client session. - * @param list $connected_account_ids IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) for which you want to create a client session. + * @param list $connect_webview_ids IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session. + * @param list $connected_account_ids IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) for which you want to create a client session. * @param string $customer_id Customer ID that you want to associate with the new client session. * @param string $customer_key Customer key that you want to associate with the new client session. * @param string $expires_at Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. * @param string $user_identifier_key Your user ID for the user for whom you want to create a client session. - * @param string $user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. - * @param list $user_identity_ids IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * @param string $user_identity_id ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. + * @param list $user_identity_ids IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. * @return ClientSession OK */ public function create( @@ -87,7 +87,7 @@ public function create( } /** - * Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * * @param string $client_session_id ID of the client session that you want to delete. * @return void OK @@ -104,7 +104,7 @@ public function delete(string $client_session_id): void } /** - * Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * * @param string $client_session_id ID of the client session that you want to get. * @param string $user_identifier_key User identifier key associated with the client session that you want to get. @@ -135,14 +135,14 @@ public function get( } /** - * Returns a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. + * Returns a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. * - * @param list $connect_webview_ids IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). - * @param list $connected_account_ids IDs of the [connected accounts](https://docs.seam.co/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). + * @param list $connect_webview_ids IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). + * @param list $connected_account_ids IDs of the [connected accounts](https://www.seam.co/docs/api/connected_accounts/object) that you want to associate with the client session (or that are already associated with the existing client session). * @param string $expires_at Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it. * @param string $user_identifier_key Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). - * @param string $user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). - * @param list $user_identity_ids IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * @param string $user_identity_id ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). + * @param list $user_identity_ids IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. * @return ClientSession OK */ public function get_or_create( @@ -190,14 +190,14 @@ public function get_or_create( } /** - * Grants a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews), [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on. + * Grants a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews), [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on. * * @param string $client_session_id ID of the client session to which you want to grant access to resources. - * @param list $connect_webview_ids IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session. - * @param list $connected_account_ids IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that you want to associate with the client session. + * @param list $connect_webview_ids IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session. + * @param list $connected_account_ids IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that you want to associate with the client session. * @param string $user_identifier_key Your user ID for the user that you want to associate with the client session. - * @param string $user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. - * @param list $user_identity_ids IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * @param string $user_identity_id ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * @param list $user_identity_ids IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. * @return void OK */ public function grant_access( @@ -247,12 +247,12 @@ public function grant_access( } /** - * Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * * @param string $client_session_id ID of the client session that you want to retrieve. - * @param string|NullValue $connect_webview_id ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview. + * @param string|NullValue $connect_webview_id ID of the [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview. * @param string $user_identifier_key Your user ID for the user by which you want to filter client sessions. - * @param string|NullValue $user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity. + * @param string|NullValue $user_identity_id ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity. * @param bool $without_user_identifier_key Indicates whether to retrieve only client sessions without associated user identifier keys. * @return array OK */ @@ -296,9 +296,9 @@ public function list( } /** - * Revokes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * - * Note that [deleting a client session](https://docs.seam.co/api/client_sessions/delete) is a separate action. + * Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action. * * @param string $client_session_id ID of the client session that you want to revoke. * @return void OK diff --git a/src/Routes/ConnectWebviewsClient.php b/src/Routes/ConnectWebviewsClient.php index bc0c128c..79efc56a 100644 --- a/src/Routes/ConnectWebviewsClient.php +++ b/src/Routes/ConnectWebviewsClient.php @@ -26,24 +26,24 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview. * * You should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users. * - * See also: [Connect Webview Process](https://docs.seam.co/core-concepts/connect-webviews/connect-webview-process). + * See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process). * * @param list $accepted_capabilities List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers. - * @param list $accepted_providers Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters. - * @param bool $automatically_manage_new_devices Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). - * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. + * @param list $accepted_providers Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters. + * @param bool $automatically_manage_new_devices Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). + * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. * @param string $custom_redirect_failure_url Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`. * @param string $custom_redirect_url URL that you want to redirect the user to after the provider login is complete. * @param string $customer_key Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. * @param list $excluded_providers List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account. - * @param string $provider_category Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with the desired `provider_category` filter. - * @param bool $wait_for_device_creation Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). + * @param string $provider_category Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter. + * @param bool $wait_for_device_creation Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). * @return ConnectWebview OK */ public function create( @@ -109,7 +109,7 @@ public function create( } /** - * Deletes a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews. * @@ -128,7 +128,7 @@ public function delete(string $connect_webview_id): void } /** - * Returns a specified [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * Unless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected. * @@ -153,9 +153,9 @@ public function get(string $connect_webview_id): ConnectWebview } /** - * Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews). + * Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews). * - * @param array|\stdClass $custom_metadata_has Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. + * @param array|\stdClass $custom_metadata_has Custom metadata pairs by which you want to [filter Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. * @param string $customer_key Customer key for which you want to list connect webviews. * @param float $limit Maximum number of records to return per page. * @param string|NullValue $page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. diff --git a/src/Routes/ConnectedAccountsClient.php b/src/Routes/ConnectedAccountsClient.php index e538ba2f..47031dc3 100644 --- a/src/Routes/ConnectedAccountsClient.php +++ b/src/Routes/ConnectedAccountsClient.php @@ -30,7 +30,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Deletes a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). * * Deleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider. * @@ -51,7 +51,7 @@ public function delete(string $connected_account_id): void } /** - * Returns a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). * * @param string $connected_account_id ID of the connected account that you want to get. * @param string $email Email address associated with the connected account that you want to get. @@ -87,7 +87,7 @@ public function get( } /** - * Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts). + * Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts). * * @param array|\stdClass $custom_metadata_has Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. * @param string $customer_key Customer key by which you want to filter connected accounts. @@ -154,7 +154,7 @@ public function list( } /** - * Request a [connected account](https://docs.seam.co/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. + * Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. * * @param string $connected_account_id ID of the connected account that you want to sync. * @return void OK @@ -171,12 +171,12 @@ public function sync(string $connected_account_id): void } /** - * Updates a [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). * * @param string $connected_account_id ID of the connected account that you want to update. * @param list $accepted_capabilities List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. - * @param bool $automatically_manage_new_devices Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). - * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. + * @param bool $automatically_manage_new_devices Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). + * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://www.seam.co/docs/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. * @param string $customer_key The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer. * @param string $display_name Human-readable name for the connected account, shown in the dashboard. For example, `Booking from Airbnb House 1`. * @return void OK diff --git a/src/Routes/ConnectedAccountsSimulateClient.php b/src/Routes/ConnectedAccountsSimulateClient.php index 85e0612e..019161cd 100644 --- a/src/Routes/ConnectedAccountsSimulateClient.php +++ b/src/Routes/ConnectedAccountsSimulateClient.php @@ -23,7 +23,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $connected_account_id ID of the connected account you want to simulate as disconnected. * @return void OK diff --git a/src/Routes/DevicesClient.php b/src/Routes/DevicesClient.php index fdfd295b..e86c52de 100644 --- a/src/Routes/DevicesClient.php +++ b/src/Routes/DevicesClient.php @@ -30,7 +30,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified [device](https://docs.seam.co/core-concepts/devices). + * Returns a specified [device](https://www.seam.co/docs/core-concepts/devices). * * You must specify either `device_id` or `name`. * @@ -64,13 +64,13 @@ public function get(?string $device_id = null, ?string $name = null): Device } /** - * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices). + * Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices). * * @param string $connect_webview_id ID of the Connect Webview for which you want to list devices. * @param string $connected_account_id ID of the connected account for which you want to list devices. * @param list $connected_account_ids Array of IDs of the connected accounts for which you want to list devices. * @param string $created_before Timestamp by which to limit returned devices. Returns devices created before this timestamp. - * @param array|\stdClass $custom_metadata_has Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. + * @param array|\stdClass $custom_metadata_has Set of key:value [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. * @param string $customer_key Customer key for which you want to list devices. * @param list $device_ids Array of device IDs for which you want to list devices. * @param string $device_type Device type for which you want to list devices. @@ -174,9 +174,9 @@ public function list( /** * Returns a list of all device providers. * - * The information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. + * The information that this endpoint returns for each provider includes a set of [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. * - * When you create a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * When you create a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). * * @param string $provider_category Category for which you want to list providers. * @return array OK @@ -224,13 +224,13 @@ public function report_provider_metadata(array $devices): void } /** - * Updates a specified [device](https://docs.seam.co/core-concepts/devices). + * Updates a specified [device](https://www.seam.co/docs/core-concepts/devices). * - * You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * You can add or change [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). * * @param string $device_id ID of the device that you want to update. - * @param bool $backup_access_code_pool_enabled Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. - * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. + * @param bool $backup_access_code_pool_enabled Indicates whether the device's [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. + * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://www.seam.co/docs/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. * @param bool $is_managed Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`. * @param string|NullValue $name Name for the device. * @param mixed $properties diff --git a/src/Routes/DevicesSimulateClient.php b/src/Routes/DevicesSimulateClient.php index b33bceac..889bb704 100644 --- a/src/Routes/DevicesSimulateClient.php +++ b/src/Routes/DevicesSimulateClient.php @@ -23,7 +23,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). * * @param string $device_id ID of the device that you want to simulate connecting to Seam. * @return void OK @@ -60,7 +60,7 @@ public function connect_to_hub(string $device_id): void } /** - * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). * * @param string $device_id ID of the device that you want to simulate disconnecting from Seam. * @return void OK @@ -121,7 +121,7 @@ public function paid_subscription(string $device_id, bool $is_expired): void } /** - * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). * * @param string $device_id ID of the device that you want to simulate removing from Seam. * @return void OK diff --git a/src/Routes/DevicesUnmanagedClient.php b/src/Routes/DevicesUnmanagedClient.php index bd454db3..829f7e8b 100644 --- a/src/Routes/DevicesUnmanagedClient.php +++ b/src/Routes/DevicesUnmanagedClient.php @@ -26,9 +26,9 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Returns a specified [unmanaged device](https://www.seam.co/docs/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/low-level-apis/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/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * 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://www.seam.co/docs/low-level-apis/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://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). * * You must specify either `device_id` or `name`. * @@ -66,9 +66,9 @@ public function get( } /** - * Returns a list of all [unmanaged devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Returns a list of all [unmanaged devices](https://www.seam.co/docs/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/low-level-apis/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/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * 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://www.seam.co/docs/low-level-apis/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://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). * * @param string $connect_webview_id ID of the Connect Webview for which you want to list devices. * @param string $connected_account_id ID of the connected account for which you want to list devices. @@ -156,9 +156,9 @@ public function list( } /** - * Updates a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. + * Updates a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. * - * 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/low-level-apis/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/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * 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://www.seam.co/docs/low-level-apis/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://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). * * @param string $device_id ID of the unmanaged device that you want to update. * @param array|\stdClass $custom_metadata Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Set a key to `null` or to an empty string to remove that key from the custom metadata. diff --git a/src/Routes/EventsClient.php b/src/Routes/EventsClient.php index 6a4509ce..0e3e5996 100644 --- a/src/Routes/EventsClient.php +++ b/src/Routes/EventsClient.php @@ -25,7 +25,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to retrieve an event that already took place. + * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. * * @param string $event_id Unique identifier for the event that you want to get. * @param string $device_id Unique identifier for the device that triggered the event that you want to get. @@ -64,7 +64,7 @@ public function get( } /** - * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to filter or see events that already took place. + * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. * * @param string $access_code_id ID of the access code for which you want to list events. * @param list $access_code_ids IDs of the access codes for which you want to list events. diff --git a/src/Routes/InstantKeysClient.php b/src/Routes/InstantKeysClient.php index d732d637..e35bbc2f 100644 --- a/src/Routes/InstantKeysClient.php +++ b/src/Routes/InstantKeysClient.php @@ -25,7 +25,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Deletes a specified [Instant Key](https://docs.seam.co/capability-guides/instant-keys). + * Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). * * @param string $instant_key_id ID of the Instant Key that you want to delete. * @return void OK @@ -42,7 +42,7 @@ public function delete(string $instant_key_id): void } /** - * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys). + * Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). * * @param string $instant_key_id ID of the instant key to get. * @param string $instant_key_url URL of the instant key to get. @@ -78,7 +78,7 @@ public function get( } /** - * Returns a list of all [instant keys](https://docs.seam.co/capability-guides/instant-keys). + * Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). * * @param string $user_identity_id ID of the user identity by which you want to filter the list of Instant Keys. * @return array OK diff --git a/src/Routes/LocksClient.php b/src/Routes/LocksClient.php index a1d64a7c..3c76630e 100644 --- a/src/Routes/LocksClient.php +++ b/src/Routes/LocksClient.php @@ -28,7 +28,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). + * Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks). * * @param bool $auto_lock_enabled Whether to enable or disable auto-lock. * @param string $device_id ID of the lock for which you want to configure the auto-lock. @@ -73,7 +73,7 @@ public function configure_auto_lock( } /** - * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). + * Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks). * * @param string $device_id ID of the lock that you want to get. * @param string $name Name of the lock that you want to get. @@ -106,7 +106,7 @@ public function get(?string $device_id = null, ?string $name = null): Device } /** - * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks). + * Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks). * * @param string $connect_webview_id ID of the Connect Webview for which you want to list devices. * @param string $connected_account_id ID of the connected account for which you want to list devices. @@ -158,7 +158,7 @@ public function list( } /** - * Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). + * Locks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock). * * @param string $device_id ID of the lock that you want to lock. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. @@ -189,7 +189,7 @@ public function lock_door( } /** - * Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). + * Unlocks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock). * * @param string $device_id ID of the lock that you want to unlock. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. diff --git a/src/Routes/LocksSimulateClient.php b/src/Routes/LocksSimulateClient.php index 02daf9fa..49c1236e 100644 --- a/src/Routes/LocksSimulateClient.php +++ b/src/Routes/LocksSimulateClient.php @@ -26,7 +26,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $code Code that you want to simulate entering on a keypad. * @param string $device_id ID of the device for which you want to simulate a keypad code entry. @@ -66,7 +66,7 @@ public function keypad_code_entry( } /** - * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $device_id ID of the device for which you want to simulate a manual lock action using a keypad. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. diff --git a/src/Routes/NoiseSensorsClient.php b/src/Routes/NoiseSensorsClient.php index 05079f0e..d66632a4 100644 --- a/src/Routes/NoiseSensorsClient.php +++ b/src/Routes/NoiseSensorsClient.php @@ -31,7 +31,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors). * * @param string $connect_webview_id ID of the Connect Webview for which you want to list devices. * @param string $connected_account_id ID of the connected account for which you want to list devices. diff --git a/src/Routes/NoiseSensorsNoiseThresholdsClient.php b/src/Routes/NoiseSensorsNoiseThresholdsClient.php index 77cb8ea6..5bc4586f 100644 --- a/src/Routes/NoiseSensorsNoiseThresholdsClient.php +++ b/src/Routes/NoiseSensorsNoiseThresholdsClient.php @@ -25,14 +25,14 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. + * Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. * * @param string $device_id ID of the device for which you want to create a noise threshold. * @param string $ends_daily_at Time at which the new noise threshold should become inactive daily. * @param string $starts_daily_at Time at which the new noise threshold should become active daily. * @param string $name Name of the new noise threshold. * @param float $noise_threshold_decibels Noise level in decibels for the new noise threshold. - * @param float $noise_threshold_nrs Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). + * @param float $noise_threshold_nrs Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors). * @return NoiseThreshold OK */ public function create( @@ -78,7 +78,7 @@ public function create( } /** - * Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). * * @param string $device_id ID of the device that contains the noise threshold that you want to delete. * @param string $noise_threshold_id ID of the noise threshold that you want to delete. @@ -99,7 +99,7 @@ public function delete(string $device_id, string $noise_threshold_id): void } /** - * Returns a specified [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). * * @param string $noise_threshold_id ID of the noise threshold that you want to get. * @return NoiseThreshold OK @@ -128,7 +128,7 @@ public function get(string $noise_threshold_id): NoiseThreshold } /** - * Returns a list of all [noise thresholds](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). * * @param string $device_id ID of the device for which you want to list noise thresholds. * @return array OK @@ -158,14 +158,14 @@ public function list(string $device_id): array } /** - * Updates a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). * * @param string $device_id ID of the device that contains the noise threshold that you want to update. * @param string $noise_threshold_id ID of the noise threshold that you want to update. * @param string $ends_daily_at Time at which the noise threshold should become inactive daily. * @param string $name Name of the noise threshold that you want to update. * @param float $noise_threshold_decibels Noise level in decibels for the noise threshold. - * @param float $noise_threshold_nrs Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). + * @param float $noise_threshold_nrs Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors). * @param string $starts_daily_at Time at which the noise threshold should become active daily. * @return void OK */ diff --git a/src/Routes/NoiseSensorsSimulateClient.php b/src/Routes/NoiseSensorsSimulateClient.php index 7d387ece..a5b362c5 100644 --- a/src/Routes/NoiseSensorsSimulateClient.php +++ b/src/Routes/NoiseSensorsSimulateClient.php @@ -23,7 +23,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates the triggering of a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * * @param string $device_id ID of the device for which you want to simulate the triggering of a noise threshold. * @return void OK diff --git a/src/Routes/PhonesClient.php b/src/Routes/PhonesClient.php index d8576183..7541e6b9 100644 --- a/src/Routes/PhonesClient.php +++ b/src/Routes/PhonesClient.php @@ -26,7 +26,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). + * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). * * @param string $device_id Device ID of the phone that you want to deactivate. * @return void OK @@ -43,7 +43,7 @@ public function deactivate(string $device_id): void } /** - * Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). + * Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). * * @param string $device_id Device ID of the phone that you want to get. * @return Phone OK @@ -64,9 +64,9 @@ public function get(string $device_id): Phone } /** - * Returns a list of all [phones](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + * Returns a list of all [phones](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. * - * @param string $acs_credential_id ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones. + * @param string $acs_credential_id ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones. * @param string $owner_user_identity_id ID of the user identity that represents the owner by which you want to filter the list of returned phones. * @return array OK */ diff --git a/src/Routes/PhonesSimulateClient.php b/src/Routes/PhonesSimulateClient.php index 353ceafb..6bd8dc8d 100644 --- a/src/Routes/PhonesSimulateClient.php +++ b/src/Routes/PhonesSimulateClient.php @@ -25,7 +25,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). + * Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). * * @param string $user_identity_id ID of the user identity that you want to associate with the simulated phone. * @param mixed $assa_abloy_metadata ASSA ABLOY metadata that you want to associate with the simulated phone. diff --git a/src/Routes/SpacesClient.php b/src/Routes/SpacesClient.php index beb92404..bc08b1af 100644 --- a/src/Routes/SpacesClient.php +++ b/src/Routes/SpacesClient.php @@ -27,7 +27,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. + * Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. * * @param list $acs_entrance_ids IDs of the entrances that you want to add to the space. * @param string $space_id ID of the space to which you want to add entrances. @@ -48,7 +48,7 @@ public function add_acs_entrances( } /** - * Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space. + * Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space. * * @param string $connected_account_id ID of the connected account that you want to add to the space. * @param string $space_id ID of the space to which you want to add the connected account. @@ -295,7 +295,7 @@ public function list( } /** - * Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. + * Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. * * @param list $acs_entrance_ids IDs of the entrances that you want to remove from the space. * @param string $space_id ID of the space from which you want to remove entrances. @@ -316,7 +316,7 @@ public function remove_acs_entrances( } /** - * Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space. + * Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space. * * @param string $connected_account_id ID of the connected account that you want to remove from the space. * @param string $space_id ID of the space from which you want to remove the connected account. diff --git a/src/Routes/ThermostatsClient.php b/src/Routes/ThermostatsClient.php index bac9241b..24b10882 100644 --- a/src/Routes/ThermostatsClient.php +++ b/src/Routes/ThermostatsClient.php @@ -36,7 +36,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Activates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $climate_preset_key Climate preset key of the climate preset that you want to activate. * @param string $device_id ID of the thermostat device for which you want to activate a climate preset. @@ -76,11 +76,11 @@ public function activate_climate_preset( } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [cool mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). * * @param string $device_id ID of the thermostat device that you want to set to cool mode. - * @param float $cooling_set_point_celsius [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. - * @param float $cooling_set_point_fahrenheit [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * @param float $cooling_set_point_celsius [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * @param float $cooling_set_point_fahrenheit [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. * @return ActionAttempt OK */ @@ -121,20 +121,20 @@ public function cool( } /** - * Creates a [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * - * @param string $climate_preset_key Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * @param string $climate_preset_key Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). * @param string $device_id ID of the thermostat device for which you want create a climate preset. * @param string $climate_preset_mode The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - * @param float $cooling_set_point_celsius Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - * @param float $cooling_set_point_fahrenheit Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param float $cooling_set_point_celsius Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param float $cooling_set_point_fahrenheit Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). * @param mixed $ecobee_metadata Metadata specific to the Ecobee climate, if applicable. - * @param string $fan_mode_setting Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - * @param float $heating_set_point_celsius Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - * @param float $heating_set_point_fahrenheit Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - * @param string $hvac_mode_setting Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * @param string $fan_mode_setting Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * @param float $heating_set_point_celsius Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param float $heating_set_point_fahrenheit Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param string $hvac_mode_setting Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. * @param bool $manual_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings. - * @param string|NullValue $name User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * @param string|NullValue $name User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). * @return void OK */ public function create_climate_preset( @@ -202,7 +202,7 @@ public function create_climate_preset( } /** - * Deletes a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $climate_preset_key Climate preset key of the climate preset that you want to delete. * @param string $device_id ID of the thermostat device for which you want to delete a climate preset. @@ -223,11 +223,11 @@ public function delete_climate_preset( } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). * * @param string $device_id ID of the thermostat device that you want to set to heat mode. - * @param float $heating_set_point_celsius [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. - * @param float $heating_set_point_fahrenheit [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * @param float $heating_set_point_celsius [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * @param float $heating_set_point_fahrenheit [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. * @return ActionAttempt OK */ @@ -268,13 +268,13 @@ public function heat( } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). * * @param string $device_id ID of the thermostat device that you want to set to heat-cool mode. - * @param float $cooling_set_point_celsius [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. - * @param float $cooling_set_point_fahrenheit [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. - * @param float $heating_set_point_celsius [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. - * @param float $heating_set_point_fahrenheit [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * @param float $cooling_set_point_celsius [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * @param float $cooling_set_point_fahrenheit [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * @param float $heating_set_point_celsius [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * @param float $heating_set_point_fahrenheit [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. * @return ActionAttempt OK */ @@ -327,7 +327,7 @@ public function heat_cool( } /** - * Returns a list of all [thermostats](https://docs.seam.co/capability-guides/thermostats). + * Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $connect_webview_id ID of the Connect Webview for which you want to list devices. * @param string $connected_account_id ID of the connected account for which you want to list devices. @@ -379,7 +379,7 @@ public function list( } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). * * @param string $device_id ID of the thermostat device that you want to set to off mode. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. @@ -410,7 +410,7 @@ public function off( } /** - * Sets a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $climate_preset_key Climate preset key of the climate preset that you want to set as the fallback climate preset. * @param string $device_id ID of the thermostat device for which you want to set the fallback climate preset. @@ -433,11 +433,11 @@ public function set_fallback_climate_preset( } /** - * Sets the [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $device_id ID of the thermostat device for which you want to set the fan mode. * @param string $fan_mode Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`. - * @param string $fan_mode_setting [Fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. + * @param string $fan_mode_setting [Fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. * @return ActionAttempt OK */ @@ -474,14 +474,14 @@ public function set_fan_mode( } /** - * Sets the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $device_id ID of the thermostat device for which you want to set the HVAC mode. * @param string $hvac_mode_setting - * @param float $cooling_set_point_celsius [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. - * @param float $cooling_set_point_fahrenheit [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. - * @param float $heating_set_point_celsius [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. - * @param float $heating_set_point_fahrenheit [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * @param float $cooling_set_point_celsius [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * @param float $cooling_set_point_fahrenheit [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * @param float $heating_set_point_celsius [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * @param float $heating_set_point_fahrenheit [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. * @return ActionAttempt OK */ @@ -540,7 +540,7 @@ public function set_hvac_mode( } /** - * Sets a [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + * Sets a [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. * * @param string $device_id ID of the thermostat device for which you want to set a temperature threshold. * @param float|NullValue $lower_limit_celsius Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. @@ -584,20 +584,20 @@ public function set_temperature_threshold( } /** - * Updates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * - * @param string $climate_preset_key Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * @param string $climate_preset_key Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). * @param string $device_id ID of the thermostat device for which you want to update a climate preset. * @param string $climate_preset_mode The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - * @param float $cooling_set_point_celsius Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - * @param float $cooling_set_point_fahrenheit Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param float $cooling_set_point_celsius Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param float $cooling_set_point_fahrenheit Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). * @param mixed $ecobee_metadata Metadata specific to the Ecobee climate, if applicable. - * @param string $fan_mode_setting Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - * @param float $heating_set_point_celsius Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - * @param float $heating_set_point_fahrenheit Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - * @param string $hvac_mode_setting Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - * @param bool $manual_override_allowed Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - * @param string|NullValue $name User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * @param string $fan_mode_setting Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * @param float $heating_set_point_celsius Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param float $heating_set_point_fahrenheit Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * @param string $hvac_mode_setting Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * @param bool $manual_override_allowed Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * @param string|NullValue $name User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). * @return void OK */ public function update_climate_preset( diff --git a/src/Routes/ThermostatsSchedulesClient.php b/src/Routes/ThermostatsSchedulesClient.php index 5f716d7f..903113f8 100644 --- a/src/Routes/ThermostatsSchedulesClient.php +++ b/src/Routes/ThermostatsSchedulesClient.php @@ -26,14 +26,14 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * - * @param string $climate_preset_key Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. + * @param string $climate_preset_key Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. * @param string $device_id ID of the thermostat device for which you want to create a schedule. * @param string $ends_at Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. * @param string $starts_at Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - * @param bool $is_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - * @param int|NullValue $max_override_period_minutes Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * @param bool $is_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * @param int|NullValue $max_override_period_minutes Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * @param string $name Name of the thermostat schedule. * @return ThermostatSchedule OK */ @@ -80,7 +80,7 @@ public function create( } /** - * Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $thermostat_schedule_id ID of the thermostat schedule that you want to delete. * @return void OK @@ -97,7 +97,7 @@ public function delete(string $thermostat_schedule_id): void } /** - * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * * @param string $thermostat_schedule_id ID of the thermostat schedule that you want to get. * @return ThermostatSchedule OK @@ -124,7 +124,7 @@ public function get(string $thermostat_schedule_id): ThermostatSchedule } /** - * Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). * * @param string $device_id ID of the thermostat device for which you want to list schedules. * @param string $user_identifier_key User identifier key by which to filter the list of returned thermostat schedules. @@ -158,13 +158,13 @@ public function list( } /** - * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * * @param string $thermostat_schedule_id ID of the thermostat schedule that you want to update. - * @param string $climate_preset_key Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. + * @param string $climate_preset_key Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. * @param string $ends_at Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - * @param bool $is_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - * @param int|NullValue $max_override_period_minutes Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * @param bool $is_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * @param int|NullValue $max_override_period_minutes Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * @param string $name Name of the thermostat schedule. * @param string $starts_at Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. * @return void OK diff --git a/src/Routes/ThermostatsSimulateClient.php b/src/Routes/ThermostatsSimulateClient.php index 244539cd..4c8bd702 100644 --- a/src/Routes/ThermostatsSimulateClient.php +++ b/src/Routes/ThermostatsSimulateClient.php @@ -23,14 +23,14 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). + * Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). * * @param string $device_id ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. * @param string $hvac_mode HVAC mode that you want to simulate. - * @param float $cooling_set_point_celsius Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. - * @param float $cooling_set_point_fahrenheit Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. - * @param float $heating_set_point_celsius Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. - * @param float $heating_set_point_fahrenheit Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. + * @param float $cooling_set_point_celsius Cooling [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. + * @param float $cooling_set_point_fahrenheit Cooling [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. + * @param float $heating_set_point_celsius Heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. + * @param float $heating_set_point_fahrenheit Heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. * @return void OK */ public function hvac_mode_adjusted( @@ -74,7 +74,7 @@ public function hvac_mode_adjusted( } /** - * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). + * Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). * * @param string $device_id ID of the thermostat device that you want to simulate reaching a specified temperature. * @param float $temperature_celsius Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`. diff --git a/src/Routes/UserIdentitiesClient.php b/src/Routes/UserIdentitiesClient.php index b9861baa..efe17fb7 100644 --- a/src/Routes/UserIdentitiesClient.php +++ b/src/Routes/UserIdentitiesClient.php @@ -35,7 +35,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * You must specify either `user_identity_id` or `user_identity_key` to identify the user identity. * @@ -67,7 +67,7 @@ public function add_acs_user( } /** - * Creates a new [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Creates a new [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param list $acs_system_ids List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. * @param string|NullValue $email_address Unique email address for the new user identity. @@ -113,7 +113,7 @@ public function create( } /** - * Deletes a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/api/acs/credentials), [acs users](https://docs.seam.co/api/acs/users) and [client sessions](https://docs.seam.co/api/client_sessions). + * Deletes a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://www.seam.co/docs/api/acs/credentials/object), [acs users](https://www.seam.co/docs/api/acs/users/object) and [client sessions](https://www.seam.co/docs/api/client_sessions/object). * * @param string $user_identity_id ID of the user identity that you want to delete. * @return void OK @@ -130,7 +130,7 @@ public function delete(string $user_identity_id): void } /** - * Generates a new [instant key](https://docs.seam.co/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Generates a new [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys) for a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $user_identity_id ID of the user identity for which you want to generate an instant key. * @param string $customization_profile_id @@ -172,7 +172,7 @@ public function generate_instant_key( } /** - * Returns a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $user_identity_id ID of the user identity that you want to get. * @param string $user_identity_key @@ -208,7 +208,7 @@ public function get( } /** - * Grants a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/core-concepts/devices/). + * Grants a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://www.seam.co/docs/core-concepts/devices). * * @param string $device_id ID of the managed device to which you want to grant access to the user identity. * @param string $user_identity_id ID of the user identity that you want to grant access to a device. @@ -231,7 +231,7 @@ public function grant_access_to_device( } /** - * Returns a list of all [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $created_before Timestamp by which to limit returned user identities. Returns user identities created before this timestamp. * @param string $credential_manager_acs_system_id `acs_system_id` of the credential manager by which you want to filter the list of user identities. @@ -291,7 +291,7 @@ public function list( } /** - * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity. + * Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity. * * @param string $user_identity_id ID of the user identity for which you want to retrieve all accessible devices. * @return array OK @@ -321,7 +321,7 @@ public function list_accessible_devices(string $user_identity_id): array } /** - * Returns a list of all [ACS entrances](https://docs.seam.co/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity. + * Returns a list of all [ACS entrances](https://www.seam.co/docs/api/acs/entrances/object) accessible to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity. * * @param string $user_identity_id ID of the user identity for which you want to retrieve all accessible entrances. * @return array OK @@ -351,7 +351,7 @@ public function list_accessible_entrances(string $user_identity_id): array } /** - * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $user_identity_id ID of the user identity for which you want to retrieve all access systems. * @return array OK @@ -379,7 +379,7 @@ public function list_acs_systems(string $user_identity_id): array } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $user_identity_id ID of the user identity for which you want to retrieve all access system users. * @return array OK @@ -407,7 +407,7 @@ public function list_acs_users(string $user_identity_id): array } /** - * Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. + * Merges one or more [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. * * The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`. * @@ -462,7 +462,7 @@ public function merge( } /** - * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $acs_user_id ID of the access system user that you want to remove from the user identity.. * @param string $user_identity_id ID of the user identity from which you want to remove an access system user. @@ -483,7 +483,7 @@ public function remove_acs_user( } /** - * Revokes access to a specified [device](https://docs.seam.co/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Revokes access to a specified [device](https://www.seam.co/docs/core-concepts/devices) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $device_id ID of the managed device to which you want to revoke access from the user identity. * @param string $user_identity_id ID of the user identity from which you want to revoke access to a device. @@ -506,7 +506,7 @@ public function revoke_access_to_device( } /** - * Updates a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Updates a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * @param string $user_identity_id ID of the user identity that you want to update. * @param string|NullValue $email_address Unique email address for the user identity. diff --git a/src/Routes/UserIdentitiesUnmanagedClient.php b/src/Routes/UserIdentitiesUnmanagedClient.php index 9bf8f516..46b45f1e 100644 --- a/src/Routes/UserIdentitiesUnmanagedClient.php +++ b/src/Routes/UserIdentitiesUnmanagedClient.php @@ -26,7 +26,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Returns a specified unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). + * Returns a specified unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). * * @param string $user_identity_id ID of the unmanaged user identity that you want to get. * @return UnmanagedUserIdentity OK @@ -49,7 +49,7 @@ public function get(string $user_identity_id): UnmanagedUserIdentity } /** - * Returns a list of all unmanaged [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). + * Returns a list of all unmanaged [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). * * @param string $created_before Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp. * @param int $limit Maximum number of records to return per page. @@ -101,7 +101,7 @@ public function list( } /** - * Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. + * Updates an unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. * * This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged. * diff --git a/src/Routes/WebhooksClient.php b/src/Routes/WebhooksClient.php index 042dda4e..a4920f35 100644 --- a/src/Routes/WebhooksClient.php +++ b/src/Routes/WebhooksClient.php @@ -25,7 +25,7 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + * Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). * * @param string $url URL for the new webhook. * @param list $event_types Types of events that you want the new webhook to receive. @@ -52,7 +52,7 @@ public function create(string $url, ?array $event_types = null): Webhook } /** - * Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). * * @param string $webhook_id ID of the webhook that you want to delete. * @return void OK @@ -69,7 +69,7 @@ public function delete(string $webhook_id): void } /** - * Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). * * @param string $webhook_id ID of the webhook that you want to get. * @return Webhook OK @@ -90,7 +90,7 @@ public function get(string $webhook_id): Webhook } /** - * Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks). + * Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks). * * @return array OK */ @@ -105,7 +105,7 @@ public function list(): array } /** - * Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). * * @param list $event_types Types of events that you want the webhook to receive. * @param string $webhook_id ID of the webhook that you want to update. diff --git a/src/Routes/WorkspacesClient.php b/src/Routes/WorkspacesClient.php index c1c0d793..8e9e84be 100644 --- a/src/Routes/WorkspacesClient.php +++ b/src/Routes/WorkspacesClient.php @@ -28,13 +28,13 @@ public function __construct(ClientInterface $client, array $defaults) } /** - * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + * Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). * * @param string $name Name of the new workspace. * @param string $company_name Company name for the new workspace. * @param string|NullValue $connect_partner_name Connect partner name for the new workspace. - * @param mixed $connect_webview_customization [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). - * @param bool $is_sandbox Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * @param mixed $connect_webview_customization [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * @param bool $is_sandbox Indicates whether the new workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). * @param string $organization_id ID of the organization to associate with the new workspace. If omitted, the new workspace is associated with the organization that you administer, if you administer exactly one. If you administer no organization, Seam creates one for you and associates the new workspace with it. * @param string $webview_logo_shape * @param string $webview_primary_button_color @@ -105,7 +105,7 @@ public function create( } /** - * Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. * * @return Workspace OK */ @@ -119,7 +119,7 @@ public function get(): Workspace } /** - * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. * * @return array OK */ @@ -134,7 +134,7 @@ public function list(): array } /** - * Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. + * Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. * * @param bool|array|null $wait_for_action_attempt Whether to wait for the action attempt to finish, optionally with timeout and polling_interval in seconds. Defaults to the value set on the client. * @return ActionAttempt OK @@ -157,10 +157,10 @@ public function reset_sandbox( } /** - * Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. * * @param string $connect_partner_name Connect partner name for the workspace. - * @param mixed $connect_webview_customization [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * @param mixed $connect_webview_customization [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). * @param bool $is_publishable_key_auth_enabled Indicates whether publishable key authentication is enabled for this workspace. * @param bool $is_suspended Indicates whether the workspace is suspended. * @param string $name Name of the workspace.