@maxio-com/self-service 1.0.2

package/typings/packages/data-access/src/DataAccess.d.ts

@@ -0,0 +1,399 @@
+import { SessionManager } from "../../session-manager/src";
+import { HttpMethod, CustomerDetails, Allocation, InvoicesParams } from './types';
+import { CustomFieldUpdate } from './types/customField';
+import { SubscriptionResumptionCharge } from './types/subscription';
+export interface DataAccessOptions {
+    baseUrl?: string;
+    sessionManager: SessionManager;
+}
+declare class DataAccess {
+    baseUrl: string;
+    sessionManager: SessionManager;
+    constructor({ baseUrl, sessionManager }: DataAccessOptions);
+    performRequest<R>(url: string, body?: Record<string, any>, method?: HttpMethod): Promise<R>;
+    getProductsCatalog(): Promise<{
+        items: {
+            id: number;
+            name: string;
+        }[];
+    }>;
+    getComponents(subscriptionId: number): Promise<{
+        items: {
+            id: number;
+            name: string;
+            type: "quantity" | "metered" | "on_off" | "prepaid";
+            allocatedQuantity?: number;
+            enabled?: boolean;
+            recurring?: boolean;
+            description: string;
+            updatesAllowed: boolean;
+            allowFractionalQuantities: boolean;
+            pricePoint: {
+                id: number;
+                type: "per_unit" | "stairstep" | "volume" | "tiered";
+                prices: {
+                    id: number;
+                    startingQuantity: number;
+                    endingQuantity: number;
+                    priceInCents: number;
+                    currency: string;
+                }[];
+                renewPrepaidAllocation?: boolean;
+                rolloverPrepaidRemainder?: boolean;
+                expirationInterval?: number;
+                expirationIntervalUnit?: "day" | "month";
+            };
+            unit: {
+                name: string;
+                balance?: number;
+                overageBalance?: number;
+            };
+        }[];
+    }>;
+    getGatewayConfig(): Promise<{
+        vaultCurrencies: {} extends infer T ? { [P in keyof T as import("type-fest").DelimiterCase<P, "_">]: {}[P]; } : never;
+        requiredFields: {
+            creditCard: string[];
+        };
+        serverHost: string;
+        publicKey: string;
+        secureToken: string;
+        defaultVaults: {};
+        threeDSecure: {
+            enabled: boolean;
+        };
+    }>;
+    createPaymentProfile(token: string): Promise<{
+        bankAccount: {
+            bankName: string;
+            maskedAccountNumber: string;
+            maskedRoutingNumber: string;
+            firstName: string;
+            lastName: string;
+        };
+        creditCard: {
+            firstName: string;
+            lastName: string;
+            cardType: string;
+            maskedNumber: string;
+            expirationMonth: number;
+            expirationYear: number;
+            expired: boolean;
+        };
+        address: {
+            address: string;
+            address2: string;
+            city: string;
+            country: string;
+            state: string;
+            zip: string;
+        };
+    }>;
+    updateSubscriptionPaymentProfile(paymentProfileId: number, subscriptionId: number): Promise<{}>;
+    resumeSubscription(subscriptionId: number): Promise<{}>;
+    getSubscriptionResumptionConfig(): Promise<{
+        resumptionCharge: SubscriptionResumptionCharge;
+    }>;
+    updateSubscriptionResumptionDate(subscriptionId: number, autoResumeDate: string): Promise<{
+        resumptionCharge: SubscriptionResumptionCharge;
+    }>;
+    getSubscriptions(): Promise<{
+        items: {
+            id: number;
+            productFamilyId: number;
+            state: string;
+            balanceInCents: number;
+            currentPeriodEndsAt: string;
+            nextAssessmentAt: string;
+            currentBillingAmountInCents: number;
+            automaticallyResumeAt: string;
+            expiresAt: string;
+            canceledAt: string;
+            scheduledCancellationAt: string;
+            currency: string;
+            billing: {
+                paymentProfileConnected: boolean;
+                bankAccount: {
+                    bankName: string;
+                    maskedAccountNumber: string;
+                    maskedRoutingNumber: string;
+                    firstName: string;
+                    lastName: string;
+                };
+                creditCard: {
+                    firstName: string;
+                    lastName: string;
+                    cardType: string;
+                    maskedNumber: string;
+                    expirationMonth: number;
+                    expirationYear: number;
+                    expired: boolean;
+                };
+                address: {
+                    address: string;
+                    address2: string;
+                    city: string;
+                    country: string;
+                    state: string;
+                    zip: string;
+                };
+            };
+            product: {
+                id: number;
+                name: string;
+                priceInCents: number;
+                interval: number;
+                intervalUnit: "day" | "month";
+                trialPriceInCents: number;
+                trialInterval: string;
+                trialIntervalUnit: string;
+            };
+            components: {
+                updatesAllowed: boolean;
+                usedInBilling: boolean;
+            };
+            customFields: {
+                updatesAllowed: boolean;
+                visible: boolean;
+            };
+        }[];
+    }>;
+    getCustomerDetails(): Promise<{
+        address: string;
+        address2: string;
+        ccEmails: string[];
+        city: string;
+        country: string;
+        email: string;
+        firstName: string;
+        lastName: string;
+        organization: string;
+        state: string;
+        vatNumber: string;
+        zip: string;
+        phoneNumber: string;
+    }>;
+    updateCustomerDetails(customerDetails: CustomerDetails): Promise<{
+        address: string;
+        address2: string;
+        ccEmails: string[];
+        city: string;
+        country: string;
+        email: string;
+        firstName: string;
+        lastName: string;
+        organization: string;
+        state: string;
+        vatNumber: string;
+        zip: string;
+        phoneNumber: string;
+    }>;
+    getCountrySubdivisions(countryCode: string): Promise<{
+        items: {
+            name: string;
+            code: string;
+        }[];
+    }>;
+    getCountries(): Promise<{
+        items: {
+            name: string;
+            code: string;
+        }[];
+    }>;
+    getInvoices(requestParams: InvoicesParams): Promise<{
+        pagination: {
+            totalItems: number;
+            totalPages: number;
+            itemsPerPage: number;
+        };
+        items: {
+            id: number;
+            number: string;
+            issueDate: string;
+            dueDate: string;
+            status: import("./types/invoicesList").InvoiceStatus;
+            totalAmountInCents: number;
+            amountDueInCents: number;
+            currency: string;
+            invoiceUrl: string;
+            consolidationLevel: import("./types/invoicesList").InvoiceConsolidationLevel;
+        }[];
+    }>;
+    getInvoiceFilters(): Promise<{
+        productNames: {
+            id: number;
+            name: string;
+        }[];
+    }>;
+    previewComponentAllocations(subscriptionId: number, body: {
+        allocations: Allocation[];
+    }): Promise<{
+        allocationsPreview: {
+            startDate: string;
+            endDate: string;
+            periodType: string;
+            totalInCents: number;
+            totalDiscountInCents: number;
+            totalTaxInCents: number;
+            subtotalInCents: number;
+            existingBalanceInCents: number;
+            accrueCharge: boolean;
+            currency: string;
+            componentsAllocations: {
+                id: number;
+                direction: "upgrade" | "downgrade";
+                transactionType: "credit" | "charge";
+                type: "quantity" | "metered" | "on_off" | "prepaid" | "event";
+                amountInCents: number;
+                taxableAmountInCents: number;
+                discountAmountInCents: number;
+                previousQuantity: number;
+                quantity: number;
+                memo: string;
+                componentHandle: string;
+            }[];
+        };
+    }>;
+    updateComponentAllocations(subscriptionId: number, body: {
+        allocations: Allocation[];
+    }): Promise<{
+        allocations: {
+            memo: string;
+            quantity: number;
+            id: number;
+        }[];
+        subscription: {
+            id: number;
+            balanceInCents: number;
+            currentBillingAmountInCents: number;
+        };
+    }>;
+    getSubscriptionCustomFields(subscriptionId: number): Promise<{
+        items: {
+            id: number;
+            name: string;
+            value: string;
+            visible: boolean;
+            fieldType: "radio" | "text" | "dropdown";
+            enum: string[];
+        }[];
+    }>;
+    getCustomerCustomFields(): Promise<{
+        items: {
+            id: number;
+            name: string;
+            value: string;
+            visible: boolean;
+            fieldType: "radio" | "text" | "dropdown";
+            enum: string[];
+        }[];
+    }>;
+    updateCustomerCustomFields(customFields: CustomFieldUpdate[]): Promise<{
+        fields: {
+            id: number;
+            value: string;
+        }[];
+    }>;
+    updateSubscriptionCustomFields(subscriptionId: number, customFields: CustomFieldUpdate[]): Promise<{
+        fields: {
+            id: number;
+            value: string;
+        }[];
+    }>;
+    pauseSubscription(subscriptionId: number, automaticallyResumeAt: Date | null): Promise<{
+        subscriptionId: number;
+        automaticallyResumeAt: string;
+        state: string;
+    }>;
+    cancelSubscription({ subscriptionId, ...rest }: {
+        subscriptionId: number;
+        cancellationMessage?: string;
+        scheduledCancellationAt?: string | null;
+        cancelAtEndOfPeriod?: boolean;
+        churnReasonCode?: string;
+    }): Promise<{
+        canceledAt?: string;
+        subscriptionId: number;
+        scheduledCancellationAt: string;
+        state: string;
+    }>;
+    getPaymentProfiles(): Promise<{
+        id: number;
+        expired?: boolean;
+        type: import("./types/paymentProfiles").PaymentProfileType;
+        requiredFields: string[];
+        vault: string;
+        bankAccount?: {
+            bankName: string;
+            maskedAccountNumber: string;
+            maskedRoutingNumber: string;
+            firstName: string;
+            lastName: string;
+        };
+        creditCard?: {
+            firstName: string;
+            lastName: string;
+            cardType: string;
+            maskedNumber: string;
+            expirationMonth: number;
+            expirationYear: number;
+            expired: boolean;
+        };
+        address?: {
+            address: string;
+            address2: string;
+            city: string;
+            country: string;
+            state: string;
+            zip: string;
+        };
+    }[]>;
+    deletePaymentProfile(paymentProfileId: number): Promise<{
+        id: number;
+        expired?: boolean;
+        type: import("./types/paymentProfiles").PaymentProfileType;
+        requiredFields: string[];
+        vault: string;
+        bankAccount?: {
+            bankName: string;
+            maskedAccountNumber: string;
+            maskedRoutingNumber: string;
+            firstName: string;
+            lastName: string;
+        };
+        creditCard?: {
+            firstName: string;
+            lastName: string;
+            cardType: string;
+            maskedNumber: string;
+            expirationMonth: number;
+            expirationYear: number;
+            expired: boolean;
+        };
+        address?: {
+            address: string;
+            address2: string;
+            city: string;
+            country: string;
+            state: string;
+            zip: string;
+        };
+    }[]>;
+    undoCancelation(subscriptionId: number): Promise<{}>;
+    getChurnReasonCodes(): Promise<{
+        items: {
+            id: number;
+            code: string;
+            description: string;
+            position: number;
+        }[];
+    }>;
+    getInvoicePDF(invoiceId: string): Promise<ArrayBuffer>;
+    reactivateSubscription(subscriptionId: number, couponCode?: string): Promise<{
+        id: number;
+        currentBillingAmountInCents: number;
+        nextAssessmentAt: string;
+        currentPeriodEndsAt: string;
+    }>;
+}
+export default DataAccess;

