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

package/spellbook-client/docs/PaginatedCardDetailList.md

@@ -0,0 +1,40 @@
+
+# PaginatedCardDetailList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<CardDetail>](CardDetail.md)
+
+## Example
+
+```typescript
+import type { PaginatedCardDetailList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedCardDetailList
+
+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 PaginatedCardDetailList
+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/PaginatedFeatureList.md

@@ -0,0 +1,40 @@
+
+# PaginatedFeatureList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Feature>](Feature.md)
+
+## Example
+
+```typescript
+import type { PaginatedFeatureList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedFeatureList
+
+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 PaginatedFeatureList
+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/PaginatedFindMyCombosResponseList.md

@@ -0,0 +1,40 @@
+
+# PaginatedFindMyCombosResponseList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [PaginatedFindMyCombosResponseListResults](PaginatedFindMyCombosResponseListResults.md)
+
+## Example
+
+```typescript
+import type { PaginatedFindMyCombosResponseList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedFindMyCombosResponseList
+
+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 PaginatedFindMyCombosResponseList
+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/PaginatedFindMyCombosResponseListResults.md

@@ -0,0 +1,46 @@
+
+# PaginatedFindMyCombosResponseListResults
+
+
+## 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 { PaginatedFindMyCombosResponseListResults } 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 PaginatedFindMyCombosResponseListResults
+
+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 PaginatedFindMyCombosResponseListResults
+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/PaginatedTemplateList.md

@@ -0,0 +1,40 @@
+
+# PaginatedTemplateList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Template>](Template.md)
+
+## Example
+
+```typescript
+import type { PaginatedTemplateList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedTemplateList
+
+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 PaginatedTemplateList
+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/PaginatedUserDetailList.md

@@ -0,0 +1,40 @@
+
+# PaginatedUserDetailList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<UserDetail>](UserDetail.md)
+
+## Example
+
+```typescript
+import type { PaginatedUserDetailList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedUserDetailList
+
+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 PaginatedUserDetailList
+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/PaginatedVariantAliasList.md

@@ -0,0 +1,40 @@
+
+# PaginatedVariantAliasList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<VariantAlias>](VariantAlias.md)
+
+## Example
+
+```typescript
+import type { PaginatedVariantAliasList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedVariantAliasList
+
+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 PaginatedVariantAliasList
+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/PaginatedVariantList.md

@@ -0,0 +1,40 @@
+
+# PaginatedVariantList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Variant>](Variant.md)
+
+## Example
+
+```typescript
+import type { PaginatedVariantList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedVariantList
+
+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 PaginatedVariantList
+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/PaginatedVariantSuggestionList.md

@@ -0,0 +1,40 @@
+
+# PaginatedVariantSuggestionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<VariantSuggestion>](VariantSuggestion.md)
+
+## Example
+
+```typescript
+import type { PaginatedVariantSuggestionList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedVariantSuggestionList
+
+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 PaginatedVariantSuggestionList
+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/PaginatedVariantUpdateSuggestionList.md

@@ -0,0 +1,40 @@
+
+# PaginatedVariantUpdateSuggestionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<VariantUpdateSuggestion>](VariantUpdateSuggestion.md)
+
+## Example
+
+```typescript
+import type { PaginatedVariantUpdateSuggestionList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedVariantUpdateSuggestionList
+
+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 PaginatedVariantUpdateSuggestionList
+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/PaginatedWebsitePropertyList.md

@@ -0,0 +1,40 @@
+
+# PaginatedWebsitePropertyList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<WebsiteProperty>](WebsiteProperty.md)
+
+## Example
+
+```typescript
+import type { PaginatedWebsitePropertyList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?offset=400&limit=100,
+  "previous": http://api.example.org/accounts/?offset=200&limit=100,
+  "results": null,
+} satisfies PaginatedWebsitePropertyList
+
+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 PaginatedWebsitePropertyList
+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/PatchedUserDetailRequest.md

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

@@ -0,0 +1,52 @@
+
+# PatchedVariantSuggestionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uses` | [Array<CardUsedInVariantSuggestionRequest>](CardUsedInVariantSuggestionRequest.md)
+`requires` | [Array<TemplateRequiredInVariantSuggestionRequest>](TemplateRequiredInVariantSuggestionRequest.md)
+`produces` | [Array<FeatureProducedInVariantSuggestionRequest>](FeatureProducedInVariantSuggestionRequest.md)
+`variantOf` | string
+`manaNeeded` | string
+`easyPrerequisites` | string
+`notablePrerequisites` | string
+`description` | string
+`spoiler` | boolean
+`comment` | string
+
+## Example
+
+```typescript
+import type { PatchedVariantSuggestionRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "uses": null,
+  "requires": null,
+  "produces": null,
+  "variantOf": null,
+  "manaNeeded": null,
+  "easyPrerequisites": null,
+  "notablePrerequisites": null,
+  "description": null,
+  "spoiler": null,
+  "comment": null,
+} satisfies PatchedVariantSuggestionRequest
+
+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 PatchedVariantSuggestionRequest
+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/PatchedVariantUpdateSuggestionRequest.md

@@ -0,0 +1,42 @@
+
+# PatchedVariantUpdateSuggestionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`kind` | [KindEnum](KindEnum.md)
+`variants` | [Array<VariantInVariantUpdateSuggestionRequest>](VariantInVariantUpdateSuggestionRequest.md)
+`issue` | string
+`solution` | string
+`comment` | string
+
+## Example
+
+```typescript
+import type { PatchedVariantUpdateSuggestionRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "kind": null,
+  "variants": null,
+  "issue": null,
+  "solution": null,
+  "comment": null,
+} satisfies PatchedVariantUpdateSuggestionRequest
+
+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 PatchedVariantUpdateSuggestionRequest
+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)
+
+