diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e9a139fea..a55f97ae7 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -188,6 +188,7 @@ * [Access Control Systems (ACS)](api/acs/README.md) * [Access Groups](api/acs/access_groups/README.md) * [Add an ACS User to an Access Group](api/acs/access_groups/add_user.md) + * [Delete an Access Group](api/acs/access_groups/delete.md) * [Get an Access Group](api/acs/access_groups/get.md) * [List Access Groups](api/acs/access_groups/list.md) * [List ACS Users in an Access Group](api/acs/access_groups/list_users.md) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index e037c37bc..ebbcb189c 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -8008,6 +8008,55 @@ } ] }, + { + "title": "Delete an Access Group", + "name": "delete", + "path": "/acs/access_groups/delete", + "parentPath": "/acs/access_groups", + "description": "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "void", + "description": "OK" + }, + "request": { + "methods": [ + "DELETE", + "POST" + ], + "semanticMethod": "DELETE", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the access group that you want to delete.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, { "title": "Get an Access Group", "name": "get", @@ -81739,6 +81788,16 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" + }, + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" } ] } @@ -109967,6 +110026,16 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" + }, + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" } ] } diff --git a/docs/api/_report.md b/docs/api/_report.md index add20e06e..265116c64 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -686,6 +686,7 @@ These items are deprecated. - `/access_methods/get_related` - `/access_methods/unmanaged/get` - `/access_methods/unmanaged/list` +- `/acs/access_groups/delete` - `/connected_accounts/simulate/disconnect` - `/customers/create_portal` - `/customers/delete_data` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 847f3e896..2ea98c9ba 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -187,6 +187,7 @@ Warnings associated with the `acs_access_group`. Enum values: - unknown_issue_with_acs_access_group + - being_deleted @@ -256,6 +257,11 @@ An ACS access group was deleted. Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +[**`/acs/access_groups/delete`**](./delete.md) + +Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + [**`/acs/access_groups/get`**](./get.md) Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/delete.md b/docs/api/acs/access_groups/delete.md new file mode 100644 index 000000000..c8dc083ea --- /dev/null +++ b/docs/api/acs/access_groups/delete.md @@ -0,0 +1,37 @@ +# Delete an Access Group + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## Request Parameters + +**`acs_access_group_id`** *String* (Required) + +ID of the access group that you want to delete. + +--- + + +## Response + +{% hint style="success" %} +Returns: +**void** + +{% endhint %} + diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index 783f11248..b85abf998 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -1,330 +1,384 @@ # Create Customer Portal - {% hint style="info" %} **Early Access Preview.** The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [support@seam.co](mailto:support@seam.co). Expect breaking changes as we refine the design. {% endhint %} -* [Request Parameters](create_portal.md#request-parameters) -* [Response](create_portal.md#response) +- [Request Parameters](#request-parameters) +- [Response](#response) Creates a new customer portal magic link with configurable features. +
Authentication Methods -* API key -* Personal access token\ - Must also include the `seam-workspace` header in the request. +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). -
## Request Parameters -**`customer_data`** _Object_ +**`customer_data`** *Object*
-access_grants List +access_grants List List of access grants.
-*** +--- + +
-bookings List +bookings List List of bookings.
-*** +--- + +
-buildings List +buildings List List of buildings.
-*** +--- + +
-common_areas List +common_areas List List of shared common areas.
-*** +--- + +
-customer_key String +customer_key String Your unique identifier for the customer.
-*** +--- + +
-facilities List +facilities List List of gym or fitness facilities.
-*** +--- + +
-guests List +guests List List of guests.
-*** +--- + +
-listings List +listings List List of property listings.
-*** +--- + +
-properties List +properties List List of short-term rental properties.
-*** +--- + +
-property_listings List +property_listings List List of property listings.
-*** +--- + +
-reservations List +reservations List List of reservations.
-*** +--- + +
-residents List +residents List List of residents.
-*** +--- + +
-rooms List +rooms List List of hotel or hospitality rooms.
-*** +--- + +
-sites List +sites List List of general sites or areas.
-*** +--- + +
-spaces List +spaces List List of general spaces or areas.
-*** +--- + +
-staff_members List +staff_members List List of staff members.
-*** +--- + +
-tenants List +tenants List List of tenants.
-*** +--- + +
-units List +units List List of multi-family residential units.
-*** +--- + +
-user_identities List +user_identities List List of user identities.
-*** +--- + +
-users List +users List List of users.
-*** +--- -**`customization_profile_id`** _String_ + +**`customization_profile_id`** *String* The ID of the customization profile to use for the portal. -*** +--- -**`features`** _Object_ +**`features`** *Object*
-configure Object +configure Object Configuration for the configure feature.
-*** +--- + +
-connect Object +connect Object Configuration for the connect accounts feature.
-*** +--- + +
-manage Object +manage Object Configuration for the manage feature.
-*** +--- + -
-manage_devices Object +
-### Configuration for the manage devices feature. +manage_devices Object -### deprecated: Use `manage` instead. +Configuration for the manage devices feature. +--- +deprecated: Use `manage` instead. +---
-*** +--- + +
-organize Object +organize Object Configuration for the organize feature.
-*** +--- + -**`is_embedded`** _Boolean_ +**`is_embedded`** *Boolean* Whether the portal is embedded in another application. -*** +--- -**`landing_page`** _Object_ +**`landing_page`** *Object* Configuration for the landing page when the portal loads.
-manage Object - - +manage Object
-*** +--- -**`locale`** _String_ + +**`locale`** *String* The locale to use for the portal. -*** +--- + +**`property_listing_filter`** *Object* -**`property_listing_filter`** _Object_ +Filter configuration for property listings based on their custom_metadata. Keys and values must match the custom_metadata stored on property listings. -Filter configuration for property listings based on their custom\_metadata. Keys and values must match the custom\_metadata stored on property listings. +--- -*** ## Response {% hint style="success" %} -Returns: [**magic\_link**](../unstable_partner/building_blocks/) +Returns: +**[magic\_link](./../unstable_partner/building_blocks)** + {% endhint %} + {% tabs %} {% tab title="JSON" %} + + + ```json { "building_block_type": "connect_accounts", diff --git a/package-lock.json b/package-lock.json index 4c43f966b..1ff57a958 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.53.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.683.0", + "@seamapi/types": "1.684.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.683.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.683.0.tgz", - "integrity": "sha512-k01xjafqJX54HMLRfjeeyrP9dhKHVGS/824aptdElYo0JaWJQiEwvvLYunm4CYAFIa4mt4MhtoatE6VmQPyqUg==", + "version": "1.684.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.684.0.tgz", + "integrity": "sha512-Vyvhijfob/DX/Iprrydy1ZOxmbbNBUrxS3DgHtJ989FVLEGbxpyln60WfXWoOT1uJEhyUjPbgm3I6ByZG0GxLA==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index db4afb86f..daa9803d5 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.53.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.683.0", + "@seamapi/types": "1.684.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",