@space-cow-media/spellbook-client
Version:
An Open Api generated client for the Commander Spellbook backend REST API.
85 lines (57 loc) • 1.99 kB
Markdown
# 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)