@secondcloset/types 2.5.8-beta-epic29357-0

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "firstname"
+  ]
+}

package/README.md

@@ -0,0 +1,13 @@
+
+
+# Install
+`npm i @secondcloset/types`
+
+# Usage 
+```
+import { Storage, Fulfillment, Warehouse, Common } from "@secondcloset/types" 
+type Appointment = Storage.Appointment;
+type Order = Storage.Order;
+...
+type Order = Fulfillment.Order;
+```

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@secondcloset/types",
+  "version": "2.5.8-beta-epic29357-0",
+  "description": "secondcloset type declaration and definitions",
+  "main": "src/index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SecondCloset/types.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/SecondCloset/types/issues"
+  },
+  "homepage": "https://github.com/SecondCloset/types#readme",
+  "devDependencies": {
+    "typescript": "^3.9.5"
+  }
+}

package/src/_common/address.ts

@@ -0,0 +1,19 @@
+import { ServiceArea } from "./serviceArea";
+
+export interface Coordinates {
+  lat: number;
+  lng: number;
+}
+
+export interface BaseAddress {
+  id: string;
+  apartment_number: string | null;
+  address: string;
+  city: string;
+  province: string;
+  country: string;
+  postal_code: string;
+  phone_number: string;
+  coordinates: Coordinates;
+  service_area: ServiceArea | null;
+}

package/src/_common/credential.ts

@@ -0,0 +1,12 @@
+import { User } from "./user";
+
+interface Token {
+  token: string;
+  created_at: string;
+}
+
+export interface Credential {
+  token?: Token;
+  user?: User;
+  rememberMe?: boolean;
+}

package/src/_common/facility.ts

@@ -0,0 +1,38 @@
+import { ServiceArea } from "./serviceArea";
+
+export type FacilityCode =
+  | "yyz1"
+  | "yyz2"
+  | "yyz3"
+  | "yyz4"
+  | "yvr1"
+  | "yvr2"
+  | "yow1"
+  | "yul1"
+  | "unknown";
+
+export type DeprecatedFacilityCode = "yyz1" | "yyz2";
+
+export type FacilityCity =
+  | "Toronto"
+  | "Mississauga"
+  | "Vancouver"
+  | "Ottawa"
+  | "Montreal";
+
+export interface Facility {
+  id: number;
+  name: FacilityCode;
+  phone: string;
+  email: string;
+  address: {
+    table: {
+      street: string;
+      city: FacilityCity;
+      province: string;
+      country: string;
+      postal_code: string;
+    };
+  };
+  service_area: ServiceArea;
+}

package/src/_common/file.ts

@@ -0,0 +1,7 @@
+export interface File {
+  access: string;
+  created_at: string;
+  id: string;
+  updated_at: string;
+  url: string;
+}

package/src/_common/image.ts

@@ -0,0 +1,7 @@
+export interface BaseImage {
+  id: string;
+  url: string;
+  created_at: string;
+  updated_at: string;
+  access: "external" | "internal";
+}

package/src/_common/index.ts

@@ -0,0 +1,9 @@
+export * from "./facility";
+export * from "./serviceArea";
+export * from "./user";
+export * from "./address";
+export * from "./image";
+export * from "./organization";
+export * from "./credential";
+export * from "./file";
+export * from "./note";

package/src/_common/note.ts

@@ -0,0 +1,9 @@
+import { BaseUser } from "./";
+
+export interface BaseNote {
+  created_at: string;
+  id: string;
+  text: string;
+  updated_at: string;
+  user: BaseUser;
+}

package/src/_common/organization.ts

