@secondcloset/types 2.7.48-product-quantums-0 → 2.8.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondcloset/types",
-  "version": "2.7.48-product-quantums-0",
+  "version": "2.8.0-beta.1",
   "description": "secondcloset type declaration and definitions",
   "main": "src/index.ts",
   "scripts": {

package/src/_common/organization.ts

@@ -8,7 +8,8 @@ export type OrganizationConfigKey =
   | "default_fulfilled_from"
   | "auto_fulfill_orders"
   | "freightcom_api_username"
-  | "freightcom_api_password";
+  | "freightcom_api_password"
+  | "preferred_return_facility";
 
 export interface OrganizationConfig {
   key: OrganizationConfigKey;
@@ -71,6 +72,10 @@ export interface Organization extends BaseOrganization {
   permissions: Permission[];
   geofilter_constraints?: GeofilterConstraint[];
   facility_service_areas?: FacilityServiceArea[];
+  default_fulfilled_from?: {
+    facility: Facility<"V2">;
+    organization_regions: Region;
+  }[];
 }
 
 export interface Region {

package/src/fulfillment/appointment/appointment.ts

@@ -2,6 +2,7 @@ import {
   AppointmentType,
   AppointmentSubtype,
   DeliveryType,
+  ParcelServiceLevel,
 } from "./appointmentType";
 import { AppointmentStatus } from "./appointmentStatus";
 import { Shipment, ScServiceCode } from "../shipment";
@@ -10,6 +11,7 @@ import { AppointmentSlot } from "../../storage";
 import { BaseImage, BaseNote, ServiceArea } from "../../_common";
 
 export interface Appointment {
+  air_skip?: boolean;
   appointment_actions: string[];
   arrived_time: string | null;
   cancelled_at: string | null;
@@ -38,6 +40,7 @@ export interface Appointment {
   movers: null;
   num_movers: null;
   number: string;
+  parcel_service_level?: ParcelServiceLevel;
   range_of_days_assigned_dates?: {
     assigned_start_datetime: string;
     assigned_end_datetime: string;
@@ -65,6 +68,7 @@ export interface Appointment {
   verification_images?: BaseImage[];
   delivery_type?: DeliveryType;
   shipping_labels?: LastMileShippingLabel[];
+  signature_required?: boolean;
 }
 
 export interface Location {

package/src/fulfillment/appointment/appointmentType.ts

@@ -9,3 +9,5 @@ export type AppointmentType =
 export type AppointmentSubtype = "mid_mile_pick_up" | "mid_mile_drop_off";
 
 export type DeliveryType = "heavy" | "parcel";
+
+export type ParcelServiceLevel = "same_day" | "next_day" | null;

package/src/fulfillment/asn/asn.ts

@@ -65,4 +65,5 @@ export interface ASN {
   deleted_at?: string;
   items_attributes: ASNItem[];
   timeline?: TimelineEvent[];
+  organization_id?: string;
 }

package/src/fulfillment/index.ts

@@ -5,3 +5,4 @@ export * from "./appointment";
 export * from "./warehouseReceivingOrder";
 export * from "./asn";
 export * from "./resourceError";
+export * from "./returns";

package/src/fulfillment/order/order.ts

@@ -6,6 +6,7 @@ import {
   BaseUser,
   Organization,
   File,
+  Version,
 } from "../../_common";
 import { OrderItem } from "./orderItem";
 
@@ -40,41 +41,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 = Version> = 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<"V1">[];
+      items: OrderItem<"V1">[];
+      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;
+    }
+  : Omit<Order<"V1">, "items" | "shipments">;

package/src/fulfillment/order/orderItem.ts

@@ -1,16 +1,32 @@
-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 = Version> = 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"];
+      };
+      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,11 +3,15 @@ import { BaseImage } from "../../_common";
 
 export interface BaseProduct {
   id: string;
-  organization_id: string;
-  scid: string;
+  name: string;
   sku: string;
+  scid: string;
+  type: "base" | "kit";
+}
+
+export interface Product extends Omit<BaseProduct, "type"> {
+  organization_id: string;
   upc: string;
-  name: string;
   description: string;
   platform: string;
   active: 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/returns/configs.ts

@@ -0,0 +1,32 @@
+import { Common } from "../..";
+
+export type ReturnsConfigurationCondition =
+  | "item_good_package_open"
+  | "item_good_package_damaged"
+  | "item_damaged"
+  | "email_customer";
+
+export type ReturnsConfigurationInstruction =
+  | "allow"
+  | "dispose"
+  | "restock"
+  | "return_to_merchant"
+  | "donate";
+
+interface ReturnAddress extends Common.BaseAddress {
+  full_name?: string;
+}
+
+export interface ReturnsConfiguration {
+  organization_id: string;
+  condition: ReturnsConfigurationCondition;
+  instruction: ReturnsConfigurationInstruction | null;
+  comment: string;
+  address?: Partial<ReturnAddress>;
+  preferred_return_facility?: Common.FacilityCode;
+}
+
+export interface ReturnsFacilities {
+  key: string;
+  value: string;
+}

package/src/fulfillment/returns/index.ts

@@ -0,0 +1 @@
+export * from "./configs";

package/src/fulfillment/shipment/shipment.ts

@@ -1,5 +1,11 @@
 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,
@@ -14,6 +20,15 @@ export type ShipmentActionType =
   | StorageAppointmentType
   | FulfillmentAppointmentType;
 
+export type ServiceCode =
+  | "standard"
+  | "white_glove"
+  | "to_the_door"
+  | "room_of_choice"
+  | "standard_1_person"
+  | "room_of_choice_1_person"
+  | "to_the_door_1_person";
+
 export type ScServiceCode =
   | "second_closet_standard"
   | "second_closet_white_glove"
@@ -21,37 +36,42 @@ export type ScServiceCode =
   | "second_closet_room_of_choice"
   | "second_closet_standard_1_person"
   | "second_closet_room_of_choice_1_person"
-  | "second_closet_to_the_door_1_person";
+  | "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 = Version> = V extends "V1"
+  ? {
+      id: string;
+      organization_id: string;
+      organization?: BaseOrganization;
+      billed: boolean;
+      user: BaseUser;
+      notes: BaseNote[] | string;
+      shipment_items: ShipmentItem<"V1">[];
+      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>;
+    }
+  : Omit<Shipment<"V1">, "shipment_items">;

package/src/fulfillment/shipment/shipmentItem.ts

@@ -1,42 +1,49 @@
+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 = Version> = 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_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

@@ -4,6 +4,7 @@ import {
   AppointmentType,
   AppointmentSubtype,
   DeliveryType,
+  ParcelServiceLevel,
 } from "../../fulfillment/appointment";
 import { CustomerAddress, Customer, ShipmentTag } from "../order";
 import { BaseUser, BaseImage, BaseNote, BaseAddress } from "../../_common";
@@ -31,6 +32,7 @@ export type ShippingMethodType =
   | "external_carrier_shipment";
 
 export interface SecondClosetShippingMethod {
+  air_skip?: boolean;
   id: string;
   user_id?: string;
   user_code?: string;
@@ -62,6 +64,7 @@ export interface SecondClosetShippingMethod {
   } | null;
   range_of_days_start_date?: string | null;
   range_of_days_end_date?: string | null;
+  parcel_service_level?: ParcelServiceLevel;
   created_at: string;
   updated_at?: string;
   num_movers?: number | null;
@@ -77,6 +80,7 @@ export interface SecondClosetShippingMethod {
   verification_images?: BaseImage[];
   delivery_type?: DeliveryType;
   shipping_labels?: LastMileShippingLabel[];
+  signature_required?: boolean;
   source?: {
     id: string;
     type: string;

package/src/storage/appointment/appointment.ts

@@ -3,6 +3,7 @@ import {
   AppointmentType,
   AppointmentSubtype,
   DeliveryType,
+  ParcelServiceLevel,
 } from "./appointmentType";
 import { AppointmentStatus } from "./appointmentStatus";
 import { Address } from "../address";
@@ -10,6 +11,7 @@ import { BaseImage, BaseNote, ServiceArea } from "../../_common";
 import { ScServiceCode } from "../../fulfillment";
 
 export interface Appointment {
+  air_skip?: boolean;
   address: Address;
   arrived_time?: string;
   bulky_order_only: boolean;
@@ -37,6 +39,7 @@ export interface Appointment {
   num_movers?: number;
   number: string;
   order_id: string;
+  parcel_service_level?: ParcelServiceLevel;
   rescheduled: boolean;
   rescheduled_appointment_id?: string | null;
   signature_image?: string;
@@ -57,6 +60,7 @@ export interface Appointment {
   items: AppointmentItem[];
   verification_images?: BaseImage[];
   delivery_type?: DeliveryType;
+  signature_required?: boolean;
 }
 
 export type AppointmentSlot =

package/src/storage/appointment/appointmentType.ts

@@ -10,3 +10,5 @@ export type AppointmentType =
 export type AppointmentSubtype = "mid_mile_pick_up" | "mid_mile_drop_off";
 
 export type DeliveryType = "heavy" | "parcel";
+
+export type ParcelServiceLevel = "same_day" | "next_day" | null;

package/src/warehouse/asnContainer.ts

@@ -0,0 +1,8 @@
+export type ASNContainer = {
+  id: string;
+  asn_number: string;
+  container_id: string;
+  quantity: number;
+  product_id: string;
+  created_at: 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

@@ -1,24 +1,26 @@
+export * from "./asnContainer";
 export * from "./asnProcessLog";
 export * from "./bin";
+export * from "./carrierTransferPackage";
+export * from "./carrierTransferPallet";
+export * from "./containerRequestLog";
 export * from "./location";
+export * from "./locationActivityLog";
 export * from "./locationItem";
 export * from "./locationTemplate";
+export * from "./manualItem";
+export * from "./occupiedLocation";
 export * from "./organization";
+export * from "./packerActivityLog";
 export * from "./pallet";
+export * from "./picksheet";
 export * from "./product";
+export * from "./productQuantum";
+export * from "./putawayActivityLog";
+export * from "./return";
 export * from "./shipmentProductsTracking";
+export * from "./specialProject";
+export * from "./stock";
 export * from "./supply";
 export * from "./supplyStock";
 export * from "./supplyTransaction";
-export * from "./locationActivityLog";
-export * from "./packerActivityLog";
-export * from "./containerRequestLog";
-export * from "./manualItem";
-export * from "./return";
-export * from "./stock";
-export * from "./specialProject";
-export * from "./carrierTransferPallet";
-export * from "./carrierTransferPackage";
-export * from "./picksheet";
-export * from "./occupiedLocation";
-export * from "./putawayActivityLog";

package/src/warehouse/organization.ts

@@ -20,6 +20,7 @@ export enum OrganizationConfigKey {
   GOOD_CONDITION_DAMAGED_PACKAGING_INSTRUCTION = "GOOD_CONDITION_DAMAGED_PACKAGING_INSTRUCTION",
   RTS_INSTRUCTION = "RTS_INSTRUCTION",
   ENABLE_SEND_EMAIL_TO_CUSTOMERS = "ENABLE_SEND_EMAIL_TO_CUSTOMERS",
+  DEFAULT_RATE_FETCHING_V1 = "DEFAULT_RATE_FETCHING_V1",
 }
 export interface OrganizationConfig {
   id: string;
@@ -29,6 +30,7 @@ export interface OrganizationConfig {
   organization?: Organization;
   created_at: string;
   updated_at: string;
+  metadata?: Record<string, any>;
 }
 
 export interface FacilityOrganization {

package/src/warehouse/packerActivityLog.ts

@@ -7,10 +7,13 @@ export enum PackerActivityType {
 export interface PackerActivityLog {
   id: string;
   user_email: string;
-  shipment_id: string;
-  shipment_number: string;
-  external_order_id: string;
-  external_order_number: string;
+  shipment_id?: string;
+  shipment_number?: string;
+  external_order_id?: string;
+  external_order_number?: string;
+  start_by_scanning?: string;
+  core_error_msg?: string;
   created_at: string;
   action: PackerActivityType;
+  provider_scope?: string;
 }

package/src/warehouse/productQuantum.ts

@@ -1,56 +1,51 @@
 import { Product } from "./product";
 
-export enum ProductQuantumType {
+enum ProductQuantumTypeEnum {
   EACH = "EACH",
   CASE = "CASE",
   INNER_PACK = "INNER_PACK",
   MASTER_PACK = "MASTER_PACK",
 }
 
-export enum CaseType {
-  INNER_PACK = "INNER_PACK",
-  MASTER_PACK = "MASTER_PACK",
-}
-
-export enum ContainsType {
+enum ContainsTypeEnum {
   EACH = "EACH",
   INNER_PACK = "INNER_PACK",
 }
 
-export enum WeightUnit {
+enum WeightUnitEnum {
   LB = "LB",
   OZ = "OZ",
   G = "G",
   KG = "KG",
 }
 
-export enum DimensionsUnit {
+enum DimensionsUnitEnum {
   IN = "IN",
-  FT = "IT",
+  FT = "FT",
   CM = "CM",
   M = "M",
 }
 
 export interface ProductQuantum {
   id: string;
-  type: ProductQuantumType;
+  type: ProductQuantumTypeEnum;
   quantity: number;
   sku: string;
   upc?: string;
-  contains_type: ContainsType | null;
+  contains_type: ContainsTypeEnum | null;
   weight: number;
   height: number;
   length: number;
   width: number;
-  weight_unit: WeightUnit;
-  dimensions_unit: DimensionsUnit;
+  weight_unit: WeightUnitEnum;
+  dimensions_unit: DimensionsUnitEnum;
   product_id: string;
   product: Product;
 }
 
 export interface ProductQuantumUpdateBody {
-  type: ProductQuantumType;
-  contains_type: ContainsType;
+  type: ProductQuantumTypeEnum;
+  contains_type: ContainsTypeEnum;
   quantity: number;
   sku: string;
   upc: string;
@@ -58,22 +53,22 @@ export interface ProductQuantumUpdateBody {
   height: number;
   weight: number;
   width: number;
-  dimensions_unit: DimensionsUnit;
-  weight_unit: WeightUnit;
+  dimensions_unit: DimensionsUnitEnum;
+  weight_unit: WeightUnitEnum;
   product_id: string;
 }
 
 export interface CreateProductQuantumBody {
-  type: ProductQuantumType;
+  type: ProductQuantumTypeEnum;
   upc: string;
   sku: string;
   product_id: string;
-  contains_type: ProductQuantumType;
+  contains_type: ProductQuantumTypeEnum;
   quantity: number;
   weight: number;
-  weight_unit: WeightUnit;
+  weight_unit: WeightUnitEnum;
   height: number;
   width: number;
   length: number;
-  dimensions_unit: DimensionsUnit;
+  dimensions_unit: DimensionsUnitEnum;
 }