# @equisoft/equisoft-plan-sdk-typescript@latest

A TypeScript SDK client for the localhost API.

## Usage

First, install the SDK from npm.

```bash
npm install @equisoft/equisoft-plan-sdk-typescript --save
```

Next, try it out.


```ts
import {
  Configuration,
  OrganizationsApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { CreateOrganizationRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new OrganizationsApi(config);

  const body = {
    // OrganizationsCreateOrganizationPayload | Organization creation payload
    organizationsCreateOrganizationPayload: ...,
  } satisfies CreateOrganizationRequest;

  try {
    const data = await api.createOrganization(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```


## Documentation

### API Endpoints

All URIs are relative to *http://localhost*

| Class | Method | HTTP request | Description
| ----- | ------ | ------------ | -------------
*OrganizationsApi* | [**createOrganization**](docs/OrganizationsApi.md#createorganization) | **POST** /fna/api/v2/organizations | 
*OrganizationsApi* | [**deleteOrganization**](docs/OrganizationsApi.md#deleteorganization) | **DELETE** /fna/api/v2/organizations/{uuid} | 
*OrganizationsApi* | [**getOrganization**](docs/OrganizationsApi.md#getorganization) | **GET** /fna/api/v2/organizations/{uuid} | 
*OrganizationsApi* | [**listOrganizationUsers**](docs/OrganizationsApi.md#listorganizationusers) | **GET** /fna/api/v2/organizations/{uuid}/users | 
*OrganizationsApi* | [**listOrganizations**](docs/OrganizationsApi.md#listorganizations) | **GET** /fna/api/v2/organizations | 
*PlansApi* | [**listPlans**](docs/PlansApi.md#listplans) | **GET** /fna/api/v2/plans | 
*UsersApi* | [**createUser**](docs/UsersApi.md#createuser) | **POST** /fna/api/v2/organizations/{uuid}/users | 
*UsersApi* | [**deleteUser**](docs/UsersApi.md#deleteuser) | **DELETE** /fna/api/v2/users/{uuid} | 
*UsersApi* | [**getUser**](docs/UsersApi.md#getuser) | **GET** /fna/api/v2/users/{uuid} | 
*UsersApi* | [**getUserContext**](docs/UsersApi.md#getusercontext) | **GET** /fna/api/v2/userContext | 
*UsersApi* | [**transferUserData**](docs/UsersApi.md#transferuserdata) | **POST** /fna/api/v2/users/{uuid}/transfer-data | 


### Models

- [CmdCopyFNA](docs/CmdCopyFNA.md)
- [CmdCopyFNAResponse](docs/CmdCopyFNAResponse.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [OrganizationsCreateOrganizationPayload](docs/OrganizationsCreateOrganizationPayload.md)
- [OrganizationsCreateOrganizationResponse](docs/OrganizationsCreateOrganizationResponse.md)
- [OrganizationsListOrganizationsResponse](docs/OrganizationsListOrganizationsResponse.md)
- [OrganizationsOrganization](docs/OrganizationsOrganization.md)
- [PlansListPlansResponse](docs/PlansListPlansResponse.md)
- [PlansPlan](docs/PlansPlan.md)
- [UserCreateUserPayload](docs/UserCreateUserPayload.md)
- [UserCreateUserResponse](docs/UserCreateUserResponse.md)
- [UserTransferDataPayload](docs/UserTransferDataPayload.md)
- [UsersListUsersResponse](docs/UsersListUsersResponse.md)
- [UsersUser](docs/UsersUser.md)
- [UsersUserContext](docs/UsersUserContext.md)

### Authorization


Authentication schemes defined for the API:
<a id="OAuth2-implicit"></a>
#### OAuth2 implicit


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: https://secure.kronos-web.com/oauth/authorize
- **Scopes**: 
  - `fna:fna`: Grants all access to plan/fna (deprecated)
  - `plan:plan`: Grants all access to plan/fna
  - `plan:plan:create`: Creation access on plan
  - `plan:organization`: Grants all access to plan/organizations
  - `plan:user`: Grants all access to plan/users

## About

This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
and is automatically generated by the
[OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `latest`
- Package version: `latest`
- Generator version: `7.20.0-equisoft1`
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`

The generated npm module supports the following:

- Environments
  * Node.js
  * Webpack
  * Browserify
- Language levels
  * ES5 - you must have a Promises/A+ library installed
  * ES6
- Module systems
  * CommonJS
  * ES6 module system


## Development

### Building

To build the TypeScript source code, you need to have Node.js and npm installed.
After cloning the repository, navigate to the project directory and run:

```bash
npm install
npm run build
```

### Publishing

Once you've built the package, you can publish it to npm:

```bash
npm publish
```

## License

[]()