Skip to main content

ProductApi

valkyrai-api

All URIs are relative to http://localhost:8080/v1

MethodHTTP requestDescription
deleteProductDELETE ProductApiDelete a Product.

deleteProduct

Void
deleteProduct(id)

Delete a Product.

Deletes a specific Product.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.ProductApi;


ProductApi apiInstance = new ProductApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Product.

try {
Void result = apiInstance.deleteProduct(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#deleteProduct");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Product.

Return type

Void

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getProduct

Product
getProduct(id)

Retrieve a single Product

Retrieves a single Product for a specific uid.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.ProductApi;


ProductApi apiInstance = new ProductApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Product.

try {
Product result = apiInstance.getProduct(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#getProduct");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Product.

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProductList

Product
getProductList()

Retrieve a list of Products

Retrieves a list of Products.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.ProductApi;


ProductApi apiInstance = new ProductApi();

try {
Product result = apiInstance.getProductList();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#getProductList");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

postProduct

Product
postProduct(product)

Create a new Product

Creates a new Product.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.ProductApi;


ProductApi apiInstance = new ProductApi();
Product product = new Product(); // Product | Product details.

try {
Product result = apiInstance.postProduct(product);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#postProduct");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
productProductProduct details.

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateProduct

Product
updateProduct(idproduct)

Update an existing Product

Updates an existing Product.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.ProductApi;


ProductApi apiInstance = new ProductApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Product.
Product product = new Product(); // Product | Updated Product details.

try {
Product result = apiInstance.updateProduct(idproduct);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#updateProduct");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Product.
productProductUpdated Product details.

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-04-09T20:27:13.881184-07:00[America/Los_Angeles]