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

package/spellbook-client/docs/VariantUpdateSuggestionsApi.md

@@ -0,0 +1,707 @@
+# VariantUpdateSuggestionsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**variantUpdateSuggestionsCreate**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionscreate) | **POST** /variant-update-suggestions/ |  |
+| [**variantUpdateSuggestionsDestroy**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionsdestroy) | **DELETE** /variant-update-suggestions/{id}/ |  |
+| [**variantUpdateSuggestionsList**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionslist) | **GET** /variant-update-suggestions/ |  |
+| [**variantUpdateSuggestionsPartialUpdate**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionspartialupdate) | **PATCH** /variant-update-suggestions/{id}/ |  |
+| [**variantUpdateSuggestionsRetrieve**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionsretrieve) | **GET** /variant-update-suggestions/{id}/ |  |
+| [**variantUpdateSuggestionsUpdate**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionsupdate) | **PUT** /variant-update-suggestions/{id}/ |  |
+| [**variantUpdateSuggestionsValidateCreate**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionsvalidatecreate) | **POST** /variant-update-suggestions/validate/ |  |
+| [**variantUpdateSuggestionsValidatePartialUpdate**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionsvalidatepartialupdate) | **PATCH** /variant-update-suggestions/{id}/validate/ |  |
+| [**variantUpdateSuggestionsValidateUpdate**](VariantUpdateSuggestionsApi.md#variantupdatesuggestionsvalidateupdate) | **PUT** /variant-update-suggestions/{id}/validate/ |  |
+
+
+
+## variantUpdateSuggestionsCreate
+
+> VariantUpdateSuggestion variantUpdateSuggestionsCreate(variantUpdateSuggestionRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsCreateRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // VariantUpdateSuggestionRequest
+    variantUpdateSuggestionRequest: ...,
+  } satisfies VariantUpdateSuggestionsCreateRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **variantUpdateSuggestionRequest** | [VariantUpdateSuggestionRequest](VariantUpdateSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+
+
+## variantUpdateSuggestionsDestroy
+
+> variantUpdateSuggestionsDestroy(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsDestroyRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant update suggestion.
+    id: 56,
+  } satisfies VariantUpdateSuggestionsDestroyRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsDestroy(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 update 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)
+
+
+## variantUpdateSuggestionsList
+
+> PaginatedVariantUpdateSuggestionList variantUpdateSuggestionsList(limit, offset, suggestedBy)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsListRequest } 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 VariantUpdateSuggestionsApi(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 VariantUpdateSuggestionsListRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsList(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
+
+[**PaginatedVariantUpdateSuggestionList**](PaginatedVariantUpdateSuggestionList.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)
+
+
+## variantUpdateSuggestionsPartialUpdate
+
+> VariantUpdateSuggestion variantUpdateSuggestionsPartialUpdate(id, patchedVariantUpdateSuggestionRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsPartialUpdateRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant update suggestion.
+    id: 56,
+    // PatchedVariantUpdateSuggestionRequest (optional)
+    patchedVariantUpdateSuggestionRequest: ...,
+  } satisfies VariantUpdateSuggestionsPartialUpdateRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsPartialUpdate(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 update suggestion. | [Defaults to `undefined`] |
+| **patchedVariantUpdateSuggestionRequest** | [PatchedVariantUpdateSuggestionRequest](PatchedVariantUpdateSuggestionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+
+
+## variantUpdateSuggestionsRetrieve
+
+> VariantUpdateSuggestion variantUpdateSuggestionsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsRetrieveRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant update suggestion.
+    id: 56,
+  } satisfies VariantUpdateSuggestionsRetrieveRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsRetrieve(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 update suggestion. | [Defaults to `undefined`] |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+
+
+## variantUpdateSuggestionsUpdate
+
+> VariantUpdateSuggestion variantUpdateSuggestionsUpdate(id, variantUpdateSuggestionRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsUpdateRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant update suggestion.
+    id: 56,
+    // VariantUpdateSuggestionRequest
+    variantUpdateSuggestionRequest: ...,
+  } satisfies VariantUpdateSuggestionsUpdateRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsUpdate(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 update suggestion. | [Defaults to `undefined`] |
+| **variantUpdateSuggestionRequest** | [VariantUpdateSuggestionRequest](VariantUpdateSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+
+
+## variantUpdateSuggestionsValidateCreate
+
+> VariantUpdateSuggestion variantUpdateSuggestionsValidateCreate(variantUpdateSuggestionRequest)
+
+
+
+Validate the variant suggestion data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsValidateCreateRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // VariantUpdateSuggestionRequest
+    variantUpdateSuggestionRequest: ...,
+  } satisfies VariantUpdateSuggestionsValidateCreateRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsValidateCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **variantUpdateSuggestionRequest** | [VariantUpdateSuggestionRequest](VariantUpdateSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+
+
+## variantUpdateSuggestionsValidatePartialUpdate
+
+> VariantUpdateSuggestion variantUpdateSuggestionsValidatePartialUpdate(id, patchedVariantUpdateSuggestionRequest)
+
+
+
+Validate the variant suggestion update data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsValidatePartialUpdateRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant update suggestion.
+    id: 56,
+    // PatchedVariantUpdateSuggestionRequest (optional)
+    patchedVariantUpdateSuggestionRequest: ...,
+  } satisfies VariantUpdateSuggestionsValidatePartialUpdateRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsValidatePartialUpdate(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 update suggestion. | [Defaults to `undefined`] |
+| **patchedVariantUpdateSuggestionRequest** | [PatchedVariantUpdateSuggestionRequest](PatchedVariantUpdateSuggestionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+
+
+## variantUpdateSuggestionsValidateUpdate
+
+> VariantUpdateSuggestion variantUpdateSuggestionsValidateUpdate(id, variantUpdateSuggestionRequest)
+
+
+
+Validate the variant suggestion update data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantUpdateSuggestionsApi,
+} from '';
+import type { VariantUpdateSuggestionsValidateUpdateRequest } 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 VariantUpdateSuggestionsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this variant update suggestion.
+    id: 56,
+    // VariantUpdateSuggestionRequest
+    variantUpdateSuggestionRequest: ...,
+  } satisfies VariantUpdateSuggestionsValidateUpdateRequest;
+
+  try {
+    const data = await api.variantUpdateSuggestionsValidateUpdate(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 update suggestion. | [Defaults to `undefined`] |
+| **variantUpdateSuggestionRequest** | [VariantUpdateSuggestionRequest](VariantUpdateSuggestionRequest.md) |  | |
+
+### Return type
+
+[**VariantUpdateSuggestion**](VariantUpdateSuggestion.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)
+