@heymantle/core-api-client 0.1.9 → 0.1.11

package/dist/index.d.mts

@@ -1798,6 +1798,19 @@ interface Agent {
 interface AgentListResponse {
     agents: Agent[];
 }
+/**
+ * Parameters for creating an agent
+ */
+interface AgentCreateParams {
+    email: string;
+    name?: string;
+}
+/**
+ * Response from creating/retrieving an agent
+ */
+interface AgentResponse {
+    agent: Agent;
+}
 
 /**
  * Task status
@@ -2063,6 +2076,45 @@ interface EntitiesSearchResponse {
     entities: Entity[];
 }
 
+/**
+ * Resource type for custom data
+ */
+type CustomDataResourceType = 'ticket' | 'customer' | 'contact';
+/**
+ * Parameters for setting custom data
+ */
+interface CustomDataSetParams {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+    value: string;
+}
+/**
+ * Parameters for getting custom data
+ */
+interface CustomDataGetParams {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+}
+/**
+ * Response from getting custom data
+ */
+interface CustomDataResponse {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+    value: string;
+}
+/**
+ * Parameters for deleting custom data
+ */
+interface CustomDataDeleteParams {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+}
+
 /**
  * Resource for managing customers
  */
@@ -3098,6 +3150,23 @@ declare class AgentsResource extends BaseResource {
      * List support agents
      */
     list(): Promise<AgentListResponse>;
+    /**
+     * Retrieve a specific agent by ID
+     */
+    retrieve(agentId: string): Promise<AgentResponse>;
+    /**
+     * Create a new agent
+     */
+    create(params: AgentCreateParams): Promise<AgentResponse>;
+    /**
+     * Find an existing agent by email, or create one if not found.
+     * This is useful for sync operations where you want to ensure
+     * an agent exists without duplicating.
+     *
+     * @param params - Agent data (email required, name optional)
+     * @returns The existing or newly created agent
+     */
+    findOrCreate(params: AgentCreateParams): Promise<AgentResponse>;
 }
 
 /**
@@ -3215,6 +3284,33 @@ declare class EntitiesResource extends BaseResource {
     search(params?: EntitiesSearchParams): Promise<EntitiesSearchResponse>;
 }
 
+/**
+ * Resource for managing custom data on entities.
+ * Custom data allows storing arbitrary key-value pairs on tickets, customers, and contacts.
+ */
+declare class CustomDataResource extends BaseResource {
+    /**
+     * Set custom data on a resource.
+     * This will create or update the value for the given key.
+     *
+     * @param params - The custom data parameters
+     */
+    set(params: CustomDataSetParams): Promise<void>;
+    /**
+     * Get custom data from a resource.
+     *
+     * @param params - Parameters identifying the custom data to retrieve
+     * @returns The custom data value
+     */
+    getValue(params: CustomDataGetParams): Promise<CustomDataResponse>;
+    /**
+     * Delete custom data from a resource.
+     *
+     * @param params - Parameters identifying the custom data to delete
+     */
+    del(params: CustomDataDeleteParams): Promise<void>;
+}
+
 /**
  * Mantle Core API Client
  *
@@ -3269,6 +3365,7 @@ declare class MantleCoreClient {
     readonly agents: AgentsResource;
     readonly docs: DocsResource;
     readonly entities: EntitiesResource;
+    readonly customData: CustomDataResource;
     constructor(config: MantleCoreClientConfig);
     /**
      * Register a middleware function
@@ -3474,4 +3571,87 @@ interface AuthRefreshOptions {
  */
 declare function createAuthRefreshMiddleware(options: AuthRefreshOptions): Middleware;
 
-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, type AuthRefreshOptions, 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 ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, 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 DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, 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, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, 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 Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, 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 SocialProfileType, 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, createAuthRefreshMiddleware };
+/**
+ * Options for the rate limit middleware
+ */
+interface RateLimitOptions {
+    /**
+     * Enable automatic retry on 429 responses
+     * @default false
+     */
+    enableRetry?: boolean;
+    /**
+     * Enable preemptive throttling to avoid hitting rate limits
+     * @default false
+     */
+    enableThrottle?: boolean;
+    /**
+     * Maximum number of retry attempts
+     * @default 3
+     */
+    maxRetries?: number;
+    /**
+     * Base delay in milliseconds for retries when no retryAfter is provided
+     * @default 1000
+     */
+    baseDelay?: number;
+    /**
+     * Use exponential backoff for retries
+     * @default true
+     */
+    exponentialBackoff?: boolean;
+    /**
+     * Add random jitter to retry delays to prevent thundering herd
+     * @default true
+     */
+    jitter?: boolean;
+    /**
+     * Maximum requests per minute (primary limit)
+     * @default 1000
+     */
+    requestsPerMinute?: number;
+    /**
+     * Maximum requests per burst window
+     * @default 5000
+     */
+    burstLimit?: number;
+    /**
+     * Burst window in milliseconds
+     * @default 300000 (5 minutes)
+     */
+    burstWindowMs?: number;
+    /**
+     * Start throttling when usage reaches this percentage of the limit (0-1)
+     * @default 0.9
+     */
+    throttleThreshold?: number;
+}
+/**
+ * Creates a middleware that handles rate limiting with optional retry and throttling
+ *
+ * @example
+ * ```typescript
+ * const client = new MantleCoreClient({ ... });
+ *
+ * // Enable retry on 429 responses
+ * client.use(createRateLimitMiddleware({
+ *   enableRetry: true,
+ * }));
+ *
+ * // Enable preemptive throttling
+ * client.use(createRateLimitMiddleware({
+ *   enableThrottle: true,
+ * }));
+ *
+ * // Enable both features
+ * client.use(createRateLimitMiddleware({
+ *   enableRetry: true,
+ *   enableThrottle: true,
+ *   maxRetries: 5,
+ *   requestsPerMinute: 500,
+ * }));
+ * ```
+ */
+declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
+
+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 AgentCreateParams, type AgentListResponse, type AgentResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, type AuthRefreshOptions, 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 ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomDataDeleteParams, type CustomDataGetParams, CustomDataResource, type CustomDataResourceType, type CustomDataResponse, type CustomDataSetParams, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, 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 DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, 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, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, 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 Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RateLimitOptions, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type SocialProfileType, 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, createAuthRefreshMiddleware, createRateLimitMiddleware };

