@opexa/portal-sdk 0.0.72 → 0.0.73

package/dist/sdk/sdk.d.ts

@@ -28,170 +28,21 @@ export declare class Sdk {
      * @deprecated use `sendVerificationCode__next`
      */
     sendAuthenticationCode(mobileNumber: string): Promise<SendAuthenticationCodeReturn>;
-    /**
-     * @example
-     * ```ts
-     * const signInResult = await signIn({
-     * 	type: 'NAME_AND_PASSWORD',
-     * 	name: data.name,
-     * 	password: data.password,
-     * });
-     *
-     * if (!signInResult.ok) {
-     * 	return window.alert(signInResult.error.message);
-     * }
-     *
-     * if (!signInResult.data) {
-     * 	// Signed in. No more steps needed
-     * 	return;
-     * }
-     *
-     * const secretAnswer = window.prompt(SECRET_QUESTIONS_MAP[signInResult.secretQuestion]);
-     *
-     * const authResult = await sdk.authenticate({
-     * 	type: 'SECURITY_QUESTION',
-     * 	token: signInResult.token,
-     * 	secretAnswer: secretAnswer,
-     * });
-     *
-     * if (!authResult.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Signed in
-     * }
-     * ```
-     */
     authenticate(input: AuthenticateInput): Promise<AuthenticateReturn>;
     signOut(): Promise<void>;
-    /**
-     * @description Watches the session if it is still valid whenever signed in.
-     * @returns Unsubscribe function
-     * @example
-     * ```tsx
-     * import * as React from 'react';
-     * import { useAuthenticated } from '@lib/stores';
-     *
-     * function WatchSession() {
-     * 	const { setAuthenticated } = useAuthenticated();
-     *
-     * 	React.useEffect(() => {
-     * 		const unsubscribe = sdk.watchSession({
-     * 			interval: 30000,
-     * 			onInvalid() {
-     * 				setAuthenticated(false);
-     * 			},
-     * 		});
-     *
-     * 		return unsubscribe;
-     * 	}, []);
-     * }
-     * ```
-     */
     watchSession(input: WatchSessionInput): () => void;
     session(): Promise<SessionReturn>;
     validateMayaSession(): Promise<ValidateMayaSessionReturn>;
     site(): Promise<SiteReturn>;
     platform(): Promise<PlatformReturn>;
     account(): Promise<AccountReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.createAccount({
-     * 	id: ObjectId.generate(ObjectType.Account).toString(),
-     * 	name: data.name,
-     * 	password: data.password,
-     * 	dateOfBirth: new Date(data.dateOfBirth),
-     * 	mobileNumber: data.mobileNumber,
-     * 	domain: data.domain,
-     * 	verificationCode: data.verificationCode,
-     * 	reCAPTCHAResponse: data.reCAPTCHAResponse,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     createAccount(input: CreateAccountInput): Promise<CreateAccountReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.createAccount({
-     * 	id: ObjectId.generate(ObjectType.Account).toString(),
-     * 	name: data.name,
-     * 	password: data.password,
-     * 	dateOfBirth: new Date(data.dateOfBirth),
-     * 	mobileNumber: data.mobileNumber,
-     * 	domain: data.domain,
-     * 	reCAPTCHAResponse: data.reCAPTCHAResponse,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     createAccount__next(input: CreateAccountInput__Next): Promise<CreateAccountReturn>;
     registerMayaAccount(input: RegisterMayaAccountInput): Promise<RegisterMayaAccountReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.updateAccount(user.id, {
-     * 	validId: data.validId,
-     * 	realName: data.realName,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     updateAccount(id: string, input: UpdateAccountInput): Promise<UpdateAccountReturn>;
     deleteAccount(id: string): Promise<DeleteAccountReturn>;
     verificationDetails(): Promise<VerificationDetailsReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.submitVerificationDetails({
-     * 	id: ObjectId.generate(ObjectType.Verification).toString(),
-     * 	idFrontImage: data.idFrontImage,
-     * 	selfieImage: data.selfieImage,
-     * 	address: data.address,
-     * 	sourceOfIncome: data.sourceOfIncome,
-     * 	natureOfWork: data.natureOfWork,
-     * 	placeOfBirth: data.placeOfBirth,
-     * 	nationality: data.nationality,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     submitVerificationDetails(input: SubmitVerificationDetailsInput): Promise<SubmitVerificationDetailsReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.submitVerificationDetails(verificationDetails.id, {
-     * 	idFrontImage: data.idFrontImage,
-     * 	selfieImage: data.selfieImage,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     updateVerificationDetails(id: string, input: UpdateVerificationDetailsInput): Promise<UpdateVerificationDetailsReturn>;
     resetPassword(input: ResetPasswordInput): Promise<ResetPasswordReturn>;
     verifyMobileNumber(verificationCode: string): Promise<VerifyMobileNumberReturn>;
@@ -200,43 +51,9 @@ export declare class Sdk {
     sendVerificationCode__next(mobileNumber: string): Promise<SendVerificationCodeReturn__Next>;
     wallet(): Promise<WalletReturn>;
     announcements(input?: AnnouncementsInput): Promise<AnnouncementsReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.createWithdrawal({
-     * 	id: ObjectId.generate(ObjectType.Withdrawal).toString(),
-     * 	type: 'BANK',
-     * 	amount: data.amount,
-     * 	transactionPassword: data.transactionPassword,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     createWithdrawal(input: CreateWithdrawalInput): Promise<CreateWithdrawalReturn>;
     withdrawalRecords(input?: WithdrawalRecordsInput): Promise<WithdrawalRecordsReturn>;
     remainingDailyWithdrawalsCount(): Promise<RemainingDailyWithdrawalsCountReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.createDeposit({
-     * 	id: ObjectId.generate(ObjectType.Deposit).toString(),
-     * 	type: 'GCASH',
-     * 	amount: data.amount,
-     * 	promo: data.promo,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     createDeposit(input: CreateDepositInput): Promise<CreateDepositReturn>;
     deposit(id: string): Promise<DepositReturn>;
     depositRecords(input?: DepositRecordsInput): Promise<DepositRecordsReturn>;
@@ -275,22 +92,6 @@ export declare class Sdk {
     /** @deprecated use `gameSession__next` */
     gameSession__legacy(id: string): Promise<GameSessionReturn>;
     gameSession__next(id: string): Promise<GameSessionReturn>;
-    /**
-     * @deprecated use `createGameSession__next`
-     * @example
-     * ```ts
-     * const res = await sdk.createGameSession({
-     * 	id: ObjectId.generate(ObjectType.GameSession).toString(),
-     * 	game: game.id,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     createGameSession(input: CreateGameSessionInput): Promise<CreateGameSessionReturn>;
     /** @deprecated use `createGameSession__next` */
     createGameSession__legacy(input: CreateGameSessionInput): Promise<CreateGameSessionReturn>;
@@ -301,21 +102,6 @@ export declare class Sdk {
     endGameSession__legacy(id: string): Promise<EndGameSessionReturn__Legacy>;
     endGameSession__next(id: string): Promise<EndGameSessionReturn__Legacy>;
     file(id: string): Promise<FileReturn>;
-    /**
-     * @example
-     * ```ts
-     * const res = await sdk.uploadImageFile({
-     * 	id: ObjectId.generate(ObjectType.File).toString(),
-     * 	file: data.file,
-     * });
-     *
-     * if (!res.ok) {
-     * 	window.alert(res.error.message);
-     * } else {
-     * 	// Do something
-     * }
-     * ```
-     */
     uploadImageFile(input: UploadImageFileInput): Promise<UploadImageFileReturn>;
     pointsWallet(): Promise<PointsWalletReturn>;
     pointsToCashConversion(amount: number): Promise<PointsToCashConversionReturn>;