@whiplashmerch/whiplash-api-client 2.0.36 → 3.0.0

package/dist/mock-data/v2_1/consumer-return/in-transit.d.ts

@@ -8,9 +8,9 @@ export declare const ApiV21ConsumerReturnInTransitExample: {
     status: number;
     status_name: string;
     received_by: null;
-    notes_by_whiplash: null;
-    notes_by_customer: null;
-    total_boxes: number;
+    notes_by_whiplash: string;
+    notes_by_customer: string;
+    total_boxes: null;
     created_at: string;
     updated_at: string;
     arrived_at: null;
@@ -20,8 +20,7 @@ export declare const ApiV21ConsumerReturnInTransitExample: {
     shipping_label_url: null;
     ship_actual_cost: null;
     shipping_method_text: null;
-    carrier: null;
-    tracking: null;
+    tracking: string;
     type: string;
     postage_billed: null;
     handling_billed: null;
@@ -32,126 +31,14 @@ export declare const ApiV21ConsumerReturnInTransitExample: {
     delivered_at: null;
     due_at: null;
     reference: null;
-    customer: {
-        id: number;
-        name: string;
-        created_at: string;
-        active: boolean;
-        auto_merge_gestation: null;
-        default_warehouse_id: number;
-        eori_number: null;
-        estimated_monthly_volume: null;
-        fedex_account: null;
-        from_email: null;
-        instructions: null;
-        item_scanning_preference: boolean;
-        label_format: null;
-        notes: null;
-        notify_originator: boolean;
-        notify_originator_inventory: number;
-        originator_permissions: boolean;
-        packing_slip_msg: null;
-        packingslip_template: null;
-        request_serial_numbers: boolean;
-        ship_method_preference: number;
-        shipping_name: string;
-        ups_account: null;
-        vat_number: null;
-        ein: null;
-        warehouse_fallback: number;
-        payment_hold: boolean;
-        account_level: number;
-        account_level_name: null;
-        whitelisted_warehouses: {
-            id: number;
-            name: string;
-            timezone: string;
-            shipping_address_1: string;
-            shipping_address_2: string;
-            shipping_city: string;
-            shipping_state: string;
-            shipping_zip: string;
-            shipping_country: string;
-            shipping_country_iso2: string;
-            latitude: number;
-            longitude: number;
-        }[];
-        activated_at: string;
-        deactivated_at: null;
-        auto_merge_skus: boolean;
-        billing_email: string;
-        billing_contact_name: string;
-        billing_company: null;
-        billing_phone1: null;
-        billing_phone2: null;
-        billing_address1: string;
-        billing_address2: null;
-        billing_address3: null;
-        billing_city: string;
-        billing_state: string;
-        billing_zip: string;
-        billing_country: string;
-        billing_residential: null;
-        items_returnable: boolean;
-        allow_international_returns: boolean;
-        items_exchangeable: boolean;
-        return_time_limit: number;
-        return_label_expires_in: number;
-        return_price_restricted: boolean;
-        return_sku_match: null;
-        rma_display_logo: boolean;
-        rma_footer_content: null;
-        return_name: null;
-        return_company: null;
-        return_email: null;
-        return_phone: null;
-        return_address_1: null;
-        return_address_2: null;
-        return_city: null;
-        return_state: null;
-        return_zip: null;
-        return_country: null;
-        supports_return_labels: boolean;
-        logo_content_type: null;
-        logo_file_name: null;
-        logo_file_size: null;
-        logo_updated_at: null;
-        full_logo_url: string;
-        email_confirmation_from: string;
-        email_confirmation_name: string;
-        email_confirmation_msg: null;
-        email_confirmation_preference: number;
-        email_confirmation_template: null;
-        low_inventory_threshold: null;
-        lot_control: boolean;
-        expiration_period: null;
-        ship_strategy: number;
-        items_unavailable_on_sellout: number;
-        replenishment_min: null;
-        replenishment_target: null;
-    };
-    warehouse: {
-        id: number;
-        name: string;
-        timezone: string;
-        shipping_address_1: string;
-        shipping_address_2: string;
-        shipping_city: string;
-        shipping_state: string;
-        shipping_zip: string;
-        shipping_country: string;
-        shipping_country_iso2: string;
-        latitude: number;
-        longitude: number;
-    };
     originator: {
         id: number;
-        originated_id: number;
+        originated_id: null;
         originated_type: string;
         shop_id: null;
         provider: string;
-        original_id: null;
-        group_id: null;
+        original_id: string;
+        group_id: string;
         misc: null;
         active: boolean;
         integration_id: null;
@@ -160,385 +47,8 @@ export declare const ApiV21ConsumerReturnInTransitExample: {
         distinct_originator_key: null;
         created_at: string;
         updated_at: string;
-        application_id: null;
-    };
-    return_items: {
-        id: number;
-        item_id: number;
-        name: string;
-        sku: string;
-        price: string;
-        quantity: number;
-        quantity_good: number;
-        quantity_damaged: number;
-        description: string;
-        extended_description: null;
-        return_action: string;
-        order_item_id: number;
-        return_item_originator_id: null;
-        originator_id: null;
-        lot_ids: never[];
-    }[];
-    exchange_order: {
-        id: number;
-        customer_id: number;
-        order_batch_id: null;
-        quote_id: null;
-        warehouse_id: number;
-        return_warehouse_id: number;
-        shipping_method_id: null;
-        estimated_shipping_method_id: null;
-        humanize_id: string;
-        status: number;
-        status_name: string;
-        previous_status: number;
-        order_orig: string;
-        level1_token: string;
-        level2_token: string;
-        workable_at: string;
-        skip_street_date: boolean;
-        due_at: string;
-        created_at: string;
-        updated_at: string;
-        meta_data: null;
-        customer_provided_label_carrier: null;
-        purchase_order: null;
-        email: string;
-        address_verified: boolean;
-        address_message: null;
-        shop_warehouse_ids: never[];
-        shop_shipping_method_currency: null;
-        shop_created_at: null;
-        shop_updated_at: null;
-        shop_shipping_method_text: null;
-        shop_shipping_method_price: string;
-        billing_company: null;
-        billing_address_1: null;
-        billing_address_2: null;
-        billing_address_3: null;
-        billing_city: null;
-        billing_state: null;
-        billing_zip: null;
-        billing_country: null;
-        billing_phone: null;
-        billed: boolean;
-        billing_name: null;
-        first_name: null;
-        last_name: null;
-        full_name: null;
-        shipping_name: string;
-        shipping_company: null;
-        shipping_address_1: string;
-        shipping_address_2: null;
-        shipping_city: string;
-        shipping_state: string;
-        shipping_zip: string;
-        shipping_country: string;
-        shipping_country_iso2: string;
-        shipping_phone: null;
-        requested_address: string;
-        residential: boolean;
-        require_signature: boolean;
-        require_adult_signature: boolean;
-        saturday_delivery: boolean;
-        gift: boolean;
-        insure: boolean;
-        contains_alcohol: boolean;
-        ship_actual_cost: null;
-        shipped_on: null;
-        ship_notes: null;
-        shipping_confirmation_sent: boolean;
-        ship_3rdparty_cost: string;
-        ship_3rdparty_account: null;
-        ship_3rdparty_zip: null;
-        ship_3rdparty_country: null;
-        incoterm: null;
-        public_note: null;
-        days_in_transit: number;
-        days_in_transit_carrier_estimate: null;
-        req_insurance_value: null;
-        ship_method: null;
-        packingslip_pdf_url: null;
-        tracking: never[];
-        tracking_links: string[];
-        approximate_delivery_date: null;
-        return_name: null;
-        return_company: null;
-        return_address_1: null;
-        return_address_2: null;
-        return_city: null;
-        return_state: null;
-        return_country: null;
-        return_zip: null;
-        return_phone: null;
-        return_email: null;
-        return_address_verified: null;
-        return_time_limit: null;
-        order_items: {
-            id: number;
-            order_id: number;
-            customer_id: number;
-            item_id: number;
-            package_id: number;
-            quote_item_id: null;
-            sku: string;
-            description: string;
-            quantity: number;
-            price: string;
-            created_at: string;
-            updated_at: string;
-            unshippable: boolean;
-            available: boolean;
-            packed: number;
-            packaging: boolean;
-            wholesale_cost: null;
-            is_bundle: boolean;
-            retail_fee: null;
-            promo: boolean;
-            returnable: null;
-            currency: string;
-            wholesale_fee: null;
-            hazmat: boolean;
-            misc: null;
-            originator: {
-                id: number;
-                originated_id: number;
-                originated_type: string;
-                shop_id: null;
-                provider: string;
-                original_id: null;
-                group_id: null;
-                misc: null;
-                active: boolean;
-                integration_id: null;
-                last_notified_at: null;
-                last_notification_status: null;
-                distinct_originator_key: null;
-                created_at: string;
-                updated_at: string;
-                application_id: null;
-            };
-        }[];
-        originator: {
-            id: number;
-            originated_id: number;
-            originated_type: string;
-            shop_id: null;
-            provider: string;
-            original_id: null;
-            group_id: null;
-            misc: null;
-            active: boolean;
-            integration_id: null;
-            last_notified_at: null;
-            last_notification_status: null;
-            distinct_originator_key: null;
-            created_at: string;
-            updated_at: string;
-            application_id: null;
-        };
-        proto_originator_id: null;
-        packages: {
-            id: number;
-            order_id: number;
-            shipped_on: null;
-            ship_actual_cost: null;
-            actual_weight: null;
-            actual_width: null;
-            actual_height: null;
-            actual_length: null;
-            actual_dimensional_weight: null;
-            tracking: null;
-            tracking_link: string;
-            order_item_ids: number[];
-            created_at: string;
-            updated_at: string;
-            ucc128: null;
-            barcode_sscc18: string;
-            ship_actual_currency: null;
-        }[];
-        shipping_method: null;
-        serial_numbers: never[];
-    };
-    order: {
-        id: number;
-        customer_id: number;
-        order_batch_id: null;
-        quote_id: null;
-        warehouse_id: number;
-        return_warehouse_id: number;
-        shipping_method_id: null;
-        estimated_shipping_method_id: null;
-        humanize_id: string;
-        status: number;
-        status_name: string;
-        previous_status: number;
-        order_orig: string;
-        level1_token: string;
-        level2_token: string;
-        workable_at: string;
-        skip_street_date: boolean;
-        due_at: string;
-        created_at: string;
-        updated_at: string;
-        meta_data: null;
-        customer_provided_label_carrier: null;
-        purchase_order: null;
-        email: string;
-        address_verified: boolean;
-        address_message: null;
-        shop_warehouse_ids: never[];
-        shop_shipping_method_currency: null;
-        shop_created_at: null;
-        shop_updated_at: null;
-        shop_shipping_method_text: null;
-        shop_shipping_method_price: string;
-        billing_company: null;
-        billing_address_1: null;
-        billing_address_2: null;
-        billing_address_3: null;
-        billing_city: null;
-        billing_state: null;
-        billing_zip: null;
-        billing_country: null;
-        billing_phone: null;
-        billed: boolean;
-        billing_name: null;
-        first_name: null;
-        last_name: null;
-        full_name: null;
-        shipping_name: string;
-        shipping_company: null;
-        shipping_address_1: string;
-        shipping_address_2: null;
-        shipping_city: string;
-        shipping_state: string;
-        shipping_zip: string;
-        shipping_country: string;
-        shipping_country_iso2: string;
-        shipping_phone: null;
-        requested_address: string;
-        residential: boolean;
-        require_signature: boolean;
-        require_adult_signature: boolean;
-        saturday_delivery: boolean;
-        gift: boolean;
-        insure: boolean;
-        contains_alcohol: boolean;
-        ship_actual_cost: null;
-        shipped_on: null;
-        ship_notes: null;
-        shipping_confirmation_sent: boolean;
-        ship_3rdparty_cost: string;
-        ship_3rdparty_account: null;
-        ship_3rdparty_zip: null;
-        ship_3rdparty_country: null;
-        incoterm: null;
-        public_note: null;
-        days_in_transit: number;
-        days_in_transit_carrier_estimate: null;
-        req_insurance_value: null;
-        ship_method: null;
-        packingslip_pdf_url: null;
-        tracking: never[];
-        tracking_links: string[];
-        approximate_delivery_date: null;
-        return_name: null;
-        return_company: null;
-        return_address_1: null;
-        return_address_2: null;
-        return_city: null;
-        return_state: null;
-        return_country: null;
-        return_zip: null;
-        return_phone: null;
-        return_email: null;
-        return_address_verified: null;
-        return_time_limit: null;
-        order_items: {
-            id: number;
-            order_id: number;
-            customer_id: number;
-            item_id: number;
-            package_id: number;
-            quote_item_id: null;
-            sku: string;
-            description: string;
-            quantity: number;
-            price: string;
-            created_at: string;
-            updated_at: string;
-            unshippable: boolean;
-            available: boolean;
-            packed: number;
-            packaging: boolean;
-            wholesale_cost: null;
-            is_bundle: boolean;
-            retail_fee: null;
-            promo: boolean;
-            returnable: null;
-            currency: string;
-            wholesale_fee: null;
-            hazmat: boolean;
-            misc: null;
-            originator: {
-                id: number;
-                originated_id: number;
-                originated_type: string;
-                shop_id: null;
-                provider: string;
-                original_id: null;
-                group_id: null;
-                misc: null;
-                active: boolean;
-                integration_id: null;
-                last_notified_at: null;
-                last_notification_status: null;
-                distinct_originator_key: null;
-                created_at: string;
-                updated_at: string;
-                application_id: null;
-            };
-        }[];
-        originator: {
-            id: number;
-            originated_id: number;
-            originated_type: string;
-            shop_id: null;
-            provider: string;
-            original_id: null;
-            group_id: null;
-            misc: null;
-            active: boolean;
-            integration_id: null;
-            last_notified_at: null;
-            last_notification_status: null;
-            distinct_originator_key: null;
-            created_at: string;
-            updated_at: string;
-            application_id: null;
-        };
-        proto_originator_id: null;
-        packages: {
-            id: number;
-            order_id: number;
-            shipped_on: null;
-            ship_actual_cost: null;
-            actual_weight: null;
-            actual_width: null;
-            actual_height: null;
-            actual_length: null;
-            actual_dimensional_weight: null;
-            tracking: null;
-            tracking_link: string;
-            order_item_ids: number[];
-            created_at: string;
-            updated_at: string;
-            ucc128: null;
-            barcode_sscc18: string;
-            ship_actual_currency: null;
-        }[];
-        shipping_method: null;
-        serial_numbers: never[];
+        application_id: number;
     };
+    customer_name: string;
+    warehouse_name: string;
 };

package/dist/mock-data/v2_1/importer-of-record/created.d.ts

@@ -0,0 +1 @@
+export declare const ApiV21ImporterOfRecordCreatedExample = "{\"id\":123}";

package/dist/mock-data/v2_1/item/bundle.d.ts

@@ -0,0 +1,60 @@
+export declare const ApiV21ItemBundleExample: {
+    id: number;
+    sku: string;
+    title: string;
+    description: string;
+    full_description: string;
+    created_at: string;
+    updated_at: string;
+    customer_id: number;
+    quantity: number;
+    weight: string;
+    available: boolean;
+    image_originator_url: null;
+    vendor: null;
+    scancode: string;
+    price: string;
+    media_mail: boolean;
+    packaging: boolean;
+    length: string;
+    width: string;
+    height: string;
+    active: boolean;
+    wholesale_cost: null;
+    is_bundle: boolean;
+    packaging_type: null;
+    promo: boolean;
+    street_date: null;
+    category: null;
+    include_inbound_in_published: boolean;
+    returnable: null;
+    return_sku_match: null;
+    return_price_restricted: null;
+    request_serial_number: null;
+    currency: null;
+    tariff_number: null;
+    notify_originator_inventory: null;
+    name: string;
+    nmfc_code: null;
+    nmfc_class: null;
+    commodity_description: null;
+    image_url: null;
+    hazmat: boolean;
+    hazmat_type: null;
+    misc: null;
+    ean: null;
+    lot_control: boolean;
+    expiration_period: null;
+    ship_strategy: number;
+    velocity: number;
+    case_quantity: null;
+    carton_quantity: null;
+    origin_country: null;
+    alcohol: boolean;
+    shippable_container: boolean;
+    goh: boolean;
+    label_format: null;
+    replenishment_min: null;
+    replenishment_target: null;
+    low_inventory_threshold: null;
+}[];

package/dist/mock-data/v2_1/item/merch.d.ts

@@ -0,0 +1,119 @@
+export declare const ApiV21ItemMerchExample: ({
+    id: number;
+    sku: string;
+    title: string;
+    description: string;
+    full_description: string;
+    created_at: string;
+    updated_at: string;
+    customer_id: number;
+    quantity: number;
+    weight: string;
+    available: boolean;
+    image_originator_url: null;
+    vendor: null;
+    scancode: string;
+    price: string;
+    media_mail: boolean;
+    packaging: boolean;
+    length: string;
+    width: string;
+    height: string;
+    active: boolean;
+    wholesale_cost: null;
+    is_bundle: boolean;
+    packaging_type: null;
+    promo: boolean;
+    street_date: null;
+    category: null;
+    include_inbound_in_published: boolean;
+    returnable: null;
+    return_sku_match: null;
+    return_price_restricted: null;
+    request_serial_number: null;
+    currency: null;
+    tariff_number: null;
+    notify_originator_inventory: null;
+    name: string;
+    nmfc_code: null;
+    nmfc_class: null;
+    commodity_description: null;
+    image_url: null;
+    hazmat: boolean;
+    hazmat_type: null;
+    misc: null;
+    ean: null;
+    lot_control: boolean;
+    expiration_period: null;
+    ship_strategy: number;
+    velocity: number;
+    case_quantity: null;
+    carton_quantity: null;
+    origin_country: null;
+    alcohol: boolean;
+    shippable_container: boolean;
+    goh: boolean;
+    label_format: null;
+    replenishment_min: null;
+    replenishment_target: null;
+    low_inventory_threshold: null;
+} | {
+    id: number;
+    sku: string;
+    title: string;
+    description: string;
+    full_description: string;
+    created_at: string;
+    updated_at: string;
+    customer_id: number;
+    quantity: number;
+    weight: string;
+    available: boolean;
+    image_originator_url: null;
+    vendor: null;
+    scancode: string;
+    price: string;
+    media_mail: boolean;
+    packaging: boolean;
+    length: string;
+    width: string;
+    height: string;
+    active: boolean;
+    wholesale_cost: null;
+    is_bundle: boolean;
+    packaging_type: string;
+    promo: boolean;
+    street_date: null;
+    category: null;
+    include_inbound_in_published: boolean;
+    returnable: null;
+    return_sku_match: null;
+    return_price_restricted: null;
+    request_serial_number: null;
+    currency: null;
+    tariff_number: null;
+    notify_originator_inventory: null;
+    name: string;
+    nmfc_code: null;
+    nmfc_class: null;
+    commodity_description: null;
+    image_url: null;
+    hazmat: boolean;
+    hazmat_type: null;
+    misc: null;
+    ean: null;
+    lot_control: boolean;
+    expiration_period: null;
+    ship_strategy: number;
+    velocity: number;
+    case_quantity: null;
+    carton_quantity: null;
+    origin_country: null;
+    alcohol: boolean;
+    shippable_container: boolean;
+    goh: boolean;
+    label_format: null;
+    replenishment_min: null;
+    replenishment_target: null;
+    low_inventory_threshold: null;
+})[];