@augno/sdk 0.12.7 → 0.13.1

package/resources/core/analytics.d.ts

@@ -0,0 +1,547 @@
+import { APIResource } from "../../core/resource.js";
+import * as CoreAPI from "./core.js";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Analyze sales, orders, manufacturing, materials, and other business metrics.
+ */
+export declare class Analytics extends APIResource {
+    /**
+     * Returns Overall Equipment Effectiveness (OEE) metrics by department.
+     *
+     * Availability is measured from logged machine downtime rather than inferred, so
+     * it requires both `planned_time` for the department and downtime events in the
+     * period. Departments with `has_downtime_data` false have no availability
+     * measurement, and their ratios are returned as null rather than as 100%.
+     *
+     * This endpoint requires the permission: `machine_downtime:read`.
+     *
+     * @example
+     * ```ts
+     * const analyzeOeeResponse =
+     *   await client.core.analytics.updateOee({
+     *     end_date: '2026-05-10T00:23:00Z',
+     *     start_date: '2026-05-10T00:00:00Z',
+     *     department_ids: ['dp_01791c25ab59da4704cba61874'],
+     *   });
+     * ```
+     */
+    updateOee(body: AnalyticsUpdateOeeParams, options?: RequestOptions): APIPromise<AnalyzeOeeResponse>;
+    /**
+     * Returns actual production measured against the plan that was live at the time.
+     *
+     * The baseline for each week is the schedule version published on or before that
+     * week began, so republishing mid-horizon cannot rewrite a week the floor has
+     * already worked. `baseline_schedules` names the versions used.
+     *
+     * Two ratios are returned because either alone misleads: `attainment_pct` caps
+     * each campaign at what was asked for, so over-building one SKU cannot hide a miss
+     * on another, while `output_ratio_pct` is uncapped and is what reveals
+     * over-production. Production with no matching planned campaign is reported as
+     * `unplanned_quantity` rather than discarded — that number is the clearest signal
+     * a schedule is being worked around.
+     *
+     * Every ratio is null rather than zero when nothing was planned, and
+     * `has_baseline` is false when nothing was ever published over the period.
+     *
+     * This endpoint requires the permission: `production_schedules:read`.
+     *
+     * @example
+     * ```ts
+     * const analyzeScheduleAttainmentResponse =
+     *   await client.core.analytics.updateScheduleAttainment({
+     *     end_date: '2026-05-10T00:23:00Z',
+     *     start_date: '2026-05-10T00:00:00Z',
+     *     group_by: 'week',
+     *   });
+     * ```
+     */
+    updateScheduleAttainment(body: AnalyticsUpdateScheduleAttainmentParams, options?: RequestOptions): APIPromise<AnalyzeScheduleAttainmentResponse>;
+}
+/**
+ * AnalyzeOeeRequest is the request to analyze Overall Equipment Effectiveness
+ * (OEE).
+ */
+export interface AnalyzeOeeRequest {
+    /**
+     * The end date for the analysis period.
+     */
+    end_date: string;
+    /**
+     * The start date for the analysis period.
+     */
+    start_date: string;
+    /**
+     * Optional department IDs to filter by.
+     */
+    department_ids?: Array<string>;
+    /**
+     * Scheduled production time per department for the period. Availability,
+     * performance and OEE are only returned for departments this covers.
+     */
+    planned_time?: Array<OeeDepartmentPlannedTime>;
+}
+/**
+ * AnalyzeOeeResponse represents the response from the analyze OEE endpoint.
+ */
+export interface AnalyzeOeeResponse {
+    /**
+     * List represents a paginated list of resources.
+     */
+    departments: ListOeeDepartment | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'analyze_oee_response';
+}
+/**
+ * AnalyzeScheduleAttainmentRequest is the request to measure production against
+ * plan.
+ */
+export interface AnalyzeScheduleAttainmentRequest {
+    /**
+     * The end date for the analysis period.
+     */
+    end_date: string;
+    /**
+     * The start date for the analysis period.
+     */
+    start_date: string;
+    /**
+     * Only measure production in these departments.
+     */
+    department_ids?: Array<string>;
+    /**
+     * The dimension to break the results down by. Defaults to `week`.
+     */
+    group_by?: 'week' | 'machine' | 'department' | 'item';
+    /**
+     * Only measure production on these machines.
+     */
+    machine_ids?: Array<string>;
+}
+/**
+ * Actual production measured against the plan that was live at the time.
+ *
+ * The baseline for each week is the version that was published on or before that
+ * week began, so republishing mid-horizon cannot rewrite a week the floor has
+ * already worked. `baseline_schedules` names the versions used, so any number here
+ * can be traced back to the plan that produced it.
+ */
+export interface AnalyzeScheduleAttainmentResponse {
+    /**
+     * List represents a paginated list of resources.
+     */
+    baseline_schedules: CoreAPI.ListEntity | null;
+    /**
+     * Whether the period had a plan to measure against. When `no_baseline`, every
+     * ratio is null and the period has no plan rather than a missed one.
+     */
+    baseline_status: 'measured' | 'no_baseline';
+    /**
+     * List represents a paginated list of resources.
+     */
+    buckets: ListAttainmentBucket | null;
+    /**
+     * End of the measured period.
+     */
+    ends_at: string;
+    /**
+     * List represents a paginated list of resources.
+     */
+    frozen_adherence: ListFrozenAdherence | null;
+    /**
+     * The dimension the breakdown is grouped by.
+     */
+    group_by: 'week' | 'machine' | 'department' | 'item';
+    /**
+     * Resource type identifier.
+     */
+    object: 'analyze_schedule_attainment_response';
+    /**
+     * Start of the measured period.
+     */
+    starts_at: string;
+    /**
+     * One row of a schedule-attainment breakdown.
+     *
+     * Both ratios are reported because either alone misleads. `attainment_pct` caps
+     * each SKU at what was asked for, so over-building one easy item cannot paper over
+     * a total miss on another; `output_ratio_pct` does not cap, so it is the only one
+     * that reveals over-production.
+     */
+    totals: AttainmentBucket;
+}
+/**
+ * One row of a schedule-attainment breakdown.
+ *
+ * Both ratios are reported because either alone misleads. `attainment_pct` caps
+ * each SKU at what was asked for, so over-building one easy item cannot paper over
+ * a total miss on another; `output_ratio_pct` does not cap, so it is the only one
+ * that reveals over-production.
+ */
+export interface AttainmentBucket {
+    /**
+     * Units actually produced.
+     */
+    actual_quantity: number;
+    /**
+     * Share of the plan that was met. Null when nothing was planned.
+     */
+    attainment_pct: number | null;
+    /**
+     * Batches scanned in this bucket.
+     */
+    batch_count: number;
+    /**
+     * Identifies the bucket within the chosen grouping — a week start, machine ID,
+     * department ID or item ID.
+     */
+    key: string;
+    /**
+     * Display label for the bucket.
+     */
+    label: string;
+    /**
+     * Units produced that were planned for, capped per campaign at what was asked.
+     */
+    matched_quantity: number;
+    /**
+     * Output as a share of plan, uncapped. Null when nothing was planned.
+     */
+    output_ratio_pct: number | null;
+    /**
+     * Planned campaigns in this bucket.
+     */
+    planned_lines: number;
+    /**
+     * Units the live plan called for.
+     */
+    planned_quantity: number;
+    /**
+     * Machine hours the plan called for.
+     */
+    planned_run_hours: number;
+    /**
+     * Units produced with no matching planned campaign.
+     */
+    unplanned_quantity: number;
+    /**
+     * Units scrapped.
+     */
+    waste_quantity: number;
+    /**
+     * First day of the week, when grouping by week.
+     */
+    week_starts_at: string | null;
+}
+/**
+ * How well a published commitment survived the week it covered.
+ */
+export interface FrozenAdherence {
+    /**
+     * Total absolute unit change across frozen-week deviations.
+     */
+    abs_delta_units: number;
+    /**
+     * Campaigns added into the frozen window after publish.
+     */
+    added_lines: number;
+    /**
+     * Frozen campaigns that were changed after publish.
+     */
+    deviated_lines: number;
+    /**
+     * Campaigns frozen at publish.
+     */
+    frozen_line_count: number;
+    /**
+     * Units frozen at publish.
+     */
+    frozen_planned_quantity: number;
+    /**
+     * Last day of the frozen window.
+     */
+    frozen_through_at: string | null;
+    /**
+     * Share of frozen campaigns that survived untouched. Null when nothing was frozen.
+     */
+    line_adherence_pct: number | null;
+    /**
+     * Entity is a polymorphic reference to any resource in the system.
+     */
+    schedule: CoreAPI.Entity | null;
+    /**
+     * Share of frozen units that survived untouched. Null when nothing was frozen.
+     */
+    units_adherence_pct: number | null;
+    /**
+     * Version number of that schedule.
+     */
+    version: number;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAttainmentBucket {
+    /**
+     * Resources in this page.
+     */
+    data: Array<AttainmentBucket>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListFrozenAdherence {
+    /**
+     * Resources in this page.
+     */
+    data: Array<FrozenAdherence>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListOeeDepartment {
+    /**
+     * Resources in this page.
+     */
+    data: Array<OeeDepartment>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListOeeDowntimeReason {
+    /**
+     * Resources in this page.
+     */
+    data: Array<OeeDowntimeReason>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * OeeDepartment represents OEE metrics for a single department.
+ */
+export interface OeeDepartment {
+    /**
+     * Data-quality warnings for this grouping. Empty when the numbers can be taken at
+     * face value.
+     */
+    anomalies: Array<'performance_above_capacity'>;
+    /**
+     * Logged downtime charged against availability, in seconds.
+     */
+    availability_loss_seconds: number;
+    /**
+     * Run time divided by scheduled time.
+     */
+    availability_pct: number | null;
+    /**
+     * Time spent changing over between products, in seconds.
+     */
+    changeover_seconds: number;
+    /**
+     * Entity is a polymorphic reference to any resource in the system.
+     */
+    department: CoreAPI.Entity | null;
+    /**
+     * List represents a paginated list of resources.
+     */
+    downtime_breakdown: ListOeeDowntimeReason | null;
+    /**
+     * Number of downtime events logged in the period.
+     */
+    downtime_event_count: number;
+    /**
+     * The estimated runtime in hours.
+     */
+    estimated_runtime_hours: number;
+    /**
+     * The number of good units produced.
+     */
+    good_units: number;
+    /**
+     * The ideal time of the batch tickets in the performance sample, in seconds: what
+     * their output should have taken at each production step's ideal cycle time.
+     */
+    measured_ideal_seconds: number;
+    /**
+     * The actual time the sampled tickets took, in seconds, measured from the gaps
+     * between consecutive batch-ticket scans per machine, net of downtime already
+     * charged elsewhere.
+     */
+    measured_run_seconds: number;
+    /**
+     * 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.
+     */
+    measurement_status: 'measured' | 'estimated';
+    /**
+     * Time nobody planned to run, removed from the OEE denominator rather than counted
+     * as a loss.
+     */
+    not_scheduled_seconds: number;
+    /**
+     * Availability multiplied by performance multiplied by quality.
+     */
+    oee_pct: number | null;
+    /**
+     * How performance_pct was obtained: measured from scan intervals, or fallen back
+     * to the shift-pattern run-time estimate. Null when performance_pct is null.
+     */
+    performance_basis: 'scan_intervals' | 'run_time_estimate' | null;
+    /**
+     * Logged downtime charged against performance, in seconds.
+     */
+    performance_loss_seconds: number;
+    /**
+     * Ideal time over actual time for the sampled batch tickets (measured), or
+     * standard seconds earned divided by run time (estimated fallback).
+     */
+    performance_pct: number | null;
+    /**
+     * The number of batch tickets in the performance sample.
+     */
+    performance_ticket_count: number;
+    /**
+     * Logged downtime charged against quality, in seconds.
+     */
+    quality_loss_seconds: number;
+    /**
+     * Good units divided by total units produced.
+     */
+    quality_pct: number | null;
+    /**
+     * Scheduled time net of availability losses, in seconds.
+     */
+    run_time_seconds: number;
+    /**
+     * Planned time net of not-scheduled downtime, in seconds.
+     */
+    scheduled_seconds: number;
+    /**
+     * The number of seconds units.
+     */
+    seconds_units: number;
+    /**
+     * The time this output should have taken at each production step's own labor rate.
+     * This is the numerator of Performance.
+     */
+    standard_seconds_earned: number;
+    /**
+     * The number of waste units.
+     */
+    waste_units: number;
+}
+/**
+ * OeeDepartmentPlannedTime supplies the scheduled production time for one
+ * department.
+ */
+export interface OeeDepartmentPlannedTime {
+    /**
+     * The department ID.
+     */
+    department_id: string;
+    /**
+     * Scheduled production hours for the period.
+     */
+    planned_hours: number;
+}
+/**
+ * OeeDowntimeReason represents one reason's contribution to a department's
+ * downtime.
+ */
+export interface OeeDowntimeReason {
+    /**
+     * Downtime attributed to this reason, in seconds.
+     */
+    downtime_seconds: number;
+    /**
+     * Number of events logged against this reason.
+     */
+    event_count: number;
+    /**
+     * Which OEE term this reason charges.
+     */
+    oee_bucket: 'availability' | 'performance' | 'quality' | 'not_scheduled';
+    /**
+     * Why the machine stopped.
+     */
+    reason: 'breakdown' | 'changeover' | 'material_shortage' | 'no_operator' | 'planned_maintenance' | 'minor_stop' | 'quality_hold' | 'no_schedule';
+}
+export interface AnalyticsUpdateOeeParams {
+    /**
+     * The end date for the analysis period.
+     */
+    end_date: string;
+    /**
+     * The start date for the analysis period.
+     */
+    start_date: string;
+    /**
+     * Optional department IDs to filter by.
+     */
+    department_ids?: Array<string>;
+    /**
+     * Scheduled production time per department for the period. Availability,
+     * performance and OEE are only returned for departments this covers.
+     */
+    planned_time?: Array<OeeDepartmentPlannedTime>;
+}
+export interface AnalyticsUpdateScheduleAttainmentParams {
+    /**
+     * The end date for the analysis period.
+     */
+    end_date: string;
+    /**
+     * The start date for the analysis period.
+     */
+    start_date: string;
+    /**
+     * Only measure production in these departments.
+     */
+    department_ids?: Array<string>;
+    /**
+     * The dimension to break the results down by. Defaults to `week`.
+     */
+    group_by?: 'week' | 'machine' | 'department' | 'item';
+    /**
+     * Only measure production on these machines.
+     */
+    machine_ids?: Array<string>;
+}
+export declare namespace Analytics {
+    export { type AnalyzeOeeRequest as AnalyzeOeeRequest, type AnalyzeOeeResponse as AnalyzeOeeResponse, type AnalyzeScheduleAttainmentRequest as AnalyzeScheduleAttainmentRequest, type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse, type AttainmentBucket as AttainmentBucket, type FrozenAdherence as FrozenAdherence, type ListAttainmentBucket as ListAttainmentBucket, type ListFrozenAdherence as ListFrozenAdherence, type ListOeeDepartment as ListOeeDepartment, type ListOeeDowntimeReason as ListOeeDowntimeReason, type OeeDepartment as OeeDepartment, type OeeDepartmentPlannedTime as OeeDepartmentPlannedTime, type OeeDowntimeReason as OeeDowntimeReason, type AnalyticsUpdateOeeParams as AnalyticsUpdateOeeParams, type AnalyticsUpdateScheduleAttainmentParams as AnalyticsUpdateScheduleAttainmentParams, };
+}
+//# sourceMappingURL=analytics.d.ts.map

package/resources/core/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAAI,EAAE,uCAAuC,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,eAAe,EAAE,UAAU,GAAG,aAAa,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,sCAAsC,CAAC;IAE/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE/C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,EAAE,UAAU,GAAG,WAAW,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,iBAAiB,EAAE,gBAAgB,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAEjE;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,eAAe,CAAC;IAEzE;;OAEG;IACH,MAAM,EACF,WAAW,GACX,YAAY,GACZ,mBAAmB,GACnB,aAAa,GACb,qBAAqB,GACrB,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}

package/resources/core/analytics.js

@@ -0,0 +1,67 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+const resource_1 = require("../../core/resource.js");
+/**
+ * Analyze sales, orders, manufacturing, materials, and other business metrics.
+ */
+class Analytics extends resource_1.APIResource {
+    /**
+     * Returns Overall Equipment Effectiveness (OEE) metrics by department.
+     *
+     * Availability is measured from logged machine downtime rather than inferred, so
+     * it requires both `planned_time` for the department and downtime events in the
+     * period. Departments with `has_downtime_data` false have no availability
+     * measurement, and their ratios are returned as null rather than as 100%.
+     *
+     * This endpoint requires the permission: `machine_downtime:read`.
+     *
+     * @example
+     * ```ts
+     * const analyzeOeeResponse =
+     *   await client.core.analytics.updateOee({
+     *     end_date: '2026-05-10T00:23:00Z',
+     *     start_date: '2026-05-10T00:00:00Z',
+     *     department_ids: ['dp_01791c25ab59da4704cba61874'],
+     *   });
+     * ```
+     */
+    updateOee(body, options) {
+        return this._client.put('/v1/core/analytics/oee', { body, ...options });
+    }
+    /**
+     * Returns actual production measured against the plan that was live at the time.
+     *
+     * The baseline for each week is the schedule version published on or before that
+     * week began, so republishing mid-horizon cannot rewrite a week the floor has
+     * already worked. `baseline_schedules` names the versions used.
+     *
+     * Two ratios are returned because either alone misleads: `attainment_pct` caps
+     * each campaign at what was asked for, so over-building one SKU cannot hide a miss
+     * on another, while `output_ratio_pct` is uncapped and is what reveals
+     * over-production. Production with no matching planned campaign is reported as
+     * `unplanned_quantity` rather than discarded — that number is the clearest signal
+     * a schedule is being worked around.
+     *
+     * Every ratio is null rather than zero when nothing was planned, and
+     * `has_baseline` is false when nothing was ever published over the period.
+     *
+     * This endpoint requires the permission: `production_schedules:read`.
+     *
+     * @example
+     * ```ts
+     * const analyzeScheduleAttainmentResponse =
+     *   await client.core.analytics.updateScheduleAttainment({
+     *     end_date: '2026-05-10T00:23:00Z',
+     *     start_date: '2026-05-10T00:00:00Z',
+     *     group_by: 'week',
+     *   });
+     * ```
+     */
+    updateScheduleAttainment(body, options) {
+        return this._client.put('/v1/core/analytics/schedule-attainment', { body, ...options });
+    }
+}
+exports.Analytics = Analytics;
+//# sourceMappingURL=analytics.js.map

package/resources/core/analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAA8B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA5DD,8BA4DC"}

package/resources/core/analytics.mjs

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+/**
+ * Analyze sales, orders, manufacturing, materials, and other business metrics.
+ */
+export class Analytics extends APIResource {
+    /**
+     * Returns Overall Equipment Effectiveness (OEE) metrics by department.
+     *
+     * Availability is measured from logged machine downtime rather than inferred, so
+     * it requires both `planned_time` for the department and downtime events in the
+     * period. Departments with `has_downtime_data` false have no availability
+     * measurement, and their ratios are returned as null rather than as 100%.
+     *
+     * This endpoint requires the permission: `machine_downtime:read`.
+     *
+     * @example
+     * ```ts
+     * const analyzeOeeResponse =
+     *   await client.core.analytics.updateOee({
+     *     end_date: '2026-05-10T00:23:00Z',
+     *     start_date: '2026-05-10T00:00:00Z',
+     *     department_ids: ['dp_01791c25ab59da4704cba61874'],
+     *   });
+     * ```
+     */
+    updateOee(body, options) {
+        return this._client.put('/v1/core/analytics/oee', { body, ...options });
+    }
+    /**
+     * Returns actual production measured against the plan that was live at the time.
+     *
+     * The baseline for each week is the schedule version published on or before that
+     * week began, so republishing mid-horizon cannot rewrite a week the floor has
+     * already worked. `baseline_schedules` names the versions used.
+     *
+     * Two ratios are returned because either alone misleads: `attainment_pct` caps
+     * each campaign at what was asked for, so over-building one SKU cannot hide a miss
+     * on another, while `output_ratio_pct` is uncapped and is what reveals
+     * over-production. Production with no matching planned campaign is reported as
+     * `unplanned_quantity` rather than discarded — that number is the clearest signal
+     * a schedule is being worked around.
+     *
+     * Every ratio is null rather than zero when nothing was planned, and
+     * `has_baseline` is false when nothing was ever published over the period.
+     *
+     * This endpoint requires the permission: `production_schedules:read`.
+     *
+     * @example
+     * ```ts
+     * const analyzeScheduleAttainmentResponse =
+     *   await client.core.analytics.updateScheduleAttainment({
+     *     end_date: '2026-05-10T00:23:00Z',
+     *     start_date: '2026-05-10T00:00:00Z',
+     *     group_by: 'week',
+     *   });
+     * ```
+     */
+    updateScheduleAttainment(body, options) {
+        return this._client.put('/v1/core/analytics/schedule-attainment', { body, ...options });
+    }
+}
+//# sourceMappingURL=analytics.mjs.map

package/resources/core/analytics.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.mjs","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAA8B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}