Add OpenAPI

This commit is contained in:
2025-07-05 22:32:52 +02:00
parent acd910e013
commit 54a4f7e08a
98 changed files with 4816 additions and 696 deletions

View File

@@ -0,0 +1,20 @@
# Attribute
## Enum
* `Wind` (value: `'WIND'`)
* `Water` (value: `'WATER'`)
* `Fire` (value: `'FIRE'`)
* `Earth` (value: `'EARTH'`)
* `Light` (value: `'LIGHT'`)
* `Dark` (value: `'DARK'`)
* `Divine` (value: `'DIVINE'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -6,40 +6,46 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**cardType** | [**CardType**](CardType.md) | | [default to undefined]
**description** | **string** | | [default to undefined]
**pendulumDescription** | **string** | | [optional] [default to undefined]
**defense** | **number** | | [optional] [default to undefined]
**attack** | **number** | | [optional] [default to undefined]
**health** | **number** | | [optional] [default to undefined]
**level** | **number** | | [optional] [default to undefined]
**linkValue** | **number** | | [optional] [default to undefined]
**name** | **string** | | [default to undefined]
**type** | **string** | | [default to undefined]
**frameType** | **string** | | [default to undefined]
**archetype** | **string** | | [optional] [default to undefined]
**race** | **string** | | [optional] [default to undefined]
**attribute** | **string** | | [optional] [default to undefined]
**cardPrints** | [**Set<CardPrint>**](CardPrint.md) | | [default to undefined]
**monsterEffect** | **string** | | [optional] [default to undefined]
**attack** | **number** | | [optional] [default to undefined]
**defense** | **number** | | [optional] [default to undefined]
**level** | **number** | | [optional] [default to undefined]
**isPendulum** | **boolean** | | [optional] [default to undefined]
**pendulumScale** | **number** | | [optional] [default to undefined]
**pendulumEffect** | **string** | | [optional] [default to undefined]
**linkValue** | **number** | | [optional] [default to undefined]
**subType** | [**SpellCardType**](SpellCardType.md) | | [default to undefined]
**monsterType** | [**MonsterType**](MonsterType.md) | | [default to undefined]
**attribute** | [**Attribute**](Attribute.md) | | [default to undefined]
**linkArrows** | [**Set<LinkArrow>**](LinkArrow.md) | | [default to undefined]
## Example
```typescript
import { Card } from 'restClient';
import { Card } from './api';
const instance: Card = {
id,
cardType,
description,
pendulumDescription,
defense,
attack,
health,
level,
linkValue,
name,
type,
frameType,
archetype,
race,
cardPrints,
monsterEffect,
attack,
defense,
level,
isPendulum,
pendulumScale,
pendulumEffect,
linkValue,
subType,
monsterType,
attribute,
linkArrows,
};
```

View File

@@ -5,21 +5,21 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**regionalSet** | [**RegionalSet**](RegionalSet.md) | | [default to undefined]
**card** | [**NewCard**](NewCard.md) | | [default to undefined]
**imageApiPath** | **string** | | [default to undefined]
**id** | **string** | | [default to undefined]
**name** | **string** | | [default to undefined]
**regionalName** | **string** | | [optional] [default to undefined]
**rarity** | **string** | | [default to undefined]
## Example
```typescript
import { CardPrint } from 'restClient';
import { CardPrint } from './api';
const instance: CardPrint = {
id,
regionalSet,
card,
imageApiPath,
name,
regionalName,
rarity,
};
```

View File

@@ -0,0 +1,64 @@
# CardPrintService
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getCardPrintPage**](#getcardprintpage) | **GET** /api/prints | Get a page of Card Prints with optional name query parameter|
# **getCardPrintPage**
> PageCardPrintDto getCardPrintPage()
### Example
```typescript
import {
CardPrintService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new CardPrintService(configuration);
let name: string; // (optional) (default to undefined)
let page: number; // (optional) (default to undefined)
let pageSize: number; // (optional) (default to undefined)
const { status, data } = await apiInstance.getCardPrintPage(
name,
page,
pageSize
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | | (optional) defaults to undefined|
| **page** | [**number**] | | (optional) defaults to undefined|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
### Return type
**PageCardPrintDto**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Card Prints Page retrieved | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@@ -4,13 +4,13 @@ All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**apiCardsIdNewPut**](#apicardsidnewput) | **PUT** /api/cards/{id}/new | Test|
|[**fetchUpstream**](#fetchupstream) | **POST** /api/cards/fetch | Fetch Cards by ID or Name from any upstream service|
|[**getCardById**](#getcardbyid) | **GET** /api/cards/{id} | Get a singular Card by its ID|
|[**getCardImageById**](#getcardimagebyid) | **GET** /api/cards/{id}/image | Get the image of a Card by its ID|
|[**getCards**](#getcards) | **GET** /api/cards | Get a page of Cards with optional name query parameter|
|[**getCardPage**](#getcardpage) | **GET** /api/cards | Get a page of Cards with optional name query parameter|
# **apiCardsIdNewPut**
> apiCardsIdNewPut()
# **fetchUpstream**
> Array<Card> fetchUpstream(cardUpstreamFetchRequest)
### Example
@@ -18,16 +18,17 @@ All URIs are relative to *http://localhost*
```typescript
import {
CardService,
Configuration
} from 'restClient';
Configuration,
CardUpstreamFetchRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new CardService(configuration);
let id: number; // (default to undefined)
let cardUpstreamFetchRequest: CardUpstreamFetchRequest; //
const { status, data } = await apiInstance.apiCardsIdNewPut(
id
const { status, data } = await apiInstance.fetchUpstream(
cardUpstreamFetchRequest
);
```
@@ -35,12 +36,12 @@ const { status, data } = await apiInstance.apiCardsIdNewPut(
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | | defaults to undefined|
| **cardUpstreamFetchRequest** | **CardUpstreamFetchRequest**| | |
### Return type
void (empty response body)
**Array<Card>**
### Authorization
@@ -48,19 +49,20 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | No Content | - |
|**200** | Cards retrieved | - |
|**404** | Card with Name or ID cannot be found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getCardById**
> NewCard getCardById()
> Card getCardById()
### Example
@@ -69,7 +71,7 @@ No authorization required
import {
CardService,
Configuration
} from 'restClient';
} from './api';
const configuration = new Configuration();
const apiInstance = new CardService(configuration);
@@ -90,7 +92,7 @@ const { status, data } = await apiInstance.getCardById(
### Return type
**NewCard**
**Card**
### Authorization
@@ -120,7 +122,7 @@ No authorization required
import {
CardService,
Configuration
} from 'restClient';
} from './api';
const configuration = new Configuration();
const apiInstance = new CardService(configuration);
@@ -161,8 +163,8 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getCards**
> Array<Card> getCards()
# **getCardPage**
> PageCardDto getCardPage()
### Example
@@ -171,7 +173,7 @@ No authorization required
import {
CardService,
Configuration
} from 'restClient';
} from './api';
const configuration = new Configuration();
const apiInstance = new CardService(configuration);
@@ -180,7 +182,7 @@ let name: string; // (optional) (default to undefined)
let page: number; // (optional) (default to undefined)
let pageSize: number; // (optional) (default to undefined)
const { status, data } = await apiInstance.getCards(
const { status, data } = await apiInstance.getCardPage(
name,
page,
pageSize
@@ -198,7 +200,7 @@ const { status, data } = await apiInstance.getCards(
### Return type
**Array<Card>**
**PageCardDto**
### Authorization

View File

@@ -0,0 +1,26 @@
# CardUpstreamFetchRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**services** | **Array&lt;string&gt;** | | [default to undefined]
**persist** | **boolean** | | [optional] [default to undefined]
**name** | **string** | | [optional] [default to undefined]
**id** | **number** | | [optional] [default to undefined]
## Example
```typescript
import { CardUpstreamFetchRequest } from './api';
const instance: CardUpstreamFetchRequest = {
services,
persist,
name,
id,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -7,17 +7,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**name** | **string** | | [default to undefined]
**cards** | **{ [key: string]: number; }** | | [default to undefined]
**prints** | [**Set&lt;CardPrint&gt;**](CardPrint.md) | | [default to undefined]
## Example
```typescript
import { Deck } from 'restClient';
import { Deck } from './api';
const instance: Deck = {
id,
name,
cards,
prints,
};
```

View File

@@ -0,0 +1,20 @@
# DeckCreateRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [default to undefined]
## Example
```typescript
import { DeckCreateRequest } from './api';
const instance: DeckCreateRequest = {
name,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -19,7 +19,7 @@ All URIs are relative to *http://localhost*
import {
DeckService,
Configuration
} from 'restClient';
} from './api';
const configuration = new Configuration();
const apiInstance = new DeckService(configuration);
@@ -64,7 +64,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **createDeck**
> createDeck(deck)
> createDeck(deckCreateRequest)
### Example
@@ -73,16 +73,16 @@ No authorization required
import {
DeckService,
Configuration,
Deck
} from 'restClient';
DeckCreateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new DeckService(configuration);
let deck: Deck; //
let deckCreateRequest: DeckCreateRequest; //
const { status, data } = await apiInstance.createDeck(
deck
deckCreateRequest
);
```
@@ -90,7 +90,7 @@ const { status, data } = await apiInstance.createDeck(
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **deck** | **Deck**| | |
| **deckCreateRequest** | **DeckCreateRequest**| | |
### Return type
@@ -125,7 +125,7 @@ No authorization required
import {
DeckService,
Configuration
} from 'restClient';
} from './api';
const configuration = new Configuration();
const apiInstance = new DeckService(configuration);
@@ -167,7 +167,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getDecks**
> PageDeck getDecks()
> PageDeckDto getDecks()
### Example
@@ -176,7 +176,7 @@ No authorization required
import {
DeckService,
Configuration
} from 'restClient';
} from './api';
const configuration = new Configuration();
const apiInstance = new DeckService(configuration);
@@ -203,7 +203,7 @@ const { status, data } = await apiInstance.getDecks(
### Return type
**PageDeck**
**PageDeckDto**
### Authorization

View File

@@ -0,0 +1,58 @@
# JobControllerService
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**apiJobsNameGet**](#apijobsnameget) | **GET** /api/jobs/{name} | Get Deck By Name|
# **apiJobsNameGet**
> string apiJobsNameGet()
### Example
```typescript
import {
JobControllerService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new JobControllerService(configuration);
let name: string; // (default to undefined)
const { status, data } = await apiInstance.apiJobsNameGet(
name
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | | defaults to undefined|
### Return type
**string**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@@ -0,0 +1,30 @@
# JobDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**pendingJobs** | **number** | | [optional] [default to undefined]
**processingJobs** | **number** | | [optional] [default to undefined]
**completedJobs** | **number** | | [optional] [default to undefined]
**failedJobs** | **number** | | [optional] [default to undefined]
**status** | [**JobStatus**](JobStatus.md) | | [default to undefined]
## Example
```typescript
import { JobDto } from './api';
const instance: JobDto = {
id,
pendingJobs,
processingJobs,
completedJobs,
failedJobs,
status,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,160 @@
# JobService
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getCardPrintImportJobStatusById**](#getcardprintimportjobstatusbyid) | **GET** /api/jobs/cardPrintImport/{id} | Get status of CardPrintImportJob|
|[**getCardSetImportJobStatusById**](#getcardsetimportjobstatusbyid) | **GET** /api/jobs/cardSetImport/{id} | Get status of CardSetImportJob|
|[**getRegionalSetImportJobStatusById**](#getregionalsetimportjobstatusbyid) | **GET** /api/jobs/regionalSetImport/{id} | Get status of RegionalSetImportJob|
# **getCardPrintImportJobStatusById**
> JobDto getCardPrintImportJobStatusById()
### Example
```typescript
import {
JobService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new JobService(configuration);
let id: number; // (default to undefined)
const { status, data } = await apiInstance.getCardPrintImportJobStatusById(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | | defaults to undefined|
### Return type
**JobDto**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getCardSetImportJobStatusById**
> JobDto getCardSetImportJobStatusById()
### Example
```typescript
import {
JobService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new JobService(configuration);
let id: number; // (default to undefined)
const { status, data } = await apiInstance.getCardSetImportJobStatusById(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | | defaults to undefined|
### Return type
**JobDto**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getRegionalSetImportJobStatusById**
> JobDto getRegionalSetImportJobStatusById()
### Example
```typescript
import {
JobService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new JobService(configuration);
let id: number; // (default to undefined)
const { status, data } = await apiInstance.getRegionalSetImportJobStatusById(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | | defaults to undefined|
### Return type
**JobDto**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@@ -0,0 +1,14 @@
# JobStatus
## Enum
* `Pending` (value: `'PENDING'`)
* `Processing` (value: `'PROCESSING'`)
* `Completed` (value: `'COMPLETED'`)
* `Failed` (value: `'FAILED'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,22 @@
# LinkArrow
## Enum
* `TopLeft` (value: `'TOP_LEFT'`)
* `Top` (value: `'TOP'`)
* `TopRight` (value: `'TOP_RIGHT'`)
* `Left` (value: `'LEFT'`)
* `Right` (value: `'RIGHT'`)
* `BottomLeft` (value: `'BOTTOM_LEFT'`)
* `Bottom` (value: `'BOTTOM'`)
* `BottomRight` (value: `'BOTTOM_RIGHT'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,52 @@
# MonsterCard
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**cardType** | [**CardType**](CardType.md) | | [default to undefined]
**description** | **string** | | [default to undefined]
**name** | **string** | | [default to undefined]
**cardPrints** | [**Set&lt;CardPrint&gt;**](CardPrint.md) | | [default to undefined]
**monsterEffect** | **string** | | [optional] [default to undefined]
**attack** | **number** | | [optional] [default to undefined]
**defense** | **number** | | [optional] [default to undefined]
**level** | **number** | | [optional] [default to undefined]
**isPendulum** | **boolean** | | [optional] [default to undefined]
**pendulumScale** | **number** | | [optional] [default to undefined]
**pendulumEffect** | **string** | | [optional] [default to undefined]
**linkValue** | **number** | | [optional] [default to undefined]
**subType** | [**MonsterCardType**](MonsterCardType.md) | | [default to undefined]
**monsterType** | [**MonsterType**](MonsterType.md) | | [default to undefined]
**attribute** | [**Attribute**](Attribute.md) | | [default to undefined]
**linkArrows** | [**Set&lt;LinkArrow&gt;**](LinkArrow.md) | | [default to undefined]
## Example
```typescript
import { MonsterCard } from './api';
const instance: MonsterCard = {
id,
cardType,
description,
name,
cardPrints,
monsterEffect,
attack,
defense,
level,
isPendulum,
pendulumScale,
pendulumEffect,
linkValue,
subType,
monsterType,
attribute,
linkArrows,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,20 @@
# MonsterCardType
## Enum
* `Normal` (value: `'NORMAL'`)
* `Effect` (value: `'EFFECT'`)
* `Ritual` (value: `'RITUAL'`)
* `Fusion` (value: `'FUSION'`)
* `Synchro` (value: `'SYNCHRO'`)
* `Xyz` (value: `'XYZ'`)
* `Link` (value: `'LINK'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,58 @@
# MonsterType
## Enum
* `Aqua` (value: `'AQUA'`)
* `Beast` (value: `'BEAST'`)
* `BeastWarrior` (value: `'BEAST_WARRIOR'`)
* `CreatorGod` (value: `'CREATOR_GOD'`)
* `Cyberse` (value: `'CYBERSE'`)
* `Dinosaur` (value: `'DINOSAUR'`)
* `DivineBeast` (value: `'DIVINE_BEAST'`)
* `Dragon` (value: `'DRAGON'`)
* `Fairy` (value: `'FAIRY'`)
* `Fiend` (value: `'FIEND'`)
* `Fish` (value: `'FISH'`)
* `Insect` (value: `'INSECT'`)
* `Illusion` (value: `'ILLUSION'`)
* `Machine` (value: `'MACHINE'`)
* `Plant` (value: `'PLANT'`)
* `Psychic` (value: `'PSYCHIC'`)
* `Pyro` (value: `'PYRO'`)
* `Reptile` (value: `'REPTILE'`)
* `Rock` (value: `'ROCK'`)
* `SeaSerpent` (value: `'SEA_SERPENT'`)
* `Spellcaster` (value: `'SPELLCASTER'`)
* `Thunder` (value: `'THUNDER'`)
* `Warrior` (value: `'WARRIOR'`)
* `WingedBeast` (value: `'WINGED_BEAST'`)
* `Wyrm` (value: `'WYRM'`)
* `Zombie` (value: `'ZOMBIE'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -1,25 +1,28 @@
# PageDeck
# Page
Page of items
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | [**Array&lt;Deck&gt;**](Deck.md) | | [default to undefined]
**content** | **Array&lt;any&gt;** | Items in the page | [default to undefined]
**page** | **number** | | [optional] [default to undefined]
**pageSize** | **number** | | [optional] [default to undefined]
**totalPages** | **number** | | [optional] [default to undefined]
**totalRecords** | **number** | | [optional] [default to undefined]
## Example
```typescript
import { PageDeck } from 'restClient';
import { Page } from './api';
const instance: PageDeck = {
const instance: Page = {
content,
page,
pageSize,
totalPages,
totalRecords,
};
```

View File

@@ -0,0 +1,29 @@
# PageCardDto
Page of items
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | [**Array&lt;Card&gt;**](Card.md) | Items in the page | [default to undefined]
**page** | **number** | | [optional] [default to undefined]
**pageSize** | **number** | | [optional] [default to undefined]
**totalPages** | **number** | | [optional] [default to undefined]
**totalRecords** | **number** | | [optional] [default to undefined]
## Example
```typescript
import { PageCardDto } from './api';
const instance: PageCardDto = {
content,
page,
pageSize,
totalPages,
totalRecords,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,29 @@
# PageCardPrintDto
Page of items
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | [**Array&lt;CardPrint&gt;**](CardPrint.md) | Items in the page | [default to undefined]
**page** | **number** | | [optional] [default to undefined]
**pageSize** | **number** | | [optional] [default to undefined]
**totalPages** | **number** | | [optional] [default to undefined]
**totalRecords** | **number** | | [optional] [default to undefined]
## Example
```typescript
import { PageCardPrintDto } from './api';
const instance: PageCardPrintDto = {
content,
page,
pageSize,
totalPages,
totalRecords,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,29 @@
# PageDeckDto
Page of items
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | [**Array&lt;Deck&gt;**](Deck.md) | Items in the page | [default to undefined]
**page** | **number** | | [optional] [default to undefined]
**pageSize** | **number** | | [optional] [default to undefined]
**totalPages** | **number** | | [optional] [default to undefined]
**totalRecords** | **number** | | [optional] [default to undefined]
## Example
```typescript
import { PageDeckDto } from './api';
const instance: PageDeckDto = {
content,
page,
pageSize,
totalPages,
totalRecords,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,29 @@
# PageSetDto
Page of items
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | [**Array&lt;SetDto&gt;**](SetDto.md) | Items in the page | [default to undefined]
**page** | **number** | | [optional] [default to undefined]
**pageSize** | **number** | | [optional] [default to undefined]
**totalPages** | **number** | | [optional] [default to undefined]
**totalRecords** | **number** | | [optional] [default to undefined]
## Example
```typescript
import { PageSetDto } from './api';
const instance: PageSetDto = {
content,
page,
pageSize,
totalPages,
totalRecords,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -1,24 +1,34 @@
# Region
## Properties
## Enum
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [default to undefined]
**name** | **string** | | [default to undefined]
**regionalSets** | [**Set&lt;RegionalSet&gt;**](RegionalSet.md) | | [default to undefined]
* `AsianEnglish` (value: `'ASIAN_ENGLISH'`)
## Example
* `Japanese` (value: `'JAPANESE'`)
```typescript
import { Region } from 'restClient';
* `JapaneseAsian` (value: `'JAPANESE_ASIAN'`)
const instance: Region = {
id,
name,
regionalSets,
};
```
* `English` (value: `'ENGLISH'`)
* `EuropeanEnglish` (value: `'EUROPEAN_ENGLISH'`)
* `Korean` (value: `'KOREAN'`)
* `French` (value: `'FRENCH'`)
* `FrenchCanadian` (value: `'FRENCH_CANADIAN'`)
* `NaEnglish` (value: `'NA_ENGLISH'`)
* `Oceanic` (value: `'OCEANIC'`)
* `German` (value: `'GERMAN'`)
* `Portuguese` (value: `'PORTUGUESE'`)
* `Italian` (value: `'ITALIAN'`)
* `Spanish` (value: `'SPANISH'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,24 @@
# RegionCodeAlias
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**alias** | **string** | | [default to undefined]
**region** | [**Region**](Region.md) | | [default to undefined]
## Example
```typescript
import { RegionCodeAlias } from './api';
const instance: RegionCodeAlias = {
id,
alias,
region,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -5,15 +5,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [default to undefined]
**prefix** | [**SetPrefix**](SetPrefix.md) | | [default to undefined]
**region** | [**Region**](Region.md) | | [default to undefined]
**cardPrints** | [**Set&lt;CardPrint&gt;**](CardPrint.md) | | [default to undefined]
**id** | **number** | | [optional] [default to undefined]
**prefix** | **string** | | [default to undefined]
**region** | **string** | | [default to undefined]
**cardPrints** | [**Array&lt;CardPrint&gt;**](CardPrint.md) | | [default to undefined]
## Example
```typescript
import { RegionalSet } from 'restClient';
import { RegionalSet } from './api';
const instance: RegionalSet = {
id,

View File

@@ -0,0 +1,20 @@
# SetDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [default to undefined]
## Example
```typescript
import { SetDto } from './api';
const instance: SetDto = {
name,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -5,19 +5,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [default to undefined]
**id** | **number** | | [optional] [default to undefined]
**name** | **string** | | [default to undefined]
**regionalSets** | [**Set&lt;RegionalSet&gt;**](RegionalSet.md) | | [default to undefined]
## Example
```typescript
import { SetPrefix } from 'restClient';
import { SetPrefix } from './api';
const instance: SetPrefix = {
id,
name,
regionalSets,
};
```

View File

@@ -0,0 +1,217 @@
# SetService
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**apiSetsNameGet**](#apisetsnameget) | **GET** /api/sets/{name} | Find Set By Name|
|[**apiSetsNameNewGet**](#apisetsnamenewget) | **GET** /api/sets/{name}/new | Fetch And Persist From Upstream|
|[**apiSetsNameScrapeGet**](#apisetsnamescrapeget) | **GET** /api/sets/{name}/scrape | Scrape And Persist From Upstream|
|[**getCardSetPage**](#getcardsetpage) | **GET** /api/sets | Get a page of Card Sets with optional name query parameter|
# **apiSetsNameGet**
> SetDto apiSetsNameGet()
### Example
```typescript
import {
SetService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new SetService(configuration);
let name: string; // (default to undefined)
const { status, data } = await apiInstance.apiSetsNameGet(
name
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | | defaults to undefined|
### Return type
**SetDto**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Set retrieved | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **apiSetsNameNewGet**
> Array<SetDto> apiSetsNameNewGet()
### Example
```typescript
import {
SetService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new SetService(configuration);
let name: string; // (default to undefined)
const { status, data } = await apiInstance.apiSetsNameNewGet(
name
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | | defaults to undefined|
### Return type
**Array<SetDto>**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Set retrieved | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **apiSetsNameScrapeGet**
> apiSetsNameScrapeGet()
### Example
```typescript
import {
SetService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new SetService(configuration);
let name: string; // (default to undefined)
const { status, data } = await apiInstance.apiSetsNameScrapeGet(
name
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | | defaults to undefined|
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Set retrieved | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getCardSetPage**
> PageSetDto getCardSetPage()
### Example
```typescript
import {
SetService,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new SetService(configuration);
let name: string; // (optional) (default to undefined)
let page: number; // (optional) (default to undefined)
let pageSize: number; // (optional) (default to undefined)
const { status, data } = await apiInstance.getCardSetPage(
name,
page,
pageSize
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | | (optional) defaults to undefined|
| **page** | [**number**] | | (optional) defaults to undefined|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
### Return type
**PageSetDto**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Page for the given query | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@@ -0,0 +1,30 @@
# SpellCard
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to undefined]
**cardType** | [**CardType**](CardType.md) | | [default to undefined]
**description** | **string** | | [default to undefined]
**name** | **string** | | [default to undefined]
**cardPrints** | [**Set&lt;CardPrint&gt;**](CardPrint.md) | | [default to undefined]
**subType** | [**SpellCardType**](SpellCardType.md) | | [default to undefined]
## Example
```typescript
import { SpellCard } from './api';
const instance: SpellCard = {
id,
cardType,
description,
name,
cardPrints,
subType,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,18 @@
# SpellCardType
## Enum
* `Normal` (value: `'NORMAL'`)
* `Continuous` (value: `'CONTINUOUS'`)
* `Equip` (value: `'EQUIP'`)
* `QuickPlay` (value: `'QUICK_PLAY'`)
* `Field` (value: `'FIELD'`)
* `Ritual` (value: `'RITUAL'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -1,4 +1,4 @@
# NewCard
# TrapCard
## Properties
@@ -10,18 +10,20 @@ Name | Type | Description | Notes
**description** | **string** | | [default to undefined]
**name** | **string** | | [default to undefined]
**cardPrints** | [**Set&lt;CardPrint&gt;**](CardPrint.md) | | [default to undefined]
**subType** | [**TrapCardType**](TrapCardType.md) | | [default to undefined]
## Example
```typescript
import { NewCard } from 'restClient';
import { TrapCard } from './api';
const instance: NewCard = {
const instance: TrapCard = {
id,
cardType,
description,
name,
cardPrints,
subType,
};
```

View File

@@ -0,0 +1,12 @@
# TrapCardType
## Enum
* `Normal` (value: `'NORMAL'`)
* `Continuous` (value: `'CONTINUOUS'`)
* `Counter` (value: `'COUNTER'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)