yellowgrid-api-ts 3.2.95-dev.0 → 3.2.97-dev.0
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/README.md +3 -0
- package/api.ts +238 -0
- package/dist/api.d.ts +115 -0
- package/dist/api.js +275 -0
- package/docs/OrdersApi.md +120 -0
- package/docs/ProductsApi.md +58 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -163,6 +163,7 @@ Class | Method | HTTP request | Description
|
|
|
163
163
|
*OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
|
|
164
164
|
*OrdersApi* | [**getGetOrderSummary**](docs/OrdersApi.md#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)
|
|
165
165
|
*OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
|
|
166
|
+
*OrdersApi* | [**patchCompleteOrder**](docs/OrdersApi.md#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)
|
|
166
167
|
*OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
|
|
167
168
|
*OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
|
|
168
169
|
*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
|
|
@@ -175,6 +176,7 @@ Class | Method | HTTP request | Description
|
|
|
175
176
|
*OrdersApi* | [**postSendSupplierEmail**](docs/OrdersApi.md#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email
|
|
176
177
|
*OrdersApi* | [**postSplitOrder**](docs/OrdersApi.md#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order
|
|
177
178
|
*OrdersApi* | [**putAllocateItems**](docs/OrdersApi.md#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier
|
|
179
|
+
*OrdersApi* | [**putDeleteBatch**](docs/OrdersApi.md#putdeletebatch) | **PUT** /admin/orders/{id}/batches/{batch_id} | Update Batch Item (Admin)
|
|
178
180
|
*OrdersApi* | [**putUpdateAdminOrder**](docs/OrdersApi.md#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)
|
|
179
181
|
*OrdersApi* | [**putUpdateOrder**](docs/OrdersApi.md#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)
|
|
180
182
|
*OrdersApi* | [**putUpdatePaymentStatus**](docs/OrdersApi.md#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)
|
|
@@ -188,6 +190,7 @@ Class | Method | HTTP request | Description
|
|
|
188
190
|
*ProductsApi* | [**getGetStockList**](docs/ProductsApi.md#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing
|
|
189
191
|
*ProductsApi* | [**getGetTcxTemplates**](docs/ProductsApi.md#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates
|
|
190
192
|
*ProductsApi* | [**getSearchProducts**](docs/ProductsApi.md#getsearchproducts) | **GET** /products/search | Search Products
|
|
193
|
+
*ProductsApi* | [**patchAddQuantityToStock**](docs/ProductsApi.md#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock
|
|
191
194
|
*ProductsApi* | [**postGetProduct**](docs/ProductsApi.md#postgetproduct) | **POST** /products/{sku} | Get Product
|
|
192
195
|
*ProductsApi* | [**postGetProductForCustomer**](docs/ProductsApi.md#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer
|
|
193
196
|
*ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
|
package/api.ts
CHANGED
|
@@ -20458,6 +20458,40 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20458
20458
|
|
|
20459
20459
|
|
|
20460
20460
|
|
|
20461
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20462
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20463
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20464
|
+
|
|
20465
|
+
return {
|
|
20466
|
+
url: toPathString(localVarUrlObj),
|
|
20467
|
+
options: localVarRequestOptions,
|
|
20468
|
+
};
|
|
20469
|
+
},
|
|
20470
|
+
/**
|
|
20471
|
+
* Mark Order As Complete (Admin)
|
|
20472
|
+
* @summary Mark Order As Complete (Admin)
|
|
20473
|
+
* @param {number} id Order ID
|
|
20474
|
+
* @param {*} [options] Override http request option.
|
|
20475
|
+
* @throws {RequiredError}
|
|
20476
|
+
*/
|
|
20477
|
+
patchCompleteOrder: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20478
|
+
// verify required parameter 'id' is not null or undefined
|
|
20479
|
+
assertParamExists('patchCompleteOrder', 'id', id)
|
|
20480
|
+
const localVarPath = `/admin/orders/{id}/complete`
|
|
20481
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
20482
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20483
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20484
|
+
let baseOptions;
|
|
20485
|
+
if (configuration) {
|
|
20486
|
+
baseOptions = configuration.baseOptions;
|
|
20487
|
+
}
|
|
20488
|
+
|
|
20489
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
20490
|
+
const localVarHeaderParameter = {} as any;
|
|
20491
|
+
const localVarQueryParameter = {} as any;
|
|
20492
|
+
|
|
20493
|
+
|
|
20494
|
+
|
|
20461
20495
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20462
20496
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20463
20497
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -20961,6 +20995,52 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20961
20995
|
options: localVarRequestOptions,
|
|
20962
20996
|
};
|
|
20963
20997
|
},
|
|
20998
|
+
/**
|
|
20999
|
+
* Update Batch Item (Admin)
|
|
21000
|
+
* @summary Update Batch Item (Admin)
|
|
21001
|
+
* @param {number} id Order ID
|
|
21002
|
+
* @param {number} batchId Batch ID
|
|
21003
|
+
* @param {number} itemId Ordered Item ID
|
|
21004
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
21005
|
+
* @param {*} [options] Override http request option.
|
|
21006
|
+
* @throws {RequiredError}
|
|
21007
|
+
*/
|
|
21008
|
+
putDeleteBatch: async (id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21009
|
+
// verify required parameter 'id' is not null or undefined
|
|
21010
|
+
assertParamExists('putDeleteBatch', 'id', id)
|
|
21011
|
+
// verify required parameter 'batchId' is not null or undefined
|
|
21012
|
+
assertParamExists('putDeleteBatch', 'batchId', batchId)
|
|
21013
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
21014
|
+
assertParamExists('putDeleteBatch', 'itemId', itemId)
|
|
21015
|
+
const localVarPath = `/admin/orders/{id}/batches/{batch_id}`
|
|
21016
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
21017
|
+
.replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
|
|
21018
|
+
.replace(`{${"item_id"}}`, encodeURIComponent(String(itemId)));
|
|
21019
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21020
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21021
|
+
let baseOptions;
|
|
21022
|
+
if (configuration) {
|
|
21023
|
+
baseOptions = configuration.baseOptions;
|
|
21024
|
+
}
|
|
21025
|
+
|
|
21026
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
21027
|
+
const localVarHeaderParameter = {} as any;
|
|
21028
|
+
const localVarQueryParameter = {} as any;
|
|
21029
|
+
|
|
21030
|
+
|
|
21031
|
+
|
|
21032
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
21033
|
+
|
|
21034
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21035
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21036
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21037
|
+
localVarRequestOptions.data = serializeDataIfNeeded(orderedItemModel, localVarRequestOptions, configuration)
|
|
21038
|
+
|
|
21039
|
+
return {
|
|
21040
|
+
url: toPathString(localVarUrlObj),
|
|
21041
|
+
options: localVarRequestOptions,
|
|
21042
|
+
};
|
|
21043
|
+
},
|
|
20964
21044
|
/**
|
|
20965
21045
|
* Update An Order (Admin)
|
|
20966
21046
|
* @summary Update An Order (Admin)
|
|
@@ -21283,6 +21363,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
21283
21363
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrders']?.[localVarOperationServerIndex]?.url;
|
|
21284
21364
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21285
21365
|
},
|
|
21366
|
+
/**
|
|
21367
|
+
* Mark Order As Complete (Admin)
|
|
21368
|
+
* @summary Mark Order As Complete (Admin)
|
|
21369
|
+
* @param {number} id Order ID
|
|
21370
|
+
* @param {*} [options] Override http request option.
|
|
21371
|
+
* @throws {RequiredError}
|
|
21372
|
+
*/
|
|
21373
|
+
async patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>> {
|
|
21374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCompleteOrder(id, options);
|
|
21375
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21376
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.patchCompleteOrder']?.[localVarOperationServerIndex]?.url;
|
|
21377
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21378
|
+
},
|
|
21286
21379
|
/**
|
|
21287
21380
|
* Add Order Note
|
|
21288
21381
|
* @summary Add Order Note
|
|
@@ -21457,6 +21550,22 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
21457
21550
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.putAllocateItems']?.[localVarOperationServerIndex]?.url;
|
|
21458
21551
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21459
21552
|
},
|
|
21553
|
+
/**
|
|
21554
|
+
* Update Batch Item (Admin)
|
|
21555
|
+
* @summary Update Batch Item (Admin)
|
|
21556
|
+
* @param {number} id Order ID
|
|
21557
|
+
* @param {number} batchId Batch ID
|
|
21558
|
+
* @param {number} itemId Ordered Item ID
|
|
21559
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
21560
|
+
* @param {*} [options] Override http request option.
|
|
21561
|
+
* @throws {RequiredError}
|
|
21562
|
+
*/
|
|
21563
|
+
async putDeleteBatch(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderedItemModel>> {
|
|
21564
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.putDeleteBatch(id, batchId, itemId, orderedItemModel, options);
|
|
21565
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21566
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.putDeleteBatch']?.[localVarOperationServerIndex]?.url;
|
|
21567
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21568
|
+
},
|
|
21460
21569
|
/**
|
|
21461
21570
|
* Update An Order (Admin)
|
|
21462
21571
|
* @summary Update An Order (Admin)
|
|
@@ -21636,6 +21745,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21636
21745
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel> {
|
|
21637
21746
|
return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then((request) => request(axios, basePath));
|
|
21638
21747
|
},
|
|
21748
|
+
/**
|
|
21749
|
+
* Mark Order As Complete (Admin)
|
|
21750
|
+
* @summary Mark Order As Complete (Admin)
|
|
21751
|
+
* @param {number} id Order ID
|
|
21752
|
+
* @param {*} [options] Override http request option.
|
|
21753
|
+
* @throws {RequiredError}
|
|
21754
|
+
*/
|
|
21755
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO> {
|
|
21756
|
+
return localVarFp.patchCompleteOrder(id, options).then((request) => request(axios, basePath));
|
|
21757
|
+
},
|
|
21639
21758
|
/**
|
|
21640
21759
|
* Add Order Note
|
|
21641
21760
|
* @summary Add Order Note
|
|
@@ -21774,6 +21893,19 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21774
21893
|
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BatchDTO>> {
|
|
21775
21894
|
return localVarFp.putAllocateItems(id, supplierId, putAllocateItemsRequest, options).then((request) => request(axios, basePath));
|
|
21776
21895
|
},
|
|
21896
|
+
/**
|
|
21897
|
+
* Update Batch Item (Admin)
|
|
21898
|
+
* @summary Update Batch Item (Admin)
|
|
21899
|
+
* @param {number} id Order ID
|
|
21900
|
+
* @param {number} batchId Batch ID
|
|
21901
|
+
* @param {number} itemId Ordered Item ID
|
|
21902
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
21903
|
+
* @param {*} [options] Override http request option.
|
|
21904
|
+
* @throws {RequiredError}
|
|
21905
|
+
*/
|
|
21906
|
+
putDeleteBatch(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): AxiosPromise<OrderedItemModel> {
|
|
21907
|
+
return localVarFp.putDeleteBatch(id, batchId, itemId, orderedItemModel, options).then((request) => request(axios, basePath));
|
|
21908
|
+
},
|
|
21777
21909
|
/**
|
|
21778
21910
|
* Update An Order (Admin)
|
|
21779
21911
|
* @summary Update An Order (Admin)
|
|
@@ -21961,6 +22093,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
21961
22093
|
return OrdersApiFp(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then((request) => request(this.axios, this.basePath));
|
|
21962
22094
|
}
|
|
21963
22095
|
|
|
22096
|
+
/**
|
|
22097
|
+
* Mark Order As Complete (Admin)
|
|
22098
|
+
* @summary Mark Order As Complete (Admin)
|
|
22099
|
+
* @param {number} id Order ID
|
|
22100
|
+
* @param {*} [options] Override http request option.
|
|
22101
|
+
* @throws {RequiredError}
|
|
22102
|
+
* @memberof OrdersApi
|
|
22103
|
+
*/
|
|
22104
|
+
public patchCompleteOrder(id: number, options?: RawAxiosRequestConfig) {
|
|
22105
|
+
return OrdersApiFp(this.configuration).patchCompleteOrder(id, options).then((request) => request(this.axios, this.basePath));
|
|
22106
|
+
}
|
|
22107
|
+
|
|
21964
22108
|
/**
|
|
21965
22109
|
* Add Order Note
|
|
21966
22110
|
* @summary Add Order Note
|
|
@@ -22123,6 +22267,21 @@ export class OrdersApi extends BaseAPI {
|
|
|
22123
22267
|
return OrdersApiFp(this.configuration).putAllocateItems(id, supplierId, putAllocateItemsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
22124
22268
|
}
|
|
22125
22269
|
|
|
22270
|
+
/**
|
|
22271
|
+
* Update Batch Item (Admin)
|
|
22272
|
+
* @summary Update Batch Item (Admin)
|
|
22273
|
+
* @param {number} id Order ID
|
|
22274
|
+
* @param {number} batchId Batch ID
|
|
22275
|
+
* @param {number} itemId Ordered Item ID
|
|
22276
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
22277
|
+
* @param {*} [options] Override http request option.
|
|
22278
|
+
* @throws {RequiredError}
|
|
22279
|
+
* @memberof OrdersApi
|
|
22280
|
+
*/
|
|
22281
|
+
public putDeleteBatch(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig) {
|
|
22282
|
+
return OrdersApiFp(this.configuration).putDeleteBatch(id, batchId, itemId, orderedItemModel, options).then((request) => request(this.axios, this.basePath));
|
|
22283
|
+
}
|
|
22284
|
+
|
|
22126
22285
|
/**
|
|
22127
22286
|
* Update An Order (Admin)
|
|
22128
22287
|
* @summary Update An Order (Admin)
|
|
@@ -22792,6 +22951,47 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
22792
22951
|
|
|
22793
22952
|
|
|
22794
22953
|
|
|
22954
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22955
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22956
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22957
|
+
|
|
22958
|
+
return {
|
|
22959
|
+
url: toPathString(localVarUrlObj),
|
|
22960
|
+
options: localVarRequestOptions,
|
|
22961
|
+
};
|
|
22962
|
+
},
|
|
22963
|
+
/**
|
|
22964
|
+
* Add Item Quantity To Stock
|
|
22965
|
+
* @summary Add Item Quantity To Stock
|
|
22966
|
+
* @param {string} sku Product SKU
|
|
22967
|
+
* @param {number} quantity Quantity
|
|
22968
|
+
* @param {*} [options] Override http request option.
|
|
22969
|
+
* @throws {RequiredError}
|
|
22970
|
+
*/
|
|
22971
|
+
patchAddQuantityToStock: async (sku: string, quantity: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22972
|
+
// verify required parameter 'sku' is not null or undefined
|
|
22973
|
+
assertParamExists('patchAddQuantityToStock', 'sku', sku)
|
|
22974
|
+
// verify required parameter 'quantity' is not null or undefined
|
|
22975
|
+
assertParamExists('patchAddQuantityToStock', 'quantity', quantity)
|
|
22976
|
+
const localVarPath = `/products/{sku}/stock/add`
|
|
22977
|
+
.replace(`{${"sku"}}`, encodeURIComponent(String(sku)));
|
|
22978
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22979
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22980
|
+
let baseOptions;
|
|
22981
|
+
if (configuration) {
|
|
22982
|
+
baseOptions = configuration.baseOptions;
|
|
22983
|
+
}
|
|
22984
|
+
|
|
22985
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
22986
|
+
const localVarHeaderParameter = {} as any;
|
|
22987
|
+
const localVarQueryParameter = {} as any;
|
|
22988
|
+
|
|
22989
|
+
if (quantity !== undefined) {
|
|
22990
|
+
localVarQueryParameter['quantity'] = quantity;
|
|
22991
|
+
}
|
|
22992
|
+
|
|
22993
|
+
|
|
22994
|
+
|
|
22795
22995
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22796
22996
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22797
22997
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -22987,6 +23187,20 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
22987
23187
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getSearchProducts']?.[localVarOperationServerIndex]?.url;
|
|
22988
23188
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22989
23189
|
},
|
|
23190
|
+
/**
|
|
23191
|
+
* Add Item Quantity To Stock
|
|
23192
|
+
* @summary Add Item Quantity To Stock
|
|
23193
|
+
* @param {string} sku Product SKU
|
|
23194
|
+
* @param {number} quantity Quantity
|
|
23195
|
+
* @param {*} [options] Override http request option.
|
|
23196
|
+
* @throws {RequiredError}
|
|
23197
|
+
*/
|
|
23198
|
+
async patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
23199
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchAddQuantityToStock(sku, quantity, options);
|
|
23200
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
23201
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.patchAddQuantityToStock']?.[localVarOperationServerIndex]?.url;
|
|
23202
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23203
|
+
},
|
|
22990
23204
|
/**
|
|
22991
23205
|
* Get Product
|
|
22992
23206
|
* @summary Get Product
|
|
@@ -23094,6 +23308,17 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
23094
23308
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProductSearchResultsModel> {
|
|
23095
23309
|
return localVarFp.getSearchProducts(pageSize, page, search, options).then((request) => request(axios, basePath));
|
|
23096
23310
|
},
|
|
23311
|
+
/**
|
|
23312
|
+
* Add Item Quantity To Stock
|
|
23313
|
+
* @summary Add Item Quantity To Stock
|
|
23314
|
+
* @param {string} sku Product SKU
|
|
23315
|
+
* @param {number} quantity Quantity
|
|
23316
|
+
* @param {*} [options] Override http request option.
|
|
23317
|
+
* @throws {RequiredError}
|
|
23318
|
+
*/
|
|
23319
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
23320
|
+
return localVarFp.patchAddQuantityToStock(sku, quantity, options).then((request) => request(axios, basePath));
|
|
23321
|
+
},
|
|
23097
23322
|
/**
|
|
23098
23323
|
* Get Product
|
|
23099
23324
|
* @summary Get Product
|
|
@@ -23209,6 +23434,19 @@ export class ProductsApi extends BaseAPI {
|
|
|
23209
23434
|
return ProductsApiFp(this.configuration).getSearchProducts(pageSize, page, search, options).then((request) => request(this.axios, this.basePath));
|
|
23210
23435
|
}
|
|
23211
23436
|
|
|
23437
|
+
/**
|
|
23438
|
+
* Add Item Quantity To Stock
|
|
23439
|
+
* @summary Add Item Quantity To Stock
|
|
23440
|
+
* @param {string} sku Product SKU
|
|
23441
|
+
* @param {number} quantity Quantity
|
|
23442
|
+
* @param {*} [options] Override http request option.
|
|
23443
|
+
* @throws {RequiredError}
|
|
23444
|
+
* @memberof ProductsApi
|
|
23445
|
+
*/
|
|
23446
|
+
public patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig) {
|
|
23447
|
+
return ProductsApiFp(this.configuration).patchAddQuantityToStock(sku, quantity, options).then((request) => request(this.axios, this.basePath));
|
|
23448
|
+
}
|
|
23449
|
+
|
|
23212
23450
|
/**
|
|
23213
23451
|
* Get Product
|
|
23214
23452
|
* @summary Get Product
|
package/dist/api.d.ts
CHANGED
|
@@ -15801,6 +15801,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15801
15801
|
* @throws {RequiredError}
|
|
15802
15802
|
*/
|
|
15803
15803
|
getGetOrders: (pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15804
|
+
/**
|
|
15805
|
+
* Mark Order As Complete (Admin)
|
|
15806
|
+
* @summary Mark Order As Complete (Admin)
|
|
15807
|
+
* @param {number} id Order ID
|
|
15808
|
+
* @param {*} [options] Override http request option.
|
|
15809
|
+
* @throws {RequiredError}
|
|
15810
|
+
*/
|
|
15811
|
+
patchCompleteOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15804
15812
|
/**
|
|
15805
15813
|
* Add Order Note
|
|
15806
15814
|
* @summary Add Order Note
|
|
@@ -15915,6 +15923,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15915
15923
|
* @throws {RequiredError}
|
|
15916
15924
|
*/
|
|
15917
15925
|
putAllocateItems: (id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15926
|
+
/**
|
|
15927
|
+
* Update Batch Item (Admin)
|
|
15928
|
+
* @summary Update Batch Item (Admin)
|
|
15929
|
+
* @param {number} id Order ID
|
|
15930
|
+
* @param {number} batchId Batch ID
|
|
15931
|
+
* @param {number} itemId Ordered Item ID
|
|
15932
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
15933
|
+
* @param {*} [options] Override http request option.
|
|
15934
|
+
* @throws {RequiredError}
|
|
15935
|
+
*/
|
|
15936
|
+
putDeleteBatch: (id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15918
15937
|
/**
|
|
15919
15938
|
* Update An Order (Admin)
|
|
15920
15939
|
* @summary Update An Order (Admin)
|
|
@@ -16050,6 +16069,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
16050
16069
|
* @throws {RequiredError}
|
|
16051
16070
|
*/
|
|
16052
16071
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummariesModel>>;
|
|
16072
|
+
/**
|
|
16073
|
+
* Mark Order As Complete (Admin)
|
|
16074
|
+
* @summary Mark Order As Complete (Admin)
|
|
16075
|
+
* @param {number} id Order ID
|
|
16076
|
+
* @param {*} [options] Override http request option.
|
|
16077
|
+
* @throws {RequiredError}
|
|
16078
|
+
*/
|
|
16079
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
|
|
16053
16080
|
/**
|
|
16054
16081
|
* Add Order Note
|
|
16055
16082
|
* @summary Add Order Note
|
|
@@ -16164,6 +16191,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
16164
16191
|
* @throws {RequiredError}
|
|
16165
16192
|
*/
|
|
16166
16193
|
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BatchDTO>>>;
|
|
16194
|
+
/**
|
|
16195
|
+
* Update Batch Item (Admin)
|
|
16196
|
+
* @summary Update Batch Item (Admin)
|
|
16197
|
+
* @param {number} id Order ID
|
|
16198
|
+
* @param {number} batchId Batch ID
|
|
16199
|
+
* @param {number} itemId Ordered Item ID
|
|
16200
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
16201
|
+
* @param {*} [options] Override http request option.
|
|
16202
|
+
* @throws {RequiredError}
|
|
16203
|
+
*/
|
|
16204
|
+
putDeleteBatch(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderedItemModel>>;
|
|
16167
16205
|
/**
|
|
16168
16206
|
* Update An Order (Admin)
|
|
16169
16207
|
* @summary Update An Order (Admin)
|
|
@@ -16299,6 +16337,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16299
16337
|
* @throws {RequiredError}
|
|
16300
16338
|
*/
|
|
16301
16339
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel>;
|
|
16340
|
+
/**
|
|
16341
|
+
* Mark Order As Complete (Admin)
|
|
16342
|
+
* @summary Mark Order As Complete (Admin)
|
|
16343
|
+
* @param {number} id Order ID
|
|
16344
|
+
* @param {*} [options] Override http request option.
|
|
16345
|
+
* @throws {RequiredError}
|
|
16346
|
+
*/
|
|
16347
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
|
|
16302
16348
|
/**
|
|
16303
16349
|
* Add Order Note
|
|
16304
16350
|
* @summary Add Order Note
|
|
@@ -16413,6 +16459,17 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16413
16459
|
* @throws {RequiredError}
|
|
16414
16460
|
*/
|
|
16415
16461
|
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BatchDTO>>;
|
|
16462
|
+
/**
|
|
16463
|
+
* Update Batch Item (Admin)
|
|
16464
|
+
* @summary Update Batch Item (Admin)
|
|
16465
|
+
* @param {number} id Order ID
|
|
16466
|
+
* @param {number} batchId Batch ID
|
|
16467
|
+
* @param {number} itemId Ordered Item ID
|
|
16468
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
16469
|
+
* @param {*} [options] Override http request option.
|
|
16470
|
+
* @throws {RequiredError}
|
|
16471
|
+
*/
|
|
16472
|
+
putDeleteBatch(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): AxiosPromise<OrderedItemModel>;
|
|
16416
16473
|
/**
|
|
16417
16474
|
* Update An Order (Admin)
|
|
16418
16475
|
* @summary Update An Order (Admin)
|
|
@@ -16560,6 +16617,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
16560
16617
|
* @memberof OrdersApi
|
|
16561
16618
|
*/
|
|
16562
16619
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummariesModel, any, {}>>;
|
|
16620
|
+
/**
|
|
16621
|
+
* Mark Order As Complete (Admin)
|
|
16622
|
+
* @summary Mark Order As Complete (Admin)
|
|
16623
|
+
* @param {number} id Order ID
|
|
16624
|
+
* @param {*} [options] Override http request option.
|
|
16625
|
+
* @throws {RequiredError}
|
|
16626
|
+
* @memberof OrdersApi
|
|
16627
|
+
*/
|
|
16628
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
|
|
16563
16629
|
/**
|
|
16564
16630
|
* Add Order Note
|
|
16565
16631
|
* @summary Add Order Note
|
|
@@ -16686,6 +16752,18 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
16686
16752
|
* @memberof OrdersApi
|
|
16687
16753
|
*/
|
|
16688
16754
|
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchDTO[], any, {}>>;
|
|
16755
|
+
/**
|
|
16756
|
+
* Update Batch Item (Admin)
|
|
16757
|
+
* @summary Update Batch Item (Admin)
|
|
16758
|
+
* @param {number} id Order ID
|
|
16759
|
+
* @param {number} batchId Batch ID
|
|
16760
|
+
* @param {number} itemId Ordered Item ID
|
|
16761
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
16762
|
+
* @param {*} [options] Override http request option.
|
|
16763
|
+
* @throws {RequiredError}
|
|
16764
|
+
* @memberof OrdersApi
|
|
16765
|
+
*/
|
|
16766
|
+
putDeleteBatch(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderedItemModel, any, {}>>;
|
|
16689
16767
|
/**
|
|
16690
16768
|
* Update An Order (Admin)
|
|
16691
16769
|
* @summary Update An Order (Admin)
|
|
@@ -17043,6 +17121,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
17043
17121
|
* @throws {RequiredError}
|
|
17044
17122
|
*/
|
|
17045
17123
|
getSearchProducts: (pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17124
|
+
/**
|
|
17125
|
+
* Add Item Quantity To Stock
|
|
17126
|
+
* @summary Add Item Quantity To Stock
|
|
17127
|
+
* @param {string} sku Product SKU
|
|
17128
|
+
* @param {number} quantity Quantity
|
|
17129
|
+
* @param {*} [options] Override http request option.
|
|
17130
|
+
* @throws {RequiredError}
|
|
17131
|
+
*/
|
|
17132
|
+
patchAddQuantityToStock: (sku: string, quantity: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17046
17133
|
/**
|
|
17047
17134
|
* Get Product
|
|
17048
17135
|
* @summary Get Product
|
|
@@ -17122,6 +17209,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
17122
17209
|
* @throws {RequiredError}
|
|
17123
17210
|
*/
|
|
17124
17211
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSearchResultsModel>>;
|
|
17212
|
+
/**
|
|
17213
|
+
* Add Item Quantity To Stock
|
|
17214
|
+
* @summary Add Item Quantity To Stock
|
|
17215
|
+
* @param {string} sku Product SKU
|
|
17216
|
+
* @param {number} quantity Quantity
|
|
17217
|
+
* @param {*} [options] Override http request option.
|
|
17218
|
+
* @throws {RequiredError}
|
|
17219
|
+
*/
|
|
17220
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
17125
17221
|
/**
|
|
17126
17222
|
* Get Product
|
|
17127
17223
|
* @summary Get Product
|
|
@@ -17201,6 +17297,15 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
17201
17297
|
* @throws {RequiredError}
|
|
17202
17298
|
*/
|
|
17203
17299
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProductSearchResultsModel>;
|
|
17300
|
+
/**
|
|
17301
|
+
* Add Item Quantity To Stock
|
|
17302
|
+
* @summary Add Item Quantity To Stock
|
|
17303
|
+
* @param {string} sku Product SKU
|
|
17304
|
+
* @param {number} quantity Quantity
|
|
17305
|
+
* @param {*} [options] Override http request option.
|
|
17306
|
+
* @throws {RequiredError}
|
|
17307
|
+
*/
|
|
17308
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
17204
17309
|
/**
|
|
17205
17310
|
* Get Product
|
|
17206
17311
|
* @summary Get Product
|
|
@@ -17289,6 +17394,16 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
17289
17394
|
* @memberof ProductsApi
|
|
17290
17395
|
*/
|
|
17291
17396
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSearchResultsModel, any, {}>>;
|
|
17397
|
+
/**
|
|
17398
|
+
* Add Item Quantity To Stock
|
|
17399
|
+
* @summary Add Item Quantity To Stock
|
|
17400
|
+
* @param {string} sku Product SKU
|
|
17401
|
+
* @param {number} quantity Quantity
|
|
17402
|
+
* @param {*} [options] Override http request option.
|
|
17403
|
+
* @throws {RequiredError}
|
|
17404
|
+
* @memberof ProductsApi
|
|
17405
|
+
*/
|
|
17406
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
17292
17407
|
/**
|
|
17293
17408
|
* Get Product
|
|
17294
17409
|
* @summary Get Product
|
package/dist/api.js
CHANGED
|
@@ -10356,6 +10356,43 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10356
10356
|
});
|
|
10357
10357
|
});
|
|
10358
10358
|
},
|
|
10359
|
+
/**
|
|
10360
|
+
* Mark Order As Complete (Admin)
|
|
10361
|
+
* @summary Mark Order As Complete (Admin)
|
|
10362
|
+
* @param {number} id Order ID
|
|
10363
|
+
* @param {*} [options] Override http request option.
|
|
10364
|
+
* @throws {RequiredError}
|
|
10365
|
+
*/
|
|
10366
|
+
patchCompleteOrder: function (id_1) {
|
|
10367
|
+
var args_1 = [];
|
|
10368
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
10369
|
+
args_1[_i - 1] = arguments[_i];
|
|
10370
|
+
}
|
|
10371
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
10372
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10373
|
+
if (options === void 0) { options = {}; }
|
|
10374
|
+
return __generator(this, function (_a) {
|
|
10375
|
+
// verify required parameter 'id' is not null or undefined
|
|
10376
|
+
(0, common_1.assertParamExists)('patchCompleteOrder', 'id', id);
|
|
10377
|
+
localVarPath = "/admin/orders/{id}/complete"
|
|
10378
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
10379
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10380
|
+
if (configuration) {
|
|
10381
|
+
baseOptions = configuration.baseOptions;
|
|
10382
|
+
}
|
|
10383
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
10384
|
+
localVarHeaderParameter = {};
|
|
10385
|
+
localVarQueryParameter = {};
|
|
10386
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10387
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10388
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10389
|
+
return [2 /*return*/, {
|
|
10390
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10391
|
+
options: localVarRequestOptions,
|
|
10392
|
+
}];
|
|
10393
|
+
});
|
|
10394
|
+
});
|
|
10395
|
+
},
|
|
10359
10396
|
/**
|
|
10360
10397
|
* Add Order Note
|
|
10361
10398
|
* @summary Add Order Note
|
|
@@ -10872,6 +10909,54 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10872
10909
|
});
|
|
10873
10910
|
});
|
|
10874
10911
|
},
|
|
10912
|
+
/**
|
|
10913
|
+
* Update Batch Item (Admin)
|
|
10914
|
+
* @summary Update Batch Item (Admin)
|
|
10915
|
+
* @param {number} id Order ID
|
|
10916
|
+
* @param {number} batchId Batch ID
|
|
10917
|
+
* @param {number} itemId Ordered Item ID
|
|
10918
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
10919
|
+
* @param {*} [options] Override http request option.
|
|
10920
|
+
* @throws {RequiredError}
|
|
10921
|
+
*/
|
|
10922
|
+
putDeleteBatch: function (id_1, batchId_1, itemId_1, orderedItemModel_1) {
|
|
10923
|
+
var args_1 = [];
|
|
10924
|
+
for (var _i = 4; _i < arguments.length; _i++) {
|
|
10925
|
+
args_1[_i - 4] = arguments[_i];
|
|
10926
|
+
}
|
|
10927
|
+
return __awaiter(_this, __spreadArray([id_1, batchId_1, itemId_1, orderedItemModel_1], args_1, true), void 0, function (id, batchId, itemId, orderedItemModel, options) {
|
|
10928
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10929
|
+
if (options === void 0) { options = {}; }
|
|
10930
|
+
return __generator(this, function (_a) {
|
|
10931
|
+
// verify required parameter 'id' is not null or undefined
|
|
10932
|
+
(0, common_1.assertParamExists)('putDeleteBatch', 'id', id);
|
|
10933
|
+
// verify required parameter 'batchId' is not null or undefined
|
|
10934
|
+
(0, common_1.assertParamExists)('putDeleteBatch', 'batchId', batchId);
|
|
10935
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
10936
|
+
(0, common_1.assertParamExists)('putDeleteBatch', 'itemId', itemId);
|
|
10937
|
+
localVarPath = "/admin/orders/{id}/batches/{batch_id}"
|
|
10938
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)))
|
|
10939
|
+
.replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
|
|
10940
|
+
.replace("{".concat("item_id", "}"), encodeURIComponent(String(itemId)));
|
|
10941
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10942
|
+
if (configuration) {
|
|
10943
|
+
baseOptions = configuration.baseOptions;
|
|
10944
|
+
}
|
|
10945
|
+
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
|
|
10946
|
+
localVarHeaderParameter = {};
|
|
10947
|
+
localVarQueryParameter = {};
|
|
10948
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10949
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10950
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10951
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10952
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(orderedItemModel, localVarRequestOptions, configuration);
|
|
10953
|
+
return [2 /*return*/, {
|
|
10954
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10955
|
+
options: localVarRequestOptions,
|
|
10956
|
+
}];
|
|
10957
|
+
});
|
|
10958
|
+
});
|
|
10959
|
+
},
|
|
10875
10960
|
/**
|
|
10876
10961
|
* Update An Order (Admin)
|
|
10877
10962
|
* @summary Update An Order (Admin)
|
|
@@ -11300,6 +11385,29 @@ var OrdersApiFp = function (configuration) {
|
|
|
11300
11385
|
});
|
|
11301
11386
|
});
|
|
11302
11387
|
},
|
|
11388
|
+
/**
|
|
11389
|
+
* Mark Order As Complete (Admin)
|
|
11390
|
+
* @summary Mark Order As Complete (Admin)
|
|
11391
|
+
* @param {number} id Order ID
|
|
11392
|
+
* @param {*} [options] Override http request option.
|
|
11393
|
+
* @throws {RequiredError}
|
|
11394
|
+
*/
|
|
11395
|
+
patchCompleteOrder: function (id, options) {
|
|
11396
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11397
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11398
|
+
var _a, _b, _c;
|
|
11399
|
+
return __generator(this, function (_d) {
|
|
11400
|
+
switch (_d.label) {
|
|
11401
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCompleteOrder(id, options)];
|
|
11402
|
+
case 1:
|
|
11403
|
+
localVarAxiosArgs = _d.sent();
|
|
11404
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11405
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.patchCompleteOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11406
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11407
|
+
}
|
|
11408
|
+
});
|
|
11409
|
+
});
|
|
11410
|
+
},
|
|
11303
11411
|
/**
|
|
11304
11412
|
* Add Order Note
|
|
11305
11413
|
* @summary Add Order Note
|
|
@@ -11594,6 +11702,32 @@ var OrdersApiFp = function (configuration) {
|
|
|
11594
11702
|
});
|
|
11595
11703
|
});
|
|
11596
11704
|
},
|
|
11705
|
+
/**
|
|
11706
|
+
* Update Batch Item (Admin)
|
|
11707
|
+
* @summary Update Batch Item (Admin)
|
|
11708
|
+
* @param {number} id Order ID
|
|
11709
|
+
* @param {number} batchId Batch ID
|
|
11710
|
+
* @param {number} itemId Ordered Item ID
|
|
11711
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
11712
|
+
* @param {*} [options] Override http request option.
|
|
11713
|
+
* @throws {RequiredError}
|
|
11714
|
+
*/
|
|
11715
|
+
putDeleteBatch: function (id, batchId, itemId, orderedItemModel, options) {
|
|
11716
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11717
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11718
|
+
var _a, _b, _c;
|
|
11719
|
+
return __generator(this, function (_d) {
|
|
11720
|
+
switch (_d.label) {
|
|
11721
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.putDeleteBatch(id, batchId, itemId, orderedItemModel, options)];
|
|
11722
|
+
case 1:
|
|
11723
|
+
localVarAxiosArgs = _d.sent();
|
|
11724
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11725
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.putDeleteBatch']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11726
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11727
|
+
}
|
|
11728
|
+
});
|
|
11729
|
+
});
|
|
11730
|
+
},
|
|
11597
11731
|
/**
|
|
11598
11732
|
* Update An Order (Admin)
|
|
11599
11733
|
* @summary Update An Order (Admin)
|
|
@@ -11813,6 +11947,16 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11813
11947
|
getGetOrders: function (pageSize, page, search, fulfillable, status, filter, customerId, options) {
|
|
11814
11948
|
return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then(function (request) { return request(axios, basePath); });
|
|
11815
11949
|
},
|
|
11950
|
+
/**
|
|
11951
|
+
* Mark Order As Complete (Admin)
|
|
11952
|
+
* @summary Mark Order As Complete (Admin)
|
|
11953
|
+
* @param {number} id Order ID
|
|
11954
|
+
* @param {*} [options] Override http request option.
|
|
11955
|
+
* @throws {RequiredError}
|
|
11956
|
+
*/
|
|
11957
|
+
patchCompleteOrder: function (id, options) {
|
|
11958
|
+
return localVarFp.patchCompleteOrder(id, options).then(function (request) { return request(axios, basePath); });
|
|
11959
|
+
},
|
|
11816
11960
|
/**
|
|
11817
11961
|
* Add Order Note
|
|
11818
11962
|
* @summary Add Order Note
|
|
@@ -11951,6 +12095,19 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11951
12095
|
putAllocateItems: function (id, supplierId, putAllocateItemsRequest, options) {
|
|
11952
12096
|
return localVarFp.putAllocateItems(id, supplierId, putAllocateItemsRequest, options).then(function (request) { return request(axios, basePath); });
|
|
11953
12097
|
},
|
|
12098
|
+
/**
|
|
12099
|
+
* Update Batch Item (Admin)
|
|
12100
|
+
* @summary Update Batch Item (Admin)
|
|
12101
|
+
* @param {number} id Order ID
|
|
12102
|
+
* @param {number} batchId Batch ID
|
|
12103
|
+
* @param {number} itemId Ordered Item ID
|
|
12104
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
12105
|
+
* @param {*} [options] Override http request option.
|
|
12106
|
+
* @throws {RequiredError}
|
|
12107
|
+
*/
|
|
12108
|
+
putDeleteBatch: function (id, batchId, itemId, orderedItemModel, options) {
|
|
12109
|
+
return localVarFp.putDeleteBatch(id, batchId, itemId, orderedItemModel, options).then(function (request) { return request(axios, basePath); });
|
|
12110
|
+
},
|
|
11954
12111
|
/**
|
|
11955
12112
|
* Update An Order (Admin)
|
|
11956
12113
|
* @summary Update An Order (Admin)
|
|
@@ -12142,6 +12299,18 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
12142
12299
|
var _this = this;
|
|
12143
12300
|
return (0, exports.OrdersApiFp)(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12144
12301
|
};
|
|
12302
|
+
/**
|
|
12303
|
+
* Mark Order As Complete (Admin)
|
|
12304
|
+
* @summary Mark Order As Complete (Admin)
|
|
12305
|
+
* @param {number} id Order ID
|
|
12306
|
+
* @param {*} [options] Override http request option.
|
|
12307
|
+
* @throws {RequiredError}
|
|
12308
|
+
* @memberof OrdersApi
|
|
12309
|
+
*/
|
|
12310
|
+
OrdersApi.prototype.patchCompleteOrder = function (id, options) {
|
|
12311
|
+
var _this = this;
|
|
12312
|
+
return (0, exports.OrdersApiFp)(this.configuration).patchCompleteOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12313
|
+
};
|
|
12145
12314
|
/**
|
|
12146
12315
|
* Add Order Note
|
|
12147
12316
|
* @summary Add Order Note
|
|
@@ -12304,6 +12473,21 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
12304
12473
|
var _this = this;
|
|
12305
12474
|
return (0, exports.OrdersApiFp)(this.configuration).putAllocateItems(id, supplierId, putAllocateItemsRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12306
12475
|
};
|
|
12476
|
+
/**
|
|
12477
|
+
* Update Batch Item (Admin)
|
|
12478
|
+
* @summary Update Batch Item (Admin)
|
|
12479
|
+
* @param {number} id Order ID
|
|
12480
|
+
* @param {number} batchId Batch ID
|
|
12481
|
+
* @param {number} itemId Ordered Item ID
|
|
12482
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
12483
|
+
* @param {*} [options] Override http request option.
|
|
12484
|
+
* @throws {RequiredError}
|
|
12485
|
+
* @memberof OrdersApi
|
|
12486
|
+
*/
|
|
12487
|
+
OrdersApi.prototype.putDeleteBatch = function (id, batchId, itemId, orderedItemModel, options) {
|
|
12488
|
+
var _this = this;
|
|
12489
|
+
return (0, exports.OrdersApiFp)(this.configuration).putDeleteBatch(id, batchId, itemId, orderedItemModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12490
|
+
};
|
|
12307
12491
|
/**
|
|
12308
12492
|
* Update An Order (Admin)
|
|
12309
12493
|
* @summary Update An Order (Admin)
|
|
@@ -13013,6 +13197,49 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
13013
13197
|
});
|
|
13014
13198
|
});
|
|
13015
13199
|
},
|
|
13200
|
+
/**
|
|
13201
|
+
* Add Item Quantity To Stock
|
|
13202
|
+
* @summary Add Item Quantity To Stock
|
|
13203
|
+
* @param {string} sku Product SKU
|
|
13204
|
+
* @param {number} quantity Quantity
|
|
13205
|
+
* @param {*} [options] Override http request option.
|
|
13206
|
+
* @throws {RequiredError}
|
|
13207
|
+
*/
|
|
13208
|
+
patchAddQuantityToStock: function (sku_1, quantity_1) {
|
|
13209
|
+
var args_1 = [];
|
|
13210
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
13211
|
+
args_1[_i - 2] = arguments[_i];
|
|
13212
|
+
}
|
|
13213
|
+
return __awaiter(_this, __spreadArray([sku_1, quantity_1], args_1, true), void 0, function (sku, quantity, options) {
|
|
13214
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
13215
|
+
if (options === void 0) { options = {}; }
|
|
13216
|
+
return __generator(this, function (_a) {
|
|
13217
|
+
// verify required parameter 'sku' is not null or undefined
|
|
13218
|
+
(0, common_1.assertParamExists)('patchAddQuantityToStock', 'sku', sku);
|
|
13219
|
+
// verify required parameter 'quantity' is not null or undefined
|
|
13220
|
+
(0, common_1.assertParamExists)('patchAddQuantityToStock', 'quantity', quantity);
|
|
13221
|
+
localVarPath = "/products/{sku}/stock/add"
|
|
13222
|
+
.replace("{".concat("sku", "}"), encodeURIComponent(String(sku)));
|
|
13223
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
13224
|
+
if (configuration) {
|
|
13225
|
+
baseOptions = configuration.baseOptions;
|
|
13226
|
+
}
|
|
13227
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
13228
|
+
localVarHeaderParameter = {};
|
|
13229
|
+
localVarQueryParameter = {};
|
|
13230
|
+
if (quantity !== undefined) {
|
|
13231
|
+
localVarQueryParameter['quantity'] = quantity;
|
|
13232
|
+
}
|
|
13233
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
13234
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13235
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13236
|
+
return [2 /*return*/, {
|
|
13237
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
13238
|
+
options: localVarRequestOptions,
|
|
13239
|
+
}];
|
|
13240
|
+
});
|
|
13241
|
+
});
|
|
13242
|
+
},
|
|
13016
13243
|
/**
|
|
13017
13244
|
* Get Product
|
|
13018
13245
|
* @summary Get Product
|
|
@@ -13272,6 +13499,30 @@ var ProductsApiFp = function (configuration) {
|
|
|
13272
13499
|
});
|
|
13273
13500
|
});
|
|
13274
13501
|
},
|
|
13502
|
+
/**
|
|
13503
|
+
* Add Item Quantity To Stock
|
|
13504
|
+
* @summary Add Item Quantity To Stock
|
|
13505
|
+
* @param {string} sku Product SKU
|
|
13506
|
+
* @param {number} quantity Quantity
|
|
13507
|
+
* @param {*} [options] Override http request option.
|
|
13508
|
+
* @throws {RequiredError}
|
|
13509
|
+
*/
|
|
13510
|
+
patchAddQuantityToStock: function (sku, quantity, options) {
|
|
13511
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
13512
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
13513
|
+
var _a, _b, _c;
|
|
13514
|
+
return __generator(this, function (_d) {
|
|
13515
|
+
switch (_d.label) {
|
|
13516
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchAddQuantityToStock(sku, quantity, options)];
|
|
13517
|
+
case 1:
|
|
13518
|
+
localVarAxiosArgs = _d.sent();
|
|
13519
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
13520
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.patchAddQuantityToStock']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
13521
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
13522
|
+
}
|
|
13523
|
+
});
|
|
13524
|
+
});
|
|
13525
|
+
},
|
|
13275
13526
|
/**
|
|
13276
13527
|
* Get Product
|
|
13277
13528
|
* @summary Get Product
|
|
@@ -13399,6 +13650,17 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
13399
13650
|
getSearchProducts: function (pageSize, page, search, options) {
|
|
13400
13651
|
return localVarFp.getSearchProducts(pageSize, page, search, options).then(function (request) { return request(axios, basePath); });
|
|
13401
13652
|
},
|
|
13653
|
+
/**
|
|
13654
|
+
* Add Item Quantity To Stock
|
|
13655
|
+
* @summary Add Item Quantity To Stock
|
|
13656
|
+
* @param {string} sku Product SKU
|
|
13657
|
+
* @param {number} quantity Quantity
|
|
13658
|
+
* @param {*} [options] Override http request option.
|
|
13659
|
+
* @throws {RequiredError}
|
|
13660
|
+
*/
|
|
13661
|
+
patchAddQuantityToStock: function (sku, quantity, options) {
|
|
13662
|
+
return localVarFp.patchAddQuantityToStock(sku, quantity, options).then(function (request) { return request(axios, basePath); });
|
|
13663
|
+
},
|
|
13402
13664
|
/**
|
|
13403
13665
|
* Get Product
|
|
13404
13666
|
* @summary Get Product
|
|
@@ -13518,6 +13780,19 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
13518
13780
|
var _this = this;
|
|
13519
13781
|
return (0, exports.ProductsApiFp)(this.configuration).getSearchProducts(pageSize, page, search, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
13520
13782
|
};
|
|
13783
|
+
/**
|
|
13784
|
+
* Add Item Quantity To Stock
|
|
13785
|
+
* @summary Add Item Quantity To Stock
|
|
13786
|
+
* @param {string} sku Product SKU
|
|
13787
|
+
* @param {number} quantity Quantity
|
|
13788
|
+
* @param {*} [options] Override http request option.
|
|
13789
|
+
* @throws {RequiredError}
|
|
13790
|
+
* @memberof ProductsApi
|
|
13791
|
+
*/
|
|
13792
|
+
ProductsApi.prototype.patchAddQuantityToStock = function (sku, quantity, options) {
|
|
13793
|
+
var _this = this;
|
|
13794
|
+
return (0, exports.ProductsApiFp)(this.configuration).patchAddQuantityToStock(sku, quantity, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
13795
|
+
};
|
|
13521
13796
|
/**
|
|
13522
13797
|
* Get Product
|
|
13523
13798
|
* @summary Get Product
|
package/docs/OrdersApi.md
CHANGED
|
@@ -14,6 +14,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
14
14
|
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
15
15
|
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
16
16
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
17
|
+
|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
|
|
17
18
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
18
19
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
19
20
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
@@ -26,6 +27,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
26
27
|
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
27
28
|
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
28
29
|
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
30
|
+
|[**putDeleteBatch**](#putdeletebatch) | **PUT** /admin/orders/{id}/batches/{batch_id} | Update Batch Item (Admin)|
|
|
29
31
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
30
32
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
31
33
|
|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
|
|
@@ -601,6 +603,60 @@ No authorization required
|
|
|
601
603
|
|
|
602
604
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
603
605
|
|
|
606
|
+
# **patchCompleteOrder**
|
|
607
|
+
> OrderDetailsDTO patchCompleteOrder()
|
|
608
|
+
|
|
609
|
+
Mark Order As Complete (Admin)
|
|
610
|
+
|
|
611
|
+
### Example
|
|
612
|
+
|
|
613
|
+
```typescript
|
|
614
|
+
import {
|
|
615
|
+
OrdersApi,
|
|
616
|
+
Configuration
|
|
617
|
+
} from 'yellowgrid-api-ts';
|
|
618
|
+
|
|
619
|
+
const configuration = new Configuration();
|
|
620
|
+
const apiInstance = new OrdersApi(configuration);
|
|
621
|
+
|
|
622
|
+
let id: number; //Order ID (default to undefined)
|
|
623
|
+
|
|
624
|
+
const { status, data } = await apiInstance.patchCompleteOrder(
|
|
625
|
+
id
|
|
626
|
+
);
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
### Parameters
|
|
630
|
+
|
|
631
|
+
|Name | Type | Description | Notes|
|
|
632
|
+
|------------- | ------------- | ------------- | -------------|
|
|
633
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
### Return type
|
|
637
|
+
|
|
638
|
+
**OrderDetailsDTO**
|
|
639
|
+
|
|
640
|
+
### Authorization
|
|
641
|
+
|
|
642
|
+
No authorization required
|
|
643
|
+
|
|
644
|
+
### HTTP request headers
|
|
645
|
+
|
|
646
|
+
- **Content-Type**: Not defined
|
|
647
|
+
- **Accept**: application/json
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
### HTTP response details
|
|
651
|
+
| Status code | Description | Response headers |
|
|
652
|
+
|-------------|-------------|------------------|
|
|
653
|
+
|**200** | Order Details | - |
|
|
654
|
+
|**400** | Bad Request | - |
|
|
655
|
+
|**401** | Unauthorised | - |
|
|
656
|
+
|**403** | Access Denied | - |
|
|
657
|
+
|
|
658
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
659
|
+
|
|
604
660
|
# **postAddOrderNote**
|
|
605
661
|
> AuditLogEntity postAddOrderNote()
|
|
606
662
|
|
|
@@ -1311,6 +1367,70 @@ No authorization required
|
|
|
1311
1367
|
|
|
1312
1368
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1313
1369
|
|
|
1370
|
+
# **putDeleteBatch**
|
|
1371
|
+
> OrderedItemModel putDeleteBatch()
|
|
1372
|
+
|
|
1373
|
+
Update Batch Item (Admin)
|
|
1374
|
+
|
|
1375
|
+
### Example
|
|
1376
|
+
|
|
1377
|
+
```typescript
|
|
1378
|
+
import {
|
|
1379
|
+
OrdersApi,
|
|
1380
|
+
Configuration,
|
|
1381
|
+
OrderedItemModel
|
|
1382
|
+
} from 'yellowgrid-api-ts';
|
|
1383
|
+
|
|
1384
|
+
const configuration = new Configuration();
|
|
1385
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1386
|
+
|
|
1387
|
+
let id: number; //Order ID (default to undefined)
|
|
1388
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1389
|
+
let itemId: number; //Ordered Item ID (default to undefined)
|
|
1390
|
+
let orderedItemModel: OrderedItemModel; //Batch Item (optional)
|
|
1391
|
+
|
|
1392
|
+
const { status, data } = await apiInstance.putDeleteBatch(
|
|
1393
|
+
id,
|
|
1394
|
+
batchId,
|
|
1395
|
+
itemId,
|
|
1396
|
+
orderedItemModel
|
|
1397
|
+
);
|
|
1398
|
+
```
|
|
1399
|
+
|
|
1400
|
+
### Parameters
|
|
1401
|
+
|
|
1402
|
+
|Name | Type | Description | Notes|
|
|
1403
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1404
|
+
| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
|
|
1405
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1406
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1407
|
+
| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
### Return type
|
|
1411
|
+
|
|
1412
|
+
**OrderedItemModel**
|
|
1413
|
+
|
|
1414
|
+
### Authorization
|
|
1415
|
+
|
|
1416
|
+
No authorization required
|
|
1417
|
+
|
|
1418
|
+
### HTTP request headers
|
|
1419
|
+
|
|
1420
|
+
- **Content-Type**: application/json
|
|
1421
|
+
- **Accept**: application/json
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
### HTTP response details
|
|
1425
|
+
| Status code | Description | Response headers |
|
|
1426
|
+
|-------------|-------------|------------------|
|
|
1427
|
+
|**200** | Ordered Item | - |
|
|
1428
|
+
|**400** | Bad Request | - |
|
|
1429
|
+
|**401** | Unauthorised | - |
|
|
1430
|
+
|**403** | Access Denied | - |
|
|
1431
|
+
|
|
1432
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1433
|
+
|
|
1314
1434
|
# **putUpdateAdminOrder**
|
|
1315
1435
|
> Array<OrderSummaryDTO> putUpdateAdminOrder()
|
|
1316
1436
|
|
package/docs/ProductsApi.md
CHANGED
|
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
11
11
|
|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
|
|
12
12
|
|[**getGetTcxTemplates**](#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates|
|
|
13
13
|
|[**getSearchProducts**](#getsearchproducts) | **GET** /products/search | Search Products|
|
|
14
|
+
|[**patchAddQuantityToStock**](#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock|
|
|
14
15
|
|[**postGetProduct**](#postgetproduct) | **POST** /products/{sku} | Get Product|
|
|
15
16
|
|[**postGetProductForCustomer**](#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer|
|
|
16
17
|
|
|
@@ -363,6 +364,63 @@ No authorization required
|
|
|
363
364
|
|
|
364
365
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
365
366
|
|
|
367
|
+
# **patchAddQuantityToStock**
|
|
368
|
+
> patchAddQuantityToStock()
|
|
369
|
+
|
|
370
|
+
Add Item Quantity To Stock
|
|
371
|
+
|
|
372
|
+
### Example
|
|
373
|
+
|
|
374
|
+
```typescript
|
|
375
|
+
import {
|
|
376
|
+
ProductsApi,
|
|
377
|
+
Configuration
|
|
378
|
+
} from 'yellowgrid-api-ts';
|
|
379
|
+
|
|
380
|
+
const configuration = new Configuration();
|
|
381
|
+
const apiInstance = new ProductsApi(configuration);
|
|
382
|
+
|
|
383
|
+
let sku: string; //Product SKU (default to undefined)
|
|
384
|
+
let quantity: number; //Quantity (default to undefined)
|
|
385
|
+
|
|
386
|
+
const { status, data } = await apiInstance.patchAddQuantityToStock(
|
|
387
|
+
sku,
|
|
388
|
+
quantity
|
|
389
|
+
);
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
|
|
394
|
+
|Name | Type | Description | Notes|
|
|
395
|
+
|------------- | ------------- | ------------- | -------------|
|
|
396
|
+
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
397
|
+
| **quantity** | [**number**] | Quantity | defaults to undefined|
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
### Return type
|
|
401
|
+
|
|
402
|
+
void (empty response body)
|
|
403
|
+
|
|
404
|
+
### Authorization
|
|
405
|
+
|
|
406
|
+
No authorization required
|
|
407
|
+
|
|
408
|
+
### HTTP request headers
|
|
409
|
+
|
|
410
|
+
- **Content-Type**: Not defined
|
|
411
|
+
- **Accept**: Not defined
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
### HTTP response details
|
|
415
|
+
| Status code | Description | Response headers |
|
|
416
|
+
|-------------|-------------|------------------|
|
|
417
|
+
|**200** | No Response | - |
|
|
418
|
+
|**400** | Bad Request | - |
|
|
419
|
+
|**401** | Unauthorised | - |
|
|
420
|
+
|**403** | Access Denied | - |
|
|
421
|
+
|
|
422
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
423
|
+
|
|
366
424
|
# **postGetProduct**
|
|
367
425
|
> ProductSummaryDTO postGetProduct(postGetProductRequest)
|
|
368
426
|
|