@augno/sdk 0.1.6

package/src/resources/operations/locations.ts

@@ -0,0 +1,249 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CustomersAPI from '../sales/customers/customers';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * List and manage locations.
+ */
+export class Locations extends APIResource {
+  /**
+   * Creates a location for the caller's account.
+   *
+   * @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 });
+  }
+
+  /**
+   * Returns a location by ID.
+   *
+   * @example
+   * ```ts
+   * const location = await client.operations.locations.retrieve(
+   *   'lc_014d187d99b31926f0c74af9d8',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: LocationRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.Location> {
+    return this._client.get(path`/v1/operations/locations/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a location.
+   *
+   * @example
+   * ```ts
+   * const location = await client.operations.locations.update(
+   *   'lc_014d187d99b31926f0c74af9d8',
+   *   { name: 'Warehouse B' },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    params: LocationUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.Location> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/operations/locations/${id}`, { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a paginated list of locations for the caller's account.
+   *
+   * @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.
+   *
+   * @example
+   * ```ts
+   * const location = await client.operations.locations.delete(
+   *   'lc_014d187d99b31926f0c74af9d8',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<LocationDeleteResponse> {
+    return this._client.delete(path`/v1/operations/locations/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a location.
+ */
+export interface CreateLocationRequest {
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Location type code.
+   */
+  type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+
+  /**
+   * IDs of child locations to attach.
+   */
+  child_ids?: Array<string> | null;
+
+  /**
+   * Parent location ID. Null for top-level locations.
+   */
+  parent_id?: string | null;
+}
+
+/**
+ * Request to partially update a location.
+ */
+export interface UpdateLocationRequest {
+  /**
+   * Child location IDs. Replaces all current children when provided. Send null to
+   * clear.
+   */
+  child_ids?: Array<string> | null;
+
+  /**
+   * Display name.
+   */
+  name?: string;
+
+  /**
+   * Parent location ID. Send null to clear.
+   */
+  parent_id?: string | null;
+
+  /**
+   * Location type code.
+   */
+  type?: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+}
+
+export interface LocationDeleteResponse {}
+
+export interface LocationCreateParams {
+  /**
+   * Body param: Display name.
+   */
+  name: string;
+
+  /**
+   * Body param: Location type code.
+   */
+  type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+
+  /**
+   * Query param: 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.
+   */
+  child_ids?: Array<string> | null;
+
+  /**
+   * Body param: Parent location ID. Null for top-level locations.
+   */
+  parent_id?: string | null;
+}
+
+export interface LocationRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'parent' | 'children'>;
+}
+
+export interface LocationUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'parent' | 'children'>;
+
+  /**
+   * Body param: Child location IDs. Replaces all current children when provided.
+   * Send null to clear.
+   */
+  child_ids?: Array<string> | null;
+
+  /**
+   * Body param: Display name.
+   */
+  name?: string;
+
+  /**
+   * Body param: Parent location ID. Send null to clear.
+   */
+  parent_id?: string | null;
+
+  /**
+   * Body param: Location type code.
+   */
+  type?: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+}
+
+export interface LocationListParams {
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'parent' | 'children'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+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,
+  };
+}

package/src/resources/operations/operations.ts

