@openmrp/sdk 0.20.0 → 0.22.0

package/src/resources/operations/operations.ts

@@ -96,6 +96,14 @@ import {
   FulfillmentRecommendations,
   ListFulfillmentRecommendation,
 } from './fulfillment-recommendations/fulfillment-recommendations';
+import * as InventoryChangeLogsAPI from './inventory-change-logs/inventory-change-logs';
+import {
+  InventoryChangeLog,
+  InventoryChangeLogListParams,
+  InventoryChangeLogRetrieveParams,
+  InventoryChangeLogs,
+  ListInventoryChangeLog,
+} from './inventory-change-logs/inventory-change-logs';
 import * as LocationsAPI from './locations/locations';
 import {
   CreateLocationRequest,
@@ -119,6 +127,19 @@ import {
   OperatingCalendars,
   UpdateOperatingCalendarRequest,
 } from './operating-calendars/operating-calendars';
+import * as PicksAPI from './picks/picks';
+import {
+  ListPick,
+  ListPickLine,
+  Pick,
+  PickLine,
+  PickListParams,
+  PickRelated,
+  PickRetrieveParams,
+  PickStageTotal,
+  PickTotals,
+  Picks,
+} from './picks/picks';
 import * as ProductionScheduleSettingsAPI from './production-schedule-settings/production-schedule-settings';
 import {
   ProductionScheduleSettingUpdateParams,
@@ -173,6 +194,8 @@ export class Operations extends APIResource {
   shippingTerms: ShippingTermsAPI.ShippingTerms = new ShippingTermsAPI.ShippingTerms(this._client);
   carriers: CarriersAPI.Carriers = new CarriersAPI.Carriers(this._client);
   departments: DepartmentsAPI.Departments = new DepartmentsAPI.Departments(this._client);
+  inventoryChangeLogs: InventoryChangeLogsAPI.InventoryChangeLogs =
+    new InventoryChangeLogsAPI.InventoryChangeLogs(this._client);
   machines: MachinesAPI.Machines = new MachinesAPI.Machines(this._client);
   machineDowntimeEvents: MachineDowntimeEventsAPI.MachineDowntimeEvents =
     new MachineDowntimeEventsAPI.MachineDowntimeEvents(this._client);
@@ -186,6 +209,7 @@ export class Operations extends APIResource {
   operatingCalendars: OperatingCalendarsAPI.OperatingCalendars = new OperatingCalendarsAPI.OperatingCalendars(
     this._client,
   );
+  picks: PicksAPI.Picks = new PicksAPI.Picks(this._client);
   locations: LocationsAPI.Locations = new LocationsAPI.Locations(this._client);
   locationTypes: LocationTypesAPI.LocationTypes = new LocationTypesAPI.LocationTypes(this._client);
   shipments: ShipmentsAPI.Shipments = new ShipmentsAPI.Shipments(this._client);
@@ -785,12 +809,14 @@ export interface OperationRetrieveMachineStatusParams {
 Operations.ShippingTerms = ShippingTerms;
 Operations.Carriers = Carriers;
 Operations.Departments = Departments;
+Operations.InventoryChangeLogs = InventoryChangeLogs;
 Operations.Machines = Machines;
 Operations.MachineDowntimeEvents = MachineDowntimeEvents;
 Operations.DemandOverrides = DemandOverrides;
 Operations.ProductionSchedules = ProductionSchedules;
 Operations.FulfillmentRecommendations = FulfillmentRecommendations;
 Operations.OperatingCalendars = OperatingCalendars;
+Operations.Picks = Picks;
 Operations.Locations = Locations;
 Operations.LocationTypes = LocationTypes;
 Operations.Shipments = Shipments;
@@ -849,6 +875,14 @@ export declare namespace Operations {
     type DepartmentUpdateParams as DepartmentUpdateParams,
   };
 
+  export {
+    InventoryChangeLogs as InventoryChangeLogs,
+    type InventoryChangeLog as InventoryChangeLog,
+    type ListInventoryChangeLog as ListInventoryChangeLog,
+    type InventoryChangeLogListParams as InventoryChangeLogListParams,
+    type InventoryChangeLogRetrieveParams as InventoryChangeLogRetrieveParams,
+  };
+
   export {
     Machines as Machines,
     type CreateMachineRequest as CreateMachineRequest,
@@ -949,6 +983,19 @@ export declare namespace Operations {
     type OperatingCalendarUpdateParams as OperatingCalendarUpdateParams,
   };
 
+  export {
+    Picks as Picks,
+    type ListPick as ListPick,
+    type ListPickLine as ListPickLine,
+    type Pick as Pick,
+    type PickLine as PickLine,
+    type PickRelated as PickRelated,
+    type PickStageTotal as PickStageTotal,
+    type PickTotals as PickTotals,
+    type PickListParams as PickListParams,
+    type PickRetrieveParams as PickRetrieveParams,
+  };
+
   export {
     Locations as Locations,
     type CreateLocationRequest as CreateLocationRequest,

package/src/resources/operations/picks/actions.ts

@@ -0,0 +1,131 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as JobsAPI from '../../core/jobs';
+import * as PicksAPI from './picks';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List, view, pick, void, and pack picks and pick lines.
+ */
+export class Actions extends APIResource {
+  /**
+   * Marks all lines on a pick as picked.
+   *
+   * Sets each unpacked line's picked quantity to the quantity still outstanding on
+   * its sales order line, after accounting for what other pick lines for that order
+   * line have already picked. Lines that have already been packed are unaffected.
+   * Use this to fill in a full pick in one call instead of picking each line
+   * individually; nothing is shipped until the pick is packed.
+   *
+   * This endpoint requires the permission: `picks:update`.
+   *
+   * @example
+   * ```ts
+   * const pick = await client.operations.picks.actions.pick(
+   *   'pk_6eilj488bq8d',
+   * );
+   * ```
+   */
+  pick(id: string, options?: RequestOptions): APIPromise<PicksAPI.Pick> {
+    return this._client.put(path`/v1/operations/picks/${id}/actions/pick`, options);
+  }
+
+  /**
+   * Voids a pick, undoing all picking work recorded on it.
+   *
+   * Resets the picked quantity on every unpacked line to zero and clears the pick's
+   * `finished_at` timestamp, so the pick starts over as open with nothing picked.
+   * The pick itself is not deleted, and the sales order is unaffected.
+   *
+   * Returns a validation error if any shipment exists for the pick's sales order.
+   * Voiding those shipments is not enough — they must be deleted, since a voided
+   * shipment still exists.
+   *
+   * This endpoint requires the permission: `picks:update`.
+   *
+   * @example
+   * ```ts
+   * const pick = await client.operations.picks.actions.void(
+   *   'pk_6eilj488bq8d',
+   * );
+   * ```
+   */
+  void(id: string, options?: RequestOptions): APIPromise<PicksAPI.Pick> {
+    return this._client.put(path`/v1/operations/picks/${id}/actions/void`, options);
+  }
+
+  /**
+   * Packs a pick, creating a shipment from the picked lines.
+   *
+   * Returns `202 Accepted` with a job, because packing writes a shipment, one
+   * shipment line per packed pick line, and the requested shipping cases. Poll the
+   * job at the returned `Location`; once it reports `completed`, its first result
+   * carries the new shipment's `id`, with the shipment line and shipping case ids in
+   * `sub_resource_ids`. Every unpacked line with a picked quantity greater than zero
+   * is marked as packed and added to a new shipment in `packed` status, which
+   * inherits the sales order's carrier, service level, and shipping address. When a
+   * sales order line still has outstanding quantity afterward and no unpacked pick
+   * line is already open for it, a new zero-quantity pick line is created for the
+   * remainder, so packing a partial pick leaves the pick open for the next round.
+   * The pick is marked finished only once every one of its lines is packed.
+   *
+   * Returns a validation error if no line on the pick has a picked quantity greater
+   * than zero.
+   *
+   * This endpoint requires the permission: `picks:update`.
+   *
+   * @example
+   * ```ts
+   * const job = await client.operations.picks.actions.pack(
+   *   'pk_6eilj488bq8d',
+   *   { shipment_case_count: 3 },
+   * );
+   * ```
+   */
+  pack(id: string, params: ActionPackParams, options?: RequestOptions): APIPromise<JobsAPI.Job> {
+    const { include, ...body } = params;
+    return this._client.post(path`/v1/operations/picks/${id}/actions/pack`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+}
+
+/**
+ * Request to pack a pick, creating a shipment from the picked lines.
+ */
+export interface PackPickRequest {
+  /**
+   * Number of shipping cases to create on the new shipment.
+   *
+   * Must be at least 1. Cases are numbered sequentially from the shipment number
+   * (e.g. `SO-001-1`, `SO-001-2`), and each starts with zero freight weight and
+   * freight cost for you to fill in later.
+   */
+  shipment_case_count: number;
+}
+
+export interface ActionPackParams {
+  /**
+   * Body param: Number of shipping cases to create on the new shipment.
+   *
+   * Must be at least 1. Cases are numbered sequentially from the shipment number
+   * (e.g. `SO-001-1`, `SO-001-2`), and each starts with zero freight weight and
+   * freight cost for you to fill in later.
+   */
+  shipment_case_count: number;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'created_by' | 'created_by.role'>;
+}
+
+export declare namespace Actions {
+  export { type PackPickRequest as PackPickRequest, type ActionPackParams as ActionPackParams };
+}

package/src/resources/operations/picks/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type PackPickRequest, type ActionPackParams } from './actions';
+export { Lines, type UpdatePickLineRequest, type LineUpdateParams } from './lines/index';
+export {
+  Picks,
+  type ListPick,
+  type ListPickLine,
+  type Pick,
+  type PickLine,
+  type PickRelated,
+  type PickStageTotal,
+  type PickTotals,
+  type PickListParams,
+  type PickRetrieveParams,
+} from './picks';

package/src/resources/operations/picks/lines/actions.ts

@@ -0,0 +1,78 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as PicksAPI from '../picks';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * List, view, pick, void, and pack picks and pick lines.
+ */
+export class Actions extends APIResource {
+  /**
+   * Marks a pick line as fully picked.
+   *
+   * Sets the line's picked quantity to its sales order line's ordered quantity less
+   * everything already picked for that order line, including whatever this line had
+   * picked before the call. To record a short pick instead, set the quantity
+   * yourself with Update Pick Line. Has no effect on a line that has already been
+   * packed.
+   *
+   * This endpoint requires the permission: `picks:update`.
+   *
+   * @example
+   * ```ts
+   * const pickLine =
+   *   await client.operations.picks.lines.actions.pick(
+   *     'example',
+   *     { pick_id: 'pk_6eilj488bq8d' },
+   *   );
+   * ```
+   */
+  pick(id: string, params: ActionPickParams, options?: RequestOptions): APIPromise<PicksAPI.PickLine> {
+    const { pick_id } = params;
+    return this._client.put(path`/v1/operations/picks/${pick_id}/lines/${id}/actions/pick`, options);
+  }
+
+  /**
+   * Voids a pick line, undoing the picking work recorded on it.
+   *
+   * Resets the line's picked quantity to zero without deleting the line, so the
+   * quantity can be picked again. Returns a validation error if the line has already
+   * been packed.
+   *
+   * This endpoint requires the permission: `picks:update`.
+   *
+   * @example
+   * ```ts
+   * const pickLine =
+   *   await client.operations.picks.lines.actions.void(
+   *     'example',
+   *     { pick_id: 'pk_6eilj488bq8d' },
+   *   );
+   * ```
+   */
+  void(id: string, params: ActionVoidParams, options?: RequestOptions): APIPromise<PicksAPI.PickLine> {
+    const { pick_id } = params;
+    return this._client.put(path`/v1/operations/picks/${pick_id}/lines/${id}/actions/void`, options);
+  }
+}
+
+export interface ActionPickParams {
+  /**
+   * Pick ID.
+   */
+  pick_id: string;
+}
+
+export interface ActionVoidParams {
+  /**
+   * Pick ID.
+   */
+  pick_id: string;
+}
+
+export declare namespace Actions {
+  export { type ActionPickParams as ActionPickParams, type ActionVoidParams as ActionVoidParams };
+}

package/src/resources/operations/picks/lines/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type ActionPickParams, type ActionVoidParams } from './actions';
+export { Lines, type UpdatePickLineRequest, type LineUpdateParams } from './lines';

package/src/resources/operations/picks/lines/lines.ts

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as PicksAPI from '../picks';
+import * as ActionsAPI from './actions';
+import { ActionPickParams, ActionVoidParams, Actions } from './actions';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * List, view, pick, void, and pack picks and pick lines.
+ */
+export class Lines extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Updates a pick line's picked quantity.
+   *
+   * Use this to record a short or partial pick; Pick Pick Line fills in the full
+   * outstanding quantity instead.
+   *
+   * This endpoint requires the permission: `picks:update`.
+   *
+   * @example
+   * ```ts
+   * const pickLine = await client.operations.picks.lines.update(
+   *   'example',
+   *   {
+   *     pick_id: 'pk_6eilj488bq8d',
+   *     quantity_value: '10.000000000000000000000000000000',
+   *   },
+   * );
+   * ```
+   */
+  update(id: string, params: LineUpdateParams, options?: RequestOptions): APIPromise<PicksAPI.PickLine> {
+    const { pick_id, include, ...body } = params;
+    return this._client.patch(path`/v1/operations/picks/${pick_id}/lines/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+}
+
+/**
+ * Request to update a pick line's picked quantity.
+ */
+export interface UpdatePickLineRequest {
+  /**
+   * New picked quantity for the line, as a decimal string read in the unit the sales
+   * order line was sold in, stored as given and not capped at the ordered quantity.
+   *
+   * Must not be negative. Pulling more than was ordered is a real floor event and is
+   * kept as recorded; pulling a negative amount is not.
+   */
+  quantity_value?: string;
+}
+
+export interface LineUpdateParams {
+  /**
+   * Path param: Pick ID.
+   */
+  pick_id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'sales_order_line'
+    | 'sales_order_line.product'
+    | 'quantity'
+    | 'quantity.unit'
+    | 'ordered_quantity'
+    | 'ordered_quantity.unit'
+  >;
+
+  /**
+   * Body param: New picked quantity for the line, as a decimal string read in the
+   * unit the sales order line was sold in, stored as given and not capped at the
+   * ordered quantity.
+   *
+   * Must not be negative. Pulling more than was ordered is a real floor event and is
+   * kept as recorded; pulling a negative amount is not.
+   */
+  quantity_value?: string;
+}
+
+Lines.Actions = Actions;
+
+export declare namespace Lines {
+  export { type UpdatePickLineRequest as UpdatePickLineRequest, type LineUpdateParams as LineUpdateParams };
+
+  export {
+    Actions as Actions,
+    type ActionPickParams as ActionPickParams,
+    type ActionVoidParams as ActionVoidParams,
+  };
+}

package/src/resources/operations/picks/lines.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './lines/index';