cliodot 1.2.2 → 1.2.4

package/dist/CommercialAppClient.d.ts

@@ -0,0 +1,178 @@
+import type { CommercialAnalyticsParams, CommercialAppClientApi, CommercialAppClientConfig, CommercialChangePlanInput, CommercialConfirmPaymentInput, CommercialCheckInput, CommercialCreateCustomerInput, CommercialCreateSubscriptionInput, CommercialInitiatePaymentInput, CommercialInitiatePaymentResult, CommercialConfirmPaymentResult, CommercialPaymentMethodSummary, CommercialCheckResult, CommercialConsumeInput, CommercialConsumeResult, CommercialCustomer, CommercialFeature, CommercialLicenseIssueInput, CommercialLicenseValidateInput, CommercialListCustomersResponse, CommercialListFeaturesResponse, CommercialListParams, CommercialListPlansResponse, CommercialInvoice, CommercialListInvoicesParams, CommercialListInvoicesResponse, CommercialListSubscriptionsParams, CommercialListSubscriptionsResponse, CommercialPaginationMeta, CommercialPlan, CommercialPricingQuote, CommercialPricingQuoteInput, CommercialSeatAssignInput, CommercialStateInput, CommercialStateResult, CommercialSubscription, CommercialUpdatePendingSubscriptionInput, CommercialUpdateSubscriptionStatusInput, CommercialEntitlementTopupInput, CommercialCreditsTopupInput, CommercialChargeUsageInput, CommercialChargeUsageResult, CommercialRenewSubscriptionInput, CommercialRenewSubscriptionResult, CommercialListCreditsParams, CommercialListCreditsResponse, CommercialAddCardInput, CommercialCustomerCard, CommercialListCardsParams, CommercialListCardsResponse, CommercialListEventsParams, CommercialListEventsResponse, CommercialListUsageEventsResponse, CommercialDiscount, CommercialTaxRate, CommercialAddon, CommercialSeatAssignment, CommercialLicense } from "./types/commercial-app.api";
+export declare class CommercialAppClient implements CommercialAppClientApi {
+    private readonly baseUrl;
+    private readonly appId;
+    private readonly apiKey?;
+    private readonly appSecret?;
+    private readonly environment?;
+    private readonly axios;
+    readonly debug: boolean;
+    constructor(config: CommercialAppClientConfig);
+    check(input: CommercialCheckInput): Promise<CommercialCheckResult>;
+    consume(input: CommercialConsumeInput): Promise<CommercialConsumeResult>;
+    state(input: CommercialStateInput): Promise<CommercialStateResult>;
+    getCustomerSubscription(customerId: string, options?: {
+        include_billing?: boolean;
+    }): Promise<CommercialStateResult>;
+    listCustomers(params?: CommercialListParams): Promise<CommercialListCustomersResponse>;
+    getCustomer(customerId: string): Promise<{
+        ok: true;
+        customer: CommercialCustomer;
+    }>;
+    listCredits(customerId: string, params?: CommercialListCreditsParams): Promise<CommercialListCreditsResponse>;
+    topupCredits(input: CommercialCreditsTopupInput): Promise<{
+        ok: true;
+        invoice: CommercialInvoice;
+    }>;
+    listCards(customerId: string, params?: CommercialListCardsParams): Promise<CommercialListCardsResponse>;
+    addCard(customerId: string, input?: CommercialAddCardInput): Promise<{
+        ok: true;
+        card: CommercialCustomerCard;
+    }>;
+    updateCard(customerId: string, cardId: string, input?: CommercialAddCardInput): Promise<{
+        ok: true;
+        card: CommercialCustomerCard;
+    }>;
+    removeCard(customerId: string, cardId: string): Promise<{
+        ok: true;
+        card: CommercialCustomerCard;
+    }>;
+    setDefaultCard(customerId: string, cardId: string): Promise<{
+        ok: true;
+        card: CommercialCustomerCard;
+    }>;
+    createCustomer(input: CommercialCreateCustomerInput): Promise<{
+        ok: true;
+        customer: CommercialCustomer;
+    }>;
+    listFeatures(params?: CommercialListParams): Promise<CommercialListFeaturesResponse>;
+    getFeature(featureId: string): Promise<{
+        ok: true;
+        feature: CommercialFeature;
+    }>;
+    listPlans(params?: CommercialListParams): Promise<CommercialListPlansResponse>;
+    getPlan(planId: string): Promise<{
+        ok: true;
+        plan: CommercialPlan;
+    }>;
+    listSubscriptions(params?: CommercialListSubscriptionsParams): Promise<CommercialListSubscriptionsResponse>;
+    getSubscription(subscriptionId: string): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    listInvoices(params?: CommercialListInvoicesParams): Promise<CommercialListInvoicesResponse>;
+    getInvoice(invoiceId: string | {
+        invoiceId?: string;
+        _id?: string;
+        id?: string;
+        reference?: string;
+    }): Promise<{
+        ok: true;
+        invoice: CommercialInvoice;
+    }>;
+    createSubscription(input: CommercialCreateSubscriptionInput): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    subscribe(input: CommercialCreateSubscriptionInput): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    updatePendingSubscription(input: CommercialUpdatePendingSubscriptionInput): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    changePlan(input: CommercialChangePlanInput): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    entitlementTopup(input: CommercialEntitlementTopupInput): Promise<{
+        ok: true;
+        invoice: CommercialInvoice;
+        subscription: CommercialSubscription;
+    }>;
+    chargeUsage(input: CommercialChargeUsageInput): Promise<CommercialChargeUsageResult>;
+    renewSubscription(input: CommercialRenewSubscriptionInput): Promise<CommercialRenewSubscriptionResult>;
+    renew(input: CommercialRenewSubscriptionInput): Promise<CommercialRenewSubscriptionResult>;
+    listEvents(customerId: string, params?: CommercialListEventsParams): Promise<CommercialListEventsResponse>;
+    listUsageEvents(customerId: string, params?: CommercialListEventsParams): Promise<CommercialListUsageEventsResponse>;
+    listEventTypes(): Promise<{
+        ok: true;
+        event_types: string[];
+    }>;
+    listPaymentMethods(): Promise<{
+        ok: true;
+        payment_methods: CommercialPaymentMethodSummary[];
+    }>;
+    initiatePayment(input: CommercialInitiatePaymentInput): Promise<CommercialInitiatePaymentResult>;
+    confirmPayment(input: CommercialConfirmPaymentInput): Promise<CommercialConfirmPaymentResult>;
+    quote(input: CommercialPricingQuoteInput): Promise<{
+        ok: true;
+        quote: CommercialPricingQuote;
+    }>;
+    previewDiscount(input: {
+        code: string;
+        plan: string;
+        currency?: string;
+        customer?: string;
+    }): Promise<{
+        ok: true;
+        discount: CommercialDiscount;
+        quote: CommercialPricingQuote;
+    }>;
+    listDiscounts(params?: CommercialListParams): Promise<{
+        ok: true;
+        discounts: CommercialDiscount[];
+        pagination: CommercialPaginationMeta;
+    }>;
+    listTaxRates(params?: CommercialListParams): Promise<{
+        ok: true;
+        tax_rates: CommercialTaxRate[];
+        pagination: CommercialPaginationMeta;
+    }>;
+    listAddons(params?: CommercialListParams): Promise<{
+        ok: true;
+        addons: CommercialAddon[];
+        pagination: CommercialPaginationMeta;
+    }>;
+    updateSubscriptionStatus(input: CommercialUpdateSubscriptionStatusInput): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    archiveSubscription(subscriptionId: string): Promise<{
+        ok: true;
+        subscription: CommercialSubscription;
+    }>;
+    assignSeat(input: CommercialSeatAssignInput): Promise<{
+        ok: true;
+        assignment: CommercialSeatAssignment;
+    }>;
+    unassignSeat(input: CommercialSeatAssignInput): Promise<{
+        ok: boolean;
+    }>;
+    issueLicense(input: CommercialLicenseIssueInput): Promise<{
+        ok: true;
+        license: CommercialLicense;
+        license_key: string;
+    }>;
+    validateLicense(input: CommercialLicenseValidateInput): Promise<{
+        ok: true;
+        valid: boolean;
+        [key: string]: unknown;
+    }>;
+    revokeLicense(licenseId: string): Promise<{
+        ok: true;
+        license: CommercialLicense;
+    }>;
+    analytics(params?: CommercialAnalyticsParams): Promise<{
+        ok: true;
+        analytics: unknown;
+    }>;
+    analyticsCharts(params?: CommercialAnalyticsParams): Promise<{
+        ok: true;
+        [key: string]: unknown;
+    }>;
+    private buildAuthHeaders;
+    private request;
+}
+//# sourceMappingURL=CommercialAppClient.d.ts.map