@@ -0,0 +1,63 @@
+import { BaseImage } from "./image";
+import { BaseAddress } from "./address";
+import { BaseUser } from "./user";
+import { Carrier } from "../fulfillment";
+
+export type OrganizationConfigKey =
+  | "default_fulfilled_from"
+  | "auto_fulfill_orders";
+
+export interface OrganizationConfig {
+  key: OrganizationConfigKey;
+  value: string;
+}
+
+export interface Permission {
+  id: string;
+  name: string;
+}
+
+export interface OrganizationAddress extends BaseAddress {
+  building_type: string;
+  care_of: string;
+  elevator_access: boolean;
+  is_primary: boolean;
+  partner_name: string;
+}
+
+export interface GeofilterConstraint {
+  country: string;
+  provinces: string[];
+}
+
+export interface SCServiceTier {
+  threshold?: boolean;
+  room_of_choice?: boolean;
+  white_glove?: boolean;
+  to_the_door?: boolean;
+}
+
+export interface BaseOrganization {
+  created_at: string;
+  email: string;
+  id: string;
+  name: string;
+  packing_notes: string;
+  phone_number: string;
+  logo?: BaseImage;
+}
+
+export interface Organization extends BaseOrganization {
+  addresses: OrganizationAddress[];
+  carriers: Carrier[];
+  users: BaseUser[];
+  recommended_shipping_methods?: {
+    parcel: boolean;
+    freight: boolean;
+    sc_last_mile: boolean;
+    sc_service_tier?: SCServiceTier;
+  };
+  configurations_attributes: OrganizationConfig[];
+  permissions: Permission[];
+  geofilter_constraints?: GeofilterConstraint[];
+}

package/src/_common/serviceArea.ts

@@ -0,0 +1 @@
+export type ServiceArea = "yyz" | "yvr" | "yow" | "yul";

package/src/_common/user.ts

@@ -0,0 +1,26 @@
+export interface BaseUser {
+  id: string;
+  first_name: string;
+  last_name: string;
+  user_code: string;
+  email: string;
+  role: string;
+  phone_number: string | null;
+}
+
+export interface User extends BaseUser {
+  business_name: string | null;
+  business_type: string | null;
+  business_user: boolean;
+  closets: number;
+  confirmed: boolean;
+  created_at: string;
+  legacy: boolean;
+  orders: number;
+  organization_id: string;
+  organization_role: string;
+  payment_issue: boolean | null;
+  stripe_customer_id: string;
+  subrole: string;
+  updated_at: string;
+}

package/src/fulfillment/appointment/appointment.ts

@@ -0,0 +1,77 @@
+import { AppointmentType } from "./appointmentType";
+import { AppointmentStatus } from "./appointmentStatus";
+import { Shipment, ScServiceCode } from "../shipment";
+import { Order } from "../order";
+import { AppointmentSlot } from "../../storage";
+import { BaseImage, BaseNote } from "../../_common";
+
+export interface Appointment {
+  appointment_actions: string[];
+  arrived_time: string | null;
+  cancelled_at: string | null;
+  completed_at: string | null;
+  claim_number?: string;
+  created_at: string;
+  customer_segment: "business";
+  date: string;
+  delivery_service_level?: ScServiceCode;
+  driver_id: string | null;
+  end_time: string | null;
+  estimated_time: number;
+  failed_notes: string | null;
+  failed_reason: string | null;
+  field_ops_notes?: BaseNote[];
+  formatted_timeslot: string | null;
+  id: string;
+  incomplete_at: string | null;
+  issue_images?: BaseImage[];
+  job_type: AppointmentType;
+  location: Location;
+  movers: null;
+  num_movers: null;
+  number: string;
+  range_of_days_assigned_dates?: {
+    assigned_start_datetime: string;
+    assigned_end_datetime: string;
+  } | null;
+  range_of_days_start_date?: string | null;
+  range_of_days_end_date?: string | null;
+  rescheduled: boolean;
+  rescheduled_appointment_id: string | null;
+  shipment: Partial<Shipment>;
+  signature_image: any;
+  signature_url: string | null;
+  signed_at: string | null;
+  sms: boolean;
+  source: Partial<Order>;
+  start_time: string | null;
+  status: AppointmentStatus;
+  timerange: AppointmentSlot;
+  type: "fulfillment";
+  updated_at: string;
+  user_code: string;
+  user_email: string;
+  user_firstname: string;
+  user_id: string;
+  user_lastname: string;
+  verification_images?: BaseImage[];
+}
+
+export interface Location {
+  address: string;
+  cell_phone_number: string | null;
+  city: string;
+  contact_name: string;
+  coordinates: { lat: number; lng: number };
+  country: string;
+  created_at: string;
+  customer_id: string;
+  customer_phone_number: string;
+  evening_phone_number: string | null;
+  id: string;
+  phone_number: string;
+  postal_code: string;
+  province: string;
+  service_area: "yyz" | "yvr" | "yow" | "yul" | null;
+  updated_at: string;
+}

