npm - @heymantle/core-api-client - Versions diffs - 0.1.10 → 0.1.12 - Mend

@heymantle/core-api-client 0.1.10 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/index.d.mts CHANGED Viewed

@@ -1815,11 +1815,30 @@ interface AgentResponse {
 /**
  * Task status
  */
-type TaskStatus = 'pending' | 'in_progress' | 'completed' | 'canceled';
+type TaskStatus = 'new' | 'in_progress' | 'complete';
 /**
  * Task priority
  */
-type TaskPriority = 'low' | 'medium' | 'high' | 'urgent';
+type TaskPriority = 'low' | 'medium' | 'high';
+/**
+ * Task todo item entity
+ */
+interface TodoItem {
+    id: string;
+    content: string;
+    completed: boolean;
+    completedAt?: string | null;
+    displayOrder: number;
+}
+/**
+ * Parameters for creating a todo item (used in task creation/update)
+ */
+interface TodoItemInput {
+    id?: string;
+    content: string;
+    completed?: boolean;
+    displayOrder?: number;
+}
 /**
  * Task entity
  */
@@ -1831,6 +1850,7 @@ interface Task {
     priority: TaskPriority;
     status: TaskStatus;
     dueDate?: string;
+    completedAt?: string | null;
     assigneeId?: string;
     customerId?: string;
     contactId?: string;
@@ -1844,19 +1864,33 @@ interface Task {
         id: string;
         name?: string;
         email?: string;
-    };
+    } | null;
+    createdBy?: {
+        id: string;
+        name?: string;
+        email?: string;
+    } | null;
     customer?: {
         id: string;
         name?: string;
-    };
+    } | null;
     contact?: {
         id: string;
         name?: string;
-    };
+    } | null;
     deal?: {
         id: string;
         name?: string;
-    };
+        dealStage?: {
+            id: string;
+            name?: string;
+        } | null;
+    } | null;
+    dealActivity?: {
+        id: string;
+        name?: string;
+    } | null;
+    todoItems?: TodoItem[];
 }
 /**
  * Parameters for listing tasks
@@ -1891,12 +1925,59 @@ interface TaskCreateParams {
     dealActivityId?: string;
     appInstallationId?: string;
     tags?: string[];
+    todoItems?: TodoItemInput[];
 }
 /**
  * Parameters for updating a task
  */
 interface TaskUpdateParams extends Partial<TaskCreateParams> {
 }
+/**
+ * Response from listing todo items
+ */
+interface TodoItemListResponse {
+    items: TodoItem[];
+    total: number;
+}
+/**
+ * Deal progression information returned when a task update triggers deal stage change
+ */
+interface DealProgression {
+    dealId: string;
+    dealName: string;
+    previousStage: {
+        id: string;
+        name: string;
+    } | null;
+    nextStage: {
+        id: string;
+        name: string;
+    } | null;
+}
+/**
+ * Response from updating a task
+ */
+interface TaskUpdateResponse {
+    task: Task;
+    dealProgressed: boolean;
+    dealProgression: DealProgression | null;
+}
+/**
+ * Parameters for creating a todo item via the dedicated endpoint
+ */
+interface TodoItemCreateParams {
+    content: string;
+    completed?: boolean;
+    displayOrder?: number;
+}
+/**
+ * Parameters for updating a todo item
+ */
+interface TodoItemUpdateParams {
+    content?: string;
+    completed?: boolean;
+    displayOrder?: number;
+}
 /**
  * Company entity
@@ -2771,19 +2852,41 @@ declare class TasksResource extends BaseResource {
     /**
      * Create a new task
      */
-    create(data: TaskCreateParams): Promise<{
-        task: Task;
-    }>;
+    create(data: TaskCreateParams): Promise<Task>;
     /**
      * Update an existing task
      */
-    update(taskId: string, data: TaskUpdateParams): Promise<{
-        task: Task;
-    }>;
+    update(taskId: string, data: TaskUpdateParams): Promise<TaskUpdateResponse>;
     /**
      * Delete a task
      */
     del(taskId: string): Promise<DeleteResponse>;
