@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.
Files changed (31) hide show
  1. package/dist/connect.cjs +316 -0
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +412 -1
  4. package/dist/index.cjs +316 -0
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -0
  7. package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/batch.d.ts +25 -0
  10. package/lib/seam/connect/models/customer/customer-data.d.ts +34 -0
  11. package/lib/seam/connect/models/customer/customer-data.js +5 -1
  12. package/lib/seam/connect/models/customer/customer-data.js.map +1 -1
  13. package/lib/seam/connect/models/customer/user-identity-resources.d.ts +39 -0
  14. package/lib/seam/connect/models/customer/user-identity-resources.js +15 -0
  15. package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -1
  16. package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
  17. package/lib/seam/connect/openapi.d.ts +293 -0
  18. package/lib/seam/connect/openapi.js +266 -0
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +88 -0
  21. package/lib/seam/connect/schemas.d.ts +1 -1
  22. package/lib/seam/connect/schemas.js +1 -1
  23. package/lib/seam/connect/schemas.js.map +1 -1
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  26. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  27. package/src/lib/seam/connect/models/customer/customer-data.ts +5 -0
  28. package/src/lib/seam/connect/models/customer/user-identity-resources.ts +18 -0
  29. package/src/lib/seam/connect/openapi.ts +287 -0
  30. package/src/lib/seam/connect/route-types.ts +92 -0
  31. package/src/lib/seam/connect/schemas.ts +1 -0
@@ -1157,6 +1157,10 @@ declare const _default: {
1157
1157
  required: string[];
1158
1158
  type: string;
1159
1159
  };
