@augno/sdk 0.16.0 → 0.17.0

package/src/resources/core/analytics.ts

@@ -125,6 +125,17 @@ export class Analytics extends APIResource {
    * Every rate is null rather than zero when nothing was due, and average lateness
    * is measured over late orders only.
    *
+   * The same window is also returned sliced by customer, customer group, product
+   * line, and the rule each ship-by date came from — each ordered worst-first, and
+   * each derived from the same set of orders as the headline so a drilldown always
+   * adds up to it. `by_product_line` is the one exception to that: an order spanning
+   * two lines is counted under both, because a late order is late for every line on
+   * it.
+   *
+   * Every filter is empty-means-all and they combine with AND. They narrow
+   * `uncommitted_order_count` too, so the excluded count always describes the same
+   * slice of the order book the rates do.
+   *
    * This endpoint requires the permission: `sales_orders:read`.
    *
    * @example
@@ -160,10 +171,31 @@ export interface AnalyzeDeliveryPerformanceRequest {
    */
   starts_at: string;
 
+  /**
+   * Only measure orders whose customer sits in these groups.
+   */
+  customer_group_ids?: Array<string>;
+
+  /**
+   * Only measure orders bought by these customers. Their child accounts are
+   * included, matching how the sales analytics resolve a customer.
+   */
+  customer_ids?: Array<string>;
+
   /**
    * The period to break the results down by. Defaults to `week`.
    */
   granularity?: 'day' | 'week' | 'month';
+
+  /**
+   * Only measure orders containing at least one line in these product lines.
+   */
+  product_line_ids?: Array<string>;
+
+  /**
+   * Only measure orders owned by these sales reps.
+   */
+  sales_rep_ids?: Array<string>;
 }
 
 /**
@@ -176,6 +208,36 @@ export interface AnalyzeDeliveryPerformanceResponse {
    */
   backlog: ListDeliveryBacklogBucket | null;
 
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  by_commitment_source: ListDeliveryBreakdown | null;
+
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  by_customer: ListDeliveryBreakdown | null;
+
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  by_customer_group: ListDeliveryBreakdown | null;
+
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  by_product_line: ListDeliveryBreakdown | null;
+
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  lateness: ListDeliveryLatenessBucket | null;
+
   /**
    * Resource type identifier.
    */
@@ -363,6 +425,15 @@ export interface AnalyzeScheduleAttainmentResponse {
    */
   object: 'analyze_schedule_attainment_response';
 
+  /**
+   * Machines the plan asked for over this window.
+   *
+   * Every figure in this response covers those machines only. Production scanned
+   * onto a machine no published version scheduled is excluded outright, so the score
+   * measures the plan that was made rather than the whole plant against it.
+   */
+  scheduled_machine_count: number;
+
   /**
    * Start of the measured period.
    */
@@ -491,6 +562,73 @@ export interface DeliveryBacklogBucket {
   units: number;
 }
 
+/**
+ * Delivery performance for one slice of the order book.
+ */
+export interface DeliveryBreakdown {
+  /**
+   * Identifier of the slice — a customer, customer group, product line, or
+   * commitment source. Empty when the dimension is unset on the orders in it.
+   */
+  key: string;
+
+  /**
+   * Display name for the slice.
+   */
+  label: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'delivery_breakdown';
+
+  /**
+   * Delivery reliability for one period, or for a whole window.
+   */
+  performance: DeliveryPerformance | null;
+}
+
+/**
+ * One band of how far the window's misses missed by.
+ */
+export interface DeliveryLatenessBucket {
+  /**
+   * Name of the band.
+   */
+  label: string;
+
+  /**
+   * Upper bound in days late; `0` means unbounded.
+   */
+  max_days_late: number;
+
+  /**
+   * Lower bound of the band in days late.
+   */
+  min_days_late: number;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'delivery_lateness_bucket';
+
+  /**
+   * Orders in the band, shipped and unshipped.
+   */
+  order_count: number;
+
+  /**
+   * How many of them have since shipped. The remainder are still owed, and are the
+   * same orders `backlog` counts.
+   */
+  shipped_count: number;
+
+  /**
+   * Quantity still unpacked across the band's orders.
+   */
+  units: number;
+}
+
 /**
  * Delivery reliability for one period, or for a whole window.
  */
@@ -615,6 +753,20 @@ export interface FrozenAdherence {
    */
   line_adherence_pct: number | null;
 
+  /**
+   * Campaigns the floor ran inside the frozen window that the frozen plan never
+   * called for, counted per machine-week-SKU.
+   *
+   * Working around a commitment breaks it as surely as editing it does, so this
+   * scores alongside the hand edits rather than beside them.
+   */
+  off_plan_lines: number;
+
+  /**
+   * Units behind those off-plan campaigns.
+   */
+  off_plan_quantity: number;
+
   /**
    * Entity is a polymorphic reference to any resource in the system.
    */
@@ -685,6 +837,60 @@ export interface ListDeliveryBacklogBucket {
   page_info: APIKeysAPI.PageInfo;
 }
 
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListDeliveryBreakdown {
+  /**
+   * Resources in this page.
+   */
+  data: Array<DeliveryBreakdown>;
+
+  /**
+   * 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;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListDeliveryLatenessBucket {
+  /**
+   * Resources in this page.
+   */
+  data: Array<DeliveryLatenessBucket>;
+
+  /**
+   * 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;
+}
+
 /**
  * A single page of resources, together with the metadata needed to page through
  * the rest of the result set.
@@ -1158,10 +1364,31 @@ export interface AnalyticsUpdateDeliveryPerformanceParams {
    */
   starts_at: string;
 
+  /**
+   * Only measure orders whose customer sits in these groups.
+   */
+  customer_group_ids?: Array<string>;
+
+  /**
+   * Only measure orders bought by these customers. Their child accounts are
+   * included, matching how the sales analytics resolve a customer.
+   */
+  customer_ids?: Array<string>;
+
   /**
    * The period to break the results down by. Defaults to `week`.
    */
   granularity?: 'day' | 'week' | 'month';
+
+  /**
+   * Only measure orders containing at least one line in these product lines.
+   */
+  product_line_ids?: Array<string>;
+
+  /**
+   * Only measure orders owned by these sales reps.
+   */
+  sales_rep_ids?: Array<string>;
 }
 
 export declare namespace Analytics {
@@ -1176,10 +1403,14 @@ export declare namespace Analytics {
     type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse,
     type AttainmentBucket as AttainmentBucket,
     type DeliveryBacklogBucket as DeliveryBacklogBucket,
+    type DeliveryBreakdown as DeliveryBreakdown,
+    type DeliveryLatenessBucket as DeliveryLatenessBucket,
     type DeliveryPerformance as DeliveryPerformance,
     type FrozenAdherence as FrozenAdherence,
     type ListAttainmentBucket as ListAttainmentBucket,
     type ListDeliveryBacklogBucket as ListDeliveryBacklogBucket,
+    type ListDeliveryBreakdown as ListDeliveryBreakdown,
+    type ListDeliveryLatenessBucket as ListDeliveryLatenessBucket,
     type ListDeliveryPerformance as ListDeliveryPerformance,
     type ListFrozenAdherence as ListFrozenAdherence,
     type ListOeeDepartment as ListOeeDepartment,

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

@@ -294,6 +294,8 @@ export interface AuditEvent {
     | 'analyze_delivery_performance_response'
     | 'delivery_performance'
     | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'promise_date_quote'
@@ -447,7 +449,6 @@ export interface AuditEvent {
     | 'sales_order_price_quote'
     | 'sales_order_freight_quote'
     | 'sales_order_price_quote_line'
-    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -467,6 +468,8 @@ export interface AuditEvent {
     | 'pack_list_back_order'
     | 'pack_list_case'
     | 'job'
+    | 'job_result'
+    | 'job_export'
     | 'analyze_customer_pricing_response'
     | 'customer_pricing_finding'
     | 'customer_pricing_summary'
@@ -696,6 +699,8 @@ export interface ListObjectType {
     | 'analyze_delivery_performance_response'
     | 'delivery_performance'
     | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'promise_date_quote'
@@ -849,7 +854,6 @@ export interface ListObjectType {
     | 'sales_order_price_quote'
     | 'sales_order_freight_quote'
     | 'sales_order_price_quote_line'
-    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -869,6 +873,8 @@ export interface ListObjectType {
     | 'pack_list_back_order'
     | 'pack_list_case'
     | 'job'
+    | 'job_result'
+    | 'job_export'
     | 'analyze_customer_pricing_response'
     | 'customer_pricing_finding'
     | 'customer_pricing_summary'
@@ -1086,6 +1092,8 @@ export interface AuditEventListParams {
     | 'analyze_delivery_performance_response'
     | 'delivery_performance'
     | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'promise_date_quote'
@@ -1239,7 +1247,6 @@ export interface AuditEventListParams {
     | 'sales_order_price_quote'
     | 'sales_order_freight_quote'
     | 'sales_order_price_quote_line'
-    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -1259,6 +1266,8 @@ export interface AuditEventListParams {
     | 'pack_list_back_order'
     | 'pack_list_case'
     | 'job'
+    | 'job_result'
+    | 'job_export'
     | 'analyze_customer_pricing_response'
     | 'customer_pricing_finding'
     | 'customer_pricing_summary'
@@ -1399,6 +1408,8 @@ export interface AuditEventListParams {
     | 'analyze_delivery_performance_response'
     | 'delivery_performance'
     | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'promise_date_quote'
@@ -1552,7 +1563,6 @@ export interface AuditEventListParams {
     | 'sales_order_price_quote'
     | 'sales_order_freight_quote'
     | 'sales_order_price_quote_line'
-    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -1572,6 +1582,8 @@ export interface AuditEventListParams {
     | 'pack_list_back_order'
     | 'pack_list_case'
     | 'job'
+    | 'job_result'
+    | 'job_export'
     | 'analyze_customer_pricing_response'
     | 'customer_pricing_finding'
     | 'customer_pricing_summary'

package/src/resources/core/core.ts

@@ -18,10 +18,14 @@ import {
   AnalyzeScheduleAttainmentResponse,
   AttainmentBucket,
   DeliveryBacklogBucket,
+  DeliveryBreakdown,
+  DeliveryLatenessBucket,
   DeliveryPerformance,
   FrozenAdherence,
   ListAttainmentBucket,
   ListDeliveryBacklogBucket,
+  ListDeliveryBreakdown,
+  ListDeliveryLatenessBucket,
   ListDeliveryPerformance,
   ListFrozenAdherence,
   ListOeeDepartment,
@@ -46,7 +50,17 @@ import {
 import * as EmailLogsAPI from './email-logs';
 import { EmailLog, EmailLogListParams, EmailLogRetrieveParams, EmailLogs, ListEmailLog } from './email-logs';
 import * as JobsAPI from './jobs';
-import { Job, JobExport, JobResult, Jobs, QuotaInfo, ResponseError, RowError } from './jobs';
+import {
+  Job,
+  JobCancelParams,
+  JobExport,
+  JobResult,
+  JobRetrieveParams,
+  Jobs,
+  ListJobResult,
+  QuotaInfo,
+  ResponseError,
+} from './jobs';
 import * as RequestLogsAPI from './request-logs';
 import {
   Actor,
@@ -270,6 +284,8 @@ export interface Entity {
     | 'analyze_delivery_performance_response'
     | 'delivery_performance'
     | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'promise_date_quote'
@@ -423,7 +439,6 @@ export interface Entity {
     | 'sales_order_price_quote'
     | 'sales_order_freight_quote'
     | 'sales_order_price_quote_line'
-    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -443,6 +458,8 @@ export interface Entity {
     | 'pack_list_back_order'
     | 'pack_list_case'
     | 'job'
+    | 'job_result'
+    | 'job_export'
     | 'analyze_customer_pricing_response'
     | 'customer_pricing_finding'
     | 'customer_pricing_summary'
@@ -638,6 +655,8 @@ export interface CoreRetrieveSearchParams {
     | 'analyze_delivery_performance_response'
     | 'delivery_performance'
     | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
     | 'schedule_order_coverage'
     | 'schedule_order_coverage_line'
     | 'promise_date_quote'
@@ -791,7 +810,6 @@ export interface CoreRetrieveSearchParams {
     | 'sales_order_price_quote'
     | 'sales_order_freight_quote'
     | 'sales_order_price_quote_line'
-    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -811,6 +829,8 @@ export interface CoreRetrieveSearchParams {
     | 'pack_list_back_order'
     | 'pack_list_case'
     | 'job'
+    | 'job_result'
+    | 'job_export'
     | 'analyze_customer_pricing_response'
     | 'customer_pricing_finding'
     | 'customer_pricing_summary'
@@ -888,9 +908,11 @@ export declare namespace Core {
     type Job as Job,
     type JobExport as JobExport,
     type JobResult as JobResult,
+    type ListJobResult as ListJobResult,
     type QuotaInfo as QuotaInfo,
     type ResponseError as ResponseError,
-    type RowError as RowError,
+    type JobRetrieveParams as JobRetrieveParams,
+    type JobCancelParams as JobCancelParams,
   };
 
   export {
@@ -905,10 +927,14 @@ export declare namespace Core {
     type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse,
     type AttainmentBucket as AttainmentBucket,
     type DeliveryBacklogBucket as DeliveryBacklogBucket,
+    type DeliveryBreakdown as DeliveryBreakdown,
+    type DeliveryLatenessBucket as DeliveryLatenessBucket,
     type DeliveryPerformance as DeliveryPerformance,
     type FrozenAdherence as FrozenAdherence,
     type ListAttainmentBucket as ListAttainmentBucket,
     type ListDeliveryBacklogBucket as ListDeliveryBacklogBucket,
+    type ListDeliveryBreakdown as ListDeliveryBreakdown,
+    type ListDeliveryLatenessBucket as ListDeliveryLatenessBucket,
     type ListDeliveryPerformance as ListDeliveryPerformance,
     type ListFrozenAdherence as ListFrozenAdherence,
     type ListOeeDepartment as ListOeeDepartment,

package/src/resources/core/index.ts

@@ -18,10 +18,14 @@ export {
   type AnalyzeScheduleAttainmentResponse,
   type AttainmentBucket,
   type DeliveryBacklogBucket,
+  type DeliveryBreakdown,
+  type DeliveryLatenessBucket,
   type DeliveryPerformance,
   type FrozenAdherence,
   type ListAttainmentBucket,
   type ListDeliveryBacklogBucket,
+  type ListDeliveryBreakdown,
+  type ListDeliveryLatenessBucket,
   type ListDeliveryPerformance,
   type ListFrozenAdherence,
   type ListOeeDepartment,
@@ -59,9 +63,11 @@ export {
   type Job,
   type JobExport,
   type JobResult,
+  type ListJobResult,
   type QuotaInfo,
   type ResponseError,
-  type RowError,
+  type JobRetrieveParams,
+  type JobCancelParams,
 } from './jobs';
 export {
   RequestLogs,