@whiplashmerch/whiplash-api-client 2.0.36 → 3.0.1
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.
- package/dist/client.esm.js +3953 -16323
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/AccountTransactions.d.ts +2 -2
- package/dist/generated/Accounts.d.ts +9 -9
- package/dist/generated/BillOfLadings.d.ts +4 -4
- package/dist/generated/Broadcasts.d.ts +2 -2
- package/dist/generated/BundleItems.d.ts +2 -2
- package/dist/generated/CarrierAccounts.d.ts +12 -12
- package/dist/generated/Carriers.d.ts +37 -1
- package/dist/generated/Chromalists.d.ts +2 -2
- package/dist/generated/ConsumerReturns.d.ts +10 -10
- package/dist/generated/Currencies.d.ts +2 -2
- package/dist/generated/Customers.d.ts +15 -15
- package/dist/generated/Documents.d.ts +3 -3
- package/dist/generated/FilterSets.d.ts +10 -10
- package/dist/generated/ImporterOfRecords.d.ts +5 -5
- package/dist/generated/Incidents.d.ts +2 -2
- package/dist/generated/InvoiceItems.d.ts +4 -4
- package/dist/generated/Invoices.d.ts +4 -4
- package/dist/generated/Items.d.ts +31 -31
- package/dist/generated/Loads.d.ts +4 -4
- package/dist/generated/LocationAdjustments.d.ts +5 -5
- package/dist/generated/LocationAudits.d.ts +3 -3
- package/dist/generated/LocationTransfers.d.ts +3 -3
- package/dist/generated/Locations.d.ts +11 -11
- package/dist/generated/Lots.d.ts +10 -10
- package/dist/generated/Manifests.d.ts +7 -7
- package/dist/generated/MetaKeys.d.ts +4 -4
- package/dist/generated/Nav.d.ts +2 -2
- package/dist/generated/NavItems.d.ts +2 -2
- package/dist/generated/NotificationEvents.d.ts +3 -3
- package/dist/generated/NotificationSubscriptions.d.ts +8 -8
- package/dist/generated/OrderBatchItems.d.ts +3 -3
- package/dist/generated/OrderBatchRequests.d.ts +2 -2
- package/dist/generated/OrderBatches.d.ts +17 -17
- package/dist/generated/OrderDocuments.d.ts +2 -2
- package/dist/generated/OrderItems.d.ts +13 -13
- package/dist/generated/OrderTotes.d.ts +4 -4
- package/dist/generated/Orders.d.ts +29 -29
- package/dist/generated/Originators.d.ts +8 -8
- package/dist/generated/Packages.d.ts +12 -12
- package/dist/generated/Pallets.d.ts +5 -5
- package/dist/generated/Partners.d.ts +2 -2
- package/dist/generated/ProjectTasks.d.ts +2 -2
- package/dist/generated/Projects.d.ts +4 -4
- package/dist/generated/Public.d.ts +2 -2
- package/dist/generated/Rates.d.ts +10 -10
- package/dist/generated/ReasonCodes.d.ts +3 -3
- package/dist/generated/RelocateInventoryTransfers.d.ts +2 -2
- package/dist/generated/ReturnAddresses.d.ts +7 -7
- package/dist/generated/Rules.d.ts +8 -8
- package/dist/generated/ScancodeAliases.d.ts +2 -2
- package/dist/generated/Scancodes.d.ts +2 -2
- package/dist/generated/Schemas.d.ts +20 -0
- package/dist/generated/SerialNumbers.d.ts +2 -2
- package/dist/generated/ShipnoticeItems.d.ts +18 -18
- package/dist/generated/Shipnotices.d.ts +22 -22
- package/dist/generated/ShippingAliases.d.ts +8 -8
- package/dist/generated/ShippingBlacklistedMethods.d.ts +2 -2
- package/dist/generated/ShippingMethodMarkups.d.ts +7 -7
- package/dist/generated/ShippingMethods.d.ts +4 -4
- package/dist/generated/Shops.d.ts +9 -9
- package/dist/generated/Stats.d.ts +3 -3
- package/dist/generated/SurchargeMarkups.d.ts +4 -4
- package/dist/generated/TemplateTypes.d.ts +2 -2
- package/dist/generated/Templates.d.ts +14 -14
- package/dist/generated/Transactions.d.ts +7 -7
- package/dist/generated/TransportationMarkups.d.ts +4 -4
- package/dist/generated/Users.d.ts +6 -6
- package/dist/generated/WarehouseFeatures.d.ts +2 -2
- package/dist/generated/Warehouses.d.ts +7 -7
- package/dist/generated/Wholesales.d.ts +2 -2
- package/dist/generated/data-contracts.d.ts +3365 -1071
- package/dist/generated/index.d.ts +1 -0
- package/dist/mock-data/index.d.ts +13 -5
- package/dist/mock-data/v2/consumer-return/all.d.ts +1 -1087
- package/dist/mock-data/v2/consumer-return/in-transit.d.ts +192 -355
- package/dist/mock-data/v2/customer/normal.d.ts +1 -0
- package/dist/mock-data/v2/item/bundle.d.ts +61 -0
- package/dist/mock-data/v2/item/merch.d.ts +121 -0
- package/dist/mock-data/v2/item/packaging.d.ts +61 -0
- package/dist/mock-data/v2/item/single.d.ts +9 -5
- package/dist/mock-data/v2/location/multiple.d.ts +78 -0
- package/dist/mock-data/v2/location/single.d.ts +78 -0
- package/dist/mock-data/v2/order/all.d.ts +1 -1665
- package/dist/mock-data/v2/order/processing.d.ts +67 -20
- package/dist/mock-data/v2/shipnotice/all.d.ts +1 -621
- package/dist/mock-data/v2/shipnotice/in-transit.d.ts +94 -51
- package/dist/mock-data/v2/shipnotice/processing.d.ts +90 -47
- package/dist/mock-data/v2_1/consumer-return/all.d.ts +1 -1087
- package/dist/mock-data/v2_1/consumer-return/in-transit.d.ts +10 -500
- package/dist/mock-data/v2_1/importer-of-record/created.d.ts +1 -0
- package/dist/mock-data/v2_1/item/bundle.d.ts +60 -0
- package/dist/mock-data/v2_1/item/merch.d.ts +119 -0
- package/dist/mock-data/v2_1/item/packaging.d.ts +60 -0
- package/dist/mock-data/v2_1/item/single.d.ts +9 -6
- package/dist/mock-data/v2_1/location/multiple.d.ts +15 -0
- package/dist/mock-data/v2_1/location/single.d.ts +15 -0
- package/dist/mock-data/v2_1/order/all.d.ts +1 -384
- package/dist/mock-data/v2_1/order/processing.d.ts +49 -86
- package/dist/mock-data/v2_1/order-batch/in-load.d.ts +0 -56
- package/dist/mock-data/v2_1/order-batch/wholesale-available.d.ts +0 -56
- package/dist/mock-data/v2_1/return-address/created.d.ts +1 -0
- package/dist/mock-data/v2_1/shipnotice/all.d.ts +1 -367
- package/dist/mock-data/v2_1/shipnotice/in-transit.d.ts +20 -198
- package/dist/mock-data/v2_1/shipnotice/processing.d.ts +18 -196
- package/generated/BundleItems.ts +8 -7
- package/generated/CarrierAliases.ts +3 -3
- package/generated/ConsumerReturns.ts +22 -20
- package/generated/Customers.ts +12 -11
- package/generated/Documents.ts +11 -11
- package/generated/Items.ts +56 -48
- package/generated/NotificationEvents.ts +6 -5
- package/generated/NotificationSubscriptions.ts +16 -15
- package/generated/OrderDocuments.ts +3 -3
- package/generated/OrderItems.ts +25 -24
- package/generated/OrderTotes.ts +6 -5
- package/generated/Orders.ts +47 -42
- package/generated/Originators.ts +4 -3
- package/generated/Projects.ts +4 -3
- package/generated/ShipnoticeItems.ts +17 -16
- package/generated/Shipnotices.ts +32 -30
- package/generated/Simulate.ts +13 -13
- package/generated/Templates.ts +11 -13
- package/generated/WholesaleItems.ts +9 -9
- package/generated/data-contracts.ts +558 -48
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesAccountTransaction, ApiV2EntitiesAccountTransaction, ApiV2EntitiesCount, GetApiV21AccountTransactionsCountParams, GetApiV21AccountTransactionsParams, GetApiV2AccountTransactionsCountParams, GetApiV2AccountTransactionsParams } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesAccountTransaction, ApiV21EntitiesCount, ApiV2EntitiesAccountTransaction, ApiV2EntitiesCount, GetApiV21AccountTransactionsCountParams, GetApiV21AccountTransactionsParams, GetApiV2AccountTransactionsCountParams, GetApiV2AccountTransactionsParams } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all account transactions
|
|
@@ -44,7 +44,7 @@ export declare const getApiV21AccountTransactions: (client: HttpClient, query: G
|
|
|
44
44
|
* @summary Count account transactions
|
|
45
45
|
* @request GET:/api/v2.1/account_transactions/count
|
|
46
46
|
*/
|
|
47
|
-
export declare const getApiV21AccountTransactionsCount: (client: HttpClient, query: GetApiV21AccountTransactionsCountParams, params?: RequestParams) => Promise<
|
|
47
|
+
export declare const getApiV21AccountTransactionsCount: (client: HttpClient, query: GetApiV21AccountTransactionsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
48
48
|
/**
|
|
49
49
|
* @description Get an account transaction
|
|
50
50
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesAccount, ApiV21EntitiesAccountTransaction, ApiV21EntitiesPostResponse, ApiV2EntitiesAccount, ApiV2EntitiesAccountTransaction,
|
|
1
|
+
import { ApiSharedEntitiesAudits, ApiV21EntitiesAccount, ApiV21EntitiesAccountTransaction, ApiV21EntitiesCount, ApiV21EntitiesFloatNum, ApiV21EntitiesPostResponse, ApiV2EntitiesAccount, ApiV2EntitiesAccountTransaction, ApiV2EntitiesCount, ApiV2EntitiesFloatNum, GetApiV21AccountsCountParams, GetApiV21AccountsIdAccountTransactionsParams, GetApiV21AccountsParams, GetApiV2AccountsCountParams, GetApiV2AccountsIdAccountTransactionsParams, GetApiV2AccountsParams, PostApiV21AccountsIdAccountTransactionsRequest, PostApiV21AccountsRequest, PostApiV2AccountsIdAccountTransactionsRequest, PostApiV2AccountsRequest, PutApiV21AccountsIdRequest, PutApiV2AccountsIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all accounts
|
|
@@ -73,14 +73,14 @@ export declare const getApiV2AccountsIdAccountTransactions: (client: HttpClient,
|
|
|
73
73
|
*/
|
|
74
74
|
export declare const postApiV2AccountsIdAccountTransactions: (client: HttpClient, id: number, data: PostApiV2AccountsIdAccountTransactionsRequest, params?: RequestParams) => Promise<ApiV2EntitiesAccountTransaction>;
|
|
75
75
|
/**
|
|
76
|
-
* @description Get all audits for
|
|
76
|
+
* @description Get all audits for accounts
|
|
77
77
|
*
|
|
78
78
|
* @tags accounts
|
|
79
79
|
* @name GetApiV2AccountsIdAudits
|
|
80
|
-
* @summary Retrieve audit info for
|
|
80
|
+
* @summary Retrieve audit info for accounts
|
|
81
81
|
* @request GET:/api/v2/accounts/{id}/audits
|
|
82
82
|
*/
|
|
83
|
-
export declare const getApiV2AccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const getApiV2AccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiSharedEntitiesAudits>;
|
|
84
84
|
/**
|
|
85
85
|
* @description Get the suggested_refill for an order
|
|
86
86
|
*
|
|
@@ -116,7 +116,7 @@ export declare const postApiV21Accounts: (client: HttpClient, data: PostApiV21Ac
|
|
|
116
116
|
* @summary Count accounts
|
|
117
117
|
* @request GET:/api/v2.1/accounts/count
|
|
118
118
|
*/
|
|
119
|
-
export declare const getApiV21AccountsCount: (client: HttpClient, query: GetApiV21AccountsCountParams, params?: RequestParams) => Promise<
|
|
119
|
+
export declare const getApiV21AccountsCount: (client: HttpClient, query: GetApiV21AccountsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
120
120
|
/**
|
|
121
121
|
* @description Get an account
|
|
122
122
|
*
|
|
@@ -163,14 +163,14 @@ export declare const getApiV21AccountsIdAccountTransactions: (client: HttpClient
|
|
|
163
163
|
*/
|
|
164
164
|
export declare const postApiV21AccountsIdAccountTransactions: (client: HttpClient, id: number, data: PostApiV21AccountsIdAccountTransactionsRequest, params?: RequestParams) => Promise<ApiV21EntitiesPostResponse>;
|
|
165
165
|
/**
|
|
166
|
-
* @description Get all audits for
|
|
166
|
+
* @description Get all audits for accounts
|
|
167
167
|
*
|
|
168
168
|
* @tags accounts
|
|
169
169
|
* @name GetApiV21AccountsIdAudits
|
|
170
|
-
* @summary Retrieve audit info for
|
|
170
|
+
* @summary Retrieve audit info for accounts
|
|
171
171
|
* @request GET:/api/v2.1/accounts/{id}/audits
|
|
172
172
|
*/
|
|
173
|
-
export declare const getApiV21AccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
173
|
+
export declare const getApiV21AccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiSharedEntitiesAudits>;
|
|
174
174
|
/**
|
|
175
175
|
* @description Get the suggested_refill for an order
|
|
176
176
|
*
|
|
@@ -179,4 +179,4 @@ export declare const getApiV21AccountsIdAudits: (client: HttpClient, id: number,
|
|
|
179
179
|
* @summary Retrieve the suggested refill for an order
|
|
180
180
|
* @request GET:/api/v2.1/accounts/{id}/suggested_refill
|
|
181
181
|
*/
|
|
182
|
-
export declare const getApiV21AccountsIdSuggestedRefill: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
182
|
+
export declare const getApiV21AccountsIdSuggestedRefill: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesFloatNum>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesPostResponse, ApiV2EntitiesAddress, ApiV2EntitiesBillOfLading, GetApiV21BillOfLadingsIdAddressesParams, GetApiV21BillOfLadingsParams, GetApiV2BillOfLadingsIdAddressesParams, GetApiV2BillOfLadingsParams, PostApiV21BillOfLadingsIdAddressesRequest, PostApiV21BillOfLadingsRequest, PostApiV2BillOfLadingsIdAddressesRequest, PostApiV2BillOfLadingsRequest, PutApiV21BillOfLadingsIdCallActionRequest, PutApiV21BillOfLadingsIdRequest, PutApiV2BillOfLadingsIdCallActionRequest, PutApiV2BillOfLadingsIdRequest } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesAddress, ApiV21EntitiesBillOfLading, ApiV21EntitiesPostResponse, ApiV2EntitiesAddress, ApiV2EntitiesBillOfLading, GetApiV21BillOfLadingsIdAddressesParams, GetApiV21BillOfLadingsParams, GetApiV2BillOfLadingsIdAddressesParams, GetApiV2BillOfLadingsParams, PostApiV21BillOfLadingsIdAddressesRequest, PostApiV21BillOfLadingsRequest, PostApiV2BillOfLadingsIdAddressesRequest, PostApiV2BillOfLadingsRequest, PutApiV21BillOfLadingsIdCallActionRequest, PutApiV21BillOfLadingsIdRequest, PutApiV2BillOfLadingsIdCallActionRequest, PutApiV2BillOfLadingsIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Returns all bill of ladings
|
|
@@ -89,7 +89,7 @@ export declare const putApiV2BillOfLadingsIdCallAction: (client: HttpClient, act
|
|
|
89
89
|
* @summary List all bill of ladings
|
|
90
90
|
* @request GET:/api/v2.1/bill_of_ladings
|
|
91
91
|
*/
|
|
92
|
-
export declare const getApiV21BillOfLadings: (client: HttpClient, query: GetApiV21BillOfLadingsParams, params?: RequestParams) => Promise<
|
|
92
|
+
export declare const getApiV21BillOfLadings: (client: HttpClient, query: GetApiV21BillOfLadingsParams, params?: RequestParams) => Promise<ApiV21EntitiesBillOfLading[]>;
|
|
93
93
|
/**
|
|
94
94
|
* @description Create a bill of lading
|
|
95
95
|
*
|
|
@@ -116,7 +116,7 @@ export declare const getApiV21BillOfLadingsActions: (client: HttpClient, params?
|
|
|
116
116
|
* @summary Retrieve a bill of lading
|
|
117
117
|
* @request GET:/api/v2.1/bill_of_ladings/{id}
|
|
118
118
|
*/
|
|
119
|
-
export declare const getApiV21BillOfLadingsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
119
|
+
export declare const getApiV21BillOfLadingsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesBillOfLading>;
|
|
120
120
|
/**
|
|
121
121
|
* @description Update a bill of lading
|
|
122
122
|
*
|
|
@@ -143,7 +143,7 @@ export declare const deleteApiV21BillOfLadingsId: (client: HttpClient, id: numbe
|
|
|
143
143
|
* @summary List all addresses for a document
|
|
144
144
|
* @request GET:/api/v2.1/bill_of_ladings/{id}/addresses
|
|
145
145
|
*/
|
|
146
|
-
export declare const getApiV21BillOfLadingsIdAddresses: (client: HttpClient, { id, ...query }: GetApiV21BillOfLadingsIdAddressesParams, params?: RequestParams) => Promise<
|
|
146
|
+
export declare const getApiV21BillOfLadingsIdAddresses: (client: HttpClient, { id, ...query }: GetApiV21BillOfLadingsIdAddressesParams, params?: RequestParams) => Promise<ApiV21EntitiesAddress[]>;
|
|
147
147
|
/**
|
|
148
148
|
* @description Create an address for a bill of lading
|
|
149
149
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesBroadcast, ApiV21EntitiesPostResponse, ApiV2EntitiesBroadcast, ApiV2EntitiesCount, GetApiV21BroadcastsCountParams, GetApiV21BroadcastsParams, GetApiV2BroadcastsCountParams, GetApiV2BroadcastsParams, PostApiV21BroadcastsRequest, PostApiV2BroadcastsRequest, PutApiV21BroadcastsIdRequest, PutApiV2BroadcastsIdRequest } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesBroadcast, ApiV21EntitiesCount, ApiV21EntitiesPostResponse, ApiV2EntitiesBroadcast, ApiV2EntitiesCount, GetApiV21BroadcastsCountParams, GetApiV21BroadcastsParams, GetApiV2BroadcastsCountParams, GetApiV2BroadcastsParams, PostApiV21BroadcastsRequest, PostApiV2BroadcastsRequest, PutApiV21BroadcastsIdRequest, PutApiV2BroadcastsIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all broadcasts
|
|
@@ -107,7 +107,7 @@ export declare const postApiV21Broadcasts: (client: HttpClient, data: PostApiV21
|
|
|
107
107
|
* @summary Count broadcasts
|
|
108
108
|
* @request GET:/api/v2.1/broadcasts/count
|
|
109
109
|
*/
|
|
110
|
-
export declare const getApiV21BroadcastsCount: (client: HttpClient, query: GetApiV21BroadcastsCountParams, params?: RequestParams) => Promise<
|
|
110
|
+
export declare const getApiV21BroadcastsCount: (client: HttpClient, query: GetApiV21BroadcastsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
111
111
|
/**
|
|
112
112
|
* @description get broadcast levels
|
|
113
113
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV2EntitiesBundleItem, PutApiV21BundleItemsIdRequest, PutApiV2BundleItemsIdRequest } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesBundleItem, ApiV2EntitiesBundleItem, PutApiV21BundleItemsIdRequest, PutApiV2BundleItemsIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get a bundle item
|
|
@@ -35,7 +35,7 @@ export declare const deleteApiV2BundleItemsId: (client: HttpClient, id: number,
|
|
|
35
35
|
* @summary Retrieve a bundle item
|
|
36
36
|
* @request GET:/api/v2.1/bundle_items/{id}
|
|
37
37
|
*/
|
|
38
|
-
export declare const getApiV21BundleItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
38
|
+
export declare const getApiV21BundleItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesBundleItem>;
|
|
39
39
|
/**
|
|
40
40
|
* @description Update a bundle item for a bundle
|
|
41
41
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesCarrierAccount, ApiV21EntitiesPostResponse,
|
|
1
|
+
import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiV21EntitiesCarrierAccount, ApiV21EntitiesCount, ApiV21EntitiesPostResponse, ApiV21EntitiesProviderCarrierAccount, ApiV2EntitiesCarrierAccount, ApiV2EntitiesCount, ApiV2EntitiesProviderCarrierAccount, GetApiV21CarrierAccountsCountParams, GetApiV21CarrierAccountsIdMetaFieldsParams, GetApiV21CarrierAccountsParams, GetApiV21CarrierAccountsProviderAccountsParams, GetApiV2CarrierAccountsCountParams, GetApiV2CarrierAccountsIdMetaFieldsParams, GetApiV2CarrierAccountsParams, GetApiV2CarrierAccountsProviderAccountsParams, PostApiV21CarrierAccountsRequest, PostApiV2CarrierAccountsRequest, PutApiV21CarrierAccountsIdMetaFieldsRequest, PutApiV21CarrierAccountsIdRequest, PutApiV2CarrierAccountsIdMetaFieldsRequest, PutApiV2CarrierAccountsIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get a list of carrier_accounts
|
|
@@ -73,14 +73,14 @@ export declare const putApiV2CarrierAccountsId: (client: HttpClient, id: number,
|
|
|
73
73
|
*/
|
|
74
74
|
export declare const deleteApiV2CarrierAccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
75
75
|
/**
|
|
76
|
-
* @description Get all audits for
|
|
76
|
+
* @description Get all audits for carrier_accounts
|
|
77
77
|
*
|
|
78
78
|
* @tags carrier_accounts
|
|
79
79
|
* @name GetApiV2CarrierAccountsIdAudits
|
|
80
|
-
* @summary Retrieve audit info for
|
|
80
|
+
* @summary Retrieve audit info for carrier_accounts
|
|
81
81
|
* @request GET:/api/v2/carrier_accounts/{id}/audits
|
|
82
82
|
*/
|
|
83
|
-
export declare const getApiV2CarrierAccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const getApiV2CarrierAccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiSharedEntitiesAudits>;
|
|
84
84
|
/**
|
|
85
85
|
* @description Get easypost details for a carrier_account
|
|
86
86
|
*
|
|
@@ -98,7 +98,7 @@ export declare const getApiV2CarrierAccountsIdEasypostAccount: (client: HttpClie
|
|
|
98
98
|
* @summary List all Meta Fields
|
|
99
99
|
* @request GET:/api/v2/carrier_accounts/{id}/meta_fields
|
|
100
100
|
*/
|
|
101
|
-
export declare const getApiV2CarrierAccountsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2CarrierAccountsIdMetaFieldsParams, params?: RequestParams) => Promise<
|
|
101
|
+
export declare const getApiV2CarrierAccountsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2CarrierAccountsIdMetaFieldsParams, params?: RequestParams) => Promise<ApiSharedEntitiesMetaFields[]>;
|
|
102
102
|
/**
|
|
103
103
|
* @description Update Shop meta fields
|
|
104
104
|
*
|
|
@@ -143,7 +143,7 @@ export declare const postApiV21CarrierAccounts: (client: HttpClient, data: PostA
|
|
|
143
143
|
* @summary Count carrier acounts
|
|
144
144
|
* @request GET:/api/v2.1/carrier_accounts/count
|
|
145
145
|
*/
|
|
146
|
-
export declare const getApiV21CarrierAccountsCount: (client: HttpClient, query: GetApiV21CarrierAccountsCountParams, params?: RequestParams) => Promise<
|
|
146
|
+
export declare const getApiV21CarrierAccountsCount: (client: HttpClient, query: GetApiV21CarrierAccountsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
147
147
|
/**
|
|
148
148
|
* @description Get a list of EasyPost carrier_accounts
|
|
149
149
|
*
|
|
@@ -152,7 +152,7 @@ export declare const getApiV21CarrierAccountsCount: (client: HttpClient, query:
|
|
|
152
152
|
* @summary Get a list of EasyPost carrier_accounts
|
|
153
153
|
* @request GET:/api/v2.1/carrier_accounts/easypost
|
|
154
154
|
*/
|
|
155
|
-
export declare const getApiV21CarrierAccountsEasypost: (client: HttpClient, params?: RequestParams) => Promise<
|
|
155
|
+
export declare const getApiV21CarrierAccountsEasypost: (client: HttpClient, params?: RequestParams) => Promise<ApiV21EntitiesProviderCarrierAccount>;
|
|
156
156
|
/**
|
|
157
157
|
* @description Get a list of provider carrier_accounts
|
|
158
158
|
*
|
|
@@ -161,7 +161,7 @@ export declare const getApiV21CarrierAccountsEasypost: (client: HttpClient, para
|
|
|
161
161
|
* @summary Retrieve a list of provider carrier accounts
|
|
162
162
|
* @request GET:/api/v2.1/carrier_accounts/provider_accounts
|
|
163
163
|
*/
|
|
164
|
-
export declare const getApiV21CarrierAccountsProviderAccounts: (client: HttpClient, query: GetApiV21CarrierAccountsProviderAccountsParams, params?: RequestParams) => Promise<
|
|
164
|
+
export declare const getApiV21CarrierAccountsProviderAccounts: (client: HttpClient, query: GetApiV21CarrierAccountsProviderAccountsParams, params?: RequestParams) => Promise<ApiV21EntitiesProviderCarrierAccount[]>;
|
|
165
165
|
/**
|
|
166
166
|
* @description Get a carrier_account
|
|
167
167
|
*
|
|
@@ -190,14 +190,14 @@ export declare const putApiV21CarrierAccountsId: (client: HttpClient, id: number
|
|
|
190
190
|
*/
|
|
191
191
|
export declare const deleteApiV21CarrierAccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
192
192
|
/**
|
|
193
|
-
* @description Get all audits for
|
|
193
|
+
* @description Get all audits for carrier_accounts
|
|
194
194
|
*
|
|
195
195
|
* @tags carrier_accounts
|
|
196
196
|
* @name GetApiV21CarrierAccountsIdAudits
|
|
197
|
-
* @summary Retrieve audit info for
|
|
197
|
+
* @summary Retrieve audit info for carrier_accounts
|
|
198
198
|
* @request GET:/api/v2.1/carrier_accounts/{id}/audits
|
|
199
199
|
*/
|
|
200
|
-
export declare const getApiV21CarrierAccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
200
|
+
export declare const getApiV21CarrierAccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiSharedEntitiesAudits>;
|
|
201
201
|
/**
|
|
202
202
|
* @description Get easypost details for a carrier_account
|
|
203
203
|
*
|
|
@@ -215,7 +215,7 @@ export declare const getApiV21CarrierAccountsIdEasypostAccount: (client: HttpCli
|
|
|
215
215
|
* @summary List all Meta Fields
|
|
216
216
|
* @request GET:/api/v2.1/carrier_accounts/{id}/meta_fields
|
|
217
217
|
*/
|
|
218
|
-
export declare const getApiV21CarrierAccountsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21CarrierAccountsIdMetaFieldsParams, params?: RequestParams) => Promise<
|
|
218
|
+
export declare const getApiV21CarrierAccountsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21CarrierAccountsIdMetaFieldsParams, params?: RequestParams) => Promise<ApiSharedEntitiesMetaFields[]>;
|
|
219
219
|
/**
|
|
220
220
|
* @description Update Shop meta fields
|
|
221
221
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesCarrier, ApiV21EntitiesPostResponse, ApiV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams, PostApiV21CarriersRequest, PutApiV21CarriersIdRequest } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesCarrier, ApiV21EntitiesPostResponse, ApiV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams, PostApiV21CarriersRequest, PostApiV2CarriersRequest, PutApiV21CarriersIdRequest, PutApiV2CarriersIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get a list of carriers
|
|
@@ -9,6 +9,42 @@ import { HttpClient, RequestParams } from "./http-client";
|
|
|
9
9
|
* @request GET:/api/v2/carriers
|
|
10
10
|
*/
|
|
11
11
|
export declare const getApiV2Carriers: (client: HttpClient, query: GetApiV2CarriersParams, params?: RequestParams) => Promise<ApiV2EntitiesCarrier[]>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Create a carrier
|
|
14
|
+
*
|
|
15
|
+
* @tags carriers
|
|
16
|
+
* @name PostApiV2Carriers
|
|
17
|
+
* @summary Create a carrier
|
|
18
|
+
* @request POST:/api/v2/carriers
|
|
19
|
+
*/
|
|
20
|
+
export declare const postApiV2Carriers: (client: HttpClient, data: PostApiV2CarriersRequest, params?: RequestParams) => Promise<ApiV2EntitiesCarrier>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Get a carrier
|
|
23
|
+
*
|
|
24
|
+
* @tags carriers
|
|
25
|
+
* @name GetApiV2CarriersId
|
|
26
|
+
* @summary Retrieve a carrier
|
|
27
|
+
* @request GET:/api/v2/carriers/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2CarriersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesCarrier>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Update a carrier
|
|
32
|
+
*
|
|
33
|
+
* @tags carriers
|
|
34
|
+
* @name PutApiV2CarriersId
|
|
35
|
+
* @summary Update a carrier
|
|
36
|
+
* @request PUT:/api/v2/carriers/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const putApiV2CarriersId: (client: HttpClient, id: number, data: PutApiV2CarriersIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesCarrier>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Destroy a carrier
|
|
41
|
+
*
|
|
42
|
+
* @tags carriers
|
|
43
|
+
* @name DeleteApiV2CarriersId
|
|
44
|
+
* @summary Destroy a carrier
|
|
45
|
+
* @request DELETE:/api/v2/carriers/{id}
|
|
46
|
+
*/
|
|
47
|
+
export declare const deleteApiV2CarriersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
12
48
|
/**
|
|
13
49
|
* @description Get a list of carriers
|
|
14
50
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesPostResponse, ApiV2EntitiesChromalist, GetApiV21ChromalistsParams, GetApiV2ChromalistsParams, PostApiV21ChromalistsRequest, PostApiV2ChromalistsRequest } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesChromalist, ApiV21EntitiesPostResponse, ApiV2EntitiesChromalist, GetApiV21ChromalistsParams, GetApiV2ChromalistsParams, PostApiV21ChromalistsRequest, PostApiV2ChromalistsRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all chromalists
|
|
@@ -35,7 +35,7 @@ export declare const deleteApiV2ChromalistsId: (client: HttpClient, id: number,
|
|
|
35
35
|
* @summary List all chromalists
|
|
36
36
|
* @request GET:/api/v2.1/chromalists
|
|
37
37
|
*/
|
|
38
|
-
export declare const getApiV21Chromalists: (client: HttpClient, query: GetApiV21ChromalistsParams, params?: RequestParams) => Promise<
|
|
38
|
+
export declare const getApiV21Chromalists: (client: HttpClient, query: GetApiV21ChromalistsParams, params?: RequestParams) => Promise<ApiV21EntitiesChromalist[]>;
|
|
39
39
|
/**
|
|
40
40
|
* @description Create a chromalist
|
|
41
41
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesConsumerReturn, ApiV21EntitiesIncident, ApiV21EntitiesPostResponse, ApiV2EntitiesConsumerReturn, ApiV2EntitiesCount, ApiV2EntitiesIncident,
|
|
1
|
+
import { ApiSharedEntitiesMetaFields, ApiV21EntitiesConsumerReturn, ApiV21EntitiesCount, ApiV21EntitiesIncident, ApiV21EntitiesOriginator, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV2EntitiesConsumerReturn, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesOriginator, ApiV2EntitiesResult, GetApiV21ConsumerReturnsAggregateParams, GetApiV21ConsumerReturnsCountParams, GetApiV21ConsumerReturnsIdCallTraitParams, GetApiV21ConsumerReturnsIdIncidentsCountParams, GetApiV21ConsumerReturnsIdIncidentsParams, GetApiV21ConsumerReturnsIdMetaFieldsParams, GetApiV21ConsumerReturnsIdTraitsParams, GetApiV21ConsumerReturnsParams, GetApiV2ConsumerReturnsAggregateParams, GetApiV2ConsumerReturnsCountParams, GetApiV2ConsumerReturnsIdCallTraitParams, GetApiV2ConsumerReturnsIdIncidentsCountParams, GetApiV2ConsumerReturnsIdIncidentsParams, GetApiV2ConsumerReturnsIdMetaFieldsParams, GetApiV2ConsumerReturnsIdTraitsParams, GetApiV2ConsumerReturnsParams, PostApiV21ConsumerReturnsBulkRequest, PostApiV21ConsumerReturnsIdIncidentsRequest, PostApiV21ConsumerReturnsRequest, PostApiV2ConsumerReturnsBulkRequest, PostApiV2ConsumerReturnsIdIncidentsRequest, PostApiV2ConsumerReturnsRequest, PutApiV21ConsumerReturnsIdMetaFieldsRequest, PutApiV21ConsumerReturnsIdRequest, PutApiV2ConsumerReturnsIdMetaFieldsRequest, PutApiV2ConsumerReturnsIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all consumer returns
|
|
@@ -125,7 +125,7 @@ export declare const getApiV2ConsumerReturnsIdIncidentsCount: (client: HttpClien
|
|
|
125
125
|
* @summary List meta fields
|
|
126
126
|
* @request GET:/api/v2/consumer_returns/{id}/meta_fields
|
|
127
127
|
*/
|
|
128
|
-
export declare const getApiV2ConsumerReturnsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ConsumerReturnsIdMetaFieldsParams, params?: RequestParams) => Promise<
|
|
128
|
+
export declare const getApiV2ConsumerReturnsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ConsumerReturnsIdMetaFieldsParams, params?: RequestParams) => Promise<ApiSharedEntitiesMetaFields>;
|
|
129
129
|
/**
|
|
130
130
|
* @description Update ConsumerReturn meta fields
|
|
131
131
|
*
|
|
@@ -179,7 +179,7 @@ export declare const postApiV21ConsumerReturns: (client: HttpClient, data: PostA
|
|
|
179
179
|
* @summary Returns aggregated consumer_returns
|
|
180
180
|
* @request GET:/api/v2.1/consumer_returns/aggregate
|
|
181
181
|
*/
|
|
182
|
-
export declare const getApiV21ConsumerReturnsAggregate: (client: HttpClient, query: GetApiV21ConsumerReturnsAggregateParams, params?: RequestParams) => Promise<
|
|
182
|
+
export declare const getApiV21ConsumerReturnsAggregate: (client: HttpClient, query: GetApiV21ConsumerReturnsAggregateParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
183
183
|
/**
|
|
184
184
|
* @description Create consumer_returns in bulk
|
|
185
185
|
*
|
|
@@ -188,7 +188,7 @@ export declare const getApiV21ConsumerReturnsAggregate: (client: HttpClient, que
|
|
|
188
188
|
* @summary Create consumer_returns in bulk
|
|
189
189
|
* @request POST:/api/v2.1/consumer_returns/bulk
|
|
190
190
|
*/
|
|
191
|
-
export declare const postApiV21ConsumerReturnsBulk: (client: HttpClient, data: PostApiV21ConsumerReturnsBulkRequest, params?: RequestParams) => Promise<
|
|
191
|
+
export declare const postApiV21ConsumerReturnsBulk: (client: HttpClient, data: PostApiV21ConsumerReturnsBulkRequest, params?: RequestParams) => Promise<ApiV21EntitiesResult[]>;
|
|
192
192
|
/**
|
|
193
193
|
* @description Returns count of consumer returns
|
|
194
194
|
*
|
|
@@ -197,7 +197,7 @@ export declare const postApiV21ConsumerReturnsBulk: (client: HttpClient, data: P
|
|
|
197
197
|
* @summary Count consumer returns
|
|
198
198
|
* @request GET:/api/v2.1/consumer_returns/count
|
|
199
199
|
*/
|
|
200
|
-
export declare const getApiV21ConsumerReturnsCount: (client: HttpClient, query: GetApiV21ConsumerReturnsCountParams, params?: RequestParams) => Promise<
|
|
200
|
+
export declare const getApiV21ConsumerReturnsCount: (client: HttpClient, query: GetApiV21ConsumerReturnsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
201
201
|
/**
|
|
202
202
|
* @description Get consumer_returns traits
|
|
203
203
|
*
|
|
@@ -242,7 +242,7 @@ export declare const deleteApiV21ConsumerReturnsId: (client: HttpClient, id: num
|
|
|
242
242
|
* @summary Retrieve the specified consumer_returns trait
|
|
243
243
|
* @request GET:/api/v2.1/consumer_returns/{id}/call/{trait}
|
|
244
244
|
*/
|
|
245
|
-
export declare const getApiV21ConsumerReturnsIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21ConsumerReturnsIdCallTraitParams, params?: RequestParams) => Promise<
|
|
245
|
+
export declare const getApiV21ConsumerReturnsIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21ConsumerReturnsIdCallTraitParams, params?: RequestParams) => Promise<ApiV21EntitiesResult>;
|
|
246
246
|
/**
|
|
247
247
|
* @description Get all incidents for a(n) ConsumerReturn
|
|
248
248
|
*
|
|
@@ -269,7 +269,7 @@ export declare const postApiV21ConsumerReturnsIdIncidents: (client: HttpClient,
|
|
|
269
269
|
* @summary Count incidents for a resource
|
|
270
270
|
* @request GET:/api/v2.1/consumer_returns/{id}/incidents/count
|
|
271
271
|
*/
|
|
272
|
-
export declare const getApiV21ConsumerReturnsIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdIncidentsCountParams, params?: RequestParams) => Promise<
|
|
272
|
+
export declare const getApiV21ConsumerReturnsIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdIncidentsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
273
273
|
/**
|
|
274
274
|
* @description Get the meta fields for a(n) ConsumerReturn
|
|
275
275
|
*
|
|
@@ -278,7 +278,7 @@ export declare const getApiV21ConsumerReturnsIdIncidentsCount: (client: HttpClie
|
|
|
278
278
|
* @summary List meta fields
|
|
279
279
|
* @request GET:/api/v2.1/consumer_returns/{id}/meta_fields
|
|
280
280
|
*/
|
|
281
|
-
export declare const getApiV21ConsumerReturnsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdMetaFieldsParams, params?: RequestParams) => Promise<
|
|
281
|
+
export declare const getApiV21ConsumerReturnsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdMetaFieldsParams, params?: RequestParams) => Promise<ApiSharedEntitiesMetaFields>;
|
|
282
282
|
/**
|
|
283
283
|
* @description Update ConsumerReturn meta fields
|
|
284
284
|
*
|
|
@@ -296,7 +296,7 @@ export declare const putApiV21ConsumerReturnsIdMetaFields: (client: HttpClient,
|
|
|
296
296
|
* @summary Retrieve the associated originator
|
|
297
297
|
* @request GET:/api/v2.1/consumer_returns/{id}/originator
|
|
298
298
|
*/
|
|
299
|
-
export declare const getApiV21ConsumerReturnsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
299
|
+
export declare const getApiV21ConsumerReturnsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOriginator>;
|
|
300
300
|
/**
|
|
301
301
|
* @description Get the specified consumer_returns traits
|
|
302
302
|
*
|
|
@@ -305,4 +305,4 @@ export declare const getApiV21ConsumerReturnsIdOriginator: (client: HttpClient,
|
|
|
305
305
|
* @summary Retrieve the specified consumer_returns traits
|
|
306
306
|
* @request GET:/api/v2.1/consumer_returns/{id}/traits
|
|
307
307
|
*/
|
|
308
|
-
export declare const getApiV21ConsumerReturnsIdTraits: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdTraitsParams, params?: RequestParams) => Promise<
|
|
308
|
+
export declare const getApiV21ConsumerReturnsIdTraits: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdTraitsParams, params?: RequestParams) => Promise<ApiV21EntitiesResult>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesPostResponse, ApiV2EntitiesCurrency, GetApiV21CurrenciesParams, GetApiV2CurrenciesParams, PostApiV21CurrenciesRequest, PostApiV2CurrenciesRequest } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesCurrency, ApiV21EntitiesPostResponse, ApiV2EntitiesCurrency, GetApiV21CurrenciesParams, GetApiV2CurrenciesParams, PostApiV21CurrenciesRequest, PostApiV2CurrenciesRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all currencies
|
|
@@ -35,7 +35,7 @@ export declare const deleteApiV2CurrenciesId: (client: HttpClient, id: number, p
|
|
|
35
35
|
* @summary List all currencies
|
|
36
36
|
* @request GET:/api/v2.1/currencies
|
|
37
37
|
*/
|
|
38
|
-
export declare const getApiV21Currencies: (client: HttpClient, query: GetApiV21CurrenciesParams, params?: RequestParams) => Promise<
|
|
38
|
+
export declare const getApiV21Currencies: (client: HttpClient, query: GetApiV21CurrenciesParams, params?: RequestParams) => Promise<ApiV21EntitiesCurrency[]>;
|
|
39
39
|
/**
|
|
40
40
|
* @description Create a currency
|
|
41
41
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesCustomer, ApiV21EntitiesPostResponse,
|
|
1
|
+
import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomer, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesShop, ApiV2EntitiesCount, ApiV2EntitiesCustomer, ApiV2EntitiesResult, ApiV2EntitiesShop, GetApiV21CustomersCountParams, GetApiV21CustomersIdCallTraitParams, GetApiV21CustomersIdMetaFieldsParams, GetApiV21CustomersIdTraitsParams, GetApiV21CustomersParams, GetApiV2CustomersCountParams, GetApiV2CustomersIdCallTraitParams, GetApiV2CustomersIdMetaFieldsParams, GetApiV2CustomersIdTraitsParams, GetApiV2CustomersParams, PostApiV21CustomersRequest, PostApiV2CustomersRequest, PutApiV21CustomersIdCallActionRequest, PutApiV21CustomersIdCallAsyncActionRequest, PutApiV21CustomersIdMetaFieldsRequest, PutApiV21CustomersIdRequest, PutApiV2CustomersIdCallActionRequest, PutApiV2CustomersIdCallAsyncActionRequest, PutApiV2CustomersIdMetaFieldsRequest, PutApiV2CustomersIdRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all customers
|
|
@@ -64,14 +64,14 @@ export declare const getApiV2CustomersId: (client: HttpClient, id: number, param
|
|
|
64
64
|
*/
|
|
65
65
|
export declare const putApiV2CustomersId: (client: HttpClient, id: number, data: PutApiV2CustomersIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesCustomer>;
|
|
66
66
|
/**
|
|
67
|
-
* @description Get all audits for
|
|
67
|
+
* @description Get all audits for customers
|
|
68
68
|
*
|
|
69
69
|
* @tags customers
|
|
70
70
|
* @name GetApiV2CustomersIdAudits
|
|
71
|
-
* @summary Retrieve audit info for
|
|
71
|
+
* @summary Retrieve audit info for customers
|
|
72
72
|
* @request GET:/api/v2/customers/{id}/audits
|
|
73
73
|
*/
|
|
74
|
-
export declare const getApiV2CustomersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
74
|
+
export declare const getApiV2CustomersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiSharedEntitiesAudits>;
|
|
75
75
|
/**
|
|
76
76
|
* @description Perform an action on a customer
|
|
77
77
|
*
|
|
@@ -98,7 +98,7 @@ export declare const getApiV2CustomersIdCallTrait: (client: HttpClient, { trait,
|
|
|
98
98
|
* @summary Perform an action on a customer asynchronously
|
|
99
99
|
* @request PUT:/api/v2/customers/{id}/call_async/{action}
|
|
100
100
|
*/
|
|
101
|
-
export declare const putApiV2CustomersIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV2CustomersIdCallAsyncActionRequest, params?: RequestParams) => Promise<
|
|
101
|
+
export declare const putApiV2CustomersIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV2CustomersIdCallAsyncActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
102
102
|
/**
|
|
103
103
|
* @description Get the meta fields for a(n) Shop
|
|
104
104
|
*
|
|
@@ -107,7 +107,7 @@ export declare const putApiV2CustomersIdCallAsyncAction: (client: HttpClient, ac
|
|
|
107
107
|
* @summary List all Meta Fields
|
|
108
108
|
* @request GET:/api/v2/customers/{id}/meta_fields
|
|
109
109
|
*/
|
|
110
|
-
export declare const getApiV2CustomersIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2CustomersIdMetaFieldsParams, params?: RequestParams) => Promise<
|
|
110
|
+
export declare const getApiV2CustomersIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2CustomersIdMetaFieldsParams, params?: RequestParams) => Promise<ApiSharedEntitiesMetaFields[]>;
|
|
111
111
|
/**
|
|
112
112
|
* @description Update Shop meta fields
|
|
113
113
|
*
|
|
@@ -170,7 +170,7 @@ export declare const getApiV21CustomersActions: (client: HttpClient, params?: Re
|
|
|
170
170
|
* @summary Count customers
|
|
171
171
|
* @request GET:/api/v2.1/customers/count
|
|
172
172
|
*/
|
|
173
|
-
export declare const getApiV21CustomersCount: (client: HttpClient, query: GetApiV21CustomersCountParams, params?: RequestParams) => Promise<
|
|
173
|
+
export declare const getApiV21CustomersCount: (client: HttpClient, query: GetApiV21CustomersCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
174
174
|
/**
|
|
175
175
|
* @description Get customers traits
|
|
176
176
|
*
|
|
@@ -199,14 +199,14 @@ export declare const getApiV21CustomersId: (client: HttpClient, id: number, para
|
|
|
199
199
|
*/
|
|
200
200
|
export declare const putApiV21CustomersId: (client: HttpClient, id: number, data: PutApiV21CustomersIdRequest, params?: RequestParams) => Promise<void>;
|
|
201
201
|
/**
|
|
202
|
-
* @description Get all audits for
|
|
202
|
+
* @description Get all audits for customers
|
|
203
203
|
*
|
|
204
204
|
* @tags customers
|
|
205
205
|
* @name GetApiV21CustomersIdAudits
|
|
206
|
-
* @summary Retrieve audit info for
|
|
206
|
+
* @summary Retrieve audit info for customers
|
|
207
207
|
* @request GET:/api/v2.1/customers/{id}/audits
|
|
208
208
|
*/
|
|
209
|
-
export declare const getApiV21CustomersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
209
|
+
export declare const getApiV21CustomersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiSharedEntitiesAudits>;
|
|
210
210
|
/**
|
|
211
211
|
* @description Perform an action on a customer
|
|
212
212
|
*
|
|
@@ -224,7 +224,7 @@ export declare const putApiV21CustomersIdCallAction: (client: HttpClient, action
|
|
|
224
224
|
* @summary Retrieve the specified customers trait
|
|
225
225
|
* @request GET:/api/v2.1/customers/{id}/call/{trait}
|
|
226
226
|
*/
|
|
227
|
-
export declare const getApiV21CustomersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21CustomersIdCallTraitParams, params?: RequestParams) => Promise<
|
|
227
|
+
export declare const getApiV21CustomersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21CustomersIdCallTraitParams, params?: RequestParams) => Promise<ApiV21EntitiesResult>;
|
|
228
228
|
/**
|
|
229
229
|
* @description Perform an action on a customer asynchronously
|
|
230
230
|
*
|
|
@@ -233,7 +233,7 @@ export declare const getApiV21CustomersIdCallTrait: (client: HttpClient, { trait
|
|
|
233
233
|
* @summary Perform an action on a customer asynchronously
|
|
234
234
|
* @request PUT:/api/v2.1/customers/{id}/call_async/{action}
|
|
235
235
|
*/
|
|
236
|
-
export declare const putApiV21CustomersIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV21CustomersIdCallAsyncActionRequest, params?: RequestParams) => Promise<
|
|
236
|
+
export declare const putApiV21CustomersIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV21CustomersIdCallAsyncActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
237
237
|
/**
|
|
238
238
|
* @description Get the meta fields for a(n) Shop
|
|
239
239
|
*
|
|
@@ -242,7 +242,7 @@ export declare const putApiV21CustomersIdCallAsyncAction: (client: HttpClient, a
|
|
|
242
242
|
* @summary List all Meta Fields
|
|
243
243
|
* @request GET:/api/v2.1/customers/{id}/meta_fields
|
|
244
244
|
*/
|
|
245
|
-
export declare const getApiV21CustomersIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21CustomersIdMetaFieldsParams, params?: RequestParams) => Promise<
|
|
245
|
+
export declare const getApiV21CustomersIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21CustomersIdMetaFieldsParams, params?: RequestParams) => Promise<ApiSharedEntitiesMetaFields[]>;
|
|
246
246
|
/**
|
|
247
247
|
* @description Update Shop meta fields
|
|
248
248
|
*
|
|
@@ -260,7 +260,7 @@ export declare const putApiV21CustomersIdMetaFields: (client: HttpClient, id: nu
|
|
|
260
260
|
* @summary List all shops for a customer
|
|
261
261
|
* @request GET:/api/v2.1/customers/{id}/shops
|
|
262
262
|
*/
|
|
263
|
-
export declare const getApiV21CustomersIdShops: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
263
|
+
export declare const getApiV21CustomersIdShops: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesShop[]>;
|
|
264
264
|
/**
|
|
265
265
|
* @description Get the specified customers traits
|
|
266
266
|
*
|
|
@@ -269,4 +269,4 @@ export declare const getApiV21CustomersIdShops: (client: HttpClient, id: number,
|
|
|
269
269
|
* @summary Retrieve the specified customers traits
|
|
270
270
|
* @request GET:/api/v2.1/customers/{id}/traits
|
|
271
271
|
*/
|
|
272
|
-
export declare const getApiV21CustomersIdTraits: (client: HttpClient, { id, ...query }: GetApiV21CustomersIdTraitsParams, params?: RequestParams) => Promise<
|
|
272
|
+
export declare const getApiV21CustomersIdTraits: (client: HttpClient, { id, ...query }: GetApiV21CustomersIdTraitsParams, params?: RequestParams) => Promise<ApiV21EntitiesResult>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesDocument, ApiV21EntitiesPostResponse, ApiV2EntitiesDocument,
|
|
1
|
+
import { ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesDocument, ApiV21EntitiesPostResponse, ApiV2EntitiesDocument, GetApiV21DocumentsParams, GetApiV2DocumentsParams, PostApiV21DocumentsRequest, PostApiV2DocumentsRequest, PutApiV21DocumentsIdCallActionRequest, PutApiV21DocumentsIdCallAsyncActionRequest, PutApiV2DocumentsIdCallActionRequest, PutApiV2DocumentsIdCallAsyncActionRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get all documents
|
|
@@ -62,7 +62,7 @@ export declare const putApiV2DocumentsIdCallAction: (client: HttpClient, action:
|
|
|
62
62
|
* @summary Perform an action on an document asynchronously
|
|
63
63
|
* @request PUT:/api/v2/documents/{id}/call_async/{action}
|
|
64
64
|
*/
|
|
65
|
-
export declare const putApiV2DocumentsIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV2DocumentsIdCallAsyncActionRequest, params?: RequestParams) => Promise<
|
|
65
|
+
export declare const putApiV2DocumentsIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV2DocumentsIdCallAsyncActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
66
66
|
/**
|
|
67
67
|
* @description Get all documents
|
|
68
68
|
*
|
|
@@ -125,4 +125,4 @@ export declare const putApiV21DocumentsIdCallAction: (client: HttpClient, action
|
|
|
125
125
|
* @summary Perform an action on an document asynchronously
|
|
126
126
|
* @request PUT:/api/v2.1/documents/{id}/call_async/{action}
|
|
127
127
|
*/
|
|
128
|
-
export declare const putApiV21DocumentsIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV21DocumentsIdCallAsyncActionRequest, params?: RequestParams) => Promise<
|
|
128
|
+
export declare const putApiV21DocumentsIdCallAsyncAction: (client: HttpClient, action: string, id: number, data: PutApiV21DocumentsIdCallAsyncActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesFilterSet, ApiV21EntitiesPostResponse, ApiV2EntitiesCount, ApiV2EntitiesFilterSet, ApiV2EntitiesFilterSetOptions, ApiV2EntitiesResult,
|
|
1
|
+
import { ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesFilterSet, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV2EntitiesCount, ApiV2EntitiesFilterSet, ApiV2EntitiesFilterSetOptions, ApiV2EntitiesResult, GetApiV21FilterSetsCountParams, GetApiV21FilterSetsIdCallTraitParams, GetApiV21FilterSetsIdResultsAggregateParams, GetApiV21FilterSetsIdResultsCountParams, GetApiV21FilterSetsIdResultsParams, GetApiV21FilterSetsIdTraitsParams, GetApiV21FilterSetsParams, GetApiV2FilterSetsCountParams, GetApiV2FilterSetsIdCallTraitParams, GetApiV2FilterSetsIdResultsAggregateParams, GetApiV2FilterSetsIdResultsCountParams, GetApiV2FilterSetsIdResultsParams, GetApiV2FilterSetsIdTraitsParams, GetApiV2FilterSetsParams, PostApiV21FilterSetsRequest, PostApiV2FilterSetsRequest, PutApiV21FilterSetsIdBatchRequest, PutApiV21FilterSetsIdCallActionRequest, PutApiV21FilterSetsIdCallEachActionRequest, PutApiV21FilterSetsIdExportRequest, PutApiV21FilterSetsIdRequest, PutApiV21FilterSetsUpsertRequest, PutApiV2FilterSetsIdBatchRequest, PutApiV2FilterSetsIdCallActionRequest, PutApiV2FilterSetsIdCallEachActionRequest, PutApiV2FilterSetsIdExportRequest, PutApiV2FilterSetsIdRequest, PutApiV2FilterSetsUpsertRequest } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Returns all filter sets
|
|
@@ -98,7 +98,7 @@ export declare const putApiV2FilterSetsIdBatch: (client: HttpClient, id: number,
|
|
|
98
98
|
* @summary Perform an action on a resource or collection
|
|
99
99
|
* @request PUT:/api/v2/filter_sets/{id}/call/{action}
|
|
100
100
|
*/
|
|
101
|
-
export declare const putApiV2FilterSetsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV2FilterSetsIdCallActionRequest, params?: RequestParams) => Promise<
|
|
101
|
+
export declare const putApiV2FilterSetsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV2FilterSetsIdCallActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
102
102
|
/**
|
|
103
103
|
* @description Get the specified filter_sets trait
|
|
104
104
|
*
|
|
@@ -116,7 +116,7 @@ export declare const getApiV2FilterSetsIdCallTrait: (client: HttpClient, { trait
|
|
|
116
116
|
* @summary Perform an action on all filter set results
|
|
117
117
|
* @request PUT:/api/v2/filter_sets/{id}/call_each/{action}
|
|
118
118
|
*/
|
|
119
|
-
export declare const putApiV2FilterSetsIdCallEachAction: (client: HttpClient, action: string, id: number, data: PutApiV2FilterSetsIdCallEachActionRequest, params?: RequestParams) => Promise<
|
|
119
|
+
export declare const putApiV2FilterSetsIdCallEachAction: (client: HttpClient, action: string, id: number, data: PutApiV2FilterSetsIdCallEachActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
120
120
|
/**
|
|
121
121
|
* @description Export all filter set results
|
|
122
122
|
*
|
|
@@ -197,7 +197,7 @@ export declare const postApiV21FilterSets: (client: HttpClient, data: PostApiV21
|
|
|
197
197
|
* @summary Count filter sets
|
|
198
198
|
* @request GET:/api/v2.1/filter_sets/count
|
|
199
199
|
*/
|
|
200
|
-
export declare const getApiV21FilterSetsCount: (client: HttpClient, query: GetApiV21FilterSetsCountParams, params?: RequestParams) => Promise<
|
|
200
|
+
export declare const getApiV21FilterSetsCount: (client: HttpClient, query: GetApiV21FilterSetsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
201
201
|
/**
|
|
202
202
|
* @description Returns filter set options
|
|
203
203
|
*
|
|
@@ -269,7 +269,7 @@ export declare const putApiV21FilterSetsIdBatch: (client: HttpClient, id: number
|
|
|
269
269
|
* @summary Perform an action on a resource or collection
|
|
270
270
|
* @request PUT:/api/v2.1/filter_sets/{id}/call/{action}
|
|
271
271
|
*/
|
|
272
|
-
export declare const putApiV21FilterSetsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV21FilterSetsIdCallActionRequest, params?: RequestParams) => Promise<
|
|
272
|
+
export declare const putApiV21FilterSetsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV21FilterSetsIdCallActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
273
273
|
/**
|
|
274
274
|
* @description Get the specified filter_sets trait
|
|
275
275
|
*
|
|
@@ -278,7 +278,7 @@ export declare const putApiV21FilterSetsIdCallAction: (client: HttpClient, actio
|
|
|
278
278
|
* @summary Retrieve the specified filter_sets trait
|
|
279
279
|
* @request GET:/api/v2.1/filter_sets/{id}/call/{trait}
|
|
280
280
|
*/
|
|
281
|
-
export declare const getApiV21FilterSetsIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21FilterSetsIdCallTraitParams, params?: RequestParams) => Promise<
|
|
281
|
+
export declare const getApiV21FilterSetsIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21FilterSetsIdCallTraitParams, params?: RequestParams) => Promise<ApiV21EntitiesResult>;
|
|
282
282
|
/**
|
|
283
283
|
* @description Perform an action on all filter set results
|
|
284
284
|
*
|
|
@@ -287,7 +287,7 @@ export declare const getApiV21FilterSetsIdCallTrait: (client: HttpClient, { trai
|
|
|
287
287
|
* @summary Perform an action on all filter set results
|
|
288
288
|
* @request PUT:/api/v2.1/filter_sets/{id}/call_each/{action}
|
|
289
289
|
*/
|
|
290
|
-
export declare const putApiV21FilterSetsIdCallEachAction: (client: HttpClient, action: string, id: number, data: PutApiV21FilterSetsIdCallEachActionRequest, params?: RequestParams) => Promise<
|
|
290
|
+
export declare const putApiV21FilterSetsIdCallEachAction: (client: HttpClient, action: string, id: number, data: PutApiV21FilterSetsIdCallEachActionRequest, params?: RequestParams) => Promise<ApiSharedEntitiesSidekiqBatch>;
|
|
291
291
|
/**
|
|
292
292
|
* @description Export all filter set results
|
|
293
293
|
*
|
|
@@ -314,7 +314,7 @@ export declare const getApiV21FilterSetsIdResults: (client: HttpClient, { id, ..
|
|
|
314
314
|
* @summary Aggregates filter set results
|
|
315
315
|
* @request GET:/api/v2.1/filter_sets/{id}/results/aggregate
|
|
316
316
|
*/
|
|
317
|
-
export declare const getApiV21FilterSetsIdResultsAggregate: (client: HttpClient, { id, ...query }: GetApiV21FilterSetsIdResultsAggregateParams, params?: RequestParams) => Promise<
|
|
317
|
+
export declare const getApiV21FilterSetsIdResultsAggregate: (client: HttpClient, { id, ...query }: GetApiV21FilterSetsIdResultsAggregateParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
318
318
|
/**
|
|
319
319
|
* @description Returns the filter set search result count
|
|
320
320
|
*
|
|
@@ -323,7 +323,7 @@ export declare const getApiV21FilterSetsIdResultsAggregate: (client: HttpClient,
|
|
|
323
323
|
* @summary Count the filter set search results
|
|
324
324
|
* @request GET:/api/v2.1/filter_sets/{id}/results/count
|
|
325
325
|
*/
|
|
326
|
-
export declare const getApiV21FilterSetsIdResultsCount: (client: HttpClient, { id, ...query }: GetApiV21FilterSetsIdResultsCountParams, params?: RequestParams) => Promise<
|
|
326
|
+
export declare const getApiV21FilterSetsIdResultsCount: (client: HttpClient, { id, ...query }: GetApiV21FilterSetsIdResultsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
327
327
|
/**
|
|
328
328
|
* @description Take a snapshot of a filter set
|
|
329
329
|
*
|
|
@@ -341,4 +341,4 @@ export declare const putApiV21FilterSetsIdSnapshot: (client: HttpClient, id: num
|
|
|
341
341
|
* @summary Retrieve the specified filter_sets traits
|
|
342
342
|
* @request GET:/api/v2.1/filter_sets/{id}/traits
|
|
343
343
|
*/
|
|
344
|
-
export declare const getApiV21FilterSetsIdTraits: (client: HttpClient, { id, ...query }: GetApiV21FilterSetsIdTraitsParams, params?: RequestParams) => Promise<
|
|
344
|
+
export declare const getApiV21FilterSetsIdTraits: (client: HttpClient, { id, ...query }: GetApiV21FilterSetsIdTraitsParams, params?: RequestParams) => Promise<ApiV21EntitiesResult>;
|