@secondcloset/types 1.8.4 → 1.38.1-beta-pq-0

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/logistics/shippingRate.ts

@@ -14,4 +14,6 @@ export interface ShippingRate {
   service_type: string;
   shipment_id: string | null;
   trackable: boolean;
+  client_account: boolean;
+  signature_rate?: boolean;
 }

package/src/storage/appointment/appointment.ts

@@ -1,8 +1,12 @@
 import { AppointmentItem } from "./appointmentItem";
-import { AppointmentType } from "./appointmentType";
+import {
+  AppointmentType,
+  AppointmentSubtype,
+  DeliveryType,
+} from "./appointmentType";
 import { AppointmentStatus } from "./appointmentStatus";
 import { Address } from "../address";
-import { BaseImage, BaseNote } from "../../_common";
+import { BaseImage, BaseNote, ServiceArea } from "../../_common";
 import { ScServiceCode } from "../../fulfillment";
 
 export interface Appointment {
@@ -26,6 +30,7 @@ export interface Appointment {
   incomplete_at?: string;
   issue_images?: BaseImage[];
   job_type: AppointmentType;
+  job_subtype?: AppointmentSubtype;
   location?: Location;
   movers?: any;
   notes?: string;
@@ -51,6 +56,7 @@ export interface Appointment {
   user_lastname: string;
   items: AppointmentItem[];
   verification_images?: BaseImage[];
+  delivery_type?: DeliveryType;
 }
 
 export type AppointmentSlot =
@@ -95,6 +101,6 @@ export interface Location {
   phone_number: string;
   postal_code: string;
   province: string;
-  service_area: "yyz" | "yvr" | "yow" | "yul" | null;
+  service_area: ServiceArea | null;
   updated_at: string;
 }

package/src/storage/appointment/appointmentType.ts

@@ -6,3 +6,7 @@ export type AppointmentType =
   | "return"
   | "immediate_retrieve"
   | "custom";
+
+export type AppointmentSubtype = "mid_mile_pick_up" | "mid_mile_drop_off";
+
+export type DeliveryType = "heavy" | "parcel";

package/src/storage/availability.ts

@@ -1,8 +1,10 @@
+import { ServiceArea } from "../_common";
+
 export type Slot = "10-13" | "13-16" | "16-19" | "19-22" | string;
 
 export interface TimeSlot {
   timeslot: Slot;
-  service_area: string;
+  service_area: ServiceArea;
   customer_segment: string;
   holiday: boolean;
   total_milliseconds: number;

package/src/warehouse/asnProcessLog.ts

@@ -0,0 +1,15 @@
+export type ASNProcessAction = "receive" | "set_damage" | "reset" | "complete";
+
+export interface ASNProcessLog {
+  id: string;
+  user_email: string;
+  external_asn_id: string;
+  external_asn_number: string;
+  external_product_id?: string;
+  product_name?: string;
+  product_sku?: string;
+  product_upc?: string;
+  quantity: number;
+  action: ASNProcessAction;
+  created_at: string;
+}

package/src/warehouse/bin.ts

@@ -0,0 +1,9 @@
+import { LocationItem } from "./locationItem";
+import { FacilityCode } from "../_common";
+
+export interface Bin {
+  id: string;
+  facility: FacilityCode;
+  location_items?: LocationItem[];
+  created_at: string;
+}

package/src/warehouse/carrierTransferPackage.ts

@@ -0,0 +1,65 @@
+import {
+  ExternalCarrierShippingLabel,
+  Package,
+  Shipment,
+} from "../fulfillment";
+import { Organization } from "../_common";
+import { CarrierTransferPallet } from "./carrierTransferPallet";
+
+export type CarrierTransferPackageStatus = "at_facility" | "with_carrier";
+
+export interface CarrierTransferPackage {
+  id: string;
+  status: CarrierTransferPackageStatus;
+  carrier_name?: string;
+  tracking_number?: string;
+  carrier_transfer_pallet_id?: string;
+  carrier_transfer_pallet?: CarrierTransferPallet;
+  handover_by?: string;
+  handover_at?: string;
+  created_by: string;
+  created_at: string;
+}
+
+interface PackageCarrier {
+  id: string;
+  carrier_code?: string;
+  name?: string;
+  external_platform?: string;
+  external_id?: string;
+  enabled_service_codes?: string[];
+  created_at: string;
+  updated_at: string;
+  deleted_at?: string;
+  organization_id?: string;
+  disabled?: string;
+}
+
+interface ShippingLabel extends Partial<ExternalCarrierShippingLabel> {
+  logistics_external_carrier_shipment_id?: string;
+  external_platform_shipment_id?: string;
+  external_platform_service_code?: string;
+  external_platform_void_label_error?: string;
+  created_at: string;
+  updated_at: string;
+}
+interface PackageShipment extends Partial<Shipment> {
+  user_id: string;
+  shipping_method_id?: string;
+  customer_scheduling_token?: string;
+  customer_scheduling_token_expired?: string;
+  latest_booking_email_sent_at?: string;
+  logistics_carrier_id?: string;
+  facility_id?: string;
+}
+export interface PackageInfo extends Partial<Package> {
+  tracking_number?: string;
+  package_id_type: string;
+}
+
+export interface PackageDetailsInfo extends PackageInfo {
+  shipment?: PackageShipment;
+  organization: Organization;
+  carrier?: PackageCarrier;
+  shipping_label?: ShippingLabel;
+}

package/src/warehouse/carrierTransferPallet.ts

@@ -0,0 +1,12 @@
+import { FacilityCode } from "../_common";
+import { CarrierTransferPackage } from "./carrierTransferPackage";
+
+export interface CarrierTransferPallet {
+  id: string;
+  carrier_transfer_packages?: CarrierTransferPackage[];
+  created_at: string;
+  with_packages?: boolean;
+  handed_over: boolean;
+  facility: FacilityCode | null;
+  container_request_log_id?: string;
+}

package/src/warehouse/containerRequestLog.ts

@@ -0,0 +1,31 @@
+import { CarrierTransferPallet, Pallet } from ".";
+
+export enum ContainerRequestStatus {
+  FAILED = "failed",
+  SUCCESS = "success",
+  IN_PROGRESS = "in_progress",
+}
+
+export enum ContainerRequestSource {
+  PALLET = "pallet",
+  CARRIER_TRANSFER_PALLET = "carrier_transfer_pallet",
+  BIN = "bin",
+}
+
+export enum ContainerType {
+  SINGLE = "single",
+  DOUBLE = "double",
+  BIN = "bin",
+}
+
+export interface ContainerRequestLog {
+  id: string;
+  status: ContainerRequestStatus;
+  user_email: string;
+  count: number;
+  fail_reason?: string;
+  source: ContainerRequestSource;
+  created_at: string;
+  carrier_transfer_pallets?: CarrierTransferPallet[];
+  pallets?: Pallet[];
+}

package/src/warehouse/index.ts

@@ -1,6 +1,25 @@
-export * from "./issue";
+export * from "./asnProcessLog";
+export * from "./bin";
 export * from "./location";
+export * from "./locationItem";
+export * from "./locationTemplate";
+export * from "./organization";
 export * from "./pallet";
-export * from "./task";
-export * from "./taskDefinition";
-export * from "./warehouseItem";
+export * from "./product";
+export * from "./productQuantum";
+export * from "./shipmentProductsTracking";
+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/location.ts

@@ -1,32 +1,30 @@
-import { WarehouseItem } from "./warehouseItem";
-import { FacilityCode } from "../_common/facility";
+import { LocationTemplate } from "./locationTemplate";
+import { LocationItem } from "./locationItem";
+import { FacilityCode } from "../_common";
 
-export type LocationType =
-  | "srz"
-  | "racking"
-  | "ioz"
-  | "forklift"
-  | "pz"
-  | "liz";
+export enum LocationType {
+  SHELF = "SHELF",
+  PACKING_STATION = "PACKING_STATION",
+  RACKING = "RACKING",
+  CART = "CART",
+  PALLET_ZONE = "PALLET_ZONE",
+}
 
-export interface Location {
-  location_code: string;
-  id: string;
-  facility: FacilityCode;
-  location_template_id: string;
-  type_of: LocationType;
-  labels: [];
-  is_in_service: boolean;
-  created_at: string;
-  updated_at: string;
+export enum LocationStatus {
+  EMPTY = "EMPTY",
+  OCCUPIED = "OCCUPIED",
 }
 
-export interface LookupLocation {
+export interface Location {
   code: string;
-  created_at: string;
-  id: string;
-  is_in_service: true;
-  items: Partial<WarehouseItem>[];
-  type_of: LocationType;
-  updated_at: string;
+  facility: FacilityCode;
+  type: LocationType;
+  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

@@ -0,0 +1,26 @@
+import { Product } from "./product";
+
+export enum LocationActivityType {
+  MOVE = "MOVE",
+  RECEIVE = "RECEIVE",
+  CREATE_PALLET = "CREATE_PALLET",
+  BREAK_DOWN = "BREAK_DOWN",
+  AUDIT = "AUDIT",
+}
+
+export interface LocationActivityLog {
+  id: string;
+  from_location_code: string;
+  to_location_code: string;
+  product_id: string;
+  pallet_id: string;
+  from_bin_id: string;
+  to_bin_id: string;
+  quantity: number;
+  lot_number: string;
+  created_at: string;
+  user_email: string;
+  action: LocationActivityType;
+  product?: Product;
+  reference_number?: string;
+}

package/src/warehouse/locationItem.ts

@@ -0,0 +1,33 @@
+import { Product } from "./product";
+import { Location } from "./location";
+import { Pallet } from "./pallet";
+import { Bin } from "./bin";
+import { ManualItem } from "./manualItem";
+
+export enum LocationItemStatus {
+  DAMAGED = "DAMAGED",
+  NORMAL = "NORMAL",
+}
+
+export interface LocationItem {
+  id: string;
+  lot_number?: string;
+  quantity: number;
+  product_id?: string;
+  product?: Product;
+  manual_item_id?: string;
+  manual_item?: ManualItem;
+  location_code: string;
+  location?: Location;
+  pallet_id: string;
+  pallet?: Pallet;
+  bin_id: string;
+  bin: Bin;
+  created_at: string;
+  updated_at: string;
+  status: LocationItemStatus;
+}
+
+export interface ItemMoveLocationValidation {
+  multiple_bins: boolean;
+}

package/src/warehouse/locationTemplate.ts

@@ -0,0 +1,8 @@
+import { Location } from "./location";
+
+export interface LocationTemplate {
+  id: string;
+  format: string;
+  name: string;
+  locations?: Location[];
+}

package/src/warehouse/manualItem.ts

@@ -0,0 +1,21 @@
+import { Organization } from "./organization";
+
+export type ManualItemType =
+  | "structube_pallet"
+  | "ikea_pallet"
+  | "rove_pallet"
+  | "storage"
+  | "other";
+
+export interface ManualItem {
+  id: string;
+  code: string;
+  type: ManualItemType;
+  customer_name: string;
+  order_number?: string;
+  note?: string;
+  created_at: string;
+  updated_at: string;
+  organization?: Organization;
+  organization_id?: 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

@@ -0,0 +1,39 @@
+import { Product } from "./product";
+import { Supply } from "./supply";
+import { ShipmentProductsTracking } from "./shipmentProductsTracking";
+import { FacilityCode } from "../_common";
+
+export interface Organization {
+  id: string;
+  name: string;
+  products?: Product[];
+  supplies?: Supply[];
+  shipment_products_trackings?: ShipmentProductsTracking[];
+}
+
+export enum OrganizationConfigKey {
+  ENABLE_SCAN_ITEMS = "ENABLE_SCAN_ITEMS",
+  OPENED_GOOD_CONDITION_SHIP_TO_ADDRESS = "OPENED_GOOD_CONDITION_SHIP_TO_ADDRESS",
+  SHIP_TO_ME = "SHIP_TO_ME",
+  OPENED_GOOD_CONDITION_INSTRUCTION = "OPENED_GOOD_CONDITION_INSTRUCTION",
+  DAMAGED_CONDITION_INSTRUCTION = "DAMAGED_CONDITION_INSTRUCTION",
+  GOOD_CONDITION_DAMAGED_PACKAGING_INSTRUCTION = "GOOD_CONDITION_DAMAGED_PACKAGING_INSTRUCTION",
+  RTS_INSTRUCTION = "RTS_INSTRUCTION",
+  ENABLE_SEND_EMAIL_TO_CUSTOMERS = "ENABLE_SEND_EMAIL_TO_CUSTOMERS",
+}
+export interface OrganizationConfig {
+  id: string;
+  key: OrganizationConfigKey;
+  value: string;
+  organization_id: string;
+  organization?: Organization;
+  created_at: string;
+  updated_at: string;
+}
+
+export interface FacilityOrganization {
+  id: string;
+  organization_id: string;
+  facility: FacilityCode;
+  organization?: Organization;
+}

package/src/warehouse/packerActivityLog.ts

@@ -0,0 +1,16 @@
+export enum PackerActivityType {
+  COMPLETE = "COMPLETE",
+  ADD = "ADD",
+  REMOVE = "REMOVE",
+}
+
+export interface PackerActivityLog {
+  id: string;
+  user_email: string;
+  shipment_id: string;
+  shipment_number: string;
+  external_order_id: string;
+  external_order_number: string;
+  created_at: string;
+  action: PackerActivityType;
+}

package/src/warehouse/pallet.ts

@@ -1,20 +1,14 @@
-import { WarehouseItemLocation } from "./warehouseItem";
+import { FacilityCode } from "../_common";
+import { LocationItem } from "./locationItem";
 
-export interface PalletItem {
-  description: string;
-  external_item_id: string;
-  external_item_type: string;
-  id: string;
-  item_code: string;
-  name: string;
-  size: string;
+export enum PalletType {
+  SINGLE = "single",
+  DOUBLE = "double",
 }
 export interface Pallet {
   id: string;
-  kind: "standard" | "double";
-  height: number;
-  locations: WarehouseItemLocation[];
-  created_at: string;
-  updated_at: string;
-  items: PalletItem[];
+  type: PalletType;
+  location_items?: LocationItem[];
+  facility: FacilityCode | null;
+  container_request_log_id?: string;
 }

package/src/warehouse/picksheet.ts

@@ -0,0 +1,98 @@
+import { FacilityCode } from "../_common";
+import { Organization } from "./organization";
+
+export type PicksheetOrganization = {
+  name: string;
+  id: string;
+};
+
+export type PicksheetFailedReasons = {
+  order_number?: string;
+  external_order_number?: string;
+  failed_reason: string;
+};
+
+export type PicksheetStats = {
+  organization?: PicksheetOrganization;
+  ready_to_fulfill_count: number;
+  processing_items_count: number;
+};
+
+export enum PicksheetStatus {
+  IN_PROGRESS = "IN_PROGRESS",
+  COMPLETED = "COMPLETED",
+}
+
+export enum InflationStatus {
+  INFLATING = "INFLATING",
+  INFLATED = "INFLATED",
+  FAILED = "FAILED",
+}
+
+export enum PicksheetRequestType {
+  DISCRETE = "DISCRETE",
+  WAVE = "WAVE",
+}
+
+export enum PicksheetType {
+  PARCEL = "PARCEL",
+  LAST_MILE = "LAST_MILE",
+}
+
+export type Picksheet = {
+  id: string;
+  request_id: string;
+  external_order_id: string;
+  external_order_number?: string;
+  inflation_status?: InflationStatus;
+  order_id?: string;
+  shipment_id?: string;
+  shipment_number?: string;
+  failed_reason?: string;
+  created_at: string;
+  updated_at: string;
+  wavesheet_id?: string;
+  request?: PicksheetRequest;
+  picksheet_items?: PicksheetItem[];
+  type: PicksheetType;
+};
+
+export type PicksheetItem = {
+  id: string;
+  picksheet_id: string;
+  picksheet: Picksheet;
+  sku: string;
+  upc: string;
+  name: string;
+  quantity: number;
+  picked_quantity: number;
+  manual_item_code?: string;
+  manual_item_customer_name?: string;
+};
+
+export type PicksheetRequest = {
+  id: string;
+  organization_id: string;
+  organization?: Organization;
+  facility: FacilityCode;
+  status: PicksheetStatus;
+  number_of_picksheets: number;
+  requested_by: string;
+  created_at: string;
+  updated_at: string;
+  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/product.ts

@@ -0,0 +1,17 @@
+import { LocationItem } from "./locationItem";
+import { Organization } from "./organization";
+import { LocationActivityLog } from "./locationActivityLog";
+
+export interface Product {
+  id: string;
+  sku: string;
+  upc: string;
+  name: string;
+  organization_id: string;
+  organization?: Organization;
+  location_item?: LocationItem;
+  location_activity_log?: LocationActivityLog;
+  profiled: boolean;
+  created_at: string;
+  updated_at: string;
+}