@whiplashmerch/whiplash-api-client 0.1.22 → 0.2.0

package/generated/Items.ts

@@ -18,28 +18,28 @@ import {
   APIV2EntitiesItemWarehouseQuantity,
   APIV2EntitiesMetaFields,
   APIV2EntitiesOriginator,
-  APIV2EntitiesScancodeAlias,
+  APIV2EntitiesScancode,
   APIV2EntitiesShipnoticeItem,
   APIV2EntitiesTransaction,
   GetApiV21ItemsCountParams,
   GetApiV21ItemsIdMetaFieldsParams,
   GetApiV21ItemsIdOriginatorsParams,
-  GetApiV21ItemsIdScancodeAliasesParams,
+  GetApiV21ItemsIdScancodesParams,
   GetApiV21ItemsIdShipnoticeItemsCountParams,
   GetApiV21ItemsIdShipnoticeItemsParams,
   GetApiV21ItemsIdTransactionsCountParams,
   GetApiV21ItemsIdTransactionsParams,
-  GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  GetApiV21ItemsOriginatorOriginatorIdScancodesParams,
   GetApiV21ItemsParams,
   GetApiV2ItemsCountParams,
   GetApiV2ItemsIdMetaFieldsParams,
   GetApiV2ItemsIdOriginatorsParams,
-  GetApiV2ItemsIdScancodeAliasesParams,
+  GetApiV2ItemsIdScancodesParams,
   GetApiV2ItemsIdShipnoticeItemsCountParams,
   GetApiV2ItemsIdShipnoticeItemsParams,
   GetApiV2ItemsIdTransactionsCountParams,
   GetApiV2ItemsIdTransactionsParams,
-  GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  GetApiV2ItemsOriginatorOriginatorIdScancodesParams,
   GetApiV2ItemsParams,
   PostApiV21Items,
   PostApiV21ItemsIdBundleItems,
@@ -110,17 +110,17 @@ export const getApiV2ItemsActions = (client: HttpClient, params: RequestParams =
  * @description An item may have many alternate scancodes
  *
  * @tags originators
- * @name GetApiV2ItemsOriginatorOriginatorIdScancodeAliases
+ * @name GetApiV2ItemsOriginatorOriginatorIdScancodes
  * @summary List all scancodes associated with this item
- * @request GET:/api/v2/items/originator/{originator_id}/scancode_aliases
+ * @request GET:/api/v2/items/originator/{originator_id}/scancodes
  */
-export const getApiV2ItemsOriginatorOriginatorIdScancodeAliases = (
+export const getApiV2ItemsOriginatorOriginatorIdScancodes = (
   client: HttpClient,
-  { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodesParams,
   params: RequestParams = {},
 ) => {
-  return client.request<APIV2EntitiesScancodeAlias[], APIV2EntitiesApiError>({
-    path: `/api/v2/items/originator/${originatorId}/scancode_aliases`,
+  return client.request<APIV2EntitiesScancode[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}/scancodes`,
     method: "GET",
     query: query,
     format: "json",
@@ -296,17 +296,17 @@ export const getApiV2ItemsIdMetaFields = (
  * @description An item may have many alternate scancodes
  *
  * @tags items
- * @name GetApiV2ItemsIdScancodeAliases
+ * @name GetApiV2ItemsIdScancodes
  * @summary List all scancodes associated with this item
- * @request GET:/api/v2/items/{id}/scancode_aliases
+ * @request GET:/api/v2/items/{id}/scancodes
  */
-export const getApiV2ItemsIdScancodeAliases = (
+export const getApiV2ItemsIdScancodes = (
   client: HttpClient,
-  { id, ...query }: GetApiV2ItemsIdScancodeAliasesParams,
+  { id, ...query }: GetApiV2ItemsIdScancodesParams,
   params: RequestParams = {},
 ) => {
-  return client.request<APIV2EntitiesScancodeAlias[], APIV2EntitiesApiError>({
-    path: `/api/v2/items/${id}/scancode_aliases`,
+  return client.request<APIV2EntitiesScancode[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/scancodes`,
     method: "GET",
     query: query,
     format: "json",
@@ -638,17 +638,17 @@ export const getApiV21ItemsActions = (client: HttpClient, params: RequestParams
  * @description An item may have many alternate scancodes
  *
  * @tags originators
- * @name GetApiV21ItemsOriginatorOriginatorIdScancodeAliases
+ * @name GetApiV21ItemsOriginatorOriginatorIdScancodes
  * @summary List all scancodes associated with this item
- * @request GET:/api/v2.1/items/originator/{originator_id}/scancode_aliases
+ * @request GET:/api/v2.1/items/originator/{originator_id}/scancodes
  */
-export const getApiV21ItemsOriginatorOriginatorIdScancodeAliases = (
+export const getApiV21ItemsOriginatorOriginatorIdScancodes = (
   client: HttpClient,
-  { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodesParams,
   params: RequestParams = {},
 ) => {
-  return client.request<APIV2EntitiesScancodeAlias[], APIV2EntitiesApiError>({
-    path: `/api/v2.1/items/originator/${originatorId}/scancode_aliases`,
+  return client.request<APIV2EntitiesScancode[], APIV2EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}/scancodes`,
     method: "GET",
     query: query,
     format: "json",
@@ -823,17 +823,17 @@ export const getApiV21ItemsIdMetaFields = (
  * @description An item may have many alternate scancodes
  *
  * @tags items
- * @name GetApiV21ItemsIdScancodeAliases
+ * @name GetApiV21ItemsIdScancodes
  * @summary List all scancodes associated with this item
- * @request GET:/api/v2.1/items/{id}/scancode_aliases
+ * @request GET:/api/v2.1/items/{id}/scancodes
  */
-export const getApiV21ItemsIdScancodeAliases = (
+export const getApiV21ItemsIdScancodes = (
   client: HttpClient,
-  { id, ...query }: GetApiV21ItemsIdScancodeAliasesParams,
+  { id, ...query }: GetApiV21ItemsIdScancodesParams,
   params: RequestParams = {},
 ) => {
-  return client.request<APIV2EntitiesScancodeAlias[], APIV2EntitiesApiError>({
-    path: `/api/v2.1/items/${id}/scancode_aliases`,
+  return client.request<APIV2EntitiesScancode[], APIV2EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/scancodes`,
     method: "GET",
     query: query,
     format: "json",

package/generated/data-contracts.ts

@@ -9,7 +9,6 @@
  * ---------------------------------------------------------------
  */
 
-/** Create a meta_key */
 export interface APIV21EntitiesPostResponse {
   /**
    * The Whiplash ID of the newly created resource
@@ -288,6 +287,8 @@ export interface APIV2EntitiesCustomer {
   eori_number?: string;
   /** Customer estimated monthly volume. */
   estimated_monthly_volume?: string;
+  /** is this account flagged for exit notice? (admins only) */
+  exit_notice?: boolean;
   /**
    * items that are this many days from expiration will not be allowed to ship
    * @format int32
@@ -848,45 +849,6 @@ export interface APIV2EntitiesMetaFields {
   fields?: object;
 }
 
-/** Get a meta_key */
-export interface APIV2EntitiesMetaKey {
-  /**
-   * Key creation date and time
-   * @format date-time
-   */
-  created_at?: string;
-  /**
-   * Customer who owns this key (admins only)
-   * @format int32
-   */
-  customer_id?: number;
-  /** Key description */
-  description?: string;
-  /**
-   * Key discard date and time (admins only)
-   * @format date-time
-   */
-  discarded_at?: string;
-  /**
-   * Key ID
-   * @format int32
-   */
-  id?: number;
-  /** array of tag keywords */
-  keyword_list?: string;
-  /** Key name */
-  name?: string;
-  /** Resource this key will be attached to */
-  owner_type?: string;
-  /**
-   * Key last update date and time
-   * @format date-time
-   */
-  updated_at?: string;
-  /** Value type */
-  value_type?: string;
-}
-
 export interface APIV2EntitiesNotificationEvent {
   /**
    * the notification event creation date and time
@@ -1026,6 +988,8 @@ export interface APIV2EntitiesOrder {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /**
@@ -1111,7 +1075,7 @@ export interface APIV2EntitiesOrder {
   /** the order type */
   order_type?: string;
   originator?: APIV2EntitiesOriginator;
-  packages?: APIV2EntitiesPackage;
+  packages?: APIV2EntitiesPackage[];
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -1174,8 +1138,7 @@ export interface APIV2EntitiesOrder {
   return_zip?: string;
   /** require a carrier that delivers on Saturdays for this order? */
   saturday_delivery?: boolean;
-  /** Serial numbers are scanned and saved during the packing process. */
-  serial_numbers?: APIV2EntitiesSerialNumber;
+  serial_numbers?: APIV2EntitiesSerialNumber[];
   /**
    * the order actual cost of shipping
    * @format float
@@ -1655,7 +1618,7 @@ export interface APIV2EntitiesReturnItem {
   sku?: string;
 }
 
-/** Get all scancode_aliases */
+/** An item may have many alternate scancodes */
 export interface APIV2EntitiesScancode {
   /** is this scancode active? */
   active?: boolean;
@@ -1694,36 +1657,6 @@ export interface APIV2EntitiesScancode {
   updated_at?: string;
 }
 
-/** An item may have many alternate scancodes */
-export interface APIV2EntitiesScancodeAlias {
-  /** is this scancode_alias active? */
-  active?: boolean;
-  /**
-   * scancode_alias creation date
-   * @format date-time
-   */
-  created_at?: string;
-  /**
-   * the scancode_alias id
-   * @format int32
-   */
-  id?: number;
-  /**
-   * the item_id
-   * @format int32
-   */
-  item_id?: number;
-  /** label format for the scancode_alias */
-  label_format?: string;
-  /** the scancode for the scancode_alias */
-  scancode?: string;
-  /**
-   * scancode_alias last updated date
-   * @format date-time
-   */
-  updated_at?: string;
-}
-
 /** Serial numbers are scanned and saved during the packing process. */
 export interface APIV2EntitiesSerialNumber {
   /**
@@ -2167,15 +2100,21 @@ export interface APIV2EntitiesUser {
   id?: number;
   /** last name of the user */
   last_name?: string;
-  /** locale for languate settings */
-  locale?: string;
+  /**
+   * locale for language settings
+   * @default "en"
+   */
+  locale?: ApiV2EntitiesUserLocale;
   /**
    * partner_id of the user
    * @format int32
    */
   partner_id?: number;
-  /** role of the user */
-  role?: string;
+  /**
+   * role of the user
+   * @default "customer"
+   */
+  role?: ApiV2EntitiesUserRole;
   /**
    * the user sign in count
    * @format int32
@@ -2366,6 +2305,18 @@ export interface GetApiV21CustomersParams {
   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 GetApiV21DocumentsParams {
@@ -2412,7 +2363,7 @@ export interface GetApiV21ItemsIdOriginatorsParams {
   id: number;
 }
 
-export interface GetApiV21ItemsIdScancodeAliasesParams {
+export interface GetApiV21ItemsIdScancodesParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
   /** A list of sort options (ex: name asc,created_at desc) */
@@ -2489,7 +2440,7 @@ export interface GetApiV21ItemsIdTransactionsParams {
   id: number;
 }
 
-export interface GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams {
+export interface GetApiV21ItemsOriginatorOriginatorIdScancodesParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
   /** A list of sort options (ex: name asc,created_at desc) */
@@ -2531,32 +2482,6 @@ export interface GetApiV21ItemsParams {
   per_page?: number;
 }
 
-export interface GetApiV21MetaKeysCountParams {
-  /** JSON search string like {"attribute_eq": "Term"} */
-  search?: string;
-}
-
-export interface GetApiV21MetaKeysParams {
-  /** 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 GetApiV21NotificationEventsParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -2757,27 +2682,6 @@ export interface GetApiV21OriginatorsParams {
   per_page?: number;
 }
 
-export interface GetApiV21ScancodeAliasesParams {
-  /** 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 GetApiV21ShipnoticeItemsCountParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -2901,6 +2805,18 @@ export interface GetApiV2CustomersParams {
   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 GetApiV2DocumentsParams {
@@ -2947,7 +2863,7 @@ export interface GetApiV2ItemsIdOriginatorsParams {
   id: number;
 }
 
-export interface GetApiV2ItemsIdScancodeAliasesParams {
+export interface GetApiV2ItemsIdScancodesParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
   /** A list of sort options (ex: name asc,created_at desc) */
@@ -3024,7 +2940,7 @@ export interface GetApiV2ItemsIdTransactionsParams {
   id: number;
 }
 
-export interface GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams {
+export interface GetApiV2ItemsOriginatorOriginatorIdScancodesParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
   /** A list of sort options (ex: name asc,created_at desc) */
@@ -3066,32 +2982,6 @@ export interface GetApiV2ItemsParams {
   per_page?: number;
 }
 
-export interface GetApiV2MetaKeysCountParams {
-  /** JSON search string like {"attribute_eq": "Term"} */
-  search?: string;
-}
-
-export interface GetApiV2MetaKeysParams {
-  /** 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 GetApiV2NotificationEventsParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -3292,48 +3182,6 @@ export interface GetApiV2OriginatorsParams {
   per_page?: number;
 }
 
-export interface GetApiV2ScancodeAliasesParams {
-  /** 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 GetApiV2ScancodesParams {
-  /** 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 GetApiV2ShipnoticeItemsCountParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -3742,6 +3590,27 @@ export enum ApiV2EntitiesOrderIncoterm {
   DDU = "DDU",
 }
 
+/**
+ * locale for language settings
+ * @default "en"
+ */
+export enum ApiV2EntitiesUserLocale {
+  En = "en",
+  Es = "es",
+}
+
+/**
+ * role of the user
+ * @default "customer"
+ */
+export enum ApiV2EntitiesUserRole {
+  Admin = "admin",
+  Manager = "manager",
+  Staff = "staff",
+  Customer = "customer",
+  Partner = "partner",
+}
+
 /** Create a consumer return */
 export interface PostApiV21ConsumerReturns {
   /**
@@ -4420,18 +4289,6 @@ export enum PostApiV21ItemsPackagingType {
   MediumParcel = "MediumParcel",
 }
 
-/** Create a meta_key */
-export interface PostApiV21MetaKeys {
-  "Key description"?: string;
-  "Key name"?: string;
-  "Resource this key will be attached to"?: string;
-  "Value type"?: string;
-  String?: string;
-  desc?: string;
-  type?: string;
-  values?: string;
-}
-
 /** Create a notification subscription */
 export interface PostApiV21NotificationSubscriptions {
   /** is the notification subscription active? */
@@ -4521,6 +4378,8 @@ export interface PostApiV21Orders {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /** the carrier on the customer provided label (for tracking purposes) */
@@ -5874,18 +5733,6 @@ export enum PostApiV2ItemsPackagingType {
   MediumParcel = "MediumParcel",
 }
 
-/** Create a meta_key */
-export interface PostApiV2MetaKeys {
-  "Key description"?: string;
-  "Key name"?: string;
-  "Resource this key will be attached to"?: string;
-  "Value type"?: string;
-  String?: string;
-  desc?: string;
-  type?: string;
-  values?: string;
-}
-
 /** Create a notification subscription */
 export interface PostApiV2NotificationSubscriptions {
   /** is the notification subscription active? */
@@ -5975,6 +5822,8 @@ export interface PostApiV2Orders {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /** the carrier on the customer provided label (for tracking purposes) */
@@ -6813,6 +6662,8 @@ export interface PutApiV21Customers {
   eori_number?: string;
   /** Customer estimated monthly volume. */
   estimated_monthly_volume?: string;
+  /** is this account flagged for exit notice? (admins only) */
+  exit_notice?: boolean;
   /**
    * items that are this many days from expiration will not be allowed to ship
    * @format int32
@@ -7918,18 +7769,6 @@ export enum PutApiV21ItemsPackagingType {
   MediumParcel = "MediumParcel",
 }
 
-/** Update a meta_key */
-export interface PutApiV21MetaKeys {
-  "Key description"?: string;
-  "Key name"?: string;
-  "Resource this key will be attached to"?: string;
-  "Value type"?: string;
-  String?: string;
-  desc?: string;
-  type?: string;
-  values?: string;
-}
-
 /** Update a notification subscription */
 export interface PutApiV21NotificationSubscriptions {
   /** is the notification subscription active? */
@@ -8111,6 +7950,8 @@ export interface PutApiV21Orders {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /** the carrier on the customer provided label (for tracking purposes) */
@@ -8361,6 +8202,8 @@ export interface PutApiV21OrdersOriginator {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /** the carrier on the customer provided label (for tracking purposes) */
@@ -9013,6 +8856,8 @@ export interface PutApiV2Customers {
   eori_number?: string;
   /** Customer estimated monthly volume. */
   estimated_monthly_volume?: string;
+  /** is this account flagged for exit notice? (admins only) */
+  exit_notice?: boolean;
   /**
    * items that are this many days from expiration will not be allowed to ship
    * @format int32
@@ -10118,18 +9963,6 @@ export enum PutApiV2ItemsPackagingType {
   MediumParcel = "MediumParcel",
 }
 
-/** Update a meta_key */
-export interface PutApiV2MetaKeys {
-  "Key description"?: string;
-  "Key name"?: string;
-  "Resource this key will be attached to"?: string;
-  "Value type"?: string;
-  String?: string;
-  desc?: string;
-  type?: string;
-  values?: string;
-}
-
 /** Update a notification subscription */
 export interface PutApiV2NotificationSubscriptions {
   /** is the notification subscription active? */
@@ -10311,6 +10144,8 @@ export interface PutApiV2Orders {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /** the carrier on the customer provided label (for tracking purposes) */
@@ -10559,6 +10394,8 @@ export interface PutApiV2OrdersOriginator {
    * @format int32
    */
   carrier_account_id?: number;
+  /** packingslip pdf url */
+  cf_packingslip_pdf_url?: string;
   /** does the order contain alcohol? */
   contains_alcohol?: boolean;
   /** the carrier on the customer provided label (for tracking purposes) */

package/generated/index.ts

@@ -3,16 +3,12 @@ export * from './ConsumerReturns';
 export * from './Customers';
 export * from './Documents';
 export * from './Items';
-export * from './MetaKeys';
 export * from './NotificationEvents';
 export * from './NotificationSubscriptions';
 export * from './OrderDocuments';
 export * from './OrderItems';
 export * from './Orders';
 export * from './Originators';
-export * from './Public';
-export * from './ScancodeAliases';
-export * from './Scancodes';
 export * from './ShipnoticeItems';
 export * from './Shipnotices';
 export * from './Simulate';

package/package.json

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