crunchyroll-js-api/dist/types/services/auth.d.ts

JavaScript API consumer for crunchyroll

declare namespace _default {
    export { getDeviceCode };
    export { getDeviceAuth };
    export { getToken };
    export { getTokenWithPhone };
    export { getTokenWithCode };
    export { getRefreshToken };
    export { revokeRefreshToken };
    export { switchProfile };
}
export default _default;
/**
 * Get device code for easy login
 * @param {Object} obj
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').DeviceCode>}
 */
declare function getDeviceCode(obj: {
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").DeviceCode>;
/**
 * Get access token from device code
 * @param {Object} obj
 * @param {import('../types.js').Device} obj.device Device
 * @param {String} obj.deviceCode login type
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').Token>}
 */
declare function getDeviceAuth({ device, deviceCode, fnConfig }: {
    device: import("../types.js").Device;
    deviceCode: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").Token>;
/**
 * Make out system login
 * @param {Object} obj
 * @param {import('../types.js').Device} obj.device Device
 * @param {String} [obj.scope]
 * @param {String} obj.username user's email
 * @param {String} obj.password user's password
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').Token>}
 */
declare function getToken({ device, scope, username, password, fnConfig }: {
    device: import("../types.js").Device;
    scope?: string;
    username: string;
    password: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").Token>;
/**
 * Make out system login
 * @param {Object} obj
 * @param {import('../types.js').Device} obj.device Device
 * @param {String} [obj.scope]
 * @param {String} obj.phone user's phone
 * @param {String} obj.verification_code
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').Token>}
 */
declare function getTokenWithPhone({ device, scope, phone, verification_code, fnConfig }: {
    device: import("../types.js").Device;
    scope?: string;
    phone: string;
    verification_code: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").Token>;
/**
 * Make out system login
 * @param {Object} obj
 * @param {import('../types.js').Device} obj.device Device
 * @param {String} [obj.scope]
 * @param {String} obj.code
 * @param {String} obj.code_verifier
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').Token>}
 */
declare function getTokenWithCode({ device, scope, code, code_verifier, fnConfig }: {
    device: import("../types.js").Device;
    scope?: string;
    code: string;
    code_verifier: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").Token>;
/**
 * Refresh access token.
 * @param {Object} obj
 * @param {import('../types.js').Device} obj.device Device
 * @param {String} [obj.scope]
 * @param {String} obj.refreshToken refresh token from login
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').Token>}
 */
declare function getRefreshToken({ device, scope, refreshToken, fnConfig }: {
    device: import("../types.js").Device;
    scope?: string;
    refreshToken: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").Token>;
/**
 * revoke access token.
 * @param {Object} obj
 * @param {String} obj.refreshToken
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{status: String}>}
 */
declare function revokeRefreshToken({ refreshToken, fnConfig }: {
    refreshToken: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    status: string;
}>;
/**
 * Switch profile
 * @param {Object} obj
 * @param {import('../types.js').Device} obj.device Device
 * @param {String} [obj.scope]
 * @param {String} obj.refreshToken refresh token from login
 * @param {String} obj.profileId profile id for switch
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').Token>}
 */
declare function switchProfile({ device, scope, refreshToken, profileId, fnConfig }: {
    device: import("../types.js").Device;
    scope?: string;
    refreshToken: string;
    profileId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").Token>;