package/src/fulfillment/appointment/appointmentStatus.ts

@@ -0,0 +1,21 @@
+export type AppointmentStatus =
+  | "request_received"
+  | "confirmed"
+  | "shipment_created"
+  | "fulfillment"
+  | "ready"
+  | "loaded"
+  | "cancelled"
+  | "scheduled"
+  | "fulfilled"
+  | "on_the_way"
+  | "active"
+  | "done"
+  | "staging"
+  | "completed"
+  | "completed_with_exceptions"
+  | "started"
+  | "arrived"
+  | "incomplete"
+  | "failed"
+  | "no_show";

package/src/fulfillment/appointment/appointmentType.ts

@@ -0,0 +1,7 @@
+export type AppointmentType =
+  | "reverse_logistics"
+  | "inventory_pick_up"
+  | "delivery"
+  | "cross_dock_delivery"
+  | "return_to_sender"
+  | "inventory_warehouse_receiving";

package/src/fulfillment/appointment/index.ts

@@ -0,0 +1,3 @@
+export * from "./appointment";
+export * from "./appointmentStatus";
+export * from "./appointmentType";

package/src/fulfillment/asn/asn.ts

@@ -0,0 +1,68 @@
+import { FacilityCode } from "../../_common/facility";
+import { ASNItem } from "./asnItem";
+
+export type ASNStatus =
+  | "draft"
+  | "awaiting"
+  | "arrived"
+  | "on_hold"
+  | "completed";
+
+export type ASNShipmentType =
+  | "parcel"
+  | "pallet"
+  | "container"
+  | "floor_loaded"
+  | "drop_off";
+
+export type ASNPalletPackingOption =
+  | "one_sku_per_pallet"
+  | "multiple_sku_per_pallet";
+
+export type ASNBoxPackingOption = "one_sku_per_box" | "multiple_sku_per_box";
+
+export interface AsnBol {
+  access: "external" | "internal";
+  created_at: string;
+  id: string;
+  updated_at: string;
+  url: string;
+}
+
+export interface TimelineEvent {
+  user_name: string;
+  user_is_admin: boolean;
+  event: string;
+  description: string;
+  created_at: string;
+}
+
+export interface ASN {
+  id: string;
+  status: ASNStatus;
+  number: string;
+  facility?: FacilityCode;
+  submitted_date?: string;
+  expected_arrival_date?: string;
+  actual_arrival_date?: string;
+  reference_number?: string;
+  po_number?: string;
+  container_size?: string;
+  box_packing_option?: ASNBoxPackingOption;
+  pallet_packing_option?: ASNPalletPackingOption;
+  shipment_type?: ASNShipmentType;
+  internal_notes?: string;
+  qty_under_received?: boolean;
+  qty_over_received?: boolean;
+  box_expected_quantity?: number;
+  box_received_quantity?: number;
+  pallet_expected_quantity?: number;
+  pallet_received_quantity?: number;
+  bols_attributes: AsnBol[];
+  current_step?: string;
+  created_at: string;
+  updated_at: string;
+  deleted_at?: string;
+  items_attributes: ASNItem[];
+  timeline?: TimelineEvent[];
+}

package/src/fulfillment/asn/asnItem.ts

@@ -0,0 +1,15 @@
+export interface ASNItem {
+  id: string;
+  product_id: string;
+  product_name: string;
+  product_sku: string;
+  product_upc?: string;
+  product_scid: string;
+  expected_quantity: number;
+  received_quantity?: number;
+  damaged_quantity?: number;
+  lot_number?: string;
+  created_at: string;
+  updated_at: string;
+  deleted_at: string;
+}

package/src/fulfillment/asn/index.ts

@@ -0,0 +1,2 @@
+export * from "./asn";
+export * from "./asnItem";

package/src/fulfillment/index.ts

@@ -0,0 +1,6 @@
+export * from "./shipment";
+export * from "./product";
+export * from "./order";
+export * from "./appointment";
+export * from "./warehouseReceivingOrder";
+export * from "./asn";

package/src/fulfillment/order/customer.ts

