@widgetic/api-sdk 1.0.32 → 1.0.34

package/dist/esm/models/PersonalStorage.js

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PersonalExtraStorageFromJSON, PersonalExtraStorageToJSON, } from './PersonalExtraStorage.js';
+import { PersonalStoragePackFromJSON, PersonalStoragePackToJSON, } from './PersonalStoragePack.js';
+/**
+ * Check if a given object implements the PersonalStorage interface.
+ */
+export function instanceOfPersonalStorage(value) {
+    if (!('planStorageGb' in value) || value['planStorageGb'] === undefined)
+        return false;
+    if (!('extraStorageGb' in value) || value['extraStorageGb'] === undefined)
+        return false;
+    if (!('totalQuotaGb' in value) || value['totalQuotaGb'] === undefined)
+        return false;
+    if (!('usedGb' in value) || value['usedGb'] === undefined)
+        return false;
+    if (!('availableGb' in value) || value['availableGb'] === undefined)
+        return false;
+    if (!('storagePacksCount' in value) || value['storagePacksCount'] === undefined)
+        return false;
+    if (!('extraStorage' in value) || value['extraStorage'] === undefined)
+        return false;
+    if (!('packs' in value) || value['packs'] === undefined)
+        return false;
+    return true;
+}
+export function PersonalStorageFromJSON(json) {
+    return PersonalStorageFromJSONTyped(json, false);
+}
+export function PersonalStorageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'planStorageGb': json['planStorageGb'],
+        'extraStorageGb': json['extraStorageGb'],
+        'totalQuotaGb': json['totalQuotaGb'],
+        'usedGb': json['usedGb'],
+        'availableGb': json['availableGb'],
+        'storagePacksCount': json['storagePacksCount'],
+        'extraStorage': PersonalExtraStorageFromJSON(json['extraStorage']),
+        'packs': (json['packs'].map(PersonalStoragePackFromJSON)),
+    };
+}
+export function PersonalStorageToJSON(json) {
+    return PersonalStorageToJSONTyped(json, false);
+}
+export function PersonalStorageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'planStorageGb': value['planStorageGb'],
+        'extraStorageGb': value['extraStorageGb'],
+        'totalQuotaGb': value['totalQuotaGb'],
+        'usedGb': value['usedGb'],
+        'availableGb': value['availableGb'],
+        'storagePacksCount': value['storagePacksCount'],
+        'extraStorage': PersonalExtraStorageToJSON(value['extraStorage']),
+        'packs': (value['packs'].map(PersonalStoragePackToJSON)),
+    };
+}

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

