@secondcloset/types 2.5.8-beta-epic29357-0

package/src/storage/index.ts

@@ -0,0 +1,8 @@
+export * from "./address";
+export * from "./appointment";
+export * from "./order";
+export * from "./availability";
+export * from "./categoryItem";
+export * from "./closet";
+export * from "./inventoryItem";
+export * from "./product";

package/src/storage/inventoryItem.ts

@@ -0,0 +1,41 @@
+import { CategoryItem } from "./categoryItem";
+import { BaseUser, BaseImage } from "../_common";
+
+export interface InventoryItemImage extends BaseImage {
+  deleted_at: string;
+  resource_id: string;
+  resource_type: string;
+}
+
+export interface InventoryItem {
+  id: string;
+  status: string;
+  name: string;
+  nickname: string;
+  image_url: string;
+  item_id: string;
+  notes: string;
+  stripe_plan_id: string;
+  stripe_subscription_id: string;
+  stripe_subscription_item_id: string;
+  created_at: string;
+  description: string;
+  item_type: string;
+  last_pick_up_address_id: string;
+  last_drop_off_address_id: string;
+  closet_id: string;
+  barcode: string;
+  qr_code: string;
+  customer: BaseUser;
+  orders: any[];
+  images: InventoryItemImage[];
+  category_item: CategoryItem;
+  internal_status: string;
+  internal_notes: string;
+  admin_images: string;
+  has_parts: boolean;
+  material: string;
+  color: string;
+  size: string;
+  brand: string;
+}

package/src/storage/order/index.ts

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

package/src/storage/order/order.ts

@@ -0,0 +1,29 @@
+import { OrderItem } from "./orderItem";
+import { Appointment } from "../appointment";
+
+export interface Order {
+  id?: string;
+  number: string;
+  user_id: string;
+  kind: string;
+  temporary: boolean;
+  status: string;
+  created_at?: string;
+  updated_at?: string;
+  fragile: boolean;
+  heavy: boolean;
+  immediate: boolean;
+  notes?: string;
+  bulky_order_only: boolean;
+  billing_type: string;
+  space_order: boolean;
+  user_code: string;
+  subtotal: number;
+  tax_percentage: number;
+  total: number;
+  items: OrderItem[];
+  user_email: string;
+  user_firstname: string;
+  user_lastname: string;
+  appointments: Appointment[];
+}

package/src/storage/order/orderItem.ts

@@ -0,0 +1,26 @@
+export interface OrderItem {
+  name: string;
+  stripe_id: string;
+  quantity: number;
+  price: number;
+  recurring: true;
+  type: string;
+  item_type: string;
+  item_id: string;
+  description: string;
+  barcode: string;
+  category_id?: string;
+  category_name?: string;
+  category_description?: string;
+  category_volume?: string;
+  qr_code?: string;
+  status?: string;
+  internal_status: string;
+  nickname?: string;
+  material?: string;
+  color?: string;
+  size?: string;
+  brand?: string;
+  images: string[];
+  metadata?: any;
+}

package/src/storage/product.ts

@@ -0,0 +1,26 @@
+type TrueOrFalse = "true" | "false";
+
+interface Metadata {
+  group: string;
+  hidden: TrueOrFalse;
+  inStock: TrueOrFalse;
+  adminHidden: TrueOrFalse;
+  movingFees: TrueOrFalse;
+  images: string;
+  size: string;
+  spacePlan: TrueOrFalse;
+  dropoffable: TrueOrFalse;
+  retrievable: TrueOrFalse;
+  sierraHidden: TrueOrFalse;
+  webHidden: TrueOrFalse;
+  pricing_segment: string;
+  fr: string;
+}
+
+export interface Product {
+  id: string;
+  category: string;
+  name: string;
+  price: number;
+  metadata: Metadata;
+}

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,7 @@
+import { LocationItem } from "./locationItem";
+
+export interface Bin {
+  id: string;
+  location_items?: LocationItem[];
+  created_at: string;
+}

package/src/warehouse/index.ts

