/** * BugBash * BugBash\'s backend service * * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface Account */ export interface Account { /** * * @type {string} * @memberof Account */ id: string; /** * * @type {string} * @memberof Account */ organization: string; /** * * @type {string} * @memberof Account */ createdAt: string; } /** * * @export * @interface Assignee */ export interface Assignee { /** * * @type {string} * @memberof Assignee */ name: string; } /** * * @export * @interface BugBash */ export interface BugBash { /** * * @type {string} * @memberof BugBash */ id: string; /** * * @type {string} * @memberof BugBash */ bugBashName: string; /** * * @type {string} * @memberof BugBash */ accountID: string; /** * * @type {string} * @memberof BugBash */ joinCode: string; /** * * @type {Array} * @memberof BugBash */ participants?: Array; /** * * @type {string} * @memberof BugBash */ facilitator: string; /** * * @type {string} * @memberof BugBash */ createdAt: string; /** * * @type {string} * @memberof BugBash */ endedAt?: string; /** * * @type {string} * @memberof BugBash */ timeAllotted: string; } /** * * @export * @interface BugBashItem */ export interface BugBashItem { /** * * @type {string} * @memberof BugBashItem */ id?: string; /** * * @type {string} * @memberof BugBashItem */ createdAt?: string; /** * * @type {string} * @memberof BugBashItem */ lastUpdatedAt?: string; /** * * @type {string} * @memberof BugBashItem */ bugBashID: string; /** * * @type {string} * @memberof BugBashItem */ reproSteps: string; /** * * @type {string} * @memberof BugBashItem */ reportedState: string; /** * * @type {string} * @memberof BugBashItem */ expectedState: string; /** * * @type {DeviceMetadata} * @memberof BugBashItem */ deviceMetadata?: DeviceMetadata; /** * * @type {Reporter} * @memberof BugBashItem */ reporter: Reporter; /** * * @type {Assignee} * @memberof BugBashItem */ assignee?: Assignee; /** * * @type {boolean} * @memberof BugBashItem */ blocker?: boolean; /** * * @type {boolean} * @memberof BugBashItem */ kept?: boolean; } /** * * @export * @interface CreateAccountBody */ export interface CreateAccountBody { /** * * @type {string} * @memberof CreateAccountBody */ organization: string; } /** * * @export * @interface CreateBugBashBody */ export interface CreateBugBashBody { /** * * @type {string} * @memberof CreateBugBashBody */ bugBashName: string; /** * * @type {Array} * @memberof CreateBugBashBody */ participants?: Array; /** * * @type {string} * @memberof CreateBugBashBody */ facilitator: string; /** * * @type {string} * @memberof CreateBugBashBody */ timeAllotted: string; } /** * * @export * @interface DeviceMetadata */ export interface DeviceMetadata { /** * * @type {string} * @memberof DeviceMetadata */ browser?: string; /** * * @type {string} * @memberof DeviceMetadata */ ios?: string; } /** * * @export * @interface ModelError */ export interface ModelError { /** * * @type {number} * @memberof ModelError */ code: number; /** * * @type {string} * @memberof ModelError */ message: string; } /** * * @export * @interface Reporter */ export interface Reporter { /** * * @type {string} * @memberof Reporter */ name: string; } /** * DefaultApi - axios parameter creator * @export */ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create new account * @param {string} email * @param {string} password * @param {CreateAccountBody} createAccountBody Account data to store * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAccount: (email: string, password: string, createAccountBody: CreateAccountBody, options?: any) => Promise; /** * Start a bug bash session * @param {string} accountID The account id to create the bug bash for * @param {CreateBugBashBody} createBugBashBody Bug bash request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBugBash: (accountID: string, createBugBashBody: CreateBugBashBody, options?: any) => Promise; /** * Get all bug bash sessions for an account * @param {string} accountID Account id to receive bug bashes for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllBugBashesForAccount: (accountID: string, options?: any) => Promise; /** * Get all bug bash items for a specific bug bash * @param {string} bugbashID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBugBashItems: (bugbashID: string, options?: any) => Promise; /** * Verify if login credentials are valid * @param {string} email * @param {string} password * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLoginByEmailAndPassword: (email: string, password: string, options?: any) => Promise; /** * Health check endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ healthCheck: (options?: any) => Promise; /** * Save bug bash item * @param {string} accountID * @param {BugBashItem} bugBashItem Bug bash data to save * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveBugBashItem: (accountID: string, bugBashItem: BugBashItem, options?: any) => Promise; }; /** * DefaultApi - functional programming interface * @export */ export declare const DefaultApiFp: (configuration?: Configuration) => { /** * Create new account * @param {string} email * @param {string} password * @param {CreateAccountBody} createAccountBody Account data to store * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAccount(email: string, password: string, createAccountBody: CreateAccountBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Start a bug bash session * @param {string} accountID The account id to create the bug bash for * @param {CreateBugBashBody} createBugBashBody Bug bash request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBugBash(accountID: string, createBugBashBody: CreateBugBashBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all bug bash sessions for an account * @param {string} accountID Account id to receive bug bashes for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllBugBashesForAccount(accountID: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get all bug bash items for a specific bug bash * @param {string} bugbashID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBugBashItems(bugbashID: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Verify if login credentials are valid * @param {string} email * @param {string} password * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLoginByEmailAndPassword(email: string, password: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Health check endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ healthCheck(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Save bug bash item * @param {string} accountID * @param {BugBashItem} bugBashItem Bug bash data to save * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveBugBashItem(accountID: string, bugBashItem: BugBashItem, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DefaultApi - factory interface * @export */ export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create new account * @param {string} email * @param {string} password * @param {CreateAccountBody} createAccountBody Account data to store * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAccount(email: string, password: string, createAccountBody: CreateAccountBody, options?: any): AxiosPromise; /** * Start a bug bash session * @param {string} accountID The account id to create the bug bash for * @param {CreateBugBashBody} createBugBashBody Bug bash request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBugBash(accountID: string, createBugBashBody: CreateBugBashBody, options?: any): AxiosPromise; /** * Get all bug bash sessions for an account * @param {string} accountID Account id to receive bug bashes for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllBugBashesForAccount(accountID: string, options?: any): AxiosPromise>; /** * Get all bug bash items for a specific bug bash * @param {string} bugbashID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBugBashItems(bugbashID: string, options?: any): AxiosPromise>; /** * Verify if login credentials are valid * @param {string} email * @param {string} password * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLoginByEmailAndPassword(email: string, password: string, options?: any): AxiosPromise; /** * Health check endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ healthCheck(options?: any): AxiosPromise; /** * Save bug bash item * @param {string} accountID * @param {BugBashItem} bugBashItem Bug bash data to save * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveBugBashItem(accountID: string, bugBashItem: BugBashItem, options?: any): AxiosPromise; }; /** * DefaultApi - object-oriented interface * @export * @class DefaultApi * @extends {BaseAPI} */ export declare class DefaultApi extends BaseAPI { /** * Create new account * @param {string} email * @param {string} password * @param {CreateAccountBody} createAccountBody Account data to store * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createAccount(email: string, password: string, createAccountBody: CreateAccountBody, options?: any): Promise>; /** * Start a bug bash session * @param {string} accountID The account id to create the bug bash for * @param {CreateBugBashBody} createBugBashBody Bug bash request body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createBugBash(accountID: string, createBugBashBody: CreateBugBashBody, options?: any): Promise>; /** * Get all bug bash sessions for an account * @param {string} accountID Account id to receive bug bashes for * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getAllBugBashesForAccount(accountID: string, options?: any): Promise>; /** * Get all bug bash items for a specific bug bash * @param {string} bugbashID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBugBashItems(bugbashID: string, options?: any): Promise>; /** * Verify if login credentials are valid * @param {string} email * @param {string} password * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLoginByEmailAndPassword(email: string, password: string, options?: any): Promise>; /** * Health check endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ healthCheck(options?: any): Promise>; /** * Save bug bash item * @param {string} accountID * @param {BugBashItem} bugBashItem Bug bash data to save * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveBugBashItem(accountID: string, bugBashItem: BugBashItem, options?: any): Promise>; }