@heymantle/core-api-client 0.5.2 → 0.5.4
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 +100 -3
- package/dist/index.d.ts +100 -3
- package/dist/index.js +3 -0
- package/dist/index.mjs +3 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1680,6 +1680,64 @@ type paths = {
|
|
|
1680
1680
|
patch?: never;
|
|
1681
1681
|
trace?: never;
|
|
1682
1682
|
};
|
|
1683
|
+
"/api/core/v1/metrics/subscriptionChurn": {
|
|
1684
|
+
parameters: {
|
|
1685
|
+
query?: never;
|
|
1686
|
+
header?: never;
|
|
1687
|
+
path?: never;
|
|
1688
|
+
cookie?: never;
|
|
1689
|
+
};
|
|
1690
|
+
/**
|
|
1691
|
+
* subscriptionChurn
|
|
1692
|
+
* @description Returns subscription churn data with optional time series breakdown
|
|
1693
|
+
*/
|
|
1694
|
+
get: {
|
|
1695
|
+
parameters: {
|
|
1696
|
+
query?: {
|
|
1697
|
+
/** @description Filter by specific app IDs (comma-separated) */
|
|
1698
|
+
appIds?: components["parameters"]["AppIds"];
|
|
1699
|
+
/** @description Filter by specific app installation IDs (comma-separated) */
|
|
1700
|
+
appInstallationIds?: components["parameters"]["AppInstallationIds"];
|
|
1701
|
+
/** @description Filter by specific customer ID */
|
|
1702
|
+
customerId?: components["parameters"]["CustomerId"];
|
|
1703
|
+
/** @description Filter by customer segment ID */
|
|
1704
|
+
customerSegmentId?: components["parameters"]["CustomerSegmentId"];
|
|
1705
|
+
/** @description Time series interval (only returns time series if provided) */
|
|
1706
|
+
interval?: components["parameters"]["Interval"];
|
|
1707
|
+
/** @description Predefined time period (overrides periodStart/periodEnd) */
|
|
1708
|
+
period?: components["parameters"]["Period"];
|
|
1709
|
+
/** @description Custom end date (YYYY-MM-DD, defaults to now) */
|
|
1710
|
+
periodEnd?: components["parameters"]["PeriodEnd"];
|
|
1711
|
+
/** @description Custom start date (YYYY-MM-DD) */
|
|
1712
|
+
periodStart?: components["parameters"]["PeriodStart"];
|
|
1713
|
+
};
|
|
1714
|
+
header?: never;
|
|
1715
|
+
path?: never;
|
|
1716
|
+
cookie?: never;
|
|
1717
|
+
};
|
|
1718
|
+
requestBody?: never;
|
|
1719
|
+
responses: {
|
|
1720
|
+
/** @description Subscription churn metrics data */
|
|
1721
|
+
200: {
|
|
1722
|
+
headers: {
|
|
1723
|
+
[name: string]: unknown;
|
|
1724
|
+
};
|
|
1725
|
+
content: {
|
|
1726
|
+
"application/json": components["schemas"]["SubscriptionChurnResponse"];
|
|
1727
|
+
};
|
|
1728
|
+
};
|
|
1729
|
+
400: components["responses"]["BadRequest"];
|
|
1730
|
+
500: components["responses"]["InternalServerError"];
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
put?: never;
|
|
1734
|
+
post?: never;
|
|
1735
|
+
delete?: never;
|
|
1736
|
+
options?: never;
|
|
1737
|
+
head?: never;
|
|
1738
|
+
patch?: never;
|
|
1739
|
+
trace?: never;
|
|
1740
|
+
};
|
|
1683
1741
|
"/api/core/v1/metrics/usageEvent": {
|
|
1684
1742
|
parameters: {
|
|
1685
1743
|
query?: never;
|
|
@@ -7158,7 +7216,7 @@ type paths = {
|
|
|
7158
7216
|
* @description Status of the collection
|
|
7159
7217
|
* @enum {string}
|
|
7160
7218
|
*/
|
|
7161
|
-
status?: "draft" | "
|
|
7219
|
+
status?: "draft" | "active";
|
|
7162
7220
|
/** @description Title of the collection */
|
|
7163
7221
|
title: string;
|
|
7164
7222
|
};
|
|
@@ -7234,7 +7292,7 @@ type paths = {
|
|
|
7234
7292
|
* @description Status of the collection
|
|
7235
7293
|
* @enum {string}
|
|
7236
7294
|
*/
|
|
7237
|
-
status?: "draft" | "
|
|
7295
|
+
status?: "draft" | "active";
|
|
7238
7296
|
/** @description Title of the collection */
|
|
7239
7297
|
title?: string;
|
|
7240
7298
|
};
|
|
@@ -18399,6 +18457,31 @@ type components = {
|
|
|
18399
18457
|
usageBalanceUsed?: number;
|
|
18400
18458
|
usageCappedAmount?: number;
|
|
18401
18459
|
};
|
|
18460
|
+
SubscriptionChurnResponse: {
|
|
18461
|
+
/**
|
|
18462
|
+
* @description Data format type
|
|
18463
|
+
* @enum {string}
|
|
18464
|
+
*/
|
|
18465
|
+
format?: "percent";
|
|
18466
|
+
/** @description Period used for the query */
|
|
18467
|
+
period?: string;
|
|
18468
|
+
/**
|
|
18469
|
+
* Format: date-time
|
|
18470
|
+
* @description End date of the period
|
|
18471
|
+
*/
|
|
18472
|
+
periodEnd?: string;
|
|
18473
|
+
/**
|
|
18474
|
+
* Format: date-time
|
|
18475
|
+
* @description Start date of the period
|
|
18476
|
+
*/
|
|
18477
|
+
periodStart?: string;
|
|
18478
|
+
/** @description Time series data (only present if interval is provided) */
|
|
18479
|
+
timeSeries?: components["schemas"]["TimeSeriesDataPoint"][];
|
|
18480
|
+
/** @description Interval used for time series (only present if interval is provided) */
|
|
18481
|
+
timeSeriesInterval?: string;
|
|
18482
|
+
/** @description Current period subscription churn percentage */
|
|
18483
|
+
value?: number;
|
|
18484
|
+
};
|
|
18402
18485
|
SubscriptionWebhook: {
|
|
18403
18486
|
subscription?: {
|
|
18404
18487
|
/**
|
|
@@ -25770,6 +25853,19 @@ declare class MetricsResource extends BaseResource {
|
|
|
25770
25853
|
timeSeriesInterval?: string | undefined;
|
|
25771
25854
|
value?: number | undefined;
|
|
25772
25855
|
}>;
|
|
25856
|
+
subscriptionChurn(params?: paths['/api/core/v1/metrics/subscriptionChurn']['get']['parameters']['query']): Promise<{
|
|
25857
|
+
format?: "percent" | undefined;
|
|
25858
|
+
period?: string | undefined;
|
|
25859
|
+
periodEnd?: string | undefined;
|
|
25860
|
+
periodStart?: string | undefined;
|
|
25861
|
+
timeSeries?: {
|
|
25862
|
+
periodEnd?: string | undefined;
|
|
25863
|
+
periodStart?: string | undefined;
|
|
25864
|
+
value?: number | undefined;
|
|
25865
|
+
}[] | undefined;
|
|
25866
|
+
timeSeriesInterval?: string | undefined;
|
|
25867
|
+
value?: number | undefined;
|
|
25868
|
+
}>;
|
|
25773
25869
|
usageEvent(params: paths['/api/core/v1/metrics/usageEvent']['get']['parameters']['query']): Promise<{
|
|
25774
25870
|
format?: "count" | undefined;
|
|
25775
25871
|
period?: string | undefined;
|
|
@@ -27839,6 +27935,7 @@ type Review = components['schemas']['Review'];
|
|
|
27839
27935
|
type ReviewWebhook = components['schemas']['ReviewWebhook'];
|
|
27840
27936
|
type StandardMetricResponse = components['schemas']['StandardMetricResponse'];
|
|
27841
27937
|
type Subscription = components['schemas']['Subscription'];
|
|
27938
|
+
type SubscriptionChurnResponse = components['schemas']['SubscriptionChurnResponse'];
|
|
27842
27939
|
type SubscriptionWebhook = components['schemas']['SubscriptionWebhook'];
|
|
27843
27940
|
type SyncedEmail = components['schemas']['SyncedEmail'];
|
|
27844
27941
|
type SyncedEmailContact = components['schemas']['SyncedEmailContact'];
|
|
@@ -27959,4 +28056,4 @@ interface RateLimitOptions {
|
|
|
27959
28056
|
*/
|
|
27960
28057
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
27961
28058
|
|
|
27962
|
-
export { type AccountOwner, type AccountOwnerType, type Action, type ActiveSubscriptionsResponse, type Affiliate, type AffiliateAttributionWebhook, type AffiliateCommission, AffiliateCommissionsResource, type AffiliateMembershipWebhook, type AffiliatePayout, type AffiliatePayoutWebhook, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramGroup, type AffiliateProgramMembership, type AffiliateProgramWebhook, AffiliateProgramsResource, type AffiliateReferral, AffiliateReferralsResource, type AffiliateRules, type AffiliateRulesWebhook, type AffiliateWebhook, AffiliatesResource, type Agent, type AgentRun, AgentsResource, AiAgentRunsResource, type App, type AppChargeWebhook, type AppEvent, type AppInstallation, type AppInstallationWebhook, type AppWebhook, AppsResource, type BaseCustomerWebhook, BaseResource, ChannelsResource, type Charge, ChargesResource, type Checklist, type ChecklistStep, CompaniesResource, type Company, type Contact, type ContactWebhook, ContactsResource, type CursorPagination, CustomDataResource, type CustomField, type CustomFieldDefaultValue, type Customer, type CustomerContact, type CustomerContactWebhook, type CustomerSegment, CustomerSegmentsResource, type CustomerWebhook, type CustomerWithoutSubscriptionWebhook, CustomersResource, type Deal, type DealAcquirer, DealActivitiesResource, type DealActivity, type DealAffiliate, type DealApp, type DealContact, type DealCustomData, type DealCustomer, type DealEvent, type DealFlow, type DealFlowAffiliate, type DealFlowDefaultSource, type DealFlowPartnership, type DealFlowStage, type DealFlowUser, DealFlowsResource, type DealOwner, type DealPartnership, type DealPlan, type DealStage, DealsResource, type DetailedAffiliate, type DetailedFlow, type DocsCollection, type DocsCollectionResponse, type DocsGenerateJobResponse, type DocsGenerateStatusCompleted, type DocsGenerateStatusFailed, type DocsGenerateStatusPending, type DocsGroup, type DocsGroupResponse, type DocsPage, type DocsPageResponse, type DocsPageSummary, type DocsRepository, type DocsRepositoryResponse, DocsResource, type EmailCampaign, type EmailDelivery, type EmailDeliveryStats, type EmailLayout, type EmailPreview, type EmailSender, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupMember, EmailUnsubscribeGroupsResource, EntitiesResource, type EventWebhook, type ExtensionUninstallPayload, type ExtensionWebhook, type Feature, type Flow, type FlowActionRun, FlowExtensionsResource, FlowsResource, type InvalidTokenError, type Invoice, type InvoiceWebhook, JournalEntriesResource, type JournalEntry, type JournalEntryApp, type JournalEntryFile, type List, ListsResource, type LogoChurnResponse, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type Meeting, type MeetingAttendee, type MeetingAttendeeRef, type MeetingContactRef, type MeetingCustomer, type MeetingDeal, type MeetingPermission, type MeetingTaskSuggestion, type MeetingTranscript, type MeetingUser, type MeetingUtterance, MeetingsResource, MetricsResource, type MissingScopesError, type MrrResponse, type NetInstallsResponse, type NetRevenueResponse, type NetRevenueRetentionResponse, type Organization, OrganizationResource, type Pagination, type PayoutResponse, type Plan, type PlanFeature, type PlanFeatureWebhook, type PlanUsageChargeWebhook, type PlanWebhook, type PredictedLtvResponse, type RateLimitOptions, type RevenueRetentionResponse, type Review, type ReviewWebhook, type StandardMetricResponse, type Subscription, type SubscriptionWebhook, SubscriptionsResource, type SyncedEmail, type SyncedEmailContact, type SyncedEmailCustomer, type SyncedEmailDeal, type SyncedEmailMessage, type SyncedEmailUser, SyncedEmailsResource, type Task, type TaskComment, type TaskTodoItem, TasksResource, type ThreadEventType, type ThreadMessageWebhook, type ThreadWebhook, type Ticket, type TicketAgent, type TicketApp, type TicketAttachment, type TicketChannel, type TicketContact, type TicketCustomer, type TicketEvent, type TicketLoop, type TicketMessage, TicketsResource, type TimeSeriesDataPoint, type TimelineComment, TimelineCommentsResource, type Transaction, type TransactionWebhook, TransactionsResource, type Trigger, type UninstallEventWebhook, type UsageEvent, type UsageEventResponse, UsageEventsResource, type UsageMetric, type UsageMetricResponse, type User, UsersResource, type Webhook, WebhooksResource, type components, createRateLimitMiddleware, type paths };
|
|
28059
|
+
export { type AccountOwner, type AccountOwnerType, type Action, type ActiveSubscriptionsResponse, type Affiliate, type AffiliateAttributionWebhook, type AffiliateCommission, AffiliateCommissionsResource, type AffiliateMembershipWebhook, type AffiliatePayout, type AffiliatePayoutWebhook, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramGroup, type AffiliateProgramMembership, type AffiliateProgramWebhook, AffiliateProgramsResource, type AffiliateReferral, AffiliateReferralsResource, type AffiliateRules, type AffiliateRulesWebhook, type AffiliateWebhook, AffiliatesResource, type Agent, type AgentRun, AgentsResource, AiAgentRunsResource, type App, type AppChargeWebhook, type AppEvent, type AppInstallation, type AppInstallationWebhook, type AppWebhook, AppsResource, type BaseCustomerWebhook, BaseResource, ChannelsResource, type Charge, ChargesResource, type Checklist, type ChecklistStep, CompaniesResource, type Company, type Contact, type ContactWebhook, ContactsResource, type CursorPagination, CustomDataResource, type CustomField, type CustomFieldDefaultValue, type Customer, type CustomerContact, type CustomerContactWebhook, type CustomerSegment, CustomerSegmentsResource, type CustomerWebhook, type CustomerWithoutSubscriptionWebhook, CustomersResource, type Deal, type DealAcquirer, DealActivitiesResource, type DealActivity, type DealAffiliate, type DealApp, type DealContact, type DealCustomData, type DealCustomer, type DealEvent, type DealFlow, type DealFlowAffiliate, type DealFlowDefaultSource, type DealFlowPartnership, type DealFlowStage, type DealFlowUser, DealFlowsResource, type DealOwner, type DealPartnership, type DealPlan, type DealStage, DealsResource, type DetailedAffiliate, type DetailedFlow, type DocsCollection, type DocsCollectionResponse, type DocsGenerateJobResponse, type DocsGenerateStatusCompleted, type DocsGenerateStatusFailed, type DocsGenerateStatusPending, type DocsGroup, type DocsGroupResponse, type DocsPage, type DocsPageResponse, type DocsPageSummary, type DocsRepository, type DocsRepositoryResponse, DocsResource, type EmailCampaign, type EmailDelivery, type EmailDeliveryStats, type EmailLayout, type EmailPreview, type EmailSender, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupMember, EmailUnsubscribeGroupsResource, EntitiesResource, type EventWebhook, type ExtensionUninstallPayload, type ExtensionWebhook, type Feature, type Flow, type FlowActionRun, FlowExtensionsResource, FlowsResource, type InvalidTokenError, type Invoice, type InvoiceWebhook, JournalEntriesResource, type JournalEntry, type JournalEntryApp, type JournalEntryFile, type List, ListsResource, type LogoChurnResponse, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type Meeting, type MeetingAttendee, type MeetingAttendeeRef, type MeetingContactRef, type MeetingCustomer, type MeetingDeal, type MeetingPermission, type MeetingTaskSuggestion, type MeetingTranscript, type MeetingUser, type MeetingUtterance, MeetingsResource, MetricsResource, type MissingScopesError, type MrrResponse, type NetInstallsResponse, type NetRevenueResponse, type NetRevenueRetentionResponse, type Organization, OrganizationResource, type Pagination, type PayoutResponse, type Plan, type PlanFeature, type PlanFeatureWebhook, type PlanUsageChargeWebhook, type PlanWebhook, type PredictedLtvResponse, type RateLimitOptions, type RevenueRetentionResponse, type Review, type ReviewWebhook, type StandardMetricResponse, type Subscription, type SubscriptionChurnResponse, type SubscriptionWebhook, SubscriptionsResource, type SyncedEmail, type SyncedEmailContact, type SyncedEmailCustomer, type SyncedEmailDeal, type SyncedEmailMessage, type SyncedEmailUser, SyncedEmailsResource, type Task, type TaskComment, type TaskTodoItem, TasksResource, type ThreadEventType, type ThreadMessageWebhook, type ThreadWebhook, type Ticket, type TicketAgent, type TicketApp, type TicketAttachment, type TicketChannel, type TicketContact, type TicketCustomer, type TicketEvent, type TicketLoop, type TicketMessage, TicketsResource, type TimeSeriesDataPoint, type TimelineComment, TimelineCommentsResource, type Transaction, type TransactionWebhook, TransactionsResource, type Trigger, type UninstallEventWebhook, type UsageEvent, type UsageEventResponse, UsageEventsResource, type UsageMetric, type UsageMetricResponse, type User, UsersResource, type Webhook, WebhooksResource, type components, createRateLimitMiddleware, type paths };
|
package/dist/index.d.ts
CHANGED
|
@@ -1680,6 +1680,64 @@ type paths = {
|
|
|
1680
1680
|
patch?: never;
|
|
1681
1681
|
trace?: never;
|
|
1682
1682
|
};
|
|
1683
|
+
"/api/core/v1/metrics/subscriptionChurn": {
|
|
1684
|
+
parameters: {
|
|
1685
|
+
query?: never;
|
|
1686
|
+
header?: never;
|
|
1687
|
+
path?: never;
|
|
1688
|
+
cookie?: never;
|
|
1689
|
+
};
|
|
1690
|
+
/**
|
|
1691
|
+
* subscriptionChurn
|
|
1692
|
+
* @description Returns subscription churn data with optional time series breakdown
|
|
1693
|
+
*/
|
|
1694
|
+
get: {
|
|
1695
|
+
parameters: {
|
|
1696
|
+
query?: {
|
|
1697
|
+
/** @description Filter by specific app IDs (comma-separated) */
|
|
1698
|
+
appIds?: components["parameters"]["AppIds"];
|
|
1699
|
+
/** @description Filter by specific app installation IDs (comma-separated) */
|
|
1700
|
+
appInstallationIds?: components["parameters"]["AppInstallationIds"];
|
|
1701
|
+
/** @description Filter by specific customer ID */
|
|
1702
|
+
customerId?: components["parameters"]["CustomerId"];
|
|
1703
|
+
/** @description Filter by customer segment ID */
|
|
1704
|
+
customerSegmentId?: components["parameters"]["CustomerSegmentId"];
|
|
1705
|
+
/** @description Time series interval (only returns time series if provided) */
|
|
1706
|
+
interval?: components["parameters"]["Interval"];
|
|
1707
|
+
/** @description Predefined time period (overrides periodStart/periodEnd) */
|
|
1708
|
+
period?: components["parameters"]["Period"];
|
|
1709
|
+
/** @description Custom end date (YYYY-MM-DD, defaults to now) */
|
|
1710
|
+
periodEnd?: components["parameters"]["PeriodEnd"];
|
|
1711
|
+
/** @description Custom start date (YYYY-MM-DD) */
|
|
1712
|
+
periodStart?: components["parameters"]["PeriodStart"];
|
|
1713
|
+
};
|
|
1714
|
+
header?: never;
|
|
1715
|
+
path?: never;
|
|
1716
|
+
cookie?: never;
|
|
1717
|
+
};
|
|
1718
|
+
requestBody?: never;
|
|
1719
|
+
responses: {
|
|
1720
|
+
/** @description Subscription churn metrics data */
|
|
1721
|
+
200: {
|
|
1722
|
+
headers: {
|
|
1723
|
+
[name: string]: unknown;
|
|
1724
|
+
};
|
|
1725
|
+
content: {
|
|
1726
|
+
"application/json": components["schemas"]["SubscriptionChurnResponse"];
|
|
1727
|
+
};
|
|
1728
|
+
};
|
|
1729
|
+
400: components["responses"]["BadRequest"];
|
|
1730
|
+
500: components["responses"]["InternalServerError"];
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
put?: never;
|
|
1734
|
+
post?: never;
|
|
1735
|
+
delete?: never;
|
|
1736
|
+
options?: never;
|
|
1737
|
+
head?: never;
|
|
1738
|
+
patch?: never;
|
|
1739
|
+
trace?: never;
|
|
1740
|
+
};
|
|
1683
1741
|
"/api/core/v1/metrics/usageEvent": {
|
|
1684
1742
|
parameters: {
|
|
1685
1743
|
query?: never;
|
|
@@ -7158,7 +7216,7 @@ type paths = {
|
|
|
7158
7216
|
* @description Status of the collection
|
|
7159
7217
|
* @enum {string}
|
|
7160
7218
|
*/
|
|
7161
|
-
status?: "draft" | "
|
|
7219
|
+
status?: "draft" | "active";
|
|
7162
7220
|
/** @description Title of the collection */
|
|
7163
7221
|
title: string;
|
|
7164
7222
|
};
|
|
@@ -7234,7 +7292,7 @@ type paths = {
|
|
|
7234
7292
|
* @description Status of the collection
|
|
7235
7293
|
* @enum {string}
|
|
7236
7294
|
*/
|
|
7237
|
-
status?: "draft" | "
|
|
7295
|
+
status?: "draft" | "active";
|
|
7238
7296
|
/** @description Title of the collection */
|
|
7239
7297
|
title?: string;
|
|
7240
7298
|
};
|
|
@@ -18399,6 +18457,31 @@ type components = {
|
|
|
18399
18457
|
usageBalanceUsed?: number;
|
|
18400
18458
|
usageCappedAmount?: number;
|
|
18401
18459
|
};
|
|
18460
|
+
SubscriptionChurnResponse: {
|
|
18461
|
+
/**
|
|
18462
|
+
* @description Data format type
|
|
18463
|
+
* @enum {string}
|
|
18464
|
+
*/
|
|
18465
|
+
format?: "percent";
|
|
18466
|
+
/** @description Period used for the query */
|
|
18467
|
+
period?: string;
|
|
18468
|
+
/**
|
|
18469
|
+
* Format: date-time
|
|
18470
|
+
* @description End date of the period
|
|
18471
|
+
*/
|
|
18472
|
+
periodEnd?: string;
|
|
18473
|
+
/**
|
|
18474
|
+
* Format: date-time
|
|
18475
|
+
* @description Start date of the period
|
|
18476
|
+
*/
|
|
18477
|
+
periodStart?: string;
|
|
18478
|
+
/** @description Time series data (only present if interval is provided) */
|
|
18479
|
+
timeSeries?: components["schemas"]["TimeSeriesDataPoint"][];
|
|
18480
|
+
/** @description Interval used for time series (only present if interval is provided) */
|
|
18481
|
+
timeSeriesInterval?: string;
|
|
18482
|
+
/** @description Current period subscription churn percentage */
|
|
18483
|
+
value?: number;
|
|
18484
|
+
};
|
|
18402
18485
|
SubscriptionWebhook: {
|
|
18403
18486
|
subscription?: {
|
|
18404
18487
|
/**
|
|
@@ -25770,6 +25853,19 @@ declare class MetricsResource extends BaseResource {
|
|
|
25770
25853
|
timeSeriesInterval?: string | undefined;
|
|
25771
25854
|
value?: number | undefined;
|
|
25772
25855
|
}>;
|
|
25856
|
+
subscriptionChurn(params?: paths['/api/core/v1/metrics/subscriptionChurn']['get']['parameters']['query']): Promise<{
|
|
25857
|
+
format?: "percent" | undefined;
|
|
25858
|
+
period?: string | undefined;
|
|
25859
|
+
periodEnd?: string | undefined;
|
|
25860
|
+
periodStart?: string | undefined;
|
|
25861
|
+
timeSeries?: {
|
|
25862
|
+
periodEnd?: string | undefined;
|
|
25863
|
+
periodStart?: string | undefined;
|
|
25864
|
+
value?: number | undefined;
|
|
25865
|
+
}[] | undefined;
|
|
25866
|
+
timeSeriesInterval?: string | undefined;
|
|
25867
|
+
value?: number | undefined;
|
|
25868
|
+
}>;
|
|
25773
25869
|
usageEvent(params: paths['/api/core/v1/metrics/usageEvent']['get']['parameters']['query']): Promise<{
|
|
25774
25870
|
format?: "count" | undefined;
|
|
25775
25871
|
period?: string | undefined;
|
|
@@ -27839,6 +27935,7 @@ type Review = components['schemas']['Review'];
|
|
|
27839
27935
|
type ReviewWebhook = components['schemas']['ReviewWebhook'];
|
|
27840
27936
|
type StandardMetricResponse = components['schemas']['StandardMetricResponse'];
|
|
27841
27937
|
type Subscription = components['schemas']['Subscription'];
|
|
27938
|
+
type SubscriptionChurnResponse = components['schemas']['SubscriptionChurnResponse'];
|
|
27842
27939
|
type SubscriptionWebhook = components['schemas']['SubscriptionWebhook'];
|
|
27843
27940
|
type SyncedEmail = components['schemas']['SyncedEmail'];
|
|
27844
27941
|
type SyncedEmailContact = components['schemas']['SyncedEmailContact'];
|
|
@@ -27959,4 +28056,4 @@ interface RateLimitOptions {
|
|
|
27959
28056
|
*/
|
|
27960
28057
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
27961
28058
|
|
|
27962
|
-
export { type AccountOwner, type AccountOwnerType, type Action, type ActiveSubscriptionsResponse, type Affiliate, type AffiliateAttributionWebhook, type AffiliateCommission, AffiliateCommissionsResource, type AffiliateMembershipWebhook, type AffiliatePayout, type AffiliatePayoutWebhook, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramGroup, type AffiliateProgramMembership, type AffiliateProgramWebhook, AffiliateProgramsResource, type AffiliateReferral, AffiliateReferralsResource, type AffiliateRules, type AffiliateRulesWebhook, type AffiliateWebhook, AffiliatesResource, type Agent, type AgentRun, AgentsResource, AiAgentRunsResource, type App, type AppChargeWebhook, type AppEvent, type AppInstallation, type AppInstallationWebhook, type AppWebhook, AppsResource, type BaseCustomerWebhook, BaseResource, ChannelsResource, type Charge, ChargesResource, type Checklist, type ChecklistStep, CompaniesResource, type Company, type Contact, type ContactWebhook, ContactsResource, type CursorPagination, CustomDataResource, type CustomField, type CustomFieldDefaultValue, type Customer, type CustomerContact, type CustomerContactWebhook, type CustomerSegment, CustomerSegmentsResource, type CustomerWebhook, type CustomerWithoutSubscriptionWebhook, CustomersResource, type Deal, type DealAcquirer, DealActivitiesResource, type DealActivity, type DealAffiliate, type DealApp, type DealContact, type DealCustomData, type DealCustomer, type DealEvent, type DealFlow, type DealFlowAffiliate, type DealFlowDefaultSource, type DealFlowPartnership, type DealFlowStage, type DealFlowUser, DealFlowsResource, type DealOwner, type DealPartnership, type DealPlan, type DealStage, DealsResource, type DetailedAffiliate, type DetailedFlow, type DocsCollection, type DocsCollectionResponse, type DocsGenerateJobResponse, type DocsGenerateStatusCompleted, type DocsGenerateStatusFailed, type DocsGenerateStatusPending, type DocsGroup, type DocsGroupResponse, type DocsPage, type DocsPageResponse, type DocsPageSummary, type DocsRepository, type DocsRepositoryResponse, DocsResource, type EmailCampaign, type EmailDelivery, type EmailDeliveryStats, type EmailLayout, type EmailPreview, type EmailSender, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupMember, EmailUnsubscribeGroupsResource, EntitiesResource, type EventWebhook, type ExtensionUninstallPayload, type ExtensionWebhook, type Feature, type Flow, type FlowActionRun, FlowExtensionsResource, FlowsResource, type InvalidTokenError, type Invoice, type InvoiceWebhook, JournalEntriesResource, type JournalEntry, type JournalEntryApp, type JournalEntryFile, type List, ListsResource, type LogoChurnResponse, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type Meeting, type MeetingAttendee, type MeetingAttendeeRef, type MeetingContactRef, type MeetingCustomer, type MeetingDeal, type MeetingPermission, type MeetingTaskSuggestion, type MeetingTranscript, type MeetingUser, type MeetingUtterance, MeetingsResource, MetricsResource, type MissingScopesError, type MrrResponse, type NetInstallsResponse, type NetRevenueResponse, type NetRevenueRetentionResponse, type Organization, OrganizationResource, type Pagination, type PayoutResponse, type Plan, type PlanFeature, type PlanFeatureWebhook, type PlanUsageChargeWebhook, type PlanWebhook, type PredictedLtvResponse, type RateLimitOptions, type RevenueRetentionResponse, type Review, type ReviewWebhook, type StandardMetricResponse, type Subscription, type SubscriptionWebhook, SubscriptionsResource, type SyncedEmail, type SyncedEmailContact, type SyncedEmailCustomer, type SyncedEmailDeal, type SyncedEmailMessage, type SyncedEmailUser, SyncedEmailsResource, type Task, type TaskComment, type TaskTodoItem, TasksResource, type ThreadEventType, type ThreadMessageWebhook, type ThreadWebhook, type Ticket, type TicketAgent, type TicketApp, type TicketAttachment, type TicketChannel, type TicketContact, type TicketCustomer, type TicketEvent, type TicketLoop, type TicketMessage, TicketsResource, type TimeSeriesDataPoint, type TimelineComment, TimelineCommentsResource, type Transaction, type TransactionWebhook, TransactionsResource, type Trigger, type UninstallEventWebhook, type UsageEvent, type UsageEventResponse, UsageEventsResource, type UsageMetric, type UsageMetricResponse, type User, UsersResource, type Webhook, WebhooksResource, type components, createRateLimitMiddleware, type paths };
|
|
28059
|
+
export { type AccountOwner, type AccountOwnerType, type Action, type ActiveSubscriptionsResponse, type Affiliate, type AffiliateAttributionWebhook, type AffiliateCommission, AffiliateCommissionsResource, type AffiliateMembershipWebhook, type AffiliatePayout, type AffiliatePayoutWebhook, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramGroup, type AffiliateProgramMembership, type AffiliateProgramWebhook, AffiliateProgramsResource, type AffiliateReferral, AffiliateReferralsResource, type AffiliateRules, type AffiliateRulesWebhook, type AffiliateWebhook, AffiliatesResource, type Agent, type AgentRun, AgentsResource, AiAgentRunsResource, type App, type AppChargeWebhook, type AppEvent, type AppInstallation, type AppInstallationWebhook, type AppWebhook, AppsResource, type BaseCustomerWebhook, BaseResource, ChannelsResource, type Charge, ChargesResource, type Checklist, type ChecklistStep, CompaniesResource, type Company, type Contact, type ContactWebhook, ContactsResource, type CursorPagination, CustomDataResource, type CustomField, type CustomFieldDefaultValue, type Customer, type CustomerContact, type CustomerContactWebhook, type CustomerSegment, CustomerSegmentsResource, type CustomerWebhook, type CustomerWithoutSubscriptionWebhook, CustomersResource, type Deal, type DealAcquirer, DealActivitiesResource, type DealActivity, type DealAffiliate, type DealApp, type DealContact, type DealCustomData, type DealCustomer, type DealEvent, type DealFlow, type DealFlowAffiliate, type DealFlowDefaultSource, type DealFlowPartnership, type DealFlowStage, type DealFlowUser, DealFlowsResource, type DealOwner, type DealPartnership, type DealPlan, type DealStage, DealsResource, type DetailedAffiliate, type DetailedFlow, type DocsCollection, type DocsCollectionResponse, type DocsGenerateJobResponse, type DocsGenerateStatusCompleted, type DocsGenerateStatusFailed, type DocsGenerateStatusPending, type DocsGroup, type DocsGroupResponse, type DocsPage, type DocsPageResponse, type DocsPageSummary, type DocsRepository, type DocsRepositoryResponse, DocsResource, type EmailCampaign, type EmailDelivery, type EmailDeliveryStats, type EmailLayout, type EmailPreview, type EmailSender, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupMember, EmailUnsubscribeGroupsResource, EntitiesResource, type EventWebhook, type ExtensionUninstallPayload, type ExtensionWebhook, type Feature, type Flow, type FlowActionRun, FlowExtensionsResource, FlowsResource, type InvalidTokenError, type Invoice, type InvoiceWebhook, JournalEntriesResource, type JournalEntry, type JournalEntryApp, type JournalEntryFile, type List, ListsResource, type LogoChurnResponse, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type Meeting, type MeetingAttendee, type MeetingAttendeeRef, type MeetingContactRef, type MeetingCustomer, type MeetingDeal, type MeetingPermission, type MeetingTaskSuggestion, type MeetingTranscript, type MeetingUser, type MeetingUtterance, MeetingsResource, MetricsResource, type MissingScopesError, type MrrResponse, type NetInstallsResponse, type NetRevenueResponse, type NetRevenueRetentionResponse, type Organization, OrganizationResource, type Pagination, type PayoutResponse, type Plan, type PlanFeature, type PlanFeatureWebhook, type PlanUsageChargeWebhook, type PlanWebhook, type PredictedLtvResponse, type RateLimitOptions, type RevenueRetentionResponse, type Review, type ReviewWebhook, type StandardMetricResponse, type Subscription, type SubscriptionChurnResponse, type SubscriptionWebhook, SubscriptionsResource, type SyncedEmail, type SyncedEmailContact, type SyncedEmailCustomer, type SyncedEmailDeal, type SyncedEmailMessage, type SyncedEmailUser, SyncedEmailsResource, type Task, type TaskComment, type TaskTodoItem, TasksResource, type ThreadEventType, type ThreadMessageWebhook, type ThreadWebhook, type Ticket, type TicketAgent, type TicketApp, type TicketAttachment, type TicketChannel, type TicketContact, type TicketCustomer, type TicketEvent, type TicketLoop, type TicketMessage, TicketsResource, type TimeSeriesDataPoint, type TimelineComment, TimelineCommentsResource, type Transaction, type TransactionWebhook, TransactionsResource, type Trigger, type UninstallEventWebhook, type UsageEvent, type UsageEventResponse, UsageEventsResource, type UsageMetric, type UsageMetricResponse, type User, UsersResource, type Webhook, WebhooksResource, type components, createRateLimitMiddleware, type paths };
|
package/dist/index.js
CHANGED
|
@@ -938,6 +938,9 @@ var MetricsResource = class extends BaseResource {
|
|
|
938
938
|
async revenueRetention(params) {
|
|
939
939
|
return this.unwrap(this.api.GET("/api/core/v1/metrics/revenueRetention", { params: { query: params } }));
|
|
940
940
|
}
|
|
941
|
+
async subscriptionChurn(params) {
|
|
942
|
+
return this.unwrap(this.api.GET("/api/core/v1/metrics/subscriptionChurn", { params: { query: params } }));
|
|
943
|
+
}
|
|
941
944
|
async usageEvent(params) {
|
|
942
945
|
return this.unwrap(this.api.GET("/api/core/v1/metrics/usageEvent", { params: { query: params } }));
|
|
943
946
|
}
|
package/dist/index.mjs
CHANGED
|
@@ -856,6 +856,9 @@ var MetricsResource = class extends BaseResource {
|
|
|
856
856
|
async revenueRetention(params) {
|
|
857
857
|
return this.unwrap(this.api.GET("/api/core/v1/metrics/revenueRetention", { params: { query: params } }));
|
|
858
858
|
}
|
|
859
|
+
async subscriptionChurn(params) {
|
|
860
|
+
return this.unwrap(this.api.GET("/api/core/v1/metrics/subscriptionChurn", { params: { query: params } }));
|
|
861
|
+
}
|
|
859
862
|
async usageEvent(params) {
|
|
860
863
|
return this.unwrap(this.api.GET("/api/core/v1/metrics/usageEvent", { params: { query: params } }));
|
|
861
864
|
}
|