@seamapi/types 1.418.1 → 1.420.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 +242 -1
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +436 -2
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +6 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +10 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +58 -0
- package/lib/seam/connect/models/devices/device.js +12 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +21 -0
- package/lib/seam/connect/models/events/access-grants.d.ts +0 -2
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/access-methods.d.ts +47 -0
- package/lib/seam/connect/models/events/access-methods.js +9 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +24 -1
- package/lib/seam/connect/openapi.d.ts +181 -0
- package/lib/seam/connect/openapi.js +222 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +171 -2
- package/package.json +2 -2
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +10 -0
- package/src/lib/seam/connect/models/devices/device.ts +13 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +0 -6
- package/src/lib/seam/connect/models/events/access-methods.ts +10 -0
- package/src/lib/seam/connect/openapi.ts +235 -0
- package/src/lib/seam/connect/route-types.ts +188 -0
|
@@ -397,6 +397,11 @@ declare const _default: {
|
|
|
397
397
|
description: string;
|
|
398
398
|
type: string;
|
|
399
399
|
};
|
|
400
|
+
ends_at: {
|
|
401
|
+
description: string;
|
|
402
|
+
format: string;
|
|
403
|
+
type: string;
|
|
404
|
+
};
|
|
400
405
|
location_ids: {
|
|
401
406
|
deprecated: boolean;
|
|
402
407
|
items: {
|
|
@@ -446,6 +451,11 @@ declare const _default: {
|
|
|
446
451
|
};
|
|
447
452
|
type: string;
|
|
448
453
|
};
|
|
454
|
+
starts_at: {
|
|
455
|
+
description: string;
|
|
456
|
+
format: string;
|
|
457
|
+
type: string;
|
|
458
|
+
};
|
|
449
459
|
user_identity_id: {
|
|
450
460
|
description: string;
|
|
451
461
|
format: string;
|
|
@@ -15615,6 +15625,177 @@ declare const _default: {
|
|
|
15615
15625
|
'x-title': string;
|
|
15616
15626
|
};
|
|
15617
15627
|
};
|
|
15628
|
+
'/access_grants/update': {
|
|
15629
|
+
patch: {
|
|
15630
|
+
description: string;
|
|
15631
|
+
operationId: string;
|
|
15632
|
+
requestBody: {
|
|
15633
|
+
content: {
|
|
15634
|
+
'application/json': {
|
|
15635
|
+
schema: {
|
|
15636
|
+
properties: {
|
|
15637
|
+
access_grant_id: {
|
|
15638
|
+
description: string;
|
|
15639
|
+
format: string;
|
|
15640
|
+
type: string;
|
|
15641
|
+
};
|
|
15642
|
+
ends_at: {
|
|
15643
|
+
description: string;
|
|
15644
|
+
format: string;
|
|
15645
|
+
nullable: boolean;
|
|
15646
|
+
type: string;
|
|
15647
|
+
};
|
|
15648
|
+
starts_at: {
|
|
15649
|
+
description: string;
|
|
15650
|
+
format: string;
|
|
15651
|
+
nullable: boolean;
|
|
15652
|
+
type: string;
|
|
15653
|
+
};
|
|
15654
|
+
};
|
|
15655
|
+
required: string[];
|
|
15656
|
+
type: string;
|
|
15657
|
+
};
|
|
15658
|
+
};
|
|
15659
|
+
};
|
|
15660
|
+
};
|
|
15661
|
+
responses: {
|
|
15662
|
+
200: {
|
|
15663
|
+
content: {
|
|
15664
|
+
'application/json': {
|
|
15665
|
+
schema: {
|
|
15666
|
+
properties: {
|
|
15667
|
+
ok: {
|
|
15668
|
+
type: string;
|
|
15669
|
+
};
|
|
15670
|
+
};
|
|
15671
|
+
required: string[];
|
|
15672
|
+
type: string;
|
|
15673
|
+
};
|
|
15674
|
+
};
|
|
15675
|
+
};
|
|
15676
|
+
description: string;
|
|
15677
|
+
};
|
|
15678
|
+
400: {
|
|
15679
|
+
description: string;
|
|
15680
|
+
};
|
|
15681
|
+
401: {
|
|
15682
|
+
description: string;
|
|
15683
|
+
};
|
|
15684
|
+
};
|
|
15685
|
+
security: ({
|
|
15686
|
+
pat_with_workspace: never[];
|
|
15687
|
+
console_session_with_workspace?: never;
|
|
15688
|
+
api_key?: never;
|
|
15689
|
+
client_session_with_customer?: never;
|
|
15690
|
+
} | {
|
|
15691
|
+
console_session_with_workspace: never[];
|
|
15692
|
+
pat_with_workspace?: never;
|
|
15693
|
+
api_key?: never;
|
|
15694
|
+
client_session_with_customer?: never;
|
|
15695
|
+
} | {
|
|
15696
|
+
api_key: never[];
|
|
15697
|
+
pat_with_workspace?: never;
|
|
15698
|
+
console_session_with_workspace?: never;
|
|
15699
|
+
client_session_with_customer?: never;
|
|
15700
|
+
} | {
|
|
15701
|
+
client_session_with_customer: never[];
|
|
15702
|
+
pat_with_workspace?: never;
|
|
15703
|
+
console_session_with_workspace?: never;
|
|
15704
|
+
api_key?: never;
|
|
15705
|
+
})[];
|
|
15706
|
+
summary: string;
|
|
15707
|
+
tags: never[];
|
|
15708
|
+
'x-draft': string;
|
|
15709
|
+
'x-fern-ignore': boolean;
|
|
15710
|
+
'x-response-key': null;
|
|
15711
|
+
'x-title': string;
|
|
15712
|
+
};
|
|
15713
|
+
post: {
|
|
15714
|
+
description: string;
|
|
15715
|
+
operationId: string;
|
|
15716
|
+
requestBody: {
|
|
15717
|
+
content: {
|
|
15718
|
+
'application/json': {
|
|
15719
|
+
schema: {
|
|
15720
|
+
properties: {
|
|
15721
|
+
access_grant_id: {
|
|
15722
|
+
description: string;
|
|
15723
|
+
format: string;
|
|
15724
|
+
type: string;
|
|
15725
|
+
};
|
|
15726
|
+
ends_at: {
|
|
15727
|
+
description: string;
|
|
15728
|
+
format: string;
|
|
15729
|
+
nullable: boolean;
|
|
15730
|
+
type: string;
|
|
15731
|
+
};
|
|
15732
|
+
starts_at: {
|
|
15733
|
+
description: string;
|
|
15734
|
+
format: string;
|
|
15735
|
+
nullable: boolean;
|
|
15736
|
+
type: string;
|
|
15737
|
+
};
|
|
15738
|
+
};
|
|
15739
|
+
required: string[];
|
|
15740
|
+
type: string;
|
|
15741
|
+
};
|
|
15742
|
+
};
|
|
15743
|
+
};
|
|
15744
|
+
};
|
|
15745
|
+
responses: {
|
|
15746
|
+
200: {
|
|
15747
|
+
content: {
|
|
15748
|
+
'application/json': {
|
|
15749
|
+
schema: {
|
|
15750
|
+
properties: {
|
|
15751
|
+
ok: {
|
|
15752
|
+
type: string;
|
|
15753
|
+
};
|
|
15754
|
+
};
|
|
15755
|
+
required: string[];
|
|
15756
|
+
type: string;
|
|
15757
|
+
};
|
|
15758
|
+
};
|
|
15759
|
+
};
|
|
15760
|
+
description: string;
|
|
15761
|
+
};
|
|
15762
|
+
400: {
|
|
15763
|
+
description: string;
|
|
15764
|
+
};
|
|
15765
|
+
401: {
|
|
15766
|
+
description: string;
|
|
15767
|
+
};
|
|
15768
|
+
};
|
|
15769
|
+
security: ({
|
|
15770
|
+
pat_with_workspace: never[];
|
|
15771
|
+
console_session_with_workspace?: never;
|
|
15772
|
+
api_key?: never;
|
|
15773
|
+
client_session_with_customer?: never;
|
|
15774
|
+
} | {
|
|
15775
|
+
console_session_with_workspace: never[];
|
|
15776
|
+
pat_with_workspace?: never;
|
|
15777
|
+
api_key?: never;
|
|
15778
|
+
client_session_with_customer?: never;
|
|
15779
|
+
} | {
|
|
15780
|
+
api_key: never[];
|
|
15781
|
+
pat_with_workspace?: never;
|
|
15782
|
+
console_session_with_workspace?: never;
|
|
15783
|
+
client_session_with_customer?: never;
|
|
15784
|
+
} | {
|
|
15785
|
+
client_session_with_customer: never[];
|
|
15786
|
+
pat_with_workspace?: never;
|
|
15787
|
+
console_session_with_workspace?: never;
|
|
15788
|
+
api_key?: never;
|
|
15789
|
+
})[];
|
|
15790
|
+
summary: string;
|
|
15791
|
+
tags: never[];
|
|
15792
|
+
'x-draft': string;
|
|
15793
|
+
'x-fern-sdk-group-name': string[];
|
|
15794
|
+
'x-fern-sdk-method-name': string;
|
|
15795
|
+
'x-response-key': null;
|
|
15796
|
+
'x-title': string;
|
|
15797
|
+
};
|
|
15798
|
+
};
|
|
15618
15799
|
'/access_methods/delete': {
|
|
15619
15800
|
post: {
|
|
15620
15801
|
description: string;
|
|
@@ -1589,6 +1589,11 @@ export default {
|
|
|
1589
1589
|
description: 'Display name of the access grant.',
|
|
1590
1590
|
type: 'string',
|
|
1591
1591
|
},
|
|
1592
|
+
ends_at: {
|
|
1593
|
+
description: 'Date and time at which the access grant ends.',
|
|
1594
|
+
format: 'date-time',
|
|
1595
|
+
type: 'string',
|
|
1596
|
+
},
|
|
1592
1597
|
location_ids: {
|
|
1593
1598
|
deprecated: true,
|
|
1594
1599
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -1634,6 +1639,11 @@ export default {
|
|
|
1634
1639
|
items: { format: 'uuid', type: 'string' },
|
|
1635
1640
|
type: 'array',
|
|
1636
1641
|
},
|
|
1642
|
+
starts_at: {
|
|
1643
|
+
description: 'Date and time at which the access grant starts.',
|
|
1644
|
+
format: 'date-time',
|
|
1645
|
+
type: 'string',
|
|
1646
|
+
},
|
|
1637
1647
|
user_identity_id: {
|
|
1638
1648
|
description: 'ID of user identity to which the access grant gives access.',
|
|
1639
1649
|
format: 'uuid',
|
|
@@ -11042,6 +11052,28 @@ export default {
|
|
|
11042
11052
|
required: ['message', 'created_at', 'warning_code'],
|
|
11043
11053
|
type: 'object',
|
|
11044
11054
|
},
|
|
11055
|
+
{
|
|
11056
|
+
description: 'Indicates that the device is in power saving mode and may have limited functionality.',
|
|
11057
|
+
properties: {
|
|
11058
|
+
created_at: {
|
|
11059
|
+
description: 'Date and time at which Seam created the warning.',
|
|
11060
|
+
format: 'date-time',
|
|
11061
|
+
type: 'string',
|
|
11062
|
+
},
|
|
11063
|
+
message: {
|
|
11064
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
11065
|
+
type: 'string',
|
|
11066
|
+
},
|
|
11067
|
+
warning_code: {
|
|
11068
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11069
|
+
enum: ['power_saving_mode'],
|
|
11070
|
+
type: 'string',
|
|
11071
|
+
},
|
|
11072
|
+
},
|
|
11073
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
11074
|
+
type: 'object',
|
|
11075
|
+
'x-variant-group-key': 'locks',
|
|
11076
|
+
},
|
|
11045
11077
|
{
|
|
11046
11078
|
description: 'Indicates that the temperature threshold has been exceeded.',
|
|
11047
11079
|
properties: {
|
|
@@ -12766,6 +12798,47 @@ export default {
|
|
|
12766
12798
|
type: 'object',
|
|
12767
12799
|
'x-route-path': '/access_methods',
|
|
12768
12800
|
},
|
|
12801
|
+
{
|
|
12802
|
+
description: 'An access method was reissued due to an access grant update.',
|
|
12803
|
+
properties: {
|
|
12804
|
+
access_method_id: {
|
|
12805
|
+
description: 'ID of the affected access method.',
|
|
12806
|
+
format: 'uuid',
|
|
12807
|
+
type: 'string',
|
|
12808
|
+
},
|
|
12809
|
+
created_at: {
|
|
12810
|
+
description: 'Date and time at which the event was created.',
|
|
12811
|
+
format: 'date-time',
|
|
12812
|
+
type: 'string',
|
|
12813
|
+
},
|
|
12814
|
+
event_id: {
|
|
12815
|
+
description: 'ID of the event.',
|
|
12816
|
+
format: 'uuid',
|
|
12817
|
+
type: 'string',
|
|
12818
|
+
},
|
|
12819
|
+
event_type: { enum: ['access_method.reissued'], type: 'string' },
|
|
12820
|
+
occurred_at: {
|
|
12821
|
+
description: 'Date and time at which the event occurred.',
|
|
12822
|
+
format: 'date-time',
|
|
12823
|
+
type: 'string',
|
|
12824
|
+
},
|
|
12825
|
+
workspace_id: {
|
|
12826
|
+
description: 'ID of the workspace associated with the event.',
|
|
12827
|
+
format: 'uuid',
|
|
12828
|
+
type: 'string',
|
|
12829
|
+
},
|
|
12830
|
+
},
|
|
12831
|
+
required: [
|
|
12832
|
+
'event_id',
|
|
12833
|
+
'workspace_id',
|
|
12834
|
+
'created_at',
|
|
12835
|
+
'occurred_at',
|
|
12836
|
+
'access_method_id',
|
|
12837
|
+
'event_type',
|
|
12838
|
+
],
|
|
12839
|
+
type: 'object',
|
|
12840
|
+
'x-route-path': '/access_methods',
|
|
12841
|
+
},
|
|
12769
12842
|
{
|
|
12770
12843
|
description: 'An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
|
|
12771
12844
|
properties: {
|
|
@@ -20974,6 +21047,28 @@ export default {
|
|
|
20974
21047
|
required: ['message', 'created_at', 'warning_code'],
|
|
20975
21048
|
type: 'object',
|
|
20976
21049
|
},
|
|
21050
|
+
{
|
|
21051
|
+
description: 'Indicates that the device is in power saving mode and may have limited functionality.',
|
|
21052
|
+
properties: {
|
|
21053
|
+
created_at: {
|
|
21054
|
+
description: 'Date and time at which Seam created the warning.',
|
|
21055
|
+
format: 'date-time',
|
|
21056
|
+
type: 'string',
|
|
21057
|
+
},
|
|
21058
|
+
message: {
|
|
21059
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
21060
|
+
type: 'string',
|
|
21061
|
+
},
|
|
21062
|
+
warning_code: {
|
|
21063
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
21064
|
+
enum: ['power_saving_mode'],
|
|
21065
|
+
type: 'string',
|
|
21066
|
+
},
|
|
21067
|
+
},
|
|
21068
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
21069
|
+
type: 'object',
|
|
21070
|
+
'x-variant-group-key': 'locks',
|
|
21071
|
+
},
|
|
20977
21072
|
{
|
|
20978
21073
|
description: 'Indicates that the temperature threshold has been exceeded.',
|
|
20979
21074
|
properties: {
|
|
@@ -23642,6 +23737,131 @@ export default {
|
|
|
23642
23737
|
'x-title': 'List Access Grants',
|
|
23643
23738
|
},
|
|
23644
23739
|
},
|
|
23740
|
+
'/access_grants/update': {
|
|
23741
|
+
patch: {
|
|
23742
|
+
description: "Updates an existing access grant's time window.",
|
|
23743
|
+
operationId: 'accessGrantsUpdatePatch',
|
|
23744
|
+
requestBody: {
|
|
23745
|
+
content: {
|
|
23746
|
+
'application/json': {
|
|
23747
|
+
schema: {
|
|
23748
|
+
properties: {
|
|
23749
|
+
access_grant_id: {
|
|
23750
|
+
description: 'ID of the access grant to update.',
|
|
23751
|
+
format: 'uuid',
|
|
23752
|
+
type: 'string',
|
|
23753
|
+
},
|
|
23754
|
+
ends_at: {
|
|
23755
|
+
description: 'Date and time at which the validity of the grant 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`.',
|
|
23756
|
+
format: 'date-time',
|
|
23757
|
+
nullable: true,
|
|
23758
|
+
type: 'string',
|
|
23759
|
+
},
|
|
23760
|
+
starts_at: {
|
|
23761
|
+
description: 'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
23762
|
+
format: 'date-time',
|
|
23763
|
+
nullable: true,
|
|
23764
|
+
type: 'string',
|
|
23765
|
+
},
|
|
23766
|
+
},
|
|
23767
|
+
required: ['access_grant_id'],
|
|
23768
|
+
type: 'object',
|
|
23769
|
+
},
|
|
23770
|
+
},
|
|
23771
|
+
},
|
|
23772
|
+
},
|
|
23773
|
+
responses: {
|
|
23774
|
+
200: {
|
|
23775
|
+
content: {
|
|
23776
|
+
'application/json': {
|
|
23777
|
+
schema: {
|
|
23778
|
+
properties: { ok: { type: 'boolean' } },
|
|
23779
|
+
required: ['ok'],
|
|
23780
|
+
type: 'object',
|
|
23781
|
+
},
|
|
23782
|
+
},
|
|
23783
|
+
},
|
|
23784
|
+
description: 'OK',
|
|
23785
|
+
},
|
|
23786
|
+
400: { description: 'Bad Request' },
|
|
23787
|
+
401: { description: 'Unauthorized' },
|
|
23788
|
+
},
|
|
23789
|
+
security: [
|
|
23790
|
+
{ pat_with_workspace: [] },
|
|
23791
|
+
{ console_session_with_workspace: [] },
|
|
23792
|
+
{ api_key: [] },
|
|
23793
|
+
{ client_session_with_customer: [] },
|
|
23794
|
+
],
|
|
23795
|
+
summary: '/access_grants/update',
|
|
23796
|
+
tags: [],
|
|
23797
|
+
'x-draft': 'Early access.',
|
|
23798
|
+
'x-fern-ignore': true,
|
|
23799
|
+
'x-response-key': null,
|
|
23800
|
+
'x-title': 'Update an Access Grant',
|
|
23801
|
+
},
|
|
23802
|
+
post: {
|
|
23803
|
+
description: "Updates an existing access grant's time window.",
|
|
23804
|
+
operationId: 'accessGrantsUpdatePost',
|
|
23805
|
+
requestBody: {
|
|
23806
|
+
content: {
|
|
23807
|
+
'application/json': {
|
|
23808
|
+
schema: {
|
|
23809
|
+
properties: {
|
|
23810
|
+
access_grant_id: {
|
|
23811
|
+
description: 'ID of the access grant to update.',
|
|
23812
|
+
format: 'uuid',
|
|
23813
|
+
type: 'string',
|
|
23814
|
+
},
|
|
23815
|
+
ends_at: {
|
|
23816
|
+
description: 'Date and time at which the validity of the grant 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`.',
|
|
23817
|
+
format: 'date-time',
|
|
23818
|
+
nullable: true,
|
|
23819
|
+
type: 'string',
|
|
23820
|
+
},
|
|
23821
|
+
starts_at: {
|
|
23822
|
+
description: 'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
23823
|
+
format: 'date-time',
|
|
23824
|
+
nullable: true,
|
|
23825
|
+
type: 'string',
|
|
23826
|
+
},
|
|
23827
|
+
},
|
|
23828
|
+
required: ['access_grant_id'],
|
|
23829
|
+
type: 'object',
|
|
23830
|
+
},
|
|
23831
|
+
},
|
|
23832
|
+
},
|
|
23833
|
+
},
|
|
23834
|
+
responses: {
|
|
23835
|
+
200: {
|
|
23836
|
+
content: {
|
|
23837
|
+
'application/json': {
|
|
23838
|
+
schema: {
|
|
23839
|
+
properties: { ok: { type: 'boolean' } },
|
|
23840
|
+
required: ['ok'],
|
|
23841
|
+
type: 'object',
|
|
23842
|
+
},
|
|
23843
|
+
},
|
|
23844
|
+
},
|
|
23845
|
+
description: 'OK',
|
|
23846
|
+
},
|
|
23847
|
+
400: { description: 'Bad Request' },
|
|
23848
|
+
401: { description: 'Unauthorized' },
|
|
23849
|
+
},
|
|
23850
|
+
security: [
|
|
23851
|
+
{ pat_with_workspace: [] },
|
|
23852
|
+
{ console_session_with_workspace: [] },
|
|
23853
|
+
{ api_key: [] },
|
|
23854
|
+
{ client_session_with_customer: [] },
|
|
23855
|
+
],
|
|
23856
|
+
summary: '/access_grants/update',
|
|
23857
|
+
tags: [],
|
|
23858
|
+
'x-draft': 'Early access.',
|
|
23859
|
+
'x-fern-sdk-group-name': ['access_grants'],
|
|
23860
|
+
'x-fern-sdk-method-name': 'update',
|
|
23861
|
+
'x-response-key': null,
|
|
23862
|
+
'x-title': 'Update an Access Grant',
|
|
23863
|
+
},
|
|
23864
|
+
},
|
|
23645
23865
|
'/access_methods/delete': {
|
|
23646
23866
|
post: {
|
|
23647
23867
|
description: 'Delete an access method.',
|
|
@@ -30766,6 +30986,7 @@ export default {
|
|
|
30766
30986
|
'access_method.revoked',
|
|
30767
30987
|
'access_method.card_encoding_required',
|
|
30768
30988
|
'access_method.deleted',
|
|
30989
|
+
'access_method.reissued',
|
|
30769
30990
|
'acs_system.connected',
|
|
30770
30991
|
'acs_system.added',
|
|
30771
30992
|
'acs_system.disconnected',
|
|
@@ -30862,6 +31083,7 @@ export default {
|
|
|
30862
31083
|
'access_method.revoked',
|
|
30863
31084
|
'access_method.card_encoding_required',
|
|
30864
31085
|
'access_method.deleted',
|
|
31086
|
+
'access_method.reissued',
|
|
30865
31087
|
'acs_system.connected',
|
|
30866
31088
|
'acs_system.added',
|
|
30867
31089
|
'acs_system.disconnected',
|