@equisoft/billing-sdk 0.0.2-snapshot.20250930230514

package/src/apis/UserV1Api.ts

@@ -0,0 +1,232 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ErrorSchema,
+  V1SetUserNonBillablePayload,
+  V1User,
+  V1UserStatus,
+} from '../models/index';
+import {
+    ErrorSchemaFromJSON,
+    ErrorSchemaToJSON,
+    V1SetUserNonBillablePayloadFromJSON,
+    V1SetUserNonBillablePayloadToJSON,
+    V1UserFromJSON,
+    V1UserToJSON,
+    V1UserStatusFromJSON,
+    V1UserStatusToJSON,
+} from '../models/index';
+
+export interface GetUserRequest {
+    uuid: string;
+}
+
+export interface GetUserStatusRequest {
+    uuid: string;
+}
+
+export interface SetNonBillableRequest {
+    uuid: string;
+    v1SetUserNonBillablePayload: V1SetUserNonBillablePayload;
+}
+
+export interface UnsetNonBillableRequest {
+    uuid: string;
+}
+
+/**
+ * 
+ */
+export class UserV1Api extends runtime.BaseAPI {
+
+    /**
+     * Get billing information about a User
+     */
+    async getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1User>> {
+        if (requestParameters['uuid'] == null) {
+            throw new runtime.RequiredError(
+                'uuid',
+                'Required parameter "uuid" was null or undefined when calling getUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            const token = this.configuration.accessToken;
+            const tokenString = await token("OAuth2", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        const response = await this.request({
+            path: `/v1/users/{uuid}`.replace(`{${"uuid"}}`, encodeURIComponent(String(requestParameters['uuid']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V1UserFromJSON(jsonValue));
+    }
+
+    /**
+     * Get billing information about a User
+     */
+    async getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1User> {
+        const response = await this.getUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get billing status of a user
+     */
+    async getUserStatusRaw(requestParameters: GetUserStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1UserStatus>> {
+        if (requestParameters['uuid'] == null) {
+            throw new runtime.RequiredError(
+                'uuid',
+                'Required parameter "uuid" was null or undefined when calling getUserStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            const token = this.configuration.accessToken;
+            const tokenString = await token("OAuth2", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        const response = await this.request({
+            path: `/v1/users/{uuid}/status`.replace(`{${"uuid"}}`, encodeURIComponent(String(requestParameters['uuid']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V1UserStatusFromJSON(jsonValue));
+    }
+
+    /**
+     * Get billing status of a user
+     */
+    async getUserStatus(requestParameters: GetUserStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1UserStatus> {
+        const response = await this.getUserStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Set the user non-billable
+     */
+    async setNonBillableRaw(requestParameters: SetNonBillableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['uuid'] == null) {
+            throw new runtime.RequiredError(
+                'uuid',
+                'Required parameter "uuid" was null or undefined when calling setNonBillable().'
+            );
+        }
+
+        if (requestParameters['v1SetUserNonBillablePayload'] == null) {
+            throw new runtime.RequiredError(
+                'v1SetUserNonBillablePayload',
+                'Required parameter "v1SetUserNonBillablePayload" was null or undefined when calling setNonBillable().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            const token = this.configuration.accessToken;
+            const tokenString = await token("OAuth2", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        const response = await this.request({
+            path: `/v1/users/{uuid}/nonBillable`.replace(`{${"uuid"}}`, encodeURIComponent(String(requestParameters['uuid']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: V1SetUserNonBillablePayloadToJSON(requestParameters['v1SetUserNonBillablePayload']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Set the user non-billable
+     */
+    async setNonBillable(requestParameters: SetNonBillableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.setNonBillableRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Remove the non-billable flag on the user
+     */
+    async unsetNonBillableRaw(requestParameters: UnsetNonBillableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['uuid'] == null) {
+            throw new runtime.RequiredError(
+                'uuid',
+                'Required parameter "uuid" was null or undefined when calling unsetNonBillable().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            const token = this.configuration.accessToken;
+            const tokenString = await token("OAuth2", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        const response = await this.request({
+            path: `/v1/users/{uuid}/nonBillable`.replace(`{${"uuid"}}`, encodeURIComponent(String(requestParameters['uuid']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove the non-billable flag on the user
+     */
+    async unsetNonBillable(requestParameters: UnsetNonBillableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.unsetNonBillableRaw(requestParameters, initOverrides);
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './DistributorV1Api';
+export * from './OrganizationV1Api';
+export * from './UserV1Api';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/ErrorCodes.ts

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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 ErrorCodes = {
+    NOT_FOUND: 'NOT_FOUND',
+    SERVER_ERROR: 'SERVER_ERROR',
+    SERVICE_UNAVAILABLE: 'SERVICE_UNAVAILABLE',
+    INVALID_BILLING_TYPE: 'INVALID_BILLING_TYPE',
+    ACCESS_DENIED: 'ACCESS_DENIED',
+    PAYMENT_ERROR: 'PAYMENT_ERROR',
+    INVALID_PORTAL_SESSION_REDIRECT_URL: 'INVALID_PORTAL_SESSION_REDIRECT_URL',
+    unknown_default_open_api: '11184809'
+} as const;
+export type ErrorCodes = typeof ErrorCodes[keyof typeof ErrorCodes];
+
+
+export function instanceOfErrorCodes(value: any): boolean {
+    for (const key in ErrorCodes) {
+        if (Object.prototype.hasOwnProperty.call(ErrorCodes, key)) {
+            if (ErrorCodes[key as keyof typeof ErrorCodes] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ErrorCodesFromJSON(json: any): ErrorCodes {
+    return ErrorCodesFromJSONTyped(json, false);
+}
+
+export function ErrorCodesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorCodes {
+    return json as ErrorCodes;
+}
+
+export function ErrorCodesToJSON(value?: ErrorCodes | null): any {
+    return value as any;
+}
+
+export function ErrorCodesToJSONTyped(value: any, ignoreDiscriminator: boolean): ErrorCodes {
+    return value as ErrorCodes;
+}
+

package/src/models/ErrorSchema.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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 { ErrorCodes } from './ErrorCodes';
+import {
+    ErrorCodesFromJSON,
+    ErrorCodesFromJSONTyped,
+    ErrorCodesToJSON,
+    ErrorCodesToJSONTyped,
+} from './ErrorCodes';
+
+/**
+ * 
+ * @export
+ * @interface ErrorSchema
+ */
+export interface ErrorSchema {
+    /**
+     * 
+     * @type {ErrorCodes}
+     * @memberof ErrorSchema
+     */
+    code: ErrorCodes;
+    /**
+     * 
+     * @type {string}
+     * @memberof ErrorSchema
+     */
+    message?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the ErrorSchema interface.
+ */
+export function instanceOfErrorSchema(value: object): value is ErrorSchema {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    return true;
+}
+
+export function ErrorSchemaFromJSON(json: any): ErrorSchema {
+    return ErrorSchemaFromJSONTyped(json, false);
+}
+
+export function ErrorSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': ErrorCodesFromJSON(json['code']),
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function ErrorSchemaToJSON(json: any): ErrorSchema {
+    return ErrorSchemaToJSONTyped(json, false);
+}
+
+export function ErrorSchemaToJSONTyped(value?: ErrorSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': ErrorCodesToJSON(value['code']),
+        'message': value['message'],
+    };
+}
+

package/src/models/SubscriptionCreationMode.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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 SubscriptionCreationMode = {
+    CREATE_ON_FIRST_PAYMENT: 'CREATE_ON_FIRST_PAYMENT',
+    CREATE_NOW_WITH_PAYMENT_DUE: 'CREATE_NOW_WITH_PAYMENT_DUE',
+    unknown_default_open_api: '11184809'
+} as const;
+export type SubscriptionCreationMode = typeof SubscriptionCreationMode[keyof typeof SubscriptionCreationMode];
+
+
+export function instanceOfSubscriptionCreationMode(value: any): boolean {
+    for (const key in SubscriptionCreationMode) {
+        if (Object.prototype.hasOwnProperty.call(SubscriptionCreationMode, key)) {
+            if (SubscriptionCreationMode[key as keyof typeof SubscriptionCreationMode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SubscriptionCreationModeFromJSON(json: any): SubscriptionCreationMode {
+    return SubscriptionCreationModeFromJSONTyped(json, false);
+}
+
+export function SubscriptionCreationModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionCreationMode {
+    return json as SubscriptionCreationMode;
+}
+
+export function SubscriptionCreationModeToJSON(value?: SubscriptionCreationMode | null): any {
+    return value as any;
+}
+
+export function SubscriptionCreationModeToJSONTyped(value: any, ignoreDiscriminator: boolean): SubscriptionCreationMode {
+    return value as SubscriptionCreationMode;
+}
+

package/src/models/V1BillingStatus.ts

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Billing status of the organization. This is agnostic and complementary to the billingType
+ * @export
+ */
+export const V1BillingStatus = {
+    /**
+    * Automatic billing with active subscription
+    */
+    ACTIVE_SUBSCRIPTION: 'ACTIVE_SUBSCRIPTION',
+    /**
+    * Automatic billing without subscription. Waiting customer first payment.
+    */
+    NO_SUBSCRIPTION: 'NO_SUBSCRIPTION',
+    /**
+    * Automatic billing without unpaid invoices
+    */
+    UNPAID_SUBSCRIPTION: 'UNPAID_SUBSCRIPTION',
+    /**
+    * Automatic billing with canceled subscription
+    */
+    CANCELLED_SUBSCRIPTION: 'CANCELLED_SUBSCRIPTION',
+    /**
+    * Manual billing
+    */
+    MANUAL: 'MANUAL',
+    /**
+    * No billing
+    */
+    NONE: 'NONE',
+    unknown_default_open_api: '11184809'
+} as const;
+export type V1BillingStatus = typeof V1BillingStatus[keyof typeof V1BillingStatus];
+
+
+export function instanceOfV1BillingStatus(value: any): boolean {
+    for (const key in V1BillingStatus) {
+        if (Object.prototype.hasOwnProperty.call(V1BillingStatus, key)) {
+            if (V1BillingStatus[key as keyof typeof V1BillingStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function V1BillingStatusFromJSON(json: any): V1BillingStatus {
+    return V1BillingStatusFromJSONTyped(json, false);
+}
+
+export function V1BillingStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): V1BillingStatus {
+    return json as V1BillingStatus;
+}
+
+export function V1BillingStatusToJSON(value?: V1BillingStatus | null): any {
+    return value as any;
+}
+
+export function V1BillingStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): V1BillingStatus {
+    return value as V1BillingStatus;
+}
+

package/src/models/V1BillingType.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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 V1BillingType = {
+    NONE: 'NONE',
+    MANUAL: 'MANUAL',
+    LEGACY_CONNECT: 'LEGACY_CONNECT',
+    LEGACY_PLAN: 'LEGACY_PLAN',
+    CHARGEBEE_V1: 'CHARGEBEE_V1',
+    NON_BILLABLE: 'NON_BILLABLE',
+    unknown_default_open_api: '11184809'
+} as const;
+export type V1BillingType = typeof V1BillingType[keyof typeof V1BillingType];
+
+
+export function instanceOfV1BillingType(value: any): boolean {
+    for (const key in V1BillingType) {
+        if (Object.prototype.hasOwnProperty.call(V1BillingType, key)) {
+            if (V1BillingType[key as keyof typeof V1BillingType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function V1BillingTypeFromJSON(json: any): V1BillingType {
+    return V1BillingTypeFromJSONTyped(json, false);
+}
+
+export function V1BillingTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): V1BillingType {
+    return json as V1BillingType;
+}
+
+export function V1BillingTypeToJSON(value?: V1BillingType | null): any {
+    return value as any;
+}
+
+export function V1BillingTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): V1BillingType {
+    return value as V1BillingType;
+}
+

package/src/models/V1ChargebeeV1NotPaidInvoice.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Billing
+ * Micro-Service to handle billing
+ *
+ * The version of the OpenAPI document: 2.1.1-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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 V1ChargebeeV1NotPaidInvoice
+ */
+export interface V1ChargebeeV1NotPaidInvoice {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ChargebeeV1NotPaidInvoice
+     */
+    id: string;
+    /**
+     * Due date of the invoice
+     * @type {Date}
+     * @memberof V1ChargebeeV1NotPaidInvoice
+     */
+    dueDate?: Date | null;
+    /**
+     * The unpaid amount that is due on the invoice in dollars.
+     * @type {number}
+     * @memberof V1ChargebeeV1NotPaidInvoice
+     */
+    amountDue: number;
+}
+
+/**
+ * Check if a given object implements the V1ChargebeeV1NotPaidInvoice interface.
+ */
+export function instanceOfV1ChargebeeV1NotPaidInvoice(value: object): value is V1ChargebeeV1NotPaidInvoice {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('amountDue' in value) || value['amountDue'] === undefined) return false;
+    return true;
+}
+
+export function V1ChargebeeV1NotPaidInvoiceFromJSON(json: any): V1ChargebeeV1NotPaidInvoice {
+    return V1ChargebeeV1NotPaidInvoiceFromJSONTyped(json, false);
+}
+
+export function V1ChargebeeV1NotPaidInvoiceFromJSONTyped(json: any, ignoreDiscriminator: boolean): V1ChargebeeV1NotPaidInvoice {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'dueDate': json['dueDate'] == null ? undefined : (new Date(json['dueDate'])),
+        'amountDue': json['amountDue'],
+    };
+}
+
+export function V1ChargebeeV1NotPaidInvoiceToJSON(json: any): V1ChargebeeV1NotPaidInvoice {
+    return V1ChargebeeV1NotPaidInvoiceToJSONTyped(json, false);
+}
+
+export function V1ChargebeeV1NotPaidInvoiceToJSONTyped(value?: V1ChargebeeV1NotPaidInvoice | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'dueDate': value['dueDate'] == null ? undefined : ((value['dueDate'] as any).toISOString()),
+        'amountDue': value['amountDue'],
+    };
+}
+