Skip to content

Commit ab8c661

Browse files
committed
ci: Format code
1 parent b09d91e commit ab8c661

610 files changed

Lines changed: 48187 additions & 37300 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

migrate-to-mintlify.mjs

Lines changed: 318 additions & 318 deletions
Large diffs are not rendered by default.

mintlify-docs/SUMMARY.mdx

Lines changed: 175 additions & 175 deletions
Large diffs are not rendered by default.

mintlify-docs/api/SUMMARY.mdx

Lines changed: 245 additions & 245 deletions
Large diffs are not rendered by default.

mintlify-docs/api/_report.mdx

Lines changed: 163 additions & 161 deletions
Large diffs are not rendered by default.

mintlify-docs/api/access_codes/create.mdx

Lines changed: 79 additions & 106 deletions
Large diffs are not rendered by default.

mintlify-docs/api/access_codes/create_multiple.mdx

Lines changed: 55 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Create Multiple Linked Access Codes"
2+
title: 'Create Multiple Linked Access Codes'
33
---
44

55
- [Request Parameters](#request-parameters)
@@ -15,7 +15,6 @@ If you want to change these access codes that are not linked by a `common_code_k
1515

1616
See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
1717

18-
1918
<Tabs>
2019
<Tab title="JavaScript">
2120

@@ -26,47 +25,49 @@ Creates new access codes that share a common code across multiple devices.
2625
```javascript
2726
await seam.accessCodes.createMultiple({
2827
device_ids: [
29-
"d9717800-fa73-401a-b66b-03f0ef950e2a",
30-
"550e8400-e29b-41d4-a716-446655440000",
28+
'd9717800-fa73-401a-b66b-03f0ef950e2a',
29+
'550e8400-e29b-41d4-a716-446655440000',
3130
],
32-
behavior_when_code_cannot_be_shared: "throw",
31+
behavior_when_code_cannot_be_shared: 'throw',
3332
preferred_code_length: 4,
34-
name: "My Linked Access Code",
35-
starts_at: "2025-06-19T01:41:56.000Z",
36-
ends_at: "2025-06-22T16:40:40.000Z",
37-
});
33+
name: 'My Linked Access Code',
34+
starts_at: '2025-06-19T01:41:56.000Z',
35+
ends_at: '2025-06-22T16:40:40.000Z',
36+
})
3837
```
3938

4039
#### Output:
4140

4241
```javascript
43-
[
42+
;[
4443
{
45-
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
46-
"code": "1234",
47-
"common_code_key": "auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000",
48-
"created_at": "2025-06-14T16:54:17.946242Z",
49-
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
50-
"ends_at": "2025-07-04T16:54:17.946049Z",
51-
"errors": [],
52-
"is_backup": false,
53-
"is_backup_access_code_available": false,
54-
"is_external_modification_allowed": false,
55-
"is_managed": true,
56-
"is_offline_access_code": false,
57-
"is_one_time_use": false,
58-
"is_scheduled_on_device": true,
59-
"is_waiting_for_code_assignment": false,
60-
"name": "My Linked Access Code",
61-
"pulled_backup_access_code_id": null,
62-
"starts_at": "2025-07-02T16:54:17.946049Z",
63-
"status": "set",
64-
"type": "time_bound",
65-
"warnings": [],
66-
"workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
67-
}
44+
access_code_id: 'e9cf6dd6-89aa-477f-a701-c08f3de13c1f',
45+
code: '1234',
46+
common_code_key:
47+
'auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000',
48+
created_at: '2025-06-14T16:54:17.946242Z',
49+
device_id: 'c9cd621d-ef0c-45c8-b608-026ebdb74615',
50+
ends_at: '2025-07-04T16:54:17.946049Z',
51+
errors: [],
52+
is_backup: false,
53+
is_backup_access_code_available: false,
54+
is_external_modification_allowed: false,
55+
is_managed: true,
56+
is_offline_access_code: false,
57+
is_one_time_use: false,
58+
is_scheduled_on_device: true,
59+
is_waiting_for_code_assignment: false,
60+
name: 'My Linked Access Code',
61+
pulled_backup_access_code_id: null,
62+
starts_at: '2025-07-02T16:54:17.946049Z',
63+
status: 'set',
64+
type: 'time_bound',
65+
warnings: [],
66+
workspace_id: '750fc0bc-4450-4356-8d9f-18c6a3a6b2c7',
67+
},
6868
]
6969
```
70+
7071
</Tab>
7172

7273
<Tab title="cURL">
@@ -125,6 +126,7 @@ EOF
125126
]
126127
}
127128
```
129+
128130
</Tab>
129131

130132
<Tab title="Python">
@@ -177,6 +179,7 @@ seam.access_codes.create_multiple(
177179
)
178180
]
179181
```
182+
180183
</Tab>
181184

182185
<Tab title="Ruby">
@@ -226,6 +229,7 @@ seam.access_codes.create_multiple(
226229
},
227230
]
228231
```
232+
229233
</Tab>
230234

231235
<Tab title="PHP">
@@ -279,6 +283,7 @@ $seam->access_codes->create_multiple(
279283
],
280284
];
281285
```
286+
282287
</Tab>
283288

284289
<Tab title="Seam CLI">
@@ -321,66 +326,68 @@ seam access-codes create-multiple --device_ids ["d9717800-fa73-401a-b66b-03f0ef9
321326
}
322327
]
323328
```
329+
324330
</Tab>
325331

326332
</Tabs>
327333

328-
329334
<details>
330335

331336
<summary>Authentication Methods</summary>
332337

