@heymantle/core-api-client 0.1.19 → 0.1.20
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 +27 -1
- package/dist/index.d.ts +27 -1
- package/dist/index.js +6 -0
- package/dist/index.mjs +6 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1537,6 +1537,28 @@ interface UsageEventMetricsParams extends MetricsBaseParams {
|
|
|
1537
1537
|
interface UsageMetricParams extends MetricsBaseParams {
|
|
1538
1538
|
metricId: string;
|
|
1539
1539
|
}
|
|
1540
|
+
/**
|
|
1541
|
+
* Parameters for sales metrics request
|
|
1542
|
+
*/
|
|
1543
|
+
interface SalesMetricsParams {
|
|
1544
|
+
userId?: string;
|
|
1545
|
+
}
|
|
1546
|
+
/**
|
|
1547
|
+
* Sales metrics data
|
|
1548
|
+
*/
|
|
1549
|
+
interface SalesMetrics {
|
|
1550
|
+
attributedRevenue: number;
|
|
1551
|
+
activeDeals: number;
|
|
1552
|
+
activeDealsTotalAmount: number;
|
|
1553
|
+
winRate: number;
|
|
1554
|
+
avgDealSize: number;
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
* Response from sales metrics endpoint
|
|
1558
|
+
*/
|
|
1559
|
+
interface SalesMetricsResponse {
|
|
1560
|
+
metrics: SalesMetrics;
|
|
1561
|
+
}
|
|
1540
1562
|
|
|
1541
1563
|
/**
|
|
1542
1564
|
* Webhook topic types
|
|
@@ -3703,6 +3725,10 @@ declare class MetricsResource extends BaseResource {
|
|
|
3703
3725
|
* Get usage metric data
|
|
3704
3726
|
*/
|
|
3705
3727
|
usageMetric(params: UsageMetricParams): Promise<MetricsResponse>;
|
|
3728
|
+
/**
|
|
3729
|
+
* Get key sales metrics
|
|
3730
|
+
*/
|
|
3731
|
+
sales(params?: SalesMetricsParams): Promise<SalesMetricsResponse>;
|
|
3706
3732
|
}
|
|
3707
3733
|
|
|
3708
3734
|
/**
|
|
@@ -4494,4 +4520,4 @@ interface RateLimitOptions {
|
|
|
4494
4520
|
*/
|
|
4495
4521
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
4496
4522
|
|
|
4497
|
-
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, type AgentRun, type AgentRunCreateParams, type AgentRunCreateResponse, type AgentRunRetrieveResponse, type AgentRunStatus, type AgentRunTokenUsage, 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 ContactCreateResponse, 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 DocRepository, type DocRepositoryCollection, type DocRepositoryListParams, type DocRepositoryListResponse, type DocRepositoryLocale, type DocRepositoryRetrieveParams, type DocTreeNode, type DocTreeResponse, DocsResource, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupAddMembersParams, type EmailUnsubscribeGroupAddMembersResponse, type EmailUnsubscribeGroupListParams, type EmailUnsubscribeGroupListResponse, type EmailUnsubscribeGroupMember, type EmailUnsubscribeGroupMemberListParams, type EmailUnsubscribeGroupMemberListResponse, type EmailUnsubscribeGroupRemoveMembersParams, type EmailUnsubscribeGroupRemoveMembersResponse, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowActionRun, type FlowActionRunStatus, type FlowActionRunUpdateParams, type FlowCreateParams, type FlowExtensionAction, type FlowExtensionActionCreateParams, type FlowExtensionActionListParams, type FlowExtensionActionListResponse, type FlowExtensionActionUpdateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type JournalEntry, type JournalEntryCreateParams, type JournalEntryFile, type JournalEntryListParams, type JournalEntryListResponse, type JournalEntryUpdateParams, type List, type ListAddEntitiesParams, type ListAddEntitiesResponse, type ListCreateParams, type ListEntity, type ListListParams, type ListListResponse, type ListParams, type ListRemoveEntitiesParams, type ListRemoveEntitiesResponse, type ListRetrieveParams, type ListRetrieveResponse, type ListUpdateParams, 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 TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, 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 };
|
|
4523
|
+
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, type AgentRun, type AgentRunCreateParams, type AgentRunCreateResponse, type AgentRunRetrieveResponse, type AgentRunStatus, type AgentRunTokenUsage, 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 ContactCreateResponse, 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 DocRepository, type DocRepositoryCollection, type DocRepositoryListParams, type DocRepositoryListResponse, type DocRepositoryLocale, type DocRepositoryRetrieveParams, type DocTreeNode, type DocTreeResponse, DocsResource, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupAddMembersParams, type EmailUnsubscribeGroupAddMembersResponse, type EmailUnsubscribeGroupListParams, type EmailUnsubscribeGroupListResponse, type EmailUnsubscribeGroupMember, type EmailUnsubscribeGroupMemberListParams, type EmailUnsubscribeGroupMemberListResponse, type EmailUnsubscribeGroupRemoveMembersParams, type EmailUnsubscribeGroupRemoveMembersResponse, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowActionRun, type FlowActionRunStatus, type FlowActionRunUpdateParams, type FlowCreateParams, type FlowExtensionAction, type FlowExtensionActionCreateParams, type FlowExtensionActionListParams, type FlowExtensionActionListResponse, type FlowExtensionActionUpdateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type JournalEntry, type JournalEntryCreateParams, type JournalEntryFile, type JournalEntryListParams, type JournalEntryListResponse, type JournalEntryUpdateParams, type List, type ListAddEntitiesParams, type ListAddEntitiesResponse, type ListCreateParams, type ListEntity, type ListListParams, type ListListResponse, type ListParams, type ListRemoveEntitiesParams, type ListRemoveEntitiesResponse, type ListRetrieveParams, type ListRetrieveResponse, type ListUpdateParams, 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 SalesMetrics, type SalesMetricsParams, type SalesMetricsResponse, 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 TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, 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
|
@@ -1537,6 +1537,28 @@ interface UsageEventMetricsParams extends MetricsBaseParams {
|
|
|
1537
1537
|
interface UsageMetricParams extends MetricsBaseParams {
|
|
1538
1538
|
metricId: string;
|
|
1539
1539
|
}
|
|
1540
|
+
/**
|
|
1541
|
+
* Parameters for sales metrics request
|
|
1542
|
+
*/
|
|
1543
|
+
interface SalesMetricsParams {
|
|
1544
|
+
userId?: string;
|
|
1545
|
+
}
|
|
1546
|
+
/**
|
|
1547
|
+
* Sales metrics data
|
|
1548
|
+
*/
|
|
1549
|
+
interface SalesMetrics {
|
|
1550
|
+
attributedRevenue: number;
|
|
1551
|
+
activeDeals: number;
|
|
1552
|
+
activeDealsTotalAmount: number;
|
|
1553
|
+
winRate: number;
|
|
1554
|
+
avgDealSize: number;
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
* Response from sales metrics endpoint
|
|
1558
|
+
*/
|
|
1559
|
+
interface SalesMetricsResponse {
|
|
1560
|
+
metrics: SalesMetrics;
|
|
1561
|
+
}
|
|
1540
1562
|
|
|
1541
1563
|
/**
|
|
1542
1564
|
* Webhook topic types
|
|
@@ -3703,6 +3725,10 @@ declare class MetricsResource extends BaseResource {
|
|
|
3703
3725
|
* Get usage metric data
|
|
3704
3726
|
*/
|
|
3705
3727
|
usageMetric(params: UsageMetricParams): Promise<MetricsResponse>;
|
|
3728
|
+
/**
|
|
3729
|
+
* Get key sales metrics
|
|
3730
|
+
*/
|
|
3731
|
+
sales(params?: SalesMetricsParams): Promise<SalesMetricsResponse>;
|
|
3706
3732
|
}
|
|
3707
3733
|
|
|
3708
3734
|
/**
|
|
@@ -4494,4 +4520,4 @@ interface RateLimitOptions {
|
|
|
4494
4520
|
*/
|
|
4495
4521
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
4496
4522
|
|
|
4497
|
-
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, type AgentRun, type AgentRunCreateParams, type AgentRunCreateResponse, type AgentRunRetrieveResponse, type AgentRunStatus, type AgentRunTokenUsage, 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 ContactCreateResponse, 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 DocRepository, type DocRepositoryCollection, type DocRepositoryListParams, type DocRepositoryListResponse, type DocRepositoryLocale, type DocRepositoryRetrieveParams, type DocTreeNode, type DocTreeResponse, DocsResource, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupAddMembersParams, type EmailUnsubscribeGroupAddMembersResponse, type EmailUnsubscribeGroupListParams, type EmailUnsubscribeGroupListResponse, type EmailUnsubscribeGroupMember, type EmailUnsubscribeGroupMemberListParams, type EmailUnsubscribeGroupMemberListResponse, type EmailUnsubscribeGroupRemoveMembersParams, type EmailUnsubscribeGroupRemoveMembersResponse, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowActionRun, type FlowActionRunStatus, type FlowActionRunUpdateParams, type FlowCreateParams, type FlowExtensionAction, type FlowExtensionActionCreateParams, type FlowExtensionActionListParams, type FlowExtensionActionListResponse, type FlowExtensionActionUpdateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type JournalEntry, type JournalEntryCreateParams, type JournalEntryFile, type JournalEntryListParams, type JournalEntryListResponse, type JournalEntryUpdateParams, type List, type ListAddEntitiesParams, type ListAddEntitiesResponse, type ListCreateParams, type ListEntity, type ListListParams, type ListListResponse, type ListParams, type ListRemoveEntitiesParams, type ListRemoveEntitiesResponse, type ListRetrieveParams, type ListRetrieveResponse, type ListUpdateParams, 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 TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, 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 };
|
|
4523
|
+
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, type AgentRun, type AgentRunCreateParams, type AgentRunCreateResponse, type AgentRunRetrieveResponse, type AgentRunStatus, type AgentRunTokenUsage, 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 ContactCreateResponse, 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 DocRepository, type DocRepositoryCollection, type DocRepositoryListParams, type DocRepositoryListResponse, type DocRepositoryLocale, type DocRepositoryRetrieveParams, type DocTreeNode, type DocTreeResponse, DocsResource, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupAddMembersParams, type EmailUnsubscribeGroupAddMembersResponse, type EmailUnsubscribeGroupListParams, type EmailUnsubscribeGroupListResponse, type EmailUnsubscribeGroupMember, type EmailUnsubscribeGroupMemberListParams, type EmailUnsubscribeGroupMemberListResponse, type EmailUnsubscribeGroupRemoveMembersParams, type EmailUnsubscribeGroupRemoveMembersResponse, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowActionRun, type FlowActionRunStatus, type FlowActionRunUpdateParams, type FlowCreateParams, type FlowExtensionAction, type FlowExtensionActionCreateParams, type FlowExtensionActionListParams, type FlowExtensionActionListResponse, type FlowExtensionActionUpdateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type JournalEntry, type JournalEntryCreateParams, type JournalEntryFile, type JournalEntryListParams, type JournalEntryListResponse, type JournalEntryUpdateParams, type List, type ListAddEntitiesParams, type ListAddEntitiesResponse, type ListCreateParams, type ListEntity, type ListListParams, type ListListResponse, type ListParams, type ListRemoveEntitiesParams, type ListRemoveEntitiesResponse, type ListRetrieveParams, type ListRetrieveResponse, type ListUpdateParams, 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 SalesMetrics, type SalesMetricsParams, type SalesMetricsResponse, 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 TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, 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
|
@@ -1698,6 +1698,12 @@ var MetricsResource = class extends BaseResource {
|
|
|
1698
1698
|
...params
|
|
1699
1699
|
});
|
|
1700
1700
|
}
|
|
1701
|
+
/**
|
|
1702
|
+
* Get key sales metrics
|
|
1703
|
+
*/
|
|
1704
|
+
async sales(params) {
|
|
1705
|
+
return this.get("/metrics/sales", params);
|
|
1706
|
+
}
|
|
1701
1707
|
};
|
|
1702
1708
|
|
|
1703
1709
|
// src/resources/users.ts
|
package/dist/index.mjs
CHANGED
|
@@ -1632,6 +1632,12 @@ var MetricsResource = class extends BaseResource {
|
|
|
1632
1632
|
...params
|
|
1633
1633
|
});
|
|
1634
1634
|
}
|
|
1635
|
+
/**
|
|
1636
|
+
* Get key sales metrics
|
|
1637
|
+
*/
|
|
1638
|
+
async sales(params) {
|
|
1639
|
+
return this.get("/metrics/sales", params);
|
|
1640
|
+
}
|
|
1635
1641
|
};
|
|
1636
1642
|
|
|
1637
1643
|
// src/resources/users.ts
|