@deeprelay/sdk 0.4.2 → 0.4.3

package/README.md

@@ -1,4 +1,4 @@
-# @deeprelay/sdk@0.4.2
+# @deeprelay/sdk@0.4.3
 
 A TypeScript SDK client for the api.deeprelay.ai API.
 
@@ -194,7 +194,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `0.4.2`
+- Package version: `0.4.3`
 - Generator version: `7.24.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/BillingApi.d.ts

@@ -134,12 +134,12 @@ export declare class BillingApi extends runtime.BaseAPI {
      */
     getReferralRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferralRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Referral>>;
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferral(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Referral>;

package/dist/apis/BillingApi.js

@@ -341,7 +341,7 @@ class BillingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferralRaw(initOverrides) {
@@ -352,7 +352,7 @@ class BillingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferral(initOverrides) {

package/dist/esm/apis/BillingApi.d.ts

@@ -134,12 +134,12 @@ export declare class BillingApi extends runtime.BaseAPI {
      */
     getReferralRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferralRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Referral>>;
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferral(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Referral>;

package/dist/esm/apis/BillingApi.js

@@ -338,7 +338,7 @@ export class BillingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferralRaw(initOverrides) {
@@ -349,7 +349,7 @@ export class BillingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads.
      * Get the org referral code, invite link, terms and stats
      */
     getReferral(initOverrides) {

package/dist/esm/models/RefereeStatus.d.ts

@@ -17,21 +17,41 @@
  */
 export interface RefereeStatus {
     /**
-     * Lifecycle state. `pending` until the spend gate is met; `qualified` inside the hold; `settled` once paid.
+     * Lifecycle state. `pending` until the gate is met; `qualified` inside the hold; `settled` once paid; `reversed` when the qualifying deposit was refunded after payout and both rewards were taken back.
      * @type {RefereeStatusStatusEnum}
      * @memberof RefereeStatus
      */
     status: RefereeStatusStatusEnum;
     /**
-     * Cumulative inference spend so far.
+     * What qualifies this referral. `deposit` (net real deposits) for current referrals; `spend` (inference usage) for referrals made under the earlier program, which keep their original terms.
+     * @type {RefereeStatusGateEnum}
+     * @memberof RefereeStatus
+     */
+    gate?: RefereeStatusGateEnum;
+    /**
+     * Progress toward the gate so far — net deposits for `deposit`, inference spend for `spend`.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    progressCents?: number;
+    /**
+     * The amount that qualifies the referral.
      * @type {number}
      * @memberof RefereeStatus
      */
+    goalCents?: number;
+    /**
+     * Deprecated alias of `progress_cents`.
+     * @type {number}
+     * @memberof RefereeStatus
+     * @deprecated
+     */
     spentCents: number;
     /**
-     * The spend that qualifies the referral.
+     * Deprecated alias of `goal_cents`.
      * @type {number}
      * @memberof RefereeStatus
+     * @deprecated
      */
     qualifySpendCents: number;
     /**
@@ -41,7 +61,7 @@ export interface RefereeStatus {
      */
     rewardCents: number;
     /**
-     * When the spend gate was met. Absent while pending.
+     * When the gate was met. Absent while pending.
      * @type {Date}
      * @memberof RefereeStatus
      */
@@ -67,8 +87,17 @@ export declare const RefereeStatusStatusEnum: {
     readonly Qualified: "qualified";
     readonly Settled: "settled";
     readonly Rejected: "rejected";
+    readonly Reversed: "reversed";
 };
 export type RefereeStatusStatusEnum = typeof RefereeStatusStatusEnum[keyof typeof RefereeStatusStatusEnum];
+/**
+ * @export
+ */
+export declare const RefereeStatusGateEnum: {
+    readonly Deposit: "deposit";
+    readonly Spend: "spend";
+};
+export type RefereeStatusGateEnum = typeof RefereeStatusGateEnum[keyof typeof RefereeStatusGateEnum];
 /**
  * Check if a given object implements the RefereeStatus interface.
  */

package/dist/esm/models/RefereeStatus.js

@@ -18,7 +18,15 @@ export const RefereeStatusStatusEnum = {
     Pending: 'pending',
     Qualified: 'qualified',
     Settled: 'settled',
-    Rejected: 'rejected'
+    Rejected: 'rejected',
+    Reversed: 'reversed'
+};
+/**
+ * @export
+ */
+export const RefereeStatusGateEnum = {
+    Deposit: 'deposit',
+    Spend: 'spend'
 };
 /**
  * Check if a given object implements the RefereeStatus interface.
@@ -43,6 +51,9 @@ export function RefereeStatusFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'status': json['status'],
+        'gate': json['gate'] == null ? undefined : json['gate'],
+        'progressCents': json['progress_cents'] == null ? undefined : json['progress_cents'],
+        'goalCents': json['goal_cents'] == null ? undefined : json['goal_cents'],
         'spentCents': json['spent_cents'],
         'qualifySpendCents': json['qualify_spend_cents'],
         'rewardCents': json['reward_cents'],
@@ -60,6 +71,9 @@ export function RefereeStatusToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'status': value['status'],
+        'gate': value['gate'],
+        'progress_cents': value['progressCents'],
+        'goal_cents': value['goalCents'],
         'spent_cents': value['spentCents'],
         'qualify_spend_cents': value['qualifySpendCents'],
         'reward_cents': value['rewardCents'],

package/dist/esm/models/Referral.d.ts

@@ -30,13 +30,13 @@ export interface Referral {
      */
     inviteUrl: string;
     /**
-     * Friends who signed up through the link but have not yet reached the spend gate.
+     * Friends who signed up through the link but have not yet reached the qualifying deposit.
      * @type {number}
      * @memberof Referral
      */
     pending: number;
     /**
-     * Friends past the spend gate whose reward is inside the chargeback hold.
+     * Friends past the qualifying deposit whose reward is inside the chargeback hold.
      * @type {number}
      * @memberof Referral
      */
@@ -72,10 +72,17 @@ export interface Referral {
      */
     refereeRewardCents: number;
     /**
-     * The friend's cumulative inference spend that qualifies a referral.
+     * The friend's cumulative net real deposits (card, auto-pay and crypto, less refunds) that qualify a referral.
      * @type {number}
      * @memberof Referral
      */
+    qualifyDepositCents?: number;
+    /**
+     * Deprecated — referrals now qualify on deposits. Mirrors `qualify_deposit_cents`.
+     * @type {number}
+     * @memberof Referral
+     * @deprecated
+     */
     qualifySpendCents: number;
     /**
      * Days between qualification and payout (chargeback hold).

package/dist/esm/models/Referral.js

@@ -59,6 +59,7 @@ export function ReferralFromJSONTyped(json, ignoreDiscriminator) {
         'commissionEarnedCents': json['commission_earned_cents'],
         'rewardCents': json['reward_cents'],
         'refereeRewardCents': json['referee_reward_cents'],
+        'qualifyDepositCents': json['qualify_deposit_cents'] == null ? undefined : json['qualify_deposit_cents'],
         'qualifySpendCents': json['qualify_spend_cents'],
         'holdDays': json['hold_days'],
         'commissionPct': json['commission_pct'],
@@ -82,6 +83,7 @@ export function ReferralToJSONTyped(value, ignoreDiscriminator = false) {
         'commission_earned_cents': value['commissionEarnedCents'],
         'reward_cents': value['rewardCents'],
         'referee_reward_cents': value['refereeRewardCents'],
+        'qualify_deposit_cents': value['qualifyDepositCents'],
         'qualify_spend_cents': value['qualifySpendCents'],
         'hold_days': value['holdDays'],
         'commission_pct': value['commissionPct'],

package/dist/esm/runtime.js

@@ -61,7 +61,7 @@ export class Configuration {
         return undefined;
     }
     get headers() {
-        return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.4.2' }, this.configuration.headers);
+        return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.4.3' }, this.configuration.headers);
     }
     get credentials() {
         return this.configuration.credentials;

package/dist/models/RefereeStatus.d.ts

@@ -17,21 +17,41 @@
  */
 export interface RefereeStatus {
     /**
-     * Lifecycle state. `pending` until the spend gate is met; `qualified` inside the hold; `settled` once paid.
+     * Lifecycle state. `pending` until the gate is met; `qualified` inside the hold; `settled` once paid; `reversed` when the qualifying deposit was refunded after payout and both rewards were taken back.
      * @type {RefereeStatusStatusEnum}
      * @memberof RefereeStatus
      */
     status: RefereeStatusStatusEnum;
     /**
-     * Cumulative inference spend so far.
+     * What qualifies this referral. `deposit` (net real deposits) for current referrals; `spend` (inference usage) for referrals made under the earlier program, which keep their original terms.
+     * @type {RefereeStatusGateEnum}
+     * @memberof RefereeStatus
+     */
+    gate?: RefereeStatusGateEnum;
+    /**
+     * Progress toward the gate so far — net deposits for `deposit`, inference spend for `spend`.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    progressCents?: number;
+    /**
+     * The amount that qualifies the referral.
      * @type {number}
      * @memberof RefereeStatus
      */
+    goalCents?: number;
+    /**
+     * Deprecated alias of `progress_cents`.
+     * @type {number}
+     * @memberof RefereeStatus
+     * @deprecated
+     */
     spentCents: number;
     /**
-     * The spend that qualifies the referral.
+     * Deprecated alias of `goal_cents`.
      * @type {number}
      * @memberof RefereeStatus
+     * @deprecated
      */
     qualifySpendCents: number;
     /**
@@ -41,7 +61,7 @@ export interface RefereeStatus {
      */
     rewardCents: number;
     /**
-     * When the spend gate was met. Absent while pending.
+     * When the gate was met. Absent while pending.
      * @type {Date}
      * @memberof RefereeStatus
      */
@@ -67,8 +87,17 @@ export declare const RefereeStatusStatusEnum: {
     readonly Qualified: "qualified";
     readonly Settled: "settled";
     readonly Rejected: "rejected";
+    readonly Reversed: "reversed";
 };
 export type RefereeStatusStatusEnum = typeof RefereeStatusStatusEnum[keyof typeof RefereeStatusStatusEnum];
+/**
+ * @export
+ */
+export declare const RefereeStatusGateEnum: {
+    readonly Deposit: "deposit";
+    readonly Spend: "spend";
+};
+export type RefereeStatusGateEnum = typeof RefereeStatusGateEnum[keyof typeof RefereeStatusGateEnum];
 /**
  * Check if a given object implements the RefereeStatus interface.
  */

package/dist/models/RefereeStatus.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RefereeStatusStatusEnum = void 0;
+exports.RefereeStatusGateEnum = exports.RefereeStatusStatusEnum = void 0;
 exports.instanceOfRefereeStatus = instanceOfRefereeStatus;
 exports.RefereeStatusFromJSON = RefereeStatusFromJSON;
 exports.RefereeStatusFromJSONTyped = RefereeStatusFromJSONTyped;
@@ -26,7 +26,15 @@ exports.RefereeStatusStatusEnum = {
     Pending: 'pending',
     Qualified: 'qualified',
     Settled: 'settled',
-    Rejected: 'rejected'
+    Rejected: 'rejected',
+    Reversed: 'reversed'
+};
+/**
+ * @export
+ */
+exports.RefereeStatusGateEnum = {
+    Deposit: 'deposit',
+    Spend: 'spend'
 };
 /**
  * Check if a given object implements the RefereeStatus interface.
@@ -51,6 +59,9 @@ function RefereeStatusFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'status': json['status'],
+        'gate': json['gate'] == null ? undefined : json['gate'],
+        'progressCents': json['progress_cents'] == null ? undefined : json['progress_cents'],
+        'goalCents': json['goal_cents'] == null ? undefined : json['goal_cents'],
         'spentCents': json['spent_cents'],
         'qualifySpendCents': json['qualify_spend_cents'],
         'rewardCents': json['reward_cents'],
@@ -68,6 +79,9 @@ function RefereeStatusToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'status': value['status'],
+        'gate': value['gate'],
+        'progress_cents': value['progressCents'],
+        'goal_cents': value['goalCents'],
         'spent_cents': value['spentCents'],
         'qualify_spend_cents': value['qualifySpendCents'],
         'reward_cents': value['rewardCents'],

package/dist/models/Referral.d.ts

@@ -30,13 +30,13 @@ export interface Referral {
      */
     inviteUrl: string;
     /**
-     * Friends who signed up through the link but have not yet reached the spend gate.
+     * Friends who signed up through the link but have not yet reached the qualifying deposit.
      * @type {number}
      * @memberof Referral
      */
     pending: number;
     /**
-     * Friends past the spend gate whose reward is inside the chargeback hold.
+     * Friends past the qualifying deposit whose reward is inside the chargeback hold.
      * @type {number}
      * @memberof Referral
      */
@@ -72,10 +72,17 @@ export interface Referral {
      */
     refereeRewardCents: number;
     /**
-     * The friend's cumulative inference spend that qualifies a referral.
+     * The friend's cumulative net real deposits (card, auto-pay and crypto, less refunds) that qualify a referral.
      * @type {number}
      * @memberof Referral
      */
+    qualifyDepositCents?: number;
+    /**
+     * Deprecated — referrals now qualify on deposits. Mirrors `qualify_deposit_cents`.
+     * @type {number}
+     * @memberof Referral
+     * @deprecated
+     */
     qualifySpendCents: number;
     /**
      * Days between qualification and payout (chargeback hold).

package/dist/models/Referral.js

@@ -66,6 +66,7 @@ function ReferralFromJSONTyped(json, ignoreDiscriminator) {
         'commissionEarnedCents': json['commission_earned_cents'],
         'rewardCents': json['reward_cents'],
         'refereeRewardCents': json['referee_reward_cents'],
+        'qualifyDepositCents': json['qualify_deposit_cents'] == null ? undefined : json['qualify_deposit_cents'],
         'qualifySpendCents': json['qualify_spend_cents'],
         'holdDays': json['hold_days'],
         'commissionPct': json['commission_pct'],
@@ -89,6 +90,7 @@ function ReferralToJSONTyped(value, ignoreDiscriminator = false) {
         'commission_earned_cents': value['commissionEarnedCents'],
         'reward_cents': value['rewardCents'],
         'referee_reward_cents': value['refereeRewardCents'],
+        'qualify_deposit_cents': value['qualifyDepositCents'],
         'qualify_spend_cents': value['qualifySpendCents'],
         'hold_days': value['holdDays'],
         'commission_pct': value['commissionPct'],

package/dist/runtime.js

@@ -69,7 +69,7 @@ class Configuration {
         return undefined;
     }
     get headers() {
-        return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.4.2' }, this.configuration.headers);
+        return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.4.3' }, this.configuration.headers);
     }
     get credentials() {
         return this.configuration.credentials;

package/docs/BillingApi.md

@@ -460,7 +460,7 @@ example().catch(console.error);
 
 Get the org referral code, invite link, terms and stats
 
-Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
+Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
 
 ### Example
 

package/docs/RefereeStatus.md

@@ -8,6 +8,9 @@ Present only when the organization signed up through someone else\'s invite link
 Name | Type
 ------------ | -------------
 `status` | string
+`gate` | string
+`progressCents` | number
+`goalCents` | number
 `spentCents` | number
 `qualifySpendCents` | number
 `rewardCents` | number
@@ -23,6 +26,9 @@ import type { RefereeStatus } from '@deeprelay/sdk'
 // TODO: Update the object below with actual values
 const example = {
   "status": null,
+  "gate": null,
+  "progressCents": null,
+  "goalCents": null,
   "spentCents": null,
   "qualifySpendCents": null,
   "rewardCents": null,

package/docs/Referral.md

@@ -16,6 +16,7 @@ Name | Type
 `commissionEarnedCents` | number
 `rewardCents` | number
 `refereeRewardCents` | number
+`qualifyDepositCents` | number
 `qualifySpendCents` | number
 `holdDays` | number
 `commissionPct` | number
@@ -37,6 +38,7 @@ const example = {
   "commissionEarnedCents": null,
   "rewardCents": null,
   "refereeRewardCents": null,
+  "qualifyDepositCents": null,
   "qualifySpendCents": null,
   "holdDays": null,
   "commissionPct": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deeprelay/sdk",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "TypeScript SDK for the deeprelay Public Developer API",
   "author": "deeprelay Support <support@deeprelay.ai>",
   "repository": {

package/src/apis/BillingApi.ts

@@ -446,7 +446,7 @@ export class BillingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
      * Get the org referral code, invite link, terms and stats
      */
     async getReferralRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Referral>> {
@@ -457,7 +457,7 @@ export class BillingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; once a friend who signed up through it has made `qualify_deposit_cents` of net real deposits (card, auto-pay or crypto, less refunds), the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. Both rewards are reversed if the qualifying deposit is later refunded. The deposit commission is retired and `commission_pct` is 0; when it is non-zero the referrer also earns that percent of every real deposit the friend makes. `commission_earned_cents` still reports commission earned before retirement. Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
      * Get the org referral code, invite link, terms and stats
      */
     async getReferral(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Referral> {

package/src/models/RefereeStatus.ts

@@ -21,21 +21,41 @@ import { mapValues } from '../runtime';
  */
 export interface RefereeStatus {
     /**
-     * Lifecycle state. `pending` until the spend gate is met; `qualified` inside the hold; `settled` once paid.
+     * Lifecycle state. `pending` until the gate is met; `qualified` inside the hold; `settled` once paid; `reversed` when the qualifying deposit was refunded after payout and both rewards were taken back.
      * @type {RefereeStatusStatusEnum}
      * @memberof RefereeStatus
      */
     status: RefereeStatusStatusEnum;
     /**
-     * Cumulative inference spend so far.
+     * What qualifies this referral. `deposit` (net real deposits) for current referrals; `spend` (inference usage) for referrals made under the earlier program, which keep their original terms.
+     * @type {RefereeStatusGateEnum}
+     * @memberof RefereeStatus
+     */
+    gate?: RefereeStatusGateEnum;
+    /**
+     * Progress toward the gate so far — net deposits for `deposit`, inference spend for `spend`.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    progressCents?: number;
+    /**
+     * The amount that qualifies the referral.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    goalCents?: number;
+    /**
+     * Deprecated alias of `progress_cents`.
      * @type {number}
      * @memberof RefereeStatus
+     * @deprecated
      */
     spentCents: number;
     /**
-     * The spend that qualifies the referral.
+     * Deprecated alias of `goal_cents`.
      * @type {number}
      * @memberof RefereeStatus
+     * @deprecated
      */
     qualifySpendCents: number;
     /**
@@ -45,7 +65,7 @@ export interface RefereeStatus {
      */
     rewardCents: number;
     /**
-     * When the spend gate was met. Absent while pending.
+     * When the gate was met. Absent while pending.
      * @type {Date}
      * @memberof RefereeStatus
      */
@@ -72,10 +92,20 @@ export const RefereeStatusStatusEnum = {
     Pending: 'pending',
     Qualified: 'qualified',
     Settled: 'settled',
-    Rejected: 'rejected'
+    Rejected: 'rejected',
+    Reversed: 'reversed'
 } as const;
 export type RefereeStatusStatusEnum = typeof RefereeStatusStatusEnum[keyof typeof RefereeStatusStatusEnum];
 
+/**
+ * @export
+ */
+export const RefereeStatusGateEnum = {
+    Deposit: 'deposit',
+    Spend: 'spend'
+} as const;
+export type RefereeStatusGateEnum = typeof RefereeStatusGateEnum[keyof typeof RefereeStatusGateEnum];
+
 
 /**
  * Check if a given object implements the RefereeStatus interface.
@@ -99,6 +129,9 @@ export function RefereeStatusFromJSONTyped(json: any, ignoreDiscriminator: boole
     return {
         
         'status': json['status'],
+        'gate': json['gate'] == null ? undefined : json['gate'],
+        'progressCents': json['progress_cents'] == null ? undefined : json['progress_cents'],
+        'goalCents': json['goal_cents'] == null ? undefined : json['goal_cents'],
         'spentCents': json['spent_cents'],
         'qualifySpendCents': json['qualify_spend_cents'],
         'rewardCents': json['reward_cents'],
@@ -120,6 +153,9 @@ export function RefereeStatusToJSONTyped(value?: RefereeStatus | null, ignoreDis
     return {
         
         'status': value['status'],
+        'gate': value['gate'],
+        'progress_cents': value['progressCents'],
+        'goal_cents': value['goalCents'],
         'spent_cents': value['spentCents'],
         'qualify_spend_cents': value['qualifySpendCents'],
         'reward_cents': value['rewardCents'],

package/src/models/Referral.ts

@@ -41,13 +41,13 @@ export interface Referral {
      */
     inviteUrl: string;
     /**
-     * Friends who signed up through the link but have not yet reached the spend gate.
+     * Friends who signed up through the link but have not yet reached the qualifying deposit.
      * @type {number}
      * @memberof Referral
      */
     pending: number;
     /**
-     * Friends past the spend gate whose reward is inside the chargeback hold.
+     * Friends past the qualifying deposit whose reward is inside the chargeback hold.
      * @type {number}
      * @memberof Referral
      */
@@ -83,10 +83,17 @@ export interface Referral {
      */
     refereeRewardCents: number;
     /**
-     * The friend's cumulative inference spend that qualifies a referral.
+     * The friend's cumulative net real deposits (card, auto-pay and crypto, less refunds) that qualify a referral.
      * @type {number}
      * @memberof Referral
      */
+    qualifyDepositCents?: number;
+    /**
+     * Deprecated — referrals now qualify on deposits. Mirrors `qualify_deposit_cents`.
+     * @type {number}
+     * @memberof Referral
+     * @deprecated
+     */
     qualifySpendCents: number;
     /**
      * Days between qualification and payout (chargeback hold).
@@ -146,6 +153,7 @@ export function ReferralFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'commissionEarnedCents': json['commission_earned_cents'],
         'rewardCents': json['reward_cents'],
         'refereeRewardCents': json['referee_reward_cents'],
+        'qualifyDepositCents': json['qualify_deposit_cents'] == null ? undefined : json['qualify_deposit_cents'],
         'qualifySpendCents': json['qualify_spend_cents'],
         'holdDays': json['hold_days'],
         'commissionPct': json['commission_pct'],
@@ -173,6 +181,7 @@ export function ReferralToJSONTyped(value?: Referral | null, ignoreDiscriminator
         'commission_earned_cents': value['commissionEarnedCents'],
         'reward_cents': value['rewardCents'],
         'referee_reward_cents': value['refereeRewardCents'],
+        'qualify_deposit_cents': value['qualifyDepositCents'],
         'qualify_spend_cents': value['qualifySpendCents'],
         'hold_days': value['holdDays'],
         'commission_pct': value['commissionPct'],

package/src/runtime.ts

@@ -75,7 +75,7 @@ export class Configuration {
     }
 
     get headers(): HTTPHeaders | undefined {
-        return { 'User-Agent': 'deeprelay-sdk-ts/0.4.2', ...this.configuration.headers };
+        return { 'User-Agent': 'deeprelay-sdk-ts/0.4.3', ...this.configuration.headers };
     }
 
     get credentials(): RequestCredentials | undefined {