@space-cow-media/spellbook-client/spellbook-client/apis/VariantSuggestionsApi.ts

An Open Api generated client for the Commander Spellbook backend REST API.

/* 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 PaginatedVariantSuggestionList,
    PaginatedVariantSuggestionListFromJSON,
    PaginatedVariantSuggestionListToJSON,
} from '../models/PaginatedVariantSuggestionList.js';
import {
    type PatchedVariantSuggestionRequest,
    PatchedVariantSuggestionRequestFromJSON,
    PatchedVariantSuggestionRequestToJSON,
} from '../models/PatchedVariantSuggestionRequest.js';
import {
    type VariantSuggestion,
    VariantSuggestionFromJSON,
    VariantSuggestionToJSON,
} from '../models/VariantSuggestion.js';
import {
    type VariantSuggestionRequest,
    VariantSuggestionRequestFromJSON,
    VariantSuggestionRequestToJSON,
} from '../models/VariantSuggestionRequest.js';

export interface VariantSuggestionsCreateRequest {
    variantSuggestionRequest: VariantSuggestionRequest;
}

export interface VariantSuggestionsDestroyRequest {
    id: number;
}

export interface VariantSuggestionsListRequest {
    count?: boolean;
    limit?: number;
    offset?: number;
    suggestedBy?: number;
}

export interface VariantSuggestionsPartialUpdateRequest {
    id: number;
    patchedVariantSuggestionRequest?: PatchedVariantSuggestionRequest;
}

export interface VariantSuggestionsRetrieveRequest {
    id: number;
}

export interface VariantSuggestionsUpdateRequest {
    id: number;
    variantSuggestionRequest: VariantSuggestionRequest;
}

export interface VariantSuggestionsValidateCreateRequest {
    variantSuggestionRequest: VariantSuggestionRequest;
}

export interface VariantSuggestionsValidatePartialUpdateRequest {
    id: number;
    patchedVariantSuggestionRequest?: PatchedVariantSuggestionRequest;
}

export interface VariantSuggestionsValidateUpdateRequest {
    id: number;
    variantSuggestionRequest: VariantSuggestionRequest;
}

/**
 * 
 */
export class VariantSuggestionsApi extends runtime.BaseAPI {

