@openmrp/sdk 0.21.0 → 0.22.0

package/src/resources/core/core.ts

@@ -178,6 +178,7 @@ export interface Entity {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -289,6 +290,9 @@ export interface Entity {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -475,7 +479,6 @@ export interface Entity {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 }
@@ -556,6 +559,7 @@ export interface CoreRetrieveSearchParams {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -667,6 +671,9 @@ export interface CoreRetrieveSearchParams {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -853,7 +860,6 @@ export interface CoreRetrieveSearchParams {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total'
   >;

package/src/resources/core/jobs.ts

@@ -127,6 +127,7 @@ export interface Job {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -238,6 +239,9 @@ export interface Job {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -424,7 +428,6 @@ export interface Job {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total'
     | null;

package/src/resources/messaging/conversations/conversations.ts

@@ -470,6 +470,7 @@ export interface CreateConversationRequest {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -581,6 +582,9 @@ export interface CreateConversationRequest {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -767,7 +771,6 @@ export interface CreateConversationRequest {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 }
@@ -1363,6 +1366,7 @@ export interface ConversationCreateParams {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -1474,6 +1478,9 @@ export interface ConversationCreateParams {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -1660,7 +1667,6 @@ export interface ConversationCreateParams {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 }
@@ -1751,6 +1757,7 @@ export interface ConversationListParams {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -1862,6 +1869,9 @@ export interface ConversationListParams {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -2048,7 +2058,6 @@ export interface ConversationListParams {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 

package/src/resources/messaging/conversations/links.ts

@@ -104,6 +104,7 @@ export interface AddConversationLinkRequest {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -215,6 +216,9 @@ export interface AddConversationLinkRequest {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -401,7 +405,6 @@ export interface AddConversationLinkRequest {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 }
@@ -486,6 +489,7 @@ export interface LinkCreateParams {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -597,6 +601,9 @@ export interface LinkCreateParams {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -783,7 +790,6 @@ export interface LinkCreateParams {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 

package/src/resources/messaging/conversations/messages.ts

@@ -255,6 +255,7 @@ export interface SendMessageRequest {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -366,6 +367,9 @@ export interface SendMessageRequest {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -552,7 +556,6 @@ export interface SendMessageRequest {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 
@@ -700,6 +703,7 @@ export interface MessageCreateParams {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -811,6 +815,9 @@ export interface MessageCreateParams {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -997,7 +1004,6 @@ export interface MessageCreateParams {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 

package/src/resources/messaging/notifications/notifications.ts

@@ -485,6 +485,7 @@ export interface SendNotificationRequest {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -596,6 +597,9 @@ export interface SendNotificationRequest {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -782,7 +786,6 @@ export interface SendNotificationRequest {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 
@@ -843,6 +846,7 @@ export interface NotificationCreateParams {
     | 'entity'
     | 'record'
     | 'freight'
+    | 'commitment'
     | 'sales_order_totals'
     | 'sales_order_stage_total'
     | 'sales_order_related'
@@ -954,6 +958,9 @@ export interface NotificationCreateParams {
     | 'delivery_backlog_bucket'
     | 'delivery_lateness_bucket'
     | 'delivery_breakdown'
+    | 'analyze_sales_breakdown_response'
+    | 'sales_totals'
+    | 'sales_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'schedule_deviation_type'
@@ -1140,7 +1147,6 @@ export interface NotificationCreateParams {
     | 'shipment_related'
     | 'invoice_related'
     | 'pick_related'
-    | 'pick_shipments_response'
     | 'pick_totals'
     | 'pick_stage_total';
 

package/src/resources/operations/index.ts

@@ -40,6 +40,13 @@ export {
   type FulfillmentRecommendation,
   type ListFulfillmentRecommendation,
 } from './fulfillment-recommendations/index';
+export {
+  InventoryChangeLogs,
+  type InventoryChangeLog,
+  type ListInventoryChangeLog,
+  type InventoryChangeLogListParams,
+  type InventoryChangeLogRetrieveParams,
+} from './inventory-change-logs/index';
 export {
   LocationTypes,
   type ListLocationType,
@@ -104,6 +111,18 @@ export {
   type ScheduleDeviationType,
   type OperationRetrieveMachineStatusParams,
 } from './operations';
+export {
+  Picks,
+  type ListPick,
+  type ListPickLine,
+  type Pick,
+  type PickLine,
+  type PickRelated,
+  type PickStageTotal,
+  type PickTotals,
+  type PickListParams,
+  type PickRetrieveParams,
+} from './picks/index';
 export {
   ProductionScheduleSettings,
   type UpdateProductionScheduleSettingsRequest,

package/src/resources/operations/inventory-change-logs/actions.ts

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * List and export inventory change logs.
+ */
+export class Actions extends APIResource {
+  /**
+   * Exports inventory change logs matching the provided filters as an Excel file.
+   *
+   * Unlike the list endpoint, results are not paginated — every matching change log
+   * is included in the download, newest first. The download is named for the date
+   * range you requested, using `all` in place of a bound you left open.
+   *
+   * This endpoint requires the permission: `inventory_logs:read`.
+   *
+   * @example
+   * ```ts
+   * const fileDownload =
+   *   await client.operations.inventoryChangeLogs.actions.export();
+   * ```
+   */
+  export(
+    query: ActionExportParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FileDownload> {
+    return this._client.get('/v1/operations/inventory-change-logs/actions/export', { query, ...options });
+  }
+}
+
+/**
+ * FileDownload is a response type for endpoints that return a file (e.g. Excel
+ * export). When the service returns \*FileDownload, the handler writes the body
+ * with Content-Type and Content-Disposition.
+ */
+export interface FileDownload {}
+
+export interface ActionExportParams {
+  /**
+   * Restricts results to these action types.
+   */
+  action_types?: Array<'scan' | 'user_action' | 'system_action' | 'user_correction'>;
+
+  /**
+   * Restricts results to changes made by these users.
+   *
+   * Changes that were recorded without a responsible user are excluded whenever this
+   * filter is set.
+   */
+  changed_by_user_ids?: Array<string>;
+
+  /**
+   * Restricts results to change logs created on or before this timestamp.
+   */
+  ends_at?: string;
+
+  /**
+   * Restricts results to changes affecting these items.
+   */
+  item_ids?: Array<string>;
+
+  /**
+   * Restricts results to change logs created on or after this timestamp.
+   */
+  starts_at?: string;
+}
+
+export declare namespace Actions {
+  export { type FileDownload as FileDownload, type ActionExportParams as ActionExportParams };
+}

package/src/resources/operations/inventory-change-logs/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type FileDownload, type ActionExportParams } from './actions';
+export {
+  InventoryChangeLogs,
+  type InventoryChangeLog,
+  type ListInventoryChangeLog,
+  type InventoryChangeLogListParams,
+  type InventoryChangeLogRetrieveParams,
+} from './inventory-change-logs';

package/src/resources/operations/inventory-change-logs/inventory-change-logs.ts

@@ -0,0 +1,239 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BlocksAPI from '../../messaging/blocks';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ItemsAPI from '../../catalog/items/items';
+import * as MaterialsAPI from '../../catalog/materials/materials';
+import * as ActionsAPI from './actions';
+import { ActionExportParams, Actions, FileDownload } from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and export inventory change logs.
+ */
+export class InventoryChangeLogs extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Returns a paginated list of inventory change logs, newest first.
+   *
+   * Filters combine with AND, while the values within a single filter combine with
+   * OR. The `q` search term matches on item SKU, responsible user name, and scanning
+   * station name.
+   *
+   * This endpoint requires the permission: `inventory_logs:read`.
+   *
+   * @example
+   * ```ts
+   * const listInventoryChangeLog =
+   *   await client.operations.inventoryChangeLogs.list();
+   * ```
+   */
+  list(
+    query: InventoryChangeLogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListInventoryChangeLog> {
+    return this._client.get('/v1/operations/inventory-change-logs', { query, ...options });
+  }
+
+  /**
+   * Returns an inventory change log by ID.
+   *
+   * This endpoint requires the permission: `inventory_logs:read`.
+   *
+   * @example
+   * ```ts
+   * const inventoryChangeLog =
+   *   await client.operations.inventoryChangeLogs.retrieve(
+   *     'icl_kb4dlhqx4voe',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: InventoryChangeLogRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InventoryChangeLog> {
+    return this._client.get(path`/v1/operations/inventory-change-logs/${id}`, { query, ...options });
+  }
+}
+
+/**
+ * A record of a single change to an item's on-hand inventory.
+ *
+ * Every inventory movement — production scans, manual user adjustments, and
+ * automatic system actions — produces one entry, forming an audit trail of how
+ * on-hand quantities changed over time.
+ */
+export interface InventoryChangeLog {
+  /**
+   * Inventory change log ID.
+   */
+  id: string;
+
+  /**
+   * Action that produced this inventory change.
+   *
+   * - `scan`: change driven by a scan, typically a production step.
+   * - `user_action`: change made manually by a user.
+   * - `system_action`: change made automatically by the system.
+   * - `user_correction`: manual adjustment a user made to correct an inventory
+   *   discrepancy.
+   */
+  action_type: 'scan' | 'user_action' | 'system_action' | 'user_correction';
+
+  /**
+   * Timestamp when this change was recorded.
+   */
+  created_at: string;
+
+  /**
+   * An entry in your catalog: something you sell, consume, or build with.
+   */
+  item: ItemsAPI.Item | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'inventory_change_log';
+
+  /**
+   * A measured amount: a numeric value together with the unit it is expressed in.
+   *
+   * Quantities are shared building blocks rather than standalone records — other
+   * resources point at them to report stock levels, ordered and packed amounts,
+   * money, weights, and durations.
+   */
+  quantity: MaterialsAPI.Quantity | null;
+
+  /**
+   * A station on the production floor where operators scan batches to perform a
+   * batch operation, such as initializing or moving a batch.
+   */
+  responsible_scanning_station: BlocksAPI.ScanningStation | null;
+
+  /**
+   * A user's global profile, shared across every account they belong to.
+   *
+   * Account-specific settings (status, role, department) live on the account user
+   * resource that links the user to each account.
+   */
+  responsible_user: BlocksAPI.User | null;
+
+  /**
+   * Timestamp when this record was last updated.
+   */
+  updated_at: string;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListInventoryChangeLog {
+  /**
+   * Resources in this page.
+   */
+  data: Array<InventoryChangeLog>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo describes where the current page sits within a paginated result set and
+   * how to move to the adjacent pages.
+   *
+   * Page a list by following the URLs below rather than assembling cursors yourself.
+   * For a top-level list endpoint the URL repeats the original request's query
+   * string with only the cursor swapped, so following it preserves the same filters,
+   * search term, and page size.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+export interface InventoryChangeLogListParams {
+  /**
+   * Restricts results to these action types.
+   */
+  action_types?: Array<'scan' | 'user_action' | 'system_action' | 'user_correction'>;
+
+  /**
+   * Restricts results to changes made by these users.
+   *
+   * Changes that were recorded without a responsible user are excluded whenever this
+   * filter is set.
+   */
+  changed_by_user_ids?: Array<string>;
+
+  /**
+   * 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;
+
+  /**
+   * Restricts results to change logs created on or before this timestamp.
+   */
+  ends_at?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'item' | 'responsible_user' | 'responsible_scanning_station'>;
+
+  /**
+   * Restricts results to changes affecting these items.
+   */
+  item_ids?: Array<string>;
+
+  /**
+   * Maximum number of results to return in a single page.
+   */
+  limit?: number;
+
+  /**
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
+   */
+  q?: string;
+
+  /**
+   * Restricts results to change logs created on or after this timestamp.
+   */
+  starts_at?: string;
+}
+
+export interface InventoryChangeLogRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'item' | 'responsible_user' | 'responsible_scanning_station'>;
+}
+
+InventoryChangeLogs.Actions = Actions;
+
+export declare namespace InventoryChangeLogs {
+  export {
+    type InventoryChangeLog as InventoryChangeLog,
+    type ListInventoryChangeLog as ListInventoryChangeLog,
+    type InventoryChangeLogListParams as InventoryChangeLogListParams,
+    type InventoryChangeLogRetrieveParams as InventoryChangeLogRetrieveParams,
+  };
+
+  export {
+    Actions as Actions,
+    type FileDownload as FileDownload,
+    type ActionExportParams as ActionExportParams,
+  };
+}

package/src/resources/operations/inventory-change-logs.ts

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