@redhat-cloud-services/notifications-client 2.2.4 → 2.3.0

package/doc/classes/Configuration.md

@@ -0,0 +1,194 @@
+[@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?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) |
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/master/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/master/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/master/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/master/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/master/packages/notifications/utils/configuration.ts#L48)
+
+___
+
+### formDataCtor
+
+• `Optional` **formDataCtor**: () => `any`
+
+#### Type declaration
+
+• **new Configuration**()
+
+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.
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:63](https://github.com/RedHatInsights/javascript-clients/blob/master/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/master/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/master/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/master/packages/notifications/utils/configuration.ts#L85)

package/doc/classes/RequiredError.md

@@ -0,0 +1,179 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / RequiredError
+
+# Class: RequiredError
+
+**`Export`**
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`RequiredError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RequiredError.md#constructor)
+
+### Properties
+
+- [field](RequiredError.md#field)
+- [message](RequiredError.md#message)
+- [name](RequiredError.md#name)
+- [stack](RequiredError.md#stack)
+- [prepareStackTrace](RequiredError.md#preparestacktrace)
+- [stackTraceLimit](RequiredError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](RequiredError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new RequiredError**(`field`, `msg?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `field` | `string` |
+| `msg?` | `string` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:167](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L167)
+
+## Properties
+
+### field
+
+• **field**: `string`
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:167](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L167)
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1041
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1040
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1042
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`See`**
+
+https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
+
+##### 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
+
+▸ `Static` **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/enums/EndpointStatus.md

@@ -0,0 +1,76 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EndpointStatus
+
+# Enumeration: EndpointStatus
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Deleting](EndpointStatus.md#deleting)
+- [Failed](EndpointStatus.md#failed)
+- [New](EndpointStatus.md#new)
+- [Provisioning](EndpointStatus.md#provisioning)
+- [Ready](EndpointStatus.md#ready)
+- [Unknown](EndpointStatus.md#unknown)
+
+## Enumeration Members
+
+### Deleting
+
+• **Deleting** = ``"DELETING"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:796](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L796)
+
+___
+
+### Failed
+
+• **Failed** = ``"FAILED"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:797](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L797)
+
+___
+
+### New
+
+• **New** = ``"NEW"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:794](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L794)
+
+___
+
+### Provisioning
+
+• **Provisioning** = ``"PROVISIONING"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:795](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L795)
+
+___
+
+### Ready
+
+• **Ready** = ``"READY"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:792](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L792)
+
+___
+
+### Unknown
+
+• **Unknown** = ``"UNKNOWN"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:793](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L793)

package/doc/enums/EndpointType.md

@@ -0,0 +1,65 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EndpointType
+
+# Enumeration: EndpointType
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Ansible](EndpointType.md#ansible)
+- [Camel](EndpointType.md#camel)
+- [Drawer](EndpointType.md#drawer)
+- [EmailSubscription](EndpointType.md#emailsubscription)
+- [Webhook](EndpointType.md#webhook)
+
+## Enumeration Members
+
+### Ansible
+
+• **Ansible** = ``"ansible"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:826](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L826)
+
+___
+
+### Camel
+
+• **Camel** = ``"camel"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:825](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L825)
+
+___
+
+### Drawer
+
+• **Drawer** = ``"drawer"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:827](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L827)
+
+___
+
+### EmailSubscription
+
+• **EmailSubscription** = ``"email_subscription"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:824](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L824)
+
+___
+
+### Webhook
+
+• **Webhook** = ``"webhook"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:823](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L823)

package/doc/enums/Environment.md

@@ -0,0 +1,54 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Environment
+
+# Enumeration: Environment
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Ephemeral](Environment.md#ephemeral)
+- [LocalServer](Environment.md#localserver)
+- [Prod](Environment.md#prod)
+- [Stage](Environment.md#stage)
+
+## Enumeration Members
+
+### Ephemeral
+
+• **Ephemeral** = ``"EPHEMERAL"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:842](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L842)
+
+___
+
+### LocalServer
+
+• **LocalServer** = ``"LOCAL_SERVER"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:843](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L843)
+
+___
+
+### Prod
+
+• **Prod** = ``"PROD"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:840](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L840)
+
+___
+
+### Stage
+
+• **Stage** = ``"STAGE"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:841](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L841)

package/doc/enums/EventLogEntryActionStatus.md

@@ -0,0 +1,65 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventLogEntryActionStatus
+
+# Enumeration: EventLogEntryActionStatus
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Failed](EventLogEntryActionStatus.md#failed)
+- [Processing](EventLogEntryActionStatus.md#processing)
+- [Sent](EventLogEntryActionStatus.md#sent)
+- [Success](EventLogEntryActionStatus.md#success)
+- [Unknown](EventLogEntryActionStatus.md#unknown)
+
+## Enumeration Members
+
+### Failed
+
+• **Failed** = ``"FAILED"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:960](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L960)
+
+___
+
+### Processing
+
+• **Processing** = ``"PROCESSING"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:959](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L959)
+
+___
+
+### Sent
+
+• **Sent** = ``"SENT"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:957](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L957)
+
+___
+
+### Success
+
+• **Success** = ``"SUCCESS"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:958](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L958)
+
+___
+
+### Unknown
+
+• **Unknown** = ``"UNKNOWN"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:961](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L961)

package/doc/enums/HttpType.md

@@ -0,0 +1,43 @@
+[@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/master/packages/notifications/types/index.ts#L1141)
+
+___
+
+### Post
+
+• **Post** = ``"POST"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1142](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1142)
+
+___
+
+### Put
+
+• **Put** = ``"PUT"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1143](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1143)