@whiplashmerch/whiplash-api-client 0.4.76 → 0.4.78

package/dist/generated/index.d.ts

@@ -1,18 +1,75 @@
+export * from './AccountTransactions';
+export * from './Accounts';
+export * from './Allocations';
+export * from './Broadcasts';
 export * from './BundleItems';
+export * from './Cache';
+export * from './CarrierAccounts';
+export * from './Carriers';
+export * from './Chromalists';
 export * from './ConsumerReturns';
+export * from './Currencies';
 export * from './Customers';
+export * from './CustomsInfos';
+export * from './Dashboards';
 export * from './Documents';
+export * from './ExtApp';
+export * from './FilterSets';
+export * from './ImporterOfRecords';
+export * from './Incidents';
+export * from './InvoiceItems';
+export * from './Invoices';
 export * from './Items';
+export * from './Locales';
+export * from './LocationAdjustments';
+export * from './LocationAudits';
+export * from './LocationTransfers';
+export * from './Locations';
+export * from './Lots';
+export * from './Manifests';
+export * from './Me';
+export * from './Nav';
+export * from './NavItems';
 export * from './NotificationEvents';
 export * from './NotificationSubscriptions';
+export * from './OrderBatchItems';
+export * from './OrderBatchRequests';
+export * from './OrderBatches';
 export * from './OrderDocuments';
 export * from './OrderItems';
+export * from './OrderTotes';
 export * from './Orders';
 export * from './Originators';
+export * from './Packages';
+export * from './Partners';
+export * from './Prepacks';
+export * from './ProjectTasks';
 export * from './Projects';
+export * from './Rates';
+export * from './ReasonCodes';
+export * from './ReturnAddresses';
+export * from './RuleDismissals';
+export * from './Rules';
+export * from './Scancodes';
+export * from './SerialNumbers';
 export * from './ShipnoticeItems';
 export * from './Shipnotices';
+export * from './ShippingAliases';
+export * from './ShippingBlacklistedMethods';
+export * from './ShippingMethodMarkups';
+export * from './ShippingMethods';
+export * from './Shops';
 export * from './Simulate';
+export * from './Stats';
+export * from './SurchargeMarkups';
+export * from './TemplateTypes';
 export * from './Templates';
+export * from './Transactions';
+export * from './TransportationMarkups';
+export * from './Users';
+export * from './Utilities';
+export * from './WarehouseFeatures';
+export * from './Warehouses';
+export * from './Wholesales';
 export * from './data-contracts';
 export * from './http-client';

package/dist/index.d.ts

@@ -1 +1,4 @@
 export * from './generated';
+export * from './mocks';
+export * from './constants';
+export * from './utils';

package/dist/mocks/customer.d.ts

@@ -0,0 +1,2 @@
+import { APIV2EntitiesCustomer } from './../generated';
+export declare const customerMock: APIV2EntitiesCustomer;

package/dist/mocks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './customer';
+export * from './nav';
+export * from './user';
+export * from './warehouse';

package/dist/mocks/nav.d.ts

@@ -0,0 +1,2 @@
+import { APIV2EntitiesNav } from './../generated';
+export declare const navMock: APIV2EntitiesNav;

package/dist/mocks/user.d.ts

@@ -0,0 +1,2 @@
+import { APIV2EntitiesUser } from './../generated';
+export declare const userMock: APIV2EntitiesUser;

package/dist/mocks/warehouse.d.ts

@@ -0,0 +1,2 @@
+import { APIV2EntitiesWarehouse } from './../generated';
+export declare const warehouseMock: APIV2EntitiesWarehouse;

package/dist/utils/errorHandler.d.ts

@@ -0,0 +1,2 @@
+import { AxiosError } from 'axios';
+export declare function errorHandler(error: AxiosError): string[];

package/dist/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './errorHandler';
+export * from './nav';
+export * from './orderBatch';
+export * from './orders';
+export * from './pusher';
+export * from './rules';
+export * from './user';
+export * from './utilities';
+export * from './warehouse';

package/dist/utils/nav.d.ts

@@ -0,0 +1,9 @@
+import { searchTypes } from './../constants';
+import { APIV2EntitiesNav, APIV2EntitiesNavItem } from './../generated';
+export declare function getNavDataUrlBySlug(navItems: APIV2EntitiesNavItem[], slug: string): string | null;
+export declare function getSearchUrl(navData: APIV2EntitiesNav, searchType: searchTypes): string | null;
+export declare function getLogoutUrl(navData: APIV2EntitiesNav): string | null;
+export declare function getLocaleUrl(navData: APIV2EntitiesNav): string | null;
+export declare function getAllWarehousesUrl(navData: APIV2EntitiesNav): string | null;
+export declare function getPartnerBillingUrl(navData: APIV2EntitiesNav): string | null;
+export declare function getAllCustomersUrl(navData: APIV2EntitiesNav): string | null;