package/typings/packages/data-access/src/DataAccessContext.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import DataAccess from './DataAccess';
+export declare const DataAccessContext: import("react").Context<{
+    dataAccess: DataAccess;
+}>;

package/typings/packages/data-access/src/constants.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_API_URL = "http://localhost:3000/api";

package/typings/packages/data-access/src/index.d.ts

@@ -0,0 +1,5 @@
+import DataAccess from './DataAccess';
+import { DataAccessContext } from './DataAccessContext';
+import type { ProductFamily, Subscription, Division, Allocation, AllocationDetails, AllocationsPreview, AllocationsError, SubscriptionComponent, SubscriptionResumptionCharge } from './types';
+export { DataAccess, DataAccessContext };
+export type { ProductFamily, Subscription, Division, Allocation, AllocationDetails, AllocationsPreview, AllocationsError, SubscriptionResumptionCharge, SubscriptionComponent, };

package/typings/packages/data-access/src/types/address.d.ts

@@ -0,0 +1,8 @@
+export declare type Address = {
+    address: string | null;
+    address_2: string | null;
+    city: string | null;
+    country: string | null;
+    state: string | null;
+    zip: string | null;
+};

package/typings/packages/data-access/src/types/addressDetails.d.ts

@@ -0,0 +1,4 @@
+export declare type Division = {
+    name: string;
+    code: string;
+};

