@deeprelay/sdk 0.1.0 → 0.1.2

package/src/models/InferencePreflight.ts

@@ -0,0 +1,147 @@
+/* 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 verdict for one (organization, model) pair: what would happen if the model were invoked right now.
+ * 
+ * @export
+ * @interface InferencePreflight
+ */
+export interface InferencePreflight {
+    /**
+     * The canonical catalog id the request resolved to.
+     * @type {string}
+     * @memberof InferencePreflight
+     */
+    model: string;
+    /**
+     * `ok` — the request will be served (covered by the plan, or payable). `warn` — it will be served AND charged in a way the caller may not expect. `block` — it will be refused (402 or 429).
+     * @type {InferencePreflightVerdictEnum}
+     * @memberof InferencePreflight
+     */
+    verdict: InferencePreflightVerdictEnum;
+    /**
+     * Stable code explaining the verdict, for clients that need their own wording. Absent on a plain `ok` that needs no explanation.
+     * @type {InferencePreflightReasonEnum}
+     * @memberof InferencePreflight
+     */
+    reason?: InferencePreflightReasonEnum;
+    /**
+     * A ready-to-print sentence, phrased for this exact plan/credit combination. Prefer it over composing one from verdict and reason: it improves without a client release.
+     * @type {string}
+     * @memberof InferencePreflight
+     */
+    message: string;
+    /**
+     * Whether the subscription tier covers this model. A property of the PLATFORM, not of the caller — it stays true for an organization that has no subscription, which is what makes the "this is included in the plan" upsell honest.
+     * @type {boolean}
+     * @memberof InferencePreflight
+     */
+    planCovered: boolean;
+    /**
+     * Whether the organization is entitled to the plan right now.
+     * @type {boolean}
+     * @memberof InferencePreflight
+     */
+    subscribed: boolean;
+    /**
+     * Whether a pay-as-you-go request could be paid for right now: a positive credit balance AND no self-set spending cap already at its limit. A boolean and never a figure — this route is on the inference read scope and must not disclose the balance.
+     * @type {boolean}
+     * @memberof InferencePreflight
+     */
+    funded: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const InferencePreflightVerdictEnum = {
+    Ok: 'ok',
+    Warn: 'warn',
+    Block: 'block'
+} as const;
+export type InferencePreflightVerdictEnum = typeof InferencePreflightVerdictEnum[keyof typeof InferencePreflightVerdictEnum];
+
+/**
+ * @export
+ */
+export const InferencePreflightReasonEnum = {
+    PlanCovered: 'plan_covered',
+    Payg: 'payg',
+    NotPlanCovered: 'not_plan_covered',
+    SubscriptionQuotaExhausted: 'subscription_quota_exhausted',
+    InsufficientBalance: 'insufficient_balance',
+    DailyLimitReached: 'daily_limit_reached',
+    MonthlyLimitReached: 'monthly_limit_reached',
+    PreflightUnavailable: 'preflight_unavailable'
+} as const;
+export type InferencePreflightReasonEnum = typeof InferencePreflightReasonEnum[keyof typeof InferencePreflightReasonEnum];
+
+
+/**
+ * Check if a given object implements the InferencePreflight interface.
+ */
+export function instanceOfInferencePreflight(value: object): value is InferencePreflight {
+    if (!('model' in value) || value['model'] === undefined) return false;
+    if (!('verdict' in value) || value['verdict'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if ((!('planCovered' in (value as Record<string, any>)) && !('plan_covered' in (value as Record<string, any>))) || ((value as Record<string, any>)['planCovered'] === undefined && (value as Record<string, any>)['plan_covered'] === undefined)) return false;
+    if (!('subscribed' in value) || value['subscribed'] === undefined) return false;
+    if (!('funded' in value) || value['funded'] === undefined) return false;
+    return true;
+}
+
+export function InferencePreflightFromJSON(json: any): InferencePreflight {
+    return InferencePreflightFromJSONTyped(json, false);
+}
+
+export function InferencePreflightFromJSONTyped(json: any, ignoreDiscriminator: boolean): InferencePreflight {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'model': json['model'],
+        'verdict': json['verdict'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'message': json['message'],
+        'planCovered': json['plan_covered'],
+        'subscribed': json['subscribed'],
+        'funded': json['funded'],
+    };
+}
+
+export function InferencePreflightToJSON(json: any): InferencePreflight {
+    return InferencePreflightToJSONTyped(json, false);
+}
+
+export function InferencePreflightToJSONTyped(value?: InferencePreflight | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'model': value['model'],
+        'verdict': value['verdict'],
+        'reason': value['reason'],
+        'message': value['message'],
+        'plan_covered': value['planCovered'],
+        'subscribed': value['subscribed'],
+        'funded': value['funded'],
+    };
+}
+

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/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/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'],
+    };
+}
+