@secondcloset/types 2.5.8-beta-epic29357-0

package/src/fulfillment/product/stock.ts

@@ -0,0 +1,21 @@
+import { FacilityCode } from "../../_common";
+
+interface StockOrder {
+  id: string;
+  order_id: string;
+  item_quantity: number;
+}
+
+export interface Stock {
+  id: string;
+  product_id: string;
+  facility: FacilityCode;
+  quantity: number;
+  deleted_at: string;
+  created_at: string;
+  updated_at: string;
+  quantity_to_be_reserved: number;
+  orders_to_be_reserved: StockOrder[];
+  reserved_quantity: number;
+  reserved_orders: StockOrder[];
+}

package/src/fulfillment/shipment/carrier.ts

@@ -0,0 +1,17 @@
+export interface CarrierLogo {
+  id: string;
+  url: string;
+  created_at: string;
+  updated_at: string;
+  access: string;
+}
+
+export interface Carrier {
+  id: string;
+  carrier_code: string;
+  name: string;
+  external_platform: string | null;
+  external_id: string | null;
+  logo: CarrierLogo;
+  enabled_service_codes: string[];
+}

package/src/fulfillment/shipment/index.ts

@@ -0,0 +1,7 @@
+export * from "./shipmentItem";
+export * from "./shipment";
+export * from "./shipmentItem";
+export * from "./shippingMethod";
+export * from "./carrier";
+export * from "./package";
+export * from "./packageIssue";

package/src/fulfillment/shipment/package.ts

@@ -0,0 +1,32 @@
+import { PackageIssue } from "./packageIssue";
+
+export type PackageStatus =
+  | "unattempted"
+  | "failed"
+  | "completed"
+  | "cancelled"
+  | "not_delivered"
+  | "redelivered";
+export type PackageType = "box" | "standard_pallet" | "double_pallet";
+
+export interface Package {
+  id: string;
+  package_id: null | string;
+  logistics_shipment_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;
+  logistics_external_carrier_shipping_label_id: string;
+  shipment_item_ids: string[];
+  status: PackageStatus;
+  tracking_number: null | string;
+  failed_reason: null | string;
+  failed_notes: null | string;
+  package_type?: PackageType;
+  package_issues?: PackageIssue[];
+}

package/src/fulfillment/shipment/packageIssue.ts

@@ -0,0 +1,11 @@
+import { BaseImage } from "../../_common";
+
+export type PackageIssueFailedReason = 'damaged_package' | 'missing_package' | 'extra_package' | 'change_mind' | 'other'
+export interface PackageIssue {
+  id: string;
+  logistics_shipment_id: string;
+  logistics_shipment_package_id: string;
+  failed_notes?: string | null;
+  failed_reason?: PackageIssueFailedReason | null;
+  images?: BaseImage[];
+}

package/src/fulfillment/shipment/shipment.ts

@@ -0,0 +1,56 @@
+import { ShipmentItem } from "./shipmentItem";
+import { BaseUser, BaseNote, BaseOrganization } from "../../_common";
+import { Package } from "./package";
+import {
+  SecondClosetShippingMethod,
+  ExternalCarrierShippingMethod,
+} from "./shippingMethod";
+import { Carrier } from "./carrier";
+import { AppointmentType as FulfillmentAppointmentType } from "../appointment/appointmentType";
+import { AppointmentType as StorageAppointmentType } from "../../storage/appointment/appointmentType";
+
+export type ShipmentActionType =
+  | "setup"
+  | StorageAppointmentType
+  | FulfillmentAppointmentType;
+
+export type ScServiceCode =
+  | "second_closet_standard"
+  | "second_closet_white_glove"
+  | "second_closet_to_the_door"
+  | "second_closet_room_of_choice"
+  | "second_closet_standard_1_person"
+  | "second_closet_room_of_choice_1_person"
+  | "second_closet_to_the_door_1_person";
+
+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;
+  };
+}

package/src/fulfillment/shipment/shipmentItem.ts

@@ -0,0 +1,42 @@
+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;
+    }
+  >;
+  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;
+}

package/src/fulfillment/shipment/shippingMethod.ts