1160
+ can_belong_to_reservation: {
1161
+ description: string;
1162
+ type: string;
1163
+ };
1160
1164
  can_unlock_with_card: {
1161
1165
  description: string;
1162
1166
  type: string;
@@ -11517,6 +11521,10 @@ declare const _default: {
11517
11521
  required: string[];
11518
11522
  type: string;
11519
11523
  };
11524
+ can_belong_to_reservation: {
11525
+ description: string;
11526
+ type: string;
11527
+ };
11520
11528
  can_unlock_with_card: {
11521
11529
  description: string;
11522
11530
  type: string;
@@ -12210,6 +12218,37 @@ declare const _default: {
12210
12218
  'x-draft': string;
12211
12219
  'x-route-path': string;
12212
12220
  };
12221
+ staff_member: {
12222
+ description: string;
12223
+ properties: {
12224
+ email_address: {
12225
+ description: string;
12226
+ type: string;
12227
+ };
12228
+ name: {
12229
+ description: string;
12230
+ type: string;
12231
+ };
12232
+ phone_number: {
12233
+ description: string;
12234
+ type: string;
12235
+ };
12236
+ site_keys: {
12237
+ description: string;
12238
+ items: {
12239
+ type: string;
12240
+ };
12241
+ type: string;
12242
+ };
12243
+ staff_member_key: {
12244
+ description: string;
12245
+ type: string;
12246
+ };
12247
+ };
12248
+ required: string[];
12249
+ type: string;
12250
+ 'x-route-path': string;
12251
+ };
12213
12252
  thermostat_daily_program: {
12214
12253
  description: string;
12215
12254
  properties: {
@@ -32597,6 +32636,41 @@ declare const _default: {
32597
32636
  };
32598
32637
  type: string;
32599
32638
  };
32639
+ staff_members: {
32640
+ description: string;
32641
+ items: {
32642
+ description: string;
32643
+ properties: {
32644
+ email_address: {
32645
+ description: string;
32646
+ type: string;
32647
+ };
32648
+ name: {
32649
+ description: string;
32650
+ type: string;
32651
+ };
32652
+ phone_number: {
32653
+ description: string;
32654
+ type: string;
32655
+ };
32656
+ site_keys: {
32657
+ description: string;
32658
+ items: {
32659
+ type: string;
32660
+ };
32661
+ type: string;
32662
+ };
32663
+ staff_member_key: {
32664
+ description: string;
32665
+ type: string;
32666
+ };
32667
+ };
32668
+ required: string[];
32669
+ type: string;
32670
+ 'x-route-path': string;
32671
+ };
32672
+ type: string;
32673
+ };
32600
32674
  tenants: {
32601
32675
  description: string;
32602
32676
  items: {
@@ -33559,6 +33633,41 @@ declare const _default: {
33559
33633
  };
33560
33634
  type: string;
33561
33635
  };
33636
+ staff_members: {
33637
+ description: string;
33638
+ items: {
33639
+ description: string;
33640
+ properties: {
33641
+ email_address: {
33642
+ description: string;
33643
+ type: string;
33644
+ };
33645
+ name: {
33646
+ description: string;
33647
+ type: string;
33648
+ };
33649
+ phone_number: {
33650
+ description: string;
33651
+ type: string;
33652
+ };
33653
+ site_keys: {
33654
+ description: string;
33655
+ items: {
33656
+ type: string;
33657
+ };
33658
+ type: string;
33659
+ };
33660
+ staff_member_key: {
33661
+ description: string;
33662
+ type: string;
33663
+ };
33664
+ };
33665
+ required: string[];
33666
+ type: string;
33667
+ 'x-route-path': string;
33668
+ };
33669
+ type: string;
33670
+ };
33562
33671
  tenants: {
33563
33672
  description: string;
33564
33673
  items: {
@@ -44524,6 +44633,190 @@ declare const _default: {
44524
44633
  'x-title': string;
44525
44634
  };
44526
44635
  };
44636
+ '/seam/customer/v1/staff_members/list': {
44637
+ get: {
44638
+ description: string;
44639
+ operationId: string;
44640
+ parameters: ({
44641
+ in: string;
44642
+ name: string;
44643
+ schema: {
44644
+ description: string;
44645
+ type: string;
44646
+ format?: never;
44647
+ default?: never;
44648
+ exclusiveMinimum?: never;
44649
+ minimum?: never;
44650
+ nullable?: never;
44651
+ };
44652
+ } | {
44653
+ in: string;
44654
+ name: string;
44655
+ schema: {
44656
+ description: string;
44657
+ format: string;
44658
+ type: string;
44659
+ default?: never;
44660
+ exclusiveMinimum?: never;
44661
+ minimum?: never;
44662
+ nullable?: never;
44663
+ };
44664
+ } | {
44665
+ in: string;
44666
+ name: string;
44667
+ schema: {
44668
+ default: number;
44669
+ description: string;
44670
+ exclusiveMinimum: boolean;
44671
+ minimum: number;
44672
+ type: string;
44673
+ format?: never;
44674
+ nullable?: never;
44675
+ };
44676
+ } | {
44677
+ in: string;
44678
+ name: string;
44679
+ schema: {
44680
+ description: string;
44681
+ nullable: boolean;
44682
+ type: string;
44683
+ format?: never;
44684
+ default?: never;
44685
+ exclusiveMinimum?: never;
44686
+ minimum?: never;
44687
+ };
44688
+ })[];
44689
+ responses: {
44690
+ 200: {
44691
+ content: {
44692
+ 'application/json': {
44693
+ schema: {
44694
+ properties: {
44695
+ ok: {
44696
+ type: string;
44697
+ };
44698
+ pagination: {
44699
+ $ref: string;
44700
+ };
44701
+ staff_members: {
44702
+ items: {
44703
+ $ref: string;
44704
+ };
44705
+ type: string;
44706
+ };
44707
+ };
44708
+ required: string[];
44709
+ type: string;
44710
+ };
44711
+ };
44712
+ };
44713
+ description: string;
44714
+ };
44715
+ 400: {
44716
+ description: string;
44717
+ };
44718
+ 401: {
44719
+ description: string;
44720
+ };
44721
+ };
44722
+ security: {
44723
+ client_session_with_customer: never[];
44724
+ }[];
44725
+ summary: string;
44726
+ tags: never[];
44727
+ 'x-fern-sdk-group-name': string[];
44728
+ 'x-fern-sdk-method-name': string;
44729
+ 'x-fern-sdk-return-value': string;
44730
+ 'x-response-key': string;
44731
+ 'x-title': string;
44732
+ 'x-undocumented': string;
44733
+ };
44734
+ post: {
44735
+ description: string;
44736
+ operationId: string;
44737
+ requestBody: {
44738
+ content: {
44739
+ 'application/json': {
44740
+ schema: {
44741
+ properties: {
44742
+ created_before: {
44743
+ description: string;
44744
+ format: string;
44745
+ type: string;
44746
+ };
44747
+ limit: {
44748
+ default: number;
44749
+ description: string;
44750
+ exclusiveMinimum: boolean;
44751
+ minimum: number;
44752
+ type: string;
44753
+ };
44754
+ page_cursor: {
44755
+ description: string;
44756
+ nullable: boolean;
44757
+ type: string;
44758
+ };
44759
+ space_id: {
44760
+ description: string;
44761
+ format: string;
44762
+ type: string;
44763
+ };
44764
+ space_key: {
44765
+ description: string;
44766
+ type: string;
44767
+ };
44768
+ };
44769
+ type: string;
44770
+ };
44771
+ };
44772
+ };
44773
+ };
44774
+ responses: {
44775
+ 200: {
44776
+ content: {
44777
+ 'application/json': {
44778
+ schema: {
44779
+ properties: {
44780
+ ok: {
44781
+ type: string;
44782
+ };
44783
+ pagination: {
44784
+ $ref: string;
44785
+ };
44786
+ staff_members: {
44787
+ items: {
44788
+ $ref: string;
44789
+ };
44790
+ type: string;
44791
+ };
44792
+ };
44793
+ required: string[];
44794
+ type: string;
44795
+ };
44796
+ };
44797
+ };
44798
+ description: string;
44799
+ };
44800
+ 400: {
44801
+ description: string;
44802
+ };
44803
+ 401: {
44804
+ description: string;
44805
+ };
44806
+ };
44807
+ security: {
44808
+ client_session_with_customer: never[];
44809
+ }[];
44810
+ summary: string;
44811
+ tags: never[];
44812
+ 'x-fern-sdk-group-name': string[];
44813
+ 'x-fern-sdk-method-name': string;
44814
+ 'x-fern-sdk-return-value': string;
44815
+ 'x-response-key': string;
44816
+ 'x-title': string;
44817
+ 'x-undocumented': string;
44818
+ };
44819
+ };
44527
44820
  '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
44528
44821
  post: {
44529
44822
  description: string;
@@ -2457,6 +2457,10 @@ export default {
2457
2457
  required: ['door_type', 'door_name'],
2458
2458
  type: 'object',
2459
2459
  },
2460
+ can_belong_to_reservation: {
2461
+ description: 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
2462
+ type: 'boolean',
2463
+ },
2460
2464
  can_unlock_with_card: {
2461
2465
  description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
2462
2466
  type: 'boolean',
@@ -17884,6 +17888,10 @@ export default {
17884
17888
  required: ['door_type', 'door_name'],
17885
17889
  type: 'object',
17886
17890
  },
17891
+ can_belong_to_reservation: {
17892
+ description: 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
17893
+ type: 'boolean',
17894
+ },
17887
17895
  can_unlock_with_card: {
17888
17896
  description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
17889
17897
  type: 'boolean',
@@ -18770,6 +18778,35 @@ export default {
18770
18778
  'x-draft': 'Early access.',
18771
18779
  'x-route-path': '/spaces',
18772
18780
  },
18781
+ staff_member: {
18782
+ description: 'Represents a staff member for a specific customer.',
18783
+ properties: {
18784
+ email_address: {
18785
+ description: 'Email address associated with the user identity.',
18786
+ type: 'string',
18787
+ },
18788
+ name: {
18789
+ description: 'Your display name for this user identity resource.',
18790
+ type: 'string',
18791
+ },
18792
+ phone_number: {
18793
+ description: 'Phone number associated with the user identity.',
18794
+ type: 'string',
18795
+ },
18796
+ site_keys: {
18797
+ description: 'List of unique identifiers for the sites the staff member is associated with.',
18798
+ items: { type: 'string' },
18799
+ type: 'array',
18800
+ },
18801
+ staff_member_key: {
18802
+ description: 'Your unique identifier for the staff.',
18803
+ type: 'string',
18804
+ },
18805
+ },
18806
+ required: ['name', 'staff_member_key', 'site_keys'],
18807
+ type: 'object',
18808
+ 'x-route-path': '/seam/customer/v1/staff_members',
18809
+ },
18773
18810
  thermostat_daily_program: {
18774
18811
  description: '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.',
18775
18812
  properties: {
@@ -37972,6 +38009,43 @@ export default {
37972
38009
  },
37973
38010
  type: 'array',
37974
38011
  },
38012
+ staff_members: {
38013
+ description: 'List of staff members.',
38014
+ items: {
38015
+ description: 'Represents a staff member for a specific customer.',
38016
+ properties: {
38017
+ email_address: {
38018
+ description: 'Email address associated with the user identity.',
38019
+ type: 'string',
38020
+ },
38021
+ name: {
38022
+ description: 'Your display name for this user identity resource.',
38023
+ type: 'string',
38024
+ },
38025
+ phone_number: {
38026
+ description: 'Phone number associated with the user identity.',
38027
+ type: 'string',
38028
+ },
38029
+ site_keys: {
38030
+ description: 'List of unique identifiers for the sites the staff member is associated with.',
38031
+ items: { type: 'string' },
38032
+ type: 'array',
38033
+ },
38034
+ staff_member_key: {
38035
+ description: 'Your unique identifier for the staff.',
38036
+ type: 'string',
38037
+ },
38038
+ },
38039
+ required: [
38040
+ 'name',
38041
+ 'staff_member_key',
38042
+ 'site_keys',
38043
+ ],
38044
+ type: 'object',
38045
+ 'x-route-path': '/seam/customer/v1/staff_members',
38046
+ },
38047
+ type: 'array',
38048
+ },
37975
38049
  tenants: {
37976
38050
  description: 'List of tenants.',
37977
38051
  items: {
@@ -38951,6 +39025,39 @@ export default {
38951
39025
  },
38952
39026
  type: 'array',
38953
39027
  },
39028
+ staff_members: {
39029
+ description: 'List of staff members.',
39030
+ items: {
39031
+ description: 'Represents a staff member for a specific customer.',
39032
+ properties: {
39033
+ email_address: {
39034
+ description: 'Email address associated with the user identity.',
39035
+ type: 'string',
39036
+ },
39037
+ name: {
39038
+ description: 'Your display name for this user identity resource.',
39039
+ type: 'string',
39040
+ },
39041
+ phone_number: {
39042
+ description: 'Phone number associated with the user identity.',
39043
+ type: 'string',
39044
+ },
39045
+ site_keys: {
39046
+ description: 'List of unique identifiers for the sites the staff member is associated with.',
39047
+ items: { type: 'string' },
39048
+ type: 'array',
39049
+ },
39050
+ staff_member_key: {
39051
+ description: 'Your unique identifier for the staff.',
39052
+ type: 'string',
39053
+ },
39054
+ },
39055
+ required: ['name', 'staff_member_key', 'site_keys'],
39056
+ type: 'object',
39057
+ 'x-route-path': '/seam/customer/v1/staff_members',
39058
+ },
39059
+ type: 'array',
39060
+ },
38954
39061
  tenants: {
38955
39062
  description: 'List of tenants.',
38956
39063
  items: {
@@ -49590,6 +49697,165 @@ export default {
49590
49697
  'x-title': 'List Spaces',
49591
49698
  },
49592
49699
  },
49700
+ '/seam/customer/v1/staff_members/list': {
49701
+ get: {
49702
+ description: '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.',
49703
+ operationId: 'seamCustomerV1StaffMembersListGet',
49704
+ parameters: [
49705
+ {
49706
+ in: 'query',
49707
+ name: 'space_key',
49708
+ schema: {
49709
+ description: 'Filter staff members by space key.',
49710
+ type: 'string',
49711
+ },
49712
+ },
49713
+ {
49714
+ in: 'query',
49715
+ name: 'space_id',
49716
+ schema: {
49717
+ description: 'Filter staff members by space ID (UUID).',
49718
+ format: 'uuid',
49719
+ type: 'string',
49720
+ },
49721
+ },
49722
+ {
49723
+ in: 'query',
49724
+ name: 'limit',
49725
+ schema: {
49726
+ default: 500,
49727
+ description: 'Maximum number of records to return per page.',
49728
+ exclusiveMinimum: true,
49729
+ minimum: 0,
49730
+ type: 'integer',
49731
+ },
49732
+ },
49733
+ {
49734
+ in: 'query',
49735
+ name: 'created_before',
49736
+ schema: {
49737
+ description: 'Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.',
49738
+ format: 'date-time',
49739
+ type: 'string',
49740
+ },
49741
+ },
49742
+ {
49743
+ in: 'query',
49744
+ name: 'page_cursor',
49745
+ schema: {
49746
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
49747
+ nullable: true,
49748
+ type: 'string',
49749
+ },
49750
+ },
49751
+ ],
49752
+ responses: {
49753
+ 200: {
49754
+ content: {
49755
+ 'application/json': {
49756
+ schema: {
49757
+ properties: {
49758
+ ok: { type: 'boolean' },
49759
+ pagination: { $ref: '#/components/schemas/pagination' },
49760
+ staff_members: {
49761
+ items: { $ref: '#/components/schemas/staff_member' },
49762
+ type: 'array',
49763
+ },
49764
+ },
49765
+ required: ['staff_members', 'pagination', 'ok'],
49766
+ type: 'object',
49767
+ },
49768
+ },
49769
+ },
49770
+ description: 'OK',
49771
+ },
49772
+ 400: { description: 'Bad Request' },
49773
+ 401: { description: 'Unauthorized' },
49774
+ },
49775
+ security: [{ client_session_with_customer: [] }],
49776
+ summary: '/seam/customer/v1/staff_members/list',
49777
+ tags: [],
49778
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
49779
+ 'x-fern-sdk-method-name': 'list',
49780
+ 'x-fern-sdk-return-value': 'staff_members',
49781
+ 'x-response-key': 'staff_members',
49782
+ 'x-title': 'List Staff Members for Customer Space',
49783
+ 'x-undocumented': 'Internal endpoint for customer portals.',
49784
+ },
49785
+ post: {
49786
+ description: '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.',
49787
+ operationId: 'seamCustomerV1StaffMembersListPost',
49788
+ requestBody: {
49789
+ content: {
49790
+ 'application/json': {
49791
+ schema: {
49792
+ properties: {
49793
+ created_before: {
49794
+ description: 'Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.',
49795
+ format: 'date-time',
49796
+ type: 'string',
49797
+ },
49798
+ limit: {
49799
+ default: 500,
49800
+ description: 'Maximum number of records to return per page.',
49801
+ exclusiveMinimum: true,
49802
+ minimum: 0,
49803
+ type: 'integer',
49804
+ },
49805
+ page_cursor: {
49806
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
49807
+ nullable: true,
49808
+ type: 'string',
49809
+ },
49810
+ space_id: {
49811
+ description: 'Filter staff members by space ID (UUID).',
49812
+ format: 'uuid',
49813
+ type: 'string',
49814
+ },
49815
+ space_key: {
49816
+ description: 'Filter staff members by space key.',
49817
+ type: 'string',
49818
+ },
49819
+ },
49820
+ type: 'object',
49821
+ },
49822
+ },
49823
+ },
49824
+ },
49825
+ responses: {
49826
+ 200: {
49827
+ content: {
49828
+ 'application/json': {
49829
+ schema: {
49830
+ properties: {
49831
+ ok: { type: 'boolean' },
49832
+ pagination: { $ref: '#/components/schemas/pagination' },
49833
+ staff_members: {
49834
+ items: { $ref: '#/components/schemas/staff_member' },
49835
+ type: 'array',
49836
+ },
49837
+ },
49838
+ required: ['staff_members', 'pagination', 'ok'],
49839
+ type: 'object',
49840
+ },
49841
+ },
49842
+ },
49843
+ description: 'OK',
49844
+ },
49845
+ 400: { description: 'Bad Request' },
49846
+ 401: { description: 'Unauthorized' },
49847
+ },
49848
+ security: [{ client_session_with_customer: [] }],
49849
+ summary: '/seam/customer/v1/staff_members/list',
49850
+ tags: [],
49851
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
49852
+ 'x-fern-sdk-method-name': 'list',
49853
+ 'x-fern-sdk-return-value': 'staff_members',
49854
+ 'x-response-key': 'staff_members',
49855
+ 'x-title': 'List Staff Members for Customer Space',
49856
+ 'x-undocumented': 'Internal endpoint for customer portals.',
49857
+ },
49858
+ },
49593
49859
  '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
49594
49860
  post: {
49595
49861
  description: 'Receives webhook events from external connector APIs and processes them into partner resources.',