package/dist/CommercialAppClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommercialAppClient.d.ts","sourceRoot":"","sources":["../src/CommercialAppClient.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,6BAA6B,EAC7B,oBAAoB,EACpB,6BAA6B,EAC7B,iCAAiC,EACjC,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC9B,8BAA8B,EAC9B,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,2BAA2B,EAC3B,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC9B,oBAAoB,EACpB,2BAA2B,EAC3B,iBAAiB,EACjB,4BAA4B,EAC5B,8BAA8B,EAC9B,iCAAiC,EACjC,mCAAmC,EACnC,wBAAwB,EACxB,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,yBAAyB,EACzB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,wCAAwC,EACxC,uCAAuC,EACvC,+BAA+B,EAC/B,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,EAC3B,gCAAgC,EAChC,iCAAiC,EACjC,2BAA2B,EAC3B,6BAA6B,EAC7B,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,EACzB,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,iCAAiC,EACjC,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AAmDpC,qBAAa,mBAAoB,YAAW,sBAAsB;IAChE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,SAAgB,KAAK,EAAE,OAAO,CAAC;gBAEnB,MAAM,EAAE,yBAAyB;IAqB7C,KAAK,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAalE,OAAO,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAaxE,KAAK,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAYlE,uBAAuB,CACrB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,eAAe,CAAC,EAAE,OAAO,CAAA;KAAE,GACtC,OAAO,CAAC,qBAAqB,CAAC;IAejC,aAAa,CACX,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,+BAA+B,CAAC;IAM3C,WAAW,CACT,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,QAAQ,EAAE,kBAAkB,CAAA;KAAE,CAAC;IAOtD,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,2BAA2B,GACnC,OAAO,CAAC,6BAA6B,CAAC;IAWzC,YAAY,CACV,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,CAAC;IAuBpD,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,2BAA2B,CAAC;IAWvC,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,sBAA2B,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAWtD,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAA2B,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAWtD,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAUtD,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAUtD,cAAc,CACZ,KAAK,EAAE,6BAA6B,GACnC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,QAAQ,EAAE,kBAAkB,CAAA;KAAE,CAAC;IAiBtD,YAAY,CACV,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,8BAA8B,CAAC;IAM1C,UAAU,CACR,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,CAAC;IAUpD,SAAS,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAM9E,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IAOpE,iBAAiB,CACf,MAAM,CAAC,EAAE,iCAAiC,GACzC,OAAO,CAAC,mCAAmC,CAAC;IAM/C,eAAe,CACb,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAU9D,YAAY,CACV,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,8BAA8B,CAAC;IAM1C,UAAU,CACR,SAAS,EACL,MAAM,GACN;QACE,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GACJ,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,CAAC;IAgBpD,kBAAkB,CAChB,KAAK,EAAE,iCAAiC,GACvC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IA2B9D,SAAS,CACP,KAAK,EAAE,iCAAiC,GACvC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAI9D,yBAAyB,CACvB,KAAK,EAAE,wCAAwC,GAC9C,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IA4B9D,UAAU,CACR,KAAK,EAAE,yBAAyB,GAC/B,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IA4B9D,gBAAgB,CACd,KAAK,EAAE,+BAA+B,GACrC,OAAO,CAAC;QACT,EAAE,EAAE,IAAI,CAAC;QACT,OAAO,EAAE,iBAAiB,CAAC;QAC3B,YAAY,EAAE,sBAAsB,CAAC;KACtC,CAAC;IAqBF,WAAW,CACT,KAAK,EAAE,0BAA0B,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAmBvC,iBAAiB,CACf,KAAK,EAAE,gCAAgC,GACtC,OAAO,CAAC,iCAAiC,CAAC;IAe7C,KAAK,CACH,KAAK,EAAE,gCAAgC,GACtC,OAAO,CAAC,iCAAiC,CAAC;IAI7C,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,0BAA0B,GAClC,OAAO,CAAC,4BAA4B,CAAC;IAWxC,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,0BAA0B,GAClC,OAAO,CAAC,iCAAiC,CAAC;IAW7C,cAAc,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,WAAW,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAI9D,kBAAkB,IAAI,OAAO,CAAC;QAC5B,EAAE,EAAE,IAAI,CAAC;QACT,eAAe,EAAE,8BAA8B,EAAE,CAAC;KACnD,CAAC;IAIF,eAAe,CACb,KAAK,EAAE,8BAA8B,GACpC,OAAO,CAAC,+BAA+B,CAAC;IAmB3C,cAAc,CACZ,KAAK,EAAE,6BAA6B,GACnC,OAAO,CAAC,8BAA8B,CAAC;IAe1C,KAAK,CACH,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAkBvD,eAAe,CAAC,KAAK,EAAE;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,QAAQ,EAAE,kBAAkB,CAAC;QAAC,KAAK,EAAE,sBAAsB,CAAA;KAAE,CAAC;IActF,aAAa,CACX,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,SAAS,EAAE,kBAAkB,EAAE,CAAC;QAAC,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;IAM/F,YAAY,CACV,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,SAAS,EAAE,iBAAiB,EAAE,CAAC;QAAC,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;IAM9F,UAAU,CACR,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,eAAe,EAAE,CAAC;QAAC,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;IAMzF,wBAAwB,CACtB,KAAK,EAAE,uCAAuC,GAC7C,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAW9D,mBAAmB,CACjB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,sBAAsB,CAAA;KAAE,CAAC;IAU9D,UAAU,CACR,KAAK,EAAE,yBAAyB,GAC/B,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;IAc9D,YAAY,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAC;IAcxE,YAAY,CACV,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAazE,eAAe,CACb,KAAK,EAAE,8BAA8B,GACpC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAShE,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,CAAC;IAUnF,SAAS,CACP,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,CAAC;IAM5C,eAAe,CACb,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAMhD,OAAO,CAAC,gBAAgB;YAoBV,OAAO;CAoCtB"}