@revkeen/sdk 1.20260312.41

package/BaseClient.d.ts

@@ -0,0 +1,41 @@
+import { HeaderAuthProvider } from "./auth/HeaderAuthProvider.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.RevKeenEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    fetcher?: core.FetchFunction;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & HeaderAuthProvider.AuthOptions;
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;
+//# sourceMappingURL=BaseClient.d.ts.map

package/BaseClient.js

@@ -0,0 +1,29 @@
+// This file was auto-generated by Fern from our API Definition.
+import { HeaderAuthProvider } from "./auth/HeaderAuthProvider.js";
+import { mergeHeaders } from "./core/headers.js";
+import * as core from "./core/index.js";
+export function normalizeClientOptions(options) {
+    const headers = mergeHeaders({
+        "X-Fern-Language": "JavaScript",
+        "X-Fern-Runtime": core.RUNTIME.type,
+        "X-Fern-Runtime-Version": core.RUNTIME.version,
+    }, options?.headers);
+    return {
+        ...options,
+        logging: core.logging.createLogger(options?.logging),
+        headers,
+    };
+}
+export function normalizeClientOptionsWithAuth(options) {
+    const normalized = normalizeClientOptions(options);
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    normalized.authProvider ?? (normalized.authProvider = new HeaderAuthProvider(normalizedWithNoOpAuthProvider));
+    return normalized;
+}
+function withNoOpAuthProvider(options) {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}
+//# sourceMappingURL=BaseClient.js.map

package/BaseClient.ts

@@ -0,0 +1,83 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { HeaderAuthProvider } from "./auth/HeaderAuthProvider.js";
+import { mergeHeaders } from "./core/headers.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.RevKeenEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    fetcher?: core.FetchFunction;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & HeaderAuthProvider.AuthOptions;
+
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> =
+    NormalizedClientOptions<T> & {
+        authProvider: core.AuthProvider;
+    };
+
+export function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(
+    options: T,
+): NormalizedClientOptions<T> {
+    const headers = mergeHeaders(
+        {
+            "X-Fern-Language": "JavaScript",
+            "X-Fern-Runtime": core.RUNTIME.type,
+            "X-Fern-Runtime-Version": core.RUNTIME.version,
+        },
+        options?.headers,
+    );
+
+    return {
+        ...options,
+        logging: core.logging.createLogger(options?.logging),
+        headers,
+    } as NormalizedClientOptions<T>;
+}
+
+export function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(
+    options: T,
+): NormalizedClientOptionsWithAuth<T> {
+    const normalized = normalizeClientOptions(options) as NormalizedClientOptionsWithAuth<T>;
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    normalized.authProvider ??= new HeaderAuthProvider(normalizedWithNoOpAuthProvider);
+    return normalized;
+}
+
+function withNoOpAuthProvider<T extends BaseClientOptions = BaseClientOptions>(
+    options: NormalizedClientOptions<T>,
+): NormalizedClientOptionsWithAuth<T> {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}

package/Client.d.ts

