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

package/spellbook-client/docs/UsersApi.md

@@ -0,0 +1,392 @@
+# UsersApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**usersDestroy**](UsersApi.md#usersdestroy) | **DELETE** /users/{id}/ |  |
+| [**usersList**](UsersApi.md#userslist) | **GET** /users/ |  |
+| [**usersPartialUpdate**](UsersApi.md#userspartialupdate) | **PATCH** /users/{id}/ |  |
+| [**usersRetrieve**](UsersApi.md#usersretrieve) | **GET** /users/{id}/ |  |
+| [**usersUpdate**](UsersApi.md#usersupdate) | **PUT** /users/{id}/ |  |
+
+
+
+## usersDestroy
+
+> usersDestroy(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '';
+import type { UsersDestroyRequest } 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 UsersApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this user.
+    id: 56,
+  } satisfies UsersDestroyRequest;
+
+  try {
+    const data = await api.usersDestroy(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 user. | [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)
+
+
+## usersList
+
+> PaginatedUserDetailList usersList(limit, offset)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '';
+import type { UsersListRequest } 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 UsersApi(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,
+  } satisfies UsersListRequest;
+
+  try {
+    const data = await api.usersList(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`] |
+
+### Return type
+
+[**PaginatedUserDetailList**](PaginatedUserDetailList.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)
+
+
+## usersPartialUpdate
+
+> UserDetail usersPartialUpdate(id, patchedUserDetailRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '';
+import type { UsersPartialUpdateRequest } 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 UsersApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this user.
+    id: 56,
+    // PatchedUserDetailRequest (optional)
+    patchedUserDetailRequest: ...,
+  } satisfies UsersPartialUpdateRequest;
+
+  try {
+    const data = await api.usersPartialUpdate(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 user. | [Defaults to `undefined`] |
+| **patchedUserDetailRequest** | [PatchedUserDetailRequest](PatchedUserDetailRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UserDetail**](UserDetail.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)
+
+
+## usersRetrieve
+
+> UserDetail usersRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '';
+import type { UsersRetrieveRequest } 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 UsersApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this user.
+    id: 56,
+  } satisfies UsersRetrieveRequest;
+
+  try {
+    const data = await api.usersRetrieve(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 user. | [Defaults to `undefined`] |
+
+### Return type
+
+[**UserDetail**](UserDetail.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)
+
+
+## usersUpdate
+
+> UserDetail usersUpdate(id, userDetailRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '';
+import type { UsersUpdateRequest } 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 UsersApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this user.
+    id: 56,
+    // UserDetailRequest
+    userDetailRequest: ...,
+  } satisfies UsersUpdateRequest;
+
+  try {
+    const data = await api.usersUpdate(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 user. | [Defaults to `undefined`] |
+| **userDetailRequest** | [UserDetailRequest](UserDetailRequest.md) |  | |
+
+### Return type
+
+[**UserDetail**](UserDetail.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)
+

package/spellbook-client/docs/Variant.md

@@ -0,0 +1,72 @@
+
+# Variant
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | [VariantStatusEnum](VariantStatusEnum.md)
+`uses` | [Array<CardInVariant>](CardInVariant.md)
+`requires` | [Array<TemplateInVariant>](TemplateInVariant.md)
+`produces` | [Array<FeatureProducedByVariant>](FeatureProducedByVariant.md)
+`of` | [Array<Combo>](Combo.md)
+`includes` | [Array<Combo>](Combo.md)
+`identity` | [IdentityEnum](IdentityEnum.md)
+`manaNeeded` | string
+`manaValueNeeded` | number
+`easyPrerequisites` | string
+`notablePrerequisites` | string
+`description` | string
+`notes` | string
+`popularity` | number
+`spoiler` | boolean
+`bracketTag` | [BracketTagEnum](BracketTagEnum.md)
+`legalities` | [VariantLegalities](VariantLegalities.md)
+`prices` | [VariantPrices](VariantPrices.md)
+`variantCount` | number
+
+## Example
+
+```typescript
+import type { Variant } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "uses": null,
+  "requires": null,
+  "produces": null,
+  "of": null,
+  "includes": null,
+  "identity": null,
+  "manaNeeded": null,
+  "manaValueNeeded": null,
+  "easyPrerequisites": null,
+  "notablePrerequisites": null,
+  "description": null,
+  "notes": null,
+  "popularity": null,
+  "spoiler": null,
+  "bracketTag": null,
+  "legalities": null,
+  "prices": null,
+  "variantCount": null,
+} satisfies Variant
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Variant
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/spellbook-client/docs/VariantAlias.md

@@ -0,0 +1,36 @@
+
+# VariantAlias
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`variant` | string
+
+## Example
+
+```typescript
+import type { VariantAlias } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "variant": null,
+} satisfies VariantAlias
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as VariantAlias
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/spellbook-client/docs/VariantAliasesApi.md

@@ -0,0 +1,161 @@
+# VariantAliasesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**variantAliasesList**](VariantAliasesApi.md#variantaliaseslist) | **GET** /variant-aliases/ |  |
+| [**variantAliasesRetrieve**](VariantAliasesApi.md#variantaliasesretrieve) | **GET** /variant-aliases/{id}/ |  |
+
+
+
+## variantAliasesList
+
+> PaginatedVariantAliasList variantAliasesList(limit, offset)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantAliasesApi,
+} from '';
+import type { VariantAliasesListRequest } 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 VariantAliasesApi(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,
+  } satisfies VariantAliasesListRequest;
+
+  try {
+    const data = await api.variantAliasesList(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`] |
+
+### Return type
+
+[**PaginatedVariantAliasList**](PaginatedVariantAliasList.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)
+
+
+## variantAliasesRetrieve
+
+> VariantAlias variantAliasesRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantAliasesApi,
+} from '';
+import type { VariantAliasesRetrieveRequest } 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 VariantAliasesApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies VariantAliasesRetrieveRequest;
+
+  try {
+    const data = await api.variantAliasesRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**VariantAlias**](VariantAlias.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)
+

package/spellbook-client/docs/VariantInVariantUpdateSuggestion.md

@@ -0,0 +1,36 @@
+
+# VariantInVariantUpdateSuggestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`variant` | string
+`issue` | string
+
+## Example
+
+```typescript
+import type { VariantInVariantUpdateSuggestion } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "variant": null,
+  "issue": null,
+} satisfies VariantInVariantUpdateSuggestion
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as VariantInVariantUpdateSuggestion
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+