@seamapi/types 1.605.0 → 1.607.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 +316 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +412 -1
- package/dist/index.cjs +316 -0
- 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 +25 -0
- package/lib/seam/connect/models/customer/customer-data.d.ts +34 -0
- package/lib/seam/connect/models/customer/customer-data.js +5 -1
- package/lib/seam/connect/models/customer/customer-data.js.map +1 -1
- package/lib/seam/connect/models/customer/user-identity-resources.d.ts +39 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js +15 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -1
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
- package/lib/seam/connect/openapi.d.ts +293 -0
- package/lib/seam/connect/openapi.js +266 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +88 -0
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/models/customer/customer-data.ts +5 -0
- package/src/lib/seam/connect/models/customer/user-identity-resources.ts +18 -0
- package/src/lib/seam/connect/openapi.ts +287 -0
- package/src/lib/seam/connect/route-types.ts +92 -0
- package/src/lib/seam/connect/schemas.ts +1 -0
|
@@ -11465,6 +11465,8 @@ export type Routes = {
|
|
|
11465
11465
|
can_unlock_with_card?: boolean | undefined;
|
|
11466
11466
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
11467
11467
|
can_unlock_with_code?: boolean | undefined;
|
|
11468
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
11469
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
11468
11470
|
}[] | undefined;
|
|
11469
11471
|
user_identities?: {
|
|
11470
11472
|
/** ID of the user identity. */
|
|
@@ -14897,6 +14899,8 @@ export type Routes = {
|
|
|
14897
14899
|
can_unlock_with_card?: boolean | undefined;
|
|
14898
14900
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
14899
14901
|
can_unlock_with_code?: boolean | undefined;
|
|
14902
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
14903
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
14900
14904
|
}[] | undefined;
|
|
14901
14905
|
acs_systems?: {
|
|
14902
14906
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
@@ -20954,6 +20958,8 @@ export type Routes = {
|
|
|
20954
20958
|
can_unlock_with_card?: boolean | undefined;
|
|
20955
20959
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
20956
20960
|
can_unlock_with_code?: boolean | undefined;
|
|
20961
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
20962
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
20957
20963
|
}[];
|
|
20958
20964
|
};
|
|
20959
20965
|
};
|
|
@@ -22320,6 +22326,8 @@ export type Routes = {
|
|
|
22320
22326
|
can_unlock_with_card?: boolean | undefined;
|
|
22321
22327
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
22322
22328
|
can_unlock_with_code?: boolean | undefined;
|
|
22329
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
22330
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
22323
22331
|
}[];
|
|
22324
22332
|
};
|
|
22325
22333
|
};
|
|
@@ -25786,6 +25794,8 @@ export type Routes = {
|
|
|
25786
25794
|
can_unlock_with_card?: boolean | undefined;
|
|
25787
25795
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
25788
25796
|
can_unlock_with_code?: boolean | undefined;
|
|
25797
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
25798
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
25789
25799
|
};
|
|
25790
25800
|
};
|
|
25791
25801
|
};
|
|
@@ -25953,6 +25963,8 @@ export type Routes = {
|
|
|
25953
25963
|
can_unlock_with_card?: boolean | undefined;
|
|
25954
25964
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
25955
25965
|
can_unlock_with_code?: boolean | undefined;
|
|
25966
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
25967
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
25956
25968
|
}[];
|
|
25957
25969
|
/** Information about the current page of results. */
|
|
25958
25970
|
pagination: {
|
|
@@ -27428,6 +27440,8 @@ export type Routes = {
|
|
|
27428
27440
|
can_unlock_with_card?: boolean | undefined;
|
|
27429
27441
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
27430
27442
|
can_unlock_with_code?: boolean | undefined;
|
|
27443
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
27444
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
27431
27445
|
}[];
|
|
27432
27446
|
};
|
|
27433
27447
|
};
|
|
@@ -31804,6 +31818,19 @@ export type Routes = {
|
|
|
31804
31818
|
/** Your unique identifier for the user identity. */
|
|
31805
31819
|
user_identity_key: string;
|
|
31806
31820
|
}[] | undefined;
|
|
31821
|
+
/** List of staff members. */
|
|
31822
|
+
staff_members?: {
|
|
31823
|
+
/** Your display name for this user identity resource. */
|
|
31824
|
+
name: string;
|
|
31825
|
+
/** Email address associated with the user identity. */
|
|
31826
|
+
email_address?: string | undefined;
|
|
31827
|
+
/** Phone number associated with the user identity. */
|
|
31828
|
+
phone_number?: string | undefined;
|
|
31829
|
+
/** Your unique identifier for the staff. */
|
|
31830
|
+
staff_member_key: string;
|
|
31831
|
+
/** List of unique identifiers for the sites the staff member is associated with. */
|
|
31832
|
+
site_keys: string[];
|
|
31833
|
+
}[] | undefined;
|
|
31807
31834
|
/** List of reservations. */
|
|
31808
31835
|
reservations?: {
|
|
31809
31836
|
/** Your name for this access grant resource. */
|
|
@@ -32129,6 +32156,19 @@ export type Routes = {
|
|
|
32129
32156
|
/** Your unique identifier for the user identity. */
|
|
32130
32157
|
user_identity_key: string;
|
|
32131
32158
|
}[] | undefined;
|
|
32159
|
+
/** List of staff members. */
|
|
32160
|
+
staff_members?: {
|
|
32161
|
+
/** Your display name for this user identity resource. */
|
|
32162
|
+
name: string;
|
|
32163
|
+
/** Email address associated with the user identity. */
|
|
32164
|
+
email_address?: string | undefined;
|
|
32165
|
+
/** Phone number associated with the user identity. */
|
|
32166
|
+
phone_number?: string | undefined;
|
|
32167
|
+
/** Your unique identifier for the staff. */
|
|
32168
|
+
staff_member_key: string;
|
|
32169
|
+
/** List of unique identifiers for the sites the staff member is associated with. */
|
|
32170
|
+
site_keys: string[];
|
|
32171
|
+
}[] | undefined;
|
|
32132
32172
|
/** List of reservations. */
|
|
32133
32173
|
reservations?: {
|
|
32134
32174
|
/** Your name for this access grant resource. */
|
|
@@ -59154,6 +59194,48 @@ export type Routes = {
|
|
|
59154
59194
|
}[];
|
|
59155
59195
|
};
|
|
59156
59196
|
};
|
|
59197
|
+
'/seam/customer/v1/staff_members/list': {
|
|
59198
|
+
route: '/seam/customer/v1/staff_members/list';
|
|
59199
|
+
method: 'GET' | 'POST';
|
|
59200
|
+
queryParams: {};
|
|
59201
|
+
jsonBody: {};
|
|
59202
|
+
commonParams: {
|
|
59203
|
+
/** Filter staff members by space key. */
|
|
59204
|
+
space_key?: string | undefined;
|
|
59205
|
+
/** Filter staff members by space ID (UUID). */
|
|
59206
|
+
space_id?: string | undefined;
|
|
59207
|
+
/** Maximum number of records to return per page. */
|
|
59208
|
+
limit?: number;
|
|
59209
|
+
/** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
|
|
59210
|
+
created_before?: Date | undefined;
|
|
59211
|
+
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
59212
|
+
page_cursor?: ((string | undefined) | null) | undefined;
|
|
59213
|
+
};
|
|
59214
|
+
formData: {};
|
|
59215
|
+
jsonResponse: {
|
|
59216
|
+
staff_members: {
|
|
59217
|
+
/** Your display name for this user identity resource. */
|
|
59218
|
+
name: string;
|
|
59219
|
+
/** Email address associated with the user identity. */
|
|
59220
|
+
email_address?: string | undefined;
|
|
59221
|
+
/** Phone number associated with the user identity. */
|
|
59222
|
+
phone_number?: string | undefined;
|
|
59223
|
+
/** Your unique identifier for the staff. */
|
|
59224
|
+
staff_member_key: string;
|
|
59225
|
+
/** List of unique identifiers for the sites the staff member is associated with. */
|
|
59226
|
+
site_keys: string[];
|
|
59227
|
+
}[];
|
|
59228
|
+
/** Information about the current page of results. */
|
|
59229
|
+
pagination: {
|
|
59230
|
+
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
59231
|
+
next_page_cursor: string | null;
|
|
59232
|
+
/** Indicates whether there is another page of results after this one. */
|
|
59233
|
+
has_next_page: boolean;
|
|
59234
|
+
/** URL to get the next page of results. */
|
|
59235
|
+
next_page_url: string | null;
|
|
59236
|
+
};
|
|
59237
|
+
};
|
|
59238
|
+
};
|
|
59157
59239
|
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
59158
59240
|
route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
|
|
59159
59241
|
method: 'POST';
|
|
@@ -59690,6 +59772,8 @@ export type Routes = {
|
|
|
59690
59772
|
can_unlock_with_card?: boolean | undefined;
|
|
59691
59773
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
59692
59774
|
can_unlock_with_code?: boolean | undefined;
|
|
59775
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
59776
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
59693
59777
|
}[];
|
|
59694
59778
|
}[];
|
|
59695
59779
|
}[];
|
|
@@ -61269,6 +61353,8 @@ export type Routes = {
|
|
|
61269
61353
|
can_unlock_with_card?: boolean | undefined;
|
|
61270
61354
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
61271
61355
|
can_unlock_with_code?: boolean | undefined;
|
|
61356
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
61357
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
61272
61358
|
}[] | undefined;
|
|
61273
61359
|
connected_accounts?: {
|
|
61274
61360
|
/** ID of the connected account. */
|
|
@@ -82503,6 +82589,8 @@ export type Routes = {
|
|
|
82503
82589
|
can_unlock_with_card?: boolean | undefined;
|
|
82504
82590
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
82505
82591
|
can_unlock_with_code?: boolean | undefined;
|
|
82592
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
82593
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
82506
82594
|
}[] | undefined;
|
|
82507
82595
|
acs_systems?: {
|
|
82508
82596
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
1
|
+
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
1
|
+
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
2
2
|
//# sourceMappingURL=schemas.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
|
package/package.json
CHANGED
|
@@ -30,6 +30,12 @@ export const acs_entrance_capability_flags = z.object({
|
|
|
30
30
|
.describe(
|
|
31
31
|
'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
32
32
|
),
|
|
33
|
+
can_belong_to_reservation: z
|
|
34
|
+
.boolean()
|
|
35
|
+
.optional()
|
|
36
|
+
.describe(
|
|
37
|
+
'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
|
|
38
|
+
),
|
|
33
39
|
})
|
|
34
40
|
|
|
35
41
|
export const acs_entrance = z
|
|
@@ -20,6 +20,7 @@ import {
|
|
|
20
20
|
import {
|
|
21
21
|
guest_resource,
|
|
22
22
|
resident_resource,
|
|
23
|
+
staff_member_resource,
|
|
23
24
|
tenant_resource,
|
|
24
25
|
user_identity_resource,
|
|
25
26
|
user_resource,
|
|
@@ -82,6 +83,10 @@ export const customer_data = z.object({
|
|
|
82
83
|
.array(user_identity_resource)
|
|
83
84
|
.optional()
|
|
84
85
|
.describe('List of user identities.'),
|
|
86
|
+
staff_members: z
|
|
87
|
+
.array(staff_member_resource)
|
|
88
|
+
.optional()
|
|
89
|
+
.describe('List of staff members.'),
|
|
85
90
|
|
|
86
91
|
// Access grant resources
|
|
87
92
|
reservations: z
|
|
@@ -32,6 +32,23 @@ export const user_resource = base_user_identity_resource.extend({
|
|
|
32
32
|
user_key: z.string().describe('Your unique identifier for the user.'),
|
|
33
33
|
})
|
|
34
34
|
|
|
35
|
+
// staff resource
|
|
36
|
+
export const staff_member_resource = base_user_identity_resource.extend({
|
|
37
|
+
staff_member_key: z
|
|
38
|
+
.string()
|
|
39
|
+
.describe('Your unique identifier for the staff.'),
|
|
40
|
+
site_keys: z
|
|
41
|
+
.array(z.string())
|
|
42
|
+
.describe(
|
|
43
|
+
'List of unique identifiers for the sites the staff member is associated with.',
|
|
44
|
+
),
|
|
45
|
+
}).describe(`
|
|
46
|
+
---
|
|
47
|
+
route_path: /seam/customer/v1/staff_members
|
|
48
|
+
---
|
|
49
|
+
Represents a staff member for a specific customer.
|
|
50
|
+
`)
|
|
51
|
+
|
|
35
52
|
export const user_identity_resource = base_user_identity_resource.extend({
|
|
36
53
|
user_identity_key: z
|
|
37
54
|
.string()
|
|
@@ -45,6 +62,7 @@ export const user_identity_resource_union = z.union([
|
|
|
45
62
|
resident_resource,
|
|
46
63
|
user_resource,
|
|
47
64
|
user_identity_resource,
|
|
65
|
+
staff_member_resource,
|
|
48
66
|
])
|
|
49
67
|
|
|
50
68
|
// All user identity key aliases for use in references
|
|
@@ -2820,6 +2820,11 @@ export default {
|
|
|
2820
2820
|
required: ['door_type', 'door_name'],
|
|
2821
2821
|
type: 'object',
|
|
2822
2822
|
},
|
|
2823
|
+
can_belong_to_reservation: {
|
|
2824
|
+
description:
|
|
2825
|
+
'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
|
|
2826
|
+
type: 'boolean',
|
|
2827
|
+
},
|
|
2823
2828
|
can_unlock_with_card: {
|
|
2824
2829
|
description:
|
|
2825
2830
|
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
@@ -19852,6 +19857,11 @@ export default {
|
|
|
19852
19857
|
required: ['door_type', 'door_name'],
|
|
19853
19858
|
type: 'object',
|
|
19854
19859
|
},
|
|
19860
|
+
can_belong_to_reservation: {
|
|
19861
|
+
description:
|
|
19862
|
+
'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
|
|
19863
|
+
type: 'boolean',
|
|
19864
|
+
},
|
|
19855
19865
|
can_unlock_with_card: {
|
|
19856
19866
|
description:
|
|
19857
19867
|
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
@@ -20864,6 +20874,36 @@ export default {
|
|
|
20864
20874
|
'x-draft': 'Early access.',
|
|
20865
20875
|
'x-route-path': '/spaces',
|
|
20866
20876
|
},
|
|
20877
|
+
staff_member: {
|
|
20878
|
+
description: 'Represents a staff member for a specific customer.',
|
|
20879
|
+
properties: {
|
|
20880
|
+
email_address: {
|
|
20881
|
+
description: 'Email address associated with the user identity.',
|
|
20882
|
+
type: 'string',
|
|
20883
|
+
},
|
|
20884
|
+
name: {
|
|
20885
|
+
description: 'Your display name for this user identity resource.',
|
|
20886
|
+
type: 'string',
|
|
20887
|
+
},
|
|
20888
|
+
phone_number: {
|
|
20889
|
+
description: 'Phone number associated with the user identity.',
|
|
20890
|
+
type: 'string',
|
|
20891
|
+
},
|
|
20892
|
+
site_keys: {
|
|
20893
|
+
description:
|
|
20894
|
+
'List of unique identifiers for the sites the staff member is associated with.',
|
|
20895
|
+
items: { type: 'string' },
|
|
20896
|
+
type: 'array',
|
|
20897
|
+
},
|
|
20898
|
+
staff_member_key: {
|
|
20899
|
+
description: 'Your unique identifier for the staff.',
|
|
20900
|
+
type: 'string',
|
|
20901
|
+
},
|
|
20902
|
+
},
|
|
20903
|
+
required: ['name', 'staff_member_key', 'site_keys'],
|
|
20904
|
+
type: 'object',
|
|
20905
|
+
'x-route-path': '/seam/customer/v1/staff_members',
|
|
20906
|
+
},
|
|
20867
20907
|
thermostat_daily_program: {
|
|
20868
20908
|
description:
|
|
20869
20909
|
'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
|
|
@@ -41657,6 +41697,49 @@ export default {
|
|
|
41657
41697
|
},
|
|
41658
41698
|
type: 'array',
|
|
41659
41699
|
},
|
|
41700
|
+
staff_members: {
|
|
41701
|
+
description: 'List of staff members.',
|
|
41702
|
+
items: {
|
|
41703
|
+
description:
|
|
41704
|
+
'Represents a staff member for a specific customer.',
|
|
41705
|
+
properties: {
|
|
41706
|
+
email_address: {
|
|
41707
|
+
description:
|
|
41708
|
+
'Email address associated with the user identity.',
|
|
41709
|
+
type: 'string',
|
|
41710
|
+
},
|
|
41711
|
+
name: {
|
|
41712
|
+
description:
|
|
41713
|
+
'Your display name for this user identity resource.',
|
|
41714
|
+
type: 'string',
|
|
41715
|
+
},
|
|
41716
|
+
phone_number: {
|
|
41717
|
+
description:
|
|
41718
|
+
'Phone number associated with the user identity.',
|
|
41719
|
+
type: 'string',
|
|
41720
|
+
},
|
|
41721
|
+
site_keys: {
|
|
41722
|
+
description:
|
|
41723
|
+
'List of unique identifiers for the sites the staff member is associated with.',
|
|
41724
|
+
items: { type: 'string' },
|
|
41725
|
+
type: 'array',
|
|
41726
|
+
},
|
|
41727
|
+
staff_member_key: {
|
|
41728
|
+
description:
|
|
41729
|
+
'Your unique identifier for the staff.',
|
|
41730
|
+
type: 'string',
|
|
41731
|
+
},
|
|
41732
|
+
},
|
|
41733
|
+
required: [
|
|
41734
|
+
'name',
|
|
41735
|
+
'staff_member_key',
|
|
41736
|
+
'site_keys',
|
|
41737
|
+
],
|
|
41738
|
+
type: 'object',
|
|
41739
|
+
'x-route-path': '/seam/customer/v1/staff_members',
|
|
41740
|
+
},
|
|
41741
|
+
type: 'array',
|
|
41742
|
+
},
|
|
41660
41743
|
tenants: {
|
|
41661
41744
|
description: 'List of tenants.',
|
|
41662
41745
|
items: {
|
|
@@ -42732,6 +42815,44 @@ export default {
|
|
|
42732
42815
|
},
|
|
42733
42816
|
type: 'array',
|
|
42734
42817
|
},
|
|
42818
|
+
staff_members: {
|
|
42819
|
+
description: 'List of staff members.',
|
|
42820
|
+
items: {
|
|
42821
|
+
description:
|
|
42822
|
+
'Represents a staff member for a specific customer.',
|
|
42823
|
+
properties: {
|
|
42824
|
+
email_address: {
|
|
42825
|
+
description:
|
|
42826
|
+
'Email address associated with the user identity.',
|
|
42827
|
+
type: 'string',
|
|
42828
|
+
},
|
|
42829
|
+
name: {
|
|
42830
|
+
description:
|
|
42831
|
+
'Your display name for this user identity resource.',
|
|
42832
|
+
type: 'string',
|
|
42833
|
+
},
|
|
42834
|
+
phone_number: {
|
|
42835
|
+
description:
|
|
42836
|
+
'Phone number associated with the user identity.',
|
|
42837
|
+
type: 'string',
|
|
42838
|
+
},
|
|
42839
|
+
site_keys: {
|
|
42840
|
+
description:
|
|
42841
|
+
'List of unique identifiers for the sites the staff member is associated with.',
|
|
42842
|
+
items: { type: 'string' },
|
|
42843
|
+
type: 'array',
|
|
42844
|
+
},
|
|
42845
|
+
staff_member_key: {
|
|
42846
|
+
description: 'Your unique identifier for the staff.',
|
|
42847
|
+
type: 'string',
|
|
42848
|
+
},
|
|
42849
|
+
},
|
|
42850
|
+
required: ['name', 'staff_member_key', 'site_keys'],
|
|
42851
|
+
type: 'object',
|
|
42852
|
+
'x-route-path': '/seam/customer/v1/staff_members',
|
|
42853
|
+
},
|
|
42854
|
+
type: 'array',
|
|
42855
|
+
},
|
|
42735
42856
|
tenants: {
|
|
42736
42857
|
description: 'List of tenants.',
|
|
42737
42858
|
items: {
|
|
@@ -53782,6 +53903,172 @@ export default {
|
|
|
53782
53903
|
'x-title': 'List Spaces',
|
|
53783
53904
|
},
|
|
53784
53905
|
},
|
|
53906
|
+
'/seam/customer/v1/staff_members/list': {
|
|
53907
|
+
get: {
|
|
53908
|
+
description:
|
|
53909
|
+
'Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.',
|
|
53910
|
+
operationId: 'seamCustomerV1StaffMembersListGet',
|
|
53911
|
+
parameters: [
|
|
53912
|
+
{
|
|
53913
|
+
in: 'query',
|
|
53914
|
+
name: 'space_key',
|
|
53915
|
+
schema: {
|
|
53916
|
+
description: 'Filter staff members by space key.',
|
|
53917
|
+
type: 'string',
|
|
53918
|
+
},
|
|
53919
|
+
},
|
|
53920
|
+
{
|
|
53921
|
+
in: 'query',
|
|
53922
|
+
name: 'space_id',
|
|
53923
|
+
schema: {
|
|
53924
|
+
description: 'Filter staff members by space ID (UUID).',
|
|
53925
|
+
format: 'uuid',
|
|
53926
|
+
type: 'string',
|
|
53927
|
+
},
|
|
53928
|
+
},
|
|
53929
|
+
{
|
|
53930
|
+
in: 'query',
|
|
53931
|
+
name: 'limit',
|
|
53932
|
+
schema: {
|
|
53933
|
+
default: 500,
|
|
53934
|
+
description: 'Maximum number of records to return per page.',
|
|
53935
|
+
exclusiveMinimum: true,
|
|
53936
|
+
minimum: 0,
|
|
53937
|
+
type: 'integer',
|
|
53938
|
+
},
|
|
53939
|
+
},
|
|
53940
|
+
{
|
|
53941
|
+
in: 'query',
|
|
53942
|
+
name: 'created_before',
|
|
53943
|
+
schema: {
|
|
53944
|
+
description:
|
|
53945
|
+
'Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.',
|
|
53946
|
+
format: 'date-time',
|
|
53947
|
+
type: 'string',
|
|
53948
|
+
},
|
|
53949
|
+
},
|
|
53950
|
+
{
|
|
53951
|
+
in: 'query',
|
|
53952
|
+
name: 'page_cursor',
|
|
53953
|
+
schema: {
|
|
53954
|
+
description:
|
|
53955
|
+
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
53956
|
+
nullable: true,
|
|
53957
|
+
type: 'string',
|
|
53958
|
+
},
|
|
53959
|
+
},
|
|
53960
|
+
],
|
|
53961
|
+
responses: {
|
|
53962
|
+
200: {
|
|
53963
|
+
content: {
|
|
53964
|
+
'application/json': {
|
|
53965
|
+
schema: {
|
|
53966
|
+
properties: {
|
|
53967
|
+
ok: { type: 'boolean' },
|
|
53968
|
+
pagination: { $ref: '#/components/schemas/pagination' },
|
|
53969
|
+
staff_members: {
|
|
53970
|
+
items: { $ref: '#/components/schemas/staff_member' },
|
|
53971
|
+
type: 'array',
|
|
53972
|
+
},
|
|
53973
|
+
},
|
|
53974
|
+
required: ['staff_members', 'pagination', 'ok'],
|
|
53975
|
+
type: 'object',
|
|
53976
|
+
},
|
|
53977
|
+
},
|
|
53978
|
+
},
|
|
53979
|
+
description: 'OK',
|
|
53980
|
+
},
|
|
53981
|
+
400: { description: 'Bad Request' },
|
|
53982
|
+
401: { description: 'Unauthorized' },
|
|
53983
|
+
},
|
|
53984
|
+
security: [{ client_session_with_customer: [] }],
|
|
53985
|
+
summary: '/seam/customer/v1/staff_members/list',
|
|
53986
|
+
tags: [],
|
|
53987
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
|
|
53988
|
+
'x-fern-sdk-method-name': 'list',
|
|
53989
|
+
'x-fern-sdk-return-value': 'staff_members',
|
|
53990
|
+
'x-response-key': 'staff_members',
|
|
53991
|
+
'x-title': 'List Staff Members for Customer Space',
|
|
53992
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
53993
|
+
},
|
|
53994
|
+
post: {
|
|
53995
|
+
description:
|
|
53996
|
+
'Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.',
|
|
53997
|
+
operationId: 'seamCustomerV1StaffMembersListPost',
|
|
53998
|
+
requestBody: {
|
|
53999
|
+
content: {
|
|
54000
|
+
'application/json': {
|
|
54001
|
+
schema: {
|
|
54002
|
+
properties: {
|
|
54003
|
+
created_before: {
|
|
54004
|
+
description:
|
|
54005
|
+
'Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.',
|
|
54006
|
+
format: 'date-time',
|
|
54007
|
+
type: 'string',
|
|
54008
|
+
},
|
|
54009
|
+
limit: {
|
|
54010
|
+
default: 500,
|
|
54011
|
+
description:
|
|
54012
|
+
'Maximum number of records to return per page.',
|
|
54013
|
+
exclusiveMinimum: true,
|
|
54014
|
+
minimum: 0,
|
|
54015
|
+
type: 'integer',
|
|
54016
|
+
},
|
|
54017
|
+
page_cursor: {
|
|
54018
|
+
description:
|
|
54019
|
+
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
54020
|
+
nullable: true,
|
|
54021
|
+
type: 'string',
|
|
54022
|
+
},
|
|
54023
|
+
space_id: {
|
|
54024
|
+
description: 'Filter staff members by space ID (UUID).',
|
|
54025
|
+
format: 'uuid',
|
|
54026
|
+
type: 'string',
|
|
54027
|
+
},
|
|
54028
|
+
space_key: {
|
|
54029
|
+
description: 'Filter staff members by space key.',
|
|
54030
|
+
type: 'string',
|
|
54031
|
+
},
|
|
54032
|
+
},
|
|
54033
|
+
type: 'object',
|
|
54034
|
+
},
|
|
54035
|
+
},
|
|
54036
|
+
},
|
|
54037
|
+
},
|
|
54038
|
+
responses: {
|
|
54039
|
+
200: {
|
|
54040
|
+
content: {
|
|
54041
|
+
'application/json': {
|
|
54042
|
+
schema: {
|
|
54043
|
+
properties: {
|
|
54044
|
+
ok: { type: 'boolean' },
|
|
54045
|
+
pagination: { $ref: '#/components/schemas/pagination' },
|
|
54046
|
+
staff_members: {
|
|
54047
|
+
items: { $ref: '#/components/schemas/staff_member' },
|
|
54048
|
+
type: 'array',
|
|
54049
|
+
},
|
|
54050
|
+
},
|
|
54051
|
+
required: ['staff_members', 'pagination', 'ok'],
|
|
54052
|
+
type: 'object',
|
|
54053
|
+
},
|
|
54054
|
+
},
|
|
54055
|
+
},
|
|
54056
|
+
description: 'OK',
|
|
54057
|
+
},
|
|
54058
|
+
400: { description: 'Bad Request' },
|
|
54059
|
+
401: { description: 'Unauthorized' },
|
|
54060
|
+
},
|
|
54061
|
+
security: [{ client_session_with_customer: [] }],
|
|
54062
|
+
summary: '/seam/customer/v1/staff_members/list',
|
|
54063
|
+
tags: [],
|
|
54064
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
|
|
54065
|
+
'x-fern-sdk-method-name': 'list',
|
|
54066
|
+
'x-fern-sdk-return-value': 'staff_members',
|
|
54067
|
+
'x-response-key': 'staff_members',
|
|
54068
|
+
'x-title': 'List Staff Members for Customer Space',
|
|
54069
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
54070
|
+
},
|
|
54071
|
+
},
|
|
53785
54072
|
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
53786
54073
|
post: {
|
|
53787
54074
|
description:
|