@seamapi/types 1.781.0 → 1.782.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.
@@ -69728,6 +69728,10 @@ export type Routes = {
69728
69728
  connected_account_id?: string | undefined;
69729
69729
  /** Filter spaces by space_key. */
69730
69730
  space_key?: string | undefined;
69731
+ /** Maximum number of records to return per page. */
69732
+ limit?: number;
69733
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
69734
+ page_cursor?: (string | undefined) | null;
69731
69735
  };
69732
69736
  formData: {};
69733
69737
  jsonResponse: {
@@ -69753,6 +69757,15 @@ export type Routes = {
69753
69757
  /** */
69754
69758
  parent_space_key?: string | undefined;
69755
69759
  }[];
69760
+ /** Information about the current page of results. */
69761
+ pagination: {
69762
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
69763
+ next_page_cursor: string | null;
69764
+ /** Indicates whether there is another page of results after this one. */
69765
+ has_next_page: boolean;
69766
+ /** URL to get the next page of results. */
69767
+ next_page_url: string | null;
69768
+ };
69756
69769
  };
69757
69770
  maxDuration: undefined;
69758
69771
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.781.0",
3
+ "version": "1.782.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -72961,6 +72961,26 @@ export default {
72961
72961
  type: 'string',
72962
72962
  },
72963
72963
  },
72964
+ {
72965
+ in: 'query',
72966
+ name: 'limit',
72967
+ schema: {
72968
+ default: 500,
72969
+ description: 'Maximum number of records to return per page.',
72970
+ format: 'float',
72971
+ type: 'number',
72972
+ },
72973
+ },
72974
+ {
72975
+ in: 'query',
72976
+ name: 'page_cursor',
72977
+ schema: {
72978
+ description:
72979
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
72980
+ nullable: true,
72981
+ type: 'string',
72982
+ },
72983
+ },
72964
72984
  ],
72965
72985
  responses: {
72966
72986
  200: {
@@ -72969,12 +72989,13 @@ export default {
72969
72989
  schema: {
72970
72990
  properties: {
72971
72991
  ok: { type: 'boolean' },
72992
+ pagination: { $ref: '#/components/schemas/pagination' },
72972
72993
  spaces: {
72973
72994
  items: { $ref: '#/components/schemas/space' },
72974
72995
  type: 'array',
72975
72996
  },
72976
72997
  },
72977
- required: ['spaces', 'ok'],
72998
+ required: ['spaces', 'pagination', 'ok'],
72978
72999
  type: 'object',
72979
73000
  },
72980
73001
  },
@@ -73020,6 +73041,19 @@ export default {
73020
73041
  'Customer key for which you want to list spaces.',
73021
73042
  type: 'string',
73022
73043
  },
73044
+ limit: {
73045
+ default: 500,
73046
+ description:
73047
+ 'Maximum number of records to return per page.',
73048
+ format: 'float',
73049
+ type: 'number',
73050
+ },
73051
+ page_cursor: {
73052
+ description:
73053
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
73054
+ nullable: true,
73055
+ type: 'string',
73056
+ },
73023
73057
  search: {
73024
73058
  description:
73025
73059
  'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
@@ -73043,12 +73077,13 @@ export default {
73043
73077
  schema: {
73044
73078
  properties: {
73045
73079
  ok: { type: 'boolean' },
73080
+ pagination: { $ref: '#/components/schemas/pagination' },
73046
73081
  spaces: {
73047
73082
  items: { $ref: '#/components/schemas/space' },
73048
73083
  type: 'array',
73049
73084
  },
73050
73085
  },
73051
- required: ['spaces', 'ok'],
73086
+ required: ['spaces', 'pagination', 'ok'],
73052
73087
  type: 'object',
73053
73088
  },
73054
73089
  },
@@ -82914,6 +82914,10 @@ export type Routes = {
82914
82914
  connected_account_id?: string | undefined
82915
82915
  /** Filter spaces by space_key. */
82916
82916
  space_key?: string | undefined
82917
+ /** Maximum number of records to return per page. */
82918
+ limit?: number
82919
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
82920
+ page_cursor?: (string | undefined) | null
82917
82921
  }
82918
82922
  formData: {}
82919
82923
  jsonResponse: {
@@ -82939,6 +82943,15 @@ export type Routes = {
82939
82943
  /** */
82940
82944
  parent_space_key?: string | undefined
82941
82945
  }[]
82946
+ /** Information about the current page of results. */
82947
+ pagination: {
82948
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
82949
+ next_page_cursor: string | null
82950
+ /** Indicates whether there is another page of results after this one. */
82951
+ has_next_page: boolean
82952
+ /** URL to get the next page of results. */
82953
+ next_page_url: string | null
82954
+ }
82942
82955
  }
82943
82956
  maxDuration: undefined
82944
82957
  }