@@ -0,0 +1,122 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as LocationTypesAPI from './location-types';
+import { ListLocationType, LocationType, LocationTypeListParams, LocationTypes } from './location-types';
+import * as LocationsAPI from './locations';
+import {
+  CreateLocationRequest,
+  LocationCreateParams,
+  LocationDeleteResponse,
+  LocationListParams,
+  LocationRetrieveParams,
+  LocationUpdateParams,
+  Locations,
+  UpdateLocationRequest,
+} from './locations';
+import * as ScanningStationsAPI from './scanning-stations';
+import {
+  CreateScanningStationRequest,
+  ScanningStationCreateParams,
+  ScanningStationDeleteResponse,
+  ScanningStationListParams,
+  ScanningStationRetrieveParams,
+  ScanningStationUpdateParams,
+  ScanningStations,
+  UpdateScanningStationRequest,
+} from './scanning-stations';
+import * as ShippingTermsAPI from './shipping-terms';
+import {
+  CreateShippingTermRequest,
+  ListShippingTerm,
+  ShippingTermCreateParams,
+  ShippingTermDeleteResponse,
+  ShippingTermListParams,
+  ShippingTermRetrieveParams,
+  ShippingTermUpdateParams,
+  ShippingTerms,
+  UpdateShippingTermRequest,
+} from './shipping-terms';
+import * as CarriersAPI from './carriers/carriers';
+import {
+  CarrierCreateParams,
+  CarrierDeleteResponse,
+  CarrierListParams,
+  CarrierRetrieveParams,
+  CarrierUpdateParams,
+  Carriers,
+  CreateCarrierRequest,
+  ListCarrier,
+  UpdateCarrierRequest,
+} from './carriers/carriers';
+
+export class Operations extends APIResource {
+  shippingTerms: ShippingTermsAPI.ShippingTerms = new ShippingTermsAPI.ShippingTerms(this._client);
+  carriers: CarriersAPI.Carriers = new CarriersAPI.Carriers(this._client);
+  locations: LocationsAPI.Locations = new LocationsAPI.Locations(this._client);
+  locationTypes: LocationTypesAPI.LocationTypes = new LocationTypesAPI.LocationTypes(this._client);
+  scanningStations: ScanningStationsAPI.ScanningStations = new ScanningStationsAPI.ScanningStations(
+    this._client,
+  );
+}
+
+Operations.ShippingTerms = ShippingTerms;
+Operations.Carriers = Carriers;
+Operations.Locations = Locations;
+Operations.LocationTypes = LocationTypes;
+Operations.ScanningStations = ScanningStations;
+
+export declare namespace Operations {
+  export {
+    ShippingTerms as ShippingTerms,
+    type CreateShippingTermRequest as CreateShippingTermRequest,
+    type ListShippingTerm as ListShippingTerm,
+    type UpdateShippingTermRequest as UpdateShippingTermRequest,
+    type ShippingTermDeleteResponse as ShippingTermDeleteResponse,
+    type ShippingTermCreateParams as ShippingTermCreateParams,
+    type ShippingTermRetrieveParams as ShippingTermRetrieveParams,
+    type ShippingTermUpdateParams as ShippingTermUpdateParams,
+    type ShippingTermListParams as ShippingTermListParams,
+  };
+
+  export {
+    Carriers as Carriers,
+    type CreateCarrierRequest as CreateCarrierRequest,
+    type ListCarrier as ListCarrier,
+    type UpdateCarrierRequest as UpdateCarrierRequest,
+    type CarrierDeleteResponse as CarrierDeleteResponse,
+    type CarrierCreateParams as CarrierCreateParams,
+    type CarrierRetrieveParams as CarrierRetrieveParams,
+    type CarrierUpdateParams as CarrierUpdateParams,
+    type CarrierListParams as CarrierListParams,
+  };
+
+  export {
+    Locations as Locations,
+    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 {
+    LocationTypes as LocationTypes,
+    type ListLocationType as ListLocationType,
+    type LocationType as LocationType,
+    type LocationTypeListParams as LocationTypeListParams,
+  };
+
+  export {
+    ScanningStations as ScanningStations,
+    type CreateScanningStationRequest as CreateScanningStationRequest,
+    type UpdateScanningStationRequest as UpdateScanningStationRequest,
+    type ScanningStationDeleteResponse as ScanningStationDeleteResponse,
+    type ScanningStationCreateParams as ScanningStationCreateParams,
+    type ScanningStationRetrieveParams as ScanningStationRetrieveParams,
+    type ScanningStationUpdateParams as ScanningStationUpdateParams,
+    type ScanningStationListParams as ScanningStationListParams,
+  };
+}

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

@@ -0,0 +1,302 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CustomersAPI from '../sales/customers/customers';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * List and manage scanning stations.
+ */
+export class ScanningStations extends APIResource {
+  /**
+   * Creates a scanning station associated with a department.
+   *
+   * @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 });
+  }
+
+  /**
+   * Returns a scanning station by ID.
+   *
+   * @example
+   * ```ts
+   * const scanningStation =
+   *   await client.operations.scanningStations.retrieve(
+   *     'scst_0129335dd6286056a97024fcc1',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: ScanningStationRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ScanningStation> {
+    return this._client.get(path`/v1/operations/scanning-stations/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a scanning station.
+   *
+   * @example
+   * ```ts
+   * const scanningStation =
+   *   await client.operations.scanningStations.update(
+   *     'scst_0129335dd6286056a97024fcc1',
+   *     { name: 'Station B' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: ScanningStationUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ScanningStation> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/operations/scanning-stations/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * 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.
+   *
+   * @example
+   * ```ts
+   * const scanningStation =
+   *   await client.operations.scanningStations.delete(
+   *     'scst_0129335dd6286056a97024fcc1',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<ScanningStationDeleteResponse> {
+    return this._client.delete(path`/v1/operations/scanning-stations/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a scanning station.
+ */
+export interface CreateScanningStationRequest {
+  /**
+   * Department ID.
+   */
+  department_id: string;
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Operator requirement behavior for this station.
+   */
+  operator_requirement: 'none' | 'material_check';
+
+  /**
+   * Scanning station type.
+   */
+  type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
+
+  /**
+   * Label size code.
+   */
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+
+  /**
+   * Label type code.
+   */
+  label_type?: 'tag' | 'traveler';
+
+  /**
+   * Notes.
+   */
+  notes?: string;
+}
+
+/**
+ * Request to partially update a scanning station.
+ */
+export interface UpdateScanningStationRequest {
+  /**
+   * Label size code.
+   */
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+
+  /**
+   * Label type code.
+   */
+  label_type?: 'tag' | 'traveler';
+
+  /**
+   * Display name.
+   */
+  name?: string;
+
+  /**
+   * Notes.
+   */
+  notes?: string | null;
+
+  /**
+   * Operator requirement behavior for this station.
+   */
+  operator_requirement?: 'none' | 'material_check';
+}
+
+export interface ScanningStationDeleteResponse {}
+
+export interface ScanningStationCreateParams {
+  /**
+   * Body param: Department ID.
+   */
+  department_id: string;
+
+  /**
+   * Body param: Display name.
+   */
+  name: string;
+
+  /**
+   * Body param: Operator requirement behavior for this station.
+   */
+  operator_requirement: 'none' | 'material_check';
+
+  /**
+   * Body param: Scanning station type.
+   */
+  type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'department' | 'production_steps'>;
+
+  /**
+   * Body param: Label size code.
+   */
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+
+  /**
+   * Body param: Label type code.
+   */
+  label_type?: 'tag' | 'traveler';
+
+  /**
+   * Body param: Notes.
+   */
+  notes?: string;
+}
+
+export interface ScanningStationRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'department' | 'production_steps'>;
+}
+
+export interface ScanningStationUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'department' | 'production_steps'>;
+
+  /**
+   * Body param: Label size code.
+   */
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+
+  /**
+   * Body param: Label type code.
+   */
+  label_type?: 'tag' | 'traveler';
+
+  /**
+   * Body param: Display name.
+   */
+  name?: string;
+
+  /**
+   * Body param: Notes.
+   */
+  notes?: string | null;
+
+  /**
+   * Body param: Operator requirement behavior for this station.
+   */
+  operator_requirement?: 'none' | 'material_check';
+}
+
+export interface ScanningStationListParams {
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'department' | 'production_steps'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+export declare namespace ScanningStations {
+  export {
+    type CreateScanningStationRequest as CreateScanningStationRequest,
+    type UpdateScanningStationRequest as UpdateScanningStationRequest,
+    type ScanningStationDeleteResponse as ScanningStationDeleteResponse,
+    type ScanningStationCreateParams as ScanningStationCreateParams,
+    type ScanningStationRetrieveParams as ScanningStationRetrieveParams,
+    type ScanningStationUpdateParams as ScanningStationUpdateParams,
+    type ScanningStationListParams as ScanningStationListParams,
+  };
+}