Installations
An installation represents any entity (company, office, building, hotel, etc.) that uses Salto Nebula.
As such, it represents a collection of all the access control elements (such as access points, access rights, users, etc.) that comprise the access control system.
This service is responsible for managing installation resources.
Resource name of the installation. It must have the format of installations/*. For example: installations/surelock-homes-hq.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
Output only. Resource name of the subscription. It must have the format of installations/*/subscription. For example: installations/surelock-homes-hq/subscription.
The billing information of the subscription.
The payment method of the subscription.
The coupons applied to the subscription.
End of the trial period for the subscription.
Resource name of the subscription's billing info. It must have the format of installations/*/subscription/billing-info. For example: installations/surelock-homes-hq/subscription/billing-info.
The company name.
The lines of the address. The first line may include the street name, number, P.O. box, and further lines can include information such as an apartment number, suite or unit.
The region, country or territory code. Must be in ISO 3166-1 format.
The city, district, suburb, town, or village name.
The ZIP or postal code.
The state or province code. Must be in ISO 3166-2 format. Mandatory for the following countries: USA, Canada and India. For the rest of the countries, it will be ignored.
The VAT or Tax Registration Number (TRN).
Resource name of the subscription's payment method. It must have the format of installations/*/subscription/payment-method. For example: installations/surelock-homes-hq/subscription/payment-method.
The accepted payment method for the installation.
Card details.
Direct debit details.
Resource name of the payment authorization. It must have the format of installations/*/subscription/payment-authorizations/*. For example: installations/salto-hq/subscription/payment-authorizations/01HCD0YB.
Resource name of the coupon. It must have the format of installations/*/subscription/coupons/*. For example: installations/salto-hq/subscription/coupons/01HCD0YB.
Resource name of the invoice. It must have the format of installations/*/subscription/invoices/*. For example: installations/salto-hq/subscription/invoices/2023-000015.
Start time of the invoice. It must be past time.
End time of the invoice.
The line items included in the invoice. Must include at least one item and no more than 50.
The total cost of the invoice. The value is in the minor unit of the currency. (for example: cents).
Indicates whether this invoice has been paid or not.
STATE_UNSPECIFIED0.Sentinel value used to indicate that the state is unknown, omitted, or is not applicable.
UNPAID1. The invoice is unpaid.PAID2. The invoice has been paid.Output only. Resource name of the policy. It must have the format of installations/*/iam-policies. For example: installations/surelock-homes-hq/iam-policies/standard.
Specifies the identity requesting access to this resource.
The names of the roles this policy grants.
The URI to view the digital key background image.
The file resource name for the digital key background image. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The color used to display the installation name text on top of the background image.
Email address for the proposed installation owner.
Expiration time of the transfer proposal.
The identifier of the partner who created the installation.
The currency code the partner used for the installation (ISO 4217 format).
The date the card expires.
The last four digits of the card.
The card brand. For example: visa, mastercard, american_express, other.
The direct debit scheme.
SEPA details.
The line item ID belonging to the subscription. For example: elevators.
The quantity of the line item used.
The cost of the item price when the pricing model is flat fee. When the pricing model is per unit, it is the price per unit quantity of the item. The value is in the minor unit of the currency. (for example: cents).
The amount of red in the color as a value in the interval [0, 1].
The amount of green in the color as a value in the interval [0, 1].
The amount of blue in the color as a value in the interval [0, 1].
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
Month of year. Must be from 1 to 12.
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
The last four digits of the bank account number used for direct debit.
The name of the person or business that owns the bank account.
The IBAN (International Bank Account Number) of the bank account.
The IAM policy object
Output only. Resource name of the policy. It must have the format of installations/*/iam-policies. For example: installations/surelock-homes-hq/iam-policies/standard.
Specifies the identity requesting access to this resource.
The names of the roles this policy grants.
The invoice object used for billing
Resource name of the invoice. It must have the format of installations/*/subscription/invoices/*. For example: installations/salto-hq/subscription/invoices/2023-000015.
Start time of the invoice. It must be past time.
End time of the invoice.
The line items included in the invoice. Must include at least one item and no more than 50.
The total cost of the invoice. The value is in the minor unit of the currency. (for example: cents).
Indicates whether this invoice has been paid or not.
STATE_UNSPECIFIED0.Sentinel value used to indicate that the state is unknown, omitted, or is not applicable.
UNPAID1. The invoice is unpaid.PAID2. The invoice has been paid.The coupon object
Resource name of the coupon. It must have the format of installations/*/subscription/coupons/*. For example: installations/salto-hq/subscription/coupons/01HCD0YB.
Payment authorization for the subscription.
Resource name of the payment authorization. It must have the format of installations/*/subscription/payment-authorizations/*. For example: installations/salto-hq/subscription/payment-authorizations/01HCD0YB.
Representation of a payment method, belonging to a subscription
Resource name of the subscription's payment method. It must have the format of installations/*/subscription/payment-method. For example: installations/surelock-homes-hq/subscription/payment-method.
The accepted payment method for the installation.
Card details.
Direct debit details.
Billing info object, belonging to a subscription
Resource name of the subscription's billing info. It must have the format of installations/*/subscription/billing-info. For example: installations/surelock-homes-hq/subscription/billing-info.
The company name.
The lines of the address. The first line may include the street name, number, P.O. box, and further lines can include information such as an apartment number, suite or unit.
The region, country or territory code. Must be in ISO 3166-1 format.
The city, district, suburb, town, or village name.
The ZIP or postal code.
The state or province code. Must be in ISO 3166-2 format. Mandatory for the following countries: USA, Canada and India. For the rest of the countries, it will be ignored.
The VAT or Tax Registration Number (TRN).
The subscription information
Output only. Resource name of the subscription. It must have the format of installations/*/subscription. For example: installations/surelock-homes-hq/subscription.
The billing information of the subscription.
The payment method of the subscription.
The coupons applied to the subscription.
End of the trial period for the subscription.
The installation object
Resource name of the installation. It must have the format of installations/*. For example: installations/surelock-homes-hq.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
Create an installation
Creates a new installation.
Input
The installation resource to be created. Client must not set the Installation.name field.
The installation ID to use for this installation. In case it's empty the server will autogenerate a unique identifier.
If set, validate the request but do not actually create the installation.
Output
Resource name of the installation. It must have the format of installations/*.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
Get an installation
Retrieves an existing installation.
Input
The name of the requested installation resource.
Output
Resource name of the installation. It must have the format of installations/*.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
List installations
Returns a list of installations that have been previously created.
Input
The maximum number of items to return.
The next_page_token value returned from a previous List request, if any.
A filter that chooses which installations to return.
How the results should be sorted.
Show deleted installations.
Output
The field name should match the noun installations in the method name. There will be a maximum number of items returned based on the page_size field in the request.
Token to retrieve the next page of results, or empty if there are no more results in the list.
Update an installation
Updates an existing installation.
Input
The installation resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Resource name of the installation. It must have the format of installations/*.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
Delete an installation
Soft deletes an installation. This action can be reversed if required.
Input
The resource name of the installation to be soft deleted.
If set, validate the request but do not actually delete the installation.
The number of hours to wait before permanently deleting the installation. If unset, the default is 720 (30 days).
Output
Resource name of the installation. It must have the format of installations/*.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
Undelete an installation
Undeletes an installation.
Input
The resource name of the installation to be undeleted.
Output
Resource name of the installation. It must have the format of installations/*.
Display name of the installation.
The URI to view the installation photo.
Unstructured address. For example: "1600 Amphitheatre Pkwy, Mountain View, CA 94043, Sunnyvale, California."
Time zone where the installation is located. It must follow the IANA Time Zone Database format. For example, "America/New_York."
The digital key art configuration resource that belongs to the installation.
Current state of the ownership transfer. Client must not set the Installation.transfer_ownership_state field. This data is only visible to the current installation owner.
The time when the installation was soft deleted.
The length of time a key remains valid before requiring renewal. This duration defines the effective lifespan of a key, after which it must be updated to maintain access privileges. The duration is crucial for ensuring security in the system, as it determines how frequently keys need to be renewed.
The file resource name for the installation photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.
The information of the partner who created the installation.
The time when the installation was blocked.
Create a policy
Creates a policy for the installation. An IAM policy is a collection of roles associated to users that define who has what type of access to manage access control objects within the installation.
Input
Resource name of the parent resource where to create the IAM policy.
The policy ID to use for the IAM policy. In case it's empty the server will autogenerate a unique identifier.
The policy resource to be created. Client must not set the Policy.name field.
Output
Output only. Resource name of the policy. It must have the format of installations/*/iam-policies.
Specifies the identity requesting access to this resource.
The names of the roles this policy grants.
Get a policy
Retrieves an existing policy.
Input
The name of the requested policy resource.
Output
Output only. Resource name of the policy. It must have the format of installations/*/iam-policies.
Specifies the identity requesting access to this resource.
The names of the roles this policy grants.
List policies
Returns a list of policies that have been previously created.
Input
The parent resource name.
The maximum number of items to return.
The next_page_token value returned from a previous List request, if any.
A filter that chooses which installations to return.
How the results should be sorted.
Output
The field name should match the noun policies in the method name. There will be a maximum number of items returned based on the page_size field in the request.
Token to retrieve the next page of results, or empty if there are no more results in the list.
Update a policy
Updates an existing policy.
Input
The policy resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Output only. Resource name of the policy. It must have the format of installations/*/iam-policies.
Specifies the identity requesting access to this resource.
The names of the roles this policy grants.
Delete a policy
Permanently deletes a policy. This cannot be undone.
Input
The resource name of the policy to be deleted.
Output
No return value.
Tests permissions
Returns permissions that a caller has within the installation. If the installation does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Input
The resource name for which the policy detail is being requested.
The set of permissions to check for the resource_name. Permissions with wildcards (such as '' or 'nebula.access-point.') are not allowed.
Output
A subset of TestPermissionsRequest.permissions that the caller is allowed.
Transfer installation ownership
Transfers the ownership of an installation.
Input
The resource name for which the transfer ownership is being requested.
Email address for the proposed installation owner.
Output
Accept installation ownership
Accepts the ownership of an installation.
Input
The resource name for which the accept ownership is being requested.
The billing info resource for the subscription billing.
Output
Get a subscription
Gets an existing subscription
Input
The name of the requested subscription resource.
Output
Output only. Resource name of the subscription. It must have the format of installations/*/subscription.
The billing information of the subscription.
The payment method of the subscription.
The coupons applied to the subscription.
End of the trial period for the subscription.
Update a subscription's billing information
Updates an existing subscription's billing information.
Input
The billing info resource which replaces the resource on the server.
Output
Resource name of the subscription's billing info. It must have the format of installations/*/subscription/billing-info.
The company name.
The lines of the address. The first line may include the street name, number, P.O. box, and further lines can include information such as an apartment number, suite or unit.
The region, country or territory code. Must be in ISO 3166-1 format.
The city, district, suburb, town, or village name.
The ZIP or postal code.
The state or province code. Must be in ISO 3166-2 format. Mandatory for the following countries: USA, Canada and India. For the rest of the countries, it will be ignored.
The VAT or Tax Registration Number (TRN).
Update subscription payment method
Updates an existing subscription payment method. If there is a payment method associated with the subscription, it will be deleted.
Input
The payment method resource which replaces the resource on the server.
Output
Resource name of the subscription's payment method. It must have the format of installations/*/subscription/payment-method.
The accepted payment method for the installation.
Card details.
Direct debit details.
Update subscription payment method's card
Updates subscription payment method's card. If there is a payment method associated with the subscription, it will be deleted.
Input
The resource name of the subscription's payment method for which the card is being requested to be updated.
The token provided for the operation.
Output
Create a payment authorization
Creates a payment authorization for the subscription. The payment authorization is a process that allows the customer to authorize a payment card for future use. This is done by creating a payment authorization request. The result of the request is a payment authorization that must be authorized by the client in the client's UI.
Input
The resource name of the subscription for which the payment authorization is being requested to be created.
The payment authorization resource to be created. Client must not set the PaymentAuthorization.name field.
Output
Resource name of the payment authorization. It must have the format of installations/*/subscription/payment-authorizations/*.
List invoices
Returns a list of invoices.
Input
The parent resource name. It must have the format of installations/*/subscription.
Output
The field name should match the noun invoices in the method name.
Apply a coupon
Applies a coupon to the subscription.
Input
The resource name of the subscription for which the coupon is being requested to be applied.
The resource name of the coupon that is requested to be applied.
Output
Unapply a coupon
Unapplies a coupon to the subscription.
Input
The resource name of the subscription for which the coupon is being requested to be unapplied.
The resource name of the coupon that is requested to be unapplied.
Back
