@whiplashmerch/whiplash-api-client 3.0.11 → 3.0.13

package/dist/generated/LoadScacs.d.ts

@@ -0,0 +1,110 @@
+import { ApiV21EntitiesCount, ApiV21EntitiesLoadScac, ApiV21EntitiesPostResponse, ApiV2EntitiesCount, ApiV2EntitiesLoadScac, GetApiV21LoadScacsCountParams, GetApiV21LoadScacsParams, GetApiV2LoadScacsCountParams, GetApiV2LoadScacsParams, PostApiV21LoadScacsRequest, PostApiV2LoadScacsRequest, PutApiV21LoadScacsIdRequest, PutApiV2LoadScacsIdRequest } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get a list of load scacs
+ *
+ * @tags load_scacs
+ * @name GetApiV2LoadScacs
+ * @summary List all load scacs
+ * @request GET:/api/v2/load_scacs
+ */
+export declare const getApiV2LoadScacs: (client: HttpClient, query: GetApiV2LoadScacsParams, params?: RequestParams) => Promise<ApiV2EntitiesLoadScac[]>;
+/**
+ * @description Create a load_scac
+ *
+ * @tags load_scacs
+ * @name PostApiV2LoadScacs
+ * @summary Create a load_scac
+ * @request POST:/api/v2/load_scacs
+ */
+export declare const postApiV2LoadScacs: (client: HttpClient, data: PostApiV2LoadScacsRequest, params?: RequestParams) => Promise<ApiV2EntitiesLoadScac>;
+/**
+ * @description Returns count of load scacs
+ *
+ * @tags load_scacs
+ * @name GetApiV2LoadScacsCount
+ * @summary Count load scacs
+ * @request GET:/api/v2/load_scacs/count
+ */
+export declare const getApiV2LoadScacsCount: (client: HttpClient, query: GetApiV2LoadScacsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description Get a load_scac
+ *
+ * @tags load_scacs
+ * @name GetApiV2LoadScacsId
+ * @summary Retrieve a load_scac
+ * @request GET:/api/v2/load_scacs/{id}
+ */
+export declare const getApiV2LoadScacsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesLoadScac>;
+/**
+ * @description Update a load_scac
+ *
+ * @tags load_scacs
+ * @name PutApiV2LoadScacsId
+ * @summary Update a load_scac
+ * @request PUT:/api/v2/load_scacs/{id}
+ */
+export declare const putApiV2LoadScacsId: (client: HttpClient, id: number, data: PutApiV2LoadScacsIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesLoadScac>;
+/**
+ * @description Destroy a load_scac
+ *
+ * @tags load_scacs
+ * @name DeleteApiV2LoadScacsId
+ * @summary Destroy a load_scac
+ * @request DELETE:/api/v2/load_scacs/{id}
+ */
+export declare const deleteApiV2LoadScacsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get a list of load scacs
+ *
+ * @tags load_scacs
+ * @name GetApiV21LoadScacs
+ * @summary List all load scacs
+ * @request GET:/api/v2.1/load_scacs
+ */
+export declare const getApiV21LoadScacs: (client: HttpClient, query: GetApiV21LoadScacsParams, params?: RequestParams) => Promise<ApiV21EntitiesLoadScac[]>;
+/**
+ * @description Create a load_scac
+ *
+ * @tags load_scacs
+ * @name PostApiV21LoadScacs
+ * @summary Create a load_scac
+ * @request POST:/api/v2.1/load_scacs
+ */
+export declare const postApiV21LoadScacs: (client: HttpClient, data: PostApiV21LoadScacsRequest, params?: RequestParams) => Promise<ApiV21EntitiesPostResponse>;
+/**
+ * @description Returns count of load scacs
+ *
+ * @tags load_scacs
+ * @name GetApiV21LoadScacsCount
+ * @summary Count load scacs
+ * @request GET:/api/v2.1/load_scacs/count
+ */
+export declare const getApiV21LoadScacsCount: (client: HttpClient, query: GetApiV21LoadScacsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
+/**
+ * @description Get a load_scac
+ *
+ * @tags load_scacs
+ * @name GetApiV21LoadScacsId
+ * @summary Retrieve a load_scac
+ * @request GET:/api/v2.1/load_scacs/{id}
+ */
+export declare const getApiV21LoadScacsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesLoadScac>;
+/**
+ * @description Update a load_scac
+ *
+ * @tags load_scacs
+ * @name PutApiV21LoadScacsId
+ * @summary Update a load_scac
+ * @request PUT:/api/v2.1/load_scacs/{id}
+ */
+export declare const putApiV21LoadScacsId: (client: HttpClient, id: number, data: PutApiV21LoadScacsIdRequest, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a load_scac
+ *
+ * @tags load_scacs
+ * @name DeleteApiV21LoadScacsId
+ * @summary Destroy a load_scac
+ * @request DELETE:/api/v2.1/load_scacs/{id}
+ */
+export declare const deleteApiV21LoadScacsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/data-contracts.d.ts

@@ -432,7 +432,6 @@ export interface ApiV2EntitiesBundleItem {
 }
 /** V2 */
 export interface ApiV2EntitiesCarrier {
-    carrier_aliases?: ApiV2EntitiesCarrierAlias;
     /** Does this carrier support electronic trade documents? */
     etd_enabled?: boolean | null;
     /**
@@ -526,22 +525,6 @@ export interface ApiV2EntitiesCarrierAccount {
     warehouses?: ApiV2EntitiesWarehouse;
 }
 /** V2 */
-export interface ApiV2EntitiesCarrierAlias {
-    /** carrier alias slug */
-    context?: string | null;
-    /**
-     * carrier alias object id
-     * @format int32
-     */
-    id?: number;
-    /** carrier alias object name */
-    name?: string | null;
-    /** carrier owner name */
-    owner_name?: string | null;
-    /** carrier SCAC code */
-    scac?: string | null;
-}
-/** V2 */
 export interface ApiV2EntitiesChromalist {
     /** white-, black-, etc-list */
     chroma?: ApiV2EntitiesChromalistChroma;
@@ -2306,6 +2289,27 @@ export interface ApiV2EntitiesLoad {
     wholesale_vendor?: string | null;
 }
 /** V2 */
+export interface ApiV2EntitiesLoadScac {
+    /** the carrier associated with this load scac */
+    carrier?: string | null;
+    /** the ccid for the load scac */
+    ccid?: string | null;
+    /**
+     * the id of the customer associated with this load scac
+     * @format int32
+     */
+    customer_id?: number | null;
+    /** customer name of the load scac */
+    customer_name?: string | null;
+    /**
+     * load scac object id
+     * @format int32
+     */
+    id?: number;
+    /** SCAC code */
+    scac?: string | null;
+}
+/** V2 */
 export interface ApiV2EntitiesLocation {
     /** is this location active? */
     active?: boolean | null;
@@ -3091,7 +3095,7 @@ export interface ApiV2EntitiesOrder {
      */
     shop_updated_at?: string | null;
     shop_warehouse_ids?: number[];
-    /** skip order shipping address verification? (staff only) */
+    /** skip order shipping address verification? */
     skip_address_verification?: boolean | null;
     /** skip street date for this order? */
     skip_street_date?: boolean | null;
@@ -6322,7 +6326,6 @@ export interface ApiV21EntitiesBundleItem {
 }
 /** V3 */
 export interface ApiV21EntitiesCarrier {
-    carrier_aliases?: ApiV21EntitiesCarrierAlias;
     /** Does this carrier support electronic trade documents? */
     etd_enabled?: boolean | null;
     /**
@@ -6416,22 +6419,6 @@ export interface ApiV21EntitiesCarrierAccount {
     warehouse_ids?: number[];
 }
 /** V3 */
-export interface ApiV21EntitiesCarrierAlias {
-    /** carrier alias slug */
-    context?: string | null;
-    /**
-     * carrier alias object id
-     * @format int32
-     */
-    id?: number;
-    /** carrier alias object name */
-    name?: string | null;
-    /** carrier owner name */
-    owner_name?: string | null;
-    /** carrier SCAC code */
-    scac?: string | null;
-}
-/** V3 */
 export interface ApiV21EntitiesChromalist {
     /** white-, black-, etc-list */
     chroma?: ApiV21EntitiesChromalistChroma;
@@ -7584,6 +7571,27 @@ export interface ApiV21EntitiesLoad {
     wholesale_vendor?: string | null;
 }
 /** V3 */
+export interface ApiV21EntitiesLoadScac {
+    /** the carrier associated with this load scac */
+    carrier?: string | null;
+    /** the ccid for the load scac */
+    ccid?: string | null;
+    /**
+     * the id of the customer associated with this load scac
+     * @format int32
+     */
+    customer_id?: number | null;
+    /** customer name of the load scac */
+    customer_name?: string | null;
+    /**
+     * load scac object id
+     * @format int32
+     */
+    id?: number;
+    /** SCAC code */
+    scac?: string | null;
+}
+/** V3 */
 export interface ApiV21EntitiesLocation {
     /** is this location active? */
     active?: boolean | null;
@@ -8367,7 +8375,7 @@ export interface ApiV21EntitiesOrder {
      */
     shop_warehouse_id?: number | null;
     shop_warehouse_ids?: number[];
-    /** skip order shipping address verification? (staff only) */
+    /** skip order shipping address verification? */
     skip_address_verification?: boolean | null;
     /** skip street date for this order? */
     skip_street_date?: boolean | null;
@@ -11228,28 +11236,6 @@ export interface GetApiV21CarrierAccountsProviderAccountsParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
-export interface GetApiV21CarrierAliasesParams {
-    /** JSON search string like {"attribute_eq": "Term"} */
-    search?: string;
-    /** Comma-separated list of fields to include in the response */
-    fields?: string;
-    /** A list of sort options (ex: name asc,created_at desc) */
-    sort?: string;
-    /**
-     * Page of results to fetch
-     * @format int32
-     */
-    page?: number;
-    /**
-     * Number of results to return per page
-     * @format int32
-     */
-    per_page?: number;
-    /** Include total count of results */
-    page_total?: boolean;
-    /** Include prev/next links in response headers */
-    page_links?: boolean;
-}
 export interface GetApiV21CarriersParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -11945,6 +11931,46 @@ export interface GetApiV21ItemsParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
+export interface GetApiV21LoadScacsCountParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+}
+export interface GetApiV21LoadScacsParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /** Comma-separated list of fields to include in the response */
+    fields?: string;
+    /** A list of sort options (ex: name asc,created_at desc) */
+    sort?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+}
 export interface GetApiV21LoadsCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -13959,28 +13985,6 @@ export interface GetApiV2CarrierAccountsProviderAccountsParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
-export interface GetApiV2CarrierAliasesParams {
-    /** JSON search string like {"attribute_eq": "Term"} */
-    search?: string;
-    /** Comma-separated list of fields to include in the response */
-    fields?: string;
-    /** A list of sort options (ex: name asc,created_at desc) */
-    sort?: string;
-    /**
-     * Page of results to fetch
-     * @format int32
-     */
-    page?: number;
-    /**
-     * Number of results to return per page
-     * @format int32
-     */
-    per_page?: number;
-    /** Include total count of results */
-    page_total?: boolean;
-    /** Include prev/next links in response headers */
-    page_links?: boolean;
-}
 export interface GetApiV2CarriersParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -14676,6 +14680,46 @@ export interface GetApiV2ItemsParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
+export interface GetApiV2LoadScacsCountParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+}
+export interface GetApiV2LoadScacsParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /** Comma-separated list of fields to include in the response */
+    fields?: string;
+    /** A list of sort options (ex: name asc,created_at desc) */
+    sort?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+}
 export interface GetApiV2LoadsCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -16789,12 +16833,6 @@ export interface PostApiV21CarrierAccountsRequest {
     /** Array of warehouse_ids associated with this carrier account */
     warehouse_ids?: string[];
 }
-export interface PostApiV21CarrierAliasesRequest {
-    /** TBD */
-    context?: string;
-    /** carrier alias object name */
-    name?: string;
-}
 export interface PostApiV21CarriersRequest {
     /** Does this carrier support electronic trade documents? */
     etd_enabled?: boolean;
@@ -17787,6 +17825,21 @@ export interface PostApiV21ItemsRequest {
      */
     width?: number;
 }
+export interface PostApiV21LoadScacsRequest {
+    /** the carrier associated with this load scac */
+    carrier?: string;
+    /** the ccid for the load scac */
+    ccid?: string;
+    /**
+     * the id of the customer associated with this load scac
+     * @format int32
+     */
+    customer_id?: number;
+    /** customer name of the load scac */
+    customer_name?: string;
+    /** SCAC code */
+    scac?: string;
+}
 export interface PostApiV21LoadsRequest {
     /** True by default, whether to cascade load bol routing field values to child bols */
     cascade_routing?: boolean;
@@ -18030,7 +18083,7 @@ export interface PostApiV21OrdersBulkRequest {
         batch_priority?: boolean;
         /** the order shipping email */
         email?: string;
-        /** skip order shipping address verification? (staff only) */
+        /** skip order shipping address verification? */
         skip_address_verification?: boolean;
         /** the orders Standard Carrier Alpha Code number */
         scac?: string;
@@ -19008,7 +19061,7 @@ export interface PostApiV21OrdersRequest {
     shop_updated_at?: string;
     /** the order shop warehouse ids */
     shop_warehouse_ids?: number[];
-    /** skip order shipping address verification? (staff only) */
+    /** skip order shipping address verification? */
     skip_address_verification?: boolean;
     /** skip street date for this order? */
     skip_street_date?: boolean;
@@ -20473,12 +20526,6 @@ export interface PostApiV2CarrierAccountsRequest {
     /** Array of warehouse_ids associated with this carrier account */
     warehouse_ids?: string[];
 }
-export interface PostApiV2CarrierAliasesRequest {
-    /** TBD */
-    context?: string;
-    /** carrier alias object name */
-    name?: string;
-}
 export interface PostApiV2CarriersRequest {
     /** Does this carrier support electronic trade documents? */
     etd_enabled?: boolean;
@@ -21471,6 +21518,21 @@ export interface PostApiV2ItemsRequest {
      */
     width?: number;
 }
+export interface PostApiV2LoadScacsRequest {
+    /** the carrier associated with this load scac */
+    carrier?: string;
+    /** the ccid for the load scac */
+    ccid?: string;
+    /**
+     * the id of the customer associated with this load scac
+     * @format int32
+     */
+    customer_id?: number;
+    /** customer name of the load scac */
+    customer_name?: string;
+    /** SCAC code */
+    scac?: string;
+}
 export interface PostApiV2LoadsRequest {
     /** True by default, whether to cascade load bol routing field values to child bols */
     cascade_routing?: boolean;
@@ -21714,7 +21776,7 @@ export interface PostApiV2OrdersBulkRequest {
         batch_priority?: boolean;
         /** the order shipping email */
         email?: string;
-        /** skip order shipping address verification? (staff only) */
+        /** skip order shipping address verification? */
         skip_address_verification?: boolean;
         /** the orders Standard Carrier Alpha Code number */
         scac?: string;
@@ -22692,7 +22754,7 @@ export interface PostApiV2OrdersRequest {
     shop_updated_at?: string;
     /** the order shop warehouse ids */
     shop_warehouse_ids?: number[];
-    /** skip order shipping address verification? (staff only) */
+    /** skip order shipping address verification? */
     skip_address_verification?: boolean;
     /** skip street date for this order? */
     skip_street_date?: boolean;
@@ -24104,12 +24166,6 @@ export interface PutApiV21CarrierAccountsIdRequest {
     /** Array of warehouse_ids associated with this carrier account */
     warehouse_ids?: string[];
 }
-export interface PutApiV21CarrierAliasesIdRequest {
-    /** carrier alias slug */
-    context?: string;
-    /** carrier alias object name */
-    name?: string;
-}
 export interface PutApiV21CarriersIdRequest {
     /** Does this carrier support electronic trade documents? */
     etd_enabled?: boolean;
@@ -24934,6 +24990,14 @@ export interface PutApiV21ItemsIdRequest {
      */
     width?: number;
 }
+export interface PutApiV21LoadScacsIdRequest {
+    /** the carrier associated with this load scac */
+    carrier?: string;
+    /** the ccid for the load scac */
+    ccid?: string;
+    /** SCAC code */
+    scac?: string;
+}
 export interface PutApiV21LoadsIdCallActionRequest {
     action?: string;
     /** Method params */
@@ -25666,7 +25730,7 @@ export interface PutApiV21OrdersIdRequest {
     shop_updated_at?: string;
     /** the order shop warehouse ids */
     shop_warehouse_ids?: number[];
-    /** skip order shipping address verification? (staff only) */
+    /** skip order shipping address verification? */
     skip_address_verification?: boolean;
     /** skip street date for this order? */
     skip_street_date?: boolean;
@@ -26616,7 +26680,6 @@ export interface PutApiV21WarehouseFeaturesIdRequest {
     feature_code?: string;
     /** List of warehouse ids for the warehouse feature */
     warehouse_ids?: number[];
-    warehouses?: string;
 }
 export interface PutApiV21WarehousesIdCallActionRequest {
     action?: string;
@@ -27119,12 +27182,6 @@ export interface PutApiV2CarrierAccountsIdRequest {
     /** Array of warehouse_ids associated with this carrier account */
     warehouse_ids?: string[];
 }
-export interface PutApiV2CarrierAliasesIdRequest {
-    /** carrier alias slug */
-    context?: string;
-    /** carrier alias object name */
-    name?: string;
-}
 export interface PutApiV2CarriersIdRequest {
     /** Does this carrier support electronic trade documents? */
     etd_enabled?: boolean;
@@ -27949,6 +28006,14 @@ export interface PutApiV2ItemsIdRequest {
      */
     width?: number;
 }
+export interface PutApiV2LoadScacsIdRequest {
+    /** the carrier associated with this load scac */
+    carrier?: string;
+    /** the ccid for the load scac */
+    ccid?: string;
+    /** SCAC code */
+    scac?: string;
+}
 export interface PutApiV2LoadsIdCallActionRequest {
     action?: string;
     /** Method params */
@@ -28681,7 +28746,7 @@ export interface PutApiV2OrdersIdRequest {
     shop_updated_at?: string;
     /** the order shop warehouse ids */
     shop_warehouse_ids?: number[];
-    /** skip order shipping address verification? (staff only) */
+    /** skip order shipping address verification? */
     skip_address_verification?: boolean;
     /** skip street date for this order? */
     skip_street_date?: boolean;
@@ -29631,7 +29696,6 @@ export interface PutApiV2WarehouseFeaturesIdRequest {
     feature_code?: string;
     /** List of warehouse ids for the warehouse feature */
     warehouse_ids?: number[];
-    warehouses?: string;
 }
 export interface PutApiV2WarehousesIdCallActionRequest {
     action?: string;

package/dist/generated/index.d.ts

@@ -7,7 +7,6 @@ export * from './Broadcasts';
 export * from './BundleItems';
 export * from './Cache';
 export * from './CarrierAccounts';
-export * from './CarrierAliases';
 export * from './Carriers';
 export * from './Chaos';
 export * from './Chromalists';
@@ -23,6 +22,7 @@ export * from './Incidents';
 export * from './InvoiceItems';
 export * from './Invoices';
 export * from './Items';
+export * from './LoadScacs';
 export * from './Loads';
 export * from './Locales';
 export * from './LocationAdjustments';

package/dist/mock-data/index.d.ts

@@ -26,7 +26,6 @@ export * from './v2_1/address/created';
 export * from './v2_1/broadcast/created';
 export * from './v2_1/bundle-item/created';
 export * from './v2_1/carrier-account/created';
-export * from './v2_1/carrier-alias/created';
 export * from './v2_1/carrier/created';
 export * from './v2_1/chromalist/created';
 export * from './v2_1/consumer-return/all';
@@ -41,6 +40,7 @@ export * from './v2_1/item/merch';
 export * from './v2_1/item/packaging';
 export * from './v2_1/item/bundle';
 export * from './v2_1/item/created';
+export * from './v2_1/load-scac/created';
 export * from './v2_1/load/open-no-bol';
 export * from './v2_1/load/created';
 export * from './v2_1/order-batch/in-load';

package/dist/mock-data/v2_1/load-scac/created.d.ts

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