@space-cow-media/spellbook-client
Version:
An Open Api generated client for the Commander Spellbook backend REST API.
615 lines (501 loc) • 26.7 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* Commander Spellbook API
* API for Commander Spellbook, the combo database engine for Magic: The Gathering
*
* The version of the OpenAPI document: 5.4.10
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime.js';
import {
type PaginatedVariantUpdateSuggestionList,
PaginatedVariantUpdateSuggestionListFromJSON,
PaginatedVariantUpdateSuggestionListToJSON,
} from '../models/PaginatedVariantUpdateSuggestionList.js';
import {
type PatchedVariantUpdateSuggestionRequest,
PatchedVariantUpdateSuggestionRequestFromJSON,
PatchedVariantUpdateSuggestionRequestToJSON,
} from '../models/PatchedVariantUpdateSuggestionRequest.js';
import {
type VariantUpdateSuggestion,
VariantUpdateSuggestionFromJSON,
VariantUpdateSuggestionToJSON,
} from '../models/VariantUpdateSuggestion.js';
import {
type VariantUpdateSuggestionRequest,
VariantUpdateSuggestionRequestFromJSON,
VariantUpdateSuggestionRequestToJSON,
} from '../models/VariantUpdateSuggestionRequest.js';
export interface VariantUpdateSuggestionsCreateRequest {
variantUpdateSuggestionRequest: VariantUpdateSuggestionRequest;
}
export interface VariantUpdateSuggestionsDestroyRequest {
id: number;
}
export interface VariantUpdateSuggestionsListRequest {
count?: boolean;
limit?: number;
offset?: number;
suggestedBy?: number;
}
export interface VariantUpdateSuggestionsPartialUpdateRequest {
id: number;
patchedVariantUpdateSuggestionRequest?: PatchedVariantUpdateSuggestionRequest;
}
export interface VariantUpdateSuggestionsRetrieveRequest {
id: number;
}
export interface VariantUpdateSuggestionsUpdateRequest {
id: number;
variantUpdateSuggestionRequest: VariantUpdateSuggestionRequest;
}
export interface VariantUpdateSuggestionsValidateCreateRequest {
variantUpdateSuggestionRequest: VariantUpdateSuggestionRequest;
}
export interface VariantUpdateSuggestionsValidatePartialUpdateRequest {
id: number;
patchedVariantUpdateSuggestionRequest?: PatchedVariantUpdateSuggestionRequest;
}
export interface VariantUpdateSuggestionsValidateUpdateRequest {
id: number;
variantUpdateSuggestionRequest: VariantUpdateSuggestionRequest;
}
/**
*
*/
export class VariantUpdateSuggestionsApi extends runtime.BaseAPI {
/**
* Creates request options for variantUpdateSuggestionsCreate without sending the request
*/
async variantUpdateSuggestionsCreateRequestOpts(requestParameters: VariantUpdateSuggestionsCreateRequest): Promise<runtime.RequestOpts> {
if (requestParameters['variantUpdateSuggestionRequest'] == null) {
throw new runtime.RequiredError(
'variantUpdateSuggestionRequest',
'Required parameter "variantUpdateSuggestionRequest" was null or undefined when calling variantUpdateSuggestionsCreate().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/`;
return {
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: VariantUpdateSuggestionRequestToJSON(requestParameters['variantUpdateSuggestionRequest']),
};
}
/**
*/
async variantUpdateSuggestionsCreateRaw(requestParameters: VariantUpdateSuggestionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsCreateRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
*/
async variantUpdateSuggestionsCreate(requestParameters: VariantUpdateSuggestionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsCreateRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsDestroy without sending the request
*/
async variantUpdateSuggestionsDestroyRequestOpts(requestParameters: VariantUpdateSuggestionsDestroyRequest): Promise<runtime.RequestOpts> {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError(
'id',
'Required parameter "id" was null or undefined when calling variantUpdateSuggestionsDestroy().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/{id}/`;
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
return {
path: urlPath,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
};
}
/**
*/
async variantUpdateSuggestionsDestroyRaw(requestParameters: VariantUpdateSuggestionsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const requestOptions = await this.variantUpdateSuggestionsDestroyRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async variantUpdateSuggestionsDestroy(requestParameters: VariantUpdateSuggestionsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.variantUpdateSuggestionsDestroyRaw(requestParameters, initOverrides);
}
/**
* Creates request options for variantUpdateSuggestionsList without sending the request
*/
async variantUpdateSuggestionsListRequestOpts(requestParameters: VariantUpdateSuggestionsListRequest): Promise<runtime.RequestOpts> {
const queryParameters: any = {};
if (requestParameters['count'] != null) {
queryParameters['count'] = requestParameters['count'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['suggestedBy'] != null) {
queryParameters['suggestedBy'] = requestParameters['suggestedBy'];
}
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/`;
return {
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
};
}
/**
*/
async variantUpdateSuggestionsListRaw(requestParameters: VariantUpdateSuggestionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedVariantUpdateSuggestionList>> {
const requestOptions = await this.variantUpdateSuggestionsListRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedVariantUpdateSuggestionListFromJSON(jsonValue));
}
/**
*/
async variantUpdateSuggestionsList(requestParameters: VariantUpdateSuggestionsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedVariantUpdateSuggestionList> {
const response = await this.variantUpdateSuggestionsListRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsPartialUpdate without sending the request
*/
async variantUpdateSuggestionsPartialUpdateRequestOpts(requestParameters: VariantUpdateSuggestionsPartialUpdateRequest): Promise<runtime.RequestOpts> {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError(
'id',
'Required parameter "id" was null or undefined when calling variantUpdateSuggestionsPartialUpdate().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/{id}/`;
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
return {
path: urlPath,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: PatchedVariantUpdateSuggestionRequestToJSON(requestParameters['patchedVariantUpdateSuggestionRequest']),
};
}
/**
*/
async variantUpdateSuggestionsPartialUpdateRaw(requestParameters: VariantUpdateSuggestionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsPartialUpdateRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
*/
async variantUpdateSuggestionsPartialUpdate(requestParameters: VariantUpdateSuggestionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsPartialUpdateRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsRetrieve without sending the request
*/
async variantUpdateSuggestionsRetrieveRequestOpts(requestParameters: VariantUpdateSuggestionsRetrieveRequest): Promise<runtime.RequestOpts> {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError(
'id',
'Required parameter "id" was null or undefined when calling variantUpdateSuggestionsRetrieve().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/{id}/`;
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
return {
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
};
}
/**
*/
async variantUpdateSuggestionsRetrieveRaw(requestParameters: VariantUpdateSuggestionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsRetrieveRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
*/
async variantUpdateSuggestionsRetrieve(requestParameters: VariantUpdateSuggestionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsRetrieveRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsUpdate without sending the request
*/
async variantUpdateSuggestionsUpdateRequestOpts(requestParameters: VariantUpdateSuggestionsUpdateRequest): Promise<runtime.RequestOpts> {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError(
'id',
'Required parameter "id" was null or undefined when calling variantUpdateSuggestionsUpdate().'
);
}
if (requestParameters['variantUpdateSuggestionRequest'] == null) {
throw new runtime.RequiredError(
'variantUpdateSuggestionRequest',
'Required parameter "variantUpdateSuggestionRequest" was null or undefined when calling variantUpdateSuggestionsUpdate().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/{id}/`;
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
return {
path: urlPath,
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: VariantUpdateSuggestionRequestToJSON(requestParameters['variantUpdateSuggestionRequest']),
};
}
/**
*/
async variantUpdateSuggestionsUpdateRaw(requestParameters: VariantUpdateSuggestionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsUpdateRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
*/
async variantUpdateSuggestionsUpdate(requestParameters: VariantUpdateSuggestionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsUpdateRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsValidateCreate without sending the request
*/
async variantUpdateSuggestionsValidateCreateRequestOpts(requestParameters: VariantUpdateSuggestionsValidateCreateRequest): Promise<runtime.RequestOpts> {
if (requestParameters['variantUpdateSuggestionRequest'] == null) {
throw new runtime.RequiredError(
'variantUpdateSuggestionRequest',
'Required parameter "variantUpdateSuggestionRequest" was null or undefined when calling variantUpdateSuggestionsValidateCreate().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/validate/`;
return {
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: VariantUpdateSuggestionRequestToJSON(requestParameters['variantUpdateSuggestionRequest']),
};
}
/**
* Validate the variant suggestion data.
*/
async variantUpdateSuggestionsValidateCreateRaw(requestParameters: VariantUpdateSuggestionsValidateCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsValidateCreateRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
* Validate the variant suggestion data.
*/
async variantUpdateSuggestionsValidateCreate(requestParameters: VariantUpdateSuggestionsValidateCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsValidateCreateRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsValidatePartialUpdate without sending the request
*/
async variantUpdateSuggestionsValidatePartialUpdateRequestOpts(requestParameters: VariantUpdateSuggestionsValidatePartialUpdateRequest): Promise<runtime.RequestOpts> {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError(
'id',
'Required parameter "id" was null or undefined when calling variantUpdateSuggestionsValidatePartialUpdate().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/{id}/validate/`;
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
return {
path: urlPath,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: PatchedVariantUpdateSuggestionRequestToJSON(requestParameters['patchedVariantUpdateSuggestionRequest']),
};
}
/**
* Validate the variant suggestion update data.
*/
async variantUpdateSuggestionsValidatePartialUpdateRaw(requestParameters: VariantUpdateSuggestionsValidatePartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsValidatePartialUpdateRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
* Validate the variant suggestion update data.
*/
async variantUpdateSuggestionsValidatePartialUpdate(requestParameters: VariantUpdateSuggestionsValidatePartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsValidatePartialUpdateRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Creates request options for variantUpdateSuggestionsValidateUpdate without sending the request
*/
async variantUpdateSuggestionsValidateUpdateRequestOpts(requestParameters: VariantUpdateSuggestionsValidateUpdateRequest): Promise<runtime.RequestOpts> {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError(
'id',
'Required parameter "id" was null or undefined when calling variantUpdateSuggestionsValidateUpdate().'
);
}
if (requestParameters['variantUpdateSuggestionRequest'] == null) {
throw new runtime.RequiredError(
'variantUpdateSuggestionRequest',
'Required parameter "variantUpdateSuggestionRequest" was null or undefined when calling variantUpdateSuggestionsValidateUpdate().'
);
}
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
}
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("jwtAuth", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
let urlPath = `/variant-update-suggestions/{id}/validate/`;
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
return {
path: urlPath,
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: VariantUpdateSuggestionRequestToJSON(requestParameters['variantUpdateSuggestionRequest']),
};
}
/**
* Validate the variant suggestion update data.
*/
async variantUpdateSuggestionsValidateUpdateRaw(requestParameters: VariantUpdateSuggestionsValidateUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantUpdateSuggestion>> {
const requestOptions = await this.variantUpdateSuggestionsValidateUpdateRequestOpts(requestParameters);
const response = await this.request(requestOptions, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => VariantUpdateSuggestionFromJSON(jsonValue));
}
/**
* Validate the variant suggestion update data.
*/
async variantUpdateSuggestionsValidateUpdate(requestParameters: VariantUpdateSuggestionsValidateUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantUpdateSuggestion> {
const response = await this.variantUpdateSuggestionsValidateUpdateRaw(requestParameters, initOverrides);
return await response.value();
}
}