@heymantle/core-api-client 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,2907 @@
+/**
+ * Configuration for the MantleCoreClient
+ */
+interface MantleCoreClientConfig {
+    /** Base URL for API requests. Defaults to "https://api.heymantle.com/v1" */
+    baseURL?: string;
+    /** API key for authentication (server-side only) */
+    apiKey?: string;
+    /** OAuth access token for authentication */
+    accessToken?: string;
+    /** Request timeout in milliseconds. Defaults to 30000 */
+    timeout?: number;
+}
+/**
+ * Generic paginated list response
+ */
+interface PaginatedResponse {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    total?: number;
+    cursor?: string;
+}
+/**
+ * Common list parameters for paginated endpoints
+ */
+interface ListParams {
+    /** Page number for offset pagination (0-indexed) */
+    page?: number;
+    /** Number of items per page */
+    take?: number;
+    /** Cursor for cursor-based pagination */
+    cursor?: string;
+    /** Field to sort by */
+    sort?: string;
+    /** Sort direction */
+    sortDirection?: 'asc' | 'desc';
+    /** Search query */
+    search?: string;
+    /** Minimum updated date filter (ISO 8601) */
+    minUpdatedAt?: string;
+    /** Maximum updated date filter (ISO 8601) */
+    maxUpdatedAt?: string;
+    /** Allow additional string keys */
+    [key: string]: unknown;
+}
+/**
+ * Request options for internal HTTP client
+ */
+interface RequestOptions {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    body?: string;
+    headers?: Record<string, string>;
+}
+/**
+ * Standard success response for delete operations
+ */
+interface DeleteResponse {
+    success: boolean;
+}
+
+/**
+ * Base resource class that all resources extend.
+ * Provides common HTTP methods that delegate to the client.
+ */
+declare abstract class BaseResource {
+    protected readonly client: MantleCoreClient;
+    constructor(client: MantleCoreClient);
+    protected get<T>(endpoint: string, params?: Record<string, unknown> | object): Promise<T>;
+    protected post<T>(endpoint: string, data?: Record<string, unknown> | object): Promise<T>;
+    protected put<T>(endpoint: string, data?: Record<string, unknown> | object): Promise<T>;
+    protected _delete<T>(endpoint: string): Promise<T>;
+}
+
+/**
+ * App installation on a customer
+ */
+interface AppInstallation {
+    id: string;
+    appId: string;
+    installedAt?: string;
+    uninstalledAt?: string;
+    test?: boolean;
+    active?: boolean;
+    plan?: {
+        id: string;
+        name: string;
+    };
+    subscription?: {
+        id: string;
+        status: string;
+    };
+}
+/**
+ * App installation params for creating/updating
+ */
+interface AppInstallationParams {
+    appId: string;
+    installedAt?: string;
+    test?: boolean;
+}
+/**
+ * Account owner for a customer
+ */
+interface AccountOwner {
+    id: string;
+    email: string;
+    name?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Customer entity
+ */
+interface Customer {
+    id: string;
+    name?: string;
+    email?: string;
+    domain?: string;
+    url?: string;
+    shopifyDomain?: string;
+    shopifyShopId?: string;
+    countryCode?: string;
+    preferredCurrency?: string;
+    description?: string;
+    tags: string[];
+    customFields?: Record<string, unknown>;
+    lifetimeValue?: number;
+    test?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    appInstallations?: AppInstallation[];
+    accountOwners?: AccountOwner[];
+    company?: {
+        id: string;
+        name: string;
+    };
+}
+/**
+ * Parameters for listing customers
+ */
+interface CustomerListParams extends ListParams {
+    appIds?: string[];
+    shopifyShopDomain?: string;
+    shopifyShopId?: string;
+    includeUsageMetrics?: boolean;
+    includeContactCount?: boolean;
+}
+/**
+ * Response from listing customers
+ */
+interface CustomerListResponse extends PaginatedResponse {
+    customers: Customer[];
+}
+/**
+ * Parameters for creating a customer
+ */
+interface CustomerCreateParams {
+    name?: string;
+    email?: string;
+    domain?: string;
+    url?: string;
+    shopifyDomain?: string;
+    shopifyShopId?: string;
+    tags?: string[];
+    customFields?: Record<string, unknown>;
+    companyId?: string;
+    countryCode?: string;
+    preferredCurrency?: string;
+    description?: string;
+    appInstallations?: AppInstallationParams[];
+}
+/**
+ * Parameters for updating a customer
+ */
+interface CustomerUpdateParams extends Partial<CustomerCreateParams> {
+}
+/**
+ * Parameters for retrieving a customer
+ */
+interface CustomerRetrieveParams {
+    includeContactCount?: boolean;
+    includeCurrentInvoice?: boolean;
+}
+/**
+ * Timeline event for a customer
+ */
+interface TimelineEvent {
+    id: string;
+    type: string;
+    description?: string;
+    occurredAt: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Response from listing timeline events
+ */
+interface TimelineListResponse extends PaginatedResponse {
+    events: TimelineEvent[];
+}
+/**
+ * Parameters for listing timeline events
+ */
+interface TimelineListParams {
+    appId?: string;
+    type?: string;
+    limit?: number;
+    cursor?: string;
+}
+/**
+ * Response from listing account owners
+ */
+interface AccountOwnersListResponse {
+    accountOwners: AccountOwner[];
+}
+/**
+ * Custom field definition
+ */
+interface CustomField {
+    id: string;
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'date' | 'select';
+    defaultValue?: unknown;
+    options?: string[];
+    appLevel?: boolean;
+    showOnCustomerDetail?: boolean;
+    private?: boolean;
+    filterable?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a custom field
+ */
+interface CustomFieldCreateParams {
+    appId: string;
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'date' | 'select';
+    defaultValue?: unknown;
+    options?: string[];
+    appLevel?: boolean;
+    showOnCustomerDetail?: boolean;
+    private?: boolean;
+    filterable?: boolean;
+}
+/**
+ * Parameters for updating a custom field
+ */
+interface CustomFieldUpdateParams extends Partial<Omit<CustomFieldCreateParams, 'appId'>> {
+}
+
+/**
+ * Social profile for a contact
+ */
+interface SocialProfile {
+    platform: string;
+    url: string;
+    username?: string;
+}
+/**
+ * Contact entity
+ */
+interface Contact {
+    id: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    jobTitle?: string;
+    notes?: string;
+    tags: string[];
+    socialProfiles?: SocialProfile[];
+    customers?: Array<{
+        id: string;
+        name?: string;
+    }>;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing contacts
+ */
+interface ContactListParams extends ListParams {
+}
+/**
+ * Response from listing contacts
+ */
+interface ContactListResponse extends PaginatedResponse {
+    contacts: Contact[];
+}
+/**
+ * Parameters for creating a contact
+ */
+interface ContactCreateParams {
+    name?: string;
+    email?: string;
+    phone?: string;
+    jobTitle?: string;
+    notes?: string;
+    tags?: string[];
+    customers?: string[];
+    socialProfiles?: SocialProfile[];
+}
+/**
+ * Parameters for updating a contact
+ */
+interface ContactUpdateParams extends Partial<ContactCreateParams> {
+}
+
+/**
+ * Subscription entity
+ */
+interface Subscription {
+    id: string;
+    customerId: string;
+    appId: string;
+    planId?: string;
+    status: string;
+    currentPeriodStart?: string;
+    currentPeriodEnd?: string;
+    canceledAt?: string;
+    cancelAtPeriodEnd?: boolean;
+    trialStart?: string;
+    trialEnd?: string;
+    amount?: number;
+    currencyCode?: string;
+    interval?: string;
+    test?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    plan?: {
+        id: string;
+        name: string;
+        amount: number;
+        currencyCode: string;
+        interval: string;
+    };
+    customer?: {
+        id: string;
+        name?: string;
+        email?: string;
+    };
+}
+/**
+ * Parameters for listing subscriptions
+ */
+interface SubscriptionListParams extends ListParams {
+    appId?: string;
+    customerId?: string;
+    startDate?: string;
+    endDate?: string;
+    ids?: string[];
+    active?: boolean;
+}
+/**
+ * Response from listing subscriptions
+ */
+interface SubscriptionListResponse extends PaginatedResponse {
+    subscriptions: Subscription[];
+}
+
+/**
+ * App entity
+ */
+interface App {
+    id: string;
+    name: string;
+    slug?: string;
+    platform?: string;
+    description?: string;
+    iconUrl?: string;
+    listingUrl?: string;
+    websiteUrl?: string;
+    supportEmail?: string;
+    privacyPolicyUrl?: string;
+    termsOfServiceUrl?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing apps
+ */
+interface AppListParams {
+    minUpdatedAt?: string;
+    maxUpdatedAt?: string;
+}
+/**
+ * Plan usage charge configuration
+ */
+interface PlanUsageCharge {
+    id?: string;
+    usageMetricId: string;
+    cappedAmount?: number;
+    terms?: string;
+    balanceUsed?: boolean;
+    interval?: string;
+}
+/**
+ * Plan feature configuration
+ */
+interface PlanFeature {
+    id: string;
+    featureId: string;
+    value?: unknown;
+    valueType?: string;
+}
+/**
+ * Plan entity
+ */
+interface Plan {
+    id: string;
+    appId: string;
+    name: string;
+    description?: string;
+    interval: 'month' | 'year' | 'one_time';
+    currencyCode: string;
+    amount: number;
+    trialDays?: number;
+    public?: boolean;
+    visible?: boolean;
+    archived?: boolean;
+    customerTags?: string[];
+    customerExcludeTags?: string[];
+    shopifyPlans?: string[];
+    type?: string;
+    flexBilling?: boolean;
+    flexBillingTerms?: string;
+    planUsageCharges?: PlanUsageCharge[];
+    features?: PlanFeature[];
+    customFields?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing plans
+ */
+interface PlanListParams {
+    public?: boolean;
+    page?: number;
+    perPage?: number;
+    search?: string;
+}
+/**
+ * Response from listing plans
+ */
+interface PlanListResponse {
+    plans: Plan[];
+    total: number;
+    hasMore: boolean;
+    nextCursor?: string;
+}
+/**
+ * Parameters for creating a plan
+ */
+interface PlanCreateParams {
+    name: string;
+    description?: string;
+    interval: 'month' | 'year' | 'one_time';
+    currencyCode: string;
+    amount: number;
+    trialDays?: number;
+    public?: boolean;
+    visible?: boolean;
+    customerTags?: string[];
+    customerExcludeTags?: string[];
+    shopifyPlans?: string[];
+    type?: string;
+    flexBilling?: boolean;
+    flexBillingTerms?: string;
+    planUsageCharges?: Omit<PlanUsageCharge, 'id'>[];
+    features?: Array<{
+        featureId: string;
+        value?: unknown;
+    }>;
+    customFields?: Record<string, unknown>;
+}
+/**
+ * Parameters for updating a plan
+ */
+interface PlanUpdateParams extends Partial<PlanCreateParams> {
+}
+/**
+ * Feature entity
+ */
+interface Feature {
+    id: string;
+    appId: string;
+    name: string;
+    type: 'boolean' | 'limit' | 'unlimited';
+    description?: string;
+    usageMetricId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a feature
+ */
+interface FeatureCreateParams {
+    name: string;
+    type: 'boolean' | 'limit' | 'unlimited';
+    description?: string;
+    usageMetricId?: string;
+}
+/**
+ * Parameters for updating a feature
+ */
+interface FeatureUpdateParams extends Partial<Omit<FeatureCreateParams, 'type'>> {
+}
+/**
+ * App review entity
+ */
+interface Review {
+    id: string;
+    appId: string;
+    rating: number;
+    title?: string;
+    body?: string;
+    author?: string;
+    reviewedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a review
+ */
+interface ReviewCreateParams {
+    rating: number;
+    title?: string;
+    body?: string;
+}
+/**
+ * Parameters for updating a review
+ */
+interface ReviewUpdateParams extends Partial<ReviewCreateParams> {
+}
+/**
+ * Usage metric entity
+ */
+interface UsageMetric {
+    id: string;
+    appId: string;
+    name: string;
+    description?: string;
+    eventName?: string;
+    aggregationType?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a usage metric
+ */
+interface UsageMetricCreateParams {
+    name: string;
+    description?: string;
+    eventName?: string;
+    aggregationType?: string;
+}
+/**
+ * Parameters for updating a usage metric
+ */
+interface UsageMetricUpdateParams extends Partial<UsageMetricCreateParams> {
+}
+/**
+ * App event entity
+ */
+interface AppEvent {
+    id: string;
+    appId: string;
+    customerId?: string;
+    name: string;
+    description?: string;
+    occurredAt: string;
+    properties?: Record<string, unknown>;
+    createdAt: string;
+}
+/**
+ * Parameters for listing app events
+ */
+interface AppEventListParams extends ListParams {
+    customerId?: string;
+}
+/**
+ * Response from listing app events
+ */
+interface AppEventListResponse extends PaginatedResponse {
+    appEvents: AppEvent[];
+}
+
+/**
+ * Usage event entity
+ */
+interface UsageEvent {
+    id: string;
+    appId: string;
+    customerId: string;
+    eventName: string;
+    eventId?: string;
+    timestamp: string;
+    properties?: Record<string, unknown>;
+    billingStatus?: string;
+    countryCode?: string;
+    createdAt: string;
+}
+/**
+ * Parameters for listing usage events
+ */
+interface UsageEventListParams extends ListParams {
+    appId?: string;
+    customerId?: string;
+    eventName?: string;
+    propertiesFilters?: Record<string, unknown>;
+    billingStatus?: string;
+    countryCode?: string;
+    startDate?: string;
+    endDate?: string;
+}
+/**
+ * Response from listing usage events
+ */
+interface UsageEventListResponse extends PaginatedResponse {
+    usageEvents: UsageEvent[];
+    events?: UsageEvent[];
+}
+/**
+ * Single usage event for creation
+ */
+interface UsageEventCreateData {
+    timestamp?: string;
+    eventName: string;
+    eventId?: string;
+    customerId: string;
+    appId: string;
+    properties?: Record<string, unknown>;
+}
+/**
+ * Parameters for creating usage event(s)
+ */
+interface UsageEventCreateParams {
+    /** Single event data */
+    timestamp?: string;
+    eventName?: string;
+    eventId?: string;
+    customerId?: string;
+    appId?: string;
+    properties?: Record<string, unknown>;
+    private?: boolean;
+    /** Multiple events */
+    events?: UsageEventCreateData[];
+}
+/**
+ * Response from creating usage events
+ */
+interface UsageEventCreateResponse {
+    success: boolean;
+}
+
+/**
+ * Deal entity
+ */
+interface Deal {
+    id: string;
+    name: string;
+    amount?: number;
+    amountCurrencyCode?: string;
+    currentAmount?: number;
+    acquisitionChannel?: string;
+    acquisitionSource?: string;
+    firstInteractionAt?: string;
+    closingAt?: string;
+    closedAt?: string;
+    stage?: string;
+    step?: number;
+    dealFlowId?: string;
+    dealStageId?: string;
+    customerId?: string;
+    domain?: string;
+    shopifyDomain?: string;
+    companyId?: string;
+    appId?: string;
+    planId?: string;
+    ownerIds?: string[];
+    contactIds?: string[];
+    notes?: string;
+    affiliateId?: string;
+    partnershipId?: string;
+    archived?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    customer?: {
+        id: string;
+        name?: string;
+    };
+    dealFlow?: {
+        id: string;
+        name: string;
+    };
+    dealStage?: {
+        id: string;
+        name: string;
+    };
+}
+/**
+ * Parameters for listing deals
+ */
+interface DealListParams extends ListParams {
+    customerId?: string;
+    appId?: string;
+    planId?: string;
+    dealStageId?: string;
+    dealFlowId?: string;
+    affiliateId?: string;
+    partnershipId?: string;
+    acquirerId?: string;
+    ownerId?: string;
+    contactId?: string;
+    stage?: string;
+    step?: number;
+    minAmount?: number;
+    maxAmount?: number;
+    minCurrentAmount?: number;
+    maxCurrentAmount?: number;
+    acquisitionChannel?: string;
+    acquisitionSource?: string;
+    includeArchived?: boolean;
+}
+/**
+ * Response from listing deals
+ */
+interface DealListResponse extends PaginatedResponse {
+    deals: Deal[];
+}
+/**
+ * Parameters for creating a deal
+ */
+interface DealCreateParams {
+    name: string;
+    amount?: number;
+    amountCurrencyCode?: string;
+    acquisitionChannel?: string;
+    acquisitionSource?: string;
+    firstInteractionAt?: string;
+    closingAt?: string;
+    closedAt?: string;
+    dealFlowId?: string;
+    dealStageId?: string;
+    customerId?: string;
+    domain?: string;
+    shopifyDomain?: string;
+    companyId?: string;
+    appId?: string;
+    planId?: string;
+    ownerIds?: string[];
+    contactIds?: string[];
+    notes?: string;
+    affiliateId?: string;
+    partnershipId?: string;
+}
+/**
+ * Parameters for updating a deal
+ */
+interface DealUpdateParams extends Partial<DealCreateParams> {
+}
+/**
+ * Deal flow entity
+ */
+interface DealFlow {
+    id: string;
+    name: string;
+    description?: string;
+    stages?: DealStage[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Deal stage within a flow
+ */
+interface DealStage {
+    id: string;
+    name: string;
+    order: number;
+    color?: string;
+}
+/**
+ * Parameters for creating a deal flow
+ */
+interface DealFlowCreateParams {
+    name: string;
+    description?: string;
+}
+/**
+ * Parameters for updating a deal flow
+ */
+interface DealFlowUpdateParams extends Partial<DealFlowCreateParams> {
+}
+/**
+ * Deal activity entity
+ */
+interface DealActivity {
+    id: string;
+    name: string;
+    dealFlowId: string;
+    description?: string;
+    order: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a deal activity
+ */
+interface DealActivityCreateParams {
+    name: string;
+    dealFlowId: string;
+    description?: string;
+    order?: number;
+}
+/**
+ * Parameters for updating a deal activity
+ */
+interface DealActivityUpdateParams extends Partial<Omit<DealActivityCreateParams, 'dealFlowId'>> {
+}
+
+/**
+ * Ticket entity
+ */
+interface Ticket {
+    id: string;
+    subject: string;
+    status: 'open' | 'pending' | 'resolved' | 'closed';
+    priority: 'low' | 'medium' | 'high' | 'urgent';
+    tags: string[];
+    contactId?: string;
+    customerId?: string;
+    channelId?: string;
+    appId?: string;
+    assignedToId?: string;
+    createdAt: string;
+    updatedAt: string;
+    contact?: {
+        id: string;
+        name?: string;
+        email?: string;
+    };
+    customer?: {
+        id: string;
+        name?: string;
+    };
+    assignedTo?: {
+        id: string;
+        name?: string;
+        email?: string;
+    };
+}
+/**
+ * Parameters for listing tickets
+ */
+interface TicketListParams extends ListParams {
+    status?: 'open' | 'pending' | 'resolved' | 'closed';
+    priority?: 'low' | 'medium' | 'high' | 'urgent';
+    assignedToId?: string;
+    appId?: string;
+    customerId?: string;
+    contactId?: string;
+    channelId?: string;
+    tags?: string[];
+}
+/**
+ * Response from listing tickets
+ */
+interface TicketListResponse extends PaginatedResponse {
+    tickets: Ticket[];
+}
+/**
+ * Contact data for ticket creation
+ */
+interface TicketContactData {
+    email: string;
+    name?: string;
+}
+/**
+ * Parameters for creating a ticket
+ */
+interface TicketCreateParams {
+    subject: string;
+    status?: 'open' | 'pending' | 'resolved' | 'closed';
+    priority?: 'low' | 'medium' | 'high' | 'urgent';
+    tags?: string[];
+    contactId?: string;
+    customerId?: string;
+    channelId?: string;
+    appId?: string;
+    assignedToId?: string;
+    contact?: TicketContactData;
+}
+/**
+ * Parameters for updating a ticket
+ */
+interface TicketUpdateParams {
+    subject?: string;
+    status?: 'open' | 'pending' | 'resolved' | 'closed';
+    priority?: 'low' | 'medium' | 'high' | 'urgent';
+    tags?: string[];
+    assignedToId?: string;
+}
+/**
+ * Ticket message attachment
+ */
+interface MessageAttachment {
+    id?: string;
+    filename: string;
+    url: string;
+    contentType?: string;
+    size?: number;
+}
+/**
+ * Ticket message entity
+ */
+interface TicketMessage {
+    id: string;
+    ticketId: string;
+    body: string;
+    from: 'customer' | 'agent';
+    attachments?: MessageAttachment[];
+    createdAt: string;
+    updatedAt: string;
+    author?: {
+        id: string;
+        name?: string;
+        email?: string;
+    };
+}
+/**
+ * Parameters for creating a ticket message
+ */
+interface TicketMessageCreateParams {
+    body: string;
+    from: 'customer' | 'agent';
+    attachments?: Omit<MessageAttachment, 'id'>[];
+}
+/**
+ * Parameters for updating a ticket message
+ */
+interface TicketMessageUpdateParams {
+    body?: string;
+}
+/**
+ * Channel entity (email or chat)
+ */
+interface Channel {
+    id: string;
+    type: 'email' | 'chat';
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing channels
+ */
+interface ChannelListParams {
+    type?: 'email' | 'chat';
+}
+/**
+ * Parameters for creating a channel
+ */
+interface ChannelCreateParams {
+    type: 'email' | 'chat';
+    name: string;
+}
+
+/**
+ * Affiliate entity
+ */
+interface Affiliate {
+    id: string;
+    email: string;
+    name?: string;
+    status: 'pending' | 'active' | 'rejected' | 'suspended';
+    affiliateProgramId: string;
+    appId?: string;
+    commissionRate?: number;
+    referralCode?: string;
+    referralUrl?: string;
+    paypalEmail?: string;
+    totalReferrals?: number;
+    totalCommissions?: number;
+    unpaidCommissions?: number;
+    createdAt: string;
+    updatedAt: string;
+    affiliateProgram?: {
+        id: string;
+        name: string;
+    };
+}
+/**
+ * Parameters for listing affiliates
+ */
+interface AffiliateListParams extends ListParams {
+    affiliateProgramId?: string;
+    status?: 'pending' | 'active' | 'rejected' | 'suspended';
+    appId?: string;
+    email?: string;
+}
+/**
+ * Response from listing affiliates
+ */
+interface AffiliateListResponse extends PaginatedResponse {
+    affiliates: Affiliate[];
+}
+/**
+ * Parameters for updating an affiliate
+ */
+interface AffiliateUpdateParams {
+    status?: 'pending' | 'active' | 'rejected' | 'suspended';
+    commissionRate?: number;
+}
+/**
+ * Affiliate program entity
+ */
+interface AffiliateProgram {
+    id: string;
+    name: string;
+    description?: string;
+    commissionType: 'percentage' | 'fixed';
+    commissionValue: number;
+    commissionDurationMonths?: number;
+    cookieDurationDays?: number;
+    minimumPayoutAmount?: number;
+    payoutCurrency?: string;
+    active?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating an affiliate program
+ */
+interface AffiliateProgramCreateParams {
+    name: string;
+    description?: string;
+    commissionType: 'percentage' | 'fixed';
+    commissionValue: number;
+    commissionDurationMonths?: number;
+    cookieDurationDays?: number;
+    minimumPayoutAmount?: number;
+    payoutCurrency?: string;
+    active?: boolean;
+}
+/**
+ * Parameters for updating an affiliate program
+ */
+interface AffiliateProgramUpdateParams extends Partial<AffiliateProgramCreateParams> {
+}
+/**
+ * Affiliate commission entity
+ */
+interface AffiliateCommission {
+    id: string;
+    affiliateId: string;
+    referralId?: string;
+    amount: number;
+    currencyCode: string;
+    status: 'pending' | 'approved' | 'paid' | 'rejected';
+    paidAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    affiliate?: {
+        id: string;
+        name?: string;
+        email: string;
+    };
+}
+/**
+ * Parameters for listing affiliate commissions
+ */
+interface AffiliateCommissionListParams extends ListParams {
+    affiliateId?: string;
+    status?: 'pending' | 'approved' | 'paid' | 'rejected';
+}
+/**
+ * Response from listing affiliate commissions
+ */
+interface AffiliateCommissionListResponse extends PaginatedResponse {
+    commissions: AffiliateCommission[];
+}
+/**
+ * Affiliate payout entity
+ */
+interface AffiliatePayout {
+    id: string;
+    affiliateId: string;
+    amount: number;
+    currencyCode: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    method?: string;
+    processedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    affiliate?: {
+        id: string;
+        name?: string;
+        email: string;
+    };
+}
+/**
+ * Parameters for listing affiliate payouts
+ */
+interface AffiliatePayoutListParams extends ListParams {
+    affiliateId?: string;
+    status?: 'pending' | 'processing' | 'completed' | 'failed';
+}
+/**
+ * Response from listing affiliate payouts
+ */
+interface AffiliatePayoutListResponse extends PaginatedResponse {
+    payouts: AffiliatePayout[];
+}
+/**
+ * Affiliate referral entity
+ */
+interface AffiliateReferral {
+    id: string;
+    affiliateId: string;
+    customerId?: string;
+    subscriptionId?: string;
+    status: 'pending' | 'converted' | 'expired';
+    referredAt: string;
+    convertedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    affiliate?: {
+        id: string;
+        name?: string;
+        email: string;
+    };
+    customer?: {
+        id: string;
+        name?: string;
+    };
+}
+/**
+ * Parameters for listing affiliate referrals
+ */
+interface AffiliateReferralListParams extends ListParams {
+    affiliateId?: string;
+    status?: 'pending' | 'converted' | 'expired';
+}
+/**
+ * Response from listing affiliate referrals
+ */
+interface AffiliateReferralListResponse extends PaginatedResponse {
+    referrals: AffiliateReferral[];
+}
+
+/**
+ * Available metrics for the Mantle API
+ */
+type MetricType = 'PlatformApp.activeInstalls' | 'PlatformApp.activeSubscriptions' | 'PlatformApp.arr' | 'PlatformApp.arpu' | 'PlatformApp.charges' | 'PlatformApp.logoChurn' | 'PlatformApp.ltv' | 'PlatformApp.mrr' | 'PlatformApp.netInstalls' | 'PlatformApp.netRevenue' | 'PlatformApp.netRevenueRetention' | 'PlatformApp.payout' | 'PlatformApp.predictedLtv' | 'PlatformApp.revenueChurn' | 'PlatformApp.revenueRetention' | 'PlatformApp.usageEvent' | 'PlatformApp.usageMetric';
+/**
+ * Available date ranges for metrics
+ */
+type DateRangeType = 'last_30_minutes' | 'last_60_minutes' | 'last_12_hours' | 'last_24_hours' | 'last_7_days' | 'last_14_days' | 'last_30_days' | 'last_90_days' | 'last_12_months' | 'last_24_months' | 'today' | 'yesterday' | 'last_month' | 'month_to_date' | 'quarter_to_date' | 'year_to_date' | 'all_time' | 'custom';
+/**
+ * Base parameters for metrics requests
+ */
+interface MetricsBaseParams {
+    appId: string;
+    dateRange?: DateRangeType;
+    startDate?: string;
+    endDate?: string;
+    includes?: string[];
+    appEventsForMrr?: boolean;
+}
+/**
+ * Parameters for generic metric request
+ */
+interface MetricsGetParams extends MetricsBaseParams {
+    metric: MetricType | string;
+    nf?: boolean;
+}
+/**
+ * Metric data point
+ */
+interface MetricDataPoint {
+    date?: string;
+    value?: number;
+    total?: number;
+    startingTotal?: number;
+    change?: number;
+    changePercentage?: number;
+    formattedTotal?: string;
+    formattedChange?: string;
+    formattedChangePercentage?: string;
+}
+/**
+ * Response from metrics endpoint
+ */
+interface MetricsResponse {
+    data: MetricDataPoint[];
+    total?: number;
+    startingTotal?: number;
+    change?: number;
+    changePercentage?: number;
+    formattedTotal?: string;
+    formattedChange?: string;
+    formattedChangePercentage?: string;
+}
+/**
+ * Parameters for usage event metrics
+ */
+interface UsageEventMetricsParams extends MetricsBaseParams {
+    eventName: string;
+    propertyKey?: string;
+    aggregation?: 'count' | 'sum' | 'avg' | 'min' | 'max';
+}
+/**
+ * Parameters for usage metric request
+ */
+interface UsageMetricParams extends MetricsBaseParams {
+    metricId: string;
+}
+
+/**
+ * Webhook topic types
+ */
+type WebhookTopic = 'customer.created' | 'customer.updated' | 'customer.deleted' | 'subscription.created' | 'subscription.updated' | 'subscription.canceled' | 'usage_event.created' | 'app_event.created' | 'deal.created' | 'deal.updated' | 'deal.deleted' | 'ticket.created' | 'ticket.updated';
+/**
+ * Webhook filter configuration
+ */
+interface WebhookFilter {
+    eventName?: string;
+}
+/**
+ * Webhook entity
+ */
+interface Webhook {
+    id: string;
+    topic: WebhookTopic | string;
+    address: string;
+    appIds?: string[];
+    filter?: WebhookFilter;
+    active?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Response from listing webhooks
+ */
+interface WebhookListResponse extends PaginatedResponse {
+    webhooks: Webhook[];
+}
+/**
+ * Parameters for creating a webhook
+ */
+interface WebhookCreateParams {
+    topic: WebhookTopic | string;
+    address: string;
+    appIds?: string[];
+    filter?: WebhookFilter;
+}
+/**
+ * Parameters for updating a webhook
+ */
+interface WebhookUpdateParams extends Partial<WebhookCreateParams> {
+}
+
+/**
+ * Flow status
+ */
+type FlowStatus = 'draft' | 'active' | 'paused' | 'archived';
+/**
+ * Flow entity (email/automation)
+ */
+interface Flow {
+    id: string;
+    name: string;
+    status: FlowStatus;
+    allowRepeatRuns?: boolean;
+    blockRepeatsTimeValue?: number;
+    blockRepeatsTimeUnit?: 'minutes' | 'hours' | 'days' | 'weeks';
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing flows
+ */
+interface FlowListParams extends ListParams {
+    status?: FlowStatus;
+}
+/**
+ * Response from listing flows
+ */
+interface FlowListResponse extends PaginatedResponse {
+    flows: Flow[];
+}
+/**
+ * Parameters for creating a flow
+ */
+interface FlowCreateParams {
+    name: string;
+    allowRepeatRuns?: boolean;
+    blockRepeatsTimeValue?: number;
+    blockRepeatsTimeUnit?: 'minutes' | 'hours' | 'days' | 'weeks';
+}
+/**
+ * Parameters for updating a flow
+ */
+interface FlowUpdateParams extends Partial<FlowCreateParams> {
+    status?: FlowStatus;
+}
+
+/**
+ * Doc collection entity
+ */
+interface DocCollection {
+    id: string;
+    name: string;
+    slug?: string;
+    description?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a doc collection
+ */
+interface DocCollectionCreateParams {
+    name: string;
+    slug?: string;
+    description?: string;
+}
+/**
+ * Parameters for updating a doc collection
+ */
+interface DocCollectionUpdateParams extends Partial<DocCollectionCreateParams> {
+}
+/**
+ * Doc group entity
+ */
+interface DocGroup {
+    id: string;
+    collectionId: string;
+    name: string;
+    slug?: string;
+    order?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for creating a doc group
+ */
+interface DocGroupCreateParams {
+    name: string;
+    collectionId: string;
+    slug?: string;
+    order?: number;
+}
+/**
+ * Parameters for updating a doc group
+ */
+interface DocGroupUpdateParams extends Partial<Omit<DocGroupCreateParams, 'collectionId'>> {
+}
+/**
+ * Doc page status
+ */
+type DocPageStatus = 'draft' | 'published' | 'archived';
+/**
+ * Doc page entity
+ */
+interface DocPage {
+    id: string;
+    collectionId: string;
+    groupId?: string;
+    title: string;
+    slug?: string;
+    content?: string;
+    status: DocPageStatus;
+    order?: number;
+    publishedAt?: string;
+    archivedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing doc pages
+ */
+interface DocPageListParams {
+    collectionId?: string;
+    groupId?: string;
+    status?: DocPageStatus;
+}
+/**
+ * Response from listing doc pages
+ */
+interface DocPageListResponse extends PaginatedResponse {
+    pages: DocPage[];
+}
+/**
+ * Parameters for creating a doc page
+ */
+interface DocPageCreateParams {
+    title: string;
+    collectionId: string;
+    groupId?: string;
+    slug?: string;
+    content?: string;
+    order?: number;
+}
+/**
+ * Parameters for updating a doc page
+ */
+interface DocPageUpdateParams extends Partial<Omit<DocPageCreateParams, 'collectionId'>> {
+}
+/**
+ * Doc tree node
+ */
+interface DocTreeNode {
+    id: string;
+    type: 'collection' | 'group' | 'page';
+    name: string;
+    slug?: string;
+    children?: DocTreeNode[];
+}
+/**
+ * Doc tree response
+ */
+interface DocTreeResponse {
+    tree: DocTreeNode[];
+}
+
+/**
+ * Organization entity
+ */
+interface Organization {
+    id: string;
+    name: string;
+    customerTags?: string[];
+    contactTags?: string[];
+    websiteUrl?: string;
+    supportEmail?: string;
+    socialNetworks?: Record<string, string>;
+    mantleFeatures?: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * User entity
+ */
+interface User {
+    id: string;
+    email: string;
+    name?: string;
+    role?: string;
+    avatarUrl?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing users
+ */
+interface UserListParams extends ListParams {
+}
+/**
+ * Response from listing users
+ */
+interface UserListResponse extends PaginatedResponse {
+    users: User[];
+}
+/**
+ * Response from /me endpoint
+ */
+interface MeResponse {
+    user: User;
+    organization: Organization;
+}
+/**
+ * Agent entity (support agent)
+ */
+interface Agent {
+    id: string;
+    userId: string;
+    name?: string;
+    email: string;
+    active?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Response from listing agents
+ */
+interface AgentListResponse {
+    agents: Agent[];
+}
+
+/**
+ * Task status
+ */
+type TaskStatus = 'pending' | 'in_progress' | 'completed' | 'canceled';
+/**
+ * Task priority
+ */
+type TaskPriority = 'low' | 'medium' | 'high' | 'urgent';
+/**
+ * Task entity
+ */
+interface Task {
+    id: string;
+    title: string;
+    description?: string;
+    descriptionHtml?: string;
+    priority: TaskPriority;
+    status: TaskStatus;
+    dueDate?: string;
+    assigneeId?: string;
+    customerId?: string;
+    contactId?: string;
+    dealId?: string;
+    dealActivityId?: string;
+    appInstallationId?: string;
+    tags: string[];
+    createdAt: string;
+    updatedAt: string;
+    assignee?: {
+        id: string;
+        name?: string;
+        email?: string;
+    };
+    customer?: {
+        id: string;
+        name?: string;
+    };
+    contact?: {
+        id: string;
+        name?: string;
+    };
+    deal?: {
+        id: string;
+        name?: string;
+    };
+}
+/**
+ * Parameters for listing tasks
+ */
+interface TaskListParams extends ListParams {
+    dealId?: string;
+    customerId?: string;
+    assigneeId?: string;
+    status?: TaskStatus;
+    priority?: TaskPriority;
+}
+/**
+ * Response from listing tasks
+ */
+interface TaskListResponse extends PaginatedResponse {
+    tasks: Task[];
+}
+/**
+ * Parameters for creating a task
+ */
+interface TaskCreateParams {
+    title: string;
+    description?: string;
+    descriptionHtml?: string;
+    priority?: TaskPriority;
+    status?: TaskStatus;
+    dueDate?: string;
+    assigneeId?: string;
+    customerId?: string;
+    contactId?: string;
+    dealId?: string;
+    dealActivityId?: string;
+    appInstallationId?: string;
+    tags?: string[];
+}
+/**
+ * Parameters for updating a task
+ */
+interface TaskUpdateParams extends Partial<TaskCreateParams> {
+}
+
+/**
+ * Company entity
+ */
+interface Company {
+    id: string;
+    name: string;
+    parentCustomerId?: string;
+    createdAt: string;
+    updatedAt: string;
+    parentCustomer?: {
+        id: string;
+        name?: string;
+    };
+}
+/**
+ * Parameters for listing companies
+ */
+interface CompanyListParams extends ListParams {
+}
+/**
+ * Response from listing companies
+ */
+interface CompanyListResponse extends PaginatedResponse {
+    companies: Company[];
+}
+/**
+ * Parameters for creating a company
+ */
+interface CompanyCreateParams {
+    name: string;
+    parentCustomerId?: string;
+}
+/**
+ * Parameters for updating a company
+ */
+interface CompanyUpdateParams extends Partial<CompanyCreateParams> {
+}
+
+/**
+ * Charge entity
+ */
+interface Charge {
+    id: string;
+    customerId: string;
+    appId?: string;
+    subscriptionId?: string;
+    amount: number;
+    currencyCode: string;
+    status: string;
+    type?: string;
+    description?: string;
+    billedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    customer?: {
+        id: string;
+        name?: string;
+    };
+}
+/**
+ * Parameters for listing charges
+ */
+interface ChargeListParams extends ListParams {
+    groupBy?: 'customer';
+    customerId?: string;
+    appId?: string;
+    subscriptionId?: string;
+    status?: string;
+    startDate?: string;
+    endDate?: string;
+}
+/**
+ * Response from listing charges
+ */
+interface ChargeListResponse extends PaginatedResponse {
+    charges: Charge[];
+}
+
+/**
+ * Transaction entity
+ */
+interface Transaction {
+    id: string;
+    customerId: string;
+    appId?: string;
+    subscriptionId?: string;
+    chargeId?: string;
+    amount: number;
+    currencyCode: string;
+    type: string;
+    status: string;
+    description?: string;
+    processedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    customer?: {
+        id: string;
+        name?: string;
+    };
+}
+/**
+ * Parameters for listing transactions
+ */
+interface TransactionListParams extends ListParams {
+    customerId?: string;
+    appId?: string;
+    subscriptionId?: string;
+    type?: string;
+    status?: string;
+    startDate?: string;
+    endDate?: string;
+}
+/**
+ * Response from listing transactions
+ */
+interface TransactionListResponse extends PaginatedResponse {
+    transactions: Transaction[];
+}
+
+/**
+ * Customer segment entity
+ */
+interface CustomerSegment {
+    id: string;
+    name: string;
+    description?: string;
+    filters?: Record<string, unknown>;
+    customerCount?: number;
+    public?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Parameters for listing customer segments
+ */
+interface CustomerSegmentListParams extends ListParams {
+}
+/**
+ * Response from listing customer segments
+ */
+interface CustomerSegmentListResponse extends PaginatedResponse {
+    customerSegments: CustomerSegment[];
+}
+
+/**
+ * Resource for managing customers
+ */
+declare class CustomersResource extends BaseResource {
+    /**
+     * List customers with optional filters and pagination
+     */
+    list(params?: CustomerListParams): Promise<CustomerListResponse>;
+    /**
+     * Retrieve a single customer by ID
+     */
+    retrieve(customerId: string, params?: CustomerRetrieveParams): Promise<{
+        customer: Customer;
+    }>;
+    /**
+     * Create a new customer
+     */
+    create(data: CustomerCreateParams): Promise<{
+        customer: Customer;
+    }>;
+    /**
+     * Update an existing customer
+     */
+    update(customerId: string, data: CustomerUpdateParams): Promise<{
+        customer: Customer;
+    }>;
+    /**
+     * Add tags to a customer
+     */
+    addTags(customerId: string, tags: string[]): Promise<{
+        customer: Customer;
+    }>;
+    /**
+     * Remove tags from a customer
+     */
+    removeTags(customerId: string, tags: string[]): Promise<{
+        customer: Customer;
+    }>;
+    /**
+     * Get customer activity timeline
+     */
+    getTimeline(customerId: string, params?: TimelineListParams): Promise<TimelineListResponse>;
+    /**
+     * List account owners for a customer
+     */
+    listAccountOwners(customerId: string): Promise<AccountOwnersListResponse>;
+    /**
+     * Add an account owner to a customer
+     */
+    addAccountOwner(customerId: string, data: {
+        email: string;
+        name?: string;
+    }): Promise<{
+        accountOwner: {
+            id: string;
+            email: string;
+            name?: string;
+        };
+    }>;
+    /**
+     * Remove an account owner from a customer
+     */
+    removeAccountOwner(customerId: string, ownerId: string): Promise<DeleteResponse>;
+    /**
+     * List custom fields
+     */
+    listCustomFields(params?: {
+        appId?: string;
+    }): Promise<{
+        customFields: CustomField[];
+    }>;
+    /**
+     * Create a custom field
+     */
+    createCustomField(data: CustomFieldCreateParams): Promise<{
+        customField: CustomField;
+    }>;
+    /**
+     * Retrieve a custom field by ID
+     */
+    retrieveCustomField(fieldId: string): Promise<{
+        customField: CustomField;
+    }>;
+    /**
+     * Update a custom field
+     */
+    updateCustomField(fieldId: string, data: CustomFieldUpdateParams): Promise<{
+        customField: CustomField;
+    }>;
+    /**
+     * Delete a custom field
+     */
+    deleteCustomField(fieldId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing contacts
+ */
+declare class ContactsResource extends BaseResource {
+    /**
+     * List contacts with optional filters and pagination
+     */
+    list(params?: ContactListParams): Promise<ContactListResponse>;
+    /**
+     * Retrieve a single contact by ID
+     */
+    retrieve(contactId: string): Promise<{
+        contact: Contact;
+    }>;
+    /**
+     * Create a new contact
+     */
+    create(data: ContactCreateParams): Promise<{
+        contact: Contact;
+    }>;
+    /**
+     * Update an existing contact
+     */
+    update(contactId: string, data: ContactUpdateParams): Promise<{
+        contact: Contact;
+    }>;
+    /**
+     * Delete a contact
+     */
+    del(contactId: string): Promise<DeleteResponse>;
+    /**
+     * Add tags to a contact
+     */
+    addTags(contactId: string, tags: string[]): Promise<{
+        contact: Contact;
+    }>;
+    /**
+     * Remove tags from a contact
+     */
+    removeTags(contactId: string, tags: string[]): Promise<{
+        contact: Contact;
+    }>;
+}
+
+/**
+ * Resource for managing subscriptions
+ */
+declare class SubscriptionsResource extends BaseResource {
+    /**
+     * List subscriptions with optional filters and pagination
+     */
+    list(params?: SubscriptionListParams): Promise<SubscriptionListResponse>;
+    /**
+     * Retrieve a single subscription by ID
+     */
+    retrieve(subscriptionId: string): Promise<{
+        subscription: Subscription;
+    }>;
+}
+
+/**
+ * Resource for managing usage events
+ */
+declare class UsageEventsResource extends BaseResource {
+    /**
+     * List usage events with optional filters and pagination
+     */
+    list(params?: UsageEventListParams): Promise<UsageEventListResponse>;
+    /**
+     * Create usage event(s)
+     *
+     * @example
+     * // Single event
+     * await client.usageEvents.create({
+     *   eventName: 'api_call',
+     *   customerId: 'cust_123',
+     *   appId: 'app_456',
+     *   properties: { endpoint: '/users' },
+     * });
+     *
+     * @example
+     * // Multiple events
+     * await client.usageEvents.create({
+     *   events: [
+     *     { eventName: 'api_call', customerId: 'cust_123', appId: 'app_456' },
+     *     { eventName: 'api_call', customerId: 'cust_789', appId: 'app_456' },
+     *   ],
+     * });
+     */
+    create(data: UsageEventCreateParams): Promise<UsageEventCreateResponse>;
+}
+
+/**
+ * Resource for managing apps and their related entities (plans, features, reviews, etc.)
+ */
+declare class AppsResource extends BaseResource {
+    /**
+     * List all apps
+     */
+    list(params?: AppListParams): Promise<{
+        apps: App[];
+    }>;
+    /**
+     * Retrieve a single app by ID
+     */
+    retrieve(appId: string): Promise<{
+        app: App;
+    }>;
+    /**
+     * List plans for an app
+     */
+    listPlans(appId: string, params?: PlanListParams): Promise<PlanListResponse>;
+    /**
+     * Retrieve a single plan
+     */
+    retrievePlan(appId: string, planId: string): Promise<{
+        plan: Plan;
+    }>;
+    /**
+     * Create a new plan for an app
+     */
+    createPlan(appId: string, data: PlanCreateParams): Promise<{
+        plan: Plan;
+    }>;
+    /**
+     * Update an existing plan
+     */
+    updatePlan(appId: string, planId: string, data: PlanUpdateParams): Promise<{
+        plan: Plan;
+    }>;
+    /**
+     * Archive a plan
+     */
+    archivePlan(appId: string, planId: string): Promise<{
+        plan: Plan;
+    }>;
+    /**
+     * Unarchive a plan
+     */
+    unarchivePlan(appId: string, planId: string): Promise<{
+        plan: Plan;
+    }>;
+    /**
+     * List features for an app
+     */
+    listFeatures(appId: string): Promise<{
+        features: Feature[];
+    }>;
+    /**
+     * Retrieve a single feature
+     */
+    retrieveFeature(appId: string, featureId: string): Promise<{
+        feature: Feature;
+    }>;
+    /**
+     * Create a new feature for an app
+     */
+    createFeature(appId: string, data: FeatureCreateParams): Promise<{
+        feature: Feature;
+    }>;
+    /**
+     * Update an existing feature
+     */
+    updateFeature(appId: string, featureId: string, data: FeatureUpdateParams): Promise<{
+        feature: Feature;
+    }>;
+    /**
+     * Delete a feature
+     */
+    deleteFeature(appId: string, featureId: string): Promise<DeleteResponse>;
+    /**
+     * List reviews for an app
+     */
+    listReviews(appId: string): Promise<{
+        reviews: Review[];
+    }>;
+    /**
+     * Retrieve a single review
+     */
+    retrieveReview(appId: string, reviewId: string): Promise<{
+        review: Review;
+    }>;
+    /**
+     * Create a new review for an app
+     */
+    createReview(appId: string, data: ReviewCreateParams): Promise<{
+        review: Review;
+    }>;
+    /**
+     * Update an existing review
+     */
+    updateReview(appId: string, reviewId: string, data: ReviewUpdateParams): Promise<{
+        review: Review;
+    }>;
+    /**
+     * Delete a review
+     */
+    deleteReview(appId: string, reviewId: string): Promise<DeleteResponse>;
+    /**
+     * Get usage event names for an app
+     */
+    listEventNames(appId: string): Promise<{
+        eventNames: string[];
+    }>;
+    /**
+     * Get property keys for a specific event name
+     */
+    listPropertyKeys(appId: string, eventName: string): Promise<{
+        propertyKeys: string[];
+    }>;
+    /**
+     * List usage metrics for an app
+     */
+    listUsageMetrics(appId: string): Promise<{
+        usageMetrics: UsageMetric[];
+    }>;
+    /**
+     * Retrieve a single usage metric
+     */
+    retrieveUsageMetric(appId: string, usageMetricId: string): Promise<{
+        usageMetric: UsageMetric;
+    }>;
+    /**
+     * Create a new usage metric for an app
+     */
+    createUsageMetric(appId: string, data: UsageMetricCreateParams): Promise<{
+        usageMetric: UsageMetric;
+    }>;
+    /**
+     * Update an existing usage metric
+     */
+    updateUsageMetric(appId: string, usageMetricId: string, data: UsageMetricUpdateParams): Promise<{
+        usageMetric: UsageMetric;
+    }>;
+    /**
+     * Delete a usage metric
+     */
+    deleteUsageMetric(appId: string, usageMetricId: string): Promise<DeleteResponse>;
+    /**
+     * List app events
+     */
+    listAppEvents(appId: string, params?: AppEventListParams): Promise<AppEventListResponse>;
+}
+
+/**
+ * Resource for managing deals
+ */
+declare class DealsResource extends BaseResource {
+    /**
+     * List deals with optional filters and pagination
+     */
+    list(params?: DealListParams): Promise<DealListResponse>;
+    /**
+     * Retrieve a single deal by ID
+     */
+    retrieve(dealId: string): Promise<{
+        deal: Deal;
+    }>;
+    /**
+     * Create a new deal
+     */
+    create(data: DealCreateParams): Promise<{
+        deal: Deal;
+    }>;
+    /**
+     * Update an existing deal
+     */
+    update(dealId: string, data: DealUpdateParams): Promise<{
+        deal: Deal;
+    }>;
+    /**
+     * Archive (soft delete) a deal
+     */
+    del(dealId: string): Promise<DeleteResponse>;
+    /**
+     * Get deal activity timeline
+     */
+    getTimeline(dealId: string): Promise<TimelineListResponse>;
+    /**
+     * Get deal events
+     */
+    getEvents(dealId: string): Promise<{
+        events: unknown[];
+    }>;
+}
+
+/**
+ * Resource for managing deal flows
+ */
+declare class DealFlowsResource extends BaseResource {
+    /**
+     * List all deal flows
+     */
+    list(): Promise<{
+        dealFlows: DealFlow[];
+    }>;
+    /**
+     * Retrieve a single deal flow by ID
+     */
+    retrieve(dealFlowId: string): Promise<{
+        dealFlow: DealFlow;
+    }>;
+    /**
+     * Create a new deal flow
+     */
+    create(data: DealFlowCreateParams): Promise<{
+        dealFlow: DealFlow;
+    }>;
+    /**
+     * Update an existing deal flow
+     */
+    update(dealFlowId: string, data: DealFlowUpdateParams): Promise<{
+        dealFlow: DealFlow;
+    }>;
+    /**
+     * Delete a deal flow
+     */
+    del(dealFlowId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing deal activities
+ */
+declare class DealActivitiesResource extends BaseResource {
+    /**
+     * List all deal activities
+     */
+    list(): Promise<{
+        dealActivities: DealActivity[];
+    }>;
+    /**
+     * Retrieve a single deal activity by ID
+     */
+    retrieve(dealActivityId: string): Promise<{
+        dealActivity: DealActivity;
+    }>;
+    /**
+     * Create a new deal activity
+     */
+    create(data: DealActivityCreateParams): Promise<{
+        dealActivity: DealActivity;
+    }>;
+    /**
+     * Update an existing deal activity
+     */
+    update(dealActivityId: string, data: DealActivityUpdateParams): Promise<{
+        dealActivity: DealActivity;
+    }>;
+    /**
+     * Delete a deal activity
+     */
+    del(dealActivityId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing tickets and ticket messages
+ */
+declare class TicketsResource extends BaseResource {
+    /**
+     * List tickets with optional filters and pagination
+     */
+    list(params?: TicketListParams): Promise<TicketListResponse>;
+    /**
+     * Retrieve a single ticket by ID
+     */
+    retrieve(ticketId: string): Promise<{
+        ticket: Ticket;
+    }>;
+    /**
+     * Create a new ticket
+     */
+    create(data: TicketCreateParams): Promise<{
+        ticket: Ticket;
+    }>;
+    /**
+     * Update an existing ticket
+     */
+    update(ticketId: string, data: TicketUpdateParams): Promise<{
+        ticket: Ticket;
+    }>;
+    /**
+     * Delete a ticket
+     */
+    del(ticketId: string): Promise<DeleteResponse>;
+    /**
+     * List messages for a ticket
+     */
+    listMessages(ticketId: string): Promise<{
+        messages: TicketMessage[];
+    }>;
+    /**
+     * Retrieve a single message
+     */
+    retrieveMessage(ticketId: string, messageId: string): Promise<{
+        message: TicketMessage;
+    }>;
+    /**
+     * Create a new message on a ticket
+     */
+    createMessage(ticketId: string, data: TicketMessageCreateParams): Promise<{
+        message: TicketMessage;
+    }>;
+    /**
+     * Update a message
+     */
+    updateMessage(ticketId: string, messageId: string, data: TicketMessageUpdateParams): Promise<{
+        message: TicketMessage;
+    }>;
+    /**
+     * Delete a message
+     */
+    deleteMessage(ticketId: string, messageId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing CX channels
+ */
+declare class ChannelsResource extends BaseResource {
+    /**
+     * List CX channels
+     */
+    list(params?: ChannelListParams): Promise<{
+        channels: Channel[];
+    }>;
+    /**
+     * Create a new CX channel
+     */
+    create(data: ChannelCreateParams): Promise<{
+        channel: Channel;
+    }>;
+}
+
+/**
+ * Resource for managing flows (email/automation)
+ */
+declare class FlowsResource extends BaseResource {
+    /**
+     * List flows with optional filters and pagination
+     */
+    list(params?: FlowListParams): Promise<FlowListResponse>;
+    /**
+     * Retrieve a single flow by ID
+     */
+    retrieve(flowId: string): Promise<{
+        flow: Flow;
+    }>;
+    /**
+     * Create a new flow
+     */
+    create(data: FlowCreateParams): Promise<{
+        flow: Flow;
+    }>;
+    /**
+     * Update an existing flow
+     */
+    update(flowId: string, data: FlowUpdateParams): Promise<{
+        flow: Flow;
+    }>;
+    /**
+     * Delete a flow
+     */
+    del(flowId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing tasks
+ */
+declare class TasksResource extends BaseResource {
+    /**
+     * List tasks with optional filters and pagination
+     */
+    list(params?: TaskListParams): Promise<TaskListResponse>;
+    /**
+     * Retrieve a single task by ID
+     */
+    retrieve(taskId: string): Promise<{
+        task: Task;
+    }>;
+    /**
+     * Create a new task
+     */
+    create(data: TaskCreateParams): Promise<{
+        task: Task;
+    }>;
+    /**
+     * Update an existing task
+     */
+    update(taskId: string, data: TaskUpdateParams): Promise<{
+        task: Task;
+    }>;
+    /**
+     * Delete a task
+     */
+    del(taskId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing webhooks
+ */
+declare class WebhooksResource extends BaseResource {
+    /**
+     * List all webhooks
+     */
+    list(): Promise<WebhookListResponse>;
+    /**
+     * Retrieve a single webhook by ID
+     */
+    retrieve(webhookId: string): Promise<{
+        webhook: Webhook;
+    }>;
+    /**
+     * Create a new webhook
+     */
+    create(data: WebhookCreateParams): Promise<{
+        webhook: Webhook;
+    }>;
+    /**
+     * Update an existing webhook
+     */
+    update(webhookId: string, data: WebhookUpdateParams): Promise<{
+        webhook: Webhook;
+    }>;
+    /**
+     * Delete a webhook
+     */
+    del(webhookId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing companies
+ */
+declare class CompaniesResource extends BaseResource {
+    /**
+     * List companies with optional pagination
+     */
+    list(params?: CompanyListParams): Promise<CompanyListResponse>;
+    /**
+     * Retrieve a single company by ID
+     */
+    retrieve(companyId: string): Promise<{
+        company: Company;
+    }>;
+    /**
+     * Create a new company
+     */
+    create(data: CompanyCreateParams): Promise<{
+        company: Company;
+    }>;
+    /**
+     * Update an existing company
+     */
+    update(companyId: string, data: CompanyUpdateParams): Promise<{
+        company: Company;
+    }>;
+    /**
+     * Delete a company
+     */
+    del(companyId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing customer segments
+ */
+declare class CustomerSegmentsResource extends BaseResource {
+    /**
+     * List public customer segments with optional pagination
+     */
+    list(params?: CustomerSegmentListParams): Promise<CustomerSegmentListResponse>;
+    /**
+     * Retrieve a single customer segment by ID
+     */
+    retrieve(segmentId: string): Promise<{
+        customerSegment: CustomerSegment;
+    }>;
+}
+
+/**
+ * Resource for managing affiliates
+ */
+declare class AffiliatesResource extends BaseResource {
+    /**
+     * List affiliates with optional filters and pagination
+     */
+    list(params?: AffiliateListParams): Promise<AffiliateListResponse>;
+    /**
+     * Retrieve a single affiliate by ID
+     */
+    retrieve(affiliateId: string): Promise<{
+        affiliate: Affiliate;
+    }>;
+    /**
+     * Update an existing affiliate
+     */
+    update(affiliateId: string, data: AffiliateUpdateParams): Promise<{
+        affiliate: Affiliate;
+    }>;
+}
+
+/**
+ * Resource for managing affiliate programs
+ */
+declare class AffiliateProgramsResource extends BaseResource {
+    /**
+     * List all affiliate programs
+     */
+    list(): Promise<{
+        affiliatePrograms: AffiliateProgram[];
+    }>;
+    /**
+     * Retrieve a single affiliate program by ID
+     */
+    retrieve(programId: string): Promise<{
+        affiliateProgram: AffiliateProgram;
+    }>;
+    /**
+     * Create a new affiliate program
+     */
+    create(data: AffiliateProgramCreateParams): Promise<{
+        affiliateProgram: AffiliateProgram;
+    }>;
+    /**
+     * Update an existing affiliate program
+     */
+    update(programId: string, data: AffiliateProgramUpdateParams): Promise<{
+        affiliateProgram: AffiliateProgram;
+    }>;
+    /**
+     * Delete an affiliate program
+     */
+    del(programId: string): Promise<DeleteResponse>;
+}
+
+/**
+ * Resource for managing affiliate commissions
+ */
+declare class AffiliateCommissionsResource extends BaseResource {
+    /**
+     * List affiliate commissions with optional filters and pagination
+     */
+    list(params?: AffiliateCommissionListParams): Promise<AffiliateCommissionListResponse>;
+    /**
+     * Retrieve a single affiliate commission by ID
+     */
+    retrieve(commissionId: string): Promise<{
+        commission: AffiliateCommission;
+    }>;
+}
+
+/**
+ * Resource for managing affiliate payouts
+ */
+declare class AffiliatePayoutsResource extends BaseResource {
+    /**
+     * List affiliate payouts with optional filters and pagination
+     */
+    list(params?: AffiliatePayoutListParams): Promise<AffiliatePayoutListResponse>;
+    /**
+     * Retrieve a single affiliate payout by ID
+     */
+    retrieve(payoutId: string): Promise<{
+        payout: AffiliatePayout;
+    }>;
+}
+
+/**
+ * Resource for managing affiliate referrals
+ */
+declare class AffiliateReferralsResource extends BaseResource {
+    /**
+     * List affiliate referrals with optional filters and pagination
+     */
+    list(params?: AffiliateReferralListParams): Promise<AffiliateReferralListResponse>;
+    /**
+     * Retrieve a single affiliate referral by ID
+     */
+    retrieve(referralId: string): Promise<{
+        referral: AffiliateReferral;
+    }>;
+}
+
+/**
+ * Resource for managing charges
+ */
+declare class ChargesResource extends BaseResource {
+    /**
+     * List charges with optional filters and pagination
+     */
+    list(params?: ChargeListParams): Promise<ChargeListResponse>;
+}
+
+/**
+ * Resource for managing transactions
+ */
+declare class TransactionsResource extends BaseResource {
+    /**
+     * List transactions with optional filters and pagination
+     */
+    list(params?: TransactionListParams): Promise<TransactionListResponse>;
+    /**
+     * Retrieve a single transaction by ID
+     */
+    retrieve(transactionId: string): Promise<{
+        transaction: Transaction;
+    }>;
+}
+
+/**
+ * Resource for retrieving metrics and analytics
+ */
+declare class MetricsResource extends BaseResource {
+    /**
+     * Fetch metrics with custom parameters
+     */
+    fetch(params: MetricsGetParams): Promise<MetricsResponse>;
+    /**
+     * Get Annual Recurring Revenue (ARR)
+     */
+    arr(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get Monthly Recurring Revenue (MRR)
+     */
+    mrr(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get active subscriptions count
+     */
+    activeSubscriptions(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get active installations count
+     */
+    activeInstalls(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get net new installations
+     */
+    netInstalls(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get Average Revenue Per User (ARPU)
+     */
+    arpu(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get Lifetime Value (LTV)
+     */
+    ltv(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get revenue churn rate
+     */
+    revenueChurn(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get logo (customer) churn rate
+     */
+    logoChurn(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get revenue retention rate
+     */
+    revenueRetention(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get net revenue retention rate
+     */
+    netRevenueRetention(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get net revenue
+     */
+    netRevenue(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get payout amount
+     */
+    payout(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get predicted Lifetime Value
+     */
+    predictedLtv(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get charges
+     */
+    charges(params: MetricsBaseParams & {
+        dateRange?: DateRangeType;
+    }): Promise<MetricsResponse>;
+    /**
+     * Get usage event metrics
+     */
+    usageEvent(params: UsageEventMetricsParams): Promise<MetricsResponse>;
+    /**
+     * Get usage metric data
+     */
+    usageMetric(params: UsageMetricParams): Promise<MetricsResponse>;
+}
+
+/**
+ * Resource for managing organization users
+ */
+declare class UsersResource extends BaseResource {
+    /**
+     * List organization users with optional pagination
+     */
+    list(params?: UserListParams): Promise<UserListResponse>;
+    /**
+     * Retrieve a single user by ID
+     */
+    retrieve(userId: string): Promise<{
+        user: User;
+    }>;
+}
+
+/**
+ * Resource for retrieving current user and organization info
+ */
+declare class MeResource extends BaseResource {
+    /**
+     * Get current user and organization info
+     */
+    retrieve(): Promise<MeResponse>;
+}
+
+/**
+ * Resource for retrieving organization info
+ */
+declare class OrganizationResource extends BaseResource {
+    /**
+     * Get organization details
+     */
+    retrieve(): Promise<{
+        organization: Organization;
+    }>;
+}
+
+/**
+ * Resource for managing support agents
+ */
+declare class AgentsResource extends BaseResource {
+    /**
+     * List support agents
+     */
+    list(): Promise<AgentListResponse>;
+}
+
+/**
+ * Resource for managing documentation (collections, groups, pages)
+ */
+declare class DocsResource extends BaseResource {
+    /**
+     * List all doc collections
+     */
+    listCollections(): Promise<{
+        collections: DocCollection[];
+    }>;
+    /**
+     * Retrieve a single doc collection
+     */
+    retrieveCollection(collectionId: string): Promise<{
+        collection: DocCollection;
+    }>;
+    /**
+     * Create a new doc collection
+     */
+    createCollection(data: DocCollectionCreateParams): Promise<{
+        collection: DocCollection;
+    }>;
+    /**
+     * Update a doc collection
+     */
+    updateCollection(collectionId: string, data: DocCollectionUpdateParams): Promise<{
+        collection: DocCollection;
+    }>;
+    /**
+     * Delete a doc collection
+     */
+    deleteCollection(collectionId: string): Promise<DeleteResponse>;
+    /**
+     * List all doc groups
+     */
+    listGroups(): Promise<{
+        groups: DocGroup[];
+    }>;
+    /**
+     * Retrieve a single doc group
+     */
+    retrieveGroup(groupId: string): Promise<{
+        group: DocGroup;
+    }>;
+    /**
+     * Create a new doc group
+     */
+    createGroup(data: DocGroupCreateParams): Promise<{
+        group: DocGroup;
+    }>;
+    /**
+     * Update a doc group
+     */
+    updateGroup(groupId: string, data: DocGroupUpdateParams): Promise<{
+        group: DocGroup;
+    }>;
+    /**
+     * Delete a doc group
+     */
+    deleteGroup(groupId: string): Promise<DeleteResponse>;
+    /**
+     * List doc pages with optional filters
+     */
+    listPages(params?: DocPageListParams): Promise<DocPageListResponse>;
+    /**
+     * Retrieve a single doc page
+     */
+    retrievePage(pageId: string): Promise<{
+        page: DocPage;
+    }>;
+    /**
+     * Create a new doc page
+     */
+    createPage(data: DocPageCreateParams): Promise<{
+        page: DocPage;
+    }>;
+    /**
+     * Update a doc page
+     */
+    updatePage(pageId: string, data: DocPageUpdateParams): Promise<{
+        page: DocPage;
+    }>;
+    /**
+     * Publish a doc page
+     */
+    publishPage(pageId: string): Promise<{
+        page: DocPage;
+    }>;
+    /**
+     * Archive a doc page
+     */
+    archivePage(pageId: string): Promise<{
+        page: DocPage;
+    }>;
+    /**
+     * Delete a doc page
+     */
+    deletePage(pageId: string): Promise<DeleteResponse>;
+    /**
+     * Get the full documentation tree structure
+     */
+    getTree(): Promise<DocTreeResponse>;
+}
+
+/**
+ * Mantle Core API Client
+ *
+ * A TypeScript SDK for interacting with the Mantle Core API.
+ * Provides a resource-based interface similar to the Stripe SDK.
+ *
+ * @example
+ * ```typescript
+ * const client = new MantleCoreClient({
+ *   apiKey: 'your-api-key',
+ * });
+ *
+ * // List customers
+ * const { customers } = await client.customers.list({ take: 25 });
+ *
+ * // Get a specific customer
+ * const { customer } = await client.customers.retrieve('cust_123');
+ * ```
+ */
+declare class MantleCoreClient {
+    private readonly baseURL;
+    private readonly apiKey?;
+    private readonly accessToken?;
+    private readonly timeout;
+    readonly customers: CustomersResource;
+    readonly contacts: ContactsResource;
+    readonly subscriptions: SubscriptionsResource;
+    readonly usageEvents: UsageEventsResource;
+    readonly apps: AppsResource;
+    readonly deals: DealsResource;
+    readonly dealFlows: DealFlowsResource;
+    readonly dealActivities: DealActivitiesResource;
+    readonly tickets: TicketsResource;
+    readonly channels: ChannelsResource;
+    readonly flows: FlowsResource;
+    readonly tasks: TasksResource;
+    readonly webhooks: WebhooksResource;
+    readonly companies: CompaniesResource;
+    readonly customerSegments: CustomerSegmentsResource;
+    readonly affiliates: AffiliatesResource;
+    readonly affiliatePrograms: AffiliateProgramsResource;
+    readonly affiliateCommissions: AffiliateCommissionsResource;
+    readonly affiliatePayouts: AffiliatePayoutsResource;
+    readonly affiliateReferrals: AffiliateReferralsResource;
+    readonly charges: ChargesResource;
+    readonly transactions: TransactionsResource;
+    readonly metrics: MetricsResource;
+    readonly users: UsersResource;
+    readonly me: MeResource;
+    readonly organization: OrganizationResource;
+    readonly agents: AgentsResource;
+    readonly docs: DocsResource;
+    constructor(config: MantleCoreClientConfig);
+    /**
+     * Performs a GET request to the API
+     */
+    get<T>(endpoint: string, params?: Record<string, unknown>): Promise<T>;
+    /**
+     * Performs a POST request to the API
+     */
+    post<T>(endpoint: string, data?: Record<string, unknown>): Promise<T>;
+    /**
+     * Performs a PUT request to the API
+     */
+    put<T>(endpoint: string, data?: Record<string, unknown>): Promise<T>;
+    /**
+     * Performs a DELETE request to the API
+     */
+    delete<T>(endpoint: string): Promise<T>;
+    /**
+     * Makes an HTTP request to the API
+     */
+    private makeRequest;
+    /**
+     * Gets the authorization header value
+     */
+    private getAuthHeader;
+    /**
+     * Handles error responses from the API
+     */
+    private handleErrorResponse;
+}
+
+/**
+ * Base error class for Mantle API errors
+ */
+declare class MantleAPIError extends Error {
+    readonly statusCode: number;
+    readonly details?: string;
+    constructor(message: string, statusCode: number, details?: string);
+    static fromResponse(response: {
+        error: string;
+        details?: string;
+    }, statusCode: number): MantleAPIError;
+}
+/**
+ * Authentication failed (401)
+ */
+declare class MantleAuthenticationError extends MantleAPIError {
+    constructor(message?: string);
+}
+/**
+ * Permission denied (403)
+ */
+declare class MantlePermissionError extends MantleAPIError {
+    constructor(message?: string);
+}
+/**
+ * Resource not found (404)
+ */
+declare class MantleNotFoundError extends MantleAPIError {
+    constructor(resource: string, id: string);
+}
+/**
+ * Validation error (422)
+ */
+declare class MantleValidationError extends MantleAPIError {
+    constructor(message: string, details?: string);
+}
+/**
+ * Rate limit exceeded (429)
+ */
+declare class MantleRateLimitError extends MantleAPIError {
+    readonly retryAfter?: number;
+    constructor(message?: string, retryAfter?: number);
+}
+
+export { type AccountOwner, type AccountOwnersListResponse, type Affiliate, type AffiliateCommission, type AffiliateCommissionListParams, type AffiliateCommissionListResponse, AffiliateCommissionsResource, type AffiliateListParams, type AffiliateListResponse, type AffiliatePayout, type AffiliatePayoutListParams, type AffiliatePayoutListResponse, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramCreateParams, type AffiliateProgramUpdateParams, AffiliateProgramsResource, type AffiliateReferral, type AffiliateReferralListParams, type AffiliateReferralListResponse, AffiliateReferralsResource, type AffiliateUpdateParams, AffiliatesResource, type Agent, type AgentListResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, BaseResource, type Channel, type ChannelCreateParams, type ChannelListParams, ChannelsResource, type Charge, type ChargeListParams, type ChargeListResponse, ChargesResource, CompaniesResource, type Company, type CompanyCreateParams, type CompanyListParams, type CompanyListResponse, type CompanyUpdateParams, type Contact, type ContactCreateParams, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerListResponse, type CustomerRetrieveParams, type CustomerSegment, type CustomerSegmentListParams, type CustomerSegmentListResponse, CustomerSegmentsResource, type CustomerUpdateParams, CustomersResource, type DateRangeType, type Deal, DealActivitiesResource, type DealActivity, type DealActivityCreateParams, type DealActivityUpdateParams, type DealCreateParams, type DealFlow, type DealFlowCreateParams, type DealFlowUpdateParams, DealFlowsResource, type DealListParams, type DealListResponse, type DealStage, type DealUpdateParams, DealsResource, type DeleteResponse, type DocCollection, type DocCollectionCreateParams, type DocCollectionUpdateParams, type DocGroup, type DocGroupCreateParams, type DocGroupUpdateParams, type DocPage, type DocPageCreateParams, type DocPageListParams, type DocPageListResponse, type DocPageStatus, type DocPageUpdateParams, type DocTreeNode, type DocTreeResponse, DocsResource, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type ListParams, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type MeResponse, type MessageAttachment, type MetricDataPoint, type MetricType, type MetricsBaseParams, type MetricsGetParams, MetricsResource, type MetricsResponse, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type Subscription, type SubscriptionListParams, type SubscriptionListResponse, SubscriptionsResource, type Task, type TaskCreateParams, type TaskListParams, type TaskListResponse, type TaskPriority, type TaskStatus, type TaskUpdateParams, TasksResource, type Ticket, type TicketContactData, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TicketMessage, type TicketMessageCreateParams, type TicketMessageUpdateParams, type TicketUpdateParams, TicketsResource, type TimelineEvent, type TimelineListParams, type TimelineListResponse, type Transaction, type TransactionListParams, type TransactionListResponse, TransactionsResource, type UsageEvent, type UsageEventCreateData, type UsageEventCreateParams, type UsageEventCreateResponse, type UsageEventListParams, type UsageEventListResponse, type UsageEventMetricsParams, UsageEventsResource, type UsageMetric, type UsageMetricCreateParams, type UsageMetricParams, type UsageMetricUpdateParams, type User, type UserListParams, type UserListResponse, UsersResource, type Webhook, type WebhookCreateParams, type WebhookFilter, type WebhookListResponse, type WebhookTopic, type WebhookUpdateParams, WebhooksResource };