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

Node.js SDK for interacting with the ParityDeals API.

import type { ParityDeals } from './client';
import { CheckEntitlementsResponse } from './models';
/**
 * Handles 'entitlements' related API operations.
 * This class is instantiated by the ParityDeals client and accessed
 * via `client.entitlements`. All methods are asynchronous.
 * These operations target the Edge API URL.
 */
export declare class EntitlementsOperations {
    private client;
    constructor(client: ParityDeals);
    /**
     * Checks if a customer has access to a specific feature.
     * @param params - Parameters for checking access.
     * - customerId: string - Customer's unique identifier.
     * - featureId: string - Feature's unique identifier.
     * @returns A Promise resolving to a boolean indicating access status.
     */
    hasAccess(params: {
        customerId: string;
        featureId: string;
    }): Promise<boolean>;
    /**
     * Retrieves detailed entitlement information for a specific feature for a customer.
     * @param params - Parameters for retrieving a specific entitlement.
     * - customerId: string - Customer's unique identifier.
     * - featureId: string - Feature's unique identifier.
     * @returns A Promise resolving to CheckEntitlementsResponse (typically containing one entitlement).
     */
    getEntitlement(params: {
        customerId: string;
        featureId: string;
    }): Promise<CheckEntitlementsResponse>;
    /**
     * Retrieves all entitlements for a given customer.
     * @param params - Parameters for retrieving all entitlements.
     * - customerId: string - Customer's unique identifier.
     * @returns A Promise resolving to CheckEntitlementsResponse.
     */
    getAllEntitlements(params: {
        customerId: string;
    }): Promise<CheckEntitlementsResponse>;
}
//# sourceMappingURL=entitlements.d.ts.map