Skip to content

Commit 47858fc

Browse files
dependabot[bot]seambot
dependabot[bot]
and
seambot
authored
feat(deps-dev): Bump @seamapi/types from 1.454.0 to 1.457.0 in the seam group (#738)
* feat(deps-dev): Bump @seamapi/types in the seam group Bumps the seam group with 1 update: [@seamapi/types](https://github.com/seamapi/types). Updates `@seamapi/types` from 1.454.0 to 1.457.0 - [Release notes](https://github.com/seamapi/types/releases) - [Changelog](https://github.com/seamapi/types/blob/main/.releaserc.json) - [Commits](seamapi/types@v1.454.0...v1.457.0) --- updated-dependencies: - dependency-name: "@seamapi/types" dependency-version: 1.457.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: seam ... Signed-off-by: dependabot[bot] <[email protected]> * ci: Generate docs --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Seam Bot <[email protected]>
1 parent ee9e18b commit 47858fc

File tree

7 files changed

+256
-5
lines changed

7 files changed

+256
-5
lines changed

‎docs/SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@
227227
* [Delete an Access Method](api/access_methods/delete.md)
228228
* [Encode an Access Method](api/access_methods/encode.md)
229229
* [Get an Access Method](api/access_methods/get.md)
230+
* [Get related Access Method resources](api/access_methods/get_related.md)
230231
* [List Access Methods](api/access_methods/list.md)
231232
* [Action Attempts](api/action_attempts/README.md)
232233
* [Get an Action Attempt](api/action_attempts/get.md)

‎docs/api/_blueprint.json‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6494,6 +6494,152 @@
64946494
}
64956495
]
64966496
},
6497+
{
6498+
"title": "Get related Access Method resources",
6499+
"name": "get_related",
6500+
"path": "/access_methods/get_related",
6501+
"parentPath": "/access_methods",
6502+
"description": "Gets all related resources for one or more Access Methods.",
6503+
"isDeprecated": false,
6504+
"deprecationMessage": "",
6505+
"isUndocumented": false,
6506+
"undocumentedMessage": "",
6507+
"isDraft": true,
6508+
"draftMessage": "Early access.",
6509+
"response": {
6510+
"responseType": "resource",
6511+
"responseKey": "batch",
6512+
"resourceType": "unknown",
6513+
"description": "OK",
6514+
"actionAttemptType": null
6515+
},
6516+
"request": {
6517+
"methods": [
6518+
"GET",
6519+
"POST"
6520+
],
6521+
"semanticMethod": "GET",
6522+
"preferredMethod": "POST",
6523+
"parameters": [
6524+
{
6525+
"name": "access_method_ids",
6526+
"description": "IDs of the access methods that you want to get along with their related resources.",
6527+
"isRequired": true,
6528+
"isDeprecated": false,
6529+
"deprecationMessage": "",
6530+
"isUndocumented": false,
6531+
"undocumentedMessage": "",
6532+
"isDraft": false,
6533+
"draftMessage": "",
6534+
"hasDefault": false,
6535+
"format": "list",
6536+
"jsonType": "array",
6537+
"itemFormat": "id"
6538+
},
6539+
{
6540+
"name": "exclude",
6541+
"description": "",
6542+
"isRequired": false,
6543+
"isDeprecated": false,
6544+
"deprecationMessage": "",
6545+
"isUndocumented": false,
6546+
"undocumentedMessage": "",
6547+
"isDraft": false,
6548+
"draftMessage": "",
6549+
"hasDefault": false,
6550+
"format": "list",
6551+
"jsonType": "array",
6552+
"itemFormat": "enum",
6553+
"itemEnumValues": [
6554+
{
6555+
"name": "spaces",
6556+
"description": "",
6557+
"isDeprecated": false,
6558+
"deprecationMessage": "",
6559+
"isUndocumented": false,
6560+
"undocumentedMessage": "",
6561+
"isDraft": false,
6562+
"draftMessage": ""
6563+
},
6564+
{
6565+
"name": "devices",
6566+
"description": "",
6567+
"isDeprecated": false,
6568+
"deprecationMessage": "",
6569+
"isUndocumented": false,
6570+
"undocumentedMessage": "",
6571+
"isDraft": false,
6572+
"draftMessage": ""
6573+
},
6574+
{
6575+
"name": "acs_entrances",
6576+
"description": "",
6577+
"isDeprecated": false,
6578+
"deprecationMessage": "",
6579+
"isUndocumented": false,
6580+
"undocumentedMessage": "",
6581+
"isDraft": false,
6582+
"draftMessage": ""
6583+
}
6584+
]
6585+
},
6586+
{
6587+
"name": "include",
6588+
"description": "",
6589+
"isRequired": false,
6590+
"isDeprecated": false,
6591+
"deprecationMessage": "",
6592+
"isUndocumented": false,
6593+
"undocumentedMessage": "",
6594+
"isDraft": false,
6595+
"draftMessage": "",
6596+
"hasDefault": false,
6597+
"format": "list",
6598+
"jsonType": "array",
6599+
"itemFormat": "enum",
6600+
"itemEnumValues": [
6601+
{
6602+
"name": "spaces",
6603+
"description": "",
6604+
"isDeprecated": false,
6605+
"deprecationMessage": "",
6606+
"isUndocumented": false,
6607+
"undocumentedMessage": "",
6608+
"isDraft": false,
6609+
"draftMessage": ""
6610+
},
6611+
{
6612+
"name": "devices",
6613+
"description": "",
6614+
"isDeprecated": false,
6615+
"deprecationMessage": "",
6616+
"isUndocumented": false,
6617+
"undocumentedMessage": "",
6618+
"isDraft": false,
6619+
"draftMessage": ""
6620+
},
6621+
{
6622+
"name": "acs_entrances",
6623+
"description": "",
6624+
"isDeprecated": false,
6625+
"deprecationMessage": "",
6626+
"isUndocumented": false,
6627+
"undocumentedMessage": "",
6628+
"isDraft": false,
6629+
"draftMessage": ""
6630+
}
6631+
]
6632+
}
6633+
]
6634+
},
6635+
"hasPagination": false,
6636+
"authMethods": [
6637+
"personal_access_token",
6638+
"api_key"
6639+
],
6640+
"workspaceScope": "required",
6641+
"codeSamples": []
6642+
},
64976643
{
64986644
"title": "List Access Methods",
64996645
"name": "list",
@@ -53322,6 +53468,16 @@
5332253468
"undocumentedMessage": "",
5332353469
"isDraft": false,
5332453470
"draftMessage": ""
53471+
},
53472+
{
53473+
"name": "eco",
53474+
"description": "",
53475+
"isDeprecated": false,
53476+
"deprecationMessage": "",
53477+
"isUndocumented": false,
53478+
"undocumentedMessage": "",
53479+
"isDraft": false,
53480+
"draftMessage": ""
5332553481
}
5332653482
]
5332753483
},
@@ -67924,6 +68080,19 @@
6792468080
"format": "boolean",
6792568081
"jsonType": "boolean"
6792668082
},
68083+
{
68084+
"name": "is_issued",
68085+
"description": "Indicates whether the access method has been issued.",
68086+
"isDeprecated": false,
68087+
"deprecationMessage": "",
68088+
"isUndocumented": false,
68089+
"undocumentedMessage": "",
68090+
"isDraft": false,
68091+
"draftMessage": "",
68092+
"propertyGroupKey": null,
68093+
"format": "boolean",
68094+
"jsonType": "boolean"
68095+
},
6792768096
{
6792868097
"name": "issued_at",
6792968098
"description": "Date and time at which the access method was issued.",

‎docs/api/_report.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,9 @@ Items that are intentionally undocumented are not included in this section.
315315
- `include`
316316
- `/access_grants/list`
317317
- `location_id`
318+
- `/access_methods/get_related`
319+
- `exclude`
320+
- `include`
318321
- `/acs/encoders/simulate/next_credential_scan_will_fail`
319322
- `error_code`
320323
- `acs_credential_id_on_seam`
@@ -419,6 +422,7 @@ These items have been marked as draft.
419422
- `/access_grants/update`: Early access.
420423
- `/access_methods/delete`: Early access.
421424
- `/access_methods/get`: Early access.
425+
- `/access_methods/get_related`: Early access.
422426
- `/access_methods/list`: Early access.
423427
- `/spaces/add_acs_entrances`: Early access.
424428
- `/spaces/add_devices`: Early access.
@@ -537,6 +541,7 @@ These items are deprecated.
537541
### Missing resources
538542

539543
- `/access_grants/get_related`: `batch`
544+
- `/access_methods/get_related`: `batch`
540545
- `/bridges/get`: `bridge`
541546
- `/bridges/list`: `bridges`
542547
- `/networks/get`: `network`
@@ -550,6 +555,7 @@ These items are deprecated.
550555

551556
- `/access_grants/get_related`
552557
- `/access_methods/encode`
558+
- `/access_methods/get_related`
553559
- `/customers/create_portal`
554560
- `/customers/push_data`
555561
- `/locks/get`

‎docs/api/access_methods/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,15 @@ Indicates whether encoding with an card encoder is required to issue or reissue
126126

127127

128128

129+
---
130+
131+
**`is_issued`** *Boolean*
132+
133+
Indicates whether the access method has been issued.
134+
135+
136+
137+
129138
---
130139

131140
**`issued_at`** *Datetime*
@@ -358,6 +367,11 @@ Encodes an existing access method onto a plastic card placed on the specified [e
358367
Gets an access method.
359368

360369

370+
[**`/access_methods/get_related`**](./get_related.md)
371+
372+
Gets all related resources for one or more Access Methods.
373+
374+
361375
[**`/access_methods/list`**](./list.md)
362376

363377
Lists all access methods, usually filtered by Access Grant.

‎docs/api/access_methods/get_related.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Get related Access Method resources
2+
{% hint style="info" %}
3+
**Early Access Preview.** The access methods API is currently in Alpha. We're actively developing it and seeking early feedback at [[email protected]](mailto:[email protected]). Expect breaking changes as we refine the design.
4+
{% endhint %}
5+
6+
- [Request Parameters](#request-parameters)
7+
- [Response](#response)
8+
9+
Gets all related resources for one or more Access Methods.
10+
11+
12+
<details>
13+
14+
<summary>Authentication Methods</summary>
15+
16+
- API key
17+
- Personal access token
18+
<br>Must also include the `seam-workspace` header in the request.
19+
20+
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
21+
</details>
22+
23+
## Request Parameters
24+
25+
**`access_method_ids`** *Array* *of UUIDs* (Required)
26+
27+
IDs of the access methods that you want to get along with their related resources.
28+
29+
---
30+
31+
**`exclude`** *Array* *of Enums*
32+
<details>
33+
34+
<summary>Enum values</summary>
35+
36+
Possible enum values:
37+
- <code>spaces</code>
38+
- <code>devices</code>
39+
- <code>acs_entrances</code>
40+
</details>
41+
42+
---
43+
44+
**`include`** *Array* *of Enums*
45+
<details>
46+
47+
<summary>Enum values</summary>
48+
49+
Possible enum values:
50+
- <code>spaces</code>
51+
- <code>devices</code>
52+
- <code>acs_entrances</code>
53+
</details>
54+
55+
---
56+
57+
58+
## Response
59+
60+
[unknown](./)
61+

‎package-lock.json‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"@prettier/plugin-ruby": "^4.0.4",
3333
"@seamapi/blueprint": "^0.51.3",
3434
"@seamapi/smith": "^0.4.4",
35-
"@seamapi/types": "^1.454.0",
35+
"@seamapi/types": "^1.457.0",
3636
"@types/command-exists": "^1.2.3",
3737
"change-case": "^5.4.4",
3838
"command-exists": "^1.2.9",

0 commit comments

Comments
 (0)