@augno/sdk 0.1.9 → 0.7.0

package/src/resources/operations/scanning-stations.ts

@@ -11,25 +11,19 @@ import { path } from '../../internal/utils/path';
  */
 export class ScanningStations extends APIResource {
   /**
-   * Creates a scanning station associated with a department.
+   * Returns a paginated list of scanning stations in your account.
    *
    * @example
    * ```ts
-   * const scanningStation =
-   *   await client.operations.scanningStations.create({
-   *     department_id: 'dp_01791c25ab59da4704cba61874',
-   *     name: 'Packaging Line 1',
-   *     operator_requirement: 'none',
-   *     type: 'init_batch',
-   *   });
+   * const listScanningStation =
+   *   await client.operations.scanningStations.list();
    * ```
    */
-  create(
-    params: ScanningStationCreateParams,
+  list(
+    query: ScanningStationListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ScanningStation> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/operations/scanning-stations', { query: { include }, body, ...options });
+  ): APIPromise<CustomersAPI.ListScanningStation> {
+    return this._client.get('/v1/operations/scanning-stations', { query, ...options });
   }
 
   /**
@@ -51,14 +45,45 @@ export class ScanningStations extends APIResource {
     return this._client.get(path`/v1/operations/scanning-stations/${id}`, { query, ...options });
   }
 
+  /**
+   * Creates a scanning station and assigns it to a department.
+   *
+   * Returns a conflict error if a scanning station with the same name already
+   * exists.
+   *
+   * @example
+   * ```ts
+   * const scanningStation =
+   *   await client.operations.scanningStations.create({
+   *     department_id: 'dp_01791c25ab59da4704cba61874',
+   *     name: 'Packaging Line 1',
+   *     operator_requirement: 'none',
+   *     type: 'init_batch',
+   *     label_size: '1x1',
+   *     label_type: 'tag',
+   *   });
+   * ```
+   */
+  create(
+    params: ScanningStationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ScanningStation> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/operations/scanning-stations', { query: { include }, body, ...options });
+  }
+
   /**
    * Partially updates a scanning station.
    *
+   * Only the fields provided in the request are changed. Returns a conflict error if
+   * the new name is already in use by another scanning station.
+   *
    * @example
    * ```ts
    * const scanningStation =
    *   await client.operations.scanningStations.update(
    *     'scst_0129335dd6286056a97024fcc1',
+   *     { name: 'Station B' },
    *   );
    * ```
    */
@@ -75,22 +100,6 @@ export class ScanningStations extends APIResource {
     });
   }
 