@@ -0,0 +1,23 @@
+import { BaseAddress } from "../../_common";
+
+export interface Customer {
+  id: string;
+  user_id: string;
+  organization_id: string;
+  name: string;
+  email_address: string;
+  phone_number?: string;
+  created_at: string;
+  updated_at: string;
+  addresses?: CustomerAddress[];
+}
+
+export interface CustomerAddress extends BaseAddress {
+  cell_phone_number: string | null;
+  contact_name: string;
+  created_at: string;
+  customer_id: string;
+  customer_phone_number: string;
+  evening_phone_number: string | null;
+  updated_at: string;
+}

package/src/fulfillment/order/index.ts

@@ -0,0 +1,3 @@
+export * from "./customer";
+export * from "./orderItem";
+export * from "./order";

package/src/fulfillment/order/order.ts

@@ -0,0 +1,79 @@
+import { Shipment, ScServiceCode } from "../shipment/shipment";
+import { Customer } from "./customer";
+import {
+  FacilityCode,
+  BaseAddress,
+  BaseUser,
+  Organization,
+  File,
+} from "../../_common";
+import { OrderItem } from "./orderItem";
+
+export type ShipmentTag =
+  | "ready_to_fulfill"
+  | "unfulfilled_items"
+  | "processing_items"
+  | "items_fulfilled"
+  | "processing_return_items"
+  | "items_returned"
+  | "items_removed"
+  | "pending_inventory_receiving"
+  | "items_partially_fulfilled"
+  | "customer_booking";
+
+export type OrderPlatform =
+  | "manual"
+  | "csv"
+  | "shopify"
+  | "centiro"
+  | "woo_commerce"
+  | "shipstaion"
+  | "external_api";
+
+interface Address extends BaseAddress {
+  customer_id: string;
+  contact_name: string;
+  customer_phone_number: string | null;
+  evening_phone_number: string | null;
+  cell_phone_number: string | null;
+  created_at: string;
+  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;
+}

package/src/fulfillment/order/orderItem.ts

@@ -0,0 +1,16 @@
+import { 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;
+}

package/src/fulfillment/product/index.ts

@@ -0,0 +1,2 @@
+export * from "./product";
+export * from "./stock";

package/src/fulfillment/product/product.ts

@@ -0,0 +1,86 @@
+import { Stock } from "./stock";
+import { BaseImage } from "../../_common";
+
+export interface BaseProduct {
+  id: string;
+  organization_id: string;
+  scid: string;
+  sku: string;
+  upc: string;
+  name: string;
+  description: string;
+  platform: string;
+  active: boolean;
+  fragile: boolean;
+  dangerous: boolean;
+  liquid: boolean;
+  digital: boolean;
+  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;
+  cost: number;
+  wholesale_price: number;
+  retail_price: number;
+  hs_tariff_code: string;
+  customs_description: string | null;
+  images: BaseImage[];
+  packaging_criteria: string;
+  product_type: "base" | "kit";
+  stocks?: Stock[];
+  deleted_at: string;
+  created_at: string;
+  updated_at: string;
+  virtual_kits?: {
+    id: string;
+    organization_id: string;
+    scid: string;
+    sku: string;
+    name: string;
+    quantity_per_kit: number;
+    deleted_at: string | null;
+    created_at: string;
+    updated_at: string;
+    product_type: string;
+  }[];
+  required_parts?: { [productID: string]: number };
+  packaging_levels?: PackagingLevel[];
+  return_days?: number;
+}
+
+export interface Product extends BaseProduct {
+  base_products?: BaseProduct[];
+}
+
+export interface PackagingLevel {
+  id?: string;
+  product_id?: string;
+  product: {
+    id: string;
+    sku: string;
+    scid: string;
+    name: string;
+    tracks_lot_numbers: boolean;
+  };
+  level: "single_item" | "inner_pack" | "master_pack" | "pallet";
+  base_product_quantity: number;
+  sku: string;
+  name?: string;
+  description: string;
+  weight_value: string;
+  weight_unit: "lb" | "kg" | "g" | "mg" | "oz";
+  length_value: string;
+  length_unit: "m" | "in" | "ft" | "yd" | "mi";
+  height_value: string;
+  height_unit: "m" | "in" | "ft" | "yd" | "mi";
+  width_value: string;
+  width_unit: "m" | "in" | "ft" | "yd" | "mi";
+  created_at: string;
+  updated_at: string;
+}