rerobe-js-orm 2.4.6 → 2.4.8

package/lib/models/Product.js

@@ -49,6 +49,8 @@ class Product extends Base_1.default {
             priceRange: (props === null || props === void 0 ? void 0 : props.priceRange) || '',
             condition: (props === null || props === void 0 ? void 0 : props.condition) || '',
             measurements: (props === null || props === void 0 ? void 0 : props.measurements) || {},
+            featuredCollections: (props === null || props === void 0 ? void 0 : props.featuredCollections) || [],
+            tags: (props === null || props === void 0 ? void 0 : props.tags) || [],
         };
         this.consignmentAttributes = {
             sellRequestImageUrls: (props === null || props === void 0 ? void 0 : props.sellRequestImageUrls) || [],
@@ -77,13 +79,44 @@ class Product extends Base_1.default {
             discountType: (props === null || props === void 0 ? void 0 : props.discountType) || '',
             discountValue: (props === null || props === void 0 ? void 0 : props.discountValue) || '',
             selectedForClearance: (props === null || props === void 0 ? void 0 : props.selectedForClearance) || '',
+            locationIds: (props === null || props === void 0 ? void 0 : props.locationIds) || [],
+        };
+        this.timestampAttributes = {
+            sellRequestReviewDraftTimestamp: (props === null || props === void 0 ? void 0 : props.sellRequestReviewDraftTimestamp)
+                ? Number(props === null || props === void 0 ? void 0 : props.sellRequestReviewDraftTimestamp)
+                : null,
+            sellRequestReviewTimestamp: (props === null || props === void 0 ? void 0 : props.sellRequestReviewTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.sellRequestReviewTimestamp) : null,
+            rejectedTimestamp: (props === null || props === void 0 ? void 0 : props.rejectedTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.rejectedTimestamp) : null,
+            holdTimestamp: (props === null || props === void 0 ? void 0 : props.holdTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.holdTimestamp) : null,
+            acceptedTimestamp: (props === null || props === void 0 ? void 0 : props.acceptedTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.acceptedTimestamp) : null,
+            sellerToDropOffTimestamp: (props === null || props === void 0 ? void 0 : props.sellerToDropOffTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.sellerToDropOffTimestamp) : null,
+            sellerToShipTimestamp: (props === null || props === void 0 ? void 0 : props.sellerToShipTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.sellerToShipTimestamp) : null,
+            sellerToGetPickUpTimestamp: (props === null || props === void 0 ? void 0 : props.sellerToGetPickUpTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.sellerToGetPickUpTimestamp) : null,
+            qualityControlTimestamp: (props === null || props === void 0 ? void 0 : props.qualityControlTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.qualityControlTimestamp) : null,
+            pendingPublicationTimestamp: (props === null || props === void 0 ? void 0 : props.pendingPublicationTimestamp)
+                ? Number(props === null || props === void 0 ? void 0 : props.pendingPublicationTimestamp)
+                : null,
+            listedTimestamp: (props === null || props === void 0 ? void 0 : props.listedTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.listedTimestamp) : null,
+            clearanceTimestamp: (props === null || props === void 0 ? void 0 : props.clearanceTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.clearanceTimestamp) : null,
+            reservedTimestamp: (props === null || props === void 0 ? void 0 : props.reservedTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.reservedTimestamp) : null,
+            soldTimestamp: (props === null || props === void 0 ? void 0 : props.soldTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.soldTimestamp) : null,
+            returnedTimestamp: (props === null || props === void 0 ? void 0 : props.returnedTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.returnedTimestamp) : null,
+            soldSellerToBePaidTimestamp: (props === null || props === void 0 ? void 0 : props.soldSellerToBePaidTimestamp)
+                ? Number(props === null || props === void 0 ? void 0 : props.soldSellerToBePaidTimestamp)
+                : null,
+            soldSellerPaidTimestamp: (props === null || props === void 0 ? void 0 : props.soldSellerPaidTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.soldSellerPaidTimestamp) : null,
+            sellerSelfRejectTimestamp: (props === null || props === void 0 ? void 0 : props.sellerSelfRejectTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.sellerSelfRejectTimestamp) : null,
+            liquidationRequestedTimestamp: (props === null || props === void 0 ? void 0 : props.liquidationRequestedTimestamp)
+                ? Number(props === null || props === void 0 ? void 0 : props.liquidationRequestedTimestamp)
+                : null,
+            sellerLiquidatedTimestamp: (props === null || props === void 0 ? void 0 : props.sellerLiquidatedTimestamp) ? Number(props === null || props === void 0 ? void 0 : props.sellerLiquidatedTimestamp) : null,
         };
     }
     toPartialObj() {
         return Object.assign(Object.assign({}, this.attributes), this.filterAttributes);
     }
     toObj() {
-        return Object.assign(Object.assign(Object.assign({}, this.attributes), this.filterAttributes), this.consignmentAttributes);
+        return Object.assign(Object.assign(Object.assign(Object.assign({}, this.attributes), this.filterAttributes), this.consignmentAttributes), this.timestampAttributes);
     }
     toProductInputObjForShopify(location) {
         const productInputObj = {

package/lib/models/ProductCollection.d.ts

@@ -0,0 +1,15 @@
+import Base from '../Base';
+export default class ProductCollection extends Base {
+    documentId: string;
+    preTitle: string;
+    title: string;
+    subTitle: string;
+    description: string;
+    type: CollectionType;
+    imgUrl: string;
+    refinements: ProductRefinements;
+    tags: string[];
+    collectionId: string;
+    constructor(props?: any);
+    toObj(): ProductCollectionType;
+}

package/lib/models/ProductCollection.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Base_1 = require("../Base");
+class ProductCollection extends Base_1.default {
+    constructor(props) {
+        super();
+        this.documentId = (props === null || props === void 0 ? void 0 : props.documentId) || this.utilities.makeRandId(28);
+        this.preTitle = (props === null || props === void 0 ? void 0 : props.preTitle) || '';
+        this.title = (props === null || props === void 0 ? void 0 : props.title) || '';
+        this.subTitle = (props === null || props === void 0 ? void 0 : props.subTitle) || '';
+        this.description = (props === null || props === void 0 ? void 0 : props.description) || '';
+        this.type = (props === null || props === void 0 ? void 0 : props.type) || 'AUTOMATED';
+        this.imgUrl = (props === null || props === void 0 ? void 0 : props.imgUrl) || '';
+        this.refinements = (props === null || props === void 0 ? void 0 : props.refinements) || {};
+        this.tags = (props === null || props === void 0 ? void 0 : props.tags) || [];
+        this.collectionId = (props === null || props === void 0 ? void 0 : props.collectionId) || '';
+    }
+    toObj() {
+        const productCollectionObj = {
+            documentId: this.documentId,
+            preTitle: this.preTitle,
+            title: this.title,
+            subTitle: this.subTitle,
+            description: this.description,
+            type: this.type,
+            imgUrl: this.imgUrl,
+            refinements: this.refinements,
+            tags: this.tags,
+            collectionId: this.collectionId,
+        };
+        return productCollectionObj;
+    }
+}
+exports.default = ProductCollection;

package/lib/models/User.js

@@ -133,6 +133,7 @@ class User extends Base_1.default {
     toCustomerInputObjForRibbn() {
         const customerInput = {
             uid: this.uid,
+            gid: this.gid,
             firstName: this.firstName,
             lastName: this.lastName,
             displayName: this.displayName,
@@ -150,6 +151,10 @@ class User extends Base_1.default {
             ordersCount: this.ordersCount,
             amountSpent: this.amountSpent,
             emailVerified: this.emailVerified,
+            isSeller: this.isSeller,
+            devicePlatform: this.devicePlatform,
+            lastLogin: this.lastLogin,
+            referralCode: this.referralCode,
         };
         return customerInput;
     }

package/lib/types/product-collection-types.d.ts

@@ -0,0 +1,63 @@
+declare type ProductAttrRefinementsOptions = 'brand' | 'clothingSize' | 'color' | 'condition' | 'gender' | 'jeanSize' | 'materialComposition' | 'priceRange' | 'productCategory' | 'productType' | 'productStyle' | 'shoeSize' | 'status' | 'salesChannel';
+declare type FiltersOptions = 'brandRefinement' | 'clothingSizeRefinement' | 'colorRefinement' | 'conditionRefinement' | 'genderRefinement' | 'jeanSizeRefinement' | 'materialCompositionRefinement' | 'priceRangeRefinement' | 'productCategoryRefinement' | 'productTypeRefinement' | 'productStyleRefinement' | 'shoeSizeRefinement' | 'statusRefinement' | 'salesChannelRefinement';
+declare type FiltersObj = {
+    brand?: string[];
+    clothingSize?: string[];
+    color?: string[];
+    condition?: string[];
+    gender?: string[];
+    jeanSize?: string[];
+    materialComposition?: string[];
+    priceRange?: string[];
+    productCategory?: string[];
+    productType?: string[];
+    productStyle?: string[];
+    shoeSize?: string[];
+    status?: string[];
+    salesChannel?: string[];
+};
+interface ProductRefinements {
+    brandRefinement?: string[];
+    clothingSizeRefinement?: string[];
+    colorRefinement?: string[];
+    conditionRefinement?: string[];
+    genderRefinement?: string[];
+    jeanSizeRefinement?: string[];
+    materialCompositionRefinement?: string[];
+    priceRangeRefinement?: string[];
+    productCategoryRefinement?: string[];
+    productTypeRefinement?: string[];
+    productStyleRefinement?: string[];
+    shoeSizeRefinement?: string[];
+    statusRefinement?: string[];
+    salesChannelRefinement?: string[];
+}
+declare type CollectionType = 'AUTOMATED' | 'MANUAL';
+declare type ProductCollectionType = {
+    createdAt?: string;
+    updatedAt?: string;
+    documentId?: string;
+    preTitle: string;
+    title: string;
+    subTitle: string;
+    description: string;
+    type: CollectionType;
+    imgUrl: string;
+    refinements: ProductRefinements;
+    tags: string[];
+    collectionId: string;
+};
+declare type CompleteProductCollection = ProductCollectionType & {
+    [key: string]: any;
+};
+declare type ProductCollectionFormFields = {
+    preTitle: TextInputFormField<string>;
+    title: TextInputFormField<string>;
+    subTitle: TextInputFormField<string>;
+    description: TextInputFormField<string>;
+    type: SingleSelectFormField<CollectionType>;
+    imgUrl: TextInputFormField<string>;
+    refinements: SingleSelectFormField<ProductRefinements>;
+    tags: MultiSelectFormField<string>;
+    collectionId: TextInputFormField<string>;
+};

package/lib/types/product-collection-types.js

@@ -0,0 +1,13 @@
+"use strict";
+// //from shopify product collection
+// type ComparisonOptions =
+//   | 'IS_EQUAL_TO'
+//   | 'IS_NOT_EQUAL_TO'
+//   | 'IS_GREATER_THAN'
+//   | 'IS_LESS_THAN'
+//   | 'STARTS_WITH'
+//   | 'ENDS_WITH'
+//   | 'CONTAINS'
+//   | 'DOES_NOT_CONTAINS'
+//   | 'IS_EMPTY'
+//   | 'IS_NOT_EMPTY';

package/lib/types/rerobe-order-types.d.ts

@@ -39,6 +39,7 @@ declare type ReRobeOrderObj = {
     shippingType: ReRobeShippingAndDeliveryTypes | string;
     shopifyId?: string | null;
     shopifyOrderNumber?: number | null;
+    ribbnOrderNumber?: number | null;
     subtotalPrice: Money;
     tags?: string[] | string | null;
     totalDiscount: Money;
@@ -62,8 +63,9 @@ declare type ReRobeOrderObj = {
     createdAt?: string;
     updatedAt?: string;
 };
-declare type OrderWithRefundsInfoObj = {
+declare type OrderWithRefundsAndFulfillmentsInfoObj = {
     documentId?: string;
+    name?: string;
     currencyCode: string;
     fulfillmentStatus?: FulfillmentStatusTypes | string;
     totalDiscount: Money;
@@ -72,11 +74,14 @@ declare type OrderWithRefundsInfoObj = {
     totalShippingPrice?: Money;
     totalTax?: Money;
     subtotalPrice: Money;
-    lineItems: ReRobeOrderLineItem[];
     discountType: string;
     shippingRate: string;
-    orderRefunds: OrderRefund[];
+    refunds: OrderRefund[];
+    activeLineItems: ReRobeOrderLineItem[];
+    unfulfilledItems: ReRobeOrderLineItem[];
+    fulfilledItems: ReRobeOrderLineItem[];
     refundedItems: ReRobeOrderLineItem[];
+    canceledItems: ReRobeOrderLineItem[];
 };
 declare type OrderInput = {
     id?: string | null;
@@ -91,10 +96,12 @@ declare type OrderInput = {
     products: CompleteProduct[];
     appliedDiscount?: AppliedDiscount;
     shopifyId?: string | null;
+    ribbnOrderNumber?: number | null;
     shopifyOrderNumber?: number | null;
     state?: ReRobeOrderStates | string | null;
     userId?: string | null;
     email?: string | null;
+    customerName?: string | null;
     tags?: string[];
     salesChannel?: SalesChannels | string | null;
     paymentDetails?: PaymentDetails | null;
@@ -201,7 +208,10 @@ interface ReRobeOrderLineItem extends OrderLineItem {
     brand?: string | null;
     productId?: string | null;
     shopifyProductId?: string | number | null;
-    refundedQuantity?: number;
+    refundedQuantity?: number | string;
+    canceledQuantity?: number | string;
+    fulfilledQuantity?: number | string;
+    unfulfilledQuantity?: number | string;
 }
 declare type OrderLineItemConnection = {
     edges: OrderLineItemEdge[];
@@ -301,8 +311,10 @@ declare type OrderRefund = {
 declare type RefundLineItem = {
     lineItem: ReRobeOrderLineItem;
     quantityRefund: number;
+    quantityCancel: number;
     discountRefund?: Money;
     subtotalRefund?: Money;
+    subtotalCanceled?: Money;
 };
 declare type TaxLine = {
     title: string;
@@ -336,7 +348,7 @@ declare type FulfillmentLineItemEdge = {
     node: FulfillmentLineItem;
 };
 declare type FulfillmentLineItem = {
-    lineItem: OrderLineItem;
+    lineItem: ReRobeOrderLineItem;
     quantity: number;
 };
 declare type FulfillmentAdmin = {
@@ -346,7 +358,7 @@ declare type FulfillmentAdmin = {
     displayStatus?: FulfillmentDisplayStatusTypes;
     deliveredAt?: string;
     estimatedDeliveryAt?: string;
-    fulfillmentLineItems: FulfillmentLineItemConnection;
+    fulfillmentLineItems: FulfillmentLineItem[] | FulfillmentLineItemConnection;
     inTransitAt?: string;
     location?: OrderLocation;
     order?: ShopifyAdminOrderObj;
@@ -480,6 +492,25 @@ declare type OrderLineItemRest = {
     total_discount_set?: MoneyBagRest;
     discount_allocations?: DiscountAllocationRest[];
     origin_location?: AddressInputRest;
+    line_item?: {
+        [key: string]: any;
+    };
+    subtotal?: number | string;
+    location_id?: string | null;
+};
+declare type RefundLineItemRest = {
+    id: number | string;
+    line_item?: {
+        [key: string]: any;
+    };
+    line_item_id: number;
+    location_id?: number | string | null;
+    quantity: number;
+    restock_type: string;
+    total_tax?: number;
+    total_tax_set?: MoneyBagRest;
+    subtotal?: number | string;
+    subtotal_set?: MoneyBagRest;
 };
 declare type CancelReasonRestTypes = 'customer' | 'declined' | 'fraud' | 'inventory' | 'other';
 declare type FinancialStatusRestTypes = 'authorized' | 'paid' | 'partially_paid' | 'partially_refunded' | 'pending' | 'refunded' | 'voided';
@@ -512,17 +543,23 @@ declare type DiscountCodeRest = {
 declare type OrderRefundRest = {
     id: number | string;
     order_id: number | string;
-    refund_line_items: OrderLineItemRest[];
+    refund_line_items: RefundLineItemRest[];
     created_at?: string;
     note?: string;
     user_id?: number | string;
     processed_at?: string;
+    order_adjustments: any[];
+    transactions: any[];
+    admin_graphql_api_id?: string | null;
+    restock?: boolean;
+    duties?: any[];
+    total_duties_set?: MoneyBagRest;
 };
 declare type AddressInputRest = {
     address1: string;
     address2?: string;
     city: string;
-    country: string;
+    country?: string;
     company?: string | null;
     first_name?: string | null;
     last_name?: string | null;
@@ -556,7 +593,7 @@ declare type FulfillmentRest = {
     service?: FulfillmentServiceRestTypes | string | null;
     shipment_status?: FulfillmentShipmentStatusRestTypes | string | null;
     status?: FulfillmentStatusRestTypes | string | null;
-    tracking_company?: string;
+    tracking_company?: string | null;
     tracking_numbers?: string[] | number[];
     tracking_urls?: string[];
     updated_at?: string;

package/lib/types/rerobe-product-types.d.ts

@@ -38,6 +38,8 @@ declare type ProductFilterAttributes = {
     productStyle: string[];
     shoeSize: string;
     measurements: Measurements;
+    featuredCollections?: string[];
+    tags?: string[];
 };
 declare type ProductConsignmentAttributes = {
     sellRequestImageUrls: string[];
@@ -66,6 +68,29 @@ declare type ProductConsignmentAttributes = {
     discountType: string;
     discountValue: string;
     selectedForClearance: string;
+    locationIds?: string[];
+};
+declare type ProductTimestampAttributes = {
+    sellRequestReviewTimestamp: number | null;
+    sellRequestReviewDraftTimestamp: number | null;
+    rejectedTimestamp: number | null;
+    holdTimestamp: number | null;
+    acceptedTimestamp: number | null;
+    sellerToDropOffTimestamp: number | null;
+    sellerToShipTimestamp: number | null;
+    sellerToGetPickUpTimestamp: number | null;
+    qualityControlTimestamp: number | null;
+    pendingPublicationTimestamp: number | null;
+    listedTimestamp: number | null;
+    clearanceTimestamp: number | null;
+    reservedTimestamp: number | null;
+    soldTimestamp: number | null;
+    returnedTimestamp: number | null;
+    soldSellerToBePaidTimestamp: number | null;
+    soldSellerPaidTimestamp: number | null;
+    sellerSelfRejectTimestamp: number | null;
+    liquidationRequestedTimestamp: number | null;
+    sellerLiquidatedTimestamp: number | null;
 };
 declare type TranslatableAttributes = {
     description: string;
@@ -120,6 +145,7 @@ declare type ProductAttributesFormFields = {
     editorAuthorizations: SingleSelectFormField<EditorAuthorization>;
     vendorId: SingleSelectFormField<string>;
     vendorName: SingleSelectFormField<string>;
+    rfidTag: TextInputFormField<string>;
 };
 declare type ProductFilterAttributesFormFields = {
     brand: SingleSelectFormField<string>;
@@ -134,6 +160,8 @@ declare type ProductFilterAttributesFormFields = {
     productType: SingleSelectFormField<string>;
     productStyle: MultiSelectFormField<string>;
     shoeSize: SingleSelectFormField<string>;
+    featuredCollections: MultiSelectFormField<string>;
+    tags: MultiSelectFormField<string>;
 };
 declare type ProductConsignmentAttributesFormFields = {
     previousSellers: MultiSelectFormField<string>;
@@ -159,6 +187,7 @@ declare type ProductConsignmentAttributesFormFields = {
     isOnSale: SingleSelectFormField<string>;
     discountType: SingleSelectFormField<string>;
     discountValue: TextInputFormField<string>;
+    locationIds: MultiSelectFormField<string>;
 };
 declare type ProductFormFields = ProductAttributesFormFields & ProductFilterAttributesFormFields & ProductConsignmentAttributesFormFields;
 interface ParamsForBuildProductInputObjForShopify {

package/lib/types/rerobe-user-types.d.ts

@@ -31,6 +31,32 @@ interface UserAttributes extends ReRobeDocument {
     lastLogin?: string;
     emailVerified: boolean;
 }
+declare type RibbnCustomerObj = {
+    uid?: string;
+    gid?: string;
+    firstName: string;
+    lastName: string;
+    displayName?: string;
+    email: string;
+    phone?: string;
+    addresses?: UserAddress;
+    availableCredit?: number;
+    createdAt?: string;
+    updatedAt?: string;
+    shoppingSessionId?: string;
+    savedItems?: string[];
+    shoppingBag?: string[];
+    avatarUrl?: string | null;
+    tags?: string[];
+    notes?: string;
+    ordersCount?: number;
+    amountSpent?: number;
+    emailVerified: boolean;
+    isSeller?: boolean;
+    devicePlatform?: string;
+    lastLogin?: string;
+    referralCode?: string;
+};
 declare type UserObjForAuthTemplateMethod = {
     authUserProfile: UserFromShopifyGraphQLResp;
     prevUserProfile: UserAttributes | undefined;
@@ -82,7 +108,7 @@ declare type AddressInput = {
     city: string;
     country?: string;
     countryCode?: string;
-    province?: string;
+    province?: string | null;
     zip?: string;
 };
 declare type AddressFormFields = {
@@ -101,23 +127,3 @@ declare type UserRespFromShopifyWebhook = {
     phone?: string;
     addresses: AddressInput[];
 };
-declare type RibbnCustomerObj = {
-    uid?: string;
-    firstName: string;
-    lastName: string;
-    displayName?: string;
-    email: string;
-    phone?: string;
-    addresses?: UserAddress;
-    availableCredit?: number;
-    createdAt?: string;
-    shoppingSessionId?: string;
-    savedItems?: string[];
-    shoppingBag?: string[];
-    avatarUrl?: string | null;
-    tags?: string[];
-    notes?: string;
-    ordersCount?: number;
-    amountSpent?: number;
-    emailVerified: boolean;
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rerobe-js-orm",
-  "version": "2.4.6",
+  "version": "2.4.8",
   "description": "ReRobe's Javascript ORM Framework",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -14,7 +14,8 @@
     "prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "postversion": "git push && git push --tags",
+    "clean": "npm run format && npm run lint"
   },
   "repository": {
     "type": "git",