@heymantle/core-api-client 0.1.11 → 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.
- package/dist/index.d.mts +116 -13
- package/dist/index.d.ts +116 -13
- package/dist/index.js +34 -0
- package/dist/index.mjs +34 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1815,11 +1815,30 @@ interface AgentResponse {
|
|
|
1815
1815
|
/**
|
|
1816
1816
|
* Task status
|
|
1817
1817
|
*/
|
|
1818
|
-
type TaskStatus = '
|
|
1818
|
+
type TaskStatus = 'new' | 'in_progress' | 'complete';
|
|
1819
1819
|
/**
|
|
1820
1820
|
* Task priority
|
|
1821
1821
|
*/
|
|
1822
|
-
type TaskPriority = 'low' | 'medium' | 'high'
|
|
1822
|
+
type TaskPriority = 'low' | 'medium' | 'high';
|
|
1823
|
+
/**
|
|
1824
|
+
* Task todo item entity
|
|
1825
|
+
*/
|
|
1826
|
+
interface TodoItem {
|
|
1827
|
+
id: string;
|
|
1828
|
+
content: string;
|
|
1829
|
+
completed: boolean;
|
|
1830
|
+
completedAt?: string | null;
|
|
1831
|
+
displayOrder: number;
|
|
1832
|
+
}
|
|
1833
|
+
/**
|
|
1834
|
+
* Parameters for creating a todo item (used in task creation/update)
|
|
1835
|
+
*/
|
|
1836
|
+
interface TodoItemInput {
|
|
1837
|
+
id?: string;
|
|
1838
|
+
content: string;
|
|
1839
|
+
completed?: boolean;
|
|
1840
|
+
displayOrder?: number;
|
|
1841
|
+
}
|
|
1823
1842
|
/**
|
|
1824
1843
|
* Task entity
|
|
1825
1844
|
*/
|
|
@@ -1831,6 +1850,7 @@ interface Task {
|
|
|
1831
1850
|
priority: TaskPriority;
|
|
1832
1851
|
status: TaskStatus;
|
|
1833
1852
|
dueDate?: string;
|
|
1853
|
+
completedAt?: string | null;
|
|
1834
1854
|
assigneeId?: string;
|
|
1835
1855
|
customerId?: string;
|
|
1836
1856
|
contactId?: string;
|
|
@@ -1844,19 +1864,33 @@ interface Task {
|
|
|
1844
1864
|
id: string;
|
|
1845
1865
|
name?: string;
|
|
1846
1866
|
email?: string;
|
|
1847
|
-
};
|
|
1867
|
+
} | null;
|
|
1868
|
+
createdBy?: {
|
|
1869
|
+
id: string;
|
|
1870
|
+
name?: string;
|
|
1871
|
+
email?: string;
|
|
1872
|
+
} | null;
|
|
1848
1873
|
customer?: {
|
|
1849
1874
|
id: string;
|
|
1850
1875
|
name?: string;
|
|
1851
|
-
};
|
|
1876
|
+
} | null;
|
|
1852
1877
|
contact?: {
|
|
1853
1878
|
id: string;
|
|
1854
1879
|
name?: string;
|
|
1855
|
-
};
|
|
1880
|
+
} | null;
|
|
1856
1881
|
deal?: {
|
|
1857
1882
|
id: string;
|
|
1858
1883
|
name?: string;
|
|
1859
|
-
|
|
1884
|
+
dealStage?: {
|
|
1885
|
+
id: string;
|
|
1886
|
+
name?: string;
|
|
1887
|
+
} | null;
|
|
1888
|
+
} | null;
|
|
1889
|
+
dealActivity?: {
|
|
1890
|
+
id: string;
|
|
1891
|
+
name?: string;
|
|
1892
|
+
} | null;
|
|
1893
|
+
todoItems?: TodoItem[];
|
|
1860
1894
|
}
|
|
1861
1895
|
/**
|
|
1862
1896
|
* Parameters for listing tasks
|
|
@@ -1891,12 +1925,59 @@ interface TaskCreateParams {
|
|
|
1891
1925
|
dealActivityId?: string;
|
|
1892
1926
|
appInstallationId?: string;
|
|
1893
1927
|
tags?: string[];
|
|
1928
|
+
todoItems?: TodoItemInput[];
|
|
1894
1929
|
}
|
|
1895
1930
|
/**
|
|
1896
1931
|
* Parameters for updating a task
|
|
1897
1932
|
*/
|
|
1898
1933
|
interface TaskUpdateParams extends Partial<TaskCreateParams> {
|
|
1899
1934
|
}
|
|
1935
|
+
/**
|
|
1936
|
+
* Response from listing todo items
|
|
1937
|
+
*/
|
|
1938
|
+
interface TodoItemListResponse {
|
|
1939
|
+
items: TodoItem[];
|
|
1940
|
+
total: number;
|
|
1941
|
+
}
|
|
1942
|
+
/**
|
|
1943
|
+
* Deal progression information returned when a task update triggers deal stage change
|
|
1944
|
+
*/
|
|
1945
|
+
interface DealProgression {
|
|
1946
|
+
dealId: string;
|
|
1947
|
+
dealName: string;
|
|
1948
|
+
previousStage: {
|
|
1949
|
+
id: string;
|
|
1950
|
+
name: string;
|
|
1951
|
+
} | null;
|
|
1952
|
+
nextStage: {
|
|
1953
|
+
id: string;
|
|
1954
|
+
name: string;
|
|
1955
|
+
} | null;
|
|
1956
|
+
}
|
|
1957
|
+
/**
|
|
1958
|
+
* Response from updating a task
|
|
1959
|
+
*/
|
|
1960
|
+
interface TaskUpdateResponse {
|
|
1961
|
+
task: Task;
|
|
1962
|
+
dealProgressed: boolean;
|
|
1963
|
+
dealProgression: DealProgression | null;
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* Parameters for creating a todo item via the dedicated endpoint
|
|
1967
|
+
*/
|
|
1968
|
+
interface TodoItemCreateParams {
|
|
1969
|
+
content: string;
|
|
1970
|
+
completed?: boolean;
|
|
1971
|
+
displayOrder?: number;
|
|
1972
|
+
}
|
|
1973
|
+
/**
|
|
1974
|
+
* Parameters for updating a todo item
|
|
1975
|
+
*/
|
|
1976
|
+
interface TodoItemUpdateParams {
|
|
1977
|
+
content?: string;
|
|
1978
|
+
completed?: boolean;
|
|
1979
|
+
displayOrder?: number;
|
|
1980
|
+
}
|
|
1900
1981
|
|
|
1901
1982
|
/**
|
|
1902
1983
|
* Company entity
|
|
@@ -2771,19 +2852,41 @@ declare class TasksResource extends BaseResource {
|
|
|
2771
2852
|
/**
|
|
2772
2853
|
* Create a new task
|
|
2773
2854
|
*/
|
|
2774
|
-
create(data: TaskCreateParams): Promise<
|
|
2775
|
-
task: Task;
|
|
2776
|
-
}>;
|
|
2855
|
+
create(data: TaskCreateParams): Promise<Task>;
|
|
2777
2856
|
/**
|
|
2778
2857
|
* Update an existing task
|
|
2779
2858
|
*/
|
|
2780
|
-
update(taskId: string, data: TaskUpdateParams): Promise<
|
|
2781
|
-
task: Task;
|
|
2782
|
-
}>;
|
|
2859
|
+
update(taskId: string, data: TaskUpdateParams): Promise<TaskUpdateResponse>;
|
|
2783
2860
|
/**
|
|
2784
2861
|
* Delete a task
|
|
2785
2862
|
*/
|
|
2786
2863
|
del(taskId: string): Promise<DeleteResponse>;
|
|
2864
|
+
/**
|
|
2865
|
+
* List todo items for a task
|
|
2866
|
+
*/
|
|
2867
|
+
listTodoItems(taskId: string): Promise<TodoItemListResponse>;
|
|
2868
|
+
/**
|
|
2869
|
+
* Retrieve a single todo item
|
|
2870
|
+
*/
|
|
2871
|
+
retrieveTodoItem(taskId: string, itemId: string): Promise<{
|
|
2872
|
+
item: TodoItem;
|
|
2873
|
+
}>;
|
|
2874
|
+
/**
|
|
2875
|
+
* Create a todo item for a task
|
|
2876
|
+
*/
|
|
2877
|
+
createTodoItem(taskId: string, data: TodoItemCreateParams): Promise<{
|
|
2878
|
+
item: TodoItem;
|
|
2879
|
+
}>;
|
|
2880
|
+
/**
|
|
2881
|
+
* Update a todo item
|
|
2882
|
+
*/
|
|
2883
|
+
updateTodoItem(taskId: string, itemId: string, data: TodoItemUpdateParams): Promise<{
|
|
2884
|
+
item: TodoItem;
|
|
2885
|
+
}>;
|
|
2886
|
+
/**
|
|
2887
|
+
* Delete a todo item
|
|
2888
|
+
*/
|
|
2889
|
+
deleteTodoItem(taskId: string, itemId: string): Promise<DeleteResponse>;
|
|
2787
2890
|
}
|
|
2788
2891
|
|
|
2789
2892
|
/**
|
|
@@ -3654,4 +3757,4 @@ interface RateLimitOptions {
|
|
|
3654
3757
|
*/
|
|
3655
3758
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
3656
3759
|
|
|
3657
|
-
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 };
|
|
3760
|
+
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
|
@@ -1815,11 +1815,30 @@ interface AgentResponse {
|
|
|
1815
1815
|
/**
|
|
1816
1816
|
* Task status
|
|
1817
1817
|
*/
|
|
1818
|
-
type TaskStatus = '
|
|
1818
|
+
type TaskStatus = 'new' | 'in_progress' | 'complete';
|
|
1819
1819
|
/**
|
|
1820
1820
|
* Task priority
|
|
1821
1821
|
*/
|
|
1822
|
-
type TaskPriority = 'low' | 'medium' | 'high'
|
|
1822
|
+
type TaskPriority = 'low' | 'medium' | 'high';
|
|
1823
|
+
/**
|
|
1824
|
+
* Task todo item entity
|
|
1825
|
+
*/
|
|
1826
|
+
interface TodoItem {
|
|
1827
|
+
id: string;
|
|
1828
|
+
content: string;
|
|
1829
|
+
completed: boolean;
|
|
1830
|
+
completedAt?: string | null;
|
|
1831
|
+
displayOrder: number;
|
|
1832
|
+
}
|
|
1833
|
+
/**
|
|
1834
|
+
* Parameters for creating a todo item (used in task creation/update)
|
|
1835
|
+
*/
|
|
1836
|
+
interface TodoItemInput {
|
|
1837
|
+
id?: string;
|
|
1838
|
+
content: string;
|
|
1839
|
+
completed?: boolean;
|
|
1840
|
+
displayOrder?: number;
|
|
1841
|
+
}
|
|
1823
1842
|
/**
|
|
1824
1843
|
* Task entity
|
|
1825
1844
|
*/
|
|
@@ -1831,6 +1850,7 @@ interface Task {
|
|
|
1831
1850
|
priority: TaskPriority;
|
|
1832
1851
|
status: TaskStatus;
|
|
1833
1852
|
dueDate?: string;
|
|
1853
|
+
completedAt?: string | null;
|
|
1834
1854
|
assigneeId?: string;
|
|
1835
1855
|
customerId?: string;
|
|
1836
1856
|
contactId?: string;
|
|
@@ -1844,19 +1864,33 @@ interface Task {
|
|
|
1844
1864
|
id: string;
|
|
1845
1865
|
name?: string;
|
|
1846
1866
|
email?: string;
|
|
1847
|
-
};
|
|
1867
|
+
} | null;
|
|
1868
|
+
createdBy?: {
|
|
1869
|
+
id: string;
|
|
1870
|
+
name?: string;
|
|
1871
|
+
email?: string;
|
|
1872
|
+
} | null;
|
|
1848
1873
|
customer?: {
|
|
1849
1874
|
id: string;
|
|
1850
1875
|
name?: string;
|
|
1851
|
-
};
|
|
1876
|
+
} | null;
|
|
1852
1877
|
contact?: {
|
|
1853
1878
|
id: string;
|
|
1854
1879
|
name?: string;
|
|
1855
|
-
};
|
|
1880
|
+
} | null;
|
|
1856
1881
|
deal?: {
|
|
1857
1882
|
id: string;
|
|
1858
1883
|
name?: string;
|
|
1859
|
-
|
|
1884
|
+
dealStage?: {
|
|
1885
|
+
id: string;
|
|
1886
|
+
name?: string;
|
|
1887
|
+
} | null;
|
|
1888
|
+
} | null;
|
|
1889
|
+
dealActivity?: {
|
|
1890
|
+
id: string;
|
|
1891
|
+
name?: string;
|
|
1892
|
+
} | null;
|
|
1893
|
+
todoItems?: TodoItem[];
|
|
1860
1894
|
}
|
|
1861
1895
|
/**
|
|
1862
1896
|
* Parameters for listing tasks
|
|
@@ -1891,12 +1925,59 @@ interface TaskCreateParams {
|
|
|
1891
1925
|
dealActivityId?: string;
|
|
1892
1926
|
appInstallationId?: string;
|
|
1893
1927
|
tags?: string[];
|
|
1928
|
+
todoItems?: TodoItemInput[];
|
|
1894
1929
|
}
|
|
1895
1930
|
/**
|
|
1896
1931
|
* Parameters for updating a task
|
|
1897
1932
|
*/
|
|
1898
1933
|
interface TaskUpdateParams extends Partial<TaskCreateParams> {
|
|
1899
1934
|
}
|
|
1935
|
+
/**
|
|
1936
|
+
* Response from listing todo items
|
|
1937
|
+
*/
|
|
1938
|
+
interface TodoItemListResponse {
|
|
1939
|
+
items: TodoItem[];
|
|
1940
|
+
total: number;
|
|
1941
|
+
}
|
|
1942
|
+
/**
|
|
1943
|
+
* Deal progression information returned when a task update triggers deal stage change
|
|
1944
|
+
*/
|
|
1945
|
+
interface DealProgression {
|
|
1946
|
+
dealId: string;
|
|
1947
|
+
dealName: string;
|
|
1948
|
+
previousStage: {
|
|
1949
|
+
id: string;
|
|
1950
|
+
name: string;
|
|
1951
|
+
} | null;
|
|
1952
|
+
nextStage: {
|
|
1953
|
+
id: string;
|
|
1954
|
+
name: string;
|
|
1955
|
+
} | null;
|
|
1956
|
+
}
|
|
1957
|
+
/**
|
|
1958
|
+
* Response from updating a task
|
|
1959
|
+
*/
|
|
1960
|
+
interface TaskUpdateResponse {
|
|
1961
|
+
task: Task;
|
|
1962
|
+
dealProgressed: boolean;
|
|
1963
|
+
dealProgression: DealProgression | null;
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* Parameters for creating a todo item via the dedicated endpoint
|
|
1967
|
+
*/
|
|
1968
|
+
interface TodoItemCreateParams {
|
|
1969
|
+
content: string;
|
|
1970
|
+
completed?: boolean;
|
|
1971
|
+
displayOrder?: number;
|
|
1972
|
+
}
|
|
1973
|
+
/**
|
|
1974
|
+
* Parameters for updating a todo item
|
|
1975
|
+
*/
|
|
1976
|
+
interface TodoItemUpdateParams {
|
|
1977
|
+
content?: string;
|
|
1978
|
+
completed?: boolean;
|
|
1979
|
+
displayOrder?: number;
|
|
1980
|
+
}
|
|
1900
1981
|
|
|
1901
1982
|
/**
|
|
1902
1983
|
* Company entity
|
|
@@ -2771,19 +2852,41 @@ declare class TasksResource extends BaseResource {
|
|
|
2771
2852
|
/**
|
|
2772
2853
|
* Create a new task
|
|
2773
2854
|
*/
|
|
2774
|
-
create(data: TaskCreateParams): Promise<
|
|
2775
|
-
task: Task;
|
|
2776
|
-
}>;
|
|
2855
|
+
create(data: TaskCreateParams): Promise<Task>;
|
|
2777
2856
|
/**
|
|
2778
2857
|
* Update an existing task
|
|
2779
2858
|
*/
|
|
2780
|
-
update(taskId: string, data: TaskUpdateParams): Promise<
|
|
2781
|
-
task: Task;
|
|
2782
|
-
}>;
|
|
2859
|
+
update(taskId: string, data: TaskUpdateParams): Promise<TaskUpdateResponse>;
|
|
2783
2860
|
/**
|
|
2784
2861
|
* Delete a task
|
|
2785
2862
|
*/
|
|
2786
2863
|
del(taskId: string): Promise<DeleteResponse>;
|
|
2864
|
+
/**
|
|
2865
|
+
* List todo items for a task
|
|
2866
|
+
*/
|
|
2867
|
+
listTodoItems(taskId: string): Promise<TodoItemListResponse>;
|
|
2868
|
+
/**
|
|
2869
|
+
* Retrieve a single todo item
|
|
2870
|
+
*/
|
|
2871
|
+
retrieveTodoItem(taskId: string, itemId: string): Promise<{
|
|
2872
|
+
item: TodoItem;
|
|
2873
|
+
}>;
|
|
2874
|
+
/**
|
|
2875
|
+
* Create a todo item for a task
|
|
2876
|
+
*/
|
|
2877
|
+
createTodoItem(taskId: string, data: TodoItemCreateParams): Promise<{
|
|
2878
|
+
item: TodoItem;
|
|
2879
|
+
}>;
|
|
2880
|
+
/**
|
|
2881
|
+
* Update a todo item
|
|
2882
|
+
*/
|
|
2883
|
+
updateTodoItem(taskId: string, itemId: string, data: TodoItemUpdateParams): Promise<{
|
|
2884
|
+
item: TodoItem;
|
|
2885
|
+
}>;
|
|
2886
|
+
/**
|
|
2887
|
+
* Delete a todo item
|
|
2888
|
+
*/
|
|
2889
|
+
deleteTodoItem(taskId: string, itemId: string): Promise<DeleteResponse>;
|
|
2787
2890
|
}
|
|
2788
2891
|
|
|
2789
2892
|
/**
|
|
@@ -3654,4 +3757,4 @@ interface RateLimitOptions {
|
|
|
3654
3757
|
*/
|
|
3655
3758
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
3656
3759
|
|
|
3657
|
-
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 };
|
|
3760
|
+
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
|
@@ -1155,6 +1155,40 @@ var TasksResource = class extends BaseResource {
|
|
|
1155
1155
|
async del(taskId) {
|
|
1156
1156
|
return this._delete(`/tasks/${taskId}`);
|
|
1157
1157
|
}
|
|
1158
|
+
// ========== Todo Items ==========
|
|
1159
|
+
/**
|
|
1160
|
+
* List todo items for a task
|
|
1161
|
+
*/
|
|
1162
|
+
async listTodoItems(taskId) {
|
|
1163
|
+
return this.get(`/tasks/${taskId}/todo-items`);
|
|
1164
|
+
}
|
|
1165
|
+
/**
|
|
1166
|
+
* Retrieve a single todo item
|
|
1167
|
+
*/
|
|
1168
|
+
async retrieveTodoItem(taskId, itemId) {
|
|
1169
|
+
return this.get(`/tasks/${taskId}/todo-items/${itemId}`);
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* Create a todo item for a task
|
|
1173
|
+
*/
|
|
1174
|
+
async createTodoItem(taskId, data) {
|
|
1175
|
+
return this.post(`/tasks/${taskId}/todo-items`, data);
|
|
1176
|
+
}
|
|
1177
|
+
/**
|
|
1178
|
+
* Update a todo item
|
|
1179
|
+
*/
|
|
1180
|
+
async updateTodoItem(taskId, itemId, data) {
|
|
1181
|
+
return this.put(
|
|
1182
|
+
`/tasks/${taskId}/todo-items/${itemId}`,
|
|
1183
|
+
data
|
|
1184
|
+
);
|
|
1185
|
+
}
|
|
1186
|
+
/**
|
|
1187
|
+
* Delete a todo item
|
|
1188
|
+
*/
|
|
1189
|
+
async deleteTodoItem(taskId, itemId) {
|
|
1190
|
+
return this._delete(`/tasks/${taskId}/todo-items/${itemId}`);
|
|
1191
|
+
}
|
|
1158
1192
|
};
|
|
1159
1193
|
|
|
1160
1194
|
// src/resources/webhooks.ts
|
package/dist/index.mjs
CHANGED
|
@@ -1089,6 +1089,40 @@ var TasksResource = class extends BaseResource {
|
|
|
1089
1089
|
async del(taskId) {
|
|
1090
1090
|
return this._delete(`/tasks/${taskId}`);
|
|
1091
1091
|
}
|
|
1092
|
+
// ========== Todo Items ==========
|
|
1093
|
+
/**
|
|
1094
|
+
* List todo items for a task
|
|
1095
|
+
*/
|
|
1096
|
+
async listTodoItems(taskId) {
|
|
1097
|
+
return this.get(`/tasks/${taskId}/todo-items`);
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* Retrieve a single todo item
|
|
1101
|
+
*/
|
|
1102
|
+
async retrieveTodoItem(taskId, itemId) {
|
|
1103
|
+
return this.get(`/tasks/${taskId}/todo-items/${itemId}`);
|
|
1104
|
+
}
|
|
1105
|
+
/**
|
|
1106
|
+
* Create a todo item for a task
|
|
1107
|
+
*/
|
|
1108
|
+
async createTodoItem(taskId, data) {
|
|
1109
|
+
return this.post(`/tasks/${taskId}/todo-items`, data);
|
|
1110
|
+
}
|
|
1111
|
+
/**
|
|
1112
|
+
* Update a todo item
|
|
1113
|
+
*/
|
|
1114
|
+
async updateTodoItem(taskId, itemId, data) {
|
|
1115
|
+
return this.put(
|
|
1116
|
+
`/tasks/${taskId}/todo-items/${itemId}`,
|
|
1117
|
+
data
|
|
1118
|
+
);
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* Delete a todo item
|
|
1122
|
+
*/
|
|
1123
|
+
async deleteTodoItem(taskId, itemId) {
|
|
1124
|
+
return this._delete(`/tasks/${taskId}/todo-items/${itemId}`);
|
|
1125
|
+
}
|
|
1092
1126
|
};
|
|
1093
1127
|
|
|
1094
1128
|
// src/resources/webhooks.ts
|