yellowgrid-api-ts 3.2.157-dev.0 → 3.2.158-dev.0

package/README.md

@@ -183,6 +183,7 @@ Class | Method | HTTP request | Description
 *OAuth20Api* | [**postAccessToken**](docs/OAuth20Api.md#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token
 *OAuth20Api* | [**postAuthorise**](docs/OAuth20Api.md#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code
 *OAuth20Api* | [**postGetIdentity**](docs/OAuth20Api.md#postgetidentity) | **POST** /oauth2/me | Get Token Identity
+*OAuth20Api* | [**postLogout**](docs/OAuth20Api.md#postlogout) | **POST** /oauth2/logout | 
 *OAuth20Api* | [**postPortalLogin**](docs/OAuth20Api.md#postportallogin) | **POST** /oauth2/portal/login | Portal Login
 *OrdersApi* | [**deleteDeleteBatch**](docs/OrdersApi.md#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | 
 *OrdersApi* | [**deleteUpdateOrder**](docs/OrdersApi.md#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)

package/api.ts

@@ -4861,7 +4861,8 @@ export const ProspectDTOStatusEnum = {
     CallBackDue: 'Call Back Due',
     NoOrdersPlaced: 'No Orders Placed',
     NoOrdersInTheLast4Months: 'No Orders In The Last 4 Months',
-    NoActionRequired: 'No Action Required'
+    NoActionRequired: 'No Action Required',
+    DoNotCall: 'Do Not Call'
 } as const;
 
 export type ProspectDTOStatusEnum = typeof ProspectDTOStatusEnum[keyof typeof ProspectDTOStatusEnum];
@@ -18334,6 +18335,34 @@ export const OAuth20ApiAxiosParamCreator = function (configuration?: Configurati
 
             localVarHeaderParameter['Accept'] = 'application/json';
 
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Remove Oauth 2.0 Cookies
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postLogout: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/oauth2/logout`;
+            // 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;
+
+
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -18464,6 +18493,17 @@ export const OAuth20ApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OAuth20Api.postGetIdentity']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Remove Oauth 2.0 Cookies
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postLogout(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postLogout(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OAuth20Api.postLogout']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Portal Login
          * @summary Portal Login
@@ -18550,6 +18590,14 @@ export const OAuth20ApiFactory = function (configuration?: Configuration, basePa
         postGetIdentity(options?: RawAxiosRequestConfig): AxiosPromise<ClientDetailsModel> {
             return localVarFp.postGetIdentity(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Remove Oauth 2.0 Cookies
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postLogout(options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.postLogout(options).then((request) => request(axios, basePath));
+        },
         /**
          * Portal Login
          * @summary Portal Login
@@ -18636,6 +18684,15 @@ export class OAuth20Api extends BaseAPI {
         return OAuth20ApiFp(this.configuration).postGetIdentity(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Remove Oauth 2.0 Cookies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postLogout(options?: RawAxiosRequestConfig) {
+        return OAuth20ApiFp(this.configuration).postLogout(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Portal Login
      * @summary Portal Login

package/dist/api.d.ts

@@ -4807,6 +4807,7 @@ export declare const ProspectDTOStatusEnum: {
     readonly NoOrdersPlaced: "No Orders Placed";
     readonly NoOrdersInTheLast4Months: "No Orders In The Last 4 Months";
     readonly NoActionRequired: "No Action Required";
+    readonly DoNotCall: "Do Not Call";
 };
 export type ProspectDTOStatusEnum = typeof ProspectDTOStatusEnum[keyof typeof ProspectDTOStatusEnum];
 /**
@@ -12962,6 +12963,12 @@ export declare const OAuth20ApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     postGetIdentity: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Remove Oauth 2.0 Cookies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postLogout: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Portal Login
      * @summary Portal Login
@@ -13029,6 +13036,12 @@ export declare const OAuth20ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postGetIdentity(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientDetailsModel>>;
+    /**
+     * Remove Oauth 2.0 Cookies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postLogout(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Portal Login
      * @summary Portal Login
@@ -13096,6 +13109,12 @@ export declare const OAuth20ApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     postGetIdentity(options?: RawAxiosRequestConfig): AxiosPromise<ClientDetailsModel>;
+    /**
+     * Remove Oauth 2.0 Cookies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postLogout(options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Portal Login
      * @summary Portal Login
@@ -13163,6 +13182,12 @@ export declare class OAuth20Api extends BaseAPI {
      * @throws {RequiredError}
      */
     postGetIdentity(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientDetailsModel, any, {}>>;
+    /**
+     * Remove Oauth 2.0 Cookies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postLogout(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Portal Login
      * @summary Portal Login

package/dist/api.js

@@ -305,7 +305,8 @@ exports.ProspectDTOStatusEnum = {
     CallBackDue: 'Call Back Due',
     NoOrdersPlaced: 'No Orders Placed',
     NoOrdersInTheLast4Months: 'No Orders In The Last 4 Months',
-    NoActionRequired: 'No Action Required'
+    NoActionRequired: 'No Action Required',
+    DoNotCall: 'Do Not Call'
 };
 exports.ServiceHealthDTOGlobalStatusEnum = {
     NUMBER_0: 0,
@@ -12039,6 +12040,38 @@ var OAuth20ApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Remove Oauth 2.0 Cookies
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postLogout: function () {
+            var args_1 = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args_1[_i] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    localVarPath = "/oauth2/logout";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    (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,
+                        }];
+                });
+            });
+        },
         /**
          * Portal Login
          * @summary Portal Login
@@ -12214,6 +12247,27 @@ var OAuth20ApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Remove Oauth 2.0 Cookies
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postLogout: function (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.postLogout(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['OAuth20Api.postLogout']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Portal Login
          * @summary Portal Login
@@ -12310,6 +12364,14 @@ var OAuth20ApiFactory = function (configuration, basePath, axios) {
         postGetIdentity: function (options) {
             return localVarFp.postGetIdentity(options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Remove Oauth 2.0 Cookies
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postLogout: function (options) {
+            return localVarFp.postLogout(options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Portal Login
          * @summary Portal Login
@@ -12400,6 +12462,15 @@ var OAuth20Api = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OAuth20ApiFp)(this.configuration).postGetIdentity(options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Remove Oauth 2.0 Cookies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    OAuth20Api.prototype.postLogout = function (options) {
+        var _this = this;
+        return (0, exports.OAuth20ApiFp)(this.configuration).postLogout(options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Portal Login
      * @summary Portal Login

package/docs/OAuth20Api.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://localhost*
 |[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
 |[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
 |[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
+|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
 |[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
 
 # **getGetMfaQrCode**
@@ -311,6 +312,53 @@ 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)
 
+# **postLogout**
+> postLogout()
+
+Remove Oauth 2.0 Cookies
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.postLogout();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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)
+
 # **postPortalLogin**
 > AuthCodeResponseModel postPortalLogin()
 

package/package.json

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