yellowgrid-api-ts 3.1.15-dev.0 → 3.1.16-dev.0

package/.openapi-generator/FILES

@@ -24,6 +24,7 @@ docs/ApiLogEntity.md
 docs/AreaCodeModel.md
 docs/AttachmentModel.md
 docs/AttributeSetEnum.md
+docs/AuditLogEntity.md
 docs/AuthCodeResponseModel.md
 docs/BasicItemDTO.md
 docs/BasicProductDTO.md

package/README.md

@@ -185,6 +185,7 @@ Class | Method | HTTP request | Description
 *SIPTrunksApi* | [**putGetAddress**](docs/SIPTrunksApi.md#putgetaddress) | **PUT** /sip/trunks/{id}/address | Update SIP Trunk Address
 *SIPTrunksApi* | [**putGetDiverts**](docs/SIPTrunksApi.md#putgetdiverts) | **PUT** /sip/trunks/{id}/diverts | Update SIP Trunk Diverts
 *SMSApi* | [**postSendSms**](docs/SMSApi.md#postsendsms) | **POST** /messaging/sms/send | 
+*ShippingApi* | [**postGetAdminShippingServices**](docs/ShippingApi.md#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services
 *ShippingApi* | [**postGetShippingServices**](docs/ShippingApi.md#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services
 *StockManagementApi* | [**deleteDeleteStockOrder**](docs/StockManagementApi.md#deletedeletestockorder) | **DELETE** /stock/orders/{id} | Delete Stock Order
 *StockManagementApi* | [**deleteDeleteStockOrderDeduction**](docs/StockManagementApi.md#deletedeletestockorderdeduction) | **DELETE** /stock/orders/{order_id}/deductions/{deduction_id} | Delete Stock Order Deduction
@@ -240,6 +241,7 @@ Class | Method | HTTP request | Description
  - [AreaCodeModel](docs/AreaCodeModel.md)
  - [AttachmentModel](docs/AttachmentModel.md)
  - [AttributeSetEnum](docs/AttributeSetEnum.md)
+ - [AuditLogEntity](docs/AuditLogEntity.md)
  - [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
  - [BasicItemDTO](docs/BasicItemDTO.md)
  - [BasicProductDTO](docs/BasicProductDTO.md)

package/api.ts

@@ -994,6 +994,67 @@ export interface AttributeSetEnum {
      */
     'name'?: string;
 }
+/**
+ * AuditLogEntity
+ * @export
+ * @interface AuditLogEntity
+ */
+export interface AuditLogEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof AuditLogEntity
+     */
+    'id'?: number;
+    /**
+     * action
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'action'?: string;
+    /**
+     * type
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'type'?: string;
+    /**
+     * identifier
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'identifier'?: string;
+    /**
+     * user
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'user'?: string;
+    /**
+     * timestamp
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'timestamp'?: string;
+    /**
+     * beforeData
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'beforeData'?: string;
+    /**
+     * afterData
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'afterData'?: string;
+    /**
+     * description
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'description'?: string;
+}
 /**
  * OAuth Auth Code Response
  * @export
@@ -20380,6 +20441,47 @@ export class SMSApi extends BaseAPI {
  */
 export const ShippingApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Get Shipping Services (Admin)
+         * @summary Get Shipping Services
+         * @param {number} customerId Customer ID
+         * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetAdminShippingServices: async (customerId: number, shippingInformationDTO?: ShippingInformationDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'customerId' is not null or undefined
+            assertParamExists('postGetAdminShippingServices', 'customerId', customerId)
+            const localVarPath = `/admin/shipping/services`;
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (customerId !== undefined) {
+                localVarQueryParameter['customerId'] = customerId;
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(shippingInformationDTO, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -20424,6 +20526,20 @@ export const ShippingApiAxiosParamCreator = function (configuration?: Configurat
 export const ShippingApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = ShippingApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Get Shipping Services (Admin)
+         * @summary Get Shipping Services
+         * @param {number} customerId Customer ID
+         * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShippingServicesModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetAdminShippingServices(customerId, shippingInformationDTO, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ShippingApi.postGetAdminShippingServices']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -20447,6 +20563,17 @@ export const ShippingApiFp = function(configuration?: Configuration) {
 export const ShippingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = ShippingApiFp(configuration)
     return {
+        /**
+         * Get Shipping Services (Admin)
+         * @summary Get Shipping Services
+         * @param {number} customerId Customer ID
+         * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShippingServicesModel> {
+            return localVarFp.postGetAdminShippingServices(customerId, shippingInformationDTO, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -20467,6 +20594,19 @@ export const ShippingApiFactory = function (configuration?: Configuration, baseP
  * @extends {BaseAPI}
  */
 export class ShippingApi extends BaseAPI {
+    /**
+     * Get Shipping Services (Admin)
+     * @summary Get Shipping Services
+     * @param {number} customerId Customer ID
+     * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShippingApi
+     */
+    public postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig) {
+        return ShippingApiFp(this.configuration).postGetAdminShippingServices(customerId, shippingInformationDTO, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Shipping Services
      * @summary Get Shipping Services

package/dist/api.d.ts

@@ -981,6 +981,67 @@ export interface AttributeSetEnum {
      */
     'name'?: string;
 }
+/**
+ * AuditLogEntity
+ * @export
+ * @interface AuditLogEntity
+ */
+export interface AuditLogEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof AuditLogEntity
+     */
+    'id'?: number;
+    /**
+     * action
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'action'?: string;
+    /**
+     * type
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'type'?: string;
+    /**
+     * identifier
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'identifier'?: string;
+    /**
+     * user
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'user'?: string;
+    /**
+     * timestamp
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'timestamp'?: string;
+    /**
+     * beforeData
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'beforeData'?: string;
+    /**
+     * afterData
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'afterData'?: string;
+    /**
+     * description
+     * @type {string}
+     * @memberof AuditLogEntity
+     */
+    'description'?: string;
+}
 /**
  * OAuth Auth Code Response
  * @export
@@ -14832,6 +14893,15 @@ export declare class SMSApi extends BaseAPI {
  * @export
  */
 export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get Shipping Services (Admin)
+     * @summary Get Shipping Services
+     * @param {number} customerId Customer ID
+     * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetAdminShippingServices: (customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services
@@ -14846,6 +14916,15 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const ShippingApiFp: (configuration?: Configuration) => {
+    /**
+     * Get Shipping Services (Admin)
+     * @summary Get Shipping Services
+     * @param {number} customerId Customer ID
+     * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShippingServicesModel>>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services
@@ -14860,6 +14939,15 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const ShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get Shipping Services (Admin)
+     * @summary Get Shipping Services
+     * @param {number} customerId Customer ID
+     * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShippingServicesModel>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services
@@ -14876,6 +14964,16 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
  * @extends {BaseAPI}
  */
 export declare class ShippingApi extends BaseAPI {
+    /**
+     * Get Shipping Services (Admin)
+     * @summary Get Shipping Services
+     * @param {number} customerId Customer ID
+     * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShippingApi
+     */
+    postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShippingServicesModel, any, {}>>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services

package/dist/api.js

@@ -12749,6 +12749,48 @@ exports.SMSApi = SMSApi;
 var ShippingApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
+        /**
+         * Get Shipping Services (Admin)
+         * @summary Get Shipping Services
+         * @param {number} customerId Customer ID
+         * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetAdminShippingServices: function (customerId_1, shippingInformationDTO_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([customerId_1, shippingInformationDTO_1], args_1, true), void 0, function (customerId, shippingInformationDTO, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'customerId' is not null or undefined
+                    (0, common_1.assertParamExists)('postGetAdminShippingServices', 'customerId', customerId);
+                    localVarPath = "/admin/shipping/services";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (customerId !== undefined) {
+                        localVarQueryParameter['customerId'] = customerId;
+                    }
+                    localVarHeaderParameter['Content-Type'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(shippingInformationDTO, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -12795,6 +12837,30 @@ exports.ShippingApiAxiosParamCreator = ShippingApiAxiosParamCreator;
 var ShippingApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.ShippingApiAxiosParamCreator)(configuration);
     return {
+        /**
+         * Get Shipping Services (Admin)
+         * @summary Get Shipping Services
+         * @param {number} customerId Customer ID
+         * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetAdminShippingServices: function (customerId, shippingInformationDTO, 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.postGetAdminShippingServices(customerId, shippingInformationDTO, 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['ShippingApi.postGetAdminShippingServices']) === 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 Shipping Services
          * @summary Get Shipping Services
@@ -12828,6 +12894,17 @@ exports.ShippingApiFp = ShippingApiFp;
 var ShippingApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.ShippingApiFp)(configuration);
     return {
+        /**
+         * Get Shipping Services (Admin)
+         * @summary Get Shipping Services
+         * @param {number} customerId Customer ID
+         * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetAdminShippingServices: function (customerId, shippingInformationDTO, options) {
+            return localVarFp.postGetAdminShippingServices(customerId, shippingInformationDTO, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -12852,6 +12929,19 @@ var ShippingApi = /** @class */ (function (_super) {
     function ShippingApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Get Shipping Services (Admin)
+     * @summary Get Shipping Services
+     * @param {number} customerId Customer ID
+     * @param {ShippingInformationDTO} [shippingInformationDTO] Shipping Information
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShippingApi
+     */
+    ShippingApi.prototype.postGetAdminShippingServices = function (customerId, shippingInformationDTO, options) {
+        var _this = this;
+        return (0, exports.ShippingApiFp)(this.configuration).postGetAdminShippingServices(customerId, shippingInformationDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Shipping Services
      * @summary Get Shipping Services

package/docs/AuditLogEntity.md

@@ -0,0 +1,37 @@
+# AuditLogEntity
+
+AuditLogEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**action** | **string** | action | [optional] [default to undefined]
+**type** | **string** | type | [optional] [default to undefined]
+**identifier** | **string** | identifier | [optional] [default to undefined]
+**user** | **string** | user | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**beforeData** | **string** | beforeData | [optional] [default to undefined]
+**afterData** | **string** | afterData | [optional] [default to undefined]
+**description** | **string** | description | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuditLogEntity } from 'yellowgrid-api-ts';
+
+const instance: AuditLogEntity = {
+    id,
+    action,
+    type,
+    identifier,
+    user,
+    timestamp,
+    beforeData,
+    afterData,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ShippingApi.md

@@ -4,8 +4,67 @@ All URIs are relative to *http://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**postGetAdminShippingServices**](#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services|
 |[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
 
+# **postGetAdminShippingServices**
+> ShippingServicesModel postGetAdminShippingServices()
+
+Get Shipping Services (Admin)
+
+### Example
+
+```typescript
+import {
+    ShippingApi,
+    Configuration,
+    ShippingInformationDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ShippingApi(configuration);
+
+let customerId: number; //Customer ID (default to undefined)
+let shippingInformationDTO: ShippingInformationDTO; //Shipping Information (optional)
+
+const { status, data } = await apiInstance.postGetAdminShippingServices(
+    customerId,
+    shippingInformationDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **shippingInformationDTO** | **ShippingInformationDTO**| Shipping Information | |
+| **customerId** | [**number**] | Customer ID | defaults to undefined|
+
+
+### Return type
+
+**ShippingServicesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Shipping Services |  -  |
+|**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)
+
 # **postGetShippingServices**
 > ShippingServicesModel postGetShippingServices()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.1.15-dev.0",
+  "version": "3.1.16-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {