1.1.1 • Published 1 year ago
@datenkraft/bb-x-organization-structure-api-ts-client v1.1.1
Backbone - Organization Structure API TS Client
Introduction
The Organization Structure API TS Client enables you to work with the Organization Structure API.
Prerequisites
- npm
Installation
You can use npm to install the package.
npm install @datenkraft/bb-organization-structure-api-ts-client
Using the package
The package can be used to communicate with the Organization Structure API. The Client includes functionalities for every endpoint defined in the openapi.json. The Client is auto-generated with ferdikoomen/openapi-typescript-codegen using an openapi.json file.
Initializing the Client
import { ConfigOptions } from '@datenkraft/bb-base-api-ts-client';
import { OrganizationStructureApiClient } from '@datenkraft/bb-organization-structure-api-ts-client';
const configOptions: ConfigOptions = {
clientId: 'clientId',
clientSecret: 'clientSecret',
oAuthTokenHost: 'oAuthTokenHost',
tokenTradeInPath: 'tokenTradeInPath',
externalIdToken: 'externalIdToken',
useExternalIdToken: true,
};
OrganizationStructureApiClient.init(configOptions).then(() => {
// Client is initialized
});
Example Endpoint: Get Project
OrganizationStructureApiClient.Generated.ProjectService
.getProject('project-id')
.then((project) => {
// Request succeeded
})
.catch((error) => {
// An error occured
});
License
This repository is available under the MIT license.
1.1.1
1 year ago