Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CON-453 add delete stock functions #41

Merged
merged 5 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18.20.2
20.15.0
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@

# 🤖 Introduction

This is a JavaScript/TypeScript SDK for the [fulfillmenttools API](https://fulfillmenttools.github.io/api-reference-ui/).
This is a JavaScript/TypeScript SDK for the [fulfillmenttools API](https://docs.fulfillmenttools.com/api-docs/).

## 👨‍💻 Development

### 👉 Requirements

- [Node.js](https://nodejs.org/en/) 18 with [NVM](https://github.com/nvm-sh/nvm) and npm
- [Node.js](https://nodejs.org/en/) 20 with [NVM](https://github.com/nvm-sh/nvm) and npm

### 🛫 Setup

Expand Down Expand Up @@ -56,6 +56,10 @@ $ npm run lint
This software is published on [npmjs.com](https://www.npmjs.com/package/@fulfillmenttools/fulfillmenttools-sdk-typescript).
The package contains both an ESM and a CommonJS build.

```bash
$ npm install @fulfillmenttools/fulfillmenttools-sdk-typescript`
```

Here's a little example how to create a client instance in TypeScript:

```typescript
Expand All @@ -74,7 +78,7 @@ const fftOrder = {} as OrderForCreation;
await fftOrderService.create(fftOrder);
```

By default, logging is disabled. If you wish to have the HttpClient logging enabled, just add a boolean to your `FftApiClient`:
By default, HTTP request logging is disabled. If you wish to have it logging enabled, just add a boolean to your `FftApiClient`:
```typescript
import { FftApiClient, FftOrderService, OrderForCreation } from '@fulfillmenttools/fulfillmenttools-sdk-typescript';

Expand All @@ -85,11 +89,6 @@ const fftApiClient = new FftApiClient(
process.env.FFT_API_KEY || '',
process.env.FFT_LOGGING_ENABLED || true
);

const fftOrderService = new FftOrderService(fftApiClient);

const fftOrder = {} as OrderForCreation;
await fftOrderService.create(fftOrder);
```

## 📖 Documentation
Expand Down
Loading