@curviate/sdk 0.35.0 → 0.36.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.
package/CHANGELOG.md CHANGED
@@ -9,6 +9,30 @@ Versioning: semantic. Minor for additive changes, patch for bug fixes; no stabil
9
9
 
10
10
  ## [Unreleased]
11
11
 
12
+ ## [0.36.0] - 2026-09-20
13
+
14
+ Fixture and types regenerated against the deployed production document
15
+ (`https://api.curviate.com`, 127 paths, server
16
+ `41d48ed451280c29b0fb6b4b15c44ca70b76af98`). One additive shape change.
17
+
18
+ ### Added
19
+
20
+ - **`search.getParameters()` accepts `cursor`.** The filter-ID resolver
21
+ paginates: `SearchParametersQuery` gains an optional `cursor`, and the
22
+ response's `cursor` field is the token to send back for the next page. Walk
23
+ until it comes back `null`. `offset` still works and is now described as the
24
+ numeric fallback for `cursor`. A malformed cursor is a `400`. Additive and
25
+ backward compatible: a call that passes no `cursor` behaves exactly as
26
+ before.
27
+
28
+ ### Changed
29
+
30
+ - Regenerated descriptions on `GET /v1/{account_id}/search/parameters`: the
31
+ operation description now states how the pages are walked, `offset` names
32
+ itself the numeric fallback, and the `400` description names a malformed
33
+ cursor among its causes.
34
+ - `search.getParameters()` carries a paging `@example` in its JSDoc.
35
+
12
36
  ## [0.35.0] - 2026-09-19
13
37
 
14
38
  Fixture and types regenerated a second time against the deployed production
@@ -25,7 +49,7 @@ nothing added, removed or retyped.
25
49
  Present when populated. Reading it back through Curviate stores it in your
26
50
  tenant's entity records, with no expiry."
27
51
 
28
- First refresh in this Unreleased batch, against production server
52
+ First refresh in this release, against production server
29
53
  `00a1388d42b09db54424de12ecf1c7cbebe2ec12`: 23 description strings and 3
30
54
  example values changed, nothing added, removed or retyped.
31
55
 
package/dist/index.d.ts CHANGED
@@ -661,7 +661,7 @@ interface paths {
661
661
  };
662
662
  /**
663
663
  * Resolve search filter IDs
664
- * @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE.
664
+ * @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE. Results paginate: send the cursor from the previous response to get the next page, and stop when it comes back null.
665
665
  */
666
666
  get: operations["getV1AccountIdSearchParameters"];
667
667
  put?: never;
@@ -8420,10 +8420,12 @@ interface operations {
8420
8420
  type: "LOCATION" | "PEOPLE" | "RELATION" | "COMPANY" | "SCHOOL" | "INDUSTRY" | "SERVICE" | "JOB_FUNCTION" | "JOB_TITLE" | "EMPLOYMENT_TYPE" | "SKILL";
8421
8421
  /** @description Human term to resolve to opaque filter IDs (e.g. 'software development'). Required for every type, including EMPLOYMENT_TYPE. */
8422
8422
  keywords: string;
8423
- /** @description Zero-based pagination offset (default 0). */
8423
+ /** @description Zero-based pagination offset; a numeric fallback for cursor (default 0). */
8424
8424
  offset?: number;
8425
8425
  /** @description Number of parameters to return (1-100, default 10). */
8426
8426
  limit?: number;
8427
+ /** @description Opaque pagination cursor returned from a previous response. */
8428
+ cursor?: string;
8427
8429
  };
8428
8430
  header?: never;
8429
8431
  path: {
@@ -8461,7 +8463,7 @@ interface operations {
8461
8463
  };
8462
8464
  };
8463
8465
  };
