@teemill/[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 build

Publishing

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 @teemill/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.localhost:8080

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BlogsApi | exportBlogs | GET /v1/website/blogs/export | Export blogs BlogsApi | getBlog | GET /v1/website/blogs/{blogId} | Get website blog post BlogsApi | listBlogs | GET /v1/website/blogs | List website blog posts BlogsApi | updateBlog | PATCH /v1/website/blogs/{blogId} | Update website blog post BlogsApi | updateBlogs | PATCH /v1/website/blogs | Update website blog posts CrossSellApi | attachCrossSellProducts | PUT /v1/website/products/{productId}/cross-sell/products | Attach cross-sell products CrossSellApi | getCrossSellProducts | GET /v1/website/products/{productId}/cross-sell/products | Get cross-sell products linked to a product DefaultApi | getBrand | GET /v1/website/brand | Get brand DefaultApi | updateBrand | PATCH /v1/website/brand | Update brand FooterApi | getFooter | GET /v1/website/footer | Get footer FooterApi | updateFooter | PUT /v1/website/footer | Update footer MenuApi | getMenu | GET /v1/website/menu | Get menu MenuApi | updateMenu | PUT /v1/website/menu | Update menu PagesApi | exportPages | GET /v1/website/pages/export | Export pages PagesApi | getPage | GET /v1/website/pages/{pageId} | Get website page PagesApi | listPages | GET /v1/website/pages | List website pages PagesApi | seoOptimisePages | POST /v1/website/pages/ai-seo-optimise | AI SEO optimise pages PagesApi | updatePage | PATCH /v1/website/pages/{pageId} | Update website page PagesApi | updatePages | PATCH /v1/website/pages | Update website pages PaymentApi | authorizePayPal | GET /v1/website/payment/paypal/authorize | Authorize PayPal PaymentApi | authorizeStripe | GET /v1/website/payment/stripe/authorize | Authorize Stripe PaymentApi | deauthorizePayPal | DELETE /v1/website/payment/paypal/deauthorize | Deauthorize PayPal PaymentApi | deauthorizeStripe | DELETE /v1/website/payment/stripe/deauthorize | Deauthorize Stripe PaymentApi | getPayPalPaymentAccount | GET /v1/website/payment/paypal | Get PayPal Payment Account PaymentApi | getStripePaymentAccount | GET /v1/website/payment/stripe | Get Stripe Payment Account ReviewsApi | exportReviews | GET /v1/website/reviews/export | Export reviews ReviewsApi | getReview | GET /v1/website/reviews/{reviewId} | Get review ReviewsApi | listReviews | GET /v1/website/reviews | List Reviews ReviewsApi | moderateReview | PATCH /v1/website/reviews/{reviewId}/moderate | Moderate review RoutesApi | listRoutes | GET /v1/website/routes | List routes SearchApi | createSearchRedirect | POST /v1/website/search/redirects | Create search redirect SearchApi | deleteSearchRedirect | DELETE /v1/website/search/redirects/{redirectId} | Delete search redirect SearchApi | getSearchRedirect | GET /v1/website/search/redirects/{redirectId} | Get search redirect SearchApi | listSearchRedirects | GET /v1/website/search/redirects | List search redirects SearchApi | updateSearchRedirect | PATCH /v1/website/search/redirects/{redirectId} | Update search redirect WebsiteApi | createDomain | POST /v1/website/domains | Create a website domain WebsiteApi | deleteDomain | DELETE /v1/website/domains/{domain} | Delete a website domain WebsiteApi | listDomains | GET /v1/website/domains | List website domains WebsiteApi | updateBaseDomain | PUT /v1/website/domains/base | Update base domain

Documentation For Models

• ApiError
• Application
• ApplicationMockup
• AttachCrossSellProductsRequest
• Attribute
• AttributeThumbnail
• AuthorizeStripe200Response
• Blog
• BlogsResponse
• Brand
• CreateDomainRequest
• CreateSearchRedirectRequest
• Domain
• ExportPages202Response
• Footer
• FooterItem
• Image
• ListDomains200Response
• ListRoutesResponse
• Menu
• MenuItem
• MetaField
• MetaImage
• ModerateReviewRequest
• NullableMetaImage
• OptimisationHistoryItem
• Page
• PagesResponse
• PaymentAccount
• Price
• Product
• ProductAdditionalFilesInner
• ProductApplicationSetsInner
• ProductWarehouseProduct
• Review
• ReviewAuthor
• ReviewImagesInner
• ReviewProduct
• ReviewReply
• ReviewReplyAuthor
• ReviewsResponse
• Route
• SalePrice
• SearchRedirect
• SearchRedirectsResponse
• SeoMetadata
• SeoOptimisePages202Response
• SeoOptimisePagesRequest
• Stock
• SubmenuInner
• SubmenuInnerImage
• SubmenuInnerImageButton
• SubmenuInnerImageText
• SubmenuItem
• TargetSearchPhraseData
• UpdateBlogRequest
• UpdateBlogsRequest
• UpdateBlogsRequestBlogsInner
• UpdateBlogsRequestBlogsInnerSeoMetadata
• UpdateBrandRequest
• UpdateFooterRequest
• UpdateFooterRequestItemsInner
• UpdateMenuRequest
• UpdateMenuRequestItem
• UpdateMenuRequestItemSubmenuInner
• UpdateMenuRequestItemSubmenuInnerImage
• UpdateMenuRequestItemSubmenuInnerImageButton
• UpdateMenuRequestItemSubmenuInnerImageText
• UpdateMenuRequestSubmenuItem
• UpdatePageRequest
• UpdatePagesRequest
• UpdatePagesRequestPagesInner
• UpdateSearchRedirectRequest
• Variant
• VariantProduct
• Video

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A