@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
|
@@ -2275,6 +2275,44 @@ const openapi: OpenAPISpec = {
|
|
|
2275
2275
|
description: 'Display name of the access method.',
|
|
2276
2276
|
type: 'string',
|
|
2277
2277
|
},
|
|
2278
|
+
errors: {
|
|
2279
|
+
description:
|
|
2280
|
+
'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
2281
|
+
items: {
|
|
2282
|
+
description:
|
|
2283
|
+
'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
2284
|
+
discriminator: { propertyName: 'error_code' },
|
|
2285
|
+
oneOf: [
|
|
2286
|
+
{
|
|
2287
|
+
description:
|
|
2288
|
+
'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.',
|
|
2289
|
+
properties: {
|
|
2290
|
+
created_at: {
|
|
2291
|
+
description:
|
|
2292
|
+
'Date and time at which Seam created the error.',
|
|
2293
|
+
format: 'date-time',
|
|
2294
|
+
type: 'string',
|
|
2295
|
+
},
|
|
2296
|
+
error_code: {
|
|
2297
|
+
description:
|
|
2298
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
2299
|
+
enum: ['failed_to_issue'],
|
|
2300
|
+
type: 'string',
|
|
2301
|
+
},
|
|
2302
|
+
message: {
|
|
2303
|
+
description:
|
|
2304
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
2305
|
+
type: 'string',
|
|
2306
|
+
},
|
|
2307
|
+
},
|
|
2308
|
+
required: ['created_at', 'message', 'error_code'],
|
|
2309
|
+
type: 'object',
|
|
2310
|
+
'x-resource-type': 'access_method',
|
|
2311
|
+
},
|
|
2312
|
+
],
|
|
2313
|
+
},
|
|
2314
|
+
type: 'array',
|
|
2315
|
+
},
|
|
2278
2316
|
instant_key_url: {
|
|
2279
2317
|
description:
|
|
2280
2318
|
'URL of the Instant Key for mobile key access methods.',
|
|
@@ -2596,6 +2634,31 @@ const openapi: OpenAPISpec = {
|
|
|
2596
2634
|
required: ['created_at', 'message', 'warning_code'],
|
|
2597
2635
|
type: 'object',
|
|
2598
2636
|
},
|
|
2637
|
+
{
|
|
2638
|
+
description:
|
|
2639
|
+
'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.',
|
|
2640
|
+
properties: {
|
|
2641
|
+
created_at: {
|
|
2642
|
+
description:
|
|
2643
|
+
'Date and time at which Seam created the warning.',
|
|
2644
|
+
format: 'date-time',
|
|
2645
|
+
type: 'string',
|
|
2646
|
+
},
|
|
2647
|
+
message: {
|
|
2648
|
+
description:
|
|
2649
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2650
|
+
type: 'string',
|
|
2651
|
+
},
|
|
2652
|
+
warning_code: {
|
|
2653
|
+
description:
|
|
2654
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
2655
|
+
enum: ['delay_in_issuing'],
|
|
2656
|
+
type: 'string',
|
|
2657
|
+
},
|
|
2658
|
+
},
|
|
2659
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
2660
|
+
type: 'object',
|
|
2661
|
+
},
|
|
2599
2662
|
],
|
|
2600
2663
|
},
|
|
2601
2664
|
type: 'array',
|
|
@@ -2616,6 +2679,7 @@ const openapi: OpenAPISpec = {
|
|
|
2616
2679
|
'issued_at',
|
|
2617
2680
|
'is_issued',
|
|
2618
2681
|
'warnings',
|
|
2682
|
+
'errors',
|
|
2619
2683
|
'pending_mutations',
|
|
2620
2684
|
],
|
|
2621
2685
|
type: 'object',
|
|
@@ -9107,6 +9171,44 @@ const openapi: OpenAPISpec = {
|
|
|
9107
9171
|
description: 'Display name of the access method.',
|
|
9108
9172
|
type: 'string',
|
|
9109
9173
|
},
|
|
9174
|
+
errors: {
|
|
9175
|
+
description:
|
|
9176
|
+
'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
9177
|
+
items: {
|
|
9178
|
+
description:
|
|
9179
|
+
'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
9180
|
+
discriminator: { propertyName: 'error_code' },
|
|
9181
|
+
oneOf: [
|
|
9182
|
+
{
|
|
9183
|
+
description:
|
|
9184
|
+
'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.',
|
|
9185
|
+
properties: {
|
|
9186
|
+
created_at: {
|
|
9187
|
+
description:
|
|
9188
|
+
'Date and time at which Seam created the error.',
|
|
9189
|
+
format: 'date-time',
|
|
9190
|
+
type: 'string',
|
|
9191
|
+
},
|
|
9192
|
+
error_code: {
|
|
9193
|
+
description:
|
|
9194
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
9195
|
+
enum: ['failed_to_issue'],
|
|
9196
|
+
type: 'string',
|
|
9197
|
+
},
|
|
9198
|
+
message: {
|
|
9199
|
+
description:
|
|
9200
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
9201
|
+
type: 'string',
|
|
9202
|
+
},
|
|
9203
|
+
},
|
|
9204
|
+
required: ['created_at', 'message', 'error_code'],
|
|
9205
|
+
type: 'object',
|
|
9206
|
+
'x-resource-type': 'access_method',
|
|
9207
|
+
},
|
|
9208
|
+
],
|
|
9209
|
+
},
|
|
9210
|
+
type: 'array',
|
|
9211
|
+
},
|
|
9110
9212
|
instant_key_url: {
|
|
9111
9213
|
description:
|
|
9112
9214
|
'URL of the Instant Key for mobile key access methods.',
|
|
@@ -9435,6 +9537,31 @@ const openapi: OpenAPISpec = {
|
|
|
9435
9537
|
required: ['created_at', 'message', 'warning_code'],
|
|
9436
9538
|
type: 'object',
|
|
9437
9539
|
},
|
|
9540
|
+
{
|
|
9541
|
+
description:
|
|
9542
|
+
'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.',
|
|
9543
|
+
properties: {
|
|
9544
|
+
created_at: {
|
|
9545
|
+
description:
|
|
9546
|
+
'Date and time at which Seam created the warning.',
|
|
9547
|
+
format: 'date-time',
|
|
9548
|
+
type: 'string',
|
|
9549
|
+
},
|
|
9550
|
+
message: {
|
|
9551
|
+
description:
|
|
9552
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
9553
|
+
type: 'string',
|
|
9554
|
+
},
|
|
9555
|
+
warning_code: {
|
|
9556
|
+
description:
|
|
9557
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
9558
|
+
enum: ['delay_in_issuing'],
|
|
9559
|
+
type: 'string',
|
|
9560
|
+
},
|
|
9561
|
+
},
|
|
9562
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
9563
|
+
type: 'object',
|
|
9564
|
+
},
|
|
9438
9565
|
],
|
|
9439
9566
|
},
|
|
9440
9567
|
type: 'array',
|
|
@@ -9455,6 +9582,7 @@ const openapi: OpenAPISpec = {
|
|
|
9455
9582
|
'issued_at',
|
|
9456
9583
|
'is_issued',
|
|
9457
9584
|
'warnings',
|
|
9585
|
+
'errors',
|
|
9458
9586
|
'pending_mutations',
|
|
9459
9587
|
],
|
|
9460
9588
|
type: 'object',
|
|
@@ -20685,6 +20813,132 @@ const openapi: OpenAPISpec = {
|
|
|
20685
20813
|
type: 'object',
|
|
20686
20814
|
'x-route-path': '/access_methods',
|
|
20687
20815
|
},
|
|
20816
|
+
{
|
|
20817
|
+
description:
|
|
20818
|
+
'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.',
|
|
20819
|
+
properties: {
|
|
20820
|
+
access_grant_ids: {
|
|
20821
|
+
description:
|
|
20822
|
+
'IDs of the access grants associated with this access method.',
|
|
20823
|
+
items: { format: 'uuid', type: 'string' },
|
|
20824
|
+
type: 'array',
|
|
20825
|
+
},
|
|
20826
|
+
access_grant_keys: {
|
|
20827
|
+
description:
|
|
20828
|
+
'Keys of the access grants associated with this access method (if present).',
|
|
20829
|
+
items: { type: 'string' },
|
|
20830
|
+
type: 'array',
|
|
20831
|
+
},
|
|
20832
|
+
access_method_id: {
|
|
20833
|
+
description: 'ID of the affected access method.',
|
|
20834
|
+
format: 'uuid',
|
|
20835
|
+
type: 'string',
|
|
20836
|
+
},
|
|
20837
|
+
created_at: {
|
|
20838
|
+
description: 'Date and time at which the event was created.',
|
|
20839
|
+
format: 'date-time',
|
|
20840
|
+
type: 'string',
|
|
20841
|
+
},
|
|
20842
|
+
event_description: {
|
|
20843
|
+
description:
|
|
20844
|
+
'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.',
|
|
20845
|
+
type: 'string',
|
|
20846
|
+
},
|
|
20847
|
+
event_id: {
|
|
20848
|
+
description: 'ID of the event.',
|
|
20849
|
+
format: 'uuid',
|
|
20850
|
+
type: 'string',
|
|
20851
|
+
},
|
|
20852
|
+
event_type: {
|
|
20853
|
+
enum: ['access_method.delay_in_issuing'],
|
|
20854
|
+
type: 'string',
|
|
20855
|
+
},
|
|
20856
|
+
occurred_at: {
|
|
20857
|
+
description: 'Date and time at which the event occurred.',
|
|
20858
|
+
format: 'date-time',
|
|
20859
|
+
type: 'string',
|
|
20860
|
+
},
|
|
20861
|
+
workspace_id: {
|
|
20862
|
+
description: 'ID of the workspace associated with the event.',
|
|
20863
|
+
format: 'uuid',
|
|
20864
|
+
type: 'string',
|
|
20865
|
+
},
|
|
20866
|
+
},
|
|
20867
|
+
required: [
|
|
20868
|
+
'event_id',
|
|
20869
|
+
'workspace_id',
|
|
20870
|
+
'created_at',
|
|
20871
|
+
'occurred_at',
|
|
20872
|
+
'access_method_id',
|
|
20873
|
+
'access_grant_ids',
|
|
20874
|
+
'event_type',
|
|
20875
|
+
],
|
|
20876
|
+
type: 'object',
|
|
20877
|
+
'x-route-path': '/access_methods',
|
|
20878
|
+
},
|
|
20879
|
+
{
|
|
20880
|
+
description:
|
|
20881
|
+
'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.',
|
|
20882
|
+
properties: {
|
|
20883
|
+
access_grant_ids: {
|
|
20884
|
+
description:
|
|
20885
|
+
'IDs of the access grants associated with this access method.',
|
|
20886
|
+
items: { format: 'uuid', type: 'string' },
|
|
20887
|
+
type: 'array',
|
|
20888
|
+
},
|
|
20889
|
+
access_grant_keys: {
|
|
20890
|
+
description:
|
|
20891
|
+
'Keys of the access grants associated with this access method (if present).',
|
|
20892
|
+
items: { type: 'string' },
|
|
20893
|
+
type: 'array',
|
|
20894
|
+
},
|
|
20895
|
+
access_method_id: {
|
|
20896
|
+
description: 'ID of the affected access method.',
|
|
20897
|
+
format: 'uuid',
|
|
20898
|
+
type: 'string',
|
|
20899
|
+
},
|
|
20900
|
+
created_at: {
|
|
20901
|
+
description: 'Date and time at which the event was created.',
|
|
20902
|
+
format: 'date-time',
|
|
20903
|
+
type: 'string',
|
|
20904
|
+
},
|
|
20905
|
+
event_description: {
|
|
20906
|
+
description:
|
|
20907
|
+
'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.',
|
|
20908
|
+
type: 'string',
|
|
20909
|
+
},
|
|
20910
|
+
event_id: {
|
|
20911
|
+
description: 'ID of the event.',
|
|
20912
|
+
format: 'uuid',
|
|
20913
|
+
type: 'string',
|
|
20914
|
+
},
|
|
20915
|
+
event_type: {
|
|
20916
|
+
enum: ['access_method.failed_to_issue'],
|
|
20917
|
+
type: 'string',
|
|
20918
|
+
},
|
|
20919
|
+
occurred_at: {
|
|
20920
|
+
description: 'Date and time at which the event occurred.',
|
|
20921
|
+
format: 'date-time',
|
|
20922
|
+
type: 'string',
|
|
20923
|
+
},
|
|
20924
|
+
workspace_id: {
|
|
20925
|
+
description: 'ID of the workspace associated with the event.',
|
|
20926
|
+
format: 'uuid',
|
|
20927
|
+
type: 'string',
|
|
20928
|
+
},
|
|
20929
|
+
},
|
|
20930
|
+
required: [
|
|
20931
|
+
'event_id',
|
|
20932
|
+
'workspace_id',
|
|
20933
|
+
'created_at',
|
|
20934
|
+
'occurred_at',
|
|
20935
|
+
'access_method_id',
|
|
20936
|
+
'access_grant_ids',
|
|
20937
|
+
'event_type',
|
|
20938
|
+
],
|
|
20939
|
+
type: 'object',
|
|
20940
|
+
'x-route-path': '/access_methods',
|
|
20941
|
+
},
|
|
20688
20942
|
{
|
|
20689
20943
|
description:
|
|
20690
20944
|
'An [access system](https://docs.seam.co/low-level-apis/access-systems) was connected.',
|
|
@@ -42562,6 +42816,48 @@ const openapi: OpenAPISpec = {
|
|
|
42562
42816
|
description: 'Display name of the access method.',
|
|
42563
42817
|
type: 'string',
|
|
42564
42818
|
},
|
|
42819
|
+
errors: {
|
|
42820
|
+
description:
|
|
42821
|
+
'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
42822
|
+
items: {
|
|
42823
|
+
description:
|
|
42824
|
+
'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
42825
|
+
discriminator: { propertyName: 'error_code' },
|
|
42826
|
+
oneOf: [
|
|
42827
|
+
{
|
|
42828
|
+
description:
|
|
42829
|
+
'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.',
|
|
42830
|
+
properties: {
|
|
42831
|
+
created_at: {
|
|
42832
|
+
description:
|
|
42833
|
+
'Date and time at which Seam created the error.',
|
|
42834
|
+
format: 'date-time',
|
|
42835
|
+
type: 'string',
|
|
42836
|
+
},
|
|
42837
|
+
error_code: {
|
|
42838
|
+
description:
|
|
42839
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
42840
|
+
enum: ['failed_to_issue'],
|
|
42841
|
+
type: 'string',
|
|
42842
|
+
},
|
|
42843
|
+
message: {
|
|
42844
|
+
description:
|
|
42845
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
42846
|
+
type: 'string',
|
|
42847
|
+
},
|
|
42848
|
+
},
|
|
42849
|
+
required: [
|
|
42850
|
+
'created_at',
|
|
42851
|
+
'message',
|
|
42852
|
+
'error_code',
|
|
42853
|
+
],
|
|
42854
|
+
type: 'object',
|
|
42855
|
+
'x-resource-type': 'access_method',
|
|
42856
|
+
},
|
|
42857
|
+
],
|
|
42858
|
+
},
|
|
42859
|
+
type: 'array',
|
|
42860
|
+
},
|
|
42565
42861
|
is_assignment_required: {
|
|
42566
42862
|
description:
|
|
42567
42863
|
'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.',
|
|
@@ -42913,6 +43209,35 @@ const openapi: OpenAPISpec = {
|
|
|
42913
43209
|
],
|
|
42914
43210
|
type: 'object',
|
|
42915
43211
|
},
|
|
43212
|
+
{
|
|
43213
|
+
description:
|
|
43214
|
+
'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.',
|
|
43215
|
+
properties: {
|
|
43216
|
+
created_at: {
|
|
43217
|
+
description:
|
|
43218
|
+
'Date and time at which Seam created the warning.',
|
|
43219
|
+
format: 'date-time',
|
|
43220
|
+
type: 'string',
|
|
43221
|
+
},
|
|
43222
|
+
message: {
|
|
43223
|
+
description:
|
|
43224
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
43225
|
+
type: 'string',
|
|
43226
|
+
},
|
|
43227
|
+
warning_code: {
|
|
43228
|
+
description:
|
|
43229
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
43230
|
+
enum: ['delay_in_issuing'],
|
|
43231
|
+
type: 'string',
|
|
43232
|
+
},
|
|
43233
|
+
},
|
|
43234
|
+
required: [
|
|
43235
|
+
'created_at',
|
|
43236
|
+
'message',
|
|
43237
|
+
'warning_code',
|
|
43238
|
+
],
|
|
43239
|
+
type: 'object',
|
|
43240
|
+
},
|
|
42916
43241
|
],
|
|
42917
43242
|
},
|
|
42918
43243
|
type: 'array',
|
|
@@ -42933,6 +43258,7 @@ const openapi: OpenAPISpec = {
|
|
|
42933
43258
|
'issued_at',
|
|
42934
43259
|
'is_issued',
|
|
42935
43260
|
'warnings',
|
|
43261
|
+
'errors',
|
|
42936
43262
|
'pending_mutations',
|
|
42937
43263
|
],
|
|
42938
43264
|
type: 'object',
|
|
@@ -43016,6 +43342,48 @@ const openapi: OpenAPISpec = {
|
|
|
43016
43342
|
description: 'Display name of the access method.',
|
|
43017
43343
|
type: 'string',
|
|
43018
43344
|
},
|
|
43345
|
+
errors: {
|
|
43346
|
+
description:
|
|
43347
|
+
'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
43348
|
+
items: {
|
|
43349
|
+
description:
|
|
43350
|
+
'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
43351
|
+
discriminator: { propertyName: 'error_code' },
|
|
43352
|
+
oneOf: [
|
|
43353
|
+
{
|
|
43354
|
+
description:
|
|
43355
|
+
'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.',
|
|
43356
|
+
properties: {
|
|
43357
|
+
created_at: {
|
|
43358
|
+
description:
|
|
43359
|
+
'Date and time at which Seam created the error.',
|
|
43360
|
+
format: 'date-time',
|
|
43361
|
+
type: 'string',
|
|
43362
|
+
},
|
|
43363
|
+
error_code: {
|
|
43364
|
+
description:
|
|
43365
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
43366
|
+
enum: ['failed_to_issue'],
|
|
43367
|
+
type: 'string',
|
|
43368
|
+
},
|
|
43369
|
+
message: {
|
|
43370
|
+
description:
|
|
43371
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
43372
|
+
type: 'string',
|
|
43373
|
+
},
|
|
43374
|
+
},
|
|
43375
|
+
required: [
|
|
43376
|
+
'created_at',
|
|
43377
|
+
'message',
|
|
43378
|
+
'error_code',
|
|
43379
|
+
],
|
|
43380
|
+
type: 'object',
|
|
43381
|
+
'x-resource-type': 'access_method',
|
|
43382
|
+
},
|
|
43383
|
+
],
|
|
43384
|
+
},
|
|
43385
|
+
type: 'array',
|
|
43386
|
+
},
|
|
43019
43387
|
is_assignment_required: {
|
|
43020
43388
|
description:
|
|
43021
43389
|
'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.',
|
|
@@ -43367,6 +43735,35 @@ const openapi: OpenAPISpec = {
|
|
|
43367
43735
|
],
|
|
43368
43736
|
type: 'object',
|
|
43369
43737
|
},
|
|
43738
|
+
{
|
|
43739
|
+
description:
|
|
43740
|
+
'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.',
|
|
43741
|
+
properties: {
|
|
43742
|
+
created_at: {
|
|
43743
|
+
description:
|
|
43744
|
+
'Date and time at which Seam created the warning.',
|
|
43745
|
+
format: 'date-time',
|
|
43746
|
+
type: 'string',
|
|
43747
|
+
},
|
|
43748
|
+
message: {
|
|
43749
|
+
description:
|
|
43750
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
43751
|
+
type: 'string',
|
|
43752
|
+
},
|
|
43753
|
+
warning_code: {
|
|
43754
|
+
description:
|
|
43755
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
43756
|
+
enum: ['delay_in_issuing'],
|
|
43757
|
+
type: 'string',
|
|
43758
|
+
},
|
|
43759
|
+
},
|
|
43760
|
+
required: [
|
|
43761
|
+
'created_at',
|
|
43762
|
+
'message',
|
|
43763
|
+
'warning_code',
|
|
43764
|
+
],
|
|
43765
|
+
type: 'object',
|
|
43766
|
+
},
|
|
43370
43767
|
],
|
|
43371
43768
|
},
|
|
43372
43769
|
type: 'array',
|
|
@@ -43387,6 +43784,7 @@ const openapi: OpenAPISpec = {
|
|
|
43387
43784
|
'issued_at',
|
|
43388
43785
|
'is_issued',
|
|
43389
43786
|
'warnings',
|
|
43787
|
+
'errors',
|
|
43390
43788
|
'pending_mutations',
|
|
43391
43789
|
],
|
|
43392
43790
|
type: 'object',
|
|
@@ -43502,6 +43900,48 @@ const openapi: OpenAPISpec = {
|
|
|
43502
43900
|
description: 'Display name of the access method.',
|
|
43503
43901
|
type: 'string',
|
|
43504
43902
|
},
|
|
43903
|
+
errors: {
|
|
43904
|
+
description:
|
|
43905
|
+
'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
43906
|
+
items: {
|
|
43907
|
+
description:
|
|
43908
|
+
'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
43909
|
+
discriminator: { propertyName: 'error_code' },
|
|
43910
|
+
oneOf: [
|
|
43911
|
+
{
|
|
43912
|
+
description:
|
|
43913
|
+
'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.',
|
|
43914
|
+
properties: {
|
|
43915
|
+
created_at: {
|
|
43916
|
+
description:
|
|
43917
|
+
'Date and time at which Seam created the error.',
|
|
43918
|
+
format: 'date-time',
|
|
43919
|
+
type: 'string',
|
|
43920
|
+
},
|
|
43921
|
+
error_code: {
|
|
43922
|
+
description:
|
|
43923
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
43924
|
+
enum: ['failed_to_issue'],
|
|
43925
|
+
type: 'string',
|
|
43926
|
+
},
|
|
43927
|
+
message: {
|
|
43928
|
+
description:
|
|
43929
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
43930
|
+
type: 'string',
|
|
43931
|
+
},
|
|
43932
|
+
},
|
|
43933
|
+
required: [
|
|
43934
|
+
'created_at',
|
|
43935
|
+
'message',
|
|
43936
|
+
'error_code',
|
|
43937
|
+
],
|
|
43938
|
+
type: 'object',
|
|
43939
|
+
'x-resource-type': 'access_method',
|
|
43940
|
+
},
|
|
43941
|
+
],
|
|
43942
|
+
},
|
|
43943
|
+
type: 'array',
|
|
43944
|
+
},
|
|
43505
43945
|
is_assignment_required: {
|
|
43506
43946
|
description:
|
|
43507
43947
|
'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.',
|
|
@@ -43854,6 +44294,35 @@ const openapi: OpenAPISpec = {
|
|
|
43854
44294
|
],
|
|
43855
44295
|
type: 'object',
|
|
43856
44296
|
},
|
|
44297
|
+
{
|
|
44298
|
+
description:
|
|
44299
|
+
'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.',
|
|
44300
|
+
properties: {
|
|
44301
|
+
created_at: {
|
|
44302
|
+
description:
|
|
44303
|
+
'Date and time at which Seam created the warning.',
|
|
44304
|
+
format: 'date-time',
|
|
44305
|
+
type: 'string',
|
|
44306
|
+
},
|
|
44307
|
+
message: {
|
|
44308
|
+
description:
|
|
44309
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
44310
|
+
type: 'string',
|
|
44311
|
+
},
|
|
44312
|
+
warning_code: {
|
|
44313
|
+
description:
|
|
44314
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
44315
|
+
enum: ['delay_in_issuing'],
|
|
44316
|
+
type: 'string',
|
|
44317
|
+
},
|
|
44318
|
+
},
|
|
44319
|
+
required: [
|
|
44320
|
+
'created_at',
|
|
44321
|
+
'message',
|
|
44322
|
+
'warning_code',
|
|
44323
|
+
],
|
|
44324
|
+
type: 'object',
|
|
44325
|
+
},
|
|
43857
44326
|
],
|
|
43858
44327
|
},
|
|
43859
44328
|
type: 'array',
|
|
@@ -43874,6 +44343,7 @@ const openapi: OpenAPISpec = {
|
|
|
43874
44343
|
'issued_at',
|
|
43875
44344
|
'is_issued',
|
|
43876
44345
|
'warnings',
|
|
44346
|
+
'errors',
|
|
43877
44347
|
'pending_mutations',
|
|
43878
44348
|
],
|
|
43879
44349
|
type: 'object',
|
|
@@ -43980,6 +44450,48 @@ const openapi: OpenAPISpec = {
|
|
|
43980
44450
|
description: 'Display name of the access method.',
|
|
43981
44451
|
type: 'string',
|
|
43982
44452
|
},
|
|
44453
|
+
errors: {
|
|
44454
|
+
description:
|
|
44455
|
+
'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
44456
|
+
items: {
|
|
44457
|
+
description:
|
|
44458
|
+
'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
|
|
44459
|
+
discriminator: { propertyName: 'error_code' },
|
|
44460
|
+
oneOf: [
|
|
44461
|
+
{
|
|
44462
|
+
description:
|
|
44463
|
+
'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.',
|
|
44464
|
+
properties: {
|
|
44465
|
+
created_at: {
|
|
44466
|
+
description:
|
|
44467
|
+
'Date and time at which Seam created the error.',
|
|
44468
|
+
format: 'date-time',
|
|
44469
|
+
type: 'string',
|
|
44470
|
+
},
|
|
44471
|
+
error_code: {
|
|
44472
|
+
description:
|
|
44473
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
44474
|
+
enum: ['failed_to_issue'],
|
|
44475
|
+
type: 'string',
|
|
44476
|
+
},
|
|
44477
|
+
message: {
|
|
44478
|
+
description:
|
|
44479
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
44480
|
+
type: 'string',
|
|
44481
|
+
},
|
|
44482
|
+
},
|
|
44483
|
+
required: [
|
|
44484
|
+
'created_at',
|
|
44485
|
+
'message',
|
|
44486
|
+
'error_code',
|
|
44487
|
+
],
|
|
44488
|
+
type: 'object',
|
|
44489
|
+
'x-resource-type': 'access_method',
|
|
44490
|
+
},
|
|
44491
|
+
],
|
|
44492
|
+
},
|
|
44493
|
+
type: 'array',
|
|
44494
|
+
},
|
|
43983
44495
|
is_assignment_required: {
|
|
43984
44496
|
description:
|
|
43985
44497
|
'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.',
|
|
@@ -44332,6 +44844,35 @@ const openapi: OpenAPISpec = {
|
|
|
44332
44844
|
],
|
|
44333
44845
|
type: 'object',
|
|
44334
44846
|
},
|
|
44847
|
+
{
|
|
44848
|
+
description:
|
|
44849
|
+
'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.',
|
|
44850
|
+
properties: {
|
|
44851
|
+
created_at: {
|
|
44852
|
+
description:
|
|
44853
|
+
'Date and time at which Seam created the warning.',
|
|
44854
|
+
format: 'date-time',
|
|
44855
|
+
type: 'string',
|
|
44856
|
+
},
|
|
44857
|
+
message: {
|
|
44858
|
+
description:
|
|
44859
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
44860
|
+
type: 'string',
|
|
44861
|
+
},
|
|
44862
|
+
warning_code: {
|
|
44863
|
+
description:
|
|
44864
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
44865
|
+
enum: ['delay_in_issuing'],
|
|
44866
|
+
type: 'string',
|
|
44867
|
+
},
|
|
44868
|
+
},
|
|
44869
|
+
required: [
|
|
44870
|
+
'created_at',
|
|
44871
|
+
'message',
|
|
44872
|
+
'warning_code',
|
|
44873
|
+
],
|
|
44874
|
+
type: 'object',
|
|
44875
|
+
},
|
|
44335
44876
|
],
|
|
44336
44877
|
},
|
|
44337
44878
|
type: 'array',
|
|
@@ -44352,6 +44893,7 @@ const openapi: OpenAPISpec = {
|
|
|
44352
44893
|
'issued_at',
|
|
44353
44894
|
'is_issued',
|
|
44354
44895
|
'warnings',
|
|
44896
|
+
'errors',
|
|
44355
44897
|
'pending_mutations',
|
|
44356
44898
|
],
|
|
44357
44899
|
type: 'object',
|
|
@@ -60867,6 +61409,8 @@ const openapi: OpenAPISpec = {
|
|
|
60867
61409
|
'access_method.deleted',
|
|
60868
61410
|
'access_method.reissued',
|
|
60869
61411
|
'access_method.created',
|
|
61412
|
+
'access_method.delay_in_issuing',
|
|
61413
|
+
'access_method.failed_to_issue',
|
|
60870
61414
|
'acs_system.connected',
|
|
60871
61415
|
'acs_system.added',
|
|
60872
61416
|
'acs_system.disconnected',
|
|
@@ -60985,6 +61529,8 @@ const openapi: OpenAPISpec = {
|
|
|
60985
61529
|
'access_method.deleted',
|
|
60986
61530
|
'access_method.reissued',
|
|
60987
61531
|
'access_method.created',
|
|
61532
|
+
'access_method.delay_in_issuing',
|
|
61533
|
+
'access_method.failed_to_issue',
|
|
60988
61534
|
'acs_system.connected',
|
|
60989
61535
|
'acs_system.added',
|
|
60990
61536
|
'acs_system.disconnected',
|
|
@@ -61436,6 +61982,8 @@ const openapi: OpenAPISpec = {
|
|
|
61436
61982
|
'access_method.deleted',
|
|
61437
61983
|
'access_method.reissued',
|
|
61438
61984
|
'access_method.created',
|
|
61985
|
+
'access_method.delay_in_issuing',
|
|
61986
|
+
'access_method.failed_to_issue',
|
|
61439
61987
|
'acs_system.connected',
|
|
61440
61988
|
'acs_system.added',
|
|
61441
61989
|
'acs_system.disconnected',
|
|
@@ -61550,6 +62098,8 @@ const openapi: OpenAPISpec = {
|
|
|
61550
62098
|
'access_method.deleted',
|
|
61551
62099
|
'access_method.reissued',
|
|
61552
62100
|
'access_method.created',
|
|
62101
|
+
'access_method.delay_in_issuing',
|
|
62102
|
+
'access_method.failed_to_issue',
|
|
61553
62103
|
'acs_system.connected',
|
|
61554
62104
|
'acs_system.added',
|
|
61555
62105
|
'acs_system.disconnected',
|
|
@@ -74346,6 +74896,8 @@ const openapi: OpenAPISpec = {
|
|
|
74346
74896
|
'access_method.deleted',
|
|
74347
74897
|
'access_method.reissued',
|
|
74348
74898
|
'access_method.created',
|
|
74899
|
+
'access_method.delay_in_issuing',
|
|
74900
|
+
'access_method.failed_to_issue',
|
|
74349
74901
|
'acs_system.connected',
|
|
74350
74902
|
'acs_system.added',
|
|
74351
74903
|
'acs_system.disconnected',
|
|
@@ -74465,6 +75017,8 @@ const openapi: OpenAPISpec = {
|
|
|
74465
75017
|
'access_method.deleted',
|
|
74466
75018
|
'access_method.reissued',
|
|
74467
75019
|
'access_method.created',
|
|
75020
|
+
'access_method.delay_in_issuing',
|
|
75021
|
+
'access_method.failed_to_issue',
|
|
74468
75022
|
'acs_system.connected',
|
|
74469
75023
|
'acs_system.added',
|
|
74470
75024
|
'acs_system.disconnected',
|
|
@@ -74647,6 +75201,8 @@ const openapi: OpenAPISpec = {
|
|
|
74647
75201
|
'access_method.deleted',
|
|
74648
75202
|
'access_method.reissued',
|
|
74649
75203
|
'access_method.created',
|
|
75204
|
+
'access_method.delay_in_issuing',
|
|
75205
|
+
'access_method.failed_to_issue',
|
|
74650
75206
|
'acs_system.connected',
|
|
74651
75207
|
'acs_system.added',
|
|
74652
75208
|
'acs_system.disconnected',
|
|
@@ -74761,6 +75317,8 @@ const openapi: OpenAPISpec = {
|
|
|
74761
75317
|
'access_method.deleted',
|
|
74762
75318
|
'access_method.reissued',
|
|
74763
75319
|
'access_method.created',
|
|
75320
|
+
'access_method.delay_in_issuing',
|
|
75321
|
+
'access_method.failed_to_issue',
|
|
74764
75322
|
'acs_system.connected',
|
|
74765
75323
|
'acs_system.added',
|
|
74766
75324
|
'acs_system.disconnected',
|