@deeprelay/sdk 0.1.1 → 0.1.2

package/src/models/RefereeStatus.ts

@@ -0,0 +1,131 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Present only when the organization signed up through someone else's invite link: where that referral sits and how far the organization is from unlocking its own reward.
+ * 
+ * @export
+ * @interface RefereeStatus
+ */
+export interface RefereeStatus {
+    /**
+     * Lifecycle state. `pending` until the spend gate is met; `qualified` inside the hold; `settled` once paid.
+     * @type {RefereeStatusStatusEnum}
+     * @memberof RefereeStatus
+     */
+    status: RefereeStatusStatusEnum;
+    /**
+     * Cumulative inference spend so far.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    spentCents: number;
+    /**
+     * The spend that qualifies the referral.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    qualifySpendCents: number;
+    /**
+     * What this organization receives on settlement.
+     * @type {number}
+     * @memberof RefereeStatus
+     */
+    rewardCents: number;
+    /**
+     * When the spend gate was met. Absent while pending.
+     * @type {Date}
+     * @memberof RefereeStatus
+     */
+    qualifiedAt?: Date;
+    /**
+     * When the hold ends and both halves pay out. Absent while pending.
+     * @type {Date}
+     * @memberof RefereeStatus
+     */
+    holdUntil?: Date;
+    /**
+     * When the reward was paid. Absent until settled.
+     * @type {Date}
+     * @memberof RefereeStatus
+     */
+    settledAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const RefereeStatusStatusEnum = {
+    Pending: 'pending',
+    Qualified: 'qualified',
+    Settled: 'settled',
+    Rejected: 'rejected'
+} as const;
+export type RefereeStatusStatusEnum = typeof RefereeStatusStatusEnum[keyof typeof RefereeStatusStatusEnum];
+
+
+/**
+ * Check if a given object implements the RefereeStatus interface.
+ */
+export function instanceOfRefereeStatus(value: object): value is RefereeStatus {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if ((!('spentCents' in (value as Record<string, any>)) && !('spent_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['spentCents'] === undefined && (value as Record<string, any>)['spent_cents'] === undefined)) return false;
+    if ((!('qualifySpendCents' in (value as Record<string, any>)) && !('qualify_spend_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['qualifySpendCents'] === undefined && (value as Record<string, any>)['qualify_spend_cents'] === undefined)) return false;
+    if ((!('rewardCents' in (value as Record<string, any>)) && !('reward_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['rewardCents'] === undefined && (value as Record<string, any>)['reward_cents'] === undefined)) return false;
+    return true;
+}
+
+export function RefereeStatusFromJSON(json: any): RefereeStatus {
+    return RefereeStatusFromJSONTyped(json, false);
+}
+
+export function RefereeStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefereeStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'spentCents': json['spent_cents'],
+        'qualifySpendCents': json['qualify_spend_cents'],
+        'rewardCents': json['reward_cents'],
+        'qualifiedAt': json['qualified_at'] == null ? undefined : (new Date(json['qualified_at'])),
+        'holdUntil': json['hold_until'] == null ? undefined : (new Date(json['hold_until'])),
+        'settledAt': json['settled_at'] == null ? undefined : (new Date(json['settled_at'])),
+    };
+}
+
+export function RefereeStatusToJSON(json: any): RefereeStatus {
+    return RefereeStatusToJSONTyped(json, false);
+}
+
+export function RefereeStatusToJSONTyped(value?: RefereeStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'spent_cents': value['spentCents'],
+        'qualify_spend_cents': value['qualifySpendCents'],
+        'reward_cents': value['rewardCents'],
+        'qualified_at': value['qualifiedAt'] == null ? value['qualifiedAt'] : value['qualifiedAt'].toISOString(),
+        'hold_until': value['holdUntil'] == null ? value['holdUntil'] : value['holdUntil'].toISOString(),
+        'settled_at': value['settledAt'] == null ? value['settledAt'] : value['settledAt'].toISOString(),
+    };
+}
+

package/src/models/Referral.ts

@@ -0,0 +1,164 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { RefereeStatus } from './RefereeStatus';
+import {
+    RefereeStatusFromJSON,
+    RefereeStatusFromJSONTyped,
+    RefereeStatusToJSON,
+    RefereeStatusToJSONTyped,
+} from './RefereeStatus';
+
+/**
+ * The organization's referral-program view: its invite link, the program terms, its referrer stats, and (only when it was itself referred) its referee progress. Amounts are USD cents.
+ * 
+ * @export
+ * @interface Referral
+ */
+export interface Referral {
+    /**
+     * The organization's shareable referral code, e.g. `GPU-7KQ2-M4XP`.
+     * @type {string}
+     * @memberof Referral
+     */
+    code: string;
+    /**
+     * The ready-to-share invite link, `{site}/r/{code}`.
+     * @type {string}
+     * @memberof Referral
+     */
+    inviteUrl: string;
+    /**
+     * Friends who signed up through the link but have not yet reached the spend gate.
+     * @type {number}
+     * @memberof Referral
+     */
+    pending: number;
+    /**
+     * Friends past the spend gate whose reward is inside the chargeback hold.
+     * @type {number}
+     * @memberof Referral
+     */
+    qualified: number;
+    /**
+     * Referrals that have paid out.
+     * @type {number}
+     * @memberof Referral
+     */
+    settled: number;
+    /**
+     * Total credit paid to this organization as a referrer.
+     * @type {number}
+     * @memberof Referral
+     */
+    earnedCents: number;
+    /**
+     * Credit paid to the referrer per settled referral.
+     * @type {number}
+     * @memberof Referral
+     */
+    rewardCents: number;
+    /**
+     * Credit paid to the referred friend per settled referral.
+     * @type {number}
+     * @memberof Referral
+     */
+    refereeRewardCents: number;
+    /**
+     * The friend's cumulative inference spend that qualifies a referral.
+     * @type {number}
+     * @memberof Referral
+     */
+    qualifySpendCents: number;
+    /**
+     * Days between qualification and payout (chargeback hold).
+     * @type {number}
+     * @memberof Referral
+     */
+    holdDays: number;
+    /**
+     * 
+     * @type {RefereeStatus}
+     * @memberof Referral
+     */
+    referred?: RefereeStatus;
+}
+
+/**
+ * Check if a given object implements the Referral interface.
+ */
+export function instanceOfReferral(value: object): value is Referral {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if ((!('inviteUrl' in (value as Record<string, any>)) && !('invite_url' in (value as Record<string, any>))) || ((value as Record<string, any>)['inviteUrl'] === undefined && (value as Record<string, any>)['invite_url'] === undefined)) return false;
+    if (!('pending' in value) || value['pending'] === undefined) return false;
+    if (!('qualified' in value) || value['qualified'] === undefined) return false;
+    if (!('settled' in value) || value['settled'] === undefined) return false;
+    if ((!('earnedCents' in (value as Record<string, any>)) && !('earned_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['earnedCents'] === undefined && (value as Record<string, any>)['earned_cents'] === undefined)) return false;
+    if ((!('rewardCents' in (value as Record<string, any>)) && !('reward_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['rewardCents'] === undefined && (value as Record<string, any>)['reward_cents'] === undefined)) return false;
+    if ((!('refereeRewardCents' in (value as Record<string, any>)) && !('referee_reward_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['refereeRewardCents'] === undefined && (value as Record<string, any>)['referee_reward_cents'] === undefined)) return false;
+    if ((!('qualifySpendCents' in (value as Record<string, any>)) && !('qualify_spend_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['qualifySpendCents'] === undefined && (value as Record<string, any>)['qualify_spend_cents'] === undefined)) return false;
+    if ((!('holdDays' in (value as Record<string, any>)) && !('hold_days' in (value as Record<string, any>))) || ((value as Record<string, any>)['holdDays'] === undefined && (value as Record<string, any>)['hold_days'] === undefined)) return false;
+    return true;
+}
+
+export function ReferralFromJSON(json: any): Referral {
+    return ReferralFromJSONTyped(json, false);
+}
+
+export function ReferralFromJSONTyped(json: any, ignoreDiscriminator: boolean): Referral {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'inviteUrl': json['invite_url'],
+        'pending': json['pending'],
+        'qualified': json['qualified'],
+        'settled': json['settled'],
+        'earnedCents': json['earned_cents'],
+        'rewardCents': json['reward_cents'],
+        'refereeRewardCents': json['referee_reward_cents'],
+        'qualifySpendCents': json['qualify_spend_cents'],
+        'holdDays': json['hold_days'],
+        'referred': json['referred'] == null ? undefined : RefereeStatusFromJSON(json['referred']),
+    };
+}
+
+export function ReferralToJSON(json: any): Referral {
+    return ReferralToJSONTyped(json, false);
+}
+
+export function ReferralToJSONTyped(value?: Referral | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'invite_url': value['inviteUrl'],
+        'pending': value['pending'],
+        'qualified': value['qualified'],
+        'settled': value['settled'],
+        'earned_cents': value['earnedCents'],
+        'reward_cents': value['rewardCents'],
+        'referee_reward_cents': value['refereeRewardCents'],
+        'qualify_spend_cents': value['qualifySpendCents'],
+        'hold_days': value['holdDays'],
+        'referred': RefereeStatusToJSON(value['referred']),
+    };
+}
+

package/src/models/VideoJob.ts

@@ -85,6 +85,12 @@ export interface VideoJob {
      * @memberof VideoJob
      */
     error?: string;
+    /**
+     * Human-readable reason behind `error`, when the upstream supplied one. `error` classifies the failure, `error_message` explains it (for example a requested duration outside the model's supported range). Sanitized before storage; only ever present alongside `error`.
+     * @type {string}
+     * @memberof VideoJob
+     */
+    errorMessage?: string;
     /**
      * Final billed cost in cents; present once the job completes (failed/cancelled jobs are never billed).
      * @type {number}
@@ -152,6 +158,7 @@ export function VideoJobFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
         'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
         'error': json['error'] == null ? undefined : json['error'],
+        'errorMessage': json['error_message'] == null ? undefined : json['error_message'],
         'costCents': json['cost_cents'] == null ? undefined : json['cost_cents'],
     };
 }
@@ -178,6 +185,7 @@ export function VideoJobToJSONTyped(value?: VideoJob | null, ignoreDiscriminator
         'completed_at': value['completedAt'],
         'expires_at': value['expiresAt'],
         'error': value['error'],
+        'error_message': value['errorMessage'],
         'cost_cents': value['costCents'],
     };
 }

package/src/models/index.ts

@@ -32,6 +32,8 @@ export * from './OperationError';
 export * from './OperationResult';
 export * from './PeakWindow';
 export * from './Problem';
+export * from './RefereeStatus';
+export * from './Referral';
 export * from './SpendingLimit';
 export * from './StreamOptions';
 export * from './Subscription';

package/src/runtime.ts

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