@whiplashmerch/whiplash-api-client 0.4.113 → 0.4.115

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,92 @@
1
+ import { APIV21EntitiesCarrierAlias, APIV21EntitiesPostResponse, APIV2EntitiesCarrierAlias, GetApiV21CarrierAliasesParams, GetApiV2CarrierAliasesParams, PostApiV21CarrierAliases, PostApiV2CarrierAliases, PutApiV21CarrierAliasesId, PutApiV2CarrierAliasesId } from "./data-contracts";
2
+ import { HttpClient, RequestParams } from "./http-client";
3
+ /**
4
+ * No description
5
+ *
6
+ * @tags carrier_aliases
7
+ * @name GetApiV2CarrierAliases
8
+ * @summary List all carrier_aliases
9
+ * @request GET:/api/v2/carrier_aliases
10
+ */
11
+ export declare const getApiV2CarrierAliases: (client: HttpClient, query: GetApiV2CarrierAliasesParams, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias[]>;
12
+ /**
13
+ * @description Create a carrier_alias
14
+ *
15
+ * @tags carrier_aliases
16
+ * @name PostApiV2CarrierAliases
17
+ * @summary Create a carrier_alias
18
+ * @request POST:/api/v2/carrier_aliases
19
+ */
20
+ export declare const postApiV2CarrierAliases: (client: HttpClient, postApiV2CarrierAliases: PostApiV2CarrierAliases, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias>;
21
+ /**
22
+ * @description Get a carrier_alias
23
+ *
24
+ * @tags carrier_aliases
25
+ * @name GetApiV2CarrierAliasesId
26
+ * @summary Retrieve a carrier_alias
27
+ * @request GET:/api/v2/carrier_aliases/{id}
28
+ */
29
+ export declare const getApiV2CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias>;
30
+ /**
31
+ * @description Update a carrier_alias
32
+ *
33
+ * @tags carrier_aliases
34
+ * @name PutApiV2CarrierAliasesId
35
+ * @summary Update a carrier_alias
36
+ * @request PUT:/api/v2/carrier_aliases/{id}
37
+ */
38
+ export declare const putApiV2CarrierAliasesId: (client: HttpClient, id: number, putApiV2CarrierAliasesId: PutApiV2CarrierAliasesId, params?: RequestParams) => Promise<APIV2EntitiesCarrierAlias>;
39
+ /**
40
+ * @description Destroy a carrier_alias
41
+ *
42
+ * @tags carrier_aliases
43
+ * @name DeleteApiV2CarrierAliasesId
44
+ * @summary Destroy a carrier_alias
45
+ * @request DELETE:/api/v2/carrier_aliases/{id}
46
+ */
47
+ export declare const deleteApiV2CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
48
+ /**
49
+ * No description
50
+ *
51
+ * @tags carrier_aliases
52
+ * @name GetApiV21CarrierAliases
53
+ * @summary List all carrier_aliases
54
+ * @request GET:/api/v2.1/carrier_aliases
55
+ */
56
+ export declare const getApiV21CarrierAliases: (client: HttpClient, query: GetApiV21CarrierAliasesParams, params?: RequestParams) => Promise<APIV21EntitiesCarrierAlias[]>;
57
+ /**
58
+ * @description Create a carrier_alias
59
+ *
60
+ * @tags carrier_aliases
61
+ * @name PostApiV21CarrierAliases
62
+ * @summary Create a carrier_alias
63
+ * @request POST:/api/v2.1/carrier_aliases
64
+ */
65
+ export declare const postApiV21CarrierAliases: (client: HttpClient, postApiV21CarrierAliases: PostApiV21CarrierAliases, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
66
+ /**
67
+ * @description Get a carrier_alias
68
+ *
69
+ * @tags carrier_aliases
70
+ * @name GetApiV21CarrierAliasesId
71
+ * @summary Retrieve a carrier_alias
72
+ * @request GET:/api/v2.1/carrier_aliases/{id}
73
+ */
74
+ export declare const getApiV21CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCarrierAlias>;
75
+ /**
76
+ * @description Update a carrier_alias
77
+ *
78
+ * @tags carrier_aliases
79
+ * @name PutApiV21CarrierAliasesId
80
+ * @summary Update a carrier_alias
81
+ * @request PUT:/api/v2.1/carrier_aliases/{id}
82
+ */
83
+ export declare const putApiV21CarrierAliasesId: (client: HttpClient, id: number, putApiV21CarrierAliasesId: PutApiV21CarrierAliasesId, params?: RequestParams) => Promise<void>;
84
+ /**
85
+ * @description Destroy a carrier_alias
86
+ *
87
+ * @tags carrier_aliases
88
+ * @name DeleteApiV21CarrierAliasesId
89
+ * @summary Destroy a carrier_alias
90
+ * @request DELETE:/api/v2.1/carrier_aliases/{id}
91
+ */
92
+ export declare const deleteApiV21CarrierAliasesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
@@ -1,4 +1,4 @@
1
- import { APIV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams } from "./data-contracts";
1
+ import { APIV21EntitiesCarrier, APIV21EntitiesPostResponse, APIV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams, PostApiV21Carriers, PutApiV21CarriersId } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Get a list of carriers
@@ -17,4 +17,40 @@ export declare const getApiV2Carriers: (client: HttpClient, query: GetApiV2Carri
17
17
  * @summary List all carriers
18
18
  * @request GET:/api/v2.1/carriers
19
19
  */
20
- export declare const getApiV21Carriers: (client: HttpClient, query: GetApiV21CarriersParams, params?: RequestParams) => Promise<APIV2EntitiesCarrier[]>;
20
+ export declare const getApiV21Carriers: (client: HttpClient, query: GetApiV21CarriersParams, params?: RequestParams) => Promise<APIV21EntitiesCarrier[]>;
21
+ /**
22
+ * @description Create a carrier
23
+ *
24
+ * @tags carriers
25
+ * @name PostApiV21Carriers
26
+ * @summary Create a carrier
27
+ * @request POST:/api/v2.1/carriers
28
+ */
29
+ export declare const postApiV21Carriers: (client: HttpClient, postApiV21Carriers: PostApiV21Carriers, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
30
+ /**
31
+ * @description Get a carrier
32
+ *
33
+ * @tags carriers
34
+ * @name GetApiV21CarriersId
35
+ * @summary Retrieve a carrier
36
+ * @request GET:/api/v2.1/carriers/{id}
37
+ */
38
+ export declare const getApiV21CarriersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCarrier>;
39
+ /**
40
+ * @description Update a carrier
41
+ *
42
+ * @tags carriers
43
+ * @name PutApiV21CarriersId
44
+ * @summary Update a carrier
45
+ * @request PUT:/api/v2.1/carriers/{id}
46
+ */
47
+ export declare const putApiV21CarriersId: (client: HttpClient, id: number, putApiV21CarriersId: PutApiV21CarriersId, params?: RequestParams) => Promise<void>;
48
+ /**
49
+ * @description Destroy a carrier
50
+ *
51
+ * @tags carriers
52
+ * @name DeleteApiV21CarriersId
53
+ * @summary Destroy a carrier
54
+ * @request DELETE:/api/v2.1/carriers/{id}
55
+ */
56
+ export declare const deleteApiV21CarriersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
@@ -227,6 +227,26 @@ export interface APIV21EntitiesBroadcast {
227
227
  */
228
228
  user_id?: number;
229
229
  }
230
+ /** API_V2_1_Entities_Carrier model */
231
+ export interface APIV21EntitiesCarrier {
232
+ /** carrier aliases */
233
+ carrier_aliases?: APIV21EntitiesCarrierAlias;
234
+ /** Does this carrier support electronic trade documents? */
235
+ etd_enabled?: boolean;
236
+ /**
237
+ * carrier id
238
+ * @format int32
239
+ */
240
+ id?: number;
241
+ /** carrier name */
242
+ name?: string;
243
+ /** carrier owner name */
244
+ owner_name?: string;
245
+ /** carrier SCAC code */
246
+ scac?: string;
247
+ /** carrier tracking URL */
248
+ tracking_url?: string;
249
+ }
230
250
  /** API_V2_1_Entities_CarrierAccount model */
231
251
  export interface APIV21EntitiesCarrierAccount {
232
252
  /** is this carrier account active? */
@@ -306,6 +326,18 @@ export interface APIV21EntitiesCarrierAccount {
306
326
  /** Warehouses associated with this Feature */
307
327
  warehouse_ids?: number[];
308
328
  }
329
+ /** API_V2_1_Entities_CarrierAlias model */
330
+ export interface APIV21EntitiesCarrierAlias {
331
+ /** carrier alias slug */
332
+ context?: string;
333
+ /**
334
+ * carrier alias object id
335
+ * @format int32
336
+ */
337
+ id?: number;
338
+ /** carrier alias object name */
339
+ name?: string;
340
+ }
309
341
  /** API_V2_1_Entities_ConsumerReturn model */
310
342
  export interface APIV21EntitiesConsumerReturn {
311
343
  /**
@@ -1673,6 +1705,11 @@ export interface APIV21EntitiesOrderBatch {
1673
1705
  }
1674
1706
  /** API_V2_1_Entities_OrderBatchRequest model */
1675
1707
  export interface APIV21EntitiesOrderBatchRequest {
1708
+ /**
1709
+ * the duration of the order_batches from preprocessing start to processing end in seconds
1710
+ * @format int32
1711
+ */
1712
+ batch_duration?: number;
1676
1713
  /**
1677
1714
  * order_batch_request created_at
1678
1715
  * @format date-time
@@ -3282,6 +3319,18 @@ export interface APIV2EntitiesCarrierAccount {
3282
3319
  /** API_V2_Entities_Warehouse model */
3283
3320
  warehouses?: APIV2EntitiesWarehouse;
3284
3321
  }
3322
+ /** API_V2_Entities_CarrierAlias model */
3323
+ export interface APIV2EntitiesCarrierAlias {
3324
+ /** carrier alias slug */
3325
+ context?: string;
3326
+ /**
3327
+ * carrier alias object id
3328
+ * @format int32
3329
+ */
3330
+ id?: number;
3331
+ /** carrier alias object name */
3332
+ name?: string;
3333
+ }
3285
3334
  /** API_V2_Entities_Chromalist model */
3286
3335
  export interface APIV2EntitiesChromalist {
3287
3336
  /** white-, black-, etc-list */
@@ -5597,6 +5646,11 @@ export interface APIV2EntitiesOrderBatchItem {
5597
5646
  }
5598
5647
  /** API_V2_Entities_OrderBatchRequest model */
5599
5648
  export interface APIV2EntitiesOrderBatchRequest {
5649
+ /**
5650
+ * the duration of the order_batches from preprocessing start to processing end in seconds
5651
+ * @format int32
5652
+ */
5653
+ batch_duration?: number;
5600
5654
  /**
5601
5655
  * order_batch_request created_at
5602
5656
  * @format date-time
@@ -8114,6 +8168,26 @@ export interface GetApiV21CarrierAccountsProviderAccountsParams {
8114
8168
  */
8115
8169
  per_page?: number;
8116
8170
  }
8171
+ export interface GetApiV21CarrierAliasesParams {
8172
+ /** JSON search string like {"attribute_eq": "Term"} */
8173
+ search?: string;
8174
+ /** Comma-separated list of fields to include in the response */
8175
+ fields?: string;
8176
+ /** A list of sort options (ex: name asc,created_at desc) */
8177
+ sort?: string;
8178
+ /**
8179
+ * Page of results to fetch.
8180
+ * @format int32
8181
+ * @default 1
8182
+ */
8183
+ page?: number;
8184
+ /**
8185
+ * Number of results to return per page.
8186
+ * @format int32
8187
+ * @default 25
8188
+ */
8189
+ per_page?: number;
8190
+ }
8117
8191
  export interface GetApiV21CarriersParams {
8118
8192
  /** JSON search string like {"attribute_eq": "Term"} */
8119
8193
  search?: string;
@@ -10339,6 +10413,26 @@ export interface GetApiV2CarrierAccountsProviderAccountsParams {
10339
10413
  */
10340
10414
  per_page?: number;
10341
10415
  }
10416
+ export interface GetApiV2CarrierAliasesParams {
10417
+ /** JSON search string like {"attribute_eq": "Term"} */
10418
+ search?: string;
10419
+ /** Comma-separated list of fields to include in the response */
10420
+ fields?: string;
10421
+ /** A list of sort options (ex: name asc,created_at desc) */
10422
+ sort?: string;
10423
+ /**
10424
+ * Page of results to fetch.
10425
+ * @format int32
10426
+ * @default 1
10427
+ */
10428
+ page?: number;
10429
+ /**
10430
+ * Number of results to return per page.
10431
+ * @format int32
10432
+ * @default 25
10433
+ */
10434
+ per_page?: number;
10435
+ }
10342
10436
  export interface GetApiV2CarriersParams {
10343
10437
  /** JSON search string like {"attribute_eq": "Term"} */
10344
10438
  search?: string;
@@ -13824,6 +13918,24 @@ export declare enum PostApiV21CarrierAccountsProvider {
13824
13918
  Easypost = "easypost",
13825
13919
  Shippo = "shippo"
13826
13920
  }
13921
+ /** Create a carrier_alias */
13922
+ export interface PostApiV21CarrierAliases {
13923
+ /** TBD */
13924
+ context?: string;
13925
+ /** carrier alias object name */
13926
+ name: string;
13927
+ }
13928
+ /** Create a carrier */
13929
+ export interface PostApiV21Carriers {
13930
+ ""?: string;
13931
+ /** Does this carrier support electronic trade documents? */
13932
+ etd_enabled?: boolean;
13933
+ /** carrier name */
13934
+ name: string;
13935
+ /** Carrier SCAC code */
13936
+ scac?: string;
13937
+ tracking_url?: string;
13938
+ }
13827
13939
  /** Create a chromalist */
13828
13940
  export interface PostApiV21Chromalists {
13829
13941
  /** white-, black-, etc-list */
@@ -17946,6 +18058,13 @@ export declare enum PostApiV2CarrierAccountsProvider {
17946
18058
  Easypost = "easypost",
17947
18059
  Shippo = "shippo"
17948
18060
  }
18061
+ /** Create a carrier_alias */
18062
+ export interface PostApiV2CarrierAliases {
18063
+ /** TBD */
18064
+ context?: string;
18065
+ /** carrier alias object name */
18066
+ name: string;
18067
+ }
17949
18068
  /** Create a chromalist */
17950
18069
  export interface PostApiV2Chromalists {
17951
18070
  /** white-, black-, etc-list */
@@ -21978,6 +22097,24 @@ export interface PutApiV21CarrierAccountsIdMetaFields {
21978
22097
  /** Hash of key/value pairs */
21979
22098
  fields?: object;
21980
22099
  }
22100
+ /** Update a carrier_alias */
22101
+ export interface PutApiV21CarrierAliasesId {
22102
+ /** carrier alias slug */
22103
+ context?: string;
22104
+ /** carrier alias object name */
22105
+ name?: string;
22106
+ }
22107
+ /** Update a carrier */
22108
+ export interface PutApiV21CarriersId {
22109
+ /** Does this carrier support electronic trade documents? */
22110
+ etd_enabled?: boolean;
22111
+ /** carrier name */
22112
+ name?: string;
22113
+ /** carrier SCAC code */
22114
+ scac?: string;
22115
+ /** carrier tracking URL */
22116
+ tracking_url?: string;
22117
+ }
21981
22118
  /** Update a consumer return */
21982
22119
  export interface PutApiV21ConsumerReturnsId {
21983
22120
  /**
@@ -26488,6 +26625,13 @@ export interface PutApiV2CarrierAccountsIdMetaFields {
26488
26625
  /** Hash of key/value pairs */
26489
26626
  fields?: object;
26490
26627
  }
26628
+ /** Update a carrier_alias */
26629
+ export interface PutApiV2CarrierAliasesId {
26630
+ /** carrier alias slug */
26631
+ context?: string;
26632
+ /** carrier alias object name */
26633
+ name?: string;
26634
+ }
26491
26635
  /** Update a consumer return */
26492
26636
  export interface PutApiV2ConsumerReturnsId {
26493
26637
  /**
@@ -7,6 +7,7 @@ export * from './Broadcasts';
7
7
  export * from './BundleItems';
8
8
  export * from './Cache';
9
9
  export * from './CarrierAccounts';
10
+ export * from './CarrierAliases';
10
11
  export * from './Carriers';
11
12
  export * from './Chromalists';
12
13
  export * from './ConsumerReturns';
@@ -0,0 +1,62 @@
1
+ /* eslint-disable */
2
+ /* tslint:disable */
3
+ /*
4
+ * ---------------------------------------------------------------
5
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
6
+ * ## ##
7
+ * ## AUTHOR: acacode ##
8
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
9
+ * ---------------------------------------------------------------
10
+ */
11
+
12
+ import {
13
+ APIV21EntitiesCarrierAlias,
14
+ APIV2EntitiesApiError,
15
+ APIV2EntitiesCarrierAlias,
16
+ GetApiV21CarrierAliasesParams,
17
+ GetApiV2CarrierAliasesParams,
18
+ } from "./data-contracts";
19
+ import { HttpClient, RequestParams } from "./http-client";
20
+
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags carrier_aliases
25
+ * @name GetApiV2CarrierAliases
26
+ * @summary List all carrier_aliases
27
+ * @request GET:/api/v2/carrier_aliases
28
+ */
29
+ export const getApiV2CarrierAliases = (
30
+ client: HttpClient,
31
+ query: GetApiV2CarrierAliasesParams,
32
+ params: RequestParams = {},
33
+ ) => {
34
+ return client.request<APIV2EntitiesCarrierAlias[], APIV2EntitiesApiError>({
35
+ path: `/api/v2/carrier_aliases`,
36
+ method: "GET",
37
+ query: query,
38
+ format: "json",
39
+ ...params,
40
+ });
41
+ };
42
+ /**
43
+ * No description
44
+ *
45
+ * @tags carrier_aliases
46
+ * @name GetApiV21CarrierAliases
47
+ * @summary List all carrier_aliases
48
+ * @request GET:/api/v2.1/carrier_aliases
49
+ */
50
+ export const getApiV21CarrierAliases = (
51
+ client: HttpClient,
52
+ query: GetApiV21CarrierAliasesParams,
53
+ params: RequestParams = {},
54
+ ) => {
55
+ return client.request<APIV21EntitiesCarrierAlias[], APIV2EntitiesApiError>({
56
+ path: `/api/v2.1/carrier_aliases`,
57
+ method: "GET",
58
+ query: query,
59
+ format: "json",
60
+ ...params,
61
+ });
62
+ };
@@ -9,6 +9,19 @@
9
9
  * ---------------------------------------------------------------
10
10
  */
11
11
 
12
+ /** API_V2_1_Entities_CarrierAlias model */
13
+ export interface APIV21EntitiesCarrierAlias {
14
+ /** carrier alias slug */
15
+ context?: string;
16
+ /**
17
+ * carrier alias object id
18
+ * @format int32
19
+ */
20
+ id?: number;
21
+ /** carrier alias object name */
22
+ name?: string;
23
+ }
24
+
12
25
  /** API_V2_1_Entities_ConsumerReturn model */
13
26
  export interface APIV21EntitiesConsumerReturn {
14
27
  /**
@@ -1578,6 +1591,19 @@ export interface APIV2EntitiesBundleItem {
1578
1591
  updated_at?: string;
1579
1592
  }
1580
1593
 
1594
+ /** API_V2_Entities_CarrierAlias model */
1595
+ export interface APIV2EntitiesCarrierAlias {
1596
+ /** carrier alias slug */
1597
+ context?: string;
1598
+ /**
1599
+ * carrier alias object id
1600
+ * @format int32
1601
+ */
1602
+ id?: number;
1603
+ /** carrier alias object name */
1604
+ name?: string;
1605
+ }
1606
+
1581
1607
  /** API_V2_Entities_ConsumerReturn model */
1582
1608
  export interface APIV2EntitiesConsumerReturn {
1583
1609
  /**
@@ -4038,6 +4064,27 @@ export interface APIV2EntitiesWholesale {
4038
4064
  vendor_number?: string;
4039
4065
  }
4040
4066
 
4067
+ export interface GetApiV21CarrierAliasesParams {
4068
+ /** JSON search string like {"attribute_eq": "Term"} */
4069
+ search?: string;
4070
+ /** Comma-separated list of fields to include in the response */
4071
+ fields?: string;
4072
+ /** A list of sort options (ex: name asc,created_at desc) */
4073
+ sort?: string;
4074
+ /**
4075
+ * Page of results to fetch.
4076
+ * @format int32
4077
+ * @default 1
4078
+ */
4079
+ page?: number;
4080
+ /**
4081
+ * Number of results to return per page.
4082
+ * @format int32
4083
+ * @default 25
4084
+ */
4085
+ per_page?: number;
4086
+ }
4087
+
4041
4088
  export interface GetApiV21ConsumerReturnsCountParams {
4042
4089
  /** JSON search string like {"attribute_eq": "Term"} */
4043
4090
  search?: string;
@@ -4591,6 +4638,27 @@ export interface GetApiV21TemplatesParams {
4591
4638
  per_page?: number;
4592
4639
  }
4593
4640
 
4641
+ export interface GetApiV2CarrierAliasesParams {
4642
+ /** JSON search string like {"attribute_eq": "Term"} */
4643
+ search?: string;
4644
+ /** Comma-separated list of fields to include in the response */
4645
+ fields?: string;
4646
+ /** A list of sort options (ex: name asc,created_at desc) */
4647
+ sort?: string;
4648
+ /**
4649
+ * Page of results to fetch.
4650
+ * @format int32
4651
+ * @default 1
4652
+ */
4653
+ page?: number;
4654
+ /**
4655
+ * Number of results to return per page.
4656
+ * @format int32
4657
+ * @default 25
4658
+ */
4659
+ per_page?: number;
4660
+ }
4661
+
4594
4662
  export interface GetApiV2ConsumerReturnsCountParams {
4595
4663
  /** JSON search string like {"attribute_eq": "Term"} */
4596
4664
  search?: string;
@@ -1,4 +1,5 @@
1
1
  export * from './BundleItems';
2
+ export * from './CarrierAliases';
2
3
  export * from './ConsumerReturns';
3
4
  export * from './Customers';
4
5
  export * from './Documents';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whiplashmerch/whiplash-api-client",
3
- "version": "0.4.113",
3
+ "version": "0.4.115",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {