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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondcloset/types",
-  "version": "1.8.4",
+  "version": "1.38.1-beta-pq-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

@@ -0,0 +1,22 @@
+export type ActivityEvent = "all" | "asn" | "order" | "manual" | "system";
+export interface ActivityHistory {
+  id: string;
+  user?: {
+    id: string;
+    name?: string;
+    is_admin: boolean;
+    is_customer: boolean;
+  };
+  description: string[];
+  organization_name?: string;
+  created_at: string;
+  event: Partial<ActivityEvent>;
+  metadata?: {
+    facility?: { id: string; name: string };
+    asn?: { id: string; number: string };
+    order?: { id: string; number: string };
+    file?: { url: string; name: string };
+    shipment?: { id: string; number: string };
+    image_url?: string;
+  };
+}

package/src/_common/address.ts

@@ -9,6 +9,8 @@ export interface BaseAddress {
   id: string;
   apartment_number: string | null;
   address: string;
+  address_line_1?: string;
+  address_line_2?: string;
   city: string;
   province: string;
   country: string;

package/src/_common/facility.ts

@@ -1,3 +1,5 @@
+import { Version } from ".";
+import { Common } from "..";
 import { ServiceArea } from "./serviceArea";
 
 export type FacilityCode =
@@ -5,9 +7,16 @@ export type FacilityCode =
   | "yyz2"
   | "yyz3"
   | "yyz4"
+  | "yyz5"
   | "yvr1"
+  | "yvr2"
   | "yow1"
   | "yul1"
+  | "lax1"
+  | "lax2"
+  | "nyc1"
+  | "mia1"
+  | "hou1"
   | "unknown";
 
 export type DeprecatedFacilityCode = "yyz1" | "yyz2";
@@ -15,23 +24,45 @@ export type DeprecatedFacilityCode = "yyz1" | "yyz2";
 export type FacilityCity =
   | "Toronto"
   | "Mississauga"
+  | "Markham"
   | "Vancouver"
   | "Ottawa"
-  | "Montreal";
+  | "Montreal"
+  | "Buena Park"
+  | "Santa Fe Springs"
+  | "Carlstadt"
+  | "Medley"
+  | "Houston";
 
-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,3 +8,4 @@ export * from "./organization";
 export * from "./credential";
 export * from "./file";
 export * from "./note";
+export * from "./activityHistory";

package/src/_common/organization.ts

@@ -2,8 +2,13 @@ import { BaseImage } from "./image";
 import { BaseAddress } from "./address";
 import { BaseUser } from "./user";
 import { Carrier } from "../fulfillment";
+import { Facility } from "./facility";
 
-export type OrganizationConfigKey = "default_fulfilled_from";
+export type OrganizationConfigKey =
+  | "default_fulfilled_from"
+  | "auto_fulfill_orders"
+  | "freightcom_api_username"
+  | "freightcom_api_password";
 
 export interface OrganizationConfig {
   key: OrganizationConfigKey;
@@ -25,7 +30,14 @@ export interface OrganizationAddress extends BaseAddress {
 
 export interface GeofilterConstraint {
   country: string;
-  provinces: string[];
+  provinces: GeofilterConstraintProvince[];
+}
+
+export interface GeofilterConstraintProvince {
+  id?: string;
+  country: string;
+  province: string;
+  _destroy?: boolean;
 }
 
 export interface SCServiceTier {
@@ -35,14 +47,17 @@ export interface SCServiceTier {
   to_the_door?: boolean;
 }
 
-export interface Organization {
+export interface BaseOrganization {
+  created_at: string;
+  email: string;
   id: string;
   name: string;
-  phone_number: string;
-  email: string;
-  created_at: string;
-  logo: BaseImage;
   packing_notes: string;
+  phone_number: string;
+  logo?: BaseImage;
+}
+
+export interface Organization extends BaseOrganization {
   addresses: OrganizationAddress[];
   carriers: Carrier[];
   users: BaseUser[];
@@ -55,4 +70,18 @@ export interface Organization {
   configurations_attributes: OrganizationConfig[];
   permissions: Permission[];
   geofilter_constraints?: GeofilterConstraint[];
+  facility_service_areas?: FacilityServiceArea[];
+}
+
+export interface Region {
+  id?: string;
+  region_code: string;
+  region_name: string;
+  country_code: string;
+  country_name: string;
+}
+export interface FacilityServiceArea {
+  facility: Facility<"V2">;
+  default_regions: Region[];
+  organization_regions: Region[];
 }

package/src/_common/serviceArea.ts

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

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,9 +1,13 @@
-import { AppointmentType } from "./appointmentType";
+import {
+  AppointmentType,
+  AppointmentSubtype,
+  DeliveryType,
+} from "./appointmentType";
 import { AppointmentStatus } from "./appointmentStatus";
 import { Shipment, ScServiceCode } from "../shipment";
 import { Order } from "../order";
 import { AppointmentSlot } from "../../storage";
-import { BaseImage, BaseNote } from "../../_common";
+import { BaseImage, BaseNote, ServiceArea } from "../../_common";
 
 export interface Appointment {
   appointment_actions: string[];
@@ -18,6 +22,9 @@ export interface Appointment {
   driver_id: string | null;
   end_time: string | null;
   estimated_time: number;
+  facility?: {
+    name: string;
+  };
   failed_notes: string | null;
   failed_reason: string | null;
   field_ops_notes?: BaseNote[];
@@ -26,16 +33,24 @@ export interface Appointment {
   incomplete_at: string | null;
   issue_images?: BaseImage[];
   job_type: AppointmentType;
+  job_subtype?: AppointmentSubtype;
   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;
@@ -48,6 +63,8 @@ export interface Appointment {
   user_id: string;
   user_lastname: string;
   verification_images?: BaseImage[];
+  delivery_type?: DeliveryType;
+  shipping_labels?: LastMileShippingLabel[];
 }
 
 export interface Location {
@@ -65,6 +82,14 @@ 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;
 }
+
+interface LastMileShippingLabel {
+  id: string;
+  label_id?: string;
+  tracking_number?: string;
+  tracking_url?: string;
+  label_download?: string;
+}

package/src/fulfillment/appointment/appointmentStatus.ts

@@ -13,6 +13,7 @@ export type AppointmentStatus =
   | "done"
   | "staging"
   | "completed"
+  | "completed_with_exceptions"
   | "started"
   | "arrived"
   | "incomplete"

package/src/fulfillment/appointment/appointmentType.ts

@@ -5,3 +5,7 @@ export type AppointmentType =
   | "cross_dock_delivery"
   | "return_to_sender"
   | "inventory_warehouse_receiving";
+
+export type AppointmentSubtype = "mid_mile_pick_up" | "mid_mile_drop_off";
+
+export type DeliveryType = "heavy" | "parcel";

package/src/fulfillment/asn/asn.ts

@@ -46,6 +46,7 @@ export interface ASN {
   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;

package/src/fulfillment/asn/asnItem.ts

@@ -3,6 +3,7 @@ export interface ASNItem {
   product_id: string;
   product_name: string;
   product_sku: string;
+  product_upc?: string;
   product_scid: string;
   expected_quantity: number;
   received_quantity?: number;

package/src/fulfillment/index.ts

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

package/src/fulfillment/order/order.ts

@@ -10,13 +10,16 @@ import {
 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";
+  | "pending_inventory_receiving"
+  | "items_partially_fulfilled"
+  | "customer_booking";
 
 export type OrderPlatform =
   | "manual"
@@ -27,7 +30,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;
@@ -52,8 +55,9 @@ export interface Order {
   client_type: string | null;
   insurance_value: number;
   shipping_service: string | null;
+  signature_required?: boolean;
   customer: Customer;
-  address: Address;
+  address: FulfillmentOrderAddress;
   created_at: string;
   updated_at: string;
   organization: Organization;
@@ -72,4 +76,5 @@ export interface Order {
   on_hold: boolean;
   on_hold_at: string;
   selected_service_code?: ScServiceCode;
+  has_errors: boolean;
 }

package/src/fulfillment/product/index.ts

@@ -1,2 +1,3 @@
 export * from "./product";
-export * from "./stock";
+export * from "./stock";
+export * from "../../_common/activityHistory";

package/src/fulfillment/product/product.ts

@@ -51,6 +51,11 @@ export interface BaseProduct {
   }[];
   required_parts?: { [productID: string]: number };
   packaging_levels?: PackagingLevel[];
+  return_days?: number;
+  insurance_required: boolean;
+  insurance_value: number | null;
+  has_errors: boolean;
+  under_conversion: boolean;
 }
 
 export interface Product extends BaseProduct {
@@ -63,6 +68,7 @@ export interface PackagingLevel {
   product: {
     id: string;
     sku: string;
+    upc: string;
     scid: string;
     name: string;
     tracks_lot_numbers: boolean;

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;
+}

package/src/fulfillment/shipment/index.ts

@@ -4,3 +4,4 @@ export * from "./shipmentItem";
 export * from "./shippingMethod";
 export * from "./carrier";
 export * from "./package";
+export * from "./packageIssue";

package/src/fulfillment/shipment/package.ts

@@ -1,8 +1,17 @@
-export type PackageStatus = "unattempted" | "failed" | "completed";
+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;
@@ -13,10 +22,12 @@ export interface Package {
   width_value: string;
   width_unit: string;
   logistics_external_carrier_shipping_label_id: string;
+  logistics_bolt_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

@@ -1,5 +1,5 @@
 import { ShipmentItem } from "./shipmentItem";
-import { BaseUser, BaseNote } from "../../_common";
+import { BaseUser, BaseNote, BaseOrganization, Facility } from "../../_common";
 import { Package } from "./package";
 import {
   SecondClosetShippingMethod,
@@ -26,14 +26,7 @@ export type ScServiceCode =
 export interface Shipment {
   id: string;
   organization_id: string;
-  organization: {
-    created_at: string;
-    email: string;
-    id: string;
-    name: string;
-    packing_notes: string;
-    phone_number: string;
-  };
+  organization?: BaseOrganization;
   billed: boolean;
   user: BaseUser;
   notes: BaseNote[] | string;
@@ -60,4 +53,5 @@ export interface Shipment {
     created_at: string;
     updated_at: string;
   };
+  facility?: Partial<Facility>;
 }

package/src/fulfillment/shipment/shipmentItem.ts

@@ -6,6 +6,7 @@ export interface ShipmentItem {
   item_identifier: string;
   item_identifier_type: string;
   item_identifier_value: string;
+  product_id?: string;
   weight_value: string;
   weight_unit: string;
   length_value: string;

package/src/fulfillment/shipment/shippingMethod.ts

@@ -2,9 +2,11 @@ import { ShipmentItem } from "./shipmentItem";
 import {
   AppointmentStatus,
   AppointmentType,
+  AppointmentSubtype,
+  DeliveryType,
 } from "../../fulfillment/appointment";
 import { CustomerAddress, Customer, ShipmentTag } from "../order";
-import { BaseUser, BaseImage, BaseNote } from "../../_common";
+import { BaseUser, BaseImage, BaseNote, BaseAddress } from "../../_common";
 import { Package } from "./package";
 import { Carrier } from "./carrier";
 import { ScServiceCode } from "../shipment";
@@ -44,6 +46,7 @@ export interface SecondClosetShippingMethod {
   issue_images?: BaseImage[];
   incomplete_at?: string;
   job_type?: AppointmentType;
+  job_subtype?: AppointmentSubtype;
   date?: string | null;
   timerange?: string | null;
   formatted_timeslot?: string | null;
@@ -53,6 +56,12 @@ export interface SecondClosetShippingMethod {
   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;
@@ -66,6 +75,8 @@ export interface SecondClosetShippingMethod {
   delivery_service_level?: ScServiceCode;
   field_ops_notes?: BaseNote[];
   verification_images?: BaseImage[];
+  delivery_type?: DeliveryType;
+  shipping_labels?: LastMileShippingLabel[];
   source?: {
     id: string;
     type: string;
@@ -100,6 +111,8 @@ interface CarrierShippingAddress {
   contact_name: string;
   phone_number: string;
   address: string;
+  address_line_1?: string;
+  address_line_2?: string;
   city: string;
   country: string;
   province: string;
@@ -116,6 +129,14 @@ export interface ExternalCarrierShippingLabel {
   voided_at: string | null;
 }
 
+export interface LastMileShippingLabel {
+  id: string;
+  label_id?: string;
+  tracking_number?: string;
+  tracking_url?: string;
+  label_download?: string;
+}
+
 export interface ExternalCarrierShippingMethod {
   id: string;
   status: ExternalCarrierShipmentStatus;

package/src/index.ts

@@ -3,3 +3,4 @@ export * as Fulfillment from "./fulfillment";
 export * as Storage from "./storage";
 export * as Warehouse from "./warehouse";
 export * as Logistics from "./logistics";
+export * as Integration from "./integrations";

package/src/integrations/index.ts

@@ -0,0 +1 @@
+export * from "./shopify";

package/src/integrations/shopify.ts

@@ -0,0 +1,7 @@
+export interface Shop {
+  active: boolean;
+  created_at: string;
+  id: string;
+  name: string;
+  updated_at: string;
+}

package/src/logistics/availability.ts

@@ -1,6 +1,14 @@
+import { ServiceArea } from "../_common";
+
+export type DeliveryServiceLevel =
+  | "white_glove"
+  | "non_white_glove"
+  | "all_service_levels"
+  | "parcel_regular";
+
 export interface AvailabilityTimeSlot {
   timeslot: string;
-  service_area: string;
+  service_area: ServiceArea;
   customer_segment: string;
   holiday: boolean;
   total_milliseconds: number;
@@ -9,6 +17,10 @@ export interface AvailabilityTimeSlot {
   vehicles_required: number;
   duration_in_milliseconds: number;
   available: boolean;
+  delivery_service_level: DeliveryServiceLevel;
+  booked_appointments_count: number;
+  remaining_appointments_count: number;
+  maximum_appointments_number: number;
   [index: string]: any;
 }
 

package/src/logistics/index.ts

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