@space-cow-media/spellbook-client 4.8.13 → 4.8.15

package/spellbook-client/docs/VariantSuggestionsApi.md

@@ -0,0 +1,707 @@
+# VariantSuggestionsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**variantSuggestionsCreate**](VariantSuggestionsApi.md#variantsuggestionscreate) | **POST** /variant-suggestions/ |  |
+| [**variantSuggestionsDestroy**](VariantSuggestionsApi.md#variantsuggestionsdestroy) | **DELETE** /variant-suggestions/{id}/ |  |
+| [**variantSuggestionsList**](VariantSuggestionsApi.md#variantsuggestionslist) | **GET** /variant-suggestions/ |  |
+| [**variantSuggestionsPartialUpdate**](VariantSuggestionsApi.md#variantsuggestionspartialupdate) | **PATCH** /variant-suggestions/{id}/ |  |
+| [**variantSuggestionsRetrieve**](VariantSuggestionsApi.md#variantsuggestionsretrieve) | **GET** /variant-suggestions/{id}/ |  |
+| [**variantSuggestionsUpdate**](VariantSuggestionsApi.md#variantsuggestionsupdate) | **PUT** /variant-suggestions/{id}/ |  |
+| [**variantSuggestionsValidateCreate**](VariantSuggestionsApi.md#variantsuggestionsvalidatecreate) | **POST** /variant-suggestions/validate/ |  |
+| [**variantSuggestionsValidatePartialUpdate**](VariantSuggestionsApi.md#variantsuggestionsvalidatepartialupdate) | **PATCH** /variant-suggestions/{id}/validate/ |  |
+| [**variantSuggestionsValidateUpdate**](VariantSuggestionsApi.md#variantsuggestionsvalidateupdate) | **PUT** /variant-suggestions/{id}/validate/ |  |
+
+
+
+## variantSuggestionsCreate
+
+> VariantSuggestion variantSuggestionsCreate(variantSuggestionRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // VariantSuggestionRequest
+    variantSuggestionRequest: ...,
+  } satisfies VariantSuggestionsCreateRequest;
+
+  try {
+    const data = await api.variantSuggestionsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **variantSuggestionRequest** | [VariantSuggestionRequest](VariantSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsDestroy
+
+> variantSuggestionsDestroy(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsDestroyRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant suggestion.
+    id: 56,
+  } satisfies VariantSuggestionsDestroyRequest;
+
+  try {
+    const data = await api.variantSuggestionsDestroy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this variant suggestion. | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No response body |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsList
+
+> PaginatedVariantSuggestionList variantSuggestionsList(limit, offset, suggestedBy)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsListRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | Number of results to return per page. (optional)
+    limit: 56,
+    // number | The initial index from which to return the results. (optional)
+    offset: 56,
+    // number (optional)
+    suggestedBy: 56,
+  } satisfies VariantSuggestionsListRequest;
+
+  try {
+    const data = await api.variantSuggestionsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | The initial index from which to return the results. | [Optional] [Defaults to `undefined`] |
+| **suggestedBy** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedVariantSuggestionList**](PaginatedVariantSuggestionList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsPartialUpdate
+
+> VariantSuggestion variantSuggestionsPartialUpdate(id, patchedVariantSuggestionRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsPartialUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant suggestion.
+    id: 56,
+    // PatchedVariantSuggestionRequest (optional)
+    patchedVariantSuggestionRequest: ...,
+  } satisfies VariantSuggestionsPartialUpdateRequest;
+
+  try {
+    const data = await api.variantSuggestionsPartialUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this variant suggestion. | [Defaults to `undefined`] |
+| **patchedVariantSuggestionRequest** | [PatchedVariantSuggestionRequest](PatchedVariantSuggestionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsRetrieve
+
+> VariantSuggestion variantSuggestionsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsRetrieveRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant suggestion.
+    id: 56,
+  } satisfies VariantSuggestionsRetrieveRequest;
+
+  try {
+    const data = await api.variantSuggestionsRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this variant suggestion. | [Defaults to `undefined`] |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsUpdate
+
+> VariantSuggestion variantSuggestionsUpdate(id, variantSuggestionRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant suggestion.
+    id: 56,
+    // VariantSuggestionRequest
+    variantSuggestionRequest: ...,
+  } satisfies VariantSuggestionsUpdateRequest;
+
+  try {
+    const data = await api.variantSuggestionsUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this variant suggestion. | [Defaults to `undefined`] |
+| **variantSuggestionRequest** | [VariantSuggestionRequest](VariantSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsValidateCreate
+
+> VariantSuggestion variantSuggestionsValidateCreate(variantSuggestionRequest)
+
+
+
+Validate the variant suggestion data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsValidateCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // VariantSuggestionRequest
+    variantSuggestionRequest: ...,
+  } satisfies VariantSuggestionsValidateCreateRequest;
+
+  try {
+    const data = await api.variantSuggestionsValidateCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **variantSuggestionRequest** | [VariantSuggestionRequest](VariantSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsValidatePartialUpdate
+
+> VariantSuggestion variantSuggestionsValidatePartialUpdate(id, patchedVariantSuggestionRequest)
+
+
+
+Validate the variant suggestion update data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsValidatePartialUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant suggestion.
+    id: 56,
+    // PatchedVariantSuggestionRequest (optional)
+    patchedVariantSuggestionRequest: ...,
+  } satisfies VariantSuggestionsValidatePartialUpdateRequest;
+
+  try {
+    const data = await api.variantSuggestionsValidatePartialUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this variant suggestion. | [Defaults to `undefined`] |
+| **patchedVariantSuggestionRequest** | [PatchedVariantSuggestionRequest](PatchedVariantSuggestionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## variantSuggestionsValidateUpdate
+
+> VariantSuggestion variantSuggestionsValidateUpdate(id, variantSuggestionRequest)
+
+
+
+Validate the variant suggestion update data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantSuggestionsApi,
+} from '';
+import type { VariantSuggestionsValidateUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: basicAuth
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: jwtAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VariantSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant suggestion.
+    id: 56,
+    // VariantSuggestionRequest
+    variantSuggestionRequest: ...,
+  } satisfies VariantSuggestionsValidateUpdateRequest;
+
+  try {
+    const data = await api.variantSuggestionsValidateUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this variant suggestion. | [Defaults to `undefined`] |
+| **variantSuggestionRequest** | [VariantSuggestionRequest](VariantSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantSuggestion**](VariantSuggestion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+