@redhat-cloud-services/notifications-client 2.3.2 → 2.4.1

package/dist/utils/configuration.js

@@ -1,34 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
-var Configuration = /** @class */ (function () {
-    function Configuration(param) {
-        if (param === void 0) { param = {}; }
-        this.apiKey = param.apiKey;
-        this.username = param.username;
-        this.password = param.password;
-        this.accessToken = param.accessToken;
-        this.basePath = param.basePath;
-        this.baseOptions = param.baseOptions;
-        this.formDataCtor = param.formDataCtor;
-    }
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    Configuration.prototype.isJsonMime = function (mime) {
-        var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    };
-    return Configuration;
-}());
-exports.Configuration = Configuration;
-//# sourceMappingURL=configuration.js.map

package/dist/utils/configuration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../utils/configuration.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;;;AAYpB;IAmDI,uBAAY,KAAmC;QAAnC,sBAAA,EAAA,UAAmC;QAC3C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACI,kCAAU,GAAjB,UAAkB,IAAY;QAC1B,IAAM,QAAQ,GAAW,IAAI,MAAM,CAAC,+DAA+D,EAAE,GAAG,CAAC,CAAC;QAC1G,OAAO,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,6BAA6B,CAAC,CAAC;IAC1G,CAAC;IACL,oBAAC;AAAD,CAAC,AA3ED,IA2EC;AA3EY,sCAAa"}

package/doc/classes/BaseAPI.md

