@seamapi/types 1.423.0 → 1.423.2
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 +82 -173
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +97 -213
- package/lib/seam/connect/openapi.d.ts +94 -210
- package/lib/seam/connect/openapi.js +82 -173
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3 -3
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +84 -190
- package/src/lib/seam/connect/route-types.ts +3 -3
|
@@ -25374,7 +25374,7 @@ export interface Routes {
|
|
|
25374
25374
|
};
|
|
25375
25375
|
'/devices/simulate/remove': {
|
|
25376
25376
|
route: '/devices/simulate/remove';
|
|
25377
|
-
method: '
|
|
25377
|
+
method: 'POST';
|
|
25378
25378
|
queryParams: {};
|
|
25379
25379
|
jsonBody: {
|
|
25380
25380
|
/** ID of the device that you want to simulate removing from Seam. */
|
|
@@ -45371,7 +45371,7 @@ export interface Routes {
|
|
|
45371
45371
|
};
|
|
45372
45372
|
'/phones/simulate/create_sandbox_phone': {
|
|
45373
45373
|
route: '/phones/simulate/create_sandbox_phone';
|
|
45374
|
-
method: '
|
|
45374
|
+
method: 'POST';
|
|
45375
45375
|
queryParams: {};
|
|
45376
45376
|
jsonBody: {
|
|
45377
45377
|
/** ID of the custom SDK installation that you want to use for the simulated phone. */
|
|
@@ -45777,7 +45777,7 @@ export interface Routes {
|
|
|
45777
45777
|
};
|
|
45778
45778
|
'/seam/customer/v1/portals/get': {
|
|
45779
45779
|
route: '/seam/customer/v1/portals/get';
|
|
45780
|
-
method: 'GET';
|
|
45780
|
+
method: 'GET' | 'POST';
|
|
45781
45781
|
queryParams: {};
|
|
45782
45782
|
jsonBody: {};
|
|
45783
45783
|
commonParams: {
|
package/package.json
CHANGED
|
@@ -38471,57 +38471,6 @@ export default {
|
|
|
38471
38471
|
},
|
|
38472
38472
|
},
|
|
38473
38473
|
'/devices/simulate/remove': {
|
|
38474
|
-
delete: {
|
|
38475
|
-
description:
|
|
38476
|
-
'Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).',
|
|
38477
|
-
operationId: 'devicesSimulateRemoveDelete',
|
|
38478
|
-
requestBody: {
|
|
38479
|
-
content: {
|
|
38480
|
-
'application/json': {
|
|
38481
|
-
schema: {
|
|
38482
|
-
properties: {
|
|
38483
|
-
device_id: {
|
|
38484
|
-
description:
|
|
38485
|
-
'ID of the device that you want to simulate removing from Seam.',
|
|
38486
|
-
format: 'uuid',
|
|
38487
|
-
type: 'string',
|
|
38488
|
-
},
|
|
38489
|
-
},
|
|
38490
|
-
required: ['device_id'],
|
|
38491
|
-
type: 'object',
|
|
38492
|
-
},
|
|
38493
|
-
},
|
|
38494
|
-
},
|
|
38495
|
-
},
|
|
38496
|
-
responses: {
|
|
38497
|
-
200: {
|
|
38498
|
-
content: {
|
|
38499
|
-
'application/json': {
|
|
38500
|
-
schema: {
|
|
38501
|
-
properties: { ok: { type: 'boolean' } },
|
|
38502
|
-
required: ['ok'],
|
|
38503
|
-
type: 'object',
|
|
38504
|
-
},
|
|
38505
|
-
},
|
|
38506
|
-
},
|
|
38507
|
-
description: 'OK',
|
|
38508
|
-
},
|
|
38509
|
-
400: { description: 'Bad Request' },
|
|
38510
|
-
401: { description: 'Unauthorized' },
|
|
38511
|
-
},
|
|
38512
|
-
security: [
|
|
38513
|
-
{ api_key: [] },
|
|
38514
|
-
{ pat_with_workspace: [] },
|
|
38515
|
-
{ console_session_with_workspace: [] },
|
|
38516
|
-
{ client_session_with_customer: [] },
|
|
38517
|
-
],
|
|
38518
|
-
summary: '/devices/simulate/remove',
|
|
38519
|
-
tags: ['/devices'],
|
|
38520
|
-
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
38521
|
-
'x-fern-sdk-method-name': 'remove',
|
|
38522
|
-
'x-response-key': null,
|
|
38523
|
-
'x-title': 'Simulate Device Removal',
|
|
38524
|
-
},
|
|
38525
38474
|
post: {
|
|
38526
38475
|
description:
|
|
38527
38476
|
'Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).',
|
|
@@ -43363,143 +43312,6 @@ export default {
|
|
|
43363
43312
|
},
|
|
43364
43313
|
},
|
|
43365
43314
|
'/phones/simulate/create_sandbox_phone': {
|
|
43366
|
-
get: {
|
|
43367
|
-
description:
|
|
43368
|
-
'Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).',
|
|
43369
|
-
operationId: 'phonesSimulateCreateSandboxPhoneGet',
|
|
43370
|
-
requestBody: {
|
|
43371
|
-
content: {
|
|
43372
|
-
'application/json': {
|
|
43373
|
-
schema: {
|
|
43374
|
-
properties: {
|
|
43375
|
-
assa_abloy_metadata: {
|
|
43376
|
-
default: {},
|
|
43377
|
-
description:
|
|
43378
|
-
'ASSA ABLOY metadata that you want to associate with the simulated phone.',
|
|
43379
|
-
properties: {
|
|
43380
|
-
application_version: {
|
|
43381
|
-
default: '1.0.0',
|
|
43382
|
-
description:
|
|
43383
|
-
'Application version that you want to use for the simulated phone.',
|
|
43384
|
-
type: 'string',
|
|
43385
|
-
},
|
|
43386
|
-
ble_capability: {
|
|
43387
|
-
default: true,
|
|
43388
|
-
description:
|
|
43389
|
-
'Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.',
|
|
43390
|
-
type: 'boolean',
|
|
43391
|
-
},
|
|
43392
|
-
hce_capability: {
|
|
43393
|
-
default: false,
|
|
43394
|
-
description:
|
|
43395
|
-
'Indicates whether the simulated phone should have host card emulation (HCE) capability.',
|
|
43396
|
-
type: 'boolean',
|
|
43397
|
-
},
|
|
43398
|
-
nfc_capability: {
|
|
43399
|
-
default: false,
|
|
43400
|
-
description:
|
|
43401
|
-
'Indicates whether the simulated phone should have near-field communication (NFC) capability.',
|
|
43402
|
-
type: 'boolean',
|
|
43403
|
-
},
|
|
43404
|
-
seos_applet_version: {
|
|
43405
|
-
default: '1.0.0',
|
|
43406
|
-
description:
|
|
43407
|
-
'SEOS applet version that you want to use for the simulated phone.',
|
|
43408
|
-
type: 'string',
|
|
43409
|
-
},
|
|
43410
|
-
seos_tsm_endpoint_id: {
|
|
43411
|
-
default: 1,
|
|
43412
|
-
description:
|
|
43413
|
-
'ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.',
|
|
43414
|
-
format: 'float',
|
|
43415
|
-
type: 'number',
|
|
43416
|
-
},
|
|
43417
|
-
},
|
|
43418
|
-
type: 'object',
|
|
43419
|
-
},
|
|
43420
|
-
custom_sdk_installation_id: {
|
|
43421
|
-
description:
|
|
43422
|
-
'ID of the custom SDK installation that you want to use for the simulated phone.',
|
|
43423
|
-
type: 'string',
|
|
43424
|
-
},
|
|
43425
|
-
phone_metadata: {
|
|
43426
|
-
default: {},
|
|
43427
|
-
description:
|
|
43428
|
-
'Metadata that you want to associate with the simulated phone.',
|
|
43429
|
-
properties: {
|
|
43430
|
-
device_manufacturer: {
|
|
43431
|
-
default: 'Samsung',
|
|
43432
|
-
description:
|
|
43433
|
-
'Manufacturer that you want to use for the simulated phone.',
|
|
43434
|
-
type: 'string',
|
|
43435
|
-
},
|
|
43436
|
-
device_model: {
|
|
43437
|
-
default: 'Samsung Galaxy S10',
|
|
43438
|
-
description:
|
|
43439
|
-
'Device model that you want to use for the simulated phone.',
|
|
43440
|
-
type: 'string',
|
|
43441
|
-
},
|
|
43442
|
-
operating_system: {
|
|
43443
|
-
default: 'android',
|
|
43444
|
-
description:
|
|
43445
|
-
'Mobile operating system that you want to use for the simulated phone.',
|
|
43446
|
-
enum: ['android', 'ios'],
|
|
43447
|
-
type: 'string',
|
|
43448
|
-
},
|
|
43449
|
-
os_version: {
|
|
43450
|
-
default: '10',
|
|
43451
|
-
description:
|
|
43452
|
-
'Mobile operating system version that you want to use for the simulated phone.',
|
|
43453
|
-
type: 'string',
|
|
43454
|
-
},
|
|
43455
|
-
},
|
|
43456
|
-
type: 'object',
|
|
43457
|
-
},
|
|
43458
|
-
user_identity_id: {
|
|
43459
|
-
description:
|
|
43460
|
-
'ID of the user identity that you want to associate with the simulated phone.',
|
|
43461
|
-
format: 'uuid',
|
|
43462
|
-
type: 'string',
|
|
43463
|
-
},
|
|
43464
|
-
},
|
|
43465
|
-
required: ['user_identity_id'],
|
|
43466
|
-
type: 'object',
|
|
43467
|
-
},
|
|
43468
|
-
},
|
|
43469
|
-
},
|
|
43470
|
-
},
|
|
43471
|
-
responses: {
|
|
43472
|
-
200: {
|
|
43473
|
-
content: {
|
|
43474
|
-
'application/json': {
|
|
43475
|
-
schema: {
|
|
43476
|
-
properties: {
|
|
43477
|
-
ok: { type: 'boolean' },
|
|
43478
|
-
phone: { $ref: '#/components/schemas/phone' },
|
|
43479
|
-
},
|
|
43480
|
-
required: ['phone', 'ok'],
|
|
43481
|
-
type: 'object',
|
|
43482
|
-
},
|
|
43483
|
-
},
|
|
43484
|
-
},
|
|
43485
|
-
description: 'OK',
|
|
43486
|
-
},
|
|
43487
|
-
400: { description: 'Bad Request' },
|
|
43488
|
-
401: { description: 'Unauthorized' },
|
|
43489
|
-
},
|
|
43490
|
-
security: [
|
|
43491
|
-
{ api_key: [] },
|
|
43492
|
-
{ pat_with_workspace: [] },
|
|
43493
|
-
{ console_session_with_workspace: [] },
|
|
43494
|
-
],
|
|
43495
|
-
summary: '/phones/simulate/create_sandbox_phone',
|
|
43496
|
-
tags: ['/phones'],
|
|
43497
|
-
'x-fern-sdk-group-name': ['phones', 'simulate'],
|
|
43498
|
-
'x-fern-sdk-method-name': 'create_sandbox_phone',
|
|
43499
|
-
'x-fern-sdk-return-value': 'phone',
|
|
43500
|
-
'x-response-key': 'phone',
|
|
43501
|
-
'x-title': 'Create a Sandbox Phone',
|
|
43502
|
-
},
|
|
43503
43315
|
post: {
|
|
43504
43316
|
description:
|
|
43505
43317
|
'Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).',
|
|
@@ -44098,8 +43910,90 @@ export default {
|
|
|
44098
43910
|
tags: [],
|
|
44099
43911
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
44100
43912
|
'x-fern-sdk-method-name': 'get',
|
|
44101
|
-
'x-fern-sdk-return-value': '
|
|
44102
|
-
'x-response-key': '
|
|
43913
|
+
'x-fern-sdk-return-value': 'customer_portal',
|
|
43914
|
+
'x-response-key': 'customer_portal',
|
|
43915
|
+
'x-title': 'Get Customer Portal Configuration',
|
|
43916
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
43917
|
+
},
|
|
43918
|
+
post: {
|
|
43919
|
+
description:
|
|
43920
|
+
'Retrieves the configuration for a customer portal identified by customer_portal_id.',
|
|
43921
|
+
operationId: 'seamCustomerV1PortalsGetPost',
|
|
43922
|
+
requestBody: {
|
|
43923
|
+
content: {
|
|
43924
|
+
'application/json': {
|
|
43925
|
+
schema: {
|
|
43926
|
+
properties: {
|
|
43927
|
+
customer_portal_id: {
|
|
43928
|
+
description: 'Customer portal ID.',
|
|
43929
|
+
type: 'string',
|
|
43930
|
+
},
|
|
43931
|
+
},
|
|
43932
|
+
required: ['customer_portal_id'],
|
|
43933
|
+
type: 'object',
|
|
43934
|
+
},
|
|
43935
|
+
},
|
|
43936
|
+
},
|
|
43937
|
+
},
|
|
43938
|
+
responses: {
|
|
43939
|
+
200: {
|
|
43940
|
+
content: {
|
|
43941
|
+
'application/json': {
|
|
43942
|
+
schema: {
|
|
43943
|
+
properties: {
|
|
43944
|
+
customer_portal: {
|
|
43945
|
+
properties: {
|
|
43946
|
+
business_vertical: {
|
|
43947
|
+
description:
|
|
43948
|
+
'Business vertical of the customer portal.',
|
|
43949
|
+
enum: [
|
|
43950
|
+
'short_term_rental',
|
|
43951
|
+
'hospitality',
|
|
43952
|
+
'multi_family',
|
|
43953
|
+
'gym_management',
|
|
43954
|
+
'property_tours',
|
|
43955
|
+
],
|
|
43956
|
+
type: 'string',
|
|
43957
|
+
},
|
|
43958
|
+
features: {
|
|
43959
|
+
properties: {
|
|
43960
|
+
connect: {
|
|
43961
|
+
properties: { exclude: { type: 'boolean' } },
|
|
43962
|
+
type: 'object',
|
|
43963
|
+
},
|
|
43964
|
+
manage_devices: {
|
|
43965
|
+
properties: { exclude: { type: 'boolean' } },
|
|
43966
|
+
type: 'object',
|
|
43967
|
+
},
|
|
43968
|
+
organize: {
|
|
43969
|
+
properties: { exclude: { type: 'boolean' } },
|
|
43970
|
+
type: 'object',
|
|
43971
|
+
},
|
|
43972
|
+
},
|
|
43973
|
+
type: 'object',
|
|
43974
|
+
},
|
|
43975
|
+
},
|
|
43976
|
+
type: 'object',
|
|
43977
|
+
},
|
|
43978
|
+
ok: { type: 'boolean' },
|
|
43979
|
+
},
|
|
43980
|
+
required: ['customer_portal', 'ok'],
|
|
43981
|
+
type: 'object',
|
|
43982
|
+
},
|
|
43983
|
+
},
|
|
43984
|
+
},
|
|
43985
|
+
description: 'OK',
|
|
43986
|
+
},
|
|
43987
|
+
400: { description: 'Bad Request' },
|
|
43988
|
+
401: { description: 'Unauthorized' },
|
|
43989
|
+
},
|
|
43990
|
+
security: [{ client_session_with_customer: [] }],
|
|
43991
|
+
summary: '/seam/customer/v1/portals/get',
|
|
43992
|
+
tags: [],
|
|
43993
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
43994
|
+
'x-fern-sdk-method-name': 'get',
|
|
43995
|
+
'x-fern-sdk-return-value': 'customer_portal',
|
|
43996
|
+
'x-response-key': 'customer_portal',
|
|
44103
43997
|
'x-title': 'Get Customer Portal Configuration',
|
|
44104
43998
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44105
43999
|
},
|
|
@@ -29226,7 +29226,7 @@ export interface Routes {
|
|
|
29226
29226
|
}
|
|
29227
29227
|
'/devices/simulate/remove': {
|
|
29228
29228
|
route: '/devices/simulate/remove'
|
|
29229
|
-
method: '
|
|
29229
|
+
method: 'POST'
|
|
29230
29230
|
queryParams: {}
|
|
29231
29231
|
jsonBody: {
|
|
29232
29232
|
/** ID of the device that you want to simulate removing from Seam. */
|
|
@@ -52857,7 +52857,7 @@ export interface Routes {
|
|
|
52857
52857
|
}
|
|
52858
52858
|
'/phones/simulate/create_sandbox_phone': {
|
|
52859
52859
|
route: '/phones/simulate/create_sandbox_phone'
|
|
52860
|
-
method: '
|
|
52860
|
+
method: 'POST'
|
|
52861
52861
|
queryParams: {}
|
|
52862
52862
|
jsonBody: {
|
|
52863
52863
|
/** ID of the custom SDK installation that you want to use for the simulated phone. */
|
|
@@ -53279,7 +53279,7 @@ export interface Routes {
|
|
|
53279
53279
|
}
|
|
53280
53280
|
'/seam/customer/v1/portals/get': {
|
|
53281
53281
|
route: '/seam/customer/v1/portals/get'
|
|
53282
|
-
method: 'GET'
|
|
53282
|
+
method: 'GET' | 'POST'
|
|
53283
53283
|
queryParams: {}
|
|
53284
53284
|
jsonBody: {}
|
|
53285
53285
|
commonParams: {
|