coolcolduk / etsy-ts

Etsy API wrapper written in typescript

etsy-ts

Etsy API wrapper written in TypeScript. Includes types for all Etsy API endpoints.

Installation:

npm install etsy-ts --save
yarn add etsy-ts

Etsy API v3

See example in examples/run.ts
Find full API v3 documentation on Etsy.

Breaking changes when migrating from 3.x.x to 4.x.x

• Support for Etsy APIv2 is removed
• All v3 modules are now imported from the root of the package, e.g. import { Etsy } from 'etsy-ts' instead of import { Etsy } from 'etsy-ts/v3'
• Etsy class constructor now requires SecurityDataStorage instance that implements ISecurityDataStorage interface. See a sample implementation in examples/v3/SecurityDataStorage.ts.
• You should remove the refresh token logic from your code - now that's included within this client
• For methods that require oauth, now you need to pass etsyUserId instead of accessToken. This client will use SecurityDataStorage instance to get, refresh and save accessToken for the given etsyUserId.

Credits

Most of the code is generated from Etsy APIv3 Swagger specs, fed to swagger-typescript-api.