    /**
     * Creates request options for variantSuggestionsCreate without sending the request
     */
    async variantSuggestionsCreateRequestOpts(requestParameters: VariantSuggestionsCreateRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['variantSuggestionRequest'] == null) {
            throw new runtime.RequiredError(
                'variantSuggestionRequest',
                'Required parameter "variantSuggestionRequest" was null or undefined when calling variantSuggestionsCreate().'
            );
        }

        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-suggestions/`;

        return {
            path: urlPath,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: VariantSuggestionRequestToJSON(requestParameters['variantSuggestionRequest']),
        };
    }

    /**
     */
    async variantSuggestionsCreateRaw(requestParameters: VariantSuggestionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsCreateRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     */
    async variantSuggestionsCreate(requestParameters: VariantSuggestionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsCreateRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsDestroy without sending the request
     */
    async variantSuggestionsDestroyRequestOpts(requestParameters: VariantSuggestionsDestroyRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling variantSuggestionsDestroy().'
            );
        }

        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-suggestions/{id}/`;
        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));

        return {
            path: urlPath,
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        };
    }

    /**
     */
    async variantSuggestionsDestroyRaw(requestParameters: VariantSuggestionsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        const requestOptions = await this.variantSuggestionsDestroyRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     */
    async variantSuggestionsDestroy(requestParameters: VariantSuggestionsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.variantSuggestionsDestroyRaw(requestParameters, initOverrides);
    }

    /**
     * Creates request options for variantSuggestionsList without sending the request
     */
    async variantSuggestionsListRequestOpts(requestParameters: VariantSuggestionsListRequest): 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-suggestions/`;

        return {
            path: urlPath,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        };
    }

    /**
     */
    async variantSuggestionsListRaw(requestParameters: VariantSuggestionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedVariantSuggestionList>> {
        const requestOptions = await this.variantSuggestionsListRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedVariantSuggestionListFromJSON(jsonValue));
    }

    /**
     */
    async variantSuggestionsList(requestParameters: VariantSuggestionsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedVariantSuggestionList> {
        const response = await this.variantSuggestionsListRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsPartialUpdate without sending the request
     */
    async variantSuggestionsPartialUpdateRequestOpts(requestParameters: VariantSuggestionsPartialUpdateRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling variantSuggestionsPartialUpdate().'
            );
        }

        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-suggestions/{id}/`;
        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));

        return {
            path: urlPath,
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
            body: PatchedVariantSuggestionRequestToJSON(requestParameters['patchedVariantSuggestionRequest']),
        };
    }

    /**
     */
    async variantSuggestionsPartialUpdateRaw(requestParameters: VariantSuggestionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsPartialUpdateRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     */
    async variantSuggestionsPartialUpdate(requestParameters: VariantSuggestionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsPartialUpdateRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsRetrieve without sending the request
     */
    async variantSuggestionsRetrieveRequestOpts(requestParameters: VariantSuggestionsRetrieveRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling variantSuggestionsRetrieve().'
            );
        }

        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-suggestions/{id}/`;
        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));

        return {
            path: urlPath,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        };
    }

    /**
     */
    async variantSuggestionsRetrieveRaw(requestParameters: VariantSuggestionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsRetrieveRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     */
    async variantSuggestionsRetrieve(requestParameters: VariantSuggestionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsRetrieveRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsUpdate without sending the request
     */
    async variantSuggestionsUpdateRequestOpts(requestParameters: VariantSuggestionsUpdateRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling variantSuggestionsUpdate().'
            );
        }

        if (requestParameters['variantSuggestionRequest'] == null) {
            throw new runtime.RequiredError(
                'variantSuggestionRequest',
                'Required parameter "variantSuggestionRequest" was null or undefined when calling variantSuggestionsUpdate().'
            );
        }

        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-suggestions/{id}/`;
        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));

        return {
            path: urlPath,
            method: 'PUT',
            headers: headerParameters,
            query: queryParameters,
            body: VariantSuggestionRequestToJSON(requestParameters['variantSuggestionRequest']),
        };
    }

    /**
     */
    async variantSuggestionsUpdateRaw(requestParameters: VariantSuggestionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsUpdateRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     */
    async variantSuggestionsUpdate(requestParameters: VariantSuggestionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsUpdateRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsValidateCreate without sending the request
     */
    async variantSuggestionsValidateCreateRequestOpts(requestParameters: VariantSuggestionsValidateCreateRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['variantSuggestionRequest'] == null) {
            throw new runtime.RequiredError(
                'variantSuggestionRequest',
                'Required parameter "variantSuggestionRequest" was null or undefined when calling variantSuggestionsValidateCreate().'
            );
        }

        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-suggestions/validate/`;

        return {
            path: urlPath,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: VariantSuggestionRequestToJSON(requestParameters['variantSuggestionRequest']),
        };
    }

    /**
     * Validate the variant suggestion data.
     */
    async variantSuggestionsValidateCreateRaw(requestParameters: VariantSuggestionsValidateCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsValidateCreateRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     * Validate the variant suggestion data.
     */
    async variantSuggestionsValidateCreate(requestParameters: VariantSuggestionsValidateCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsValidateCreateRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsValidatePartialUpdate without sending the request
     */
    async variantSuggestionsValidatePartialUpdateRequestOpts(requestParameters: VariantSuggestionsValidatePartialUpdateRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling variantSuggestionsValidatePartialUpdate().'
            );
        }

        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-suggestions/{id}/validate/`;
        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));

        return {
            path: urlPath,
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
            body: PatchedVariantSuggestionRequestToJSON(requestParameters['patchedVariantSuggestionRequest']),
        };
    }

    /**
     * Validate the variant suggestion update data.
     */
    async variantSuggestionsValidatePartialUpdateRaw(requestParameters: VariantSuggestionsValidatePartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsValidatePartialUpdateRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     * Validate the variant suggestion update data.
     */
    async variantSuggestionsValidatePartialUpdate(requestParameters: VariantSuggestionsValidatePartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsValidatePartialUpdateRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates request options for variantSuggestionsValidateUpdate without sending the request
     */
    async variantSuggestionsValidateUpdateRequestOpts(requestParameters: VariantSuggestionsValidateUpdateRequest): Promise<runtime.RequestOpts> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling variantSuggestionsValidateUpdate().'
            );
        }

        if (requestParameters['variantSuggestionRequest'] == null) {
            throw new runtime.RequiredError(
                'variantSuggestionRequest',
                'Required parameter "variantSuggestionRequest" was null or undefined when calling variantSuggestionsValidateUpdate().'
            );
        }

        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-suggestions/{id}/validate/`;
        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));

        return {
            path: urlPath,
            method: 'PUT',
            headers: headerParameters,
            query: queryParameters,
            body: VariantSuggestionRequestToJSON(requestParameters['variantSuggestionRequest']),
        };
    }

    /**
     * Validate the variant suggestion update data.
     */
    async variantSuggestionsValidateUpdateRaw(requestParameters: VariantSuggestionsValidateUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantSuggestion>> {
        const requestOptions = await this.variantSuggestionsValidateUpdateRequestOpts(requestParameters);
        const response = await this.request(requestOptions, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => VariantSuggestionFromJSON(jsonValue));
    }

    /**
     * Validate the variant suggestion update data.
     */
    async variantSuggestionsValidateUpdate(requestParameters: VariantSuggestionsValidateUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantSuggestion> {
        const response = await this.variantSuggestionsValidateUpdateRaw(requestParameters, initOverrides);
        return await response.value();
    }

}