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

package/spellbook-client/docs/VariantsApi.md

@@ -0,0 +1,175 @@
+# VariantsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**variantsList**](VariantsApi.md#variantslist) | **GET** /variants/ |  |
+| [**variantsRetrieve**](VariantsApi.md#variantsretrieve) | **GET** /variants/{id}/ |  |
+
+
+
+## variantsList
+
+> PaginatedVariantList variantsList(groupByCombo, limit, offset, ordering, q, variant)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantsApi,
+} from '';
+import type { VariantsListRequest } 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 VariantsApi(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 VariantsListRequest;
+
+  try {
+    const data = await api.variantsList(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
+
+[**PaginatedVariantList**](PaginatedVariantList.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)
+
+
+## variantsRetrieve
+
+> Variant variantsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariantsApi,
+} from '';
+import type { VariantsRetrieveRequest } 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 VariantsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies VariantsRetrieveRequest;
+
+  try {
+    const data = await api.variantsRetrieve(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
+
+[**Variant**](Variant.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/VariantsQueryValidationError.md

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

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

@@ -0,0 +1,33 @@
+
+# ZoneLocationsEnum
+
+* `H` - Hand * `B` - Battlefield * `C` - Command Zone * `E` - Exile * `G` - Graveyard * `L` - Library
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ZoneLocationsEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ZoneLocationsEnum
+
+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 ZoneLocationsEnum
+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/models/bracketTagEnum.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/card.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardDetail.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardInDeck.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardInDeckRequest.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardInVariant.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardLegalities.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardPrices.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardUsedInVariantSuggestion.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/cardUsedInVariantSuggestionRequest.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/combo.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/deck.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/deckRequest.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/estimateBracketResult.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/feature.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/featureOfCard.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/featureProducedByVariant.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/featureProducedInVariantSuggestion.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/featureProducedInVariantSuggestionRequest.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/featureStatusEnum.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/findMyCombosResponse.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/identityEnum.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/invalidUrlResponse.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/kindEnum.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedCardDetailList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedFeatureList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedFindMyCombosResponseList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedFindMyCombosResponseListResults.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedTemplateList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedUserDetailList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedVariantAliasList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedVariantList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedVariantSuggestionList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedVariantUpdateSuggestionList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/paginatedWebsitePropertyList.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/patchedUserDetailRequest.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/spellbook-client/models/patchedVariantSuggestionRequest.ts

@@ -4,7 +4,7 @@
  * Commander Spellbook API
  * API for Commander Spellbook, the combo database engine for Magic: The Gathering
  *
- * The version of the OpenAPI document: 4.8.13
+ * The version of the OpenAPI document: 4.8.15
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).