yellowgrid-api-ts 3.2.80 → 3.2.81

package/README.md

@@ -158,6 +158,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**deleteUpdateShipment**](docs/OrdersApi.md#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)
 *OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
 *OrdersApi* | [**getGetAdminOrderDetails**](docs/OrdersApi.md#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)
+*OrdersApi* | [**getGetCommercialInvoice**](docs/OrdersApi.md#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF
 *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)
 *OrdersApi* | [**getGetItemSerialInfo**](docs/OrdersApi.md#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
 *OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF

package/api.ts

@@ -16069,6 +16069,48 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Commercial Invoice PDF
+         * @summary Get Commercial Invoice PDF
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCommercialInvoice: async (id: number, batchId: number, shipmentId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetCommercialInvoice', 'id', id)
+            // verify required parameter 'batchId' is not null or undefined
+            assertParamExists('getGetCommercialInvoice', 'batchId', batchId)
+            // verify required parameter 'shipmentId' is not null or undefined
+            assertParamExists('getGetCommercialInvoice', 'shipmentId', shipmentId)
+            const localVarPath = `/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
+                .replace(`{${"shipment_id"}}`, encodeURIComponent(String(shipmentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/pdf';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get Editable Order (Beta)
          * @summary Get Editable Order (Beta)
@@ -17082,6 +17124,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetAdminOrderDetails']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Commercial Invoice PDF
+         * @summary Get Commercial Invoice PDF
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCommercialInvoice(id, batchId, shipmentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetCommercialInvoice']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Editable Order (Beta)
          * @summary Get Editable Order (Beta)
@@ -17478,6 +17535,18 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO> {
             return localVarFp.getGetAdminOrderDetails(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Commercial Invoice PDF
+         * @summary Get Commercial Invoice PDF
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.getGetCommercialInvoice(id, batchId, shipmentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Editable Order (Beta)
          * @summary Get Editable Order (Beta)
@@ -17808,6 +17877,19 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).getGetAdminOrderDetails(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Commercial Invoice PDF
+     * @summary Get Commercial Invoice PDF
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).getGetCommercialInvoice(id, batchId, shipmentId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Editable Order (Beta)
      * @summary Get Editable Order (Beta)

package/dist/api.d.ts

@@ -11630,6 +11630,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getGetAdminOrderDetails: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Commercial Invoice PDF
+     * @summary Get Commercial Invoice PDF
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCommercialInvoice: (id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Editable Order (Beta)
      * @summary Get Editable Order (Beta)
@@ -11897,6 +11907,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
+    /**
+     * Get Commercial Invoice PDF
+     * @summary Get Commercial Invoice PDF
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Get Editable Order (Beta)
      * @summary Get Editable Order (Beta)
@@ -12164,6 +12184,16 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
+    /**
+     * Get Commercial Invoice PDF
+     * @summary Get Commercial Invoice PDF
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      * Get Editable Order (Beta)
      * @summary Get Editable Order (Beta)
@@ -12431,6 +12461,16 @@ export declare class OrdersApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
+    /**
+     * Get Commercial Invoice PDF
+     * @summary Get Commercial Invoice PDF
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
     /**
      * Get Editable Order (Beta)
      * @summary Get Editable Order (Beta)

package/dist/api.js

@@ -10019,6 +10019,52 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Commercial Invoice PDF
+         * @summary Get Commercial Invoice PDF
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCommercialInvoice: function (id_1, batchId_1, shipmentId_1) {
+            var args_1 = [];
+            for (var _i = 3; _i < arguments.length; _i++) {
+                args_1[_i - 3] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1, batchId_1, shipmentId_1], args_1, true), void 0, function (id, batchId, shipmentId, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('getGetCommercialInvoice', 'id', id);
+                    // verify required parameter 'batchId' is not null or undefined
+                    (0, common_1.assertParamExists)('getGetCommercialInvoice', 'batchId', batchId);
+                    // verify required parameter 'shipmentId' is not null or undefined
+                    (0, common_1.assertParamExists)('getGetCommercialInvoice', 'shipmentId', shipmentId);
+                    localVarPath = "/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)))
+                        .replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
+                        .replace("{".concat("shipment_id", "}"), encodeURIComponent(String(shipmentId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Accept'] = 'application/pdf';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Get Editable Order (Beta)
          * @summary Get Editable Order (Beta)
@@ -11158,6 +11204,31 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Commercial Invoice PDF
+         * @summary Get Commercial Invoice PDF
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCommercialInvoice: function (id, batchId, shipmentId, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCommercialInvoice(id, batchId, shipmentId, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getGetCommercialInvoice']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Get Editable Order (Beta)
          * @summary Get Editable Order (Beta)
@@ -11784,6 +11855,18 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         getGetAdminOrderDetails: function (id, options) {
             return localVarFp.getGetAdminOrderDetails(id, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Commercial Invoice PDF
+         * @summary Get Commercial Invoice PDF
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCommercialInvoice: function (id, batchId, shipmentId, options) {
+            return localVarFp.getGetCommercialInvoice(id, batchId, shipmentId, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Editable Order (Beta)
          * @summary Get Editable Order (Beta)
@@ -12118,6 +12201,19 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).getGetAdminOrderDetails(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Commercial Invoice PDF
+     * @summary Get Commercial Invoice PDF
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    OrdersApi.prototype.getGetCommercialInvoice = function (id, batchId, shipmentId, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).getGetCommercialInvoice(id, batchId, shipmentId, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Editable Order (Beta)
      * @summary Get Editable Order (Beta)

package/docs/OrdersApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
+|[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
 |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
 |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
@@ -312,6 +313,66 @@ No authorization required
 
 [[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)
 
+# **getGetCommercialInvoice**
+> File getGetCommercialInvoice()
+
+Get Commercial Invoice PDF
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let batchId: number; //Batch ID (default to undefined)
+let shipmentId: number; //Shipment ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetCommercialInvoice(
+    id,
+    batchId,
+    shipmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order PDF |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **getGetEditableOrder**
 > DetailedOrderRequestDTO getGetEditableOrder()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.80",
+  "version": "3.2.81",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {