@lucra/sdk 0.1.0

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,599 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import type { AccountLinksCreateData, AccountLinksCreateErrors, AccountLinksCreateResponses, AccountRetrieveData, AccountRetrieveErrors, AccountRetrieveResponses, AccountUpdateData, AccountUpdateErrors, AccountUpdateResponses, AdAudiencesListData, AdAudiencesListErrors, AdAudiencesListResponses, AdAuthorizationsCreateData, AdAuthorizationsCreateErrors, AdAuthorizationsCreateResponses, AdAuthorizationsListData, AdAuthorizationsListErrors, AdAuthorizationsListResponses, AdAuthorizationsRetrieveData, AdAuthorizationsRetrieveErrors, AdAuthorizationsRetrieveResponses, AdAuthorizationsUpdateData, AdAuthorizationsUpdateErrors, AdAuthorizationsUpdateResponses, AdDefaultsRetrieveData, AdDefaultsRetrieveErrors, AdDefaultsRetrieveResponses, AdDefaultsUpdateData, AdDefaultsUpdateErrors, AdDefaultsUpdateResponses, AdFieldsListData, AdFieldsListErrors, AdFieldsListResponses, AdInterestsListData, AdInterestsListErrors, AdInterestsListResponses, AdsCopiesCreateData, AdsCopiesCreateErrors, AdsCopiesCreateResponses, AdSetsCopiesCreateData, AdSetsCopiesCreateErrors, AdSetsCopiesCreateResponses, AdSetsListData, AdSetsListErrors, AdSetsListResponses, AdSetsRetrieveData, AdSetsRetrieveErrors, AdSetsRetrieveResponses, AdSetsUpdateData, AdSetsUpdateErrors, AdSetsUpdateResponses, AdsListData, AdsListErrors, AdsListResponses, AdsRetrieveData, AdsRetrieveErrors, AdsRetrieveResponses, AdsUpdateData, AdsUpdateErrors, AdsUpdateResponses, AgreementsAcceptancesListData, AgreementsAcceptancesListErrors, AgreementsAcceptancesListResponses, AgreementsCreateData, AgreementsCreateErrors, AgreementsCreateResponses, AgreementsListData, AgreementsListErrors, AgreementsListResponses, AgreementsRetrieveData, AgreementsRetrieveErrors, AgreementsRetrieveResponses, AgreementsUpdateData, AgreementsUpdateErrors, AgreementsUpdateResponses, AgreementsVersionsCreateData, AgreementsVersionsCreateErrors, AgreementsVersionsCreateResponses, AgreementsVersionsListData, AgreementsVersionsListErrors, AgreementsVersionsListResponses, AgreementsVersionsRetrieveData, AgreementsVersionsRetrieveErrors, AgreementsVersionsRetrieveResponses, AnalyticsRetrieveData, AnalyticsRetrieveErrors, AnalyticsRetrieveResponses, ApplicationsCreateData, ApplicationsCreateErrors, ApplicationsCreateResponses, ApplicationsListData, ApplicationsListErrors, ApplicationsListResponses, ApplicationsRetrieveData, ApplicationsRetrieveErrors, ApplicationsRetrieveResponses, ApplicationsUpdateData, ApplicationsUpdateErrors, ApplicationsUpdateResponses, BalanceDepositsCreateData, BalanceDepositsCreateErrors, BalanceDepositsCreateResponses, BalanceDepositsListData, BalanceDepositsListErrors, BalanceDepositsListResponses, BalanceDepositsRetrieveData, BalanceDepositsRetrieveErrors, BalanceDepositsRetrieveResponses, BalanceRefundsCreateData, BalanceRefundsCreateErrors, BalanceRefundsCreateResponses, BalanceRefundsListData, BalanceRefundsListErrors, BalanceRefundsListResponses, BalanceRefundsRetrieveData, BalanceRefundsRetrieveErrors, BalanceRefundsRetrieveResponses, BalanceRetrieveData, BalanceRetrieveErrors, BalanceRetrieveResponses, BalanceTransactionsListData, BalanceTransactionsListErrors, BalanceTransactionsListResponses, BrandsCreateData, BrandsCreateErrors, BrandsCreateResponses, BrandsListData, BrandsListErrors, BrandsListResponses, BrandsRetrieveData, BrandsRetrieveErrors, BrandsRetrieveResponses, BrandsUpdateData, BrandsUpdateErrors, BrandsUpdateResponses, CampaignsCopiesCreateData, CampaignsCopiesCreateErrors, CampaignsCopiesCreateResponses, CampaignsCreateData, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsListData, CampaignsListErrors, CampaignsListResponses, CampaignsRetrieveData, CampaignsRetrieveErrors, CampaignsRetrieveResponses, CampaignsUpdateData, CampaignsUpdateErrors, CampaignsUpdateResponses, ConnectionsListData, ConnectionsListErrors, ConnectionsListResponses, ConnectionsRetrieveData, ConnectionsRetrieveErrors, ConnectionsRetrieveResponses, CreatorsCreateData, CreatorsCreateErrors, CreatorsCreateResponses, CreatorsListData, CreatorsListErrors, CreatorsListResponses, CreatorsRetrieveData, CreatorsRetrieveErrors, CreatorsRetrieveResponses, CreatorsUpdateData, CreatorsUpdateErrors, CreatorsUpdateResponses, EarningsListData, EarningsListErrors, EarningsListResponses, EarningsRetrieveData, EarningsRetrieveErrors, EarningsRetrieveResponses, EmbedsCreateData, EmbedsCreateErrors, EmbedsCreateResponses, EmbedsListData, EmbedsListErrors, EmbedsListResponses, EmbedsRetrieveData, EmbedsRetrieveErrors, EmbedsRetrieveResponses, EmbedsUpdateData, EmbedsUpdateErrors, EmbedsUpdateResponses, FilesCreateData, FilesCreateErrors, FilesCreateResponses, FilesListData, FilesListErrors, FilesListResponses, FilesRetrieveData, FilesRetrieveErrors, FilesRetrieveResponses, FilesUpdateData, FilesUpdateErrors, FilesUpdateResponses, MessagesCreateData, MessagesCreateErrors, MessagesCreateResponses, MessagesListData, MessagesListErrors, MessagesListResponses, PaymentsCreateData, PaymentsCreateErrors, PaymentsCreateResponses, PaymentsListData, PaymentsListErrors, PaymentsListResponses, PaymentsRetrieveData, PaymentsRetrieveErrors, PaymentsRetrieveResponses, PaymentsUpdateData, PaymentsUpdateErrors, PaymentsUpdateResponses, PayoutsListData, PayoutsListErrors, PayoutsListResponses, PayoutsRetrieveData, PayoutsRetrieveErrors, PayoutsRetrieveResponses, PostsListData, PostsListErrors, PostsListResponses, PostsRetrieveData, PostsRetrieveErrors, PostsRetrieveResponses, PostsUpdateData, PostsUpdateErrors, PostsUpdateResponses, ProductsCreateData, ProductsCreateErrors, ProductsCreateResponses, ProductsListData, ProductsListErrors, ProductsListResponses, ProductsRetrieveData, ProductsRetrieveErrors, ProductsRetrieveResponses, ProductsUpdateData, ProductsUpdateErrors, ProductsUpdateResponses, ProgramsCreateData, ProgramsCreateErrors, ProgramsCreateResponses, ProgramsListData, ProgramsListErrors, ProgramsListResponses, ProgramsRetrieveData, ProgramsRetrieveErrors, ProgramsRetrieveResponses, ProgramsUpdateData, ProgramsUpdateErrors, ProgramsUpdateResponses, RetainersCreateData, RetainersCreateErrors, RetainersCreateResponses, RetainersListData, RetainersListErrors, RetainersListResponses, RetainersRetrieveData, RetainersRetrieveErrors, RetainersRetrieveResponses, RetainersUpdateData, RetainersUpdateErrors, RetainersUpdateResponses, SamplesCreateData, SamplesCreateErrors, SamplesCreateResponses, SamplesListData, SamplesListErrors, SamplesListResponses, SamplesRetrieveData, SamplesRetrieveErrors, SamplesRetrieveResponses, SamplesUpdateData, SamplesUpdateErrors, SamplesUpdateResponses, SubmissionsCreateData, SubmissionsCreateErrors, SubmissionsCreateResponses, SubmissionsListData, SubmissionsListErrors, SubmissionsListResponses, SubmissionsRetrieveData, SubmissionsRetrieveErrors, SubmissionsRetrieveResponses, SubmissionsUpdateData, SubmissionsUpdateErrors, SubmissionsUpdateResponses, ThreadsListData, ThreadsListErrors, ThreadsListResponses, ThreadsRetrieveData, ThreadsRetrieveErrors, ThreadsRetrieveResponses, WithdrawalsCreateData, WithdrawalsCreateErrors, WithdrawalsCreateResponses, WithdrawalsListData, WithdrawalsListErrors, WithdrawalsListResponses, WithdrawalsRetrieveData, WithdrawalsRetrieveErrors, WithdrawalsRetrieveResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+declare class HeyApiClient {
+    protected client: Client;
+    constructor(args?: {
+        client?: Client;
+    });
+}
+declare class HeyApiRegistry<T> {
+    private readonly defaultKey;
+    private readonly instances;
+    get(key?: string): T;
+    set(value: T, key?: string): void;
+}
+export declare class Account extends HeyApiClient {
+    /**
+     * Get the key's own account
+     */
+    retrieve<ThrowOnError extends boolean = true>(options?: Options<AccountRetrieveData, ThrowOnError>): RequestResult<AccountRetrieveResponses, AccountRetrieveErrors, ThrowOnError>;
+    /**
+     * Update the key's own account
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<AccountUpdateData, ThrowOnError>): RequestResult<AccountUpdateResponses, AccountUpdateErrors, ThrowOnError>;
+}
+export declare class Analytics extends HeyApiClient {
+    /**
+     * Get daily ad results, or creators' organic results, optionally filtered and split by campaign, submission, creator or platform; as a creator, your own work's ad results across brands
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<AnalyticsRetrieveData, ThrowOnError>): RequestResult<AnalyticsRetrieveResponses, AnalyticsRetrieveErrors, ThrowOnError>;
+}
+export declare class Applications extends HeyApiClient {
+    /**
+     * List applications
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<ApplicationsListData, ThrowOnError>): RequestResult<ApplicationsListResponses, ApplicationsListErrors, ThrowOnError>;
+    /**
+     * Invite a creator to a program, or apply as one
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<ApplicationsCreateData, ThrowOnError>): RequestResult<ApplicationsCreateResponses, ApplicationsCreateErrors, ThrowOnError>;
+    /**
+     * Get an application
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<ApplicationsRetrieveData, ThrowOnError>): RequestResult<ApplicationsRetrieveResponses, ApplicationsRetrieveErrors, ThrowOnError>;
+    /**
+     * Approve, reject or reopen an application, or set the creator's pay; as the creator, withdraw it or accept an invitation (approved)
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<ApplicationsUpdateData, ThrowOnError>): RequestResult<ApplicationsUpdateResponses, ApplicationsUpdateErrors, ThrowOnError>;
+}
+export declare class Transactions extends HeyApiClient {
+    /**
+     * List every ledger line on the account
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<BalanceTransactionsListData, ThrowOnError>): RequestResult<BalanceTransactionsListResponses, BalanceTransactionsListErrors, ThrowOnError>;
+}
+export declare class Deposits extends HeyApiClient {
+    /**
+     * List deposits to the balance
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<BalanceDepositsListData, ThrowOnError>): RequestResult<BalanceDepositsListResponses, BalanceDepositsListErrors, ThrowOnError>;
+    /**
+     * Add funds to the balance
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<BalanceDepositsCreateData, ThrowOnError>): RequestResult<BalanceDepositsCreateResponses, BalanceDepositsCreateErrors, ThrowOnError>;
+    /**
+     * Get a deposit
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<BalanceDepositsRetrieveData, ThrowOnError>): RequestResult<BalanceDepositsRetrieveResponses, BalanceDepositsRetrieveErrors, ThrowOnError>;
+}
+export declare class Refunds extends HeyApiClient {
+    /**
+     * List refunds from the balance
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<BalanceRefundsListData, ThrowOnError>): RequestResult<BalanceRefundsListResponses, BalanceRefundsListErrors, ThrowOnError>;
+    /**
+     * Refund available funds
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<BalanceRefundsCreateData, ThrowOnError>): RequestResult<BalanceRefundsCreateResponses, BalanceRefundsCreateErrors, ThrowOnError>;
+    /**
+     * Get a refund
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<BalanceRefundsRetrieveData, ThrowOnError>): RequestResult<BalanceRefundsRetrieveResponses, BalanceRefundsRetrieveErrors, ThrowOnError>;
+}
+export declare class Balance extends HeyApiClient {
+    /**
+     * Get the balance: the account's funds, or a creator's earnings
+     */
+    retrieve<ThrowOnError extends boolean = true>(options?: Options<BalanceRetrieveData, ThrowOnError>): RequestResult<BalanceRetrieveResponses, BalanceRetrieveErrors, ThrowOnError>;
+    private _transactions?;
+    get transactions(): Transactions;
+    private _deposits?;
+    get deposits(): Deposits;
+    private _refunds?;
+    get refunds(): Refunds;
+}
+export declare class Brands extends HeyApiClient {
+    /**
+     * List the brands this key reaches, and a partner's brands whose relationship ended
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<BrandsListData, ThrowOnError>): RequestResult<BrandsListResponses, BrandsListErrors, ThrowOnError>;
+    /**
+     * Create a brand a partner manages
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<BrandsCreateData, ThrowOnError>): RequestResult<BrandsCreateResponses, BrandsCreateErrors, ThrowOnError>;
+    /**
+     * Get a brand
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<BrandsRetrieveData, ThrowOnError>): RequestResult<BrandsRetrieveResponses, BrandsRetrieveErrors, ThrowOnError>;
+    /**
+     * Update a brand a partner manages
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<BrandsUpdateData, ThrowOnError>): RequestResult<BrandsUpdateResponses, BrandsUpdateErrors, ThrowOnError>;
+}
+export declare class Copies extends HeyApiClient {
+    /**
+     * Copy a campaign with its ad sets and ads, as a new campaign
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<CampaignsCopiesCreateData, ThrowOnError>): RequestResult<CampaignsCopiesCreateResponses, CampaignsCopiesCreateErrors, ThrowOnError>;
+}
+export declare class Campaigns extends HeyApiClient {
+    /**
+     * List campaigns
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<CampaignsListData, ThrowOnError>): RequestResult<CampaignsListResponses, CampaignsListErrors, ThrowOnError>;
+    /**
+     * Create and launch a campaign
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<CampaignsCreateData, ThrowOnError>): RequestResult<CampaignsCreateResponses, CampaignsCreateErrors, ThrowOnError>;
+    /**
+     * Get a campaign
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<CampaignsRetrieveData, ThrowOnError>): RequestResult<CampaignsRetrieveResponses, CampaignsRetrieveErrors, ThrowOnError>;
+    /**
+     * Change a campaign, its ad sets' budgets, or its status: launch, pause, resume, retry or archive
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<CampaignsUpdateData, ThrowOnError>): RequestResult<CampaignsUpdateResponses, CampaignsUpdateErrors, ThrowOnError>;
+    private _copies?;
+    get copies(): Copies;
+}
+export declare class AdFields extends HeyApiClient {
+    /**
+     * List the settings each ad platform takes for campaigns, ad sets and ads
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<AdFieldsListData, ThrowOnError>): RequestResult<AdFieldsListResponses, AdFieldsListErrors, ThrowOnError>;
+}
+export declare class AdDefaults extends HeyApiClient {
+    /**
+     * Get what the account's new campaigns start with
+     */
+    retrieve<ThrowOnError extends boolean = true>(options?: Options<AdDefaultsRetrieveData, ThrowOnError>): RequestResult<AdDefaultsRetrieveResponses, AdDefaultsRetrieveErrors, ThrowOnError>;
+    /**
+     * Change what the account's new campaigns start with
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<AdDefaultsUpdateData, ThrowOnError>): RequestResult<AdDefaultsUpdateResponses, AdDefaultsUpdateErrors, ThrowOnError>;
+}
+export declare class AdAudiences extends HeyApiClient {
+    /**
+     * List an ad account's saved audiences (Meta custom and lookalike audiences, TikTok audiences)
+     */
+    list<ThrowOnError extends boolean = true>(options: Options<AdAudiencesListData, ThrowOnError>): RequestResult<AdAudiencesListResponses, AdAudiencesListErrors, ThrowOnError>;
+}
+export declare class AdInterests extends HeyApiClient {
+    /**
+     * Search the interests an ad set can target on Meta or TikTok
+     */
+    list<ThrowOnError extends boolean = true>(options: Options<AdInterestsListData, ThrowOnError>): RequestResult<AdInterestsListResponses, AdInterestsListErrors, ThrowOnError>;
+}
+export declare class Copies2 extends HeyApiClient {
+    /**
+     * Copy an ad set (and run it paused) in its campaign or another one
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<AdSetsCopiesCreateData, ThrowOnError>): RequestResult<AdSetsCopiesCreateResponses, AdSetsCopiesCreateErrors, ThrowOnError>;
+}
+export declare class AdSets extends HeyApiClient {
+    /**
+     * List ad sets (Meta ad sets, TikTok and Google ad groups, Snapchat ad squads)
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<AdSetsListData, ThrowOnError>): RequestResult<AdSetsListResponses, AdSetsListErrors, ThrowOnError>;
+    /**
+     * Get an ad set
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<AdSetsRetrieveData, ThrowOnError>): RequestResult<AdSetsRetrieveResponses, AdSetsRetrieveErrors, ThrowOnError>;
+    /**
+     * Rename, pause, resume, archive or re-budget an ad set on its platform
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<AdSetsUpdateData, ThrowOnError>): RequestResult<AdSetsUpdateResponses, AdSetsUpdateErrors, ThrowOnError>;
+    private _copies?;
+    get copies(): Copies2;
+}
+export declare class Copies3 extends HeyApiClient {
+    /**
+     * Copy an ad (and run it paused) in its ad set or another one
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<AdsCopiesCreateData, ThrowOnError>): RequestResult<AdsCopiesCreateResponses, AdsCopiesCreateErrors, ThrowOnError>;
+}
+export declare class Ads extends HeyApiClient {
+    /**
+     * List ads
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<AdsListData, ThrowOnError>): RequestResult<AdsListResponses, AdsListErrors, ThrowOnError>;
+    /**
+     * Get an ad
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<AdsRetrieveData, ThrowOnError>): RequestResult<AdsRetrieveResponses, AdsRetrieveErrors, ThrowOnError>;
+    /**
+     * Rename, pause, resume or archive an ad on its platform
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<AdsUpdateData, ThrowOnError>): RequestResult<AdsUpdateResponses, AdsUpdateErrors, ThrowOnError>;
+    private _copies?;
+    get copies(): Copies3;
+}
+export declare class Connections extends HeyApiClient {
+    /**
+     * Get a connection
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<ConnectionsRetrieveData, ThrowOnError>): RequestResult<ConnectionsRetrieveResponses, ConnectionsRetrieveErrors, ThrowOnError>;
+    /**
+     * List connected ad platforms, Shopify and creator social accounts
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<ConnectionsListData, ThrowOnError>): RequestResult<ConnectionsListResponses, ConnectionsListErrors, ThrowOnError>;
+}
+export declare class Creators extends HeyApiClient {
+    /**
+     * List the account's creators and, for a partner, its roster
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<CreatorsListData, ThrowOnError>): RequestResult<CreatorsListResponses, CreatorsListErrors, ThrowOnError>;
+    /**
+     * Add a creator to a partner's roster; one already on it is returned with 200
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<CreatorsCreateData, ThrowOnError>): RequestResult<CreatorsCreateResponses, CreatorsCreateErrors, ThrowOnError>;
+    /**
+     * Get one of the account's creators, or, as a creator, yourself
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<CreatorsRetrieveData, ThrowOnError>): RequestResult<CreatorsRetrieveResponses, CreatorsRetrieveErrors, ThrowOnError>;
+    /**
+     * Update a creator: a brand's labels and status, a partner's roster creator, or, as a creator, your own profile
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<CreatorsUpdateData, ThrowOnError>): RequestResult<CreatorsUpdateResponses, CreatorsUpdateErrors, ThrowOnError>;
+}
+export declare class Files extends HeyApiClient {
+    /**
+     * List files
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<FilesListData, ThrowOnError>): RequestResult<FilesListResponses, FilesListErrors, ThrowOnError>;
+    /**
+     * Upload a file
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<FilesCreateData, ThrowOnError>): RequestResult<FilesCreateResponses, FilesCreateErrors, ThrowOnError>;
+    /**
+     * Get a file
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<FilesRetrieveData, ThrowOnError>): RequestResult<FilesRetrieveResponses, FilesRetrieveErrors, ThrowOnError>;
+    /**
+     * Finish or delete an upload
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<FilesUpdateData, ThrowOnError>): RequestResult<FilesUpdateResponses, FilesUpdateErrors, ThrowOnError>;
+}
+export declare class Messages extends HeyApiClient {
+    /**
+     * List messages
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<MessagesListData, ThrowOnError>): RequestResult<MessagesListResponses, MessagesListErrors, ThrowOnError>;
+    /**
+     * Send a message
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<MessagesCreateData, ThrowOnError>): RequestResult<MessagesCreateResponses, MessagesCreateErrors, ThrowOnError>;
+}
+export declare class Payments extends HeyApiClient {
+    /**
+     * List payments to creators
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<PaymentsListData, ThrowOnError>): RequestResult<PaymentsListResponses, PaymentsListErrors, ThrowOnError>;
+    /**
+     * Pay a creator
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<PaymentsCreateData, ThrowOnError>): RequestResult<PaymentsCreateResponses, PaymentsCreateErrors, ThrowOnError>;
+    /**
+     * Get a payment to a creator
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<PaymentsRetrieveData, ThrowOnError>): RequestResult<PaymentsRetrieveResponses, PaymentsRetrieveErrors, ThrowOnError>;
+    /**
+     * Approve or dispute a payment to a creator
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<PaymentsUpdateData, ThrowOnError>): RequestResult<PaymentsUpdateResponses, PaymentsUpdateErrors, ThrowOnError>;
+}
+export declare class Payouts extends HeyApiClient {
+    /**
+     * List payouts: to creators from this brand's earnings, received by this account, or (as a creator) the creator's own
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<PayoutsListData, ThrowOnError>): RequestResult<PayoutsListResponses, PayoutsListErrors, ThrowOnError>;
+    /**
+     * Get a payout
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<PayoutsRetrieveData, ThrowOnError>): RequestResult<PayoutsRetrieveResponses, PayoutsRetrieveErrors, ThrowOnError>;
+}
+export declare class Earnings extends HeyApiClient {
+    /**
+     * List a creator's earnings
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<EarningsListData, ThrowOnError>): RequestResult<EarningsListResponses, EarningsListErrors, ThrowOnError>;
+    /**
+     * Get one of a creator's earnings
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<EarningsRetrieveData, ThrowOnError>): RequestResult<EarningsRetrieveResponses, EarningsRetrieveErrors, ThrowOnError>;
+}
+export declare class Withdrawals extends HeyApiClient {
+    /**
+     * List withdrawals from the balance
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<WithdrawalsListData, ThrowOnError>): RequestResult<WithdrawalsListResponses, WithdrawalsListErrors, ThrowOnError>;
+    /**
+     * Withdraw from the balance to the bank account or debit card
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<WithdrawalsCreateData, ThrowOnError>): RequestResult<WithdrawalsCreateResponses, WithdrawalsCreateErrors, ThrowOnError>;
+    /**
+     * Get a withdrawal
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<WithdrawalsRetrieveData, ThrowOnError>): RequestResult<WithdrawalsRetrieveResponses, WithdrawalsRetrieveErrors, ThrowOnError>;
+}
+export declare class Acceptances extends HeyApiClient {
+    /**
+     * List creators' acceptances of your agreements; as a creator, the ones you accepted and the ones waiting on you
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<AgreementsAcceptancesListData, ThrowOnError>): RequestResult<AgreementsAcceptancesListResponses, AgreementsAcceptancesListErrors, ThrowOnError>;
+}
+export declare class Versions extends HeyApiClient {
+    /**
+     * List an agreement's versions, newest first
+     */
+    list<ThrowOnError extends boolean = true>(options: Options<AgreementsVersionsListData, ThrowOnError>): RequestResult<AgreementsVersionsListResponses, AgreementsVersionsListErrors, ThrowOnError>;
+    /**
+     * Publish a new version of an agreement
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<AgreementsVersionsCreateData, ThrowOnError>): RequestResult<AgreementsVersionsCreateResponses, AgreementsVersionsCreateErrors, ThrowOnError>;
+    /**
+     * Get a version of an agreement by its number
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<AgreementsVersionsRetrieveData, ThrowOnError>): RequestResult<AgreementsVersionsRetrieveResponses, AgreementsVersionsRetrieveErrors, ThrowOnError>;
+}
+export declare class Agreements extends HeyApiClient {
+    /**
+     * List agreements
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<AgreementsListData, ThrowOnError>): RequestResult<AgreementsListResponses, AgreementsListErrors, ThrowOnError>;
+    /**
+     * Publish an agreement
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<AgreementsCreateData, ThrowOnError>): RequestResult<AgreementsCreateResponses, AgreementsCreateErrors, ThrowOnError>;
+    /**
+     * Get an agreement
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<AgreementsRetrieveData, ThrowOnError>): RequestResult<AgreementsRetrieveResponses, AgreementsRetrieveErrors, ThrowOnError>;
+    /**
+     * Change where an agreement is required, or archive it
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<AgreementsUpdateData, ThrowOnError>): RequestResult<AgreementsUpdateResponses, AgreementsUpdateErrors, ThrowOnError>;
+    private _acceptances?;
+    get acceptances(): Acceptances;
+    private _versions?;
+    get versions(): Versions;
+}
+export declare class Threads extends HeyApiClient {
+    /**
+     * List the conversations the account (or, acting as a creator, the creator) takes part in, most recently active first
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<ThreadsListData, ThrowOnError>): RequestResult<ThreadsListResponses, ThreadsListErrors, ThrowOnError>;
+    /**
+     * Get a conversation; its messages are GET /v1/messages?thread=
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<ThreadsRetrieveData, ThrowOnError>): RequestResult<ThreadsRetrieveResponses, ThreadsRetrieveErrors, ThrowOnError>;
+}
+export declare class Posts extends HeyApiClient {
+    /**
+     * List creators' posts in organic programs
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<PostsListData, ThrowOnError>): RequestResult<PostsListResponses, PostsListErrors, ThrowOnError>;
+    /**
+     * Get a post with its claim evidence
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<PostsRetrieveData, ThrowOnError>): RequestResult<PostsRetrieveResponses, PostsRetrieveErrors, ThrowOnError>;
+    /**
+     * Tag or archive a post
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<PostsUpdateData, ThrowOnError>): RequestResult<PostsUpdateResponses, PostsUpdateErrors, ThrowOnError>;
+}
+export declare class AccountLinks extends HeyApiClient {
+    /**
+     * Open a hosted setup step: payouts on Stripe, the payment method, or a platform sign-in
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<AccountLinksCreateData, ThrowOnError>): RequestResult<AccountLinksCreateResponses, AccountLinksCreateErrors, ThrowOnError>;
+}
+export declare class AdAuthorizations extends HeyApiClient {
+    /**
+     * List ad authorizations: a brand's requests, or, as a creator, the ones asked of you
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<AdAuthorizationsListData, ThrowOnError>): RequestResult<AdAuthorizationsListResponses, AdAuthorizationsListErrors, ThrowOnError>;
+    /**
+     * Ask a submission's creator to authorize it as a TikTok Spark or Meta partnership ad
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<AdAuthorizationsCreateData, ThrowOnError>): RequestResult<AdAuthorizationsCreateResponses, AdAuthorizationsCreateErrors, ThrowOnError>;
+    /**
+     * Get an ad authorization
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<AdAuthorizationsRetrieveData, ThrowOnError>): RequestResult<AdAuthorizationsRetrieveResponses, AdAuthorizationsRetrieveErrors, ThrowOnError>;
+    /**
+     * Grant an ad authorization as its creator, or revoke it
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<AdAuthorizationsUpdateData, ThrowOnError>): RequestResult<AdAuthorizationsUpdateResponses, AdAuthorizationsUpdateErrors, ThrowOnError>;
+}
+export declare class Embeds extends HeyApiClient {
+    /**
+     * List the embeds you opened for a brand or creator
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<EmbedsListData, ThrowOnError>): RequestResult<EmbedsListResponses, EmbedsListErrors, ThrowOnError>;
+    /**
+     * Open Lucra UI for a brand or creator, hosted or embedded
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<EmbedsCreateData, ThrowOnError>): RequestResult<EmbedsCreateResponses, EmbedsCreateErrors, ThrowOnError>;
+    /**
+     * Get an embed
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<EmbedsRetrieveData, ThrowOnError>): RequestResult<EmbedsRetrieveResponses, EmbedsRetrieveErrors, ThrowOnError>;
+    /**
+     * End an embed early
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<EmbedsUpdateData, ThrowOnError>): RequestResult<EmbedsUpdateResponses, EmbedsUpdateErrors, ThrowOnError>;
+}
+export declare class Products extends HeyApiClient {
+    /**
+     * List products; as a creator, the ones attached to the programs you're approved in, which you can ask a sample of
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<ProductsListData, ThrowOnError>): RequestResult<ProductsListResponses, ProductsListErrors, ThrowOnError>;
+    /**
+     * Add a product to the catalog
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<ProductsCreateData, ThrowOnError>): RequestResult<ProductsCreateResponses, ProductsCreateErrors, ThrowOnError>;
+    /**
+     * Get a product
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<ProductsRetrieveData, ThrowOnError>): RequestResult<ProductsRetrieveResponses, ProductsRetrieveErrors, ThrowOnError>;
+    /**
+     * Edit, archive or set the access code of a product
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<ProductsUpdateData, ThrowOnError>): RequestResult<ProductsUpdateResponses, ProductsUpdateErrors, ThrowOnError>;
+}
+export declare class Retainers extends HeyApiClient {
+    /**
+     * List retainers
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<RetainersListData, ThrowOnError>): RequestResult<RetainersListResponses, RetainersListErrors, ThrowOnError>;
+    /**
+     * Offer a creator a retainer
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<RetainersCreateData, ThrowOnError>): RequestResult<RetainersCreateResponses, RetainersCreateErrors, ThrowOnError>;
+    /**
+     * Get a retainer
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<RetainersRetrieveData, ThrowOnError>): RequestResult<RetainersRetrieveResponses, RetainersRetrieveErrors, ThrowOnError>;
+    /**
+     * Cancel a retainer, or, as the creator, accept or reject an offer or cancel
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<RetainersUpdateData, ThrowOnError>): RequestResult<RetainersUpdateResponses, RetainersUpdateErrors, ThrowOnError>;
+}
+export declare class Programs extends HeyApiClient {
+    /**
+     * List programs: your own (archived ones only with status=archived), or with scope=network the open programs on the Lucra Network
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<ProgramsListData, ThrowOnError>): RequestResult<ProgramsListResponses, ProgramsListErrors, ThrowOnError>;
+    /**
+     * Create a program
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<ProgramsCreateData, ThrowOnError>): RequestResult<ProgramsCreateResponses, ProgramsCreateErrors, ThrowOnError>;
+    /**
+     * Get a program
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<ProgramsRetrieveData, ThrowOnError>): RequestResult<ProgramsRetrieveResponses, ProgramsRetrieveErrors, ThrowOnError>;
+    /**
+     * Update a program; every change in one request applies together, or none does
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<ProgramsUpdateData, ThrowOnError>): RequestResult<ProgramsUpdateResponses, ProgramsUpdateErrors, ThrowOnError>;
+}
+export declare class Samples extends HeyApiClient {
+    /**
+     * List samples
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<SamplesListData, ThrowOnError>): RequestResult<SamplesListResponses, SamplesListErrors, ThrowOnError>;
+    /**
+     * Request a sample as a creator, or send one to a creator as the brand
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<SamplesCreateData, ThrowOnError>): RequestResult<SamplesCreateResponses, SamplesCreateErrors, ThrowOnError>;
+    /**
+     * Get a sample; its creator can reveal an access code with expand=accessCode
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<SamplesRetrieveData, ThrowOnError>): RequestResult<SamplesRetrieveResponses, SamplesRetrieveErrors, ThrowOnError>;
+    /**
+     * Approve or reject a sample request
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<SamplesUpdateData, ThrowOnError>): RequestResult<SamplesUpdateResponses, SamplesUpdateErrors, ThrowOnError>;
+}
+export declare class Submissions extends HeyApiClient {
+    /**
+     * List submissions
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<SubmissionsListData, ThrowOnError>): RequestResult<SubmissionsListResponses, SubmissionsListErrors, ThrowOnError>;
+    /**
+     * Submit work as a creator, or add a brand's own video to its library
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<SubmissionsCreateData, ThrowOnError>): RequestResult<SubmissionsCreateResponses, SubmissionsCreateErrors, ThrowOnError>;
+    /**
+     * Get a submission
+     */
+    retrieve<ThrowOnError extends boolean = true>(options: Options<SubmissionsRetrieveData, ThrowOnError>): RequestResult<SubmissionsRetrieveResponses, SubmissionsRetrieveErrors, ThrowOnError>;
+    /**
+     * Review, tag, file or archive a submission, or approve paying for a post; as its creator, withdraw it
+     */
+    update<ThrowOnError extends boolean = true>(options: Options<SubmissionsUpdateData, ThrowOnError>): RequestResult<SubmissionsUpdateResponses, SubmissionsUpdateErrors, ThrowOnError>;
+}
+export declare class LucraApi extends HeyApiClient {
+    static readonly __registry: HeyApiRegistry<LucraApi>;
+    constructor(args?: {
+        client?: Client;
+        key?: string;
+    });
+    private _account?;
+    get account(): Account;
+    private _analytics?;
+    get analytics(): Analytics;
+    private _applications?;
+    get applications(): Applications;
+    private _balance?;
+    get balance(): Balance;
+    private _brands?;
+    get brands(): Brands;
+    private _campaigns?;
+    get campaigns(): Campaigns;
+    private _adFields?;
+    get adFields(): AdFields;
+    private _adDefaults?;
+    get adDefaults(): AdDefaults;
+    private _adAudiences?;
+    get adAudiences(): AdAudiences;
+    private _adInterests?;
+    get adInterests(): AdInterests;
+    private _adSets?;
+    get adSets(): AdSets;
+    private _ads?;
+    get ads(): Ads;
+    private _connections?;
+    get connections(): Connections;
+    private _creators?;
+    get creators(): Creators;
+    private _files?;
+    get files(): Files;
+    private _messages?;
+    get messages(): Messages;
+    private _payments?;
+    get payments(): Payments;
+    private _payouts?;
+    get payouts(): Payouts;
+    private _earnings?;
+    get earnings(): Earnings;
+    private _withdrawals?;
+    get withdrawals(): Withdrawals;
+    private _agreements?;
+    get agreements(): Agreements;
+    private _threads?;
+    get threads(): Threads;
+    private _posts?;
+    get posts(): Posts;
+    private _accountLinks?;
+    get accountLinks(): AccountLinks;
+    private _adAuthorizations?;
+    get adAuthorizations(): AdAuthorizations;
+    private _embeds?;
+    get embeds(): Embeds;
+    private _products?;
+    get products(): Products;
+    private _retainers?;
+    get retainers(): Retainers;
+    private _programs?;
+    get programs(): Programs;
+    private _samples?;
+    get samples(): Samples;
+    private _submissions?;
+    get submissions(): Submissions;
+}
+export {};