-  /**
-   * Returns a paginated list of scanning stations for the current account.
-   *
-   * @example
-   * ```ts
-   * const listScanningStation =
-   *   await client.operations.scanningStations.list();
-   * ```
-   */
-  list(
-    query: ScanningStationListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ListScanningStation> {
-    return this._client.get('/v1/operations/scanning-stations', { query, ...options });
-  }
-
   /**
    * Deletes a scanning station.
    *
@@ -112,37 +121,54 @@ export class ScanningStations extends APIResource {
  */
 export interface CreateScanningStationRequest {
   /**
-   * Department ID.
+   * ID of the department this station belongs to.
    */
   department_id: string;
 
   /**
-   * Display name.
+   * Display name of the scanning station.
+   *
+   * Must be unique within your account; maximum 255 characters.
    */
   name: string;
 
   /**
-   * Operator requirement behavior for this station.
+   * Whether operators must perform a material check at this station.
+   *
+   * - `none`: no additional operator check is required.
+   * - `material_check`: a material check is expected before the operation.
    */
   operator_requirement: 'none' | 'material_check';
 
   /**
-   * Scanning station type.
+   * Scanning station type, determining which batch operation the station performs.
+   *
+   * - `init_batch`: initializes a new batch.
+   * - `merge_batch`: merges multiple batches into one.
+   * - `move_batch`: moves a batch to another location or step.
+   * - `split_batch`: splits a batch into multiple batches.
+   *
+   * The type cannot be changed after creation.
    */
   type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
 
   /**
-   * Label size code.
+   * Size of the labels printed at this station, given as width-by-height (for
+   * example, `1x1`).
    */
   label_size?: '1x1' | '1x3' | '1x4' | '2x4';
 
   /**
-   * Label type code.
+   * Type of label printed at this station.
+   *
+   * - `tag`: a label attached to the physical product.
+   * - `traveler`: a routing sheet that accompanies the batch through every
+   *   production step.
    */
   label_type?: 'tag' | 'traveler';
 
   /**
-   * Notes.
+   * Free-form notes about the scanning station.
    */
   notes?: string;
 }
@@ -152,85 +178,116 @@ export interface CreateScanningStationRequest {
  */
 export interface UpdateScanningStationRequest {
   /**
-   * Label size code.
+   * Size of the labels printed at this station, given as width-by-height (for
+   * example, `1x1`).
    */
   label_size?: '1x1' | '1x3' | '1x4' | '2x4';
 
   /**
-   * Label type code.
+   * Type of label printed at this station.
+   *
+   * - `tag`: a label attached to the physical product.
+   * - `traveler`: a routing sheet that accompanies the batch through every
+   *   production step.
    */
   label_type?: 'tag' | 'traveler';
 
   /**
-   * Display name.
+   * Display name of the scanning station.
+   *
+   * Must be unique within your account; maximum 255 characters.
    */
   name?: string;
 
   /**
-   * Notes.
+   * Free-form notes about the scanning station.
+   *
+   * Send `null` to clear.
    */
   notes?: string | null;
 
   /**
-   * Operator requirement behavior for this station.
+   * Whether operators must perform a material check at this station.
+   *
+   * - `none`: no additional operator check is required.
+   * - `material_check`: a material check is expected before the operation.
    */
   operator_requirement?: 'none' | 'material_check';
 }
 
 export interface ScanningStationDeleteResponse {}
 
-export interface ScanningStationCreateParams {
+export interface ScanningStationListParams {
   /**
-   * Body param: Department ID.
+   * 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.
    */
-  department_id: string;
+  cursor?: string;
 
   /**
-   * Body param: Display name.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  name: string;
+  include?: Array<'department' | 'production_steps'>;
 
   /**
-   * Body param: Operator requirement behavior for this station.
+   * Maximum number of results to return in a single page.
    */
-  operator_requirement: 'none' | 'material_check';
+  limit?: number;
 
   /**
-   * Body param: Scanning station type.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
+  q?: string;
+}
 
+export interface ScanningStationRetrieveParams {
   /**
-   * 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<'department' | 'production_steps'>;
+}
 
+export interface ScanningStationCreateParams {
   /**
-   * Body param: Label size code.
+   * Body param: ID of the department this station belongs to.
    */
-  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+  department_id: string;
 
   /**
-   * Body param: Label type code.
+   * Body param: Display name of the scanning station.
+   *
+   * Must be unique within your account; maximum 255 characters.
    */
-  label_type?: 'tag' | 'traveler';
+  name: string;
 
   /**
-   * Body param: Notes.
+   * Body param: Whether operators must perform a material check at this station.
+   *
+   * - `none`: no additional operator check is required.
+   * - `material_check`: a material check is expected before the operation.
    */
-  notes?: string;
-}
+  operator_requirement: 'none' | 'material_check';
 
-export interface ScanningStationRetrieveParams {
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Body param: Scanning station type, determining which batch operation the station
+   * performs.
+   *
+   * - `init_batch`: initializes a new batch.
+   * - `merge_batch`: merges multiple batches into one.
+   * - `move_batch`: moves a batch to another location or step.
+   * - `split_batch`: splits a batch into multiple batches.
+   *
+   * The type cannot be changed after creation.
    */
-  include?: Array<'department' | 'production_steps'>;
-}
+  type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
 
-export interface ScanningStationUpdateParams {
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
@@ -238,52 +295,69 @@ export interface ScanningStationUpdateParams {
   include?: Array<'department' | 'production_steps'>;
 
   /**
-   * Body param: Label size code.
+   * Body param: Size of the labels printed at this station, given as width-by-height
+   * (for example, `1x1`).
    */
   label_size?: '1x1' | '1x3' | '1x4' | '2x4';
 
   /**
-   * Body param: Label type code.
+   * Body param: Type of label printed at this station.
+   *
+   * - `tag`: a label attached to the physical product.
+   * - `traveler`: a routing sheet that accompanies the batch through every
+   *   production step.
    */
   label_type?: 'tag' | 'traveler';
 
   /**
-   * Body param: Display name.
+   * Body param: Free-form notes about the scanning station.
    */
-  name?: string;
+  notes?: string;
+}
 
+export interface ScanningStationUpdateParams {
   /**
-   * Body param: Notes.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  notes?: string | null;
+  include?: Array<'department' | 'production_steps'>;
 
   /**
-   * Body param: Operator requirement behavior for this station.
+   * Body param: Size of the labels printed at this station, given as width-by-height
+   * (for example, `1x1`).
    */
-  operator_requirement?: 'none' | 'material_check';
-}
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
 
-export interface ScanningStationListParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Body param: Type of label printed at this station.
+   *
+   * - `tag`: a label attached to the physical product.
+   * - `traveler`: a routing sheet that accompanies the batch through every
+   *   production step.
    */
-  cursor?: string;
+  label_type?: 'tag' | 'traveler';
 
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Body param: Display name of the scanning station.
+   *
+   * Must be unique within your account; maximum 255 characters.
    */
-  include?: Array<'department' | 'production_steps'>;
+  name?: string;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: Free-form notes about the scanning station.
+   *
+   * Send `null` to clear.
    */
-  limit?: number;
+  notes?: string | null;
 
   /**
-   * Search query used to filter results.
+   * Body param: Whether operators must perform a material check at this station.
+   *
+   * - `none`: no additional operator check is required.
+   * - `material_check`: a material check is expected before the operation.
    */
-  q?: string;
+  operator_requirement?: 'none' | 'material_check';
 }
 
 export declare namespace ScanningStations {
@@ -291,9 +365,9 @@ export declare namespace ScanningStations {
     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,
   };
 }