lfk-client-js/dist/services/DonorService.d.ts
Nicolai Ort f4905b8df6
All checks were successful
continuous-integration/drone Build is passing
🚀New lib version v1.0.0 [CI SKIP]
2023-04-18 18:05:41 +00:00

51 lines
1.9 KiB
TypeScript

import type { CreateDonor } from '../models/CreateDonor';
import type { ResponseDonor } from '../models/ResponseDonor';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { UpdateDonor } from '../models/UpdateDonor';
export declare class DonorService {
/**
* Get all
* Lists all donor. <br> This includes the donor's current donation amount.
* @param page
* @param pageSize
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseDonor>>;
/**
* Post
* Create a new donor.
* @param requestBody CreateDonor
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerPost(requestBody?: CreateDonor): Promise<ResponseDonor>;
/**
* Get one
* Lists all information about the donor whose id got provided. <br> This includes the donor's current donation amount.
* @param id
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerGetOne(id: number): Promise<ResponseDonor>;
/**
* Put
* Update the donor whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateDonor
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerPut(id: number, requestBody?: UpdateDonor): Promise<ResponseDonor>;
/**
* Remove
* Delete the donor whose id you provided. <br> If no donor with this id exists it will just return 204(no content). <br> If the donor still has donations associated this will fail, please provide the query param ?force=true to delete the donor with all associated donations.
* @param id
* @param force
* @result ResponseDonor
* @result ResponseEmpty
* @throws ApiError
*/
static donorControllerRemove(id: number, force?: boolean): Promise<ResponseDonor | ResponseEmpty>;
}