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

package/spellbook-client/docs/FeatureOfCard.md

@@ -0,0 +1,50 @@
+
+# FeatureOfCard
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`feature` | [Feature](Feature.md)
+`quantity` | number
+`zoneLocations` | Array<string>
+`battlefieldCardState` | string
+`exileCardState` | string
+`libraryCardState` | string
+`graveyardCardState` | string
+`mustBeCommander` | boolean
+
+## Example
+
+```typescript
+import type { FeatureOfCard } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "feature": null,
+  "quantity": null,
+  "zoneLocations": null,
+  "battlefieldCardState": null,
+  "exileCardState": null,
+  "libraryCardState": null,
+  "graveyardCardState": null,
+  "mustBeCommander": null,
+} satisfies FeatureOfCard
+
+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 FeatureOfCard
+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/FeatureProducedByVariant.md

@@ -0,0 +1,36 @@
+
+# FeatureProducedByVariant
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`feature` | [Feature](Feature.md)
+`quantity` | number
+
+## Example
+
+```typescript
+import type { FeatureProducedByVariant } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "feature": null,
+  "quantity": null,
+} satisfies FeatureProducedByVariant
+
+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 FeatureProducedByVariant
+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/FeatureProducedInVariantSuggestion.md

@@ -0,0 +1,34 @@
+
+# FeatureProducedInVariantSuggestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`feature` | string
+
+## Example
+
+```typescript
+import type { FeatureProducedInVariantSuggestion } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "feature": null,
+} satisfies FeatureProducedInVariantSuggestion
+
+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 FeatureProducedInVariantSuggestion
+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/FeatureProducedInVariantSuggestionRequest.md

@@ -0,0 +1,34 @@
+
+# FeatureProducedInVariantSuggestionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`feature` | string
+
+## Example
+
+```typescript
+import type { FeatureProducedInVariantSuggestionRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "feature": null,
+} satisfies FeatureProducedInVariantSuggestionRequest
+
+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 FeatureProducedInVariantSuggestionRequest
+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/FeatureStatusEnum.md

