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

package/spellbook-client/docs/PropertiesApi.md

@@ -0,0 +1,161 @@
+# PropertiesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**propertiesList**](PropertiesApi.md#propertieslist) | **GET** /properties/ |  |
+| [**propertiesRetrieve**](PropertiesApi.md#propertiesretrieve) | **GET** /properties/{key}/ |  |
+
+
+
+## propertiesList
+
+> PaginatedWebsitePropertyList propertiesList(limit, offset)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PropertiesApi,
+} from '';
+import type { PropertiesListRequest } 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 PropertiesApi(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,
+  } satisfies PropertiesListRequest;
+
+  try {
+    const data = await api.propertiesList(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`] |
+
+### Return type
+
+[**PaginatedWebsitePropertyList**](PaginatedWebsitePropertyList.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)
+
+
+## propertiesRetrieve
+
+> WebsiteProperty propertiesRetrieve(key)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PropertiesApi,
+} from '';
+import type { PropertiesRetrieveRequest } 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 PropertiesApi(config);
+
+  const body = {
+    // string | A unique value identifying this Website Property.
+    key: key_example,
+  } satisfies PropertiesRetrieveRequest;
+
+  try {
+    const data = await api.propertiesRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **key** | `string` | A unique value identifying this Website Property. | [Defaults to `undefined`] |
+
+### Return type
+
+[**WebsiteProperty**](WebsiteProperty.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/SuggestionStatusEnum.md

@@ -0,0 +1,33 @@
+
+# SuggestionStatusEnum
+
+* `N` - New * `AD` - Awaiting Discussion * `PA` - Pending Approval * `A` - Accepted * `R` - Rejected
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SuggestionStatusEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SuggestionStatusEnum
+
+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 SuggestionStatusEnum
+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/Template.md

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

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

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

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

@@ -0,0 +1,164 @@
+# TemplatesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**templatesList**](TemplatesApi.md#templateslist) | **GET** /templates/ |  |
+| [**templatesRetrieve**](TemplatesApi.md#templatesretrieve) | **GET** /templates/{id}/ |  |
+
+
+
+## templatesList
+
+> PaginatedTemplateList templatesList(limit, offset, q)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from '';
+import type { TemplatesListRequest } 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 TemplatesApi(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,
+  } satisfies TemplatesListRequest;
+
+  try {
+    const data = await api.templatesList(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`] |
+
+### Return type
+
+[**PaginatedTemplateList**](PaginatedTemplateList.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)
+
+
+## templatesRetrieve
+
+> Template templatesRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from '';
+import type { TemplatesRetrieveRequest } 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 TemplatesApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this card template.
+    id: 56,
+  } satisfies TemplatesRetrieveRequest;
+
+  try {
+    const data = await api.templatesRetrieve(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 template. | [Defaults to `undefined`] |
+
+### Return type
+
+[**Template**](Template.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)
+