Licence
Unlicense
Version
1.100.0
Deps
1
Size
1.4 MB
Vulns
0
Weekly
0
@teemill/product-catalog@1.100.0
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/product-catalog@1.100.0 --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
Documentation 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 |
| ProductAnalyticsApi | exportProductAnalytics | GET /v1/catalog/analytics/export | Export product analytics |
| ProductAnalyticsApi | getProductAnalyticsSummary | GET /v1/catalog/analytics/summary | Get product analytics summary |
| ProductAnalyticsApi | listProductAnalytics | GET /v1/catalog/analytics | List product analytics |
| ProductCreatorsApi | listProductCreators | GET /v1/catalog/creators | List product creators |
| ProductTypesApi | listProductTypes | GET /v1/catalog/product-types | List product types |
| ProductsApi | autoMerchProducts | POST /v1/catalog/products/auto-merch | AI auto merchandise products. |
| 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
- Action
- AdditionalFile
- AnalyticsItem
- AnalyticsSummary
- ApiError
- Application
- ApplicationGroup
- ApplicationGroupsResponse
- ApplicationMockup
- ApplicationProperties
- ApplicationPropertiesMetadata
- ApplicationPropertiesPersonalization
- ApplicationPropertiesPersonalizationRules
- ApplicationPropertiesPosition
- ApplicationPropertiesPositionInference
- ApplicationPropertiesProperties
- ApplicationSet
- ApplicationSet1
- ApplicationSetRecord
- ApplicationSetsResponse
- ApplicationTechnologiesResponse
- ApplicationTechnology
- ApplicationTechnologyIntegrationProduct
- Attribute
- AttributeThumbnail
- AutoMerchProductsRequest
- BundleProduct
- CreateApplication
- CreateApplicationGroupRequest
- CreateApplicationProperties
- CreateApplicationSetRequest
- CreateApplicationSetRequestRecordsInner
- CreateApplicationSetRequestRecordsInnerAttributesInner
- CreateBundleProduct
- CreateBundleProductSeoMetadata
- CreateDigitalProduct
- CreateDigitalProductVariantsInner
- CreateDigitalProductVariantsInnerAttributesInner
- CreateDigitalProductVariantsInnerImagesInner
- CreateProduct
- CreateProductAdditionalFilesInner
- CreateProductImagesInner
- CreateProductRequest
- CreateProductVariant
- CreateProductVariantAttributesInner
- CreateProductVariantImagesInner
- CreateProductVideosInner
- DeleteProductsRequest
- DuplicateProductsRequest
- ExportProducts202Response
- Image
- ImageFile
- ImageFileFocalPoint
- ImportProducts200Response
- License
- Location
- MarketplaceListing
- MetaField
- NamedPrice
- OptimisationHistoryItem
- PersonalizationOptional
- Price
- Product
- ProductAdditionalFilesInner
- ProductAnalytics
- ProductAnalyticsResponse
- ProductApplicationSetsInner
- ProductAttribute
- ProductAttributeValue
- ProductBundleItemsInner
- ProductGfnProduct
- ProductStaticCollectionsInner
- ProductType
- ProductTypeListResponse
- ProductWarehouseProduct
- ProductsResponse
- Recommendation
- RequiredPrice
- SEOMetadata
- SEOMetadata1
- SalePrice
- SeoOptimiseProductsRequest
- Stock
- TargetSearchPhraseData
- TextApplicationProperties
- TextApplicationPropertiesMetadata
- TextApplicationPropertiesPersonalization
- TextApplicationPropertiesPersonalizationRules
- TextApplicationPropertiesPosition
- UpdateApplicationGroupRequest
- UpdateApplicationSetRequest
- UpdateApplicationSetRequestRecordsInner
- UpdateApplicationSetRequestRecordsInnerAttributesInner
- UpdateProductRequest
- UpdateProductRequestAttributesInner
- UpdateProductRequestBundleItemsInner
- UpdateProductRequestBundleItemsInnerConfig
- UpdateProductRequestBundleItemsInnerConfigValidOptionsInner
- UpdateProductsRequest
- UpdateProductsRequestProductsInner
- UpdateProductsRequestProductsInnerCollectionsInner
- UpdateProductsRequestProductsInnerLicense
- UpdateProductsRequestProductsInnerSeoMetadata
- UpdateProductsRequestProductsInnerVariantsInner
- UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
- UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
- UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
- UpdateProductsRequestProductsInnerVariantsInnerSalePrice
- UserList
- UserListCreatorsInner
- UserListCreatorsInnerAvatar
- Variant
- VariantGfnVariant
- VariantProduct
- VariantWarehouseVariant
- 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