This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json
. (Reference)
To build and compile the typescript sources to javascript use:
npm install
npm run build
First build the package then run npm publish
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @teemill/product-feed@0.18.3 --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
All URIs are relative to https://api.localhost:8080
Class | Method | HTTP request | Description |
---|---|---|---|
ExchangeRatesApi | batchUpdateExchangeRates | PATCH /admin/currencies/exchange-rates | Batch update exchange rates |
FeedApi | createFeed | POST /feeds | Create feed |
FeedApi | deleteFeed | DELETE /feeds/{feedId} | Delete feed |
FeedApi | downloadFeed | GET /download/{filename} | Download feed |
FeedApi | getFeed | GET /feeds/{feedId} | Get feed |
FeedApi | listFeeds | GET /feeds | List feeds |
FeedApi | updateFeed | PATCH /feeds/{feedId} | Update feed |
ItemApi | batchCreateItemGroups | POST /items | Batch create or overwrite item groups |
ItemApi | batchDeleteItemGroups | DELETE /items | Batch delete item groups |
ItemApi | batchModifyItemGroups | PATCH /items | Batch modify item groups |
ItemApi | deleteItemGroup | DELETE /items/{itemGroupId} | Delete an item group |
ProjectApi | getProject | GET /admin/projects/{project} | Get a project |
ProjectApi | listProject | GET /admin/projects | List projects |
ProjectApi | setupProject | POST /admin/projects/{project} | Setup new projects |
ProjectApi | teardownProject | DELETE /admin/projects/{project} | Teardown product feed project |
ProjectApi | updateProject | PATCH /admin/projects/{project} | Update product feed project |
TagApi | listTags | GET /tags | List tags |
WarehouseProductApi | adminBatchCreateWarehouseProducts | POST /admin/warehouse-products | Admin batch create or update warehouse products |
WarehouseProductApi | adminDeleteWarehouseProduct | DELETE /admin/warehouse-products/{warehouseProductId} | Admin delete warehouse product |
- AdminBatchCreateWarehouseProductsRequestInner
- ApiError
- BaseFeed
- BaseItem
- BaseItemImagesInner
- BatchCreateItemGroupsRequestInner
- BatchDeleteItemGroupsRequest
- BatchDeleteItemGroupsRequestFilters
- BatchModifyItemGroupsRequestInner
- BatchUpdateExchangeRatesRequestInner
- CountryFeed
- CountryFeedConfig
- CountryFeedType
- CreateCountryFeed
- CreateFeedRequest
- CreatePlatformFeed
- CreateProductFeed
- CreateYoutubeFeed
- Demographic
- FeedList
- FeedListFeedsInner
- InlineObject
- InlineObject1
- Item
- ItemType
- ModifiableItem
- PlatformFeed
- PlatformFeedConfig
- PlatformFeedType
- ProductFeed
- ProductFeedConfig
- ProductFeedType
- Project
- SetupProjectRequest
- SetupProjectRequestServiceAccount
- ShippingPerCountryValue
- YoutubeFeed
- YoutubeFeedConfig
- YoutubeFeedType
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes: N/A