+    /**
+     * List todo items for a task
+     */
+    listTodoItems(taskId: string): Promise<TodoItemListResponse>;
+    /**
+     * Retrieve a single todo item
+     */
+    retrieveTodoItem(taskId: string, itemId: string): Promise<{
+        item: TodoItem;
+    }>;
+    /**
+     * Create a todo item for a task
+     */
+    createTodoItem(taskId: string, data: TodoItemCreateParams): Promise<{
+        item: TodoItem;
+    }>;
+    /**
+     * Update a todo item
+     */
+    updateTodoItem(taskId: string, itemId: string, data: TodoItemUpdateParams): Promise<{
+        item: TodoItem;
+    }>;
+    /**
+     * Delete a todo item
+     */
+    deleteTodoItem(taskId: string, itemId: string): Promise<DeleteResponse>;
 }
 /**
@@ -3571,4 +3674,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 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 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 DealProgression, 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, type TaskUpdateResponse, 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 TodoItem, type TodoItemCreateParams, type TodoItemInput, type TodoItemListResponse, type TodoItemUpdateParams, 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 CHANGED Viewed

@@ -1815,11 +1815,30 @@ interface AgentResponse {
 /**
  * Task status
  */
-type TaskStatus = 'pending' | 'in_progress' | 'completed' | 'canceled';
+type TaskStatus = 'new' | 'in_progress' | 'complete';
 /**
  * Task priority
  */
-type TaskPriority = 'low' | 'medium' | 'high' | 'urgent';
+type TaskPriority = 'low' | 'medium' | 'high';
+/**
+ * Task todo item entity
+ */
+interface TodoItem {
+    id: string;
+    content: string;
+    completed: boolean;
+    completedAt?: string | null;
+    displayOrder: number;
+}
+/**
+ * Parameters for creating a todo item (used in task creation/update)
+ */
+interface TodoItemInput {
+    id?: string;
+    content: string;
+    completed?: boolean;
+    displayOrder?: number;
+}
 /**
  * Task entity
  */
@@ -1831,6 +1850,7 @@ interface Task {
     priority: TaskPriority;
     status: TaskStatus;
     dueDate?: string;
+    completedAt?: string | null;
     assigneeId?: string;
     customerId?: string;
     contactId?: string;
@@ -1844,19 +1864,33 @@ interface Task {
         id: string;
         name?: string;
         email?: string;
-    };
+    } | null;
+    createdBy?: {
+        id: string;
+        name?: string;
+        email?: string;
+    } | null;
     customer?: {
         id: string;
         name?: string;
-    };
+    } | null;
     contact?: {
         id: string;
         name?: string;
-    };
+    } | null;
     deal?: {
         id: string;
         name?: string;
-    };
+        dealStage?: {
+            id: string;
+            name?: string;
+        } | null;
+    } | null;
+    dealActivity?: {
+        id: string;
+        name?: string;
+    } | null;
+    todoItems?: TodoItem[];
 }
 /**
  * Parameters for listing tasks
@@ -1891,12 +1925,59 @@ interface TaskCreateParams {
     dealActivityId?: string;
     appInstallationId?: string;
     tags?: string[];
+    todoItems?: TodoItemInput[];
 }
 /**
  * Parameters for updating a task
  */
 interface TaskUpdateParams extends Partial<TaskCreateParams> {
 }
+/**
+ * Response from listing todo items
+ */
+interface TodoItemListResponse {
+    items: TodoItem[];
+    total: number;
+}
+/**
+ * Deal progression information returned when a task update triggers deal stage change
+ */
+interface DealProgression {
+    dealId: string;
+    dealName: string;
+    previousStage: {
+        id: string;
+        name: string;
+    } | null;
+    nextStage: {
+        id: string;
+        name: string;
+    } | null;
+}
+/**
+ * Response from updating a task
+ */
+interface TaskUpdateResponse {
+    task: Task;
+    dealProgressed: boolean;
+    dealProgression: DealProgression | null;
+}
+/**
+ * Parameters for creating a todo item via the dedicated endpoint
+ */
+interface TodoItemCreateParams {
+    content: string;
+    completed?: boolean;
+    displayOrder?: number;
+}
+/**
+ * Parameters for updating a todo item
+ */
+interface TodoItemUpdateParams {
+    content?: string;
+    completed?: boolean;
+    displayOrder?: number;
+}
 /**
  * Company entity
@@ -2771,19 +2852,41 @@ declare class TasksResource extends BaseResource {
     /**
      * Create a new task
      */
-    create(data: TaskCreateParams): Promise<{
-        task: Task;
-    }>;
+    create(data: TaskCreateParams): Promise<Task>;
     /**
      * Update an existing task
      */
-    update(taskId: string, data: TaskUpdateParams): Promise<{
-        task: Task;
-    }>;
+    update(taskId: string, data: TaskUpdateParams): Promise<TaskUpdateResponse>;
     /**
      * Delete a task
      */
     del(taskId: string): Promise<DeleteResponse>;
