@paritydeals/node-sdk/dist/constants.d.ts

Node.js SDK for interacting with the ParityDeals API.

/** Default base URL for the ParityDeals API. */
export declare const DEFAULT_API_URL = "https://api.paritydeals.com";
/** Default API version. */
export declare const DEFAULT_API_VERSION = "v1";
/** Fixed base path prefix for all API calls (e.g., /api). */
export declare const API_BASE_PATH_PREFIX = "/api";
/** Default timeout for API requests in milliseconds. */
export declare const DEFAULT_TIMEOUT_MS = 10000;
/** Base URL for Edge services like the Entitlements API. */
export declare const EDGE_API_URL = "https://edge.api.paritydeals.com";
export declare const SANDBOX_API_URL = "https://sandboxapi.paritydeals.com";
export declare const SANDBOX_EDGE_API_URL = "https://edge.sandboxapi.paritydeals.com";
/**
 * Behaviour choices for usage reporting.
 */
export declare const BEHAVIOUR_CHOICES: {
    readonly SET: "SET";
    readonly DELTA: "DELTA";
};
export type Behaviour = typeof BEHAVIOUR_CHOICES[keyof typeof BEHAVIOUR_CHOICES];
/**
 * Charge period choices for subscriptions and checkouts.
 */
export declare const CHARGE_PERIOD_CHOICES: {
    readonly ONE_TIME: "ONE_TIME";
    readonly MONTHLY: "MONTHLY";
    readonly YEARLY: "YEARLY";
    readonly WEEKLY: "WEEKLY";
    readonly DAILY: "DAILY";
    readonly THREE_MONTHS: "THREE_MONTHS";
    readonly SIX_MONTHS: "SIX_MONTHS";
};
export type ChargePeriod = typeof CHARGE_PERIOD_CHOICES[keyof typeof CHARGE_PERIOD_CHOICES];
/**
 * Cancellation types for subscriptions.
 */
export declare const CANCELLATION_TYPES: {
    readonly IMMEDIATE: "IMMEDIATE";
    readonly CURRENT_PERIOD_ENDS: "CURRENT_PERIOD_ENDS";
    readonly SPECIFIC_DATE: "SPECIFIC_DATE";
};
export type CancellationType = typeof CANCELLATION_TYPES[keyof typeof CANCELLATION_TYPES];
/**
 * Probation behaviour types for subscription updates.
 */
export declare const PROBATION_BEHAVIOURS: {
    readonly IMMEDIATE_CHARGE: "IMMEDIATE_CHARGE";
    readonly NEXT_BILLING_CYCLE: "NEXT_BILLING_CYCLE";
    readonly PRO_RATA: "PRO_RATA";
};
export type ProbationBehaviour = typeof PROBATION_BEHAVIOURS[keyof typeof PROBATION_BEHAVIOURS];
/** Module path prefix for reporting endpoints. */
export declare const REPORT_MODULE_PREFIX = "/report";
/** Module path prefix for checkout endpoints. */
export declare const CHECKOUT_MODULE_PREFIX = "/checkout";
/** Module path prefix for entitlements endpoints. */
export declare const ENTITLEMENTS_MODULE_PREFIX = "/entitlements";
/** Module path prefix for customer endpoints. */
export declare const CUSTOMERS_MODULE_PREFIX = "/customers";
/** Module path prefix for subscription endpoints. */
export declare const SUBSCRIPTION_MODULE_PREFIX = "/subscriptions";
//# sourceMappingURL=constants.d.ts.map