@augno/sdk 0.1.9 → 0.7.0

package/src/resources/operations/locations.ts

@@ -11,19 +11,19 @@ import { path } from '../../internal/utils/path';
  */
 export 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> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/operations/locations', { query: { include }, body, ...options });
+  list(
+    query: LocationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ListLocation> {
+    return this._client.get('/v1/operations/locations', { query, ...options });
   }
 
   /**
@@ -44,6 +44,22 @@ export class Locations extends APIResource {
     return this._client.get(path`/v1/operations/locations/${id}`, { query, ...options });
   }
 
+  /**
+   * Creates a storage location, optionally placing it in the location hierarchy.
+   *
+   * @example
+   * ```ts
+   * const location = await client.operations.locations.create({
+   *   name: 'Warehouse A',
+   *   type: 'building',
+   * });
+   * ```
+   */
+  create(params: LocationCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Location> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/operations/locations', { query: { include }, body, ...options });
+  }
+
   /**
    * Partially updates a location.
    *
@@ -51,6 +67,7 @@ export class Locations extends APIResource {
    * ```ts
    * const location = await client.operations.locations.update(
    *   'lc_014d187d99b31926f0c74af9d8',
+   *   { name: 'Warehouse B' },
    * );
    * ```
    */
@@ -64,23 +81,10 @@ export class Locations extends APIResource {
   }
 
   /**
-   * Returns a paginated list of locations for the caller's account.
+   * Deletes a location.
    *
-   * @example
-   * ```ts
-   * const listLocation =
-   *   await client.operations.locations.list();
-   * ```
-   */
-  list(
-    query: LocationListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ListLocation> {
-    return this._client.get('/v1/operations/locations', { query, ...options });
-  }
-
-  /**
-   * Deletes a location. Fails if the location has child locations.
+   * Fails if the location has child locations; remove or reassign the children
+   * first.
    *
    * @example
    * ```ts
@@ -99,22 +103,35 @@ export 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;
 }
@@ -124,55 +141,70 @@ 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.
+   * 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;
 }
 
 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 {
@@ -183,56 +215,90 @@ 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 {
@@ -240,9 +306,9 @@ export declare namespace Locations {
     type CreateLocationRequest as CreateLocationRequest,
     type UpdateLocationRequest as UpdateLocationRequest,
     type LocationDeleteResponse as LocationDeleteResponse,
-    type LocationCreateParams as LocationCreateParams,
+    type LocationListParams as LocationListParams,
     type LocationRetrieveParams as LocationRetrieveParams,
+    type LocationCreateParams as LocationCreateParams,
     type LocationUpdateParams as LocationUpdateParams,
-    type LocationListParams as LocationListParams,
   };
 }

package/src/resources/operations/operations.ts

@@ -73,10 +73,10 @@ export declare namespace Operations {
     type ListShippingTerm as ListShippingTerm,
     type UpdateShippingTermRequest as UpdateShippingTermRequest,
     type ShippingTermDeleteResponse as ShippingTermDeleteResponse,
-    type ShippingTermCreateParams as ShippingTermCreateParams,
+    type ShippingTermListParams as ShippingTermListParams,
     type ShippingTermRetrieveParams as ShippingTermRetrieveParams,
+    type ShippingTermCreateParams as ShippingTermCreateParams,
     type ShippingTermUpdateParams as ShippingTermUpdateParams,
-    type ShippingTermListParams as ShippingTermListParams,
   };
 
   export {
@@ -85,10 +85,10 @@ export declare namespace Operations {
     type ListCarrier as ListCarrier,
     type UpdateCarrierRequest as UpdateCarrierRequest,
     type CarrierDeleteResponse as CarrierDeleteResponse,
-    type CarrierCreateParams as CarrierCreateParams,
+    type CarrierListParams as CarrierListParams,
     type CarrierRetrieveParams as CarrierRetrieveParams,
+    type CarrierCreateParams as CarrierCreateParams,
     type CarrierUpdateParams as CarrierUpdateParams,
-    type CarrierListParams as CarrierListParams,
   };
 
   export {
@@ -96,10 +96,10 @@ export declare namespace Operations {
     type CreateLocationRequest as CreateLocationRequest,
     type UpdateLocationRequest as UpdateLocationRequest,
     type LocationDeleteResponse as LocationDeleteResponse,
-    type LocationCreateParams as LocationCreateParams,
+    type LocationListParams as LocationListParams,
     type LocationRetrieveParams as LocationRetrieveParams,
+    type LocationCreateParams as LocationCreateParams,
     type LocationUpdateParams as LocationUpdateParams,
-    type LocationListParams as LocationListParams,
   };
 
   export {
@@ -114,9 +114,9 @@ export declare namespace Operations {
     type CreateScanningStationRequest as CreateScanningStationRequest,
     type UpdateScanningStationRequest as UpdateScanningStationRequest,
     type ScanningStationDeleteResponse as ScanningStationDeleteResponse,
-    type ScanningStationCreateParams as ScanningStationCreateParams,
+    type ScanningStationListParams as ScanningStationListParams,
     type ScanningStationRetrieveParams as ScanningStationRetrieveParams,
+    type ScanningStationCreateParams as ScanningStationCreateParams,
     type ScanningStationUpdateParams as ScanningStationUpdateParams,
-    type ScanningStationListParams as ScanningStationListParams,
   };
 }