@@ -1,133 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / BaseAPI
-
-# Class: BaseAPI
-
-Base API to store config, basepath and axios instance.
-
-**`Export`**
-
-BaseAPI
-
-## Table of contents
-
-### Constructors
-
-- [constructor](BaseAPI.md#constructor)
-
-### Properties
-
-- [axios](BaseAPI.md#axios)
-- [basePath](BaseAPI.md#basepath)
-- [configuration](BaseAPI.md#configuration)
-
-### Methods
-
-- [authConfig](BaseAPI.md#authconfig)
-- [sendRequest](BaseAPI.md#sendrequest)
-
-## Constructors
-
-### constructor
-
-• **new BaseAPI**(`basePath?`, `config?`): [`BaseAPI`](BaseAPI.md)
-
-Constructor to create baseAPI.
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `basePath` | `string` | `BASE_PATH` | basePath of api requests. |
-| `config` | [`ApiConfig`](../interfaces/ApiConfig.md) | `undefined` | to be passed down to axios. |
-
-#### Returns
-
-[`BaseAPI`](BaseAPI.md)
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L70)
-
-## Properties
-
-### axios
-
-• `Protected` **axios**: `AxiosInstance`
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L64)
-
-___
-
-### basePath
-
-• `Protected` **basePath**: `string` = `BASE_PATH`
-
-basePath of api requests.
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L70)
-
-___
-
-### configuration
-
-• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md)
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:63](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L63)
-
-## Methods
-
-### authConfig
-
-▸ **authConfig**(`«destructured»`): `Promise`\<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `«destructured»` | `Omit`\<[`RequestArgs`](../interfaces/RequestArgs.md), ``"authType"`` \| ``"authKey"``\> & \{ `authKey?`: `string` \| [`string`, `string`[]] ; `authType`: [`AuthTypeEnum`](../modules.md#authtypeenum)  } |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:83](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L83)
-
-___
-
-### sendRequest
-
-▸ **sendRequest**\<`T`\>(`request`, `axios?`, `basePath?`): `Promise`\<`AxiosResponse`\<`T`, `any`\>\>
-
-Send axios request
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `request` | `Promise`\<[`RequestArgs`](../interfaces/RequestArgs.md)\> | to be send trough axios. |
-| `axios?` | `AxiosInstance` | optional axios instance. |
-| `basePath?` | `string` | - |
-
-#### Returns
-
-`Promise`\<`AxiosResponse`\<`T`, `any`\>\>
-
-promisable axios response.
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:111](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L111)

package/doc/classes/Configuration.md

@@ -1,202 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Configuration
-
-# Class: Configuration
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Configuration.md#constructor)
-
-### Properties
-
-- [accessToken](Configuration.md#accesstoken)
-- [apiKey](Configuration.md#apikey)
-- [baseOptions](Configuration.md#baseoptions)
-- [basePath](Configuration.md#basepath)
-- [formDataCtor](Configuration.md#formdatactor)
-- [password](Configuration.md#password)
-- [username](Configuration.md#username)
-
-### Methods
-
-- [isJsonMime](Configuration.md#isjsonmime)
-
-## Constructors
-
-### constructor
-
-• **new Configuration**(`param?`): [`Configuration`](Configuration.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) |
-
-#### Returns
-
-[`Configuration`](Configuration.md)
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L65)
-
-## Properties
-
-### accessToken
-
-• `Optional` **accessToken**: `string` \| `Promise`\<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`\<`string`\>
-
-parameter for oauth2 security
-
-**`Param`**
-
-security name
-
-**`Param`**
-
-oauth2 scope
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L41)
-
-___
-
-### apiKey
-
-• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\>
-
-parameter for apiKey security
-
-**`Param`**
-
-security name
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L20)
-
-___
-
-### baseOptions
-
-• `Optional` **baseOptions**: `any`
-
-base options for axios calls
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:55](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L55)
-
-___
-
-### basePath
-
-• `Optional` **basePath**: `string`
-
-override base path
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:48](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L48)
-
-___
-
-### formDataCtor
-
-• `Optional` **formDataCtor**: () => `any`
-
-The FormData constructor that will be used to create multipart form data
-requests. You can inject this here so that execution environments that
-do not support the FormData class can still run the generated client.
-
-#### Type declaration
-
-• **new formDataCtor**(): `any`
-
-##### Returns
-
-`any`
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:63](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L63)
-
-___
-
-### password
-
-• `Optional` **password**: `string`
-
-parameter for basic security
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L34)
-
-___
-
-### username
-
-• `Optional` **username**: `string`
-
-parameter for basic security
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:27](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L27)
-
-## Methods
-
-### isJsonMime
-
-▸ **isJsonMime**(`mime`): `boolean`
-
-Check if the given MIME is a JSON MIME.
-JSON MIME examples:
-  application/json
-  application/json; charset=UTF8
-  APPLICATION/JSON
-  application/vnd.company+json
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) |
-
-#### Returns
-
-`boolean`
-
-True if the given MIME is JSON, false otherwise.
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:85](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L85)

package/doc/enums/HttpType.md

@@ -1,43 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / HttpType
-
-# Enumeration: HttpType
-
-**`Export`**
-
-## Table of contents
-
-### Enumeration Members
-
-- [Get](HttpType.md#get)
-- [Post](HttpType.md#post)
-- [Put](HttpType.md#put)
-
-## Enumeration Members
-
-### Get
-
-• **Get** = ``"GET"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1141](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1141)
-
-___
-
-### Post
-
-• **Post** = ``"POST"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1142](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1142)
-
-___
-
-### Put
-
-• **Put** = ``"PUT"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1143](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1143)

package/doc/enums/NotificationStatus.md

@@ -1,65 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / NotificationStatus
-
-# Enumeration: NotificationStatus
-
-**`Export`**
-
-## Table of contents
-
-### Enumeration Members
-
-- [FailedExternal](NotificationStatus.md#failedexternal)
-- [FailedInternal](NotificationStatus.md#failedinternal)
-- [Processing](NotificationStatus.md#processing)
-- [Sent](NotificationStatus.md#sent)
-- [Success](NotificationStatus.md#success)
-
-## Enumeration Members
-
-### FailedExternal
-
-• **FailedExternal** = ``"FAILED_EXTERNAL"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1383](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1383)
-
-___
-
-### FailedInternal
-
-• **FailedInternal** = ``"FAILED_INTERNAL"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1382](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1382)
-
-___
-
-### Processing
-
-• **Processing** = ``"PROCESSING"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1384](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1384)
-
-___
-
-### Sent
-
-• **Sent** = ``"SENT"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1385](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1385)
-
-___
-
-### Success
-
-• **Success** = ``"SUCCESS"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1386](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1386)

package/doc/enums/Status.md

@@ -1,32 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Status
-
-# Enumeration: Status
-
-**`Export`**
-
-## Table of contents
-
-### Enumeration Members
-
-- [Maintenance](Status.md#maintenance)
-- [Up](Status.md#up)
-
-## Enumeration Members
-
-### Maintenance
-
-• **Maintenance** = ``"MAINTENANCE"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1610](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1610)
-
-___
-
-### Up
-
-• **Up** = ``"UP"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1609](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1609)

package/doc/enums/SubscriptionType.md

@@ -1,43 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / SubscriptionType
-
-# Enumeration: SubscriptionType
-
-**`Export`**
-
-## Table of contents
-
-### Enumeration Members
-
-- [Daily](SubscriptionType.md#daily)
-- [Drawer](SubscriptionType.md#drawer)
-- [Instant](SubscriptionType.md#instant)
-
-## Enumeration Members
-
-### Daily
-
-• **Daily** = ``"DAILY"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1624](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1624)
-
-___
-
-### Drawer
-
-• **Drawer** = ``"DRAWER"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1625](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1625)
-
-___
-
-### Instant
-
-• **Instant** = ``"INSTANT"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1623](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1623)

package/doc/interfaces/ApiConfig.md

@@ -1,30 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ApiConfig
-
-# Interface: ApiConfig
-
-## Table of contents
-
-### Properties
-
-- [axios](ApiConfig.md#axios)
-- [configuration](ApiConfig.md#configuration)
-
-## Properties
-
-### axios
-
-• **axios**: `AxiosInstance`
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L41)
-
-___
-
-### configuration
-
-• `Optional` **configuration**: [`Configuration`](../classes/Configuration.md)
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:42](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L42)

package/doc/interfaces/ConfigurationParameters.md

@@ -1,93 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters
-
-# Interface: ConfigurationParameters
-
-## Table of contents
-
-### Properties
-
-- [accessToken](ConfigurationParameters.md#accesstoken)
-- [apiKey](ConfigurationParameters.md#apikey)
-- [baseOptions](ConfigurationParameters.md#baseoptions)
-- [basePath](ConfigurationParameters.md#basepath)
-- [formDataCtor](ConfigurationParameters.md#formdatactor)
-- [password](ConfigurationParameters.md#password)
-- [username](ConfigurationParameters.md#username)
-
-## Properties
-
-### accessToken
-
-• `Optional` **accessToken**: `string` \| `Promise`\<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`\<`string`\>
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:8](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L8)
-
-___
-
-### apiKey
-
-• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\>
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:5](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L5)
-
-___
-
-### baseOptions
-
-• `Optional` **baseOptions**: `any`
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:10](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L10)
-
-___
-
-### basePath
-
-• `Optional` **basePath**: `string`
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:9](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L9)
-
-___
-
-### formDataCtor
-
-• `Optional` **formDataCtor**: () => `any`
-
-#### Type declaration
-
-• **new formDataCtor**(): `any`
-
-##### Returns
-
-`any`
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:11](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L11)
-
-___
-
-### password
-
-• `Optional` **password**: `string`
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:7](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L7)
-
-___
-
-### username
-
-• `Optional` **username**: `string`
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:6](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L6)