@morabr/mora-sdk 1.0.0

package/dist/types/api/api.d.ts

@@ -0,0 +1,925 @@
+export interface AddWithdrawalAccountDto {
+    /** @example {"key":"00000000000"} */
+    accountInfo: object;
+    /**
+     * @default "pix"
+     * @example "pix"
+     */
+    type: WithdrawalAccountTypeEnum;
+}
+export interface AddressDto {
+    city: string;
+    complement?: string | null;
+    number?: string | null;
+    postalCode: string;
+    province: string;
+    state: string;
+    street: string;
+}
+export interface ChargeItemEntityDto {
+    /** @example 99.99 */
+    amount: number;
+    /** @format uuid */
+    chargeId: string;
+    /** @format date-time */
+    createdAt: string;
+    /** @example null */
+    description: string | null;
+    /** @format uuid */
+    id: string;
+    /** @example "Charge of contract #00001" */
+    name: string;
+    /** @format uuid */
+    tenantId: string;
+    /** @format date-time */
+    updatedAt: string;
+}
+export declare enum ChargeStatusEnum {
+    Pending = "pending",
+    Processing = "processing",
+    Paid = "paid"
+}
+export interface CreditCardDto {
+    /** @example 1 */
+    expiryMonth: number;
+    /** @example 1 */
+    expiryYear: number;
+    holderName: string;
+    /** @example 1 */
+    installments?: number;
+    number: string;
+    securityCode: string;
+}
+export interface HttpExceptionDto {
+    /** @example null */
+    data?: object;
+    /** @example "Something went wrong" */
+    errorCode?: string;
+    errors: string[];
+    /** @example "Something went wrong" */
+    message: object;
+    /** @example "/api/foo/bar" */
+    path: string;
+    /** @example 500 */
+    statusCode: number;
+    /** @example "2022-07-25T17:24:07.042Z" */
+    timestamp: string;
+}
+export type Map = object;
+export declare enum OrderByEnum {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface PaginationLinksDto {
+    /** @example "http://example.com?page=1" */
+    first?: string;
+    /** @example "http://example.com?page=3" */
+    last?: string;
+    /** @example "http://example.com?page=2" */
+    next?: string;
+    /** @example "http://example.com?page=1" */
+    prev?: string;
+}
+export interface PaginationMetaDto {
+    /** @example 1 */
+    currentPage: number;
+    /** @example 1 */
+    itemCount: number;
+    /** @example 1 */
+    itemsPerPage: number;
+    /** @example 1 */
+    totalItems?: number;
+    /** @example 1 */
+    totalPages?: number;
+}
+export interface PayChargeDto {
+    creditCard?: CreditCardDto | null;
+    /** @example "pix" */
+    paymentMethod: PaymentMethodEnum;
+}
+export declare enum PaymentMethodEnum {
+    Pix = "pix",
+    CreditCard = "credit_card"
+}
+export interface PublicChargeEntityDto {
+    /** @example 99.99 */
+    amount: number;
+    /** @example "Charge of contract #00001" */
+    description: string;
+    /** @format date-time */
+    dueDate: string;
+    /** @format uuid */
+    id: string;
+    /** @example false */
+    isProtested: boolean;
+    /** @format date-time */
+    paymentDate?: string | null;
+    /** @example "paid" */
+    status: ChargeStatusEnum;
+}
+export interface PublicChargeEntityPaginatedDto {
+    items: PublicChargeEntityDto[];
+    links?: PaginationLinksDto;
+    meta: PaginationMetaDto;
+}
+export interface PublicChargeItemEntityDto {
+    /** @example 99.99 */
+    amount: number;
+    /** @example null */
+    description: string | null;
+    /** @example "Charge of contract #00001" */
+    name: string;
+}
+export interface PublicFullChargeEntityDto {
+    /** @example 99.99 */
+    amount: number;
+    /** @example "Charge of contract #00001" */
+    description: string;
+    /** @format date-time */
+    dueDate: string;
+    /** @format uuid */
+    id: string;
+    /** @example false */
+    isProtested: boolean;
+    items: PublicChargeItemEntityDto[];
+    /** @format date-time */
+    paymentDate?: string | null;
+    /** @example "paid" */
+    status: ChargeStatusEnum;
+    tenant: PublicTenantInfoDto;
+}
+export interface PublicTenantInfoDto {
+    /** @example "Company A" */
+    name: string;
+}
+export interface RequestPasswordResetDto {
+    email: string;
+    /** @format uuid */
+    tenantId: string;
+}
+export interface ResetPasswordDto {
+    /** @example "user@example.com" */
+    email: string;
+    /**
+     * Password should include lowercase, uppercase and digits and have between 8 and 32 digits
+     * @example "P@ssw0rd"
+     */
+    password: string;
+    /** @example "P@ssw0rd" */
+    passwordConfirmation: string;
+    /** @format uuid */
+    tenantId: string;
+    token: string;
+}
+export interface SigninDto {
+    /** @example "user@example.com" */
+    email: string;
+    /** @example "P@ssw0rd" */
+    password: string;
+    /** @format uuid */
+    tenantId: string;
+}
+export interface SigninResponseDto {
+    token: string;
+    user: UserEntityDto;
+}
+export declare enum TenantRoleEnum {
+    Operator = "operator",
+    Admin = "admin",
+    Owner = "owner",
+    Receiver = "receiver"
+}
+export declare enum TenantUserStatusEnum {
+    Enabled = "enabled",
+    Blocked = "blocked"
+}
+export interface UserEntityDto {
+    address: AddressDto;
+    /** @format date-time */
+    birthDate?: string | null;
+    /** @format date-time */
+    createdAt: string;
+    documentNumber: string;
+    email: string;
+    /** @format uuid */
+    id: string;
+    name: string | null;
+    phone: string;
+    roles: TenantRoleEnum[];
+    /** @example "enabled" */
+    status: TenantUserStatusEnum;
+    /** @format uuid */
+    tenantId: string;
+    /** @format date-time */
+    updatedAt: string;
+}
+export interface UserEntityPaginatedDto {
+    items: UserEntityDto[];
+    links?: PaginationLinksDto;
+    meta: PaginationMetaDto;
+}
+export interface WithdrawalAccountEntityDto {
+    /** @example {"key":"00000000000"} */
+    accountInfo?: object;
+    /** @format date-time */
+    createdAt?: string;
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    tenantId: string;
+    /** @example "pix" */
+    type: WithdrawalAccountTypeEnum;
+    /** @format date-time */
+    updatedAt?: string;
+    /** @format uuid */
+    userId: string;
+}
+export interface WithdrawalAccountEntityPaginatedDto {
+    items: WithdrawalAccountEntityDto[];
+    links?: PaginationLinksDto;
+    meta: PaginationMetaDto;
+}
+export declare enum WithdrawalAccountTypeEnum {
+    Pix = "pix"
+}
+export declare namespace Webhooks {
+    /**
+     * @description Receives ASAAS events webhooks to validate and sync states
+     * @tags Integration Webhooks
+     * @name ReceiveAsaasEventWebhook
+     * @request POST:/webhooks/asaas/events
+     * @secure
+     * @response `200` `void`
+     * @response `403` `void` Invalid ASAAS access token
+     */
+    namespace ReceiveAsaasEventWebhook {
+        type RequestParams = {};
+        type RequestQuery = {};
+        type RequestBody = Map;
+        type RequestHeaders = {
+            /** ASAAS webhook configured accessToken */
+            "asaas-access-token": string;
+        };
+        type ResponseBody = void;
+    }
+    /**
+     * @description Receives ASAAS webhooks to validate withdraws on receiver account
+     * @tags Integration Webhooks
+     * @name ReceiveAsaasWithdrawValidationWebhook
+     * @request POST:/webhooks/asaas/withdraw-validation
+     * @secure
+     * @response `200` `void`
+     * @response `403` `void` Invalid ASAAS access token
+     */
+    namespace ReceiveAsaasWithdrawValidationWebhook {
+        type RequestParams = {};
+        type RequestQuery = {};
+        type RequestBody = Map;
+        type RequestHeaders = {
+            /** ASAAS webhook configured accessToken */
+            "asaas-access-token": string;
+        };
+        type ResponseBody = void;
+    }
+}
+export declare namespace Tenants {
+    /**
+     * No description
+     * @tags Users Withdrawal Accounts
+     * @name AddUserWithdrawalAccount
+     * @request POST:/tenants/{tenantId}/users/{userId}/withdrawal-accounts
+     * @secure
+     * @response `201` `WithdrawalAccountEntityDto`
+     * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+     */
+    namespace AddUserWithdrawalAccount {
+        type RequestParams = {
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = AddWithdrawalAccountDto;
+        type RequestHeaders = {};
+        type ResponseBody = WithdrawalAccountEntityDto;
+    }
+    /**
+     * No description
+     * @tags Users Withdrawal Accounts
+     * @name DeleteUserWithdrawalAccount
+     * @request DELETE:/tenants/{tenantId}/users/{userId}/withdrawal-accounts/{accountId}
+     * @secure
+     * @response `204` `void`
+     * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+     */
+    namespace DeleteUserWithdrawalAccount {
+        type RequestParams = {
+            accountId: string;
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = void;
+    }
+    /**
+     * No description
+     * @tags Tenant Users
+     * @name DisableTenantUser
+     * @request PATCH:/tenants/{tenantId}/users/{userId}/disable
+     * @secure
+     * @response `204` `void`
+     * @response `403` `HttpExceptionDto` Need user with one of these roles: owner
+     */
+    namespace DisableTenantUser {
+        type RequestParams = {
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = void;
+    }
+    /**
+     * No description
+     * @tags Tenant Users
+     * @name EnableTenantUser
+     * @request PATCH:/tenants/{tenantId}/users/{userId}/enable
+     * @secure
+     * @response `204` `void`
+     * @response `403` `HttpExceptionDto` Need user with one of these roles: owner
+     */
+    namespace EnableTenantUser {
+        type RequestParams = {
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = void;
+    }
+    /**
+     * No description
+     * @tags Tenant Users
+     * @name GetTenantUser
+     * @request GET:/tenants/{tenantId}/users/{userId}
+     * @secure
+     * @response `200` `UserEntityDto`
+     * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+     */
+    namespace GetTenantUser {
+        type RequestParams = {
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = UserEntityDto;
+    }
+    /**
+     * No description
+     * @tags Users Withdrawal Accounts
+     * @name GetUserWithdrawalAccountById
+     * @request GET:/tenants/{tenantId}/users/{userId}/withdrawal-accounts/{accountId}
+     * @secure
+     * @response `200` `WithdrawalAccountEntityDto`
+     * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+     */
+    namespace GetUserWithdrawalAccountById {
+        type RequestParams = {
+            accountId: string;
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = WithdrawalAccountEntityDto;
+    }
+    /**
+     * No description
+     * @tags Tenant Users
+     * @name ListTenantUsers
+     * @request GET:/tenants/{tenantId}/users
+     * @secure
+     * @response `200` `UserEntityPaginatedDto`
+     * @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
+     */
+    namespace ListTenantUsers {
+        type RequestParams = {
+            tenantId: string;
+        };
+        type RequestQuery = {
+            createdAt?: string;
+            /**
+             * @default 10
+             * @example 10
+             */
+            limit?: number;
+            orderBy?: OrderByEnum;
+            /**
+             * @default 1
+             * @example 1
+             */
+            page?: number;
+            roles?: TenantRoleEnum[];
+            search?: string;
+            sortBy?: string[];
+            status?: TenantUserStatusEnum[];
+        };
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = UserEntityPaginatedDto;
+    }
+    /**
+     * No description
+     * @tags Users Withdrawal Accounts
+     * @name ListUserWithdrawalAccounts
+     * @request GET:/tenants/{tenantId}/users/{userId}/withdrawal-accounts
+     * @secure
+     * @response `200` `WithdrawalAccountEntityPaginatedDto`
+     * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+     */
+    namespace ListUserWithdrawalAccounts {
+        type RequestParams = {
+            tenantId: string;
+            userId: string;
+        };
+        type RequestQuery = {
+            createdAt?: string;
+            /**
+             * @default 10
+             * @example 10
+             */
+            limit?: number;
+            orderBy?: OrderByEnum;
+            /**
+             * @default 1
+             * @example 1
+             */
+            page?: number;
+            search?: string;
+            sortBy?: string[];
+        };
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = WithdrawalAccountEntityPaginatedDto;
+    }
+    /**
+     * No description
+     * @tags Integration Webhooks
+     * @name ReceiveStatusCallback
+     * @request POST:/tenants/{tenantId}/webhooks/twilio/message-status
+     * @secure
+     * @response `200` `void`
+     */
+    namespace ReceiveStatusCallback {
+        type RequestParams = {
+            tenantId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = Map;
+        type RequestHeaders = {};
+        type ResponseBody = void;
+    }
+}
+export declare namespace Public {
+    /**
+     * No description
+     * @tags [Public] Tenant Charges
+     * @name GetPublicChargeById
+     * @request GET:/public/tenants/{tenantId}/charges/{document}/{chargeId}
+     * @secure
+     * @response `200` `PublicFullChargeEntityDto`
+     */
+    namespace GetPublicChargeById {
+        type RequestParams = {
+            chargeId: string;
+            document: string;
+            tenantId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = PublicFullChargeEntityDto;
+    }
+    /**
+     * No description
+     * @tags [Public] Tenant Charges
+     * @name ListPublicChargesByDocument
+     * @request GET:/public/tenants/{tenantId}/charges/{document}
+     * @secure
+     * @response `200` `PublicChargeEntityPaginatedDto`
+     */
+    namespace ListPublicChargesByDocument {
+        type RequestParams = {
+            document: string;
+            tenantId: string;
+        };
+        type RequestQuery = {
+            createdAt?: string;
+            /**
+             * @default 10
+             * @example 10
+             */
+            limit?: number;
+            orderBy?: OrderByEnum;
+            /**
+             * @default 1
+             * @example 1
+             */
+            page?: number;
+            sortBy?: string[];
+        };
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = PublicChargeEntityPaginatedDto;
+    }
+    /**
+     * No description
+     * @tags [Public] Tenant Charges
+     * @name PayCharge
+     * @request POST:/public/tenants/{tenantId}/charges/{document}/{chargeId}/pay
+     * @secure
+     * @response `200` `PublicFullChargeEntityDto`
+     */
+    namespace PayCharge {
+        type RequestParams = {
+            chargeId: string;
+            document: string;
+            tenantId: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = PayChargeDto;
+        type RequestHeaders = {};
+        type ResponseBody = PublicFullChargeEntityDto;
+    }
+}
+export declare namespace Auth {
+    /**
+     * No description
+     * @tags Authentication
+     * @name Logout
+     * @request POST:/auth/logout
+     * @secure
+     * @response `204` `void`
+     */
+    namespace Logout {
+        type RequestParams = {};
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = void;
+    }
+    /**
+     * No description
+     * @tags Authentication
+     * @name RequestPasswordReset
+     * @request POST:/auth/request-password-reset
+     * @secure
+     * @response `204` `void`
+     */
+    namespace RequestPasswordReset {
+        type RequestParams = {};
+        type RequestQuery = {};
+        type RequestBody = RequestPasswordResetDto;
+        type RequestHeaders = {};
+        type ResponseBody = void;
+    }
+    /**
+     * No description
+     * @tags Authentication
+     * @name ResetPassword
+     * @request PATCH:/auth/reset-password
+     * @secure
+     * @response `200` `SigninResponseDto`
+     */
+    namespace ResetPassword {
+        type RequestParams = {};
+        type RequestQuery = {};
+        type RequestBody = ResetPasswordDto;
+        type RequestHeaders = {};
+        type ResponseBody = SigninResponseDto;
+    }
+    /**
+     * No description
+     * @tags Authentication
+     * @name SignIn
+     * @request POST:/auth/signin
+     * @secure
+     * @response `200` `SigninResponseDto`
+     */
+    namespace SignIn {
+        type RequestParams = {};
+        type RequestQuery = {};
+        type RequestBody = SigninDto;
+        type RequestHeaders = {};
+        type ResponseBody = SigninResponseDto;
+    }
+}
+import type { AxiosInstance, AxiosRequestConfig, ResponseType } from "axios";
+export type QueryParamsType = Record<string | number, any>;
+export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+    /** set parameter to `true` for call `securityWorker` for this request */
+    secure?: boolean;
+    /** request path */
+    path: string;
+    /** content type of request body */
+    type?: ContentType;
+    /** query params */
+    query?: QueryParamsType;
+    /** format of response (i.e. response.json() -> format: "json") */
+    format?: ResponseType;
+    /** request body */
+    body?: unknown;
+}
+export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+    secure?: boolean;
+    format?: ResponseType;
+}
+export declare enum ContentType {
+    Json = "application/json",
+    JsonApi = "application/vnd.api+json",
+    FormData = "multipart/form-data",
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
+}
+export declare class HttpClient<SecurityDataType = unknown> {
+    instance: AxiosInstance;
+    private securityData;
+    private securityWorker?;
+    private secure?;
+    private format?;
+    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
+    setSecurityData: (data: SecurityDataType | null) => void;
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
+    protected stringifyFormItem(formItem: unknown): string;
+    protected createFormData(input: Record<string, unknown>): FormData;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
+}
+/**
+ * @title mora-backend
+ * @version 0.0.1
+ * @baseUrl http://localhost:3000
+ * @contact
+ */
+export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * No description
+     *
+     * @tags App
+     * @name Index
+     * @request GET:/
+     * @response `200` `void`
+     */
+    index: (params?: RequestParams) => Promise<void>;
+    webhooks: {
+        /**
+         * @description Receives ASAAS events webhooks to validate and sync states
+         *
+         * @tags Integration Webhooks
+         * @name ReceiveAsaasEventWebhook
+         * @request POST:/webhooks/asaas/events
+         * @secure
+         * @response `200` `void`
+         * @response `403` `void` Invalid ASAAS access token
+         */
+        receiveAsaasEventWebhook: (data: Map, params?: RequestParams) => Promise<void>;
+        /**
+         * @description Receives ASAAS webhooks to validate withdraws on receiver account
+         *
+         * @tags Integration Webhooks
+         * @name ReceiveAsaasWithdrawValidationWebhook
+         * @request POST:/webhooks/asaas/withdraw-validation
+         * @secure
+         * @response `200` `void`
+         * @response `403` `void` Invalid ASAAS access token
+         */
+        receiveAsaasWithdrawValidationWebhook: (data: Map, params?: RequestParams) => Promise<void>;
+    };
+    tenants: {
+        /**
+         * No description
+         *
+         * @tags Users Withdrawal Accounts
+         * @name AddUserWithdrawalAccount
+         * @request POST:/tenants/{tenantId}/users/{userId}/withdrawal-accounts
+         * @secure
+         * @response `201` `WithdrawalAccountEntityDto`
+         * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+         */
+        addUserWithdrawalAccount: (tenantId: string, userId: string, data: AddWithdrawalAccountDto, params?: RequestParams) => Promise<WithdrawalAccountEntityDto>;
+        /**
+         * No description
+         *
+         * @tags Users Withdrawal Accounts
+         * @name DeleteUserWithdrawalAccount
+         * @request DELETE:/tenants/{tenantId}/users/{userId}/withdrawal-accounts/{accountId}
+         * @secure
+         * @response `204` `void`
+         * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+         */
+        deleteUserWithdrawalAccount: (tenantId: string, userId: string, accountId: string, params?: RequestParams) => Promise<void>;
+        /**
+         * No description
+         *
+         * @tags Tenant Users
+         * @name DisableTenantUser
+         * @request PATCH:/tenants/{tenantId}/users/{userId}/disable
+         * @secure
+         * @response `204` `void`
+         * @response `403` `HttpExceptionDto` Need user with one of these roles: owner
+         */
+        disableTenantUser: (tenantId: string, userId: string, params?: RequestParams) => Promise<void>;
+        /**
+         * No description
+         *
+         * @tags Tenant Users
+         * @name EnableTenantUser
+         * @request PATCH:/tenants/{tenantId}/users/{userId}/enable
+         * @secure
+         * @response `204` `void`
+         * @response `403` `HttpExceptionDto` Need user with one of these roles: owner
+         */
+        enableTenantUser: (tenantId: string, userId: string, params?: RequestParams) => Promise<void>;
+        /**
+         * No description
+         *
+         * @tags Tenant Users
+         * @name GetTenantUser
+         * @request GET:/tenants/{tenantId}/users/{userId}
+         * @secure
+         * @response `200` `UserEntityDto`
+         * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+         */
+        getTenantUser: (tenantId: string, userId: string, params?: RequestParams) => Promise<UserEntityDto>;
+        /**
+         * No description
+         *
+         * @tags Users Withdrawal Accounts
+         * @name GetUserWithdrawalAccountById
+         * @request GET:/tenants/{tenantId}/users/{userId}/withdrawal-accounts/{accountId}
+         * @secure
+         * @response `200` `WithdrawalAccountEntityDto`
+         * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+         */
+        getUserWithdrawalAccountById: (tenantId: string, userId: string, accountId: string, params?: RequestParams) => Promise<WithdrawalAccountEntityDto>;
+        /**
+         * No description
+         *
+         * @tags Tenant Users
+         * @name ListTenantUsers
+         * @request GET:/tenants/{tenantId}/users
+         * @secure
+         * @response `200` `UserEntityPaginatedDto`
+         * @response `403` `HttpExceptionDto` Need user with one of these roles: owner, admin, operator
+         */
+        listTenantUsers: (tenantId: string, query?: {
+            createdAt?: string;
+            /**
+             * @default 10
+             * @example 10
+             */
+            limit?: number;
+            orderBy?: OrderByEnum;
+            /**
+             * @default 1
+             * @example 1
+             */
+            page?: number;
+            roles?: TenantRoleEnum[];
+            search?: string;
+            sortBy?: string[];
+            status?: TenantUserStatusEnum[];
+        }, params?: RequestParams) => Promise<UserEntityPaginatedDto>;
+        /**
+         * No description
+         *
+         * @tags Users Withdrawal Accounts
+         * @name ListUserWithdrawalAccounts
+         * @request GET:/tenants/{tenantId}/users/{userId}/withdrawal-accounts
+         * @secure
+         * @response `200` `WithdrawalAccountEntityPaginatedDto`
+         * @response `403` `HttpExceptionDto` You're not enabled to make this operation.
+         */
+        listUserWithdrawalAccounts: (tenantId: string, userId: string, query?: {
+            createdAt?: string;
+            /**
+             * @default 10
+             * @example 10
+             */
+            limit?: number;
+            orderBy?: OrderByEnum;
+            /**
+             * @default 1
+             * @example 1
+             */
+            page?: number;
+            search?: string;
+            sortBy?: string[];
+        }, params?: RequestParams) => Promise<WithdrawalAccountEntityPaginatedDto>;
+        /**
+         * No description
+         *
+         * @tags Integration Webhooks
+         * @name ReceiveStatusCallback
+         * @request POST:/tenants/{tenantId}/webhooks/twilio/message-status
+         * @secure
+         * @response `200` `void`
+         */
+        receiveStatusCallback: (tenantId: string, data: Map, params?: RequestParams) => Promise<void>;
+    };
+    public: {
+        /**
+         * No description
+         *
+         * @tags [Public] Tenant Charges
+         * @name GetPublicChargeById
+         * @request GET:/public/tenants/{tenantId}/charges/{document}/{chargeId}
+         * @secure
+         * @response `200` `PublicFullChargeEntityDto`
+         */
+        getPublicChargeById: (tenantId: string, document: string, chargeId: string, params?: RequestParams) => Promise<PublicFullChargeEntityDto>;
+        /**
+         * No description
+         *
+         * @tags [Public] Tenant Charges
+         * @name ListPublicChargesByDocument
+         * @request GET:/public/tenants/{tenantId}/charges/{document}
+         * @secure
+         * @response `200` `PublicChargeEntityPaginatedDto`
+         */
+        listPublicChargesByDocument: (tenantId: string, document: string, query?: {
+            createdAt?: string;
+            /**
+             * @default 10
+             * @example 10
+             */
+            limit?: number;
+            orderBy?: OrderByEnum;
+            /**
+             * @default 1
+             * @example 1
+             */
+            page?: number;
+            sortBy?: string[];
+        }, params?: RequestParams) => Promise<PublicChargeEntityPaginatedDto>;
+        /**
+         * No description
+         *
+         * @tags [Public] Tenant Charges
+         * @name PayCharge
+         * @request POST:/public/tenants/{tenantId}/charges/{document}/{chargeId}/pay
+         * @secure
+         * @response `200` `PublicFullChargeEntityDto`
+         */
+        payCharge: (tenantId: string, document: string, chargeId: string, data: PayChargeDto, params?: RequestParams) => Promise<PublicFullChargeEntityDto>;
+    };
+    auth: {
+        /**
+         * No description
+         *
+         * @tags Authentication
+         * @name Logout
+         * @request POST:/auth/logout
+         * @secure
+         * @response `204` `void`
+         */
+        logout: (params?: RequestParams) => Promise<void>;
+        /**
+         * No description
+         *
+         * @tags Authentication
+         * @name RequestPasswordReset
+         * @request POST:/auth/request-password-reset
+         * @secure
+         * @response `204` `void`
+         */
+        requestPasswordReset: (data: RequestPasswordResetDto, params?: RequestParams) => Promise<void>;
+        /**
+         * No description
+         *
+         * @tags Authentication
+         * @name ResetPassword
+         * @request PATCH:/auth/reset-password
+         * @secure
+         * @response `200` `SigninResponseDto`
+         */
+        resetPassword: (data: ResetPasswordDto, params?: RequestParams) => Promise<SigninResponseDto>;
+        /**
+         * No description
+         *
+         * @tags Authentication
+         * @name SignIn
+         * @request POST:/auth/signin
+         * @secure
+         * @response `200` `SigninResponseDto`
+         */
+        signIn: (data: SigninDto, params?: RequestParams) => Promise<SigninResponseDto>;
+    };
+}