@@ -0,0 +1,100 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A row of the person's extra storage: one per storage item on the subscription, kept in step
+ * with what Stripe bills. A row is `active` while the subscription bills it and `cancelled`
+ * once it stops (the row is kept as history).
+ *
+ * @export
+ * @interface PersonalStoragePack
+ */
+export interface PersonalStoragePack {
+    /**
+     *
+     * @type {string}
+     * @memberof PersonalStoragePack
+     */
+    id: string;
+    /**
+     * The person the storage belongs to
+     * @type {string}
+     * @memberof PersonalStoragePack
+     */
+    userId: string;
+    /**
+     * Size of the row in GB
+     * @type {number}
+     * @memberof PersonalStoragePack
+     */
+    packSizeGb: number;
+    /**
+     * What the row costs per billing period
+     * @type {number}
+     * @memberof PersonalStoragePack
+     */
+    pricePaid: number;
+    /**
+     * The interval the row is billed on
+     * @type {string}
+     * @memberof PersonalStoragePack
+     */
+    billingInterval?: PersonalStoragePackBillingIntervalEnum | null;
+    /**
+     * The user who added the storage; always the person themselves
+     * @type {string}
+     * @memberof PersonalStoragePack
+     */
+    purchasedBy: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof PersonalStoragePack
+     */
+    purchasedAt?: Date | null;
+    /**
+     * When the row stops counting; null when it does not expire
+     * @type {Date}
+     * @memberof PersonalStoragePack
+     */
+    expiresAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PersonalStoragePack
+     */
+    status: PersonalStoragePackStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const PersonalStoragePackBillingIntervalEnum: {
+    readonly Month: "month";
+    readonly Year: "year";
+};
+export type PersonalStoragePackBillingIntervalEnum = typeof PersonalStoragePackBillingIntervalEnum[keyof typeof PersonalStoragePackBillingIntervalEnum];
+/**
+ * @export
+ */
+export declare const PersonalStoragePackStatusEnum: {
+    readonly Active: "active";
+    readonly Expired: "expired";
+    readonly Cancelled: "cancelled";
+};
+export type PersonalStoragePackStatusEnum = typeof PersonalStoragePackStatusEnum[keyof typeof PersonalStoragePackStatusEnum];
+/**
+ * Check if a given object implements the PersonalStoragePack interface.
+ */
+export declare function instanceOfPersonalStoragePack(value: object): value is PersonalStoragePack;
+export declare function PersonalStoragePackFromJSON(json: any): PersonalStoragePack;
+export declare function PersonalStoragePackFromJSONTyped(json: any, ignoreDiscriminator: boolean): PersonalStoragePack;
+export declare function PersonalStoragePackToJSON(json: any): PersonalStoragePack;
+export declare function PersonalStoragePackToJSONTyped(value?: PersonalStoragePack | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PersonalStoragePack.js

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const PersonalStoragePackBillingIntervalEnum = {
+    Month: 'month',
+    Year: 'year'
+};
+/**
+ * @export
+ */
+export const PersonalStoragePackStatusEnum = {
+    Active: 'active',
+    Expired: 'expired',
+    Cancelled: 'cancelled'
+};
+/**
+ * Check if a given object implements the PersonalStoragePack interface.
+ */
+export function instanceOfPersonalStoragePack(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('packSizeGb' in value) || value['packSizeGb'] === undefined)
+        return false;
+    if (!('pricePaid' in value) || value['pricePaid'] === undefined)
+        return false;
+    if (!('purchasedBy' in value) || value['purchasedBy'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function PersonalStoragePackFromJSON(json) {
+    return PersonalStoragePackFromJSONTyped(json, false);
+}
+export function PersonalStoragePackFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'userId': json['userId'],
+        'packSizeGb': json['packSizeGb'],
+        'pricePaid': json['pricePaid'],
+        'billingInterval': json['billingInterval'] == null ? undefined : json['billingInterval'],
+        'purchasedBy': json['purchasedBy'],
+        'purchasedAt': json['purchasedAt'] == null ? undefined : (new Date(json['purchasedAt'])),
+        'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
+        'status': json['status'],
+    };
+}
+export function PersonalStoragePackToJSON(json) {
+    return PersonalStoragePackToJSONTyped(json, false);
+}
+export function PersonalStoragePackToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'userId': value['userId'],
+        'packSizeGb': value['packSizeGb'],
+        'pricePaid': value['pricePaid'],
+        'billingInterval': value['billingInterval'],
+        'purchasedBy': value['purchasedBy'],
+        'purchasedAt': value['purchasedAt'] == null ? undefined : (value['purchasedAt'].toISOString()),
+        'expiresAt': value['expiresAt'] == null ? undefined : (value['expiresAt'].toISOString()),
+        'status': value['status'],
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PurchaseStoragePack200ResponseDataPaymentIntent
+ */
+export interface PurchaseStoragePack200ResponseDataPaymentIntent {
+    /**
+     * Stripe PaymentIntent ID
+     * @type {string}
+     * @memberof PurchaseStoragePack200ResponseDataPaymentIntent
+     */
+    id?: string;
+    /**
+     * Client secret for Stripe.js confirmation
+     * @type {string}
+     * @memberof PurchaseStoragePack200ResponseDataPaymentIntent
+     */
+    clientSecret?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PurchaseStoragePack200ResponseDataPaymentIntent
+     */
+    amountUsd?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PurchaseStoragePack200ResponseDataPaymentIntent
+     */
+    packSizeGb?: number;
+}
+/**
+ * Check if a given object implements the PurchaseStoragePack200ResponseDataPaymentIntent interface.
+ */
+export declare function instanceOfPurchaseStoragePack200ResponseDataPaymentIntent(value: object): value is PurchaseStoragePack200ResponseDataPaymentIntent;
+export declare function PurchaseStoragePack200ResponseDataPaymentIntentFromJSON(json: any): PurchaseStoragePack200ResponseDataPaymentIntent;
+export declare function PurchaseStoragePack200ResponseDataPaymentIntentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PurchaseStoragePack200ResponseDataPaymentIntent;
+export declare function PurchaseStoragePack200ResponseDataPaymentIntentToJSON(json: any): PurchaseStoragePack200ResponseDataPaymentIntent;
+export declare function PurchaseStoragePack200ResponseDataPaymentIntentToJSONTyped(value?: PurchaseStoragePack200ResponseDataPaymentIntent | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PurchaseStoragePack200ResponseDataPaymentIntent.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the PurchaseStoragePack200ResponseDataPaymentIntent interface.
+ */
+export function instanceOfPurchaseStoragePack200ResponseDataPaymentIntent(value) {
+    return true;
+}
+export function PurchaseStoragePack200ResponseDataPaymentIntentFromJSON(json) {
+    return PurchaseStoragePack200ResponseDataPaymentIntentFromJSONTyped(json, false);
+}
+export function PurchaseStoragePack200ResponseDataPaymentIntentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'clientSecret': json['clientSecret'] == null ? undefined : json['clientSecret'],
+        'amountUsd': json['amountUsd'] == null ? undefined : json['amountUsd'],
+        'packSizeGb': json['packSizeGb'] == null ? undefined : json['packSizeGb'],
+    };
+}
+export function PurchaseStoragePack200ResponseDataPaymentIntentToJSON(json) {
+    return PurchaseStoragePack200ResponseDataPaymentIntentToJSONTyped(json, false);
+}
+export function PurchaseStoragePack200ResponseDataPaymentIntentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'clientSecret': value['clientSecret'],
+        'amountUsd': value['amountUsd'],
+        'packSizeGb': value['packSizeGb'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface RequestExtraCredits
+ */
+export interface RequestExtraCredits {
+    /**
+     * The dollars to spend on credits, to the cent: at least 10, at most 100000 in one request. The invoice is for the most whole credits that money buys at the list price of a credit, so it is never for more than this (12.34 buys 123 credits and the invoice says 12.30).
+     *
+     * @type {number}
+     * @memberof RequestExtraCredits
+     */
+    usd: number;
+}
+/**
+ * Check if a given object implements the RequestExtraCredits interface.
+ */
+export declare function instanceOfRequestExtraCredits(value: object): value is RequestExtraCredits;
+export declare function RequestExtraCreditsFromJSON(json: any): RequestExtraCredits;
+export declare function RequestExtraCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequestExtraCredits;
+export declare function RequestExtraCreditsToJSON(json: any): RequestExtraCredits;
+export declare function RequestExtraCreditsToJSONTyped(value?: RequestExtraCredits | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RequestExtraCredits.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the RequestExtraCredits interface.
+ */
+export function instanceOfRequestExtraCredits(value) {
+    if (!('usd' in value) || value['usd'] === undefined)
+        return false;
+    return true;
+}
+export function RequestExtraCreditsFromJSON(json) {
+    return RequestExtraCreditsFromJSONTyped(json, false);
+}
+export function RequestExtraCreditsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'usd': json['usd'],
+    };
+}
+export function RequestExtraCreditsToJSON(json) {
+    return RequestExtraCreditsToJSONTyped(json, false);
+}
+export function RequestExtraCreditsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'usd': value['usd'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface RollbackComponentRequest
+ */
+export interface RollbackComponentRequest {
+    /**
+     * The Git commit ID to roll back to
+     * @type {string}
+     * @memberof RollbackComponentRequest
+     */
+    checkpointCommitId: string;
+    /**
+     * Optional reason for the rollback
+     * @type {string}
+     * @memberof RollbackComponentRequest
+     */
+    reason?: string;
+}
+/**
+ * Check if a given object implements the RollbackComponentRequest interface.
+ */
+export declare function instanceOfRollbackComponentRequest(value: object): value is RollbackComponentRequest;
+export declare function RollbackComponentRequestFromJSON(json: any): RollbackComponentRequest;
+export declare function RollbackComponentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RollbackComponentRequest;
+export declare function RollbackComponentRequestToJSON(json: any): RollbackComponentRequest;
+export declare function RollbackComponentRequestToJSONTyped(value?: RollbackComponentRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RollbackComponentRequest.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the RollbackComponentRequest interface.
+ */
+export function instanceOfRollbackComponentRequest(value) {
+    if (!('checkpointCommitId' in value) || value['checkpointCommitId'] === undefined)
+        return false;
+    return true;
+}
+export function RollbackComponentRequestFromJSON(json) {
+    return RollbackComponentRequestFromJSONTyped(json, false);
+}
+export function RollbackComponentRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'checkpointCommitId': json['checkpointCommitId'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+export function RollbackComponentRequestToJSON(json) {
+    return RollbackComponentRequestToJSONTyped(json, false);
+}
+export function RollbackComponentRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'checkpointCommitId': value['checkpointCommitId'],
+        'reason': value['reason'],
+    };
+}

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

@@ -10,8 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- * The organization's extra storage after a change. Extra storage is a recurring item on
- * the Teams subscription: `chargePerPeriodUsd` renews with the seats until it is removed.
+ * The extra storage of an organization (Teams) or of a person (Solo) after a change. Extra
+ * storage is a recurring item on the subscription: `chargePerPeriodUsd` renews with the plan
+ * until it is removed.
  *
  * @export
  * @interface StorageChange
@@ -62,7 +63,7 @@ export interface StorageChange {
      */
     proratedChargeNow: boolean;
     /**
-     * False when the change is billed but the organization's storage pool has not caught
+     * False when the change is billed but the storage the upload check reads has not caught
      * up yet; it follows from Stripe's next event, so a client may refresh in a moment.
      *
      * @type {boolean}

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

@@ -0,0 +1,85 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SurfaceConversionResultSubscription } from './SurfaceConversionResultSubscription';
+/**
+ * A subscription that has been converted between a person (Solo) and an organization (Teams),
+ * in either direction. The Stripe subscription is the same one; what changed is who holds it
+ * and which plan it is on.
+ *
+ * @export
+ * @interface SurfaceConversionResult
+ */
+export interface SurfaceConversionResult {
+    /**
+     *
+     * @type {SurfaceConversionResultSubscription}
+     * @memberof SurfaceConversionResult
+     */
+    subscription: SurfaceConversionResultSubscription;
+    /**
+     * Where the subscription was
+     * @type {string}
+     * @memberof SurfaceConversionResult
+     */
+    from: SurfaceConversionResultFromEnum;
+    /**
+     * Where the subscription is now
+     * @type {string}
+     * @memberof SurfaceConversionResult
+     */
+    to: SurfaceConversionResultToEnum;
+    /**
+     * The plan it is on now (`teams` or `solo`)
+     * @type {string}
+     * @memberof SurfaceConversionResult
+     */
+    planType: string;
+    /**
+     * True when the plan changed but a step after it (for example granting the new plan's
+     * credits) did not finish. The change itself is done and must not be repeated: what is
+     * missing is logged for support, who can finish it.
+     *
+     * @type {boolean}
+     * @memberof SurfaceConversionResult
+     */
+    incomplete: boolean;
+    /**
+     * What happened and what it costs, in words a person can be shown
+     * @type {string}
+     * @memberof SurfaceConversionResult
+     */
+    message?: string;
+}
+/**
+ * @export
+ */
+export declare const SurfaceConversionResultFromEnum: {
+    readonly Personal: "personal";
+    readonly Organization: "organization";
+};
+export type SurfaceConversionResultFromEnum = typeof SurfaceConversionResultFromEnum[keyof typeof SurfaceConversionResultFromEnum];
+/**
+ * @export
+ */
+export declare const SurfaceConversionResultToEnum: {
+    readonly Personal: "personal";
+    readonly Organization: "organization";
+};
+export type SurfaceConversionResultToEnum = typeof SurfaceConversionResultToEnum[keyof typeof SurfaceConversionResultToEnum];
+/**
+ * Check if a given object implements the SurfaceConversionResult interface.
+ */
+export declare function instanceOfSurfaceConversionResult(value: object): value is SurfaceConversionResult;
+export declare function SurfaceConversionResultFromJSON(json: any): SurfaceConversionResult;
+export declare function SurfaceConversionResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): SurfaceConversionResult;
+export declare function SurfaceConversionResultToJSON(json: any): SurfaceConversionResult;
+export declare function SurfaceConversionResultToJSONTyped(value?: SurfaceConversionResult | null, ignoreDiscriminator?: boolean): any;