@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
|
@@ -3405,6 +3405,10 @@ export default {
|
|
|
3405
3405
|
description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
3406
3406
|
type: 'boolean',
|
|
3407
3407
|
},
|
|
3408
|
+
can_unlock_with_cloud_key: {
|
|
3409
|
+
description: 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
|
|
3410
|
+
type: 'boolean',
|
|
3411
|
+
},
|
|
3408
3412
|
can_unlock_with_code: {
|
|
3409
3413
|
description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
3410
3414
|
type: 'boolean',
|
|
@@ -21685,6 +21689,10 @@ export default {
|
|
|
21685
21689
|
description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
21686
21690
|
type: 'boolean',
|
|
21687
21691
|
},
|
|
21692
|
+
can_unlock_with_cloud_key: {
|
|
21693
|
+
description: 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
|
|
21694
|
+
type: 'boolean',
|
|
21695
|
+
},
|
|
21688
21696
|
can_unlock_with_code: {
|
|
21689
21697
|
description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
21690
21698
|
type: 'boolean',
|
|
@@ -39998,6 +40006,68 @@ export default {
|
|
|
39998
40006
|
'x-title': 'List Credentials with Access to an Entrance',
|
|
39999
40007
|
},
|
|
40000
40008
|
},
|
|
40009
|
+
'/acs/entrances/unlock': {
|
|
40010
|
+
post: {
|
|
40011
|
+
description: '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.',
|
|
40012
|
+
operationId: 'acsEntrancesUnlockPost',
|
|
40013
|
+
requestBody: {
|
|
40014
|
+
content: {
|
|
40015
|
+
'application/json': {
|
|
40016
|
+
schema: {
|
|
40017
|
+
properties: {
|
|
40018
|
+
acs_credential_id: {
|
|
40019
|
+
description: 'ID of the cloud_key credential to use for the unlock operation.',
|
|
40020
|
+
format: 'uuid',
|
|
40021
|
+
type: 'string',
|
|
40022
|
+
},
|
|
40023
|
+
acs_entrance_id: {
|
|
40024
|
+
description: 'ID of the entrance to unlock.',
|
|
40025
|
+
format: 'uuid',
|
|
40026
|
+
type: 'string',
|
|
40027
|
+
},
|
|
40028
|
+
},
|
|
40029
|
+
required: ['acs_entrance_id', 'acs_credential_id'],
|
|
40030
|
+
type: 'object',
|
|
40031
|
+
},
|
|
40032
|
+
},
|
|
40033
|
+
},
|
|
40034
|
+
},
|
|
40035
|
+
responses: {
|
|
40036
|
+
200: {
|
|
40037
|
+
content: {
|
|
40038
|
+
'application/json': {
|
|
40039
|
+
schema: {
|
|
40040
|
+
properties: {
|
|
40041
|
+
action_attempt: {
|
|
40042
|
+
$ref: '#/components/schemas/action_attempt',
|
|
40043
|
+
},
|
|
40044
|
+
ok: { type: 'boolean' },
|
|
40045
|
+
},
|
|
40046
|
+
required: ['action_attempt', 'ok'],
|
|
40047
|
+
type: 'object',
|
|
40048
|
+
},
|
|
40049
|
+
},
|
|
40050
|
+
},
|
|
40051
|
+
description: 'OK',
|
|
40052
|
+
},
|
|
40053
|
+
400: { description: 'Bad Request' },
|
|
40054
|
+
401: { description: 'Unauthorized' },
|
|
40055
|
+
},
|
|
40056
|
+
security: [
|
|
40057
|
+
{ pat_with_workspace: [] },
|
|
40058
|
+
{ console_session_with_workspace: [] },
|
|
40059
|
+
{ api_key: [] },
|
|
40060
|
+
],
|
|
40061
|
+
summary: '/acs/entrances/unlock',
|
|
40062
|
+
tags: ['/acs'],
|
|
40063
|
+
'x-action-attempt-type': 'UNLOCK_DOOR',
|
|
40064
|
+
'x-fern-sdk-group-name': ['acs', 'entrances'],
|
|
40065
|
+
'x-fern-sdk-method-name': 'unlock',
|
|
40066
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
40067
|
+
'x-response-key': 'action_attempt',
|
|
40068
|
+
'x-title': 'Unlock an Entrance',
|
|
40069
|
+
},
|
|
40070
|
+
},
|
|
40001
40071
|
'/acs/systems/get': {
|
|
40002
40072
|
get: {
|
|
40003
40073
|
description: 'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
@@ -56117,8 +56187,18 @@ export default {
|
|
|
56117
56187
|
},
|
|
56118
56188
|
'/seam/customer/v1/automations/get': {
|
|
56119
56189
|
get: {
|
|
56120
|
-
description: 'Gets the current automation configuration for a customer portal workspace.\
|
|
56190
|
+
description: '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.',
|
|
56121
56191
|
operationId: 'seamCustomerV1AutomationsGetGet',
|
|
56192
|
+
parameters: [
|
|
56193
|
+
{
|
|
56194
|
+
in: 'query',
|
|
56195
|
+
name: 'customer_key',
|
|
56196
|
+
schema: {
|
|
56197
|
+
description: 'Key of the customer to get automation config for.',
|
|
56198
|
+
type: 'string',
|
|
56199
|
+
},
|
|
56200
|
+
},
|
|
56201
|
+
],
|
|
56122
56202
|
responses: {
|
|
56123
56203
|
200: {
|
|
56124
56204
|
content: {
|
|
@@ -56388,11 +56468,7 @@ export default {
|
|
|
56388
56468
|
400: { description: 'Bad Request' },
|
|
56389
56469
|
401: { description: 'Unauthorized' },
|
|
56390
56470
|
},
|
|
56391
|
-
security: [
|
|
56392
|
-
{ console_session_with_workspace: [] },
|
|
56393
|
-
{ api_key: [] },
|
|
56394
|
-
{ client_session_with_customer: [] },
|
|
56395
|
-
],
|
|
56471
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
56396
56472
|
summary: '/seam/customer/v1/automations/get',
|
|
56397
56473
|
tags: [],
|
|
56398
56474
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
@@ -56402,8 +56478,23 @@ export default {
|
|
|
56402
56478
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
56403
56479
|
},
|
|
56404
56480
|
post: {
|
|
56405
|
-
description: 'Gets the current automation configuration for a customer portal workspace.\
|
|
56481
|
+
description: '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.',
|
|
56406
56482
|
operationId: 'seamCustomerV1AutomationsGetPost',
|
|
56483
|
+
requestBody: {
|
|
56484
|
+
content: {
|
|
56485
|
+
'application/json': {
|
|
56486
|
+
schema: {
|
|
56487
|
+
properties: {
|
|
56488
|
+
customer_key: {
|
|
56489
|
+
description: 'Key of the customer to get automation config for.',
|
|
56490
|
+
type: 'string',
|
|
56491
|
+
},
|
|
56492
|
+
},
|
|
56493
|
+
type: 'object',
|
|
56494
|
+
},
|
|
56495
|
+
},
|
|
56496
|
+
},
|
|
56497
|
+
},
|
|
56407
56498
|
responses: {
|
|
56408
56499
|
200: {
|
|
56409
56500
|
content: {
|
|
@@ -56673,11 +56764,7 @@ export default {
|
|
|
56673
56764
|
400: { description: 'Bad Request' },
|
|
56674
56765
|
401: { description: 'Unauthorized' },
|
|
56675
56766
|
},
|
|
56676
|
-
security: [
|
|
56677
|
-
{ console_session_with_workspace: [] },
|
|
56678
|
-
{ api_key: [] },
|
|
56679
|
-
{ client_session_with_customer: [] },
|
|
56680
|
-
],
|
|
56767
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
56681
56768
|
summary: '/seam/customer/v1/automations/get',
|
|
56682
56769
|
tags: [],
|
|
56683
56770
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
@@ -56936,6 +57023,10 @@ export default {
|
|
|
56936
57023
|
},
|
|
56937
57024
|
type: 'object',
|
|
56938
57025
|
},
|
|
57026
|
+
customer_key: {
|
|
57027
|
+
description: 'Key of the customer to update automation config for.',
|
|
57028
|
+
type: 'string',
|
|
57029
|
+
},
|
|
56939
57030
|
},
|
|
56940
57031
|
type: 'object',
|
|
56941
57032
|
},
|
|
@@ -57215,6 +57306,10 @@ export default {
|
|
|
57215
57306
|
},
|
|
57216
57307
|
type: 'object',
|
|
57217
57308
|
},
|
|
57309
|
+
customer_key: {
|
|
57310
|
+
description: 'Key of the customer to update automation config for.',
|
|
57311
|
+
type: 'string',
|
|
57312
|
+
},
|
|
57218
57313
|
},
|
|
57219
57314
|
type: 'object',
|
|
57220
57315
|
},
|
|
@@ -58204,16 +58299,8 @@ export default {
|
|
|
58204
58299
|
},
|
|
58205
58300
|
'/seam/customer/v1/customers/automations/get': {
|
|
58206
58301
|
get: {
|
|
58207
|
-
description: 'Gets the automation configuration for
|
|
58302
|
+
description: 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
58208
58303
|
operationId: 'seamCustomerV1CustomersAutomationsGetGet',
|
|
58209
|
-
parameters: [
|
|
58210
|
-
{
|
|
58211
|
-
in: 'query',
|
|
58212
|
-
name: 'customer_key',
|
|
58213
|
-
required: true,
|
|
58214
|
-
schema: { description: 'Key of the customer.', type: 'string' },
|
|
58215
|
-
},
|
|
58216
|
-
],
|
|
58217
58304
|
responses: {
|
|
58218
58305
|
200: {
|
|
58219
58306
|
content: {
|
|
@@ -58492,11 +58579,7 @@ export default {
|
|
|
58492
58579
|
400: { description: 'Bad Request' },
|
|
58493
58580
|
401: { description: 'Unauthorized' },
|
|
58494
58581
|
},
|
|
58495
|
-
security: [
|
|
58496
|
-
{ pat_with_workspace: [] },
|
|
58497
|
-
{ console_session_with_workspace: [] },
|
|
58498
|
-
{ api_key: [] },
|
|
58499
|
-
],
|
|
58582
|
+
security: [{ client_session_with_customer: [] }],
|
|
58500
58583
|
summary: '/seam/customer/v1/customers/automations/get',
|
|
58501
58584
|
tags: [],
|
|
58502
58585
|
'x-fern-sdk-group-name': [
|
|
@@ -58512,24 +58595,8 @@ export default {
|
|
|
58512
58595
|
'x-title': 'Get Customer Automation Configuration',
|
|
58513
58596
|
},
|
|
58514
58597
|
post: {
|
|
58515
|
-
description: 'Gets the automation configuration for
|
|
58598
|
+
description: 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
58516
58599
|
operationId: 'seamCustomerV1CustomersAutomationsGetPost',
|
|
58517
|
-
requestBody: {
|
|
58518
|
-
content: {
|
|
58519
|
-
'application/json': {
|
|
58520
|
-
schema: {
|
|
58521
|
-
properties: {
|
|
58522
|
-
customer_key: {
|
|
58523
|
-
description: 'Key of the customer.',
|
|
58524
|
-
type: 'string',
|
|
58525
|
-
},
|
|
58526
|
-
},
|
|
58527
|
-
required: ['customer_key'],
|
|
58528
|
-
type: 'object',
|
|
58529
|
-
},
|
|
58530
|
-
},
|
|
58531
|
-
},
|
|
58532
|
-
},
|
|
58533
58600
|
responses: {
|
|
58534
58601
|
200: {
|
|
58535
58602
|
content: {
|
|
@@ -58808,11 +58875,7 @@ export default {
|
|
|
58808
58875
|
400: { description: 'Bad Request' },
|
|
58809
58876
|
401: { description: 'Unauthorized' },
|
|
58810
58877
|
},
|
|
58811
|
-
security: [
|
|
58812
|
-
{ pat_with_workspace: [] },
|
|
58813
|
-
{ console_session_with_workspace: [] },
|
|
58814
|
-
{ api_key: [] },
|
|
58815
|
-
],
|
|
58878
|
+
security: [{ client_session_with_customer: [] }],
|
|
58816
58879
|
summary: '/seam/customer/v1/customers/automations/get',
|
|
58817
58880
|
tags: [],
|
|
58818
58881
|
'x-fern-sdk-group-name': [
|