@redhat-cloud-services/notifications-client 2.4.3 → 2.4.4

package/doc/classes/index.RequiredError.md

@@ -1,187 +0,0 @@
-[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [index](../modules/index.md) / RequiredError
-
-# Class: RequiredError
-
-[index](../modules/index.md).RequiredError
-
-**`Export`**
-
-RequiredError
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`RequiredError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](index.RequiredError.md#constructor)
-
-### Properties
-
-- [field](index.RequiredError.md#field)
-- [message](index.RequiredError.md#message)
-- [name](index.RequiredError.md#name)
-- [stack](index.RequiredError.md#stack)
-- [prepareStackTrace](index.RequiredError.md#preparestacktrace)
-- [stackTraceLimit](index.RequiredError.md#stacktracelimit)
-
-### Methods
-
-- [captureStackTrace](index.RequiredError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new RequiredError**(`field`, `msg?`): [`RequiredError`](index.RequiredError.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `field` | `string` |
-| `msg?` | `string` |
-
-#### Returns
-
-[`RequiredError`](index.RequiredError.md)
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-[packages/notifications/base.ts:68](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L68)
-
-## Properties
-
-### field
-
-• **field**: `string`
-
-#### Defined in
-
-[packages/notifications/base.ts:68](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L68)
-
-___
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-Error.message
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1054
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1053
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1055
-
-___
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-Optional override for formatting stack traces
-
-**`See`**
-
-https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-#### Inherited from
-
-Error.prepareStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:115
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:117
-
-## Methods
-
-### captureStackTrace
-
-▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:108

package/doc/interfaces/index.RequestArgs.md

@@ -1,36 +0,0 @@
-[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [index](../modules/index.md) / RequestArgs
-
-# Interface: RequestArgs
-
-[index](../modules/index.md).RequestArgs
-
-**`Export`**
-
-RequestArg
-
-## Table of contents
-
-### Properties
-
-- [options](index.RequestArgs.md#options)
-- [url](index.RequestArgs.md#url)
-
-## Properties
-
-### options
-
-• **options**: `AxiosRequestConfig`\<`any`\>
-
-#### Defined in
-
-[packages/notifications/base.ts:42](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L42)
-
-___
-
-### url
-
-• **url**: `string`
-
-#### Defined in
-
-[packages/notifications/base.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L41)

package/doc/interfaces/types.BasicAuthentication.md

@@ -1,44 +0,0 @@
-[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / BasicAuthentication
-
-# Interface: BasicAuthentication
-
-[types](../modules/types.md).BasicAuthentication
-
-**`Export`**
-
-BasicAuthentication
-
-## Table of contents
-
-### Properties
-
-- [password](types.BasicAuthentication.md#password)
-- [username](types.BasicAuthentication.md#username)
-
-## Properties
-
-### password
-
-• `Optional` **password**: `string`
-
-**`Memberof`**
-
-BasicAuthentication
-
-#### Defined in
-
-[packages/notifications/types/index.ts:298](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L298)
-
-___
-
-### username
-
-• `Optional` **username**: `string`
-
-**`Memberof`**
-
-BasicAuthentication
-
-#### Defined in
-
-[packages/notifications/types/index.ts:292](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L292)

package/doc/interfaces/types.CamelProperties.md

@@ -1,123 +0,0 @@
-[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / CamelProperties
-
-# Interface: CamelProperties
-
-[types](../modules/types.md).CamelProperties
-
-**`Export`**
-
-CamelPropertie
-
-## Table of contents
-
-### Properties
-
-- [basic\_authentication](types.CamelProperties.md#basic_authentication)
-- [bearer\_authentication](types.CamelProperties.md#bearer_authentication)
-- [bearer\_authentication\_sources\_id](types.CamelProperties.md#bearer_authentication_sources_id)
-- [disable\_ssl\_verification](types.CamelProperties.md#disable_ssl_verification)
-- [extras](types.CamelProperties.md#extras)
-- [secret\_token](types.CamelProperties.md#secret_token)
-- [url](types.CamelProperties.md#url)
-
-## Properties
-
-### basic\_authentication
-
-• `Optional` **basic\_authentication**: [`BasicAuthentication`](types.BasicAuthentication.md)
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:484](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L484)
-
-___
-
-### bearer\_authentication
-
-• `Optional` **bearer\_authentication**: `string`
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:502](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L502)
-
-___
-
-### bearer\_authentication\_sources\_id
-
-• `Optional` **bearer\_authentication\_sources\_id**: `number`
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:496](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L496)
-
-___
-
-### disable\_ssl\_verification
-
-• **disable\_ssl\_verification**: `boolean`
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L472)
-
-___
-
-### extras
-
-• `Optional` **extras**: `Object`
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Index signature
-
-▪ [key: `string`]: `string`
-
-#### Defined in
-
-[packages/notifications/types/index.ts:490](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L490)
-
-___
-
-### secret\_token
-
-• `Optional` **secret\_token**: `string`
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:478](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L478)
-
-___
-
-### url
-
-• **url**: `string`
-
-**`Memberof`**
-
-CamelPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:466](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L466)

package/doc/interfaces/types.SystemSubscriptionProperties.md

@@ -1,59 +0,0 @@
-[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / SystemSubscriptionProperties
-
-# Interface: SystemSubscriptionProperties
-
-[types](../modules/types.md).SystemSubscriptionProperties
-
-**`Export`**
-
-SystemSubscriptionPropertie
-
-## Table of contents
-
-### Properties
-
-- [group\_id](types.SystemSubscriptionProperties.md#group_id)
-- [ignore\_preferences](types.SystemSubscriptionProperties.md#ignore_preferences)
-- [only\_admins](types.SystemSubscriptionProperties.md#only_admins)
-
-## Properties
-
-### group\_id
-
-• `Optional` **group\_id**: `string`
-
-**`Memberof`**
-
-SystemSubscriptionPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1660](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1660)
-
-___
-
-### ignore\_preferences
-
-• **ignore\_preferences**: `boolean`
-
-**`Memberof`**
-
-SystemSubscriptionPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1654](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1654)
-
-___
-
-### only\_admins
-
-• **only\_admins**: `boolean`
-
-**`Memberof`**
-
-SystemSubscriptionPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1648](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1648)

package/doc/interfaces/types.WebhookProperties.md

@@ -1,104 +0,0 @@
-[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / WebhookProperties
-
-# Interface: WebhookProperties
-
-[types](../modules/types.md).WebhookProperties
-
-**`Export`**
-
-WebhookPropertie
-
-## Table of contents
-
-### Properties
-
-- [basic\_authentication](types.WebhookProperties.md#basic_authentication)
-- [bearer\_authentication](types.WebhookProperties.md#bearer_authentication)
-- [disable\_ssl\_verification](types.WebhookProperties.md#disable_ssl_verification)
-- [method](types.WebhookProperties.md#method)
-- [secret\_token](types.WebhookProperties.md#secret_token)
-- [url](types.WebhookProperties.md#url)
-
-## Properties
-
-### basic\_authentication
-
-• `Optional` **basic\_authentication**: [`BasicAuthentication`](types.BasicAuthentication.md)
-
-**`Memberof`**
-
-WebhookPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1852](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1852)
-
-___
-
-### bearer\_authentication
-
-• `Optional` **bearer\_authentication**: `string`
-
-**`Memberof`**
-
-WebhookPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1858](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1858)
-
-___
-
-### disable\_ssl\_verification
-
-• **disable\_ssl\_verification**: `boolean`
-
-**`Memberof`**
-
-WebhookPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1840](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1840)
-
-___
-
-### method
-
-• **method**: [`HttpType`](../enums/types.HttpType.md)
-
-**`Memberof`**
-
-WebhookPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1834](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1834)
-
-___
-
-### secret\_token
-
-• `Optional` **secret\_token**: `string`
-
-**`Memberof`**
-
-WebhookPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1846](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1846)
-
-___
-
-### url
-
-• **url**: `string`
-
-**`Memberof`**
-
-WebhookPropertie
-
-#### Defined in
-
-[packages/notifications/types/index.ts:1828](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1828)