@whiplashmerch/whiplash-api-client 0.4.113 → 0.4.114

package/dist/generated/CarrierAliases.d.ts

@@ -0,0 +1,92 @@
+import { APIV21EntitiesCarrierAlias, APIV21EntitiesPostResponse, APIV2EntitiesCarrierAlias, GetApiV21CarrierAliasesParams, GetApiV2CarrierAliasesParams, PostApiV21CarrierAliases, PostApiV2CarrierAliases, PutApiV21CarrierAliasesId, PutApiV2CarrierAliasesId } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags carrier_aliases
+ * @name GetApiV2CarrierAliases
+ * @summary List all carrier_aliases
+ * @request GET:/api/v2/carrier_aliases
+ */
+export declare const getApiV2CarrierAliases: (client: HttpClient, query: GetApiV2CarrierAliasesParams, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias[]>;
+/**
+ * @description Create a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name PostApiV2CarrierAliases
+ * @summary Create a carrier_alias
+ * @request POST:/api/v2/carrier_aliases
+ */
+export declare const postApiV2CarrierAliases: (client: HttpClient, postApiV2CarrierAliases: PostApiV2CarrierAliases, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias>;
+/**
+ * @description Get a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name GetApiV2CarrierAliasesId
+ * @summary Retrieve a carrier_alias
+ * @request GET:/api/v2/carrier_aliases/{id}
+ */
+export declare const getApiV2CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias>;
+/**
+ * @description Update a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name PutApiV2CarrierAliasesId
+ * @summary Update a carrier_alias
+ * @request PUT:/api/v2/carrier_aliases/{id}
+ */
+export declare const putApiV2CarrierAliasesId: (client: HttpClient, id: number, putApiV2CarrierAliasesId: PutApiV2CarrierAliasesId, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias>;
+/**
+ * @description Destroy a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name DeleteApiV2CarrierAliasesId
+ * @summary Destroy a carrier_alias
+ * @request DELETE:/api/v2/carrier_aliases/{id}
+ */
+export declare const deleteApiV2CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags carrier_aliases
+ * @name GetApiV21CarrierAliases
+ * @summary List all carrier_aliases
+ * @request GET:/api/v2.1/carrier_aliases
+ */
+export declare const getApiV21CarrierAliases: (client: HttpClient, query: GetApiV21CarrierAliasesParams, params?: RequestParams) => Promise<APIV21EntitiesCarrierAlias[]>;
+/**
+ * @description Create a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name PostApiV21CarrierAliases
+ * @summary Create a carrier_alias
+ * @request POST:/api/v2.1/carrier_aliases
+ */
+export declare const postApiV21CarrierAliases: (client: HttpClient, postApiV21CarrierAliases: PostApiV21CarrierAliases, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * @description Get a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name GetApiV21CarrierAliasesId
+ * @summary Retrieve a carrier_alias
+ * @request GET:/api/v2.1/carrier_aliases/{id}
+ */
+export declare const getApiV21CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCarrierAlias>;
+/**
+ * @description Update a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name PutApiV21CarrierAliasesId
+ * @summary Update a carrier_alias
+ * @request PUT:/api/v2.1/carrier_aliases/{id}
+ */
+export declare const putApiV21CarrierAliasesId: (client: HttpClient, id: number, putApiV21CarrierAliasesId: PutApiV21CarrierAliasesId, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a carrier_alias
+ *
+ * @tags carrier_aliases
+ * @name DeleteApiV21CarrierAliasesId
+ * @summary Destroy a carrier_alias
+ * @request DELETE:/api/v2.1/carrier_aliases/{id}
+ */
+export declare const deleteApiV21CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/Carriers.d.ts

@@ -1,4 +1,4 @@
-import { APIV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams } from "./data-contracts";
+import { APIV21EntitiesCarrier, APIV21EntitiesPostResponse, APIV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams, PostApiV21Carriers, PutApiV21CarriersId } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description Get a list of carriers
@@ -17,4 +17,40 @@ export declare const getApiV2Carriers: (client: HttpClient, query: GetApiV2Carri
  * @summary List all carriers
  * @request GET:/api/v2.1/carriers
  */
-export declare const getApiV21Carriers: (client: HttpClient, query: GetApiV21CarriersParams, params?: RequestParams) => Promise<APIV2EntitiesCarrier[]>;
+export declare const getApiV21Carriers: (client: HttpClient, query: GetApiV21CarriersParams, params?: RequestParams) => Promise<APIV21EntitiesCarrier[]>;
+/**
+ * @description Create a carrier
+ *
+ * @tags carriers
+ * @name PostApiV21Carriers
+ * @summary Create a carrier
+ * @request POST:/api/v2.1/carriers
+ */
+export declare const postApiV21Carriers: (client: HttpClient, postApiV21Carriers: PostApiV21Carriers, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * @description Get a carrier
+ *
+ * @tags carriers
+ * @name GetApiV21CarriersId
+ * @summary Retrieve a carrier
+ * @request GET:/api/v2.1/carriers/{id}
+ */
+export declare const getApiV21CarriersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCarrier>;
+/**
+ * @description Update a carrier
+ *
+ * @tags carriers
+ * @name PutApiV21CarriersId
+ * @summary Update a carrier
+ * @request PUT:/api/v2.1/carriers/{id}
+ */
+export declare const putApiV21CarriersId: (client: HttpClient, id: number, putApiV21CarriersId: PutApiV21CarriersId, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a carrier
+ *
+ * @tags carriers
+ * @name DeleteApiV21CarriersId
+ * @summary Destroy a carrier
+ * @request DELETE:/api/v2.1/carriers/{id}
+ */
+export declare const deleteApiV21CarriersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

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

@@ -227,6 +227,26 @@ export interface APIV21EntitiesBroadcast {
      */
     user_id?: number;
 }
+/** API_V2_1_Entities_Carrier model */
+export interface APIV21EntitiesCarrier {
+    /** carrier aliases */
+    carrier_aliases?: APIV21EntitiesCarrierAlias;
+    /** Does this carrier support electronic trade documents? */
+    etd_enabled?: boolean;
+    /**
+     * carrier id
+     * @format int32
+     */
+    id?: number;
+    /** carrier name */
+    name?: string;
+    /** carrier owner name */
+    owner_name?: string;
+    /** carrier SCAC code */
+    scac?: string;
+    /** carrier tracking URL */
+    tracking_url?: string;
+}
 /** API_V2_1_Entities_CarrierAccount model */
 export interface APIV21EntitiesCarrierAccount {
     /** is this carrier account active? */
@@ -306,6 +326,18 @@ export interface APIV21EntitiesCarrierAccount {
     /** Warehouses associated with this Feature */
     warehouse_ids?: number[];
 }
+/** API_V2_1_Entities_CarrierAlias model */
+export interface APIV21EntitiesCarrierAlias {
+    /** carrier alias slug */
+    context?: string;
+    /**
+     * carrier alias object id
+     * @format int32
+     */
+    id?: number;
+    /** carrier alias object name */
+    name?: string;
+}
 /** API_V2_1_Entities_ConsumerReturn model */
 export interface APIV21EntitiesConsumerReturn {
     /**
@@ -3282,6 +3314,18 @@ export interface APIV2EntitiesCarrierAccount {
     /** API_V2_Entities_Warehouse model */
     warehouses?: APIV2EntitiesWarehouse;
 }
+/** API_V2_Entities_CarrierAlias model */
+export interface APIV2EntitiesCarrierAlias {
+    /** carrier alias slug */
+    context?: string;
+    /**
+     * carrier alias object id
+     * @format int32
+     */
+    id?: number;
+    /** carrier alias object name */
+    name?: string;
+}
 /** API_V2_Entities_Chromalist model */
 export interface APIV2EntitiesChromalist {
     /** white-, black-, etc-list */
@@ -8114,6 +8158,26 @@ export interface GetApiV21CarrierAccountsProviderAccountsParams {
      */
     per_page?: number;
 }
+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
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Number of results to return per page.
+     * @format int32
+     * @default 25
+     */
+    per_page?: number;
+}
 export interface GetApiV21CarriersParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -10339,6 +10403,26 @@ export interface GetApiV2CarrierAccountsProviderAccountsParams {
      */
     per_page?: number;
 }
+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
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Number of results to return per page.
+     * @format int32
+     * @default 25
+     */
+    per_page?: number;
+}
 export interface GetApiV2CarriersParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -13824,6 +13908,24 @@ export declare enum PostApiV21CarrierAccountsProvider {
     Easypost = "easypost",
     Shippo = "shippo"
 }
+/** Create a carrier_alias */
+export interface PostApiV21CarrierAliases {
+    /** TBD */
+    context?: string;
+    /** carrier alias object name */
+    name: string;
+}
+/** Create a carrier */
+export interface PostApiV21Carriers {
+    ""?: string;
+    /** Does this carrier support electronic trade documents? */
+    etd_enabled?: boolean;
+    /** carrier name */
+    name: string;
+    /** Carrier SCAC code */
+    scac?: string;
+    tracking_url?: string;
+}
 /** Create a chromalist */
 export interface PostApiV21Chromalists {
     /** white-, black-, etc-list */
@@ -17946,6 +18048,13 @@ export declare enum PostApiV2CarrierAccountsProvider {
     Easypost = "easypost",
     Shippo = "shippo"
 }
+/** Create a carrier_alias */
+export interface PostApiV2CarrierAliases {
+    /** TBD */
+    context?: string;
+    /** carrier alias object name */
+    name: string;
+}
 /** Create a chromalist */
 export interface PostApiV2Chromalists {
     /** white-, black-, etc-list */
@@ -21978,6 +22087,24 @@ export interface PutApiV21CarrierAccountsIdMetaFields {
     /** Hash of key/value pairs */
     fields?: object;
 }
+/** Update a carrier_alias */
+export interface PutApiV21CarrierAliasesId {
+    /** carrier alias slug */
+    context?: string;
+    /** carrier alias object name */
+    name?: string;
+}
+/** Update a carrier */
+export interface PutApiV21CarriersId {
+    /** Does this carrier support electronic trade documents? */
+    etd_enabled?: boolean;
+    /** carrier name */
+    name?: string;
+    /** carrier SCAC code */
+    scac?: string;
+    /** carrier tracking URL */
+    tracking_url?: string;
+}
 /** Update a consumer return */
 export interface PutApiV21ConsumerReturnsId {
     /**
@@ -26488,6 +26615,13 @@ export interface PutApiV2CarrierAccountsIdMetaFields {
     /** Hash of key/value pairs */
     fields?: object;
 }
+/** Update a carrier_alias */
+export interface PutApiV2CarrierAliasesId {
+    /** carrier alias slug */
+    context?: string;
+    /** carrier alias object name */
+    name?: string;
+}
 /** Update a consumer return */
 export interface PutApiV2ConsumerReturnsId {
     /**

package/dist/generated/index.d.ts

@@ -7,6 +7,7 @@ export * from './Broadcasts';
 export * from './BundleItems';
 export * from './Cache';
 export * from './CarrierAccounts';
+export * from './CarrierAliases';
 export * from './Carriers';
 export * from './Chromalists';
 export * from './ConsumerReturns';

package/generated/CarrierAliases.ts

@@ -0,0 +1,62 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import {
+  APIV21EntitiesCarrierAlias,
+  APIV2EntitiesApiError,
+  APIV2EntitiesCarrierAlias,
+  GetApiV21CarrierAliasesParams,
+  GetApiV2CarrierAliasesParams,
+} from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+
+/**
+ * No description
+ *
+ * @tags carrier_aliases
+ * @name GetApiV2CarrierAliases
+ * @summary List all carrier_aliases
+ * @request GET:/api/v2/carrier_aliases
+ */
+export const getApiV2CarrierAliases = (
+  client: HttpClient,
+  query: GetApiV2CarrierAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCarrierAlias[], APIV2EntitiesApiError>({
+    path: `/api/v2/carrier_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags carrier_aliases
+ * @name GetApiV21CarrierAliases
+ * @summary List all carrier_aliases
+ * @request GET:/api/v2.1/carrier_aliases
+ */
+export const getApiV21CarrierAliases = (
+  client: HttpClient,
+  query: GetApiV21CarrierAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCarrierAlias[], APIV2EntitiesApiError>({
+    path: `/api/v2.1/carrier_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/data-contracts.ts

@@ -9,6 +9,19 @@
  * ---------------------------------------------------------------
  */
 
+/** API_V2_1_Entities_CarrierAlias model */
+export interface APIV21EntitiesCarrierAlias {
+  /** carrier alias slug */
+  context?: string;
+  /**
+   * carrier alias object id
+   * @format int32
+   */
+  id?: number;
+  /** carrier alias object name */
+  name?: string;
+}
+
 /** API_V2_1_Entities_ConsumerReturn model */
 export interface APIV21EntitiesConsumerReturn {
   /**
@@ -1578,6 +1591,19 @@ export interface APIV2EntitiesBundleItem {
   updated_at?: string;
 }
 
+/** API_V2_Entities_CarrierAlias model */
+export interface APIV2EntitiesCarrierAlias {
+  /** carrier alias slug */
+  context?: string;
+  /**
+   * carrier alias object id
+   * @format int32
+   */
+  id?: number;
+  /** carrier alias object name */
+  name?: string;
+}
+
 /** API_V2_Entities_ConsumerReturn model */
 export interface APIV2EntitiesConsumerReturn {
   /**
@@ -4038,6 +4064,27 @@ export interface APIV2EntitiesWholesale {
   vendor_number?: string;
 }
 
+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
+   * @default 1
+   */
+  page?: number;
+  /**
+   * Number of results to return per page.
+   * @format int32
+   * @default 25
+   */
+  per_page?: number;
+}
+
 export interface GetApiV21ConsumerReturnsCountParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -4591,6 +4638,27 @@ export interface GetApiV21TemplatesParams {
   per_page?: number;
 }
 
+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
+   * @default 1
+   */
+  page?: number;
+  /**
+   * Number of results to return per page.
+   * @format int32
+   * @default 25
+   */
+  per_page?: number;
+}
+
 export interface GetApiV2ConsumerReturnsCountParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;

package/generated/index.ts

@@ -1,4 +1,5 @@
 export * from './BundleItems';
+export * from './CarrierAliases';
 export * from './ConsumerReturns';
 export * from './Customers';
 export * from './Documents';

package/package.json

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