@secondcloset/types 2.8.0-beta.0 → 2.8.0-beta.1-yyc-atl

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondcloset/types",
-  "version": "2.8.0-beta.0",
+  "version": "2.8.0-beta.1-yyc-atl",
   "description": "secondcloset type declaration and definitions",
   "main": "src/index.ts",
   "scripts": {

package/src/_common/facility.ts

@@ -17,6 +17,9 @@ export type FacilityCode =
   | "nyc1"
   | "mia1"
   | "hou1"
+  | "yyc1"
+  | "atl1"
+  | "atl2"
   | "unknown";
 
 export type DeprecatedFacilityCode = "yyz1" | "yyz2";
@@ -32,7 +35,10 @@ export type FacilityCity =
   | "Santa Fe Springs"
   | "Carlstadt"
   | "Medley"
-  | "Houston";
+  | "Houston"
+  | "Tucker"
+  | "Newnan"
+  | "Calgary";
 
 export type Facility<V = Version> = V extends "V1"
   ? {

package/src/_common/serviceArea.ts

@@ -6,4 +6,6 @@ export type ServiceArea =
   | "lax"
   | "nyc"
   | "mia"
-  | "hou";
+  | "hou"
+  | "yyc"
+  | "atl";

package/src/fulfillment/order/order.ts

@@ -6,7 +6,6 @@ import {
   BaseUser,
   Organization,
   File,
-  Version,
 } from "../../_common";
 import { OrderItem } from "./orderItem";
 
@@ -41,43 +40,41 @@ export interface FulfillmentOrderAddress extends BaseAddress {
   updated_at: string;
 }
 
-export type Order<V = Version> = 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[];
-      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;
-      has_errors: boolean;
-    }
-  : Omit<Order<"V1">, "items" | "shipments">;
+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: FulfillmentOrderAddress;
+  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;
+  has_errors: boolean;
+}

package/src/fulfillment/order/orderItem.ts

@@ -1,32 +1,16 @@
-import { Version } from "../../_common";
-import { BaseProduct, Product } from "../product";
+import { Product } from "../product";
 import { ShipmentActionType } from "../shipment";
 
-export type OrderItem<V = Version> = 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"];
-      };
-      available_actions: {
-        inventory_pick_up_item_ids: OrderItem<"V1">["id"][];
-        inventory_warehouse_receiving_item_ids: OrderItem<"V1">["id"][];
-        delivery_item_ids: OrderItem<"V1">["id"][];
-      };
-      removed_items: {
-        removed_reason: string;
-        quantity: number;
-      }[];
-    };
+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/product.ts

@@ -3,15 +3,11 @@ import { BaseImage } from "../../_common";
 
 export interface BaseProduct {
   id: string;
-  name: string;
-  sku: string;
-  scid: string;
-  type: "base" | "kit";
-}
-
-export interface Product extends Omit<BaseProduct, "type"> {
   organization_id: string;
+  scid: string;
+  sku: string;
   upc: string;
+  name: string;
   description: string;
   platform: string;
   active: boolean;
@@ -36,7 +32,7 @@ export interface Product extends Omit<BaseProduct, "type"> {
   customs_description: string | null;
   images: BaseImage[];
   packaging_criteria: string;
-  product_type: BaseProduct["type"];
+  product_type: "base" | "kit";
   stocks?: Stock[];
   deleted_at: string;
   created_at: string;
@@ -60,14 +56,21 @@ export interface Product extends Omit<BaseProduct, "type"> {
   insurance_value: number | null;
   has_errors: boolean;
   under_conversion: boolean;
-  base_products?: Product[];
+}
+
+export interface Product extends BaseProduct {
+  base_products?: BaseProduct[];
 }
 
 export interface PackagingLevel {
   id?: string;
   product_id?: string;
-  product: BaseProduct & {
+  product: {
+    id: string;
+    sku: string;
     upc: string;
+    scid: string;
+    name: string;
     tracks_lot_numbers: boolean;
   };
   level: "single_item" | "inner_pack" | "master_pack" | "pallet";

package/src/fulfillment/shipment/shipment.ts

@@ -1,11 +1,5 @@
 import { ShipmentItem } from "./shipmentItem";
-import {
-  BaseUser,
-  BaseNote,
-  BaseOrganization,
-  Facility,
-  Version,
-} from "../../_common";
+import { BaseUser, BaseNote, BaseOrganization, Facility } from "../../_common";
 import { Package } from "./package";
 import {
   SecondClosetShippingMethod,
@@ -39,39 +33,35 @@ export type ScServiceCode =
   | "second_closet_to_the_door_1_person"
   | ServiceCode;
 
-export type Shipment<V = Version> = V extends "V1"
-  ? {
-      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;
-      };
-      facility?: Partial<Facility>;
-    }
-  : Omit<Shipment<"V1">, "shipment_items">;
+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;
+  };
+  facility?: Partial<Facility>;
+}

package/src/fulfillment/shipment/shipmentItem.ts

@@ -1,49 +1,42 @@
-import { Version } from "../../_common";
-import { BaseProduct } from "../product";
 import { ShipmentActionType } from "./shipment";
-export type ShipmentItem<V = Version> = V extends "V1"
-  ? {
-      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;
+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;
     }
-  : {
-      product: BaseProduct;
-      shipment_item_ids: ShipmentItem<"V1">["id"][];
+  >;
+  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/warehouse/carrierTransferPackage.ts

@@ -43,7 +43,7 @@ interface ShippingLabel extends Partial<ExternalCarrierShippingLabel> {
   created_at: string;
   updated_at: string;
 }
-interface PackageShipment extends Partial<Shipment<"V1">> {
+interface PackageShipment extends Partial<Shipment> {
   user_id: string;
   shipping_method_id?: string;
   customer_scheduling_token?: string;
@@ -62,4 +62,4 @@ export interface PackageDetailsInfo extends PackageInfo {
   organization: Organization;
   carrier?: PackageCarrier;
   shipping_label?: ShippingLabel;
-}
+}

package/src/warehouse/organization.ts

@@ -21,6 +21,7 @@ export enum OrganizationConfigKey {
   RTS_INSTRUCTION = "RTS_INSTRUCTION",
   ENABLE_SEND_EMAIL_TO_CUSTOMERS = "ENABLE_SEND_EMAIL_TO_CUSTOMERS",
   DEFAULT_RATE_FETCHING_V1 = "DEFAULT_RATE_FETCHING_V1",
+  DEFAULT_REQUIRE_SIGNATURE = "DEFAULT_REQUIRE_SIGNATURE",
 }
 export interface OrganizationConfig {
   id: string;