@@ -0,0 +1,123 @@
+import { AnalyticsClient } from "./api/resources/analytics/client/Client.js";
+import { AppsClient } from "./api/resources/apps/client/Client.js";
+import { BillingClient } from "./api/resources/billing/client/Client.js";
+import { BusinessesClient } from "./api/resources/businesses/client/Client.js";
+import { ChargesClient } from "./api/resources/charges/client/Client.js";
+import { CheckoutSessionsClient } from "./api/resources/checkoutSessions/client/Client.js";
+import { ClientsClient } from "./api/resources/clients/client/Client.js";
+import { CommsClient } from "./api/resources/comms/client/Client.js";
+import { CreditNotesClient } from "./api/resources/creditNotes/client/Client.js";
+import { CustomersClient } from "./api/resources/customers/client/Client.js";
+import { DiscountsClient } from "./api/resources/discounts/client/Client.js";
+import { DisputesClient } from "./api/resources/disputes/client/Client.js";
+import { EntitlementsClient } from "./api/resources/entitlements/client/Client.js";
+import { EventsClient } from "./api/resources/events/client/Client.js";
+import { FinanceClient } from "./api/resources/finance/client/Client.js";
+import { IntegrationsClient } from "./api/resources/integrations/client/Client.js";
+import { InvoicesClient } from "./api/resources/invoices/client/Client.js";
+import { OrdersClient } from "./api/resources/orders/client/Client.js";
+import { PaymentAttemptsClient } from "./api/resources/paymentAttempts/client/Client.js";
+import { PaymentIntentsClient } from "./api/resources/paymentIntents/client/Client.js";
+import { PaymentLinksClient } from "./api/resources/paymentLinks/client/Client.js";
+import { PaymentMethodsClient } from "./api/resources/paymentMethods/client/Client.js";
+import { PaymentsClient } from "./api/resources/payments/client/Client.js";
+import { PayoutsClient } from "./api/resources/payouts/client/Client.js";
+import { PricesClient } from "./api/resources/prices/client/Client.js";
+import { ProductsClient } from "./api/resources/products/client/Client.js";
+import { RefundsClient } from "./api/resources/refunds/client/Client.js";
+import { SetupIntentsClient } from "./api/resources/setupIntents/client/Client.js";
+import { SubscriptionSchedulesClient } from "./api/resources/subscriptionSchedules/client/Client.js";
+import { SubscriptionsClient } from "./api/resources/subscriptions/client/Client.js";
+import { SyncStateClient } from "./api/resources/syncState/client/Client.js";
+import { TaxRatesClient } from "./api/resources/taxRates/client/Client.js";
+import { TerminalDevicesClient } from "./api/resources/terminalDevices/client/Client.js";
+import { TerminalPaymentsClient } from "./api/resources/terminalPayments/client/Client.js";
+import { UserInvitationsClient } from "./api/resources/userInvitations/client/Client.js";
+import { VoidsClient } from "./api/resources/voids/client/Client.js";
+import { WebhookEndpointsClient } from "./api/resources/webhookEndpoints/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
+export declare namespace RevKeenClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class RevKeenClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RevKeenClient.Options>;
+    protected _invoices: InvoicesClient | undefined;
+    protected _userInvitations: UserInvitationsClient | undefined;
+    protected _products: ProductsClient | undefined;
+    protected _apps: AppsClient | undefined;
+    protected _checkoutSessions: CheckoutSessionsClient | undefined;
+    protected _businesses: BusinessesClient | undefined;
+    protected _clients: ClientsClient | undefined;
+    protected _entitlements: EntitlementsClient | undefined;
+    protected _customers: CustomersClient | undefined;
+    protected _subscriptions: SubscriptionsClient | undefined;
+    protected _comms: CommsClient | undefined;
+    protected _analytics: AnalyticsClient | undefined;
+    protected _finance: FinanceClient | undefined;
+    protected _payouts: PayoutsClient | undefined;
+    protected _refunds: RefundsClient | undefined;
+    protected _voids: VoidsClient | undefined;
+    protected _creditNotes: CreditNotesClient | undefined;
+    protected _disputes: DisputesClient | undefined;
+    protected _discounts: DiscountsClient | undefined;
+    protected _paymentLinks: PaymentLinksClient | undefined;
+    protected _paymentAttempts: PaymentAttemptsClient | undefined;
+    protected _charges: ChargesClient | undefined;
+    protected _billing: BillingClient | undefined;
+    protected _prices: PricesClient | undefined;
+    protected _taxRates: TaxRatesClient | undefined;
+    protected _orders: OrdersClient | undefined;
+    protected _payments: PaymentsClient | undefined;
+    protected _integrations: IntegrationsClient | undefined;
+    protected _syncState: SyncStateClient | undefined;
+    protected _webhookEndpoints: WebhookEndpointsClient | undefined;
+    protected _paymentIntents: PaymentIntentsClient | undefined;
+    protected _setupIntents: SetupIntentsClient | undefined;
+    protected _paymentMethods: PaymentMethodsClient | undefined;
+    protected _events: EventsClient | undefined;
+    protected _subscriptionSchedules: SubscriptionSchedulesClient | undefined;
+    protected _terminalPayments: TerminalPaymentsClient | undefined;
+    protected _terminalDevices: TerminalDevicesClient | undefined;
+    constructor(options: RevKeenClient.Options);
+    get invoices(): InvoicesClient;
+    get userInvitations(): UserInvitationsClient;
+    get products(): ProductsClient;
+    get apps(): AppsClient;
+    get checkoutSessions(): CheckoutSessionsClient;
+    get businesses(): BusinessesClient;
+    get clients(): ClientsClient;
+    get entitlements(): EntitlementsClient;
+    get customers(): CustomersClient;
+    get subscriptions(): SubscriptionsClient;
+    get comms(): CommsClient;
+    get analytics(): AnalyticsClient;
+    get finance(): FinanceClient;
+    get payouts(): PayoutsClient;
+    get refunds(): RefundsClient;
+    get voids(): VoidsClient;
+    get creditNotes(): CreditNotesClient;
+    get disputes(): DisputesClient;
+    get discounts(): DiscountsClient;
+    get paymentLinks(): PaymentLinksClient;
+    get paymentAttempts(): PaymentAttemptsClient;
+    get charges(): ChargesClient;
+    get billing(): BillingClient;
+    get prices(): PricesClient;
+    get taxRates(): TaxRatesClient;
+    get orders(): OrdersClient;
+    get payments(): PaymentsClient;
+    get integrations(): IntegrationsClient;
+    get syncState(): SyncStateClient;
+    get webhookEndpoints(): WebhookEndpointsClient;
+    get paymentIntents(): PaymentIntentsClient;
+    get setupIntents(): SetupIntentsClient;
+    get paymentMethods(): PaymentMethodsClient;
+    get events(): EventsClient;
+    get subscriptionSchedules(): SubscriptionSchedulesClient;
+    get terminalPayments(): TerminalPaymentsClient;
+    get terminalDevices(): TerminalDevicesClient;
+}
+//# sourceMappingURL=Client.d.ts.map