package/typings/packages/data-access/src/types/componentAllocation.d.ts

@@ -0,0 +1,37 @@
+import { Subscription } from './subscription';
+export declare type AllocationDetails = {
+    id: number;
+    direction: 'upgrade' | 'downgrade';
+    transaction_type: 'charge' | 'credit';
+    type: 'metered' | 'quantity' | 'on_off' | 'prepaid' | 'event';
+    amount_in_cents: number;
+    taxable_amount_in_cents: number;
+    discount_amount_in_cents: number;
+    previous_quantity: number;
+    quantity: number;
+    memo: string;
+    component_handle: string;
+};
+export declare type Allocation = Pick<AllocationDetails, 'memo' | 'quantity' | 'id'>;
+export declare type AllocationResponse = {
+    allocations: Allocation[];
+    subscription: Pick<Subscription, 'id' | 'current_billing_amount_in_cents' | 'balance_in_cents'>;
+};
+export declare type AllocationsPreview = {
+    start_date: string;
+    end_date: string;
+    period_type: string;
+    total_in_cents: number;
+    total_discount_in_cents: number;
+    total_tax_in_cents: number;
+    subtotal_in_cents: number;
+    existing_balance_in_cents: number;
+    accrue_charge: boolean;
+    currency: string;
+    components_allocations: AllocationDetails[];
+};
+export declare type AllocationsError = {
+    id: number;
+    quantity: number;
+    kind: 'allocation';
+};