@@ -0,0 +1,17 @@
+export * from "./asnProcessLog";
+export * from "./bin";
+export * from "./location";
+export * from "./locationItem";
+export * from "./locationTemplate";
+export * from "./organization";
+export * from "./pallet";
+export * from "./product";
+export * from "./shipmentProductsTracking";
+export * from "./supply";
+export * from "./supplyStock";
+export * from "./supplyTransaction";
+export * from "./transaction";
+export * from "./palletRequestLog";
+export * from "./manualItem";
+export * from "./return";
+export * from "./stock";

package/src/warehouse/location.ts

@@ -0,0 +1,20 @@
+import { LocationTemplate } from "./locationTemplate";
+import { LocationItem } from "./locationItem";
+import { FacilityCode } from "../_common";
+
+export enum LocationType {
+  SHELF = "SHELF",
+  PACKING_STATION = "PACKING_STATION",
+  RACKING = "RACKING",
+  CART = "CART",
+  PALLET_ZONE = "PALLET_ZONE",
+}
+
+export interface Location {
+  code: string;
+  facility: FacilityCode;
+  type: LocationType;
+  location_template_id: string;
+  location_template?: LocationTemplate;
+  location_items?: LocationItem[];
+}

package/src/warehouse/locationItem.ts

@@ -0,0 +1,23 @@
+import { Product } from "./product";
+import { Location } from "./location";
+import { Pallet } from "./pallet";
+import { Bin } from "./bin";
+import { ManualItem } from "./manualItem";
+
+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;
+}

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,20 @@
+import { Organization } from "./organization";
+
+export type ManualItemType =
+  | "structube_pallet"
+  | "ikea_pallet"
+  | "rove_pallet"
+  | "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/organization.ts

@@ -0,0 +1,31 @@
+import { Product } from "./product";
+import { Supply } from "./supply";
+import { ShipmentProductsTracking } from "./shipmentProductsTracking";
+
+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;
+}

package/src/warehouse/pallet.ts

@@ -0,0 +1,11 @@
+import { LocationItem } from "./locationItem";
+
+export enum PalletType {
+  SINGLE = "single",
+  DOUBLE = "double",
+}
+export interface Pallet {
+  id: string;
+  type: PalletType;
+  location_items?: LocationItem[];
+}

package/src/warehouse/palletRequestLog.ts

@@ -0,0 +1,15 @@
+export enum PalletRequestStatus {
+  FAILED = "failed",
+  SUCCESS = "success",
+  IN_PROGRESS = "in_progress",
+}
+
+export interface PalletRequestLog {
+  id: string;
+  status: PalletRequestStatus;
+  user_email: string;
+  file_link?: string;
+  count: number;
+  fail_reason?: string;
+  created_at: string;
+}

package/src/warehouse/product.ts

@@ -0,0 +1,14 @@
+import { LocationItem } from "./locationItem";
+import { Organization } from "./organization";
+import { Transaction } from "./transaction";
+
+export interface Product {
+  id: string;
+  sku: string;
+  upc: string;
+  name: string;
+  organization_id: string;
+  organization?: Organization;
+  location_item?: LocationItem;
+  transaction?: Transaction;
+}

package/src/warehouse/return.ts

@@ -0,0 +1,78 @@
+import { Organization } from "./organization";
+
+export enum ReturnItemCondition {
+  RESELLABLE = "resellable",
+  UNSELLABLE = "unsellable",
+  OTHER = "other",
+}
+
+export enum ReturnType {
+  RTS = "RTS",
+  REGULAR = "REGULAR",
+}
+
+export enum ReturnStatus {
+  READY_TO_PROCESS = "READY_TO_PROCESS",
+  NEEDS_REVIEW = "NEEDS_REVIEW",
+  ARRIVED = "ARRIVED",
+  PROCESSING = "PROCESSING",
+  REQUESTED = "REQUESTED",
+  ON_HOLD = "ON_HOLD",
+  COMPLETED = "COMPLETED",
+  CANCELLED = "CANCELLED",
+  TO_BE_RESHIPPED = "TO_BE_RESHIPPED",
+}
+
+export interface ReturnPhoto {
+  id: string;
+  return_id?: string;
+  photo_link: string;
+}
+
+export interface ReturnItem {
+  id: string;
+  name: string;
+  external_product_id: string;
+  sku?: string;
+  upc?: string;
+  condition?: string;
+  condition_notes?: string;
+  reason?: string;
+  reason_notes?: string;
+}
+
+export interface ReturnAddress {
+  name: string;
+  phone_number: string;
+  address_1: string;
+  address_2?: string;
+  city: string;
+  province: string;
+  postal_code: string;
+  country: string;
+}
+
+export interface Return {
+  id: string;
+  rma?: string;
+  tracking_number?: string;
+  tracking_url?: string;
+  label_url?: string;
+  carrier_logo?: string;
+  external_order_number: string;
+  reship_external_order_number?: string;
+  status: ReturnStatus;
+  type: ReturnType;
+  shipping_from?: ReturnAddress;
+  carrier?: string;
+  organization: Organization;
+  photos?: ReturnPhoto[];
+  return_items?: ReturnItem[];
+  reason?: string;
+  reason_notes?: string;
+  external_notes?: string;
+  internal_notes?: string;
+  order_date?: string;
+  created_at: string;
+  updated_at: string;
+}

