@secondcloset/types 2.17.17-beta-containerTypes-5 → 3.0.0

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/package.ts

@@ -22,6 +22,7 @@ export interface Package {
   width_value: string;
   width_unit: string;
   logistics_external_carrier_shipping_label_id: string;
+  logistics_bolt_shipping_label_id?: string;
   shipment_item_ids: string[];
   status: PackageStatus;
   tracking_number: null | string;

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,9 +18,19 @@ import { AppointmentType as StorageAppointmentType } from "../../storage/appoint
 
 export type ShipmentActionType =
   | "setup"
+  | "customer_pickup"
   | 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 +38,44 @@ 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 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,59 @@
+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: {
+            ids: string[];
+            failed_reason: string | null;
+          }[];
+        };
+      };
+      quantity: number;
+      attributes?: string[];
+      return_reasons?: 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

@@ -3,6 +3,8 @@ import {
   AppointmentStatus,
   AppointmentType,
   AppointmentSubtype,
+  DeliveryType,
+  ParcelServiceLevel,
 } from "../../fulfillment/appointment";
 import { CustomerAddress, Customer, ShipmentTag } from "../order";
 import { BaseUser, BaseImage, BaseNote, BaseAddress } from "../../_common";
@@ -30,6 +32,7 @@ export type ShippingMethodType =
   | "external_carrier_shipment";
 
 export interface SecondClosetShippingMethod {
+  air_skip?: boolean;
   id: string;
   user_id?: string;
   user_code?: string;
@@ -61,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;
@@ -74,6 +78,9 @@ export interface SecondClosetShippingMethod {
   delivery_service_level?: ScServiceCode;
   field_ops_notes?: BaseNote[];
   verification_images?: BaseImage[];
+  delivery_type?: DeliveryType;
+  shipping_labels?: LastMileShippingLabel[];
+  signature_required?: boolean;
   source?: {
     id: string;
     type: string;
@@ -126,6 +133,14 @@ export interface ExternalCarrierShippingLabel {
   voided_at: string | null;
 }
 
+export interface LastMileShippingLabel {
+  id: string;
+  label_id?: string;
+  tracking_number?: string;
+  tracking_url?: string;
+  label_download?: string;
+}
+
 export interface ExternalCarrierShippingMethod {
   id: string;
   status: ExternalCarrierShipmentStatus;
@@ -138,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/logistics/availability.ts

@@ -1,6 +1,10 @@
 import { ServiceArea } from "../_common";
 
-export type DeliveryServiceLevel = "white_glove" | "non_white_glove" | "all_service_levels";
+export type DeliveryServiceLevel =
+  | "white_glove"
+  | "non_white_glove"
+  | "all_service_levels"
+  | "parcel_regular";
 
 export interface AvailabilityTimeSlot {
   timeslot: string;

package/src/logistics/index.ts

@@ -1,2 +1,3 @@
 export * from "./shippingRate";
-export * from "./availability"
+export * from "./availability";
+export * from "./serviceArea";

package/src/logistics/serviceArea.ts

@@ -0,0 +1,14 @@
+import { FacilityCode, ServiceArea as ServiceAreaCode } from "../_common";
+
+export interface ServiceArea {
+  id: number;
+  facilities: FacilityCode[];
+  name: ServiceAreaCode;
+  humanized_name: string;
+  timezone: string;
+  address: { country: string; province: string };
+  standard_boundary: { latitude: number; longitude: number }[];
+  extended_boundary: { latitude: number; longitude: number }[];
+  created_at: string;
+  updated_at: string;
+}

package/src/storage/appointment/appointment.ts

@@ -1,11 +1,17 @@
 import { AppointmentItem } from "./appointmentItem";
-import { AppointmentType, AppointmentSubtype } from "./appointmentType";
+import {
+  AppointmentType,
+  AppointmentSubtype,
+  DeliveryType,
+  ParcelServiceLevel,
+} from "./appointmentType";
 import { AppointmentStatus } from "./appointmentStatus";
 import { Address } from "../address";
 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;
@@ -33,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;
@@ -52,6 +59,8 @@ export interface Appointment {
   user_lastname: string;
   items: AppointmentItem[];
   verification_images?: BaseImage[];
+  delivery_type?: DeliveryType;
+  signature_required?: boolean;
 }
 
 export type AppointmentSlot =

package/src/storage/appointment/appointmentType.ts

@@ -8,3 +8,7 @@ export type AppointmentType =
   | "custom";
 
 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

@@ -19,6 +19,7 @@ export interface CarrierTransferPackage {
   handover_at?: string;
   created_by: string;
   created_at: string;
+  destination_country?: string;
 }
 
 interface PackageCarrier {
@@ -43,7 +44,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 +63,4 @@ export interface PackageDetailsInfo extends PackageInfo {
   organization: Organization;
   carrier?: PackageCarrier;
   shipping_label?: ShippingLabel;
-}
+}

package/src/warehouse/containerRequestLog.ts

@@ -1,5 +1,4 @@
 import { CarrierTransferPallet, Pallet } from ".";
-import { Container } from "./container";
 
 export enum ContainerRequestStatus {
   FAILED = "failed",
@@ -12,6 +11,13 @@ export enum ContainerRequestSource {
   CARRIER_TRANSFER_PALLET = "carrier_transfer_pallet",
   BIN = "bin",
 }
+
+export enum ContainerType {
+  SINGLE = "single",
+  DOUBLE = "double",
+  BIN = "bin",
+}
+
 export interface ContainerRequestLog {
   id: string;
   status: ContainerRequestStatus;
@@ -22,5 +28,4 @@ export interface ContainerRequestLog {
   created_at: string;
   carrier_transfer_pallets?: CarrierTransferPallet[];
   pallets?: Pallet[];
-  containers?: Container[];
 }

package/src/warehouse/index.ts

@@ -1,24 +1,31 @@
+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 "./container";
+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 "./palletRequestLog";
+export * from "./rmaContainer";
+export * from "./productPhysicalProperty";
+export * from "./physicalProperty";
+export * from "./pickActivityLog";
+export * from "./lotCode";

package/src/warehouse/location.ts

@@ -8,6 +8,12 @@ export enum LocationType {
   RACKING = "RACKING",
   CART = "CART",
   PALLET_ZONE = "PALLET_ZONE",
+  VIRTUAL = "VIRTUAL",
+}
+
+export enum LocationStatus {
+  EMPTY = "EMPTY",
+  OCCUPIED = "OCCUPIED",
 }
 
 export interface Location {
@@ -17,4 +23,9 @@ export interface Location {
   location_template_id: string;
   location_template?: LocationTemplate;
   location_items?: LocationItem[];
+  status: LocationStatus;
+  physical_previous_location?: string;
+  physical_next_location?: string;
+  logical_previous_location?: string;
+  logical_next_location?: string;
 }

package/src/warehouse/locationActivityLog.ts

@@ -22,4 +22,5 @@ export interface LocationActivityLog {
   user_email: string;
   action: LocationActivityType;
   product?: Product;
+  reference_number?: string;
 }

package/src/warehouse/locationItem.ts

@@ -3,6 +3,13 @@ import { Location } from "./location";
 import { Pallet } from "./pallet";
 import { Bin } from "./bin";
 import { ManualItem } from "./manualItem";
+import { LotCode } from "./lotCode";
+
+export enum LocationItemStatus {
+  AVAILABLE = "available",
+  DAMAGED = "damaged",
+  HOLD = "hold",
+}
 
 export interface LocationItem {
   id: string;
@@ -20,4 +27,11 @@ export interface LocationItem {
   bin: Bin;
   created_at: string;
   updated_at: string;
+  status: LocationItemStatus;
+  lot_code?: LotCode;
+  lot_code_id?: string;
+}
+
+export interface ItemMoveLocationValidation {
+  multiple_bins: boolean;
 }

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/occupiedLocation.ts

@@ -0,0 +1,5 @@
+export interface OccupiedLocation {
+  id: string;
+  location_item_id: string;
+  location_code: 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 {
@@ -20,6 +22,8 @@ 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",
+  DEFAULT_REQUIRE_SIGNATURE = "DEFAULT_REQUIRE_SIGNATURE",
 }
 export interface OrganizationConfig {
   id: string;
@@ -29,6 +33,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/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;
+}