growsurf-typescript 0.0.2

package/resources/campaign/campaign.d.ts

@@ -0,0 +1,398 @@
+import { APIResource } from "../../core/resource.js";
+import * as CampaignAPI from "./campaign.js";
+import * as CommissionAPI from "./commission.js";
+import { Commission as CommissionAPICommission, CommissionApproveParams, CommissionApproveResponse, CommissionDeleteParams, CommissionDeleteResponse } from "./commission.js";
+import * as ParticipantAPI from "./participant.js";
+import { FraudRiskLevel, Participant, ParticipantAddParams, ParticipantDeleteParams, ParticipantDeleteResponse, ParticipantListCommissionsParams, ParticipantListPayoutsParams, ParticipantListReferralsParams, ParticipantListRewardsParams, ParticipantListRewardsResponse, ParticipantRecordTransactionParams, ParticipantRecordTransactionResponse, ParticipantResource, ParticipantRetrieveParams, ParticipantReward, ParticipantSendInvitesParams, ParticipantSendInvitesResponse, ParticipantTriggerReferralParams, ParticipantTriggerReferralResponse, ParticipantUpdateParams, ReferralSource, ReferralStatus } from "./participant.js";
+import * as RewardAPI from "./reward.js";
+import { Reward as RewardAPIReward, RewardApproveParams, RewardApproveResponse, RewardDeleteParams, RewardDeleteResponse, RewardFulfillParams, RewardFulfillResponse } from "./reward.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class CampaignResource extends APIResource {
+    participant: ParticipantAPI.ParticipantResource;
+    reward: RewardAPI.Reward;
+    commission: CommissionAPI.Commission;
+    /**
+     * Retrieves a program for the given program ID.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.campaign.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Campaign>;
+    /**
+     * Retrieves a list of your programs. Deleted programs are not returned.
+     *
+     * @example
+     * ```ts
+     * const campaigns = await client.campaign.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<CampaignListResponse>;
+    /**
+     * Retrieves a paged list of all participant commissions in an affiliate program.
+     *
+     * @example
+     * ```ts
+     * const participantCommissionList =
+     *   await client.campaign.listCommissions('id');
+     * ```
+     */
+    listCommissions(id: string, query?: CampaignListCommissionsParams | null | undefined, options?: RequestOptions): APIPromise<ParticipantCommissionList>;
+    /**
+     * Retrieves participants in leaderboard order for the specified leaderboard type.
+     *
+     * @example
+     * ```ts
+     * const participantList =
+     *   await client.campaign.listLeaderboard('id');
+     * ```
+     */
+    listLeaderboard(id: string, query?: CampaignListLeaderboardParams | null | undefined, options?: RequestOptions): APIPromise<ParticipantList>;
+    /**
+     * Retrieves a paged list of participants in a program.
+     *
+     * @example
+     * ```ts
+     * const participantList =
+     *   await client.campaign.listParticipants('id');
+     * ```
+     */
+    listParticipants(id: string, query?: CampaignListParticipantsParams | null | undefined, options?: RequestOptions): APIPromise<ParticipantList>;
+    /**
+     * Retrieves a paged list of all participant payouts in an affiliate program.
+     *
+     * @example
+     * ```ts
+     * const participantPayoutList =
+     *   await client.campaign.listPayouts('id');
+     * ```
+     */
+    listPayouts(id: string, query?: CampaignListPayoutsParams | null | undefined, options?: RequestOptions): APIPromise<ParticipantPayoutList>;
+    /**
+     * Retrieves a list of all referrals and email invites made by participants in a
+     * program.
+     *
+     * @example
+     * ```ts
+     * const referralList = await client.campaign.listReferrals(
+     *   'id',
+     * );
+     * ```
+     */
+    listReferrals(id: string, query?: CampaignListReferralsParams | null | undefined, options?: RequestOptions): APIPromise<ReferralList>;
+    /**
+     * Retrieves analytics for a program.
+     *
+     * @example
+     * ```ts
+     * const response = await client.campaign.retrieveAnalytics(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveAnalytics(id: string, query?: CampaignRetrieveAnalyticsParams | null | undefined, options?: RequestOptions): APIPromise<CampaignRetrieveAnalyticsResponse>;
+}
+export interface Campaign {
+    id: string;
+    impressionCount: number;
+    inviteCount: number;
+    name: string;
+    participantCount: number;
+    referralCount: number;
+    rewards: Array<Campaign.Reward>;
+    status: 'DRAFT' | 'IN_PROGRESS' | 'COMPLETE' | 'DELETED';
+    type: 'REFERRAL' | 'AFFILIATE';
+    winnerCount: number;
+    currencyISO?: string;
+}
+export declare namespace Campaign {
+    interface Reward {
+        id: string;
+        isUnlimited: boolean;
+        /**
+         * Shallow custom metadata object.
+         */
+        metadata: {
+            [key: string]: unknown;
+        };
+        type: 'SINGLE_SIDED' | 'DOUBLE_SIDED' | 'MILESTONE' | 'LEADERBOARD' | 'AFFILIATE';
+        commissionStructure?: CampaignAPI.CommissionStructure | null;
+        conversionsRequired?: number | null;
+        couponCode?: string | null;
+        description?: string | null;
+        imageUrl?: string | null;
+        /**
+         * `-1` represents an unlimited reward in REST responses.
+         */
+        limit?: number | null;
+        limitDuration?: 'IN_TOTAL' | 'PER_MONTH' | null;
+        nextMilestonePrefix?: string | null;
+        nextMilestoneSuffix?: string | null;
+        numberOfWinners?: number | null;
+        order?: number | null;
+        referralDescription?: string | null;
+        referredRewardUpfront?: boolean;
+    }
+}
+export interface CommissionStructure {
+    amount?: number | null;
+    approvalRequired?: boolean | null;
+    duration?: string | null;
+    durationInMonths?: number | null;
+    event?: string | null;
+    hasIntro?: boolean | null;
+    hasMaxAmount?: boolean | null;
+    holdDuration?: number | null;
+    introAmount?: number | null;
+    introAmountISO?: string | null;
+    introDuration?: string | null;
+    introDurationInMonths?: number | null;
+    introPercent?: number | null;
+    introType?: string | null;
+    maxAmount?: number | null;
+    maxAmountISO?: string | null;
+    minPaidReferrals?: number | null;
+    percent?: number | null;
+    type?: 'PERCENT' | 'AMOUNT' | null;
+    [k: string]: unknown;
+}
+export interface ParticipantCommissionList {
+    commissions: Array<ParticipantCommissionList.Commission>;
+    limit: number;
+    nextId: string | null;
+}
+export declare namespace ParticipantCommissionList {
+    interface Commission {
+        id: string;
+        amount: number;
+        createdAt: number;
+        currencyISO: string;
+        referredId: string;
+        referrerId: string;
+        saleAmount: number;
+        status: 'PENDING' | 'APPROVED' | 'PAID' | 'REVERSED' | 'DELETED';
+        amountInCampaignCurrency?: number | null;
+        approvedAt?: number;
+        campaignCurrencyISO?: string | null;
+        exchangeRate?: number | null;
+        exchangeRateAt?: number;
+        fxError?: string | null;
+        holdDuration?: number | null;
+        paidAt?: number;
+        payoutQueuedAt?: number;
+        provider?: string | null;
+        reversedAt?: number;
+        saleAmountAmountInCampaignCurrency?: number | null;
+    }
+}
+export interface ParticipantList {
+    limit: number;
+    nextId: string | null;
+    participants: Array<ParticipantAPI.Participant>;
+}
+export interface ParticipantPayoutList {
+    limit: number;
+    nextId: string | null;
+    payouts: Array<ParticipantPayoutList.Payout>;
+}
+export declare namespace ParticipantPayoutList {
+    interface Payout {
+        id: string;
+        amount: number;
+        commissionIds: Array<string>;
+        createdAt: number;
+        currencyISO: string;
+        participantId: string;
+        status: 'UPCOMING' | 'QUEUED' | 'ISSUED' | 'FAILED';
+        amountInCampaignCurrency?: number | null;
+        campaignCurrencyISO?: string | null;
+        exchangeRate?: number | null;
+        exchangeRateAt?: number;
+        failedAt?: number;
+        fxError?: string | null;
+        issuedAt?: number;
+        provider?: string | null;
+    }
+}
+export interface ReferralList {
+    limit: number;
+    more: boolean;
+    referrals: Array<ReferralList.Referral>;
+    nextId?: string | null;
+    nextOffset?: number | null;
+}
+export declare namespace ReferralList {
+    interface Referral {
+        id: string;
+        createdAt: number;
+        email: string;
+        referralStatus: ParticipantAPI.ReferralStatus;
+        referredBy: string;
+        updatedAt: number;
+        firstName?: string | null;
+        lastName?: string | null;
+    }
+}
+export interface CampaignListResponse {
+    campaigns: Array<Campaign>;
+}
+export interface CampaignRetrieveAnalyticsResponse {
+    analytics: CampaignRetrieveAnalyticsResponse.Analytics;
+    endDate: number;
+    startDate: number;
+}
+export declare namespace CampaignRetrieveAnalyticsResponse {
+    interface Analytics {
+        blueskyShares?: number;
+        emailShares?: number;
+        facebookShares?: number;
+        impressions?: number;
+        invites?: number;
+        linkedInShares?: number;
+        messengerShares?: number;
+        participants?: number;
+        pinterestShares?: number;
+        qrcodeShares?: number;
+        redditShares?: number;
+        referralCreditExpireds?: number;
+        referralCreditPendings?: number;
+        referrals?: number;
+        smsShares?: number;
+        telegramShares?: number;
+        threadsShares?: number;
+        /**
+         * Affiliate programs only. Number of commission records.
+         */
+        totalCommissionCount?: number;
+        /**
+         * Affiliate programs only. Commissions in the smallest unit of the program
+         * currency.
+         */
+        totalCommissions?: number;
+        /**
+         * Affiliate programs only. Revenue in the smallest unit of the program currency.
+         */
+        totalRevenue?: number;
+        tumblrShares?: number;
+        twitterShares?: number;
+        uniqueImpressions?: number;
+        wechatShares?: number;
+        whatsAppShares?: number;
+    }
+}
+export interface CampaignListCommissionsParams {
+    /**
+     * Number of results to return. Maximum 100.
+     */
+    limit?: number;
+    /**
+     * ID to start the next paged result set with.
+     */
+    nextId?: string;
+    /**
+     * Participant commission status.
+     */
+    status?: 'PENDING' | 'APPROVED' | 'PAID' | 'REVERSED' | 'DELETED';
+}
+export interface CampaignListLeaderboardParams {
+    /**
+     * Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+     */
+    isMonthly?: boolean;
+    /**
+     * Leaderboard ordering mode.
+     */
+    leaderboardType?: 'ALL_TIME' | 'CURRENT_MONTH' | 'PREV_MONTH' | 'TOTAL_IMPRESSION_COUNT' | 'UNIQUE_IMPRESSION_COUNT' | 'BY_COMMISSIONS' | 'BY_REVENUE' | 'BY_REFERRALS' | 'BY_LEADS';
+    /**
+     * Number of results to return. Maximum 100.
+     */
+    limit?: number;
+    /**
+     * ID to start the next paged result set with.
+     */
+    nextId?: string;
+}
+export interface CampaignListParticipantsParams {
+    /**
+     * Number of results to return. Maximum 100.
+     */
+    limit?: number;
+    /**
+     * ID to start the next paged result set with.
+     */
+    nextId?: string;
+}
+export interface CampaignListPayoutsParams {
+    /**
+     * Number of results to return. Maximum 100.
+     */
+    limit?: number;
+    /**
+     * ID to start the next paged result set with.
+     */
+    nextId?: string;
+    /**
+     * Participant payout status.
+     */
+    status?: 'UPCOMING' | 'QUEUED' | 'ISSUED' | 'FAILED';
+}
+export interface CampaignListReferralsParams {
+    /**
+     * Return results in descending order when true.
+     */
+    desc?: boolean;
+    /**
+     * URL-encoded email value to filter referral results.
+     */
+    email?: string;
+    /**
+     * First name value to filter results.
+     */
+    firstName?: string;
+    /**
+     * Last name value to filter results.
+     */
+    lastName?: string;
+    /**
+     * Number of results to return. Maximum 100.
+     */
+    limit?: number;
+    /**
+     * ID to start the next paged result set with.
+     */
+    nextId?: string;
+    /**
+     * Offset number used to skip through a result set.
+     */
+    offset?: number;
+    referralStatus?: ParticipantAPI.ReferralStatus;
+    /**
+     * Field used to sort referral results.
+     */
+    sortBy?: 'updatedAt' | 'createdAt' | 'email' | 'firstName' | 'lastName' | 'referralStatus' | 'referralTriggeredAt';
+}
+export interface CampaignRetrieveAnalyticsParams {
+    /**
+     * Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+     */
+    days?: number;
+    /**
+     * End date of the analytics timeframe as a Unix timestamp in milliseconds.
+     * Required if `days` is not set.
+     */
+    endDate?: number;
+    /**
+     * Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+     * Required if `days` is not set.
+     */
+    startDate?: number;
+}
+export declare namespace CampaignResource {
+    export { type Campaign as Campaign, type CommissionStructure as CommissionStructure, type ParticipantCommissionList as ParticipantCommissionList, type ParticipantList as ParticipantList, type ParticipantPayoutList as ParticipantPayoutList, type ReferralList as ReferralList, type CampaignListResponse as CampaignListResponse, type CampaignRetrieveAnalyticsResponse as CampaignRetrieveAnalyticsResponse, type CampaignListCommissionsParams as CampaignListCommissionsParams, type CampaignListLeaderboardParams as CampaignListLeaderboardParams, type CampaignListParticipantsParams as CampaignListParticipantsParams, type CampaignListPayoutsParams as CampaignListPayoutsParams, type CampaignListReferralsParams as CampaignListReferralsParams, type CampaignRetrieveAnalyticsParams as CampaignRetrieveAnalyticsParams, };
+    export { ParticipantResource as ParticipantResource, type FraudRiskLevel as FraudRiskLevel, type Participant as Participant, type ParticipantReward as ParticipantReward, type ReferralSource as ReferralSource, type ReferralStatus as ReferralStatus, type ParticipantDeleteResponse as ParticipantDeleteResponse, type ParticipantListRewardsResponse as ParticipantListRewardsResponse, type ParticipantRecordTransactionResponse as ParticipantRecordTransactionResponse, type ParticipantSendInvitesResponse as ParticipantSendInvitesResponse, type ParticipantTriggerReferralResponse as ParticipantTriggerReferralResponse, type ParticipantRetrieveParams as ParticipantRetrieveParams, type ParticipantUpdateParams as ParticipantUpdateParams, type ParticipantDeleteParams as ParticipantDeleteParams, type ParticipantAddParams as ParticipantAddParams, type ParticipantListCommissionsParams as ParticipantListCommissionsParams, type ParticipantListPayoutsParams as ParticipantListPayoutsParams, type ParticipantListReferralsParams as ParticipantListReferralsParams, type ParticipantListRewardsParams as ParticipantListRewardsParams, type ParticipantRecordTransactionParams as ParticipantRecordTransactionParams, type ParticipantSendInvitesParams as ParticipantSendInvitesParams, type ParticipantTriggerReferralParams as ParticipantTriggerReferralParams, };
+    export { RewardAPIReward as Reward, type RewardDeleteResponse as RewardDeleteResponse, type RewardApproveResponse as RewardApproveResponse, type RewardFulfillResponse as RewardFulfillResponse, type RewardDeleteParams as RewardDeleteParams, type RewardApproveParams as RewardApproveParams, type RewardFulfillParams as RewardFulfillParams, };
+    export { CommissionAPICommission as Commission, type CommissionDeleteResponse as CommissionDeleteResponse, type CommissionApproveResponse as CommissionApproveResponse, type CommissionDeleteParams as CommissionDeleteParams, type CommissionApproveParams as CommissionApproveParams, };
+}
+//# sourceMappingURL=campaign.d.ts.map

package/resources/campaign/campaign.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign.d.ts","sourceRoot":"","sources":["../../src/resources/campaign/campaign.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EACL,UAAU,IAAI,uBAAuB,EACrC,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,wBAAwB,EACzB;OACM,KAAK,cAAc;OACnB,EACL,cAAc,EACd,WAAW,EACX,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,EAC9B,4BAA4B,EAC5B,8BAA8B,EAC9B,kCAAkC,EAClC,oCAAoC,EACpC,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,4BAA4B,EAC5B,8BAA8B,EAC9B,gCAAgC,EAChC,kCAAkC,EAClC,uBAAuB,EACvB,cAAc,EACd,cAAc,EACf;OACM,KAAK,SAAS;OACd,EACL,MAAM,IAAI,eAAe,EACzB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACtB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,WAAW,EAAE,cAAc,CAAC,mBAAmB,CAAwD;IACvG,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhE;;;;;;;;OAQG;IACH,eAAe,CACb,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;OAQG;IACH,eAAe,CACb,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;;;;OAQG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;;;;OAQG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX,eAAe,EAAE,MAAM,CAAC;IAExB,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,gBAAgB,EAAE,MAAM,CAAC;IAEzB,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEhC,MAAM,EAAE,OAAO,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;IAEzD,IAAI,EAAE,UAAU,GAAG,WAAW,CAAC;IAE/B,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAErC,IAAI,EAAE,cAAc,GAAG,cAAc,GAAG,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;QAElF,mBAAmB,CAAC,EAAE,WAAW,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAE7D,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,aAAa,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC;QAEhD,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC;IAEnC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,KAAK,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;IAEzD,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,UAAU;QACzB,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,MAAM,CAAC;QAEf,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;QAEjE,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzC,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,kCAAkC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACpD;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,YAAY,EAAE,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,MAAM,CAAC;QAEf,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAEpD,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,OAAO,CAAC;IAEd,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAExC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,CAAC;QAElB,KAAK,EAAE,MAAM,CAAC;QAEd,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC;QAE9C,UAAU,EAAE,MAAM,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,SAAS,EAAE,iCAAiC,CAAC,SAAS,CAAC;IAEvD,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,SAAS;QACxB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAEhC,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAEhC,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CACnE;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EACZ,UAAU,GACV,eAAe,GACf,YAAY,GACZ,wBAAwB,GACxB,yBAAyB,GACzB,gBAAgB,GAChB,YAAY,GACZ,cAAc,GACd,UAAU,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;CACtD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC;IAE/C;;OAEG;IACH,MAAM,CAAC,EACH,WAAW,GACX,WAAW,GACX,OAAO,GACP,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,qBAAqB,CAAC;CAC3B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,mBAAmB,IAAI,mBAAmB,EAC1C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,eAAe,IAAI,MAAM,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,uBAAuB,IAAI,UAAU,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/campaign/campaign.js

@@ -0,0 +1,123 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignResource = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const CommissionAPI = tslib_1.__importStar(require("./commission.js"));
+const commission_1 = require("./commission.js");
+const ParticipantAPI = tslib_1.__importStar(require("./participant.js"));
+const participant_1 = require("./participant.js");
+const RewardAPI = tslib_1.__importStar(require("./reward.js"));
+const reward_1 = require("./reward.js");
+const path_1 = require("../../internal/utils/path.js");
+class CampaignResource extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.participant = new ParticipantAPI.ParticipantResource(this._client);
+        this.reward = new RewardAPI.Reward(this._client);
+        this.commission = new CommissionAPI.Commission(this._client);
+    }
+    /**
+     * Retrieves a program for the given program ID.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.campaign.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}`, options);
+    }
+    /**
+     * Retrieves a list of your programs. Deleted programs are not returned.
+     *
+     * @example
+     * ```ts
+     * const campaigns = await client.campaign.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/campaigns', options);
+    }
+    /**
+     * Retrieves a paged list of all participant commissions in an affiliate program.
+     *
+     * @example
+     * ```ts
+     * const participantCommissionList =
+     *   await client.campaign.listCommissions('id');
+     * ```
+     */
+    listCommissions(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}/commissions`, { query, ...options });
+    }
+    /**
+     * Retrieves participants in leaderboard order for the specified leaderboard type.
+     *
+     * @example
+     * ```ts
+     * const participantList =
+     *   await client.campaign.listLeaderboard('id');
+     * ```
+     */
+    listLeaderboard(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}/leaderboard`, { query, ...options });
+    }
+    /**
+     * Retrieves a paged list of participants in a program.
+     *
+     * @example
+     * ```ts
+     * const participantList =
+     *   await client.campaign.listParticipants('id');
+     * ```
+     */
+    listParticipants(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}/participants`, { query, ...options });
+    }
+    /**
+     * Retrieves a paged list of all participant payouts in an affiliate program.
+     *
+     * @example
+     * ```ts
+     * const participantPayoutList =
+     *   await client.campaign.listPayouts('id');
+     * ```
+     */
+    listPayouts(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}/payouts`, { query, ...options });
+    }
+    /**
+     * Retrieves a list of all referrals and email invites made by participants in a
+     * program.
+     *
+     * @example
+     * ```ts
+     * const referralList = await client.campaign.listReferrals(
+     *   'id',
+     * );
+     * ```
+     */
+    listReferrals(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}/referrals`, { query, ...options });
+    }
+    /**
+     * Retrieves analytics for a program.
+     *
+     * @example
+     * ```ts
+     * const response = await client.campaign.retrieveAnalytics(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveAnalytics(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/campaign/${id}/analytics`, { query, ...options });
+    }
+}
+exports.CampaignResource = CampaignResource;
+CampaignResource.ParticipantResource = participant_1.ParticipantResource;
+CampaignResource.Reward = reward_1.Reward;
+CampaignResource.Commission = commission_1.Commission;
+//# sourceMappingURL=campaign.js.map

package/resources/campaign/campaign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign.js","sourceRoot":"","sources":["../../src/resources/campaign/campaign.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,uEAA8C;AAC9C,gDAMsB;AACtB,yEAAgD;AAChD,kDAuBuB;AACvB,+DAAsC;AACtC,wCAQkB;AAGlB,uDAAiD;AAEjD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,gBAAW,GAAuC,IAAI,cAAc,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvG,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkIpF,CAAC;IAhIC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CACb,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CACb,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CACd,EAAU,EACV,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AArID,4CAqIC;AAqdD,gBAAgB,CAAC,mBAAmB,GAAG,iCAAmB,CAAC;AAC3D,gBAAgB,CAAC,MAAM,GAAG,eAAe,CAAC;AAC1C,gBAAgB,CAAC,UAAU,GAAG,uBAAuB,CAAC"}

package/resources/campaign/campaign.mjs

@@ -0,0 +1,118 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as CommissionAPI from "./commission.mjs";
+import { Commission as CommissionAPICommission, } from "./commission.mjs";
+import * as ParticipantAPI from "./participant.mjs";
+import { ParticipantResource, } from "./participant.mjs";
+import * as RewardAPI from "./reward.mjs";
+import { Reward as RewardAPIReward, } from "./reward.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class CampaignResource extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.participant = new ParticipantAPI.ParticipantResource(this._client);
+        this.reward = new RewardAPI.Reward(this._client);
+        this.commission = new CommissionAPI.Commission(this._client);
+    }
+    /**
+     * Retrieves a program for the given program ID.
+     *
+     * @example
+     * ```ts
+     * const campaign = await client.campaign.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/campaign/${id}`, options);
+    }
+    /**
+     * Retrieves a list of your programs. Deleted programs are not returned.
+     *
+     * @example
+     * ```ts
+     * const campaigns = await client.campaign.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/campaigns', options);
+    }
+    /**
+     * Retrieves a paged list of all participant commissions in an affiliate program.
+     *
+     * @example
+     * ```ts
+     * const participantCommissionList =
+     *   await client.campaign.listCommissions('id');
+     * ```
+     */
+    listCommissions(id, query = {}, options) {
+        return this._client.get(path `/campaign/${id}/commissions`, { query, ...options });
+    }
+    /**
+     * Retrieves participants in leaderboard order for the specified leaderboard type.
+     *
+     * @example
+     * ```ts
+     * const participantList =
+     *   await client.campaign.listLeaderboard('id');
+     * ```
+     */
+    listLeaderboard(id, query = {}, options) {
+        return this._client.get(path `/campaign/${id}/leaderboard`, { query, ...options });
+    }
+    /**
+     * Retrieves a paged list of participants in a program.
+     *
+     * @example
+     * ```ts
+     * const participantList =
+     *   await client.campaign.listParticipants('id');
+     * ```
+     */
+    listParticipants(id, query = {}, options) {
+        return this._client.get(path `/campaign/${id}/participants`, { query, ...options });
+    }
+    /**
+     * Retrieves a paged list of all participant payouts in an affiliate program.
+     *
+     * @example
+     * ```ts
+     * const participantPayoutList =
+     *   await client.campaign.listPayouts('id');
+     * ```
+     */
+    listPayouts(id, query = {}, options) {
+        return this._client.get(path `/campaign/${id}/payouts`, { query, ...options });
+    }
+    /**
+     * Retrieves a list of all referrals and email invites made by participants in a
+     * program.
+     *
+     * @example
+     * ```ts
+     * const referralList = await client.campaign.listReferrals(
+     *   'id',
+     * );
+     * ```
+     */
+    listReferrals(id, query = {}, options) {
+        return this._client.get(path `/campaign/${id}/referrals`, { query, ...options });
+    }
+    /**
+     * Retrieves analytics for a program.
+     *
+     * @example
+     * ```ts
+     * const response = await client.campaign.retrieveAnalytics(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveAnalytics(id, query = {}, options) {
+        return this._client.get(path `/campaign/${id}/analytics`, { query, ...options });
+    }
+}
+CampaignResource.ParticipantResource = ParticipantResource;
+CampaignResource.Reward = RewardAPIReward;
+CampaignResource.Commission = CommissionAPICommission;
+//# sourceMappingURL=campaign.mjs.map

package/resources/campaign/campaign.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign.mjs","sourceRoot":"","sources":["../../src/resources/campaign/campaign.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,aAAa;OAClB,EACL,UAAU,IAAI,uBAAuB,GAKtC;OACM,KAAK,cAAc;OACnB,EAaL,mBAAmB,GAUpB;OACM,KAAK,SAAS;OACd,EACL,MAAM,IAAI,eAAe,GAO1B;OAGM,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,gBAAW,GAAuC,IAAI,cAAc,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvG,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkIpF,CAAC;IAhIC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CACb,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CACb,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CACd,EAAU,EACV,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AAqdD,gBAAgB,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;AAC3D,gBAAgB,CAAC,MAAM,GAAG,eAAe,CAAC;AAC1C,gBAAgB,CAAC,UAAU,GAAG,uBAAuB,CAAC"}