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

package/spellbook-client/docs/Card.md

@@ -0,0 +1,62 @@
+
+# Card
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`oracleId` | string
+`spoiler` | boolean
+`typeLine` | string
+`imageUriFrontPng` | string
+`imageUriFrontLarge` | string
+`imageUriFrontNormal` | string
+`imageUriFrontSmall` | string
+`imageUriFrontArtCrop` | string
+`imageUriBackPng` | string
+`imageUriBackLarge` | string
+`imageUriBackNormal` | string
+`imageUriBackSmall` | string
+`imageUriBackArtCrop` | string
+
+## Example
+
+```typescript
+import type { Card } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "oracleId": null,
+  "spoiler": null,
+  "typeLine": null,
+  "imageUriFrontPng": null,
+  "imageUriFrontLarge": null,
+  "imageUriFrontNormal": null,
+  "imageUriFrontSmall": null,
+  "imageUriFrontArtCrop": null,
+  "imageUriBackPng": null,
+  "imageUriBackLarge": null,
+  "imageUriBackNormal": null,
+  "imageUriBackSmall": null,
+  "imageUriBackArtCrop": null,
+} satisfies Card
+
+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 Card
+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/CardDetail.md

@@ -0,0 +1,92 @@
+
+# CardDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`oracleId` | string
+`identity` | [IdentityEnum](IdentityEnum.md)
+`variantCount` | number
+`spoiler` | boolean
+`typeLine` | string
+`oracleText` | string
+`keywords` | any
+`manaValue` | number
+`reserved` | boolean
+`latestPrintingSet` | string
+`reprinted` | boolean
+`gameChanger` | boolean
+`tutor` | boolean
+`massLandDenial` | boolean
+`extraTurn` | boolean
+`imageUriFrontPng` | string
+`imageUriFrontLarge` | string
+`imageUriFrontNormal` | string
+`imageUriFrontSmall` | string
+`imageUriFrontArtCrop` | string
+`imageUriBackPng` | string
+`imageUriBackLarge` | string
+`imageUriBackNormal` | string
+`imageUriBackSmall` | string
+`imageUriBackArtCrop` | string
+`features` | [Array<FeatureOfCard>](FeatureOfCard.md)
+`legalities` | [CardLegalities](CardLegalities.md)
+`prices` | [CardPrices](CardPrices.md)
+
+## Example
+
+```typescript
+import type { CardDetail } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "oracleId": null,
+  "identity": null,
+  "variantCount": null,
+  "spoiler": null,
+  "typeLine": null,
+  "oracleText": null,
+  "keywords": null,
+  "manaValue": null,
+  "reserved": null,
+  "latestPrintingSet": null,
+  "reprinted": null,
+  "gameChanger": null,
+  "tutor": null,
+  "massLandDenial": null,
+  "extraTurn": null,
+  "imageUriFrontPng": null,
+  "imageUriFrontLarge": null,
+  "imageUriFrontNormal": null,
+  "imageUriFrontSmall": null,
+  "imageUriFrontArtCrop": null,
+  "imageUriBackPng": null,
+  "imageUriBackLarge": null,
+  "imageUriBackNormal": null,
+  "imageUriBackSmall": null,
+  "imageUriBackArtCrop": null,
+  "features": null,
+  "legalities": null,
+  "prices": null,
+} satisfies CardDetail
+
+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 CardDetail
+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/CardInDeck.md

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

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

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

@@ -0,0 +1,58 @@
+
+# CardLegalities
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`commander` | boolean
+`pauperCommanderMain` | boolean
+`pauperCommander` | boolean
+`oathbreaker` | boolean
+`predh` | boolean
+`brawl` | boolean
+`vintage` | boolean
+`legacy` | boolean
+`premodern` | boolean
+`modern` | boolean
+`pioneer` | boolean
+`standard` | boolean
+`pauper` | boolean
+
+## Example
+
+```typescript
+import type { CardLegalities } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "commander": null,
+  "pauperCommanderMain": null,
+  "pauperCommander": null,
+  "oathbreaker": null,
+  "predh": null,
+  "brawl": null,
+  "vintage": null,
+  "legacy": null,
+  "premodern": null,
+  "modern": null,
+  "pioneer": null,
+  "standard": null,
+  "pauper": null,
+} satisfies CardLegalities
+
+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 CardLegalities
+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/CardListFromTextApi.md

@@ -0,0 +1,150 @@
+# CardListFromTextApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cardListFromTextCreate**](CardListFromTextApi.md#cardlistfromtextcreate) | **POST** /card-list-from-text |  |
+| [**cardListFromTextRetrieve**](CardListFromTextApi.md#cardlistfromtextretrieve) | **GET** /card-list-from-text |  |
+
+
+
+## cardListFromTextCreate
+
+> Deck cardListFromTextCreate(body)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CardListFromTextApi,
+} from '';
+import type { CardListFromTextCreateRequest } 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 CardListFromTextApi(config);
+
+  const body = {
+    // string (optional)
+    body: body_example,
+  } satisfies CardListFromTextCreateRequest;
+
+  try {
+    const data = await api.cardListFromTextCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **body** | `string` |  | [Optional] |
+
+### Return type
+
+[**Deck**](Deck.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `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)
+
+
+## cardListFromTextRetrieve
+
+> Deck cardListFromTextRetrieve()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CardListFromTextApi,
+} from '';
+import type { CardListFromTextRetrieveRequest } 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 CardListFromTextApi(config);
+
+  try {
+    const data = await api.cardListFromTextRetrieve();
+    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
+
+[**Deck**](Deck.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/CardListFromUrlApi.md

@@ -0,0 +1,84 @@
+# CardListFromUrlApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cardListFromUrlRetrieve**](CardListFromUrlApi.md#cardlistfromurlretrieve) | **GET** /card-list-from-url |  |
+
+
+
+## cardListFromUrlRetrieve
+
+> Deck cardListFromUrlRetrieve(url)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CardListFromUrlApi,
+} from '';
+import type { CardListFromUrlRetrieveRequest } 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 CardListFromUrlApi(config);
+
+  const body = {
+    // string (optional)
+    url: url_example,
+  } satisfies CardListFromUrlRetrieveRequest;
+
+  try {
+    const data = await api.cardListFromUrlRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **url** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Deck**](Deck.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** |  |  -  |
+| **400** |  |  -  |
+
+[[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/CardPrices.md

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

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

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