@@ -0,0 +1,136 @@
+import { ShipmentItem } from "./shipmentItem";
+import {
+  AppointmentStatus,
+  AppointmentType,
+} from "../../fulfillment/appointment";
+import { CustomerAddress, Customer, ShipmentTag } from "../order";
+import { BaseUser, BaseImage, BaseNote } from "../../_common";
+import { Package } from "./package";
+import { Carrier } from "./carrier";
+import { ScServiceCode } from "../shipment";
+
+type ExternalCarrierShipmentStatus =
+  | "shipment_created"
+  | "label_generated"
+  | "label_printed"
+  | "label_required"
+  | "apply_label"
+  | "with_carrier"
+  | "shipment_cancelled"
+  | "returned";
+
+export type ShippingMethodStatus =
+  | AppointmentStatus
+  | ExternalCarrierShipmentStatus;
+
+export type ShippingMethodType =
+  | "appointment"
+  | "fulfillment"
+  | "external_carrier_shipment";
+
+export interface SecondClosetShippingMethod {
+  id: string;
+  user_id?: string;
+  user_code?: string;
+  user_email?: string;
+  user_firstname?: string;
+  user_lastname?: string;
+  number?: string;
+  status: AppointmentStatus;
+  cancelled_at?: string | null;
+  failed_reason?: string | null;
+  failed_notes?: string | null;
+  claim_number?: string;
+  issue_images?: BaseImage[];
+  incomplete_at?: string;
+  job_type?: AppointmentType;
+  date?: string | null;
+  timerange?: string | null;
+  formatted_timeslot?: string | null;
+  customer_segment?: string;
+  start_time?: string | null;
+  end_time?: string | null;
+  arrived_time?: string | null;
+  rescheduled?: boolean;
+  rescheduled_appointment_id?: string | null;
+  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;
+  created_at: string;
+  updated_at?: string;
+  num_movers?: number | null;
+  estimated_time?: number;
+  movers?: string[] | null;
+  driver_id?: string | null;
+  signature_url?: string | null;
+  signed_at?: string | null;
+  signature_image?: BaseImage | null;
+  location?: CustomerAddress;
+  delivery_service_level?: ScServiceCode;
+  field_ops_notes?: BaseNote[];
+  verification_images?: BaseImage[];
+  source?: {
+    id: string;
+    type: string;
+    shipment_tags: ShipmentTag[];
+    customer: Customer;
+    notes: string;
+    platform: "manual" | "shopify" | string;
+    external_platform_version: number | null;
+  };
+  type?: ShippingMethodType;
+  shipment?: {
+    id: string;
+    organization_id: string;
+    billed: false;
+    user: BaseUser;
+    notes: BaseNote[];
+    shipment_items: ShipmentItem[];
+    shipment_number: string;
+    packages: Package[];
+    external_order_id: string;
+    external_order_type: string;
+    external_shipment_id: string | null;
+    carrier: Carrier | null;
+    created_at: string;
+    updated_at: string;
+    action_summary: string[];
+  };
+}
+
+interface CarrierShippingAddress {
+  id: string;
+  contact_name: string;
+  phone_number: string;
+  address: string;
+  city: string;
+  country: string;
+  province: string;
+  postal_code: string;
+}
+
+export interface ExternalCarrierShippingLabel {
+  id: string;
+  label_id: string;
+  tracking_number: string;
+  tracking_url: string;
+  label_download: string;
+  voided: boolean;
+  voided_at: string | null;
+}
+
+export interface ExternalCarrierShippingMethod {
+  id: string;
+  status: ExternalCarrierShipmentStatus;
+  shipped_at: string | null;
+  shipment_status: string | null;
+  shipment_id: string | null;
+  carrier_id: string | null;
+  service_code: string | null;
+  ship_from_address: CarrierShippingAddress;
+  ship_to_address: CarrierShippingAddress;
+  shipping_labels: ExternalCarrierShippingLabel[];
+}

package/src/fulfillment/warehouseReceivingOrder/incomingShipment.ts

