@whiplashmerch/whiplash-api-client 0.4.76 → 0.4.78
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 +18494 -2141
- package/dist/client.esm.js.map +1 -1
- package/dist/constants/index.d.ts +1 -0
- package/dist/constants/search.d.ts +9 -0
- package/dist/generated/AccountTransactions.d.ts +56 -0
- package/dist/generated/Accounts.d.ts +171 -0
- package/dist/generated/Allocations.d.ts +38 -0
- package/dist/generated/Broadcasts.d.ts +164 -0
- package/dist/generated/Cache.d.ts +56 -0
- package/dist/generated/CarrierAccounts.d.ts +191 -0
- package/dist/generated/Carriers.d.ts +20 -0
- package/dist/generated/Chromalists.d.ts +56 -0
- package/dist/generated/ConsumerReturns.d.ts +89 -1
- package/dist/generated/Currencies.d.ts +56 -0
- package/dist/generated/Customers.d.ts +172 -1
- package/dist/generated/CustomsInfos.d.ts +56 -0
- package/dist/generated/Dashboards.d.ts +38 -0
- package/dist/generated/Documents.d.ts +37 -1
- package/dist/generated/ExtApp.d.ts +30 -0
- package/dist/generated/FilterSets.d.ts +288 -0
- package/dist/generated/ImporterOfRecords.d.ts +92 -0
- package/dist/generated/Incidents.d.ts +128 -0
- package/dist/generated/InvoiceItems.d.ts +56 -0
- package/dist/generated/Invoices.d.ts +110 -0
- package/dist/generated/Items.d.ts +260 -1
- package/dist/generated/Locales.d.ts +19 -0
- package/dist/generated/LocationAdjustments.d.ts +65 -0
- package/dist/generated/LocationAudits.d.ts +162 -0
- package/dist/generated/LocationTransfers.d.ts +162 -0
- package/dist/generated/Locations.d.ts +207 -0
- package/dist/generated/Lots.d.ts +119 -0
- package/dist/generated/Manifests.d.ts +128 -0
- package/dist/generated/Me.d.ts +20 -0
- package/dist/generated/Nav.d.ts +20 -0
- package/dist/generated/NavItems.d.ts +20 -0
- package/dist/generated/OrderBatchItems.d.ts +54 -0
- package/dist/generated/OrderBatchRequests.d.ts +38 -0
- package/dist/generated/OrderBatches.d.ts +315 -0
- package/dist/generated/OrderDocuments.d.ts +37 -0
- package/dist/generated/OrderItems.d.ts +98 -1
- package/dist/generated/OrderTotes.d.ts +20 -0
- package/dist/generated/Orders.d.ts +468 -1
- package/dist/generated/Originators.d.ts +28 -1
- package/dist/generated/Packages.d.ts +205 -0
- package/dist/generated/Partners.d.ts +110 -0
- package/dist/generated/Prepacks.d.ts +11 -0
- package/dist/generated/ProjectTasks.d.ts +56 -0
- package/dist/generated/Projects.d.ts +163 -1
- package/dist/generated/Rates.d.ts +119 -0
- package/dist/generated/ReasonCodes.d.ts +20 -0
- package/dist/generated/ReturnAddresses.d.ts +92 -0
- package/dist/generated/RuleDismissals.d.ts +19 -0
- package/dist/generated/Rules.d.ts +155 -0
- package/dist/generated/Scancodes.d.ts +20 -0
- package/dist/generated/SerialNumbers.d.ts +56 -0
- package/dist/generated/ShipnoticeItems.d.ts +197 -1
- package/dist/generated/Shipnotices.d.ts +242 -1
- package/dist/generated/ShippingAliases.d.ts +119 -0
- package/dist/generated/ShippingBlacklistedMethods.d.ts +110 -0
- package/dist/generated/ShippingMethodMarkups.d.ts +11 -0
- package/dist/generated/ShippingMethods.d.ts +110 -0
- package/dist/generated/Shops.d.ts +47 -0
- package/dist/generated/Stats.d.ts +54 -0
- package/dist/generated/SurchargeMarkups.d.ts +56 -0
- package/dist/generated/TemplateTypes.d.ts +20 -0
- package/dist/generated/Templates.d.ts +82 -1
- package/dist/generated/Transactions.d.ts +11 -0
- package/dist/generated/TransportationMarkups.d.ts +56 -0
- package/dist/generated/Users.d.ts +245 -0
- package/dist/generated/Utilities.d.ts +38 -0
- package/dist/generated/WarehouseFeatures.d.ts +110 -0
- package/dist/generated/Warehouses.d.ts +245 -0
- package/dist/generated/Wholesales.d.ts +56 -0
- package/dist/generated/data-contracts.d.ts +20237 -4725
- package/dist/generated/index.d.ts +57 -0
- package/dist/index.d.ts +3 -0
- package/dist/mocks/customer.d.ts +2 -0
- package/dist/mocks/index.d.ts +4 -0
- package/dist/mocks/nav.d.ts +2 -0
- package/dist/mocks/user.d.ts +2 -0
- package/dist/mocks/warehouse.d.ts +2 -0
- package/dist/utils/errorHandler.d.ts +2 -0
- package/dist/utils/index.d.ts +9 -0
- package/dist/utils/nav.d.ts +9 -0
- package/dist/utils/orderBatch.d.ts +19 -0
- package/dist/utils/orders.d.ts +54 -0
- package/dist/utils/pusher.d.ts +25 -0
- package/dist/utils/rules.d.ts +8 -0
- package/dist/utils/user.d.ts +19 -0
- package/dist/utils/utilities.d.ts +8 -0
- package/dist/utils/warehouse.d.ts +26 -0
- package/package.json +1 -1
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
import { APIV21EntitiesCarrierAccount, APIV21EntitiesPostResponse, APIV2EntitiesAudits, APIV2EntitiesCarrierAccount, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesProviderCarrierAccount, GetApiV21CarrierAccountsCountParams, GetApiV21CarrierAccountsIdMetaFieldsParams, GetApiV21CarrierAccountsParams, GetApiV21CarrierAccountsProviderAccountsParams, GetApiV2CarrierAccountsCountParams, GetApiV2CarrierAccountsIdMetaFieldsParams, GetApiV2CarrierAccountsParams, GetApiV2CarrierAccountsProviderAccountsParams, PostApiV21CarrierAccounts, PostApiV2CarrierAccounts, PutApiV21CarrierAccountsId, PutApiV21CarrierAccountsIdMetaFields, PutApiV2CarrierAccountsId, PutApiV2CarrierAccountsIdMetaFields } from "./data-contracts";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags carrier_accounts
|
|
7
|
+
* @name GetApiV2CarrierAccountsIdAudits
|
|
8
|
+
* @summary Retrieve audit info for users
|
|
9
|
+
* @request GET:/api/v2/carrier_accounts/{id}/audits
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2CarrierAccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Get a carrier_account
|
|
14
|
+
*
|
|
15
|
+
* @tags carrier_accounts
|
|
16
|
+
* @name GetApiV2CarrierAccountsId
|
|
17
|
+
* @summary Retrieve a carrier account
|
|
18
|
+
* @request GET:/api/v2/carrier_accounts/{id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2CarrierAccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCarrierAccount>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Update a carrier_account
|
|
23
|
+
*
|
|
24
|
+
* @tags carrier_accounts
|
|
25
|
+
* @name PutApiV2CarrierAccountsId
|
|
26
|
+
* @summary Update a carrier account
|
|
27
|
+
* @request PUT:/api/v2/carrier_accounts/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const putApiV2CarrierAccountsId: (client: HttpClient, id: number, putApiV2CarrierAccountsId: PutApiV2CarrierAccountsId, params?: RequestParams) => Promise<APIV2EntitiesCarrierAccount>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Destroy a carrier_account
|
|
32
|
+
*
|
|
33
|
+
* @tags carrier_accounts
|
|
34
|
+
* @name DeleteApiV2CarrierAccountsId
|
|
35
|
+
* @summary Destroy a carrier account
|
|
36
|
+
* @request DELETE:/api/v2/carrier_accounts/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const deleteApiV2CarrierAccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Get provider details for a carrier_account
|
|
41
|
+
*
|
|
42
|
+
* @tags carrier_accounts
|
|
43
|
+
* @name GetApiV2CarrierAccountsIdProviderAccount
|
|
44
|
+
* @summary Retrieve provider details for a carrier account
|
|
45
|
+
* @request GET:/api/v2/carrier_accounts/{id}/provider_account
|
|
46
|
+
*/
|
|
47
|
+
export declare const getApiV2CarrierAccountsIdProviderAccount: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* @description Get the meta fields for a(n) Shop
|
|
50
|
+
*
|
|
51
|
+
* @tags carrier_accounts
|
|
52
|
+
* @name GetApiV2CarrierAccountsIdMetaFields
|
|
53
|
+
* @summary List all Meta Fields
|
|
54
|
+
* @request GET:/api/v2/carrier_accounts/{id}/meta_fields
|
|
55
|
+
*/
|
|
56
|
+
export declare const getApiV2CarrierAccountsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2CarrierAccountsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
57
|
+
/**
|
|
58
|
+
* @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
|
|
59
|
+
*
|
|
60
|
+
* @tags carrier_accounts
|
|
61
|
+
* @name PutApiV2CarrierAccountsIdMetaFields
|
|
62
|
+
* @summary Set Meta Fields
|
|
63
|
+
* @request PUT:/api/v2/carrier_accounts/{id}/meta_fields
|
|
64
|
+
*/
|
|
65
|
+
export declare const putApiV2CarrierAccountsIdMetaFields: (client: HttpClient, id: number, putApiV2CarrierAccountsIdMetaFields: PutApiV2CarrierAccountsIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
66
|
+
/**
|
|
67
|
+
* @description Get a list of carrier_accounts
|
|
68
|
+
*
|
|
69
|
+
* @tags carrier_accounts
|
|
70
|
+
* @name GetApiV2CarrierAccounts
|
|
71
|
+
* @summary List carrier accounts
|
|
72
|
+
* @request GET:/api/v2/carrier_accounts
|
|
73
|
+
*/
|
|
74
|
+
export declare const getApiV2CarrierAccounts: (client: HttpClient, query: GetApiV2CarrierAccountsParams, params?: RequestParams) => Promise<APIV2EntitiesCarrierAccount[]>;
|
|
75
|
+
/**
|
|
76
|
+
* @description Create a carrier_account
|
|
77
|
+
*
|
|
78
|
+
* @tags carrier_accounts
|
|
79
|
+
* @name PostApiV2CarrierAccounts
|
|
80
|
+
* @summary Create a carrier account
|
|
81
|
+
* @request POST:/api/v2/carrier_accounts
|
|
82
|
+
*/
|
|
83
|
+
export declare const postApiV2CarrierAccounts: (client: HttpClient, postApiV2CarrierAccounts: PostApiV2CarrierAccounts, params?: RequestParams) => Promise<APIV2EntitiesCarrierAccount>;
|
|
84
|
+
/**
|
|
85
|
+
* @description Get a list of provider carrier_accounts
|
|
86
|
+
*
|
|
87
|
+
* @tags carrier_accounts
|
|
88
|
+
* @name GetApiV2CarrierAccountsProviderAccounts
|
|
89
|
+
* @summary Retrieve a list of provider carrier accounts
|
|
90
|
+
* @request GET:/api/v2/carrier_accounts/provider_accounts
|
|
91
|
+
*/
|
|
92
|
+
export declare const getApiV2CarrierAccountsProviderAccounts: (client: HttpClient, query: GetApiV2CarrierAccountsProviderAccountsParams, params?: RequestParams) => Promise<APIV2EntitiesProviderCarrierAccount[]>;
|
|
93
|
+
/**
|
|
94
|
+
* @description Returns count of carrier_accounts
|
|
95
|
+
*
|
|
96
|
+
* @tags carrier_accounts
|
|
97
|
+
* @name GetApiV2CarrierAccountsCount
|
|
98
|
+
* @summary Count carrier acounts
|
|
99
|
+
* @request GET:/api/v2/carrier_accounts/count
|
|
100
|
+
*/
|
|
101
|
+
export declare const getApiV2CarrierAccountsCount: (client: HttpClient, query: GetApiV2CarrierAccountsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
102
|
+
/**
|
|
103
|
+
* @description Get a list of carrier_accounts
|
|
104
|
+
*
|
|
105
|
+
* @tags carrier_accounts
|
|
106
|
+
* @name GetApiV21CarrierAccounts
|
|
107
|
+
* @summary List carrier accounts
|
|
108
|
+
* @request GET:/api/v2.1/carrier_accounts
|
|
109
|
+
*/
|
|
110
|
+
export declare const getApiV21CarrierAccounts: (client: HttpClient, query: GetApiV21CarrierAccountsParams, params?: RequestParams) => Promise<APIV21EntitiesCarrierAccount[]>;
|
|
111
|
+
/**
|
|
112
|
+
* @description Create a carrier_account
|
|
113
|
+
*
|
|
114
|
+
* @tags carrier_accounts
|
|
115
|
+
* @name PostApiV21CarrierAccounts
|
|
116
|
+
* @summary Create a carrier account
|
|
117
|
+
* @request POST:/api/v2.1/carrier_accounts
|
|
118
|
+
*/
|
|
119
|
+
export declare const postApiV21CarrierAccounts: (client: HttpClient, postApiV21CarrierAccounts: PostApiV21CarrierAccounts, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
120
|
+
/**
|
|
121
|
+
* @description Get a list of provider carrier_accounts
|
|
122
|
+
*
|
|
123
|
+
* @tags carrier_accounts
|
|
124
|
+
* @name GetApiV21CarrierAccountsProviderAccounts
|
|
125
|
+
* @summary Retrieve a list of provider carrier accounts
|
|
126
|
+
* @request GET:/api/v2.1/carrier_accounts/provider_accounts
|
|
127
|
+
*/
|
|
128
|
+
export declare const getApiV21CarrierAccountsProviderAccounts: (client: HttpClient, query: GetApiV21CarrierAccountsProviderAccountsParams, params?: RequestParams) => Promise<APIV2EntitiesProviderCarrierAccount[]>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Returns count of carrier_accounts
|
|
131
|
+
*
|
|
132
|
+
* @tags carrier_accounts
|
|
133
|
+
* @name GetApiV21CarrierAccountsCount
|
|
134
|
+
* @summary Count carrier acounts
|
|
135
|
+
* @request GET:/api/v2.1/carrier_accounts/count
|
|
136
|
+
*/
|
|
137
|
+
export declare const getApiV21CarrierAccountsCount: (client: HttpClient, query: GetApiV21CarrierAccountsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
138
|
+
/**
|
|
139
|
+
* @description Get a carrier_account
|
|
140
|
+
*
|
|
141
|
+
* @tags carrier_accounts
|
|
142
|
+
* @name GetApiV21CarrierAccountsId
|
|
143
|
+
* @summary Retrieve a carrier account
|
|
144
|
+
* @request GET:/api/v2.1/carrier_accounts/{id}
|
|
145
|
+
*/
|
|
146
|
+
export declare const getApiV21CarrierAccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCarrierAccount>;
|
|
147
|
+
/**
|
|
148
|
+
* @description Update a carrier_account
|
|
149
|
+
*
|
|
150
|
+
* @tags carrier_accounts
|
|
151
|
+
* @name PutApiV21CarrierAccountsId
|
|
152
|
+
* @summary Update a carrier account
|
|
153
|
+
* @request PUT:/api/v2.1/carrier_accounts/{id}
|
|
154
|
+
*/
|
|
155
|
+
export declare const putApiV21CarrierAccountsId: (client: HttpClient, id: number, putApiV21CarrierAccountsId: PutApiV21CarrierAccountsId, params?: RequestParams) => Promise<void>;
|
|
156
|
+
/**
|
|
157
|
+
* @description Destroy a carrier_account
|
|
158
|
+
*
|
|
159
|
+
* @tags carrier_accounts
|
|
160
|
+
* @name DeleteApiV21CarrierAccountsId
|
|
161
|
+
* @summary Destroy a carrier account
|
|
162
|
+
* @request DELETE:/api/v2.1/carrier_accounts/{id}
|
|
163
|
+
*/
|
|
164
|
+
export declare const deleteApiV21CarrierAccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
165
|
+
/**
|
|
166
|
+
* @description Get provider details for a carrier_account
|
|
167
|
+
*
|
|
168
|
+
* @tags carrier_accounts
|
|
169
|
+
* @name GetApiV21CarrierAccountsIdProviderAccount
|
|
170
|
+
* @summary Retrieve provider details for a carrier account
|
|
171
|
+
* @request GET:/api/v2.1/carrier_accounts/{id}/provider_account
|
|
172
|
+
*/
|
|
173
|
+
export declare const getApiV21CarrierAccountsIdProviderAccount: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
174
|
+
/**
|
|
175
|
+
* @description Get the meta fields for a(n) Shop
|
|
176
|
+
*
|
|
177
|
+
* @tags carrier_accounts
|
|
178
|
+
* @name GetApiV21CarrierAccountsIdMetaFields
|
|
179
|
+
* @summary List all Meta Fields
|
|
180
|
+
* @request GET:/api/v2.1/carrier_accounts/{id}/meta_fields
|
|
181
|
+
*/
|
|
182
|
+
export declare const getApiV21CarrierAccountsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21CarrierAccountsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
183
|
+
/**
|
|
184
|
+
* @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
|
|
185
|
+
*
|
|
186
|
+
* @tags carrier_accounts
|
|
187
|
+
* @name PutApiV21CarrierAccountsIdMetaFields
|
|
188
|
+
* @summary Set Meta Fields
|
|
189
|
+
* @request PUT:/api/v2.1/carrier_accounts/{id}/meta_fields
|
|
190
|
+
*/
|
|
191
|
+
export declare const putApiV21CarrierAccountsIdMetaFields: (client: HttpClient, id: number, putApiV21CarrierAccountsIdMetaFields: PutApiV21CarrierAccountsIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { APIV2EntitiesCarrier, GetApiV21CarriersParams, GetApiV2CarriersParams } from "./data-contracts";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get a list of carriers
|
|
5
|
+
*
|
|
6
|
+
* @tags carriers
|
|
7
|
+
* @name GetApiV2Carriers
|
|
8
|
+
* @summary List all carriers
|
|
9
|
+
* @request GET:/api/v2/carriers
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2Carriers: (client: HttpClient, query: GetApiV2CarriersParams, params?: RequestParams) => Promise<APIV2EntitiesCarrier[]>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Get a list of carriers
|
|
14
|
+
*
|
|
15
|
+
* @tags carriers
|
|
16
|
+
* @name GetApiV21Carriers
|
|
17
|
+
* @summary List all carriers
|
|
18
|
+
* @request GET:/api/v2.1/carriers
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV21Carriers: (client: HttpClient, query: GetApiV21CarriersParams, params?: RequestParams) => Promise<APIV2EntitiesCarrier[]>;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV2EntitiesChromalist, GetApiV21ChromalistsParams, GetApiV2ChromalistsParams, PostApiV21Chromalists, PostApiV2Chromalists } from "./data-contracts";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get all chromalists
|
|
5
|
+
*
|
|
6
|
+
* @tags chromalists
|
|
7
|
+
* @name GetApiV2Chromalists
|
|
8
|
+
* @summary List all chromalists
|
|
9
|
+
* @request GET:/api/v2/chromalists
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2Chromalists: (client: HttpClient, query: GetApiV2ChromalistsParams, params?: RequestParams) => Promise<APIV2EntitiesChromalist[]>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Create a chromalist
|
|
14
|
+
*
|
|
15
|
+
* @tags chromalists
|
|
16
|
+
* @name PostApiV2Chromalists
|
|
17
|
+
* @summary Create a chromalist
|
|
18
|
+
* @request POST:/api/v2/chromalists
|
|
19
|
+
*/
|
|
20
|
+
export declare const postApiV2Chromalists: (client: HttpClient, postApiV2Chromalists: PostApiV2Chromalists, params?: RequestParams) => Promise<APIV2EntitiesChromalist>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Destroy a chromalist
|
|
23
|
+
*
|
|
24
|
+
* @tags chromalists
|
|
25
|
+
* @name DeleteApiV2ChromalistsId
|
|
26
|
+
* @summary Destroy a chromalist
|
|
27
|
+
* @request DELETE:/api/v2/chromalists/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const deleteApiV2ChromalistsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Get all chromalists
|
|
32
|
+
*
|
|
33
|
+
* @tags chromalists
|
|
34
|
+
* @name GetApiV21Chromalists
|
|
35
|
+
* @summary List all chromalists
|
|
36
|
+
* @request GET:/api/v2.1/chromalists
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV21Chromalists: (client: HttpClient, query: GetApiV21ChromalistsParams, params?: RequestParams) => Promise<APIV2EntitiesChromalist[]>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Create a chromalist
|
|
41
|
+
*
|
|
42
|
+
* @tags chromalists
|
|
43
|
+
* @name PostApiV21Chromalists
|
|
44
|
+
* @summary Create a chromalist
|
|
45
|
+
* @request POST:/api/v2.1/chromalists
|
|
46
|
+
*/
|
|
47
|
+
export declare const postApiV21Chromalists: (client: HttpClient, postApiV21Chromalists: PostApiV21Chromalists, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* @description Destroy a chromalist
|
|
50
|
+
*
|
|
51
|
+
* @tags chromalists
|
|
52
|
+
* @name DeleteApiV21ChromalistsId
|
|
53
|
+
* @summary Destroy a chromalist
|
|
54
|
+
* @request DELETE:/api/v2.1/chromalists/{id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const deleteApiV21ChromalistsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
@@ -1,5 +1,13 @@
|
|
|
1
|
-
import { APIV21EntitiesConsumerReturn, APIV21EntitiesPostResponse, APIV2EntitiesConsumerReturn, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, GetApiV21ConsumerReturnsCountParams, GetApiV21ConsumerReturnsIdMetaFieldsParams, GetApiV21ConsumerReturnsParams, GetApiV2ConsumerReturnsCountParams, GetApiV2ConsumerReturnsIdMetaFieldsParams, GetApiV2ConsumerReturnsParams, PostApiV21ConsumerReturns, PostApiV21ConsumerReturnsBulk, PostApiV2ConsumerReturns, PostApiV2ConsumerReturnsBulk, PutApiV21ConsumerReturnsId, PutApiV21ConsumerReturnsIdMetaFields, PutApiV21ConsumerReturnsOriginatorOriginatorId, PutApiV2ConsumerReturnsId, PutApiV2ConsumerReturnsIdMetaFields, PutApiV2ConsumerReturnsOriginatorOriginatorId } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesConsumerReturn, APIV21EntitiesIncident, APIV21EntitiesPostResponse, APIV2EntitiesConsumerReturn, APIV2EntitiesCount, APIV2EntitiesIncident, APIV2EntitiesMetaFields, APIV2EntitiesOriginator, APIV2EntitiesResult, GetApiV21ConsumerReturnsAggregateParams, GetApiV21ConsumerReturnsCountParams, GetApiV21ConsumerReturnsIdIncidentsCountParams, GetApiV21ConsumerReturnsIdIncidentsParams, GetApiV21ConsumerReturnsIdMetaFieldsParams, GetApiV21ConsumerReturnsParams, GetApiV2ConsumerReturnsAggregateParams, GetApiV2ConsumerReturnsCountParams, GetApiV2ConsumerReturnsIdIncidentsCountParams, GetApiV2ConsumerReturnsIdIncidentsParams, GetApiV2ConsumerReturnsIdMetaFieldsParams, GetApiV2ConsumerReturnsParams, PostApiV21ConsumerReturns, PostApiV21ConsumerReturnsBulk, PostApiV21ConsumerReturnsIdIncidents, PostApiV2ConsumerReturns, PostApiV2ConsumerReturnsBulk, PostApiV2ConsumerReturnsIdIncidents, PutApiV21ConsumerReturnsId, PutApiV21ConsumerReturnsIdMetaFields, PutApiV21ConsumerReturnsOriginatorOriginatorId, PutApiV2ConsumerReturnsId, PutApiV2ConsumerReturnsIdMetaFields, PutApiV2ConsumerReturnsOriginatorOriginatorId } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* @description Returns aggregated consumer_returns
|
|
5
|
+
*
|
|
6
|
+
* @tags consumer_returns
|
|
7
|
+
* @name GetApiV2ConsumerReturnsAggregate
|
|
8
|
+
* @request GET:/api/v2/consumer_returns/aggregate
|
|
9
|
+
*/
|
|
10
|
+
export declare const getApiV2ConsumerReturnsAggregate: (client: HttpClient, query: GetApiV2ConsumerReturnsAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
3
11
|
/**
|
|
4
12
|
* No description
|
|
5
13
|
*
|
|
@@ -27,6 +35,15 @@ export declare const putApiV2ConsumerReturnsOriginatorOriginatorId: (client: Htt
|
|
|
27
35
|
* @request DELETE:/api/v2/consumer_returns/originator/{originator_id}
|
|
28
36
|
*/
|
|
29
37
|
export declare const deleteApiV2ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
38
|
+
/**
|
|
39
|
+
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
40
|
+
*
|
|
41
|
+
* @tags consumer_returns
|
|
42
|
+
* @name GetApiV2ConsumerReturnsIdOriginator
|
|
43
|
+
* @summary Retrieve the associated originator
|
|
44
|
+
* @request GET:/api/v2/consumer_returns/{id}/originator
|
|
45
|
+
*/
|
|
46
|
+
export declare const getApiV2ConsumerReturnsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
|
|
30
47
|
/**
|
|
31
48
|
* No description
|
|
32
49
|
*
|
|
@@ -108,6 +125,41 @@ export declare const postApiV2ConsumerReturns: (client: HttpClient, postApiV2Con
|
|
|
108
125
|
* @request GET:/api/v2/consumer_returns/count
|
|
109
126
|
*/
|
|
110
127
|
export declare const getApiV2ConsumerReturnsCount: (client: HttpClient, query: GetApiV2ConsumerReturnsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
128
|
+
/**
|
|
129
|
+
* @description Get all incidents for a(n) ConsumerReturn
|
|
130
|
+
*
|
|
131
|
+
* @tags consumer_returns
|
|
132
|
+
* @name GetApiV2ConsumerReturnsIdIncidents
|
|
133
|
+
* @summary List all incidents for a resource
|
|
134
|
+
* @request GET:/api/v2/consumer_returns/{id}/incidents
|
|
135
|
+
*/
|
|
136
|
+
export declare const getApiV2ConsumerReturnsIdIncidents: (client: HttpClient, { id, ...query }: GetApiV2ConsumerReturnsIdIncidentsParams, params?: RequestParams) => Promise<APIV2EntitiesIncident[]>;
|
|
137
|
+
/**
|
|
138
|
+
* @description Create an incident for a(n) ConsumerReturn
|
|
139
|
+
*
|
|
140
|
+
* @tags consumer_returns
|
|
141
|
+
* @name PostApiV2ConsumerReturnsIdIncidents
|
|
142
|
+
* @summary Create an incident for a resource
|
|
143
|
+
* @request POST:/api/v2/consumer_returns/{id}/incidents
|
|
144
|
+
*/
|
|
145
|
+
export declare const postApiV2ConsumerReturnsIdIncidents: (client: HttpClient, id: number, postApiV2ConsumerReturnsIdIncidents: PostApiV2ConsumerReturnsIdIncidents, params?: RequestParams) => Promise<APIV2EntitiesIncident>;
|
|
146
|
+
/**
|
|
147
|
+
* @description Returns count of incidents for a(n) ConsumerReturn
|
|
148
|
+
*
|
|
149
|
+
* @tags consumer_returns
|
|
150
|
+
* @name GetApiV2ConsumerReturnsIdIncidentsCount
|
|
151
|
+
* @summary Count incidents for a resource
|
|
152
|
+
* @request GET:/api/v2/consumer_returns/{id}/incidents/count
|
|
153
|
+
*/
|
|
154
|
+
export declare const getApiV2ConsumerReturnsIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV2ConsumerReturnsIdIncidentsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
155
|
+
/**
|
|
156
|
+
* @description Returns aggregated consumer_returns
|
|
157
|
+
*
|
|
158
|
+
* @tags consumer_returns
|
|
159
|
+
* @name GetApiV21ConsumerReturnsAggregate
|
|
160
|
+
* @request GET:/api/v2.1/consumer_returns/aggregate
|
|
161
|
+
*/
|
|
162
|
+
export declare const getApiV21ConsumerReturnsAggregate: (client: HttpClient, query: GetApiV21ConsumerReturnsAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
111
163
|
/**
|
|
112
164
|
* No description
|
|
113
165
|
*
|
|
@@ -135,6 +187,15 @@ export declare const putApiV21ConsumerReturnsOriginatorOriginatorId: (client: Ht
|
|
|
135
187
|
* @request DELETE:/api/v2.1/consumer_returns/originator/{originator_id}
|
|
136
188
|
*/
|
|
137
189
|
export declare const deleteApiV21ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
190
|
+
/**
|
|
191
|
+
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
192
|
+
*
|
|
193
|
+
* @tags consumer_returns
|
|
194
|
+
* @name GetApiV21ConsumerReturnsIdOriginator
|
|
195
|
+
* @summary Retrieve the associated originator
|
|
196
|
+
* @request GET:/api/v2.1/consumer_returns/{id}/originator
|
|
197
|
+
*/
|
|
198
|
+
export declare const getApiV21ConsumerReturnsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
|
|
138
199
|
/**
|
|
139
200
|
* No description
|
|
140
201
|
*
|
|
@@ -216,3 +277,30 @@ export declare const postApiV21ConsumerReturns: (client: HttpClient, postApiV21C
|
|
|
216
277
|
* @request GET:/api/v2.1/consumer_returns/count
|
|
217
278
|
*/
|
|
218
279
|
export declare const getApiV21ConsumerReturnsCount: (client: HttpClient, query: GetApiV21ConsumerReturnsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
280
|
+
/**
|
|
281
|
+
* @description Get all incidents for a(n) ConsumerReturn
|
|
282
|
+
*
|
|
283
|
+
* @tags consumer_returns
|
|
284
|
+
* @name GetApiV21ConsumerReturnsIdIncidents
|
|
285
|
+
* @summary List all incidents for a resource
|
|
286
|
+
* @request GET:/api/v2.1/consumer_returns/{id}/incidents
|
|
287
|
+
*/
|
|
288
|
+
export declare const getApiV21ConsumerReturnsIdIncidents: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdIncidentsParams, params?: RequestParams) => Promise<APIV21EntitiesIncident[]>;
|
|
289
|
+
/**
|
|
290
|
+
* @description Create an incident for a(n) ConsumerReturn
|
|
291
|
+
*
|
|
292
|
+
* @tags consumer_returns
|
|
293
|
+
* @name PostApiV21ConsumerReturnsIdIncidents
|
|
294
|
+
* @summary Create an incident for a resource
|
|
295
|
+
* @request POST:/api/v2.1/consumer_returns/{id}/incidents
|
|
296
|
+
*/
|
|
297
|
+
export declare const postApiV21ConsumerReturnsIdIncidents: (client: HttpClient, id: number, postApiV21ConsumerReturnsIdIncidents: PostApiV21ConsumerReturnsIdIncidents, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
298
|
+
/**
|
|
299
|
+
* @description Returns count of incidents for a(n) ConsumerReturn
|
|
300
|
+
*
|
|
301
|
+
* @tags consumer_returns
|
|
302
|
+
* @name GetApiV21ConsumerReturnsIdIncidentsCount
|
|
303
|
+
* @summary Count incidents for a resource
|
|
304
|
+
* @request GET:/api/v2.1/consumer_returns/{id}/incidents/count
|
|
305
|
+
*/
|
|
306
|
+
export declare const getApiV21ConsumerReturnsIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV21ConsumerReturnsIdIncidentsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV2EntitiesCurrency, GetApiV21CurrenciesParams, GetApiV2CurrenciesParams, PostApiV21Currencies, PostApiV2Currencies } from "./data-contracts";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get all currencies
|
|
5
|
+
*
|
|
6
|
+
* @tags currencies
|
|
7
|
+
* @name GetApiV2Currencies
|
|
8
|
+
* @summary List all currencies
|
|
9
|
+
* @request GET:/api/v2/currencies
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2Currencies: (client: HttpClient, query: GetApiV2CurrenciesParams, params?: RequestParams) => Promise<APIV2EntitiesCurrency[]>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Create a currency
|
|
14
|
+
*
|
|
15
|
+
* @tags currencies
|
|
16
|
+
* @name PostApiV2Currencies
|
|
17
|
+
* @summary Create a currency
|
|
18
|
+
* @request POST:/api/v2/currencies
|
|
19
|
+
*/
|
|
20
|
+
export declare const postApiV2Currencies: (client: HttpClient, postApiV2Currencies: PostApiV2Currencies, params?: RequestParams) => Promise<APIV2EntitiesCurrency>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Destroy a currency
|
|
23
|
+
*
|
|
24
|
+
* @tags currencies
|
|
25
|
+
* @name DeleteApiV2CurrenciesId
|
|
26
|
+
* @summary Destroy a currency
|
|
27
|
+
* @request DELETE:/api/v2/currencies/{id}
|
|
28
|
+
*/
|
|
29
|
+
export declare const deleteApiV2CurrenciesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Get all currencies
|
|
32
|
+
*
|
|
33
|
+
* @tags currencies
|
|
34
|
+
* @name GetApiV21Currencies
|
|
35
|
+
* @summary List all currencies
|
|
36
|
+
* @request GET:/api/v2.1/currencies
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV21Currencies: (client: HttpClient, query: GetApiV21CurrenciesParams, params?: RequestParams) => Promise<APIV2EntitiesCurrency[]>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Create a currency
|
|
41
|
+
*
|
|
42
|
+
* @tags currencies
|
|
43
|
+
* @name PostApiV21Currencies
|
|
44
|
+
* @summary Create a currency
|
|
45
|
+
* @request POST:/api/v2.1/currencies
|
|
46
|
+
*/
|
|
47
|
+
export declare const postApiV21Currencies: (client: HttpClient, postApiV21Currencies: PostApiV21Currencies, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* @description Destroy a currency
|
|
50
|
+
*
|
|
51
|
+
* @tags currencies
|
|
52
|
+
* @name DeleteApiV21CurrenciesId
|
|
53
|
+
* @summary Destroy a currency
|
|
54
|
+
* @request DELETE:/api/v2.1/currencies/{id}
|
|
55
|
+
*/
|
|
56
|
+
export declare const deleteApiV21CurrenciesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesCustomer, APIV2EntitiesCount, APIV2EntitiesCustomer, GetApiV21CustomersCountParams, GetApiV21CustomersParams, GetApiV2CustomersCountParams, GetApiV2CustomersParams, PutApiV21CustomersId, PutApiV2CustomersId } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesCustomer, APIV21EntitiesPostResponse, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesCustomer, APIV2EntitiesMetaFields, APIV2EntitiesResult, APIV2EntitiesShop, APIV2EntitiesSidekiqBatch, GetApiV21CustomersCountParams, GetApiV21CustomersIdCallTraitParams, GetApiV21CustomersIdMetaFieldsParams, GetApiV21CustomersIdTraitsParams, GetApiV21CustomersParams, GetApiV2CustomersCountParams, GetApiV2CustomersIdCallTraitParams, GetApiV2CustomersIdMetaFieldsParams, GetApiV2CustomersIdTraitsParams, GetApiV2CustomersParams, PostApiV21Customers, PostApiV2Customers, PutApiV21CustomersId, PutApiV21CustomersIdCallAction, PutApiV21CustomersIdCallAsyncAction, PutApiV21CustomersIdMetaFields, PutApiV2CustomersId, PutApiV2CustomersIdCallAction, PutApiV2CustomersIdCallAsyncAction, PutApiV2CustomersIdMetaFields } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get resource actions
|
|
@@ -9,6 +9,15 @@ import { HttpClient, RequestParams } from "./http-client";
|
|
|
9
9
|
* @request GET:/api/v2/customers/actions
|
|
10
10
|
*/
|
|
11
11
|
export declare const getApiV2CustomersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Get customers traits
|
|
14
|
+
*
|
|
15
|
+
* @tags customers
|
|
16
|
+
* @name GetApiV2CustomersTraits
|
|
17
|
+
* @summary List customers traits
|
|
18
|
+
* @request GET:/api/v2/customers/traits
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2CustomersTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
12
21
|
/**
|
|
13
22
|
* No description
|
|
14
23
|
*
|
|
@@ -18,6 +27,15 @@ export declare const getApiV2CustomersActions: (client: HttpClient, params?: Req
|
|
|
18
27
|
* @request GET:/api/v2/customers
|
|
19
28
|
*/
|
|
20
29
|
export declare const getApiV2Customers: (client: HttpClient, query: GetApiV2CustomersParams, params?: RequestParams) => Promise<APIV2EntitiesCustomer[]>;
|
|
30
|
+
/**
|
|
31
|
+
* No description
|
|
32
|
+
*
|
|
33
|
+
* @tags customers
|
|
34
|
+
* @name PostApiV2Customers
|
|
35
|
+
* @summary Create a customer
|
|
36
|
+
* @request POST:/api/v2/customers
|
|
37
|
+
*/
|
|
38
|
+
export declare const postApiV2Customers: (client: HttpClient, postApiV2Customers: PostApiV2Customers, params?: RequestParams) => Promise<APIV2EntitiesCustomer>;
|
|
21
39
|
/**
|
|
22
40
|
* No description
|
|
23
41
|
*
|
|
@@ -27,6 +45,24 @@ export declare const getApiV2Customers: (client: HttpClient, query: GetApiV2Cust
|
|
|
27
45
|
* @request GET:/api/v2/customers/count
|
|
28
46
|
*/
|
|
29
47
|
export declare const getApiV2CustomersCount: (client: HttpClient, query: GetApiV2CustomersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
48
|
+
/**
|
|
49
|
+
* No description
|
|
50
|
+
*
|
|
51
|
+
* @tags customers
|
|
52
|
+
* @name GetApiV2CustomersIdAudits
|
|
53
|
+
* @summary Retrieve audit info for users
|
|
54
|
+
* @request GET:/api/v2/customers/{id}/audits
|
|
55
|
+
*/
|
|
56
|
+
export declare const getApiV2CustomersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags customers
|
|
61
|
+
* @name GetApiV2CustomersIdTraits
|
|
62
|
+
* @summary Retrieve the specified customers traits
|
|
63
|
+
* @request GET:/api/v2/customers/{id}/traits
|
|
64
|
+
*/
|
|
65
|
+
export declare const getApiV2CustomersIdTraits: (client: HttpClient, { id, ...query }: GetApiV2CustomersIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
30
66
|
/**
|
|
31
67
|
* No description
|
|
32
68
|
*
|
|
@@ -45,6 +81,60 @@ export declare const getApiV2CustomersId: (client: HttpClient, id: number, param
|
|
|
45
81
|
* @request PUT:/api/v2/customers/{id}
|
|
46
82
|
*/
|
|
47
83
|
export declare const putApiV2CustomersId: (client: HttpClient, id: number, putApiV2CustomersId: PutApiV2CustomersId, params?: RequestParams) => Promise<APIV2EntitiesCustomer>;
|
|
84
|
+
/**
|
|
85
|
+
* @description Get the meta fields for a(n) Shop
|
|
86
|
+
*
|
|
87
|
+
* @tags customers
|
|
88
|
+
* @name GetApiV2CustomersIdMetaFields
|
|
89
|
+
* @summary List all Meta Fields
|
|
90
|
+
* @request GET:/api/v2/customers/{id}/meta_fields
|
|
91
|
+
*/
|
|
92
|
+
export declare const getApiV2CustomersIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2CustomersIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
93
|
+
/**
|
|
94
|
+
* @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
|
|
95
|
+
*
|
|
96
|
+
* @tags customers
|
|
97
|
+
* @name PutApiV2CustomersIdMetaFields
|
|
98
|
+
* @summary Set Meta Fields
|
|
99
|
+
* @request PUT:/api/v2/customers/{id}/meta_fields
|
|
100
|
+
*/
|
|
101
|
+
export declare const putApiV2CustomersIdMetaFields: (client: HttpClient, id: number, putApiV2CustomersIdMetaFields: PutApiV2CustomersIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
102
|
+
/**
|
|
103
|
+
* No description
|
|
104
|
+
*
|
|
105
|
+
* @tags customers
|
|
106
|
+
* @name GetApiV2CustomersIdCallTrait
|
|
107
|
+
* @summary Retrieve the specified customers trait
|
|
108
|
+
* @request GET:/api/v2/customers/{id}/call/{trait}
|
|
109
|
+
*/
|
|
110
|
+
export declare const getApiV2CustomersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV2CustomersIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
111
|
+
/**
|
|
112
|
+
* @description Perform an action on a customer
|
|
113
|
+
*
|
|
114
|
+
* @tags customers
|
|
115
|
+
* @name PutApiV2CustomersIdCallAction
|
|
116
|
+
* @summary Perform an action on a customer
|
|
117
|
+
* @request PUT:/api/v2/customers/{id}/call/{action}
|
|
118
|
+
*/
|
|
119
|
+
export declare const putApiV2CustomersIdCallAction: (client: HttpClient, action: string, id: number, putApiV2CustomersIdCallAction: PutApiV2CustomersIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesCustomer>;
|
|
120
|
+
/**
|
|
121
|
+
* @description Perform an action on a customer asynchronously
|
|
122
|
+
*
|
|
123
|
+
* @tags customers
|
|
124
|
+
* @name PutApiV2CustomersIdCallAsyncAction
|
|
125
|
+
* @summary Perform an action on a customer asynchronously
|
|
126
|
+
* @request PUT:/api/v2/customers/{id}/call_async/{action}
|
|
127
|
+
*/
|
|
128
|
+
export declare const putApiV2CustomersIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV2CustomersIdCallAsyncAction: PutApiV2CustomersIdCallAsyncAction, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatch>;
|
|
129
|
+
/**
|
|
130
|
+
* @description List a customer's shops
|
|
131
|
+
*
|
|
132
|
+
* @tags customers
|
|
133
|
+
* @name GetApiV2CustomersIdShops
|
|
134
|
+
* @summary List all shops for a customer
|
|
135
|
+
* @request GET:/api/v2/customers/{id}/shops
|
|
136
|
+
*/
|
|
137
|
+
export declare const getApiV2CustomersIdShops: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShop[]>;
|
|
48
138
|
/**
|
|
49
139
|
* @description Get resource actions
|
|
50
140
|
*
|
|
@@ -54,6 +144,15 @@ export declare const putApiV2CustomersId: (client: HttpClient, id: number, putAp
|
|
|
54
144
|
* @request GET:/api/v2.1/customers/actions
|
|
55
145
|
*/
|
|
56
146
|
export declare const getApiV21CustomersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
147
|
+
/**
|
|
148
|
+
* @description Get customers traits
|
|
149
|
+
*
|
|
150
|
+
* @tags customers
|
|
151
|
+
* @name GetApiV21CustomersTraits
|
|
152
|
+
* @summary List customers traits
|
|
153
|
+
* @request GET:/api/v2.1/customers/traits
|
|
154
|
+
*/
|
|
155
|
+
export declare const getApiV21CustomersTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
57
156
|
/**
|
|
58
157
|
* No description
|
|
59
158
|
*
|
|
@@ -63,6 +162,15 @@ export declare const getApiV21CustomersActions: (client: HttpClient, params?: Re
|
|
|
63
162
|
* @request GET:/api/v2.1/customers
|
|
64
163
|
*/
|
|
65
164
|
export declare const getApiV21Customers: (client: HttpClient, query: GetApiV21CustomersParams, params?: RequestParams) => Promise<APIV21EntitiesCustomer[]>;
|
|
165
|
+
/**
|
|
166
|
+
* No description
|
|
167
|
+
*
|
|
168
|
+
* @tags customers
|
|
169
|
+
* @name PostApiV21Customers
|
|
170
|
+
* @summary Create a customer
|
|
171
|
+
* @request POST:/api/v2.1/customers
|
|
172
|
+
*/
|
|
173
|
+
export declare const postApiV21Customers: (client: HttpClient, postApiV21Customers: PostApiV21Customers, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
66
174
|
/**
|
|
67
175
|
* No description
|
|
68
176
|
*
|
|
@@ -72,6 +180,24 @@ export declare const getApiV21Customers: (client: HttpClient, query: GetApiV21Cu
|
|
|
72
180
|
* @request GET:/api/v2.1/customers/count
|
|
73
181
|
*/
|
|
74
182
|
export declare const getApiV21CustomersCount: (client: HttpClient, query: GetApiV21CustomersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
183
|
+
/**
|
|
184
|
+
* No description
|
|
185
|
+
*
|
|
186
|
+
* @tags customers
|
|
187
|
+
* @name GetApiV21CustomersIdCallTrait
|
|
188
|
+
* @summary Retrieve the specified customers trait
|
|
189
|
+
* @request GET:/api/v2.1/customers/{id}/call/{trait}
|
|
190
|
+
*/
|
|
191
|
+
export declare const getApiV21CustomersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21CustomersIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
192
|
+
/**
|
|
193
|
+
* No description
|
|
194
|
+
*
|
|
195
|
+
* @tags customers
|
|
196
|
+
* @name GetApiV21CustomersIdTraits
|
|
197
|
+
* @summary Retrieve the specified customers traits
|
|
198
|
+
* @request GET:/api/v2.1/customers/{id}/traits
|
|
199
|
+
*/
|
|
200
|
+
export declare const getApiV21CustomersIdTraits: (client: HttpClient, { id, ...query }: GetApiV21CustomersIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
75
201
|
/**
|
|
76
202
|
* No description
|
|
77
203
|
*
|
|
@@ -90,3 +216,48 @@ export declare const getApiV21CustomersId: (client: HttpClient, id: number, para
|
|
|
90
216
|
* @request PUT:/api/v2.1/customers/{id}
|
|
91
217
|
*/
|
|
92
218
|
export declare const putApiV21CustomersId: (client: HttpClient, id: number, putApiV21CustomersId: PutApiV21CustomersId, params?: RequestParams) => Promise<void>;
|
|
219
|
+
/**
|
|
220
|
+
* @description Get the meta fields for a(n) Shop
|
|
221
|
+
*
|
|
222
|
+
* @tags customers
|
|
223
|
+
* @name GetApiV21CustomersIdMetaFields
|
|
224
|
+
* @summary List all Meta Fields
|
|
225
|
+
* @request GET:/api/v2.1/customers/{id}/meta_fields
|
|
226
|
+
*/
|
|
227
|
+
export declare const getApiV21CustomersIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21CustomersIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
228
|
+
/**
|
|
229
|
+
* @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
|
|
230
|
+
*
|
|
231
|
+
* @tags customers
|
|
232
|
+
* @name PutApiV21CustomersIdMetaFields
|
|
233
|
+
* @summary Set Meta Fields
|
|
234
|
+
* @request PUT:/api/v2.1/customers/{id}/meta_fields
|
|
235
|
+
*/
|
|
236
|
+
export declare const putApiV21CustomersIdMetaFields: (client: HttpClient, id: number, putApiV21CustomersIdMetaFields: PutApiV21CustomersIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
237
|
+
/**
|
|
238
|
+
* @description Perform an action on a customer
|
|
239
|
+
*
|
|
240
|
+
* @tags customers
|
|
241
|
+
* @name PutApiV21CustomersIdCallAction
|
|
242
|
+
* @summary Perform an action on a customer
|
|
243
|
+
* @request PUT:/api/v2.1/customers/{id}/call/{action}
|
|
244
|
+
*/
|
|
245
|
+
export declare const putApiV21CustomersIdCallAction: (client: HttpClient, action: string, id: number, putApiV21CustomersIdCallAction: PutApiV21CustomersIdCallAction, params?: RequestParams) => Promise<void>;
|
|
246
|
+
/**
|
|
247
|
+
* @description Perform an action on a customer asynchronously
|
|
248
|
+
*
|
|
249
|
+
* @tags customers
|
|
250
|
+
* @name PutApiV21CustomersIdCallAsyncAction
|
|
251
|
+
* @summary Perform an action on a customer asynchronously
|
|
252
|
+
* @request PUT:/api/v2.1/customers/{id}/call_async/{action}
|
|
253
|
+
*/
|
|
254
|
+
export declare const putApiV21CustomersIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV21CustomersIdCallAsyncAction: PutApiV21CustomersIdCallAsyncAction, params?: RequestParams) => Promise<void>;
|
|
255
|
+
/**
|
|
256
|
+
* @description List a customer's shops
|
|
257
|
+
*
|
|
258
|
+
* @tags customers
|
|
259
|
+
* @name GetApiV21CustomersIdShops
|
|
260
|
+
* @summary List all shops for a customer
|
|
261
|
+
* @request GET:/api/v2.1/customers/{id}/shops
|
|
262
|
+
*/
|
|
263
|
+
export declare const getApiV21CustomersIdShops: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShop[]>;
|