@openmrp/sdk 0.24.2 → 0.25.0

package/src/resources/catalog/items/actions.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as CoreAPI from '../../core/core';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as InventoryAPI from './inventory';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 
@@ -217,50 +219,72 @@ export interface ReconcileErrorResult {
   error: string;
 
   /**
-   * Item SKU.
+   * Entity is a polymorphic reference to any resource in the system.
    */
-  sku: string;
+  item: CoreAPI.Entity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'reconcile_error_result';
 }
 
 /**
  * An item whose on-hand quantity was successfully reconciled.
  *
  * Both quantities are expressed in the item's own base unit, not in the unit
- * submitted with the request.
+ * submitted with the request, and both arrive with that unit resolved.
  */
 export interface ReconciledItemResult {
   /**
-   * Item ID.
+   * Entity is a polymorphic reference to any resource in the system.
    */
-  item_id: string;
+  item: CoreAPI.Entity | null;
 
   /**
-   * Quantity after the reconciliation, as a decimal string.
+   * An amount calculated on demand rather than stored.
+   *
+   * The same shape as a quantity minus the ID, because nothing was written: it is
+   * derived per request, such as a total rolled up across invoiced lines for one
+   * analysis.
    */
-  new_quantity: string;
+  new_quantity: InventoryAPI.ComputedQuantity | null;
 
   /**
-   * Quantity before the reconciliation, as a decimal string.
+   * Resource type identifier.
    */
-  previous_quantity: string;
+  object: 'reconciled_item_result';
 
   /**
-   * Item SKU.
+   * An amount calculated on demand rather than stored.
+   *
+   * The same shape as a quantity minus the ID, because nothing was written: it is
+   * derived per request, such as a total rolled up across invoiced lines for one
+   * analysis.
    */
-  sku: string;
+  previous_quantity: InventoryAPI.ComputedQuantity | null;
 }
 
 /**
  * A submitted row that was skipped rather than reconciled.
+ *
+ * A skipped row is reported by the SKU it was submitted under rather than as an
+ * item reference, because the usual reason to skip one is that no item carries
+ * that SKU — there is nothing to point at.
  */
 export interface SkippedItemResult {
+  /**
+   * Resource type identifier.
+   */
+  object: 'skipped_item_result';
+
   /**
    * Human-readable reason the item was skipped.
    */
   reason: string;
 
   /**
-   * Item SKU.
+   * Item SKU, as submitted.
    */
   sku: string;
 }

package/src/resources/catalog/units/units.ts

