# apigee-api

> Typescript/Javascript Node library for the Apigee Management API

Latest version **0.0.2** (published 2018-12-06) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install apigee-api
pnpm add apigee-api
yarn add apigee-api
bun add apigee-api
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-12-06 |
| First published | 2018-12-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 7.9 MB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Author | api-infrastructure-team@bazaarvoice.com |
| Maintainers | apii |
| Keywords | apigee, api, typescript, node |

## Links

- npm: https://www.npmjs.com/package/apigee-api
- Homepage: https://github.com/bazaarvoice/apigee-api
- npm.io page: https://npm.io/package/apigee-api

## Dependencies (9)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [jszip](https://npm.io/package/jszip.md) ^3.1.3
- [request](https://npm.io/package/request.md) ^2.81.0
- [form-data](https://npm.io/package/form-data.md) ^2.3.2
- [@types/node](https://npm.io/package/@types/node.md) ^8.0.19
- [@types/jszip](https://npm.io/package/@types/jszip.md) ^0.0.33
- [@types/request](https://npm.io/package/@types/request.md) ^2.0.0
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.4
- [@types/request-promise-native](https://npm.io/package/@types/request-promise-native.md) ^1.0.6

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2018-12-06

## README

# apigee-api

Typescript/Javascript node/browser compatible library for interacting with the [Apigee Management API](http://docs.apigee.com/api-services/content/apigee-reference).

## Usage

Install library as project dependency:
```sh
npm install apigee-api --save
```

### Typescript
```typescript
import { ApigeeClient, ApigeeClientConfig } from 'apigee-api';

// create a new client
const config: ApigeeClientConfig = {
    endpoint: 'https://api.enterprise.apigee.com',
    version: 'v1',
    username: 'myusername',
    password: 'mypassword',
    organization: 'myorg',
    environment: 'myenv'
};

const client = new ApigeeClient(config);

// use promises
client.proxies().list().then(proxies => console.log(proxies));

// or use async/await
const func = async () => {
    const proxies = await client.proxies().list();
    console.log(proxies);
};

func();
```

### Javscript ES6
```javascript
const apigee = require('apigee-api');

// create a new client
const config = {
    endpoint: 'https://api.enterprise.apigee.com',
    version: 'v1',
    username: 'myusername',
    password: 'mypassword',
    organization: 'myorg',
    environment: 'myenv'
};

const client = new apigee.ApigeeClient(config);

// use promises
client.proxies().list().then(proxies => console.log(proxies));
```

## Development

1. Fork the repo
2. Clone your fork

### Requirements

- [nvm](https://github.com/creationix/nvm) for Node version management
    - `brew install nvm`
    - `.nvmrc` file will be used to download and load the correct Node environment automatically
- [Visiual Studio Code](https://code.visualstudio.com/) for editing and debugging
    - `brew cask install visual-studio-code` 

### Testing

1. Run the following command to auto compile source code into `lib/`:
    - ``npm run build``
2. Create a config file for the tests to use:
    - `cp config/test.json.example config/test.json`
3. Run `npm test` or `npm run test` to run all tests under `test/`
4. Debug in VScode ([See Debugging Section](#debugging))

### Debugging

The Visual Studio Code Editor is utilized to provide debugging functionality during testing. 
A `task` is provided under `.vscode/` which takes care of running the tests in debug mode. 
Simply place a break point anywhere in the tests or library code and start debugging (use the `Debug` menu in VSCode).

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