yellowgrid-api-ts 3.2.80-dev.0 → 3.2.83-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.
Files changed (6) hide show
  1. package/README.md +1 -1
  2. package/api.ts +76 -90
  3. package/dist/api.d.ts +37 -45
  4. package/dist/api.js +89 -103
  5. package/docs/OrdersApi.md +58 -64
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -158,6 +158,7 @@ Class | Method | HTTP request | Description
158
158
  *OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
159
159
  *OrdersApi* | [**getGetAdminOrderDetails**](docs/OrdersApi.md#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)
160
160
  *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)
161
+ *OrdersApi* | [**getGetItemSerialInfo**](docs/OrdersApi.md#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
161
162
  *OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
162
163
  *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
163
164
  *OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
@@ -165,7 +166,6 @@ Class | Method | HTTP request | Description
165
166
  *OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
166
167
  *OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
167
168
  *OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
168
- *OrdersApi* | [**postGetShipmentItemSerialInfo**](docs/OrdersApi.md#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)
169
169
  *OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
170
170
  *OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
171
171
  *OrdersApi* | [**postSendOrderEmail**](docs/OrdersApi.md#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email
package/api.ts CHANGED
@@ -20029,6 +20029,44 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
20029
20029
 
20030
20030
 
20031
20031
 
20032
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20033
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20034
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20035
+
20036
+ return {
20037
+ url: toPathString(localVarUrlObj),
20038
+ options: localVarRequestOptions,
20039
+ };
20040
+ },
20041
+ /**
20042
+ * Get Item Serial Info (Admin)
20043
+ * @summary Get Item Serial Info (Admin)
20044
+ * @param {number} id Order ID
20045
+ * @param {number} itemId Shipment Item ID
20046
+ * @param {*} [options] Override http request option.
20047
+ * @throws {RequiredError}
20048
+ */
20049
+ getGetItemSerialInfo: async (id: number, itemId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20050
+ // verify required parameter 'id' is not null or undefined
20051
+ assertParamExists('getGetItemSerialInfo', 'id', id)
20052
+ // verify required parameter 'itemId' is not null or undefined
20053
+ assertParamExists('getGetItemSerialInfo', 'itemId', itemId)
20054
+ const localVarPath = `/admin/orders/{id}/items/{item_id}/info`
20055
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
20056
+ .replace(`{${"item_id"}}`, encodeURIComponent(String(itemId)));
20057
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20058
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20059
+ let baseOptions;
20060
+ if (configuration) {
20061
+ baseOptions = configuration.baseOptions;
20062
+ }
20063
+
20064
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20065
+ const localVarHeaderParameter = {} as any;
20066
+ const localVarQueryParameter = {} as any;
20067
+
20068
+
20069
+
20032
20070
  setSearchParams(localVarUrlObj, localVarQueryParameter);
20033
20071
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20034
20072
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -20337,52 +20375,6 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
20337
20375
  options: localVarRequestOptions,
20338
20376
  };
20339
20377
  },
20340
- /**
20341
- * Get Shipment Item Serial Info (Admin)
20342
- * @summary Get Shipment Item Serial Info (Admin)
20343
- * @param {number} id Order ID
20344
- * @param {number} batchId Batch ID
20345
- * @param {number} shipmentId Shipment ID
20346
- * @param {number} itemId Shipment Item ID
20347
- * @param {*} [options] Override http request option.
20348
- * @throws {RequiredError}
20349
- */
20350
- postGetShipmentItemSerialInfo: async (id: number, batchId: number, shipmentId: number, itemId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20351
- // verify required parameter 'id' is not null or undefined
20352
- assertParamExists('postGetShipmentItemSerialInfo', 'id', id)
20353
- // verify required parameter 'batchId' is not null or undefined
20354
- assertParamExists('postGetShipmentItemSerialInfo', 'batchId', batchId)
20355
- // verify required parameter 'shipmentId' is not null or undefined
20356
- assertParamExists('postGetShipmentItemSerialInfo', 'shipmentId', shipmentId)
20357
- // verify required parameter 'itemId' is not null or undefined
20358
- assertParamExists('postGetShipmentItemSerialInfo', 'itemId', itemId)
20359
- const localVarPath = `/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info`
20360
- .replace(`{${"id"}}`, encodeURIComponent(String(id)))
20361
- .replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
20362
- .replace(`{${"shipment_id"}}`, encodeURIComponent(String(shipmentId)))
20363
- .replace(`{${"item_id"}}`, encodeURIComponent(String(itemId)));
20364
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
20365
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20366
- let baseOptions;
20367
- if (configuration) {
20368
- baseOptions = configuration.baseOptions;
20369
- }
20370
-
20371
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
20372
- const localVarHeaderParameter = {} as any;
20373
- const localVarQueryParameter = {} as any;
20374
-
20375
-
20376
-
20377
- setSearchParams(localVarUrlObj, localVarQueryParameter);
20378
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20379
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20380
-
20381
- return {
20382
- url: toPathString(localVarUrlObj),
20383
- options: localVarRequestOptions,
20384
- };
20385
- },
20386
20378
  /**
20387
20379
  * Issue Credit (Admin)
20388
20380
  * @summary Issue Credit (Admin)
@@ -20899,6 +20891,20 @@ export const OrdersApiFp = function(configuration?: Configuration) {
20899
20891
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetEditableOrder']?.[localVarOperationServerIndex]?.url;
20900
20892
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
20901
20893
  },
20894
+ /**
20895
+ * Get Item Serial Info (Admin)
20896
+ * @summary Get Item Serial Info (Admin)
20897
+ * @param {number} id Order ID
20898
+ * @param {number} itemId Shipment Item ID
20899
+ * @param {*} [options] Override http request option.
20900
+ * @throws {RequiredError}
20901
+ */
20902
+ async getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>> {
20903
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetItemSerialInfo(id, itemId, options);
20904
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
20905
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetItemSerialInfo']?.[localVarOperationServerIndex]?.url;
20906
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
20907
+ },
20902
20908
  /**
20903
20909
  * Download Order PDF
20904
20910
  * @summary Download Order PDF
@@ -21003,22 +21009,6 @@ export const OrdersApiFp = function(configuration?: Configuration) {
21003
21009
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetOrders']?.[localVarOperationServerIndex]?.url;
21004
21010
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21005
21011
  },
21006
- /**
21007
- * Get Shipment Item Serial Info (Admin)
21008
- * @summary Get Shipment Item Serial Info (Admin)
21009
- * @param {number} id Order ID
21010
- * @param {number} batchId Batch ID
21011
- * @param {number} shipmentId Shipment ID
21012
- * @param {number} itemId Shipment Item ID
21013
- * @param {*} [options] Override http request option.
21014
- * @throws {RequiredError}
21015
- */
21016
- async postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>> {
21017
- const localVarAxiosArgs = await localVarAxiosParamCreator.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options);
21018
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21019
- const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetShipmentItemSerialInfo']?.[localVarOperationServerIndex]?.url;
21020
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21021
- },
21022
21012
  /**
21023
21013
  * Issue Credit (Admin)
21024
21014
  * @summary Issue Credit (Admin)
@@ -21239,6 +21229,17 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
21239
21229
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO> {
21240
21230
  return localVarFp.getGetEditableOrder(id, options).then((request) => request(axios, basePath));
21241
21231
  },
21232
+ /**
21233
+ * Get Item Serial Info (Admin)
21234
+ * @summary Get Item Serial Info (Admin)
21235
+ * @param {number} id Order ID
21236
+ * @param {number} itemId Shipment Item ID
21237
+ * @param {*} [options] Override http request option.
21238
+ * @throws {RequiredError}
21239
+ */
21240
+ getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel> {
21241
+ return localVarFp.getGetItemSerialInfo(id, itemId, options).then((request) => request(axios, basePath));
21242
+ },
21242
21243
  /**
21243
21244
  * Download Order PDF
21244
21245
  * @summary Download Order PDF
@@ -21322,19 +21323,6 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
21322
21323
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>> {
21323
21324
  return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(axios, basePath));
21324
21325
  },
21325
- /**
21326
- * Get Shipment Item Serial Info (Admin)
21327
- * @summary Get Shipment Item Serial Info (Admin)
21328
- * @param {number} id Order ID
21329
- * @param {number} batchId Batch ID
21330
- * @param {number} shipmentId Shipment ID
21331
- * @param {number} itemId Shipment Item ID
21332
- * @param {*} [options] Override http request option.
21333
- * @throws {RequiredError}
21334
- */
21335
- postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel> {
21336
- return localVarFp.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then((request) => request(axios, basePath));
21337
- },
21338
21326
  /**
21339
21327
  * Issue Credit (Admin)
21340
21328
  * @summary Issue Credit (Admin)
@@ -21537,6 +21525,19 @@ export class OrdersApi extends BaseAPI {
21537
21525
  return OrdersApiFp(this.configuration).getGetEditableOrder(id, options).then((request) => request(this.axios, this.basePath));
21538
21526
  }
21539
21527
 
21528
+ /**
21529
+ * Get Item Serial Info (Admin)
21530
+ * @summary Get Item Serial Info (Admin)
21531
+ * @param {number} id Order ID
21532
+ * @param {number} itemId Shipment Item ID
21533
+ * @param {*} [options] Override http request option.
21534
+ * @throws {RequiredError}
21535
+ * @memberof OrdersApi
21536
+ */
21537
+ public getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig) {
21538
+ return OrdersApiFp(this.configuration).getGetItemSerialInfo(id, itemId, options).then((request) => request(this.axios, this.basePath));
21539
+ }
21540
+
21540
21541
  /**
21541
21542
  * Download Order PDF
21542
21543
  * @summary Download Order PDF
@@ -21634,21 +21635,6 @@ export class OrdersApi extends BaseAPI {
21634
21635
  return OrdersApiFp(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(this.axios, this.basePath));
21635
21636
  }
21636
21637
 
21637
- /**
21638
- * Get Shipment Item Serial Info (Admin)
21639
- * @summary Get Shipment Item Serial Info (Admin)
21640
- * @param {number} id Order ID
21641
- * @param {number} batchId Batch ID
21642
- * @param {number} shipmentId Shipment ID
21643
- * @param {number} itemId Shipment Item ID
21644
- * @param {*} [options] Override http request option.
21645
- * @throws {RequiredError}
21646
- * @memberof OrdersApi
21647
- */
21648
- public postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig) {
21649
- return OrdersApiFp(this.configuration).postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then((request) => request(this.axios, this.basePath));
21650
- }
21651
-
21652
21638
  /**
21653
21639
  * Issue Credit (Admin)
21654
21640
  * @summary Issue Credit (Admin)
package/dist/api.d.ts CHANGED
@@ -15545,6 +15545,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
15545
15545
  * @throws {RequiredError}
15546
15546
  */
