diff --git a/codegen/lib/build-model.ts b/codegen/lib/build-model.ts index d28d9fba..e98c841d 100644 --- a/codegen/lib/build-model.ts +++ b/codegen/lib/build-model.ts @@ -646,17 +646,24 @@ const resolveModel = ( // The C# type for an endpoint's return value, and the resource property name it // is unwrapped from in the response body. +// A model named like the API class that returns it (e.g. Media from the Media +// API) is shadowed by that class inside Seam.Api, so it is fully qualified. const responseReturn = ( response: Endpoint['response'], modelTypes: Set, + apiClassName: string, ): { returnType: string; returnProp: string } | undefined => { if (response.responseType === 'void') return undefined const returnProp = pascalCase(response.responseKey) - const model = resolveModel( + const resolvedModel = resolveModel( response.resourceType, response.responseKey, modelTypes, ) + const model = + resolvedModel === apiClassName + ? `Seam.Model.${resolvedModel}` + : resolvedModel const returnType = response.responseType === 'resource_list' ? `List<${model}>` : model return { returnType, returnProp } @@ -690,7 +697,11 @@ export const buildApiFile = ( : {}), } - const returned = responseReturn(endpoint.response, modelTypes) + const returned = responseReturn( + endpoint.response, + modelTypes, + pascalCase(className), + ) const isVoid = returned == null if (isVoid) { diff --git a/package-lock.json b/package-lock.json index 415097bb..bb1e8906 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,9 +9,9 @@ "version": "1.5.0", "license": "MIT", "devDependencies": { - "@seamapi/blueprint": "^1.9.1", + "@seamapi/blueprint": "^1.12.0", "@seamapi/smith": "^1.1.0", - "@seamapi/types": "1.1047.0", + "@seamapi/types": "1.1092.0", "change-case": "^5.4.4", "execa": "^10.0.1", "prettier": "^3.0.0" @@ -790,14 +790,14 @@ "license": "MIT" }, "node_modules/@seamapi/blueprint": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-1.9.1.tgz", - "integrity": "sha512-A9H3dZE9f+ZEEnOAlMl5jSlL5F/RIKkjOF8NDFbnuahAiu/trDz/RzHOGhbQd6sd0RErIyx3eG1p4HCOJDKDCA==", + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-1.12.0.tgz", + "integrity": "sha512-cH6mpLIUm2q2YxuxEW4G6ODYZJFZihJcUtGyVWjwfdfrmGCyAJRl+S7XCyGz5LuNhdBRux5iShHxtsc/b0Y80g==", "dev": true, "license": "MIT", "dependencies": { "change-case": "^5.4.4", - "zod": "^3.23.8" + "zod": "^4.0.0" }, "engines": { "node": ">=22.12.0", @@ -838,9 +838,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.1047.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1047.0.tgz", - "integrity": "sha512-S3A3FcQ4fWJ1IsxVjHaE14k7WlQt0iKJsb3oPF/YVUZHJAmHnFg6riAF6LghlMig7prLf6C2uxaTDairw5dCJQ==", + "version": "1.1092.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1092.0.tgz", + "integrity": "sha512-99Wi8sSk4RZ2g9/iRJiONtIp9Hc/c2Xe5SeIIacbwxKbqkpmiTi8tQO0+M2qGXVzYuoO3xM/lBkEy4kUAhe/Ew==", "dev": true, "license": "MIT", "engines": { @@ -848,7 +848,7 @@ "npm": ">=10.0.0" }, "peerDependencies": { - "zod": "^3.24.0" + "zod": "^3.25.0 || ^4.0.0" } }, "node_modules/@sec-ant/readable-stream": { @@ -6022,9 +6022,9 @@ } }, "node_modules/zod": { - "version": "3.25.76", - "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz", - "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", + "version": "4.6.5", + "resolved": "https://registry.npmjs.org/zod/-/zod-4.6.5.tgz", + "integrity": "sha512-v5l/aFXZQeai4awLbOpSoHecE9UiMrnfx75tEXLjNonXVARxQ5mOeipTjROUchszUNCqnE+hqAMujRsRHsut2Q==", "dev": true, "license": "MIT", "funding": { diff --git a/package.json b/package.json index 097ea578..f9b53507 100644 --- a/package.json +++ b/package.json @@ -31,9 +31,9 @@ }, "packageManager": "npm@11.19.0", "devDependencies": { - "@seamapi/blueprint": "^1.9.1", + "@seamapi/blueprint": "^1.12.0", "@seamapi/smith": "^1.1.0", - "@seamapi/types": "1.1047.0", + "@seamapi/types": "1.1092.0", "change-case": "^5.4.4", "execa": "^10.0.1", "prettier": "^3.0.0" diff --git a/src/Seam/Api/AccessCodes.cs b/src/Seam/Api/AccessCodes.cs index a302e833..e2cc36c9 100644 --- a/src/Seam/Api/AccessCodes.cs +++ b/src/Seam/Api/AccessCodes.cs @@ -65,7 +65,7 @@ public CreateRequest( } /// - /// 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`. + /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum MaxTimeRoundingEnum @@ -87,7 +87,7 @@ public enum MaxTimeRoundingEnum } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + /// 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`. /// [DataMember( Name = "allow_external_modification", @@ -110,7 +110,7 @@ public enum MaxTimeRoundingEnum public string? Code { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "common_code_key", IsRequired = false, EmitDefaultValue = false)] public string? CommonCodeKey { get; set; } @@ -128,7 +128,7 @@ public enum MaxTimeRoundingEnum public string? EndsAt { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + /// 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`. /// [DataMember( Name = "is_external_modification_allowed", @@ -138,7 +138,7 @@ public enum MaxTimeRoundingEnum public bool? IsExternalModificationAllowed { get; set; } /// - /// Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes). + /// 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). /// [DataMember( Name = "is_offline_access_code", @@ -148,13 +148,13 @@ public enum MaxTimeRoundingEnum public bool? IsOfflineAccessCode { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "is_one_time_use", IsRequired = false, EmitDefaultValue = false)] public bool? IsOneTimeUse { get; set; } /// - /// 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`. + /// 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`. /// [DataMember(Name = "max_time_rounding", IsRequired = false, EmitDefaultValue = false)] public CreateRequest.MaxTimeRoundingEnum? MaxTimeRounding { get; set; } @@ -172,7 +172,7 @@ public enum MaxTimeRoundingEnum public string? Name { get; set; } /// - /// 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`. + /// 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`. /// [DataMember( Name = "prefer_native_scheduling", @@ -198,7 +198,7 @@ public enum MaxTimeRoundingEnum public string? StartsAt { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "use_backup_access_code_pool", @@ -273,7 +273,7 @@ public override string ToString() } /// - /// 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. /// public AccessCode Create(CreateRequest request) { @@ -286,7 +286,7 @@ public AccessCode Create(CreateRequest request) } /// - /// 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. /// public AccessCode Create( bool? allowExternalModification = default, @@ -330,7 +330,7 @@ public AccessCode Create( } /// - /// 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. /// public async Task CreateAsync(CreateRequest request) { @@ -342,7 +342,7 @@ public async Task CreateAsync(CreateRequest request) } /// - /// 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. /// public async Task CreateAsync( bool? allowExternalModification = default, @@ -443,7 +443,7 @@ public enum BehaviorWhenCodeCannotBeSharedEnum } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + /// 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`. /// [DataMember( Name = "allow_external_modification", @@ -488,7 +488,7 @@ public enum BehaviorWhenCodeCannotBeSharedEnum public string? EndsAt { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + /// 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`. /// [DataMember( Name = "is_external_modification_allowed", @@ -510,7 +510,7 @@ public enum BehaviorWhenCodeCannotBeSharedEnum public string? Name { get; set; } /// - /// 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`. + /// 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`. /// [DataMember( Name = "prefer_native_scheduling", @@ -536,7 +536,7 @@ public enum BehaviorWhenCodeCannotBeSharedEnum public string? StartsAt { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "use_backup_access_code_pool", @@ -603,7 +603,7 @@ public override string ToString() } /// - /// 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. /// @@ -611,9 +611,9 @@ public override string ToString() /// /// 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. /// public List CreateMultiple(CreateMultipleRequest request) { @@ -626,7 +626,7 @@ public List CreateMultiple(CreateMultipleRequest request) } /// - /// 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. /// @@ -634,9 +634,9 @@ public List CreateMultiple(CreateMultipleRequest request) /// /// 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. /// public List CreateMultiple( bool? allowExternalModification = default, @@ -673,7 +673,7 @@ public List CreateMultiple( } /// - /// 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. /// @@ -681,9 +681,9 @@ public List CreateMultiple( /// /// 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. /// public async Task> CreateMultipleAsync(CreateMultipleRequest request) { @@ -700,7 +700,7 @@ await _seam.PutAsync( } /// - /// 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. /// @@ -708,9 +708,9 @@ await _seam.PutAsync( /// /// 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. /// public async Task> CreateMultipleAsync( bool? allowExternalModification = default, @@ -796,7 +796,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -806,7 +806,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string accessCodeId = default, string? deviceId = default) { @@ -814,7 +814,7 @@ public void Delete(string accessCodeId = default, string? deviceId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -824,7 +824,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string accessCodeId = default, string? deviceId = default) { @@ -909,7 +909,7 @@ public override string ToString() } /// - /// 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. /// public AccessCode GenerateCode(GenerateCodeRequest request) { @@ -922,7 +922,7 @@ public AccessCode GenerateCode(GenerateCodeRequest request) } /// - /// 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. /// public AccessCode GenerateCode(string deviceId = default) { @@ -930,7 +930,7 @@ public AccessCode GenerateCode(string deviceId = default) } /// - /// 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. /// public async Task GenerateCodeAsync(GenerateCodeRequest request) { @@ -947,7 +947,7 @@ await _seam.GetAsync( } /// - /// 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. /// public async Task GenerateCodeAsync(string deviceId = default) { @@ -1050,7 +1050,7 @@ public override string ToString() } /// - /// 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`. /// @@ -1065,7 +1065,7 @@ public AccessCode Get(GetRequest request) } /// - /// 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`. /// @@ -1079,7 +1079,7 @@ public AccessCode Get( } /// - /// 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`. /// @@ -1093,7 +1093,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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`. /// @@ -1262,7 +1262,7 @@ public override string ToString() } /// - /// 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`. /// @@ -1277,7 +1277,7 @@ public List List(ListRequest request) } /// - /// 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`. /// @@ -1311,7 +1311,7 @@ public List List( } /// - /// 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`. /// @@ -1325,7 +1325,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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`. /// @@ -1438,7 +1438,7 @@ public override string ToString() } /// - /// 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. /// @@ -1462,7 +1462,7 @@ public AccessCode PullBackupAccessCode(PullBackupAccessCodeRequest request) } /// - /// 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. /// @@ -1480,7 +1480,7 @@ public AccessCode PullBackupAccessCode(string accessCodeId = default) } /// - /// 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. /// @@ -1505,7 +1505,7 @@ await _seam.PostAsync( } /// - /// 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. /// @@ -1702,7 +1702,7 @@ public UpdateRequest( } /// - /// 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). + /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum TypeEnum @@ -1724,7 +1724,7 @@ public enum TypeEnum public string AccessCodeId { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + /// 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`. /// [DataMember( Name = "allow_external_modification", @@ -1759,7 +1759,7 @@ public enum TypeEnum public string? EndsAt { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + /// 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`. /// [DataMember( Name = "is_external_modification_allowed", @@ -1793,7 +1793,7 @@ public enum TypeEnum public string? StartsAt { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "type", IsRequired = false, EmitDefaultValue = false)] public UpdateRequest.TypeEnum? Type { get; set; } @@ -1819,9 +1819,9 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -1831,9 +1831,9 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( string accessCodeId = default, @@ -1867,9 +1867,9 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -1879,9 +1879,9 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( string accessCodeId = default, @@ -1987,11 +1987,11 @@ public override string ToString() } /// - /// 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). /// public void UpdateMultiple(UpdateMultipleRequest request) { @@ -2001,11 +2001,11 @@ public void UpdateMultiple(UpdateMultipleRequest request) } /// - /// 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). /// public void UpdateMultiple( string commonCodeKey = default, @@ -2025,11 +2025,11 @@ public void UpdateMultiple( } /// - /// 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). /// public async Task UpdateMultipleAsync(UpdateMultipleRequest request) { @@ -2039,11 +2039,11 @@ public async Task UpdateMultipleAsync(UpdateMultipleRequest request) } /// - /// 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). /// public async Task UpdateMultipleAsync( string commonCodeKey = default, diff --git a/src/Seam/Api/AccessGrants.cs b/src/Seam/Api/AccessGrants.cs index b2ea2959..68fab453 100644 --- a/src/Seam/Api/AccessGrants.cs +++ b/src/Seam/Api/AccessGrants.cs @@ -69,7 +69,7 @@ public CreateRequest( public string? AccessGrantKey { get; set; } /// - /// Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted. + /// Set of IDs of the [entrances](https://www.seam.co/docs/api/acs/systems/list) to which access is being granted. /// [DataMember(Name = "acs_entrance_ids", IsRequired = false, EmitDefaultValue = false)] public List? AcsEntranceIds { get; set; } @@ -85,7 +85,7 @@ public CreateRequest( public string? CustomizationProfileId { get; set; } /// - /// Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted. + /// Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted. /// [DataMember(Name = "device_ids", IsRequired = false, EmitDefaultValue = false)] public List? DeviceIds { get; set; } @@ -406,7 +406,7 @@ public override string ToString() } /// - /// 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. /// public AccessGrant Create(CreateRequest request) { @@ -419,7 +419,7 @@ public AccessGrant Create(CreateRequest request) } /// - /// 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. /// public AccessGrant Create( string? accessGrantKey = default, @@ -461,7 +461,7 @@ public AccessGrant Create( } /// - /// 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. /// public async Task CreateAsync(CreateRequest request) { @@ -473,7 +473,7 @@ public async Task CreateAsync(CreateRequest request) } /// - /// 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. /// public async Task CreateAsync( string? accessGrantKey = default, @@ -978,6 +978,7 @@ public ListRequest( string? locationId = default, string? pageCursor = default, string? reservationKey = default, + string? search = default, string? spaceId = default, string? userIdentityId = default ) @@ -993,6 +994,7 @@ public ListRequest( LocationId = locationId; PageCursor = pageCursor; ReservationKey = reservationKey; + Search = search; SpaceId = spaceId; UserIdentityId = userIdentityId; } @@ -1061,6 +1063,12 @@ public ListRequest( [DataMember(Name = "reservation_key", IsRequired = false, EmitDefaultValue = false)] public string? ReservationKey { get; set; } + /// + /// String for which to search. Filters returned Access Grants to include all records that satisfy a partial match using `name`, `access_grant_key`, `reservation_key`, `access_grant_id`, `user_identity_id`, `user_identity_full_name`, `user_identity_email_address` or `user_identity_phone_number`. + /// + [DataMember(Name = "search", IsRequired = false, EmitDefaultValue = false)] + public string? Search { get; set; } + /// /// ID of the space by which you want to filter the list of Access Grants. /// @@ -1158,6 +1166,7 @@ public List List( string? locationId = default, string? pageCursor = default, string? reservationKey = default, + string? search = default, string? spaceId = default, string? userIdentityId = default ) @@ -1175,6 +1184,7 @@ public List List( locationId: locationId, pageCursor: pageCursor, reservationKey: reservationKey, + search: search, spaceId: spaceId, userIdentityId: userIdentityId ) @@ -1208,6 +1218,7 @@ public async Task> ListAsync( string? locationId = default, string? pageCursor = default, string? reservationKey = default, + string? search = default, string? spaceId = default, string? userIdentityId = default ) @@ -1226,6 +1237,7 @@ await ListAsync( locationId: locationId, pageCursor: pageCursor, reservationKey: reservationKey, + search: search, spaceId: spaceId, userIdentityId: userIdentityId ) diff --git a/src/Seam/Api/AccessGroupsAcs.cs b/src/Seam/Api/AccessGroupsAcs.cs index 3b08fff4..a463c27d 100644 --- a/src/Seam/Api/AccessGroupsAcs.cs +++ b/src/Seam/Api/AccessGroupsAcs.cs @@ -77,7 +77,7 @@ public override string ToString() } /// - /// 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). /// public void AddUser(AddUserRequest request) { @@ -87,7 +87,7 @@ public void AddUser(AddUserRequest request) } /// - /// 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). /// public void AddUser( string acsAccessGroupId = default, @@ -105,7 +105,7 @@ public void AddUser( } /// - /// 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). /// public async Task AddUserAsync(AddUserRequest request) { @@ -115,7 +115,7 @@ public async Task AddUserAsync(AddUserRequest request) } /// - /// 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). /// public async Task AddUserAsync( string acsAccessGroupId = default, @@ -173,7 +173,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -183,7 +183,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string acsAccessGroupId = default) { @@ -191,7 +191,7 @@ public void Delete(string acsAccessGroupId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -201,7 +201,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string acsAccessGroupId = default) { @@ -286,7 +286,7 @@ public override string ToString() } /// - /// 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). /// public AcsAccessGroup Get(GetRequest request) { @@ -299,7 +299,7 @@ public AcsAccessGroup Get(GetRequest request) } /// - /// 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). /// public AcsAccessGroup Get(string acsAccessGroupId = default) { @@ -307,7 +307,7 @@ public AcsAccessGroup Get(string acsAccessGroupId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -319,7 +319,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string acsAccessGroupId = default) { @@ -430,7 +430,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -443,7 +443,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? acsSystemId = default, @@ -463,7 +463,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -475,7 +475,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? acsSystemId = default, @@ -574,7 +574,7 @@ public override string ToString() } /// - /// 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). /// public List ListAccessibleEntrances(ListAccessibleEntrancesRequest request) { @@ -590,7 +590,7 @@ public List ListAccessibleEntrances(ListAccessibleEntrancesRequest } /// - /// 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). /// public List ListAccessibleEntrances(string acsAccessGroupId = default) { @@ -600,7 +600,7 @@ public List ListAccessibleEntrances(string acsAccessGroupId = defau } /// - /// 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). /// public async Task> ListAccessibleEntrancesAsync( ListAccessibleEntrancesRequest request @@ -619,7 +619,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListAccessibleEntrancesAsync( string acsAccessGroupId = default @@ -710,7 +710,7 @@ public override string ToString() } /// - /// 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). /// public List ListUsers(ListUsersRequest request) { @@ -723,7 +723,7 @@ public List ListUsers(ListUsersRequest request) } /// - /// 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). /// public List ListUsers(string acsAccessGroupId = default) { @@ -731,7 +731,7 @@ public List ListUsers(string acsAccessGroupId = default) } /// - /// 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). /// public async Task> ListUsersAsync(ListUsersRequest request) { @@ -748,7 +748,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListUsersAsync(string acsAccessGroupId = default) { @@ -814,7 +814,7 @@ public override string ToString() } /// - /// 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). /// public void RemoveUser(RemoveUserRequest request) { @@ -824,7 +824,7 @@ public void RemoveUser(RemoveUserRequest request) } /// - /// 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). /// public void RemoveUser( string acsAccessGroupId = default, @@ -842,7 +842,7 @@ public void RemoveUser( } /// - /// 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). /// public async Task RemoveUserAsync(RemoveUserRequest request) { @@ -852,7 +852,7 @@ public async Task RemoveUserAsync(RemoveUserRequest request) } /// - /// 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). /// public async Task RemoveUserAsync( string acsAccessGroupId = default, diff --git a/src/Seam/Api/AccessMethods.cs b/src/Seam/Api/AccessMethods.cs index a7e4383d..030b60e6 100644 --- a/src/Seam/Api/AccessMethods.cs +++ b/src/Seam/Api/AccessMethods.cs @@ -359,7 +359,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt Encode(EncodeRequest request) { @@ -372,7 +372,7 @@ public ActionAttempt Encode(EncodeRequest request) } /// - /// 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). /// public ActionAttempt Encode(string accessMethodId = default, string acsEncoderId = default) { @@ -382,7 +382,7 @@ public ActionAttempt Encode(string accessMethodId = default, string acsEncoderId } /// - /// 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). /// public async Task EncodeAsync(EncodeRequest request) { @@ -394,7 +394,7 @@ public async Task EncodeAsync(EncodeRequest request) } /// - /// 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). /// public async Task EncodeAsync( string accessMethodId = default, @@ -1051,7 +1051,7 @@ public override string ToString() } /// - /// 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. /// public ActionAttempt UnlockDoor(UnlockDoorRequest request) { @@ -1064,7 +1064,7 @@ public ActionAttempt UnlockDoor(UnlockDoorRequest request) } /// - /// 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. /// public ActionAttempt UnlockDoor( string accessMethodId = default, @@ -1077,7 +1077,7 @@ public ActionAttempt UnlockDoor( } /// - /// 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. /// public async Task UnlockDoorAsync(UnlockDoorRequest request) { @@ -1094,7 +1094,7 @@ await _seam.PostAsync( } /// - /// 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. /// public async Task UnlockDoorAsync( string accessMethodId = default, diff --git a/src/Seam/Api/ActionAttempts.cs b/src/Seam/Api/ActionAttempts.cs index 166de3a8..615fc87b 100644 --- a/src/Seam/Api/ActionAttempts.cs +++ b/src/Seam/Api/ActionAttempts.cs @@ -96,7 +96,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt Get(GetRequest request) { @@ -109,7 +109,7 @@ public ActionAttempt Get(GetRequest request) } /// - /// 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). /// public ActionAttempt Get(string actionAttemptId = default) { @@ -117,7 +117,7 @@ public ActionAttempt Get(string actionAttemptId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -129,7 +129,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string actionAttemptId = default) { @@ -240,7 +240,7 @@ public override string ToString() } /// - /// 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. /// public List List(ListRequest request) { @@ -253,7 +253,7 @@ public List List(ListRequest request) } /// - /// 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. /// public List List( List? actionAttemptIds = default, @@ -273,7 +273,7 @@ public List List( } /// - /// 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. /// public async Task> ListAsync(ListRequest request) { @@ -285,7 +285,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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. /// public async Task> ListAsync( List? actionAttemptIds = default, diff --git a/src/Seam/Api/ClientSessions.cs b/src/Seam/Api/ClientSessions.cs index d663b273..255e5fe2 100644 --- a/src/Seam/Api/ClientSessions.cs +++ b/src/Seam/Api/ClientSessions.cs @@ -49,13 +49,13 @@ public CreateRequest( } /// - /// IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) for which you want to create a client session. + /// IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session. /// [DataMember(Name = "connect_webview_ids", IsRequired = false, EmitDefaultValue = false)] public List? ConnectWebviewIds { get; set; } /// - /// IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) for which you want to create a client session. + /// IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) for which you want to create a client session. /// [DataMember( Name = "connected_account_ids", @@ -83,19 +83,19 @@ public CreateRequest( public string? ExpiresAt { get; set; } /// - /// Your user ID for the user for whom you want to create a client session. + /// Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. /// [DataMember(Name = "user_identifier_key", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentifierKey { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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. + /// 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. /// [Obsolete("Use `user_identity_id` instead.")] [DataMember(Name = "user_identity_ids", IsRequired = false, EmitDefaultValue = false)] @@ -159,7 +159,7 @@ public override string ToString() } /// - /// 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). /// public ClientSession Create(CreateRequest request) { @@ -172,7 +172,7 @@ public ClientSession Create(CreateRequest request) } /// - /// 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). /// public ClientSession Create( List? connectWebviewIds = default, @@ -200,7 +200,7 @@ public ClientSession Create( } /// - /// 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). /// public async Task CreateAsync(CreateRequest request) { @@ -212,7 +212,7 @@ public async Task CreateAsync(CreateRequest request) } /// - /// 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). /// public async Task CreateAsync( List? connectWebviewIds = default, @@ -282,7 +282,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -292,7 +292,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string clientSessionId = default) { @@ -300,7 +300,7 @@ public void Delete(string clientSessionId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -310,7 +310,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string clientSessionId = default) { @@ -405,7 +405,7 @@ public override string ToString() } /// - /// 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). /// public ClientSession Get(GetRequest request) { @@ -418,7 +418,7 @@ public ClientSession Get(GetRequest request) } /// - /// 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). /// public ClientSession Get( string? clientSessionId = default, @@ -434,7 +434,7 @@ public ClientSession Get( } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -446,7 +446,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync( string? clientSessionId = default, @@ -490,13 +490,13 @@ public GetOrCreateRequest( } /// - /// 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). + /// 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). /// [DataMember(Name = "connect_webview_ids", IsRequired = false, EmitDefaultValue = false)] public List? ConnectWebviewIds { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "connected_account_ids", @@ -512,19 +512,19 @@ public GetOrCreateRequest( public string? ExpiresAt { get; set; } /// - /// 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). + /// 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). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. /// [DataMember(Name = "user_identifier_key", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentifierKey { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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. + /// 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. /// [Obsolete("Use `user_identity_id`.")] [DataMember(Name = "user_identity_ids", IsRequired = false, EmitDefaultValue = false)] @@ -588,7 +588,7 @@ public override string ToString() } /// - /// 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. /// public ClientSession GetOrCreate(GetOrCreateRequest request) { @@ -601,7 +601,7 @@ public ClientSession GetOrCreate(GetOrCreateRequest request) } /// - /// 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. /// public ClientSession GetOrCreate( List? connectWebviewIds = default, @@ -625,7 +625,7 @@ public ClientSession GetOrCreate( } /// - /// 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. /// public async Task GetOrCreateAsync(GetOrCreateRequest request) { @@ -642,7 +642,7 @@ await _seam.PostAsync( } /// - /// 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. /// public async Task GetOrCreateAsync( List? connectWebviewIds = default, @@ -700,13 +700,13 @@ public GrantAccessRequest( public string? ClientSessionId { get; set; } /// - /// IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session. + /// IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session. /// [DataMember(Name = "connect_webview_ids", IsRequired = false, EmitDefaultValue = false)] public List? ConnectWebviewIds { get; set; } /// - /// IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that you want to associate with the client session. + /// IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that you want to associate with the client session. /// [DataMember( Name = "connected_account_ids", @@ -722,13 +722,13 @@ public GrantAccessRequest( public string? UserIdentifierKey { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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. + /// 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. /// [Obsolete("Use `user_identity_id`.")] [DataMember(Name = "user_identity_ids", IsRequired = false, EmitDefaultValue = false)] @@ -755,7 +755,7 @@ public override string ToString() } /// - /// 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. /// public void GrantAccess(GrantAccessRequest request) { @@ -765,7 +765,7 @@ public void GrantAccess(GrantAccessRequest request) } /// - /// 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. /// public void GrantAccess( string? clientSessionId = default, @@ -789,7 +789,7 @@ public void GrantAccess( } /// - /// 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. /// public async Task GrantAccessAsync(GrantAccessRequest request) { @@ -799,7 +799,7 @@ public async Task GrantAccessAsync(GrantAccessRequest request) } /// - /// 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. /// public async Task GrantAccessAsync( string? clientSessionId = default, @@ -853,7 +853,7 @@ public ListRequest( public string? ClientSessionId { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "connect_webview_id", IsRequired = false, EmitDefaultValue = false)] public string? ConnectWebviewId { get; set; } @@ -865,7 +865,7 @@ public ListRequest( public string? UserIdentifierKey { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } @@ -938,7 +938,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -951,7 +951,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? clientSessionId = default, @@ -973,7 +973,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -985,7 +985,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? clientSessionId = default, @@ -1049,9 +1049,9 @@ public override string ToString() } /// - /// 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. /// public void Revoke(RevokeRequest request) { @@ -1061,9 +1061,9 @@ public void Revoke(RevokeRequest request) } /// - /// 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. /// public void Revoke(string clientSessionId = default) { @@ -1071,9 +1071,9 @@ public void Revoke(string clientSessionId = default) } /// - /// 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. /// public async Task RevokeAsync(RevokeRequest request) { @@ -1083,9 +1083,9 @@ public async Task RevokeAsync(RevokeRequest request) } /// - /// 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. /// public async Task RevokeAsync(string clientSessionId = default) { diff --git a/src/Seam/Api/ConnectWebviews.cs b/src/Seam/Api/ConnectWebviews.cs index 5498fb7b..88a3f2f3 100644 --- a/src/Seam/Api/ConnectWebviews.cs +++ b/src/Seam/Api/ConnectWebviews.cs @@ -78,7 +78,7 @@ public enum AcceptedCapabilitiesEnum } /// - /// 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. + /// 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. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum AcceptedProvidersEnum @@ -179,120 +179,132 @@ public enum AcceptedProvidersEnum [EnumMember(Value = "dormakaba_oracode")] DormakabaOracode = 31, + [EnumMember(Value = "dormakaba_oracode_iho")] + DormakabaOracodeIho = 32, + [EnumMember(Value = "pti")] - Pti = 32, + Pti = 33, [EnumMember(Value = "wyze")] - Wyze = 33, + Wyze = 34, [EnumMember(Value = "seam_passport")] - SeamPassport = 34, + SeamPassport = 35, [EnumMember(Value = "visionline")] - Visionline = 35, + Visionline = 36, [EnumMember(Value = "assa_abloy_credential_service")] - AssaAbloyCredentialService = 36, + AssaAbloyCredentialService = 37, [EnumMember(Value = "tedee")] - Tedee = 37, + Tedee = 38, [EnumMember(Value = "honeywell_resideo")] - HoneywellResideo = 38, + HoneywellResideo = 39, [EnumMember(Value = "first_alert")] - FirstAlert = 39, + FirstAlert = 40, [EnumMember(Value = "latch")] - Latch = 40, + Latch = 41, [EnumMember(Value = "akiles")] - Akiles = 41, + Akiles = 42, [EnumMember(Value = "assa_abloy_vostio")] - AssaAbloyVostio = 42, + AssaAbloyVostio = 43, [EnumMember(Value = "assa_abloy_vostio_credential_service")] - AssaAbloyVostioCredentialService = 43, + AssaAbloyVostioCredentialService = 44, [EnumMember(Value = "tado")] - Tado = 44, + Tado = 45, [EnumMember(Value = "salto_space")] - SaltoSpace = 45, + SaltoSpace = 46, [EnumMember(Value = "sensi")] - Sensi = 46, + Sensi = 47, [EnumMember(Value = "keynest")] - Keynest = 47, + Keynest = 48, [EnumMember(Value = "korelock")] - Korelock = 48, + Korelock = 49, [EnumMember(Value = "keyincode")] - Keyincode = 49, + Keyincode = 50, [EnumMember(Value = "dormakaba_ambiance")] - DormakabaAmbiance = 50, + DormakabaAmbiance = 51, [EnumMember(Value = "ultraloq")] - Ultraloq = 51, + Ultraloq = 52, [EnumMember(Value = "yacan")] - Yacan = 52, + Yacan = 53, [EnumMember(Value = "dusaw")] - Dusaw = 53, + Dusaw = 54, [EnumMember(Value = "sifely")] - Sifely = 54, + Sifely = 55, [EnumMember(Value = "thirty_three_lock")] - ThirtyThreeLock = 55, + ThirtyThreeLock = 56, [EnumMember(Value = "ring")] - Ring = 56, + Ring = 57, + + [EnumMember(Value = "tapo")] + Tapo = 58, + + [EnumMember(Value = "arlo")] + Arlo = 59, + + [EnumMember(Value = "reolink")] + Reolink = 60, [EnumMember(Value = "ical")] - Ical = 57, + Ical = 61, [EnumMember(Value = "lodgify")] - Lodgify = 58, + Lodgify = 62, [EnumMember(Value = "hostaway")] - Hostaway = 59, + Hostaway = 63, [EnumMember(Value = "guesty")] - Guesty = 60, + Guesty = 64, [EnumMember(Value = "acuity_scheduling")] - AcuityScheduling = 61, + AcuityScheduling = 65, [EnumMember(Value = "omnitec")] - Omnitec = 62, + Omnitec = 66, [EnumMember(Value = "kisi")] - Kisi = 63, + Kisi = 67, [EnumMember(Value = "aqara")] - Aqara = 64, + Aqara = 68, [EnumMember(Value = "yale_access")] - YaleAccess = 65, + YaleAccess = 69, [EnumMember(Value = "hid_cm")] - HidCm = 66, + HidCm = 70, [EnumMember(Value = "google_nest")] - GoogleNest = 67, + GoogleNest = 71, [EnumMember(Value = "slack")] - Slack = 68, + Slack = 72, } /// - /// 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. + /// 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. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ProviderCategoryEnum @@ -339,13 +351,13 @@ public enum ProviderCategoryEnum public List? AcceptedCapabilities { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "accepted_providers", IsRequired = false, EmitDefaultValue = false)] public List? AcceptedProviders { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "automatically_manage_new_devices", @@ -355,7 +367,7 @@ public enum ProviderCategoryEnum public bool? AutomaticallyManageNewDevices { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object? CustomMetadata { get; set; } @@ -389,13 +401,13 @@ public enum ProviderCategoryEnum public List? ExcludedProviders { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "provider_category", IsRequired = false, EmitDefaultValue = false)] public CreateRequest.ProviderCategoryEnum? ProviderCategory { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "wait_for_device_creation", @@ -462,13 +474,13 @@ public override string ToString() } /// - /// 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). /// public ConnectWebview Create(CreateRequest request) { @@ -481,13 +493,13 @@ public ConnectWebview Create(CreateRequest request) } /// - /// 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). /// public ConnectWebview Create( List? acceptedCapabilities = default, @@ -519,13 +531,13 @@ public ConnectWebview Create( } /// - /// 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). /// public async Task CreateAsync(CreateRequest request) { @@ -539,13 +551,13 @@ await _seam.PostAsync("/connect_webviews/create", requestOptions } /// - /// 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). /// public async Task CreateAsync( List? acceptedCapabilities = default, @@ -619,7 +631,7 @@ public override string ToString() } /// - /// 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. /// @@ -631,7 +643,7 @@ public void Delete(DeleteRequest request) } /// - /// 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. /// @@ -641,7 +653,7 @@ public void Delete(string connectWebviewId = default) } /// - /// 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. /// @@ -653,7 +665,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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. /// @@ -740,7 +752,7 @@ public override string ToString() } /// - /// 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. /// @@ -755,7 +767,7 @@ public ConnectWebview Get(GetRequest request) } /// - /// 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. /// @@ -765,7 +777,7 @@ public ConnectWebview Get(string connectWebviewId = default) } /// - /// 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. /// @@ -779,7 +791,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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. /// @@ -815,7 +827,7 @@ public ListRequest( } /// - /// 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. + /// 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. /// [DataMember(Name = "custom_metadata_has", IsRequired = false, EmitDefaultValue = false)] public object? CustomMetadataHas { get; set; } @@ -908,7 +920,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -921,7 +933,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( object? customMetadataHas = default, @@ -945,7 +957,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -957,7 +969,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( object? customMetadataHas = default, diff --git a/src/Seam/Api/ConnectedAccounts.cs b/src/Seam/Api/ConnectedAccounts.cs index ab35f5f4..3258faa2 100644 --- a/src/Seam/Api/ConnectedAccounts.cs +++ b/src/Seam/Api/ConnectedAccounts.cs @@ -59,7 +59,7 @@ public override string ToString() } /// - /// 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. /// @@ -73,7 +73,7 @@ public void Delete(DeleteRequest request) } /// - /// 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. /// @@ -85,7 +85,7 @@ public void Delete(string connectedAccountId = default) } /// - /// 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. /// @@ -99,7 +99,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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. /// @@ -199,7 +199,7 @@ public override string ToString() } /// - /// 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). /// public ConnectedAccount Get(GetRequest request) { @@ -212,7 +212,7 @@ public ConnectedAccount Get(GetRequest request) } /// - /// 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). /// public ConnectedAccount Get(string? connectedAccountId = default, string? email = default) { @@ -220,7 +220,7 @@ public ConnectedAccount Get(string? connectedAccountId = default, string? email } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -232,7 +232,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync( string? connectedAccountId = default, @@ -372,7 +372,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -385,7 +385,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( object? customMetadataHas = default, @@ -411,7 +411,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -423,7 +423,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( object? customMetadataHas = default, @@ -491,7 +491,7 @@ public override string ToString() } /// - /// 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`. /// public void Sync(SyncRequest request) { @@ -501,7 +501,7 @@ public void Sync(SyncRequest request) } /// - /// 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`. /// public void Sync(string connectedAccountId = default) { @@ -509,7 +509,7 @@ public void Sync(string connectedAccountId = default) } /// - /// 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`. /// public async Task SyncAsync(SyncRequest request) { @@ -519,7 +519,7 @@ public async Task SyncAsync(SyncRequest request) } /// - /// 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`. /// public async Task SyncAsync(string connectedAccountId = default) { @@ -588,7 +588,7 @@ public enum AcceptedCapabilitiesEnum public List? AcceptedCapabilities { get; set; } /// - /// Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + /// Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). /// [DataMember( Name = "automatically_manage_new_devices", @@ -604,7 +604,7 @@ public enum AcceptedCapabilitiesEnum public string ConnectedAccountId { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object? CustomMetadata { get; set; } @@ -642,7 +642,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -652,7 +652,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( List? acceptedCapabilities = default, @@ -676,7 +676,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -686,7 +686,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( List? acceptedCapabilities = default, diff --git a/src/Seam/Api/CredentialsAcs.cs b/src/Seam/Api/CredentialsAcs.cs index 5130261b..8398a1d8 100644 --- a/src/Seam/Api/CredentialsAcs.cs +++ b/src/Seam/Api/CredentialsAcs.cs @@ -77,7 +77,7 @@ public override string ToString() } /// - /// 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). /// public void Assign(AssignRequest request) { @@ -87,7 +87,7 @@ public void Assign(AssignRequest request) } /// - /// 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). /// public void Assign( string acsCredentialId = default, @@ -105,7 +105,7 @@ public void Assign( } /// - /// 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). /// public async Task AssignAsync(AssignRequest request) { @@ -115,7 +115,7 @@ public async Task AssignAsync(AssignRequest request) } /// - /// 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). /// public async Task AssignAsync( string acsCredentialId = default, @@ -213,7 +213,7 @@ public enum AccessMethodEnum public string? AcsUserId { get; set; } /// - /// 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. + /// 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. /// [DataMember( Name = "allowed_acs_entrance_ids", @@ -233,7 +233,7 @@ public enum AccessMethodEnum public CreateRequestAssaAbloyVostioMetadata? AssaAbloyVostioMetadata { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "code", IsRequired = false, EmitDefaultValue = false)] public string? Code { get; set; } @@ -255,7 +255,7 @@ public enum AccessMethodEnum public string? EndsAt { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "is_multi_phone_sync_credential", @@ -387,7 +387,7 @@ public CreateRequestSaltoSpaceMetadata(bool? assignNewKey = default) } /// - /// Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). + /// Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://www.seam.co/docs/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). /// [DataMember(Name = "assign_new_key", IsRequired = false, EmitDefaultValue = false)] public bool? AssignNewKey { get; set; } @@ -536,7 +536,7 @@ public override string ToString() } /// - /// 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. /// public AcsCredential Create(CreateRequest request) { @@ -549,7 +549,7 @@ public AcsCredential Create(CreateRequest request) } /// - /// 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. /// public AcsCredential Create( CreateRequest.AccessMethodEnum accessMethod = default, @@ -587,7 +587,7 @@ public AcsCredential Create( } /// - /// 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. /// public async Task CreateAsync(CreateRequest request) { @@ -601,7 +601,7 @@ await _seam.PostAsync("/acs/credentials/create", requestOptions) } /// - /// 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. /// public async Task CreateAsync( CreateRequest.AccessMethodEnum accessMethod = default, @@ -681,7 +681,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -691,7 +691,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string acsCredentialId = default) { @@ -699,7 +699,7 @@ public void Delete(string acsCredentialId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -709,7 +709,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string acsCredentialId = default) { @@ -794,7 +794,7 @@ public override string ToString() } /// - /// 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). /// public AcsCredential Get(GetRequest request) { @@ -807,7 +807,7 @@ public AcsCredential Get(GetRequest request) } /// - /// 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). /// public AcsCredential Get(string acsCredentialId = default) { @@ -815,7 +815,7 @@ public AcsCredential Get(string acsCredentialId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -827,7 +827,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string acsCredentialId = default) { @@ -974,7 +974,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -987,7 +987,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? acsSystemId = default, @@ -1015,7 +1015,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -1027,7 +1027,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? acsSystemId = default, @@ -1134,7 +1134,7 @@ public override string ToString() } /// - /// 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. /// public List ListAccessibleEntrances(ListAccessibleEntrancesRequest request) { @@ -1150,7 +1150,7 @@ public List ListAccessibleEntrances(ListAccessibleEntrancesRequest } /// - /// 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. /// public List ListAccessibleEntrances(string acsCredentialId = default) { @@ -1160,7 +1160,7 @@ public List ListAccessibleEntrances(string acsCredentialId = defaul } /// - /// 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. /// public async Task> ListAccessibleEntrancesAsync( ListAccessibleEntrancesRequest request @@ -1179,7 +1179,7 @@ await _seam.GetAsync( } /// - /// 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. /// public async Task> ListAccessibleEntrancesAsync( string acsCredentialId = default @@ -1251,7 +1251,7 @@ public override string ToString() } /// - /// 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). /// public void Unassign(UnassignRequest request) { @@ -1261,7 +1261,7 @@ public void Unassign(UnassignRequest request) } /// - /// 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). /// public void Unassign( string acsCredentialId = default, @@ -1279,7 +1279,7 @@ public void Unassign( } /// - /// 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). /// public async Task UnassignAsync(UnassignRequest request) { @@ -1289,7 +1289,7 @@ public async Task UnassignAsync(UnassignRequest request) } /// - /// 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). /// public async Task UnassignAsync( string acsCredentialId = default, @@ -1365,7 +1365,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -1375,7 +1375,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( string acsCredentialId = default, @@ -1387,7 +1387,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -1397,7 +1397,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( string acsCredentialId = default, diff --git a/src/Seam/Api/Customers.cs b/src/Seam/Api/Customers.cs index cd8c0ba5..f66be24b 100644 --- a/src/Seam/Api/Customers.cs +++ b/src/Seam/Api/Customers.cs @@ -2144,6 +2144,9 @@ public enum ResourceTypeEnum [EnumMember(Value = "device")] Device = 3, + + [EnumMember(Value = "acs_entrance")] + AcsEntrance = 4, } [DataMember(Name = "resource_id", IsRequired = false, EmitDefaultValue = false)] diff --git a/src/Seam/Api/DailyProgramsThermostats.cs b/src/Seam/Api/DailyProgramsThermostats.cs index a1752068..01a5d173 100644 --- a/src/Seam/Api/DailyProgramsThermostats.cs +++ b/src/Seam/Api/DailyProgramsThermostats.cs @@ -92,7 +92,7 @@ public CreateRequestPeriods( } /// - /// 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`. /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string? ClimatePresetKey { get; set; } @@ -382,7 +382,7 @@ public UpdateRequestPeriods( } /// - /// 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`. /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string? ClimatePresetKey { get; set; } diff --git a/src/Seam/Api/Devices.cs b/src/Seam/Api/Devices.cs index 88e3f917..8e273d4b 100644 --- a/src/Seam/Api/Devices.cs +++ b/src/Seam/Api/Devices.cs @@ -103,7 +103,7 @@ public override string ToString() } /// - /// 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`. /// @@ -118,7 +118,7 @@ public Device Get(GetRequest request) } /// - /// 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`. /// @@ -128,7 +128,7 @@ public Device Get(string? deviceId = default, string? name = default) } /// - /// 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`. /// @@ -142,7 +142,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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`. /// @@ -334,6 +334,15 @@ public enum DeviceTypeEnum [EnumMember(Value = "ring_camera")] RingCamera = 43, + + [EnumMember(Value = "tapo_camera")] + TapoCamera = 44, + + [EnumMember(Value = "arlo_camera")] + ArloCamera = 45, + + [EnumMember(Value = "reolink_camera")] + ReolinkCamera = 46, } /// @@ -473,6 +482,15 @@ public enum DeviceTypesEnum [EnumMember(Value = "ring_camera")] RingCamera = 43, + + [EnumMember(Value = "tapo_camera")] + TapoCamera = 44, + + [EnumMember(Value = "arlo_camera")] + ArloCamera = 45, + + [EnumMember(Value = "reolink_camera")] + ReolinkCamera = 46, } /// @@ -559,86 +577,101 @@ public enum ManufacturerEnum [EnumMember(Value = "controlbyweb")] Controlbyweb = 25, - [EnumMember(Value = "dormakaba_oracode")] - DormakabaOracode = 26, - [EnumMember(Value = "tedee")] - Tedee = 27, + Tedee = 26, [EnumMember(Value = "keyincode")] - Keyincode = 28, + Keyincode = 27, [EnumMember(Value = "akiles")] - Akiles = 29, + Akiles = 28, [EnumMember(Value = "aqara")] - Aqara = 30, + Aqara = 29, [EnumMember(Value = "ecobee")] - Ecobee = 31, + Ecobee = 30, + + [EnumMember(Value = "eufy")] + Eufy = 31, + + [EnumMember(Value = "dormakaba_oracode")] + DormakabaOracode = 32, + + [EnumMember(Value = "dormakaba_oracode_iho")] + DormakabaOracodeIho = 33, [EnumMember(Value = "honeywell_resideo")] - HoneywellResideo = 32, + HoneywellResideo = 34, [EnumMember(Value = "keynest")] - Keynest = 33, + Keynest = 35, [EnumMember(Value = "korelock")] - Korelock = 34, + Korelock = 36, [EnumMember(Value = "lockly")] - Lockly = 35, + Lockly = 37, [EnumMember(Value = "minut")] - Minut = 36, + Minut = 38, [EnumMember(Value = "nest")] - Nest = 37, + Nest = 39, [EnumMember(Value = "noiseaware")] - Noiseaware = 38, + Noiseaware = 40, [EnumMember(Value = "sensi")] - Sensi = 39, + Sensi = 41, [EnumMember(Value = "smartthings")] - Smartthings = 40, + Smartthings = 42, [EnumMember(Value = "tado")] - Tado = 41, + Tado = 43, [EnumMember(Value = "ultraloq")] - Ultraloq = 42, + Ultraloq = 44, [EnumMember(Value = "ring")] - Ring = 43, + Ring = 45, + + [EnumMember(Value = "tapo")] + Tapo = 46, + + [EnumMember(Value = "arlo")] + Arlo = 47, + + [EnumMember(Value = "reolink")] + Reolink = 48, [EnumMember(Value = "ical")] - Ical = 44, + Ical = 49, [EnumMember(Value = "lodgify")] - Lodgify = 45, + Lodgify = 50, [EnumMember(Value = "hostaway")] - Hostaway = 46, + Hostaway = 51, [EnumMember(Value = "guesty")] - Guesty = 47, + Guesty = 52, [EnumMember(Value = "acuity_scheduling")] - AcuityScheduling = 48, + AcuityScheduling = 53, [EnumMember(Value = "omnitec")] - Omnitec = 49, + Omnitec = 54, [EnumMember(Value = "kisi")] - Kisi = 50, + Kisi = 55, [EnumMember(Value = "slack")] - Slack = 51, + Slack = 56, [EnumMember(Value = "yacan")] - Yacan = 52, + Yacan = 57, } /// @@ -674,7 +707,7 @@ public enum ManufacturerEnum public string? CreatedBefore { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "custom_metadata_has", IsRequired = false, EmitDefaultValue = false)] public object? CustomMetadataHas { get; set; } @@ -805,7 +838,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -818,7 +851,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? connectWebviewId = default, @@ -862,7 +895,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -874,7 +907,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? connectWebviewId = default, @@ -1035,9 +1068,9 @@ public override string ToString() /// /// 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). /// public List ListDeviceProviders(ListDeviceProvidersRequest request) { @@ -1052,9 +1085,9 @@ public List ListDeviceProviders(ListDeviceProvidersRequest reque /// /// 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). /// public List ListDeviceProviders( ListDeviceProvidersRequest.ProviderCategoryEnum? providerCategory = default @@ -1068,9 +1101,9 @@ public List ListDeviceProviders( /// /// 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). /// public async Task> ListDeviceProvidersAsync( ListDeviceProvidersRequest request @@ -1091,9 +1124,9 @@ await _seam.GetAsync( /// /// 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). /// public async Task> ListDeviceProvidersAsync( ListDeviceProvidersRequest.ProviderCategoryEnum? providerCategory = default @@ -5287,7 +5320,7 @@ public UpdateRequest( } /// - /// 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. + /// 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. /// [DataMember( Name = "backup_access_code_pool_enabled", @@ -5297,7 +5330,7 @@ public UpdateRequest( public bool? BackupAccessCodePoolEnabled { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object? CustomMetadata { get; set; } @@ -5381,9 +5414,9 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -5393,9 +5426,9 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( bool? backupAccessCodePoolEnabled = default, @@ -5419,9 +5452,9 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -5431,9 +5464,9 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( bool? backupAccessCodePoolEnabled = default, diff --git a/src/Seam/Api/EncodersAcs.cs b/src/Seam/Api/EncodersAcs.cs index 59bfb74f..aa1d8873 100644 --- a/src/Seam/Api/EncodersAcs.cs +++ b/src/Seam/Api/EncodersAcs.cs @@ -114,7 +114,7 @@ public override string ToString() } /// - /// 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` /// public ActionAttempt EncodeCredential(EncodeCredentialRequest request) { @@ -127,7 +127,7 @@ public ActionAttempt EncodeCredential(EncodeCredentialRequest request) } /// - /// 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` /// public ActionAttempt EncodeCredential( string? accessMethodId = default, @@ -145,7 +145,7 @@ public ActionAttempt EncodeCredential( } /// - /// 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` /// public async Task EncodeCredentialAsync(EncodeCredentialRequest request) { @@ -162,7 +162,7 @@ await _seam.PostAsync( } /// - /// 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` /// public async Task EncodeCredentialAsync( string? accessMethodId = default, @@ -259,7 +259,7 @@ public override string ToString() } /// - /// 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). /// public AcsEncoder Get(GetRequest request) { @@ -272,7 +272,7 @@ public AcsEncoder Get(GetRequest request) } /// - /// 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). /// public AcsEncoder Get(string acsEncoderId = default) { @@ -280,7 +280,7 @@ public AcsEncoder Get(string acsEncoderId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -292,7 +292,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string acsEncoderId = default) { @@ -411,7 +411,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -424,7 +424,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( List? acsEncoderIds = default, @@ -446,7 +446,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -458,7 +458,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( List? acsEncoderIds = default, @@ -606,7 +606,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt ScanCredential(ScanCredentialRequest request) { @@ -619,7 +619,7 @@ public ActionAttempt ScanCredential(ScanCredentialRequest request) } /// - /// 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). /// public ActionAttempt ScanCredential( string acsEncoderId = default, @@ -635,7 +635,7 @@ public ActionAttempt ScanCredential( } /// - /// 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). /// public async Task ScanCredentialAsync(ScanCredentialRequest request) { @@ -652,7 +652,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task ScanCredentialAsync( string acsEncoderId = default, @@ -810,7 +810,7 @@ public override string ToString() } /// - /// 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`. /// public ActionAttempt ScanToAssignCredential(ScanToAssignCredentialRequest request) { @@ -826,7 +826,7 @@ public ActionAttempt ScanToAssignCredential(ScanToAssignCredentialRequest reques } /// - /// 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`. /// public ActionAttempt ScanToAssignCredential( string acsEncoderId = default, @@ -846,7 +846,7 @@ public ActionAttempt ScanToAssignCredential( } /// - /// 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`. /// public async Task ScanToAssignCredentialAsync( ScanToAssignCredentialRequest request @@ -865,7 +865,7 @@ await _seam.PostAsync( } /// - /// 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`. /// public async Task ScanToAssignCredentialAsync( string acsEncoderId = default, diff --git a/src/Seam/Api/EntrancesAcs.cs b/src/Seam/Api/EntrancesAcs.cs index 1f9bac64..cbcbb151 100644 --- a/src/Seam/Api/EntrancesAcs.cs +++ b/src/Seam/Api/EntrancesAcs.cs @@ -96,7 +96,7 @@ public override string ToString() } /// - /// 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). /// public AcsEntrance Get(GetRequest request) { @@ -109,7 +109,7 @@ public AcsEntrance Get(GetRequest request) } /// - /// 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). /// public AcsEntrance Get(string acsEntranceId = default) { @@ -117,7 +117,7 @@ public AcsEntrance Get(string acsEntranceId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -129,7 +129,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string acsEntranceId = default) { @@ -195,7 +195,7 @@ public override string ToString() } /// - /// 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). /// public void GrantAccess(GrantAccessRequest request) { @@ -205,7 +205,7 @@ public void GrantAccess(GrantAccessRequest request) } /// - /// 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). /// public void GrantAccess( string acsEntranceId = default, @@ -223,7 +223,7 @@ public void GrantAccess( } /// - /// 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). /// public async Task GrantAccessAsync(GrantAccessRequest request) { @@ -233,7 +233,7 @@ public async Task GrantAccessAsync(GrantAccessRequest request) } /// - /// 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). /// public async Task GrantAccessAsync( string acsEntranceId = default, @@ -412,7 +412,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -425,7 +425,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? accessMethodId = default, @@ -459,7 +459,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -471,7 +471,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? accessMethodId = default, @@ -607,7 +607,7 @@ public override string ToString() } /// - /// 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). /// public List ListCredentialsWithAccess( ListCredentialsWithAccessRequest request @@ -625,7 +625,7 @@ ListCredentialsWithAccessRequest request } /// - /// 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). /// public List ListCredentialsWithAccess( string acsEntranceId = default, @@ -641,7 +641,7 @@ public List ListCredentialsWithAccess( } /// - /// 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). /// public async Task> ListCredentialsWithAccessAsync( ListCredentialsWithAccessRequest request @@ -660,7 +660,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListCredentialsWithAccessAsync( string acsEntranceId = default, @@ -762,7 +762,7 @@ public override string ToString() } /// - /// 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. /// public ActionAttempt Unlock(UnlockRequest request) { @@ -775,7 +775,7 @@ public ActionAttempt Unlock(UnlockRequest request) } /// - /// 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. /// public ActionAttempt Unlock( string acsCredentialId = default, @@ -788,7 +788,7 @@ public ActionAttempt Unlock( } /// - /// 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. /// public async Task UnlockAsync(UnlockRequest request) { @@ -800,7 +800,7 @@ public async Task UnlockAsync(UnlockRequest request) } /// - /// 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. /// public async Task UnlockAsync( string acsCredentialId = default, diff --git a/src/Seam/Api/Events.cs b/src/Seam/Api/Events.cs index 25eda9fb..7ee4360e 100644 --- a/src/Seam/Api/Events.cs +++ b/src/Seam/Api/Events.cs @@ -114,7 +114,7 @@ public override string ToString() } /// - /// 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. /// public Event Get(GetRequest request) { @@ -127,7 +127,7 @@ public Event Get(GetRequest request) } /// - /// 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. /// public Event Get( string? deviceId = default, @@ -139,7 +139,7 @@ public Event Get( } /// - /// 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. /// public async Task GetAsync(GetRequest request) { @@ -151,7 +151,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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. /// public async Task GetAsync( string? deviceId = default, @@ -290,8 +290,8 @@ public enum EventTypeEnum [EnumMember(Value = "access_code.failed_to_update")] AccessCodeFailedToUpdate = 15, - [EnumMember(Value = "access_code.failed_to_expire")] - AccessCodeFailedToExpire = 16, + [EnumMember(Value = "access_code.failed_to_delete")] + AccessCodeFailedToDelete = 16, [EnumMember(Value = "access_code.deleted")] AccessCodeDeleted = 17, @@ -642,8 +642,8 @@ public enum EventTypesEnum [EnumMember(Value = "access_code.failed_to_update")] AccessCodeFailedToUpdate = 15, - [EnumMember(Value = "access_code.failed_to_expire")] - AccessCodeFailedToExpire = 16, + [EnumMember(Value = "access_code.failed_to_delete")] + AccessCodeFailedToDelete = 16, [EnumMember(Value = "access_code.deleted")] AccessCodeDeleted = 17, @@ -1170,7 +1170,7 @@ public override string ToString() } /// - /// 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. /// public List List(ListRequest request) { @@ -1183,7 +1183,7 @@ public List List(ListRequest request) } /// - /// 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. /// public List List( string? accessCodeId = default, @@ -1251,7 +1251,7 @@ public List List( } /// - /// 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. /// public async Task> ListAsync(ListRequest request) { @@ -1263,7 +1263,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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. /// public async Task> ListAsync( string? accessCodeId = default, diff --git a/src/Seam/Api/InstantKeys.cs b/src/Seam/Api/InstantKeys.cs index c64a564e..49f0047e 100644 --- a/src/Seam/Api/InstantKeys.cs +++ b/src/Seam/Api/InstantKeys.cs @@ -59,7 +59,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -69,7 +69,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string instantKeyId = default) { @@ -77,7 +77,7 @@ public void Delete(string instantKeyId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -87,7 +87,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string instantKeyId = default) { @@ -179,7 +179,7 @@ public override string ToString() } /// - /// 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). /// public InstantKey Get(GetRequest request) { @@ -192,7 +192,7 @@ public InstantKey Get(GetRequest request) } /// - /// 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). /// public InstantKey Get(string? instantKeyId = default, string? instantKeyUrl = default) { @@ -200,7 +200,7 @@ public InstantKey Get(string? instantKeyId = default, string? instantKeyUrl = de } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -212,7 +212,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync( string? instantKeyId = default, @@ -304,7 +304,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -317,7 +317,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List(string? userIdentityId = default) { @@ -325,7 +325,7 @@ public List List(string? userIdentityId = default) } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -337,7 +337,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync(string? userIdentityId = default) { diff --git a/src/Seam/Api/LiveViewsCameras.cs b/src/Seam/Api/LiveViewsCameras.cs new file mode 100644 index 00000000..8f31a69a --- /dev/null +++ b/src/Seam/Api/LiveViewsCameras.cs @@ -0,0 +1,482 @@ +using System.Runtime.Serialization; +using System.Text; +using JsonSubTypes; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using Seam.Client; +using Seam.Model; + +namespace Seam.Api +{ + public class LiveViewsCameras + { + private ISeamClient _seam; + + public LiveViewsCameras(ISeamClient seam) + { + _seam = seam; + } + + /// + /// Request parameters for Create a Camera Live View Session. + /// + [DataContract(Name = "createRequest_request")] + public class CreateRequest + { + [JsonConstructorAttribute] + protected CreateRequest() { } + + public CreateRequest( + string deviceId = default, + int? durationSeconds = default, + bool? includeAudio = default + ) + { + DeviceId = deviceId; + DurationSeconds = durationSeconds; + IncludeAudio = includeAudio; + } + + /// + /// ID of the camera to view. + /// + [DataMember(Name = "device_id", IsRequired = true, EmitDefaultValue = false)] + public string DeviceId { get; set; } + + /// + /// Number of seconds for which the live view session is valid, up to 600. + /// + [DataMember(Name = "duration_seconds", IsRequired = false, EmitDefaultValue = false)] + public int? DurationSeconds { get; set; } + + /// + /// Indicates whether to include the camera's audio. + /// + [DataMember(Name = "include_audio", IsRequired = false, EmitDefaultValue = false)] + public bool? IncludeAudio { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "createResponse_response")] + public class CreateResponse + { + [JsonConstructorAttribute] + protected CreateResponse() { } + + public CreateResponse(CameraLiveViewSession cameraLiveViewSession = default) + { + CameraLiveViewSession = cameraLiveViewSession; + } + + /// + /// OK + /// + [DataMember( + Name = "camera_live_view_session", + IsRequired = false, + EmitDefaultValue = false + )] + public CameraLiveViewSession CameraLiveViewSession { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + /// + /// Creates a short-lived live view session for a single camera. Pass the returned session ID and token to `/cameras/live_views/offer` to start a WebRTC stream, and to `/cameras/live_views/stop` to end the session. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. To check whether a camera supports live view, use `device.can_stream_live_video`. + /// + public CameraLiveViewSession Create(CreateRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return _seam + .Post("/cameras/live_views/create", requestOptions) + .EnsureData("/cameras/live_views/create") + .CameraLiveViewSession; + } + + /// + /// Creates a short-lived live view session for a single camera. Pass the returned session ID and token to `/cameras/live_views/offer` to start a WebRTC stream, and to `/cameras/live_views/stop` to end the session. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. To check whether a camera supports live view, use `device.can_stream_live_video`. + /// + public CameraLiveViewSession Create( + string deviceId = default, + int? durationSeconds = default, + bool? includeAudio = default + ) + { + return Create( + new CreateRequest( + deviceId: deviceId, + durationSeconds: durationSeconds, + includeAudio: includeAudio + ) + ); + } + + /// + /// Creates a short-lived live view session for a single camera. Pass the returned session ID and token to `/cameras/live_views/offer` to start a WebRTC stream, and to `/cameras/live_views/stop` to end the session. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. To check whether a camera supports live view, use `device.can_stream_live_video`. + /// + public async Task CreateAsync(CreateRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return ( + await _seam.PostAsync("/cameras/live_views/create", requestOptions) + ) + .EnsureData("/cameras/live_views/create") + .CameraLiveViewSession; + } + + /// + /// Creates a short-lived live view session for a single camera. Pass the returned session ID and token to `/cameras/live_views/offer` to start a WebRTC stream, and to `/cameras/live_views/stop` to end the session. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. To check whether a camera supports live view, use `device.can_stream_live_video`. + /// + public async Task CreateAsync( + string deviceId = default, + int? durationSeconds = default, + bool? includeAudio = default + ) + { + return ( + await CreateAsync( + new CreateRequest( + deviceId: deviceId, + durationSeconds: durationSeconds, + includeAudio: includeAudio + ) + ) + ); + } + + /// + /// Request parameters for Negotiate a Camera Live View. + /// + [DataContract(Name = "offerRequest_request")] + public class OfferRequest + { + [JsonConstructorAttribute] + protected OfferRequest() { } + + public OfferRequest( + string cameraLiveViewSessionId = default, + string sdpOffer = default, + string token = default + ) + { + CameraLiveViewSessionId = cameraLiveViewSessionId; + SdpOffer = sdpOffer; + Token = token; + } + + /// + /// ID of the camera live view session. + /// + [DataMember( + Name = "camera_live_view_session_id", + IsRequired = true, + EmitDefaultValue = false + )] + public string CameraLiveViewSessionId { get; set; } + + /// + /// WebRTC SDP offer from the viewer, limited to 64 KiB of UTF-8 data. + /// + [DataMember(Name = "sdp_offer", IsRequired = true, EmitDefaultValue = false)] + public string SdpOffer { get; set; } + + /// + /// Token returned when the camera live view session was created. + /// + [DataMember(Name = "token", IsRequired = true, EmitDefaultValue = false)] + public string Token { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "offerResponse_response")] + public class OfferResponse + { + [JsonConstructorAttribute] + protected OfferResponse() { } + + public OfferResponse(CameraLiveViewAnswer cameraLiveViewAnswer = default) + { + CameraLiveViewAnswer = cameraLiveViewAnswer; + } + + /// + /// OK + /// + [DataMember( + Name = "camera_live_view_answer", + IsRequired = false, + EmitDefaultValue = false + )] + public CameraLiveViewAnswer CameraLiveViewAnswer { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + /// + /// Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using `/cameras/live_views/create`. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public CameraLiveViewAnswer Offer(OfferRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return _seam + .Post("/cameras/live_views/offer", requestOptions) + .EnsureData("/cameras/live_views/offer") + .CameraLiveViewAnswer; + } + + /// + /// Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using `/cameras/live_views/create`. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public CameraLiveViewAnswer Offer( + string cameraLiveViewSessionId = default, + string sdpOffer = default, + string token = default + ) + { + return Offer( + new OfferRequest( + cameraLiveViewSessionId: cameraLiveViewSessionId, + sdpOffer: sdpOffer, + token: token + ) + ); + } + + /// + /// Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using `/cameras/live_views/create`. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public async Task OfferAsync(OfferRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return ( + await _seam.PostAsync("/cameras/live_views/offer", requestOptions) + ) + .EnsureData("/cameras/live_views/offer") + .CameraLiveViewAnswer; + } + + /// + /// Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using `/cameras/live_views/create`. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public async Task OfferAsync( + string cameraLiveViewSessionId = default, + string sdpOffer = default, + string token = default + ) + { + return ( + await OfferAsync( + new OfferRequest( + cameraLiveViewSessionId: cameraLiveViewSessionId, + sdpOffer: sdpOffer, + token: token + ) + ) + ); + } + + /// + /// Request parameters for Stop a Camera Live View Session. + /// + [DataContract(Name = "stopRequest_request")] + public class StopRequest + { + [JsonConstructorAttribute] + protected StopRequest() { } + + public StopRequest(string cameraLiveViewSessionId = default, string token = default) + { + CameraLiveViewSessionId = cameraLiveViewSessionId; + Token = token; + } + + /// + /// ID of the camera live view session. + /// + [DataMember( + Name = "camera_live_view_session_id", + IsRequired = true, + EmitDefaultValue = false + )] + public string CameraLiveViewSessionId { get; set; } + + /// + /// Token returned when the camera live view session was created. + /// + [DataMember(Name = "token", IsRequired = true, EmitDefaultValue = false)] + public string Token { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + /// + /// Stops a camera live view session that the current client session owns. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public void Stop(StopRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + _seam.Post("/cameras/live_views/stop", requestOptions); + } + + /// + /// Stops a camera live view session that the current client session owns. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public void Stop(string cameraLiveViewSessionId = default, string token = default) + { + Stop(new StopRequest(cameraLiveViewSessionId: cameraLiveViewSessionId, token: token)); + } + + /// + /// Stops a camera live view session that the current client session owns. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public async Task StopAsync(StopRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + await _seam.PostAsync("/cameras/live_views/stop", requestOptions); + } + + /// + /// Stops a camera live view session that the current client session owns. + /// + /// Camera live view is in beta. To enable it for your workspace, contact Seam support. + /// + public async Task StopAsync( + string cameraLiveViewSessionId = default, + string token = default + ) + { + await StopAsync( + new StopRequest(cameraLiveViewSessionId: cameraLiveViewSessionId, token: token) + ); + } + } +} + +namespace Seam.Client +{ + public partial class SeamClient + { + public Api.LiveViewsCameras LiveViewsCameras => new(this); + } + + public partial interface ISeamClient + { + public Api.LiveViewsCameras LiveViewsCameras { get; } + } +} diff --git a/src/Seam/Api/Locks.cs b/src/Seam/Api/Locks.cs index 5f5e8a5f..1fbd9d6e 100644 --- a/src/Seam/Api/Locks.cs +++ b/src/Seam/Api/Locks.cs @@ -118,7 +118,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt ConfigureAutoLock(ConfigureAutoLockRequest request) { @@ -131,7 +131,7 @@ public ActionAttempt ConfigureAutoLock(ConfigureAutoLockRequest request) } /// - /// 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). /// public ActionAttempt ConfigureAutoLock( float? autoLockDelaySeconds = default, @@ -149,7 +149,7 @@ public ActionAttempt ConfigureAutoLock( } /// - /// 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). /// public async Task ConfigureAutoLockAsync(ConfigureAutoLockRequest request) { @@ -166,7 +166,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task ConfigureAutoLockAsync( float? autoLockDelaySeconds = default, @@ -271,7 +271,7 @@ public override string ToString() } /// - /// 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). /// [Obsolete("Use `/devices/get` instead.")] public Device Get(GetRequest request) @@ -285,7 +285,7 @@ public Device Get(GetRequest request) } /// - /// 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). /// [Obsolete("Use `/devices/get` instead.")] public Device Get(string? deviceId = default, string? name = default) @@ -294,7 +294,7 @@ public Device Get(string? deviceId = default, string? name = default) } /// - /// 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). /// [Obsolete("Use `/devices/get` instead.")] public async Task GetAsync(GetRequest request) @@ -307,7 +307,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// [Obsolete("Use `/devices/get` instead.")] public async Task GetAsync(string? deviceId = default, string? name = default) @@ -619,41 +619,47 @@ public enum ManufacturerEnum [EnumMember(Value = "four_suites")] FourSuites = 21, - [EnumMember(Value = "dormakaba_oracode")] - DormakabaOracode = 22, - [EnumMember(Value = "tedee")] - Tedee = 23, + Tedee = 22, [EnumMember(Value = "keyincode")] - Keyincode = 24, + Keyincode = 23, [EnumMember(Value = "akiles")] - Akiles = 25, + Akiles = 24, [EnumMember(Value = "aqara")] - Aqara = 26, + Aqara = 25, + + [EnumMember(Value = "eufy")] + Eufy = 26, + + [EnumMember(Value = "dormakaba_oracode")] + DormakabaOracode = 27, + + [EnumMember(Value = "dormakaba_oracode_iho")] + DormakabaOracodeIho = 28, [EnumMember(Value = "korelock")] - Korelock = 27, + Korelock = 29, [EnumMember(Value = "lockly")] - Lockly = 28, + Lockly = 30, [EnumMember(Value = "smartthings")] - Smartthings = 29, + Smartthings = 31, [EnumMember(Value = "ultraloq")] - Ultraloq = 30, + Ultraloq = 32, [EnumMember(Value = "omnitec")] - Omnitec = 31, + Omnitec = 33, [EnumMember(Value = "kisi")] - Kisi = 32, + Kisi = 34, [EnumMember(Value = "yacan")] - Yacan = 33, + Yacan = 35, } /// @@ -754,7 +760,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -767,7 +773,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? connectWebviewId = default, @@ -791,7 +797,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -803,7 +809,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? connectWebviewId = default, @@ -906,7 +912,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt LockDoor(LockDoorRequest request) { @@ -919,7 +925,7 @@ public ActionAttempt LockDoor(LockDoorRequest request) } /// - /// 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). /// public ActionAttempt LockDoor(string deviceId = default) { @@ -927,7 +933,7 @@ public ActionAttempt LockDoor(string deviceId = default) } /// - /// 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). /// public async Task LockDoorAsync(LockDoorRequest request) { @@ -939,7 +945,7 @@ public async Task LockDoorAsync(LockDoorRequest request) } /// - /// 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). /// public async Task LockDoorAsync(string deviceId = default) { @@ -1024,7 +1030,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt UnlockDoor(UnlockDoorRequest request) { @@ -1037,7 +1043,7 @@ public ActionAttempt UnlockDoor(UnlockDoorRequest request) } /// - /// 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). /// public ActionAttempt UnlockDoor(string deviceId = default) { @@ -1045,7 +1051,7 @@ public ActionAttempt UnlockDoor(string deviceId = default) } /// - /// 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). /// public async Task UnlockDoorAsync(UnlockDoorRequest request) { @@ -1057,7 +1063,7 @@ public async Task UnlockDoorAsync(UnlockDoorRequest request) } /// - /// 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). /// public async Task UnlockDoorAsync(string deviceId = default) { diff --git a/src/Seam/Api/Media.cs b/src/Seam/Api/Media.cs new file mode 100644 index 00000000..d45aea10 --- /dev/null +++ b/src/Seam/Api/Media.cs @@ -0,0 +1,181 @@ +using System.Runtime.Serialization; +using System.Text; +using JsonSubTypes; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using Seam.Client; +using Seam.Model; + +namespace Seam.Api +{ + public class Media + { + private ISeamClient _seam; + + public Media(ISeamClient seam) + { + _seam = seam; + } + + /// + /// Request parameters for Get Media. + /// + [DataContract(Name = "getRequest_request")] + public class GetRequest + { + [JsonConstructorAttribute] + protected GetRequest() { } + + public GetRequest(GetRequest.FormatEnum? format = default, string mediaId = default) + { + Format = format; + MediaId = mediaId; + } + + /// + /// Response format. `json` returns the media object. `redirect` responds with a `302` redirect to the media's download URL, so you can use this endpoint directly as the source of an image or video. + /// + [JsonConverter(typeof(SafeStringEnumConverter))] + public enum FormatEnum + { + [EnumMember(Value = "unrecognized")] + Unrecognized = 0, + + [EnumMember(Value = "json")] + Json = 1, + + [EnumMember(Value = "redirect")] + Redirect = 2, + } + + /// + /// Response format. `json` returns the media object. `redirect` responds with a `302` redirect to the media's download URL, so you can use this endpoint directly as the source of an image or video. + /// + [DataMember(Name = "format", IsRequired = false, EmitDefaultValue = false)] + public GetRequest.FormatEnum? Format { get; set; } + + /// + /// ID of the media that you want to get. + /// + [DataMember(Name = "media_id", IsRequired = true, EmitDefaultValue = false)] + public string MediaId { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "getResponse_response")] + public class GetResponse + { + [JsonConstructorAttribute] + protected GetResponse() { } + + public GetResponse(Seam.Model.Media media = default) + { + Media = media; + } + + /// + /// OK + /// + [DataMember(Name = "media", IsRequired = false, EmitDefaultValue = false)] + public Seam.Model.Media Media { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + /// + /// Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in `media_ids`. This endpoint is in beta. + /// + public Seam.Model.Media Get(GetRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return _seam + .Get("/media/get", requestOptions) + .EnsureData("/media/get") + .Media; + } + + /// + /// Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in `media_ids`. This endpoint is in beta. + /// + public Seam.Model.Media Get( + GetRequest.FormatEnum? format = default, + string mediaId = default + ) + { + return Get(new GetRequest(format: format, mediaId: mediaId)); + } + + /// + /// Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in `media_ids`. This endpoint is in beta. + /// + public async Task GetAsync(GetRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return (await _seam.GetAsync("/media/get", requestOptions)) + .EnsureData("/media/get") + .Media; + } + + /// + /// Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in `media_ids`. This endpoint is in beta. + /// + public async Task GetAsync( + GetRequest.FormatEnum? format = default, + string mediaId = default + ) + { + return (await GetAsync(new GetRequest(format: format, mediaId: mediaId))); + } + } +} + +namespace Seam.Client +{ + public partial class SeamClient + { + public Api.Media Media => new(this); + } + + public partial interface ISeamClient + { + public Api.Media Media { get; } + } +} diff --git a/src/Seam/Api/NoiseSensors.cs b/src/Seam/Api/NoiseSensors.cs index ce85bf8e..c184a935 100644 --- a/src/Seam/Api/NoiseSensors.cs +++ b/src/Seam/Api/NoiseSensors.cs @@ -190,7 +190,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -203,7 +203,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? connectWebviewId = default, @@ -227,7 +227,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -239,7 +239,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? connectWebviewId = default, diff --git a/src/Seam/Api/NoiseThresholdsNoiseSensors.cs b/src/Seam/Api/NoiseThresholdsNoiseSensors.cs index 5d60d24d..23bd5513 100644 --- a/src/Seam/Api/NoiseThresholdsNoiseSensors.cs +++ b/src/Seam/Api/NoiseThresholdsNoiseSensors.cs @@ -73,7 +73,7 @@ public CreateRequest( public float? NoiseThresholdDecibels { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "noise_threshold_nrs", IsRequired = false, EmitDefaultValue = false)] public float? NoiseThresholdNrs { get; set; } @@ -142,7 +142,7 @@ public override string ToString() } /// - /// 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. /// public NoiseThreshold Create(CreateRequest request) { @@ -155,7 +155,7 @@ public NoiseThreshold Create(CreateRequest request) } /// - /// 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. /// public NoiseThreshold Create( string deviceId = default, @@ -179,7 +179,7 @@ public NoiseThreshold Create( } /// - /// 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. /// public async Task CreateAsync(CreateRequest request) { @@ -196,7 +196,7 @@ await _seam.PostAsync( } /// - /// 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. /// public async Task CreateAsync( string deviceId = default, @@ -269,7 +269,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -279,7 +279,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string deviceId = default, string noiseThresholdId = default) { @@ -287,7 +287,7 @@ public void Delete(string deviceId = default, string noiseThresholdId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -300,7 +300,7 @@ await _seam.DeleteAsync( } /// - /// 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). /// public async Task DeleteAsync(string deviceId = default, string noiseThresholdId = default) { @@ -387,7 +387,7 @@ public override string ToString() } /// - /// 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). /// public NoiseThreshold Get(GetRequest request) { @@ -400,7 +400,7 @@ public NoiseThreshold Get(GetRequest request) } /// - /// 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). /// public NoiseThreshold Get(string noiseThresholdId = default) { @@ -408,7 +408,7 @@ public NoiseThreshold Get(string noiseThresholdId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -425,7 +425,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task GetAsync(string noiseThresholdId = default) { @@ -510,7 +510,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -523,7 +523,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List(string deviceId = default) { @@ -531,7 +531,7 @@ public List List(string deviceId = default) } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -548,7 +548,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListAsync(string deviceId = default) { @@ -618,7 +618,7 @@ public UpdateRequest( public string NoiseThresholdId { get; set; } /// - /// 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). /// [DataMember(Name = "noise_threshold_nrs", IsRequired = false, EmitDefaultValue = false)] public float? NoiseThresholdNrs { get; set; } @@ -650,7 +650,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -660,7 +660,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( string deviceId = default, @@ -686,7 +686,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -699,7 +699,7 @@ await _seam.PatchAsync( } /// - /// 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). /// public async Task UpdateAsync( string deviceId = default, diff --git a/src/Seam/Api/Phones.cs b/src/Seam/Api/Phones.cs index 215784be..a5b45b3e 100644 --- a/src/Seam/Api/Phones.cs +++ b/src/Seam/Api/Phones.cs @@ -59,7 +59,7 @@ public override string ToString() } /// - /// 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). /// public void Deactivate(DeactivateRequest request) { @@ -69,7 +69,7 @@ public void Deactivate(DeactivateRequest request) } /// - /// 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). /// public void Deactivate(string deviceId = default) { @@ -77,7 +77,7 @@ public void Deactivate(string deviceId = default) } /// - /// 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). /// public async Task DeactivateAsync(DeactivateRequest request) { @@ -87,7 +87,7 @@ public async Task DeactivateAsync(DeactivateRequest request) } /// - /// 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). /// public async Task DeactivateAsync(string deviceId = default) { @@ -172,7 +172,7 @@ public override string ToString() } /// - /// 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). /// public Phone Get(GetRequest request) { @@ -185,7 +185,7 @@ public Phone Get(GetRequest request) } /// - /// 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). /// public Phone Get(string deviceId = default) { @@ -193,7 +193,7 @@ public Phone Get(string deviceId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -205,7 +205,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string deviceId = default) { @@ -231,7 +231,7 @@ public ListRequest( } /// - /// 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. + /// 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. /// [DataMember(Name = "acs_credential_id", IsRequired = false, EmitDefaultValue = false)] public string? AcsCredentialId { get; set; } @@ -304,7 +304,7 @@ public override string ToString() } /// - /// 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. /// public List List(ListRequest request) { @@ -317,7 +317,7 @@ public List List(ListRequest request) } /// - /// 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. /// public List List( string? acsCredentialId = default, @@ -333,7 +333,7 @@ public List List( } /// - /// 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. /// public async Task> ListAsync(ListRequest request) { @@ -345,7 +345,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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. /// public async Task> ListAsync( string? acsCredentialId = default, diff --git a/src/Seam/Api/SchedulesThermostats.cs b/src/Seam/Api/SchedulesThermostats.cs index b16702ab..abb50e15 100644 --- a/src/Seam/Api/SchedulesThermostats.cs +++ b/src/Seam/Api/SchedulesThermostats.cs @@ -47,7 +47,7 @@ public CreateRequest( } /// - /// Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. + /// 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. /// [DataMember(Name = "climate_preset_key", IsRequired = true, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } @@ -65,13 +65,13 @@ public CreateRequest( public string EndsAt { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "is_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool? IsOverrideAllowed { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "max_override_period_minutes", @@ -150,7 +150,7 @@ public override string ToString() } /// - /// 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). /// public ThermostatSchedule Create(CreateRequest request) { @@ -163,7 +163,7 @@ public ThermostatSchedule Create(CreateRequest request) } /// - /// 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). /// public ThermostatSchedule Create( string climatePresetKey = default, @@ -189,7 +189,7 @@ public ThermostatSchedule Create( } /// - /// 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). /// public async Task CreateAsync(CreateRequest request) { @@ -206,7 +206,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task CreateAsync( string climatePresetKey = default, @@ -278,7 +278,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -288,7 +288,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string thermostatScheduleId = default) { @@ -296,7 +296,7 @@ public void Delete(string thermostatScheduleId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -306,7 +306,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string thermostatScheduleId = default) { @@ -395,7 +395,7 @@ public override string ToString() } /// - /// 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). /// public ThermostatSchedule Get(GetRequest request) { @@ -408,7 +408,7 @@ public ThermostatSchedule Get(GetRequest request) } /// - /// 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). /// public ThermostatSchedule Get(string thermostatScheduleId = default) { @@ -416,7 +416,7 @@ public ThermostatSchedule Get(string thermostatScheduleId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -428,7 +428,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string thermostatScheduleId = default) { @@ -524,7 +524,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -537,7 +537,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string deviceId = default, @@ -548,7 +548,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -562,7 +562,7 @@ await _seam.GetAsync("/thermostats/schedules/list", requestOptions } /// - /// 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). /// public async Task> ListAsync( string deviceId = default, @@ -605,7 +605,7 @@ public UpdateRequest( } /// - /// Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. + /// Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string? ClimatePresetKey { get; set; } @@ -617,13 +617,13 @@ public UpdateRequest( public string? EndsAt { get; set; } /// - /// 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). + /// 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). /// [DataMember(Name = "is_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool? IsOverrideAllowed { get; set; } /// - /// 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). + /// 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). /// [DataMember( Name = "max_override_period_minutes", @@ -675,7 +675,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -685,7 +685,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( string? climatePresetKey = default, @@ -711,7 +711,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -721,7 +721,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( string? climatePresetKey = default, diff --git a/src/Seam/Api/SimulateAccessCodes.cs b/src/Seam/Api/SimulateAccessCodes.cs index 69e82178..97f34fef 100644 --- a/src/Seam/Api/SimulateAccessCodes.cs +++ b/src/Seam/Api/SimulateAccessCodes.cs @@ -114,7 +114,7 @@ public override string ToString() } /// - /// 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). /// public UnmanagedAccessCode CreateUnmanagedAccessCode( CreateUnmanagedAccessCodeRequest request @@ -132,7 +132,7 @@ CreateUnmanagedAccessCodeRequest request } /// - /// 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). /// public UnmanagedAccessCode CreateUnmanagedAccessCode( string code = default, @@ -146,7 +146,7 @@ public UnmanagedAccessCode CreateUnmanagedAccessCode( } /// - /// 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). /// public async Task CreateUnmanagedAccessCodeAsync( CreateUnmanagedAccessCodeRequest request @@ -165,7 +165,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task CreateUnmanagedAccessCodeAsync( string code = default, diff --git a/src/Seam/Api/SimulateConnectedAccounts.cs b/src/Seam/Api/SimulateConnectedAccounts.cs index 6c562cfb..214394df 100644 --- a/src/Seam/Api/SimulateConnectedAccounts.cs +++ b/src/Seam/Api/SimulateConnectedAccounts.cs @@ -59,7 +59,7 @@ public override string ToString() } /// - /// 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). /// public void Disconnect(DisconnectRequest request) { @@ -69,7 +69,7 @@ public void Disconnect(DisconnectRequest request) } /// - /// 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). /// public void Disconnect(string connectedAccountId = default) { @@ -77,7 +77,7 @@ public void Disconnect(string connectedAccountId = default) } /// - /// 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). /// public async Task DisconnectAsync(DisconnectRequest request) { @@ -90,7 +90,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task DisconnectAsync(string connectedAccountId = default) { diff --git a/src/Seam/Api/SimulateDevices.cs b/src/Seam/Api/SimulateDevices.cs index 7fd87cf4..8ef9c7bb 100644 --- a/src/Seam/Api/SimulateDevices.cs +++ b/src/Seam/Api/SimulateDevices.cs @@ -59,7 +59,7 @@ public override string ToString() } /// - /// 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). /// public void Connect(ConnectRequest request) { @@ -69,7 +69,7 @@ public void Connect(ConnectRequest request) } /// - /// 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). /// public void Connect(string deviceId = default) { @@ -77,7 +77,7 @@ public void Connect(string deviceId = default) } /// - /// 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). /// public async Task ConnectAsync(ConnectRequest request) { @@ -87,7 +87,7 @@ public async Task ConnectAsync(ConnectRequest request) } /// - /// 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). /// public async Task ConnectAsync(string deviceId = default) { @@ -223,7 +223,7 @@ public override string ToString() } /// - /// 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). /// public void Disconnect(DisconnectRequest request) { @@ -233,7 +233,7 @@ public void Disconnect(DisconnectRequest request) } /// - /// 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). /// public void Disconnect(string deviceId = default) { @@ -241,7 +241,7 @@ public void Disconnect(string deviceId = default) } /// - /// 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). /// public async Task DisconnectAsync(DisconnectRequest request) { @@ -251,7 +251,7 @@ public async Task DisconnectAsync(DisconnectRequest request) } /// - /// 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). /// public async Task DisconnectAsync(string deviceId = default) { @@ -478,7 +478,7 @@ public override string ToString() } /// - /// 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). /// public void Remove(RemoveRequest request) { @@ -488,7 +488,7 @@ public void Remove(RemoveRequest request) } /// - /// 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). /// public void Remove(string deviceId = default) { @@ -496,7 +496,7 @@ public void Remove(string deviceId = default) } /// - /// 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). /// public async Task RemoveAsync(RemoveRequest request) { @@ -506,7 +506,7 @@ public async Task RemoveAsync(RemoveRequest request) } /// - /// 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). /// public async Task RemoveAsync(string deviceId = default) { diff --git a/src/Seam/Api/SimulateEncodersAcs.cs b/src/Seam/Api/SimulateEncodersAcs.cs index de394552..50a6423a 100644 --- a/src/Seam/Api/SimulateEncodersAcs.cs +++ b/src/Seam/Api/SimulateEncodersAcs.cs @@ -99,7 +99,7 @@ public override string ToString() } /// - /// 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). /// public void NextCredentialEncodeWillFail(NextCredentialEncodeWillFailRequest request) { @@ -112,7 +112,7 @@ public void NextCredentialEncodeWillFail(NextCredentialEncodeWillFailRequest req } /// - /// 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). /// public void NextCredentialEncodeWillFail( string? acsCredentialId = default, @@ -130,7 +130,7 @@ public void NextCredentialEncodeWillFail( } /// - /// 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). /// public async Task NextCredentialEncodeWillFailAsync( NextCredentialEncodeWillFailRequest request @@ -145,7 +145,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task NextCredentialEncodeWillFailAsync( string? acsCredentialId = default, @@ -226,7 +226,7 @@ public override string ToString() } /// - /// 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). /// public void NextCredentialEncodeWillSucceed(NextCredentialEncodeWillSucceedRequest request) { @@ -239,7 +239,7 @@ public void NextCredentialEncodeWillSucceed(NextCredentialEncodeWillSucceedReque } /// - /// 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). /// public void NextCredentialEncodeWillSucceed( string acsEncoderId = default, @@ -255,7 +255,7 @@ public void NextCredentialEncodeWillSucceed( } /// - /// 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). /// public async Task NextCredentialEncodeWillSucceedAsync( NextCredentialEncodeWillSucceedRequest request @@ -270,7 +270,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task NextCredentialEncodeWillSucceedAsync( string acsEncoderId = default, @@ -358,7 +358,7 @@ public override string ToString() } /// - /// 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). /// public void NextCredentialScanWillFail(NextCredentialScanWillFailRequest request) { @@ -371,7 +371,7 @@ public void NextCredentialScanWillFail(NextCredentialScanWillFailRequest request } /// - /// 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). /// public void NextCredentialScanWillFail( string? acsCredentialIdOnSeam = default, @@ -389,7 +389,7 @@ public void NextCredentialScanWillFail( } /// - /// 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). /// public async Task NextCredentialScanWillFailAsync(NextCredentialScanWillFailRequest request) { @@ -402,7 +402,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task NextCredentialScanWillFailAsync( string? acsCredentialIdOnSeam = default, @@ -504,7 +504,7 @@ public override string ToString() } /// - /// 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). /// public void NextCredentialScanWillSucceed(NextCredentialScanWillSucceedRequest request) { @@ -517,7 +517,7 @@ public void NextCredentialScanWillSucceed(NextCredentialScanWillSucceedRequest r } /// - /// 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). /// public void NextCredentialScanWillSucceed( string? acsCredentialIdOnSeam = default, @@ -535,7 +535,7 @@ public void NextCredentialScanWillSucceed( } /// - /// 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). /// public async Task NextCredentialScanWillSucceedAsync( NextCredentialScanWillSucceedRequest request @@ -550,7 +550,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task NextCredentialScanWillSucceedAsync( string? acsCredentialIdOnSeam = default, diff --git a/src/Seam/Api/SimulateLocks.cs b/src/Seam/Api/SimulateLocks.cs index 6178d28c..f86d81f8 100644 --- a/src/Seam/Api/SimulateLocks.cs +++ b/src/Seam/Api/SimulateLocks.cs @@ -103,7 +103,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt KeypadCodeEntry(KeypadCodeEntryRequest request) { @@ -116,7 +116,7 @@ public ActionAttempt KeypadCodeEntry(KeypadCodeEntryRequest request) } /// - /// 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). /// public ActionAttempt KeypadCodeEntry(string code = default, string deviceId = default) { @@ -124,7 +124,7 @@ public ActionAttempt KeypadCodeEntry(string code = default, string deviceId = de } /// - /// 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). /// public async Task KeypadCodeEntryAsync(KeypadCodeEntryRequest request) { @@ -141,7 +141,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task KeypadCodeEntryAsync( string code = default, @@ -233,7 +233,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt ManualLockViaKeypad(ManualLockViaKeypadRequest request) { @@ -249,7 +249,7 @@ public ActionAttempt ManualLockViaKeypad(ManualLockViaKeypadRequest request) } /// - /// 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). /// public ActionAttempt ManualLockViaKeypad(string deviceId = default) { @@ -257,7 +257,7 @@ public ActionAttempt ManualLockViaKeypad(string deviceId = default) } /// - /// 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). /// public async Task ManualLockViaKeypadAsync( ManualLockViaKeypadRequest request @@ -276,7 +276,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task ManualLockViaKeypadAsync(string deviceId = default) { diff --git a/src/Seam/Api/SimulateNoiseSensors.cs b/src/Seam/Api/SimulateNoiseSensors.cs index 63303c99..b2409f72 100644 --- a/src/Seam/Api/SimulateNoiseSensors.cs +++ b/src/Seam/Api/SimulateNoiseSensors.cs @@ -59,7 +59,7 @@ public override string ToString() } /// - /// 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). /// public void TriggerNoiseThreshold(TriggerNoiseThresholdRequest request) { @@ -69,7 +69,7 @@ public void TriggerNoiseThreshold(TriggerNoiseThresholdRequest request) } /// - /// 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). /// public void TriggerNoiseThreshold(string deviceId = default) { @@ -77,7 +77,7 @@ public void TriggerNoiseThreshold(string deviceId = default) } /// - /// 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). /// public async Task TriggerNoiseThresholdAsync(TriggerNoiseThresholdRequest request) { @@ -90,7 +90,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task TriggerNoiseThresholdAsync(string deviceId = default) { diff --git a/src/Seam/Api/SimulatePhones.cs b/src/Seam/Api/SimulatePhones.cs index 3c19dba5..85df60f5 100644 --- a/src/Seam/Api/SimulatePhones.cs +++ b/src/Seam/Api/SimulatePhones.cs @@ -289,7 +289,7 @@ public override string ToString() } /// - /// 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). /// public Phone CreateSandboxPhone(CreateSandboxPhoneRequest request) { @@ -305,7 +305,7 @@ public Phone CreateSandboxPhone(CreateSandboxPhoneRequest request) } /// - /// 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). /// public Phone CreateSandboxPhone( CreateSandboxPhoneRequestAssaAbloyMetadata? assaAbloyMetadata = default, @@ -325,7 +325,7 @@ public Phone CreateSandboxPhone( } /// - /// 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). /// public async Task CreateSandboxPhoneAsync(CreateSandboxPhoneRequest request) { @@ -342,7 +342,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task CreateSandboxPhoneAsync( CreateSandboxPhoneRequestAssaAbloyMetadata? assaAbloyMetadata = default, diff --git a/src/Seam/Api/SimulateThermostats.cs b/src/Seam/Api/SimulateThermostats.cs index 8b644a44..859817dd 100644 --- a/src/Seam/Api/SimulateThermostats.cs +++ b/src/Seam/Api/SimulateThermostats.cs @@ -67,7 +67,7 @@ public enum HvacModeEnum } /// - /// 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`. + /// 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`. /// [DataMember( Name = "cooling_set_point_celsius", @@ -77,7 +77,7 @@ public enum HvacModeEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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`. + /// 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`. /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -93,7 +93,7 @@ public enum HvacModeEnum public string DeviceId { get; set; } /// - /// 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`. + /// 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`. /// [DataMember( Name = "heating_set_point_celsius", @@ -103,7 +103,7 @@ public enum HvacModeEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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`. + /// 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`. /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -139,7 +139,7 @@ public override string ToString() } /// - /// 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). /// public void HvacModeAdjusted(HvacModeAdjustedRequest request) { @@ -149,7 +149,7 @@ public void HvacModeAdjusted(HvacModeAdjustedRequest request) } /// - /// 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). /// public void HvacModeAdjusted( float? coolingSetPointCelsius = default, @@ -173,7 +173,7 @@ public void HvacModeAdjusted( } /// - /// 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). /// public async Task HvacModeAdjustedAsync(HvacModeAdjustedRequest request) { @@ -186,7 +186,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task HvacModeAdjustedAsync( float? coolingSetPointCelsius = default, @@ -272,7 +272,7 @@ public override string ToString() } /// - /// 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). /// public void TemperatureReached(TemperatureReachedRequest request) { @@ -282,7 +282,7 @@ public void TemperatureReached(TemperatureReachedRequest request) } /// - /// 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). /// public void TemperatureReached( string deviceId = default, @@ -300,7 +300,7 @@ public void TemperatureReached( } /// - /// 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). /// public async Task TemperatureReachedAsync(TemperatureReachedRequest request) { @@ -313,7 +313,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task TemperatureReachedAsync( string deviceId = default, diff --git a/src/Seam/Api/Spaces.cs b/src/Seam/Api/Spaces.cs index 52ba4f79..db2fcb4f 100644 --- a/src/Seam/Api/Spaces.cs +++ b/src/Seam/Api/Spaces.cs @@ -69,7 +69,7 @@ public override string ToString() } /// - /// 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. /// public void AddAcsEntrances(AddAcsEntrancesRequest request) { @@ -79,7 +79,7 @@ public void AddAcsEntrances(AddAcsEntrancesRequest request) } /// - /// 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. /// public void AddAcsEntrances(List acsEntranceIds = default, string spaceId = default) { @@ -89,7 +89,7 @@ public void AddAcsEntrances(List acsEntranceIds = default, string spaceI } /// - /// 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. /// public async Task AddAcsEntrancesAsync(AddAcsEntrancesRequest request) { @@ -99,7 +99,7 @@ public async Task AddAcsEntrancesAsync(AddAcsEntrancesRequest request) } /// - /// 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. /// public async Task AddAcsEntrancesAsync( List acsEntranceIds = default, @@ -162,7 +162,7 @@ public override string ToString() } /// - /// 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. /// public void AddConnectedAccount(AddConnectedAccountRequest request) { @@ -172,7 +172,7 @@ public void AddConnectedAccount(AddConnectedAccountRequest request) } /// - /// 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. /// public void AddConnectedAccount( string connectedAccountId = default, @@ -188,7 +188,7 @@ public void AddConnectedAccount( } /// - /// 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. /// public async Task AddConnectedAccountAsync(AddConnectedAccountRequest request) { @@ -198,7 +198,7 @@ public async Task AddConnectedAccountAsync(AddConnectedAccountRequest request) } /// - /// 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. /// public async Task AddConnectedAccountAsync( string connectedAccountId = default, @@ -1228,7 +1228,7 @@ public override string ToString() } /// - /// 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. /// public void RemoveAcsEntrances(RemoveAcsEntrancesRequest request) { @@ -1238,7 +1238,7 @@ public void RemoveAcsEntrances(RemoveAcsEntrancesRequest request) } /// - /// 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. /// public void RemoveAcsEntrances( List acsEntranceIds = default, @@ -1251,7 +1251,7 @@ public void RemoveAcsEntrances( } /// - /// 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. /// public async Task RemoveAcsEntrancesAsync(RemoveAcsEntrancesRequest request) { @@ -1261,7 +1261,7 @@ public async Task RemoveAcsEntrancesAsync(RemoveAcsEntrancesRequest request) } /// - /// 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. /// public async Task RemoveAcsEntrancesAsync( List acsEntranceIds = default, @@ -1324,7 +1324,7 @@ public override string ToString() } /// - /// 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. /// public void RemoveConnectedAccount(RemoveConnectedAccountRequest request) { @@ -1334,7 +1334,7 @@ public void RemoveConnectedAccount(RemoveConnectedAccountRequest request) } /// - /// 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. /// public void RemoveConnectedAccount( string connectedAccountId = default, @@ -1350,7 +1350,7 @@ public void RemoveConnectedAccount( } /// - /// 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. /// public async Task RemoveConnectedAccountAsync(RemoveConnectedAccountRequest request) { @@ -1360,7 +1360,7 @@ public async Task RemoveConnectedAccountAsync(RemoveConnectedAccountRequest requ } /// - /// 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. /// public async Task RemoveConnectedAccountAsync( string connectedAccountId = default, diff --git a/src/Seam/Api/SystemsAcs.cs b/src/Seam/Api/SystemsAcs.cs index 4960c1fc..84a89e3b 100644 --- a/src/Seam/Api/SystemsAcs.cs +++ b/src/Seam/Api/SystemsAcs.cs @@ -96,7 +96,7 @@ public override string ToString() } /// - /// 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). /// public AcsSystem Get(GetRequest request) { @@ -109,7 +109,7 @@ public AcsSystem Get(GetRequest request) } /// - /// 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). /// public AcsSystem Get(string acsSystemId = default) { @@ -117,7 +117,7 @@ public AcsSystem Get(string acsSystemId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -129,7 +129,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync(string acsSystemId = default) { @@ -236,7 +236,7 @@ public override string ToString() } /// - /// 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. /// @@ -251,7 +251,7 @@ public List List(ListRequest request) } /// - /// 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. /// @@ -271,7 +271,7 @@ public List List( } /// - /// 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. /// @@ -285,7 +285,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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. /// @@ -386,7 +386,7 @@ public override string ToString() } /// - /// 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. /// @@ -406,7 +406,7 @@ ListCompatibleCredentialManagerAcsSystemsRequest request } /// - /// 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. /// @@ -420,7 +420,7 @@ public List ListCompatibleCredentialManagerAcsSystems( } /// - /// 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. /// @@ -441,7 +441,7 @@ await _seam.GetAsync( } /// - /// 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/Seam/Api/Thermostats.cs b/src/Seam/Api/Thermostats.cs index 98c0cf12..dcfa48d2 100644 --- a/src/Seam/Api/Thermostats.cs +++ b/src/Seam/Api/Thermostats.cs @@ -106,7 +106,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt ActivateClimatePreset(ActivateClimatePresetRequest request) { @@ -122,7 +122,7 @@ public ActionAttempt ActivateClimatePreset(ActivateClimatePresetRequest request) } /// - /// 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). /// public ActionAttempt ActivateClimatePreset( string climatePresetKey = default, @@ -138,7 +138,7 @@ public ActionAttempt ActivateClimatePreset( } /// - /// 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). /// public async Task ActivateClimatePresetAsync( ActivateClimatePresetRequest request @@ -157,7 +157,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task ActivateClimatePresetAsync( string climatePresetKey = default, @@ -174,6 +174,138 @@ await ActivateClimatePresetAsync( ); } + /// + /// Request parameters for Activate the Weekly Program. + /// + [DataContract(Name = "activateWeeklyProgramRequest_request")] + public class ActivateWeeklyProgramRequest + { + [JsonConstructorAttribute] + protected ActivateWeeklyProgramRequest() { } + + public ActivateWeeklyProgramRequest(string deviceId = default) + { + DeviceId = deviceId; + } + + /// + /// ID of the thermostat device that you want to return to its weekly program. + /// + [DataMember(Name = "device_id", IsRequired = true, EmitDefaultValue = false)] + public string DeviceId { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "activateWeeklyProgramResponse_response")] + public class ActivateWeeklyProgramResponse + { + [JsonConstructorAttribute] + protected ActivateWeeklyProgramResponse() { } + + public ActivateWeeklyProgramResponse(ActionAttempt actionAttempt = default) + { + ActionAttempt = actionAttempt; + } + + /// + /// OK + /// + [DataMember(Name = "action_attempt", IsRequired = false, EmitDefaultValue = false)] + public ActionAttempt ActionAttempt { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + /// + /// Returns a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to its [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs), the schedule that is configured on the device itself, releasing any hold that Seam has set. Seam stops managing the thermostat's climate until you [activate a climate preset](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings), make a direct climate setting change, or one of the thermostat's [scheduled](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) presets reaches its activation time. + /// + public ActionAttempt ActivateWeeklyProgram(ActivateWeeklyProgramRequest request) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return _seam + .Post( + "/thermostats/activate_weekly_program", + requestOptions + ) + .EnsureData("/thermostats/activate_weekly_program") + .ActionAttempt; + } + + /// + /// Returns a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to its [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs), the schedule that is configured on the device itself, releasing any hold that Seam has set. Seam stops managing the thermostat's climate until you [activate a climate preset](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings), make a direct climate setting change, or one of the thermostat's [scheduled](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) presets reaches its activation time. + /// + public ActionAttempt ActivateWeeklyProgram(string deviceId = default) + { + return ActivateWeeklyProgram(new ActivateWeeklyProgramRequest(deviceId: deviceId)); + } + + /// + /// Returns a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to its [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs), the schedule that is configured on the device itself, releasing any hold that Seam has set. Seam stops managing the thermostat's climate until you [activate a climate preset](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings), make a direct climate setting change, or one of the thermostat's [scheduled](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) presets reaches its activation time. + /// + public async Task ActivateWeeklyProgramAsync( + ActivateWeeklyProgramRequest request + ) + { + var requestOptions = new RequestOptions(); + requestOptions.Data = request; + return ( + await _seam.PostAsync( + "/thermostats/activate_weekly_program", + requestOptions + ) + ) + .EnsureData("/thermostats/activate_weekly_program") + .ActionAttempt; + } + + /// + /// Returns a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to its [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs), the schedule that is configured on the device itself, releasing any hold that Seam has set. Seam stops managing the thermostat's climate until you [activate a climate preset](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings), make a direct climate setting change, or one of the thermostat's [scheduled](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) presets reaches its activation time. + /// + public async Task ActivateWeeklyProgramAsync(string deviceId = default) + { + return ( + await ActivateWeeklyProgramAsync( + new ActivateWeeklyProgramRequest(deviceId: deviceId) + ) + ); + } + /// /// Request parameters for Set to Cool Mode. /// @@ -195,7 +327,7 @@ public CoolRequest( } /// - /// [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. + /// [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. /// [DataMember( Name = "cooling_set_point_celsius", @@ -205,7 +337,7 @@ public CoolRequest( public float? CoolingSetPointCelsius { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -278,7 +410,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt Cool(CoolRequest request) { @@ -291,7 +423,7 @@ public ActionAttempt Cool(CoolRequest request) } /// - /// 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). /// public ActionAttempt Cool( float? coolingSetPointCelsius = default, @@ -309,7 +441,7 @@ public ActionAttempt Cool( } /// - /// 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). /// public async Task CoolAsync(CoolRequest request) { @@ -321,7 +453,7 @@ public async Task CoolAsync(CoolRequest request) } /// - /// 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). /// public async Task CoolAsync( float? coolingSetPointCelsius = default, @@ -407,7 +539,7 @@ public enum ClimatePresetModeEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -426,7 +558,7 @@ public enum FanModeSettingEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum HvacModeSettingEnum @@ -451,7 +583,7 @@ public enum HvacModeSettingEnum } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = true, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } @@ -463,7 +595,7 @@ public enum HvacModeSettingEnum public CreateClimatePresetRequest.ClimatePresetModeEnum? ClimatePresetMode { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_celsius", @@ -473,7 +605,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -495,13 +627,13 @@ public enum HvacModeSettingEnum public CreateClimatePresetRequestEcobeeMetadata? EcobeeMetadata { get; set; } /// - /// 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`. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public CreateClimatePresetRequest.FanModeSettingEnum? FanModeSetting { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_celsius", @@ -511,7 +643,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -521,7 +653,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointFahrenheit { get; set; } /// - /// 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`. /// [DataMember(Name = "hvac_mode_setting", IsRequired = false, EmitDefaultValue = false)] public CreateClimatePresetRequest.HvacModeSettingEnum? HvacModeSetting { get; set; } @@ -538,7 +670,7 @@ public enum HvacModeSettingEnum public bool? ManualOverrideAllowed { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } @@ -635,7 +767,7 @@ public override string ToString() } /// - /// 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). /// public void CreateClimatePreset(CreateClimatePresetRequest request) { @@ -645,7 +777,7 @@ public void CreateClimatePreset(CreateClimatePresetRequest request) } /// - /// 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). /// public void CreateClimatePreset( string climatePresetKey = default, @@ -681,7 +813,7 @@ public void CreateClimatePreset( } /// - /// 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). /// public async Task CreateClimatePresetAsync(CreateClimatePresetRequest request) { @@ -691,7 +823,7 @@ public async Task CreateClimatePresetAsync(CreateClimatePresetRequest request) } /// - /// 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). /// public async Task CreateClimatePresetAsync( string climatePresetKey = default, @@ -777,7 +909,7 @@ public override string ToString() } /// - /// 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). /// public void DeleteClimatePreset(DeleteClimatePresetRequest request) { @@ -787,7 +919,7 @@ public void DeleteClimatePreset(DeleteClimatePresetRequest request) } /// - /// 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). /// public void DeleteClimatePreset( string climatePresetKey = default, @@ -803,7 +935,7 @@ public void DeleteClimatePreset( } /// - /// 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). /// public async Task DeleteClimatePresetAsync(DeleteClimatePresetRequest request) { @@ -813,7 +945,7 @@ public async Task DeleteClimatePresetAsync(DeleteClimatePresetRequest request) } /// - /// 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). /// public async Task DeleteClimatePresetAsync( string climatePresetKey = default, @@ -855,7 +987,7 @@ public HeatRequest( public string DeviceId { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "heating_set_point_celsius", @@ -865,7 +997,7 @@ public HeatRequest( public float? HeatingSetPointCelsius { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -932,7 +1064,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt Heat(HeatRequest request) { @@ -945,7 +1077,7 @@ public ActionAttempt Heat(HeatRequest request) } /// - /// 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). /// public ActionAttempt Heat( string deviceId = default, @@ -963,7 +1095,7 @@ public ActionAttempt Heat( } /// - /// 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). /// public async Task HeatAsync(HeatRequest request) { @@ -975,7 +1107,7 @@ public async Task HeatAsync(HeatRequest request) } /// - /// 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). /// public async Task HeatAsync( string deviceId = default, @@ -1019,7 +1151,7 @@ public HeatCoolRequest( } /// - /// [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. + /// [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. /// [DataMember( Name = "cooling_set_point_celsius", @@ -1029,7 +1161,7 @@ public HeatCoolRequest( public float? CoolingSetPointCelsius { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -1045,7 +1177,7 @@ public HeatCoolRequest( public string DeviceId { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "heating_set_point_celsius", @@ -1055,7 +1187,7 @@ public HeatCoolRequest( public float? HeatingSetPointCelsius { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -1122,7 +1254,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt HeatCool(HeatCoolRequest request) { @@ -1135,7 +1267,7 @@ public ActionAttempt HeatCool(HeatCoolRequest request) } /// - /// 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). /// public ActionAttempt HeatCool( float? coolingSetPointCelsius = default, @@ -1157,7 +1289,7 @@ public ActionAttempt HeatCool( } /// - /// 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). /// public async Task HeatCoolAsync(HeatCoolRequest request) { @@ -1171,7 +1303,7 @@ await _seam.PostAsync("/thermostats/heat_cool", requestOptions } /// - /// 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). /// public async Task HeatCoolAsync( float? coolingSetPointCelsius = default, @@ -1402,7 +1534,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -1415,7 +1547,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? connectWebviewId = default, @@ -1439,7 +1571,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -1451,7 +1583,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? connectWebviewId = default, @@ -1554,7 +1686,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt Off(OffRequest request) { @@ -1567,7 +1699,7 @@ public ActionAttempt Off(OffRequest request) } /// - /// 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). /// public ActionAttempt Off(string deviceId = default) { @@ -1575,7 +1707,7 @@ public ActionAttempt Off(string deviceId = default) } /// - /// 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). /// public async Task OffAsync(OffRequest request) { @@ -1587,7 +1719,7 @@ public async Task OffAsync(OffRequest request) } /// - /// 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). /// public async Task OffAsync(string deviceId = default) { @@ -1645,7 +1777,7 @@ public override string ToString() } /// - /// 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). /// public void SetFallbackClimatePreset(SetFallbackClimatePresetRequest request) { @@ -1655,7 +1787,7 @@ public void SetFallbackClimatePreset(SetFallbackClimatePresetRequest request) } /// - /// 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). /// public void SetFallbackClimatePreset( string climatePresetKey = default, @@ -1671,7 +1803,7 @@ public void SetFallbackClimatePreset( } /// - /// 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). /// public async Task SetFallbackClimatePresetAsync(SetFallbackClimatePresetRequest request) { @@ -1684,7 +1816,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task SetFallbackClimatePresetAsync( string climatePresetKey = default, @@ -1739,7 +1871,7 @@ public enum FanModeEnum } /// - /// [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. + /// [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. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -1771,7 +1903,7 @@ public enum FanModeSettingEnum public SetFanModeRequest.FanModeEnum? FanMode { get; set; } /// - /// [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. + /// [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. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public SetFanModeRequest.FanModeSettingEnum? FanModeSetting { get; set; } @@ -1834,7 +1966,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt SetFanMode(SetFanModeRequest request) { @@ -1847,7 +1979,7 @@ public ActionAttempt SetFanMode(SetFanModeRequest request) } /// - /// 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). /// public ActionAttempt SetFanMode( string deviceId = default, @@ -1865,7 +1997,7 @@ public ActionAttempt SetFanMode( } /// - /// 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). /// public async Task SetFanModeAsync(SetFanModeRequest request) { @@ -1882,7 +2014,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task SetFanModeAsync( string deviceId = default, @@ -1950,7 +2082,7 @@ public enum HvacModeSettingEnum } /// - /// [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. + /// [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. /// [DataMember( Name = "cooling_set_point_celsius", @@ -1960,7 +2092,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointCelsius { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -1976,7 +2108,7 @@ public enum HvacModeSettingEnum public string DeviceId { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "heating_set_point_celsius", @@ -1986,7 +2118,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointCelsius { get; set; } /// - /// [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. + /// [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. /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -2056,7 +2188,7 @@ public override string ToString() } /// - /// 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). /// public ActionAttempt SetHvacMode(SetHvacModeRequest request) { @@ -2069,7 +2201,7 @@ public ActionAttempt SetHvacMode(SetHvacModeRequest request) } /// - /// 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). /// public ActionAttempt SetHvacMode( float? coolingSetPointCelsius = default, @@ -2093,7 +2225,7 @@ public ActionAttempt SetHvacMode( } /// - /// 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). /// public async Task SetHvacModeAsync(SetHvacModeRequest request) { @@ -2110,7 +2242,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task SetHvacModeAsync( float? coolingSetPointCelsius = default, @@ -2218,7 +2350,7 @@ public override string ToString() } /// - /// 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. /// public void SetTemperatureThreshold(SetTemperatureThresholdRequest request) { @@ -2228,7 +2360,7 @@ public void SetTemperatureThreshold(SetTemperatureThresholdRequest request) } /// - /// 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. /// public void SetTemperatureThreshold( string deviceId = default, @@ -2250,7 +2382,7 @@ public void SetTemperatureThreshold( } /// - /// 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. /// public async Task SetTemperatureThresholdAsync(SetTemperatureThresholdRequest request) { @@ -2263,7 +2395,7 @@ await _seam.PatchAsync( } /// - /// 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. /// public async Task SetTemperatureThresholdAsync( string deviceId = default, @@ -2351,7 +2483,7 @@ public enum ClimatePresetModeEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -2370,7 +2502,7 @@ public enum FanModeSettingEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum HvacModeSettingEnum @@ -2395,7 +2527,7 @@ public enum HvacModeSettingEnum } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = true, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } @@ -2407,7 +2539,7 @@ public enum HvacModeSettingEnum public UpdateClimatePresetRequest.ClimatePresetModeEnum? ClimatePresetMode { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_celsius", @@ -2417,7 +2549,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -2439,13 +2571,13 @@ public enum HvacModeSettingEnum public UpdateClimatePresetRequestEcobeeMetadata? EcobeeMetadata { get; set; } /// - /// 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`. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public UpdateClimatePresetRequest.FanModeSettingEnum? FanModeSetting { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_celsius", @@ -2455,7 +2587,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -2465,13 +2597,13 @@ public enum HvacModeSettingEnum public float? HeatingSetPointFahrenheit { get; set; } /// - /// 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`. /// [DataMember(Name = "hvac_mode_setting", IsRequired = false, EmitDefaultValue = false)] public UpdateClimatePresetRequest.HvacModeSettingEnum? HvacModeSetting { get; set; } /// - /// 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). /// [Obsolete("Use 'thermostat_schedule.is_override_allowed'")] [DataMember( @@ -2482,7 +2614,7 @@ public enum HvacModeSettingEnum public bool? ManualOverrideAllowed { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } @@ -2579,7 +2711,7 @@ public override string ToString() } /// - /// 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). /// public void UpdateClimatePreset(UpdateClimatePresetRequest request) { @@ -2589,7 +2721,7 @@ public void UpdateClimatePreset(UpdateClimatePresetRequest request) } /// - /// 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). /// public void UpdateClimatePreset( string climatePresetKey = default, @@ -2625,7 +2757,7 @@ public void UpdateClimatePreset( } /// - /// 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). /// public async Task UpdateClimatePresetAsync(UpdateClimatePresetRequest request) { @@ -2635,7 +2767,7 @@ public async Task UpdateClimatePresetAsync(UpdateClimatePresetRequest request) } /// - /// 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). /// public async Task UpdateClimatePresetAsync( string climatePresetKey = default, diff --git a/src/Seam/Api/UnmanagedAccessCodes.cs b/src/Seam/Api/UnmanagedAccessCodes.cs index c7b4a584..1bc991d6 100644 --- a/src/Seam/Api/UnmanagedAccessCodes.cs +++ b/src/Seam/Api/UnmanagedAccessCodes.cs @@ -47,7 +47,7 @@ public ConvertToManagedRequest( public string AccessCodeId { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is 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. /// [DataMember( Name = "allow_external_modification", @@ -63,7 +63,7 @@ public ConvertToManagedRequest( public bool? Force { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is 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. /// [DataMember( Name = "is_external_modification_allowed", @@ -93,7 +93,7 @@ public override string ToString() } /// - /// 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. /// @@ -107,7 +107,7 @@ public void ConvertToManaged(ConvertToManagedRequest request) } /// - /// 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. /// @@ -131,7 +131,7 @@ public void ConvertToManaged( } /// - /// 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. /// @@ -148,7 +148,7 @@ await _seam.PatchAsync( } /// - /// 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. /// @@ -212,7 +212,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -222,7 +222,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string accessCodeId = default) { @@ -230,7 +230,7 @@ public void Delete(string accessCodeId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -240,7 +240,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string accessCodeId = default) { @@ -343,7 +343,7 @@ public override string ToString() } /// - /// 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`. /// @@ -358,7 +358,7 @@ public UnmanagedAccessCode Get(GetRequest request) } /// - /// 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`. /// @@ -372,7 +372,7 @@ public UnmanagedAccessCode Get( } /// - /// 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`. /// @@ -388,7 +388,7 @@ await _seam.GetAsync("/access_codes/unmanaged/get", requestOptions) } /// - /// 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`. /// @@ -517,7 +517,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -530,7 +530,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string deviceId = default, @@ -552,7 +552,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -566,7 +566,7 @@ await _seam.GetAsync("/access_codes/unmanaged/list", requestOption } /// - /// 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). /// public async Task> ListAsync( string deviceId = default, @@ -620,7 +620,7 @@ public UpdateRequest( public string AccessCodeId { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. + /// Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. /// [DataMember( Name = "allow_external_modification", @@ -636,7 +636,7 @@ public UpdateRequest( public bool? Force { get; set; } /// - /// Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. + /// Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. /// [DataMember( Name = "is_external_modification_allowed", @@ -669,7 +669,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -679,7 +679,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( string accessCodeId = default, @@ -701,7 +701,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -711,7 +711,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( string accessCodeId = default, diff --git a/src/Seam/Api/UnmanagedDevices.cs b/src/Seam/Api/UnmanagedDevices.cs index a9b72408..c7cd8632 100644 --- a/src/Seam/Api/UnmanagedDevices.cs +++ b/src/Seam/Api/UnmanagedDevices.cs @@ -103,9 +103,9 @@ public override string ToString() } /// - /// 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`. /// @@ -120,9 +120,9 @@ public UnmanagedDevice Get(GetRequest request) } /// - /// 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`. /// @@ -132,9 +132,9 @@ public UnmanagedDevice Get(string? deviceId = default, string? name = default) } /// - /// 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`. /// @@ -148,9 +148,9 @@ public async Task GetAsync(GetRequest request) } /// - /// 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`. /// @@ -337,6 +337,15 @@ public enum DeviceTypeEnum [EnumMember(Value = "ring_camera")] RingCamera = 43, + + [EnumMember(Value = "tapo_camera")] + TapoCamera = 44, + + [EnumMember(Value = "arlo_camera")] + ArloCamera = 45, + + [EnumMember(Value = "reolink_camera")] + ReolinkCamera = 46, } /// @@ -476,6 +485,15 @@ public enum DeviceTypesEnum [EnumMember(Value = "ring_camera")] RingCamera = 43, + + [EnumMember(Value = "tapo_camera")] + TapoCamera = 44, + + [EnumMember(Value = "arlo_camera")] + ArloCamera = 45, + + [EnumMember(Value = "reolink_camera")] + ReolinkCamera = 46, } /// @@ -562,86 +580,101 @@ public enum ManufacturerEnum [EnumMember(Value = "controlbyweb")] Controlbyweb = 25, - [EnumMember(Value = "dormakaba_oracode")] - DormakabaOracode = 26, - [EnumMember(Value = "tedee")] - Tedee = 27, + Tedee = 26, [EnumMember(Value = "keyincode")] - Keyincode = 28, + Keyincode = 27, [EnumMember(Value = "akiles")] - Akiles = 29, + Akiles = 28, [EnumMember(Value = "aqara")] - Aqara = 30, + Aqara = 29, [EnumMember(Value = "ecobee")] - Ecobee = 31, + Ecobee = 30, + + [EnumMember(Value = "eufy")] + Eufy = 31, + + [EnumMember(Value = "dormakaba_oracode")] + DormakabaOracode = 32, + + [EnumMember(Value = "dormakaba_oracode_iho")] + DormakabaOracodeIho = 33, [EnumMember(Value = "honeywell_resideo")] - HoneywellResideo = 32, + HoneywellResideo = 34, [EnumMember(Value = "keynest")] - Keynest = 33, + Keynest = 35, [EnumMember(Value = "korelock")] - Korelock = 34, + Korelock = 36, [EnumMember(Value = "lockly")] - Lockly = 35, + Lockly = 37, [EnumMember(Value = "minut")] - Minut = 36, + Minut = 38, [EnumMember(Value = "nest")] - Nest = 37, + Nest = 39, [EnumMember(Value = "noiseaware")] - Noiseaware = 38, + Noiseaware = 40, [EnumMember(Value = "sensi")] - Sensi = 39, + Sensi = 41, [EnumMember(Value = "smartthings")] - Smartthings = 40, + Smartthings = 42, [EnumMember(Value = "tado")] - Tado = 41, + Tado = 43, [EnumMember(Value = "ultraloq")] - Ultraloq = 42, + Ultraloq = 44, [EnumMember(Value = "ring")] - Ring = 43, + Ring = 45, + + [EnumMember(Value = "tapo")] + Tapo = 46, + + [EnumMember(Value = "arlo")] + Arlo = 47, + + [EnumMember(Value = "reolink")] + Reolink = 48, [EnumMember(Value = "ical")] - Ical = 44, + Ical = 49, [EnumMember(Value = "lodgify")] - Lodgify = 45, + Lodgify = 50, [EnumMember(Value = "hostaway")] - Hostaway = 46, + Hostaway = 51, [EnumMember(Value = "guesty")] - Guesty = 47, + Guesty = 52, [EnumMember(Value = "acuity_scheduling")] - AcuityScheduling = 48, + AcuityScheduling = 53, [EnumMember(Value = "omnitec")] - Omnitec = 49, + Omnitec = 54, [EnumMember(Value = "kisi")] - Kisi = 50, + Kisi = 55, [EnumMember(Value = "slack")] - Slack = 51, + Slack = 56, [EnumMember(Value = "yacan")] - Yacan = 52, + Yacan = 57, } /// @@ -782,9 +815,9 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -797,9 +830,9 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? connectWebviewId = default, @@ -835,9 +868,9 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -849,9 +882,9 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? connectWebviewId = default, @@ -947,9 +980,9 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -959,9 +992,9 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( object? customMetadata = default, @@ -979,9 +1012,9 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -991,9 +1024,9 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( object? customMetadata = default, diff --git a/src/Seam/Api/UnmanagedUserIdentities.cs b/src/Seam/Api/UnmanagedUserIdentities.cs index d390dba2..5c2eede5 100644 --- a/src/Seam/Api/UnmanagedUserIdentities.cs +++ b/src/Seam/Api/UnmanagedUserIdentities.cs @@ -96,7 +96,7 @@ public override string ToString() } /// - /// 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). /// public UnmanagedUserIdentity Get(GetRequest request) { @@ -109,7 +109,7 @@ public UnmanagedUserIdentity Get(GetRequest request) } /// - /// 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). /// public UnmanagedUserIdentity Get(string userIdentityId = default) { @@ -117,7 +117,7 @@ public UnmanagedUserIdentity Get(string userIdentityId = default) } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -131,7 +131,7 @@ await _seam.GetAsync("/user_identities/unmanaged/get", requestOptio } /// - /// 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). /// public async Task GetAsync(string userIdentityId = default) { @@ -242,7 +242,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -255,7 +255,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? createdBefore = default, @@ -275,7 +275,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -292,7 +292,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListAsync( string? createdBefore = default, @@ -372,7 +372,7 @@ public override string ToString() } /// - /// 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. /// @@ -384,7 +384,7 @@ public void Update(UpdateRequest request) } /// - /// 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. /// @@ -404,7 +404,7 @@ public void Update( } /// - /// 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. /// @@ -416,7 +416,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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/Seam/Api/UserIdentities.cs b/src/Seam/Api/UserIdentities.cs index 0a069440..80f9e8c9 100644 --- a/src/Seam/Api/UserIdentities.cs +++ b/src/Seam/Api/UserIdentities.cs @@ -77,7 +77,7 @@ public override string ToString() } /// - /// 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. /// @@ -91,7 +91,7 @@ public void AddAcsUser(AddAcsUserRequest request) } /// - /// 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. /// @@ -113,7 +113,7 @@ public void AddAcsUser( } /// - /// 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. /// @@ -127,7 +127,7 @@ public async Task AddAcsUserAsync(AddAcsUserRequest request) } /// - /// 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. /// @@ -260,7 +260,7 @@ public override string ToString() } /// - /// 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). /// public UserIdentity Create(CreateRequest request) { @@ -273,7 +273,7 @@ public UserIdentity Create(CreateRequest request) } /// - /// 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). /// public UserIdentity Create( List? acsSystemIds = default, @@ -295,7 +295,7 @@ public UserIdentity Create( } /// - /// 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). /// public async Task CreateAsync(CreateRequest request) { @@ -309,7 +309,7 @@ await _seam.PostAsync("/user_identities/create", requestOptions) } /// - /// 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). /// public async Task CreateAsync( List? acsSystemIds = default, @@ -373,7 +373,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -383,7 +383,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete(string userIdentityId = default) { @@ -391,7 +391,7 @@ public void Delete(string userIdentityId = default) } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -401,7 +401,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync(string userIdentityId = default) { @@ -505,7 +505,7 @@ public override string ToString() } /// - /// 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). /// public InstantKey GenerateInstantKey(GenerateInstantKeyRequest request) { @@ -521,7 +521,7 @@ public InstantKey GenerateInstantKey(GenerateInstantKeyRequest request) } /// - /// 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). /// public InstantKey GenerateInstantKey( string? customizationProfileId = default, @@ -539,7 +539,7 @@ public InstantKey GenerateInstantKey( } /// - /// 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). /// public async Task GenerateInstantKeyAsync(GenerateInstantKeyRequest request) { @@ -556,7 +556,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task GenerateInstantKeyAsync( string? customizationProfileId = default, @@ -657,7 +657,7 @@ public override string ToString() } /// - /// 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). /// public UserIdentity Get(GetRequest request) { @@ -670,7 +670,7 @@ public UserIdentity Get(GetRequest request) } /// - /// 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). /// public UserIdentity Get(string? userIdentityId = default, string? userIdentityKey = default) { @@ -680,7 +680,7 @@ public UserIdentity Get(string? userIdentityId = default, string? userIdentityKe } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -692,7 +692,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync( string? userIdentityId = default, @@ -757,7 +757,7 @@ public override string ToString() } /// - /// 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). /// public void GrantAccessToDevice(GrantAccessToDeviceRequest request) { @@ -767,7 +767,7 @@ public void GrantAccessToDevice(GrantAccessToDeviceRequest request) } /// - /// 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). /// public void GrantAccessToDevice(string deviceId = default, string userIdentityId = default) { @@ -777,7 +777,7 @@ public void GrantAccessToDevice(string deviceId = default, string userIdentityId } /// - /// 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). /// public async Task GrantAccessToDeviceAsync(GrantAccessToDeviceRequest request) { @@ -787,7 +787,7 @@ public async Task GrantAccessToDeviceAsync(GrantAccessToDeviceRequest request) } /// - /// 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). /// public async Task GrantAccessToDeviceAsync( string deviceId = default, @@ -923,7 +923,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -936,7 +936,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? createdBefore = default, @@ -960,7 +960,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -972,7 +972,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? createdBefore = default, @@ -1075,7 +1075,7 @@ public override string ToString() } /// - /// 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. /// public List ListAccessibleDevices(ListAccessibleDevicesRequest request) { @@ -1091,7 +1091,7 @@ public List ListAccessibleDevices(ListAccessibleDevicesRequest request) } /// - /// 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. /// public List ListAccessibleDevices(string userIdentityId = default) { @@ -1101,7 +1101,7 @@ public List ListAccessibleDevices(string userIdentityId = default) } /// - /// 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. /// public async Task> ListAccessibleDevicesAsync( ListAccessibleDevicesRequest request @@ -1120,7 +1120,7 @@ await _seam.GetAsync( } /// - /// 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. /// public async Task> ListAccessibleDevicesAsync(string userIdentityId = default) { @@ -1209,7 +1209,7 @@ public override string ToString() } /// - /// 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. /// public List ListAccessibleEntrances(ListAccessibleEntrancesRequest request) { @@ -1225,7 +1225,7 @@ public List ListAccessibleEntrances(ListAccessibleEntrancesRequest } /// - /// 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. /// public List ListAccessibleEntrances(string userIdentityId = default) { @@ -1235,7 +1235,7 @@ public List ListAccessibleEntrances(string userIdentityId = default } /// - /// 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. /// public async Task> ListAccessibleEntrancesAsync( ListAccessibleEntrancesRequest request @@ -1254,7 +1254,7 @@ await _seam.GetAsync( } /// - /// 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. /// public async Task> ListAccessibleEntrancesAsync( string userIdentityId = default @@ -1345,7 +1345,7 @@ public override string ToString() } /// - /// 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). /// public List ListAcsSystems(ListAcsSystemsRequest request) { @@ -1358,7 +1358,7 @@ public List ListAcsSystems(ListAcsSystemsRequest request) } /// - /// 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). /// public List ListAcsSystems(string userIdentityId = default) { @@ -1366,7 +1366,7 @@ public List ListAcsSystems(string userIdentityId = default) } /// - /// 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). /// public async Task> ListAcsSystemsAsync(ListAcsSystemsRequest request) { @@ -1383,7 +1383,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListAcsSystemsAsync(string userIdentityId = default) { @@ -1470,7 +1470,7 @@ public override string ToString() } /// - /// 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). /// public List ListAcsUsers(ListAcsUsersRequest request) { @@ -1483,7 +1483,7 @@ public List ListAcsUsers(ListAcsUsersRequest request) } /// - /// 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). /// public List ListAcsUsers(string userIdentityId = default) { @@ -1491,7 +1491,7 @@ public List ListAcsUsers(string userIdentityId = default) } /// - /// 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). /// public async Task> ListAcsUsersAsync(ListAcsUsersRequest request) { @@ -1508,7 +1508,7 @@ await _seam.GetAsync( } /// - /// 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). /// public async Task> ListAcsUsersAsync(string userIdentityId = default) { @@ -1592,7 +1592,7 @@ public override string ToString() } /// - /// 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`. /// @@ -1608,7 +1608,7 @@ public void Merge(MergeRequest request) } /// - /// 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`. /// @@ -1634,7 +1634,7 @@ public void Merge( } /// - /// 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`. /// @@ -1650,7 +1650,7 @@ public async Task MergeAsync(MergeRequest request) } /// - /// 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`. /// @@ -1723,7 +1723,7 @@ public override string ToString() } /// - /// 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). /// public void RemoveAcsUser(RemoveAcsUserRequest request) { @@ -1733,7 +1733,7 @@ public void RemoveAcsUser(RemoveAcsUserRequest request) } /// - /// 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). /// public void RemoveAcsUser(string acsUserId = default, string userIdentityId = default) { @@ -1743,7 +1743,7 @@ public void RemoveAcsUser(string acsUserId = default, string userIdentityId = de } /// - /// 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). /// public async Task RemoveAcsUserAsync(RemoveAcsUserRequest request) { @@ -1753,7 +1753,7 @@ public async Task RemoveAcsUserAsync(RemoveAcsUserRequest request) } /// - /// 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). /// public async Task RemoveAcsUserAsync( string acsUserId = default, @@ -1816,7 +1816,7 @@ public override string ToString() } /// - /// 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). /// public void RevokeAccessToDevice(RevokeAccessToDeviceRequest request) { @@ -1826,7 +1826,7 @@ public void RevokeAccessToDevice(RevokeAccessToDeviceRequest request) } /// - /// 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). /// public void RevokeAccessToDevice(string deviceId = default, string userIdentityId = default) { @@ -1836,7 +1836,7 @@ public void RevokeAccessToDevice(string deviceId = default, string userIdentityI } /// - /// 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). /// public async Task RevokeAccessToDeviceAsync(RevokeAccessToDeviceRequest request) { @@ -1849,7 +1849,7 @@ await _seam.DeleteAsync( } /// - /// 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). /// public async Task RevokeAccessToDeviceAsync( string deviceId = default, @@ -1936,7 +1936,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -1946,7 +1946,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( string? emailAddress = default, @@ -1968,7 +1968,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -1978,7 +1978,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( string? emailAddress = default, diff --git a/src/Seam/Api/UsersAcs.cs b/src/Seam/Api/UsersAcs.cs index 152d54ca..8d2033a3 100644 --- a/src/Seam/Api/UsersAcs.cs +++ b/src/Seam/Api/UsersAcs.cs @@ -69,7 +69,7 @@ public override string ToString() } /// - /// 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). /// public void AddToAccessGroup(AddToAccessGroupRequest request) { @@ -79,7 +79,7 @@ public void AddToAccessGroup(AddToAccessGroupRequest request) } /// - /// 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). /// public void AddToAccessGroup(string acsAccessGroupId = default, string acsUserId = default) { @@ -92,7 +92,7 @@ public void AddToAccessGroup(string acsAccessGroupId = default, string acsUserId } /// - /// 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). /// public async Task AddToAccessGroupAsync(AddToAccessGroupRequest request) { @@ -102,7 +102,7 @@ public async Task AddToAccessGroupAsync(AddToAccessGroupRequest request) } /// - /// 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). /// public async Task AddToAccessGroupAsync( string acsAccessGroupId = default, @@ -174,7 +174,7 @@ public CreateRequest( public string? Email { get; set; } /// - /// 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). /// [DataMember(Name = "email_address", IsRequired = false, EmitDefaultValue = false)] public string? EmailAddress { get; set; } @@ -186,7 +186,7 @@ public CreateRequest( public string FullName { get; set; } /// - /// 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`). /// [DataMember(Name = "phone_number", IsRequired = false, EmitDefaultValue = false)] public string? PhoneNumber { get; set; } @@ -299,7 +299,7 @@ public override string ToString() } /// - /// 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). /// public AcsUser Create(CreateRequest request) { @@ -312,7 +312,7 @@ public AcsUser Create(CreateRequest request) } /// - /// 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). /// public AcsUser Create( CreateRequestAccessSchedule? accessSchedule = default, @@ -340,7 +340,7 @@ public AcsUser Create( } /// - /// 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). /// public async Task CreateAsync(CreateRequest request) { @@ -352,7 +352,7 @@ public async Task CreateAsync(CreateRequest request) } /// - /// 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). /// public async Task CreateAsync( CreateRequestAccessSchedule? accessSchedule = default, @@ -440,7 +440,7 @@ public override string ToString() } /// - /// 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). /// public void Delete(DeleteRequest request) { @@ -450,7 +450,7 @@ public void Delete(DeleteRequest request) } /// - /// 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). /// public void Delete( string? acsSystemId = default, @@ -468,7 +468,7 @@ public void Delete( } /// - /// 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). /// public async Task DeleteAsync(DeleteRequest request) { @@ -478,7 +478,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// 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). /// public async Task DeleteAsync( string? acsSystemId = default, @@ -591,7 +591,7 @@ public override string ToString() } /// - /// 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). /// public AcsUser Get(GetRequest request) { @@ -604,7 +604,7 @@ public AcsUser Get(GetRequest request) } /// - /// 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). /// public AcsUser Get( string? acsSystemId = default, @@ -622,7 +622,7 @@ public AcsUser Get( } /// - /// 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). /// public async Task GetAsync(GetRequest request) { @@ -634,7 +634,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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). /// public async Task GetAsync( string? acsSystemId = default, @@ -797,7 +797,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -810,7 +810,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List( string? acsSystemId = default, @@ -838,7 +838,7 @@ public List List( } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -850,7 +850,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync( string? acsSystemId = default, @@ -975,7 +975,7 @@ public override string ToString() } /// - /// 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. /// public List ListAccessibleEntrances(ListAccessibleEntrancesRequest request) { @@ -991,7 +991,7 @@ public List ListAccessibleEntrances(ListAccessibleEntrancesRequest } /// - /// 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. /// public List ListAccessibleEntrances( string? acsSystemId = default, @@ -1009,7 +1009,7 @@ public List ListAccessibleEntrances( } /// - /// 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. /// public async Task> ListAccessibleEntrancesAsync( ListAccessibleEntrancesRequest request @@ -1028,7 +1028,7 @@ await _seam.GetAsync( } /// - /// 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. /// public async Task> ListAccessibleEntrancesAsync( string? acsSystemId = default, @@ -1106,7 +1106,7 @@ public override string ToString() } /// - /// 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). /// public void RemoveFromAccessGroup(RemoveFromAccessGroupRequest request) { @@ -1116,7 +1116,7 @@ public void RemoveFromAccessGroup(RemoveFromAccessGroupRequest request) } /// - /// 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). /// public void RemoveFromAccessGroup( string acsAccessGroupId = default, @@ -1134,7 +1134,7 @@ public void RemoveFromAccessGroup( } /// - /// 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). /// public async Task RemoveFromAccessGroupAsync(RemoveFromAccessGroupRequest request) { @@ -1144,7 +1144,7 @@ public async Task RemoveFromAccessGroupAsync(RemoveFromAccessGroupRequest reques } /// - /// 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). /// public async Task RemoveFromAccessGroupAsync( string acsAccessGroupId = default, @@ -1220,7 +1220,7 @@ public override string ToString() } /// - /// 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). /// public void RevokeAccessToAllEntrances(RevokeAccessToAllEntrancesRequest request) { @@ -1230,7 +1230,7 @@ public void RevokeAccessToAllEntrances(RevokeAccessToAllEntrancesRequest request } /// - /// 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). /// public void RevokeAccessToAllEntrances( string? acsSystemId = default, @@ -1248,7 +1248,7 @@ public void RevokeAccessToAllEntrances( } /// - /// 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). /// public async Task RevokeAccessToAllEntrancesAsync(RevokeAccessToAllEntrancesRequest request) { @@ -1261,7 +1261,7 @@ await _seam.PostAsync( } /// - /// 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). /// public async Task RevokeAccessToAllEntrancesAsync( string? acsSystemId = default, @@ -1337,7 +1337,7 @@ public override string ToString() } /// - /// [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. /// public void Suspend(SuspendRequest request) { @@ -1347,7 +1347,7 @@ public void Suspend(SuspendRequest request) } /// - /// [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. /// public void Suspend( string? acsSystemId = default, @@ -1365,7 +1365,7 @@ public void Suspend( } /// - /// [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. /// public async Task SuspendAsync(SuspendRequest request) { @@ -1375,7 +1375,7 @@ public async Task SuspendAsync(SuspendRequest request) } /// - /// [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. /// public async Task SuspendAsync( string? acsSystemId = default, @@ -1451,7 +1451,7 @@ public override string ToString() } /// - /// [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. /// public void Unsuspend(UnsuspendRequest request) { @@ -1461,7 +1461,7 @@ public void Unsuspend(UnsuspendRequest request) } /// - /// [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. /// public void Unsuspend( string? acsSystemId = default, @@ -1479,7 +1479,7 @@ public void Unsuspend( } /// - /// [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. /// public async Task UnsuspendAsync(UnsuspendRequest request) { @@ -1489,7 +1489,7 @@ public async Task UnsuspendAsync(UnsuspendRequest request) } /// - /// [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. /// public async Task UnsuspendAsync( string? acsSystemId = default, @@ -1561,13 +1561,13 @@ public UpdateRequest( public string? Email { get; set; } /// - /// 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). /// [DataMember(Name = "email_address", IsRequired = false, EmitDefaultValue = false)] public string? EmailAddress { get; set; } /// - /// 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). /// [DataMember(Name = "full_name", IsRequired = false, EmitDefaultValue = false)] public string? FullName { get; set; } @@ -1579,7 +1579,7 @@ public UpdateRequest( public string? HidAcsSystemId { get; set; } /// - /// 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`). /// [DataMember(Name = "phone_number", IsRequired = false, EmitDefaultValue = false)] public string? PhoneNumber { get; set; } @@ -1655,7 +1655,7 @@ public override string ToString() } /// - /// 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). /// public void Update(UpdateRequest request) { @@ -1665,7 +1665,7 @@ public void Update(UpdateRequest request) } /// - /// 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). /// public void Update( UpdateRequestAccessSchedule? accessSchedule = default, @@ -1695,7 +1695,7 @@ public void Update( } /// - /// 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). /// public async Task UpdateAsync(UpdateRequest request) { @@ -1705,7 +1705,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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). /// public async Task UpdateAsync( UpdateRequestAccessSchedule? accessSchedule = default, diff --git a/src/Seam/Api/Webhooks.cs b/src/Seam/Api/Webhooks.cs index 7256e4e1..ec7eb480 100644 --- a/src/Seam/Api/Webhooks.cs +++ b/src/Seam/Api/Webhooks.cs @@ -103,7 +103,7 @@ public override string ToString() } /// - /// Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public Webhook Create(CreateRequest request) { @@ -116,7 +116,7 @@ public Webhook Create(CreateRequest request) } /// - /// Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public Webhook Create(List? eventTypes = default, string url = default) { @@ -124,7 +124,7 @@ public Webhook Create(List? eventTypes = default, string url = default) } /// - /// Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task CreateAsync(CreateRequest request) { @@ -136,7 +136,7 @@ public async Task CreateAsync(CreateRequest request) } /// - /// Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task CreateAsync( List? eventTypes = default, @@ -187,7 +187,7 @@ public override string ToString() } /// - /// Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public void Delete(DeleteRequest request) { @@ -197,7 +197,7 @@ public void Delete(DeleteRequest request) } /// - /// Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public void Delete(string webhookId = default) { @@ -205,7 +205,7 @@ public void Delete(string webhookId = default) } /// - /// Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task DeleteAsync(DeleteRequest request) { @@ -215,7 +215,7 @@ public async Task DeleteAsync(DeleteRequest request) } /// - /// Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task DeleteAsync(string webhookId = default) { @@ -300,7 +300,7 @@ public override string ToString() } /// - /// Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public Webhook Get(GetRequest request) { @@ -313,7 +313,7 @@ public Webhook Get(GetRequest request) } /// - /// Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public Webhook Get(string webhookId = default) { @@ -321,7 +321,7 @@ public Webhook Get(string webhookId = default) } /// - /// Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task GetAsync(GetRequest request) { @@ -333,7 +333,7 @@ public async Task GetAsync(GetRequest request) } /// - /// Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task GetAsync(string webhookId = default) { @@ -407,7 +407,7 @@ public override string ToString() } /// - /// 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). /// public List List(ListRequest request) { @@ -420,7 +420,7 @@ public List List(ListRequest request) } /// - /// 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). /// public List List() { @@ -428,7 +428,7 @@ public List List() } /// - /// 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). /// public async Task> ListAsync(ListRequest request) { @@ -440,7 +440,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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). /// public async Task> ListAsync() { @@ -495,7 +495,7 @@ public override string ToString() } /// - /// Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public void Update(UpdateRequest request) { @@ -505,7 +505,7 @@ public void Update(UpdateRequest request) } /// - /// Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public void Update(List eventTypes = default, string webhookId = default) { @@ -513,7 +513,7 @@ public void Update(List eventTypes = default, string webhookId = default } /// - /// Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task UpdateAsync(UpdateRequest request) { @@ -523,7 +523,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + /// Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// public async Task UpdateAsync(List eventTypes = default, string webhookId = default) { diff --git a/src/Seam/Api/Workspaces.cs b/src/Seam/Api/Workspaces.cs index 98772b55..eb4350b9 100644 --- a/src/Seam/Api/Workspaces.cs +++ b/src/Seam/Api/Workspaces.cs @@ -83,7 +83,7 @@ public enum WebviewLogoShapeEnum public string? ConnectPartnerName { get; set; } /// - /// [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). + /// [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). /// [DataMember( Name = "connect_webview_customization", @@ -93,7 +93,7 @@ public enum WebviewLogoShapeEnum public CreateRequestConnectWebviewCustomization? ConnectWebviewCustomization { get; set; } /// - /// Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + /// Indicates whether the new workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). /// [DataMember(Name = "is_sandbox", IsRequired = false, EmitDefaultValue = false)] public bool? IsSandbox { get; set; } @@ -105,7 +105,7 @@ public enum WebviewLogoShapeEnum public string Name { get; set; } /// - /// 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. + /// 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. /// [DataMember(Name = "organization_id", IsRequired = false, EmitDefaultValue = false)] public string? OrganizationId { get; set; } @@ -180,7 +180,7 @@ public CreateRequestConnectWebviewCustomization( } /// - /// Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in 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). + /// Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum LogoShapeEnum @@ -196,13 +196,13 @@ public enum LogoShapeEnum } /// - /// Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in 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). + /// Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in 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). /// [DataMember(Name = "logo_shape", IsRequired = false, EmitDefaultValue = false)] public CreateRequestConnectWebviewCustomization.LogoShapeEnum? LogoShape { get; set; } /// - /// Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in 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). + /// Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in 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). /// [DataMember( Name = "primary_button_color", @@ -212,7 +212,7 @@ public enum LogoShapeEnum public string? PrimaryButtonColor { get; set; } /// - /// Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in 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). + /// Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in 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). /// [DataMember( Name = "primary_button_text_color", @@ -222,7 +222,7 @@ public enum LogoShapeEnum public string? PrimaryButtonTextColor { get; set; } /// - /// Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in 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). + /// Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in 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). /// [DataMember(Name = "success_message", IsRequired = false, EmitDefaultValue = false)] public string? SuccessMessage { get; set; } @@ -285,7 +285,7 @@ public override string ToString() } /// - /// Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + /// Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). /// public Workspace Create(CreateRequest request) { @@ -298,7 +298,7 @@ public Workspace Create(CreateRequest request) } /// - /// Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + /// Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). /// public Workspace Create( string? companyName = default, @@ -330,7 +330,7 @@ public Workspace Create( } /// - /// Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + /// Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). /// public async Task CreateAsync(CreateRequest request) { @@ -342,7 +342,7 @@ public async Task CreateAsync(CreateRequest request) } /// - /// Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + /// Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). /// public async Task CreateAsync( string? companyName = default, @@ -442,7 +442,7 @@ public override string ToString() } /// - /// 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. /// public Workspace Get(GetRequest request) { @@ -455,7 +455,7 @@ public Workspace Get(GetRequest request) } /// - /// 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. /// public Workspace Get() { @@ -463,7 +463,7 @@ public Workspace Get() } /// - /// 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. /// public async Task GetAsync(GetRequest request) { @@ -475,7 +475,7 @@ public async Task GetAsync(GetRequest request) } /// - /// 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. /// public async Task GetAsync() { @@ -549,7 +549,7 @@ public override string ToString() } /// - /// 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. /// public List List(ListRequest request) { @@ -562,7 +562,7 @@ public List List(ListRequest request) } /// - /// 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. /// public List List() { @@ -570,7 +570,7 @@ public List List() } /// - /// 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. /// public async Task> ListAsync(ListRequest request) { @@ -582,7 +582,7 @@ public async Task> ListAsync(ListRequest request) } /// - /// 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. /// public async Task> ListAsync() { @@ -656,7 +656,7 @@ public override string ToString() } /// - /// 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. /// public ActionAttempt ResetSandbox(ResetSandboxRequest request) { @@ -669,7 +669,7 @@ public ActionAttempt ResetSandbox(ResetSandboxRequest request) } /// - /// 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. /// public ActionAttempt ResetSandbox() { @@ -677,7 +677,7 @@ public ActionAttempt ResetSandbox() } /// - /// 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. /// public async Task ResetSandboxAsync(ResetSandboxRequest request) { @@ -694,7 +694,7 @@ await _seam.PostAsync( } /// - /// 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. /// public async Task ResetSandboxAsync() { @@ -738,7 +738,7 @@ public UpdateRequest( public string? ConnectPartnerName { get; set; } /// - /// [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). + /// [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). /// [DataMember( Name = "connect_webview_customization", @@ -815,7 +815,7 @@ public UpdateRequestConnectWebviewCustomization( } /// - /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum LogoShapeEnum @@ -831,13 +831,13 @@ public enum LogoShapeEnum } /// - /// 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). /// [DataMember(Name = "logo_shape", IsRequired = false, EmitDefaultValue = false)] public UpdateRequestConnectWebviewCustomization.LogoShapeEnum? LogoShape { get; set; } /// - /// 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). /// [DataMember( Name = "primary_button_color", @@ -847,7 +847,7 @@ public enum LogoShapeEnum public string? PrimaryButtonColor { get; set; } /// - /// 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). /// [DataMember( Name = "primary_button_text_color", @@ -857,7 +857,7 @@ public enum LogoShapeEnum public string? PrimaryButtonTextColor { get; set; } /// - /// 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). /// [DataMember(Name = "success_message", IsRequired = false, EmitDefaultValue = false)] public string? SuccessMessage { get; set; } @@ -883,7 +883,7 @@ public override string ToString() } /// - /// 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. /// public void Update(UpdateRequest request) { @@ -893,7 +893,7 @@ public void Update(UpdateRequest request) } /// - /// 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. /// public void Update( string? connectPartnerName = default, @@ -917,7 +917,7 @@ public void Update( } /// - /// 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. /// public async Task UpdateAsync(UpdateRequest request) { @@ -927,7 +927,7 @@ public async Task UpdateAsync(UpdateRequest request) } /// - /// 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. /// public async Task UpdateAsync( string? connectPartnerName = default, diff --git a/src/Seam/Model/AccessCode.cs b/src/Seam/Model/AccessCode.cs index d252dad6..8b12561a 100644 --- a/src/Seam/Model/AccessCode.cs +++ b/src/Seam/Model/AccessCode.cs @@ -9,15 +9,15 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_accessCode_model")] public class AccessCode @@ -31,6 +31,7 @@ public AccessCode( string? commonCodeKey = default, string createdAt = default, string deviceId = default, + string displayStatus = default, AccessCodeDormakabaOracodeMetadata? dormakabaOracodeMetadata = default, string? endsAt = default, List errors = default, @@ -57,6 +58,7 @@ public AccessCode( CommonCodeKey = commonCodeKey; CreatedAt = createdAt; DeviceId = deviceId; + DisplayStatus = displayStatus; DormakabaOracodeMetadata = dormakabaOracodeMetadata; EndsAt = endsAt; Errors = errors; @@ -127,7 +129,7 @@ public AccessCode( typeof(AccessCodeErrorsAccountDisconnected), "account_disconnected" )] - [JsonSubtypes.KnownSubType(typeof(AccessCodeErrorsFailedToExpire), "failed_to_expire")] + [JsonSubtypes.KnownSubType(typeof(AccessCodeErrorsFailedToDelete), "failed_to_delete")] [JsonSubtypes.KnownSubType(typeof(AccessCodeErrorsFailedToUpdate), "failed_to_update")] [JsonSubtypes.KnownSubType(typeof(AccessCodeErrorsFailedToIssue), "failed_to_issue")] [JsonSubtypes.KnownSubType( @@ -923,13 +925,13 @@ public override string ToString() } } - [DataContract(Name = "seamModel_accessCodeErrorsFailedToExpire_model")] - public class AccessCodeErrorsFailedToExpire : AccessCodeErrors + [DataContract(Name = "seamModel_accessCodeErrorsFailedToDelete_model")] + public class AccessCodeErrorsFailedToDelete : AccessCodeErrors { [JsonConstructorAttribute] - protected AccessCodeErrorsFailedToExpire() { } + protected AccessCodeErrorsFailedToDelete() { } - public AccessCodeErrorsFailedToExpire( + public AccessCodeErrorsFailedToDelete( string? createdAt = default, string errorCode = default, bool isAccessCodeError = default, @@ -949,7 +951,7 @@ public AccessCodeErrorsFailedToExpire( public string? CreatedAt { get; set; } [DataMember(Name = "error_code", IsRequired = true, EmitDefaultValue = false)] - public override string ErrorCode { get; } = "failed_to_expire"; + public override string ErrorCode { get; } = "failed_to_delete"; /// /// Indicates that this is an access code error. @@ -1018,7 +1020,7 @@ public AccessCodeErrorsAccountDisconnected( public override string ErrorCode { get; } = "account_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1090,7 +1092,7 @@ public AccessCodeErrorsSaltoKsSubscriptionLimitExceeded( public override string ErrorCode { get; } = "salto_ks_subscription_limit_exceeded"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1162,7 +1164,7 @@ public AccessCodeErrorsInsufficientPermissions( public override string ErrorCode { get; } = "insufficient_permissions"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1234,7 +1236,7 @@ public AccessCodeErrorsDormakabaSitesDisconnected( public override string ErrorCode { get; } = "dormakaba_sites_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1846,7 +1848,7 @@ public AccessCodeErrorsBridgeDisconnected( public override string ErrorCode { get; } = "bridge_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public bool? IsBridgeError { get; set; } @@ -2619,7 +2621,7 @@ public override string ToString() } /// - /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum StatusEnum @@ -3516,6 +3518,12 @@ public override string ToString() [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] public string DeviceId { get; set; } + /// + /// Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. + /// + [DataMember(Name = "display_status", IsRequired = false, EmitDefaultValue = false)] + public string DisplayStatus { get; set; } + /// /// Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices. /// @@ -3533,7 +3541,7 @@ public override string ToString() public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -3627,8 +3635,11 @@ public override string ToString() public string? StartsAt { get; set; } /// - /// 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). /// + [Obsolete( + "Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`." + )] [DataMember(Name = "status", IsRequired = false, EmitDefaultValue = false)] public AccessCode.StatusEnum Status { get; set; } @@ -3639,7 +3650,7 @@ public override string ToString() public AccessCode.TypeEnum Type { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/AccessGrant.cs b/src/Seam/Model/AccessGrant.cs index fb87ee44..12f7c71b 100644 --- a/src/Seam/Model/AccessGrant.cs +++ b/src/Seam/Model/AccessGrant.cs @@ -1242,7 +1242,7 @@ public override string ToString() public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -1304,7 +1304,7 @@ public override string ToString() public string UserIdentityId { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/AccessMethod.cs b/src/Seam/Model/AccessMethod.cs index f8635235..84023914 100644 --- a/src/Seam/Model/AccessMethod.cs +++ b/src/Seam/Model/AccessMethod.cs @@ -729,6 +729,14 @@ public override string ToString() [JsonConverter(typeof(JsonSubtypes), "warning_code")] [JsonSubtypes.FallBackSubType(typeof(AccessMethodWarningsUnrecognized))] + [JsonSubtypes.KnownSubType( + typeof(AccessMethodWarningsUserIdentityMissingPhoneNumber), + "user_identity_missing_phone_number" + )] + [JsonSubtypes.KnownSubType( + typeof(AccessMethodWarningsUserIdentityMissingEmailAddress), + "user_identity_missing_email_address" + )] [JsonSubtypes.KnownSubType(typeof(AccessMethodWarningsDelayInIssuing), "delay_in_issuing")] [JsonSubtypes.KnownSubType( typeof(AccessMethodWarningsPulledBackupAccessCode), @@ -970,6 +978,110 @@ public override string ToString() } } + [DataContract(Name = "seamModel_accessMethodWarningsUserIdentityMissingEmailAddress_model")] + public class AccessMethodWarningsUserIdentityMissingEmailAddress : AccessMethodWarnings + { + [JsonConstructorAttribute] + protected AccessMethodWarningsUserIdentityMissingEmailAddress() { } + + public AccessMethodWarningsUserIdentityMissingEmailAddress( + string createdAt = default, + string message = default, + string warningCode = default + ) + { + CreatedAt = createdAt; + Message = message; + WarningCode = warningCode; + } + + /// + /// Date and time at which Seam created the warning. + /// + [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] + public override string CreatedAt { get; set; } + + /// + /// Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + /// + [DataMember(Name = "message", IsRequired = false, EmitDefaultValue = false)] + public override string Message { get; set; } + + [DataMember(Name = "warning_code", IsRequired = true, EmitDefaultValue = false)] + public override string WarningCode { get; } = "user_identity_missing_email_address"; + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "seamModel_accessMethodWarningsUserIdentityMissingPhoneNumber_model")] + public class AccessMethodWarningsUserIdentityMissingPhoneNumber : AccessMethodWarnings + { + [JsonConstructorAttribute] + protected AccessMethodWarningsUserIdentityMissingPhoneNumber() { } + + public AccessMethodWarningsUserIdentityMissingPhoneNumber( + string createdAt = default, + string message = default, + string warningCode = default + ) + { + CreatedAt = createdAt; + Message = message; + WarningCode = warningCode; + } + + /// + /// Date and time at which Seam created the warning. + /// + [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] + public override string CreatedAt { get; set; } + + /// + /// Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + /// + [DataMember(Name = "message", IsRequired = false, EmitDefaultValue = false)] + public override string Message { get; set; } + + [DataMember(Name = "warning_code", IsRequired = true, EmitDefaultValue = false)] + public override string WarningCode { get; } = "user_identity_missing_phone_number"; + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + [DataContract(Name = "seamModel_accessMethodWarningsUnrecognized_model")] public class AccessMethodWarningsUnrecognized : AccessMethodWarnings { @@ -1069,7 +1181,7 @@ public override string ToString() public string DisplayStatus { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -1123,13 +1235,13 @@ public override string ToString() public AccessMethod.ModeEnum Mode { get; set; } /// - /// 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. /// [DataMember(Name = "pending_mutations", IsRequired = false, EmitDefaultValue = false)] public List PendingMutations { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/AcsAccessGroup.cs b/src/Seam/Model/AcsAccessGroup.cs index 3398e6e1..4f932a09 100644 --- a/src/Seam/Model/AcsAccessGroup.cs +++ b/src/Seam/Model/AcsAccessGroup.cs @@ -11,9 +11,9 @@ namespace Seam.Model /// /// 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). /// [DataContract(Name = "seamModel_acsAccessGroup_model")] public class AcsAccessGroup diff --git a/src/Seam/Model/AcsCredential.cs b/src/Seam/Model/AcsCredential.cs index 6d821eb1..79fb5210 100644 --- a/src/Seam/Model/AcsCredential.cs +++ b/src/Seam/Model/AcsCredential.cs @@ -9,13 +9,13 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_acsCredential_model")] public class AcsCredential @@ -87,7 +87,7 @@ public AcsCredential( } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum AccessMethodEnum @@ -109,7 +109,7 @@ public enum AccessMethodEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ExternalTypeEnum @@ -631,13 +631,13 @@ public override string ToString() } /// - /// 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`. /// [DataMember(Name = "access_method", IsRequired = false, EmitDefaultValue = false)] public AcsCredential.AccessMethodEnum AccessMethod { get; set; } /// - /// 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). /// [DataMember(Name = "acs_credential_id", IsRequired = false, EmitDefaultValue = false)] public string AcsCredentialId { get; set; } @@ -649,25 +649,25 @@ public override string ToString() public string? AcsCredentialPoolId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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. /// [DataMember(Name = "acs_user_id", IsRequired = false, EmitDefaultValue = false)] public string? AcsUserId { get; set; } /// - /// 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). /// [DataMember(Name = "akiles_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsCredentialAkilesMetadata? AkilesMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "assa_abloy_vostio_metadata", @@ -677,55 +677,55 @@ public override string ToString() public AcsCredentialAssaAbloyVostioMetadata? AssaAbloyVostioMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "card_number", IsRequired = false, EmitDefaultValue = false)] public string? CardNumber { get; set; } /// - /// 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). /// [DataMember(Name = "code", IsRequired = false, EmitDefaultValue = false)] public string? Code { get; set; } /// - /// 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. /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } /// - /// 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`. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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`. /// [DataMember(Name = "external_type", IsRequired = false, EmitDefaultValue = false)] public AcsCredential.ExternalTypeEnum? ExternalType { get; set; } /// - /// 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. /// [DataMember( Name = "external_type_display_name", @@ -735,13 +735,13 @@ public override string ToString() public string? ExternalTypeDisplayName { get; set; } /// - /// 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. /// [DataMember(Name = "is_issued", IsRequired = false, EmitDefaultValue = false)] public bool? IsIssued { get; set; } /// - /// 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. /// [DataMember( Name = "is_latest_desired_state_synced_with_provider", @@ -757,7 +757,7 @@ public override string ToString() public bool IsManaged { get; set; } /// - /// 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). /// [DataMember( Name = "is_multi_phone_sync_credential", @@ -767,19 +767,19 @@ public override string ToString() public bool? IsMultiPhoneSyncCredential { get; set; } /// - /// 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. /// [DataMember(Name = "is_one_time_use", IsRequired = false, EmitDefaultValue = false)] public bool? IsOneTimeUse { get; set; } /// - /// 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. /// [DataMember(Name = "issued_at", IsRequired = false, EmitDefaultValue = false)] public string? IssuedAt { get; set; } /// - /// 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. /// [DataMember( Name = "latest_desired_state_synced_with_provider_at", @@ -789,7 +789,7 @@ public override string ToString() public string? LatestDesiredStateSyncedWithProviderAt { get; set; } /// - /// 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). /// [DataMember( Name = "parent_acs_credential_id", @@ -799,31 +799,31 @@ public override string ToString() public string? ParentAcsCredentialId { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string? StartsAt { get; set; } /// - /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsCredentialVisionlineMetadata? VisionlineMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } diff --git a/src/Seam/Model/AcsEncoder.cs b/src/Seam/Model/AcsEncoder.cs index 196d35b7..55bf4f0a 100644 --- a/src/Seam/Model/AcsEncoder.cs +++ b/src/Seam/Model/AcsEncoder.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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: /// @@ -20,9 +20,9 @@ namespace Seam.Model /// /// 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). /// [DataContract(Name = "seamModel_acsEncoder_model")] public class AcsEncoder @@ -50,43 +50,43 @@ public AcsEncoder( } /// - /// 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). /// [DataMember(Name = "acs_encoder_id", IsRequired = false, EmitDefaultValue = false)] public string AcsEncoderId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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). /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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). /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } diff --git a/src/Seam/Model/AcsEntrance.cs b/src/Seam/Model/AcsEntrance.cs index 26ce81fd..c887da9b 100644 --- a/src/Seam/Model/AcsEntrance.cs +++ b/src/Seam/Model/AcsEntrance.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// @@ -421,25 +421,25 @@ public override string ToString() } /// - /// 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). /// [DataMember(Name = "acs_entrance_id", IsRequired = false, EmitDefaultValue = false)] public string AcsEntranceId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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). /// [DataMember(Name = "akiles_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceAkilesMetadata? AkilesMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "assa_abloy_vostio_metadata", @@ -449,13 +449,13 @@ public override string ToString() public AcsEntranceAssaAbloyVostioMetadata? AssaAbloyVostioMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "avigilon_alta_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceAvigilonAltaMetadata? AvigilonAltaMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "brivo_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceBrivoMetadata? BrivoMetadata { get; set; } @@ -503,25 +503,25 @@ public override string ToString() public bool? CanUnlockWithMobileKey { get; set; } /// - /// 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). /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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). /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } /// - /// 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). /// [DataMember( Name = "dormakaba_ambiance_metadata", @@ -531,7 +531,7 @@ public override string ToString() public AcsEntranceDormakabaAmbianceMetadata? DormakabaAmbianceMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "dormakaba_community_metadata", @@ -541,37 +541,37 @@ public override string ToString() public AcsEntranceDormakabaCommunityMetadata? DormakabaCommunityMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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). /// [DataMember(Name = "hotek_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceHotekMetadata? HotekMetadata { get; set; } /// - /// 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. /// [DataMember(Name = "is_locked", IsRequired = false, EmitDefaultValue = false)] public bool? IsLocked { get; set; } /// - /// 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). /// [DataMember(Name = "latch_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceLatchMetadata? LatchMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "salto_ks_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceSaltoKsMetadata? SaltoKsMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "salto_space_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceSaltoSpaceMetadata? SaltoSpaceMetadata { get; set; } @@ -583,13 +583,13 @@ public override string ToString() public List SpaceIds { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsEntranceVisionlineMetadata? VisionlineMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/AcsSystem.cs b/src/Seam/Model/AcsSystem.cs index 364eb5e0..3b976465 100644 --- a/src/Seam/Model/AcsSystem.cs +++ b/src/Seam/Model/AcsSystem.cs @@ -9,11 +9,11 @@ namespace Seam.Model { /// - /// 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). /// [DataContract(Name = "seamModel_acsSystem_model")] public class AcsSystem @@ -196,7 +196,7 @@ public AcsSystemErrorsBridgeDisconnected( public override string ErrorCode { get; } = "bridge_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public bool? IsBridgeError { get; set; } @@ -644,7 +644,7 @@ public override string ToString() } /// - /// 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. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ExternalTypeEnum @@ -1062,44 +1062,44 @@ public override string ToString() } /// - /// 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). /// [DataMember(Name = "acs_access_group_count", IsRequired = false, EmitDefaultValue = false)] public float? AcsAccessGroupCount { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_user_count", IsRequired = false, EmitDefaultValue = false)] public float? AcsUserCount { get; set; } /// - /// 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). /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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). /// [Obsolete("Use `connected_account_id`.")] [DataMember(Name = "connected_account_ids", IsRequired = false, EmitDefaultValue = false)] public List ConnectedAccountIds { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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). /// [DataMember( Name = "default_credential_manager_acs_system_id", @@ -1109,19 +1109,19 @@ public override string ToString() public string? DefaultCredentialManagerAcsSystemId { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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. /// [DataMember(Name = "external_type", IsRequired = false, EmitDefaultValue = false)] public AcsSystem.ExternalTypeEnum? ExternalType { get; set; } /// - /// 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. /// [DataMember( Name = "external_type_display_name", @@ -1131,13 +1131,13 @@ public override string ToString() public string? ExternalTypeDisplayName { get; set; } /// - /// 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. /// [DataMember(Name = "image_alt_text", IsRequired = false, EmitDefaultValue = false)] public string ImageAltText { get; set; } /// - /// 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). /// [DataMember(Name = "image_url", IsRequired = false, EmitDefaultValue = false)] public string ImageUrl { get; set; } @@ -1149,13 +1149,13 @@ public override string ToString() public bool IsCredentialManager { get; set; } /// - /// 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). /// [DataMember(Name = "location", IsRequired = false, EmitDefaultValue = false)] public AcsSystemLocation Location { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string Name { get; set; } @@ -1173,19 +1173,19 @@ public override string ToString() public string? SystemTypeDisplayName { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsSystemVisionlineMetadata? VisionlineMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } @@ -1222,7 +1222,7 @@ public AcsSystemLocation(string? timeZone = default) } /// - /// 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. /// [DataMember(Name = "time_zone", IsRequired = false, EmitDefaultValue = false)] public string? TimeZone { get; set; } @@ -1265,7 +1265,7 @@ public AcsSystemVisionlineMetadata( } /// - /// 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. /// [DataMember(Name = "lan_address", IsRequired = false, EmitDefaultValue = false)] public string? LanAddress { get; set; } diff --git a/src/Seam/Model/AcsUser.cs b/src/Seam/Model/AcsUser.cs index 9df18f7b..f431ac5e 100644 --- a/src/Seam/Model/AcsUser.cs +++ b/src/Seam/Model/AcsUser.cs @@ -9,11 +9,11 @@ namespace Seam.Model { /// - /// 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). /// [DataContract(Name = "seamModel_acsUser_model")] public class AcsUser @@ -475,7 +475,7 @@ public override string ToString() } /// - /// 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. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ExternalTypeEnum @@ -1965,37 +1965,37 @@ public override string ToString() } /// - /// `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. /// [DataMember(Name = "access_schedule", IsRequired = false, EmitDefaultValue = false)] public AcsUserAccessSchedule? AccessSchedule { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_user_id", IsRequired = false, EmitDefaultValue = false)] public string AcsUserId { get; set; } /// - /// 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). /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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). /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } @@ -2005,25 +2005,25 @@ public override string ToString() public string? Email { get; set; } /// - /// 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). /// [DataMember(Name = "email_address", IsRequired = false, EmitDefaultValue = false)] public string? EmailAddress { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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. /// [DataMember(Name = "external_type", IsRequired = false, EmitDefaultValue = false)] public AcsUser.ExternalTypeEnum? ExternalType { get; set; } /// - /// 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. /// [DataMember( Name = "external_type_display_name", @@ -2033,7 +2033,7 @@ public override string ToString() public string? ExternalTypeDisplayName { get; set; } /// - /// 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). /// [DataMember(Name = "full_name", IsRequired = false, EmitDefaultValue = false)] public string? FullName { get; set; } @@ -2051,37 +2051,37 @@ public override string ToString() public bool IsManaged { get; set; } /// - /// 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). /// [DataMember(Name = "is_suspended", IsRequired = false, EmitDefaultValue = false)] public bool? IsSuspended { get; set; } /// - /// 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. /// [DataMember(Name = "pending_mutations", IsRequired = false, EmitDefaultValue = false)] public List? PendingMutations { get; set; } /// - /// 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`). /// [DataMember(Name = "phone_number", IsRequired = false, EmitDefaultValue = false)] public string? PhoneNumber { get; set; } /// - /// 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). /// [DataMember(Name = "salto_ks_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsUserSaltoKsMetadata? SaltoKsMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "salto_space_metadata", IsRequired = false, EmitDefaultValue = false)] public AcsUserSaltoSpaceMetadata? SaltoSpaceMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "user_identity_email_address", @@ -2091,19 +2091,19 @@ public override string ToString() public string? UserIdentityEmailAddress { get; set; } /// - /// 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). /// [DataMember(Name = "user_identity_full_name", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityFullName { get; set; } /// - /// 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). /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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`). /// [DataMember( Name = "user_identity_phone_number", @@ -2113,13 +2113,13 @@ public override string ToString() public string? UserIdentityPhoneNumber { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } diff --git a/src/Seam/Model/ActionAttempt.cs b/src/Seam/Model/ActionAttempt.cs index 5387e6fb..68134346 100644 --- a/src/Seam/Model/ActionAttempt.cs +++ b/src/Seam/Model/ActionAttempt.cs @@ -30,6 +30,10 @@ namespace Seam.Model typeof(ActionAttemptSimulateKeypadCodeEntry), "SIMULATE_KEYPAD_CODE_ENTRY" )] + [JsonSubtypes.KnownSubType( + typeof(ActionAttemptActivateWeeklyProgram), + "ACTIVATE_WEEKLY_PROGRAM" + )] [JsonSubtypes.KnownSubType( typeof(ActionAttemptActivateClimatePreset), "ACTIVATE_CLIMATE_PRESET" @@ -629,19 +633,19 @@ public ActionAttemptScanCredentialResultAcsCredentialOnEncoder( } /// - /// 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). /// [DataMember(Name = "card_number", IsRequired = false, EmitDefaultValue = false)] public string? CardNumber { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string? CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string? EndsAt { get; set; } @@ -653,13 +657,13 @@ public ActionAttemptScanCredentialResultAcsCredentialOnEncoder( public bool? IsIssued { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string? StartsAt { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanCredentialResultAcsCredentialOnEncoderVisionlineMetadata? VisionlineMetadata { get; set; } @@ -723,7 +727,7 @@ public ActionAttemptScanCredentialResultAcsCredentialOnEncoderVisionlineMetadata } /// - /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum CardFormatEnum @@ -739,73 +743,73 @@ public enum CardFormatEnum } /// - /// 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. /// [DataMember(Name = "cancelled", IsRequired = false, EmitDefaultValue = false)] public bool? Cancelled { get; set; } /// - /// 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). /// [DataMember(Name = "card_format", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanCredentialResultAcsCredentialOnEncoderVisionlineMetadata.CardFormatEnum? CardFormat { get; set; } /// - /// 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). /// [DataMember(Name = "card_holder", IsRequired = false, EmitDefaultValue = false)] public string? CardHolder { get; set; } /// - /// 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). /// [DataMember(Name = "card_id", IsRequired = false, EmitDefaultValue = false)] public string? CardId { get; set; } /// - /// 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). /// [DataMember(Name = "common_acs_entrance_ids", IsRequired = false, EmitDefaultValue = false)] public List? CommonAcsEntranceIds { get; set; } /// - /// 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. /// [DataMember(Name = "discarded", IsRequired = false, EmitDefaultValue = false)] public bool? Discarded { get; set; } /// - /// 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. /// [DataMember(Name = "expired", IsRequired = false, EmitDefaultValue = false)] public bool? Expired { get; set; } /// - /// 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). /// [DataMember(Name = "guest_acs_entrance_ids", IsRequired = false, EmitDefaultValue = false)] public List? GuestAcsEntranceIds { get; set; } /// - /// 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). /// [DataMember(Name = "number_of_issued_cards", IsRequired = false, EmitDefaultValue = false)] public float? NumberOfIssuedCards { get; set; } /// - /// 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. /// [DataMember(Name = "overridden", IsRequired = false, EmitDefaultValue = false)] public bool? Overridden { get; set; } /// - /// 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. /// [DataMember(Name = "overwritten", IsRequired = false, EmitDefaultValue = false)] public bool? Overwritten { get; set; } /// - /// 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. /// [DataMember(Name = "pending_auto_update", IsRequired = false, EmitDefaultValue = false)] public bool? PendingAutoUpdate { get; set; } @@ -905,7 +909,7 @@ public ActionAttemptScanCredentialResultAcsCredentialOnSeam( } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum AccessMethodEnum @@ -927,7 +931,7 @@ public enum AccessMethodEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ExternalTypeEnum @@ -979,13 +983,13 @@ public enum ExternalTypeEnum } /// - /// 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`. /// [DataMember(Name = "access_method", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanCredentialResultAcsCredentialOnSeam.AccessMethodEnum AccessMethod { get; set; } /// - /// 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). /// [DataMember(Name = "acs_credential_id", IsRequired = false, EmitDefaultValue = false)] public string AcsCredentialId { get; set; } @@ -997,25 +1001,25 @@ public enum ExternalTypeEnum public string? AcsCredentialPoolId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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. /// [DataMember(Name = "acs_user_id", IsRequired = false, EmitDefaultValue = false)] public string? AcsUserId { get; set; } /// - /// 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). /// [DataMember(Name = "akiles_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanCredentialResultAcsCredentialOnSeamAkilesMetadata? AkilesMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "assa_abloy_vostio_metadata", @@ -1025,55 +1029,55 @@ public enum ExternalTypeEnum public ActionAttemptScanCredentialResultAcsCredentialOnSeamAssaAbloyVostioMetadata? AssaAbloyVostioMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "card_number", IsRequired = false, EmitDefaultValue = false)] public string? CardNumber { get; set; } /// - /// 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). /// [DataMember(Name = "code", IsRequired = false, EmitDefaultValue = false)] public string? Code { get; set; } /// - /// 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. /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } /// - /// 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`. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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`. /// [DataMember(Name = "external_type", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanCredentialResultAcsCredentialOnSeam.ExternalTypeEnum? ExternalType { get; set; } /// - /// 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. /// [DataMember( Name = "external_type_display_name", @@ -1083,13 +1087,13 @@ public enum ExternalTypeEnum public string? ExternalTypeDisplayName { get; set; } /// - /// 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. /// [DataMember(Name = "is_issued", IsRequired = false, EmitDefaultValue = false)] public bool? IsIssued { get; set; } /// - /// 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. /// [DataMember( Name = "is_latest_desired_state_synced_with_provider", @@ -1102,7 +1106,7 @@ public enum ExternalTypeEnum public bool IsManaged { get; set; } /// - /// 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). /// [DataMember( Name = "is_multi_phone_sync_credential", @@ -1112,19 +1116,19 @@ public enum ExternalTypeEnum public bool? IsMultiPhoneSyncCredential { get; set; } /// - /// 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. /// [DataMember(Name = "is_one_time_use", IsRequired = false, EmitDefaultValue = false)] public bool? IsOneTimeUse { get; set; } /// - /// 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. /// [DataMember(Name = "issued_at", IsRequired = false, EmitDefaultValue = false)] public string? IssuedAt { get; set; } /// - /// 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. /// [DataMember( Name = "latest_desired_state_synced_with_provider_at", @@ -1134,7 +1138,7 @@ public enum ExternalTypeEnum public string? LatestDesiredStateSyncedWithProviderAt { get; set; } /// - /// 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). /// [DataMember( Name = "parent_acs_credential_id", @@ -1144,31 +1148,31 @@ public enum ExternalTypeEnum public string? ParentAcsCredentialId { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string? StartsAt { get; set; } /// - /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanCredentialResultAcsCredentialOnSeamVisionlineMetadata? VisionlineMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } @@ -1895,7 +1899,7 @@ public ActionAttemptEncodeCredentialResult( } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum AccessMethodEnum @@ -1917,7 +1921,7 @@ public enum AccessMethodEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ExternalTypeEnum @@ -1969,13 +1973,13 @@ public enum ExternalTypeEnum } /// - /// 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`. /// [DataMember(Name = "access_method", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptEncodeCredentialResult.AccessMethodEnum AccessMethod { get; set; } /// - /// 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). /// [DataMember(Name = "acs_credential_id", IsRequired = false, EmitDefaultValue = false)] public string AcsCredentialId { get; set; } @@ -1987,25 +1991,25 @@ public enum ExternalTypeEnum public string? AcsCredentialPoolId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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. /// [DataMember(Name = "acs_user_id", IsRequired = false, EmitDefaultValue = false)] public string? AcsUserId { get; set; } /// - /// 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). /// [DataMember(Name = "akiles_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptEncodeCredentialResultAkilesMetadata? AkilesMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "assa_abloy_vostio_metadata", @@ -2015,55 +2019,55 @@ public enum ExternalTypeEnum public ActionAttemptEncodeCredentialResultAssaAbloyVostioMetadata? AssaAbloyVostioMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "card_number", IsRequired = false, EmitDefaultValue = false)] public string? CardNumber { get; set; } /// - /// 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). /// [DataMember(Name = "code", IsRequired = false, EmitDefaultValue = false)] public string? Code { get; set; } /// - /// 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. /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } /// - /// 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`. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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`. /// [DataMember(Name = "external_type", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptEncodeCredentialResult.ExternalTypeEnum? ExternalType { get; set; } /// - /// 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. /// [DataMember( Name = "external_type_display_name", @@ -2073,13 +2077,13 @@ public enum ExternalTypeEnum public string? ExternalTypeDisplayName { get; set; } /// - /// 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. /// [DataMember(Name = "is_issued", IsRequired = false, EmitDefaultValue = false)] public bool? IsIssued { get; set; } /// - /// 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. /// [DataMember( Name = "is_latest_desired_state_synced_with_provider", @@ -2092,7 +2096,7 @@ public enum ExternalTypeEnum public bool IsManaged { get; set; } /// - /// 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). /// [DataMember( Name = "is_multi_phone_sync_credential", @@ -2102,19 +2106,19 @@ public enum ExternalTypeEnum public bool? IsMultiPhoneSyncCredential { get; set; } /// - /// 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. /// [DataMember(Name = "is_one_time_use", IsRequired = false, EmitDefaultValue = false)] public bool? IsOneTimeUse { get; set; } /// - /// 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. /// [DataMember(Name = "issued_at", IsRequired = false, EmitDefaultValue = false)] public string? IssuedAt { get; set; } /// - /// 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. /// [DataMember( Name = "latest_desired_state_synced_with_provider_at", @@ -2124,7 +2128,7 @@ public enum ExternalTypeEnum public string? LatestDesiredStateSyncedWithProviderAt { get; set; } /// - /// 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). /// [DataMember( Name = "parent_acs_credential_id", @@ -2134,31 +2138,31 @@ public enum ExternalTypeEnum public string? ParentAcsCredentialId { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string? StartsAt { get; set; } /// - /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptEncodeCredentialResultVisionlineMetadata? VisionlineMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } @@ -2791,7 +2795,7 @@ public ActionAttemptScanToAssignCredentialResult( } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum AccessMethodEnum @@ -2813,7 +2817,7 @@ public enum AccessMethodEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum ExternalTypeEnum @@ -2865,13 +2869,13 @@ public enum ExternalTypeEnum } /// - /// 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`. /// [DataMember(Name = "access_method", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanToAssignCredentialResult.AccessMethodEnum AccessMethod { get; set; } /// - /// 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). /// [DataMember(Name = "acs_credential_id", IsRequired = false, EmitDefaultValue = false)] public string AcsCredentialId { get; set; } @@ -2883,25 +2887,25 @@ public enum ExternalTypeEnum public string? AcsCredentialPoolId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_system_id", IsRequired = false, EmitDefaultValue = false)] public string AcsSystemId { get; set; } /// - /// 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. /// [DataMember(Name = "acs_user_id", IsRequired = false, EmitDefaultValue = false)] public string? AcsUserId { get; set; } /// - /// 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). /// [DataMember(Name = "akiles_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanToAssignCredentialResultAkilesMetadata? AkilesMetadata { get; set; } /// - /// 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). /// [DataMember( Name = "assa_abloy_vostio_metadata", @@ -2911,55 +2915,55 @@ public enum ExternalTypeEnum public ActionAttemptScanToAssignCredentialResultAssaAbloyVostioMetadata? AssaAbloyVostioMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "card_number", IsRequired = false, EmitDefaultValue = false)] public string? CardNumber { get; set; } /// - /// 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). /// [DataMember(Name = "code", IsRequired = false, EmitDefaultValue = false)] public string? Code { get; set; } /// - /// 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. /// [DataMember(Name = "connected_account_id", IsRequired = false, EmitDefaultValue = false)] public string ConnectedAccountId { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } /// - /// 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`. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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`. /// [DataMember(Name = "external_type", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanToAssignCredentialResult.ExternalTypeEnum? ExternalType { get; set; } /// - /// 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. /// [DataMember( Name = "external_type_display_name", @@ -2969,13 +2973,13 @@ public enum ExternalTypeEnum public string? ExternalTypeDisplayName { get; set; } /// - /// 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. /// [DataMember(Name = "is_issued", IsRequired = false, EmitDefaultValue = false)] public bool? IsIssued { get; set; } /// - /// 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. /// [DataMember( Name = "is_latest_desired_state_synced_with_provider", @@ -2991,7 +2995,7 @@ public enum ExternalTypeEnum public bool IsManaged { get; set; } /// - /// 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). /// [DataMember( Name = "is_multi_phone_sync_credential", @@ -3001,19 +3005,19 @@ public enum ExternalTypeEnum public bool? IsMultiPhoneSyncCredential { get; set; } /// - /// 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. /// [DataMember(Name = "is_one_time_use", IsRequired = false, EmitDefaultValue = false)] public bool? IsOneTimeUse { get; set; } /// - /// 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. /// [DataMember(Name = "issued_at", IsRequired = false, EmitDefaultValue = false)] public string? IssuedAt { get; set; } /// - /// 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. /// [DataMember( Name = "latest_desired_state_synced_with_provider_at", @@ -3023,7 +3027,7 @@ public enum ExternalTypeEnum public string? LatestDesiredStateSyncedWithProviderAt { get; set; } /// - /// 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). /// [DataMember( Name = "parent_acs_credential_id", @@ -3033,31 +3037,31 @@ public enum ExternalTypeEnum public string? ParentAcsCredentialId { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string? StartsAt { get; set; } /// - /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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). /// [DataMember(Name = "visionline_metadata", IsRequired = false, EmitDefaultValue = false)] public ActionAttemptScanToAssignCredentialResultVisionlineMetadata? VisionlineMetadata { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } /// - /// 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). /// [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] public string WorkspaceId { get; set; } @@ -3740,7 +3744,7 @@ public enum ModeEnum public string DisplayStatus { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -3794,13 +3798,13 @@ public enum ModeEnum public ActionAttemptAssignCredentialResult.ModeEnum Mode { get; set; } /// - /// 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. /// [DataMember(Name = "pending_mutations", IsRequired = false, EmitDefaultValue = false)] public List PendingMutations { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } @@ -4123,6 +4127,12 @@ public enum WarningCodeEnum [EnumMember(Value = "delay_in_issuing")] DelayInIssuing = 4, + + [EnumMember(Value = "user_identity_missing_email_address")] + UserIdentityMissingEmailAddress = 5, + + [EnumMember(Value = "user_identity_missing_phone_number")] + UserIdentityMissingPhoneNumber = 6, } /// @@ -4795,6 +4805,163 @@ public override string ToString() } } + /// + /// Activating the weekly program is pending. + /// + [DataContract(Name = "seamModel_actionAttemptActivateWeeklyProgram_model")] + public class ActionAttemptActivateWeeklyProgram : ActionAttempt + { + [JsonConstructorAttribute] + protected ActionAttemptActivateWeeklyProgram() { } + + public ActionAttemptActivateWeeklyProgram( + string actionAttemptId = default, + string actionType = default, + ActionAttemptActivateWeeklyProgramError error = default, + ActionAttemptActivateWeeklyProgramResult result = default, + ActionAttemptActivateWeeklyProgram.StatusEnum status = default + ) + { + ActionAttemptId = actionAttemptId; + ActionType = actionType; + Error = error; + Result = result; + Status = status; + } + + [JsonConverter(typeof(SafeStringEnumConverter))] + public enum StatusEnum + { + [EnumMember(Value = "unrecognized")] + Unrecognized = 0, + + [EnumMember(Value = "success")] + Success = 1, + + [EnumMember(Value = "pending")] + Pending = 2, + + [EnumMember(Value = "error")] + Error = 3, + } + + /// + /// ID of the action attempt. + /// + [DataMember(Name = "action_attempt_id", IsRequired = false, EmitDefaultValue = false)] + public override string ActionAttemptId { get; set; } + + [DataMember(Name = "action_type", IsRequired = true, EmitDefaultValue = false)] + public override string ActionType { get; } = "ACTIVATE_WEEKLY_PROGRAM"; + + /// + /// Error associated with the action. + /// + [DataMember(Name = "error", IsRequired = false, EmitDefaultValue = false)] + public ActionAttemptActivateWeeklyProgramError Error { get; set; } + + /// + /// Result of the action. + /// + [DataMember(Name = "result", IsRequired = false, EmitDefaultValue = false)] + public ActionAttemptActivateWeeklyProgramResult Result { get; set; } + + [DataMember(Name = "status", IsRequired = false, EmitDefaultValue = false)] + public ActionAttemptActivateWeeklyProgram.StatusEnum Status { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "seamModel_actionAttemptActivateWeeklyProgramError_model")] + public class ActionAttemptActivateWeeklyProgramError + { + [JsonConstructorAttribute] + protected ActionAttemptActivateWeeklyProgramError() { } + + public ActionAttemptActivateWeeklyProgramError( + string message = default, + string type = default + ) + { + Message = message; + Type = type; + } + + /// + /// Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + /// + [DataMember(Name = "message", IsRequired = false, EmitDefaultValue = false)] + public string Message { get; set; } + + /// + /// Type of the error. + /// + [DataMember(Name = "type", IsRequired = false, EmitDefaultValue = false)] + public string Type { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "seamModel_actionAttemptActivateWeeklyProgramResult_model")] + public class ActionAttemptActivateWeeklyProgramResult + { + [JsonConstructorAttribute] + public ActionAttemptActivateWeeklyProgramResult() { } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + /// /// Simulating a keypad code entry is pending. /// diff --git a/src/Seam/Model/Batch.cs b/src/Seam/Model/Batch.cs index c50ae8cf..2e4388b4 100644 --- a/src/Seam/Model/Batch.cs +++ b/src/Seam/Model/Batch.cs @@ -71,15 +71,15 @@ public Batch( } /// - /// 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. /// [DataMember(Name = "access_codes", IsRequired = false, EmitDefaultValue = false)] public object? AccessCodes { get; set; } @@ -99,27 +99,27 @@ public Batch( /// /// 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). /// [DataMember(Name = "acs_access_groups", IsRequired = false, EmitDefaultValue = false)] public object? AcsAccessGroups { get; set; } /// - /// 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. /// [DataMember(Name = "acs_credentials", IsRequired = false, EmitDefaultValue = false)] public object? AcsCredentials { get; set; } /// - /// 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: /// @@ -130,15 +130,15 @@ public Batch( /// /// 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). /// [DataMember(Name = "acs_encoders", IsRequired = false, EmitDefaultValue = false)] public object? AcsEncoders { get; set; } /// - /// 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. /// @@ -146,21 +146,21 @@ public Batch( public object? AcsEntrances { get; set; } /// - /// 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). /// [DataMember(Name = "acs_systems", IsRequired = false, EmitDefaultValue = false)] public object? AcsSystems { get; set; } /// - /// 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). /// [DataMember(Name = "acs_users", IsRequired = false, EmitDefaultValue = false)] public object? AcsUsers { get; set; } @@ -170,13 +170,13 @@ public Batch( /// /// 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). /// [DataMember(Name = "action_attempts", IsRequired = false, EmitDefaultValue = false)] public object? ActionAttempts { get; set; } /// - /// 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. /// @@ -184,13 +184,13 @@ public Batch( /// /// 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). /// [DataMember(Name = "client_sessions", IsRequired = false, EmitDefaultValue = false)] public object? ClientSessions { get; set; } /// - /// 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. /// @@ -206,13 +206,13 @@ public Batch( public object? ConnectWebviews { get; set; } /// - /// 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. /// [DataMember(Name = "connected_accounts", IsRequired = false, EmitDefaultValue = false)] public object? ConnectedAccounts { get; set; } /// - /// 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. /// [DataMember(Name = "devices", IsRequired = false, EmitDefaultValue = false)] public object? Devices { get; set; } @@ -234,7 +234,7 @@ public Batch( public object? InstantKeys { get; set; } /// - /// 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. /// [DataMember(Name = "noise_thresholds", IsRequired = false, EmitDefaultValue = false)] public object? NoiseThresholds { get; set; } @@ -256,13 +256,13 @@ public Batch( public object? ThermostatDailyPrograms { get; set; } /// - /// 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. /// [DataMember(Name = "thermostat_schedules", IsRequired = false, EmitDefaultValue = false)] public object? ThermostatSchedules { get; set; } /// - /// 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. /// @@ -272,25 +272,25 @@ public Batch( /// /// 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) /// [DataMember(Name = "unmanaged_access_codes", IsRequired = false, EmitDefaultValue = false)] public object? UnmanagedAccessCodes { get; set; } /// - /// 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). /// [DataMember(Name = "unmanaged_devices", IsRequired = false, EmitDefaultValue = false)] public object? UnmanagedDevices { get; set; } /// - /// 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. /// [DataMember(Name = "user_identities", IsRequired = false, EmitDefaultValue = false)] public object? UserIdentities { get; set; } /// - /// 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). /// [DataMember(Name = "workspaces", IsRequired = false, EmitDefaultValue = false)] public object? Workspaces { get; set; } diff --git a/src/Seam/Model/CameraLiveViewAnswer.cs b/src/Seam/Model/CameraLiveViewAnswer.cs new file mode 100644 index 00000000..633316ef --- /dev/null +++ b/src/Seam/Model/CameraLiveViewAnswer.cs @@ -0,0 +1,50 @@ +using System.Runtime.Serialization; +using System.Text; +using JsonSubTypes; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using Seam.Model; + +namespace Seam.Model +{ + /// + /// Represents the WebRTC SDP answer that starts streaming video from a camera for a live view session. + /// + [DataContract(Name = "seamModel_cameraLiveViewAnswer_model")] + public class CameraLiveViewAnswer + { + [JsonConstructorAttribute] + protected CameraLiveViewAnswer() { } + + public CameraLiveViewAnswer(string sdpAnswer = default) + { + SdpAnswer = sdpAnswer; + } + + /// + /// WebRTC SDP answer for the offer, limited to 64 KiB of UTF-8 data. + /// + [DataMember(Name = "sdp_answer", IsRequired = false, EmitDefaultValue = false)] + public string SdpAnswer { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } +} diff --git a/src/Seam/Model/CameraLiveViewSession.cs b/src/Seam/Model/CameraLiveViewSession.cs new file mode 100644 index 00000000..b6eff450 --- /dev/null +++ b/src/Seam/Model/CameraLiveViewSession.cs @@ -0,0 +1,80 @@ +using System.Runtime.Serialization; +using System.Text; +using JsonSubTypes; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using Seam.Model; + +namespace Seam.Model +{ + /// + /// Represents a short-lived live view session for a single camera. Use the session ID and token to start a WebRTC stream and to stop the session. + /// + [DataContract(Name = "seamModel_cameraLiveViewSession_model")] + public class CameraLiveViewSession + { + [JsonConstructorAttribute] + protected CameraLiveViewSession() { } + + public CameraLiveViewSession( + string cameraLiveViewSessionId = default, + string deviceId = default, + string expiresAt = default, + string token = default + ) + { + CameraLiveViewSessionId = cameraLiveViewSessionId; + DeviceId = deviceId; + ExpiresAt = expiresAt; + Token = token; + } + + /// + /// ID of the camera live view session. + /// + [DataMember( + Name = "camera_live_view_session_id", + IsRequired = false, + EmitDefaultValue = false + )] + public string CameraLiveViewSessionId { get; set; } + + /// + /// ID of the camera. + /// + [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] + public string DeviceId { get; set; } + + /// + /// Date and time at which the live view session expires. + /// + [DataMember(Name = "expires_at", IsRequired = false, EmitDefaultValue = false)] + public string ExpiresAt { get; set; } + + /// + /// Token that authorizes the offer and stop requests for this session. + /// + [DataMember(Name = "token", IsRequired = false, EmitDefaultValue = false)] + public string Token { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } +} diff --git a/src/Seam/Model/ClientSession.cs b/src/Seam/Model/ClientSession.cs index 578ad992..003994c5 100644 --- a/src/Seam/Model/ClientSession.cs +++ b/src/Seam/Model/ClientSession.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// @@ -17,7 +17,7 @@ namespace Seam.Model /// /// 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). /// [DataContract(Name = "seamModel_clientSession_model")] public class ClientSession @@ -61,61 +61,61 @@ public ClientSession( public string ClientSessionId { get; set; } /// - /// 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). /// [DataMember(Name = "connect_webview_ids", IsRequired = false, EmitDefaultValue = false)] public List ConnectWebviewIds { get; set; } /// - /// 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). /// [DataMember(Name = "connected_account_ids", IsRequired = false, EmitDefaultValue = false)] public List ConnectedAccountIds { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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). /// [DataMember(Name = "customer_key", IsRequired = false, EmitDefaultValue = false)] public string? CustomerKey { get; set; } /// - /// 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). /// [DataMember(Name = "device_count", IsRequired = false, EmitDefaultValue = false)] public float DeviceCount { get; set; } /// - /// 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. /// [DataMember(Name = "expires_at", IsRequired = false, EmitDefaultValue = false)] public string ExpiresAt { get; set; } /// - /// 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). /// [DataMember(Name = "token", IsRequired = false, EmitDefaultValue = false)] public string Token { get; set; } /// - /// 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). /// [DataMember(Name = "user_identifier_key", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentifierKey { get; set; } /// - /// 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. /// [DataMember(Name = "user_identity_id", IsRequired = false, EmitDefaultValue = false)] public string? UserIdentityId { get; set; } /// - /// 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. /// [Obsolete("Use `user_identity_id` instead.")] [DataMember(Name = "user_identity_ids", IsRequired = false, EmitDefaultValue = false)] diff --git a/src/Seam/Model/ConnectWebview.cs b/src/Seam/Model/ConnectWebview.cs index 06bfd28f..b7056f5a 100644 --- a/src/Seam/Model/ConnectWebview.cs +++ b/src/Seam/Model/ConnectWebview.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// @@ -140,7 +140,7 @@ public enum StatusEnum public List AcceptedCapabilities { get; set; } /// - /// 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). /// [DataMember(Name = "accepted_providers", IsRequired = false, EmitDefaultValue = false)] public List AcceptedProviders { get; set; } @@ -158,7 +158,7 @@ public enum StatusEnum public string? AuthorizedAt { get; set; } /// - /// 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. /// [DataMember( Name = "automatically_manage_new_devices", @@ -186,7 +186,7 @@ public enum StatusEnum public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object CustomMetadata { get; set; } @@ -226,7 +226,7 @@ public enum StatusEnum public bool LoginSuccessful { get; set; } /// - /// 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). /// [DataMember(Name = "selected_provider", IsRequired = false, EmitDefaultValue = false)] public string? SelectedProvider { get; set; } @@ -244,7 +244,7 @@ public enum StatusEnum public string Url { get; set; } /// - /// 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. /// [DataMember( Name = "wait_for_device_creation", diff --git a/src/Seam/Model/ConnectedAccount.cs b/src/Seam/Model/ConnectedAccount.cs index e73c53dd..56281762 100644 --- a/src/Seam/Model/ConnectedAccount.cs +++ b/src/Seam/Model/ConnectedAccount.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_connectedAccount_model")] public class ConnectedAccount @@ -147,7 +147,7 @@ public ConnectedAccountErrorsAccountDisconnected( public override string ErrorCode { get; } = "account_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public override bool? IsBridgeError { get; set; } @@ -219,7 +219,7 @@ public ConnectedAccountErrorsBridgeDisconnected( public override string ErrorCode { get; } = "bridge_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public override bool? IsBridgeError { get; set; } @@ -296,7 +296,7 @@ public ConnectedAccountErrorsSaltoKsSubscriptionLimitExceeded( public override string ErrorCode { get; } = "salto_ks_subscription_limit_exceeded"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public override bool? IsBridgeError { get; set; } @@ -490,7 +490,7 @@ public ConnectedAccountErrorsDormakabaSitesDisconnected( public override string ErrorCode { get; } = "dormakaba_sites_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public override bool? IsBridgeError { get; set; } @@ -562,7 +562,7 @@ public ConnectedAccountErrorsUnrecognized( public override string CreatedAt { get; set; } /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public override bool? IsBridgeError { get; set; } @@ -1269,7 +1269,7 @@ public override string ToString() public string AccountTypeDisplayName { get; set; } /// - /// 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. /// [DataMember( Name = "automatically_manage_new_devices", @@ -1291,7 +1291,7 @@ public override string ToString() public string? CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object CustomMetadata { get; set; } diff --git a/src/Seam/Model/Device.cs b/src/Seam/Model/Device.cs index f9ef260c..3133920f 100644 --- a/src/Seam/Model/Device.cs +++ b/src/Seam/Model/Device.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_device_model")] public class Device @@ -18,6 +18,7 @@ public class Device protected Device() { } public Device( + bool? canActivateWeeklyProgram = default, bool? canConfigureAutoLock = default, bool? canHvacCool = default, bool? canHvacHeat = default, @@ -36,6 +37,7 @@ public Device( bool? canSimulateHubDisconnection = default, bool? canSimulatePaidSubscription = default, bool? canSimulateRemoval = default, + bool? canStreamLiveVideo = default, bool? canTurnOffHvac = default, bool? canUnlockWithCode = default, List capabilitiesSupported = default, @@ -57,6 +59,7 @@ public Device( string workspaceId = default ) { + CanActivateWeeklyProgram = canActivateWeeklyProgram; CanConfigureAutoLock = canConfigureAutoLock; CanHvacCool = canHvacCool; CanHvacHeat = canHvacHeat; @@ -77,6 +80,7 @@ public Device( CanSimulateHubDisconnection = canSimulateHubDisconnection; CanSimulatePaidSubscription = canSimulatePaidSubscription; CanSimulateRemoval = canSimulateRemoval; + CanStreamLiveVideo = canStreamLiveVideo; CanTurnOffHvac = canTurnOffHvac; CanUnlockWithCode = canUnlockWithCode; CapabilitiesSupported = capabilitiesSupported; @@ -99,7 +103,7 @@ public Device( } /// - /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum CapabilitiesSupportedEnum @@ -263,6 +267,15 @@ public enum DeviceTypeEnum [EnumMember(Value = "ring_camera")] RingCamera = 43, + + [EnumMember(Value = "tapo_camera")] + TapoCamera = 44, + + [EnumMember(Value = "arlo_camera")] + ArloCamera = 45, + + [EnumMember(Value = "reolink_camera")] + ReolinkCamera = 46, } [JsonConverter(typeof(JsonSubtypes), "error_code")] @@ -347,7 +360,7 @@ public DeviceErrorsAccountDisconnected( public override string ErrorCode { get; } = "account_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -419,7 +432,7 @@ public DeviceErrorsSaltoKsSubscriptionLimitExceeded( public override string ErrorCode { get; } = "salto_ks_subscription_limit_exceeded"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -491,7 +504,7 @@ public DeviceErrorsInsufficientPermissions( public override string ErrorCode { get; } = "insufficient_permissions"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -563,7 +576,7 @@ public DeviceErrorsDormakabaSitesDisconnected( public override string ErrorCode { get; } = "dormakaba_sites_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1175,7 +1188,7 @@ public DeviceErrorsBridgeDisconnected( public override string ErrorCode { get; } = "bridge_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public bool? IsBridgeError { get; set; } @@ -2911,6 +2924,16 @@ public override string ToString() } } + /// + /// Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. + /// + [DataMember( + Name = "can_activate_weekly_program", + IsRequired = false, + EmitDefaultValue = false + )] + public bool? CanActivateWeeklyProgram { get; set; } + /// /// Indicates whether the lock supports configuring automatic locking. /// @@ -3059,6 +3082,12 @@ public override string ToString() [DataMember(Name = "can_simulate_removal", IsRequired = false, EmitDefaultValue = false)] public bool? CanSimulateRemoval { get; set; } + /// + /// Indicates whether the camera supports streaming live video through a camera live view session. + /// + [DataMember(Name = "can_stream_live_video", IsRequired = false, EmitDefaultValue = false)] + public bool? CanStreamLiveVideo { get; set; } + /// /// Indicates whether the thermostat can be turned off. /// @@ -3072,7 +3101,7 @@ public override string ToString() public bool? CanUnlockWithCode { get; set; } /// - /// 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). /// [DataMember(Name = "capabilities_supported", IsRequired = false, EmitDefaultValue = false)] public List CapabilitiesSupported { get; set; } @@ -3090,7 +3119,7 @@ public override string ToString() public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object CustomMetadata { get; set; } @@ -3132,7 +3161,7 @@ public override string ToString() public List Errors { get; set; } /// - /// 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). /// [DataMember(Name = "is_managed", IsRequired = false, EmitDefaultValue = false)] public bool IsManaged { get; set; } @@ -3406,11 +3435,13 @@ public DeviceProperties( default, DevicePropertiesAkilesMetadata? akilesMetadata = default, DevicePropertiesAqaraMetadata? aqaraMetadata = default, + DevicePropertiesArloMetadata? arloMetadata = default, DevicePropertiesAssaAbloyVostioMetadata? assaAbloyVostioMetadata = default, DevicePropertiesAugustMetadata? augustMetadata = default, DevicePropertiesAvigilonAltaMetadata? avigilonAltaMetadata = default, DevicePropertiesBrivoMetadata? brivoMetadata = default, DevicePropertiesControlbywebMetadata? controlbywebMetadata = default, + DevicePropertiesDormakabaOracodeIhoMetadata? dormakabaOracodeIhoMetadata = default, DevicePropertiesDormakabaOracodeMetadata? dormakabaOracodeMetadata = default, DevicePropertiesEcobeeMetadata? ecobeeMetadata = default, DevicePropertiesFourSuitesMetadata? fourSuitesMetadata = default, @@ -3428,6 +3459,7 @@ public DeviceProperties( DevicePropertiesNoiseawareMetadata? noiseawareMetadata = default, DevicePropertiesNukiMetadata? nukiMetadata = default, DevicePropertiesOmnitecMetadata? omnitecMetadata = default, + DevicePropertiesReolinkMetadata? reolinkMetadata = default, DevicePropertiesRingMetadata? ringMetadata = default, DevicePropertiesSaltoKsMetadata? saltoKsMetadata = default, DevicePropertiesSaltoMetadata? saltoMetadata = default, @@ -3436,6 +3468,7 @@ public DeviceProperties( DevicePropertiesSensiMetadata? sensiMetadata = default, DevicePropertiesSmartthingsMetadata? smartthingsMetadata = default, DevicePropertiesTadoMetadata? tadoMetadata = default, + DevicePropertiesTapoMetadata? tapoMetadata = default, DevicePropertiesTedeeMetadata? tedeeMetadata = default, DevicePropertiesTtlockMetadata? ttlockMetadata = default, DevicePropertiesTwoNMetadata? twoNMetadata = default, @@ -3515,11 +3548,13 @@ public DeviceProperties( SaltoSpaceCredentialServiceMetadata = saltoSpaceCredentialServiceMetadata; AkilesMetadata = akilesMetadata; AqaraMetadata = aqaraMetadata; + ArloMetadata = arloMetadata; AssaAbloyVostioMetadata = assaAbloyVostioMetadata; AugustMetadata = augustMetadata; AvigilonAltaMetadata = avigilonAltaMetadata; BrivoMetadata = brivoMetadata; ControlbywebMetadata = controlbywebMetadata; + DormakabaOracodeIhoMetadata = dormakabaOracodeIhoMetadata; DormakabaOracodeMetadata = dormakabaOracodeMetadata; EcobeeMetadata = ecobeeMetadata; FourSuitesMetadata = fourSuitesMetadata; @@ -3537,6 +3572,7 @@ public DeviceProperties( NoiseawareMetadata = noiseawareMetadata; NukiMetadata = nukiMetadata; OmnitecMetadata = omnitecMetadata; + ReolinkMetadata = reolinkMetadata; RingMetadata = ringMetadata; SaltoKsMetadata = saltoKsMetadata; SaltoMetadata = saltoMetadata; @@ -3545,6 +3581,7 @@ public DeviceProperties( SensiMetadata = sensiMetadata; SmartthingsMetadata = smartthingsMetadata; TadoMetadata = tadoMetadata; + TapoMetadata = tapoMetadata; TedeeMetadata = tedeeMetadata; TtlockMetadata = ttlockMetadata; TwoNMetadata = twoNMetadata; @@ -3849,6 +3886,12 @@ public enum FanModeSettingEnum [DataMember(Name = "aqara_metadata", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesAqaraMetadata? AqaraMetadata { get; set; } + /// + /// Metadata for an Arlo camera. + /// + [DataMember(Name = "arlo_metadata", IsRequired = false, EmitDefaultValue = false)] + public DevicePropertiesArloMetadata? ArloMetadata { get; set; } + /// /// Metadata for an ASSA ABLOY Vostio system. /// @@ -3883,6 +3926,16 @@ public enum FanModeSettingEnum [DataMember(Name = "controlbyweb_metadata", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesControlbywebMetadata? ControlbywebMetadata { get; set; } + /// + /// Metadata for a dormakaba Oracode Homeowner's Portal device. + /// + [DataMember( + Name = "dormakaba_oracode_iho_metadata", + IsRequired = false, + EmitDefaultValue = false + )] + public DevicePropertiesDormakabaOracodeIhoMetadata? DormakabaOracodeIhoMetadata { get; set; } + /// /// Metadata for a dormakaba Oracode device. /// @@ -3993,6 +4046,12 @@ public enum FanModeSettingEnum [DataMember(Name = "omnitec_metadata", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesOmnitecMetadata? OmnitecMetadata { get; set; } + /// + /// Metadata for a Reolink camera. + /// + [DataMember(Name = "reolink_metadata", IsRequired = false, EmitDefaultValue = false)] + public DevicePropertiesReolinkMetadata? ReolinkMetadata { get; set; } + /// /// Metadata for a Ring device. /// @@ -4042,6 +4101,12 @@ public enum FanModeSettingEnum [DataMember(Name = "tado_metadata", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesTadoMetadata? TadoMetadata { get; set; } + /// + /// Metadata for a Tapo camera. + /// + [DataMember(Name = "tapo_metadata", IsRequired = false, EmitDefaultValue = false)] + public DevicePropertiesTapoMetadata? TapoMetadata { get; set; } + /// /// Metadata for a Tedee device. /// @@ -4097,7 +4162,7 @@ public enum FanModeSettingEnum public bool? AutoLockEnabled { get; set; } /// - /// 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). /// [DataMember( Name = "backup_access_code_pool_enabled", @@ -4173,7 +4238,7 @@ public enum FanModeSettingEnum public List? SupportedCodeLengths { get; set; } /// - /// 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). /// [DataMember( Name = "supports_backup_access_code_pool", @@ -4183,7 +4248,7 @@ public enum FanModeSettingEnum public bool? SupportsBackupAccessCodePool { get; set; } /// - /// 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). /// [Obsolete("Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.")] [DataMember( @@ -4194,7 +4259,7 @@ public enum FanModeSettingEnum public DevicePropertiesActiveThermostatSchedule? ActiveThermostatSchedule { get; set; } /// - /// 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). /// [DataMember( Name = "active_thermostat_schedule_id", @@ -4214,7 +4279,7 @@ public enum FanModeSettingEnum public List? AvailableClimatePresetModes { get; set; } /// - /// 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. /// [DataMember( Name = "available_climate_presets", @@ -4254,7 +4319,7 @@ public enum FanModeSettingEnum public DevicePropertiesDefaultClimateSetting? DefaultClimateSetting { get; set; } /// - /// 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. /// [DataMember( Name = "fallback_climate_preset_key", @@ -4296,7 +4361,7 @@ public enum FanModeSettingEnum public bool? IsTemporaryManualOverrideActive { get; set; } /// - /// 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. /// [DataMember( Name = "max_cooling_set_point_celsius", @@ -4306,7 +4371,7 @@ public enum FanModeSettingEnum public float? MaxCoolingSetPointCelsius { get; set; } /// - /// 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. /// [DataMember( Name = "max_cooling_set_point_fahrenheit", @@ -4316,7 +4381,7 @@ public enum FanModeSettingEnum public float? MaxCoolingSetPointFahrenheit { get; set; } /// - /// 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. /// [DataMember( Name = "max_heating_set_point_celsius", @@ -4326,7 +4391,7 @@ public enum FanModeSettingEnum public float? MaxHeatingSetPointCelsius { get; set; } /// - /// 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. /// [DataMember( Name = "max_heating_set_point_fahrenheit", @@ -4356,7 +4421,7 @@ public enum FanModeSettingEnum public float? MaxUniqueClimatePresetsPerThermostatWeeklyProgram { get; set; } /// - /// 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. /// [DataMember( Name = "min_cooling_set_point_celsius", @@ -4366,7 +4431,7 @@ public enum FanModeSettingEnum public float? MinCoolingSetPointCelsius { get; set; } /// - /// 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. /// [DataMember( Name = "min_cooling_set_point_fahrenheit", @@ -4376,7 +4441,7 @@ public enum FanModeSettingEnum public float? MinCoolingSetPointFahrenheit { get; set; } /// - /// 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. /// [DataMember( Name = "min_heating_cooling_delta_celsius", @@ -4386,7 +4451,7 @@ public enum FanModeSettingEnum public float? MinHeatingCoolingDeltaCelsius { get; set; } /// - /// 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. /// [DataMember( Name = "min_heating_cooling_delta_fahrenheit", @@ -4396,7 +4461,7 @@ public enum FanModeSettingEnum public float? MinHeatingCoolingDeltaFahrenheit { get; set; } /// - /// 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. /// [DataMember( Name = "min_heating_set_point_celsius", @@ -4406,7 +4471,7 @@ public enum FanModeSettingEnum public float? MinHeatingSetPointCelsius { get; set; } /// - /// 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. /// [DataMember( Name = "min_heating_set_point_fahrenheit", @@ -4434,7 +4499,7 @@ public enum FanModeSettingEnum public float? TemperatureFahrenheit { get; set; } /// - /// 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. /// [DataMember(Name = "temperature_threshold", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesTemperatureThreshold? TemperatureThreshold { get; set; } @@ -4450,7 +4515,7 @@ public enum FanModeSettingEnum public float? ThermostatDailyProgramPeriodPrecisionMinutes { get; set; } /// - /// 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. /// [DataMember( Name = "thermostat_daily_programs", @@ -4460,7 +4525,7 @@ public enum FanModeSettingEnum public List? ThermostatDailyPrograms { get; set; } /// - /// 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. /// [DataMember( Name = "thermostat_weekly_program", @@ -4917,24 +4982,16 @@ public class DevicePropertiesAkilesMetadata protected DevicePropertiesAkilesMetadata() { } public DevicePropertiesAkilesMetadata( - string? memberGroupId = default, string? gadgetId = default, string? gadgetName = default, string? productName = default ) { - MemberGroupId = memberGroupId; GadgetId = gadgetId; GadgetName = gadgetName; ProductName = productName; } - /// - /// Group ID to which to add users for an Akiles device. - /// - [DataMember(Name = "member_group_id", IsRequired = false, EmitDefaultValue = false)] - public string? MemberGroupId { get; set; } - /// /// Gadget ID for an Akiles device. /// @@ -5068,6 +5125,77 @@ public override string ToString() } } + [DataContract(Name = "seamModel_devicePropertiesArloMetadata_model")] + public class DevicePropertiesArloMetadata + { + [JsonConstructorAttribute] + protected DevicePropertiesArloMetadata() { } + + public DevicePropertiesArloMetadata( + string? deviceId = default, + string? deviceName = default, + string? firmwareVersion = default, + string? hardwareVersion = default, + string? modelId = default + ) + { + DeviceId = deviceId; + DeviceName = deviceName; + FirmwareVersion = firmwareVersion; + HardwareVersion = hardwareVersion; + ModelId = modelId; + } + + /// + /// Device ID reported by Arlo. + /// + [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] + public string? DeviceId { get; set; } + + /// + /// Device name reported by Arlo. + /// + [DataMember(Name = "device_name", IsRequired = false, EmitDefaultValue = false)] + public string? DeviceName { get; set; } + + /// + /// Firmware version reported by Arlo. + /// + [DataMember(Name = "firmware_version", IsRequired = false, EmitDefaultValue = false)] + public string? FirmwareVersion { get; set; } + + /// + /// Hardware version reported by Arlo. + /// + [DataMember(Name = "hardware_version", IsRequired = false, EmitDefaultValue = false)] + public string? HardwareVersion { get; set; } + + /// + /// Model ID reported by Arlo. + /// + [DataMember(Name = "model_id", IsRequired = false, EmitDefaultValue = false)] + public string? ModelId { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + [DataContract(Name = "seamModel_devicePropertiesAssaAbloyVostioMetadata_model")] public class DevicePropertiesAssaAbloyVostioMetadata { @@ -5385,6 +5513,133 @@ public override string ToString() } } + [DataContract(Name = "seamModel_devicePropertiesDormakabaOracodeIhoMetadata_model")] + public class DevicePropertiesDormakabaOracodeIhoMetadata + { + [JsonConstructorAttribute] + protected DevicePropertiesDormakabaOracodeIhoMetadata() { } + + public DevicePropertiesDormakabaOracodeIhoMetadata( + float? doorId = default, + string? doorName = default, + string? ianaTimezone = default, + List? userLevels = default + ) + { + DoorId = doorId; + DoorName = doorName; + IanaTimezone = ianaTimezone; + UserLevels = userLevels; + } + + /// + /// Door ID for a dormakaba Oracode Homeowner's Portal device. + /// + [DataMember(Name = "door_id", IsRequired = false, EmitDefaultValue = false)] + public float? DoorId { get; set; } + + /// + /// Name of the door for a dormakaba Oracode Homeowner's Portal device. + /// + [DataMember(Name = "door_name", IsRequired = false, EmitDefaultValue = false)] + public string? DoorName { get; set; } + + /// + /// IANA time zone for a dormakaba Oracode Homeowner's Portal device. + /// + [DataMember(Name = "iana_timezone", IsRequired = false, EmitDefaultValue = false)] + public string? IanaTimezone { get; set; } + + /// + /// User levels for a dormakaba Oracode Homeowner's Portal device. + /// + [DataMember(Name = "user_levels", IsRequired = false, EmitDefaultValue = false)] + public List? UserLevels { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract(Name = "seamModel_devicePropertiesDormakabaOracodeIhoMetadataUserLevels_model")] + public class DevicePropertiesDormakabaOracodeIhoMetadataUserLevels + { + [JsonConstructorAttribute] + protected DevicePropertiesDormakabaOracodeIhoMetadataUserLevels() { } + + public DevicePropertiesDormakabaOracodeIhoMetadataUserLevels( + float? userLevel = default, + string? userLevelCheckInTime = default, + string? userLevelCheckOutTime = default, + string? userLevelName = default, + string? userLevelType = default + ) + { + UserLevel = userLevel; + UserLevelCheckInTime = userLevelCheckInTime; + UserLevelCheckOutTime = userLevelCheckOutTime; + UserLevelName = userLevelName; + UserLevelType = userLevelType; + } + + [DataMember(Name = "user_level", IsRequired = false, EmitDefaultValue = false)] + public float? UserLevel { get; set; } + + [DataMember( + Name = "user_level_check_in_time", + IsRequired = false, + EmitDefaultValue = false + )] + public string? UserLevelCheckInTime { get; set; } + + [DataMember( + Name = "user_level_check_out_time", + IsRequired = false, + EmitDefaultValue = false + )] + public string? UserLevelCheckOutTime { get; set; } + + [DataMember(Name = "user_level_name", IsRequired = false, EmitDefaultValue = false)] + public string? UserLevelName { get; set; } + + [DataMember(Name = "user_level_type", IsRequired = false, EmitDefaultValue = false)] + public string? UserLevelType { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + [DataContract(Name = "seamModel_devicePropertiesDormakabaOracodeMetadata_model")] public class DevicePropertiesDormakabaOracodeMetadata { @@ -6813,7 +7068,7 @@ public DevicePropertiesNestMetadata( public string? DeviceName { get; set; } /// - /// Display name for a Google Nest device. + /// Name of the Google Home room containing the device. The device owner sets this value. /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string? DisplayName { get; set; } @@ -7101,6 +7356,61 @@ public override string ToString() } } + [DataContract(Name = "seamModel_devicePropertiesReolinkMetadata_model")] + public class DevicePropertiesReolinkMetadata + { + [JsonConstructorAttribute] + protected DevicePropertiesReolinkMetadata() { } + + public DevicePropertiesReolinkMetadata( + string? firmwareVersion = default, + string? hardwareVersion = default, + string? model = default + ) + { + FirmwareVersion = firmwareVersion; + HardwareVersion = hardwareVersion; + Model = model; + } + + /// + /// Firmware version reported by the camera. + /// + [DataMember(Name = "firmware_version", IsRequired = false, EmitDefaultValue = false)] + public string? FirmwareVersion { get; set; } + + /// + /// Hardware version reported by the camera. + /// + [DataMember(Name = "hardware_version", IsRequired = false, EmitDefaultValue = false)] + public string? HardwareVersion { get; set; } + + /// + /// Model reported by the Reolink camera. + /// + [DataMember(Name = "model", IsRequired = false, EmitDefaultValue = false)] + public string? Model { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + [DataContract(Name = "seamModel_devicePropertiesRingMetadata_model")] public class DevicePropertiesRingMetadata { @@ -7653,6 +7963,61 @@ public override string ToString() } } + [DataContract(Name = "seamModel_devicePropertiesTapoMetadata_model")] + public class DevicePropertiesTapoMetadata + { + [JsonConstructorAttribute] + protected DevicePropertiesTapoMetadata() { } + + public DevicePropertiesTapoMetadata( + string? firmwareVersion = default, + string? hardwareVersion = default, + string? model = default + ) + { + FirmwareVersion = firmwareVersion; + HardwareVersion = hardwareVersion; + Model = model; + } + + /// + /// Firmware version reported by the camera. + /// + [DataMember(Name = "firmware_version", IsRequired = false, EmitDefaultValue = false)] + public string? FirmwareVersion { get; set; } + + /// + /// Hardware version reported by the camera. + /// + [DataMember(Name = "hardware_version", IsRequired = false, EmitDefaultValue = false)] + public string? HardwareVersion { get; set; } + + /// + /// Model reported by the Tapo camera. + /// + [DataMember(Name = "model", IsRequired = false, EmitDefaultValue = false)] + public string? Model { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + [DataContract(Name = "seamModel_devicePropertiesTedeeMetadata_model")] public class DevicePropertiesTedeeMetadata { @@ -8755,43 +9120,43 @@ public DevicePropertiesActiveThermostatSchedule( } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] public string DeviceId { get; set; } /// - /// 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. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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. /// [DataMember(Name = "is_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool? IsOverrideAllowed { get; set; } /// - /// 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). /// [DataMember( Name = "max_override_period_minutes", @@ -8801,19 +9166,19 @@ public DevicePropertiesActiveThermostatSchedule( public int? MaxOverridePeriodMinutes { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string StartsAt { get; set; } /// - /// 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). /// [DataMember(Name = "thermostat_schedule_id", IsRequired = false, EmitDefaultValue = false)] public string ThermostatScheduleId { get; set; } @@ -8970,7 +9335,7 @@ public enum ClimatePresetModeEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -8989,7 +9354,7 @@ public enum FanModeSettingEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum HvacModeSettingEnum @@ -9014,19 +9379,19 @@ public enum HvacModeSettingEnum } /// - /// 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. /// [DataMember(Name = "can_delete", IsRequired = false, EmitDefaultValue = false)] public bool CanDelete { get; set; } /// - /// 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. /// [DataMember(Name = "can_edit", IsRequired = false, EmitDefaultValue = false)] public bool CanEdit { get; set; } /// - /// 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. /// [DataMember( Name = "can_use_with_thermostat_daily_programs", @@ -9036,7 +9401,7 @@ public enum HvacModeSettingEnum public bool CanUseWithThermostatDailyPrograms { get; set; } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } @@ -9048,7 +9413,7 @@ public enum HvacModeSettingEnum public DevicePropertiesAvailableClimatePresets.ClimatePresetModeEnum? ClimatePresetMode { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_celsius", @@ -9058,7 +9423,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -9068,7 +9433,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointFahrenheit { get; set; } /// - /// 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). /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string DisplayName { get; set; } @@ -9080,13 +9445,13 @@ public enum HvacModeSettingEnum public DevicePropertiesAvailableClimatePresetsEcobeeMetadata? EcobeeMetadata { get; set; } /// - /// 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`. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesAvailableClimatePresets.FanModeSettingEnum? FanModeSetting { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_celsius", @@ -9096,7 +9461,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -9106,20 +9471,20 @@ public enum HvacModeSettingEnum public float? HeatingSetPointFahrenheit { get; set; } /// - /// 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`. /// [DataMember(Name = "hvac_mode_setting", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesAvailableClimatePresets.HvacModeSettingEnum? HvacModeSetting { get; set; } /// - /// 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). /// [Obsolete("Use 'thermostat_schedule.is_override_allowed'")] [DataMember(Name = "manual_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool ManualOverrideAllowed { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } @@ -9286,7 +9651,7 @@ public enum ClimatePresetModeEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -9305,7 +9670,7 @@ public enum FanModeSettingEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum HvacModeSettingEnum @@ -9330,19 +9695,19 @@ public enum HvacModeSettingEnum } /// - /// 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. /// [DataMember(Name = "can_delete", IsRequired = false, EmitDefaultValue = false)] public bool? CanDelete { get; set; } /// - /// 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. /// [DataMember(Name = "can_edit", IsRequired = false, EmitDefaultValue = false)] public bool? CanEdit { get; set; } /// - /// 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. /// [DataMember( Name = "can_use_with_thermostat_daily_programs", @@ -9352,7 +9717,7 @@ public enum HvacModeSettingEnum public bool? CanUseWithThermostatDailyPrograms { get; set; } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string? ClimatePresetKey { get; set; } @@ -9364,7 +9729,7 @@ public enum HvacModeSettingEnum public DevicePropertiesCurrentClimateSetting.ClimatePresetModeEnum? ClimatePresetMode { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_celsius", @@ -9374,7 +9739,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -9384,7 +9749,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointFahrenheit { get; set; } /// - /// 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). /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string? DisplayName { get; set; } @@ -9396,13 +9761,13 @@ public enum HvacModeSettingEnum public DevicePropertiesCurrentClimateSettingEcobeeMetadata? EcobeeMetadata { get; set; } /// - /// 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`. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesCurrentClimateSetting.FanModeSettingEnum? FanModeSetting { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_celsius", @@ -9412,7 +9777,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -9422,20 +9787,20 @@ public enum HvacModeSettingEnum public float? HeatingSetPointFahrenheit { get; set; } /// - /// 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`. /// [DataMember(Name = "hvac_mode_setting", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesCurrentClimateSetting.HvacModeSettingEnum? HvacModeSetting { get; set; } /// - /// 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). /// [Obsolete("Use 'thermostat_schedule.is_override_allowed'")] [DataMember(Name = "manual_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool? ManualOverrideAllowed { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } @@ -9602,7 +9967,7 @@ public enum ClimatePresetModeEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -9621,7 +9986,7 @@ public enum FanModeSettingEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum HvacModeSettingEnum @@ -9646,19 +10011,19 @@ public enum HvacModeSettingEnum } /// - /// 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. /// [DataMember(Name = "can_delete", IsRequired = false, EmitDefaultValue = false)] public bool? CanDelete { get; set; } /// - /// 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. /// [DataMember(Name = "can_edit", IsRequired = false, EmitDefaultValue = false)] public bool? CanEdit { get; set; } /// - /// 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. /// [DataMember( Name = "can_use_with_thermostat_daily_programs", @@ -9668,7 +10033,7 @@ public enum HvacModeSettingEnum public bool? CanUseWithThermostatDailyPrograms { get; set; } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string? ClimatePresetKey { get; set; } @@ -9680,7 +10045,7 @@ public enum HvacModeSettingEnum public DevicePropertiesDefaultClimateSetting.ClimatePresetModeEnum? ClimatePresetMode { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_celsius", @@ -9690,7 +10055,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -9700,7 +10065,7 @@ public enum HvacModeSettingEnum public float? CoolingSetPointFahrenheit { get; set; } /// - /// 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). /// [DataMember(Name = "display_name", IsRequired = false, EmitDefaultValue = false)] public string? DisplayName { get; set; } @@ -9712,13 +10077,13 @@ public enum HvacModeSettingEnum public DevicePropertiesDefaultClimateSettingEcobeeMetadata? EcobeeMetadata { get; set; } /// - /// 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`. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesDefaultClimateSetting.FanModeSettingEnum? FanModeSetting { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_celsius", @@ -9728,7 +10093,7 @@ public enum HvacModeSettingEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -9738,20 +10103,20 @@ public enum HvacModeSettingEnum public float? HeatingSetPointFahrenheit { get; set; } /// - /// 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`. /// [DataMember(Name = "hvac_mode_setting", IsRequired = false, EmitDefaultValue = false)] public DevicePropertiesDefaultClimateSetting.HvacModeSettingEnum? HvacModeSetting { get; set; } /// - /// 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). /// [Obsolete("Use 'thermostat_schedule.is_override_allowed'")] [DataMember(Name = "manual_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool? ManualOverrideAllowed { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } @@ -9867,25 +10232,25 @@ public DevicePropertiesTemperatureThreshold( } /// - /// 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. /// [DataMember(Name = "lower_limit_celsius", IsRequired = false, EmitDefaultValue = false)] public float? LowerLimitCelsius { get; set; } /// - /// 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. /// [DataMember(Name = "lower_limit_fahrenheit", IsRequired = false, EmitDefaultValue = false)] public float? LowerLimitFahrenheit { get; set; } /// - /// 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. /// [DataMember(Name = "upper_limit_celsius", IsRequired = false, EmitDefaultValue = false)] public float? UpperLimitCelsius { get; set; } /// - /// 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. /// [DataMember(Name = "upper_limit_fahrenheit", IsRequired = false, EmitDefaultValue = false)] public float? UpperLimitFahrenheit { get; set; } @@ -10009,7 +10374,7 @@ public DevicePropertiesThermostatDailyProgramsPeriods( } /// - /// 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`. /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } diff --git a/src/Seam/Model/DeviceProvider.cs b/src/Seam/Model/DeviceProvider.cs index e4e9e674..8c034f6a 100644 --- a/src/Seam/Model/DeviceProvider.cs +++ b/src/Seam/Model/DeviceProvider.cs @@ -15,6 +15,7 @@ public class DeviceProvider protected DeviceProvider() { } public DeviceProvider( + bool? canActivateWeeklyProgram = default, bool? canConfigureAutoLock = default, bool? canHvacCool = default, bool? canHvacHeat = default, @@ -33,6 +34,7 @@ public DeviceProvider( bool? canSimulateHubDisconnection = default, bool? canSimulatePaidSubscription = default, bool? canSimulateRemoval = default, + bool? canStreamLiveVideo = default, bool? canTurnOffHvac = default, bool? canUnlockWithCode = default, DeviceProvider.DeviceProviderNameEnum deviceProviderName = default, @@ -41,6 +43,7 @@ public DeviceProvider( List providerCategories = default ) { + CanActivateWeeklyProgram = canActivateWeeklyProgram; CanConfigureAutoLock = canConfigureAutoLock; CanHvacCool = canHvacCool; CanHvacHeat = canHvacHeat; @@ -61,6 +64,7 @@ public DeviceProvider( CanSimulateHubDisconnection = canSimulateHubDisconnection; CanSimulatePaidSubscription = canSimulatePaidSubscription; CanSimulateRemoval = canSimulateRemoval; + CanStreamLiveVideo = canStreamLiveVideo; CanTurnOffHvac = canTurnOffHvac; CanUnlockWithCode = canUnlockWithCode; DeviceProviderName = deviceProviderName; @@ -171,104 +175,116 @@ public enum DeviceProviderNameEnum [EnumMember(Value = "dormakaba_oracode")] DormakabaOracode = 31, + [EnumMember(Value = "dormakaba_oracode_iho")] + DormakabaOracodeIho = 32, + [EnumMember(Value = "pti")] - Pti = 32, + Pti = 33, [EnumMember(Value = "wyze")] - Wyze = 33, + Wyze = 34, [EnumMember(Value = "seam_passport")] - SeamPassport = 34, + SeamPassport = 35, [EnumMember(Value = "visionline")] - Visionline = 35, + Visionline = 36, [EnumMember(Value = "assa_abloy_credential_service")] - AssaAbloyCredentialService = 36, + AssaAbloyCredentialService = 37, [EnumMember(Value = "tedee")] - Tedee = 37, + Tedee = 38, [EnumMember(Value = "honeywell_resideo")] - HoneywellResideo = 38, + HoneywellResideo = 39, [EnumMember(Value = "first_alert")] - FirstAlert = 39, + FirstAlert = 40, [EnumMember(Value = "latch")] - Latch = 40, + Latch = 41, [EnumMember(Value = "akiles")] - Akiles = 41, + Akiles = 42, [EnumMember(Value = "assa_abloy_vostio")] - AssaAbloyVostio = 42, + AssaAbloyVostio = 43, [EnumMember(Value = "assa_abloy_vostio_credential_service")] - AssaAbloyVostioCredentialService = 43, + AssaAbloyVostioCredentialService = 44, [EnumMember(Value = "tado")] - Tado = 44, + Tado = 45, [EnumMember(Value = "salto_space")] - SaltoSpace = 45, + SaltoSpace = 46, [EnumMember(Value = "sensi")] - Sensi = 46, + Sensi = 47, [EnumMember(Value = "keynest")] - Keynest = 47, + Keynest = 48, [EnumMember(Value = "korelock")] - Korelock = 48, + Korelock = 49, [EnumMember(Value = "keyincode")] - Keyincode = 49, + Keyincode = 50, [EnumMember(Value = "dormakaba_ambiance")] - DormakabaAmbiance = 50, + DormakabaAmbiance = 51, [EnumMember(Value = "ultraloq")] - Ultraloq = 51, + Ultraloq = 52, [EnumMember(Value = "yacan")] - Yacan = 52, + Yacan = 53, [EnumMember(Value = "dusaw")] - Dusaw = 53, + Dusaw = 54, [EnumMember(Value = "sifely")] - Sifely = 54, + Sifely = 55, [EnumMember(Value = "thirty_three_lock")] - ThirtyThreeLock = 55, + ThirtyThreeLock = 56, [EnumMember(Value = "ring")] - Ring = 56, + Ring = 57, + + [EnumMember(Value = "tapo")] + Tapo = 58, + + [EnumMember(Value = "arlo")] + Arlo = 59, + + [EnumMember(Value = "reolink")] + Reolink = 60, [EnumMember(Value = "ical")] - Ical = 57, + Ical = 61, [EnumMember(Value = "lodgify")] - Lodgify = 58, + Lodgify = 62, [EnumMember(Value = "hostaway")] - Hostaway = 59, + Hostaway = 63, [EnumMember(Value = "guesty")] - Guesty = 60, + Guesty = 64, [EnumMember(Value = "acuity_scheduling")] - AcuityScheduling = 61, + AcuityScheduling = 65, [EnumMember(Value = "omnitec")] - Omnitec = 62, + Omnitec = 66, [EnumMember(Value = "kisi")] - Kisi = 63, + Kisi = 67, [EnumMember(Value = "aqara")] - Aqara = 64, + Aqara = 68, } /// @@ -305,6 +321,16 @@ public enum ProviderCategoriesEnum Connectors = 8, } + /// + /// Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. + /// + [DataMember( + Name = "can_activate_weekly_program", + IsRequired = false, + EmitDefaultValue = false + )] + public bool? CanActivateWeeklyProgram { get; set; } + /// /// Indicates whether the lock supports configuring automatic locking. /// @@ -453,6 +479,12 @@ public enum ProviderCategoriesEnum [DataMember(Name = "can_simulate_removal", IsRequired = false, EmitDefaultValue = false)] public bool? CanSimulateRemoval { get; set; } + /// + /// Indicates whether the camera supports streaming live video through a camera live view session. + /// + [DataMember(Name = "can_stream_live_video", IsRequired = false, EmitDefaultValue = false)] + public bool? CanStreamLiveVideo { get; set; } + /// /// Indicates whether the thermostat can be turned off. /// diff --git a/src/Seam/Model/Event.cs b/src/Seam/Model/Event.cs index bbd722bd..51eadd08 100644 --- a/src/Seam/Model/Event.cs +++ b/src/Seam/Model/Event.cs @@ -319,7 +319,7 @@ public abstract class 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. /// [DataContract(Name = "seamModel_eventAccessCodeCreated_model")] public class EventAccessCodeCreated : Event @@ -442,7 +442,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeChanged_model")] public class EventAccessCodeChanged : Event @@ -636,7 +636,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeNameChanged_model")] public class EventAccessCodeNameChanged : Event @@ -857,7 +857,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeCodeChanged_model")] public class EventAccessCodeCodeChanged : Event @@ -1078,7 +1078,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeTimeFrameChanged_model")] public class EventAccessCodeTimeFrameChanged : Event @@ -1319,7 +1319,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeMutationsRequested_model")] public class EventAccessCodeMutationsRequested : Event @@ -1534,7 +1534,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeScheduledOnDevice_model")] public class EventAccessCodeScheduledOnDevice : Event @@ -1665,7 +1665,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeSetOnDevice_model")] public class EventAccessCodeSetOnDevice : Event @@ -1796,7 +1796,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeRemovedFromDevice_model")] public class EventAccessCodeRemovedFromDevice : Event @@ -1919,7 +1919,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeDelayInSettingOnDevice_model")] public class EventAccessCodeDelayInSettingOnDevice : Event @@ -2435,7 +2435,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeFailedToSetOnDevice_model")] public class EventAccessCodeFailedToSetOnDevice : Event @@ -2950,7 +2950,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeDeleted_model")] public class EventAccessCodeDeleted : Event @@ -3081,7 +3081,7 @@ public override string ToString() } /// - /// 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. /// [Obsolete( "Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead." @@ -3605,7 +3605,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeFailedToRemoveFromDevice_model")] public class EventAccessCodeFailedToRemoveFromDevice : Event @@ -4124,7 +4124,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeModifiedExternalToSeam_model")] public class EventAccessCodeModifiedExternalToSeam : Event @@ -4247,7 +4247,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeDeletedExternalToSeam_model")] public class EventAccessCodeDeletedExternalToSeam : Event @@ -4370,7 +4370,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeBackupAccessCodePulled_model")] public class EventAccessCodeBackupAccessCodePulled : Event @@ -4501,7 +4501,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeUnmanagedConvertedToManaged_model")] public class EventAccessCodeUnmanagedConvertedToManaged : Event @@ -4624,7 +4624,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeUnmanagedFailedToConvertToManaged_model")] public class EventAccessCodeUnmanagedFailedToConvertToManaged : Event @@ -5152,7 +5152,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeUnmanagedCreated_model")] public class EventAccessCodeUnmanagedCreated : Event @@ -5275,7 +5275,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAccessCodeUnmanagedRemoved_model")] public class EventAccessCodeUnmanagedRemoved : Event @@ -5695,7 +5695,7 @@ public EventAccessGrantAccessGrantedToDoor( public string AccessGrantId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_entrance_id", IsRequired = false, EmitDefaultValue = false)] public string AcsEntranceId { get; set; } @@ -5790,7 +5790,7 @@ public EventAccessGrantAccessToDoorLost( public string AccessGrantId { get; set; } /// - /// 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). /// [DataMember(Name = "acs_entrance_id", IsRequired = false, EmitDefaultValue = false)] public string AcsEntranceId { get; set; } @@ -6920,7 +6920,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsSystemConnected_model")] public class EventAcsSystemConnected : Event @@ -7015,7 +7015,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsSystemAdded_model")] public class EventAcsSystemAdded : Event @@ -7110,7 +7110,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsSystemDisconnected_model")] public class EventAcsSystemDisconnected : Event @@ -7466,7 +7466,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsCredentialDeleted_model")] public class EventAcsCredentialDeleted : Event @@ -7569,7 +7569,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsCredentialIssued_model")] public class EventAcsCredentialIssued : Event @@ -7672,7 +7672,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsCredentialReissued_model")] public class EventAcsCredentialReissued : Event @@ -7775,7 +7775,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsCredentialInvalidated_model")] public class EventAcsCredentialInvalidated : Event @@ -7878,7 +7878,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsUserCreated_model")] public class EventAcsUserCreated : Event @@ -7981,7 +7981,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsUserDeleted_model")] public class EventAcsUserDeleted : Event @@ -8084,7 +8084,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsEncoderAdded_model")] public class EventAcsEncoderAdded : Event @@ -8187,7 +8187,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsEncoderRemoved_model")] public class EventAcsEncoderRemoved : Event @@ -8393,7 +8393,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsEntranceAdded_model")] public class EventAcsEntranceAdded : Event @@ -8496,7 +8496,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventAcsEntranceRemoved_model")] public class EventAcsEntranceRemoved : Event @@ -11204,7 +11204,7 @@ public override string ToString() } /// - /// 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). /// [DataContract(Name = "seamModel_eventDeviceConvertedToUnmanaged_model")] public class EventDeviceConvertedToUnmanaged : Event @@ -11327,7 +11327,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventDeviceUnmanagedConvertedToManaged_model")] public class EventDeviceUnmanagedConvertedToManaged : Event @@ -11450,7 +11450,7 @@ public override string ToString() } /// - /// 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`. /// [DataContract(Name = "seamModel_eventDeviceUnmanagedConnected_model")] public class EventDeviceUnmanagedConnected : Event @@ -11984,7 +11984,7 @@ public override string ToString() } /// - /// 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`. /// [DataContract(Name = "seamModel_eventDeviceUnmanagedDisconnected_model")] public class EventDeviceUnmanagedDisconnected : Event @@ -13337,7 +13337,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventDeviceSaltoPrivacyModeActivated_model")] public class EventDeviceSaltoPrivacyModeActivated : Event @@ -13460,7 +13460,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventDeviceSaltoPrivacyModeDeactivated_model")] public class EventDeviceSaltoPrivacyModeDeactivated : Event @@ -15117,7 +15117,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventNoiseSensorNoiseThresholdTriggered_model")] public class EventNoiseSensorNoiseThresholdTriggered : Event @@ -15288,7 +15288,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventLockLocked_model")] public class EventLockLocked : Event @@ -15363,6 +15363,9 @@ public enum MethodEnum [EnumMember(Value = "card")] Card = 6, + + [EnumMember(Value = "mobile_key")] + MobileKey = 7, } /// @@ -15495,7 +15498,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventLockUnlocked_model")] public class EventLockUnlocked : Event @@ -15545,7 +15548,7 @@ public EventLockUnlocked( } /// - /// 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. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum MethodEnum @@ -15570,6 +15573,9 @@ public enum MethodEnum [EnumMember(Value = "card")] Card = 6, + + [EnumMember(Value = "mobile_key")] + MobileKey = 7, } /// @@ -15664,7 +15670,7 @@ public enum MethodEnum public bool? IsViaNfc { get; set; } /// - /// 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. /// [DataMember(Name = "method", IsRequired = false, EmitDefaultValue = false)] public EventLockUnlocked.MethodEnum Method { get; set; } @@ -15702,7 +15708,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventLockAccessDenied_model")] public class EventLockAccessDenied : Event @@ -15916,7 +15922,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventThermostatClimatePresetActivated_model")] public class EventThermostatClimatePresetActivated : Event @@ -16067,7 +16073,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventThermostatManuallyAdjusted_model")] public class EventThermostatManuallyAdjusted : Event @@ -16117,7 +16123,7 @@ public EventThermostatManuallyAdjusted( } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum FanModeSettingEnum @@ -16136,7 +16142,7 @@ public enum FanModeSettingEnum } /// - /// 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`. /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum HvacModeSettingEnum @@ -16193,7 +16199,7 @@ public enum MethodEnum public string ConnectedAccountId { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_celsius", @@ -16203,7 +16209,7 @@ public enum MethodEnum public float? CoolingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "cooling_set_point_fahrenheit", @@ -16252,13 +16258,13 @@ public enum MethodEnum public override string EventType { get; } = "thermostat.manually_adjusted"; /// - /// 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`. /// [DataMember(Name = "fan_mode_setting", IsRequired = false, EmitDefaultValue = false)] public EventThermostatManuallyAdjusted.FanModeSettingEnum? FanModeSetting { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_celsius", @@ -16268,7 +16274,7 @@ public enum MethodEnum public float? HeatingSetPointCelsius { get; set; } /// - /// 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). /// [DataMember( Name = "heating_set_point_fahrenheit", @@ -16278,7 +16284,7 @@ public enum MethodEnum public float? HeatingSetPointFahrenheit { get; set; } /// - /// 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`. /// [DataMember(Name = "hvac_mode_setting", IsRequired = false, EmitDefaultValue = false)] public EventThermostatManuallyAdjusted.HvacModeSettingEnum? HvacModeSetting { get; set; } @@ -16322,7 +16328,7 @@ public override string ToString() } /// - /// 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). /// [DataContract(Name = "seamModel_eventThermostatTemperatureThresholdExceeded_model")] public class EventThermostatTemperatureThresholdExceeded : Event @@ -16493,7 +16499,7 @@ public override string ToString() } /// - /// 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). /// [DataContract(Name = "seamModel_eventThermostatTemperatureThresholdNoLongerExceeded_model")] public class EventThermostatTemperatureThresholdNoLongerExceeded : Event @@ -16665,7 +16671,7 @@ public override string ToString() } /// - /// 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). /// [DataContract(Name = "seamModel_eventThermostatTemperatureReachedSetPoint_model")] public class EventThermostatTemperatureReachedSetPoint : Event @@ -16828,7 +16834,7 @@ public override string ToString() } /// - /// 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. /// [DataContract(Name = "seamModel_eventThermostatTemperatureChanged_model")] public class EventThermostatTemperatureChanged : Event @@ -17118,6 +17124,7 @@ public EventCameraActivated( string eventId = default, string eventType = default, string? imageUrl = default, + List? mediaIds = default, EventCameraActivated.MotionSubTypeEnum? motionSubType = default, string occurredAt = default, string? videoUrl = default, @@ -17135,6 +17142,7 @@ public EventCameraActivated( EventId = eventId; EventType = eventType; ImageUrl = imageUrl; + MediaIds = mediaIds; MotionSubType = motionSubType; OccurredAt = occurredAt; VideoUrl = videoUrl; @@ -17243,6 +17251,12 @@ public enum MotionSubTypeEnum [DataMember(Name = "image_url", IsRequired = false, EmitDefaultValue = false)] public string? ImageUrl { get; set; } + /// + /// IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. + /// + [DataMember(Name = "media_ids", IsRequired = false, EmitDefaultValue = false)] + public List? MediaIds { get; set; } + /// /// Sub-type of motion detected, if available. /// @@ -17307,6 +17321,7 @@ public EventDeviceDoorbellRang( string eventId = default, string eventType = default, string? imageUrl = default, + List? mediaIds = default, string occurredAt = default, string? videoUrl = default, string workspaceId = default @@ -17322,6 +17337,7 @@ public EventDeviceDoorbellRang( EventId = eventId; EventType = eventType; ImageUrl = imageUrl; + MediaIds = mediaIds; OccurredAt = occurredAt; VideoUrl = videoUrl; WorkspaceId = workspaceId; @@ -17388,6 +17404,12 @@ public EventDeviceDoorbellRang( [DataMember(Name = "image_url", IsRequired = false, EmitDefaultValue = false)] public string? ImageUrl { get; set; } + /// + /// IDs of the media, such as a video clip and a thumbnail image, captured when the doorbell was pressed. Use `/media/get` to retrieve each one. + /// + [DataMember(Name = "media_ids", IsRequired = false, EmitDefaultValue = false)] + public List? MediaIds { get; set; } + /// /// Date and time at which the event occurred. /// diff --git a/src/Seam/Model/Media.cs b/src/Seam/Model/Media.cs new file mode 100644 index 00000000..15a83d26 --- /dev/null +++ b/src/Seam/Model/Media.cs @@ -0,0 +1,186 @@ +using System.Runtime.Serialization; +using System.Text; +using JsonSubTypes; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using Seam.Model; + +namespace Seam.Model +{ + /// + /// Represents a piece of media, such as a video clip or a thumbnail image, that a device captured for an event. Media is in beta. + /// + [DataContract(Name = "seamModel_media_model")] + public class Media + { + [JsonConstructorAttribute] + protected Media() { } + + public Media( + string? contentType = default, + string createdAt = default, + string? deviceId = default, + string? eventId = default, + string? expiresAt = default, + string mediaId = default, + Media.MediaTypeEnum mediaType = default, + Media.StatusEnum status = default, + string? url = default, + Media.VideoCodecEnum? videoCodec = default, + string workspaceId = default + ) + { + ContentType = contentType; + CreatedAt = createdAt; + DeviceId = deviceId; + EventId = eventId; + ExpiresAt = expiresAt; + MediaId = mediaId; + MediaType = mediaType; + Status = status; + Url = url; + VideoCodec = videoCodec; + WorkspaceId = workspaceId; + } + + /// + /// Type of the media: a video clip or a still image. + /// + [JsonConverter(typeof(SafeStringEnumConverter))] + public enum MediaTypeEnum + { + [EnumMember(Value = "unrecognized")] + Unrecognized = 0, + + [EnumMember(Value = "video")] + Video = 1, + + [EnumMember(Value = "image")] + Image = 2, + } + + /// + /// Status of the media. `pending` means that Seam is still retrieving the media. `available` means that `url` can be used to download it. `unavailable` means that no media exists for the event, and `failed` means that Seam could not retrieve it. + /// + [JsonConverter(typeof(SafeStringEnumConverter))] + public enum StatusEnum + { + [EnumMember(Value = "unrecognized")] + Unrecognized = 0, + + [EnumMember(Value = "pending")] + Pending = 1, + + [EnumMember(Value = "available")] + Available = 2, + + [EnumMember(Value = "unavailable")] + Unavailable = 3, + + [EnumMember(Value = "failed")] + Failed = 4, + } + + /// + /// Video codec used to encode the media. Only present for video media. `hevc` (H.265) playback support varies by browser and device, so check compatibility before assuming a clip plays inline. + /// + [JsonConverter(typeof(SafeStringEnumConverter))] + public enum VideoCodecEnum + { + [EnumMember(Value = "unrecognized")] + Unrecognized = 0, + + [EnumMember(Value = "h264")] + H264 = 1, + + [EnumMember(Value = "hevc")] + Hevc = 2, + } + + /// + /// MIME type of the media, such as `video/mp4` or `image/jpeg`. + /// + [DataMember(Name = "content_type", IsRequired = false, EmitDefaultValue = false)] + public string? ContentType { get; set; } + + /// + /// Date and time at which the media was created. + /// + [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] + public string CreatedAt { get; set; } + + /// + /// ID of the device that captured the media. + /// + [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] + public string? DeviceId { get; set; } + + /// + /// ID of the event that the media belongs to. + /// + [DataMember(Name = "event_id", IsRequired = false, EmitDefaultValue = false)] + public string? EventId { get; set; } + + /// + /// Date and time at which the media stops being available. Null when Seam does not know when the media expires. + /// + [DataMember(Name = "expires_at", IsRequired = false, EmitDefaultValue = false)] + public string? ExpiresAt { get; set; } + + /// + /// ID of the media. + /// + [DataMember(Name = "media_id", IsRequired = false, EmitDefaultValue = false)] + public string MediaId { get; set; } + + /// + /// Type of the media: a video clip or a still image. + /// + [DataMember(Name = "media_type", IsRequired = false, EmitDefaultValue = false)] + public Media.MediaTypeEnum MediaType { get; set; } + + /// + /// Status of the media. `pending` means that Seam is still retrieving the media. `available` means that `url` can be used to download it. `unavailable` means that no media exists for the event, and `failed` means that Seam could not retrieve it. + /// + [DataMember(Name = "status", IsRequired = false, EmitDefaultValue = false)] + public Media.StatusEnum Status { get; set; } + + /// + /// Short-lived URL from which you can download the media. Null unless `status` is `available`. The URL expires after about five minutes. Call `/media/get` again for a new URL. + /// + [DataMember(Name = "url", IsRequired = false, EmitDefaultValue = false)] + public string? Url { get; set; } + + /// + /// Video codec used to encode the media. Only present for video media. `hevc` (H.265) playback support varies by browser and device, so check compatibility before assuming a clip plays inline. + /// + [DataMember(Name = "video_codec", IsRequired = false, EmitDefaultValue = false)] + public Media.VideoCodecEnum? VideoCodec { get; set; } + + /// + /// ID of the workspace that contains the media. + /// + [DataMember(Name = "workspace_id", IsRequired = false, EmitDefaultValue = false)] + public string WorkspaceId { get; set; } + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } +} diff --git a/src/Seam/Model/NoiseThreshold.cs b/src/Seam/Model/NoiseThreshold.cs index 4f00ab63..18a36fd4 100644 --- a/src/Seam/Model/NoiseThreshold.cs +++ b/src/Seam/Model/NoiseThreshold.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_noiseThreshold_model")] public class NoiseThreshold @@ -71,7 +71,7 @@ public NoiseThreshold( public string NoiseThresholdId { get; set; } /// - /// 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). /// [DataMember(Name = "noise_threshold_nrs", IsRequired = false, EmitDefaultValue = false)] public float? NoiseThresholdNrs { get; set; } diff --git a/src/Seam/Model/Phone.cs b/src/Seam/Model/Phone.cs index 751ec03e..902f9c8f 100644 --- a/src/Seam/Model/Phone.cs +++ b/src/Seam/Model/Phone.cs @@ -65,7 +65,7 @@ public enum DeviceTypeEnum public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object CustomMetadata { get; set; } diff --git a/src/Seam/Model/ThermostatDailyProgram.cs b/src/Seam/Model/ThermostatDailyProgram.cs index 3430f044..4958adcc 100644 --- a/src/Seam/Model/ThermostatDailyProgram.cs +++ b/src/Seam/Model/ThermostatDailyProgram.cs @@ -110,7 +110,7 @@ public ThermostatDailyProgramPeriods( } /// - /// 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`. /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } diff --git a/src/Seam/Model/ThermostatSchedule.cs b/src/Seam/Model/ThermostatSchedule.cs index 71eba887..db036c3b 100644 --- a/src/Seam/Model/ThermostatSchedule.cs +++ b/src/Seam/Model/ThermostatSchedule.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_thermostatSchedule_model")] public class ThermostatSchedule @@ -45,43 +45,43 @@ public ThermostatSchedule( } /// - /// 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). /// [DataMember(Name = "climate_preset_key", IsRequired = false, EmitDefaultValue = false)] public string ClimatePresetKey { get; set; } /// - /// 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. /// [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] public string DeviceId { get; set; } /// - /// 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. /// [DataMember(Name = "ends_at", IsRequired = false, EmitDefaultValue = false)] public string EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } /// - /// 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. /// [DataMember(Name = "is_override_allowed", IsRequired = false, EmitDefaultValue = false)] public bool? IsOverrideAllowed { get; set; } /// - /// 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). /// [DataMember( Name = "max_override_period_minutes", @@ -91,19 +91,19 @@ public ThermostatSchedule( public int? MaxOverridePeriodMinutes { get; set; } /// - /// 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). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string? Name { get; set; } /// - /// 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. /// [DataMember(Name = "starts_at", IsRequired = false, EmitDefaultValue = false)] public string StartsAt { get; set; } /// - /// 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). /// [DataMember(Name = "thermostat_schedule_id", IsRequired = false, EmitDefaultValue = false)] public string ThermostatScheduleId { get; set; } diff --git a/src/Seam/Model/UnmanagedAccessCode.cs b/src/Seam/Model/UnmanagedAccessCode.cs index df27c4d2..0cbb4c70 100644 --- a/src/Seam/Model/UnmanagedAccessCode.cs +++ b/src/Seam/Model/UnmanagedAccessCode.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// @@ -19,7 +19,7 @@ namespace Seam.Model /// /// 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) /// [DataContract(Name = "seamModel_unmanagedAccessCode_model")] public class UnmanagedAccessCode @@ -34,6 +34,7 @@ public UnmanagedAccessCode( string? code = default, string createdAt = default, string deviceId = default, + string displayStatus = default, UnmanagedAccessCodeDormakabaOracodeMetadata? dormakabaOracodeMetadata = default, string? endsAt = default, List errors = default, @@ -52,6 +53,7 @@ public UnmanagedAccessCode( Code = code; CreatedAt = createdAt; DeviceId = deviceId; + DisplayStatus = displayStatus; DormakabaOracodeMetadata = dormakabaOracodeMetadata; EndsAt = endsAt; Errors = errors; @@ -123,8 +125,8 @@ public UnmanagedAccessCode( "account_disconnected" )] [JsonSubtypes.KnownSubType( - typeof(UnmanagedAccessCodeErrorsFailedToExpire), - "failed_to_expire" + typeof(UnmanagedAccessCodeErrorsFailedToDelete), + "failed_to_delete" )] [JsonSubtypes.KnownSubType( typeof(UnmanagedAccessCodeErrorsFailedToUpdate), @@ -936,13 +938,13 @@ public override string ToString() } } - [DataContract(Name = "seamModel_unmanagedAccessCodeErrorsFailedToExpire_model")] - public class UnmanagedAccessCodeErrorsFailedToExpire : UnmanagedAccessCodeErrors + [DataContract(Name = "seamModel_unmanagedAccessCodeErrorsFailedToDelete_model")] + public class UnmanagedAccessCodeErrorsFailedToDelete : UnmanagedAccessCodeErrors { [JsonConstructorAttribute] - protected UnmanagedAccessCodeErrorsFailedToExpire() { } + protected UnmanagedAccessCodeErrorsFailedToDelete() { } - public UnmanagedAccessCodeErrorsFailedToExpire( + public UnmanagedAccessCodeErrorsFailedToDelete( string? createdAt = default, string errorCode = default, bool isAccessCodeError = default, @@ -962,7 +964,7 @@ public UnmanagedAccessCodeErrorsFailedToExpire( public string? CreatedAt { get; set; } [DataMember(Name = "error_code", IsRequired = true, EmitDefaultValue = false)] - public override string ErrorCode { get; } = "failed_to_expire"; + public override string ErrorCode { get; } = "failed_to_delete"; /// /// Indicates that this is an access code error. @@ -1031,7 +1033,7 @@ public UnmanagedAccessCodeErrorsAccountDisconnected( public override string ErrorCode { get; } = "account_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1106,7 +1108,7 @@ public UnmanagedAccessCodeErrorsSaltoKsSubscriptionLimitExceeded( public override string ErrorCode { get; } = "salto_ks_subscription_limit_exceeded"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1178,7 +1180,7 @@ public UnmanagedAccessCodeErrorsInsufficientPermissions( public override string ErrorCode { get; } = "insufficient_permissions"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1250,7 +1252,7 @@ public UnmanagedAccessCodeErrorsDormakabaSitesDisconnected( public override string ErrorCode { get; } = "dormakaba_sites_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1862,7 +1864,7 @@ public UnmanagedAccessCodeErrorsBridgeDisconnected( public override string ErrorCode { get; } = "bridge_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public bool? IsBridgeError { get; set; } @@ -2868,6 +2870,12 @@ public override string ToString() [DataMember(Name = "device_id", IsRequired = false, EmitDefaultValue = false)] public string DeviceId { get; set; } + /// + /// Human-readable label for the code's state: `Active` or `Not active`, based on whether the code is set on the device. For display only. The wording is not stable and is not an enumeration — never compare against or branch on it. + /// + [DataMember(Name = "display_status", IsRequired = false, EmitDefaultValue = false)] + public string DisplayStatus { get; set; } + /// /// Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices. /// @@ -2885,7 +2893,7 @@ public override string ToString() public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -2911,6 +2919,7 @@ public override string ToString() /// /// Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. /// + [Obsolete("Use `display_status` to show a person the code's state.")] [DataMember(Name = "status", IsRequired = false, EmitDefaultValue = false)] public UnmanagedAccessCode.StatusEnum Status { get; set; } @@ -2921,7 +2930,7 @@ public override string ToString() public UnmanagedAccessCode.TypeEnum Type { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/UnmanagedAccessGrant.cs b/src/Seam/Model/UnmanagedAccessGrant.cs index beecf8f4..751c29c5 100644 --- a/src/Seam/Model/UnmanagedAccessGrant.cs +++ b/src/Seam/Model/UnmanagedAccessGrant.cs @@ -1237,7 +1237,7 @@ public override string ToString() public string? EndsAt { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -1293,7 +1293,7 @@ public override string ToString() public string? UserIdentityId { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/UnmanagedAccessMethod.cs b/src/Seam/Model/UnmanagedAccessMethod.cs index e8336f90..d2c88981 100644 --- a/src/Seam/Model/UnmanagedAccessMethod.cs +++ b/src/Seam/Model/UnmanagedAccessMethod.cs @@ -750,6 +750,14 @@ public override string ToString() [JsonConverter(typeof(JsonSubtypes), "warning_code")] [JsonSubtypes.FallBackSubType(typeof(UnmanagedAccessMethodWarningsUnrecognized))] + [JsonSubtypes.KnownSubType( + typeof(UnmanagedAccessMethodWarningsUserIdentityMissingPhoneNumber), + "user_identity_missing_phone_number" + )] + [JsonSubtypes.KnownSubType( + typeof(UnmanagedAccessMethodWarningsUserIdentityMissingEmailAddress), + "user_identity_missing_email_address" + )] [JsonSubtypes.KnownSubType( typeof(UnmanagedAccessMethodWarningsDelayInIssuing), "delay_in_issuing" @@ -999,6 +1007,116 @@ public override string ToString() } } + [DataContract( + Name = "seamModel_unmanagedAccessMethodWarningsUserIdentityMissingEmailAddress_model" + )] + public class UnmanagedAccessMethodWarningsUserIdentityMissingEmailAddress + : UnmanagedAccessMethodWarnings + { + [JsonConstructorAttribute] + protected UnmanagedAccessMethodWarningsUserIdentityMissingEmailAddress() { } + + public UnmanagedAccessMethodWarningsUserIdentityMissingEmailAddress( + string createdAt = default, + string message = default, + string warningCode = default + ) + { + CreatedAt = createdAt; + Message = message; + WarningCode = warningCode; + } + + /// + /// Date and time at which Seam created the warning. + /// + [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] + public override string CreatedAt { get; set; } + + /// + /// Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + /// + [DataMember(Name = "message", IsRequired = false, EmitDefaultValue = false)] + public override string Message { get; set; } + + [DataMember(Name = "warning_code", IsRequired = true, EmitDefaultValue = false)] + public override string WarningCode { get; } = "user_identity_missing_email_address"; + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + + [DataContract( + Name = "seamModel_unmanagedAccessMethodWarningsUserIdentityMissingPhoneNumber_model" + )] + public class UnmanagedAccessMethodWarningsUserIdentityMissingPhoneNumber + : UnmanagedAccessMethodWarnings + { + [JsonConstructorAttribute] + protected UnmanagedAccessMethodWarningsUserIdentityMissingPhoneNumber() { } + + public UnmanagedAccessMethodWarningsUserIdentityMissingPhoneNumber( + string createdAt = default, + string message = default, + string warningCode = default + ) + { + CreatedAt = createdAt; + Message = message; + WarningCode = warningCode; + } + + /// + /// Date and time at which Seam created the warning. + /// + [DataMember(Name = "created_at", IsRequired = false, EmitDefaultValue = false)] + public override string CreatedAt { get; set; } + + /// + /// Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + /// + [DataMember(Name = "message", IsRequired = false, EmitDefaultValue = false)] + public override string Message { get; set; } + + [DataMember(Name = "warning_code", IsRequired = true, EmitDefaultValue = false)] + public override string WarningCode { get; } = "user_identity_missing_phone_number"; + + public override string ToString() + { + JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(null); + + StringWriter stringWriter = new StringWriter( + new StringBuilder(256), + System.Globalization.CultureInfo.InvariantCulture + ); + using (JsonTextWriter jsonTextWriter = new JsonTextWriter(stringWriter)) + { + jsonTextWriter.IndentChar = ' '; + jsonTextWriter.Indentation = 2; + jsonTextWriter.Formatting = Formatting.Indented; + jsonSerializer.Serialize(jsonTextWriter, this, null); + } + + return stringWriter.ToString(); + } + } + [DataContract(Name = "seamModel_unmanagedAccessMethodWarningsUnrecognized_model")] public class UnmanagedAccessMethodWarningsUnrecognized : UnmanagedAccessMethodWarnings { @@ -1082,7 +1200,7 @@ public override string ToString() public string DisplayStatus { get; set; } /// - /// 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). /// [DataMember(Name = "errors", IsRequired = false, EmitDefaultValue = false)] public List Errors { get; set; } @@ -1130,13 +1248,13 @@ public override string ToString() public UnmanagedAccessMethod.ModeEnum Mode { get; set; } /// - /// 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. /// [DataMember(Name = "pending_mutations", IsRequired = false, EmitDefaultValue = false)] public List PendingMutations { get; set; } /// - /// 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). /// [DataMember(Name = "warnings", IsRequired = false, EmitDefaultValue = false)] public List Warnings { get; set; } diff --git a/src/Seam/Model/UnmanagedDevice.cs b/src/Seam/Model/UnmanagedDevice.cs index 1640118f..0317ac19 100644 --- a/src/Seam/Model/UnmanagedDevice.cs +++ b/src/Seam/Model/UnmanagedDevice.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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). /// [DataContract(Name = "seamModel_unmanagedDevice_model")] public class UnmanagedDevice @@ -18,6 +18,7 @@ public class UnmanagedDevice protected UnmanagedDevice() { } public UnmanagedDevice( + bool? canActivateWeeklyProgram = default, bool? canConfigureAutoLock = default, bool? canHvacCool = default, bool? canHvacHeat = default, @@ -36,6 +37,7 @@ public UnmanagedDevice( bool? canSimulateHubDisconnection = default, bool? canSimulatePaidSubscription = default, bool? canSimulateRemoval = default, + bool? canStreamLiveVideo = default, bool? canTurnOffHvac = default, bool? canUnlockWithCode = default, List capabilitiesSupported = default, @@ -53,6 +55,7 @@ public UnmanagedDevice( string workspaceId = default ) { + CanActivateWeeklyProgram = canActivateWeeklyProgram; CanConfigureAutoLock = canConfigureAutoLock; CanHvacCool = canHvacCool; CanHvacHeat = canHvacHeat; @@ -73,6 +76,7 @@ public UnmanagedDevice( CanSimulateHubDisconnection = canSimulateHubDisconnection; CanSimulatePaidSubscription = canSimulatePaidSubscription; CanSimulateRemoval = canSimulateRemoval; + CanStreamLiveVideo = canStreamLiveVideo; CanTurnOffHvac = canTurnOffHvac; CanUnlockWithCode = canUnlockWithCode; CapabilitiesSupported = capabilitiesSupported; @@ -91,7 +95,7 @@ public UnmanagedDevice( } /// - /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum CapabilitiesSupportedEnum @@ -255,6 +259,15 @@ public enum DeviceTypeEnum [EnumMember(Value = "ring_camera")] RingCamera = 43, + + [EnumMember(Value = "tapo_camera")] + TapoCamera = 44, + + [EnumMember(Value = "arlo_camera")] + ArloCamera = 45, + + [EnumMember(Value = "reolink_camera")] + ReolinkCamera = 46, } [JsonConverter(typeof(JsonSubtypes), "error_code")] @@ -351,7 +364,7 @@ public UnmanagedDeviceErrorsAccountDisconnected( public override string ErrorCode { get; } = "account_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -425,7 +438,7 @@ public UnmanagedDeviceErrorsSaltoKsSubscriptionLimitExceeded( public override string ErrorCode { get; } = "salto_ks_subscription_limit_exceeded"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -497,7 +510,7 @@ public UnmanagedDeviceErrorsInsufficientPermissions( public override string ErrorCode { get; } = "insufficient_permissions"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -569,7 +582,7 @@ public UnmanagedDeviceErrorsDormakabaSitesDisconnected( public override string ErrorCode { get; } = "dormakaba_sites_disconnected"; /// - /// 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. /// [DataMember( Name = "is_connected_account_error", @@ -1181,7 +1194,7 @@ public UnmanagedDeviceErrorsBridgeDisconnected( public override string ErrorCode { get; } = "bridge_disconnected"; /// - /// 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). /// [DataMember(Name = "is_bridge_error", IsRequired = false, EmitDefaultValue = false)] public bool? IsBridgeError { get; set; } @@ -2943,6 +2956,16 @@ public override string ToString() } } + /// + /// Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. + /// + [DataMember( + Name = "can_activate_weekly_program", + IsRequired = false, + EmitDefaultValue = false + )] + public bool? CanActivateWeeklyProgram { get; set; } + /// /// Indicates whether the lock supports configuring automatic locking. /// @@ -3091,6 +3114,12 @@ public override string ToString() [DataMember(Name = "can_simulate_removal", IsRequired = false, EmitDefaultValue = false)] public bool? CanSimulateRemoval { get; set; } + /// + /// Indicates whether the camera supports streaming live video through a camera live view session. + /// + [DataMember(Name = "can_stream_live_video", IsRequired = false, EmitDefaultValue = false)] + public bool? CanStreamLiveVideo { get; set; } + /// /// Indicates whether the thermostat can be turned off. /// @@ -3104,7 +3133,7 @@ public override string ToString() public bool? CanUnlockWithCode { get; set; } /// - /// 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). /// [DataMember(Name = "capabilities_supported", IsRequired = false, EmitDefaultValue = false)] public List CapabilitiesSupported { get; set; } @@ -3122,7 +3151,7 @@ public override string ToString() public string CreatedAt { get; set; } /// - /// 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. /// [DataMember(Name = "custom_metadata", IsRequired = false, EmitDefaultValue = false)] public object CustomMetadata { get; set; } diff --git a/src/Seam/Model/UserIdentity.cs b/src/Seam/Model/UserIdentity.cs index 7a28e98c..9d3dafbf 100644 --- a/src/Seam/Model/UserIdentity.cs +++ b/src/Seam/Model/UserIdentity.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_userIdentity_model")] public class UserIdentity diff --git a/src/Seam/Model/Webhook.cs b/src/Seam/Model/Webhook.cs index ba425ddb..0590ca5b 100644 --- a/src/Seam/Model/Webhook.cs +++ b/src/Seam/Model/Webhook.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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. /// [DataContract(Name = "seamModel_webhook_model")] public class Webhook @@ -31,19 +31,19 @@ public Webhook( } /// - /// 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. /// [DataMember(Name = "event_types", IsRequired = false, EmitDefaultValue = false)] public List? EventTypes { get; set; } /// - /// 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). /// [DataMember(Name = "secret", IsRequired = false, EmitDefaultValue = false)] public string? Secret { get; set; } /// - /// URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). + /// URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks). /// [DataMember(Name = "url", IsRequired = false, EmitDefaultValue = false)] public string Url { get; set; } diff --git a/src/Seam/Model/Workspace.cs b/src/Seam/Model/Workspace.cs index ed6f1991..01320b21 100644 --- a/src/Seam/Model/Workspace.cs +++ b/src/Seam/Model/Workspace.cs @@ -9,7 +9,7 @@ namespace Seam.Model { /// - /// 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). /// [DataContract(Name = "seamModel_workspace_model")] public class Workspace @@ -43,14 +43,14 @@ public Workspace( } /// - /// 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). /// [Obsolete("Use `connect_partner_name` instead.")] [DataMember(Name = "company_name", IsRequired = false, EmitDefaultValue = false)] public string CompanyName { get; set; } /// - /// 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). /// [DataMember(Name = "connect_partner_name", IsRequired = false, EmitDefaultValue = false)] public string? ConnectPartnerName { get; set; } @@ -73,19 +73,19 @@ public Workspace( public bool IsPublishableKeyAuthEnabled { get; set; } /// - /// 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). /// [DataMember(Name = "is_sandbox", IsRequired = false, EmitDefaultValue = false)] public bool IsSandbox { get; set; } /// - /// 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. /// [DataMember(Name = "is_suspended", IsRequired = false, EmitDefaultValue = false)] public bool IsSuspended { get; set; } /// - /// Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). + /// Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces). /// [DataMember(Name = "name", IsRequired = false, EmitDefaultValue = false)] public string Name { get; set; } @@ -97,7 +97,7 @@ public Workspace( public string? OrganizationId { get; set; } /// - /// 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. /// [DataMember(Name = "publishable_key", IsRequired = false, EmitDefaultValue = false)] public string? PublishableKey { get; set; } @@ -150,7 +150,7 @@ public WorkspaceConnectWebviewCustomization( } /// - /// 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). /// [JsonConverter(typeof(SafeStringEnumConverter))] public enum LogoShapeEnum @@ -166,25 +166,25 @@ public enum LogoShapeEnum } /// - /// 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). /// [DataMember(Name = "inviter_logo_url", IsRequired = false, EmitDefaultValue = false)] public string? InviterLogoUrl { get; set; } /// - /// 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). /// [DataMember(Name = "logo_shape", IsRequired = false, EmitDefaultValue = false)] public WorkspaceConnectWebviewCustomization.LogoShapeEnum? LogoShape { get; set; } /// - /// 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). /// [DataMember(Name = "primary_button_color", IsRequired = false, EmitDefaultValue = false)] public string? PrimaryButtonColor { get; set; } /// - /// 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). /// [DataMember( Name = "primary_button_text_color", @@ -194,7 +194,7 @@ public enum LogoShapeEnum public string? PrimaryButtonTextColor { get; set; } /// - /// 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). /// [DataMember(Name = "success_message", IsRequired = false, EmitDefaultValue = false)] public string? SuccessMessage { get; set; }