@seamapi/types 1.962.0 → 1.963.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +560 -21
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +976 -4
- package/dist/index.cjs +560 -21
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.d.ts +143 -0
- package/lib/seam/connect/models/access-grants/access-method.js +36 -0
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +63 -0
- package/lib/seam/connect/models/action-attempts/assign-credential.d.ts +63 -0
- package/lib/seam/connect/models/events/access-methods.d.ts +130 -0
- package/lib/seam/connect/models/events/access-methods.js +18 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +65 -1
- package/lib/seam/connect/openapi.js +490 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +804 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-method.ts +53 -0
- package/src/lib/seam/connect/models/events/access-methods.ts +20 -0
- package/src/lib/seam/connect/openapi.ts +558 -0
- package/src/lib/seam/connect/route-types.ts +857 -0
|
@@ -1996,6 +1996,38 @@ const openapi = {
|
|
|
1996
1996
|
description: 'Display name of the access method.',
|
|
1997
1997
|
type: 'string',
|
|
1998
1998
|
},
|
|
1999
|
+
errors: {
|
|
2000
|
+
description: 'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
2001
|
+
items: {
|
|
2002
|
+
description: 'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
2003
|
+
discriminator: { propertyName: 'error_code' },
|
|
2004
|
+
oneOf: [
|
|
2005
|
+
{
|
|
2006
|
+
description: 'Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.',
|
|
2007
|
+
properties: {
|
|
2008
|
+
created_at: {
|
|
2009
|
+
description: 'Date and time at which Seam created the error.',
|
|
2010
|
+
format: 'date-time',
|
|
2011
|
+
type: 'string',
|
|
2012
|
+
},
|
|
2013
|
+
error_code: {
|
|
2014
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
2015
|
+
enum: ['failed_to_issue'],
|
|
2016
|
+
type: 'string',
|
|
2017
|
+
},
|
|
2018
|
+
message: {
|
|
2019
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
2020
|
+
type: 'string',
|
|
2021
|
+
},
|
|
2022
|
+
},
|
|
2023
|
+
required: ['created_at', 'message', 'error_code'],
|
|
2024
|
+
type: 'object',
|
|
2025
|
+
'x-resource-type': 'access_method',
|
|
2026
|
+
},
|
|
2027
|
+
],
|
|
2028
|
+
},
|
|
2029
|
+
type: 'array',
|
|
2030
|
+
},
|
|
1999
2031
|
instant_key_url: {
|
|
2000
2032
|
description: 'URL of the Instant Key for mobile key access methods.',
|
|
2001
2033
|
format: 'uri',
|
|
@@ -2282,6 +2314,27 @@ const openapi = {
|
|
|
2282
2314
|
required: ['created_at', 'message', 'warning_code'],
|
|
2283
2315
|
type: 'object',
|
|
2284
2316
|
},
|
|
2317
|
+
{
|
|
2318
|
+
description: 'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
|
|
2319
|
+
properties: {
|
|
2320
|
+
created_at: {
|
|
2321
|
+
description: 'Date and time at which Seam created the warning.',
|
|
2322
|
+
format: 'date-time',
|
|
2323
|
+
type: 'string',
|
|
2324
|
+
},
|
|
2325
|
+
message: {
|
|
2326
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2327
|
+
type: 'string',
|
|
2328
|
+
},
|
|
2329
|
+
warning_code: {
|
|
2330
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
2331
|
+
enum: ['delay_in_issuing'],
|
|
2332
|
+
type: 'string',
|
|
2333
|
+
},
|
|
2334
|
+
},
|
|
2335
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
2336
|
+
type: 'object',
|
|
2337
|
+
},
|
|
2285
2338
|
],
|
|
2286
2339
|
},
|
|
2287
2340
|
type: 'array',
|
|
@@ -2301,6 +2354,7 @@ const openapi = {
|
|
|
2301
2354
|
'issued_at',
|
|
2302
2355
|
'is_issued',
|
|
2303
2356
|
'warnings',
|
|
2357
|
+
'errors',
|
|
2304
2358
|
'pending_mutations',
|
|
2305
2359
|
],
|
|
2306
2360
|
type: 'object',
|
|
@@ -7968,6 +8022,38 @@ const openapi = {
|
|
|
7968
8022
|
description: 'Display name of the access method.',
|
|
7969
8023
|
type: 'string',
|
|
7970
8024
|
},
|
|
8025
|
+
errors: {
|
|
8026
|
+
description: 'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
8027
|
+
items: {
|
|
8028
|
+
description: 'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
8029
|
+
discriminator: { propertyName: 'error_code' },
|
|
8030
|
+
oneOf: [
|
|
8031
|
+
{
|
|
8032
|
+
description: 'Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.',
|
|
8033
|
+
properties: {
|
|
8034
|
+
created_at: {
|
|
8035
|
+
description: 'Date and time at which Seam created the error.',
|
|
8036
|
+
format: 'date-time',
|
|
8037
|
+
type: 'string',
|
|
8038
|
+
},
|
|
8039
|
+
error_code: {
|
|
8040
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
8041
|
+
enum: ['failed_to_issue'],
|
|
8042
|
+
type: 'string',
|
|
8043
|
+
},
|
|
8044
|
+
message: {
|
|
8045
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
8046
|
+
type: 'string',
|
|
8047
|
+
},
|
|
8048
|
+
},
|
|
8049
|
+
required: ['created_at', 'message', 'error_code'],
|
|
8050
|
+
type: 'object',
|
|
8051
|
+
'x-resource-type': 'access_method',
|
|
8052
|
+
},
|
|
8053
|
+
],
|
|
8054
|
+
},
|
|
8055
|
+
type: 'array',
|
|
8056
|
+
},
|
|
7971
8057
|
instant_key_url: {
|
|
7972
8058
|
description: 'URL of the Instant Key for mobile key access methods.',
|
|
7973
8059
|
format: 'uri',
|
|
@@ -8254,6 +8340,27 @@ const openapi = {
|
|
|
8254
8340
|
required: ['created_at', 'message', 'warning_code'],
|
|
8255
8341
|
type: 'object',
|
|
8256
8342
|
},
|
|
8343
|
+
{
|
|
8344
|
+
description: 'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
|
|
8345
|
+
properties: {
|
|
8346
|
+
created_at: {
|
|
8347
|
+
description: 'Date and time at which Seam created the warning.',
|
|
8348
|
+
format: 'date-time',
|
|
8349
|
+
type: 'string',
|
|
8350
|
+
},
|
|
8351
|
+
message: {
|
|
8352
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
8353
|
+
type: 'string',
|
|
8354
|
+
},
|
|
8355
|
+
warning_code: {
|
|
8356
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
8357
|
+
enum: ['delay_in_issuing'],
|
|
8358
|
+
type: 'string',
|
|
8359
|
+
},
|
|
8360
|
+
},
|
|
8361
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
8362
|
+
type: 'object',
|
|
8363
|
+
},
|
|
8257
8364
|
],
|
|
8258
8365
|
},
|
|
8259
8366
|
type: 'array',
|
|
@@ -8273,6 +8380,7 @@ const openapi = {
|
|
|
8273
8380
|
'issued_at',
|
|
8274
8381
|
'is_issued',
|
|
8275
8382
|
'warnings',
|
|
8383
|
+
'errors',
|
|
8276
8384
|
'pending_mutations',
|
|
8277
8385
|
],
|
|
8278
8386
|
type: 'object',
|
|
@@ -18397,6 +18505,124 @@ const openapi = {
|
|
|
18397
18505
|
type: 'object',
|
|
18398
18506
|
'x-route-path': '/access_methods',
|
|
18399
18507
|
},
|
|
18508
|
+
{
|
|
18509
|
+
description: 'Seam has not yet issued this access method, even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying `delay_in_issuing` warning clears automatically once issuance succeeds.',
|
|
18510
|
+
properties: {
|
|
18511
|
+
access_grant_ids: {
|
|
18512
|
+
description: 'IDs of the access grants associated with this access method.',
|
|
18513
|
+
items: { format: 'uuid', type: 'string' },
|
|
18514
|
+
type: 'array',
|
|
18515
|
+
},
|
|
18516
|
+
access_grant_keys: {
|
|
18517
|
+
description: 'Keys of the access grants associated with this access method (if present).',
|
|
18518
|
+
items: { type: 'string' },
|
|
18519
|
+
type: 'array',
|
|
18520
|
+
},
|
|
18521
|
+
access_method_id: {
|
|
18522
|
+
description: 'ID of the affected access method.',
|
|
18523
|
+
format: 'uuid',
|
|
18524
|
+
type: 'string',
|
|
18525
|
+
},
|
|
18526
|
+
created_at: {
|
|
18527
|
+
description: 'Date and time at which the event was created.',
|
|
18528
|
+
format: 'date-time',
|
|
18529
|
+
type: 'string',
|
|
18530
|
+
},
|
|
18531
|
+
event_description: {
|
|
18532
|
+
description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
|
|
18533
|
+
type: 'string',
|
|
18534
|
+
},
|
|
18535
|
+
event_id: {
|
|
18536
|
+
description: 'ID of the event.',
|
|
18537
|
+
format: 'uuid',
|
|
18538
|
+
type: 'string',
|
|
18539
|
+
},
|
|
18540
|
+
event_type: {
|
|
18541
|
+
enum: ['access_method.delay_in_issuing'],
|
|
18542
|
+
type: 'string',
|
|
18543
|
+
},
|
|
18544
|
+
occurred_at: {
|
|
18545
|
+
description: 'Date and time at which the event occurred.',
|
|
18546
|
+
format: 'date-time',
|
|
18547
|
+
type: 'string',
|
|
18548
|
+
},
|
|
18549
|
+
workspace_id: {
|
|
18550
|
+
description: 'ID of the workspace associated with the event.',
|
|
18551
|
+
format: 'uuid',
|
|
18552
|
+
type: 'string',
|
|
18553
|
+
},
|
|
18554
|
+
},
|
|
18555
|
+
required: [
|
|
18556
|
+
'event_id',
|
|
18557
|
+
'workspace_id',
|
|
18558
|
+
'created_at',
|
|
18559
|
+
'occurred_at',
|
|
18560
|
+
'access_method_id',
|
|
18561
|
+
'access_grant_ids',
|
|
18562
|
+
'event_type',
|
|
18563
|
+
],
|
|
18564
|
+
type: 'object',
|
|
18565
|
+
'x-route-path': '/access_methods',
|
|
18566
|
+
},
|
|
18567
|
+
{
|
|
18568
|
+
description: 'Seam was unable to issue this access method before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying `failed_to_issue` error clears automatically if the access method is eventually issued.',
|
|
18569
|
+
properties: {
|
|
18570
|
+
access_grant_ids: {
|
|
18571
|
+
description: 'IDs of the access grants associated with this access method.',
|
|
18572
|
+
items: { format: 'uuid', type: 'string' },
|
|
18573
|
+
type: 'array',
|
|
18574
|
+
},
|
|
18575
|
+
access_grant_keys: {
|
|
18576
|
+
description: 'Keys of the access grants associated with this access method (if present).',
|
|
18577
|
+
items: { type: 'string' },
|
|
18578
|
+
type: 'array',
|
|
18579
|
+
},
|
|
18580
|
+
access_method_id: {
|
|
18581
|
+
description: 'ID of the affected access method.',
|
|
18582
|
+
format: 'uuid',
|
|
18583
|
+
type: 'string',
|
|
18584
|
+
},
|
|
18585
|
+
created_at: {
|
|
18586
|
+
description: 'Date and time at which the event was created.',
|
|
18587
|
+
format: 'date-time',
|
|
18588
|
+
type: 'string',
|
|
18589
|
+
},
|
|
18590
|
+
event_description: {
|
|
18591
|
+
description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
|
|
18592
|
+
type: 'string',
|
|
18593
|
+
},
|
|
18594
|
+
event_id: {
|
|
18595
|
+
description: 'ID of the event.',
|
|
18596
|
+
format: 'uuid',
|
|
18597
|
+
type: 'string',
|
|
18598
|
+
},
|
|
18599
|
+
event_type: {
|
|
18600
|
+
enum: ['access_method.failed_to_issue'],
|
|
18601
|
+
type: 'string',
|
|
18602
|
+
},
|
|
18603
|
+
occurred_at: {
|
|
18604
|
+
description: 'Date and time at which the event occurred.',
|
|
18605
|
+
format: 'date-time',
|
|
18606
|
+
type: 'string',
|
|
18607
|
+
},
|
|
18608
|
+
workspace_id: {
|
|
18609
|
+
description: 'ID of the workspace associated with the event.',
|
|
18610
|
+
format: 'uuid',
|
|
18611
|
+
type: 'string',
|
|
18612
|
+
},
|
|
18613
|
+
},
|
|
18614
|
+
required: [
|
|
18615
|
+
'event_id',
|
|
18616
|
+
'workspace_id',
|
|
18617
|
+
'created_at',
|
|
18618
|
+
'occurred_at',
|
|
18619
|
+
'access_method_id',
|
|
18620
|
+
'access_grant_ids',
|
|
18621
|
+
'event_type',
|
|
18622
|
+
],
|
|
18623
|
+
type: 'object',
|
|
18624
|
+
'x-route-path': '/access_methods',
|
|
18625
|
+
},
|
|
18400
18626
|
{
|
|
18401
18627
|
description: 'An [access system](https://docs.seam.co/low-level-apis/access-systems) was connected.',
|
|
18402
18628
|
properties: {
|
|
@@ -38273,6 +38499,42 @@ const openapi = {
|
|
|
38273
38499
|
description: 'Display name of the access method.',
|
|
38274
38500
|
type: 'string',
|
|
38275
38501
|
},
|
|
38502
|
+
errors: {
|
|
38503
|
+
description: 'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
38504
|
+
items: {
|
|
38505
|
+
description: 'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
38506
|
+
discriminator: { propertyName: 'error_code' },
|
|
38507
|
+
oneOf: [
|
|
38508
|
+
{
|
|
38509
|
+
description: 'Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.',
|
|
38510
|
+
properties: {
|
|
38511
|
+
created_at: {
|
|
38512
|
+
description: 'Date and time at which Seam created the error.',
|
|
38513
|
+
format: 'date-time',
|
|
38514
|
+
type: 'string',
|
|
38515
|
+
},
|
|
38516
|
+
error_code: {
|
|
38517
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
38518
|
+
enum: ['failed_to_issue'],
|
|
38519
|
+
type: 'string',
|
|
38520
|
+
},
|
|
38521
|
+
message: {
|
|
38522
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
38523
|
+
type: 'string',
|
|
38524
|
+
},
|
|
38525
|
+
},
|
|
38526
|
+
required: [
|
|
38527
|
+
'created_at',
|
|
38528
|
+
'message',
|
|
38529
|
+
'error_code',
|
|
38530
|
+
],
|
|
38531
|
+
type: 'object',
|
|
38532
|
+
'x-resource-type': 'access_method',
|
|
38533
|
+
},
|
|
38534
|
+
],
|
|
38535
|
+
},
|
|
38536
|
+
type: 'array',
|
|
38537
|
+
},
|
|
38276
38538
|
is_assignment_required: {
|
|
38277
38539
|
description: 'Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.',
|
|
38278
38540
|
type: 'boolean',
|
|
@@ -38578,6 +38840,31 @@ const openapi = {
|
|
|
38578
38840
|
],
|
|
38579
38841
|
type: 'object',
|
|
38580
38842
|
},
|
|
38843
|
+
{
|
|
38844
|
+
description: 'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
|
|
38845
|
+
properties: {
|
|
38846
|
+
created_at: {
|
|
38847
|
+
description: 'Date and time at which Seam created the warning.',
|
|
38848
|
+
format: 'date-time',
|
|
38849
|
+
type: 'string',
|
|
38850
|
+
},
|
|
38851
|
+
message: {
|
|
38852
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
38853
|
+
type: 'string',
|
|
38854
|
+
},
|
|
38855
|
+
warning_code: {
|
|
38856
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
38857
|
+
enum: ['delay_in_issuing'],
|
|
38858
|
+
type: 'string',
|
|
38859
|
+
},
|
|
38860
|
+
},
|
|
38861
|
+
required: [
|
|
38862
|
+
'created_at',
|
|
38863
|
+
'message',
|
|
38864
|
+
'warning_code',
|
|
38865
|
+
],
|
|
38866
|
+
type: 'object',
|
|
38867
|
+
},
|
|
38581
38868
|
],
|
|
38582
38869
|
},
|
|
38583
38870
|
type: 'array',
|
|
@@ -38597,6 +38884,7 @@ const openapi = {
|
|
|
38597
38884
|
'issued_at',
|
|
38598
38885
|
'is_issued',
|
|
38599
38886
|
'warnings',
|
|
38887
|
+
'errors',
|
|
38600
38888
|
'pending_mutations',
|
|
38601
38889
|
],
|
|
38602
38890
|
type: 'object',
|
|
@@ -38676,6 +38964,42 @@ const openapi = {
|
|
|
38676
38964
|
description: 'Display name of the access method.',
|
|
38677
38965
|
type: 'string',
|
|
38678
38966
|
},
|
|
38967
|
+
errors: {
|
|
38968
|
+
description: 'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
38969
|
+
items: {
|
|
38970
|
+
description: 'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
38971
|
+
discriminator: { propertyName: 'error_code' },
|
|
38972
|
+
oneOf: [
|
|
38973
|
+
{
|
|
38974
|
+
description: 'Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.',
|
|
38975
|
+
properties: {
|
|
38976
|
+
created_at: {
|
|
38977
|
+
description: 'Date and time at which Seam created the error.',
|
|
38978
|
+
format: 'date-time',
|
|
38979
|
+
type: 'string',
|
|
38980
|
+
},
|
|
38981
|
+
error_code: {
|
|
38982
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
38983
|
+
enum: ['failed_to_issue'],
|
|
38984
|
+
type: 'string',
|
|
38985
|
+
},
|
|
38986
|
+
message: {
|
|
38987
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
38988
|
+
type: 'string',
|
|
38989
|
+
},
|
|
38990
|
+
},
|
|
38991
|
+
required: [
|
|
38992
|
+
'created_at',
|
|
38993
|
+
'message',
|
|
38994
|
+
'error_code',
|
|
38995
|
+
],
|
|
38996
|
+
type: 'object',
|
|
38997
|
+
'x-resource-type': 'access_method',
|
|
38998
|
+
},
|
|
38999
|
+
],
|
|
39000
|
+
},
|
|
39001
|
+
type: 'array',
|
|
39002
|
+
},
|
|
38679
39003
|
is_assignment_required: {
|
|
38680
39004
|
description: 'Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.',
|
|
38681
39005
|
type: 'boolean',
|
|
@@ -38981,6 +39305,31 @@ const openapi = {
|
|
|
38981
39305
|
],
|
|
38982
39306
|
type: 'object',
|
|
38983
39307
|
},
|
|
39308
|
+
{
|
|
39309
|
+
description: 'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
|
|
39310
|
+
properties: {
|
|
39311
|
+
created_at: {
|
|
39312
|
+
description: 'Date and time at which Seam created the warning.',
|
|
39313
|
+
format: 'date-time',
|
|
39314
|
+
type: 'string',
|
|
39315
|
+
},
|
|
39316
|
+
message: {
|
|
39317
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
39318
|
+
type: 'string',
|
|
39319
|
+
},
|
|
39320
|
+
warning_code: {
|
|
39321
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
39322
|
+
enum: ['delay_in_issuing'],
|
|
39323
|
+
type: 'string',
|
|
39324
|
+
},
|
|
39325
|
+
},
|
|
39326
|
+
required: [
|
|
39327
|
+
'created_at',
|
|
39328
|
+
'message',
|
|
39329
|
+
'warning_code',
|
|
39330
|
+
],
|
|
39331
|
+
type: 'object',
|
|
39332
|
+
},
|
|
38984
39333
|
],
|
|
38985
39334
|
},
|
|
38986
39335
|
type: 'array',
|
|
@@ -39000,6 +39349,7 @@ const openapi = {
|
|
|
39000
39349
|
'issued_at',
|
|
39001
39350
|
'is_issued',
|
|
39002
39351
|
'warnings',
|
|
39352
|
+
'errors',
|
|
39003
39353
|
'pending_mutations',
|
|
39004
39354
|
],
|
|
39005
39355
|
type: 'object',
|
|
@@ -39107,6 +39457,42 @@ const openapi = {
|
|
|
39107
39457
|
description: 'Display name of the access method.',
|
|
39108
39458
|
type: 'string',
|
|
39109
39459
|
},
|
|
39460
|
+
errors: {
|
|
39461
|
+
description: 'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
39462
|
+
items: {
|
|
39463
|
+
description: 'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
39464
|
+
discriminator: { propertyName: 'error_code' },
|
|
39465
|
+
oneOf: [
|
|
39466
|
+
{
|
|
39467
|
+
description: 'Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.',
|
|
39468
|
+
properties: {
|
|
39469
|
+
created_at: {
|
|
39470
|
+
description: 'Date and time at which Seam created the error.',
|
|
39471
|
+
format: 'date-time',
|
|
39472
|
+
type: 'string',
|
|
39473
|
+
},
|
|
39474
|
+
error_code: {
|
|
39475
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
39476
|
+
enum: ['failed_to_issue'],
|
|
39477
|
+
type: 'string',
|
|
39478
|
+
},
|
|
39479
|
+
message: {
|
|
39480
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
39481
|
+
type: 'string',
|
|
39482
|
+
},
|
|
39483
|
+
},
|
|
39484
|
+
required: [
|
|
39485
|
+
'created_at',
|
|
39486
|
+
'message',
|
|
39487
|
+
'error_code',
|
|
39488
|
+
],
|
|
39489
|
+
type: 'object',
|
|
39490
|
+
'x-resource-type': 'access_method',
|
|
39491
|
+
},
|
|
39492
|
+
],
|
|
39493
|
+
},
|
|
39494
|
+
type: 'array',
|
|
39495
|
+
},
|
|
39110
39496
|
is_assignment_required: {
|
|
39111
39497
|
description: 'Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.',
|
|
39112
39498
|
type: 'boolean',
|
|
@@ -39412,6 +39798,31 @@ const openapi = {
|
|
|
39412
39798
|
],
|
|
39413
39799
|
type: 'object',
|
|
39414
39800
|
},
|
|
39801
|
+
{
|
|
39802
|
+
description: 'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
|
|
39803
|
+
properties: {
|
|
39804
|
+
created_at: {
|
|
39805
|
+
description: 'Date and time at which Seam created the warning.',
|
|
39806
|
+
format: 'date-time',
|
|
39807
|
+
type: 'string',
|
|
39808
|
+
},
|
|
39809
|
+
message: {
|
|
39810
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
39811
|
+
type: 'string',
|
|
39812
|
+
},
|
|
39813
|
+
warning_code: {
|
|
39814
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
39815
|
+
enum: ['delay_in_issuing'],
|
|
39816
|
+
type: 'string',
|
|
39817
|
+
},
|
|
39818
|
+
},
|
|
39819
|
+
required: [
|
|
39820
|
+
'created_at',
|
|
39821
|
+
'message',
|
|
39822
|
+
'warning_code',
|
|
39823
|
+
],
|
|
39824
|
+
type: 'object',
|
|
39825
|
+
},
|
|
39415
39826
|
],
|
|
39416
39827
|
},
|
|
39417
39828
|
type: 'array',
|
|
@@ -39431,6 +39842,7 @@ const openapi = {
|
|
|
39431
39842
|
'issued_at',
|
|
39432
39843
|
'is_issued',
|
|
39433
39844
|
'warnings',
|
|
39845
|
+
'errors',
|
|
39434
39846
|
'pending_mutations',
|
|
39435
39847
|
],
|
|
39436
39848
|
type: 'object',
|
|
@@ -39529,6 +39941,42 @@ const openapi = {
|
|
|
39529
39941
|
description: 'Display name of the access method.',
|
|
39530
39942
|
type: 'string',
|
|
39531
39943
|
},
|
|
39944
|
+
errors: {
|
|
39945
|
+
description: 'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
39946
|
+
items: {
|
|
39947
|
+
description: 'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
39948
|
+
discriminator: { propertyName: 'error_code' },
|
|
39949
|
+
oneOf: [
|
|
39950
|
+
{
|
|
39951
|
+
description: 'Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.',
|
|
39952
|
+
properties: {
|
|
39953
|
+
created_at: {
|
|
39954
|
+
description: 'Date and time at which Seam created the error.',
|
|
39955
|
+
format: 'date-time',
|
|
39956
|
+
type: 'string',
|
|
39957
|
+
},
|
|
39958
|
+
error_code: {
|
|
39959
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
39960
|
+
enum: ['failed_to_issue'],
|
|
39961
|
+
type: 'string',
|
|
39962
|
+
},
|
|
39963
|
+
message: {
|
|
39964
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
39965
|
+
type: 'string',
|
|
39966
|
+
},
|
|
39967
|
+
},
|
|
39968
|
+
required: [
|
|
39969
|
+
'created_at',
|
|
39970
|
+
'message',
|
|
39971
|
+
'error_code',
|
|
39972
|
+
],
|
|
39973
|
+
type: 'object',
|
|
39974
|
+
'x-resource-type': 'access_method',
|
|
39975
|
+
},
|
|
39976
|
+
],
|
|
39977
|
+
},
|
|
39978
|
+
type: 'array',
|
|
39979
|
+
},
|
|
39532
39980
|
is_assignment_required: {
|
|
39533
39981
|
description: 'Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.',
|
|
39534
39982
|
type: 'boolean',
|
|
@@ -39834,6 +40282,31 @@ const openapi = {
|
|
|
39834
40282
|
],
|
|
39835
40283
|
type: 'object',
|
|
39836
40284
|
},
|
|
40285
|
+
{
|
|
40286
|
+
description: 'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
|
|
40287
|
+
properties: {
|
|
40288
|
+
created_at: {
|
|
40289
|
+
description: 'Date and time at which Seam created the warning.',
|
|
40290
|
+
format: 'date-time',
|
|
40291
|
+
type: 'string',
|
|
40292
|
+
},
|
|
40293
|
+
message: {
|
|
40294
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
40295
|
+
type: 'string',
|
|
40296
|
+
},
|
|
40297
|
+
warning_code: {
|
|
40298
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
40299
|
+
enum: ['delay_in_issuing'],
|
|
40300
|
+
type: 'string',
|
|
40301
|
+
},
|
|
40302
|
+
},
|
|
40303
|
+
required: [
|
|
40304
|
+
'created_at',
|
|
40305
|
+
'message',
|
|
40306
|
+
'warning_code',
|
|
40307
|
+
],
|
|
40308
|
+
type: 'object',
|
|
40309
|
+
},
|
|
39837
40310
|
],
|
|
39838
40311
|
},
|
|
39839
40312
|
type: 'array',
|
|
@@ -39853,6 +40326,7 @@ const openapi = {
|
|
|
39853
40326
|
'issued_at',
|
|
39854
40327
|
'is_issued',
|
|
39855
40328
|
'warnings',
|
|
40329
|
+
'errors',
|
|
39856
40330
|
'pending_mutations',
|
|
39857
40331
|
],
|
|
39858
40332
|
type: 'object',
|
|
@@ -55436,6 +55910,8 @@ const openapi = {
|
|
|
55436
55910
|
'access_method.deleted',
|
|
55437
55911
|
'access_method.reissued',
|
|
55438
55912
|
'access_method.created',
|
|
55913
|
+
'access_method.delay_in_issuing',
|
|
55914
|
+
'access_method.failed_to_issue',
|
|
55439
55915
|
'acs_system.connected',
|
|
55440
55916
|
'acs_system.added',
|
|
55441
55917
|
'acs_system.disconnected',
|
|
@@ -55554,6 +56030,8 @@ const openapi = {
|
|
|
55554
56030
|
'access_method.deleted',
|
|
55555
56031
|
'access_method.reissued',
|
|
55556
56032
|
'access_method.created',
|
|
56033
|
+
'access_method.delay_in_issuing',
|
|
56034
|
+
'access_method.failed_to_issue',
|
|
55557
56035
|
'acs_system.connected',
|
|
55558
56036
|
'acs_system.added',
|
|
55559
56037
|
'acs_system.disconnected',
|
|
@@ -55972,6 +56450,8 @@ const openapi = {
|
|
|
55972
56450
|
'access_method.deleted',
|
|
55973
56451
|
'access_method.reissued',
|
|
55974
56452
|
'access_method.created',
|
|
56453
|
+
'access_method.delay_in_issuing',
|
|
56454
|
+
'access_method.failed_to_issue',
|
|
55975
56455
|
'acs_system.connected',
|
|
55976
56456
|
'acs_system.added',
|
|
55977
56457
|
'acs_system.disconnected',
|
|
@@ -56086,6 +56566,8 @@ const openapi = {
|
|
|
56086
56566
|
'access_method.deleted',
|
|
56087
56567
|
'access_method.reissued',
|
|
56088
56568
|
'access_method.created',
|
|
56569
|
+
'access_method.delay_in_issuing',
|
|
56570
|
+
'access_method.failed_to_issue',
|
|
56089
56571
|
'acs_system.connected',
|
|
56090
56572
|
'acs_system.added',
|
|
56091
56573
|
'acs_system.disconnected',
|
|
@@ -68540,6 +69022,8 @@ const openapi = {
|
|
|
68540
69022
|
'access_method.deleted',
|
|
68541
69023
|
'access_method.reissued',
|
|
68542
69024
|
'access_method.created',
|
|
69025
|
+
'access_method.delay_in_issuing',
|
|
69026
|
+
'access_method.failed_to_issue',
|
|
68543
69027
|
'acs_system.connected',
|
|
68544
69028
|
'acs_system.added',
|
|
68545
69029
|
'acs_system.disconnected',
|
|
@@ -68659,6 +69143,8 @@ const openapi = {
|
|
|
68659
69143
|
'access_method.deleted',
|
|
68660
69144
|
'access_method.reissued',
|
|
68661
69145
|
'access_method.created',
|
|
69146
|
+
'access_method.delay_in_issuing',
|
|
69147
|
+
'access_method.failed_to_issue',
|
|
68662
69148
|
'acs_system.connected',
|
|
68663
69149
|
'acs_system.added',
|
|
68664
69150
|
'acs_system.disconnected',
|
|
@@ -68839,6 +69325,8 @@ const openapi = {
|
|
|
68839
69325
|
'access_method.deleted',
|
|
68840
69326
|
'access_method.reissued',
|
|
68841
69327
|
'access_method.created',
|
|
69328
|
+
'access_method.delay_in_issuing',
|
|
69329
|
+
'access_method.failed_to_issue',
|
|
68842
69330
|
'acs_system.connected',
|
|
68843
69331
|
'acs_system.added',
|
|
68844
69332
|
'acs_system.disconnected',
|
|
@@ -68953,6 +69441,8 @@ const openapi = {
|
|
|
68953
69441
|
'access_method.deleted',
|
|
68954
69442
|
'access_method.reissued',
|
|
68955
69443
|
'access_method.created',
|
|
69444
|
+
'access_method.delay_in_issuing',
|
|
69445
|
+
'access_method.failed_to_issue',
|
|
68956
69446
|
'acs_system.connected',
|
|
68957
69447
|
'acs_system.added',
|
|
68958
69448
|
'acs_system.disconnected',
|