15547
15547
  getGetEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15548
+ /**
15549
+ * Get Item Serial Info (Admin)
15550
+ * @summary Get Item Serial Info (Admin)
15551
+ * @param {number} id Order ID
15552
+ * @param {number} itemId Shipment Item ID
15553
+ * @param {*} [options] Override http request option.
15554
+ * @throws {RequiredError}
15555
+ */
15556
+ getGetItemSerialInfo: (id: number, itemId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15548
15557
  /**
15549
15558
  * Download Order PDF
15550
15559
  * @summary Download Order PDF
@@ -15614,17 +15623,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
15614
15623
  * @throws {RequiredError}
15615
15624
  */
15616
15625
  postGetOrders: (readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15617
- /**
15618
- * Get Shipment Item Serial Info (Admin)
15619
- * @summary Get Shipment Item Serial Info (Admin)
15620
- * @param {number} id Order ID
15621
- * @param {number} batchId Batch ID
15622
- * @param {number} shipmentId Shipment ID
15623
- * @param {number} itemId Shipment Item ID
15624
- * @param {*} [options] Override http request option.
15625
- * @throws {RequiredError}
15626
- */
15627
- postGetShipmentItemSerialInfo: (id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15628
15626
  /**
15629
15627
  * Issue Credit (Admin)
15630
15628
  * @summary Issue Credit (Admin)
@@ -15779,6 +15777,15 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
15779
15777
  * @throws {RequiredError}
15780
15778
  */
15781
15779
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>>;
15780
+ /**
15781
+ * Get Item Serial Info (Admin)
15782
+ * @summary Get Item Serial Info (Admin)
15783
+ * @param {number} id Order ID
15784
+ * @param {number} itemId Shipment Item ID
15785
+ * @param {*} [options] Override http request option.
15786
+ * @throws {RequiredError}
15787
+ */
15788
+ getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>>;
15782
15789
  /**
15783
15790
  * Download Order PDF
15784
15791
  * @summary Download Order PDF
@@ -15848,17 +15855,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
15848
15855
  * @throws {RequiredError}
15849
15856
  */
15850
15857
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
15851
- /**
15852
- * Get Shipment Item Serial Info (Admin)
15853
- * @summary Get Shipment Item Serial Info (Admin)
15854
- * @param {number} id Order ID
15855
- * @param {number} batchId Batch ID
15856
- * @param {number} shipmentId Shipment ID
15857
- * @param {number} itemId Shipment Item ID
15858
- * @param {*} [options] Override http request option.
15859
- * @throws {RequiredError}
15860
- */
15861
- postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>>;
15862
15858
  /**
15863
15859
  * Issue Credit (Admin)
15864
15860
  * @summary Issue Credit (Admin)
@@ -16013,6 +16009,15 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
16013
16009
  * @throws {RequiredError}
16014
16010
  */
16015
16011
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO>;
16012
+ /**
16013
+ * Get Item Serial Info (Admin)
16014
+ * @summary Get Item Serial Info (Admin)
16015
+ * @param {number} id Order ID
16016
+ * @param {number} itemId Shipment Item ID
16017
+ * @param {*} [options] Override http request option.
16018
+ * @throws {RequiredError}
16019
+ */
16020
+ getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel>;
16016
16021
  /**
16017
16022
  * Download Order PDF
16018
16023
  * @summary Download Order PDF
@@ -16082,17 +16087,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
16082
16087
  * @throws {RequiredError}
16083
16088
  */
16084
16089
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
16085
- /**
16086
- * Get Shipment Item Serial Info (Admin)
16087
- * @summary Get Shipment Item Serial Info (Admin)
16088
- * @param {number} id Order ID
16089
- * @param {number} batchId Batch ID
16090
- * @param {number} shipmentId Shipment ID
16091
- * @param {number} itemId Shipment Item ID
16092
- * @param {*} [options] Override http request option.
16093
- * @throws {RequiredError}
16094
- */
16095
- postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel>;
16096
16090
  /**
16097
16091
  * Issue Credit (Admin)
16098
16092
  * @summary Issue Credit (Admin)
@@ -16255,6 +16249,16 @@ export declare class OrdersApi extends BaseAPI {
16255
16249
  * @memberof OrdersApi
16256
16250
  */
16257
16251
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetailedOrderRequestDTO, any, {}>>;
16252
+ /**
16253
+ * Get Item Serial Info (Admin)
16254
+ * @summary Get Item Serial Info (Admin)
16255
+ * @param {number} id Order ID
16256
+ * @param {number} itemId Shipment Item ID
16257
+ * @param {*} [options] Override http request option.
16258
+ * @throws {RequiredError}
16259
+ * @memberof OrdersApi
16260
+ */
16261
+ getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSerialInfoModel, any, {}>>;
16258
16262
  /**
16259
16263
  * Download Order PDF
16260
16264
  * @summary Download Order PDF
@@ -16331,18 +16335,6 @@ export declare class OrdersApi extends BaseAPI {
16331
16335
  * @memberof OrdersApi
16332
16336
  */
16333
16337
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
16334
- /**
16335
- * Get Shipment Item Serial Info (Admin)
16336
- * @summary Get Shipment Item Serial Info (Admin)
16337
- * @param {number} id Order ID
16338
- * @param {number} batchId Batch ID
16339
- * @param {number} shipmentId Shipment ID
16340
- * @param {number} itemId Shipment Item ID
16341
- * @param {*} [options] Override http request option.
16342
- * @throws {RequiredError}
16343
- * @memberof OrdersApi
16344
- */
16345
- postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSerialInfoModel, any, {}>>;
16346
16338
  /**
16347
16339
  * Issue Credit (Admin)
16348
16340
  * @summary Issue Credit (Admin)
package/dist/api.js CHANGED
@@ -10083,6 +10083,47 @@ var OrdersApiAxiosParamCreator = function (configuration) {
10083
10083
  });
10084
10084
  });
10085
10085
  },
10086
+ /**
10087
+ * Get Item Serial Info (Admin)
10088
+ * @summary Get Item Serial Info (Admin)
10089
+ * @param {number} id Order ID
10090
+ * @param {number} itemId Shipment Item ID
10091
+ * @param {*} [options] Override http request option.
10092
+ * @throws {RequiredError}
10093
+ */
10094
+ getGetItemSerialInfo: function (id_1, itemId_1) {
10095
+ var args_1 = [];
10096
+ for (var _i = 2; _i < arguments.length; _i++) {
10097
+ args_1[_i - 2] = arguments[_i];
10098
+ }
10099
+ return __awaiter(_this, __spreadArray([id_1, itemId_1], args_1, true), void 0, function (id, itemId, options) {
10100
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
10101
+ if (options === void 0) { options = {}; }
10102
+ return __generator(this, function (_a) {
10103
+ // verify required parameter 'id' is not null or undefined
10104
+ (0, common_1.assertParamExists)('getGetItemSerialInfo', 'id', id);
10105
+ // verify required parameter 'itemId' is not null or undefined
10106
+ (0, common_1.assertParamExists)('getGetItemSerialInfo', 'itemId', itemId);
10107
+ localVarPath = "/admin/orders/{id}/items/{item_id}/info"
10108
+ .replace("{".concat("id", "}"), encodeURIComponent(String(id)))
10109
+ .replace("{".concat("item_id", "}"), encodeURIComponent(String(itemId)));
10110
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
10111
+ if (configuration) {
10112
+ baseOptions = configuration.baseOptions;
10113
+ }
10114
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
10115
+ localVarHeaderParameter = {};
10116
+ localVarQueryParameter = {};
10117
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
10118
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10119
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10120
+ return [2 /*return*/, {
10121
+ url: (0, common_1.toPathString)(localVarUrlObj),
10122
+ options: localVarRequestOptions,
10123
+ }];
10124
+ });
10125
+ });
10126
+ },
10086
10127
  /**
10087
10128
  * Download Order PDF
10088
10129
  * @summary Download Order PDF
@@ -10389,55 +10430,6 @@ var OrdersApiAxiosParamCreator = function (configuration) {
10389
10430
  });
10390
10431
  });
10391
10432
  },
10392
- /**
10393
- * Get Shipment Item Serial Info (Admin)
10394
- * @summary Get Shipment Item Serial Info (Admin)
10395
- * @param {number} id Order ID
10396
- * @param {number} batchId Batch ID
10397
- * @param {number} shipmentId Shipment ID
10398
- * @param {number} itemId Shipment Item ID
10399
- * @param {*} [options] Override http request option.
10400
- * @throws {RequiredError}
10401
- */
10402
- postGetShipmentItemSerialInfo: function (id_1, batchId_1, shipmentId_1, itemId_1) {
10403
- var args_1 = [];
10404
- for (var _i = 4; _i < arguments.length; _i++) {
10405
- args_1[_i - 4] = arguments[_i];
10406
- }
10407
- return __awaiter(_this, __spreadArray([id_1, batchId_1, shipmentId_1, itemId_1], args_1, true), void 0, function (id, batchId, shipmentId, itemId, options) {
10408
- var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
10409
- if (options === void 0) { options = {}; }
10410
- return __generator(this, function (_a) {
10411
- // verify required parameter 'id' is not null or undefined
10412
- (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'id', id);
10413
- // verify required parameter 'batchId' is not null or undefined
10414
- (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'batchId', batchId);
10415
- // verify required parameter 'shipmentId' is not null or undefined
10416
- (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'shipmentId', shipmentId);
10417
- // verify required parameter 'itemId' is not null or undefined
10418
- (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'itemId', itemId);
10419
- localVarPath = "/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info"
10420
- .replace("{".concat("id", "}"), encodeURIComponent(String(id)))
10421
- .replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
10422
- .replace("{".concat("shipment_id", "}"), encodeURIComponent(String(shipmentId)))
10423
- .replace("{".concat("item_id", "}"), encodeURIComponent(String(itemId)));
10424
- localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
10425
- if (configuration) {
10426
- baseOptions = configuration.baseOptions;
10427
- }
10428
- localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
10429
- localVarHeaderParameter = {};
10430
- localVarQueryParameter = {};
10431
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
10432
- headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10433
- localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10434
- return [2 /*return*/, {
10435
- url: (0, common_1.toPathString)(localVarUrlObj),
10436
- options: localVarRequestOptions,
10437
- }];
10438
- });
10439
- });
10440
- },
10441
10433
  /**
10442
10434
  * Issue Credit (Admin)
10443
10435
  * @summary Issue Credit (Admin)
@@ -11032,6 +11024,30 @@ var OrdersApiFp = function (configuration) {
11032
11024
  });
11033
11025
  });
11034
11026
  },
11027
+ /**
11028
+ * Get Item Serial Info (Admin)
11029
+ * @summary Get Item Serial Info (Admin)
11030
+ * @param {number} id Order ID
11031
+ * @param {number} itemId Shipment Item ID
11032
+ * @param {*} [options] Override http request option.
11033
+ * @throws {RequiredError}
11034
+ */
11035
+ getGetItemSerialInfo: function (id, itemId, options) {
11036
+ return __awaiter(this, void 0, void 0, function () {
11037
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
11038
+ var _a, _b, _c;
11039
+ return __generator(this, function (_d) {
11040
+ switch (_d.label) {
11041
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetItemSerialInfo(id, itemId, options)];
11042
+ case 1:
11043
+ localVarAxiosArgs = _d.sent();
11044
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11045
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getGetItemSerialInfo']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11046
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
11047
+ }
11048
+ });
11049
+ });
11050
+ },
11035
11051
  /**
11036
11052
  * Download Order PDF
11037
11053
  * @summary Download Order PDF
@@ -11206,32 +11222,6 @@ var OrdersApiFp = function (configuration) {
11206
11222
  });
11207
11223
  });
11208
11224
  },
11209
- /**
11210
- * Get Shipment Item Serial Info (Admin)
11211
- * @summary Get Shipment Item Serial Info (Admin)
11212
- * @param {number} id Order ID
11213
- * @param {number} batchId Batch ID
11214
- * @param {number} shipmentId Shipment ID
11215
- * @param {number} itemId Shipment Item ID
11216
- * @param {*} [options] Override http request option.
11217
- * @throws {RequiredError}
11218
- */
11219
- postGetShipmentItemSerialInfo: function (id, batchId, shipmentId, itemId, options) {
11220
- return __awaiter(this, void 0, void 0, function () {
11221
- var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
11222
- var _a, _b, _c;
11223
- return __generator(this, function (_d) {
11224
- switch (_d.label) {
11225
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options)];
11226
- case 1:
11227
- localVarAxiosArgs = _d.sent();
11228
- localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11229
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.postGetShipmentItemSerialInfo']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11230
- return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
11231
- }
11232
- });
11233
- });
11234
- },
11235
11225
  /**
11236
11226
  * Issue Credit (Admin)
11237
11227
  * @summary Issue Credit (Admin)
@@ -11552,6 +11542,17 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
11552
11542
  getGetEditableOrder: function (id, options) {
11553
11543
  return localVarFp.getGetEditableOrder(id, options).then(function (request) { return request(axios, basePath); });
11554
11544
  },
11545
+ /**
11546
+ * Get Item Serial Info (Admin)
11547
+ * @summary Get Item Serial Info (Admin)
11548
+ * @param {number} id Order ID
11549
+ * @param {number} itemId Shipment Item ID
11550
+ * @param {*} [options] Override http request option.
11551
+ * @throws {RequiredError}
11552
+ */
11553
+ getGetItemSerialInfo: function (id, itemId, options) {
11554
+ return localVarFp.getGetItemSerialInfo(id, itemId, options).then(function (request) { return request(axios, basePath); });
11555
+ },
11555
11556
  /**
11556
11557
  * Download Order PDF
11557
11558
  * @summary Download Order PDF
@@ -11635,19 +11636,6 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
11635
11636
  postGetOrders: function (readonly, customerOrderRequestDTO, options) {
11636
11637
  return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(axios, basePath); });
11637
11638
  },
11638
- /**
11639
- * Get Shipment Item Serial Info (Admin)
11640
- * @summary Get Shipment Item Serial Info (Admin)
11641
- * @param {number} id Order ID
11642
- * @param {number} batchId Batch ID
11643
- * @param {number} shipmentId Shipment ID
11644
- * @param {number} itemId Shipment Item ID
11645
- * @param {*} [options] Override http request option.
11646
- * @throws {RequiredError}
11647
- */
11648
- postGetShipmentItemSerialInfo: function (id, batchId, shipmentId, itemId, options) {
11649
- return localVarFp.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then(function (request) { return request(axios, basePath); });
11650
- },
11651
11639
  /**
11652
11640
  * Issue Credit (Admin)
11653
11641
  * @summary Issue Credit (Admin)
@@ -11854,6 +11842,19 @@ var OrdersApi = /** @class */ (function (_super) {
11854
11842
  var _this = this;
11855
11843
  return (0, exports.OrdersApiFp)(this.configuration).getGetEditableOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
11856
11844
  };
11845
+ /**
11846
+ * Get Item Serial Info (Admin)
11847
+ * @summary Get Item Serial Info (Admin)
11848
+ * @param {number} id Order ID
11849
+ * @param {number} itemId Shipment Item ID
11850
+ * @param {*} [options] Override http request option.
11851
+ * @throws {RequiredError}
11852
+ * @memberof OrdersApi
11853
+ */
11854
+ OrdersApi.prototype.getGetItemSerialInfo = function (id, itemId, options) {
11855
+ var _this = this;
11856
+ return (0, exports.OrdersApiFp)(this.configuration).getGetItemSerialInfo(id, itemId, options).then(function (request) { return request(_this.axios, _this.basePath); });
11857
+ };
11857
11858
  /**
11858
11859
  * Download Order PDF
11859
11860
  * @summary Download Order PDF
@@ -11951,21 +11952,6 @@ var OrdersApi = /** @class */ (function (_super) {
11951
11952
  var _this = this;
11952
11953
  return (0, exports.OrdersApiFp)(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
11953
11954
  };
11954
- /**
11955
- * Get Shipment Item Serial Info (Admin)
11956
- * @summary Get Shipment Item Serial Info (Admin)
11957
- * @param {number} id Order ID
11958
- * @param {number} batchId Batch ID
11959
- * @param {number} shipmentId Shipment ID
11960
- * @param {number} itemId Shipment Item ID
11961
- * @param {*} [options] Override http request option.
11962
- * @throws {RequiredError}
11963
- * @memberof OrdersApi
11964
- */
11965
- OrdersApi.prototype.postGetShipmentItemSerialInfo = function (id, batchId, shipmentId, itemId, options) {
11966
- var _this = this;
11967
- return (0, exports.OrdersApiFp)(this.configuration).postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then(function (request) { return request(_this.axios, _this.basePath); });
11968
- };
11969
11955
  /**
11970
11956
  * Issue Credit (Admin)
11971
11957
  * @summary Issue Credit (Admin)
package/docs/OrdersApi.md CHANGED
@@ -10,6 +10,7 @@ All URIs are relative to *https://api.yellowgrid.local*
10
10
  |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
11
11
  |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
12
12
  |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
13
+ |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
13
14
  |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
14
15
  |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
15
16
  |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
@@ -17,7 +18,6 @@ All URIs are relative to *https://api.yellowgrid.local*
17
18
  |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
18
19
  |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
19
20
  |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
20
- |[**postGetShipmentItemSerialInfo**](#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)|
21
21
  |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
22
22
  |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
23
23
  |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
@@ -362,6 +362,63 @@ No authorization required
362
362
 
363
363
  [[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)
364
364
 
365
+ # **getGetItemSerialInfo**
366
+ > ProductSerialInfoModel getGetItemSerialInfo()
367
+
368
+ Get Item Serial Info (Admin)
369
+
370
+ ### Example
371
+
372
+ ```typescript
373
+ import {
374
+ OrdersApi,
375
+ Configuration
376
+ } from 'yellowgrid-api-ts';
377
+
378
+ const configuration = new Configuration();
379
+ const apiInstance = new OrdersApi(configuration);
380
+
381
+ let id: number; //Order ID (default to undefined)
382
+ let itemId: number; //Shipment Item ID (default to undefined)
383
+
384
+ const { status, data } = await apiInstance.getGetItemSerialInfo(
385
+ id,
386
+ itemId
387
+ );
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ |Name | Type | Description | Notes|
393
+ |------------- | ------------- | ------------- | -------------|
394
+ | **id** | [**number**] | Order ID | defaults to undefined|
395
+ | **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
396
+
397
+
398
+ ### Return type
399
+
400
+ **ProductSerialInfoModel**
401
+
402
+ ### Authorization
403
+
404
+ No authorization required
405
+
406
+ ### HTTP request headers
407
+
408
+ - **Content-Type**: Not defined
409
+ - **Accept**: application/json
410
+
411
+
412
+ ### HTTP response details
413
+ | Status code | Description | Response headers |
414
+ |-------------|-------------|------------------|
415
+ |**200** | Serial Info | - |
416
+ |**400** | Bad Request | - |
417
+ |**401** | Unauthorised | - |
418
+ |**403** | Access Denied | - |
419
+
420
+ [[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)
421
+
365
422
  # **getGetOrderPdf**
366
423
  > File getGetOrderPdf()
367
424
 
@@ -784,69 +841,6 @@ No authorization required
784
841
 
785
842
  [[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)
786
843
 
787
- # **postGetShipmentItemSerialInfo**
788
- > ProductSerialInfoModel postGetShipmentItemSerialInfo()
789
-
790
- Get Shipment Item Serial Info (Admin)
791
-
792
- ### Example
793
-
794
- ```typescript
795
- import {
796
- OrdersApi,
797
- Configuration
798
- } from 'yellowgrid-api-ts';
799
-
800
- const configuration = new Configuration();
801
- const apiInstance = new OrdersApi(configuration);
802
-
803
- let id: number; //Order ID (default to undefined)
804
- let batchId: number; //Batch ID (default to undefined)
805
- let shipmentId: number; //Shipment ID (default to undefined)
806
- let itemId: number; //Shipment Item ID (default to undefined)
807
-
808
- const { status, data } = await apiInstance.postGetShipmentItemSerialInfo(
809
- id,
810
- batchId,
811
- shipmentId,
812
- itemId
813
- );
814
- ```
815
-
816
- ### Parameters
817
-
818
- |Name | Type | Description | Notes|
819
- |------------- | ------------- | ------------- | -------------|
820
- | **id** | [**number**] | Order ID | defaults to undefined|
821
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
822
- | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
823
- | **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
824
-
825
-
826
- ### Return type
827
-
828
- **ProductSerialInfoModel**
829
-
830
- ### Authorization
831
-
832
- No authorization required
833
-
834
- ### HTTP request headers
835
-
836
- - **Content-Type**: Not defined
837
- - **Accept**: application/json
838
-
839
-
840
- ### HTTP response details
841
- | Status code | Description | Response headers |
842
- |-------------|-------------|------------------|
843
- |**200** | Serial Info | - |
844
- |**400** | Bad Request | - |
845
- |**401** | Unauthorised | - |
846
- |**403** | Access Denied | - |
847
-
848
- [[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)
849
-
850
844
  # **postIssueCredit**
851
845
  > CreditNoteModel postIssueCredit()
852
846
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.80-dev.0",
3
+ "version": "3.2.83-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {