Add acs credentials code sample definitions (#388)

Co-authored-by: DebbieAtSeam <[email protected]>
Co-authored-by: Seam Bot <[email protected]>

docs/api/_report.md

@@ -396,14 +396,6 @@ These items are deprecated.
 
 - `/acs/credential_pools/list`
 - `/acs/credential_provisioning_automations/launch`
-- `/acs/credentials/assign`
-- `/acs/credentials/create`
-- `/acs/credentials/delete`
-- `/acs/credentials/get`
-- `/acs/credentials/list`
-- `/acs/credentials/list_accessible_entrances`
-- `/acs/credentials/unassign`
-- `/acs/credentials/update`
 - `/acs/credentials/unmanaged/get`
 - `/acs/credentials/unmanaged/list`
 - `/acs/encoders/encode_card`

src/data/code-sample-definitions/acs-credentials.yaml

@@ -0,0 +1,151 @@
+---
+- title: Create a credential for an ACS user
+  description: Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`.
+  request:
+    path: /acs/credentials/create
+    parameters:
+      acs_user_id: 33333333-3333-3333-3333-333333333333
+      access_method: mobile_key
+      allowed_acs_entrance_ids:
+        [
+          55555555-5555-5555-5555-555555555555,
+          55555555-5555-5555-5555-000000000000,
+        ]
+      credential_manager_acs_system_id: 88888888-8888-8888-8888-888888888888
+      is_multi_phone_sync_credential: true
+      starts_at: '2024-03-01T10:40:00Z'
+      ends_at: '2024-03-04T10:40:00Z'
+  response:
+    body:
+      acs_credential:
+        acs_credential_id: 99999999-9999-9999-9999-999999999999
+        acs_user_id: 33333333-3333-3333-3333-333333333333
+        display_name: Multi Phone Sync Credential
+        code: null
+        acs_system_id: 88888888-8888-8888-8888-888888888888
+        access_method: mobile_key
+        workspace_id: 00000000-0000-0000-0000-000000000000
+        created_at: '2024-04-12T03:56:22.396Z'
+        is_multi_phone_sync_credential: true
+
+- title: Assign a credential to an ACS user
+  description: Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user.
+  request:
+    path: /acs/credentials/assign
+    parameters:
+      acs_user_id: 33333333-3333-3333-3333-333333333333
+      acs_credential_id: 66666666-6666-6666-6666-666666666666
+  response:
+    body:
+      acs_credential:
+        acs_credential_id: 99999999-9999-9999-9999-999999999999
+        acs_user_id: 33333333-3333-3333-3333-333333333333
+        display_name: Multi Phone Sync Credential
+        code: null
+        acs_system_id: 11111111-1111-1111-1111-111111111111
+        access_method: mobile_key
+        workspace_id: 00000000-0000-0000-0000-000000000000
+        created_at: '2024-04-12T03:56:22.396Z'
+        is_multi_phone_sync_credential: true
+
+- title: List credentials
+  description: Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`.
+  request:
+    path: /acs/credentials/list
+    parameters:
+      acs_user_id: 33333333-3333-3333-3333-333333333333
+      acs_system_id: 11111111-1111-1111-1111-111111111111
+      user_identity_id: 22222222-2222-2222-2222-222222222222
+      is_multi_phone_sync_credential: true
+  response:
+    body:
+      acs_credentials:
+        - acs_credential_id: 99999999-9999-9999-9999-999999999999
+          acs_user_id: 33333333-3333-3333-3333-333333333333
+          display_name: Multi Phone Sync Credential
+          code: null
+          acs_system_id: 11111111-1111-1111-1111-111111111111
+          access_method: mobile_key
+          workspace_id: 00000000-0000-0000-0000-000000000000
+          created_at: '2024-04-12T03:56:22.396Z'
+          is_multi_phone_sync_credential: true
+
+- title: Get a credential
+  description: Specify the `acs_credential_id` of the credential that you want to retrieve.
+  request:
+    path: /acs/credentials/get
+    parameters:
+      acs_credential_id: 66666666-6666-6666-6666-666666666666
+  response:
+    body:
+      acs_credential:
+        acs_credential_id: 99999999-9999-9999-9999-999999999999
+        acs_user_id: 33333333-3333-3333-3333-333333333333
+        display_name: Multi Phone Sync Credential
+        code: null
+        acs_system_id: 11111111-1111-1111-1111-111111111111
+        access_method: mobile_key
+        workspace_id: 00000000-0000-0000-0000-000000000000
+        created_at: '2024-04-12T03:56:22.396Z'
+        is_multi_phone_sync_credential: true
+
+- title: Update a credential
+  description: Specify the desired `acs_credential_id` and updated `code` to update the credential.
+  request:
+    path: /acs/credentials/update
+    parameters:
+      acs_credential_id: 66666666-6666-6666-6666-666666666666
+      code: '7890'
+  response:
+    body: null
+
+- title: Unassign a credential from an ACS user
+  description: Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user.
+  request:
+    path: /acs/credentials/unassign
+    parameters:
+      acs_user_id: 33333333-3333-3333-3333-333333333333
+      acs_credential_id: 66666666-6666-6666-6666-666666666666
+  response:
+    body:
+      acs_credential:
+        acs_credential_id: 99999999-9999-9999-9999-999999999999
+        acs_user_id: 33333333-3333-3333-3333-333333333333
+        display_name: Multi Phone Sync Credential
+        code: null
+        acs_system_id: 11111111-1111-1111-1111-111111111111
+        access_method: mobile_key
+        workspace_id: 00000000-0000-0000-0000-000000000000
+        created_at: '2024-04-12T03:56:22.396Z'
+        is_multi_phone_sync_credential: true
+
+- title: Delete a credential
+  description: Specify the desired `acs_credential_id` to delete the specified credential.
+  request:
+    path: /acs/credentials/delete
+    parameters:
+      acs_credential_id: 66666666-6666-6666-6666-666666666666
+  response:
+    body: null
+
+- title: List accessible entrances
+  description: Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access.
+  request:
+    path: /acs/credentials/list_accessible_entrances
+    parameters:
+      acs_credential_id: 66666666-6666-6666-6666-666666666666
+  response:
+    body:
+      acs_entrances:
+        - acs_entrance_id: '55555555-5555-5555-5555-555555555555'
+          acs_system_id: '11111111-1111-1111-1111-111111111111'
+          workspace_id: '00000000-0000-0000-0000-000000000000'
+          visionline_metadata:
+            profiles:
+              - visionline_door_profile_id: 'Guest Door'
+                visionline_door_profile_type: 'BLE'
+            door_name: 'Guest Lock 2'
+            door_category: 'guest'
+          latch_metadata: null
+          display_name: 'Guest Lock 2'
+          created_at: '2024-03-26T14:31:18.979Z'