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

package/spellbook-client/docs/CardsApi.md

@@ -0,0 +1,170 @@
+# CardsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cardsList**](CardsApi.md#cardslist) | **GET** /cards/ |  |
+| [**cardsRetrieve**](CardsApi.md#cardsretrieve) | **GET** /cards/{id}/ |  |
+
+
+
+## cardsList
+
+> PaginatedCardDetailList cardsList(limit, offset, ordering, q, replaces)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CardsApi,
+} from '';
+import type { CardsListRequest } 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 CardsApi(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 | Which field to use when ordering the results. (optional)
+    ordering: ordering_example,
+    // string | A search query. (optional)
+    q: q_example,
+    // Array<number> (optional)
+    replaces: ...,
+  } satisfies CardsListRequest;
+
+  try {
+    const data = await api.cardsList(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`] |
+| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
+| **q** | `string` | A search query. | [Optional] [Defaults to `undefined`] |
+| **replaces** | `Array<number>` |  | [Optional] |
+
+### Return type
+
+[**PaginatedCardDetailList**](PaginatedCardDetailList.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)
+
+
+## cardsRetrieve
+
+> CardDetail cardsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CardsApi,
+} from '';
+import type { CardsRetrieveRequest } 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 CardsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this card.
+    id: 56,
+  } satisfies CardsRetrieveRequest;
+
+  try {
+    const data = await api.cardsRetrieve(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 card. | [Defaults to `undefined`] |
+
+### Return type
+
+[**CardDetail**](CardDetail.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/Combo.md

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

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

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

@@ -0,0 +1,150 @@
+# DefaultApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**rootFormattedRetrieve**](DefaultApi.md#rootformattedretrieve) | **GET** /{format} |  |
+| [**rootRetrieve**](DefaultApi.md#rootretrieve) | **GET** / |  |
+
+
+
+## rootFormattedRetrieve
+
+> { [key: string]: any; } rootFormattedRetrieve(format)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '';
+import type { RootFormattedRetrieveRequest } 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 DefaultApi(config);
+
+  const body = {
+    // '.json'
+    format: format_example,
+  } satisfies RootFormattedRetrieveRequest;
+
+  try {
+    const data = await api.rootFormattedRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **format** | `.json` |  | [Defaults to `undefined`] [Enum: .json] |
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### 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)
+
+
+## rootRetrieve
+
+> { [key: string]: any; } rootRetrieve()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '';
+import type { RootRetrieveRequest } 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 DefaultApi(config);
+
+  try {
+    const data = await api.rootRetrieve();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### 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/EstimateBracketApi.md

@@ -0,0 +1,150 @@
+# EstimateBracketApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**estimateBracketCreate**](EstimateBracketApi.md#estimatebracketcreate) | **POST** /estimate-bracket |  |
+| [**estimateBracketRetrieve**](EstimateBracketApi.md#estimatebracketretrieve) | **GET** /estimate-bracket |  |
+
+
+
+## estimateBracketCreate
+
+> EstimateBracketResult estimateBracketCreate(deckRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EstimateBracketApi,
+} from '';
+import type { EstimateBracketCreateRequest } 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 EstimateBracketApi(config);
+
+  const body = {
+    // DeckRequest (optional)
+    deckRequest: ...,
+  } satisfies EstimateBracketCreateRequest;
+
+  try {
+    const data = await api.estimateBracketCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deckRequest** | [DeckRequest](DeckRequest.md) |  | [Optional] |
+
+### Return type
+
+[**EstimateBracketResult**](EstimateBracketResult.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)
+
+
+## estimateBracketRetrieve
+
+> EstimateBracketResult estimateBracketRetrieve()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EstimateBracketApi,
+} from '';
+import type { EstimateBracketRetrieveRequest } 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 EstimateBracketApi(config);
+
+  try {
+    const data = await api.estimateBracketRetrieve();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**EstimateBracketResult**](EstimateBracketResult.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/EstimateBracketResult.md

@@ -0,0 +1,64 @@
+
+# EstimateBracketResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bracketTag` | [BracketTagEnum](BracketTagEnum.md)
+`gameChangerCards` | [Array<Card>](Card.md)
+`massLandDenialCards` | [Array<Card>](Card.md)
+`massLandDenialTemplates` | [Array<Variant>](Variant.md)
+`massLandDenialCombos` | [Array<Variant>](Variant.md)
+`extraTurnCards` | [Array<Card>](Card.md)
+`extraTurnTemplates` | [Array<Variant>](Variant.md)
+`extraTurnsCombos` | [Array<Variant>](Variant.md)
+`tutorCards` | [Array<Card>](Card.md)
+`tutorTemplates` | [Array<Variant>](Variant.md)
+`lockCombos` | [Array<Variant>](Variant.md)
+`skipTurnsCombos` | [Array<Variant>](Variant.md)
+`definitelyEarlyGameTwoCardCombos` | [Array<Variant>](Variant.md)
+`arguablyEarlyGameTwoCardCombos` | [Array<Variant>](Variant.md)
+`definitelyLateGameTwoCardCombos` | [Array<Variant>](Variant.md)
+`borderlineLateGameTwoCardCombos` | [Array<Variant>](Variant.md)
+
+## Example
+
+```typescript
+import type { EstimateBracketResult } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "bracketTag": null,
+  "gameChangerCards": null,
+  "massLandDenialCards": null,
+  "massLandDenialTemplates": null,
+  "massLandDenialCombos": null,
+  "extraTurnCards": null,
+  "extraTurnTemplates": null,
+  "extraTurnsCombos": null,
+  "tutorCards": null,
+  "tutorTemplates": null,
+  "lockCombos": null,
+  "skipTurnsCombos": null,
+  "definitelyEarlyGameTwoCardCombos": null,
+  "arguablyEarlyGameTwoCardCombos": null,
+  "definitelyLateGameTwoCardCombos": null,
+  "borderlineLateGameTwoCardCombos": null,
+} satisfies EstimateBracketResult
+
+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 EstimateBracketResult
+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/Feature.md

@@ -0,0 +1,40 @@
+
+# Feature
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`uncountable` | boolean
+`status` | [FeatureStatusEnum](FeatureStatusEnum.md)
+
+## Example
+
+```typescript
+import type { Feature } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "uncountable": null,
+  "status": null,
+} satisfies Feature
+
+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 Feature
+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)
+
+