package/dist/index.d.ts

@@ -1798,6 +1798,19 @@ interface Agent {
 interface AgentListResponse {
     agents: Agent[];
 }
+/**
+ * Parameters for creating an agent
+ */
+interface AgentCreateParams {
+    email: string;
+    name?: string;
+}
+/**
+ * Response from creating/retrieving an agent
+ */
+interface AgentResponse {
+    agent: Agent;
+}
 
 /**
  * Task status
@@ -2063,6 +2076,45 @@ interface EntitiesSearchResponse {
     entities: Entity[];
 }
 
+/**
+ * Resource type for custom data
+ */
+type CustomDataResourceType = 'ticket' | 'customer' | 'contact';
+/**
+ * Parameters for setting custom data
+ */
+interface CustomDataSetParams {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+    value: string;
+}
+/**
+ * Parameters for getting custom data
+ */
+interface CustomDataGetParams {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+}
+/**
+ * Response from getting custom data
+ */
+interface CustomDataResponse {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+    value: string;
+}
+/**
+ * Parameters for deleting custom data
+ */
+interface CustomDataDeleteParams {
+    resourceId: string;
+    resourceType: CustomDataResourceType;
+    key: string;
+}
+
 /**
  * Resource for managing customers
  */
@@ -3098,6 +3150,23 @@ declare class AgentsResource extends BaseResource {
      * List support agents
      */
     list(): Promise<AgentListResponse>;
+    /**
+     * Retrieve a specific agent by ID
+     */
+    retrieve(agentId: string): Promise<AgentResponse>;
+    /**
+     * Create a new agent
+     */
+    create(params: AgentCreateParams): Promise<AgentResponse>;
+    /**
+     * Find an existing agent by email, or create one if not found.
+     * This is useful for sync operations where you want to ensure
+     * an agent exists without duplicating.
+     *
+     * @param params - Agent data (email required, name optional)
+     * @returns The existing or newly created agent
+     */
+    findOrCreate(params: AgentCreateParams): Promise<AgentResponse>;
 }
 
 /**
@@ -3215,6 +3284,33 @@ declare class EntitiesResource extends BaseResource {
     search(params?: EntitiesSearchParams): Promise<EntitiesSearchResponse>;
 }
 
+/**
+ * Resource for managing custom data on entities.
+ * Custom data allows storing arbitrary key-value pairs on tickets, customers, and contacts.
+ */
+declare class CustomDataResource extends BaseResource {
+    /**
+     * Set custom data on a resource.
+     * This will create or update the value for the given key.
+     *
+     * @param params - The custom data parameters
+     */
+    set(params: CustomDataSetParams): Promise<void>;
+    /**
+     * Get custom data from a resource.
+     *
+     * @param params - Parameters identifying the custom data to retrieve
+     * @returns The custom data value
+     */
+    getValue(params: CustomDataGetParams): Promise<CustomDataResponse>;
+    /**
+     * Delete custom data from a resource.
+     *
+     * @param params - Parameters identifying the custom data to delete
+     */
+    del(params: CustomDataDeleteParams): Promise<void>;
+}
+
 /**
  * Mantle Core API Client
  *
@@ -3269,6 +3365,7 @@ declare class MantleCoreClient {
     readonly agents: AgentsResource;
     readonly docs: DocsResource;
     readonly entities: EntitiesResource;
+    readonly customData: CustomDataResource;
     constructor(config: MantleCoreClientConfig);
     /**
      * Register a middleware function
@@ -3474,4 +3571,87 @@ interface AuthRefreshOptions {
  */
 declare function createAuthRefreshMiddleware(options: AuthRefreshOptions): Middleware;
 
-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, type AuthRefreshOptions, 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 ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, 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 DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, 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, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, 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 Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, 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 SocialProfileType, 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, createAuthRefreshMiddleware };
+/**
+ * Options for the rate limit middleware
+ */
+interface RateLimitOptions {
+    /**
+     * Enable automatic retry on 429 responses
+     * @default false
+     */
+    enableRetry?: boolean;
+    /**
+     * Enable preemptive throttling to avoid hitting rate limits
+     * @default false
+     */
+    enableThrottle?: boolean;
+    /**
+     * Maximum number of retry attempts
+     * @default 3
+     */
+    maxRetries?: number;
+    /**
+     * Base delay in milliseconds for retries when no retryAfter is provided
+     * @default 1000
+     */
+    baseDelay?: number;
+    /**
+     * Use exponential backoff for retries
+     * @default true
+     */
+    exponentialBackoff?: boolean;
+    /**
+     * Add random jitter to retry delays to prevent thundering herd
+     * @default true
+     */
+    jitter?: boolean;
+    /**
+     * Maximum requests per minute (primary limit)
+     * @default 1000
+     */
+    requestsPerMinute?: number;
+    /**
+     * Maximum requests per burst window
+     * @default 5000
+     */
+    burstLimit?: number;
+    /**
+     * Burst window in milliseconds
+     * @default 300000 (5 minutes)
+     */
+    burstWindowMs?: number;
+    /**
+     * Start throttling when usage reaches this percentage of the limit (0-1)
+     * @default 0.9
+     */
+    throttleThreshold?: number;
+}
+/**
+ * Creates a middleware that handles rate limiting with optional retry and throttling
+ *
+ * @example
+ * ```typescript
+ * const client = new MantleCoreClient({ ... });
+ *
+ * // Enable retry on 429 responses
+ * client.use(createRateLimitMiddleware({
+ *   enableRetry: true,
+ * }));
+ *
+ * // Enable preemptive throttling
+ * client.use(createRateLimitMiddleware({
+ *   enableThrottle: true,
+ * }));
+ *
+ * // Enable both features
+ * client.use(createRateLimitMiddleware({
+ *   enableRetry: true,
+ *   enableThrottle: true,
+ *   maxRetries: 5,
+ *   requestsPerMinute: 500,
+ * }));
+ * ```
+ */
+declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
+
+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 AgentCreateParams, type AgentListResponse, type AgentResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, type AuthRefreshOptions, 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 ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomDataDeleteParams, type CustomDataGetParams, CustomDataResource, type CustomDataResourceType, type CustomDataResponse, type CustomDataSetParams, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, 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 DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, 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, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, 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 Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RateLimitOptions, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type SocialProfileType, 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, createAuthRefreshMiddleware, createRateLimitMiddleware };

