@seamapi/types 1.351.0 → 1.352.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.
@@ -30365,9 +30365,14 @@ declare const _default: {
30365
30365
  };
30366
30366
  limit: {
30367
30367
  default: number;
30368
+ description: string;
30368
30369
  format: string;
30369
30370
  type: string;
30370
30371
  };
30372
+ page_cursor: {
30373
+ description: string;
30374
+ type: string;
30375
+ };
30371
30376
  user_identity_email_address: {
30372
30377
  description: string;
30373
30378
  type: string;
@@ -30402,6 +30407,22 @@ declare const _default: {
30402
30407
  ok: {
30403
30408
  type: string;
30404
30409
  };
30410
+ pagination: {
30411
+ description: string;
30412
+ properties: {
30413
+ has_next_page: {
30414
+ description: string;
30415
+ type: string;
30416
+ };
30417
+ next_page_cursor: {
30418
+ description: string;
30419
+ nullable: boolean;
30420
+ type: string;
30421
+ };
30422
+ };
30423
+ required: string[];
30424
+ type: string;
30425
+ };
30405
30426
  };
30406
30427
  required: string[];
30407
30428
  type: string;
@@ -36052,6 +36073,7 @@ declare const _default: {
36052
36073
  required: string[];
36053
36074
  type: string;
36054
36075
  'x-route-path': string;
36076
+ 'x-undocumented': string;
36055
36077
  };
36056
36078
  ok: {
36057
36079
  type: string;
@@ -36081,6 +36103,7 @@ declare const _default: {
36081
36103
  'x-fern-sdk-return-value': string;
36082
36104
  'x-response-key': string;
36083
36105
  'x-title': string;
36106
+ 'x-undocumented': string;
36084
36107
  };
36085
36108
  };
36086
36109
  '/seam/bridge/v1/bridge_client_sessions/get': {
@@ -36135,6 +36158,7 @@ declare const _default: {
36135
36158
  required: string[];
36136
36159
  type: string;
36137
36160
  'x-route-path': string;
36161
+ 'x-undocumented': string;
36138
36162
  };
36139
36163
  ok: {
36140
36164
  type: string;
@@ -36162,6 +36186,7 @@ declare const _default: {
36162
36186
  'x-fern-ignore': boolean;
36163
36187
  'x-response-key': string;
36164
36188
  'x-title': string;
36189
+ 'x-undocumented': string;
36165
36190
  };
36166
36191
  post: {
36167
36192
  description: string;
@@ -36214,6 +36239,7 @@ declare const _default: {
36214
36239
  required: string[];
36215
36240
  type: string;
36216
36241
  'x-route-path': string;
36242
+ 'x-undocumented': string;
36217
36243
  };
36218
36244
  ok: {
36219
36245
  type: string;
@@ -36243,6 +36269,7 @@ declare const _default: {
36243
36269
  'x-fern-sdk-return-value': string;
36244
36270
  'x-response-key': string;
36245
36271
  'x-title': string;
36272
+ 'x-undocumented': string;
36246
36273
  };
36247
36274
  };
36248
36275
  '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
@@ -36297,6 +36324,7 @@ declare const _default: {
36297
36324
  required: string[];
36298
36325
  type: string;
36299
36326
  'x-route-path': string;
36327
+ 'x-undocumented': string;
36300
36328
  };
36301
36329
  ok: {
36302
36330
  type: string;
@@ -36326,6 +36354,7 @@ declare const _default: {
36326
36354
  'x-fern-sdk-return-value': string;
36327
36355
  'x-response-key': string;
36328
36356
  'x-title': string;
36357
+ 'x-undocumented': string;
36329
36358
  };
36330
36359
  };
36331
36360
  '/thermostats/activate_climate_preset': {
@@ -51500,8 +51529,11 @@ interface Routes {
51500
51529
  user_identity_email_address?: string | undefined;
51501
51530
  /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
51502
51531
  acs_system_id?: string | undefined;
51532
+ /** Maximum number of records to return per page. */
51503
51533
  limit?: number;
51504
51534
  created_before?: Date | undefined;
51535
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
51536
+ page_cursor?: string | undefined;
51505
51537
  };
51506
51538
  formData: {};
51507
51539
  jsonResponse: {
@@ -51599,6 +51631,13 @@ interface Routes {
51599
51631
  phone_number?: string | undefined;
51600
51632
  is_managed: true;
51601
51633
  }>;
51634
+ /** Information about the current page of results. */
51635
+ pagination: {
51636
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
51637
+ next_page_cursor: string | null;
51638
+ /** Indicates whether there is another page of results after this one. */
51639
+ has_next_page: boolean;
51640
+ };
51602
51641
  };
51603
51642
  };
51604
51643
  '/acs/users/list_accessible_entrances': {
@@ -13,6 +13,7 @@ export const bridge_client_session = z.object({
13
13
  }).describe(`
14
14
  ---
15
15
  route_path: /seam/bridge/v1/bridge_client_sessions
16
+ undocumented: Seam Bridge Client only.
16
17
  ---
17
18
  `);
18
19
  //# sourceMappingURL=bridge_client_session.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"bridge_client_session.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/bridges/bridge_client_session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC3C,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE;IACvC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAClC,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9C,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE;IACnC,oCAAoC,EAAE,CAAC,CAAC,MAAM,EAAE;CACjD,CAAC,CAAC,QAAQ,CAAC;;;;CAIX,CAAC,CAAA"}
1
+ {"version":3,"file":"bridge_client_session.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/bridges/bridge_client_session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC3C,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE;IACvC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAClC,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9C,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE;IACnC,oCAAoC,EAAE,CAAC,CAAC,MAAM,EAAE;CACjD,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}
@@ -13764,9 +13764,14 @@ declare const _default: {
13764
13764
  };
13765
13765
  limit: {
13766
13766
  default: number;
13767
+ description: string;
13767
13768
  format: string;
13768
13769
  type: string;
13769
13770
  };
13771
+ page_cursor: {
13772
+ description: string;
13773
+ type: string;
13774
+ };
13770
13775
  user_identity_email_address: {
13771
13776
  description: string;
13772
13777
  type: string;
@@ -13801,6 +13806,22 @@ declare const _default: {
13801
13806
  ok: {
13802
13807
  type: string;
13803
13808
  };
13809
+ pagination: {
13810
+ description: string;
13811
+ properties: {
13812
+ has_next_page: {
13813
+ description: string;
13814
+ type: string;
13815
+ };
13816
+ next_page_cursor: {
13817
+ description: string;
13818
+ nullable: boolean;
13819
+ type: string;
13820
+ };
13821
+ };
13822
+ required: string[];
13823
+ type: string;
13824
+ };
13804
13825
  };
13805
13826
  required: string[];
13806
13827
  type: string;
@@ -19451,6 +19472,7 @@ declare const _default: {
19451
19472
  required: string[];
19452
19473
  type: string;
19453
19474
  'x-route-path': string;
19475
+ 'x-undocumented': string;
19454
19476
  };
19455
19477
  ok: {
19456
19478
  type: string;
@@ -19480,6 +19502,7 @@ declare const _default: {
19480
19502
  'x-fern-sdk-return-value': string;
19481
19503
  'x-response-key': string;
19482
19504
  'x-title': string;
19505
+ 'x-undocumented': string;
19483
19506
  };
19484
19507
  };
19485
19508
  '/seam/bridge/v1/bridge_client_sessions/get': {
@@ -19534,6 +19557,7 @@ declare const _default: {
19534
19557
  required: string[];
19535
19558
  type: string;
19536
19559
  'x-route-path': string;
19560
+ 'x-undocumented': string;
19537
19561
  };
19538
19562
  ok: {
19539
19563
  type: string;
@@ -19561,6 +19585,7 @@ declare const _default: {
19561
19585
  'x-fern-ignore': boolean;
19562
19586
  'x-response-key': string;
19563
19587
  'x-title': string;
19588
+ 'x-undocumented': string;
19564
19589
  };
19565
19590
  post: {
19566
19591
  description: string;
@@ -19613,6 +19638,7 @@ declare const _default: {
19613
19638
  required: string[];
19614
19639
  type: string;
19615
19640
  'x-route-path': string;
19641
+ 'x-undocumented': string;
19616
19642
  };
19617
19643
  ok: {
19618
19644
  type: string;
@@ -19642,6 +19668,7 @@ declare const _default: {
19642
19668
  'x-fern-sdk-return-value': string;
19643
19669
  'x-response-key': string;
19644
19670
  'x-title': string;
19671
+ 'x-undocumented': string;
19645
19672
  };
19646
19673
  };
19647
19674
  '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
@@ -19696,6 +19723,7 @@ declare const _default: {
19696
19723
  required: string[];
19697
19724
  type: string;
19698
19725
  'x-route-path': string;
19726
+ 'x-undocumented': string;
19699
19727
  };
19700
19728
  ok: {
19701
19729
  type: string;
@@ -19725,6 +19753,7 @@ declare const _default: {
19725
19753
  'x-fern-sdk-return-value': string;
19726
19754
  'x-response-key': string;
19727
19755
  'x-title': string;
19756
+ 'x-undocumented': string;
19728
19757
  };
19729
19758
  };
19730
19759
  '/thermostats/activate_climate_preset': {
@@ -17539,7 +17539,16 @@ export default {
17539
17539
  type: 'string',
17540
17540
  },
17541
17541
  created_before: { format: 'date-time', type: 'string' },
17542
- limit: { default: 500, format: 'float', type: 'number' },
17542
+ limit: {
17543
+ default: 500,
17544
+ description: 'Maximum number of records to return per page.',
17545
+ format: 'float',
17546
+ type: 'number',
17547
+ },
17548
+ page_cursor: {
17549
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
17550
+ type: 'string',
17551
+ },
17543
17552
  user_identity_email_address: {
17544
17553
  description: 'Email address of the user identity for which you want to retrieve all `acs_user`s.',
17545
17554
  type: 'string',
@@ -17570,8 +17579,24 @@ export default {
17570
17579
  type: 'array',
17571
17580
  },
17572
17581
  ok: { type: 'boolean' },
17582
+ pagination: {
17583
+ description: 'Information about the current page of results.',
17584
+ properties: {
17585
+ has_next_page: {
17586
+ description: 'Indicates whether there is another page of results after this one.',
17587
+ type: 'boolean',
17588
+ },
17589
+ next_page_cursor: {
17590
+ description: 'Opaque value that can be used to select the next page of results via the `page_cursor` parameter.',
17591
+ nullable: true,
17592
+ type: 'string',
17593
+ },
17594
+ },
17595
+ required: ['next_page_cursor', 'has_next_page'],
17596
+ type: 'object',
17597
+ },
17573
17598
  },
17574
- required: ['acs_users', 'ok'],
17599
+ required: ['acs_users', 'pagination', 'ok'],
17575
17600
  type: 'object',
17576
17601
  },
17577
17602
  },
@@ -22363,6 +22388,7 @@ export default {
22363
22388
  ],
22364
22389
  type: 'object',
22365
22390
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
22391
+ 'x-undocumented': 'Seam Bridge Client only.',
22366
22392
  },
22367
22393
  ok: { type: 'boolean' },
22368
22394
  },
@@ -22389,6 +22415,7 @@ export default {
22389
22415
  'x-fern-sdk-return-value': 'bridge_client_session',
22390
22416
  'x-response-key': 'bridge_client_session',
22391
22417
  'x-title': 'Create a Bridge Client Session',
22418
+ 'x-undocumented': 'Seam Bridge Client only.',
22392
22419
  },
22393
22420
  },
22394
22421
  '/seam/bridge/v1/bridge_client_sessions/get': {
@@ -22440,6 +22467,7 @@ export default {
22440
22467
  ],
22441
22468
  type: 'object',
22442
22469
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
22470
+ 'x-undocumented': 'Seam Bridge Client only.',
22443
22471
  },
22444
22472
  ok: { type: 'boolean' },
22445
22473
  },
@@ -22459,6 +22487,7 @@ export default {
22459
22487
  'x-fern-ignore': true,
22460
22488
  'x-response-key': 'bridge_client_session',
22461
22489
  'x-title': 'Get a Bridge Client Session',
22490
+ 'x-undocumented': 'Seam Bridge Client only.',
22462
22491
  },
22463
22492
  post: {
22464
22493
  description: 'Returns the bridge client session associated with the session token used.',
@@ -22508,6 +22537,7 @@ export default {
22508
22537
  ],
22509
22538
  type: 'object',
22510
22539
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
22540
+ 'x-undocumented': 'Seam Bridge Client only.',
22511
22541
  },
22512
22542
  ok: { type: 'boolean' },
22513
22543
  },
@@ -22534,6 +22564,7 @@ export default {
22534
22564
  'x-fern-sdk-return-value': 'bridge_client_session',
22535
22565
  'x-response-key': 'bridge_client_session',
22536
22566
  'x-title': 'Get a Bridge Client Session',
22567
+ 'x-undocumented': 'Seam Bridge Client only.',
22537
22568
  },
22538
22569
  },
22539
22570
  '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
@@ -22585,6 +22616,7 @@ export default {
22585
22616
  ],
22586
22617
  type: 'object',
22587
22618
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
22619
+ 'x-undocumented': 'Seam Bridge Client only.',
22588
22620
  },
22589
22621
  ok: { type: 'boolean' },
22590
22622
  },
@@ -22611,6 +22643,7 @@ export default {
22611
22643
  'x-fern-sdk-return-value': 'bridge_client_session',
22612
22644
  'x-response-key': 'bridge_client_session',
22613
22645
  'x-title': 'Regenerate a Bridge Client Session Pairing Code',
22646
+ 'x-undocumented': 'Seam Bridge Client only.',
22614
22647
  },
22615
22648
  },
22616
22649
  '/thermostats/activate_climate_preset': {