@teemill/product-catalog
v1.80.0
Published
OpenAPI client for @teemill/product-catalog
Downloads
559
Readme
@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 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 @teemill/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://api.podos.io
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApplicationGroupsApi | createApplicationGroup | POST /v1/catalog/applications/groups | Create application group ApplicationGroupsApi | deleteApplicationGroup | DELETE /v1/catalog/applications/groups/{applicationGroupId} | Delete an application group ApplicationGroupsApi | getApplicationGroup | GET /v1/catalog/applications/groups/{applicationGroupId} | Get an application group ApplicationGroupsApi | listApplicationGroups | GET /v1/catalog/applications/groups | List application groups ApplicationGroupsApi | updateApplicationGroup | PATCH /v1/catalog/applications/groups/{applicationGroupId} | Update application group ApplicationSetsApi | createApplicationSet | POST /v1/catalog/applications/sets | Create application set ApplicationSetsApi | deleteApplicationSet | DELETE /v1/catalog/applications/sets/{applicationSetId} | Delete an application set ApplicationSetsApi | getApplicationSet | GET /v1/catalog/applications/sets/{applicationSetId} | Get an application set ApplicationSetsApi | listApplicationSets | GET /v1/catalog/applications/sets | List application sets ApplicationSetsApi | updateApplicationSet | PATCH /v1/catalog/applications/sets/{applicationSetId} | Update application set ApplicationTechnologiesApi | listTechnologies | GET /v1/catalog/applications/technologies | List technologies available to this project ProductsApi | createProduct | POST /v1/catalog/products | Create product ProductsApi | deleteProduct | DELETE /v1/catalog/products/{productId} | Delete catalog product ProductsApi | deleteProducts | DELETE /v1/catalog/products | Delete products ProductsApi | duplicateProducts | POST /v1/catalog/products/duplicate | Duplicate products. ProductsApi | exportProducts | GET /v1/catalog/products/export | Export products ProductsApi | getProduct | GET /v1/catalog/products/{productId} | Get product ProductsApi | importProducts | POST /v1/catalog/products/import | Import products ProductsApi | listProducts | GET /v1/catalog/products | List products ProductsApi | seoOptimiseProducts | POST /v1/catalog/products/ai-seo-optimise | AI SEO optimise products. ProductsApi | updateProduct | PATCH /v1/catalog/products/{productId} | Update product ProductsApi | updateProducts | PATCH /v1/catalog/products | Update products VariantsApi | getVariant | GET /v1/catalog/variants/{variantId} | Get variant VariantsApi | listVariants | GET /v1/catalog/variants | List variants
Documentation For Models
- AdditionalFile
- ApiError
- Application
- ApplicationGroup
- ApplicationGroupsResponse
- ApplicationMockup
- ApplicationProperties
- ApplicationPropertiesMetadata
- ApplicationPropertiesMetadataPersonalization
- ApplicationPropertiesPersonalization
- ApplicationPropertiesPersonalizationRules
- ApplicationPropertiesPosition
- ApplicationPropertiesPositionInference
- ApplicationPropertiesProperties
- ApplicationSet
- ApplicationSet1
- ApplicationSetRecord
- ApplicationSetsResponse
- ApplicationTechnologiesResponse
- ApplicationTechnology
- ApplicationTechnologyIntegrationProduct
- Attribute
- AttributeThumbnail
- Attributes1Inner
- BundleProduct
- CreateApplication
- CreateApplicationGroupRequest
- CreateApplicationProperties
- CreateApplicationSetRequest
- CreateApplicationSetRequestRecordsInner
- CreateApplicationSetRequestRecordsInnerAttributesInner
- CreateBundleProduct
- CreateBundleProductBundleItemsInner
- CreateProduct
- CreateProductAdditionalFilesInner
- CreateProductImagesInner
- CreateProductRequest
- CreateProductVariant
- CreateProductVariantImagesInner
- CreateProductVideosInner
- DeleteProductsRequest
- DuplicateProducts202Response
- DuplicateProductsRequest
- ExportProducts202Response
- Image
- ImageFile
- ImageFileFocalPoint
- ImportProducts200Response
- License
- Location
- MetaField
- NamedPrice
- OptimisationHistoryItem
- Price
- Product
- ProductAdditionalFilesInner
- ProductApplicationSetsInner
- ProductBundleItemsInner
- ProductWarehouseProduct
- ProductsResponse
- RequiredPrice
- SEOMetadata
- SalePrice
- SeoOptimiseProducts202Response
- SeoOptimiseProductsRequest
- Stock
- TargetSearchPhraseData
- TextApplicationProperties
- TextApplicationPropertiesPersonalization
- TextApplicationPropertiesPersonalizationRules
- TextApplicationPropertiesPosition
- UpdateApplicationGroupRequest
- UpdateApplicationSetRequest
- UpdateApplicationSetRequestRecordsInner
- UpdateApplicationSetRequestRecordsInnerAttributesInner
- UpdateProductRequest
- UpdateProductRequestBundleItemsInner
- UpdateProductRequestBundleItemsInnerConfig
- UpdateProductRequestBundleItemsInnerConfigValidOptionsInner
- UpdateProductRequestIntegrationConnectionsInner
- UpdateProductsRequest
- UpdateProductsRequestProductsInner
- UpdateProductsRequestProductsInnerIntegrationConnectionsInner
- UpdateProductsRequestProductsInnerLicense
- UpdateProductsRequestProductsInnerSeoMetadata
- UpdateProductsRequestProductsInnerVariantsInner
- UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
- UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
- UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
- UpdateProductsRequestProductsInnerVariantsInnerSalePrice
- Variant
- VariantIntegrationConnectionsInner
- VariantProduct
- VariantWholesaleCost
- VariantsResponse
- Video
- VideoFile
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
