@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.
@@ -10396,8 +10396,11 @@ export interface Routes {
10396
10396
  user_identity_email_address?: string | undefined;
10397
10397
  /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
10398
10398
  acs_system_id?: string | undefined;
10399
+ /** Maximum number of records to return per page. */
10399
10400
  limit?: number;
10400
10401
  created_before?: Date | undefined;
10402
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
10403
+ page_cursor?: string | undefined;
10401
10404
  };
10402
10405
  formData: {};
10403
10406
  jsonResponse: {
@@ -10495,6 +10498,13 @@ export interface Routes {
10495
10498
  phone_number?: string | undefined;
10496
10499
  is_managed: true;
10497
10500
  }>;
10501
+ /** Information about the current page of results. */
10502
+ pagination: {
10503
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
10504
+ next_page_cursor: string | null;
10505
+ /** Indicates whether there is another page of results after this one. */
10506
+ has_next_page: boolean;
10507
+ };
10498
10508
  };
10499
10509
  };
10500
10510
  '/acs/users/list_accessible_entrances': {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.351.0",
3
+ "version": "1.352.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -14,6 +14,7 @@ export const bridge_client_session = z.object({
14
14
  }).describe(`
15
15
  ---
16
16
  route_path: /seam/bridge/v1/bridge_client_sessions
17
+ undocumented: Seam Bridge Client only.
17
18
  ---
18
19
  `)
19
20
 
@@ -18705,7 +18705,18 @@ export default {
18705
18705
  type: 'string',
18706
18706
  },
18707
18707
  created_before: { format: 'date-time', type: 'string' },
18708
- limit: { default: 500, format: 'float', type: 'number' },
18708
+ limit: {
18709
+ default: 500,
18710
+ description:
18711
+ 'Maximum number of records to return per page.',
18712
+ format: 'float',
18713
+ type: 'number',
18714
+ },
18715
+ page_cursor: {
18716
+ description:
18717
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
18718
+ type: 'string',
18719
+ },
18709
18720
  user_identity_email_address: {
18710
18721
  description:
18711
18722
  'Email address of the user identity for which you want to retrieve all `acs_user`s.',
@@ -18739,8 +18750,27 @@ export default {
18739
18750
  type: 'array',
18740
18751
  },
18741
18752
  ok: { type: 'boolean' },
18753
+ pagination: {
18754
+ description:
18755
+ 'Information about the current page of results.',
18756
+ properties: {
18757
+ has_next_page: {
18758
+ description:
18759
+ 'Indicates whether there is another page of results after this one.',
18760
+ type: 'boolean',
18761
+ },
18762
+ next_page_cursor: {
18763
+ description:
18764
+ 'Opaque value that can be used to select the next page of results via the `page_cursor` parameter.',
18765
+ nullable: true,
18766
+ type: 'string',
18767
+ },
18768
+ },
18769
+ required: ['next_page_cursor', 'has_next_page'],
18770
+ type: 'object',
18771
+ },
18742
18772
  },
18743
- required: ['acs_users', 'ok'],
18773
+ required: ['acs_users', 'pagination', 'ok'],
18744
18774
  type: 'object',
18745
18775
  },
18746
18776
  },
@@ -23606,6 +23636,7 @@ export default {
23606
23636
  ],
23607
23637
  type: 'object',
23608
23638
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
23639
+ 'x-undocumented': 'Seam Bridge Client only.',
23609
23640
  },
23610
23641
  ok: { type: 'boolean' },
23611
23642
  },
@@ -23632,6 +23663,7 @@ export default {
23632
23663
  'x-fern-sdk-return-value': 'bridge_client_session',
23633
23664
  'x-response-key': 'bridge_client_session',
23634
23665
  'x-title': 'Create a Bridge Client Session',
23666
+ 'x-undocumented': 'Seam Bridge Client only.',
23635
23667
  },
23636
23668
  },
23637
23669
  '/seam/bridge/v1/bridge_client_sessions/get': {
@@ -23684,6 +23716,7 @@ export default {
23684
23716
  ],
23685
23717
  type: 'object',
23686
23718
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
23719
+ 'x-undocumented': 'Seam Bridge Client only.',
23687
23720
  },
23688
23721
  ok: { type: 'boolean' },
23689
23722
  },
@@ -23703,6 +23736,7 @@ export default {
23703
23736
  'x-fern-ignore': true,
23704
23737
  'x-response-key': 'bridge_client_session',
23705
23738
  'x-title': 'Get a Bridge Client Session',
23739
+ 'x-undocumented': 'Seam Bridge Client only.',
23706
23740
  },
23707
23741
  post: {
23708
23742
  description:
@@ -23753,6 +23787,7 @@ export default {
23753
23787
  ],
23754
23788
  type: 'object',
23755
23789
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
23790
+ 'x-undocumented': 'Seam Bridge Client only.',
23756
23791
  },
23757
23792
  ok: { type: 'boolean' },
23758
23793
  },
@@ -23779,6 +23814,7 @@ export default {
23779
23814
  'x-fern-sdk-return-value': 'bridge_client_session',
23780
23815
  'x-response-key': 'bridge_client_session',
23781
23816
  'x-title': 'Get a Bridge Client Session',
23817
+ 'x-undocumented': 'Seam Bridge Client only.',
23782
23818
  },
23783
23819
  },
23784
23820
  '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
@@ -23832,6 +23868,7 @@ export default {
23832
23868
  ],
23833
23869
  type: 'object',
23834
23870
  'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
23871
+ 'x-undocumented': 'Seam Bridge Client only.',
23835
23872
  },
23836
23873
  ok: { type: 'boolean' },
23837
23874
  },
@@ -23859,6 +23896,7 @@ export default {
23859
23896
  'x-fern-sdk-return-value': 'bridge_client_session',
23860
23897
  'x-response-key': 'bridge_client_session',
23861
23898
  'x-title': 'Regenerate a Bridge Client Session Pairing Code',
23899
+ 'x-undocumented': 'Seam Bridge Client only.',
23862
23900
  },
23863
23901
  },
23864
23902
  '/thermostats/activate_climate_preset': {
@@ -12449,8 +12449,11 @@ export interface Routes {
12449
12449
  user_identity_email_address?: string | undefined
12450
12450
  /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
12451
12451
  acs_system_id?: string | undefined
12452
+ /** Maximum number of records to return per page. */
12452
12453
  limit?: number
12453
12454
  created_before?: Date | undefined
12455
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
12456
+ page_cursor?: string | undefined
12454
12457
  }
12455
12458
  formData: {}
12456
12459
  jsonResponse: {
@@ -12574,6 +12577,13 @@ export interface Routes {
12574
12577
  phone_number?: string | undefined
12575
12578
  is_managed: true
12576
12579
  }>
12580
+ /** Information about the current page of results. */
12581
+ pagination: {
12582
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
12583
+ next_page_cursor: string | null
12584
+ /** Indicates whether there is another page of results after this one. */
12585
+ has_next_page: boolean
12586
+ }
12577
12587
  }
12578
12588
  }
12579
12589
  '/acs/users/list_accessible_entrances': {