mailslurp-client/dist/generated/apis/GuestPortalControllerApi.d.ts

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

/**
 * MailSlurp API
 * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
 *
 * The version of the OpenAPI document: 6.5.2
 * Contact: contact@mailslurp.dev
 *
 * 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';
import { CreatePortalOptions, CreatePortalUserOptions, GuestPortalDto, GuestPortalUserCreateDto, GuestPortalUserDto, PageGuestPortalUsers } from '../models';
export interface CreateGuestPortalRequest {
    createPortalOptions: CreatePortalOptions;
}
export interface CreateGuestPortalUserRequest {
    portalId: string;
    createPortalUserOptions: CreatePortalUserOptions;
}
export interface GetAllGuestPortalUsersRequest {
    portalId?: string;
    search?: string;
    page?: number;
    size?: number;
    sort?: GetAllGuestPortalUsersSortEnum;
    since?: Date;
    before?: Date;
}
export interface GetGuestPortalRequest {
    portalId: string;
}
export interface GetGuestPortalUserRequest {
    portalId: string;
    guestId: string;
}
export interface GetGuestPortalUserByIdRequest {
    guestId: string;
}
export interface GetGuestPortalUsersRequest {
    portalId: string;
    search?: string;
    page?: number;
    size?: number;
    sort?: GetGuestPortalUsersSortEnum;
    since?: Date;
    before?: Date;
}
/**
 *
 */
export declare class GuestPortalControllerApi extends runtime.BaseAPI {
    /**
     * Create a guest login page for customers or clients to access assigned email addresses
     * Create a portal page for your customers or clients to log into email accounts and view emails.
     */
    createGuestPortalRaw(requestParameters: CreateGuestPortalRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GuestPortalDto>>;
    /**
     * Create a guest login page for customers or clients to access assigned email addresses
     * Create a portal page for your customers or clients to log into email accounts and view emails.
     */
    createGuestPortal(requestParameters: CreateGuestPortalRequest, initOverrides?: RequestInit): Promise<GuestPortalDto>;
    /**
     * Add customer to portal
     * Create a portal guest user
     */
    createGuestPortalUserRaw(requestParameters: CreateGuestPortalUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GuestPortalUserCreateDto>>;
    /**
     * Add customer to portal
     * Create a portal guest user
     */
    createGuestPortalUser(requestParameters: CreateGuestPortalUserRequest, initOverrides?: RequestInit): Promise<GuestPortalUserCreateDto>;
    /**
     * Get all customers for a portal
     * Get all guest users for portal
     */
    getAllGuestPortalUsersRaw(requestParameters: GetAllGuestPortalUsersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageGuestPortalUsers>>;
    /**
     * Get all customers for a portal
     * Get all guest users for portal
     */
    getAllGuestPortalUsers(requestParameters: GetAllGuestPortalUsersRequest, initOverrides?: RequestInit): Promise<PageGuestPortalUsers>;
    /**
     * Fetch a customer guest portal
     * Get a client email portal
     */
    getGuestPortalRaw(requestParameters: GetGuestPortalRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GuestPortalDto>>;
    /**
     * Fetch a customer guest portal
     * Get a client email portal
     */
    getGuestPortal(requestParameters: GetGuestPortalRequest, initOverrides?: RequestInit): Promise<GuestPortalDto>;
    /**
     * Get customer for portal
     * Get guest user for portal
     */
    getGuestPortalUserRaw(requestParameters: GetGuestPortalUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GuestPortalUserDto>>;
    /**
     * Get customer for portal
     * Get guest user for portal
     */
    getGuestPortalUser(requestParameters: GetGuestPortalUserRequest, initOverrides?: RequestInit): Promise<GuestPortalUserDto>;
    /**
     * Get customer by ID
     * Get guest user
     */
    getGuestPortalUserByIdRaw(requestParameters: GetGuestPortalUserByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GuestPortalUserDto>>;
    /**
     * Get customer by ID
     * Get guest user
     */
    getGuestPortalUserById(requestParameters: GetGuestPortalUserByIdRequest, initOverrides?: RequestInit): Promise<GuestPortalUserDto>;
    /**
     * Get customers for a portal
     * Get all guest users for portal
     */
    getGuestPortalUsersRaw(requestParameters: GetGuestPortalUsersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageGuestPortalUsers>>;
    /**
     * Get customers for a portal
     * Get all guest users for portal
     */
    getGuestPortalUsers(requestParameters: GetGuestPortalUsersRequest, initOverrides?: RequestInit): Promise<PageGuestPortalUsers>;
    /**
     * Get portals
     * Get guest portals
     */
    getGuestPortalsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<GuestPortalDto>>>;
    /**
     * Get portals
     * Get guest portals
     */
    getGuestPortals(initOverrides?: RequestInit): Promise<Array<GuestPortalDto>>;
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetAllGuestPortalUsersSortEnum {
    ASC = "ASC",
    DESC = "DESC"
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetGuestPortalUsersSortEnum {
    ASC = "ASC",
    DESC = "DESC"
}