@@ -113,7 +113,9 @@ export class Units extends APIResource {
    * Deletes a unit owned by your account.
    *
    * The unit is also removed from every unit group it belongs to. System units,
-   * which are shared across all accounts, cannot be deleted.
+   * which are shared across all accounts, cannot be deleted, and neither can a unit
+   * that is a unit group's base unit — change the group's base unit or delete the
+   * group first — or one that any quantity or price is recorded in.
    *
    * This endpoint requires the permission: `units:delete`.
    *

package/src/resources/core/analytics.ts

@@ -1085,7 +1085,7 @@ export interface OeeDepartment {
   /**
    * Whether availability was measured from logged downtime or estimated from
    * runtime. A department with no logged downtime computes as perfectly available,
-   * so an estimate is labelled rather than presented as a measurement.
+   * so an estimate is labeled rather than presented as a measurement.
    */
   measurement_status: 'measured' | 'estimated';
 

package/src/resources/core/audit-events.ts

@@ -319,6 +319,7 @@ export interface AuditEvent {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -398,11 +399,14 @@ export interface AuditEvent {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -444,6 +448,11 @@ export interface AuditEvent {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -735,6 +744,7 @@ export interface ListObjectType {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -814,11 +824,14 @@ export interface ListObjectType {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -860,6 +873,11 @@ export interface ListObjectType {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -1139,6 +1157,7 @@ export interface AuditEventListParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -1218,11 +1237,14 @@ export interface AuditEventListParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -1264,6 +1286,11 @@ export interface AuditEventListParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -1466,6 +1493,7 @@ export interface AuditEventListParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -1545,11 +1573,14 @@ export interface AuditEventListParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -1591,6 +1622,11 @@ export interface AuditEventListParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -1639,6 +1675,10 @@ export interface AuditEventListParams {
 
   /**
    * Restricts results to audit events on or after this timestamp.
+   *
+   * Defaults to 24 hours before `ends_at`, or before now when `ends_at` is also
+   * omitted, unless `resource_ids` or the root resource is given — a record's
+   * history is returned whole. Pass an earlier timestamp to search further back.
    */
   starts_at?: string;
 

package/src/resources/core/core.ts

@@ -312,6 +312,7 @@ export interface Entity {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -391,11 +392,14 @@ export interface Entity {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -437,6 +441,11 @@ export interface Entity {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -694,6 +703,7 @@ export interface CoreRetrieveSearchParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -773,11 +783,14 @@ export interface CoreRetrieveSearchParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -819,6 +832,11 @@ export interface CoreRetrieveSearchParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'

package/src/resources/core/jobs.ts

@@ -261,6 +261,7 @@ export interface Job {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -340,11 +341,14 @@ export interface Job {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -386,6 +390,11 @@ export interface Job {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'

package/src/resources/core/request-logs.ts

@@ -519,6 +519,9 @@ export interface RequestLogListParams {
 
   /**
    * Restricts results to request logs on or after this timestamp.
+   *
+   * Defaults to 24 hours before `ends_at`, or before now when `ends_at` is also
+   * omitted. Pass an earlier timestamp to search further back.
    */
   starts_at?: string;
 

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

@@ -604,6 +604,7 @@ export interface CreateConversationRequest {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -683,11 +684,14 @@ export interface CreateConversationRequest {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -729,6 +733,11 @@ export interface CreateConversationRequest {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -1501,6 +1510,7 @@ export interface ConversationCreateParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -1580,11 +1590,14 @@ export interface ConversationCreateParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -1626,6 +1639,11 @@ export interface ConversationCreateParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -1893,6 +1911,7 @@ export interface ConversationListParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -1972,11 +1991,14 @@ export interface ConversationListParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -2018,6 +2040,11 @@ export interface ConversationListParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'

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

@@ -238,6 +238,7 @@ export interface AddConversationLinkRequest {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -317,11 +318,14 @@ export interface AddConversationLinkRequest {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -363,6 +367,11 @@ export interface AddConversationLinkRequest {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -624,6 +633,7 @@ export interface LinkCreateParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -703,11 +713,14 @@ export interface LinkCreateParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -749,6 +762,11 @@ export interface LinkCreateParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'

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

@@ -389,6 +389,7 @@ export interface SendMessageRequest {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -468,11 +469,14 @@ export interface SendMessageRequest {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -514,6 +518,11 @@ export interface SendMessageRequest {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
@@ -838,6 +847,7 @@ export interface MessageCreateParams {
     | 'priority'
     | 'delivery'
     | 'delivery_line'
+    | 'delivery_related'
     | 'sales_order'
     | 'location'
     | 'location_type'
@@ -917,11 +927,14 @@ export interface MessageCreateParams {
     | 'map'
     | 'purchase_order'
     | 'purchase_order_line'
+    | 'purchase_order_related'
     | 'supplier'
-    | 'supplier_summary'
     | 'receivable_entry'
     | 'receiving_order'
     | 'receiving_order_line'
+    | 'receiving_order_totals'
+    | 'receiving_order_stage_total'
+    | 'receiving_order_related'
     | 'email_contact'
     | 'allocation_entry'
     | 'open_credit_entry'
@@ -963,6 +976,11 @@ export interface MessageCreateParams {
     | 'user_photo_url'
     | 'batch_lot'
     | 'check_duplicate_result'
+    | 'item_costs'
+    | 'item_trends'
+    | 'reconciled_item_result'
+    | 'skipped_item_result'
+    | 'reconcile_error_result'
     | 'item_trend_point'
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'