package/typings/packages/data-access/src/types/customField.d.ts

@@ -0,0 +1,9 @@
+export declare type CustomField = {
+    id: number;
+    name: string;
+    value: string | null;
+    visible: boolean;
+    field_type: 'radio' | 'text' | 'dropdown';
+    enum: string[];
+};
+export declare type CustomFieldUpdate = Pick<CustomField, 'id' | 'value'>;

package/typings/packages/data-access/src/types/customerDetails.d.ts

@@ -0,0 +1,15 @@
+export declare type CustomerDetails = {
+    address: string;
+    address2: string;
+    ccEmails: string[];
+    city: string;
+    country: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    organization: string;
+    state: string;
+    vatNumber: string;
+    zip: string;
+    phoneNumber: string;
+};

package/typings/packages/data-access/src/types/gatewayConfig.d.ts

@@ -0,0 +1,13 @@
+export declare type GatewayConfig = {
+    required_fields: {
+        credit_card: string[];
+    };
+    server_host: string;
+    public_key: string | null;
+    secure_token: string | null;
+    vaultCurrencies: Record<string, string[]>;
+    defaultVaults: Record<string, string>;
+    three_d_secure: {
+        enabled: boolean;
+    };
+};

package/typings/packages/data-access/src/types/index.d.ts

@@ -0,0 +1,20 @@
+import { CamelCasedPropertiesDeep } from 'type-fest';
+import type { Subscription, SubscriptionResumptionCharge } from './subscription';
+import { SubscriptionPaymentProfile } from './subscriptionPaymentProfile';
+import { SubscriptionComponent, SubscriptionComponentPriceStep } from './subscriptionComponent';
+import type { ProductFamily } from './productFamily';
+import type { CustomerDetails } from './customerDetails';
+import { GatewayConfig } from './gatewayConfig';
+import { Division } from './addressDetails';
+import { CustomField } from './customField';
+import { Allocation, AllocationsError, AllocationsPreview, AllocationDetails } from './componentAllocation';
+import { InvoicesList, InvoicesParams } from './invoicesList';
+import { BankAccount, CreditCard } from './paymentProfiles';
+export declare type APIResponse<R> = CamelCasedPropertiesDeep<R>;
+export declare enum HttpMethod {
+    GET = "get",
+    POST = "post",
+    PUT = "put",
+    DELETE = "delete"
+}
+export type { CreditCard, BankAccount, ProductFamily, SubscriptionComponent, SubscriptionComponentPriceStep, SubscriptionResumptionCharge, Subscription, SubscriptionPaymentProfile, CustomerDetails, GatewayConfig, Division, Allocation, AllocationsError, AllocationsPreview, AllocationDetails, CustomField, InvoicesList, InvoicesParams, };

package/typings/packages/data-access/src/types/invoicesList.d.ts

