@augno/sdk 0.18.0 → 0.18.2

package/src/resources/operations/operating-calendars/operating-calendars.ts

@@ -0,0 +1,427 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ClosuresAPI from './closures';
+import {
+  ClosureCreateParams,
+  ClosureDeleteParams,
+  ClosureDeleteResponse,
+  ClosureListParams,
+  Closures,
+  CreateOperatingCalendarClosureRequest,
+  ListOperatingCalendarClosure,
+  OperatingCalendarClosure,
+} from './closures';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * The days a plant tenders freight and a customer's dock accepts it, less the holidays and shutdowns either side is closed for. Every ship-by date is resolved against them, so an order is never committed to a day nobody can act on.
+ */
+export class OperatingCalendars extends APIResource {
+  closures: ClosuresAPI.Closures = new ClosuresAPI.Closures(this._client);
+
+  /**
+   * Lists the operating calendars configured for the account.
+   *
+   * Both kinds are returned unless `kind` narrows it, ordered with each kind's
+   * default first.
+   *
+   * This endpoint requires the permission: `production_schedules:read`.
+   *
+   * @example
+   * ```ts
+   * const listOperatingCalendar =
+   *   await client.operations.operatingCalendars.list();
+   * ```
+   */
+  list(
+    query: OperatingCalendarListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListOperatingCalendar> {
+    return this._client.get('/v1/operations/operating-calendars', { query, ...options });
+  }
+
+  /**
+   * Retrieves one operating calendar by ID.
+   *
+   * This endpoint requires the permission: `production_schedules:read`.
+   *
+   * @example
+   * ```ts
+   * const operatingCalendar =
+   *   await client.operations.operatingCalendars.retrieve(
+   *     'occd_7f2m9qk4wzxb',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<OperatingCalendar> {
+    return this._client.get(path`/v1/operations/operating-calendars/${id}`, options);
+  }
+
+  /**
+   * Creates an operating calendar.
+   *
+   * The days govern every ship-by date resolved against this calendar: a plant that
+   * tenders freight Monday to Thursday never gets committed to a Friday shipment,
+   * and a customer's promised delivery date is worked back from a day they can
+   * actually receive on.
+   *
+   * A calendar starts with no closures. Add holidays and shutdowns to it separately.
+   *
+   * This endpoint requires the permission: `production_schedules:create`.
+   *
+   * @example
+   * ```ts
+   * const operatingCalendar =
+   *   await client.operations.operatingCalendars.create({
+   *     code: 'default_ship',
+   *     days_of_week: '1111000',
+   *     kind: 'ship',
+   *     name: 'Shipping days',
+   *     cutoff_at: '15:00',
+   *     is_default: true,
+   *     timezone: 'America/Chicago',
+   *   });
+   * ```
+   */
+  create(body: OperatingCalendarCreateParams, options?: RequestOptions): APIPromise<OperatingCalendar> {
+    return this._client.post('/v1/operations/operating-calendars', { body, ...options });
+  }
+
+  /**
+   * Updates an operating calendar.
+   *
+   * A calendar's kind cannot change: a shipping calendar that became a receiving one
+   * would silently drop the pickup cutoff every commitment resolved against it
+   * depends on. Create a second calendar instead.
+   *
+   * Changes apply to commitments made from now on. Orders already issued keep the
+   * dates they were stamped with, so adding a holiday never retroactively makes a
+   * past order late.
+   *
+   * This endpoint requires the permission: `production_schedules:update`.
+   *
+   * @example
+   * ```ts
+   * const operatingCalendar =
+   *   await client.operations.operatingCalendars.update(
+   *     'occd_7f2m9qk4wzxb',
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    body: OperatingCalendarUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<OperatingCalendar> {
+    return this._client.patch(path`/v1/operations/operating-calendars/${id}`, { body, ...options });
+  }
+
+  /**
+   * Deletes an operating calendar.
+   *
+   * Refused while any address, customer, customer group, or account setting still
+   * points at it. Deleting a calendar out from under its references would quietly
+   * return every affected order to a plain Monday-to-Friday week, which reads as the
+   * feature breaking rather than as a decision anybody made — so re-point them
+   * first.
+   *
+   * This endpoint requires the permission: `production_schedules:delete`.
+   *
+   * @example
+   * ```ts
+   * const operatingCalendar =
+   *   await client.operations.operatingCalendars.delete(
+   *     'occd_7f2m9qk4wzxb',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<OperatingCalendarDeleteResponse> {
+    return this._client.delete(path`/v1/operations/operating-calendars/${id}`, options);
+  }
+}
+
+/**
+ * Request to create an operating calendar.
+ */
+export interface CreateOperatingCalendarRequest {
+  /**
+   * Short stable identifier, unique per account.
+   */
+  code: string;
+
+  /**
+   * Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is
+   * Monday to Friday; "1111000" is a Monday-to-Thursday plant. At least one day must
+   * be open.
+   */
+  days_of_week: string;
+
+  /**
+   * Which side of a shipment this calendar describes.
+   */
+  kind: 'ship' | 'receive';
+
+  /**
+   * Human-readable name.
+   */
+  name: string;
+
+  /**
+   * Local time freight has to be tendered by, as "15:00". Only a shipping calendar
+   * accepts one.
+   */
+  cutoff_at?: string;
+
+  /**
+   * Make this the calendar used when nothing more specific is linked. Setting it
+   * demotes whichever calendar of the same kind held the role.
+   */
+  is_default?: boolean;
+
+  /**
+   * IANA zone the cutoff is read in, such as "America/Chicago". On a receiving
+   * calendar, leave it unset to take the zone from the ship-to address.
+   */
+  timezone?: string;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListOperatingCalendar {
+  /**
+   * Resources in this page.
+   */
+  data: Array<OperatingCalendar>;
+
+  /**
+   * 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;
+}
+
+/**
+ * OperatingCalendar is the set of days one party to a shipment operates.
+ *
+ * A `ship` calendar is the plant tendering freight to a carrier; a `receive`
+ * calendar is a customer's dock accepting it. Ship-by dates are resolved against
+ * both, so an order is never committed to a day nobody can act on.
+ */
+export interface OperatingCalendar {
+  /**
+   * Unique identifier.
+   */
+  id: string;
+
+  /**
+   * Short stable identifier, unique per account.
+   */
+  code: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Local time freight has to be tendered by, as "15:00". Only a shipping calendar
+   * carries one.
+   */
+  cutoff_at: string | null;
+
+  /**
+   * Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is
+   * Monday to Friday; "1111000" is a Monday-to-Thursday plant.
+   */
+  days_of_week: string;
+
+  /**
+   * Whether this is the calendar used when nothing more specific is linked. Exactly
+   * one per kind.
+   */
+  is_default: boolean;
+
+  /**
+   * Which side of a shipment this calendar describes.
+   */
+  kind: 'ship' | 'receive';
+
+  /**
+   * Human-readable name.
+   */
+  name: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'operating_calendar';
+
+  /**
+   * IANA zone the cutoff is read in. Null on a receiving calendar means it is taken
+   * from the ship-to address.
+   */
+  timezone: string | null;
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to update an operating calendar.
+ */
+export interface UpdateOperatingCalendarRequest {
+  /**
+   * Local time freight has to be tendered by. Clearing it leaves the ship-by date a
+   * day with no time of day attached.
+   */
+  cutoff_at?: string | null;
+
+  /**
+   * Open weekdays as seven characters of '0' or '1', Monday first. At least one day
+   * must be open.
+   */
+  days_of_week?: string;
+
+  /**
+   * Make this the calendar used when nothing more specific is linked. Setting it
+   * demotes whichever calendar of the same kind held the role.
+   */
+  is_default?: boolean;
+
+  /**
+   * Human-readable name.
+   */
+  name?: string;
+
+  /**
+   * IANA zone the cutoff is read in. Clearing it on a receiving calendar returns to
+   * taking the zone from the ship-to address.
+   */
+  timezone?: string | null;
+}
+
+export interface OperatingCalendarDeleteResponse {}
+
+export interface OperatingCalendarListParams {
+  /**
+   * Return only shipping or only receiving calendars.
+   */
+  kind?: 'ship' | 'receive';
+}
+
+export interface OperatingCalendarCreateParams {
+  /**
+   * Short stable identifier, unique per account.
+   */
+  code: string;
+
+  /**
+   * Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is
+   * Monday to Friday; "1111000" is a Monday-to-Thursday plant. At least one day must
+   * be open.
+   */
+  days_of_week: string;
+
+  /**
+   * Which side of a shipment this calendar describes.
+   */
+  kind: 'ship' | 'receive';
+
+  /**
+   * Human-readable name.
+   */
+  name: string;
+
+  /**
+   * Local time freight has to be tendered by, as "15:00". Only a shipping calendar
+   * accepts one.
+   */
+  cutoff_at?: string;
+
+  /**
+   * Make this the calendar used when nothing more specific is linked. Setting it
+   * demotes whichever calendar of the same kind held the role.
+   */
+  is_default?: boolean;
+
+  /**
+   * IANA zone the cutoff is read in, such as "America/Chicago". On a receiving
+   * calendar, leave it unset to take the zone from the ship-to address.
+   */
+  timezone?: string;
+}
+
+export interface OperatingCalendarUpdateParams {
+  /**
+   * Local time freight has to be tendered by. Clearing it leaves the ship-by date a
+   * day with no time of day attached.
+   */
+  cutoff_at?: string | null;
+
+  /**
+   * Open weekdays as seven characters of '0' or '1', Monday first. At least one day
+   * must be open.
+   */
+  days_of_week?: string;
+
+  /**
+   * Make this the calendar used when nothing more specific is linked. Setting it
+   * demotes whichever calendar of the same kind held the role.
+   */
+  is_default?: boolean;
+
+  /**
+   * Human-readable name.
+   */
+  name?: string;
+
+  /**
+   * IANA zone the cutoff is read in. Clearing it on a receiving calendar returns to
+   * taking the zone from the ship-to address.
+   */
+  timezone?: string | null;
+}
+
+OperatingCalendars.Closures = Closures;
+
+export declare namespace OperatingCalendars {
+  export {
+    type CreateOperatingCalendarRequest as CreateOperatingCalendarRequest,
+    type ListOperatingCalendar as ListOperatingCalendar,
+    type OperatingCalendar as OperatingCalendar,
+    type UpdateOperatingCalendarRequest as UpdateOperatingCalendarRequest,
+    type OperatingCalendarDeleteResponse as OperatingCalendarDeleteResponse,
+    type OperatingCalendarListParams as OperatingCalendarListParams,
+    type OperatingCalendarCreateParams as OperatingCalendarCreateParams,
+    type OperatingCalendarUpdateParams as OperatingCalendarUpdateParams,
+  };
+
+  export {
+    Closures as Closures,
+    type CreateOperatingCalendarClosureRequest as CreateOperatingCalendarClosureRequest,
+    type ListOperatingCalendarClosure as ListOperatingCalendarClosure,
+    type OperatingCalendarClosure as OperatingCalendarClosure,
+    type ClosureDeleteResponse as ClosureDeleteResponse,
+    type ClosureListParams as ClosureListParams,
+    type ClosureCreateParams as ClosureCreateParams,
+    type ClosureDeleteParams as ClosureDeleteParams,
+  };
+}

package/src/resources/operations/operating-calendars.ts

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

package/src/resources/operations/operations.ts

@@ -107,6 +107,18 @@ import {
   Locations,
   UpdateLocationRequest,
 } from './locations/locations';
+import * as OperatingCalendarsAPI from './operating-calendars/operating-calendars';
+import {
+  CreateOperatingCalendarRequest,
+  ListOperatingCalendar,
+  OperatingCalendar,
+  OperatingCalendarCreateParams,
+  OperatingCalendarDeleteResponse,
+  OperatingCalendarListParams,
+  OperatingCalendarUpdateParams,
+  OperatingCalendars,
+  UpdateOperatingCalendarRequest,
+} from './operating-calendars/operating-calendars';
 import * as ProductionScheduleSettingsAPI from './production-schedule-settings/production-schedule-settings';
 import {
   ProductionScheduleSettingUpdateParams,
@@ -120,6 +132,7 @@ import {
   ListProductionScheduleDerivedLine,
   ListProductionScheduleDeviation,
   ListProductionScheduleFinishedPolicy,
+  ListProductionScheduleFinishingLine,
   ListProductionScheduleItemPolicy,
   ListReleaseScheduleBatch,
   ListReleasedScheduleLine,
@@ -133,10 +146,12 @@ import {
   ProductionScheduleDerivedLine,
   ProductionScheduleDeviation,
   ProductionScheduleFinishedPolicy,
+  ProductionScheduleFinishingLine,
   ProductionScheduleItemPolicy,
   ProductionScheduleListParams,
   ProductionScheduleRetrieveDerivedLinesParams,
   ProductionScheduleRetrieveDeviationsParams,
+  ProductionScheduleRetrieveFinishingLinesParams,
   ProductionScheduleRetrieveWeekReleasePreviewParams,
   ProductionSchedules,
   ReleaseScheduleBatch,
@@ -145,6 +160,7 @@ import {
   ScheduleAppliedOverride,
   ScheduleAtRiskOrder,
   ScheduleDiagnostics,
+  ScheduleFinishingDiagnostics,
   ScheduleOrderCoverage,
   ScheduleOrderCoverageLine,
 } from './production-schedules/production-schedules';
@@ -167,6 +183,9 @@ export class Operations extends APIResource {
     new ProductionScheduleSettingsAPI.ProductionScheduleSettings(this._client);
   fulfillmentRecommendations: FulfillmentRecommendationsAPI.FulfillmentRecommendations =
     new FulfillmentRecommendationsAPI.FulfillmentRecommendations(this._client);
+  operatingCalendars: OperatingCalendarsAPI.OperatingCalendars = new OperatingCalendarsAPI.OperatingCalendars(
+    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);
@@ -771,6 +790,7 @@ Operations.MachineDowntimeEvents = MachineDowntimeEvents;
 Operations.DemandOverrides = DemandOverrides;
 Operations.ProductionSchedules = ProductionSchedules;
 Operations.FulfillmentRecommendations = FulfillmentRecommendations;
+Operations.OperatingCalendars = OperatingCalendars;
 Operations.Locations = Locations;
 Operations.LocationTypes = LocationTypes;
 Operations.Shipments = Shipments;
@@ -873,6 +893,7 @@ export declare namespace Operations {
     type ListProductionScheduleDerivedLine as ListProductionScheduleDerivedLine,
     type ListProductionScheduleDeviation as ListProductionScheduleDeviation,
     type ListProductionScheduleFinishedPolicy as ListProductionScheduleFinishedPolicy,
+    type ListProductionScheduleFinishingLine as ListProductionScheduleFinishingLine,
     type ListProductionScheduleItemPolicy as ListProductionScheduleItemPolicy,
     type ListReleaseScheduleBatch as ListReleaseScheduleBatch,
     type ListReleasedScheduleLine as ListReleasedScheduleLine,
@@ -884,6 +905,7 @@ export declare namespace Operations {
     type ProductionScheduleDerivedLine as ProductionScheduleDerivedLine,
     type ProductionScheduleDeviation as ProductionScheduleDeviation,
     type ProductionScheduleFinishedPolicy as ProductionScheduleFinishedPolicy,
+    type ProductionScheduleFinishingLine as ProductionScheduleFinishingLine,
     type ProductionScheduleItemPolicy as ProductionScheduleItemPolicy,
     type ReleaseScheduleBatch as ReleaseScheduleBatch,
     type ReleaseScheduleWeekPreview as ReleaseScheduleWeekPreview,
@@ -891,11 +913,13 @@ export declare namespace Operations {
     type ScheduleAppliedOverride as ScheduleAppliedOverride,
     type ScheduleAtRiskOrder as ScheduleAtRiskOrder,
     type ScheduleDiagnostics as ScheduleDiagnostics,
+    type ScheduleFinishingDiagnostics as ScheduleFinishingDiagnostics,
     type ScheduleOrderCoverage as ScheduleOrderCoverage,
     type ScheduleOrderCoverageLine as ScheduleOrderCoverageLine,
     type ProductionScheduleDeleteResponse as ProductionScheduleDeleteResponse,
     type ProductionScheduleListParams as ProductionScheduleListParams,
     type ProductionScheduleCreateParams as ProductionScheduleCreateParams,
+    type ProductionScheduleRetrieveFinishingLinesParams as ProductionScheduleRetrieveFinishingLinesParams,
     type ProductionScheduleRetrieveDerivedLinesParams as ProductionScheduleRetrieveDerivedLinesParams,
     type ProductionScheduleRetrieveDeviationsParams as ProductionScheduleRetrieveDeviationsParams,
     type ProductionScheduleRetrieveWeekReleasePreviewParams as ProductionScheduleRetrieveWeekReleasePreviewParams,
@@ -913,6 +937,18 @@ export declare namespace Operations {
     type ListFulfillmentRecommendation as ListFulfillmentRecommendation,
   };
 
+  export {
+    OperatingCalendars as OperatingCalendars,
+    type CreateOperatingCalendarRequest as CreateOperatingCalendarRequest,
+    type ListOperatingCalendar as ListOperatingCalendar,
+    type OperatingCalendar as OperatingCalendar,
+    type UpdateOperatingCalendarRequest as UpdateOperatingCalendarRequest,
+    type OperatingCalendarDeleteResponse as OperatingCalendarDeleteResponse,
+    type OperatingCalendarListParams as OperatingCalendarListParams,
+    type OperatingCalendarCreateParams as OperatingCalendarCreateParams,
+    type OperatingCalendarUpdateParams as OperatingCalendarUpdateParams,
+  };
+
   export {
     Locations as Locations,
     type CreateLocationRequest as CreateLocationRequest,

package/src/resources/operations/production-schedule-settings/production-schedule-settings.ts

@@ -206,8 +206,9 @@ export interface ProductionScheduleSettings {
   /**
    * Calendar days between an order being issued and it being due to ship.
    *
-   * The last resort in the ship-by chain: a lead time set on the customer, or on the
-   * customer's account group, takes precedence. Zero means same-day shipping.
+   * The last resort in the ship-by chain: a lead time set on the customer, on its
+   * parent account, or on the customer's account group takes precedence. Zero means
+   * same-day shipping.
    */
   default_customer_lead_time_days: number;
 
@@ -353,6 +354,8 @@ export interface ProductionScheduleSettings {
    */
   planning_horizon_weeks: number;
 
+  receive_calendar_id: string | null;
+
   /**
    * Z-score behind the safety stock targets.
    *
@@ -372,6 +375,16 @@ export interface ProductionScheduleSettings {
    */
   shifts_per_day: number;
 
+  /**
+   * The account-wide operating calendars: the days the plant tenders freight, and
+   * the days a customer's dock accepts it.
+   *
+   * Behind the per-address and per-customer links and ahead of a plain
+   * Monday-to-Friday week. Null on both means every ship-by date is resolved against
+   * weekdays alone.
+   */
+  ship_calendar_id: string | null;
+
   /**
    * Last updated timestamp.
    */
@@ -469,11 +482,11 @@ export interface UpdateProductionScheduleSettingsRequest {
   /**
    * Calendar days between an order being issued and it being due to ship.
    *
-   * The last resort in the ship-by chain: a lead time set on the customer, or on the
-   * customer's account group, takes precedence. Zero commits the account to same-day
-   * shipping on every order that falls through to it, so this update replaces the
-   * whole settings object and omitting the field is not the same as leaving it
-   * alone.
+   * The last resort in the ship-by chain: a lead time set on the customer, on its
+   * parent account, or on the customer's account group takes precedence. Zero
+   * commits the account to same-day shipping on every order that falls through to
+   * it, so this update replaces the whole settings object and omitting the field is
+   * not the same as leaving it alone.
    */
   default_customer_lead_time_days: number;
 
@@ -642,6 +655,18 @@ export interface UpdateProductionScheduleSettingsRequest {
    * active, otherwise the whole update is rejected.
    */
   generation_cron?: string | null;
+
+  receive_calendar_id?: string | null;
+
+  /**
+   * The operating calendar naming the days this account's plant tenders freight, and
+   * the one naming the days a customer's dock accepts it.
+   *
+   * These are the account-wide fallbacks: an address or a customer with its own
+   * calendar overrides them, and an account with neither set falls back to a
+   * Monday-to-Friday week with no closures.
+   */
+  ship_calendar_id?: string | null;
 }
 
 export interface ProductionScheduleSettingUpdateParams {
@@ -717,11 +742,11 @@ export interface ProductionScheduleSettingUpdateParams {
   /**
    * Calendar days between an order being issued and it being due to ship.
    *
-   * The last resort in the ship-by chain: a lead time set on the customer, or on the
-   * customer's account group, takes precedence. Zero commits the account to same-day
-   * shipping on every order that falls through to it, so this update replaces the
-   * whole settings object and omitting the field is not the same as leaving it
-   * alone.
+   * The last resort in the ship-by chain: a lead time set on the customer, on its
+   * parent account, or on the customer's account group takes precedence. Zero
+   * commits the account to same-day shipping on every order that falls through to
+   * it, so this update replaces the whole settings object and omitting the field is
+   * not the same as leaving it alone.
    */
   default_customer_lead_time_days: number;
 
@@ -890,6 +915,18 @@ export interface ProductionScheduleSettingUpdateParams {
    * active, otherwise the whole update is rejected.
    */
   generation_cron?: string | null;
+
+  receive_calendar_id?: string | null;
+
+  /**
+   * The operating calendar naming the days this account's plant tenders freight, and
+   * the one naming the days a customer's dock accepts it.
+   *
+   * These are the account-wide fallbacks: an address or a customer with its own
+   * calendar overrides them, and an account with neither set falls back to a
+   * Monday-to-Friday week with no closures.
+   */
+  ship_calendar_id?: string | null;
 }
 
 ProductionScheduleSettings.Resources = Resources;