@augno/sdk 0.1.9 → 0.7.0

package/resources/operations/location-types.d.mts

@@ -1,5 +1,6 @@
 import { APIResource } from "../../core/resource.mjs";
 import * as APIKeysAPI from "../auth/api-keys/api-keys.mjs";
+import * as CustomersAPI from "../sales/customers/customers.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
@@ -7,27 +8,27 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 export declare class LocationTypes extends APIResource {
     /**
-     * Returns a location type by ID or code.
+     * Returns a paginated list of location types.
      *
      * @example
      * ```ts
-     * const locationType =
-     *   await client.operations.locationTypes.retrieve(
-     *     'lc_01e69cd3745a1bc0dd485986c0',
-     *   );
+     * const listLocationType =
+     *   await client.operations.locationTypes.list();
      * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<LocationType>;
+    list(query?: LocationTypeListParams | null | undefined, options?: RequestOptions): APIPromise<ListLocationType>;
     /**
-     * Returns a paginated list of location types.
+     * Returns a location type by ID or code.
      *
      * @example
      * ```ts
-     * const listLocationType =
-     *   await client.operations.locationTypes.list();
+     * const locationType =
+     *   await client.operations.locationTypes.retrieve(
+     *     'lc_01e69cd3745a1bc0dd485986c0',
+     *   );
      * ```
      */
-    list(query?: LocationTypeListParams | null | undefined, options?: RequestOptions): APIPromise<ListLocationType>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<LocationType>;
 }
 /**
  * List represents a paginated list of resources.
@@ -47,23 +48,31 @@ export interface ListLocationType {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * LocationType resource.
+ * A level in the storage location hierarchy, such as a building or a bin.
  */
 export interface LocationType {
     /**
-     * Location ID.
+     * Location type ID.
      */
     id: string;
     /**
-     * Location type code.
+     * Location type code, identifying the level of the storage hierarchy this type
+     * represents.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
      */
-    code: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    code: CustomersAPI.LocationTypeCode;
     /**
      * Creation timestamp.
      */
     created_at: string;
     /**
-     * Display name.
+     * Display name of the location type.
      */
     name: string;
     /**
@@ -77,15 +86,21 @@ export interface LocationType {
 }
 export interface LocationTypeListParams {
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
      */
     cursor?: string;
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Maximum number of results to return in a single page.
      */
     limit?: number;
     /**
-     * Search query used to filter results.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
     q?: string;
 }

package/resources/operations/location-types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"location-types.d.mts","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,sCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIxE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;CAGhC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAElE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"location-types.d.mts","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;OAUG;IACH,IAAI,EAAE,YAAY,CAAC,gBAAgB,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/operations/location-types.d.ts

@@ -1,5 +1,6 @@
 import { APIResource } from "../../core/resource.js";
 import * as APIKeysAPI from "../auth/api-keys/api-keys.js";
+import * as CustomersAPI from "../sales/customers/customers.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
@@ -7,27 +8,27 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class LocationTypes extends APIResource {
     /**
-     * Returns a location type by ID or code.
+     * Returns a paginated list of location types.
      *
      * @example
      * ```ts
-     * const locationType =
-     *   await client.operations.locationTypes.retrieve(
-     *     'lc_01e69cd3745a1bc0dd485986c0',
-     *   );
+     * const listLocationType =
+     *   await client.operations.locationTypes.list();
      * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<LocationType>;
+    list(query?: LocationTypeListParams | null | undefined, options?: RequestOptions): APIPromise<ListLocationType>;
     /**
-     * Returns a paginated list of location types.
+     * Returns a location type by ID or code.
      *
      * @example
      * ```ts
-     * const listLocationType =
-     *   await client.operations.locationTypes.list();
+     * const locationType =
+     *   await client.operations.locationTypes.retrieve(
+     *     'lc_01e69cd3745a1bc0dd485986c0',
+     *   );
      * ```
      */
-    list(query?: LocationTypeListParams | null | undefined, options?: RequestOptions): APIPromise<ListLocationType>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<LocationType>;
 }
 /**
  * List represents a paginated list of resources.
@@ -47,23 +48,31 @@ export interface ListLocationType {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * LocationType resource.
+ * A level in the storage location hierarchy, such as a building or a bin.
  */
 export interface LocationType {
     /**
-     * Location ID.
+     * Location type ID.
      */
     id: string;
     /**
-     * Location type code.
+     * Location type code, identifying the level of the storage hierarchy this type
+     * represents.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
      */
-    code: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    code: CustomersAPI.LocationTypeCode;
     /**
      * Creation timestamp.
      */
     created_at: string;
     /**
-     * Display name.
+     * Display name of the location type.
      */
     name: string;
     /**
@@ -77,15 +86,21 @@ export interface LocationType {
 }
 export interface LocationTypeListParams {
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
      */
     cursor?: string;
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Maximum number of results to return in a single page.
      */
     limit?: number;
     /**
-     * Search query used to filter results.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
     q?: string;
 }

package/resources/operations/location-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"location-types.d.ts","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIxE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;CAGhC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAElE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"location-types.d.ts","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;OAUG;IACH,IAAI,EAAE,YAAY,CAAC,gBAAgB,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/operations/location-types.js

@@ -9,30 +9,30 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class LocationTypes extends resource_1.APIResource {
     /**
-     * Returns a location type by ID or code.
+     * Returns a paginated list of location types.
      *
      * @example
      * ```ts
-     * const locationType =
-     *   await client.operations.locationTypes.retrieve(
-     *     'lc_01e69cd3745a1bc0dd485986c0',
-     *   );
+     * const listLocationType =
+     *   await client.operations.locationTypes.list();
      * ```
      */
-    retrieve(id, options) {
-        return this._client.get((0, path_1.path) `/v1/operations/location-types/${id}`, options);
+    list(query = {}, options) {
+        return this._client.get('/v1/operations/location-types', { query, ...options });
     }
     /**
-     * Returns a paginated list of location types.
+     * Returns a location type by ID or code.
      *
      * @example
      * ```ts
-     * const listLocationType =
-     *   await client.operations.locationTypes.list();
+     * const locationType =
+     *   await client.operations.locationTypes.retrieve(
+     *     'lc_01e69cd3745a1bc0dd485986c0',
+     *   );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/operations/location-types', { query, ...options });
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/v1/operations/location-types/${id}`, options);
     }
 }
 exports.LocationTypes = LocationTypes;

package/resources/operations/location-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"location-types.js","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AA/BD,sCA+BC"}
+{"version":3,"file":"location-types.js","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AA/BD,sCA+BC"}

package/resources/operations/location-types.mjs

@@ -6,30 +6,30 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class LocationTypes extends APIResource {
     /**
-     * Returns a location type by ID or code.
+     * Returns a paginated list of location types.
      *
      * @example
      * ```ts
-     * const locationType =
-     *   await client.operations.locationTypes.retrieve(
-     *     'lc_01e69cd3745a1bc0dd485986c0',
-     *   );
+     * const listLocationType =
+     *   await client.operations.locationTypes.list();
      * ```
      */
-    retrieve(id, options) {
-        return this._client.get(path `/v1/operations/location-types/${id}`, options);
+    list(query = {}, options) {
+        return this._client.get('/v1/operations/location-types', { query, ...options });
     }
     /**
-     * Returns a paginated list of location types.
+     * Returns a location type by ID or code.
      *
      * @example
      * ```ts
-     * const listLocationType =
-     *   await client.operations.locationTypes.list();
+     * const locationType =
+     *   await client.operations.locationTypes.retrieve(
+     *     'lc_01e69cd3745a1bc0dd485986c0',
+     *   );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/operations/location-types', { query, ...options });
+    retrieve(id, options) {
+        return this._client.get(path `/v1/operations/location-types/${id}`, options);
     }
 }
 //# sourceMappingURL=location-types.mjs.map

package/resources/operations/location-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"location-types.mjs","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}
+{"version":3,"file":"location-types.mjs","sourceRoot":"","sources":["../../src/resources/operations/location-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/resources/operations/locations.d.mts

@@ -7,17 +7,15 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 export declare class Locations extends APIResource {
     /**
-     * Creates a location for the caller's account.
+     * Returns a paginated list of locations in your account.
      *
      * @example
      * ```ts
-     * const location = await client.operations.locations.create({
-     *   name: 'Warehouse A',
-     *   type: 'building',
-     * });
+     * const listLocation =
+     *   await client.operations.locations.list();
      * ```
      */
-    create(params: LocationCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Location>;
+    list(query?: LocationListParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ListLocation>;
     /**
      * Returns a location by ID.
      *
@@ -30,28 +28,34 @@ export declare class Locations extends APIResource {
      */
     retrieve(id: string, query?: LocationRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Location>;
     /**
-     * Partially updates a location.
+     * Creates a storage location, optionally placing it in the location hierarchy.
      *
      * @example
      * ```ts
-     * const location = await client.operations.locations.update(
-     *   'lc_014d187d99b31926f0c74af9d8',
-     * );
+     * const location = await client.operations.locations.create({
+     *   name: 'Warehouse A',
+     *   type: 'building',
+     * });
      * ```
      */
-    update(id: string, params?: LocationUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Location>;
+    create(params: LocationCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Location>;
     /**
-     * Returns a paginated list of locations for the caller's account.
+     * Partially updates a location.
      *
      * @example
      * ```ts
-     * const listLocation =
-     *   await client.operations.locations.list();
+     * const location = await client.operations.locations.update(
+     *   'lc_014d187d99b31926f0c74af9d8',
+     *   { name: 'Warehouse B' },
+     * );
      * ```
      */
-    list(query?: LocationListParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ListLocation>;
+    update(id: string, params?: LocationUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Location>;
     /**
-     * Deletes a location. Fails if the location has child locations.
+     * Deletes a location.
+     *
+     * Fails if the location has child locations; remove or reassign the children
+     * first.
      *
      * @example
      * ```ts
@@ -67,19 +71,32 @@ export declare class Locations extends APIResource {
  */
 export interface CreateLocationRequest {
     /**
-     * Display name.
+     * Display name of the location.
+     *
+     * Maximum 255 characters.
      */
     name: string;
     /**
-     * Location type code.
+     * Location type code, identifying this location's level in the storage hierarchy.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
      */
-    type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    type: CustomersAPI.LocationTypeCode;
     /**
-     * IDs of child locations to attach.
+     * IDs of existing locations to attach as children of the new location.
+     *
+     * Listed locations are moved from their current parent, if any.
      */
     child_ids?: Array<string>;
     /**
-     * Parent location ID. Null for top-level locations.
+     * ID of the parent location.
+     *
+     * Omit for top-level locations.
      */
     parent_id?: string;
 }
@@ -88,47 +105,63 @@ export interface CreateLocationRequest {
  */
 export interface UpdateLocationRequest {
     /**
-     * Child location IDs. Replaces all current children when provided. Send null to
-     * clear.
+     * IDs of locations to set as this location's children.
+     *
+     * When provided, replaces the full set of children: current children not listed
+     * are detached, and listed locations are moved from their current parent. Send
+     * `null` to detach all children.
      */
     child_ids?: Array<string> | null;
     /**
-     * Display name.
+     * Display name of the location.
+     *
+     * Maximum 255 characters.
      */
     name?: string;
     /**
-     * Parent location ID. Send null to clear.
+     * ID of the parent location.
+     *
+     * Send `null` to clear the parent and make this a top-level location.
      */
     parent_id?: string | null;
     /**
-     * Location type code.
-     */
-    type?: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+     * Location type code, identifying this location's level in the storage hierarchy.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
+     */
+    type?: CustomersAPI.LocationTypeCode;
 }
 export interface LocationDeleteResponse {
 }
-export interface LocationCreateParams {
-    /**
-     * Body param: Display name.
-     */
-    name: string;
+export interface LocationListParams {
     /**
-     * Body param: Location type code.
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
      */
-    type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    cursor?: string;
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
      */
     include?: Array<'parent' | 'children'>;
     /**
-     * Body param: IDs of child locations to attach.
+     * Maximum number of results to return in a single page.
      */
-    child_ids?: Array<string>;
+    limit?: number;
     /**
-     * Body param: Parent location ID. Null for top-level locations.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
-    parent_id?: string;
+    q?: string;
 }
 export interface LocationRetrieveParams {
     /**
@@ -137,50 +170,83 @@ export interface LocationRetrieveParams {
      */
     include?: Array<'parent' | 'children'>;
 }
-export interface LocationUpdateParams {
+export interface LocationCreateParams {
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * Body param: Display name of the location.
+     *
+     * Maximum 255 characters.
      */
-    include?: Array<'parent' | 'children'>;
+    name: string;
     /**
-     * Body param: Child location IDs. Replaces all current children when provided.
-     * Send null to clear.
+     * Body param: Location type code, identifying this location's level in the storage
+     * hierarchy.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
      */
-    child_ids?: Array<string> | null;
+    type: CustomersAPI.LocationTypeCode;
     /**
-     * Body param: Display name.
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
      */
-    name?: string;
+    include?: Array<'parent' | 'children'>;
     /**
-     * Body param: Parent location ID. Send null to clear.
+     * Body param: IDs of existing locations to attach as children of the new location.
+     *
+     * Listed locations are moved from their current parent, if any.
      */
-    parent_id?: string | null;
+    child_ids?: Array<string>;
     /**
-     * Body param: Location type code.
+     * Body param: ID of the parent location.
+     *
+     * Omit for top-level locations.
      */
-    type?: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    parent_id?: string;
 }
-export interface LocationListParams {
+export interface LocationUpdateParams {
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
      */
-    cursor?: string;
+    include?: Array<'parent' | 'children'>;
     /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
+     * Body param: IDs of locations to set as this location's children.
+     *
+     * When provided, replaces the full set of children: current children not listed
+     * are detached, and listed locations are moved from their current parent. Send
+     * `null` to detach all children.
      */
-    include?: Array<'parent' | 'children'>;
+    child_ids?: Array<string> | null;
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Body param: Display name of the location.
+     *
+     * Maximum 255 characters.
      */
-    limit?: number;
+    name?: string;
     /**
-     * Search query used to filter results.
+     * Body param: ID of the parent location.
+     *
+     * Send `null` to clear the parent and make this a top-level location.
      */
-    q?: string;
+    parent_id?: string | null;
+    /**
+     * Body param: Location type code, identifying this location's level in the storage
+     * hierarchy.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
+     */
+    type?: CustomersAPI.LocationTypeCode;
 }
 export declare namespace Locations {
-    export { type CreateLocationRequest as CreateLocationRequest, type UpdateLocationRequest as UpdateLocationRequest, type LocationDeleteResponse as LocationDeleteResponse, type LocationCreateParams as LocationCreateParams, type LocationRetrieveParams as LocationRetrieveParams, type LocationUpdateParams as LocationUpdateParams, type LocationListParams as LocationListParams, };
+    export { type CreateLocationRequest as CreateLocationRequest, type UpdateLocationRequest as UpdateLocationRequest, type LocationDeleteResponse as LocationDeleteResponse, type LocationListParams as LocationListParams, type LocationRetrieveParams as LocationRetrieveParams, type LocationCreateParams as LocationCreateParams, type LocationUpdateParams as LocationUpdateParams, };
 }
 //# sourceMappingURL=locations.d.mts.map