package/dist/utils/orderBatch.d.ts

@@ -0,0 +1,19 @@
+import { HttpClient } from '../generated';
+export interface ApiV21OrderBatchesIdPackedPercentResult {
+    result?: number;
+}
+export interface ApiV21OrderBatchIdPublicPDFURLResult {
+    result: string | null;
+}
+export interface OrderBatchSummary {
+    prepacked: boolean;
+    labels_scheduled: boolean;
+    any_processing_orders: boolean;
+}
+export declare const getApiV21OrderBatchesIdPackedPercent: (client: HttpClient, orderBatchId: number) => Promise<ApiV21OrderBatchesIdPackedPercentResult>;
+export declare const getApiV21OrderBatchesIdSummary: (client: HttpClient, orderBatchId: number) => Promise<OrderBatchSummary>;
+export declare const getApiV21OrderBatchesIdPublicPackingslipUrl: (client: HttpClient, orderBatchId: number) => Promise<ApiV21OrderBatchIdPublicPDFURLResult>;
+export declare const getApiV21OrderBatchesIdPublicPicklistUrl: (client: HttpClient, orderBatchId: number) => Promise<ApiV21OrderBatchIdPublicPDFURLResult>;
+export declare const putApiV21OrderBatchesIdReleaseUnshipped: (client: HttpClient, orderBatchId: number) => Promise<void>;
+export declare const putApiV21OrderBatchesIdForcePick: (client: HttpClient, orderBatchId: number) => Promise<void>;
+export declare const putApiV21OrderBatchesIdbuyLabels: (client: HttpClient, orderBatchId: number) => Promise<void>;

package/dist/utils/orders.d.ts

@@ -0,0 +1,54 @@
+import { APIV21EntitiesItem, APIV21EntitiesOrderItem, HttpClient } from './../generated';
+import { ApiV21EntitiesPackingRuleWithSuggestedItem } from './rules';
+export interface ApiV21OrdersIdPackItemArgs {
+    args: {
+        scancode?: string;
+        quantity?: number;
+        packaging?: boolean;
+        passthrough_response: boolean;
+        set_contents_label_printed?: boolean;
+        flow: string;
+    };
+}
+export interface ApiV21OrdersIdPackItemResult {
+    result: {
+        order_item?: APIV21EntitiesOrderItem;
+        item?: APIV21EntitiesItem;
+    };
+}
+export interface ApiV21OrderIdSuggestedRulesResult {
+    result: ApiV21EntitiesPackingRuleWithSuggestedItem[] | null;
+}
+export interface ApiV21OrderIdCommercialInvoiceResult {
+    result: {
+        print_commercial_invoice: boolean;
+        url: string | null;
+    };
+}
+export interface ApiV21OrderIdPublicPackingslipResult {
+    result: string | null;
+}
+export interface ApiV21OrderIdPublicOrderInsertResult {
+    result: string | null;
+}
+export interface ApiV21OrderIdHasOuterPackagingResult {
+    result: boolean;
+}
+export interface ApiV21OrderIdToteCodeResult {
+    result: string | null;
+}
+export interface ApiV21OrderIdHasGlobalEResult {
+    result: boolean;
+}
+export interface APIV21OrderIdSkipsPackingslipResult {
+    result: boolean;
+}
+export declare const putApiV21OrdersIdPackItem: (client: HttpClient, orderId: number, args: ApiV21OrdersIdPackItemArgs) => Promise<ApiV21OrdersIdPackItemResult>;
+export declare const getApiV21OrdersIdPackingRulesWithSuggestedItems: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdSuggestedRulesResult>;
+export declare const getApiV21OrdersIdCommercialInvoice: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdCommercialInvoiceResult>;
+export declare const getApiV21OrdersIdHasGlobalEInvoice: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdHasGlobalEResult>;
+export declare const getApiV21OrdersIdSkipPackingslip: (client: HttpClient, orderId: number) => Promise<APIV21OrderIdSkipsPackingslipResult>;
+export declare const getApiV21OrdersIdPublicPackingslipUrl: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdPublicPackingslipResult>;
+export declare const getApiV21OrdersIdPublicInsertUrl: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdPublicOrderInsertResult>;
+export declare const getApiV21OrdersIdHasOuterPackaging: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdHasOuterPackagingResult>;
+export declare const getApiV21OrdersIdToteCode: (client: HttpClient, orderId: number) => Promise<ApiV21OrderIdToteCodeResult>;

package/dist/utils/pusher.d.ts

