@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.
@@ -124960,6 +124960,8 @@ declare const _default: {
124960
124960
  format?: never;
124961
124961
  'x-draft'?: never;
124962
124962
  'x-undocumented'?: never;
124963
+ default?: never;
124964
+ nullable?: never;
124963
124965
  };
124964
124966
  } | {
124965
124967
  in: string;
@@ -124971,6 +124973,8 @@ declare const _default: {
124971
124973
  format?: never;
124972
124974
  'x-draft'?: never;
124973
124975
  'x-undocumented'?: never;
124976
+ default?: never;
124977
+ nullable?: never;
124974
124978
  };
124975
124979
  } | {
124976
124980
  in: string;
@@ -124982,6 +124986,34 @@ declare const _default: {
124982
124986
  'x-draft': string;
124983
124987
  'x-undocumented': string;
124984
124988
  minLength?: never;
124989
+ default?: never;
124990
+ nullable?: never;
124991
+ };
124992
+ } | {
124993
+ in: string;
124994
+ name: string;
124995
+ schema: {
124996
+ default: number;
124997
+ description: string;
124998
+ format: string;
124999
+ type: string;
125000
+ minLength?: never;
125001
+ 'x-draft'?: never;
125002
+ 'x-undocumented'?: never;
125003
+ nullable?: never;
125004
+ };
125005
+ } | {
125006
+ in: string;
125007
+ name: string;
125008
+ schema: {
125009
+ description: string;
125010
+ nullable: boolean;
125011
+ type: string;
125012
+ minLength?: never;
125013
+ format?: never;
125014
+ 'x-draft'?: never;
125015
+ 'x-undocumented'?: never;
125016
+ default?: never;
124985
125017
  };
124986
125018
  })[];
124987
125019
  responses: {
@@ -124993,6 +125025,9 @@ declare const _default: {
124993
125025
  ok: {
124994
125026
  type: string;
124995
125027
  };
125028
+ pagination: {
125029
+ $ref: string;
125030
+ };
124996
125031
  spaces: {
124997
125032
  items: {
124998
125033
  $ref: string;
@@ -125063,6 +125098,17 @@ declare const _default: {
125063
125098
  description: string;
125064
125099
  type: string;
125065
125100
  };
125101
+ limit: {
125102
+ default: number;
125103
+ description: string;
125104
+ format: string;
125105
+ type: string;
125106
+ };
125107
+ page_cursor: {
125108
+ description: string;
125109
+ nullable: boolean;
125110
+ type: string;
125111
+ };
125066
125112
  search: {
125067
125113
  description: string;
125068
125114
  minLength: number;
@@ -125087,6 +125133,9 @@ declare const _default: {
125087
125133
  ok: {
125088
125134
  type: string;
125089
125135
  };
125136
+ pagination: {
125137
+ $ref: string;
125138
+ };
125090
125139
  spaces: {
125091
125140
  items: {
125092
125141
  $ref: string;
@@ -205578,6 +205627,10 @@ type Routes = {
205578
205627
  connected_account_id?: string | undefined;
205579
205628
  /** Filter spaces by space_key. */
205580
205629
  space_key?: string | undefined;
205630
+ /** Maximum number of records to return per page. */
205631
+ limit?: number;
205632
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
205633
+ page_cursor?: (string | undefined) | null;
205581
205634
  };
205582
205635
  formData: {};
205583
205636
  jsonResponse: {
@@ -205603,6 +205656,15 @@ type Routes = {
205603
205656
  /** */
205604
205657
  parent_space_key?: string | undefined;
205605
205658
  }[];
205659
+ /** Information about the current page of results. */
205660
+ pagination: {
205661
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
205662
+ next_page_cursor: string | null;
205663
+ /** Indicates whether there is another page of results after this one. */
205664
+ has_next_page: boolean;
205665
+ /** URL to get the next page of results. */
205666
+ next_page_url: string | null;
205667
+ };
205606
205668
  };
205607
205669
  maxDuration: undefined;
205608
205670
  };
package/dist/index.cjs CHANGED
@@ -74066,6 +74066,25 @@ var openapi_default = {
74066
74066
  description: "Filter spaces by space_key.",
74067
74067
  type: "string"
74068
74068
  }
74069
+ },
74070
+ {
74071
+ in: "query",
74072
+ name: "limit",
74073
+ schema: {
74074
+ default: 500,
74075
+ description: "Maximum number of records to return per page.",
74076
+ format: "float",
74077
+ type: "number"
74078
+ }
74079
+ },
74080
+ {
74081
+ in: "query",
74082
+ name: "page_cursor",
74083
+ schema: {
74084
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
74085
+ nullable: true,
74086
+ type: "string"
74087
+ }
74069
74088
  }
74070
74089
  ],
74071
74090
  responses: {
@@ -74075,12 +74094,13 @@ var openapi_default = {
74075
74094
  schema: {
74076
74095
  properties: {
74077
74096
  ok: { type: "boolean" },
74097
+ pagination: { $ref: "#/components/schemas/pagination" },
74078
74098
  spaces: {
74079
74099
  items: { $ref: "#/components/schemas/space" },
74080
74100
  type: "array"
74081
74101
  }
74082
74102
  },
74083
- required: ["spaces", "ok"],
74103
+ required: ["spaces", "pagination", "ok"],
74084
74104
  type: "object"
74085
74105
  }
74086
74106
  }
@@ -74124,6 +74144,17 @@ var openapi_default = {
74124
74144
  description: "Customer key for which you want to list spaces.",
74125
74145
  type: "string"
74126
74146
  },
74147
+ limit: {
74148
+ default: 500,
74149
+ description: "Maximum number of records to return per page.",
74150
+ format: "float",
74151
+ type: "number"
74152
+ },
74153
+ page_cursor: {
74154
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
74155
+ nullable: true,
74156
+ type: "string"
74157
+ },
74127
74158
  search: {
74128
74159
  description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
74129
74160
  minLength: 1,
@@ -74146,12 +74177,13 @@ var openapi_default = {
74146
74177
  schema: {
74147
74178
  properties: {
74148
74179
  ok: { type: "boolean" },
74180
+ pagination: { $ref: "#/components/schemas/pagination" },
74149
74181
  spaces: {
74150
74182
  items: { $ref: "#/components/schemas/space" },
74151
74183
  type: "array"
74152
74184
  }
74153
74185
  },
74154
- required: ["spaces", "ok"],
74186
+ required: ["spaces", "pagination", "ok"],
74155
74187
  type: "object"
74156
74188
  }
74157
74189
  }