@aligate/sdk
v2.3.0
Published
OpenAPI client for @aligate/sdk
Maintainers
Readme
@aligate/[email protected]
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)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @aligate/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://aligate-aliexpress-data-api.p.rapidapi.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DefaultApi | getProductInfo | GET /api/v2/product | Get Product Info DefaultApi | getProductReviews | GET /api/v2/product/reviews | Get Product Reviews DefaultApi | getSellerCoupons | GET /api/v2/seller/coupons | Get Seller Coupons DefaultApi | getSellerInfo | GET /api/v2/seller | Get Seller Info DefaultApi | getSellerProducts | GET /api/v2/seller/products | Get Seller Products DefaultApi | healthCheck | GET /api/v2/health | Health check DefaultApi | searchByImage | POST /api/v2/search/image | Search By Image DefaultApi | searchByImageURL | GET /api/v2/search/image | Search By Image URL DefaultApi | searchByText | GET /api/v2/search/text | Search By Text
Documentation For Models
- ConfigurationPrice
- ConfigurationProperty
- Coupon
- CouponMeta
- CouponSettings
- CouponsParseResponse
- HealthCheck200Response
- ImageSearchMeta
- ImageSearchParseResponse
- ImageSearchRequest
- ImageSearchSettings
- ModelError
- ParseMeta
- ParseResponse
- ParseSettings
- Price
- Product
- ProductConfiguration
- ProductDescription
- ProductSeller
- ProductVideo
- RatingBreakdown
- Review
- ReviewBuyer
- ReviewContent
- ReviewFilterStat
- ReviewLabel
- ReviewsMeta
- ReviewsParseResponse
- ReviewsResult
- ReviewsSettings
- SearchCategory
- SearchMeta
- SearchParseResponse
- SearchResult
- SearchSettings
- SellerItem
- SellerMeta
- SellerParseResponse
- SellerProductsMeta
- SellerProductsParseResponse
- SellerProductsResult
- SellerProductsSettings
- SellerSettings
- ShippingMethod
- StoreCategory
Documentation For Authorization
Endpoints do not require authorization.