package/src/warehouse/shipmentProductsTracking.ts

@@ -0,0 +1,18 @@
+import { Organization } from "./organization";
+
+export interface ShipmentProductsTracking {
+  id: string;
+  external_shipment_id: string;
+  external_order_id: string;
+  external_product_id: string;
+  lot_number: string;
+  serial_number: string;
+  product_name?: string;
+  product_sku?: string;
+  product_upc?: string;
+  quantity: number;
+  organization_id: string;
+  organization?: Organization;
+  created_at: string;
+  user_email: string;
+}

package/src/warehouse/stock.ts

@@ -0,0 +1,7 @@
+import { Product } from "./product";
+import { FacilityCode } from "../_common";
+export interface Stock {
+  on_hand_quantity: number;
+  product: Product;
+  facility: FacilityCode;
+}

package/src/warehouse/supply.ts

@@ -0,0 +1,41 @@
+import { Organization } from "./organization";
+import { SupplyStock } from "./supplyStock";
+import { SupplyTransaction } from "./supplyTransaction";
+
+export enum DimensionUnitType {
+  in = "in",
+  ft = "ft",
+  cm = "cm",
+  m = "m",
+}
+
+export enum WeightUnitType {
+  lb = "lb",
+  oz = "oz",
+  kg = "kg",
+  g = "g",
+}
+
+export enum SupplyType {
+  BOX = "BOX",
+  PACKAGING = "PACKAGING",
+}
+
+export interface Supply {
+  id: string;
+  name: string;
+  length: number;
+  width: number;
+  height: number;
+  weight: number;
+  weight_unit?: WeightUnitType;
+  dimension_unit?: DimensionUnitType;
+  active: boolean;
+  type: SupplyType;
+  created_at: string;
+  updated_at: string;
+  organization_id: string;
+  organization?: Organization;
+  supply_stock?: SupplyStock[];
+  supply_transactions?: SupplyTransaction[];
+}

package/src/warehouse/supplyStock.ts

@@ -0,0 +1,10 @@
+import { Supply } from "./supply";
+import { FacilityCode } from "../_common/facility";
+
+export interface SupplyStock {
+  id: string;
+  supply_id: string;
+  supply?: Supply;
+  quantity: number;
+  facility: FacilityCode;
+}

package/src/warehouse/supplyTransaction.ts

@@ -0,0 +1,14 @@
+import { FacilityCode } from "../_common/facility";
+import { Supply } from "./supply";
+
+export interface SupplyTransaction {
+  id: string;
+  supply_id: string;
+  delta: number;
+  facility: FacilityCode;
+  external_shipment_id: string;
+  external_order_id: string;
+  user_email: string;
+  created_at: string;
+  supply?: Supply;
+}

package/src/warehouse/transaction.ts

@@ -0,0 +1,25 @@
+import { Product } from "./product";
+
+export enum TransactionActionType {
+  MOVE = "MOVE",
+  RECEIVE = "RECEIVE",
+  CREATE_PALLET = "CREATE_PALLET",
+  BREAK_DOWN = "BREAK_DOWN",
+  AUDIT = "AUDIT",
+}
+
+export interface Transaction {
+  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: TransactionActionType;
+  product?: Product;
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    "sourceMap": true /* Generates corresponding '.map' file. */,
+    "outDir": "./dist" /* Redirect output structure to the directory. */,
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+
+    /* Module Resolution Options */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+  },
+  "include": ["./src/**/*"]
+}