import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import * as Whop from "../../../index.js"; import { BusinessesClient } from "../resources/businesses/client/Client.js"; export declare namespace PartnersClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } /** * Get started at [whop.com/network](https://whop.com/network). A Partner is a user who refers people and businesses to Whop. The partner profile includes enrollment, active direct business referral counts, and default payout terms. * * Retrieve your profile with `/partners/me`. Use `/partner_referral_requests` to create and manage referral links and their rewards. You can also enroll in the partner program, review referred users and businesses, track earnings, and see the partner leaderboard. */ export declare class PartnersClient { protected readonly _options: NormalizedClientOptionsWithAuth; protected _businesses: BusinessesClient | undefined; constructor(options?: PartnersClient.Options); get businesses(): BusinessesClient; /** * Enrolls the calling user in the Whop partner program, making their partner businesses eligible for earnings. Idempotent — enrolling again keeps the original enrollment time. * * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Whop.UnauthorizedError} * @throws {@link Whop.ForbiddenError} * @throws {@link Whop.ConflictError} * @throws {@link errors.WhopError} * @throws {@link errors.WhopTimeoutError} * * @example * await client.partners.create() */ create(requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise; private __create; /** * Lists, per income stream, the fee a business the caller refers would be charged, how low the caller may price it, and the commission the caller earns on that stream. Answers for a referral that does not exist yet, so a referral flow can price the deal before the business is created. Requires `partner:fees:update`, since the floors a partner may price down to are only for a credential that can set them. * * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Whop.ForbiddenError} * @throws {@link errors.WhopError} * @throws {@link errors.WhopTimeoutError} * * @example * await client.partners.feeOptions() */ feeOptions(requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise; private __feeOptions; /** * Ranks referrers by partner business earnings over the chosen `period`, all-time by default. Authentication is optional: authenticated callers also get their own standing, anonymous callers get the rankings alone. * * @param {Whop.LeaderboardPartnersRequest} request * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Whop.BadRequestError} * @throws {@link errors.WhopError} * @throws {@link errors.WhopTimeoutError} * * @example * await client.partners.leaderboard() */ leaderboard(request?: Whop.LeaderboardPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise; private __leaderboard; /** * Lists the users the caller referred onto Whop, newest first by default, each with the caller's total affiliate earnings from that user across all tiers. * * @param {Whop.ReferredUsersPartnersRequest} request * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Whop.BadRequestError} * @throws {@link Whop.UnauthorizedError} * @throws {@link Whop.ForbiddenError} * @throws {@link Whop.NotFoundError} * @throws {@link errors.WhopError} * @throws {@link errors.WhopTimeoutError} * * @example * await client.partners.referredUsers() */ referredUsers(request?: Whop.ReferredUsersPartnersRequest, requestOptions?: PartnersClient.RequestOptions): Promise>; /** * Retrieves the authenticated user's partner profile: enrollment and verification status, certification completion, active direct business referral count, and default payout rates. Other users' profiles are not accessible. To create and manage referral links, use `/partner_referral_requests`. * * @param {Whop.RetrievePartnersRequest} request * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Whop.UnauthorizedError} * @throws {@link Whop.ForbiddenError} * @throws {@link Whop.NotFoundError} * @throws {@link errors.WhopError} * @throws {@link errors.WhopTimeoutError} * * @example * await client.partners.retrieve({ * id: "me" * }) */ retrieve(request: Whop.RetrievePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise; private __retrieve; }