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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondcloset/types",
-  "version": "2.17.17-beta-containerTypes-5",
+  "version": "3.0.0",
   "description": "secondcloset type declaration and definitions",
   "main": "src/index.ts",
   "scripts": {
@@ -19,6 +19,6 @@
   },
   "homepage": "https://github.com/SecondCloset/types#readme",
   "devDependencies": {
-    "typescript": "^3.9.5"
+    "typescript": "^4.6.3"
   }
 }

package/src/_common/activityHistory.ts

@@ -1,10 +1,18 @@
-export type ActivityEvent = "all" | "asn" | "order" | "manual" | "system";
+export type ActivityEvent =
+  | "all"
+  | "asn"
+  | "inventory_channel_transfer"
+  | "order"
+  | "manual"
+  | "rma"
+  | "system";
 export interface ActivityHistory {
   id: string;
   user?: {
     id: string;
     name?: string;
     is_admin: boolean;
+    is_customer: boolean;
   };
   description: string[];
   organization_name?: string;

package/src/_common/facility.ts

@@ -1,3 +1,5 @@
+import { Version } from ".";
+import { Common } from "..";
 import { ServiceArea } from "./serviceArea";
 
 export type FacilityCode =
@@ -5,13 +7,19 @@ export type FacilityCode =
   | "yyz2"
   | "yyz3"
   | "yyz4"
+  | "yyz5"
   | "yvr1"
   | "yvr2"
   | "yow1"
   | "yul1"
   | "lax1"
   | "lax2"
-  | "yyz5"
+  | "nyc1"
+  | "mia1"
+  | "hou1"
+  | "yyc1"
+  | "atl1"
+  | "atl2"
   | "unknown";
 
 export type DeprecatedFacilityCode = "yyz1" | "yyz2";
@@ -19,25 +27,48 @@ export type DeprecatedFacilityCode = "yyz1" | "yyz2";
 export type FacilityCity =
   | "Toronto"
   | "Mississauga"
+  | "Markham"
   | "Vancouver"
   | "Ottawa"
   | "Montreal"
-  | "Los Angeles"
-  | "Markham";
+  | "Buena Park"
+  | "Santa Fe Springs"
+  | "Carlstadt"
+  | "Medley"
+  | "Houston"
+  | "Tucker"
+  | "Newnan"
+  | "Calgary";
 
-export interface Facility {
-  id: number;
-  name: FacilityCode;
-  phone: string;
-  email: string;
-  address: {
-    table: {
-      street: string;
-      city: FacilityCity;
-      province: string;
-      country: string;
-      postal_code: string;
+export type Facility<V = Version> = V extends "V1"
+  ? {
+      id: number;
+      name: FacilityCode;
+      phone: string;
+      email: string;
+      address: {
+        table: {
+          street: string;
+          city: FacilityCity;
+          province: string;
+          country: string;
+          postal_code: string;
+        };
+      };
+      service_area: ServiceArea;
+    }
+  : {
+      id: string;
+      name: FacilityCode;
+      enabled: boolean;
+      service_area: ServiceArea;
+      address: {
+        street: string;
+        city: string;
+        province: string;
+        country: string;
+        postal_code: string;
+      };
+      created_at: string;
+      updated_at: string;
     };
-  };
-  service_area: ServiceArea;
-}

package/src/_common/index.ts

@@ -1,3 +1,4 @@
+export type Version = "V1" | "V2";
 export * from "./facility";
 export * from "./serviceArea";
 export * from "./user";
@@ -7,4 +8,4 @@ export * from "./organization";
 export * from "./credential";
 export * from "./file";
 export * from "./note";
-export * from "./activityHistory";
+export * from "./activityHistory";

package/src/_common/organization.ts

@@ -2,19 +2,31 @@ import { BaseImage } from "./image";
 import { BaseAddress } from "./address";
 import { BaseUser } from "./user";
 import { Carrier } from "../fulfillment";
-import { ServiceArea } from "./serviceArea";
+import { Facility } from "./facility";
 
 export type OrganizationConfigKey =
   | "default_fulfilled_from"
   | "auto_fulfill_orders"
   | "freightcom_api_username"
-  | "freightcom_api_password";
+  | "freightcom_api_password"
+  | "preferred_return_facility"
+  | "disable_partial_fulfillment"
+  | "use_default_facility_for_partial_fallback";
 
 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;
@@ -68,26 +80,17 @@ 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[];
+  default_fulfilled_from?: {
+    facility: Facility<"V2">;
+    organization_regions: Region;
+  }[];
+  employer_identification_number?: string;
 }
 
-interface Facility {
-  id: string;
-  name: string;
-  enabled: boolean;
-  service_area: ServiceArea;
-  address: {
-    street: string;
-    city: string;
-    province: string;
-    country: string;
-    postal_code: string;
-  };
-  created_at: string;
-  updated_at: string;
-}
 export interface Region {
   id?: string;
   region_code: string;
@@ -96,7 +99,7 @@ export interface Region {
   country_name: string;
 }
 export interface FacilityServiceArea {
-  facility: Facility;
+  facility: Facility<"V2">;
   default_regions: Region[];
   organization_regions: Region[];
 }

package/src/_common/serviceArea.ts

@@ -1 +1,11 @@
-export type ServiceArea = "yyz" | "yvr" | "yow" | "yul" | "lax";
+export type ServiceArea =
+  | "yyz"
+  | "yvr"
+  | "yow"
+  | "yul"
+  | "lax"
+  | "nyc"
+  | "mia"
+  | "hou"
+  | "yyc"
+  | "atl";

package/src/_common/user.ts

@@ -19,6 +19,7 @@ export interface User extends BaseUser {
   orders: number;
   organization_id: string;
   organization_role: string;
+  organization_role_id: string;
   payment_issue: boolean | null;
   stripe_customer_id: string;
   subrole: string;

package/src/fulfillment/appointment/appointment.ts

@@ -1,4 +1,9 @@
-import { AppointmentType, AppointmentSubtype } from "./appointmentType";
+import {
+  AppointmentType,
+  AppointmentSubtype,
+  DeliveryType,
+  ParcelServiceLevel,
+} from "./appointmentType";
 import { AppointmentStatus } from "./appointmentStatus";
 import { Shipment, ScServiceCode } from "../shipment";
 import { Order } from "../order";
@@ -6,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;
@@ -18,6 +24,10 @@ export interface Appointment {
   driver_id: string | null;
   end_time: string | null;
   estimated_time: number;
+  facility?: {
+    name: string;
+    street: string;
+  };
   failed_notes: string | null;
   failed_reason: string | null;
   field_ops_notes?: BaseNote[];
@@ -31,6 +41,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;
@@ -56,6 +67,26 @@ export interface Appointment {
   user_id: string;
   user_lastname: string;
   verification_images?: BaseImage[];
+  delivery_type?: DeliveryType;
+  shipping_labels?: LastMileShippingLabel[];
+  signature_required?: boolean;
+  estimated_arrival_time_window_start: string;
+  estimated_arrival_time_window_end: string;
+  package_weights: {
+    weight_unit: "lb" | "kg";
+    weight_value: number;
+  }[] | null;
+  delivery_notes: DeliveryNote[];
+}
+
+export interface DeliveryNote {
+  id: string;
+  appointment_id: string;
+  details: string | null;
+  access: string | null;
+  created_at: string;
+  updated_at: string;
+  deleted_at: string | null;
 }
 
 export interface Location {
@@ -76,3 +107,11 @@ export interface Location {
   service_area: ServiceArea | null;
   updated_at: string;
 }
+
+interface LastMileShippingLabel {
+  id: string;
+  label_id?: string;
+  tracking_number?: string;
+  tracking_url?: string;
+  label_download?: string;
+}

package/src/fulfillment/appointment/appointmentType.ts

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

@@ -1,4 +1,5 @@
 import { FacilityCode } from "../../_common/facility";
+import { Channel } from "../inventory";
 import { ASNItem } from "./asnItem";
 
 export type ASNStatus =
@@ -65,4 +66,6 @@ export interface ASN {
   deleted_at?: string;
   items_attributes: ASNItem[];
   timeline?: TimelineEvent[];
+  organization_id?: string;
+  inventory_channel?: Channel["name"];
 }

package/src/fulfillment/asn/asnItem.ts

@@ -5,10 +5,13 @@ export interface ASNItem {
   product_sku: string;
   product_upc?: string;
   product_scid: string;
+  product_tracks_lot_numbers?: boolean;
+  product_tracks_expiry_date?: boolean;
   expected_quantity: number;
   received_quantity?: number;
   damaged_quantity?: number;
   lot_number?: string;
+  expiry_date?: string;
   created_at: string;
   updated_at: string;
   deleted_at: string;

package/src/fulfillment/index.ts

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

package/src/fulfillment/inventory/channel.ts

@@ -0,0 +1,9 @@
+import { Organization } from "../../_common";
+
+export interface Channel {
+  id: string;
+  name: string;
+  default: boolean;
+  priority: number;
+  organization_id: Organization["id"];
+}

package/src/fulfillment/inventory/index.ts

@@ -0,0 +1,2 @@
+export * from "./inventory";
+export * from "./channel";

package/src/fulfillment/inventory/inventory.ts

@@ -0,0 +1,16 @@
+import { Product } from "../product";
+
+type InventoryOrder = { id: string; order_id: string; quantity: number };
+export interface Inventory {
+  product_id: Product["id"];
+  available_for_sale: number;
+  on_hand: number;
+  reserved: number;
+  to_be_reserved: number;
+  on_hold: number;
+  damaged: number;
+  backorder: number;
+  incoming: number;
+  reserved_orders: InventoryOrder[];
+  orders_to_be_reserved: InventoryOrder[];
+}

package/src/fulfillment/order/order.ts

@@ -6,8 +6,10 @@ import {
   BaseUser,
   Organization,
   File,
+  Version,
 } from "../../_common";
 import { OrderItem } from "./orderItem";
+import { Channel } from "../inventory";
 
 export type ShipmentTag =
   | "ready_to_fulfill"
@@ -16,10 +18,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"
@@ -30,7 +36,7 @@ export type OrderPlatform =
   | "shipstaion"
   | "external_api";
 
-interface Address extends BaseAddress {
+export interface FulfillmentOrderAddress extends BaseAddress {
   customer_id: string;
   contact_name: string;
   customer_phone_number: string | null;
@@ -40,40 +46,44 @@ interface Address 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: Address;
-  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;
-}
+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;
+      sales_channel?: Channel["name"];
+    }
+  : Omit<Order<"V1">, "items" | "shipments">;

package/src/fulfillment/order/orderItem.ts

@@ -1,16 +1,36 @@
-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"][];
+        reverse_logistics_item_ids: OrderItem<"V1">["id"][];
+        setup_item_ids: OrderItem<"V1">["id"][];
+      };
+      removed_items: {
+        removed_reason: string;
+        quantity: number;
+      }[];
+    };

package/src/fulfillment/product/product.ts

@@ -3,14 +3,22 @@ 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;
+  height: number;
+  length: number;
+  width: number;
+  weight: number;
+}
+
+export interface Product extends Omit<BaseProduct, "type"> {
+  organization_id: string;
   description: string;
   platform: string;
-  active: boolean;
   fragile: boolean;
   dangerous: boolean;
   liquid: boolean;
@@ -18,10 +26,6 @@ export interface BaseProduct {
   tracks_lot_numbers: boolean;
   contains_battery: boolean;
   external_product_id: string | null;
-  height: number;
-  length: number;
-  width: number;
-  weight: number;
   weight_unit: string;
   usd_value: number;
   value: number;
@@ -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;
@@ -54,23 +58,18 @@ export interface BaseProduct {
   return_days?: number;
   insurance_required: boolean;
   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;
+    tracks_expiry_date: boolean;
   };
   level: "single_item" | "inner_pack" | "master_pack" | "pallet";
   base_product_quantity: number;

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/resourceError/index.ts

@@ -0,0 +1,2 @@
+export * from "./resourceError";
+export * from "./resourceErrorAssignee";

package/src/fulfillment/resourceError/resourceError.ts

@@ -0,0 +1,20 @@
+import { ResourceErrorAssignee } from "./resourceErrorAssignee";
+
+export type ResourceErrorType = "order" | "product";
+
+export interface ResourceError {
+  id: string;
+  resource_id: string;
+  resource_type: ResourceErrorType;
+  normalized_resource_type: ResourceErrorType;
+  issue: string;
+  issue_reason: string;
+  issue_category: string;
+  origin: string;
+  created_at: string;
+  updated_at: string;
+  caused_by_id?: string;
+  caused_by_type?: string;
+  assignee?: ResourceErrorAssignee | null;
+  deleted_at?: string | null;
+}

package/src/fulfillment/resourceError/resourceErrorAssignee.ts

@@ -0,0 +1,9 @@
+export interface ResourceErrorAssignee {
+  id: string;
+  first_name: string;
+  last_name: string;
+  user_code: string;
+  email: string;
+  role: string;
+  phone_number: string;
+}