@@ -0,0 +1,25 @@
+import type Pusher from 'pusher-js';
+import type { Channel } from 'pusher-js';
+export interface PusherResponse {
+    message: string;
+}
+export interface PusherBroadcast {
+    id: string;
+    title: string;
+    body: string;
+    variant?: string;
+}
+export declare enum PusherBatchResponses {
+    death = "death",
+    allJobsComplete = "allJobsComplete",
+    allJobsSucceeded = "allJobsSucceeded",
+    singleJobFailed = "singleJobFailed",
+    singleJobSucceeded = "singleJobSucceeded"
+}
+export declare function getUserChannelName(userId: number, pusherPrefix?: string): string;
+export declare function subscribe<R = unknown>(pusherInstance: Pusher, channelName: string, callback?: (response: R) => void): Channel;
+export declare function unsubscribe(pusherInstance: Pusher, channelName: string): void;
+export declare function waitForBatch(pusherInstance: Pusher, batchChannelName: string): Promise<void>;
+export declare function subscribeToUserChannel(pusherInstance: Pusher, userId: number, callback: (response: PusherResponse) => void, pusherPrefix?: string): Channel;
+export declare function unsubscribeFromUserChannel(pusherInstance: Pusher, userId: number, pusherPrefix?: string): void;
+export declare function getBroadcastFromPusherResponse({ message }: PusherResponse): PusherBroadcast;

package/dist/utils/rules.d.ts

@@ -0,0 +1,8 @@
+import { APIV21EntitiesItem, APIV21EntitiesRule } from './../generated';
+export interface ApiV21EntitiesPackingRuleWithSuggestedItem extends APIV21EntitiesRule {
+    rule_dismissal_id?: number;
+    item_id?: number;
+    state: string;
+    quantity: number;
+    suggested_item: APIV21EntitiesItem;
+}

package/dist/utils/user.d.ts

@@ -0,0 +1,19 @@
+import { APIV21EntitiesCustomer, APIV21EntitiesUser, APIV21EntitiesWarehouse, HttpClient, RequestParams } from './../generated';
+export interface UserSummary {
+    entity: APIV21EntitiesUser;
+    current_customer: APIV21EntitiesCustomer | null;
+    current_warehouse: APIV21EntitiesWarehouse | null;
+}
+export declare const getUserSummary: (client: HttpClient, userId: number, params?: RequestParams) => Promise<UserSummary>;
+export interface SetUserCustomerParams {
+    userId: number;
+    customerId: number;
+}
+export declare const setUserCustomer: (client: HttpClient, { userId, customerId }: SetUserCustomerParams, params?: RequestParams) => Promise<void>;
+export declare const unsetUserCustomer: (client: HttpClient, userId: number, params?: RequestParams) => Promise<void>;
+export interface SetUserWarehouseParams {
+    userId: number;
+    warehouseId: number;
+}
+export declare const setUserWarehouse: (client: HttpClient, { userId, warehouseId }: SetUserWarehouseParams, params?: RequestParams) => Promise<void>;
+export declare const unsetUserWarehouse: (client: HttpClient, userId: number, params?: RequestParams) => Promise<void>;

package/dist/utils/utilities.d.ts

@@ -0,0 +1,8 @@
+import { HttpClient } from '../generated';
+export interface ApiV21PublicUrlParams {
+    url: string;
+}
+export interface ApiV21PublicUrlResult {
+    result?: string;
+}
+export declare const postApiV21UtilsPublicUrl: (client: HttpClient, params: ApiV21PublicUrlParams) => Promise<ApiV21PublicUrlResult>;

package/dist/utils/warehouse.d.ts

@@ -0,0 +1,26 @@
+import { HttpClient, ApiV21EntitiesLocationRole, APIV2EntitiesSidekiqBatch } from './../generated';
+export interface CallAsyncProcessShelfToShelfTransferParams {
+    args: {
+        source_shelf: string;
+        destination_shelf: string;
+        user_id: number;
+        warehouse_id: number;
+        convert_to_role?: ApiV21EntitiesLocationRole;
+        quantity?: number;
+        item_id?: number;
+        loc_name_change?: boolean;
+        raise_errors: boolean;
+        initiator?: string;
+    };
+    retry?: number | false;
+}
+export declare const putProcessShelfToShelfTransfer: (client: HttpClient, params: CallAsyncProcessShelfToShelfTransferParams) => Promise<APIV2EntitiesSidekiqBatch>;
+export interface CallTraitOpenBatchesAgainstShelfParams {
+    args: {
+        shelf_name: string;
+    };
+}
+export interface ApiV21WarehousesIdOpenBatchesAgainstShelfResult {
+    result?: string[];
+}
+export declare const getWarehouseIdOpenBatchesAgainstShelf: (client: HttpClient, warehouseId: number, params: CallTraitOpenBatchesAgainstShelfParams) => Promise<ApiV21WarehousesIdOpenBatchesAgainstShelfResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whiplashmerch/whiplash-api-client",
-  "version": "0.4.76",
+  "version": "0.4.78",
   "description": "",
   "devDependencies": {},
   "scripts": {