@redhat-cloud-services/notifications-client 4.0.0 → 4.0.2

package/doc/README.md

@@ -0,0 +1,42 @@
+@redhat-cloud-services/javascript-clients / [Exports](modules.md)
+
+# Javascript Clients
+Auto generated Javascript clients for swagger API
+
+### Overview
+This repository is set up as a monorepo for all API clients to use one configuration and release cycle. This repo is using [NX](https://nx.dev/getting-started/intro) as its monorepo manager and [Github Actions](https://docs.github.com/en/actions) for CI/CD as well as publishing packages to NPM.
+
+### Local development
+
+We are using Java to install and build this generator. Please install Java and preferably Maven as well so you don't have any issues when building this new generator.
+
+* Once you have Java and Maven installed you can install dependencies by running `npm install`
+
+* When you have dependencies installed you can run build anytime you change something in the generator `npm run build:generator`
+
+### Creating a new client
+Run `npm run create-client` and enter your new client name (e.g. entering `notifications` will generate `notifications-client`). All the necessary TS and NX config files will be created for you.
+
+**IMPORTANT! Ensure the `SPEC` URL in you `generate:prod` script in the `package.json` matches your spec correctly. Also, don't forget to update your packages's README with the correct install and usage information.**
+
+### Generating and Building clients
+
+From the root javascript-clients folder:
+* To generate all clients run `npm run generate` -- The command **must** be run with git origin set to the upstream repository (**RedHatInsights/javascript-clients**) - this way the correct docs and references are generated.
+* To build clients and generate their dist to be published run `npm run build` -- NX will only build packages when it detects that a change has been made to the client (otherwise it will reference the cache). After a client has been built, our `builder` (located in `packages/build-utils`) will move each client's `dist` into a top-level `dist` for publishing. Use `npx nx run-many --skip-nx-cache -t build --exclude=@redhat-cloud-services/CLIENTNAME-client` if you wish to build all clients regardless of whether or not a change has been made.
+
+### Custom Module Federation Generator
+
+As the default, we use `typescript-axios` to generate a client based on their OpenAPI spec. In addition, we have a custom generator available for use built with module federation in mind which allows for treeshaking by webpack. This will create a new folder for each endpoint allowing consumers to import only the endpoints they are going to use without the need of importing the entire API. This generator should be a replacement for the regular `typescript-axios` generator. See below for an example script to use the new generator:
+
+```JSON
+{
+  "name": "@redhat-cloud-services/some-client-name",
+  "version": "1.0.0",
+  "scripts": {
+    "generate": "TS_POST_PROCESS_FILE='../../postProcess.sh' openapi-generator-cli generate -i $SPEC --custom-generator=../../target/typescript-axios-webpack-module-federation-openapi-generator-1.0.0.jar -g typescript-axios-webpack-module-federation -o . --skip-validate-spec --enable-post-process-file"
+  }
+}
+```
+
+If you've previously used the `typescript-axios` generator you will also have to change the version of `generator-cli.version` in `openapitool.json` to at least `6.6.0`.

package/doc/enums/types.EndpointStatus.md

@@ -0,0 +1,78 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointStatus
+
+# Enumeration: EndpointStatus
+
+[types](../modules/types.md).EndpointStatus
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Deleting](types.EndpointStatus.md#deleting)
+- [Failed](types.EndpointStatus.md#failed)
+- [New](types.EndpointStatus.md#new)
+- [Provisioning](types.EndpointStatus.md#provisioning)
+- [Ready](types.EndpointStatus.md#ready)
+- [Unknown](types.EndpointStatus.md#unknown)
+
+## Enumeration Members
+
+### Deleting
+
+• **Deleting** = ``"DELETING"``
+
+#### Defined in
+
+[types/index.ts:859](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L859)
+
+___
+
+### Failed
+
+• **Failed** = ``"FAILED"``
+
+#### Defined in
+
+[types/index.ts:860](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L860)
+
+___
+
+### New
+
+• **New** = ``"NEW"``
+
+#### Defined in
+
+[types/index.ts:857](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L857)
+
+___
+
+### Provisioning
+
+• **Provisioning** = ``"PROVISIONING"``
+
+#### Defined in
+
+[types/index.ts:858](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L858)
+
+___
+
+### Ready
+
+• **Ready** = ``"READY"``
+
+#### Defined in
+
+[types/index.ts:855](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L855)
+
+___
+
+### Unknown
+
+• **Unknown** = ``"UNKNOWN"``
+
+#### Defined in
+
+[types/index.ts:856](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L856)

package/doc/enums/types.EndpointStatusDTO.md

@@ -0,0 +1,78 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointStatusDTO
+
+# Enumeration: EndpointStatusDTO
+
+[types](../modules/types.md).EndpointStatusDTO
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Deleting](types.EndpointStatusDTO.md#deleting)
+- [Failed](types.EndpointStatusDTO.md#failed)
+- [New](types.EndpointStatusDTO.md#new)
+- [Provisioning](types.EndpointStatusDTO.md#provisioning)
+- [Ready](types.EndpointStatusDTO.md#ready)
+- [Unknown](types.EndpointStatusDTO.md#unknown)
+
+## Enumeration Members
+
+### Deleting
+
+• **Deleting** = ``"DELETING"``
+
+#### Defined in
+
+[types/index.ts:873](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L873)
+
+___
+
+### Failed
+
+• **Failed** = ``"FAILED"``
+
+#### Defined in
+
+[types/index.ts:874](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L874)
+
+___
+
+### New
+
+• **New** = ``"NEW"``
+
+#### Defined in
+
+[types/index.ts:875](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L875)
+
+___
+
+### Provisioning
+
+• **Provisioning** = ``"PROVISIONING"``
+
+#### Defined in
+
+[types/index.ts:876](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L876)
+
+___
+
+### Ready
+
+• **Ready** = ``"READY"``
+
+#### Defined in
+
+[types/index.ts:877](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L877)
+
+___
+
+### Unknown
+
+• **Unknown** = ``"UNKNOWN"``
+
+#### Defined in
+
+[types/index.ts:878](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L878)

package/doc/enums/types.EndpointType.md

@@ -0,0 +1,67 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointType
+
+# Enumeration: EndpointType
+
+[types](../modules/types.md).EndpointType
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Ansible](types.EndpointType.md#ansible)
+- [Camel](types.EndpointType.md#camel)
+- [Drawer](types.EndpointType.md#drawer)
+- [EmailSubscription](types.EndpointType.md#emailsubscription)
+- [Webhook](types.EndpointType.md#webhook)
+
+## Enumeration Members
+
+### Ansible
+
+• **Ansible** = ``"ansible"``
+
+#### Defined in
+
+[types/index.ts:904](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L904)
+
+___
+
+### Camel
+
+• **Camel** = ``"camel"``
+
+#### Defined in
+
+[types/index.ts:905](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L905)
+
+___
+
+### Drawer
+
+• **Drawer** = ``"drawer"``
+
+#### Defined in
+
+[types/index.ts:906](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L906)
+
+___
+
+### EmailSubscription
+
+• **EmailSubscription** = ``"email_subscription"``
+
+#### Defined in
+
+[types/index.ts:907](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L907)
+
+___
+
+### Webhook
+
+• **Webhook** = ``"webhook"``
+
+#### Defined in
+
+[types/index.ts:908](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L908)

package/doc/enums/types.EndpointTypeDTO.md

@@ -0,0 +1,67 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointTypeDTO
+
+# Enumeration: EndpointTypeDTO
+
+[types](../modules/types.md).EndpointTypeDTO
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Ansible](types.EndpointTypeDTO.md#ansible)
+- [Camel](types.EndpointTypeDTO.md#camel)
+- [Drawer](types.EndpointTypeDTO.md#drawer)
+- [EmailSubscription](types.EndpointTypeDTO.md#emailsubscription)
+- [Webhook](types.EndpointTypeDTO.md#webhook)
+
+## Enumeration Members
+
+### Ansible
+
+• **Ansible** = ``"ansible"``
+
+#### Defined in
+
+[types/index.ts:921](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L921)
+
+___
+
+### Camel
+
+• **Camel** = ``"camel"``
+
+#### Defined in
+
+[types/index.ts:922](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L922)
+
+___
+
+### Drawer
+
+• **Drawer** = ``"drawer"``
+
+#### Defined in
+
+[types/index.ts:923](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L923)
+
+___
+
+### EmailSubscription
+
+• **EmailSubscription** = ``"email_subscription"``
+
+#### Defined in
+
+[types/index.ts:924](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L924)
+
+___
+
+### Webhook
+
+• **Webhook** = ``"webhook"``
+
+#### Defined in
+
+[types/index.ts:925](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L925)

package/doc/enums/types.Environment.md

@@ -0,0 +1,56 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Environment
+
+# Enumeration: Environment
+
+[types](../modules/types.md).Environment
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Ephemeral](types.Environment.md#ephemeral)
+- [LocalServer](types.Environment.md#localserver)
+- [Prod](types.Environment.md#prod)
+- [Stage](types.Environment.md#stage)
+
+## Enumeration Members
+
+### Ephemeral
+
+• **Ephemeral** = ``"EPHEMERAL"``
+
+#### Defined in
+
+[types/index.ts:940](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L940)
+
+___
+
+### LocalServer
+
+• **LocalServer** = ``"LOCAL_SERVER"``
+
+#### Defined in
+
+[types/index.ts:941](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L941)
+
+___
+
+### Prod
+
+• **Prod** = ``"PROD"``
+
+#### Defined in
+
+[types/index.ts:938](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L938)
+
+___
+
+### Stage
+
+• **Stage** = ``"STAGE"``
+
+#### Defined in
+
+[types/index.ts:939](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L939)

package/doc/enums/types.EventLogEntryActionStatus.md

@@ -0,0 +1,67 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EventLogEntryActionStatus
+
+# Enumeration: EventLogEntryActionStatus
+
+[types](../modules/types.md).EventLogEntryActionStatus
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Failed](types.EventLogEntryActionStatus.md#failed)
+- [Processing](types.EventLogEntryActionStatus.md#processing)
+- [Sent](types.EventLogEntryActionStatus.md#sent)
+- [Success](types.EventLogEntryActionStatus.md#success)
+- [Unknown](types.EventLogEntryActionStatus.md#unknown)
+
+## Enumeration Members
+
+### Failed
+
+• **Failed** = ``"FAILED"``
+
+#### Defined in
+
+[types/index.ts:1058](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1058)
+
+___
+
+### Processing
+
+• **Processing** = ``"PROCESSING"``
+
+#### Defined in
+
+[types/index.ts:1057](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1057)
+
+___
+
+### Sent
+
+• **Sent** = ``"SENT"``
+
+#### Defined in
+
+[types/index.ts:1055](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1055)
+
+___
+
+### Success
+
+• **Success** = ``"SUCCESS"``
+
+#### Defined in
+
+[types/index.ts:1056](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1056)
+
+___
+
+### Unknown
+
+• **Unknown** = ``"UNKNOWN"``
+
+#### Defined in
+
+[types/index.ts:1059](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1059)

package/doc/enums/types.HttpType.md

@@ -0,0 +1,45 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / HttpType
+
+# Enumeration: HttpType
+
+[types](../modules/types.md).HttpType
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Get](types.HttpType.md#get)
+- [Post](types.HttpType.md#post)
+- [Put](types.HttpType.md#put)
+
+## Enumeration Members
+
+### Get
+
+• **Get** = ``"GET"``
+
+#### Defined in
+
+[types/index.ts:1245](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1245)
+
+___
+
+### Post
+
+• **Post** = ``"POST"``
+
+#### Defined in
+
+[types/index.ts:1246](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1246)
+
+___
+
+### Put
+
+• **Put** = ``"PUT"``
+
+#### Defined in
+
+[types/index.ts:1247](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1247)

package/doc/enums/types.NotificationStatus.md

@@ -0,0 +1,67 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / NotificationStatus
+
+# Enumeration: NotificationStatus
+
+[types](../modules/types.md).NotificationStatus
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [FailedExternal](types.NotificationStatus.md#failedexternal)
+- [FailedInternal](types.NotificationStatus.md#failedinternal)
+- [Processing](types.NotificationStatus.md#processing)
+- [Sent](types.NotificationStatus.md#sent)
+- [Success](types.NotificationStatus.md#success)
+
+## Enumeration Members
+
+### FailedExternal
+
+• **FailedExternal** = ``"FAILED_EXTERNAL"``
+
+#### Defined in
+
+[types/index.ts:1487](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1487)
+
+___
+
+### FailedInternal
+
+• **FailedInternal** = ``"FAILED_INTERNAL"``
+
+#### Defined in
+
+[types/index.ts:1486](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1486)
+
+___
+
+### Processing
+
+• **Processing** = ``"PROCESSING"``
+
+#### Defined in
+
+[types/index.ts:1488](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1488)
+
+___
+
+### Sent
+
+• **Sent** = ``"SENT"``
+
+#### Defined in
+
+[types/index.ts:1489](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1489)
+
+___
+
+### Success
+
+• **Success** = ``"SUCCESS"``
+
+#### Defined in
+
+[types/index.ts:1490](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1490)

package/doc/enums/types.Status.md

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

package/doc/enums/types.SubscriptionType.md

@@ -0,0 +1,45 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / SubscriptionType
+
+# Enumeration: SubscriptionType
+
+[types](../modules/types.md).SubscriptionType
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Daily](types.SubscriptionType.md#daily)
+- [Drawer](types.SubscriptionType.md#drawer)
+- [Instant](types.SubscriptionType.md#instant)
+
+## Enumeration Members
+
+### Daily
+
+• **Daily** = ``"DAILY"``
+
+#### Defined in
+
+[types/index.ts:1728](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1728)
+
+___
+
+### Drawer
+
+• **Drawer** = ``"DRAWER"``
+
+#### Defined in
+
+[types/index.ts:1729](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1729)
+
+___
+
+### Instant
+
+• **Instant** = ``"INSTANT"``
+
+#### Defined in
+
+[types/index.ts:1727](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1727)

package/doc/interfaces/types.AddAccessRequest.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / AddAccessRequest
+
+# Interface: AddAccessRequest
+
+[types](../modules/types.md).AddAccessRequest
+
+**`Export`**
+
+AddAccessRequest
+
+## Table of contents
+
+### Properties
+
+- [application\_id](types.AddAccessRequest.md#application_id)
+- [role](types.AddAccessRequest.md#role)
+
+## Properties
+
+### application\_id
+
+• `Optional` **application\_id**: `string`
+
+**`Memberof`**
+
+AddAccessRequest
+
+#### Defined in
+
+[types/index.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L18)
+
+___
+
+### role
+
+• `Optional` **role**: `string`
+
+**`Memberof`**
+
+AddAccessRequest
+
+#### Defined in
+
+[types/index.ts:12](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L12)