@heymantle/core-api-client 0.5.0 → 0.5.2
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 +162 -2
- package/dist/index.d.ts +162 -2
- package/dist/index.js +3 -0
- package/dist/index.mjs +3 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -8290,7 +8290,77 @@ type paths = {
|
|
|
8290
8290
|
};
|
|
8291
8291
|
};
|
|
8292
8292
|
};
|
|
8293
|
-
|
|
8293
|
+
/**
|
|
8294
|
+
* Update a documentation repository
|
|
8295
|
+
* @description Update settings for a documentation repository. At least one field must be provided.
|
|
8296
|
+
*/
|
|
8297
|
+
put: {
|
|
8298
|
+
parameters: {
|
|
8299
|
+
query?: never;
|
|
8300
|
+
header?: never;
|
|
8301
|
+
path: {
|
|
8302
|
+
/** @description The ID of the repository to update */
|
|
8303
|
+
id: string;
|
|
8304
|
+
};
|
|
8305
|
+
cookie?: never;
|
|
8306
|
+
};
|
|
8307
|
+
requestBody: {
|
|
8308
|
+
content: {
|
|
8309
|
+
"application/json": {
|
|
8310
|
+
/** @description Whether to enable auto-translation for the specified locale */
|
|
8311
|
+
autoTranslate?: boolean;
|
|
8312
|
+
/** @description Custom domain for the repository */
|
|
8313
|
+
customDomain?: string | null;
|
|
8314
|
+
/** @description The default locale for the repository (e.g. "en-us") */
|
|
8315
|
+
defaultLocale?: string;
|
|
8316
|
+
/** @description The locale to update title/shortDescription/autoTranslate for (defaults to defaultLocale) */
|
|
8317
|
+
locale?: string;
|
|
8318
|
+
/** @description The short description for the specified locale */
|
|
8319
|
+
shortDescription?: string;
|
|
8320
|
+
/** @description List of supported locale codes */
|
|
8321
|
+
supportedLocales?: string[];
|
|
8322
|
+
/** @description The title for the specified locale */
|
|
8323
|
+
title?: string;
|
|
8324
|
+
/** @description Whether to use the custom domain */
|
|
8325
|
+
useCustomDomain?: boolean;
|
|
8326
|
+
/**
|
|
8327
|
+
* @description Repository visibility
|
|
8328
|
+
* @enum {string}
|
|
8329
|
+
*/
|
|
8330
|
+
visibility?: "public" | "internal";
|
|
8331
|
+
};
|
|
8332
|
+
};
|
|
8333
|
+
};
|
|
8334
|
+
responses: {
|
|
8335
|
+
/** @description Documentation repository updated successfully */
|
|
8336
|
+
200: {
|
|
8337
|
+
headers: {
|
|
8338
|
+
[name: string]: unknown;
|
|
8339
|
+
};
|
|
8340
|
+
content: {
|
|
8341
|
+
"application/json": {
|
|
8342
|
+
repository?: components["schemas"]["DocsRepositoryResponse"];
|
|
8343
|
+
};
|
|
8344
|
+
};
|
|
8345
|
+
};
|
|
8346
|
+
/** @description Bad request */
|
|
8347
|
+
400: {
|
|
8348
|
+
headers: {
|
|
8349
|
+
[name: string]: unknown;
|
|
8350
|
+
};
|
|
8351
|
+
content?: never;
|
|
8352
|
+
};
|
|
8353
|
+
401: components["responses"]["401"];
|
|
8354
|
+
403: components["responses"]["403"];
|
|
8355
|
+
/** @description Repository not found */
|
|
8356
|
+
404: {
|
|
8357
|
+
headers: {
|
|
8358
|
+
[name: string]: unknown;
|
|
8359
|
+
};
|
|
8360
|
+
content?: never;
|
|
8361
|
+
};
|
|
8362
|
+
};
|
|
8363
|
+
};
|
|
8294
8364
|
post?: never;
|
|
8295
8365
|
delete?: never;
|
|
8296
8366
|
options?: never;
|
|
@@ -16810,6 +16880,21 @@ type components = {
|
|
|
16810
16880
|
status?: string;
|
|
16811
16881
|
title?: string;
|
|
16812
16882
|
};
|
|
16883
|
+
/** @description The associated timeline comment (for comment events). */
|
|
16884
|
+
timelineComment?: {
|
|
16885
|
+
comment?: string | null;
|
|
16886
|
+
commentHtml?: string | null;
|
|
16887
|
+
/** Format: date-time */
|
|
16888
|
+
createdAt?: string;
|
|
16889
|
+
id?: string;
|
|
16890
|
+
/** Format: date-time */
|
|
16891
|
+
updatedAt?: string;
|
|
16892
|
+
user?: {
|
|
16893
|
+
email?: string;
|
|
16894
|
+
id?: string;
|
|
16895
|
+
name?: string;
|
|
16896
|
+
} | null;
|
|
16897
|
+
} | null;
|
|
16813
16898
|
/** @description The type of event (stage_progression, deal_activity, note, etc.). */
|
|
16814
16899
|
type?: string;
|
|
16815
16900
|
/** @description The user who created/performed the event. */
|
|
@@ -17120,6 +17205,25 @@ type components = {
|
|
|
17120
17205
|
*/
|
|
17121
17206
|
visibility?: "public" | "internal";
|
|
17122
17207
|
};
|
|
17208
|
+
/** @description Response for updated repository */
|
|
17209
|
+
DocsRepositoryResponse: {
|
|
17210
|
+
customDomain?: string;
|
|
17211
|
+
defaultLocale?: string;
|
|
17212
|
+
handle?: string;
|
|
17213
|
+
id?: string;
|
|
17214
|
+
locales?: {
|
|
17215
|
+
autoTranslate?: boolean;
|
|
17216
|
+
locale?: string;
|
|
17217
|
+
shortDescription?: string;
|
|
17218
|
+
title?: string;
|
|
17219
|
+
}[];
|
|
17220
|
+
shortDescription?: string;
|
|
17221
|
+
supportedLocales?: string[];
|
|
17222
|
+
title?: string;
|
|
17223
|
+
useCustomDomain?: boolean;
|
|
17224
|
+
/** @enum {string} */
|
|
17225
|
+
visibility?: "public" | "internal";
|
|
17226
|
+
};
|
|
17123
17227
|
EmailCampaign: {
|
|
17124
17228
|
appId?: string;
|
|
17125
17229
|
clickCount?: number;
|
|
@@ -22626,6 +22730,18 @@ declare class DealsResource extends BaseResource {
|
|
|
22626
22730
|
status?: string | undefined;
|
|
22627
22731
|
title?: string | undefined;
|
|
22628
22732
|
} | undefined;
|
|
22733
|
+
timelineComment?: {
|
|
22734
|
+
comment?: string | null | undefined;
|
|
22735
|
+
commentHtml?: string | null | undefined;
|
|
22736
|
+
createdAt?: string | undefined;
|
|
22737
|
+
id?: string | undefined;
|
|
22738
|
+
updatedAt?: string | undefined;
|
|
22739
|
+
user?: {
|
|
22740
|
+
email?: string | undefined;
|
|
22741
|
+
id?: string | undefined;
|
|
22742
|
+
name?: string | undefined;
|
|
22743
|
+
} | null | undefined;
|
|
22744
|
+
} | null | undefined;
|
|
22629
22745
|
type?: string | undefined;
|
|
22630
22746
|
user?: {
|
|
22631
22747
|
email?: string | undefined;
|
|
@@ -22793,6 +22909,18 @@ declare class DealsResource extends BaseResource {
|
|
|
22793
22909
|
status?: string | undefined;
|
|
22794
22910
|
title?: string | undefined;
|
|
22795
22911
|
} | undefined;
|
|
22912
|
+
timelineComment?: {
|
|
22913
|
+
comment?: string | null | undefined;
|
|
22914
|
+
commentHtml?: string | null | undefined;
|
|
22915
|
+
createdAt?: string | undefined;
|
|
22916
|
+
id?: string | undefined;
|
|
22917
|
+
updatedAt?: string | undefined;
|
|
22918
|
+
user?: {
|
|
22919
|
+
email?: string | undefined;
|
|
22920
|
+
id?: string | undefined;
|
|
22921
|
+
name?: string | undefined;
|
|
22922
|
+
} | null | undefined;
|
|
22923
|
+
} | null | undefined;
|
|
22796
22924
|
type?: string | undefined;
|
|
22797
22925
|
user?: {
|
|
22798
22926
|
email?: string | undefined;
|
|
@@ -23083,6 +23211,18 @@ declare class DealsResource extends BaseResource {
|
|
|
23083
23211
|
status?: string | undefined;
|
|
23084
23212
|
title?: string | undefined;
|
|
23085
23213
|
} | undefined;
|
|
23214
|
+
timelineComment?: {
|
|
23215
|
+
comment?: string | null | undefined;
|
|
23216
|
+
commentHtml?: string | null | undefined;
|
|
23217
|
+
createdAt?: string | undefined;
|
|
23218
|
+
id?: string | undefined;
|
|
23219
|
+
updatedAt?: string | undefined;
|
|
23220
|
+
user?: {
|
|
23221
|
+
email?: string | undefined;
|
|
23222
|
+
id?: string | undefined;
|
|
23223
|
+
name?: string | undefined;
|
|
23224
|
+
} | null | undefined;
|
|
23225
|
+
} | null | undefined;
|
|
23086
23226
|
type?: string | undefined;
|
|
23087
23227
|
user?: {
|
|
23088
23228
|
email?: string | undefined;
|
|
@@ -23424,6 +23564,25 @@ declare class DocsResource extends BaseResource {
|
|
|
23424
23564
|
visibility?: "public" | "internal" | undefined;
|
|
23425
23565
|
} | undefined;
|
|
23426
23566
|
}>;
|
|
23567
|
+
updateRepository(docId: string, data: NonNullable<paths['/docs/repositories/{id}']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
23568
|
+
repository?: {
|
|
23569
|
+
customDomain?: string | undefined;
|
|
23570
|
+
defaultLocale?: string | undefined;
|
|
23571
|
+
handle?: string | undefined;
|
|
23572
|
+
id?: string | undefined;
|
|
23573
|
+
locales?: {
|
|
23574
|
+
autoTranslate?: boolean | undefined;
|
|
23575
|
+
locale?: string | undefined;
|
|
23576
|
+
shortDescription?: string | undefined;
|
|
23577
|
+
title?: string | undefined;
|
|
23578
|
+
}[] | undefined;
|
|
23579
|
+
shortDescription?: string | undefined;
|
|
23580
|
+
supportedLocales?: string[] | undefined;
|
|
23581
|
+
title?: string | undefined;
|
|
23582
|
+
useCustomDomain?: boolean | undefined;
|
|
23583
|
+
visibility?: "public" | "internal" | undefined;
|
|
23584
|
+
} | undefined;
|
|
23585
|
+
}>;
|
|
23427
23586
|
regeneratePage(pageId: string, data: NonNullable<paths['/docs/pages/{page_id}/generate']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
23428
23587
|
jobKey?: string | undefined;
|
|
23429
23588
|
statusUrl?: string | undefined;
|
|
@@ -27627,6 +27786,7 @@ type DocsPage = components['schemas']['DocsPage'];
|
|
|
27627
27786
|
type DocsPageResponse = components['schemas']['DocsPageResponse'];
|
|
27628
27787
|
type DocsPageSummary = components['schemas']['DocsPageSummary'];
|
|
27629
27788
|
type DocsRepository = components['schemas']['DocsRepository'];
|
|
27789
|
+
type DocsRepositoryResponse = components['schemas']['DocsRepositoryResponse'];
|
|
27630
27790
|
type EmailCampaign = components['schemas']['EmailCampaign'];
|
|
27631
27791
|
type EmailDelivery = components['schemas']['EmailDelivery'];
|
|
27632
27792
|
type EmailDeliveryStats = components['schemas']['EmailDeliveryStats'];
|
|
@@ -27799,4 +27959,4 @@ interface RateLimitOptions {
|
|
|
27799
27959
|
*/
|
|
27800
27960
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
27801
27961
|
|
|
27802
|
-
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, 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 };
|
|
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -8290,7 +8290,77 @@ type paths = {
|
|
|
8290
8290
|
};
|
|
8291
8291
|
};
|
|
8292
8292
|
};
|
|
8293
|
-
|
|
8293
|
+
/**
|
|
8294
|
+
* Update a documentation repository
|
|
8295
|
+
* @description Update settings for a documentation repository. At least one field must be provided.
|
|
8296
|
+
*/
|
|
8297
|
+
put: {
|
|
8298
|
+
parameters: {
|
|
8299
|
+
query?: never;
|
|
8300
|
+
header?: never;
|
|
8301
|
+
path: {
|
|
8302
|
+
/** @description The ID of the repository to update */
|
|
8303
|
+
id: string;
|
|
8304
|
+
};
|
|
8305
|
+
cookie?: never;
|
|
8306
|
+
};
|
|
8307
|
+
requestBody: {
|
|
8308
|
+
content: {
|
|
8309
|
+
"application/json": {
|
|
8310
|
+
/** @description Whether to enable auto-translation for the specified locale */
|
|
8311
|
+
autoTranslate?: boolean;
|
|
8312
|
+
/** @description Custom domain for the repository */
|
|
8313
|
+
customDomain?: string | null;
|
|
8314
|
+
/** @description The default locale for the repository (e.g. "en-us") */
|
|
8315
|
+
defaultLocale?: string;
|
|
8316
|
+
/** @description The locale to update title/shortDescription/autoTranslate for (defaults to defaultLocale) */
|
|
8317
|
+
locale?: string;
|
|
8318
|
+
/** @description The short description for the specified locale */
|
|
8319
|
+
shortDescription?: string;
|
|
8320
|
+
/** @description List of supported locale codes */
|
|
8321
|
+
supportedLocales?: string[];
|
|
8322
|
+
/** @description The title for the specified locale */
|
|
8323
|
+
title?: string;
|
|
8324
|
+
/** @description Whether to use the custom domain */
|
|
8325
|
+
useCustomDomain?: boolean;
|
|
8326
|
+
/**
|
|
8327
|
+
* @description Repository visibility
|
|
8328
|
+
* @enum {string}
|
|
8329
|
+
*/
|
|
8330
|
+
visibility?: "public" | "internal";
|
|
8331
|
+
};
|
|
8332
|
+
};
|
|
8333
|
+
};
|
|
8334
|
+
responses: {
|
|
8335
|
+
/** @description Documentation repository updated successfully */
|
|
8336
|
+
200: {
|
|
8337
|
+
headers: {
|
|
8338
|
+
[name: string]: unknown;
|
|
8339
|
+
};
|
|
8340
|
+
content: {
|
|
8341
|
+
"application/json": {
|
|
8342
|
+
repository?: components["schemas"]["DocsRepositoryResponse"];
|
|
8343
|
+
};
|
|
8344
|
+
};
|
|
8345
|
+
};
|
|
8346
|
+
/** @description Bad request */
|
|
8347
|
+
400: {
|
|
8348
|
+
headers: {
|
|
8349
|
+
[name: string]: unknown;
|
|
8350
|
+
};
|
|
8351
|
+
content?: never;
|
|
8352
|
+
};
|
|
8353
|
+
401: components["responses"]["401"];
|
|
8354
|
+
403: components["responses"]["403"];
|
|
8355
|
+
/** @description Repository not found */
|
|
8356
|
+
404: {
|
|
8357
|
+
headers: {
|
|
8358
|
+
[name: string]: unknown;
|
|
8359
|
+
};
|
|
8360
|
+
content?: never;
|
|
8361
|
+
};
|
|
8362
|
+
};
|
|
8363
|
+
};
|
|
8294
8364
|
post?: never;
|
|
8295
8365
|
delete?: never;
|
|
8296
8366
|
options?: never;
|
|
@@ -16810,6 +16880,21 @@ type components = {
|
|
|
16810
16880
|
status?: string;
|
|
16811
16881
|
title?: string;
|
|
16812
16882
|
};
|
|
16883
|
+
/** @description The associated timeline comment (for comment events). */
|
|
16884
|
+
timelineComment?: {
|
|
16885
|
+
comment?: string | null;
|
|
16886
|
+
commentHtml?: string | null;
|
|
16887
|
+
/** Format: date-time */
|
|
16888
|
+
createdAt?: string;
|
|
16889
|
+
id?: string;
|
|
16890
|
+
/** Format: date-time */
|
|
16891
|
+
updatedAt?: string;
|
|
16892
|
+
user?: {
|
|
16893
|
+
email?: string;
|
|
16894
|
+
id?: string;
|
|
16895
|
+
name?: string;
|
|
16896
|
+
} | null;
|
|
16897
|
+
} | null;
|
|
16813
16898
|
/** @description The type of event (stage_progression, deal_activity, note, etc.). */
|
|
16814
16899
|
type?: string;
|
|
16815
16900
|
/** @description The user who created/performed the event. */
|
|
@@ -17120,6 +17205,25 @@ type components = {
|
|
|
17120
17205
|
*/
|
|
17121
17206
|
visibility?: "public" | "internal";
|
|
17122
17207
|
};
|
|
17208
|
+
/** @description Response for updated repository */
|
|
17209
|
+
DocsRepositoryResponse: {
|
|
17210
|
+
customDomain?: string;
|
|
17211
|
+
defaultLocale?: string;
|
|
17212
|
+
handle?: string;
|
|
17213
|
+
id?: string;
|
|
17214
|
+
locales?: {
|
|
17215
|
+
autoTranslate?: boolean;
|
|
17216
|
+
locale?: string;
|
|
17217
|
+
shortDescription?: string;
|
|
17218
|
+
title?: string;
|
|
17219
|
+
}[];
|
|
17220
|
+
shortDescription?: string;
|
|
17221
|
+
supportedLocales?: string[];
|
|
17222
|
+
title?: string;
|
|
17223
|
+
useCustomDomain?: boolean;
|
|
17224
|
+
/** @enum {string} */
|
|
17225
|
+
visibility?: "public" | "internal";
|
|
17226
|
+
};
|
|
17123
17227
|
EmailCampaign: {
|
|
17124
17228
|
appId?: string;
|
|
17125
17229
|
clickCount?: number;
|
|
@@ -22626,6 +22730,18 @@ declare class DealsResource extends BaseResource {
|
|
|
22626
22730
|
status?: string | undefined;
|
|
22627
22731
|
title?: string | undefined;
|
|
22628
22732
|
} | undefined;
|
|
22733
|
+
timelineComment?: {
|
|
22734
|
+
comment?: string | null | undefined;
|
|
22735
|
+
commentHtml?: string | null | undefined;
|
|
22736
|
+
createdAt?: string | undefined;
|
|
22737
|
+
id?: string | undefined;
|
|
22738
|
+
updatedAt?: string | undefined;
|
|
22739
|
+
user?: {
|
|
22740
|
+
email?: string | undefined;
|
|
22741
|
+
id?: string | undefined;
|
|
22742
|
+
name?: string | undefined;
|
|
22743
|
+
} | null | undefined;
|
|
22744
|
+
} | null | undefined;
|
|
22629
22745
|
type?: string | undefined;
|
|
22630
22746
|
user?: {
|
|
22631
22747
|
email?: string | undefined;
|
|
@@ -22793,6 +22909,18 @@ declare class DealsResource extends BaseResource {
|
|
|
22793
22909
|
status?: string | undefined;
|
|
22794
22910
|
title?: string | undefined;
|
|
22795
22911
|
} | undefined;
|
|
22912
|
+
timelineComment?: {
|
|
22913
|
+
comment?: string | null | undefined;
|
|
22914
|
+
commentHtml?: string | null | undefined;
|
|
22915
|
+
createdAt?: string | undefined;
|
|
22916
|
+
id?: string | undefined;
|
|
22917
|
+
updatedAt?: string | undefined;
|
|
22918
|
+
user?: {
|
|
22919
|
+
email?: string | undefined;
|
|
22920
|
+
id?: string | undefined;
|
|
22921
|
+
name?: string | undefined;
|
|
22922
|
+
} | null | undefined;
|
|
22923
|
+
} | null | undefined;
|
|
22796
22924
|
type?: string | undefined;
|
|
22797
22925
|
user?: {
|
|
22798
22926
|
email?: string | undefined;
|
|
@@ -23083,6 +23211,18 @@ declare class DealsResource extends BaseResource {
|
|
|
23083
23211
|
status?: string | undefined;
|
|
23084
23212
|
title?: string | undefined;
|
|
23085
23213
|
} | undefined;
|
|
23214
|
+
timelineComment?: {
|
|
23215
|
+
comment?: string | null | undefined;
|
|
23216
|
+
commentHtml?: string | null | undefined;
|
|
23217
|
+
createdAt?: string | undefined;
|
|
23218
|
+
id?: string | undefined;
|
|
23219
|
+
updatedAt?: string | undefined;
|
|
23220
|
+
user?: {
|
|
23221
|
+
email?: string | undefined;
|
|
23222
|
+
id?: string | undefined;
|
|
23223
|
+
name?: string | undefined;
|
|
23224
|
+
} | null | undefined;
|
|
23225
|
+
} | null | undefined;
|
|
23086
23226
|
type?: string | undefined;
|
|
23087
23227
|
user?: {
|
|
23088
23228
|
email?: string | undefined;
|
|
@@ -23424,6 +23564,25 @@ declare class DocsResource extends BaseResource {
|
|
|
23424
23564
|
visibility?: "public" | "internal" | undefined;
|
|
23425
23565
|
} | undefined;
|
|
23426
23566
|
}>;
|
|
23567
|
+
updateRepository(docId: string, data: NonNullable<paths['/docs/repositories/{id}']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
23568
|
+
repository?: {
|
|
23569
|
+
customDomain?: string | undefined;
|
|
23570
|
+
defaultLocale?: string | undefined;
|
|
23571
|
+
handle?: string | undefined;
|
|
23572
|
+
id?: string | undefined;
|
|
23573
|
+
locales?: {
|
|
23574
|
+
autoTranslate?: boolean | undefined;
|
|
23575
|
+
locale?: string | undefined;
|
|
23576
|
+
shortDescription?: string | undefined;
|
|
23577
|
+
title?: string | undefined;
|
|
23578
|
+
}[] | undefined;
|
|
23579
|
+
shortDescription?: string | undefined;
|
|
23580
|
+
supportedLocales?: string[] | undefined;
|
|
23581
|
+
title?: string | undefined;
|
|
23582
|
+
useCustomDomain?: boolean | undefined;
|
|
23583
|
+
visibility?: "public" | "internal" | undefined;
|
|
23584
|
+
} | undefined;
|
|
23585
|
+
}>;
|
|
23427
23586
|
regeneratePage(pageId: string, data: NonNullable<paths['/docs/pages/{page_id}/generate']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
23428
23587
|
jobKey?: string | undefined;
|
|
23429
23588
|
statusUrl?: string | undefined;
|
|
@@ -27627,6 +27786,7 @@ type DocsPage = components['schemas']['DocsPage'];
|
|
|
27627
27786
|
type DocsPageResponse = components['schemas']['DocsPageResponse'];
|
|
27628
27787
|
type DocsPageSummary = components['schemas']['DocsPageSummary'];
|
|
27629
27788
|
type DocsRepository = components['schemas']['DocsRepository'];
|
|
27789
|
+
type DocsRepositoryResponse = components['schemas']['DocsRepositoryResponse'];
|
|
27630
27790
|
type EmailCampaign = components['schemas']['EmailCampaign'];
|
|
27631
27791
|
type EmailDelivery = components['schemas']['EmailDelivery'];
|
|
27632
27792
|
type EmailDeliveryStats = components['schemas']['EmailDeliveryStats'];
|
|
@@ -27799,4 +27959,4 @@ interface RateLimitOptions {
|
|
|
27799
27959
|
*/
|
|
27800
27960
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
27801
27961
|
|
|
27802
|
-
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, 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 };
|
|
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 };
|
package/dist/index.js
CHANGED
|
@@ -637,6 +637,9 @@ var DocsResource = class extends BaseResource {
|
|
|
637
637
|
async getRepository(docId, params) {
|
|
638
638
|
return this.unwrap(this.api.GET("/docs/repositories/{id}", { params: { path: { id: docId }, query: params } }));
|
|
639
639
|
}
|
|
640
|
+
async updateRepository(docId, data) {
|
|
641
|
+
return this.unwrap(this.api.PUT("/docs/repositories/{id}", { params: { path: { id: docId } }, body: data }));
|
|
642
|
+
}
|
|
640
643
|
async regeneratePage(pageId, data) {
|
|
641
644
|
return this.unwrap(this.api.POST("/docs/pages/{page_id}/generate", { params: { path: { page_id: pageId } }, body: data }));
|
|
642
645
|
}
|
package/dist/index.mjs
CHANGED
|
@@ -555,6 +555,9 @@ var DocsResource = class extends BaseResource {
|
|
|
555
555
|
async getRepository(docId, params) {
|
|
556
556
|
return this.unwrap(this.api.GET("/docs/repositories/{id}", { params: { path: { id: docId }, query: params } }));
|
|
557
557
|
}
|
|
558
|
+
async updateRepository(docId, data) {
|
|
559
|
+
return this.unwrap(this.api.PUT("/docs/repositories/{id}", { params: { path: { id: docId } }, body: data }));
|
|
560
|
+
}
|
|
558
561
|
async regeneratePage(pageId, data) {
|
|
559
562
|
return this.unwrap(this.api.POST("/docs/pages/{page_id}/generate", { params: { path: { page_id: pageId } }, body: data }));
|
|
560
563
|
}
|