@@ -0,0 +1,33 @@
+
+# FeatureStatusEnum
+
+* `HU` - Hidden Utility * `PU` - Public Utility * `H` - Helper * `C` - Contextual * `S` - Standalone
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { FeatureStatusEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies FeatureStatusEnum
+
+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 FeatureStatusEnum
+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/FeaturesApi.md

@@ -0,0 +1,167 @@
+# FeaturesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**featuresList**](FeaturesApi.md#featureslist) | **GET** /features/ |  |
+| [**featuresRetrieve**](FeaturesApi.md#featuresretrieve) | **GET** /features/{id}/ |  |
+
+
+
+## featuresList
+
+> PaginatedFeatureList featuresList(limit, offset, q, status)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FeaturesApi,
+} from '';
+import type { FeaturesListRequest } 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 FeaturesApi(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,
+    // string | A search query. (optional)
+    q: q_example,
+    // Array<'C' | 'H' | 'HU' | 'PU' | 'S'> | Is this feature an utility for variant generation, a helper to be exploited somehow, or a standalone, probably impactful effect? (public utilities are visible to combo submitters)  * `HU` - Hidden Utility * `PU` - Public Utility * `H` - Helper * `C` - Contextual * `S` - Standalone (optional)
+    status: ...,
+  } satisfies FeaturesListRequest;
+
+  try {
+    const data = await api.featuresList(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`] |
+| **q** | `string` | A search query. | [Optional] [Defaults to `undefined`] |
+| **status** | `C`, `H`, `HU`, `PU`, `S` | Is this feature an utility for variant generation, a helper to be exploited somehow, or a standalone, probably impactful effect? (public utilities are visible to combo submitters)  * &#x60;HU&#x60; - Hidden Utility * &#x60;PU&#x60; - Public Utility * &#x60;H&#x60; - Helper * &#x60;C&#x60; - Contextual * &#x60;S&#x60; - Standalone | [Optional] [Enum: C, H, HU, PU, S] |
+
+### Return type
+
+[**PaginatedFeatureList**](PaginatedFeatureList.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)
+
+
+## featuresRetrieve
+
+> Feature featuresRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FeaturesApi,
+} from '';
+import type { FeaturesRetrieveRequest } 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 FeaturesApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this feature.
+    id: 56,
+  } satisfies FeaturesRetrieveRequest;
+
+  try {
+    const data = await api.featuresRetrieve(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 feature. | [Defaults to `undefined`] |
+
+### Return type
+
+[**Feature**](Feature.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/FindMyCombosApi.md

@@ -0,0 +1,191 @@
+# FindMyCombosApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**findMyCombosCreate**](FindMyCombosApi.md#findmycomboscreate) | **POST** /find-my-combos |  |
+| [**findMyCombosList**](FindMyCombosApi.md#findmycomboslist) | **GET** /find-my-combos |  |
+
+
+
+## findMyCombosCreate
+
+> PaginatedFindMyCombosResponseList findMyCombosCreate(groupByCombo, limit, offset, ordering, q, variant, deckRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FindMyCombosApi,
+} from '';
+import type { FindMyCombosCreateRequest } 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 FindMyCombosApi(config);
+
+  const body = {
+    // boolean | Group variants by combo (optional)
+    groupByCombo: true,
+    // number | Number of results to return per page. (optional)
+    limit: 56,
+    // number | The initial index from which to return the results. (optional)
+    offset: 56,
+    // string | Which field to use when ordering the results. (optional)
+    ordering: ordering_example,
+    // string | A search query. (optional)
+    q: q_example,
+    // string | Filters for variants of the same combos that generated the given variant id. (optional)
+    variant: variant_example,
+    // DeckRequest (optional)
+    deckRequest: ...,
+  } satisfies FindMyCombosCreateRequest;
+
+  try {
+    const data = await api.findMyCombosCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **groupByCombo** | `boolean` | Group variants by combo | [Optional] [Defaults to `undefined`] |
+| **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`] |
+| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
+| **q** | `string` | A search query. | [Optional] [Defaults to `undefined`] |
+| **variant** | `string` | Filters for variants of the same combos that generated the given variant id. | [Optional] [Defaults to `undefined`] |
+| **deckRequest** | [DeckRequest](DeckRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedFindMyCombosResponseList**](PaginatedFindMyCombosResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/plain`
+- **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)
+
+
+## findMyCombosList
+
+> PaginatedFindMyCombosResponseList findMyCombosList(groupByCombo, limit, offset, ordering, q, variant)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FindMyCombosApi,
+} from '';
+import type { FindMyCombosListRequest } 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 FindMyCombosApi(config);
+
+  const body = {
+    // boolean | Group variants by combo (optional)
+    groupByCombo: true,
+    // number | Number of results to return per page. (optional)
+    limit: 56,
+    // number | The initial index from which to return the results. (optional)
+    offset: 56,
+    // string | Which field to use when ordering the results. (optional)
+    ordering: ordering_example,
+    // string | A search query. (optional)
+    q: q_example,
+    // string | Filters for variants of the same combos that generated the given variant id. (optional)
+    variant: variant_example,
+  } satisfies FindMyCombosListRequest;
+
+  try {
+    const data = await api.findMyCombosList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **groupByCombo** | `boolean` | Group variants by combo | [Optional] [Defaults to `undefined`] |
+| **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`] |
+| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
+| **q** | `string` | A search query. | [Optional] [Defaults to `undefined`] |
+| **variant** | `string` | Filters for variants of the same combos that generated the given variant id. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedFindMyCombosResponseList**](PaginatedFindMyCombosResponseList.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/FindMyCombosResponse.md

@@ -0,0 +1,46 @@
+
+# FindMyCombosResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identity` | string
+`included` | [Array<Variant>](Variant.md)
+`includedByChangingCommanders` | [Array<Variant>](Variant.md)
+`almostIncluded` | [Array<Variant>](Variant.md)
+`almostIncludedByAddingColors` | [Array<Variant>](Variant.md)
+`almostIncludedByChangingCommanders` | [Array<Variant>](Variant.md)
+`almostIncludedByAddingColorsAndChangingCommanders` | [Array<Variant>](Variant.md)
+
+## Example
+
+```typescript
+import type { FindMyCombosResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "identity": null,
+  "included": null,
+  "includedByChangingCommanders": null,
+  "almostIncluded": null,
+  "almostIncludedByAddingColors": null,
+  "almostIncludedByChangingCommanders": null,
+  "almostIncludedByAddingColorsAndChangingCommanders": null,
+} satisfies FindMyCombosResponse
+
+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 FindMyCombosResponse
+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/IdentityEnum.md

@@ -0,0 +1,33 @@
+
+# IdentityEnum
+
+* `C` - C * `W` - W * `U` - U * `B` - B * `R` - R * `G` - G * `WU` - WU * `WB` - WB * `RW` - RW * `GW` - GW * `UB` - UB * `UR` - UR * `GU` - GU * `BR` - BR * `BG` - BG * `RG` - RG * `WUB` - WUB * `URW` - URW * `GWU` - GWU * `RWB` - RWB * `WBG` - WBG * `RGW` - RGW * `UBR` - UBR * `BGU` - BGU * `GUR` - GUR * `BRG` - BRG * `WUBR` - WUBR * `UBRG` - UBRG * `BRGW` - BRGW * `RGWU` - RGWU * `GWUB` - GWUB * `WUBRG` - WUBRG
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { IdentityEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies IdentityEnum
+
+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 IdentityEnum
+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/InvalidUrlResponse.md

@@ -0,0 +1,34 @@
+
+# InvalidUrlResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`detail` | string
+
+## Example
+
+```typescript
+import type { InvalidUrlResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "detail": null,
+} satisfies InvalidUrlResponse
+
+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 InvalidUrlResponse
+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/KindEnum.md

@@ -0,0 +1,33 @@
+
+# KindEnum
+
+* `NW` - Not Working * `SE` - Spelling Error * `II` - Incorrect Info * `WC` - Wrong Card * `VG` - Variant Grouping * `O` - Other
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { KindEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies KindEnum
+
+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 KindEnum
+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)
+
+