@deeprelay/sdk 0.0.1 → 0.1.1

package/src/models/Subscription.ts

@@ -0,0 +1,149 @@
+/* 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 { SubscriptionPlan } from './SubscriptionPlan';
+import {
+    SubscriptionPlanFromJSON,
+    SubscriptionPlanFromJSONTyped,
+    SubscriptionPlanToJSON,
+    SubscriptionPlanToJSONTyped,
+} from './SubscriptionPlan';
+import type { SubscriptionUsage } from './SubscriptionUsage';
+import {
+    SubscriptionUsageFromJSON,
+    SubscriptionUsageFromJSONTyped,
+    SubscriptionUsageToJSON,
+    SubscriptionUsageToJSONTyped,
+} from './SubscriptionUsage';
+import type { SubscriptionQuota } from './SubscriptionQuota';
+import {
+    SubscriptionQuotaFromJSON,
+    SubscriptionQuotaFromJSONTyped,
+    SubscriptionQuotaToJSON,
+    SubscriptionQuotaToJSONTyped,
+} from './SubscriptionQuota';
+
+/**
+ * The organization's flat subscription tier: entitlement, billing period, the configured quota, and consumption against it. The console and this endpoint assemble it from the same source, so the two surfaces cannot report different numbers.
+ * 
+ * @export
+ * @interface Subscription
+ */
+export interface Subscription {
+    /**
+     * Whether the organization is entitled to the plan right now. Only an `active` or `trialing` subscription entitles, including a short grace window past the period end that absorbs renewal webhook lag; a failed payment (`past_due`) cuts access immediately. Render from this; do not re-derive entitlement from `status` and the period bounds.
+     * @type {boolean}
+     * @memberof Subscription
+     */
+    subscribed: boolean;
+    /**
+     * Raw subscription status — "active", "trialing", "past_due", "canceled" and so on — or "none" when the organization never subscribed.
+     * @type {string}
+     * @memberof Subscription
+     */
+    status: string;
+    /**
+     * Whether the subscription stops at the end of the current period instead of renewing.
+     * @type {boolean}
+     * @memberof Subscription
+     */
+    cancelAtPeriodEnd: boolean;
+    /**
+     * Start of the current billing period. Absent until the billing provider has reported a period for this subscription.
+     * @type {Date}
+     * @memberof Subscription
+     */
+    currentPeriodStart?: Date;
+    /**
+     * End of the current billing period. Absent under the same condition as current_period_start.
+     * @type {Date}
+     * @memberof Subscription
+     */
+    currentPeriodEnd?: Date;
+    /**
+     * 
+     * @type {SubscriptionPlan}
+     * @memberof Subscription
+     */
+    plan: SubscriptionPlan;
+    /**
+     * 
+     * @type {SubscriptionQuota}
+     * @memberof Subscription
+     */
+    quota: SubscriptionQuota;
+    /**
+     * 
+     * @type {SubscriptionUsage}
+     * @memberof Subscription
+     */
+    usage?: SubscriptionUsage;
+}
+
+/**
+ * Check if a given object implements the Subscription interface.
+ */
+export function instanceOfSubscription(value: object): value is Subscription {
+    if (!('subscribed' in value) || value['subscribed'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if ((!('cancelAtPeriodEnd' in (value as Record<string, any>)) && !('cancel_at_period_end' in (value as Record<string, any>))) || ((value as Record<string, any>)['cancelAtPeriodEnd'] === undefined && (value as Record<string, any>)['cancel_at_period_end'] === undefined)) return false;
+    if (!('plan' in value) || value['plan'] === undefined) return false;
+    if (!('quota' in value) || value['quota'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionFromJSON(json: any): Subscription {
+    return SubscriptionFromJSONTyped(json, false);
+}
+
+export function SubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Subscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subscribed': json['subscribed'],
+        'status': json['status'],
+        'cancelAtPeriodEnd': json['cancel_at_period_end'],
+        'currentPeriodStart': json['current_period_start'] == null ? undefined : (new Date(json['current_period_start'])),
+        'currentPeriodEnd': json['current_period_end'] == null ? undefined : (new Date(json['current_period_end'])),
+        'plan': SubscriptionPlanFromJSON(json['plan']),
+        'quota': SubscriptionQuotaFromJSON(json['quota']),
+        'usage': json['usage'] == null ? undefined : SubscriptionUsageFromJSON(json['usage']),
+    };
+}
+
+export function SubscriptionToJSON(json: any): Subscription {
+    return SubscriptionToJSONTyped(json, false);
+}
+
+export function SubscriptionToJSONTyped(value?: Subscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subscribed': value['subscribed'],
+        'status': value['status'],
+        'cancel_at_period_end': value['cancelAtPeriodEnd'],
+        'current_period_start': value['currentPeriodStart'] == null ? value['currentPeriodStart'] : value['currentPeriodStart'].toISOString(),
+        'current_period_end': value['currentPeriodEnd'] == null ? value['currentPeriodEnd'] : value['currentPeriodEnd'].toISOString(),
+        'plan': SubscriptionPlanToJSON(value['plan']),
+        'quota': SubscriptionQuotaToJSON(value['quota']),
+        'usage': SubscriptionUsageToJSON(value['usage']),
+    };
+}
+

package/src/models/SubscriptionCheckoutRequest.ts

@@ -0,0 +1,82 @@
+/* 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';
+/**
+ * Optional overrides for a checkout mint. Every field has a deployment default, so an empty body is the normal call.
+ * 
+ * @export
+ * @interface SubscriptionCheckoutRequest
+ */
+export interface SubscriptionCheckoutRequest {
+    /**
+     * Where the provider returns after a completed payment. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    successUrl?: string;
+    /**
+     * Where the provider returns if checkout is abandoned. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    cancelUrl?: string;
+    /**
+     * Pins the plan the client displayed. An unknown key is a 400 rather than a silent purchase of a different tier.
+     * @type {string}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    planKey?: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionCheckoutRequest interface.
+ */
+export function instanceOfSubscriptionCheckoutRequest(value: object): value is SubscriptionCheckoutRequest {
+    return true;
+}
+
+export function SubscriptionCheckoutRequestFromJSON(json: any): SubscriptionCheckoutRequest {
+    return SubscriptionCheckoutRequestFromJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionCheckoutRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'successUrl': json['success_url'] == null ? undefined : json['success_url'],
+        'cancelUrl': json['cancel_url'] == null ? undefined : json['cancel_url'],
+        'planKey': json['plan_key'] == null ? undefined : json['plan_key'],
+    };
+}
+
+export function SubscriptionCheckoutRequestToJSON(json: any): SubscriptionCheckoutRequest {
+    return SubscriptionCheckoutRequestToJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutRequestToJSONTyped(value?: SubscriptionCheckoutRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success_url': value['successUrl'],
+        'cancel_url': value['cancelUrl'],
+        'plan_key': value['planKey'],
+    };
+}
+

package/src/models/SubscriptionCheckoutSession.ts

@@ -0,0 +1,92 @@
+/* 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 { SubscriptionPlan } from './SubscriptionPlan';
+import {
+    SubscriptionPlanFromJSON,
+    SubscriptionPlanFromJSONTyped,
+    SubscriptionPlanToJSON,
+    SubscriptionPlanToJSONTyped,
+} from './SubscriptionPlan';
+
+/**
+ * 
+ * @export
+ * @interface SubscriptionCheckoutSession
+ */
+export interface SubscriptionCheckoutSession {
+    /**
+     * The hosted page the customer must open to pay.
+     * @type {string}
+     * @memberof SubscriptionCheckoutSession
+     */
+    checkoutUrl: string;
+    /**
+     * Checkout session id, for support correlation.
+     * @type {string}
+     * @memberof SubscriptionCheckoutSession
+     */
+    sessionId: string;
+    /**
+     * 
+     * @type {SubscriptionPlan}
+     * @memberof SubscriptionCheckoutSession
+     */
+    plan: SubscriptionPlan;
+}
+
+/**
+ * Check if a given object implements the SubscriptionCheckoutSession interface.
+ */
+export function instanceOfSubscriptionCheckoutSession(value: object): value is SubscriptionCheckoutSession {
+    if ((!('checkoutUrl' in (value as Record<string, any>)) && !('checkout_url' in (value as Record<string, any>))) || ((value as Record<string, any>)['checkoutUrl'] === undefined && (value as Record<string, any>)['checkout_url'] === undefined)) return false;
+    if ((!('sessionId' in (value as Record<string, any>)) && !('session_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['sessionId'] === undefined && (value as Record<string, any>)['session_id'] === undefined)) return false;
+    if (!('plan' in value) || value['plan'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionCheckoutSessionFromJSON(json: any): SubscriptionCheckoutSession {
+    return SubscriptionCheckoutSessionFromJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionCheckoutSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'checkoutUrl': json['checkout_url'],
+        'sessionId': json['session_id'],
+        'plan': SubscriptionPlanFromJSON(json['plan']),
+    };
+}
+
+export function SubscriptionCheckoutSessionToJSON(json: any): SubscriptionCheckoutSession {
+    return SubscriptionCheckoutSessionToJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutSessionToJSONTyped(value?: SubscriptionCheckoutSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'checkout_url': value['checkoutUrl'],
+        'session_id': value['sessionId'],
+        'plan': SubscriptionPlanToJSON(value['plan']),
+    };
+}
+

package/src/models/SubscriptionPlan.ts

@@ -0,0 +1,92 @@
+/* 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 { SubscriptionPrice } from './SubscriptionPrice';
+import {
+    SubscriptionPriceFromJSON,
+    SubscriptionPriceFromJSONTyped,
+    SubscriptionPriceToJSON,
+    SubscriptionPriceToJSONTyped,
+} from './SubscriptionPrice';
+
+/**
+ * What the organization is — or would be — subscribing to. Always present, including for an organization that never subscribed: it is what a point of purchase renders before sending anyone to pay.
+ * 
+ * @export
+ * @interface SubscriptionPlan
+ */
+export interface SubscriptionPlan {
+    /**
+     * Stable identifier for the tier. Send it as `plan_key` on /billing/subscription/checkout to pin the plan you displayed.
+     * @type {string}
+     * @memberof SubscriptionPlan
+     */
+    key: string;
+    /**
+     * Human-facing plan name.
+     * @type {string}
+     * @memberof SubscriptionPlan
+     */
+    name: string;
+    /**
+     * 
+     * @type {SubscriptionPrice}
+     * @memberof SubscriptionPlan
+     */
+    price?: SubscriptionPrice;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPlan interface.
+ */
+export function instanceOfSubscriptionPlan(value: object): value is SubscriptionPlan {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionPlanFromJSON(json: any): SubscriptionPlan {
+    return SubscriptionPlanFromJSONTyped(json, false);
+}
+
+export function SubscriptionPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPlan {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'name': json['name'],
+        'price': json['price'] == null ? undefined : SubscriptionPriceFromJSON(json['price']),
+    };
+}
+
+export function SubscriptionPlanToJSON(json: any): SubscriptionPlan {
+    return SubscriptionPlanToJSONTyped(json, false);
+}
+
+export function SubscriptionPlanToJSONTyped(value?: SubscriptionPlan | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'name': value['name'],
+        'price': SubscriptionPriceToJSON(value['price']),
+    };
+}
+

package/src/models/SubscriptionPortalRequest.ts

@@ -0,0 +1,65 @@
+/* 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';
+/**
+ * Optional overrides for a billing-portal mint.
+ * @export
+ * @interface SubscriptionPortalRequest
+ */
+export interface SubscriptionPortalRequest {
+    /**
+     * Where the provider returns when the customer leaves the portal. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionPortalRequest
+     */
+    returnUrl?: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPortalRequest interface.
+ */
+export function instanceOfSubscriptionPortalRequest(value: object): value is SubscriptionPortalRequest {
+    return true;
+}
+
+export function SubscriptionPortalRequestFromJSON(json: any): SubscriptionPortalRequest {
+    return SubscriptionPortalRequestFromJSONTyped(json, false);
+}
+
+export function SubscriptionPortalRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPortalRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'returnUrl': json['return_url'] == null ? undefined : json['return_url'],
+    };
+}
+
+export function SubscriptionPortalRequestToJSON(json: any): SubscriptionPortalRequest {
+    return SubscriptionPortalRequestToJSONTyped(json, false);
+}
+
+export function SubscriptionPortalRequestToJSONTyped(value?: SubscriptionPortalRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'return_url': value['returnUrl'],
+    };
+}
+

package/src/models/SubscriptionPortalSession.ts

@@ -0,0 +1,66 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface SubscriptionPortalSession
+ */
+export interface SubscriptionPortalSession {
+    /**
+     * The hosted billing portal — cancel, resume, change payment method, download invoices.
+     * @type {string}
+     * @memberof SubscriptionPortalSession
+     */
+    portalUrl: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPortalSession interface.
+ */
+export function instanceOfSubscriptionPortalSession(value: object): value is SubscriptionPortalSession {
+    if ((!('portalUrl' in (value as Record<string, any>)) && !('portal_url' in (value as Record<string, any>))) || ((value as Record<string, any>)['portalUrl'] === undefined && (value as Record<string, any>)['portal_url'] === undefined)) return false;
+    return true;
+}
+
+export function SubscriptionPortalSessionFromJSON(json: any): SubscriptionPortalSession {
+    return SubscriptionPortalSessionFromJSONTyped(json, false);
+}
+
+export function SubscriptionPortalSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPortalSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portalUrl': json['portal_url'],
+    };
+}
+
+export function SubscriptionPortalSessionToJSON(json: any): SubscriptionPortalSession {
+    return SubscriptionPortalSessionToJSONTyped(json, false);
+}
+
+export function SubscriptionPortalSessionToJSONTyped(value?: SubscriptionPortalSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal_url': value['portalUrl'],
+    };
+}
+

package/src/models/SubscriptionPrice.ts

@@ -0,0 +1,96 @@
+/* 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';
+/**
+ * The plan's recurring charge, read live from the billing provider — the single source of truth, never a number embedded in code.
+ * 
+ * ABSENT means "price unavailable right now" (billing unconfigured, or the provider could not be reached). It NEVER means free. Render the plan without a figure rather than substituting one; the hosted checkout page always shows the real amount.
+ * 
+ * @export
+ * @interface SubscriptionPrice
+ */
+export interface SubscriptionPrice {
+    /**
+     * Amount in the currency's minor unit (299 = $2.99).
+     * @type {number}
+     * @memberof SubscriptionPrice
+     */
+    amountCents: number;
+    /**
+     * ISO 4217 currency code, lower-case (e.g. "usd").
+     * @type {string}
+     * @memberof SubscriptionPrice
+     */
+    currency: string;
+    /**
+     * Recurrence unit — "day", "week", "month" or "year".
+     * @type {string}
+     * @memberof SubscriptionPrice
+     */
+    interval: string;
+    /**
+     * How many intervals between charges ("month", 1 = monthly).
+     * @type {number}
+     * @memberof SubscriptionPrice
+     */
+    intervalCount: number;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPrice interface.
+ */
+export function instanceOfSubscriptionPrice(value: object): value is SubscriptionPrice {
+    if ((!('amountCents' in (value as Record<string, any>)) && !('amount_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['amountCents'] === undefined && (value as Record<string, any>)['amount_cents'] === undefined)) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('interval' in value) || value['interval'] === undefined) return false;
+    if ((!('intervalCount' in (value as Record<string, any>)) && !('interval_count' in (value as Record<string, any>))) || ((value as Record<string, any>)['intervalCount'] === undefined && (value as Record<string, any>)['interval_count'] === undefined)) return false;
+    return true;
+}
+
+export function SubscriptionPriceFromJSON(json: any): SubscriptionPrice {
+    return SubscriptionPriceFromJSONTyped(json, false);
+}
+
+export function SubscriptionPriceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPrice {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'amountCents': json['amount_cents'],
+        'currency': json['currency'],
+        'interval': json['interval'],
+        'intervalCount': json['interval_count'],
+    };
+}
+
+export function SubscriptionPriceToJSON(json: any): SubscriptionPrice {
+    return SubscriptionPriceToJSONTyped(json, false);
+}
+
+export function SubscriptionPriceToJSONTyped(value?: SubscriptionPrice | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'amount_cents': value['amountCents'],
+        'currency': value['currency'],
+        'interval': value['interval'],
+        'interval_count': value['intervalCount'],
+    };
+}
+