@secondcloset/types 2.8.0-beta.1-yyc-atl → 2.8.0-beta.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondcloset/types",
-  "version": "2.8.0-beta.1-yyc-atl",
+  "version": "2.8.0-beta.11",
   "description": "secondcloset type declaration and definitions",
   "main": "src/index.ts",
   "scripts": {

package/src/_common/organization.ts

@@ -9,13 +9,23 @@ export type OrganizationConfigKey =
   | "auto_fulfill_orders"
   | "freightcom_api_username"
   | "freightcom_api_password"
-  | "preferred_return_facility";
+  | "preferred_return_facility"
+  | "disable_partial_fulfillment";
 
 export interface OrganizationConfig {
   key: OrganizationConfigKey;
   value: string;
 }
 
+export type OrganizationShippingConfigKey =
+  | "whitelist_carrier"
+  | "blacklist_carrier";
+
+export interface OrganizationShippingConfig {
+  key: OrganizationShippingConfigKey;
+  value: string[];
+}
+
 export interface Permission {
   id: string;
   name: string;
@@ -69,6 +79,7 @@ export interface Organization extends BaseOrganization {
     sc_service_tier?: SCServiceTier;
   };
   configurations_attributes: OrganizationConfig[];
+  shipping_configurations_attributes?: OrganizationShippingConfig[];
   permissions: Permission[];
   geofilter_constraints?: GeofilterConstraint[];
   facility_service_areas?: FacilityServiceArea[];

package/src/fulfillment/appointment/appointment.ts

@@ -26,6 +26,7 @@ export interface Appointment {
   estimated_time: number;
   facility?: {
     name: string;
+    street: string;
   };
   failed_notes: string | null;
   failed_reason: string | null;

package/src/fulfillment/order/order.ts

@@ -6,6 +6,7 @@ import {
   BaseUser,
   Organization,
   File,
+  Version,
 } from "../../_common";
 import { OrderItem } from "./orderItem";
 
@@ -16,10 +17,14 @@ export type ShipmentTag =
   | "items_fulfilled"
   | "processing_return_items"
   | "items_returned"
+  | "returned_to_sender"
+  | "pending_return_to_sender"
   | "items_removed"
   | "pending_inventory_receiving"
   | "items_partially_fulfilled"
-  | "customer_booking";
+  | "customer_booking"
+  | "pending_customer_pickup"
+  | "items_picked_up_by_customer";
 
 export type OrderPlatform =
   | "manual"
@@ -40,41 +45,43 @@ export interface FulfillmentOrderAddress extends BaseAddress {
   updated_at: string;
 }
 
-export interface Order {
-  id: string;
-  order_id: string;
-  external_order_number: string;
-  external_order_id: string | null;
-  notes: string;
-  internal_notes?: string;
-  platform: OrderPlatform;
-  external_platform_version: number | null;
-  parcel_type: string;
-  cancelled: boolean;
-  fulfilled_from: FacilityCode;
-  client_type: string | null;
-  insurance_value: number;
-  shipping_service: string | null;
-  signature_required?: boolean;
-  customer: Customer;
-  address: FulfillmentOrderAddress;
-  created_at: string;
-  updated_at: string;
-  organization: Organization;
-  overdue: boolean;
-  user: BaseUser;
-  status?: string;
-  shipment_tags: ShipmentTag[];
-  shipments: Shipment[];
-  items: OrderItem[];
-  files: File[];
-  stock_status:
-    | "in_stock"
-    | "partially_in_stock"
-    | "out_of_stock"
-    | "unknown_stock";
-  on_hold: boolean;
-  on_hold_at: string;
-  selected_service_code?: ScServiceCode;
-  has_errors: boolean;
-}
+export type Order<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      order_id: string;
+      external_order_number: string;
+      external_order_id: string | null;
+      notes: string;
+      internal_notes?: string;
+      platform: OrderPlatform;
+      external_platform_version: number | null;
+      parcel_type: string;
+      cancelled: boolean;
+      fulfilled_from: FacilityCode;
+      client_type: string | null;
+      insurance_value: number;
+      shipping_service: string | null;
+      signature_required?: boolean;
+      customer: Customer;
+      address: FulfillmentOrderAddress;
+      created_at: string;
+      updated_at: string;
+      organization: Organization;
+      overdue: boolean;
+      user: BaseUser;
+      status?: string;
+      shipment_tags: ShipmentTag[];
+      shipments: Shipment<V>[];
+      items: OrderItem<V>[];
+      files: File[];
+      stock_status:
+        | "in_stock"
+        | "partially_in_stock"
+        | "out_of_stock"
+        | "unknown_stock";
+      on_hold: boolean;
+      on_hold_at: string;
+      requested_service_code?: ScServiceCode;
+      has_errors: boolean;
+    }
+  : Omit<Order<"V1">, "items" | "shipments">;

package/src/fulfillment/order/orderItem.ts

@@ -1,16 +1,34 @@
-import { Product } from "../product";
+import { Version } from "../../_common";
+import { BaseProduct, Product } from "../product";
 import { ShipmentActionType } from "../shipment";
 
-export interface OrderItem {
-  id: string;
-  product: Product;
-  quantity: number;
-  attributes: string[];
-  return_reasons: string[];
-  available_actions: ShipmentActionType[];
-  actions_history: ShipmentActionType[];
-  virtual_kit_id: null | string;
-  available_quantity: number;
-  removed: boolean;
-  removed_reason: string;
-}
+export type OrderItem<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      product: Product;
+      quantity: number;
+      attributes: string[];
+      return_reasons: string[];
+      available_actions: ShipmentActionType[];
+      actions_history: ShipmentActionType[];
+      virtual_kit_id: null | string;
+      available_quantity: number;
+      removed: boolean;
+      removed_reason: string;
+    }
+  : {
+      product: BaseProduct & {
+        available_quantity: OrderItem<"V1">["available_quantity"];
+        base_products?: OrderItem<"V2">["product"][];
+        required_parts?: Record<string, number>;
+      };
+      available_actions: {
+        inventory_pick_up_item_ids: OrderItem<"V1">["id"][];
+        inventory_warehouse_receiving_item_ids: OrderItem<"V1">["id"][];
+        delivery_item_ids: OrderItem<"V1">["id"][];
+      };
+      removed_items: {
+        removed_reason: string;
+        quantity: number;
+      }[];
+    };

package/src/fulfillment/product/product.ts

@@ -3,14 +3,18 @@ import { BaseImage } from "../../_common";
 
 export interface BaseProduct {
   id: string;
-  organization_id: string;
   scid: string;
+  name: string;
   sku: string;
   upc: string;
-  name: string;
+  type: "base" | "kit";
+  active: boolean;
+}
+
+export interface Product extends Omit<BaseProduct, "type"> {
+  organization_id: string;
   description: string;
   platform: string;
-  active: boolean;
   fragile: boolean;
   dangerous: boolean;
   liquid: boolean;
@@ -32,7 +36,7 @@ export interface BaseProduct {
   customs_description: string | null;
   images: BaseImage[];
   packaging_criteria: string;
-  product_type: "base" | "kit";
+  product_type: BaseProduct["type"];
   stocks?: Stock[];
   deleted_at: string;
   created_at: string;
@@ -56,21 +60,14 @@ export interface BaseProduct {
   insurance_value: number | null;
   has_errors: boolean;
   under_conversion: boolean;
-}
-
-export interface Product extends BaseProduct {
-  base_products?: BaseProduct[];
+  base_products?: Product[];
 }
 
 export interface PackagingLevel {
   id?: string;
   product_id?: string;
-  product: {
-    id: string;
-    sku: string;
+  product: BaseProduct & {
     upc: string;
-    scid: string;
-    name: string;
     tracks_lot_numbers: boolean;
   };
   level: "single_item" | "inner_pack" | "master_pack" | "pallet";

package/src/fulfillment/product/stock.ts

@@ -18,4 +18,6 @@ export interface Stock {
   orders_to_be_reserved: StockOrder[];
   reserved_quantity: number;
   reserved_orders: StockOrder[];
+  on_hold_inventory?: number;
+  damaged_inventory?: number;
 }

package/src/fulfillment/shipment/shipment.ts

@@ -1,9 +1,16 @@
 import { ShipmentItem } from "./shipmentItem";
-import { BaseUser, BaseNote, BaseOrganization, Facility } from "../../_common";
+import {
+  BaseUser,
+  BaseNote,
+  BaseOrganization,
+  Facility,
+  Version,
+} from "../../_common";
 import { Package } from "./package";
 import {
   SecondClosetShippingMethod,
   ExternalCarrierShippingMethod,
+  CustomerPickupShippingMethod,
 } from "./shippingMethod";
 import { Carrier } from "./carrier";
 import { AppointmentType as FulfillmentAppointmentType } from "../appointment/appointmentType";
@@ -11,6 +18,7 @@ import { AppointmentType as StorageAppointmentType } from "../../storage/appoint
 
 export type ShipmentActionType =
   | "setup"
+  | "customer_pickup"
   | StorageAppointmentType
   | FulfillmentAppointmentType;
 
@@ -33,35 +41,41 @@ export type ScServiceCode =
   | "second_closet_to_the_door_1_person"
   | ServiceCode;
 
-export interface Shipment {
-  id: string;
-  organization_id: string;
-  organization?: BaseOrganization;
-  billed: boolean;
-  user: BaseUser;
-  notes: BaseNote[] | string;
-  shipment_items: ShipmentItem[];
-  shipment_number: string;
-  packages: Package[];
-  external_order_id: string | null;
-  external_order_type: string;
-  external_shipment_id: string | null;
-  carrier: Carrier | null;
-  created_at: string;
-  updated_at: string;
-  action_summary: ShipmentActionType[];
-  freight: boolean;
-  shipping_method: SecondClosetShippingMethod | ExternalCarrierShippingMethod;
-  shipping_method_type:
-    | "external_carrier_shipment"
-    | "appointment"
-    | "untracked_shipment";
-  external_order?: {
-    id: string;
-    external_order_number: string;
-    external_order_id: string | null;
-    created_at: string;
-    updated_at: string;
-  };
-  facility?: Partial<Facility>;
-}
+export type Shipment<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      organization_id: string;
+      organization?: BaseOrganization;
+      billed: boolean;
+      user: BaseUser;
+      notes: BaseNote[] | string;
+      shipment_items: ShipmentItem<V>[];
+      shipment_number: string;
+      packages: Package[];
+      external_order_id: string | null;
+      external_order_type: string;
+      external_shipment_id: string | null;
+      carrier: Carrier | null;
+      created_at: string;
+      updated_at: string;
+      action_summary: ShipmentActionType[];
+      freight: boolean;
+      shipping_method:
+        | SecondClosetShippingMethod
+        | ExternalCarrierShippingMethod
+        | CustomerPickupShippingMethod;
+      shipping_method_type:
+        | "external_carrier_shipment"
+        | "appointment"
+        | "untracked_shipment"
+        | "customer_pickup_shipment";
+      external_order?: {
+        id: string;
+        external_order_number: string;
+        external_order_id: string | null;
+        created_at: string;
+        updated_at: string;
+      };
+      facility?: Partial<Facility>;
+    }
+  : Omit<Shipment<"V1">, "shipment_items">;

package/src/fulfillment/shipment/shipmentItem.ts

@@ -1,42 +1,55 @@
+import { Version } from "../../_common";
+import { BaseProduct } from "../product";
 import { ShipmentActionType } from "./shipment";
-export interface ShipmentItem {
-  id: string;
-  order_item_id: string;
-  description: string;
-  item_identifier: string;
-  item_identifier_type: string;
-  item_identifier_value: string;
-  product_id?: string;
-  weight_value: string;
-  weight_unit: string;
-  length_value: string;
-  length_unit: string;
-  height_value: string;
-  height_unit: string;
-  width_value: string;
-  width_unit: string;
-  shipment_actions: ShipmentActionType[];
-  shipment_actions_completion: Partial<
-    {
-      [key in ShipmentActionType]: boolean;
+export type ShipmentItem<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      order_item_id: string;
+      description: string;
+      item_identifier: string;
+      item_identifier_type: string;
+      item_identifier_value: string;
+      product_id?: string;
+      weight_value: string;
+      weight_unit: string;
+      length_value: string;
+      length_unit: string;
+      height_value: string;
+      height_unit: string;
+      width_value: string;
+      width_unit: string;
+      shipment_actions: ShipmentActionType[];
+      shipment_actions_completion: Partial<
+        {
+          [key in ShipmentActionType]: boolean;
+        }
+      >;
+      shipment_actions_status?: {
+        [key in ShipmentActionType]: {
+          completed: boolean;
+          failed: boolean;
+          failed_reason: string | null;
+        };
+      };
+      shipment_item_group: {
+        id: string;
+        name: string;
+        description: string;
+        external_group_id: string;
+        group_identifier_type: string;
+        group_identifier_value: string;
+        created_at: string;
+        updated_at: string;
+        group_identifier: string;
+      } | null;
     }
-  >;
-  shipment_actions_status?: {
-    [key in ShipmentActionType]: {
-      completed: boolean;
-      failed: boolean;
-      failed_reason: string | null;
+  : {
+      product: BaseProduct;
+      shipment_item_ids: ShipmentItem<"V1">["id"][];
+      shipment_actions_status: {
+        [key in ShipmentActionType]: {
+          completed_shipment_item_ids: string[];
+          failed_shipment_items: string[];
+        };
+      };
     };
-  };
-  shipment_item_group: {
-    id: string;
-    name: string;
-    description: string;
-    external_group_id: string;
-    group_identifier_type: string;
-    group_identifier_value: string;
-    created_at: string;
-    updated_at: string;
-    group_identifier: string;
-  } | null;
-}

package/src/fulfillment/shipment/shippingMethod.ts

@@ -153,3 +153,13 @@ export interface ExternalCarrierShippingMethod {
   ship_to_address: CarrierShippingAddress;
   shipping_labels: ExternalCarrierShippingLabel[];
 }
+
+export interface CustomerPickupShippingMethod {
+  id: string;
+  status: "awaiting" | "failed" | "cancelled" | "completed";
+  created_at: string;
+  completed_at?: string;
+  failed_at?: string;
+  failed_reason?: string;
+  estimated_pickup_date?: string;
+}

package/src/warehouse/carrierTransferPackage.ts

@@ -43,7 +43,7 @@ interface ShippingLabel extends Partial<ExternalCarrierShippingLabel> {
   created_at: string;
   updated_at: string;
 }
-interface PackageShipment extends Partial<Shipment> {
+interface PackageShipment extends Partial<Shipment<"V1">> {
   user_id: string;
   shipping_method_id?: string;
   customer_scheduling_token?: string;
@@ -62,4 +62,4 @@ export interface PackageDetailsInfo extends PackageInfo {
   organization: Organization;
   carrier?: PackageCarrier;
   shipping_label?: ShippingLabel;
-}
+}

package/src/warehouse/index.ts

@@ -24,3 +24,8 @@ export * from "./stock";
 export * from "./supply";
 export * from "./supplyStock";
 export * from "./supplyTransaction";
+export * from "./rmaContainer";
+export * from "./productPhysicalProperty";
+export * from "./physicalProperty";
+export * from "./pickActivityLog";
+export * from "./lotCode";

package/src/warehouse/locationItem.ts

@@ -3,10 +3,12 @@ import { Location } from "./location";
 import { Pallet } from "./pallet";
 import { Bin } from "./bin";
 import { ManualItem } from "./manualItem";
+import { LotCode } from "./lotCode";
 
 export enum LocationItemStatus {
-  DAMAGED = "DAMAGED",
-  NORMAL = "NORMAL",
+  AVAILABLE = "available",
+  DAMAGED = "damaged",
+  HOLD = "hold",
 }
 
 export interface LocationItem {
@@ -26,6 +28,8 @@ export interface LocationItem {
   created_at: string;
   updated_at: string;
   status: LocationItemStatus;
+  lot_code?: LotCode;
+  lot_code_id?: string;
 }
 
 export interface ItemMoveLocationValidation {

package/src/warehouse/lotCode.ts

@@ -0,0 +1,13 @@
+import { LocationItem } from "./locationItem";
+import { Organization } from "./organization";
+
+export interface LotCode {
+  id: string;
+  code?: string;
+  expiry_date?: string;
+  organization_id: string;
+  organization: Organization;
+  location_items?: LocationItem[];
+  created_at: string;
+  updated_at: string;
+}

package/src/warehouse/organization.ts

@@ -1,7 +1,8 @@
+import { FacilityCode } from "../_common";
+import { LotCode } from "./lotCode";
 import { Product } from "./product";
-import { Supply } from "./supply";
 import { ShipmentProductsTracking } from "./shipmentProductsTracking";
-import { FacilityCode } from "../_common";
+import { Supply } from "./supply";
 
 export interface Organization {
   id: string;
@@ -9,6 +10,7 @@ export interface Organization {
   products?: Product[];
   supplies?: Supply[];
   shipment_products_trackings?: ShipmentProductsTracking[];
+  lot_codes?: LotCode[];
 }
 
 export enum OrganizationConfigKey {

package/src/warehouse/physicalProperty.ts

@@ -0,0 +1,9 @@
+export interface PhysicalProperty {
+  id: string;
+  name: string;
+  default_value: string;
+  type: "STRING" | "BOOLEAN" | "NUMBER";
+  created_at: Date;
+  updated_at: Date;
+  deleted_at: Date;
+}

package/src/warehouse/pickActivityLog.ts

@@ -0,0 +1,22 @@
+import { Picksheet } from "./picksheet";
+
+enum PickActivityActionType {
+  START = "START",
+  PICK = "PICK",
+  ERROR = "ERROR",
+}
+
+export interface PickActivityLog {
+  id: string;
+  picksheet_id: string;
+  picksheet: Picksheet;
+  wavesheet_id: string;
+  picksheet_item_id: string;
+  picked_by: string;
+  created_at: Date;
+  action: PickActivityActionType;
+  quantity: number;
+  picked_location_code: string;
+  recommended_location_code: string;
+  error_message: string;
+}

package/src/warehouse/picksheet.ts

@@ -16,6 +16,7 @@ export type PicksheetStats = {
   organization?: PicksheetOrganization;
   ready_to_fulfill_count: number;
   processing_items_count: number;
+  is_pushed_shipments_enabled: boolean;
 };
 
 export enum PicksheetStatus {
@@ -55,6 +56,9 @@ export type Picksheet = {
   request?: PicksheetRequest;
   picksheet_items?: PicksheetItem[];
   type: PicksheetType;
+  organization?: Organization;
+  organization_id: string;
+  facility?: FacilityCode;
 };
 
 export type PicksheetItem = {
@@ -83,16 +87,3 @@ export type PicksheetRequest = {
   type: PicksheetRequestType;
   picksheets?: Picksheet[];
 };
-
-export type PicksheetLookupData = {
-  facility?: string;
-  picksheet_id?: string;
-  shipment_number?: string;
-  number_of_items?: number;
-  order_id?: string;
-  organization?: string;
-  created_at?: string;
-  shipment_id?: string;
-  external_order_number?: string;
-  external_order_id?: string;
-};

package/src/warehouse/productPhysicalProperty.ts

@@ -0,0 +1,16 @@
+import { PhysicalProperty } from "./physicalProperty";
+
+export interface ProductPhysicalPropertyView {
+  type: string;
+  value: string;
+  name: string;
+  product_physical_property_id: string;
+}
+
+export interface ProductPhysicalProperty {
+  id: string;
+  value: string;
+  product_id: string;
+  physical_property_id: string;
+  physical_property: PhysicalProperty;
+}

package/src/warehouse/putawayActivityLog.ts

@@ -1,3 +1,4 @@
+import { LocationItemStatus } from "./locationItem";
 import { Product } from "./product";
 
 export enum PutawayActivityLogType {
@@ -8,6 +9,7 @@ export enum PutawayActivityLogType {
 export interface PutawayActivityLog {
   id: string;
   action: PutawayActivityLogType;
+  status?: LocationItemStatus;
   from_container_id?: string;
   to_container_id?: string;
   user_email: string;

package/src/warehouse/return.ts

@@ -1,4 +1,5 @@
 import { Organization } from "./organization";
+import { RmaContainer } from "./rmaContainer";
 
 export enum ReturnItemCondition {
   RESELLABLE = "resellable",
@@ -39,6 +40,8 @@ export interface ReturnItem {
   condition_notes?: string;
   reason?: string;
   reason_notes?: string;
+  rma_container_id?: string;
+  rma_container?: RmaContainer;
 }
 
 export interface ReturnAddress {

package/src/warehouse/rmaContainer.ts

@@ -0,0 +1,9 @@
+import { ReturnItem } from "./return";
+
+export type RmaContainer = {
+  id: string;
+  rma_number: string;
+  container_id: string;
+  quantity: number;
+  return_items: ReturnItem[];
+};