@seamapi/types 1.895.0 → 1.897.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 +398 -9
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +180 -18
- package/dist/index.cjs +398 -9
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/events/access-codes.d.ts +20 -20
- package/lib/seam/connect/models/events/access-codes.js +2 -2
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +10 -10
- package/lib/seam/connect/openapi.js +396 -7
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +170 -8
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +2 -2
- package/src/lib/seam/connect/openapi.ts +403 -8
- package/src/lib/seam/connect/route-types.ts +176 -8
|
@@ -46133,9 +46133,9 @@ export type Routes = {
|
|
|
46133
46133
|
/** Name of the property that changed (e.g. `code`). */
|
|
46134
46134
|
property: string;
|
|
46135
46135
|
/** Previous value of the property, or null if not set. */
|
|
46136
|
-
|
|
46136
|
+
from: string | null;
|
|
46137
46137
|
/** New value of the property, or null if cleared. */
|
|
46138
|
-
|
|
46138
|
+
to: string | null;
|
|
46139
46139
|
}[] | undefined;
|
|
46140
46140
|
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
46141
46141
|
change_reason?: string | undefined;
|
|
@@ -48990,9 +48990,9 @@ export type Routes = {
|
|
|
48990
48990
|
/** Name of the property that changed (e.g. `code`). */
|
|
48991
48991
|
property: string;
|
|
48992
48992
|
/** Previous value of the property, or null if not set. */
|
|
48993
|
-
|
|
48993
|
+
from: string | null;
|
|
48994
48994
|
/** New value of the property, or null if cleared. */
|
|
48995
|
-
|
|
48995
|
+
to: string | null;
|
|
48996
48996
|
}[] | undefined;
|
|
48997
48997
|
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
48998
48998
|
change_reason?: string | undefined;
|
|
@@ -74375,6 +74375,168 @@ export type Routes = {
|
|
|
74375
74375
|
};
|
|
74376
74376
|
maxDuration: undefined;
|
|
74377
74377
|
};
|
|
74378
|
+
'/seam/console/v1/sites/create': {
|
|
74379
|
+
route: '/seam/console/v1/sites/create';
|
|
74380
|
+
method: 'POST';
|
|
74381
|
+
queryParams: {};
|
|
74382
|
+
jsonBody: {
|
|
74383
|
+
/** Name of the site that you want to create. */
|
|
74384
|
+
name: string;
|
|
74385
|
+
/** Unique key for the site within the workspace. */
|
|
74386
|
+
site_key?: string | undefined;
|
|
74387
|
+
};
|
|
74388
|
+
commonParams: {};
|
|
74389
|
+
formData: {};
|
|
74390
|
+
jsonResponse: {
|
|
74391
|
+
/** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
|
|
74392
|
+
site: {
|
|
74393
|
+
/** ID of the space. */
|
|
74394
|
+
space_id: string;
|
|
74395
|
+
/** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */
|
|
74396
|
+
workspace_id: string;
|
|
74397
|
+
/** Unique key for the space within the workspace. */
|
|
74398
|
+
space_key?: string | undefined;
|
|
74399
|
+
/** Name of the space. */
|
|
74400
|
+
name: string;
|
|
74401
|
+
/** Display name for the space. */
|
|
74402
|
+
display_name: string;
|
|
74403
|
+
/** Date and time at which the space was created. */
|
|
74404
|
+
created_at: string;
|
|
74405
|
+
/** Number of devices in the space. */
|
|
74406
|
+
device_count: number;
|
|
74407
|
+
/** Number of entrances in the space. */
|
|
74408
|
+
acs_entrance_count: number;
|
|
74409
|
+
/** Customer key associated with the space. */
|
|
74410
|
+
customer_key?: string | undefined;
|
|
74411
|
+
/** Reservation/stay-related defaults for the space. */
|
|
74412
|
+
customer_data?: {
|
|
74413
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
74414
|
+
time_zone?: (string | null) | undefined;
|
|
74415
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
74416
|
+
default_checkin_time?: (string | null) | undefined;
|
|
74417
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
74418
|
+
default_checkout_time?: (string | null) | undefined;
|
|
74419
|
+
} | undefined;
|
|
74420
|
+
/** */
|
|
74421
|
+
parent_space_id?: string | undefined;
|
|
74422
|
+
/** */
|
|
74423
|
+
parent_space_key?: string | undefined;
|
|
74424
|
+
};
|
|
74425
|
+
};
|
|
74426
|
+
maxDuration: undefined;
|
|
74427
|
+
};
|
|
74428
|
+
'/seam/console/v1/sites/delete': {
|
|
74429
|
+
route: '/seam/console/v1/sites/delete';
|
|
74430
|
+
method: 'DELETE' | 'POST';
|
|
74431
|
+
queryParams: {};
|
|
74432
|
+
jsonBody: {
|
|
74433
|
+
/** ID of the site that you want to delete. */
|
|
74434
|
+
site_id: string;
|
|
74435
|
+
};
|
|
74436
|
+
commonParams: {};
|
|
74437
|
+
formData: {};
|
|
74438
|
+
jsonResponse: {};
|
|
74439
|
+
maxDuration: undefined;
|
|
74440
|
+
};
|
|
74441
|
+
'/seam/console/v1/sites/list': {
|
|
74442
|
+
route: '/seam/console/v1/sites/list';
|
|
74443
|
+
method: 'GET' | 'POST';
|
|
74444
|
+
queryParams: {};
|
|
74445
|
+
jsonBody: {};
|
|
74446
|
+
commonParams: {
|
|
74447
|
+
/** String for which to search. Filters sites to those with a partial match on `name` or `site_key`. */
|
|
74448
|
+
search?: string | undefined;
|
|
74449
|
+
};
|
|
74450
|
+
formData: {};
|
|
74451
|
+
jsonResponse: {
|
|
74452
|
+
sites: {
|
|
74453
|
+
/** ID of the space. */
|
|
74454
|
+
space_id: string;
|
|
74455
|
+
/** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */
|
|
74456
|
+
workspace_id: string;
|
|
74457
|
+
/** Unique key for the space within the workspace. */
|
|
74458
|
+
space_key?: string | undefined;
|
|
74459
|
+
/** Name of the space. */
|
|
74460
|
+
name: string;
|
|
74461
|
+
/** Display name for the space. */
|
|
74462
|
+
display_name: string;
|
|
74463
|
+
/** Date and time at which the space was created. */
|
|
74464
|
+
created_at: string;
|
|
74465
|
+
/** Number of devices in the space. */
|
|
74466
|
+
device_count: number;
|
|
74467
|
+
/** Number of entrances in the space. */
|
|
74468
|
+
acs_entrance_count: number;
|
|
74469
|
+
/** Customer key associated with the space. */
|
|
74470
|
+
customer_key?: string | undefined;
|
|
74471
|
+
/** Reservation/stay-related defaults for the space. */
|
|
74472
|
+
customer_data?: {
|
|
74473
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
74474
|
+
time_zone?: (string | null) | undefined;
|
|
74475
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
74476
|
+
default_checkin_time?: (string | null) | undefined;
|
|
74477
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
74478
|
+
default_checkout_time?: (string | null) | undefined;
|
|
74479
|
+
} | undefined;
|
|
74480
|
+
/** */
|
|
74481
|
+
parent_space_id?: string | undefined;
|
|
74482
|
+
/** */
|
|
74483
|
+
parent_space_key?: string | undefined;
|
|
74484
|
+
}[];
|
|
74485
|
+
};
|
|
74486
|
+
maxDuration: undefined;
|
|
74487
|
+
};
|
|
74488
|
+
'/seam/console/v1/sites/update': {
|
|
74489
|
+
route: '/seam/console/v1/sites/update';
|
|
74490
|
+
method: 'POST' | 'PATCH';
|
|
74491
|
+
queryParams: {};
|
|
74492
|
+
jsonBody: {
|
|
74493
|
+
/** ID of the site that you want to update. */
|
|
74494
|
+
site_id: string;
|
|
74495
|
+
/** New name for the site. */
|
|
74496
|
+
name?: string | undefined;
|
|
74497
|
+
/** New unique key for the site within the workspace. */
|
|
74498
|
+
site_key?: string | undefined;
|
|
74499
|
+
};
|
|
74500
|
+
commonParams: {};
|
|
74501
|
+
formData: {};
|
|
74502
|
+
jsonResponse: {
|
|
74503
|
+
/** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
|
|
74504
|
+
site: {
|
|
74505
|
+
/** ID of the space. */
|
|
74506
|
+
space_id: string;
|
|
74507
|
+
/** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */
|
|
74508
|
+
workspace_id: string;
|
|
74509
|
+
/** Unique key for the space within the workspace. */
|
|
74510
|
+
space_key?: string | undefined;
|
|
74511
|
+
/** Name of the space. */
|
|
74512
|
+
name: string;
|
|
74513
|
+
/** Display name for the space. */
|
|
74514
|
+
display_name: string;
|
|
74515
|
+
/** Date and time at which the space was created. */
|
|
74516
|
+
created_at: string;
|
|
74517
|
+
/** Number of devices in the space. */
|
|
74518
|
+
device_count: number;
|
|
74519
|
+
/** Number of entrances in the space. */
|
|
74520
|
+
acs_entrance_count: number;
|
|
74521
|
+
/** Customer key associated with the space. */
|
|
74522
|
+
customer_key?: string | undefined;
|
|
74523
|
+
/** Reservation/stay-related defaults for the space. */
|
|
74524
|
+
customer_data?: {
|
|
74525
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
74526
|
+
time_zone?: (string | null) | undefined;
|
|
74527
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
74528
|
+
default_checkin_time?: (string | null) | undefined;
|
|
74529
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
74530
|
+
default_checkout_time?: (string | null) | undefined;
|
|
74531
|
+
} | undefined;
|
|
74532
|
+
/** */
|
|
74533
|
+
parent_space_id?: string | undefined;
|
|
74534
|
+
/** */
|
|
74535
|
+
parent_space_key?: string | undefined;
|
|
74536
|
+
};
|
|
74537
|
+
};
|
|
74538
|
+
maxDuration: undefined;
|
|
74539
|
+
};
|
|
74378
74540
|
'/seam/console/v1/timelines/get': {
|
|
74379
74541
|
route: '/seam/console/v1/timelines/get';
|
|
74380
74542
|
method: 'GET' | 'POST';
|
|
@@ -77290,9 +77452,9 @@ export type Routes = {
|
|
|
77290
77452
|
/** Name of the property that changed (e.g. `code`). */
|
|
77291
77453
|
property: string;
|
|
77292
77454
|
/** Previous value of the property, or null if not set. */
|
|
77293
|
-
|
|
77455
|
+
from: string | null;
|
|
77294
77456
|
/** New value of the property, or null if cleared. */
|
|
77295
|
-
|
|
77457
|
+
to: string | null;
|
|
77296
77458
|
}[] | undefined;
|
|
77297
77459
|
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
77298
77460
|
change_reason?: string | undefined;
|
|
@@ -113825,9 +113987,9 @@ export type Routes = {
|
|
|
113825
113987
|
/** Name of the property that changed (e.g. `code`). */
|
|
113826
113988
|
property: string;
|
|
113827
113989
|
/** Previous value of the property, or null if not set. */
|
|
113828
|
-
|
|
113990
|
+
from: string | null;
|
|
113829
113991
|
/** New value of the property, or null if cleared. */
|
|
113830
|
-
|
|
113992
|
+
to: string | null;
|
|
113831
113993
|
}[] | undefined;
|
|
113832
113994
|
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
113833
113995
|
change_reason?: string | undefined;
|
package/package.json
CHANGED
|
@@ -73,11 +73,11 @@ export const access_code_changed_event = access_code_event.extend({
|
|
|
73
73
|
property: z
|
|
74
74
|
.string()
|
|
75
75
|
.describe('Name of the property that changed (e.g. `code`).'),
|
|
76
|
-
|
|
76
|
+
from: z
|
|
77
77
|
.string()
|
|
78
78
|
.nullable()
|
|
79
79
|
.describe('Previous value of the property, or null if not set.'),
|
|
80
|
-
|
|
80
|
+
to: z
|
|
81
81
|
.string()
|
|
82
82
|
.nullable()
|
|
83
83
|
.describe('New value of the property, or null if cleared.'),
|
|
@@ -17746,13 +17746,7 @@ const openapi: OpenAPISpec = {
|
|
|
17746
17746
|
'List of properties that changed on the access code.',
|
|
17747
17747
|
items: {
|
|
17748
17748
|
properties: {
|
|
17749
|
-
|
|
17750
|
-
description:
|
|
17751
|
-
'New value of the property, or null if cleared.',
|
|
17752
|
-
nullable: true,
|
|
17753
|
-
type: 'string',
|
|
17754
|
-
},
|
|
17755
|
-
previous_value: {
|
|
17749
|
+
from: {
|
|
17756
17750
|
description:
|
|
17757
17751
|
'Previous value of the property, or null if not set.',
|
|
17758
17752
|
nullable: true,
|
|
@@ -17763,8 +17757,14 @@ const openapi: OpenAPISpec = {
|
|
|
17763
17757
|
'Name of the property that changed (e.g. `code`).',
|
|
17764
17758
|
type: 'string',
|
|
17765
17759
|
},
|
|
17760
|
+
to: {
|
|
17761
|
+
description:
|
|
17762
|
+
'New value of the property, or null if cleared.',
|
|
17763
|
+
nullable: true,
|
|
17764
|
+
type: 'string',
|
|
17765
|
+
},
|
|
17766
17766
|
},
|
|
17767
|
-
required: ['property', '
|
|
17767
|
+
required: ['property', 'from', 'to'],
|
|
17768
17768
|
type: 'object',
|
|
17769
17769
|
},
|
|
17770
17770
|
type: 'array',
|
|
@@ -65387,6 +65387,401 @@ const openapi: OpenAPISpec = {
|
|
|
65387
65387
|
'x-undocumented': 'Internal endpoint for Console',
|
|
65388
65388
|
},
|
|
65389
65389
|
},
|
|
65390
|
+
'/seam/console/v1/sites/create': {
|
|
65391
|
+
post: {
|
|
65392
|
+
description:
|
|
65393
|
+
'Creates a new site, a top-level space in the property hierarchy.',
|
|
65394
|
+
operationId: 'seamConsoleV1SitesCreatePost',
|
|
65395
|
+
requestBody: {
|
|
65396
|
+
content: {
|
|
65397
|
+
'application/json': {
|
|
65398
|
+
schema: {
|
|
65399
|
+
properties: {
|
|
65400
|
+
name: {
|
|
65401
|
+
description: 'Name of the site that you want to create.',
|
|
65402
|
+
type: 'string',
|
|
65403
|
+
},
|
|
65404
|
+
site_key: {
|
|
65405
|
+
description:
|
|
65406
|
+
'Unique key for the site within the workspace.',
|
|
65407
|
+
type: 'string',
|
|
65408
|
+
},
|
|
65409
|
+
},
|
|
65410
|
+
required: ['name'],
|
|
65411
|
+
type: 'object',
|
|
65412
|
+
},
|
|
65413
|
+
},
|
|
65414
|
+
},
|
|
65415
|
+
},
|
|
65416
|
+
responses: {
|
|
65417
|
+
200: {
|
|
65418
|
+
content: {
|
|
65419
|
+
'application/json': {
|
|
65420
|
+
schema: {
|
|
65421
|
+
properties: {
|
|
65422
|
+
ok: { type: 'boolean' },
|
|
65423
|
+
site: { $ref: '#/components/schemas/space' },
|
|
65424
|
+
},
|
|
65425
|
+
required: ['site', 'ok'],
|
|
65426
|
+
type: 'object',
|
|
65427
|
+
},
|
|
65428
|
+
},
|
|
65429
|
+
},
|
|
65430
|
+
description: 'OK',
|
|
65431
|
+
},
|
|
65432
|
+
400: { description: 'Bad Request' },
|
|
65433
|
+
401: { description: 'Unauthorized' },
|
|
65434
|
+
},
|
|
65435
|
+
security: [
|
|
65436
|
+
{ pat_with_workspace: [] },
|
|
65437
|
+
{ console_session_with_workspace: [] },
|
|
65438
|
+
{ api_key: [] },
|
|
65439
|
+
],
|
|
65440
|
+
summary: '/seam/console/v1/sites/create',
|
|
65441
|
+
tags: [],
|
|
65442
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65443
|
+
'x-fern-sdk-method-name': 'create',
|
|
65444
|
+
'x-fern-sdk-return-value': 'site',
|
|
65445
|
+
'x-response-key': 'site',
|
|
65446
|
+
'x-title': 'Create a Site',
|
|
65447
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65448
|
+
},
|
|
65449
|
+
},
|
|
65450
|
+
'/seam/console/v1/sites/delete': {
|
|
65451
|
+
delete: {
|
|
65452
|
+
description: 'Deletes a site.',
|
|
65453
|
+
operationId: 'seamConsoleV1SitesDeleteDelete',
|
|
65454
|
+
requestBody: {
|
|
65455
|
+
content: {
|
|
65456
|
+
'application/json': {
|
|
65457
|
+
schema: {
|
|
65458
|
+
properties: {
|
|
65459
|
+
site_id: {
|
|
65460
|
+
description: 'ID of the site that you want to delete.',
|
|
65461
|
+
format: 'uuid',
|
|
65462
|
+
type: 'string',
|
|
65463
|
+
},
|
|
65464
|
+
},
|
|
65465
|
+
required: ['site_id'],
|
|
65466
|
+
type: 'object',
|
|
65467
|
+
},
|
|
65468
|
+
},
|
|
65469
|
+
},
|
|
65470
|
+
},
|
|
65471
|
+
responses: {
|
|
65472
|
+
200: {
|
|
65473
|
+
content: {
|
|
65474
|
+
'application/json': {
|
|
65475
|
+
schema: {
|
|
65476
|
+
properties: { ok: { type: 'boolean' } },
|
|
65477
|
+
required: ['ok'],
|
|
65478
|
+
type: 'object',
|
|
65479
|
+
},
|
|
65480
|
+
},
|
|
65481
|
+
},
|
|
65482
|
+
description: 'OK',
|
|
65483
|
+
},
|
|
65484
|
+
400: { description: 'Bad Request' },
|
|
65485
|
+
401: { description: 'Unauthorized' },
|
|
65486
|
+
},
|
|
65487
|
+
security: [
|
|
65488
|
+
{ pat_with_workspace: [] },
|
|
65489
|
+
{ console_session_with_workspace: [] },
|
|
65490
|
+
{ api_key: [] },
|
|
65491
|
+
],
|
|
65492
|
+
summary: '/seam/console/v1/sites/delete',
|
|
65493
|
+
tags: [],
|
|
65494
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65495
|
+
'x-fern-sdk-method-name': 'delete',
|
|
65496
|
+
'x-response-key': null,
|
|
65497
|
+
'x-title': 'Delete a Site',
|
|
65498
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65499
|
+
},
|
|
65500
|
+
post: {
|
|
65501
|
+
description: 'Deletes a site.',
|
|
65502
|
+
operationId: 'seamConsoleV1SitesDeletePost',
|
|
65503
|
+
requestBody: {
|
|
65504
|
+
content: {
|
|
65505
|
+
'application/json': {
|
|
65506
|
+
schema: {
|
|
65507
|
+
properties: {
|
|
65508
|
+
site_id: {
|
|
65509
|
+
description: 'ID of the site that you want to delete.',
|
|
65510
|
+
format: 'uuid',
|
|
65511
|
+
type: 'string',
|
|
65512
|
+
},
|
|
65513
|
+
},
|
|
65514
|
+
required: ['site_id'],
|
|
65515
|
+
type: 'object',
|
|
65516
|
+
},
|
|
65517
|
+
},
|
|
65518
|
+
},
|
|
65519
|
+
},
|
|
65520
|
+
responses: {
|
|
65521
|
+
200: {
|
|
65522
|
+
content: {
|
|
65523
|
+
'application/json': {
|
|
65524
|
+
schema: {
|
|
65525
|
+
properties: { ok: { type: 'boolean' } },
|
|
65526
|
+
required: ['ok'],
|
|
65527
|
+
type: 'object',
|
|
65528
|
+
},
|
|
65529
|
+
},
|
|
65530
|
+
},
|
|
65531
|
+
description: 'OK',
|
|
65532
|
+
},
|
|
65533
|
+
400: { description: 'Bad Request' },
|
|
65534
|
+
401: { description: 'Unauthorized' },
|
|
65535
|
+
},
|
|
65536
|
+
security: [
|
|
65537
|
+
{ pat_with_workspace: [] },
|
|
65538
|
+
{ console_session_with_workspace: [] },
|
|
65539
|
+
{ api_key: [] },
|
|
65540
|
+
],
|
|
65541
|
+
summary: '/seam/console/v1/sites/delete',
|
|
65542
|
+
tags: [],
|
|
65543
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65544
|
+
'x-fern-sdk-method-name': 'delete',
|
|
65545
|
+
'x-response-key': null,
|
|
65546
|
+
'x-title': 'Delete a Site',
|
|
65547
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65548
|
+
},
|
|
65549
|
+
},
|
|
65550
|
+
'/seam/console/v1/sites/list': {
|
|
65551
|
+
get: {
|
|
65552
|
+
description: 'Lists sites (top-level spaces) in the workspace.',
|
|
65553
|
+
operationId: 'seamConsoleV1SitesListGet',
|
|
65554
|
+
parameters: [
|
|
65555
|
+
{
|
|
65556
|
+
in: 'query',
|
|
65557
|
+
name: 'search',
|
|
65558
|
+
schema: {
|
|
65559
|
+
description:
|
|
65560
|
+
'String for which to search. Filters sites to those with a partial match on `name` or `site_key`.',
|
|
65561
|
+
minLength: 1,
|
|
65562
|
+
type: 'string',
|
|
65563
|
+
},
|
|
65564
|
+
},
|
|
65565
|
+
],
|
|
65566
|
+
responses: {
|
|
65567
|
+
200: {
|
|
65568
|
+
content: {
|
|
65569
|
+
'application/json': {
|
|
65570
|
+
schema: {
|
|
65571
|
+
properties: {
|
|
65572
|
+
ok: { type: 'boolean' },
|
|
65573
|
+
sites: {
|
|
65574
|
+
items: { $ref: '#/components/schemas/space' },
|
|
65575
|
+
type: 'array',
|
|
65576
|
+
},
|
|
65577
|
+
},
|
|
65578
|
+
required: ['sites', 'ok'],
|
|
65579
|
+
type: 'object',
|
|
65580
|
+
},
|
|
65581
|
+
},
|
|
65582
|
+
},
|
|
65583
|
+
description: 'OK',
|
|
65584
|
+
},
|
|
65585
|
+
400: { description: 'Bad Request' },
|
|
65586
|
+
401: { description: 'Unauthorized' },
|
|
65587
|
+
},
|
|
65588
|
+
security: [
|
|
65589
|
+
{ pat_with_workspace: [] },
|
|
65590
|
+
{ console_session_with_workspace: [] },
|
|
65591
|
+
{ api_key: [] },
|
|
65592
|
+
],
|
|
65593
|
+
summary: '/seam/console/v1/sites/list',
|
|
65594
|
+
tags: [],
|
|
65595
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65596
|
+
'x-fern-sdk-method-name': 'list',
|
|
65597
|
+
'x-fern-sdk-return-value': 'sites',
|
|
65598
|
+
'x-response-key': 'sites',
|
|
65599
|
+
'x-title': 'List Sites',
|
|
65600
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65601
|
+
},
|
|
65602
|
+
post: {
|
|
65603
|
+
description: 'Lists sites (top-level spaces) in the workspace.',
|
|
65604
|
+
operationId: 'seamConsoleV1SitesListPost',
|
|
65605
|
+
requestBody: {
|
|
65606
|
+
content: {
|
|
65607
|
+
'application/json': {
|
|
65608
|
+
schema: {
|
|
65609
|
+
properties: {
|
|
65610
|
+
search: {
|
|
65611
|
+
description:
|
|
65612
|
+
'String for which to search. Filters sites to those with a partial match on `name` or `site_key`.',
|
|
65613
|
+
minLength: 1,
|
|
65614
|
+
type: 'string',
|
|
65615
|
+
},
|
|
65616
|
+
},
|
|
65617
|
+
type: 'object',
|
|
65618
|
+
},
|
|
65619
|
+
},
|
|
65620
|
+
},
|
|
65621
|
+
},
|
|
65622
|
+
responses: {
|
|
65623
|
+
200: {
|
|
65624
|
+
content: {
|
|
65625
|
+
'application/json': {
|
|
65626
|
+
schema: {
|
|
65627
|
+
properties: {
|
|
65628
|
+
ok: { type: 'boolean' },
|
|
65629
|
+
sites: {
|
|
65630
|
+
items: { $ref: '#/components/schemas/space' },
|
|
65631
|
+
type: 'array',
|
|
65632
|
+
},
|
|
65633
|
+
},
|
|
65634
|
+
required: ['sites', 'ok'],
|
|
65635
|
+
type: 'object',
|
|
65636
|
+
},
|
|
65637
|
+
},
|
|
65638
|
+
},
|
|
65639
|
+
description: 'OK',
|
|
65640
|
+
},
|
|
65641
|
+
400: { description: 'Bad Request' },
|
|
65642
|
+
401: { description: 'Unauthorized' },
|
|
65643
|
+
},
|
|
65644
|
+
security: [
|
|
65645
|
+
{ pat_with_workspace: [] },
|
|
65646
|
+
{ console_session_with_workspace: [] },
|
|
65647
|
+
{ api_key: [] },
|
|
65648
|
+
],
|
|
65649
|
+
summary: '/seam/console/v1/sites/list',
|
|
65650
|
+
tags: [],
|
|
65651
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65652
|
+
'x-fern-sdk-method-name': 'list',
|
|
65653
|
+
'x-fern-sdk-return-value': 'sites',
|
|
65654
|
+
'x-response-key': 'sites',
|
|
65655
|
+
'x-title': 'List Sites',
|
|
65656
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65657
|
+
},
|
|
65658
|
+
},
|
|
65659
|
+
'/seam/console/v1/sites/update': {
|
|
65660
|
+
patch: {
|
|
65661
|
+
description: 'Updates an existing site.',
|
|
65662
|
+
operationId: 'seamConsoleV1SitesUpdatePatch',
|
|
65663
|
+
requestBody: {
|
|
65664
|
+
content: {
|
|
65665
|
+
'application/json': {
|
|
65666
|
+
schema: {
|
|
65667
|
+
properties: {
|
|
65668
|
+
name: {
|
|
65669
|
+
description: 'New name for the site.',
|
|
65670
|
+
type: 'string',
|
|
65671
|
+
},
|
|
65672
|
+
site_id: {
|
|
65673
|
+
description: 'ID of the site that you want to update.',
|
|
65674
|
+
format: 'uuid',
|
|
65675
|
+
type: 'string',
|
|
65676
|
+
},
|
|
65677
|
+
site_key: {
|
|
65678
|
+
description:
|
|
65679
|
+
'New unique key for the site within the workspace.',
|
|
65680
|
+
type: 'string',
|
|
65681
|
+
},
|
|
65682
|
+
},
|
|
65683
|
+
required: ['site_id'],
|
|
65684
|
+
type: 'object',
|
|
65685
|
+
},
|
|
65686
|
+
},
|
|
65687
|
+
},
|
|
65688
|
+
},
|
|
65689
|
+
responses: {
|
|
65690
|
+
200: {
|
|
65691
|
+
content: {
|
|
65692
|
+
'application/json': {
|
|
65693
|
+
schema: {
|
|
65694
|
+
properties: {
|
|
65695
|
+
ok: { type: 'boolean' },
|
|
65696
|
+
site: { $ref: '#/components/schemas/space' },
|
|
65697
|
+
},
|
|
65698
|
+
required: ['site', 'ok'],
|
|
65699
|
+
type: 'object',
|
|
65700
|
+
},
|
|
65701
|
+
},
|
|
65702
|
+
},
|
|
65703
|
+
description: 'OK',
|
|
65704
|
+
},
|
|
65705
|
+
400: { description: 'Bad Request' },
|
|
65706
|
+
401: { description: 'Unauthorized' },
|
|
65707
|
+
},
|
|
65708
|
+
security: [
|
|
65709
|
+
{ pat_with_workspace: [] },
|
|
65710
|
+
{ console_session_with_workspace: [] },
|
|
65711
|
+
{ api_key: [] },
|
|
65712
|
+
],
|
|
65713
|
+
summary: '/seam/console/v1/sites/update',
|
|
65714
|
+
tags: [],
|
|
65715
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65716
|
+
'x-fern-sdk-method-name': 'update',
|
|
65717
|
+
'x-fern-sdk-return-value': 'site',
|
|
65718
|
+
'x-response-key': 'site',
|
|
65719
|
+
'x-title': 'Update a Site',
|
|
65720
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65721
|
+
},
|
|
65722
|
+
post: {
|
|
65723
|
+
description: 'Updates an existing site.',
|
|
65724
|
+
operationId: 'seamConsoleV1SitesUpdatePost',
|
|
65725
|
+
requestBody: {
|
|
65726
|
+
content: {
|
|
65727
|
+
'application/json': {
|
|
65728
|
+
schema: {
|
|
65729
|
+
properties: {
|
|
65730
|
+
name: {
|
|
65731
|
+
description: 'New name for the site.',
|
|
65732
|
+
type: 'string',
|
|
65733
|
+
},
|
|
65734
|
+
site_id: {
|
|
65735
|
+
description: 'ID of the site that you want to update.',
|
|
65736
|
+
format: 'uuid',
|
|
65737
|
+
type: 'string',
|
|
65738
|
+
},
|
|
65739
|
+
site_key: {
|
|
65740
|
+
description:
|
|
65741
|
+
'New unique key for the site within the workspace.',
|
|
65742
|
+
type: 'string',
|
|
65743
|
+
},
|
|
65744
|
+
},
|
|
65745
|
+
required: ['site_id'],
|
|
65746
|
+
type: 'object',
|
|
65747
|
+
},
|
|
65748
|
+
},
|
|
65749
|
+
},
|
|
65750
|
+
},
|
|
65751
|
+
responses: {
|
|
65752
|
+
200: {
|
|
65753
|
+
content: {
|
|
65754
|
+
'application/json': {
|
|
65755
|
+
schema: {
|
|
65756
|
+
properties: {
|
|
65757
|
+
ok: { type: 'boolean' },
|
|
65758
|
+
site: { $ref: '#/components/schemas/space' },
|
|
65759
|
+
},
|
|
65760
|
+
required: ['site', 'ok'],
|
|
65761
|
+
type: 'object',
|
|
65762
|
+
},
|
|
65763
|
+
},
|
|
65764
|
+
},
|
|
65765
|
+
description: 'OK',
|
|
65766
|
+
},
|
|
65767
|
+
400: { description: 'Bad Request' },
|
|
65768
|
+
401: { description: 'Unauthorized' },
|
|
65769
|
+
},
|
|
65770
|
+
security: [
|
|
65771
|
+
{ pat_with_workspace: [] },
|
|
65772
|
+
{ console_session_with_workspace: [] },
|
|
65773
|
+
{ api_key: [] },
|
|
65774
|
+
],
|
|
65775
|
+
summary: '/seam/console/v1/sites/update',
|
|
65776
|
+
tags: [],
|
|
65777
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'sites'],
|
|
65778
|
+
'x-fern-sdk-method-name': 'update',
|
|
65779
|
+
'x-fern-sdk-return-value': 'site',
|
|
65780
|
+
'x-response-key': 'site',
|
|
65781
|
+
'x-title': 'Update a Site',
|
|
65782
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
65783
|
+
},
|
|
65784
|
+
},
|
|
65390
65785
|
'/seam/console/v1/timelines/get': {
|
|
65391
65786
|
get: {
|
|
65392
65787
|
description:
|