@seamapi/types 1.749.0 → 1.751.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 +114 -48
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1979 -614
- package/dist/index.cjs +114 -48
- package/dist/index.cjs.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 +5 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
- package/lib/seam/connect/openapi.d.ts +121 -63
- package/lib/seam/connect/openapi.js +111 -48
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1304 -5
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +118 -48
- package/src/lib/seam/connect/route-types.ts +1507 -5
package/package.json
CHANGED
|
@@ -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
|
|
@@ -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.',
|
|
@@ -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:
|
|
@@ -61253,8 +61327,18 @@ export default {
|
|
|
61253
61327
|
'/seam/customer/v1/automations/get': {
|
|
61254
61328
|
get: {
|
|
61255
61329
|
description:
|
|
61256
|
-
'Gets the current automation configuration for a customer portal workspace.\
|
|
61330
|
+
'Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
|
|
61257
61331
|
operationId: 'seamCustomerV1AutomationsGetGet',
|
|
61332
|
+
parameters: [
|
|
61333
|
+
{
|
|
61334
|
+
in: 'query',
|
|
61335
|
+
name: 'customer_key',
|
|
61336
|
+
schema: {
|
|
61337
|
+
description: 'Key of the customer to get automation config for.',
|
|
61338
|
+
type: 'string',
|
|
61339
|
+
},
|
|
61340
|
+
},
|
|
61341
|
+
],
|
|
61258
61342
|
responses: {
|
|
61259
61343
|
200: {
|
|
61260
61344
|
content: {
|
|
@@ -61524,11 +61608,7 @@ export default {
|
|
|
61524
61608
|
400: { description: 'Bad Request' },
|
|
61525
61609
|
401: { description: 'Unauthorized' },
|
|
61526
61610
|
},
|
|
61527
|
-
security: [
|
|
61528
|
-
{ console_session_with_workspace: [] },
|
|
61529
|
-
{ api_key: [] },
|
|
61530
|
-
{ client_session_with_customer: [] },
|
|
61531
|
-
],
|
|
61611
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
61532
61612
|
summary: '/seam/customer/v1/automations/get',
|
|
61533
61613
|
tags: [],
|
|
61534
61614
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
@@ -61539,8 +61619,24 @@ export default {
|
|
|
61539
61619
|
},
|
|
61540
61620
|
post: {
|
|
61541
61621
|
description:
|
|
61542
|
-
'Gets the current automation configuration for a customer portal workspace.\
|
|
61622
|
+
'Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
|
|
61543
61623
|
operationId: 'seamCustomerV1AutomationsGetPost',
|
|
61624
|
+
requestBody: {
|
|
61625
|
+
content: {
|
|
61626
|
+
'application/json': {
|
|
61627
|
+
schema: {
|
|
61628
|
+
properties: {
|
|
61629
|
+
customer_key: {
|
|
61630
|
+
description:
|
|
61631
|
+
'Key of the customer to get automation config for.',
|
|
61632
|
+
type: 'string',
|
|
61633
|
+
},
|
|
61634
|
+
},
|
|
61635
|
+
type: 'object',
|
|
61636
|
+
},
|
|
61637
|
+
},
|
|
61638
|
+
},
|
|
61639
|
+
},
|
|
61544
61640
|
responses: {
|
|
61545
61641
|
200: {
|
|
61546
61642
|
content: {
|
|
@@ -61810,11 +61906,7 @@ export default {
|
|
|
61810
61906
|
400: { description: 'Bad Request' },
|
|
61811
61907
|
401: { description: 'Unauthorized' },
|
|
61812
61908
|
},
|
|
61813
|
-
security: [
|
|
61814
|
-
{ console_session_with_workspace: [] },
|
|
61815
|
-
{ api_key: [] },
|
|
61816
|
-
{ client_session_with_customer: [] },
|
|
61817
|
-
],
|
|
61909
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
61818
61910
|
summary: '/seam/customer/v1/automations/get',
|
|
61819
61911
|
tags: [],
|
|
61820
61912
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
@@ -62074,6 +62166,11 @@ export default {
|
|
|
62074
62166
|
},
|
|
62075
62167
|
type: 'object',
|
|
62076
62168
|
},
|
|
62169
|
+
customer_key: {
|
|
62170
|
+
description:
|
|
62171
|
+
'Key of the customer to update automation config for.',
|
|
62172
|
+
type: 'string',
|
|
62173
|
+
},
|
|
62077
62174
|
},
|
|
62078
62175
|
type: 'object',
|
|
62079
62176
|
},
|
|
@@ -62354,6 +62451,11 @@ export default {
|
|
|
62354
62451
|
},
|
|
62355
62452
|
type: 'object',
|
|
62356
62453
|
},
|
|
62454
|
+
customer_key: {
|
|
62455
|
+
description:
|
|
62456
|
+
'Key of the customer to update automation config for.',
|
|
62457
|
+
type: 'string',
|
|
62458
|
+
},
|
|
62357
62459
|
},
|
|
62358
62460
|
type: 'object',
|
|
62359
62461
|
},
|
|
@@ -63360,16 +63462,8 @@ export default {
|
|
|
63360
63462
|
'/seam/customer/v1/customers/automations/get': {
|
|
63361
63463
|
get: {
|
|
63362
63464
|
description:
|
|
63363
|
-
'Gets the automation configuration for
|
|
63465
|
+
'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
63364
63466
|
operationId: 'seamCustomerV1CustomersAutomationsGetGet',
|
|
63365
|
-
parameters: [
|
|
63366
|
-
{
|
|
63367
|
-
in: 'query',
|
|
63368
|
-
name: 'customer_key',
|
|
63369
|
-
required: true,
|
|
63370
|
-
schema: { description: 'Key of the customer.', type: 'string' },
|
|
63371
|
-
},
|
|
63372
|
-
],
|
|
63373
63467
|
responses: {
|
|
63374
63468
|
200: {
|
|
63375
63469
|
content: {
|
|
@@ -63648,11 +63742,7 @@ export default {
|
|
|
63648
63742
|
400: { description: 'Bad Request' },
|
|
63649
63743
|
401: { description: 'Unauthorized' },
|
|
63650
63744
|
},
|
|
63651
|
-
security: [
|
|
63652
|
-
{ pat_with_workspace: [] },
|
|
63653
|
-
{ console_session_with_workspace: [] },
|
|
63654
|
-
{ api_key: [] },
|
|
63655
|
-
],
|
|
63745
|
+
security: [{ client_session_with_customer: [] }],
|
|
63656
63746
|
summary: '/seam/customer/v1/customers/automations/get',
|
|
63657
63747
|
tags: [],
|
|
63658
63748
|
'x-fern-sdk-group-name': [
|
|
@@ -63669,24 +63759,8 @@ export default {
|
|
|
63669
63759
|
},
|
|
63670
63760
|
post: {
|
|
63671
63761
|
description:
|
|
63672
|
-
'Gets the automation configuration for
|
|
63762
|
+
'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
63673
63763
|
operationId: 'seamCustomerV1CustomersAutomationsGetPost',
|
|
63674
|
-
requestBody: {
|
|
63675
|
-
content: {
|
|
63676
|
-
'application/json': {
|
|
63677
|
-
schema: {
|
|
63678
|
-
properties: {
|
|
63679
|
-
customer_key: {
|
|
63680
|
-
description: 'Key of the customer.',
|
|
63681
|
-
type: 'string',
|
|
63682
|
-
},
|
|
63683
|
-
},
|
|
63684
|
-
required: ['customer_key'],
|
|
63685
|
-
type: 'object',
|
|
63686
|
-
},
|
|
63687
|
-
},
|
|
63688
|
-
},
|
|
63689
|
-
},
|
|
63690
63764
|
responses: {
|
|
63691
63765
|
200: {
|
|
63692
63766
|
content: {
|
|
@@ -63965,11 +64039,7 @@ export default {
|
|
|
63965
64039
|
400: { description: 'Bad Request' },
|
|
63966
64040
|
401: { description: 'Unauthorized' },
|
|
63967
64041
|
},
|
|
63968
|
-
security: [
|
|
63969
|
-
{ pat_with_workspace: [] },
|
|
63970
|
-
{ console_session_with_workspace: [] },
|
|
63971
|
-
{ api_key: [] },
|
|
63972
|
-
],
|
|
64042
|
+
security: [{ client_session_with_customer: [] }],
|
|
63973
64043
|
summary: '/seam/customer/v1/customers/automations/get',
|
|
63974
64044
|
tags: [],
|
|
63975
64045
|
'x-fern-sdk-group-name': [
|