@mojito-inc/core-service/KYC/KYCService.d.ts

Mojito Core API service for auction, payment, token

import { Response } from '../data';
import { QueryOptions } from '../domain';
import { CreateApplicantData, UpdateApplicantData, GetApplicantData, CreateCheckData, GetSDKTokenData } from './KYCData';
import { CreateApplicantParam, CreateCheckParam, GetApplicantParam, GetSDKTokenParam, UpdateApplicantParam } from './KYCParam';
export interface KYCService {
    /**
     * Returns applicant details
     *
     * @remarks
     * This method is part of KYC module, create applicant
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link CreateApplicantData} applicant data
     *
     */
    createApplicant: (param: CreateApplicantParam, options?: QueryOptions) => Promise<Response<CreateApplicantData>>;
    /**
     * Returns applicant details
     *
     * @remarks
     * This method is part of KYC module, update applicant
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link UpdateApplicantData} applicant data
     *
     */
    updateApplicant: (param: UpdateApplicantParam, options?: QueryOptions) => Promise<Response<UpdateApplicantData>>;
    /**
     * Returns applicant details
     *
     * @remarks
     * This method is part of KYC module, fetch applicant details
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link GetApplicantData} applicant data
     *
     */
    getApplicant: (param: GetApplicantParam, options?: QueryOptions) => Promise<Response<GetApplicantData>>;
    /**
     * Returns token details
     *
     * @remarks
     * This method is part of KYC module, fetch SDK token details
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link GetSDKTokenData} token data
     *
     */
    getSDKToken: (param: GetSDKTokenParam, options?: QueryOptions) => Promise<Response<GetSDKTokenData>>;
    /**
     * Returns success response
     *
     * @remarks
     * This method is part of KYC module, create check
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link CreateCheckData} success response
     *
     */
    createCheck: (param: CreateCheckParam, options?: QueryOptions) => Promise<Response<CreateCheckData>>;
}