@seamapi/types 1.750.0 → 1.752.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 +126 -53
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2351 -962
- package/dist/index.cjs +126 -53
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +42 -42
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.d.ts +37 -37
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js +9 -9
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +63 -58
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
- package/lib/seam/connect/openapi.d.ts +84 -0
- package/lib/seam/connect/openapi.js +112 -42
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1606 -309
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts +14 -14
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +122 -48
- package/src/lib/seam/connect/route-types.ts +1754 -254
package/package.json
CHANGED
|
@@ -135,6 +135,18 @@ const updating_entrance_membership = common_pending_mutation
|
|
|
135
135
|
'Seam is in the process of pushing an entrance membership update to the integrated access system.',
|
|
136
136
|
)
|
|
137
137
|
|
|
138
|
+
const deferring_deletion = common_pending_mutation
|
|
139
|
+
.extend({
|
|
140
|
+
mutation_code: z
|
|
141
|
+
.literal('deferring_deletion')
|
|
142
|
+
.describe(
|
|
143
|
+
'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.',
|
|
144
|
+
),
|
|
145
|
+
})
|
|
146
|
+
.describe(
|
|
147
|
+
'This access group is scheduled for automatic deletion when its access window expires.',
|
|
148
|
+
)
|
|
149
|
+
|
|
138
150
|
const deferring_user_membership_update = common_pending_mutation
|
|
139
151
|
.extend({
|
|
140
152
|
mutation_code: z
|
|
@@ -156,29 +168,17 @@ const deferring_user_membership_update = common_pending_mutation
|
|
|
156
168
|
'A scheduled user membership change is pending for this access group.',
|
|
157
169
|
)
|
|
158
170
|
|
|
159
|
-
const deferring_deletion = common_pending_mutation
|
|
160
|
-
.extend({
|
|
161
|
-
mutation_code: z
|
|
162
|
-
.literal('deferring_deletion')
|
|
163
|
-
.describe(
|
|
164
|
-
'Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes.',
|
|
165
|
-
),
|
|
166
|
-
})
|
|
167
|
-
.describe(
|
|
168
|
-
'This access group is scheduled for automatic deletion when its access window expires.',
|
|
169
|
-
)
|
|
170
|
-
|
|
171
171
|
export const acs_access_group_pending_mutations = z.discriminatedUnion(
|
|
172
172
|
'mutation_code',
|
|
173
173
|
[
|
|
174
174
|
creating,
|
|
175
175
|
deleting,
|
|
176
|
+
deferring_deletion,
|
|
176
177
|
updating_group_information,
|
|
177
178
|
updating_access_schedule,
|
|
178
179
|
updating_user_membership,
|
|
179
180
|
updating_entrance_membership,
|
|
180
181
|
deferring_user_membership_update,
|
|
181
|
-
deferring_deletion,
|
|
182
182
|
],
|
|
183
183
|
)
|
|
184
184
|
|
|
@@ -189,6 +189,7 @@ export type AcsAccessGroupPendingMutation = z.infer<
|
|
|
189
189
|
const _acs_access_group_pending_mutations_map = z.object({
|
|
190
190
|
creating: creating.optional().nullable(),
|
|
191
191
|
deleting: deleting.optional().nullable(),
|
|
192
|
+
deferring_deletion: deferring_deletion.optional().nullable(),
|
|
192
193
|
updating_name: updating_group_information.optional().nullable(),
|
|
193
194
|
updating_access_schedule: updating_access_schedule.optional().nullable(),
|
|
194
195
|
updating_user_membership: z
|
|
@@ -203,7 +204,6 @@ const _acs_access_group_pending_mutations_map = z.object({
|
|
|
203
204
|
.record(z.string().uuid(), deferring_user_membership_update)
|
|
204
205
|
.optional()
|
|
205
206
|
.nullable(),
|
|
206
|
-
deferring_deletion: deferring_deletion.optional().nullable(),
|
|
207
207
|
})
|
|
208
208
|
|
|
209
209
|
export type AcsAccessGroupPendingMutationsMap = z.infer<
|
|
@@ -37,6 +37,12 @@ export const acs_entrance_capability_flags = z.object({
|
|
|
37
37
|
.describe(
|
|
38
38
|
'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
|
|
39
39
|
),
|
|
40
|
+
can_unlock_with_cloud_key: z
|
|
41
|
+
.boolean()
|
|
42
|
+
.optional()
|
|
43
|
+
.describe(
|
|
44
|
+
'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
|
|
45
|
+
),
|
|
40
46
|
})
|
|
41
47
|
|
|
42
48
|
export const acs_entrance = z
|
|
@@ -2853,6 +2853,30 @@ export default {
|
|
|
2853
2853
|
required: ['created_at', 'message', 'mutation_code'],
|
|
2854
2854
|
type: 'object',
|
|
2855
2855
|
},
|
|
2856
|
+
{
|
|
2857
|
+
description:
|
|
2858
|
+
'This access group is scheduled for automatic deletion when its access window expires.',
|
|
2859
|
+
properties: {
|
|
2860
|
+
created_at: {
|
|
2861
|
+
description:
|
|
2862
|
+
'Date and time at which the mutation was created.',
|
|
2863
|
+
format: 'date-time',
|
|
2864
|
+
type: 'string',
|
|
2865
|
+
},
|
|
2866
|
+
message: {
|
|
2867
|
+
description: 'Detailed description of the mutation.',
|
|
2868
|
+
type: 'string',
|
|
2869
|
+
},
|
|
2870
|
+
mutation_code: {
|
|
2871
|
+
description:
|
|
2872
|
+
'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.',
|
|
2873
|
+
enum: ['deferring_deletion'],
|
|
2874
|
+
type: 'string',
|
|
2875
|
+
},
|
|
2876
|
+
},
|
|
2877
|
+
required: ['created_at', 'message', 'mutation_code'],
|
|
2878
|
+
type: 'object',
|
|
2879
|
+
},
|
|
2856
2880
|
{
|
|
2857
2881
|
description:
|
|
2858
2882
|
'Seam is in the process of pushing an access group information update to the integrated access system.',
|
|
@@ -3127,30 +3151,6 @@ export default {
|
|
|
3127
3151
|
],
|
|
3128
3152
|
type: 'object',
|
|
3129
3153
|
},
|
|
3130
|
-
{
|
|
3131
|
-
description:
|
|
3132
|
-
'This access group is scheduled for automatic deletion when its access window expires.',
|
|
3133
|
-
properties: {
|
|
3134
|
-
created_at: {
|
|
3135
|
-
description:
|
|
3136
|
-
'Date and time at which the mutation was created.',
|
|
3137
|
-
format: 'date-time',
|
|
3138
|
-
type: 'string',
|
|
3139
|
-
},
|
|
3140
|
-
message: {
|
|
3141
|
-
description: 'Detailed description of the mutation.',
|
|
3142
|
-
type: 'string',
|
|
3143
|
-
},
|
|
3144
|
-
mutation_code: {
|
|
3145
|
-
description:
|
|
3146
|
-
'Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes.',
|
|
3147
|
-
enum: ['deferring_deletion'],
|
|
3148
|
-
type: 'string',
|
|
3149
|
-
},
|
|
3150
|
-
},
|
|
3151
|
-
required: ['created_at', 'message', 'mutation_code'],
|
|
3152
|
-
type: 'object',
|
|
3153
|
-
},
|
|
3154
3154
|
],
|
|
3155
3155
|
},
|
|
3156
3156
|
type: 'array',
|
|
@@ -3874,6 +3874,11 @@ export default {
|
|
|
3874
3874
|
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
3875
3875
|
type: 'boolean',
|
|
3876
3876
|
},
|
|
3877
|
+
can_unlock_with_cloud_key: {
|
|
3878
|
+
description:
|
|
3879
|
+
'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
|
|
3880
|
+
type: 'boolean',
|
|
3881
|
+
},
|
|
3877
3882
|
can_unlock_with_code: {
|
|
3878
3883
|
description:
|
|
3879
3884
|
'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
@@ -24094,6 +24099,11 @@ export default {
|
|
|
24094
24099
|
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
24095
24100
|
type: 'boolean',
|
|
24096
24101
|
},
|
|
24102
|
+
can_unlock_with_cloud_key: {
|
|
24103
|
+
description:
|
|
24104
|
+
'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
|
|
24105
|
+
type: 'boolean',
|
|
24106
|
+
},
|
|
24097
24107
|
can_unlock_with_code: {
|
|
24098
24108
|
description:
|
|
24099
24109
|
'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
@@ -27241,6 +27251,30 @@ export default {
|
|
|
27241
27251
|
required: ['created_at', 'message', 'mutation_code'],
|
|
27242
27252
|
type: 'object',
|
|
27243
27253
|
},
|
|
27254
|
+
{
|
|
27255
|
+
description:
|
|
27256
|
+
'This access group is scheduled for automatic deletion when its access window expires.',
|
|
27257
|
+
properties: {
|
|
27258
|
+
created_at: {
|
|
27259
|
+
description:
|
|
27260
|
+
'Date and time at which the mutation was created.',
|
|
27261
|
+
format: 'date-time',
|
|
27262
|
+
type: 'string',
|
|
27263
|
+
},
|
|
27264
|
+
message: {
|
|
27265
|
+
description: 'Detailed description of the mutation.',
|
|
27266
|
+
type: 'string',
|
|
27267
|
+
},
|
|
27268
|
+
mutation_code: {
|
|
27269
|
+
description:
|
|
27270
|
+
'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.',
|
|
27271
|
+
enum: ['deferring_deletion'],
|
|
27272
|
+
type: 'string',
|
|
27273
|
+
},
|
|
27274
|
+
},
|
|
27275
|
+
required: ['created_at', 'message', 'mutation_code'],
|
|
27276
|
+
type: 'object',
|
|
27277
|
+
},
|
|
27244
27278
|
{
|
|
27245
27279
|
description:
|
|
27246
27280
|
'Seam is in the process of pushing an access group information update to the integrated access system.',
|
|
@@ -27515,30 +27549,6 @@ export default {
|
|
|
27515
27549
|
],
|
|
27516
27550
|
type: 'object',
|
|
27517
27551
|
},
|
|
27518
|
-
{
|
|
27519
|
-
description:
|
|
27520
|
-
'This access group is scheduled for automatic deletion when its access window expires.',
|
|
27521
|
-
properties: {
|
|
27522
|
-
created_at: {
|
|
27523
|
-
description:
|
|
27524
|
-
'Date and time at which the mutation was created.',
|
|
27525
|
-
format: 'date-time',
|
|
27526
|
-
type: 'string',
|
|
27527
|
-
},
|
|
27528
|
-
message: {
|
|
27529
|
-
description: 'Detailed description of the mutation.',
|
|
27530
|
-
type: 'string',
|
|
27531
|
-
},
|
|
27532
|
-
mutation_code: {
|
|
27533
|
-
description:
|
|
27534
|
-
'Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes.',
|
|
27535
|
-
enum: ['deferring_deletion'],
|
|
27536
|
-
type: 'string',
|
|
27537
|
-
},
|
|
27538
|
-
},
|
|
27539
|
-
required: ['created_at', 'message', 'mutation_code'],
|
|
27540
|
-
type: 'object',
|
|
27541
|
-
},
|
|
27542
27552
|
],
|
|
27543
27553
|
},
|
|
27544
27554
|
type: 'array',
|
|
@@ -44201,6 +44211,70 @@ export default {
|
|
|
44201
44211
|
'x-title': 'List Credentials with Access to an Entrance',
|
|
44202
44212
|
},
|
|
44203
44213
|
},
|
|
44214
|
+
'/acs/entrances/unlock': {
|
|
44215
|
+
post: {
|
|
44216
|
+
description:
|
|
44217
|
+
'Remotely unlocks a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.',
|
|
44218
|
+
operationId: 'acsEntrancesUnlockPost',
|
|
44219
|
+
requestBody: {
|
|
44220
|
+
content: {
|
|
44221
|
+
'application/json': {
|
|
44222
|
+
schema: {
|
|
44223
|
+
properties: {
|
|
44224
|
+
acs_credential_id: {
|
|
44225
|
+
description:
|
|
44226
|
+
'ID of the cloud_key credential to use for the unlock operation.',
|
|
44227
|
+
format: 'uuid',
|
|
44228
|
+
type: 'string',
|
|
44229
|
+
},
|
|
44230
|
+
acs_entrance_id: {
|
|
44231
|
+
description: 'ID of the entrance to unlock.',
|
|
44232
|
+
format: 'uuid',
|
|
44233
|
+
type: 'string',
|
|
44234
|
+
},
|
|
44235
|
+
},
|
|
44236
|
+
required: ['acs_entrance_id', 'acs_credential_id'],
|
|
44237
|
+
type: 'object',
|
|
44238
|
+
},
|
|
44239
|
+
},
|
|
44240
|
+
},
|
|
44241
|
+
},
|
|
44242
|
+
responses: {
|
|
44243
|
+
200: {
|
|
44244
|
+
content: {
|
|
44245
|
+
'application/json': {
|
|
44246
|
+
schema: {
|
|
44247
|
+
properties: {
|
|
44248
|
+
action_attempt: {
|
|
44249
|
+
$ref: '#/components/schemas/action_attempt',
|
|
44250
|
+
},
|
|
44251
|
+
ok: { type: 'boolean' },
|
|
44252
|
+
},
|
|
44253
|
+
required: ['action_attempt', 'ok'],
|
|
44254
|
+
type: 'object',
|
|
44255
|
+
},
|
|
44256
|
+
},
|
|
44257
|
+
},
|
|
44258
|
+
description: 'OK',
|
|
44259
|
+
},
|
|
44260
|
+
400: { description: 'Bad Request' },
|
|
44261
|
+
401: { description: 'Unauthorized' },
|
|
44262
|
+
},
|
|
44263
|
+
security: [
|
|
44264
|
+
{ pat_with_workspace: [] },
|
|
44265
|
+
{ console_session_with_workspace: [] },
|
|
44266
|
+
{ api_key: [] },
|
|
44267
|
+
],
|
|
44268
|
+
summary: '/acs/entrances/unlock',
|
|
44269
|
+
tags: ['/acs'],
|
|
44270
|
+
'x-action-attempt-type': 'UNLOCK_DOOR',
|
|
44271
|
+
'x-fern-sdk-group-name': ['acs', 'entrances'],
|
|
44272
|
+
'x-fern-sdk-method-name': 'unlock',
|
|
44273
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
44274
|
+
'x-response-key': 'action_attempt',
|
|
44275
|
+
'x-title': 'Unlock an Entrance',
|
|
44276
|
+
},
|
|
44277
|
+
},
|
|
44204
44278
|
'/acs/systems/get': {
|
|
44205
44279
|
get: {
|
|
44206
44280
|
description:
|