# @compeon/compeon-api-js

> A JS client for the COMPEON API.

Latest version **0.20.0** (published 2022-09-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install @compeon/compeon-api-js
pnpm add @compeon/compeon-api-js
yarn add @compeon/compeon-api-js
bun add @compeon/compeon-api-js
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.20.0 |
| Published | 2022-09-29 |
| First published | 2018-10-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 5 |
| Unpacked size | 195.4 KB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | apaessler, finnr, dlandry, lgreiving, janb, compeonnpm, bahrens, florian-compeon, dominikfischer86, jbelovs, stphnrdmr |

## Links

- npm: https://www.npmjs.com/package/@compeon/compeon-api-js
- Repository: https://github.com/COMPEON/compeon-api-js
- Homepage: https://github.com/COMPEON/compeon-api-js#readme
- Issues: https://github.com/COMPEON/compeon-api-js/issues
- npm.io page: https://npm.io/package/@compeon/compeon-api-js

## Dependencies (5)

- [qs](https://npm.io/package/qs.md) ^6.5.2
- [uuid](https://npm.io/package/uuid.md) ^8.2.0
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [@compeon/jsonapi-serializer](https://npm.io/package/@compeon/jsonapi-serializer.md) ^0.1.0

## Recent versions

- 0.20.0 (latest) — 2022-09-29
- 0.0.43-beta.2 (beta) — 2021-03-04
- 0.19.1 — 2022-09-13
- 0.19.0 — 2022-08-25
- 0.18.0 — 2022-08-01
- 0.17.0 — 2022-07-29
- 0.16.0 — 2022-07-28
- 0.15.0 — 2022-07-08
- 0.14.1 — 2022-07-06
- 0.14.0 — 2022-07-04
- 0.13.0 — 2022-06-30
- 0.12.0 — 2022-05-30
- 0.11.4 — 2022-05-16
- 0.11.3 — 2022-05-16
- 0.11.2 — 2022-04-28
- … 153 more at https://npm.io/package/@compeon/compeon-api-js/versions

## README

# compeon-api-js

## Installation

    yarn add @compeon/compeon-api-js

## Usage

```js
import { CompeonAPI } from '@compeon/compeon-api-js'

const client = new CompeonAPI({
  // the URL that the client will perform its requests against
  baseURL: 'https://api.staging.compeon.de',


  // skipAuthentication: false,
  // (optional) Set to true if you want to manage token fetch/refresh and logout yourself

  //skipLogout: false,
  // (optional) Set to true to skip the cookie-based automatic logout

  authConfig: {
    // the URL where the OAuth provider is configured at
    baseUrl: 'https://login.staging.compeon.de',

    // the client ID registered with COMPEON
    clientId: 'your-client-id',

    // configuration for the cookie used for global logout
    loggedInCookieDomain: '.staging.compeon.de',
    loggedInCookieName: 'compeon-logged-in-staging'
  }
})
```

All options will be passed to [`axios.create`](https://github.com/axios/axios#axioscreateconfig), so you may use `transformRequest`, `transformResponse` and all other options you are used to when using `axios`.

### Do something after authentication

The client exposes a callback which is called after successful authentication. You may use this e.g. to bootstrap your application.

```js
client
  .authPromise
  .then(render)
```

### Remove OAuth2 URL Params

You might want to remove the URL params after authenticating. Depending on your setup, you want to alter the location, use a framework router or just truncate the query params

```js
const removeAuthParams = () => {
  const cleanedUrl = new URL(window.location)
  const params = new URLSearchParams(cleanedUrl.search.substring(1))

  const paramsDefined = params.get('code') && params.get('state')
  if (!paramsDefined) return

  params.delete('code')
  params.delete('state')

  cleanedUrl.search = params

  window.history.replaceState({}, '', cleanedUrl)
}

client
  .authPromise
  .then(removeAuthParams)
  .then(...)
```

### API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

##### Table of Contents

-   [AdminDocument](#admindocument)
    -   [allForInquiry](#allforinquiry)
        -   [Parameters](#parameters)
    -   [allForTender](#allfortender)
        -   [Parameters](#parameters-1)
-   [Attachment](#attachment)
    -   [find](#find)
        -   [Parameters](#parameters-2)
    -   [all](#all)
        -   [Parameters](#parameters-3)
    -   [create](#create)
        -   [Parameters](#parameters-4)
    -   [delete](#delete)
        -   [Parameters](#parameters-5)
    -   [update](#update)
        -   [Parameters](#parameters-6)
    -   [getDocumentAccess](#getdocumentaccess)
        -   [Parameters](#parameters-7)
    -   [createDocumentAccess](#createdocumentaccess)
        -   [Parameters](#parameters-8)
    -   [deleteDocumentAccess](#deletedocumentaccess)
        -   [Parameters](#parameters-9)
-   [Authentication](#authentication)
    -   [fetchTokens](#fetchtokens)
        -   [Parameters](#parameters-10)
    -   [refreshTokens](#refreshtokens)
        -   [Parameters](#parameters-11)
    -   [isSignedInWithCookie](#issignedinwithcookie)
    -   [getCookie](#getcookie)
-   [Bank](#bank)
    -   [allEmployees](#allemployees)
        -   [Parameters](#parameters-12)
    -   [inviteEmployee](#inviteemployee)
        -   [Parameters](#parameters-13)
    -   [deleteEmployee](#deleteemployee)
        -   [Parameters](#parameters-14)
    -   [updateEmployee](#updateemployee)
        -   [Parameters](#parameters-15)
    -   [allThatCanSeeTender](#allthatcanseetender)
        -   [Parameters](#parameters-16)
    -   [find](#find-1)
        -   [Parameters](#parameters-17)
    -   [update](#update-1)
        -   [Parameters](#parameters-18)
    -   [requestedDocuments](#requesteddocuments)
        -   [Parameters](#parameters-19)
-   [BankCode](#bankcode)
    -   [all](#all-1)
        -   [Parameters](#parameters-20)
-   [BankGroup](#bankgroup)
    -   [all](#all-2)
        -   [Parameters](#parameters-21)
-   [BankGroupCandidate](#bankgroupcandidate)
-   [BankInquiryNote](#bankinquirynote)
    -   [find](#find-2)
        -   [Parameters](#parameters-22)
    -   [all](#all-3)
        -   [Parameters](#parameters-23)
    -   [create](#create-1)
        -   [Parameters](#parameters-24)
    -   [delete](#delete-1)
        -   [Parameters](#parameters-25)
    -   [update](#update-2)
        -   [Parameters](#parameters-26)
-   [BankTag](#banktag)
    -   [all](#all-4)
        -   [Parameters](#parameters-27)
-   [BankVisibility](#bankvisibility)
    -   [all](#all-5)
        -   [Parameters](#parameters-28)
-   [BankVisibilityParameterSet](#bankvisibilityparameterset)
    -   [all](#all-6)
        -   [Parameters](#parameters-29)
-   [Questionnaire](#questionnaire)
    -   [resourcePath](#resourcepath)
    -   [serializer](#serializer)
    -   [allItems](#allitems)
        -   [Parameters](#parameters-30)
    -   [createItem](#createitem)
        -   [Parameters](#parameters-31)
    -   [updateItem](#updateitem)
        -   [Parameters](#parameters-32)
    -   [deleteItem](#deleteitem)
        -   [Parameters](#parameters-33)
-   [Tender](#tender)

#### AdminDocument

**Extends LegacyDocumentResource**

AdminDocument resource

##### allForInquiry

Get all admin documents for a specific inquiry

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.inquiryId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Id of the inquiry to get all admin documents for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### allForTender

Get all admin documents for a specific tender

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.tenderId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Id of the tender to get all admin documents for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### Attachment

**Extends Resource**

Attachment resource

##### find

Get a specific attachment

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context (e.g. inquiryId)
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the attachment
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### all

Get all attachments for a specific context

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### create

Create an attachment in a specific context

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** data of the attachment
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### delete

Delete an attachment

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the attachment
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### update

Create an attachment in a specific context

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the attachment
    -   `config.data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** data to update
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### getDocumentAccess

Get all accesses for a specific attachment

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.attachmentId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the attachment
    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the related bank
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### createDocumentAccess

Create a document access for a specific attachment

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.attachmentId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the attachment
    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the related bank
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### deleteDocumentAccess

Delete a document access for an attachment

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.contextType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the context in which the attachment exists (e.g. inquiry)
    -   `config.contextId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the specified context
    -   `config.attachmentId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the attachment
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the access to delete
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### Authentication

**Extends Resource**

Authentication Resource

##### fetchTokens

fetch OAuth tokens using the authorizaton code

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.code` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** OAuth2 authorization code

##### refreshTokens

refresh OAuth tokens using the refresh code

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.refreshCode` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** OAuth2 refresh code

##### isSignedInWithCookie

check if the current user is signed in

##### getCookie

get the current cookie

#### Bank

**Extends Resource**

Bank resource

##### allEmployees

Get all employees for a specific bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the bank to get the employees for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### inviteEmployee

Invite an employee to a specific bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the bank to invite the employee to
    -   `config.inviterId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the inviting user
    -   `config.data` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** attributes of the new employee
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### deleteEmployee

Delete an employee of a specific bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the bank to get the employees for
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the employee
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### updateEmployee

Update an employee of a specific bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the bank to which the updated employee belongs to
    -   `config.data` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The new attributes of the item
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the employee
    -   `config.userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the user
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### allThatCanSeeTender

Get all banks that are able to see a specific tender

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.tenderId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the tender to get all banks for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### find

Get a bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the bank
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### update

Update a bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the bank
    -   `config.data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** updated data
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### requestedDocuments

Get all requested documents of a bank

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the bank
    -   `config.options` 

#### BankCode

**Extends Resource**

BankCode resource

##### all

Get all BankCodes

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### BankGroup

**Extends Resource**

BankGroup resource

##### all

Get all BankGroups

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### BankGroupCandidate

**Extends Resource**

BankGroupCandidate resource

#### BankInquiryNote

**Extends Resource**

BankInquiryNote resource

##### find

Get a specific bankInquiryNote

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.inquiryId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the inquiry that the note is attached to
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the note
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### all

Get all notes for a specific inquiry

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.inquiryId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the inquiry to get all notes for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### create

Create a note for a specific inquiry

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.inquiryId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the inquiry to create a note for
    -   `config.data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** data of the note
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### delete

Delete a note

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.inquiryId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the inquiry to delete the note for
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the note
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### update

Update a note

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.inquiryId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the inquiry to udpate a note for
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Id of the note
    -   `config.data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** data to update
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### BankTag

**Extends Resource**

BankTag resource

##### all

Get all BankTags

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### BankVisibility

**Extends Resource**

BankVisibility resource

##### all

Get all BankVisibilities

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### BankVisibilityParameterSet

**Extends Resource**

BankVisibilityParameterSet resource

##### all

Get all BankVisibilityParameterSets

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.bankId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** bankId to fetch the parametersets for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### Questionnaire

**Extends Resource**

Questionnaire Resource

##### resourcePath

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** questionnaire resource path

##### serializer

Returns **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** questionnaire serializer

##### allItems

Get all items for a specific questionnaire

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Id of the questionnaire to get the items for
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### createItem

Create an questionnaire item for a specific questionnaire

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.questionnaireId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the questionnaire to create the item for
    -   `config.data` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The attributes of the item
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### updateItem

Update the item of an specific questionnaire

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.questionnaireId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the questionnaire to which the item belongs
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the item to update
    -   `config.data` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The new attributes of the item
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

##### deleteItem

Delete the item of a specific questionnaire

###### Parameters

-   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**

    -   `config.questionnaireId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the questionnaire to which the item belongs
    -   `config.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The id of the item to delete
    -   `config.options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that are forwarded to the http client

#### Tender

**Extends Resource**

Tender resource

---
_Source: https://npm.io/package/@compeon/compeon-api-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._