@@ -0,0 +1,35 @@
+export interface IncomingShipment {
+  id: string;
+  parcel_type: string;
+  status: string;
+  tracking_info: string;
+  shipment_contents: ShipmentContents[];
+  arrival_date: string;
+  completed_date: string;
+  created_at: string;
+  updated_at: string;
+  warehouse_receiving_order_id: string;
+  deleted_at: string | null;
+  parcel_id: string;
+  carrier_name: string;
+  container_number: string;
+}
+
+export interface ShipmentContents {
+  id: string;
+  lot_number: string | null;
+  quantity_of_packages: number;
+  product_packaging_level: {
+    id: string;
+    name: string;
+    sku: string;
+    level: string;
+    products_per_package: number;
+  };
+  product: {
+    id: string;
+    scid: string;
+    sku: string;
+    name: string;
+  };
+}

package/src/fulfillment/warehouseReceivingOrder/index.ts

@@ -0,0 +1,2 @@
+export * from "./warehouseReceivingOrder";
+export * from "./incomingShipment";

package/src/fulfillment/warehouseReceivingOrder/warehouseReceivingOrder.ts

@@ -0,0 +1,34 @@
+import { IncomingShipment } from "./incomingShipment";
+
+export interface WarehouseReceivingOrder {
+  id: string;
+  draft: boolean;
+  wro_id: string;
+  organization_id: string;
+  destination_warehouse: string;
+  shipment_size: string;
+  packaging_option: string;
+  have_shipping_label: boolean;
+  status: string;
+  arrival_date: string;
+  created_at: string;
+  updated_at: string;
+  incoming_shipments: IncomingShipment[];
+  bill_of_lading_images: BillOfLadingImage[];
+  from_address: any | null; // TODO: type this
+  organization_name: string;
+  created_by: {
+    id: string;
+    first_name: string;
+    last_name: string;
+    user_code: string;
+  };
+}
+
+export interface BillOfLadingImage {
+  access: string;
+  created_at: string;
+  id: string;
+  updated_at: string;
+  url: string;
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * as Common from "./_common";
+export * as Fulfillment from "./fulfillment";
+export * as Storage from "./storage";
+export * as Warehouse from "./warehouse";
+export * as Logistics from "./logistics";

package/src/logistics/availability.ts

@@ -0,0 +1,18 @@
+export interface AvailabilityTimeSlot {
+  timeslot: string;
+  service_area: string;
+  customer_segment: string;
+  holiday: boolean;
+  total_milliseconds: number;
+  total_booked_milliseconds: number;
+  remaining_milliseconds: number;
+  vehicles_required: number;
+  duration_in_milliseconds: number;
+  available: boolean;
+  [index: string]: any;
+}
+
+export interface Availability {
+  date: string;
+  timeslots: AvailabilityTimeSlot[];
+}

package/src/logistics/index.ts

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

package/src/logistics/shippingRate.ts

@@ -0,0 +1,19 @@
+import { Carrier } from "../fulfillment/shipment/carrier";
+
+export interface ShippingRate {
+  carrier: Carrier;
+  carrier_delivery_days: number;
+  currency: string;
+  delivery_days: number;
+  estimated_delivery_date: string;
+  external_platform: string;
+  guaranteed_service: boolean;
+  price: number;
+  rate_id: string;
+  service_code: string;
+  service_type: string;
+  shipment_id: string | null;
+  trackable: boolean;
+  client_account: boolean;
+  signature_rate?: boolean;
+}

package/src/storage/address.ts

@@ -0,0 +1,9 @@
+import { BaseAddress } from "../_common/address";
+
+export interface Address extends BaseAddress {
+  is_primary: boolean;
+  building_type: string;
+  elevator_access: boolean;
+  status: string;
+  full_name: string;
+}

package/src/storage/appointment/appointment.ts

@@ -0,0 +1,100 @@
+import { AppointmentItem } from "./appointmentItem";
+import { AppointmentType } from "./appointmentType";
+import { AppointmentStatus } from "./appointmentStatus";
+import { Address } from "../address";
+import { BaseImage, BaseNote } from "../../_common";
+import { ScServiceCode } from "../../fulfillment";
+
+export interface Appointment {
+  address: Address;
+  arrived_time?: string;
+  bulky_order_only: boolean;
+  claim_number?: string;
+  created_at: string;
+  customer_segment: string;
+  date: string;
+  delivery_service_level?: ScServiceCode;
+  driver_id?: string;
+  end_time?: string;
+  estimated_time: number;
+  failed_notes?: string;
+  failed_reason?: string;
+  field_ops_notes?: BaseNote[];
+  formatted_timeslot: string;
+  id: string;
+  immediate: true;
+  incomplete_at?: string;
+  issue_images?: BaseImage[];
+  job_type: AppointmentType;
+  location?: Location;
+  movers?: any;
+  notes?: string;
+  num_movers?: number;
+  number: string;
+  order_id: string;
+  rescheduled: boolean;
+  rescheduled_appointment_id?: string | null;
+  signature_image?: string;
+  signature_url?: string;
+  signed_at?: string;
+  space_order: boolean;
+  start_time?: string;
+  status: AppointmentStatus;
+  temporary: boolean;
+  timerange: AppointmentSlot;
+  type: string;
+  updated_at: string;
+  user_code: string;
+  user_email: string;
+  user_firstname: string;
+  user_id: string;
+  user_lastname: string;
+  items: AppointmentItem[];
+  verification_images?: BaseImage[];
+}
+
+export type AppointmentSlot =
+  | "07-10"
+  | "10-13"
+  | "13-16"
+  | "16-19"
+  | "19-22"
+  | "10-22"
+  | "09-13"
+  | "13-17"
+  | "17-21";
+
+export interface AppointmentNote {
+  id: string;
+  text: string;
+  created_at: string;
+  updated_at: string;
+}
+
+export interface AppointmentTask {
+  id: string;
+  task_type: string;
+  status: string;
+  appointment_id: string;
+  notes: string;
+  assignee: string | null;
+}
+
+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/storage/appointment/appointmentItem.ts

@@ -0,0 +1,34 @@
+import { BaseImage } from "../../_common";
+
+interface Image extends BaseImage {
+  resource_type: string;
+  resource_id: string;
+  deleted_at: string | null;
+}
+
+export interface AppointmentItem {
+  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 | null;
+  category_name: string | null;
+  category_description: string | null;
+  category_volume: string | null;
+  qr_code: string | null;
+  status: string;
+  internal_status: string;
+  nickname: string | null;
+  material: string | null;
+  color: string | null;
+  size: string;
+  brand: string | null;
+  images: Image[];
+  metadata: {};
+}

package/src/storage/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"
+  | "signed"
+  | "staging"
+  | "completed"
+  | "started"
+  | "arrived"
+  | "incomplete"
+  | "failed"
+  | "no_show";

package/src/storage/appointment/appointmentType.ts

@@ -0,0 +1,8 @@
+export type AppointmentType =
+  | "pick_up"
+  | "drop_off"
+  | "immediate_pick_up"
+  | "retrieve"
+  | "return"
+  | "immediate_retrieve"
+  | "custom";

package/src/storage/appointment/index.ts

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

package/src/storage/availability.ts

@@ -0,0 +1,19 @@
+export type Slot = "10-13" | "13-16" | "16-19" | "19-22" | string;
+
+export interface TimeSlot {
+  timeslot: Slot;
+  service_area: string;
+  customer_segment: string;
+  holiday: boolean;
+  total_milliseconds: number;
+  total_booked_milliseconds: number;
+  remaining_milliseconds: number;
+  vehicles_required: number;
+  duration_in_milliseconds: number;
+  available: boolean;
+}
+
+export interface Availability {
+  date: string;
+  timeslots: TimeSlot[];
+}

package/src/storage/categoryItem.ts

@@ -0,0 +1,12 @@
+import { BaseImage } from "../_common";
+
+export interface CategoryItem {
+  id: string;
+  name: string;
+  description: string;
+  stripe_plan_id: string;
+  synonyms: string[];
+  volume: number;
+  default_image: BaseImage;
+  public: boolean;
+}

package/src/storage/closet.ts

@@ -0,0 +1,16 @@
+import { InventoryItem } from "./inventoryItem";
+
+export interface Closet {
+  id: string;
+  user_id: string;
+  order_id?: string;
+  name: string;
+  closet_name: string;
+  quantity: number;
+  stripe_plan_id: string;
+  stripe_subscription_id?: string;
+  is_full: boolean;
+  created_at: string;
+  updated_at: string;
+  items: InventoryItem[];
+}