package/Client.js

@@ -0,0 +1,156 @@
+// This file was auto-generated by Fern from our API Definition.
+import { AnalyticsClient } from "./api/resources/analytics/client/Client.js";
+import { AppsClient } from "./api/resources/apps/client/Client.js";
+import { BillingClient } from "./api/resources/billing/client/Client.js";
+import { BusinessesClient } from "./api/resources/businesses/client/Client.js";
+import { ChargesClient } from "./api/resources/charges/client/Client.js";
+import { CheckoutSessionsClient } from "./api/resources/checkoutSessions/client/Client.js";
+import { ClientsClient } from "./api/resources/clients/client/Client.js";
+import { CommsClient } from "./api/resources/comms/client/Client.js";
+import { CreditNotesClient } from "./api/resources/creditNotes/client/Client.js";
+import { CustomersClient } from "./api/resources/customers/client/Client.js";
+import { DiscountsClient } from "./api/resources/discounts/client/Client.js";
+import { DisputesClient } from "./api/resources/disputes/client/Client.js";
+import { EntitlementsClient } from "./api/resources/entitlements/client/Client.js";
+import { EventsClient } from "./api/resources/events/client/Client.js";
+import { FinanceClient } from "./api/resources/finance/client/Client.js";
+import { IntegrationsClient } from "./api/resources/integrations/client/Client.js";
+import { InvoicesClient } from "./api/resources/invoices/client/Client.js";
+import { OrdersClient } from "./api/resources/orders/client/Client.js";
+import { PaymentAttemptsClient } from "./api/resources/paymentAttempts/client/Client.js";
+import { PaymentIntentsClient } from "./api/resources/paymentIntents/client/Client.js";
+import { PaymentLinksClient } from "./api/resources/paymentLinks/client/Client.js";
+import { PaymentMethodsClient } from "./api/resources/paymentMethods/client/Client.js";
+import { PaymentsClient } from "./api/resources/payments/client/Client.js";
+import { PayoutsClient } from "./api/resources/payouts/client/Client.js";
+import { PricesClient } from "./api/resources/prices/client/Client.js";
+import { ProductsClient } from "./api/resources/products/client/Client.js";
+import { RefundsClient } from "./api/resources/refunds/client/Client.js";
+import { SetupIntentsClient } from "./api/resources/setupIntents/client/Client.js";
+import { SubscriptionSchedulesClient } from "./api/resources/subscriptionSchedules/client/Client.js";
+import { SubscriptionsClient } from "./api/resources/subscriptions/client/Client.js";
+import { SyncStateClient } from "./api/resources/syncState/client/Client.js";
+import { TaxRatesClient } from "./api/resources/taxRates/client/Client.js";
+import { TerminalDevicesClient } from "./api/resources/terminalDevices/client/Client.js";
+import { TerminalPaymentsClient } from "./api/resources/terminalPayments/client/Client.js";
+import { UserInvitationsClient } from "./api/resources/userInvitations/client/Client.js";
+import { VoidsClient } from "./api/resources/voids/client/Client.js";
+import { WebhookEndpointsClient } from "./api/resources/webhookEndpoints/client/Client.js";
+import { normalizeClientOptionsWithAuth } from "./BaseClient.js";
+export class RevKeenClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    get invoices() {
+        return (this._invoices ?? (this._invoices = new InvoicesClient(this._options)));
+    }
+    get userInvitations() {
+        return (this._userInvitations ?? (this._userInvitations = new UserInvitationsClient(this._options)));
+    }
+    get products() {
+        return (this._products ?? (this._products = new ProductsClient(this._options)));
+    }
+    get apps() {
+        return (this._apps ?? (this._apps = new AppsClient(this._options)));
+    }
+    get checkoutSessions() {
+        return (this._checkoutSessions ?? (this._checkoutSessions = new CheckoutSessionsClient(this._options)));
+    }
+    get businesses() {
+        return (this._businesses ?? (this._businesses = new BusinessesClient(this._options)));
+    }
+    get clients() {
+        return (this._clients ?? (this._clients = new ClientsClient(this._options)));
+    }
+    get entitlements() {
+        return (this._entitlements ?? (this._entitlements = new EntitlementsClient(this._options)));
+    }
+    get customers() {
+        return (this._customers ?? (this._customers = new CustomersClient(this._options)));
+    }
+    get subscriptions() {
+        return (this._subscriptions ?? (this._subscriptions = new SubscriptionsClient(this._options)));
+    }
+    get comms() {
+        return (this._comms ?? (this._comms = new CommsClient(this._options)));
+    }
+    get analytics() {
+        return (this._analytics ?? (this._analytics = new AnalyticsClient(this._options)));
+    }
+    get finance() {
+        return (this._finance ?? (this._finance = new FinanceClient(this._options)));
+    }
+    get payouts() {
+        return (this._payouts ?? (this._payouts = new PayoutsClient(this._options)));
+    }
+    get refunds() {
+        return (this._refunds ?? (this._refunds = new RefundsClient(this._options)));
+    }
+    get voids() {
+        return (this._voids ?? (this._voids = new VoidsClient(this._options)));
+    }
+    get creditNotes() {
+        return (this._creditNotes ?? (this._creditNotes = new CreditNotesClient(this._options)));
+    }
+    get disputes() {
+        return (this._disputes ?? (this._disputes = new DisputesClient(this._options)));
+    }
+    get discounts() {
+        return (this._discounts ?? (this._discounts = new DiscountsClient(this._options)));
+    }
+    get paymentLinks() {
+        return (this._paymentLinks ?? (this._paymentLinks = new PaymentLinksClient(this._options)));
+    }
+    get paymentAttempts() {
+        return (this._paymentAttempts ?? (this._paymentAttempts = new PaymentAttemptsClient(this._options)));
+    }
+    get charges() {
+        return (this._charges ?? (this._charges = new ChargesClient(this._options)));
+    }
+    get billing() {
+        return (this._billing ?? (this._billing = new BillingClient(this._options)));
+    }
+    get prices() {
+        return (this._prices ?? (this._prices = new PricesClient(this._options)));
+    }
+    get taxRates() {
+        return (this._taxRates ?? (this._taxRates = new TaxRatesClient(this._options)));
+    }
+    get orders() {
+        return (this._orders ?? (this._orders = new OrdersClient(this._options)));
+    }
+    get payments() {
+        return (this._payments ?? (this._payments = new PaymentsClient(this._options)));
+    }
+    get integrations() {
+        return (this._integrations ?? (this._integrations = new IntegrationsClient(this._options)));
+    }
+    get syncState() {
+        return (this._syncState ?? (this._syncState = new SyncStateClient(this._options)));
+    }
+    get webhookEndpoints() {
+        return (this._webhookEndpoints ?? (this._webhookEndpoints = new WebhookEndpointsClient(this._options)));
+    }
+    get paymentIntents() {
+        return (this._paymentIntents ?? (this._paymentIntents = new PaymentIntentsClient(this._options)));
+    }
+    get setupIntents() {
+        return (this._setupIntents ?? (this._setupIntents = new SetupIntentsClient(this._options)));
+    }
+    get paymentMethods() {
+        return (this._paymentMethods ?? (this._paymentMethods = new PaymentMethodsClient(this._options)));
+    }
+    get events() {
+        return (this._events ?? (this._events = new EventsClient(this._options)));
+    }
+    get subscriptionSchedules() {
+        return (this._subscriptionSchedules ?? (this._subscriptionSchedules = new SubscriptionSchedulesClient(this._options)));
+    }
+    get terminalPayments() {
+        return (this._terminalPayments ?? (this._terminalPayments = new TerminalPaymentsClient(this._options)));
+    }
+    get terminalDevices() {
+        return (this._terminalDevices ?? (this._terminalDevices = new TerminalDevicesClient(this._options)));
+    }
+}
+//# sourceMappingURL=Client.js.map