diff --git a/codegen/lib/layout/api-endpoint.ts b/codegen/lib/layout/api-endpoint.ts index 4042d18d4..7620f0210 100644 --- a/codegen/lib/layout/api-endpoint.ts +++ b/codegen/lib/layout/api-endpoint.ts @@ -246,6 +246,13 @@ const mapBlueprintParamToEndpointParam = ( ...(param.format === 'object' && { objectParameters: param.parameters.map(mapBlueprintParamToEndpointParam), }), + + ...(param.format === 'list' && + param.itemFormat === 'object' && { + objectParameters: param.itemParameters.map( + mapBlueprintParamToEndpointParam, + ), + }), } } diff --git a/docs/api/access_grants/create.md b/docs/api/access_grants/create.md index 579b9a683..be7d83f87 100644 --- a/docs/api/access_grants/create.md +++ b/docs/api/access_grants/create.md @@ -433,8 +433,35 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`requested_access_methods`** *Array* *of Objects* (Required) +
+ +code String + +Specific PIN code to use for this access method. Only applicable when mode is 'code'. + +
+ --- + + +
+ +mode Enum + +Access method mode. Supported values: `code`, `card`, `mobile_key`. + +Enum values: + +- code +- card +- mobile_key + +
+ +--- + + **`access_grant_key`** *String* Unique key for the access grant within the workspace. diff --git a/docs/api/customers/push_data.md b/docs/api/customers/push_data.md index 6e46b11f8..43a0847fc 100644 --- a/docs/api/customers/push_data.md +++ b/docs/api/customers/push_data.md @@ -32,105 +32,1158 @@ Your unique identifier for the customer. List of access grants. +
+ +access_grant_key String + +Your unique identifier for the access grant. + +
+ +--- + + + +
+ +building_keys List + +Building keys associated with the access grant. + +
+ +--- + + + +
+ +common_area_keys List + +Common area keys associated with the access grant. + +
+ +--- + + + +
+ +ends_at String + +Ending date and time for the access grant. + +
+ +--- + + + +
+ +facility_keys List + +Facility keys associated with the access grant. + +
+ +--- + + + +
+ +guest_key String + +Guest key associated with the access grant. + +
+ +--- + + + +
+ +listing_keys List + +Listing keys associated with the access grant. + +
+ +--- + + + +
+ +name String + +Your name for this access grant resource. + +
+ +--- + + + +
+ +preferred_code String + +Preferred PIN code to use when creating access for this reservation. + +
+ +--- + + + +
+ +property_keys List + +Property keys associated with the access grant. + +
+ +--- + + + +
+ +resident_key String + +Resident key associated with the access grant. + +
+ +--- + + + +
+ +room_keys List + +Room keys associated with the access grant. + +
+ +--- + + + +
+ +space_keys List + +Space keys associated with the access grant. + +
+ +--- + + + +
+ +starts_at String + +Starting date and time for the access grant. + +
+ +--- + + + +
+ +tenant_key String + +Tenant key associated with the access grant. + +
+ +--- + + + +
+ +unit_keys List + +Unit keys associated with the access grant. + +
+ +--- + + + +
+ +user_identity_key String + +User identity key associated with the access grant. + +
+ +--- + + + +
+ +user_key String + +User key associated with the access grant. + +
+ +--- + + +**`bookings`** *Array* *of Objects* + +List of bookings. + +
+ +booking_key String + +Your unique identifier for the booking. + +
+ +--- + + + +
+ +building_keys List + +Building keys associated with the access grant. + +
+ +--- + + + +
+ +common_area_keys List + +Common area keys associated with the access grant. + +
+ +--- + + + +
+ +ends_at String + +Ending date and time for the access grant. + +
+ +--- + + + +
+ +facility_keys List + +Facility keys associated with the access grant. + +
+ +--- + + + +
+ +guest_key String + +Guest key associated with the access grant. + +
+ +--- + + + +
+ +listing_keys List + +Listing keys associated with the access grant. + +
+ +--- + + + +
+ +name String + +Your name for this access grant resource. + +
+ +--- + + + +
+ +preferred_code String + +Preferred PIN code to use when creating access for this reservation. + +
+ +--- + + + +
+ +property_keys List + +Property keys associated with the access grant. + +
+ +--- + + + +
+ +resident_key String + +Resident key associated with the access grant. + +
+ +--- + + + +
+ +room_keys List + +Room keys associated with the access grant. + +
+ +--- + + + +
+ +space_keys List + +Space keys associated with the access grant. + +
+ +--- + + + +
+ +starts_at String + +Starting date and time for the access grant. + +
+ +--- + + + +
+ +tenant_key String + +Tenant key associated with the access grant. + +
+ +--- + + + +
+ +unit_keys List + +Unit keys associated with the access grant. + +
+ +--- + + + +
+ +user_identity_key String + +User identity key associated with the access grant. + +
+ +--- + + + +
+ +user_key String + +User key associated with the access grant. + +
+ +--- + + +**`buildings`** *Array* *of Objects* + +List of buildings. + +
+ +building_key String + +Your unique identifier for the building. + +
+ +--- + + + +
+ +name String + +Your display name for this location resource. + +
+ +--- + + +**`common_areas`** *Array* *of Objects* + +List of shared common areas. + +
+ +common_area_key String + +Your unique identifier for the common area. + +
+ +--- + + + +
+ +name String + +Your display name for this location resource. + +
+ +--- + + +**`facilities`** *Array* *of Objects* + +List of gym or fitness facilities. + +
+ +facility_key String + +Your unique identifier for the facility. + +
+ +--- + + + +
+ +name String + +Your display name for this location resource. + +
+ +--- + + +**`guests`** *Array* *of Objects* + +List of guests. + +
+ +email_address String + +Email address associated with the user identity. + +
+ +--- + + + +
+ +guest_key String + +Your unique identifier for the guest. + +
+ +--- + + + +
+ +name String + +Your display name for this user identity resource. + +
+ +--- + + + +
+ +phone_number String + +Phone number associated with the user identity. + +
+ +--- + + +**`listings`** *Array* *of Objects* + +List of property listings. + +
+ +listing_key String + +Your unique identifier for the listing. + +
+ +--- + + + +
+ +name String + +Your display name for this location resource. + +
+ +--- + + +**`properties`** *Array* *of Objects* + +List of short-term rental properties. + +
+ +name String + +Your display name for this location resource. + +
+ +--- + + + +
+ +property_key String + +Your unique identifier for the property. + +
+ +--- + + +**`property_listings`** *Array* *of Objects* + +List of property listings. + +
+ +name String + +Your display name for this location resource. + +
+ +--- + + + +
+ +property_listing_key String + +Your unique identifier for the property listing. + +
+ +--- + + +**`reservations`** *Array* *of Objects* + +List of reservations. + +
+ +building_keys List + +Building keys associated with the access grant. + +
+ +--- + + + +
+ +common_area_keys List + +Common area keys associated with the access grant. + +
+ +--- + + + +
+ +ends_at String + +Ending date and time for the access grant. + +
+ +--- + + + +
+ +facility_keys List + +Facility keys associated with the access grant. + +
+ +--- + + + +
+ +guest_key String + +Guest key associated with the access grant. + +
+ +--- + + + +
+ +listing_keys List + +Listing keys associated with the access grant. + +
+ +--- + + + +
+ +name String + +Your name for this access grant resource. + +
+ +--- + + + +
+ +preferred_code String + +Preferred PIN code to use when creating access for this reservation. + +
+ +--- + + + +
+ +property_keys List + +Property keys associated with the access grant. + +
+ +--- + + + +
+ +reservation_key String + +Your unique identifier for the reservation. + +
+ +--- + + + +
+ +resident_key String + +Resident key associated with the access grant. + +
+ --- -**`bookings`** *Array* *of Objects* -List of bookings. ---- +
-**`buildings`** *Array* *of Objects* +room_keys List -List of buildings. +Room keys associated with the access grant. + +
--- -**`common_areas`** *Array* *of Objects* -List of shared common areas. ---- +
-**`facilities`** *Array* *of Objects* +space_keys List -List of gym or fitness facilities. +Space keys associated with the access grant. + +
--- -**`guests`** *Array* *of Objects* -List of guests. + +
+ +starts_at String + +Starting date and time for the access grant. + +
--- -**`listings`** *Array* *of Objects* -List of property listings. + +
+ +tenant_key String + +Tenant key associated with the access grant. + +
--- -**`properties`** *Array* *of Objects* -List of short-term rental properties. + +
+ +unit_keys List + +Unit keys associated with the access grant. + +
--- -**`property_listings`** *Array* *of Objects* -List of property listings. + +
+ +user_identity_key String + +User identity key associated with the access grant. + +
--- -**`reservations`** *Array* *of Objects* -List of reservations. + +
+ +user_key String + +User key associated with the access grant. + +
--- + **`residents`** *Array* *of Objects* List of residents. +
+ +email_address String + +Email address associated with the user identity. + +
+ +--- + + + +
+ +name String + +Your display name for this user identity resource. + +
+ +--- + + + +
+ +phone_number String + +Phone number associated with the user identity. + +
+ +--- + + + +
+ +resident_key String + +Your unique identifier for the resident. + +
+ --- + **`rooms`** *Array* *of Objects* List of hotel or hospitality rooms. +
+ +name String + +Your display name for this location resource. + +
+ +--- + + + +
+ +room_key String + +Your unique identifier for the room. + +
+ --- + **`spaces`** *Array* *of Objects* List of general spaces or areas. +
+ +name String + +Your display name for this location resource. + +
+ +--- + + + +
+ +space_key String + +Your unique identifier for the space. + +
+ --- + **`tenants`** *Array* *of Objects* List of tenants. +
+ +email_address String + +Email address associated with the user identity. + +
+ +--- + + + +
+ +name String + +Your display name for this user identity resource. + +
+ +--- + + + +
+ +phone_number String + +Phone number associated with the user identity. + +
+ +--- + + + +
+ +tenant_key String + +Your unique identifier for the tenant. + +
+ --- + **`units`** *Array* *of Objects* List of multi-family residential units. +
+ +name String + +Your display name for this location resource. + +
+ +--- + + + +
+ +unit_key String + +Your unique identifier for the unit. + +
+ --- + **`user_identities`** *Array* *of Objects* List of user identities. +
+ +email_address String + +Email address associated with the user identity. + +
+ +--- + + + +
+ +name String + +Your display name for this user identity resource. + +
+ +--- + + + +
+ +phone_number String + +Phone number associated with the user identity. + +
+ --- + + +
+ +user_identity_key String + +Your unique identifier for the user identity. + +
+ +--- + + **`users`** *Array* *of Objects* List of users. +
+ +email_address String + +Email address associated with the user identity. + +
+ +--- + + + +
+ +name String + +Your display name for this user identity resource. + +
+ +--- + + + +
+ +phone_number String + +Phone number associated with the user identity. + +
+ +--- + + + +
+ +user_key String + +Your unique identifier for the user. + +
+ --- + ## Response void diff --git a/docs/api/thermostats/daily_programs/create.md b/docs/api/thermostats/daily_programs/create.md index 20f59ba58..d14ed6bbd 100644 --- a/docs/api/thermostats/daily_programs/create.md +++ b/docs/api/thermostats/daily_programs/create.md @@ -277,9 +277,30 @@ Name of the thermostat daily program. Array of thermostat daily program periods. +
+ +climate_preset_key String + +Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the `starts_at_time`. + +
+ --- + +
+ +starts_at_time String + +Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + +
+ +--- + + + ## Response [thermostat\_daily\_program](.) diff --git a/docs/api/thermostats/daily_programs/update.md b/docs/api/thermostats/daily_programs/update.md index 8ea56b81f..b71801e56 100644 --- a/docs/api/thermostats/daily_programs/update.md +++ b/docs/api/thermostats/daily_programs/update.md @@ -236,8 +236,29 @@ Name of the thermostat daily program that you want to update. Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. +
+ +climate_preset_key String + +Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the `starts_at_time`. + +
+ --- + + +
+ +starts_at_time String + +Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + +
+ +--- + + **`thermostat_daily_program_id`** *String* (Required) ID of the thermostat daily program that you want to update.