@@ -0,0 +1,39 @@
+export declare type InvoicesList = {
+    pagination: {
+        totalItems: number;
+        totalPages: number;
+        itemsPerPage: number;
+    };
+    items: Invoice[];
+};
+export declare type InvoicesParams = {
+    limit: number;
+    page: number;
+    sortBy?: string;
+    sortDirection?: SortDir;
+    status?: InvoiceStatus[];
+    invoiceNumber?: string;
+    productIds?: number[];
+};
+export declare type Invoice = {
+    id: number;
+    number: string;
+    issueDate: string;
+    dueDate: string;
+    status: InvoiceStatus;
+    totalAmountInCents: number;
+    amountDueInCents: number;
+    currency: string;
+    invoiceUrl: string;
+    consolidationLevel: InvoiceConsolidationLevel;
+};
+export declare type ProductNames = {
+    product_names: ProductName[];
+};
+export declare type InvoiceStatus = 'draft' | 'open' | 'paid' | 'pending' | 'voided' | 'canceled';
+export declare type InvoiceConsolidationLevel = 'none' | 'parent' | 'child';
+export declare type SortDir = 'asc' | 'desc';
+export declare type ProductName = {
+    id: number;
+    name: string;
+};

package/typings/packages/data-access/src/types/paymentProfiles.d.ts

@@ -0,0 +1,35 @@
+export declare type PaymentProfileType = 'bank_account' | 'credit_card';
+export declare type BankAccount = {
+    bank_name: string;
+    masked_account_number: string;
+    masked_routing_number: string;
+    first_name: string;
+    last_name: string;
+};
+export declare type CreditCard = {
+    first_name: string | null;
+    last_name: string | null;
+    card_type: string;
+    masked_number: string;
+    expiration_month: number;
+    expiration_year: number;
+    expired: boolean;
+};
+export declare type PaymentProfile = {
+    id: number;
+    expired?: boolean;
+    type: PaymentProfileType;
+    requiredFields: string[];
+    vault: string;
+    bankAccount?: BankAccount;
+    creditCard?: CreditCard;
+    address?: Address;
+};
+export declare type Address = {
+    address: string | null;
+    address2: string | null;
+    city: string | null;
+    country: string | null;
+    state: string | null;
+    zip: string | null;
+};

package/typings/packages/data-access/src/types/productFamily.d.ts

@@ -0,0 +1,4 @@
+export declare type ProductFamily = {
+    id: number;
+    name: string;
+};

package/typings/packages/data-access/src/types/subscription.d.ts

@@ -0,0 +1,43 @@
+import { SubscriptionPaymentProfile } from './subscriptionPaymentProfile';
+export declare type Subscription = {
+    id: number;
+    product_family_id: number;
+    state: string;
+    balance_in_cents: number;
+    current_period_ends_at: string | null;
+    next_assessment_at: string | null;
+    current_billing_amount_in_cents: number;
+    automatically_resume_at: string | null;
+    expires_at: string | null;
+    canceled_at: string | null;
+    scheduled_cancellation_at: string | null;
+    currency: string;
+    billing: {
+        payment_profile_connected: boolean;
+    } & SubscriptionPaymentProfile;
+    product: {
+        id: number;
+        name: string;
+        price_in_cents: number;
+        interval: number;
+        interval_unit: 'day' | 'month';
+        trial_price_in_cents: number | null;
+        trial_interval: string | null;
+        trial_interval_unit: string | null;
+    };
+    components: {
+        updates_allowed: boolean;
+        used_in_billing: boolean;
+    };
+    custom_fields: {
+        updates_allowed: boolean;
+        visible: boolean;
+    };
+};
+export declare type SubscriptionResumptionCharge = 'prorated' | 'immediate' | 'delayed';
+export declare type ChurnReason = {
+    id: number;
+    code: string;
+    description: string;
+    position: number;
+};

package/typings/packages/data-access/src/types/subscriptionComponent.d.ts

@@ -0,0 +1,32 @@
+export declare type SubscriptionComponentPriceStep = {
+    id: number;
+    starting_quantity: number;
+    ending_quantity: number;
+    price_in_cents: number;
+    currency: string;
+};
+export declare type SubscriptionComponent = {
+    id: number;
+    name: string;
+    type: 'metered' | 'quantity' | 'on_off' | 'prepaid';
+    allocated_quantity?: number;
+    enabled?: boolean;
+    recurring?: boolean;
+    description: string;
+    updates_allowed: boolean;
+    allow_fractional_quantities: boolean;
+    price_point: {
+        id: null | number;
+        type: 'per_unit' | 'stairstep' | 'volume' | 'tiered' | null;
+        prices: SubscriptionComponentPriceStep[];
+        renew_prepaid_allocation?: boolean;
+        rollover_prepaid_remainder?: boolean;
+        expiration_interval?: number;
+        expiration_interval_unit?: 'day' | 'month';
+    };
+    unit: {
+        name: string;
+        balance?: number;
+        overage_balance?: number;
+    };
+};