@heymantle/core-api-client 0.5.3 → 0.5.5

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 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" | "published";
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" | "published";
7295
+ status?: "draft" | "active";
7238
7296
  /** @description Title of the collection */
7239
7297
  title?: string;
7240
7298
  };
@@ -8309,6 +8367,7 @@ type paths = {
8309
8367
  "application/json": {
8310
8368
  /** @description Whether to enable auto-translation for the specified locale */
8311
8369
  autoTranslate?: boolean;
8370
+ config?: components["schemas"]["DocsRepositoryConfig"];
8312
8371
  /** @description Custom domain for the repository */
8313
8372
  customDomain?: string | null;
8314
8373
  /** @description The default locale for the repository (e.g. "en-us") */
@@ -8368,6 +8427,188 @@ type paths = {
8368
8427
  patch?: never;
8369
8428
  trace?: never;
8370
8429
  };
8430
+ "/docs/repositories/{id}/redirects": {
8431
+ parameters: {
8432
+ query?: never;
8433
+ header?: never;
8434
+ path?: never;
8435
+ cookie?: never;
8436
+ };
8437
+ /** List redirects for a documentation repository */
8438
+ get: {
8439
+ parameters: {
8440
+ query?: never;
8441
+ header?: never;
8442
+ path: {
8443
+ id: string;
8444
+ };
8445
+ cookie?: never;
8446
+ };
8447
+ requestBody?: never;
8448
+ responses: {
8449
+ /** @description List of redirects */
8450
+ 200: {
8451
+ headers: {
8452
+ [name: string]: unknown;
8453
+ };
8454
+ content: {
8455
+ "application/json": {
8456
+ redirects?: components["schemas"]["DocsRedirect"][];
8457
+ };
8458
+ };
8459
+ };
8460
+ 401: components["responses"]["401"];
8461
+ 403: components["responses"]["403"];
8462
+ /** @description Repository not found */
8463
+ 404: {
8464
+ headers: {
8465
+ [name: string]: unknown;
8466
+ };
8467
+ content?: never;
8468
+ };
8469
+ };
8470
+ };
8471
+ put?: never;
8472
+ /** Create redirects for a documentation repository */
8473
+ post: {
8474
+ parameters: {
8475
+ query?: never;
8476
+ header?: never;
8477
+ path: {
8478
+ id: string;
8479
+ };
8480
+ cookie?: never;
8481
+ };
8482
+ requestBody: {
8483
+ content: {
8484
+ "application/json": {
8485
+ redirects: {
8486
+ /** @default true */
8487
+ enabled?: boolean;
8488
+ fromPath: string;
8489
+ notes?: string;
8490
+ /** @default 301 */
8491
+ redirectType?: string;
8492
+ toPath: string;
8493
+ }[];
8494
+ };
8495
+ };
8496
+ };
8497
+ responses: {
8498
+ /** @description Redirects created successfully */
8499
+ 201: {
8500
+ headers: {
8501
+ [name: string]: unknown;
8502
+ };
8503
+ content?: never;
8504
+ };
8505
+ /** @description Invalid input */
8506
+ 400: {
8507
+ headers: {
8508
+ [name: string]: unknown;
8509
+ };
8510
+ content?: never;
8511
+ };
8512
+ 401: components["responses"]["401"];
8513
+ 403: components["responses"]["403"];
8514
+ /** @description Duplicate redirects */
8515
+ 409: {
8516
+ headers: {
8517
+ [name: string]: unknown;
8518
+ };
8519
+ content?: never;
8520
+ };
8521
+ };
8522
+ };
8523
+ delete?: never;
8524
+ options?: never;
8525
+ head?: never;
8526
+ patch?: never;
8527
+ trace?: never;
8528
+ };
8529
+ "/docs/repositories/{id}/redirects/{redirect_id}": {
8530
+ parameters: {
8531
+ query?: never;
8532
+ header?: never;
8533
+ path?: never;
8534
+ cookie?: never;
8535
+ };
8536
+ get?: never;
8537
+ /** Update a redirect */
8538
+ put: {
8539
+ parameters: {
8540
+ query?: never;
8541
+ header?: never;
8542
+ path: {
8543
+ id: string;
8544
+ redirect_id: string;
8545
+ };
8546
+ cookie?: never;
8547
+ };
8548
+ requestBody: {
8549
+ content: {
8550
+ "application/json": {
8551
+ fromPath?: string;
8552
+ toPath?: string;
8553
+ };
8554
+ };
8555
+ };
8556
+ responses: {
8557
+ /** @description Redirect updated */
8558
+ 200: {
8559
+ headers: {
8560
+ [name: string]: unknown;
8561
+ };
8562
+ content?: never;
8563
+ };
8564
+ 401: components["responses"]["401"];
8565
+ 403: components["responses"]["403"];
8566
+ /** @description Redirect not found */
8567
+ 404: {
8568
+ headers: {
8569
+ [name: string]: unknown;
8570
+ };
8571
+ content?: never;
8572
+ };
8573
+ };
8574
+ };
8575
+ post?: never;
8576
+ /** Delete a redirect */
8577
+ delete: {
8578
+ parameters: {
8579
+ query?: never;
8580
+ header?: never;
8581
+ path: {
8582
+ id: string;
8583
+ redirect_id: string;
8584
+ };
8585
+ cookie?: never;
8586
+ };
8587
+ requestBody?: never;
8588
+ responses: {
8589
+ /** @description Redirect deleted */
8590
+ 200: {
8591
+ headers: {
8592
+ [name: string]: unknown;
8593
+ };
8594
+ content?: never;
8595
+ };
8596
+ 401: components["responses"]["401"];
8597
+ 403: components["responses"]["403"];
8598
+ /** @description Redirect not found */
8599
+ 404: {
8600
+ headers: {
8601
+ [name: string]: unknown;
8602
+ };
8603
+ content?: never;
8604
+ };
8605
+ };
8606
+ };
8607
+ options?: never;
8608
+ head?: never;
8609
+ patch?: never;
8610
+ trace?: never;
8611
+ };
8371
8612
  "/docs/tree": {
8372
8613
  parameters: {
8373
8614
  query?: never;
@@ -17191,9 +17432,24 @@ type components = {
17191
17432
  publishedAt?: string;
17192
17433
  title?: string;
17193
17434
  };
17435
+ DocsRedirect: {
17436
+ /** Format: date-time */
17437
+ createdAt?: string;
17438
+ enabled?: boolean;
17439
+ fromPath?: string;
17440
+ id?: string;
17441
+ notes?: string;
17442
+ /** @default 301 */
17443
+ redirectType: string;
17444
+ /** @description Relative path or absolute URL */
17445
+ toPath?: string;
17446
+ /** Format: date-time */
17447
+ updatedAt?: string;
17448
+ };
17194
17449
  /** @description A documentation repository */
17195
17450
  DocsRepository: {
17196
17451
  collections?: components["schemas"]["DocsCollection"][];
17452
+ config?: components["schemas"]["DocsRepositoryConfig"];
17197
17453
  defaultLocale?: string;
17198
17454
  handle?: string;
17199
17455
  id?: string;
@@ -17205,8 +17461,36 @@ type components = {
17205
17461
  */
17206
17462
  visibility?: "public" | "internal";
17207
17463
  };
17464
+ /** @description Repository layout and SEO configuration. Only structural properties are exposed; branding (colors, fonts, CSS) is managed in the dashboard. */
17465
+ DocsRepositoryConfig: {
17466
+ collectionPage?: {
17467
+ /**
17468
+ * @description How collection pages are rendered
17469
+ * @enum {string}
17470
+ */
17471
+ displayFormat?: "group-summary" | "page-list";
17472
+ };
17473
+ homePage?: {
17474
+ /**
17475
+ * @description How the docs homepage is rendered
17476
+ * @enum {string}
17477
+ */
17478
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom";
17479
+ /** @description Description text displayed in the homepage hero section */
17480
+ heroDescription?: string;
17481
+ /** @description Heading text displayed in the homepage hero section */
17482
+ heroHeading?: string;
17483
+ };
17484
+ settings?: {
17485
+ /** @description SEO meta description for the docs site */
17486
+ seoDescription?: string;
17487
+ /** @description SEO title for the docs site */
17488
+ seoTitle?: string;
17489
+ };
17490
+ };
17208
17491
  /** @description Response for updated repository */
17209
17492
  DocsRepositoryResponse: {
17493
+ config?: components["schemas"]["DocsRepositoryConfig"];
17210
17494
  customDomain?: string;
17211
17495
  defaultLocale?: string;
17212
17496
  handle?: string;
@@ -18399,6 +18683,31 @@ type components = {
18399
18683
  usageBalanceUsed?: number;
18400
18684
  usageCappedAmount?: number;
18401
18685
  };
18686
+ SubscriptionChurnResponse: {
18687
+ /**
18688
+ * @description Data format type
18689
+ * @enum {string}
18690
+ */
18691
+ format?: "percent";
18692
+ /** @description Period used for the query */
18693
+ period?: string;
18694
+ /**
18695
+ * Format: date-time
18696
+ * @description End date of the period
18697
+ */
18698
+ periodEnd?: string;
18699
+ /**
18700
+ * Format: date-time
18701
+ * @description Start date of the period
18702
+ */
18703
+ periodStart?: string;
18704
+ /** @description Time series data (only present if interval is provided) */
18705
+ timeSeries?: components["schemas"]["TimeSeriesDataPoint"][];
18706
+ /** @description Interval used for time series (only present if interval is provided) */
18707
+ timeSeriesInterval?: string;
18708
+ /** @description Current period subscription churn percentage */
18709
+ value?: number;
18710
+ };
18402
18711
  SubscriptionWebhook: {
18403
18712
  subscription?: {
18404
18713
  /**
@@ -23267,6 +23576,20 @@ declare class DocsResource extends BaseResource {
23267
23576
  title?: string | undefined;
23268
23577
  updatedAt?: string | undefined;
23269
23578
  }[] | undefined;
23579
+ config?: {
23580
+ collectionPage?: {
23581
+ displayFormat?: "group-summary" | "page-list" | undefined;
23582
+ } | undefined;
23583
+ homePage?: {
23584
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23585
+ heroDescription?: string | undefined;
23586
+ heroHeading?: string | undefined;
23587
+ } | undefined;
23588
+ settings?: {
23589
+ seoDescription?: string | undefined;
23590
+ seoTitle?: string | undefined;
23591
+ } | undefined;
23592
+ } | undefined;
23270
23593
  defaultLocale?: string | undefined;
23271
23594
  handle?: string | undefined;
23272
23595
  id?: string | undefined;
@@ -23400,6 +23723,20 @@ declare class DocsResource extends BaseResource {
23400
23723
  title?: string | undefined;
23401
23724
  updatedAt?: string | undefined;
23402
23725
  }[] | undefined;
23726
+ config?: {
23727
+ collectionPage?: {
23728
+ displayFormat?: "group-summary" | "page-list" | undefined;
23729
+ } | undefined;
23730
+ homePage?: {
23731
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23732
+ heroDescription?: string | undefined;
23733
+ heroHeading?: string | undefined;
23734
+ } | undefined;
23735
+ settings?: {
23736
+ seoDescription?: string | undefined;
23737
+ seoTitle?: string | undefined;
23738
+ } | undefined;
23739
+ } | undefined;
23403
23740
  defaultLocale?: string | undefined;
23404
23741
  handle?: string | undefined;
23405
23742
  id?: string | undefined;
@@ -23420,6 +23757,21 @@ declare class DocsResource extends BaseResource {
23420
23757
  unpublishPage(pageId: string): Promise<{
23421
23758
  success?: boolean | undefined;
23422
23759
  }>;
23760
+ updateRedirect(docId: string, redirectId: string, data: NonNullable<paths['/docs/repositories/{id}/redirects/{redirect_id}']['put']['requestBody']>['content']['application/json']): Promise<undefined>;
23761
+ deleteRedirect(docId: string, redirectId: string): Promise<undefined>;
23762
+ listRedirects(docId: string): Promise<{
23763
+ redirects?: {
23764
+ createdAt?: string | undefined;
23765
+ enabled?: boolean | undefined;
23766
+ fromPath?: string | undefined;
23767
+ id?: string | undefined;
23768
+ notes?: string | undefined;
23769
+ redirectType: string;
23770
+ toPath?: string | undefined;
23771
+ updatedAt?: string | undefined;
23772
+ }[] | undefined;
23773
+ }>;
23774
+ createRedirect(docId: string, data: NonNullable<paths['/docs/repositories/{id}/redirects']['post']['requestBody']>['content']['application/json']): Promise<undefined>;
23423
23775
  updateCollection(collectionId: string, data: NonNullable<paths['/docs/collections/{collection_id}']['put']['requestBody']>['content']['application/json']): Promise<{
23424
23776
  createdAt?: string | undefined;
23425
23777
  displayOrder?: number | undefined;
@@ -23556,6 +23908,20 @@ declare class DocsResource extends BaseResource {
23556
23908
  title?: string | undefined;
23557
23909
  updatedAt?: string | undefined;
23558
23910
  }[] | undefined;
23911
+ config?: {
23912
+ collectionPage?: {
23913
+ displayFormat?: "group-summary" | "page-list" | undefined;
23914
+ } | undefined;
23915
+ homePage?: {
23916
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23917
+ heroDescription?: string | undefined;
23918
+ heroHeading?: string | undefined;
23919
+ } | undefined;
23920
+ settings?: {
23921
+ seoDescription?: string | undefined;
23922
+ seoTitle?: string | undefined;
23923
+ } | undefined;
23924
+ } | undefined;
23559
23925
  defaultLocale?: string | undefined;
23560
23926
  handle?: string | undefined;
23561
23927
  id?: string | undefined;
@@ -23566,6 +23932,20 @@ declare class DocsResource extends BaseResource {
23566
23932
  }>;
23567
23933
  updateRepository(docId: string, data: NonNullable<paths['/docs/repositories/{id}']['put']['requestBody']>['content']['application/json']): Promise<{
23568
23934
  repository?: {
23935
+ config?: {
23936
+ collectionPage?: {
23937
+ displayFormat?: "group-summary" | "page-list" | undefined;
23938
+ } | undefined;
23939
+ homePage?: {
23940
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23941
+ heroDescription?: string | undefined;
23942
+ heroHeading?: string | undefined;
23943
+ } | undefined;
23944
+ settings?: {
23945
+ seoDescription?: string | undefined;
23946
+ seoTitle?: string | undefined;
23947
+ } | undefined;
23948
+ } | undefined;
23569
23949
  customDomain?: string | undefined;
23570
23950
  defaultLocale?: string | undefined;
23571
23951
  handle?: string | undefined;
@@ -25770,6 +26150,19 @@ declare class MetricsResource extends BaseResource {
25770
26150
  timeSeriesInterval?: string | undefined;
25771
26151
  value?: number | undefined;
25772
26152
  }>;
26153
+ subscriptionChurn(params?: paths['/api/core/v1/metrics/subscriptionChurn']['get']['parameters']['query']): Promise<{
26154
+ format?: "percent" | undefined;
26155
+ period?: string | undefined;
26156
+ periodEnd?: string | undefined;
26157
+ periodStart?: string | undefined;
26158
+ timeSeries?: {
26159
+ periodEnd?: string | undefined;
26160
+ periodStart?: string | undefined;
26161
+ value?: number | undefined;
26162
+ }[] | undefined;
26163
+ timeSeriesInterval?: string | undefined;
26164
+ value?: number | undefined;
26165
+ }>;
25773
26166
  usageEvent(params: paths['/api/core/v1/metrics/usageEvent']['get']['parameters']['query']): Promise<{
25774
26167
  format?: "count" | undefined;
25775
26168
  period?: string | undefined;
@@ -27785,7 +28178,9 @@ type DocsGroupResponse = components['schemas']['DocsGroupResponse'];
27785
28178
  type DocsPage = components['schemas']['DocsPage'];
27786
28179
  type DocsPageResponse = components['schemas']['DocsPageResponse'];
27787
28180
  type DocsPageSummary = components['schemas']['DocsPageSummary'];
28181
+ type DocsRedirect = components['schemas']['DocsRedirect'];
27788
28182
  type DocsRepository = components['schemas']['DocsRepository'];
28183
+ type DocsRepositoryConfig = components['schemas']['DocsRepositoryConfig'];
27789
28184
  type DocsRepositoryResponse = components['schemas']['DocsRepositoryResponse'];
27790
28185
  type EmailCampaign = components['schemas']['EmailCampaign'];
27791
28186
  type EmailDelivery = components['schemas']['EmailDelivery'];
@@ -27839,6 +28234,7 @@ type Review = components['schemas']['Review'];
27839
28234
  type ReviewWebhook = components['schemas']['ReviewWebhook'];
27840
28235
  type StandardMetricResponse = components['schemas']['StandardMetricResponse'];
27841
28236
  type Subscription = components['schemas']['Subscription'];
28237
+ type SubscriptionChurnResponse = components['schemas']['SubscriptionChurnResponse'];
27842
28238
  type SubscriptionWebhook = components['schemas']['SubscriptionWebhook'];
27843
28239
  type SyncedEmail = components['schemas']['SyncedEmail'];
27844
28240
  type SyncedEmailContact = components['schemas']['SyncedEmailContact'];
@@ -27959,4 +28355,4 @@ interface RateLimitOptions {
27959
28355
  */
27960
28356
  declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
27961
28357
 
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 };
28358
+ 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 DocsRedirect, type DocsRepository, type DocsRepositoryConfig, 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" | "published";
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" | "published";
7295
+ status?: "draft" | "active";
7238
7296
  /** @description Title of the collection */
7239
7297
  title?: string;
7240
7298
  };
@@ -8309,6 +8367,7 @@ type paths = {
8309
8367
  "application/json": {
8310
8368
  /** @description Whether to enable auto-translation for the specified locale */
8311
8369
  autoTranslate?: boolean;
8370
+ config?: components["schemas"]["DocsRepositoryConfig"];
8312
8371
  /** @description Custom domain for the repository */
8313
8372
  customDomain?: string | null;
8314
8373
  /** @description The default locale for the repository (e.g. "en-us") */
@@ -8368,6 +8427,188 @@ type paths = {
8368
8427
  patch?: never;
8369
8428
  trace?: never;
8370
8429
  };
8430
+ "/docs/repositories/{id}/redirects": {
8431
+ parameters: {
8432
+ query?: never;
8433
+ header?: never;
8434
+ path?: never;
8435
+ cookie?: never;
8436
+ };
8437
+ /** List redirects for a documentation repository */
8438
+ get: {
8439
+ parameters: {
8440
+ query?: never;
8441
+ header?: never;
8442
+ path: {
8443
+ id: string;
8444
+ };
8445
+ cookie?: never;
8446
+ };
8447
+ requestBody?: never;
8448
+ responses: {
8449
+ /** @description List of redirects */
8450
+ 200: {
8451
+ headers: {
8452
+ [name: string]: unknown;
8453
+ };
8454
+ content: {
8455
+ "application/json": {
8456
+ redirects?: components["schemas"]["DocsRedirect"][];
8457
+ };
8458
+ };
8459
+ };
8460
+ 401: components["responses"]["401"];
8461
+ 403: components["responses"]["403"];
8462
+ /** @description Repository not found */
8463
+ 404: {
8464
+ headers: {
8465
+ [name: string]: unknown;
8466
+ };
8467
+ content?: never;
8468
+ };
8469
+ };
8470
+ };
8471
+ put?: never;
8472
+ /** Create redirects for a documentation repository */
8473
+ post: {
8474
+ parameters: {
8475
+ query?: never;
8476
+ header?: never;
8477
+ path: {
8478
+ id: string;
8479
+ };
8480
+ cookie?: never;
8481
+ };
8482
+ requestBody: {
8483
+ content: {
8484
+ "application/json": {
8485
+ redirects: {
8486
+ /** @default true */
8487
+ enabled?: boolean;
8488
+ fromPath: string;
8489
+ notes?: string;
8490
+ /** @default 301 */
8491
+ redirectType?: string;
8492
+ toPath: string;
8493
+ }[];
8494
+ };
8495
+ };
8496
+ };
8497
+ responses: {
8498
+ /** @description Redirects created successfully */
8499
+ 201: {
8500
+ headers: {
8501
+ [name: string]: unknown;
8502
+ };
8503
+ content?: never;
8504
+ };
8505
+ /** @description Invalid input */
8506
+ 400: {
8507
+ headers: {
8508
+ [name: string]: unknown;
8509
+ };
8510
+ content?: never;
8511
+ };
8512
+ 401: components["responses"]["401"];
8513
+ 403: components["responses"]["403"];
8514
+ /** @description Duplicate redirects */
8515
+ 409: {
8516
+ headers: {
8517
+ [name: string]: unknown;
8518
+ };
8519
+ content?: never;
8520
+ };
8521
+ };
8522
+ };
8523
+ delete?: never;
8524
+ options?: never;
8525
+ head?: never;
8526
+ patch?: never;
8527
+ trace?: never;
8528
+ };
8529
+ "/docs/repositories/{id}/redirects/{redirect_id}": {
8530
+ parameters: {
8531
+ query?: never;
8532
+ header?: never;
8533
+ path?: never;
8534
+ cookie?: never;
8535
+ };
8536
+ get?: never;
8537
+ /** Update a redirect */
8538
+ put: {
8539
+ parameters: {
8540
+ query?: never;
8541
+ header?: never;
8542
+ path: {
8543
+ id: string;
8544
+ redirect_id: string;
8545
+ };
8546
+ cookie?: never;
8547
+ };
8548
+ requestBody: {
8549
+ content: {
8550
+ "application/json": {
8551
+ fromPath?: string;
8552
+ toPath?: string;
8553
+ };
8554
+ };
8555
+ };
8556
+ responses: {
8557
+ /** @description Redirect updated */
8558
+ 200: {
8559
+ headers: {
8560
+ [name: string]: unknown;
8561
+ };
8562
+ content?: never;
8563
+ };
8564
+ 401: components["responses"]["401"];
8565
+ 403: components["responses"]["403"];
8566
+ /** @description Redirect not found */
8567
+ 404: {
8568
+ headers: {
8569
+ [name: string]: unknown;
8570
+ };
8571
+ content?: never;
8572
+ };
8573
+ };
8574
+ };
8575
+ post?: never;
8576
+ /** Delete a redirect */
8577
+ delete: {
8578
+ parameters: {
8579
+ query?: never;
8580
+ header?: never;
8581
+ path: {
8582
+ id: string;
8583
+ redirect_id: string;
8584
+ };
8585
+ cookie?: never;
8586
+ };
8587
+ requestBody?: never;
8588
+ responses: {
8589
+ /** @description Redirect deleted */
8590
+ 200: {
8591
+ headers: {
8592
+ [name: string]: unknown;
8593
+ };
8594
+ content?: never;
8595
+ };
8596
+ 401: components["responses"]["401"];
8597
+ 403: components["responses"]["403"];
8598
+ /** @description Redirect not found */
8599
+ 404: {
8600
+ headers: {
8601
+ [name: string]: unknown;
8602
+ };
8603
+ content?: never;
8604
+ };
8605
+ };
8606
+ };
8607
+ options?: never;
8608
+ head?: never;
8609
+ patch?: never;
8610
+ trace?: never;
8611
+ };
8371
8612
  "/docs/tree": {
8372
8613
  parameters: {
8373
8614
  query?: never;
@@ -17191,9 +17432,24 @@ type components = {
17191
17432
  publishedAt?: string;
17192
17433
  title?: string;
17193
17434
  };
17435
+ DocsRedirect: {
17436
+ /** Format: date-time */
17437
+ createdAt?: string;
17438
+ enabled?: boolean;
17439
+ fromPath?: string;
17440
+ id?: string;
17441
+ notes?: string;
17442
+ /** @default 301 */
17443
+ redirectType: string;
17444
+ /** @description Relative path or absolute URL */
17445
+ toPath?: string;
17446
+ /** Format: date-time */
17447
+ updatedAt?: string;
17448
+ };
17194
17449
  /** @description A documentation repository */
17195
17450
  DocsRepository: {
17196
17451
  collections?: components["schemas"]["DocsCollection"][];
17452
+ config?: components["schemas"]["DocsRepositoryConfig"];
17197
17453
  defaultLocale?: string;
17198
17454
  handle?: string;
17199
17455
  id?: string;
@@ -17205,8 +17461,36 @@ type components = {
17205
17461
  */
17206
17462
  visibility?: "public" | "internal";
17207
17463
  };
17464
+ /** @description Repository layout and SEO configuration. Only structural properties are exposed; branding (colors, fonts, CSS) is managed in the dashboard. */
17465
+ DocsRepositoryConfig: {
17466
+ collectionPage?: {
17467
+ /**
17468
+ * @description How collection pages are rendered
17469
+ * @enum {string}
17470
+ */
17471
+ displayFormat?: "group-summary" | "page-list";
17472
+ };
17473
+ homePage?: {
17474
+ /**
17475
+ * @description How the docs homepage is rendered
17476
+ * @enum {string}
17477
+ */
17478
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom";
17479
+ /** @description Description text displayed in the homepage hero section */
17480
+ heroDescription?: string;
17481
+ /** @description Heading text displayed in the homepage hero section */
17482
+ heroHeading?: string;
17483
+ };
17484
+ settings?: {
17485
+ /** @description SEO meta description for the docs site */
17486
+ seoDescription?: string;
17487
+ /** @description SEO title for the docs site */
17488
+ seoTitle?: string;
17489
+ };
17490
+ };
17208
17491
  /** @description Response for updated repository */
17209
17492
  DocsRepositoryResponse: {
17493
+ config?: components["schemas"]["DocsRepositoryConfig"];
17210
17494
  customDomain?: string;
17211
17495
  defaultLocale?: string;
17212
17496
  handle?: string;
@@ -18399,6 +18683,31 @@ type components = {
18399
18683
  usageBalanceUsed?: number;
18400
18684
  usageCappedAmount?: number;
18401
18685
  };
18686
+ SubscriptionChurnResponse: {
18687
+ /**
18688
+ * @description Data format type
18689
+ * @enum {string}
18690
+ */
18691
+ format?: "percent";
18692
+ /** @description Period used for the query */
18693
+ period?: string;
18694
+ /**
18695
+ * Format: date-time
18696
+ * @description End date of the period
18697
+ */
18698
+ periodEnd?: string;
18699
+ /**
18700
+ * Format: date-time
18701
+ * @description Start date of the period
18702
+ */
18703
+ periodStart?: string;
18704
+ /** @description Time series data (only present if interval is provided) */
18705
+ timeSeries?: components["schemas"]["TimeSeriesDataPoint"][];
18706
+ /** @description Interval used for time series (only present if interval is provided) */
18707
+ timeSeriesInterval?: string;
18708
+ /** @description Current period subscription churn percentage */
18709
+ value?: number;
18710
+ };
18402
18711
  SubscriptionWebhook: {
18403
18712
  subscription?: {
18404
18713
  /**
@@ -23267,6 +23576,20 @@ declare class DocsResource extends BaseResource {
23267
23576
  title?: string | undefined;
23268
23577
  updatedAt?: string | undefined;
23269
23578
  }[] | undefined;
23579
+ config?: {
23580
+ collectionPage?: {
23581
+ displayFormat?: "group-summary" | "page-list" | undefined;
23582
+ } | undefined;
23583
+ homePage?: {
23584
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23585
+ heroDescription?: string | undefined;
23586
+ heroHeading?: string | undefined;
23587
+ } | undefined;
23588
+ settings?: {
23589
+ seoDescription?: string | undefined;
23590
+ seoTitle?: string | undefined;
23591
+ } | undefined;
23592
+ } | undefined;
23270
23593
  defaultLocale?: string | undefined;
23271
23594
  handle?: string | undefined;
23272
23595
  id?: string | undefined;
@@ -23400,6 +23723,20 @@ declare class DocsResource extends BaseResource {
23400
23723
  title?: string | undefined;
23401
23724
  updatedAt?: string | undefined;
23402
23725
  }[] | undefined;
23726
+ config?: {
23727
+ collectionPage?: {
23728
+ displayFormat?: "group-summary" | "page-list" | undefined;
23729
+ } | undefined;
23730
+ homePage?: {
23731
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23732
+ heroDescription?: string | undefined;
23733
+ heroHeading?: string | undefined;
23734
+ } | undefined;
23735
+ settings?: {
23736
+ seoDescription?: string | undefined;
23737
+ seoTitle?: string | undefined;
23738
+ } | undefined;
23739
+ } | undefined;
23403
23740
  defaultLocale?: string | undefined;
23404
23741
  handle?: string | undefined;
23405
23742
  id?: string | undefined;
@@ -23420,6 +23757,21 @@ declare class DocsResource extends BaseResource {
23420
23757
  unpublishPage(pageId: string): Promise<{
23421
23758
  success?: boolean | undefined;
23422
23759
  }>;
23760
+ updateRedirect(docId: string, redirectId: string, data: NonNullable<paths['/docs/repositories/{id}/redirects/{redirect_id}']['put']['requestBody']>['content']['application/json']): Promise<undefined>;
23761
+ deleteRedirect(docId: string, redirectId: string): Promise<undefined>;
23762
+ listRedirects(docId: string): Promise<{
23763
+ redirects?: {
23764
+ createdAt?: string | undefined;
23765
+ enabled?: boolean | undefined;
23766
+ fromPath?: string | undefined;
23767
+ id?: string | undefined;
23768
+ notes?: string | undefined;
23769
+ redirectType: string;
23770
+ toPath?: string | undefined;
23771
+ updatedAt?: string | undefined;
23772
+ }[] | undefined;
23773
+ }>;
23774
+ createRedirect(docId: string, data: NonNullable<paths['/docs/repositories/{id}/redirects']['post']['requestBody']>['content']['application/json']): Promise<undefined>;
23423
23775
  updateCollection(collectionId: string, data: NonNullable<paths['/docs/collections/{collection_id}']['put']['requestBody']>['content']['application/json']): Promise<{
23424
23776
  createdAt?: string | undefined;
23425
23777
  displayOrder?: number | undefined;
@@ -23556,6 +23908,20 @@ declare class DocsResource extends BaseResource {
23556
23908
  title?: string | undefined;
23557
23909
  updatedAt?: string | undefined;
23558
23910
  }[] | undefined;
23911
+ config?: {
23912
+ collectionPage?: {
23913
+ displayFormat?: "group-summary" | "page-list" | undefined;
23914
+ } | undefined;
23915
+ homePage?: {
23916
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23917
+ heroDescription?: string | undefined;
23918
+ heroHeading?: string | undefined;
23919
+ } | undefined;
23920
+ settings?: {
23921
+ seoDescription?: string | undefined;
23922
+ seoTitle?: string | undefined;
23923
+ } | undefined;
23924
+ } | undefined;
23559
23925
  defaultLocale?: string | undefined;
23560
23926
  handle?: string | undefined;
23561
23927
  id?: string | undefined;
@@ -23566,6 +23932,20 @@ declare class DocsResource extends BaseResource {
23566
23932
  }>;
23567
23933
  updateRepository(docId: string, data: NonNullable<paths['/docs/repositories/{id}']['put']['requestBody']>['content']['application/json']): Promise<{
23568
23934
  repository?: {
23935
+ config?: {
23936
+ collectionPage?: {
23937
+ displayFormat?: "group-summary" | "page-list" | undefined;
23938
+ } | undefined;
23939
+ homePage?: {
23940
+ displayFormat?: "redirect-to-first-collection" | "collection-summary" | "group-summary" | "page-list" | "collection-group-summary" | "custom" | undefined;
23941
+ heroDescription?: string | undefined;
23942
+ heroHeading?: string | undefined;
23943
+ } | undefined;
23944
+ settings?: {
23945
+ seoDescription?: string | undefined;
23946
+ seoTitle?: string | undefined;
23947
+ } | undefined;
23948
+ } | undefined;
23569
23949
  customDomain?: string | undefined;
23570
23950
  defaultLocale?: string | undefined;
23571
23951
  handle?: string | undefined;
@@ -25770,6 +26150,19 @@ declare class MetricsResource extends BaseResource {
25770
26150
  timeSeriesInterval?: string | undefined;
25771
26151
  value?: number | undefined;
25772
26152
  }>;
26153
+ subscriptionChurn(params?: paths['/api/core/v1/metrics/subscriptionChurn']['get']['parameters']['query']): Promise<{
26154
+ format?: "percent" | undefined;
26155
+ period?: string | undefined;
26156
+ periodEnd?: string | undefined;
26157
+ periodStart?: string | undefined;
26158
+ timeSeries?: {
26159
+ periodEnd?: string | undefined;
26160
+ periodStart?: string | undefined;
26161
+ value?: number | undefined;
26162
+ }[] | undefined;
26163
+ timeSeriesInterval?: string | undefined;
26164
+ value?: number | undefined;
26165
+ }>;
25773
26166
  usageEvent(params: paths['/api/core/v1/metrics/usageEvent']['get']['parameters']['query']): Promise<{
25774
26167
  format?: "count" | undefined;
25775
26168
  period?: string | undefined;
@@ -27785,7 +28178,9 @@ type DocsGroupResponse = components['schemas']['DocsGroupResponse'];
27785
28178
  type DocsPage = components['schemas']['DocsPage'];
27786
28179
  type DocsPageResponse = components['schemas']['DocsPageResponse'];
27787
28180
  type DocsPageSummary = components['schemas']['DocsPageSummary'];
28181
+ type DocsRedirect = components['schemas']['DocsRedirect'];
27788
28182
  type DocsRepository = components['schemas']['DocsRepository'];
28183
+ type DocsRepositoryConfig = components['schemas']['DocsRepositoryConfig'];
27789
28184
  type DocsRepositoryResponse = components['schemas']['DocsRepositoryResponse'];
27790
28185
  type EmailCampaign = components['schemas']['EmailCampaign'];
27791
28186
  type EmailDelivery = components['schemas']['EmailDelivery'];
@@ -27839,6 +28234,7 @@ type Review = components['schemas']['Review'];
27839
28234
  type ReviewWebhook = components['schemas']['ReviewWebhook'];
27840
28235
  type StandardMetricResponse = components['schemas']['StandardMetricResponse'];
27841
28236
  type Subscription = components['schemas']['Subscription'];
28237
+ type SubscriptionChurnResponse = components['schemas']['SubscriptionChurnResponse'];
27842
28238
  type SubscriptionWebhook = components['schemas']['SubscriptionWebhook'];
27843
28239
  type SyncedEmail = components['schemas']['SyncedEmail'];
27844
28240
  type SyncedEmailContact = components['schemas']['SyncedEmailContact'];
@@ -27959,4 +28355,4 @@ interface RateLimitOptions {
27959
28355
  */
27960
28356
  declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
27961
28357
 
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 };
28358
+ 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 DocsRedirect, type DocsRepository, type DocsRepositoryConfig, 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
@@ -610,6 +610,18 @@ var DocsResource = class extends BaseResource {
610
610
  async unpublishPage(pageId) {
611
611
  return this.unwrap(this.api.DELETE("/docs/pages/{page_id}/publish", { params: { path: { page_id: pageId } } }));
612
612
  }
613
+ async updateRedirect(docId, redirectId, data) {
614
+ return this.unwrap(this.api.PUT("/docs/repositories/{id}/redirects/{redirect_id}", { params: { path: { id: docId, redirect_id: redirectId } }, body: data }));
615
+ }
616
+ async deleteRedirect(docId, redirectId) {
617
+ return this.unwrap(this.api.DELETE("/docs/repositories/{id}/redirects/{redirect_id}", { params: { path: { id: docId, redirect_id: redirectId } } }));
618
+ }
619
+ async listRedirects(docId) {
620
+ return this.unwrap(this.api.GET("/docs/repositories/{id}/redirects", { params: { path: { id: docId } } }));
621
+ }
622
+ async createRedirect(docId, data) {
623
+ return this.unwrap(this.api.POST("/docs/repositories/{id}/redirects", { params: { path: { id: docId } }, body: data }));
624
+ }
613
625
  async updateCollection(collectionId, data) {
614
626
  return this.unwrap(this.api.PUT("/docs/collections/{collection_id}", { params: { path: { collection_id: collectionId } }, body: data }));
615
627
  }
@@ -938,6 +950,9 @@ var MetricsResource = class extends BaseResource {
938
950
  async revenueRetention(params) {
939
951
  return this.unwrap(this.api.GET("/api/core/v1/metrics/revenueRetention", { params: { query: params } }));
940
952
  }
953
+ async subscriptionChurn(params) {
954
+ return this.unwrap(this.api.GET("/api/core/v1/metrics/subscriptionChurn", { params: { query: params } }));
955
+ }
941
956
  async usageEvent(params) {
942
957
  return this.unwrap(this.api.GET("/api/core/v1/metrics/usageEvent", { params: { query: params } }));
943
958
  }
package/dist/index.mjs CHANGED
@@ -528,6 +528,18 @@ var DocsResource = class extends BaseResource {
528
528
  async unpublishPage(pageId) {
529
529
  return this.unwrap(this.api.DELETE("/docs/pages/{page_id}/publish", { params: { path: { page_id: pageId } } }));
530
530
  }
531
+ async updateRedirect(docId, redirectId, data) {
532
+ return this.unwrap(this.api.PUT("/docs/repositories/{id}/redirects/{redirect_id}", { params: { path: { id: docId, redirect_id: redirectId } }, body: data }));
533
+ }
534
+ async deleteRedirect(docId, redirectId) {
535
+ return this.unwrap(this.api.DELETE("/docs/repositories/{id}/redirects/{redirect_id}", { params: { path: { id: docId, redirect_id: redirectId } } }));
536
+ }
537
+ async listRedirects(docId) {
538
+ return this.unwrap(this.api.GET("/docs/repositories/{id}/redirects", { params: { path: { id: docId } } }));
539
+ }
540
+ async createRedirect(docId, data) {
541
+ return this.unwrap(this.api.POST("/docs/repositories/{id}/redirects", { params: { path: { id: docId } }, body: data }));
542
+ }
531
543
  async updateCollection(collectionId, data) {
532
544
  return this.unwrap(this.api.PUT("/docs/collections/{collection_id}", { params: { path: { collection_id: collectionId } }, body: data }));
533
545
  }
@@ -856,6 +868,9 @@ var MetricsResource = class extends BaseResource {
856
868
  async revenueRetention(params) {
857
869
  return this.unwrap(this.api.GET("/api/core/v1/metrics/revenueRetention", { params: { query: params } }));
858
870
  }
871
+ async subscriptionChurn(params) {
872
+ return this.unwrap(this.api.GET("/api/core/v1/metrics/subscriptionChurn", { params: { query: params } }));
873
+ }
859
874
  async usageEvent(params) {
860
875
  return this.unwrap(this.api.GET("/api/core/v1/metrics/usageEvent", { params: { query: params } }));
861
876
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@heymantle/core-api-client",
3
- "version": "0.5.3",
3
+ "version": "0.5.5",
4
4
  "description": "TypeScript SDK for the Mantle Core API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",