333338
- API key
334339
- Client session token
335340
- Personal access token
336-
<br />Must also include the `seam-workspace` header in the request.
341+
<br />
342+
Must also include the `seam-workspace` header in the request.
337343

338344
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
345+
339346
</details>
340347

341348
## Request Parameters
342349

343-
**`device_ids`** *Array* *of UUIDs* (Required)
350+
**`device_ids`** _Array_ _of UUIDs_ (Required)
344351

345352
IDs of the devices for which you want to create the new access codes.
346353

347354
---
348355

349-
**`allow_external_modification`** *Boolean*
356+
**`allow_external_modification`** _Boolean_
350357

351358
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
352359

353360
---
354361

355-
**`attempt_for_offline_device`** *Boolean*
362+
**`attempt_for_offline_device`** _Boolean_
356363

357364
---
358365

359-
**`behavior_when_code_cannot_be_shared`** *String*
366+
**`behavior_when_code_cannot_be_shared`** _String_
360367

361368
Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.
362369

363370
---
364371

365-
**`code`** *String*
372+
**`code`** _String_
366373

367374
Code to be used for access.
368375

369376
---
370377

371-
**`ends_at`** *String*
378+
**`ends_at`** _String_
372379

373380
Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
374381

375382
---
376383

377-
**`is_external_modification_allowed`** *Boolean*
384+
**`is_external_modification_allowed`** _Boolean_
378385

379386
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
380387

381388
---
382389

383-
**`name`** *String*
390+
**`name`** _String_
384391

385392
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
386393

@@ -392,31 +399,30 @@ To help your users identify codes set by Seam, Seam provides the name exactly as
392399

393400
---
394401

395-
**`prefer_native_scheduling`** *Boolean*
402+
**`prefer_native_scheduling`** _Boolean_
396403

397404
Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
398405

399406
---
400407

401-
**`preferred_code_length`** *Number*
408+
**`preferred_code_length`** _Number_
402409

403410
Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.
404411

405412
---
406413

407-
**`starts_at`** *String*
414+
**`starts_at`** _String_
408415

409416
Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
410417

411418
---
412419

413-
**`use_backup_access_code_pool`** *Boolean*
420+
**`use_backup_access_code_pool`** _Boolean_
414421

415422
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
416423

417424
---
418425

419-
420426
## Response
421427

422428
<Check>
@@ -425,12 +431,9 @@ Returns:
425431

426432
</Check>
427433

428-
429434
<Tabs>
430435
<Tab title="JSON">
431436

432-
433-
434437
```json
435438
{
436439
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
@@ -458,5 +461,6 @@ Returns:
458461
"workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
459462
}
460463
```
464+
461465
</Tab>
462466
</Tabs>

mintlify-docs/api/access_codes/delete.mdx

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
---
2-
title: "Delete an Access Code"
2+
title: 'Delete an Access Code'
33
---
44

55
- [Request Parameters](#request-parameters)
66
- [Response](#response)
77

88
Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
99

10-
1110
<Tabs>
1211
<Tab title="JavaScript">
1312

@@ -17,16 +16,17 @@ Deletes an access code.
1716

1817
```javascript
1918
await seam.accessCodes.delete({
20-
device_id: "d33f4cc7-2b6a-41a4-ad30-c372ee493589",
21-
access_code_id: "275b40a3-6b0b-4c51-8fd2-aafd3de2195c",
22-
});
19+
device_id: 'd33f4cc7-2b6a-41a4-ad30-c372ee493589',
20+
access_code_id: '275b40a3-6b0b-4c51-8fd2-aafd3de2195c',
21+
})
2322
```
2423

2524
#### Output:
2625

2726
```javascript
2827
// void
2928
```
29+
3030
</Tab>
3131

3232
<Tab title="cURL">
@@ -51,6 +51,7 @@ EOF
5151
```curl
5252
{}
5353
```
54+
5455
</Tab>
5556

5657
<Tab title="Python">
@@ -71,6 +72,7 @@ seam.access_codes.delete(
7172
```python
7273
None
7374
```
75+
7476
</Tab>
7577

7678
<Tab title="Ruby">
@@ -91,6 +93,7 @@ seam.access_codes.delete(
9193
```ruby
9294
nil
9395
```
96+
9497
</Tab>
9598

9699
<Tab title="PHP">
@@ -111,6 +114,7 @@ $seam->access_codes->delete(
111114
```php
112115

113116
```
117+
114118
</Tab>
115119

116120
<Tab title="Seam CLI">
@@ -128,43 +132,43 @@ seam access-codes delete --device_id "d33f4cc7-2b6a-41a4-ad30-c372ee493589" --ac
128132
```seam_cli
129133
{}
130134
```
135+
131136
</Tab>
132137

133138
</Tabs>
134139

135-
136140
<details>
137141

138142
<summary>Authentication Methods</summary>
139143

140144
- API key
141145
- Client session token
142146
- Personal access token
143-
<br />Must also include the `seam-workspace` header in the request.
147+
<br />
148+
Must also include the `seam-workspace` header in the request.
144149

145150
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
151+
146152
</details>
147153

148154
## Request Parameters
149155

150-
**`access_code_id`** *String* (Required)
156+
**`access_code_id`** _String_ (Required)
151157

152158
ID of the access code that you want to delete.
153159

154160
---
155161

156-
**`device_id`** *String*
162+
**`device_id`** _String_
157163

158164
ID of the device for which you want to delete the access code.
159165

160166
---
161167

162-
163168
## Response
164169

165170
<Check>
166171
Returns:
167172
**void**
168173

169174
</Check>
170-

0 commit comments

Comments
 (0)