8464
- /** @description Missing or empty account_id, missing or empty type, missing keywords, or type not in the classic allowlist. */
8466
+ /** @description Missing or empty account_id, missing or empty type, missing keywords, type not in the classic allowlist, or malformed cursor. */
8465
8467
  400: {
8466
8468
  headers: {
8467
8469
  [name: string]: unknown;
@@ -32138,6 +32140,24 @@ declare class SearchResource {
32138
32140
  /**
32139
32141
  * Resolve human-readable terms to opaque filter IDs for structured search.
32140
32142
  * `GET /v1/{account_id}/search/parameters`
32143
+ *
32144
+ * Paginated: the response carries a `cursor`, and sending it back as
32145
+ * `cursor` returns the next page. Stop when it comes back `null`. `offset`
32146
+ * stays available as the numeric fallback. A malformed cursor is a `400`.
32147
+ *
32148
+ * @example
32149
+ * ```ts
32150
+ * let cursor: string | null | undefined;
32151
+ * do {
32152
+ * const page = await acc.search.getParameters({
32153
+ * type: "SKILL",
32154
+ * keywords: "software development",
32155
+ * ...(cursor ? { cursor } : {}),
32156
+ * });
32157
+ * for (const item of page.items) console.log(item.id, item.name);
32158
+ * cursor = page.cursor;
32159
+ * } while (cursor);
32160
+ * ```
32141
32161
  */
32142
32162
  getParameters(query: SearchParametersQuery): Promise<SearchParametersResult>;
32143
32163
  /**
package/dist/index.js CHANGED
@@ -1132,6 +1132,24 @@ var SearchResource = class {
1132
1132
  /**
1133
1133
  * Resolve human-readable terms to opaque filter IDs for structured search.
1134
1134
  * `GET /v1/{account_id}/search/parameters`
1135
+ *
1136
+ * Paginated: the response carries a `cursor`, and sending it back as
1137
+ * `cursor` returns the next page. Stop when it comes back `null`. `offset`
1138
+ * stays available as the numeric fallback. A malformed cursor is a `400`.
1139
+ *
1140
+ * @example
1141
+ * ```ts
1142
+ * let cursor: string | null | undefined;
1143
+ * do {
1144
+ * const page = await acc.search.getParameters({
1145
+ * type: "SKILL",
1146
+ * keywords: "software development",
1147
+ * ...(cursor ? { cursor } : {}),
1148
+ * });
1149
+ * for (const item of page.items) console.log(item.id, item.name);
1150
+ * cursor = page.cursor;
1151
+ * } while (cursor);
1152
+ * ```
1135
1153
  */
1136
1154
  getParameters(query) {
1137
1155
  return this.ctx.request({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@curviate/sdk",
3
- "version": "0.35.0",
3
+ "version": "0.36.0",
4
4
  "private": false,
5
5
  "description": "TypeScript SDK for the Curviate API.",
6
6
  "license": "MIT",
@@ -563,7 +563,7 @@ export interface paths {
563
563
  };
564
564
  /**
565
565
  * Resolve search filter IDs
566
- * @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE.
566
+ * @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE. Results paginate: send the cursor from the previous response to get the next page, and stop when it comes back null.
567
567
  */
568
568
  get: operations["getV1AccountIdSearchParameters"];
569
569
  put?: never;
@@ -8324,10 +8324,12 @@ export interface operations {
8324
8324
  type: "LOCATION" | "PEOPLE" | "RELATION" | "COMPANY" | "SCHOOL" | "INDUSTRY" | "SERVICE" | "JOB_FUNCTION" | "JOB_TITLE" | "EMPLOYMENT_TYPE" | "SKILL";
8325
8325
  /** @description Human term to resolve to opaque filter IDs (e.g. 'software development'). Required for every type, including EMPLOYMENT_TYPE. */
8326
8326
  keywords: string;
8327
- /** @description Zero-based pagination offset (default 0). */
8327
+ /** @description Zero-based pagination offset; a numeric fallback for cursor (default 0). */
8328
8328
  offset?: number;
8329
8329
  /** @description Number of parameters to return (1-100, default 10). */
8330
8330
  limit?: number;
8331
+ /** @description Opaque pagination cursor returned from a previous response. */
8332
+ cursor?: string;
8331
8333
  };
8332
8334
  header?: never;
8333
8335
  path: {
@@ -8365,7 +8367,7 @@ export interface operations {
8365
8367
  };
8366
8368
  };
8367
8369
  };
8368
- /** @description Missing or empty account_id, missing or empty type, missing keywords, or type not in the classic allowlist. */
8370
+ /** @description Missing or empty account_id, missing or empty type, missing keywords, type not in the classic allowlist, or malformed cursor. */
8369
8371
  400: {
8370
8372
  headers: {
8371
8373
  [name: string]: unknown;