+    /**
+     * List todo items for a task
+     */
+    listTodoItems(taskId: string): Promise<TodoItemListResponse>;
+    /**
+     * Retrieve a single todo item
+     */
+    retrieveTodoItem(taskId: string, itemId: string): Promise<{
+        item: TodoItem;
+    }>;
+    /**
+     * Create a todo item for a task
+     */
+    createTodoItem(taskId: string, data: TodoItemCreateParams): Promise<{
+        item: TodoItem;
+    }>;
+    /**
+     * Update a todo item
+     */
+    updateTodoItem(taskId: string, itemId: string, data: TodoItemUpdateParams): Promise<{
+        item: TodoItem;
+    }>;
+    /**
+     * Delete a todo item
+     */
+    deleteTodoItem(taskId: string, itemId: string): Promise<DeleteResponse>;
 }
 /**
@@ -3571,4 +3674,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 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 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 DealProgression, 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, type TaskUpdateResponse, 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 TodoItem, type TodoItemCreateParams, type TodoItemInput, type TodoItemListResponse, type TodoItemUpdateParams, 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 CHANGED Viewed

@@ -59,7 +59,8 @@ __export(index_exports, {
   UsageEventsResource: () => UsageEventsResource,
   UsersResource: () => UsersResource,
   WebhooksResource: () => WebhooksResource,
-  createAuthRefreshMiddleware: () => createAuthRefreshMiddleware
+  createAuthRefreshMiddleware: () => createAuthRefreshMiddleware,
+  createRateLimitMiddleware: () => createRateLimitMiddleware
 });
 module.exports = __toCommonJS(index_exports);
@@ -1154,6 +1155,40 @@ var TasksResource = class extends BaseResource {
   async del(taskId) {
     return this._delete(`/tasks/${taskId}`);
   }
+  // ========== Todo Items ==========
+  /**
+   * List todo items for a task
+   */
+  async listTodoItems(taskId) {
+    return this.get(`/tasks/${taskId}/todo-items`);
+  }
+  /**
+   * Retrieve a single todo item
+   */
+  async retrieveTodoItem(taskId, itemId) {
+    return this.get(`/tasks/${taskId}/todo-items/${itemId}`);
+  }
+  /**
+   * Create a todo item for a task
+   */
+  async createTodoItem(taskId, data) {
+    return this.post(`/tasks/${taskId}/todo-items`, data);
+  }
+  /**
+   * Update a todo item
+   */
+  async updateTodoItem(taskId, itemId, data) {
+    return this.put(
+      `/tasks/${taskId}/todo-items/${itemId}`,
+      data
+    );
+  }
+  /**
+   * Delete a todo item
+   */
+  async deleteTodoItem(taskId, itemId) {
+    return this._delete(`/tasks/${taskId}/todo-items/${itemId}`);
+  }
 };
 // src/resources/webhooks.ts
@@ -2254,6 +2289,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,
@@ -2295,5 +2460,6 @@ function createAuthRefreshMiddleware(options) {
   UsageEventsResource,
   UsersResource,
   WebhooksResource,
-  createAuthRefreshMiddleware
+  createAuthRefreshMiddleware,
+  createRateLimitMiddleware
 });

package/dist/index.mjs CHANGED Viewed

@@ -1089,6 +1089,40 @@ var TasksResource = class extends BaseResource {
   async del(taskId) {
     return this._delete(`/tasks/${taskId}`);
   }
+  // ========== Todo Items ==========
+  /**
+   * List todo items for a task
+   */
+  async listTodoItems(taskId) {
+    return this.get(`/tasks/${taskId}/todo-items`);
+  }
+  /**
+   * Retrieve a single todo item
+   */
+  async retrieveTodoItem(taskId, itemId) {
+    return this.get(`/tasks/${taskId}/todo-items/${itemId}`);
+  }
+  /**
+   * Create a todo item for a task
+   */
+  async createTodoItem(taskId, data) {
+    return this.post(`/tasks/${taskId}/todo-items`, data);
+  }
+  /**
+   * Update a todo item
+   */
+  async updateTodoItem(taskId, itemId, data) {
+    return this.put(
+      `/tasks/${taskId}/todo-items/${itemId}`,
+      data
+    );
+  }
+  /**
+   * Delete a todo item
+   */
+  async deleteTodoItem(taskId, itemId) {
+    return this._delete(`/tasks/${taskId}/todo-items/${itemId}`);
+  }
 };
 // src/resources/webhooks.ts
@@ -2189,6 +2223,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,
@@ -2229,5 +2393,6 @@ export {
   UsageEventsResource,
   UsersResource,
   WebhooksResource,
-  createAuthRefreshMiddleware
+  createAuthRefreshMiddleware,
+  createRateLimitMiddleware
 };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@heymantle/core-api-client",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "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"