package/dist/index.js

@@ -32,6 +32,7 @@ __export(index_exports, {
   ChargesResource: () => ChargesResource,
   CompaniesResource: () => CompaniesResource,
   ContactsResource: () => ContactsResource,
+  CustomDataResource: () => CustomDataResource,
   CustomerSegmentsResource: () => CustomerSegmentsResource,
   CustomersResource: () => CustomersResource,
   DealActivitiesResource: () => DealActivitiesResource,
@@ -58,7 +59,8 @@ __export(index_exports, {
   UsageEventsResource: () => UsageEventsResource,
   UsersResource: () => UsersResource,
   WebhooksResource: () => WebhooksResource,
-  createAuthRefreshMiddleware: () => createAuthRefreshMiddleware
+  createAuthRefreshMiddleware: () => createAuthRefreshMiddleware,
+  createRateLimitMiddleware: () => createRateLimitMiddleware
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1711,6 +1713,42 @@ var AgentsResource = class extends BaseResource {
   async list() {
     return this.get("/agents");
   }
+  /**
+   * Retrieve a specific agent by ID
+   */
+  async retrieve(agentId) {
+    return this.get(`/agents/${agentId}`);
+  }
+  /**
+   * Create a new agent
+   */
+  async create(params) {
+    return this.post("/agents", params);
+  }
+  /**
+   * Find an existing agent by email, or create one if not found.
+   * This is useful for sync operations where you want to ensure
+   * an agent exists without duplicating.
+   *
+   * @param params - Agent data (email required, name optional)
+   * @returns The existing or newly created agent
+   */
+  async findOrCreate(params) {
+    try {
+      return await this.create(params);
+    } catch (error) {
+      if (error instanceof MantleAPIError && error.statusCode === 409) {
+        const { agents } = await this.list();
+        const existingAgent = agents.find(
+          (agent) => agent.email.toLowerCase() === params.email.toLowerCase()
+        );
+        if (existingAgent) {
+          return { agent: existingAgent };
+        }
+      }
+      throw error;
+    }
+  }
 };
 
 // src/resources/docs.ts
@@ -1853,6 +1891,42 @@ var EntitiesResource = class extends BaseResource {
   }
 };
 
+// src/resources/custom-data.ts
+var CustomDataResource = class extends BaseResource {
+  /**
+   * Set custom data on a resource.
+   * This will create or update the value for the given key.
+   *
+   * @param params - The custom data parameters
+   */
+  async set(params) {
+    await this.put("/custom_data", params);
+  }
+  /**
+   * Get custom data from a resource.
+   *
+   * @param params - Parameters identifying the custom data to retrieve
+   * @returns The custom data value
+   */
+  async getValue(params) {
+    const { resourceType, resourceId, key } = params;
+    return this.get(
+      `/custom_data/${resourceType}/${resourceId}/${encodeURIComponent(key)}`
+    );
+  }
+  /**
+   * Delete custom data from a resource.
+   *
+   * @param params - Parameters identifying the custom data to delete
+   */
+  async del(params) {
+    const { resourceType, resourceId, key } = params;
+    await this._delete(
+      `/custom_data/${resourceType}/${resourceId}/${encodeURIComponent(key)}`
+    );
+  }
+};
+
 // src/client.ts
 var MantleCoreClient = class {
   constructor(config) {
@@ -1904,6 +1978,7 @@ var MantleCoreClient = class {
     this.agents = new AgentsResource(this);
     this.docs = new DocsResource(this);
     this.entities = new EntitiesResource(this);
+    this.customData = new CustomDataResource(this);
   }
   /**
    * Register a middleware function
@@ -2180,6 +2255,136 @@ function createAuthRefreshMiddleware(options) {
     }
   };
 }
+
+// src/middleware/rate-limit.ts
+var RateLimiter = class {
+  constructor(options) {
+    this.timestamps = [];
+    this.requestsPerMinute = options.requestsPerMinute;
+    this.burstLimit = options.burstLimit;
+    this.burstWindowMs = options.burstWindowMs;
+    this.throttleThreshold = options.throttleThreshold;
+  }
+  /**
+   * Prune timestamps older than the burst window
+   */
+  prune() {
+    const now = Date.now();
+    const cutoff = now - this.burstWindowMs;
+    this.timestamps = this.timestamps.filter((ts) => ts > cutoff);
+  }
+  /**
+   * Get current usage statistics
+   */
+  getUsage() {
+    this.prune();
+    const now = Date.now();
+    const oneMinuteAgo = now - 6e4;
+    const minuteUsage = this.timestamps.filter((ts) => ts > oneMinuteAgo).length;
+    const burstUsage = this.timestamps.length;
+    return { minuteUsage, burstUsage };
+  }
+  /**
+   * Calculate the delay needed before the next request can be made
+   * Returns 0 if no delay is needed
+   */
+  getDelay() {
+    const { minuteUsage, burstUsage } = this.getUsage();
+    const minuteThreshold = Math.floor(this.requestsPerMinute * this.throttleThreshold);
+    const burstThreshold = Math.floor(this.burstLimit * this.throttleThreshold);
+    if (minuteUsage >= minuteThreshold) {
+      const now = Date.now();
+      const oneMinuteAgo = now - 6e4;
+      const oldestInMinute = this.timestamps.find((ts) => ts > oneMinuteAgo);
+      if (oldestInMinute) {
+        const delay = oldestInMinute + 6e4 - now;
+        if (delay > 0) {
+          return delay;
+        }
+      }
+    }
+    if (burstUsage >= burstThreshold) {
+      const now = Date.now();
+      const burstCutoff = now - this.burstWindowMs;
+      const oldestInBurst = this.timestamps.find((ts) => ts > burstCutoff);
+      if (oldestInBurst) {
+        const delay = oldestInBurst + this.burstWindowMs - now;
+        if (delay > 0) {
+          return delay;
+        }
+      }
+    }
+    return 0;
+  }
+  /**
+   * Record a request timestamp
+   */
+  recordRequest() {
+    this.timestamps.push(Date.now());
+  }
+};
+function calculateRetryDelay(retryAfter, retryCount, options) {
+  let delay;
+  if (retryAfter !== void 0 && retryAfter > 0) {
+    return retryAfter * 1e3;
+  } else if (options.exponentialBackoff) {
+    delay = options.baseDelay * Math.pow(2, retryCount);
+  } else {
+    delay = options.baseDelay;
+  }
+  if (options.jitter) {
+    const jitterFactor = 0.75 + Math.random() * 0.5;
+    delay = Math.floor(delay * jitterFactor);
+  }
+  return delay;
+}
+function createRateLimitMiddleware(options = {}) {
+  const {
+    enableRetry = false,
+    enableThrottle = false,
+    maxRetries = 3,
+    baseDelay = 1e3,
+    exponentialBackoff = true,
+    jitter = true,
+    requestsPerMinute = 1e3,
+    burstLimit = 5e3,
+    burstWindowMs = 3e5,
+    throttleThreshold = 0.9
+  } = options;
+  const rateLimiter = enableThrottle ? new RateLimiter({
+    requestsPerMinute,
+    burstLimit,
+    burstWindowMs,
+    throttleThreshold
+  }) : null;
+  return async (ctx, next) => {
+    if (rateLimiter) {
+      const delay = rateLimiter.getDelay();
+      if (delay > 0) {
+        await new Promise((resolve) => setTimeout(resolve, delay));
+      }
+    }
+    try {
+      await next();
+      rateLimiter?.recordRequest();
+    } catch (error) {
+      rateLimiter?.recordRequest();
+      if (enableRetry && error instanceof MantleRateLimitError) {
+        if (ctx.retryCount < maxRetries) {
+          const delay = calculateRetryDelay(error.retryAfter, ctx.retryCount, {
+            baseDelay,
+            exponentialBackoff,
+            jitter
+          });
+          await new Promise((resolve) => setTimeout(resolve, delay));
+          ctx.retry = true;
+          return;
+        }
+      }
+      throw error;
+    }
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AffiliateCommissionsResource,
@@ -2194,6 +2399,7 @@ function createAuthRefreshMiddleware(options) {
   ChargesResource,
   CompaniesResource,
   ContactsResource,
+  CustomDataResource,
   CustomerSegmentsResource,
   CustomersResource,
   DealActivitiesResource,
@@ -2220,5 +2426,6 @@ function createAuthRefreshMiddleware(options) {
   UsageEventsResource,
   UsersResource,
   WebhooksResource,
-  createAuthRefreshMiddleware
+  createAuthRefreshMiddleware,
+  createRateLimitMiddleware
 });

package/dist/index.mjs

@@ -1647,6 +1647,42 @@ var AgentsResource = class extends BaseResource {
   async list() {
     return this.get("/agents");
   }
+  /**
+   * Retrieve a specific agent by ID
+   */
+  async retrieve(agentId) {
+    return this.get(`/agents/${agentId}`);
+  }
+  /**
+   * Create a new agent
+   */
+  async create(params) {
+    return this.post("/agents", params);
+  }
+  /**
+   * Find an existing agent by email, or create one if not found.
+   * This is useful for sync operations where you want to ensure
+   * an agent exists without duplicating.
+   *
+   * @param params - Agent data (email required, name optional)
+   * @returns The existing or newly created agent
+   */
+  async findOrCreate(params) {
+    try {
+      return await this.create(params);
+    } catch (error) {
+      if (error instanceof MantleAPIError && error.statusCode === 409) {
+        const { agents } = await this.list();
+        const existingAgent = agents.find(
+          (agent) => agent.email.toLowerCase() === params.email.toLowerCase()
+        );
+        if (existingAgent) {
+          return { agent: existingAgent };
+        }
+      }
+      throw error;
+    }
+  }
 };
 
 // src/resources/docs.ts
@@ -1789,6 +1825,42 @@ var EntitiesResource = class extends BaseResource {
   }
 };
 
+// src/resources/custom-data.ts
+var CustomDataResource = class extends BaseResource {
+  /**
+   * Set custom data on a resource.
+   * This will create or update the value for the given key.
+   *
+   * @param params - The custom data parameters
+   */
+  async set(params) {
+    await this.put("/custom_data", params);
+  }
+  /**
+   * Get custom data from a resource.
+   *
+   * @param params - Parameters identifying the custom data to retrieve
+   * @returns The custom data value
+   */
+  async getValue(params) {
+    const { resourceType, resourceId, key } = params;
+    return this.get(
+      `/custom_data/${resourceType}/${resourceId}/${encodeURIComponent(key)}`
+    );
+  }
+  /**
+   * Delete custom data from a resource.
+   *
+   * @param params - Parameters identifying the custom data to delete
+   */
+  async del(params) {
+    const { resourceType, resourceId, key } = params;
+    await this._delete(
+      `/custom_data/${resourceType}/${resourceId}/${encodeURIComponent(key)}`
+    );
+  }
+};
+
 // src/client.ts
 var MantleCoreClient = class {
   constructor(config) {
@@ -1840,6 +1912,7 @@ var MantleCoreClient = class {
     this.agents = new AgentsResource(this);
     this.docs = new DocsResource(this);
     this.entities = new EntitiesResource(this);
+    this.customData = new CustomDataResource(this);
   }
   /**
    * Register a middleware function
@@ -2116,6 +2189,136 @@ function createAuthRefreshMiddleware(options) {
     }
   };
 }
+
+// src/middleware/rate-limit.ts
+var RateLimiter = class {
+  constructor(options) {
+    this.timestamps = [];
+    this.requestsPerMinute = options.requestsPerMinute;
+    this.burstLimit = options.burstLimit;
+    this.burstWindowMs = options.burstWindowMs;
+    this.throttleThreshold = options.throttleThreshold;
+  }
+  /**
+   * Prune timestamps older than the burst window
+   */
+  prune() {
+    const now = Date.now();
+    const cutoff = now - this.burstWindowMs;
+    this.timestamps = this.timestamps.filter((ts) => ts > cutoff);
+  }
+  /**
+   * Get current usage statistics
+   */
+  getUsage() {
+    this.prune();
+    const now = Date.now();
+    const oneMinuteAgo = now - 6e4;
+    const minuteUsage = this.timestamps.filter((ts) => ts > oneMinuteAgo).length;
+    const burstUsage = this.timestamps.length;
+    return { minuteUsage, burstUsage };
+  }
+  /**
+   * Calculate the delay needed before the next request can be made
+   * Returns 0 if no delay is needed
+   */
+  getDelay() {
+    const { minuteUsage, burstUsage } = this.getUsage();
+    const minuteThreshold = Math.floor(this.requestsPerMinute * this.throttleThreshold);
+    const burstThreshold = Math.floor(this.burstLimit * this.throttleThreshold);
+    if (minuteUsage >= minuteThreshold) {
+      const now = Date.now();
+      const oneMinuteAgo = now - 6e4;
+      const oldestInMinute = this.timestamps.find((ts) => ts > oneMinuteAgo);
+      if (oldestInMinute) {
+        const delay = oldestInMinute + 6e4 - now;
+        if (delay > 0) {
+          return delay;
+        }
+      }
+    }
+    if (burstUsage >= burstThreshold) {
+      const now = Date.now();
+      const burstCutoff = now - this.burstWindowMs;
+      const oldestInBurst = this.timestamps.find((ts) => ts > burstCutoff);
+      if (oldestInBurst) {
+        const delay = oldestInBurst + this.burstWindowMs - now;
+        if (delay > 0) {
+          return delay;
+        }
+      }
+    }
+    return 0;
+  }
+  /**
+   * Record a request timestamp
+   */
+  recordRequest() {
+    this.timestamps.push(Date.now());
+  }
+};
+function calculateRetryDelay(retryAfter, retryCount, options) {
+  let delay;
+  if (retryAfter !== void 0 && retryAfter > 0) {
+    return retryAfter * 1e3;
+  } else if (options.exponentialBackoff) {
+    delay = options.baseDelay * Math.pow(2, retryCount);
+  } else {
+    delay = options.baseDelay;
+  }
+  if (options.jitter) {
+    const jitterFactor = 0.75 + Math.random() * 0.5;
+    delay = Math.floor(delay * jitterFactor);
+  }
+  return delay;
+}
+function createRateLimitMiddleware(options = {}) {
+  const {
+    enableRetry = false,
+    enableThrottle = false,
+    maxRetries = 3,
+    baseDelay = 1e3,
+    exponentialBackoff = true,
+    jitter = true,
+    requestsPerMinute = 1e3,
+    burstLimit = 5e3,
+    burstWindowMs = 3e5,
+    throttleThreshold = 0.9
+  } = options;
+  const rateLimiter = enableThrottle ? new RateLimiter({
+    requestsPerMinute,
+    burstLimit,
+    burstWindowMs,
+    throttleThreshold
+  }) : null;
+  return async (ctx, next) => {
+    if (rateLimiter) {
+      const delay = rateLimiter.getDelay();
+      if (delay > 0) {
+        await new Promise((resolve) => setTimeout(resolve, delay));
+      }
+    }
+    try {
+      await next();
+      rateLimiter?.recordRequest();
+    } catch (error) {
+      rateLimiter?.recordRequest();
+      if (enableRetry && error instanceof MantleRateLimitError) {
+        if (ctx.retryCount < maxRetries) {
+          const delay = calculateRetryDelay(error.retryAfter, ctx.retryCount, {
+            baseDelay,
+            exponentialBackoff,
+            jitter
+          });
+          await new Promise((resolve) => setTimeout(resolve, delay));
+          ctx.retry = true;
+          return;
+        }
+      }
+      throw error;
+    }
+  };
+}
 export {
   AffiliateCommissionsResource,
   AffiliatePayoutsResource,
@@ -2129,6 +2332,7 @@ export {
   ChargesResource,
   CompaniesResource,
   ContactsResource,
+  CustomDataResource,
   CustomerSegmentsResource,
   CustomersResource,
   DealActivitiesResource,
@@ -2155,5 +2359,6 @@ export {
   UsageEventsResource,
   UsersResource,
   WebhooksResource,
-  createAuthRefreshMiddleware
+  createAuthRefreshMiddleware,
+  createRateLimitMiddleware
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heymantle/core-api-client",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "TypeScript SDK for the Mantle Core API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -19,6 +19,7 @@
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "test": "vitest run",
     "test:watch": "vitest",
+    "test:ui": "vitest --ui",
     "test:coverage": "vitest run --coverage",
     "typecheck": "tsc --noEmit",
     "build-and-publish": "npm install && npm run build && npm publish"
@@ -46,6 +47,7 @@
   "devDependencies": {
     "@types/node": "^20.11.0",
     "@vitest/coverage-v8": "^1.2.0",
+    "@vitest/ui": "^1.2.0",
     "tsup": "^8.0.2",
     "typescript": "^5.4.3",
     "vitest": "^1.2.0"