@deeprelay/sdk 0.1.1 → 0.2.0

package/docs/BillingApi.md

@@ -7,8 +7,10 @@ All URIs are relative to *https://api.deeprelay.ai/v1*
 | [**createCryptoDeposit**](BillingApi.md#createcryptodepositoperation) | **POST** /billing/deposits/crypto | Create a stablecoin deposit |
 | [**createSubscriptionCheckout**](BillingApi.md#createsubscriptioncheckout) | **POST** /billing/subscription/checkout | Start a subscription checkout session |
 | [**createSubscriptionPortal**](BillingApi.md#createsubscriptionportal) | **POST** /billing/subscription/portal | Open the billing portal to cancel or manage the subscription |
+| [**deleteSpendingLimit**](BillingApi.md#deletespendinglimit) | **DELETE** /billing/spending-limit | Clear the org spending limit |
 | [**getBalance**](BillingApi.md#getbalance) | **GET** /billing/balance | Get the org credit balance |
 | [**getDeposit**](BillingApi.md#getdeposit) | **GET** /billing/deposits/{id} | Get one stablecoin deposit |
+| [**getReferral**](BillingApi.md#getreferral) | **GET** /referrals | Get the org referral code, invite link, terms and stats |
 | [**getSpendingLimit**](BillingApi.md#getspendinglimit) | **GET** /billing/spending-limit | Get the org spending limit |
 | [**getSubscription**](BillingApi.md#getsubscription) | **GET** /billing/subscription | Get the org subscription status and quota usage |
 | [**listDeposits**](BillingApi.md#listdeposits) | **GET** /billing/deposits | List stablecoin deposits |
@@ -245,6 +247,73 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteSpendingLimit
+
+> deleteSpendingLimit()
+
+Clear the org spending limit
+
+Removes the organization\'s monthly spending limit and daily spend cap entirely. Requires the `billing:write` scope AND org-admin privileges (a non-admin member gets 403). Returns 404 when no limit is configured. This is the only way to remove a limit through the API, because `PUT` floors `monthly_limit_dollars` at 1.00 and so cannot express \"no limit\". 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@deeprelay/sdk';
+import type { DeleteSpendingLimitRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  try {
+    const data = await api.deleteSpendingLimit();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+| **403** | Error response (RFC 7807) |  -  |
+| **404** | Error response (RFC 7807) |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getBalance
 
 > Balance getBalance()
@@ -384,6 +453,71 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getReferral
+
+> Referral getReferral()
+
+Get the org referral code, invite link, terms and stats
+
+Returns the organization\&#39;s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\&#39;s stats, and — when this organization itself signed up through someone else\&#39;s link — its own progress toward the referee reward. Requires the &#x60;billing:read&#x60; 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 &#x60;qualify_spend_cents&#x60; on inference, the referrer receives &#x60;reward_cents&#x60; and the friend receives &#x60;referee_reward_cents&#x60;, both as non-withdrawable credit, after a &#x60;hold_days&#x60; chargeback hold. The terms ride on the wire so a client never hard-codes the amounts.  &#x60;referred&#x60; is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\&#39;s referral card reads. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@deeprelay/sdk';
+import type { GetReferralRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  try {
+    const data = await api.getReferral();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Referral**](Referral.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getSpendingLimit
 
 > SpendingLimit getSpendingLimit()

package/docs/RefereeStatus.md

@@ -0,0 +1,47 @@
+
+# RefereeStatus
+
+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. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`spentCents` | number
+`qualifySpendCents` | number
+`rewardCents` | number
+`qualifiedAt` | Date
+`holdUntil` | Date
+`settledAt` | Date
+
+## Example
+
+```typescript
+import type { RefereeStatus } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "spentCents": null,
+  "qualifySpendCents": null,
+  "rewardCents": null,
+  "qualifiedAt": null,
+  "holdUntil": null,
+  "settledAt": null,
+} satisfies RefereeStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RefereeStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Referral.md

@@ -0,0 +1,55 @@
+
+# Referral
+
+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. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`inviteUrl` | string
+`pending` | number
+`qualified` | number
+`settled` | number
+`earnedCents` | number
+`rewardCents` | number
+`refereeRewardCents` | number
+`qualifySpendCents` | number
+`holdDays` | number
+`referred` | [RefereeStatus](RefereeStatus.md)
+
+## Example
+
+```typescript
+import type { Referral } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": GPU-7KQ2-M4XP,
+  "inviteUrl": https://deeprelay.ai/r/GPU-7KQ2-M4XP,
+  "pending": null,
+  "qualified": null,
+  "settled": null,
+  "earnedCents": null,
+  "rewardCents": null,
+  "refereeRewardCents": null,
+  "qualifySpendCents": null,
+  "holdDays": null,
+  "referred": null,
+} satisfies Referral
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Referral
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VideoJob.md

@@ -17,6 +17,7 @@ Name | Type
 `completedAt` | number
 `expiresAt` | number
 `error` | string
+`errorMessage` | string
 `costCents` | number
 
 ## Example
@@ -37,6 +38,7 @@ const example = {
   "completedAt": null,
   "expiresAt": null,
   "error": null,
+  "errorMessage": null,
   "costCents": null,
 } satisfies VideoJob
 

package/package.json

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

package/src/apis/BillingApi.ts

@@ -38,6 +38,11 @@ import {
     ProblemFromJSON,
     ProblemToJSON,
 } from '../models/Problem';
+import {
+    type Referral,
+    ReferralFromJSON,
+    ReferralToJSON,
+} from '../models/Referral';
 import {
     type SpendingLimit,
     SpendingLimitFromJSON,
@@ -256,6 +261,52 @@ export class BillingApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for deleteSpendingLimit without sending the request
+     */
+    async deleteSpendingLimitRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/billing/spending-limit`;
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Removes the organization\'s monthly spending limit and daily spend cap entirely. Requires the `billing:write` scope AND org-admin privileges (a non-admin member gets 403). Returns 404 when no limit is configured. This is the only way to remove a limit through the API, because `PUT` floors `monthly_limit_dollars` at 1.00 and so cannot express \"no limit\". 
+     * Clear the org spending limit
+     */
+    async deleteSpendingLimitRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteSpendingLimitRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Removes the organization\'s monthly spending limit and daily spend cap entirely. Requires the `billing:write` scope AND org-admin privileges (a non-admin member gets 403). Returns 404 when no limit is configured. This is the only way to remove a limit through the API, because `PUT` floors `monthly_limit_dollars` at 1.00 and so cannot express \"no limit\". 
+     * Clear the org spending limit
+     */
+    async deleteSpendingLimit(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteSpendingLimitRaw(initOverrides);
+    }
+
     /**
      * Creates request options for getBalance without sending the request
      */
@@ -358,6 +409,53 @@ export class BillingApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getReferral without sending the request
+     */
+    async getReferralRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/referrals`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * 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 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>> {
+        const requestOptions = await this.getReferralRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReferralFromJSON(jsonValue));
+    }
+
+    /**
+     * 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 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> {
+        const response = await this.getReferralRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getSpendingLimit without sending the request
      */

package/src/apis/index.ts

@@ -3,6 +3,5 @@
 export * from './BillingApi';
 export * from './InferenceApi';
 export * from './MetaApi';
-export * from './OperationsApi';
 export * from './UsageApi';
 export * from './WebhooksApi';

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(),
+    };
+}
+