@teemill/ai-builder
v1.17.0
Published
OpenAPI client for @teemill/ai-builder
Downloads
397
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.localhost:8080
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ProductsApi | continueProductIdeasGeneration | POST /v1/ai-builder/products/generations/{generationId}/continue | Continue a staged product ideas generation ProductsApi | createDesignStyle | POST /v1/ai-builder/products/styles | Create design style ProductsApi | createIntentIdea | POST /v1/ai-builder/products/generations/{generationId}/intent-ideas | Create an intent idea ProductsApi | createMoodboardImage | POST /v1/ai-builder/products/generations/{generationId}/moodboard/images | Add an image to the intent moodboard ProductsApi | createProductIdeaChatChannel | POST /v1/ai-builder/products/ideas/{ideaId}/chat-channel | Create chat channel ProductsApi | createProductsFromIdeas | POST /v1/ai-builder/products/create | Create products from ideas ProductsApi | deleteIntentIdea | DELETE /v1/ai-builder/products/generations/{generationId}/intent-ideas/{ideaId} | Delete an intent idea ProductsApi | deleteMoodboardImage | DELETE /v1/ai-builder/products/generations/{generationId}/moodboard/images/{imageId} | Remove an image from the intent moodboard ProductsApi | deleteProductIdea | DELETE /v1/ai-builder/products/ideas/{ideaId} | Delete product idea ProductsApi | generateProductIdeas | POST /v1/ai-builder/products/generations | Generate product ideas ProductsApi | getDesignStyle | GET /v1/ai-builder/products/styles/{styleId} | Get design style ProductsApi | getProductIdeasGeneration | GET /v1/ai-builder/products/generations/{generationId} | Get product ideas generation ProductsApi | getSuggestedCollections | POST /v1/ai-builder/products/ideas/suggest-collections | Get suggested collections for product ideas ProductsApi | listProductIdeasGenerations | GET /v1/ai-builder/products/generations | List product ideas generations ProductsApi | updateIntentConcept | PATCH /v1/ai-builder/products/generations/{generationId}/concepts/{conceptId} | Update an intent concept ProductsApi | updateIntentIdea | PATCH /v1/ai-builder/products/generations/{generationId}/intent-ideas/{ideaId} | Update an intent idea ProductsApi | updateProductIdea | PATCH /v1/ai-builder/products/ideas/{ideaId} | Update product idea
Documentation For Models
- ApiError
- Collection
- ContinueProductIdeasGeneration202Response
- CreateDesignStyleRequest
- CreateDesignStyleRequestImagesInner
- CreateIntentIdeaRequest
- CreateMoodboardImageRequest
- CreateProductIdeaChatChannel200Response
- CreateProductsFromIdeas202Response
- CreateProductsFromIdeasRequest
- CreatedProduct
- DeleteProductIdeaRequest
- DesignStyle
- DesignStyleImagesInner
- GenerateProductIdeas202Response
- GenerateProductIdeasRequest
- GetSuggestedCollectionsRequest
- IntentConcept
- IntentConceptMoodboardImage
- IntentIdea
- IntentMoodboardImage
- ProductIdea
- ProductIdeaColorsInner
- ProductIdeaIterationsInner
- ProductIdeaOutputFilesInner
- ProductIdeasGeneration
- ProductIdeasGenerationInput
- ProductIdeasGenerationMoodboard
- ProductIdeasGenerationsResponse
- SuggestedCollectionsResponse
- UpdateIntentConceptRequest
- UpdateIntentIdeaRequest
- UpdateProductIdeaRequest
- UpdateProductIdeaRequestColorsInner
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
