@livechat/developer-studio-api 2.3.1 → 2.3.3
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 +151 -3
- package/dist/index.d.ts +151 -3
- package/dist/index.js +301 -25
- package/dist/index.mjs +297 -25
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -434,6 +434,25 @@ interface GetAppMonitoringEventsLogResponse {
|
|
|
434
434
|
next_page_from?: string;
|
|
435
435
|
}
|
|
436
436
|
|
|
437
|
+
interface TextPlatformDashboardReportItemDto {
|
|
438
|
+
usage: number;
|
|
439
|
+
amount: number;
|
|
440
|
+
client_id: string;
|
|
441
|
+
api_type: string;
|
|
442
|
+
method: string;
|
|
443
|
+
}
|
|
444
|
+
type TextPlatformDashboardReportDto = Record<string, TextPlatformDashboardReportItemDto[]>;
|
|
445
|
+
|
|
446
|
+
interface GetTextPlatformDashboardReportParams {
|
|
447
|
+
from: string;
|
|
448
|
+
to: string;
|
|
449
|
+
service?: "agent-api" | "customer-api" | "configuration-api" | "lc-webhooks" | "reports-api";
|
|
450
|
+
action?: string;
|
|
451
|
+
source?: string;
|
|
452
|
+
time_distribution: "hour" | "day";
|
|
453
|
+
group_by?: "source" | "service" | "action";
|
|
454
|
+
}
|
|
455
|
+
|
|
437
456
|
interface TextClientInstanceAuthorization {
|
|
438
457
|
token?: string;
|
|
439
458
|
tokenType?: "Basic" | "Bearer";
|
|
@@ -542,6 +561,21 @@ type GetVercelProjectsResult = VercelPaginatedResult & {
|
|
|
542
561
|
projects: VercelProject[];
|
|
543
562
|
};
|
|
544
563
|
|
|
564
|
+
interface AccountDto {
|
|
565
|
+
account_id: string;
|
|
566
|
+
avatar: string;
|
|
567
|
+
id: string;
|
|
568
|
+
job_title: string;
|
|
569
|
+
name: string;
|
|
570
|
+
role: string;
|
|
571
|
+
}
|
|
572
|
+
interface MyAccountDto {
|
|
573
|
+
account_id: string;
|
|
574
|
+
avatar_url: string;
|
|
575
|
+
email: string;
|
|
576
|
+
name: string;
|
|
577
|
+
}
|
|
578
|
+
|
|
545
579
|
interface AuthorizeData {
|
|
546
580
|
account_id: string;
|
|
547
581
|
access_token: string;
|
|
@@ -611,8 +645,9 @@ interface PatDto {
|
|
|
611
645
|
organization_id: string;
|
|
612
646
|
personal_token_id: string;
|
|
613
647
|
scope: string;
|
|
648
|
+
personal_token?: string;
|
|
614
649
|
}
|
|
615
|
-
interface
|
|
650
|
+
interface PatWithSecretDto extends PatDto {
|
|
616
651
|
personal_token: string;
|
|
617
652
|
}
|
|
618
653
|
|
|
@@ -622,6 +657,20 @@ interface ScopeDto {
|
|
|
622
657
|
beta?: boolean;
|
|
623
658
|
}
|
|
624
659
|
|
|
660
|
+
interface OrganizationDto {
|
|
661
|
+
organization_id: string;
|
|
662
|
+
name?: string;
|
|
663
|
+
invitation_mode?: "lax" | "strict";
|
|
664
|
+
company?: {
|
|
665
|
+
phone: string;
|
|
666
|
+
website: string;
|
|
667
|
+
};
|
|
668
|
+
products: {
|
|
669
|
+
product: string;
|
|
670
|
+
client_id: string;
|
|
671
|
+
}[];
|
|
672
|
+
}
|
|
673
|
+
|
|
625
674
|
interface PlatformAccountsClientInstanceAuthorization {
|
|
626
675
|
token?: string;
|
|
627
676
|
}
|
|
@@ -637,6 +686,77 @@ declare function getPlatformAccountsClientAuthorization(req: {
|
|
|
637
686
|
declare function getPlatformAccountsClientConfig(options?: PlatformAccountsClientInstanceOptions): AxiosRequestConfig;
|
|
638
687
|
declare function initPlatformAccountsClientInstance(baseUrl?: string, token?: string): void;
|
|
639
688
|
|
|
689
|
+
interface BillingAccountDto {
|
|
690
|
+
account_code: string;
|
|
691
|
+
state: string;
|
|
692
|
+
username: string;
|
|
693
|
+
email: string;
|
|
694
|
+
first_name: string;
|
|
695
|
+
last_name: string;
|
|
696
|
+
company_name: string;
|
|
697
|
+
vat_number: string;
|
|
698
|
+
tax_exempt: boolean;
|
|
699
|
+
accept_language: string;
|
|
700
|
+
address: {
|
|
701
|
+
first_name: string;
|
|
702
|
+
last_name: string;
|
|
703
|
+
phone: string;
|
|
704
|
+
city: string;
|
|
705
|
+
country: string;
|
|
706
|
+
state: string;
|
|
707
|
+
zip: string;
|
|
708
|
+
};
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
interface BillingAccountInfoDto {
|
|
712
|
+
first_name: string;
|
|
713
|
+
last_name: string;
|
|
714
|
+
company: string;
|
|
715
|
+
address1: string;
|
|
716
|
+
address2: string;
|
|
717
|
+
city: string;
|
|
718
|
+
state: string;
|
|
719
|
+
zip: string;
|
|
720
|
+
country: string;
|
|
721
|
+
phone: string;
|
|
722
|
+
vat_number: string;
|
|
723
|
+
ip_address: string;
|
|
724
|
+
ip_address_country: string;
|
|
725
|
+
card_type: string;
|
|
726
|
+
year: number;
|
|
727
|
+
month: number;
|
|
728
|
+
first_six: string;
|
|
729
|
+
last_four: string;
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
interface BillingInvoiceDto {
|
|
733
|
+
number: number;
|
|
734
|
+
state: string;
|
|
735
|
+
created_at: string;
|
|
736
|
+
total_cents: number;
|
|
737
|
+
currency: string;
|
|
738
|
+
items: {
|
|
739
|
+
description: string;
|
|
740
|
+
unit_amount_cents: number;
|
|
741
|
+
quantity: number;
|
|
742
|
+
total_amount_cents: number;
|
|
743
|
+
origin: string;
|
|
744
|
+
}[];
|
|
745
|
+
}
|
|
746
|
+
|
|
747
|
+
interface PlatformBillingClientInstanceAuthorization {
|
|
748
|
+
token?: string;
|
|
749
|
+
}
|
|
750
|
+
interface PlatformBillingClientInstanceOptions {
|
|
751
|
+
token?: string;
|
|
752
|
+
}
|
|
753
|
+
declare const platformBillingClientInstance: axios.AxiosInstance;
|
|
754
|
+
declare function getPlatformBillingClientAuthorization(req: {
|
|
755
|
+
headers: Record<string, string | string[] | undefined>;
|
|
756
|
+
}): PlatformBillingClientInstanceAuthorization;
|
|
757
|
+
declare function getPlatformBillingClientConfig(options?: PlatformBillingClientInstanceOptions): AxiosRequestConfig;
|
|
758
|
+
declare function initPlatformBillingClientInstance(baseUrl?: string, token?: string): void;
|
|
759
|
+
|
|
640
760
|
interface CreateAppPayload {
|
|
641
761
|
data: {
|
|
642
762
|
app: CreateApplicationPayload;
|
|
@@ -1821,6 +1941,11 @@ declare function initLiveChatClientInstance(baseUrl?: string, token?: string): v
|
|
|
1821
1941
|
declare const api: {
|
|
1822
1942
|
platform: {
|
|
1823
1943
|
accounts: {
|
|
1944
|
+
account: {
|
|
1945
|
+
readonly getAccounts: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<AccountDto[]>>;
|
|
1946
|
+
readonly getAccount: (accountId: string, authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<AccountDto>>;
|
|
1947
|
+
readonly getMeAccount: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<MyAccountDto>>;
|
|
1948
|
+
};
|
|
1824
1949
|
client: {
|
|
1825
1950
|
readonly getClients: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<ClientDto[]>>;
|
|
1826
1951
|
readonly getClient: (clientId: string, authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<ClientDto>>;
|
|
@@ -1833,9 +1958,13 @@ declare const api: {
|
|
|
1833
1958
|
};
|
|
1834
1959
|
pat: {
|
|
1835
1960
|
readonly getPersonalAccessTokens: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<PatDto[]>;
|
|
1836
|
-
readonly createPersonalAccessToken: (name: string, scopes: PatScopeDto[], authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<
|
|
1961
|
+
readonly createPersonalAccessToken: (name: string, scopes: PatScopeDto[], authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<PatWithSecretDto>;
|
|
1837
1962
|
readonly deletePersonalAccessToken: (id: string, authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<void>;
|
|
1838
1963
|
};
|
|
1964
|
+
organization: {
|
|
1965
|
+
readonly getOrganizations: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<OrganizationDto[]>;
|
|
1966
|
+
readonly getMyOrganization: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<OrganizationDto>>;
|
|
1967
|
+
};
|
|
1839
1968
|
products: {
|
|
1840
1969
|
readonly getOrganizationProducts: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<ProductDto[]>;
|
|
1841
1970
|
readonly updateOrganizationProducts: (payload: {
|
|
@@ -1849,6 +1978,18 @@ declare const api: {
|
|
|
1849
1978
|
readonly deleteSessions: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<void>>;
|
|
1850
1979
|
};
|
|
1851
1980
|
};
|
|
1981
|
+
billing: {
|
|
1982
|
+
account: {
|
|
1983
|
+
readonly getAccount: (authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<BillingAccountDto>>;
|
|
1984
|
+
readonly getAccountInfo: (authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<BillingAccountInfoDto>>;
|
|
1985
|
+
};
|
|
1986
|
+
invoices: {
|
|
1987
|
+
readonly getInvoices: (authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<{
|
|
1988
|
+
result: BillingInvoiceDto[];
|
|
1989
|
+
}>>;
|
|
1990
|
+
readonly downloadInvoices: (number: number, authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<void>;
|
|
1991
|
+
};
|
|
1992
|
+
};
|
|
1852
1993
|
adapter: {
|
|
1853
1994
|
app: {
|
|
1854
1995
|
blocks: {
|
|
@@ -2300,6 +2441,12 @@ declare const api: {
|
|
|
2300
2441
|
};
|
|
2301
2442
|
};
|
|
2302
2443
|
};
|
|
2444
|
+
platform: {
|
|
2445
|
+
dashboard: {
|
|
2446
|
+
getReport(params: GetTextPlatformDashboardReportParams, authorization?: TextClientInstanceAuthorization | undefined): Promise<TextPlatformDashboardReportDto>;
|
|
2447
|
+
getCredits(authorization?: TextClientInstanceAuthorization | undefined): Promise<unknown>;
|
|
2448
|
+
};
|
|
2449
|
+
};
|
|
2303
2450
|
};
|
|
2304
2451
|
};
|
|
2305
2452
|
isInitialized: boolean;
|
|
@@ -2308,6 +2455,7 @@ declare function initApi(config: {
|
|
|
2308
2455
|
urls: {
|
|
2309
2456
|
platform?: {
|
|
2310
2457
|
accounts?: string;
|
|
2458
|
+
billing?: string;
|
|
2311
2459
|
adapter?: string;
|
|
2312
2460
|
dps?: string;
|
|
2313
2461
|
};
|
|
@@ -2369,4 +2517,4 @@ declare const serializerBase64: {
|
|
|
2369
2517
|
deserialize<T_1>(message?: string): T_1 | undefined;
|
|
2370
2518
|
};
|
|
2371
2519
|
|
|
2372
|
-
export { API_NOTIFICATIONS, AddAppAuthorizationData, AddAppAuthorizationPayload, AddAppAuthorizationResult, AgentDto, ApiError, AppDeployment, AppDeploymentBlock, AppDeploymentMode, AppDeploymentProvider, AppGitHubRepository, AppGitHubRepositoryConfig, AppGitLabRepository, AppInfrastructureBlocks, AppLoggerBlock, AppLoggerProvider, AppMonitoringCustomReport, AppMonitoringCustomReportDataDto, AppMonitoringEvent, AppMonitoringEventData, AppMonitoringEventsLog, AppMonitoringEventsLogItem, AppMonitoringEventsReportDto, AppMonitoringReportParams, AppMonitoringUptimeReportDto, AppNetlifyDeployment, AppNetlifyDeploymentConfig, AppPlanetScaleStorage, AppPlanetScaleStorageConfig, AppRepository, AppRepositoryBlock, AppRepositoryProvider, AppRepositoryTarget, AppResourceDto, AppSentryLogger, AppSentryLoggerConfig, AppStorage, AppStorageBlock, AppStorageProvider, AppVariable, AppVariableExternalProvider, AppVariableLocalProvider, AppVariableProvider, AppVariableStatus, AppVariableType, AppVercelDeployment, AppVercelDeploymentConfig, AppVercelStorage, AppVercelStorageConfig, ApplicationAutoReviewDto, ApplicationAutoReviewPayload, ApplicationBasicDetailsDto, ApplicationBenefitDto, ApplicationDto, ApplicationFeatureDto, ApplicationIconDto, ApplicationOverviewDto, ApplicationPaymentDto, ApplicationPropertyDto, ApplicationScreenshotDto, ApplicationTutorialAndSupportDto, ApplicationUsageOptionsDto, AuthorizeData, Category, ClientDto, ClientInfoDto, ClientScopeDto, ClientWithSecretDto, CreateAppOutput, CreateAppPayload, CreateAppResult, CreateAppStatus, CreateAppStepStatus, CreateApplicationAuthorizationPayload, CreateApplicationChatActionPayload, CreateApplicationPayload, CreateApplicationResponse, CreateApplicationSubmissionPayload, CreateClientPayload, CreateDeveloperMessagePayload,
|
|
2520
|
+
export { API_NOTIFICATIONS, AccountDto, AddAppAuthorizationData, AddAppAuthorizationPayload, AddAppAuthorizationResult, AgentDto, ApiError, AppDeployment, AppDeploymentBlock, AppDeploymentMode, AppDeploymentProvider, AppGitHubRepository, AppGitHubRepositoryConfig, AppGitLabRepository, AppInfrastructureBlocks, AppLoggerBlock, AppLoggerProvider, AppMonitoringCustomReport, AppMonitoringCustomReportDataDto, AppMonitoringEvent, AppMonitoringEventData, AppMonitoringEventsLog, AppMonitoringEventsLogItem, AppMonitoringEventsReportDto, AppMonitoringReportParams, AppMonitoringUptimeReportDto, AppNetlifyDeployment, AppNetlifyDeploymentConfig, AppPlanetScaleStorage, AppPlanetScaleStorageConfig, AppRepository, AppRepositoryBlock, AppRepositoryProvider, AppRepositoryTarget, AppResourceDto, AppSentryLogger, AppSentryLoggerConfig, AppStorage, AppStorageBlock, AppStorageProvider, AppVariable, AppVariableExternalProvider, AppVariableLocalProvider, AppVariableProvider, AppVariableStatus, AppVariableType, AppVercelDeployment, AppVercelDeploymentConfig, AppVercelStorage, AppVercelStorageConfig, ApplicationAutoReviewDto, ApplicationAutoReviewPayload, ApplicationBasicDetailsDto, ApplicationBenefitDto, ApplicationDto, ApplicationFeatureDto, ApplicationIconDto, ApplicationOverviewDto, ApplicationPaymentDto, ApplicationPropertyDto, ApplicationScreenshotDto, ApplicationTutorialAndSupportDto, ApplicationUsageOptionsDto, AuthorizeData, BillingAccountDto, BillingAccountInfoDto, BillingInvoiceDto, Category, ClientDto, ClientInfoDto, ClientScopeDto, ClientWithSecretDto, CreateAppOutput, CreateAppPayload, CreateAppResult, CreateAppStatus, CreateAppStepStatus, CreateApplicationAuthorizationPayload, CreateApplicationChatActionPayload, CreateApplicationPayload, CreateApplicationResponse, CreateApplicationSubmissionPayload, CreateClientPayload, CreateDeveloperMessagePayload, DeveloperLedgerParams, DeveloperMessage, DeveloperMessageBaseDto, DeveloperMessageDto, GetAppMonitoringCustomReportDataPayload, GetAppMonitoringEventsLogPayload, GetAppMonitoringEventsLogResponse, GetAppMonitoringEventsReportPayload, GetAppMonitoringUptimeReportPayload, GetPlanetScaleDatabasePasswordsResult, GetPlanetScaleDatabasesResult, GetPlanetScaleOrganizationsResult, GetTextPlatformDashboardReportParams, GetVercelProjectsResult, GitHubInstallation, GitHubRepository, GitHubRepositoryBranch, GitHubRepositoryHook, GitHubRepositoryKey, GitHubRepositorySeed, GithubClientInstanceAuthorization, GithubClientRequestOptions, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryGitLabData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppSentryLoggerPayload, LinkAppStorageData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LinkAppStorageVercelData, LiveChatClientInstanceAuthorization, LiveChatClientInstanceOptions, MyAccountDto, NetlifyAccount, NetlifyClientInstanceAuthorization, NetlifyClientInstanceOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleClientInstanceAuthorization, PlanetScaleClientInstanceOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientInstanceAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientInstanceAuthorization, PlatformAdapterClientInstanceOptions, PlatformBillingClientInstanceAuthorization, PlatformBillingClientInstanceOptions, PlatformDpsClientInstanceAuthorization, PlatformDpsClientInstanceOptions, ProductDto, PropertiesDto, Property, PropertyAccessDto, PropertyAccessItemDto, PropertyDto, ResearchCustomerItemDto, ResearchCustomerLocationItemDto, ResearchDictionaryParams, ResearchMarketplaceItemDto, ResearchMarketplaceParams, ResearchTrafficItemDto, ResearchTrafficParams, ScopeDto, SeedAppRepositoryPayload, SeedAppRepositoryResult, SentryClientInstanceAuthorization, SentryClientInstanceOptions, SentryIntegration, SentryOrganization, SentryProject, SentryProjectIssue, SentryProjectIssueEvent, SentryProjectKey, SentryRepository, SentryTeam, ShortcutDto, SyncAppVariablePayload, TextClientInstanceAuthorization, TextClientInstanceOptions, TextPlatformDashboardReportDto, TextPlatformDashboardReportItemDto, UnauthorizeApiError, UnauthorizeApiErrorSource, UnlinkAppDeploymentPayload, UnlinkAppRepositoryPayload, UnlinkAppSentryLoggerPayload, UnlinkAppStoragePayload, UpdateAppInfrastructureBlocksPayload, UpdateApplicationChangelogPayload, UpdateApplicationChatActionPayload, UpdateApplicationDirectInstallUrlPayload, UpdateApplicationIconPayload, UpdateApplicationOnboardingPayload, UpdateApplicationProductPayload, UpdateApplicationWebhookPayload, UpdateApplicationWidgetDto, UpdateChatWebhookPayload, UpdateClientPayload, UpdateUserFeatures, UpdateUserIntegrations, UpsertAppResourcePayload, UpsertApplicationChatBoosterPayload, UserDto, UserGitHubIntegrationDto, UserIntegrationsDto, UserNetlifyIntegrationDto, UserPlanetScaleIntegrationDto, UserSentryIntegrationDto, UserVercelIntegrationDto, VercelClientInstanceAuthorization, VercelClientInstanceOptions, VercelDeploy, VercelNamespace, VercelPaginatedResult, VercelPagination, VercelProject, VercelProjectEnv, VercelRepository, VercelSearchRepositoryResponse, Webhook, WebhookDto, api, getAppAutoReviewPayload, getEmptyAppAutoReview, getGitHubClientAuthorization, getGithubClientRequestConfig, getLiveChatClientAuthorization, getLiveChatClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getSentryClientAuthorization, getSentryClientConfig, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClientInstance, initLiveChatClientInstance, initNetlifyClientInstance, initPlanetScaleClientInstance, initPlatformAccountsClientInstance, initPlatformAdapterClientInstance, initPlatformBillingClientInstance, initPlatformDpsClientInstance, initSentryClientInstance, initTextClientInstance, initVercelClientInstance, livechatClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, sentryClientInstance, serializerBase64, textClientInstance, updateGithubClientInstance, updateNetlifyClientInstance, updatePlanetScaleClientInstance, updatePlatformAdapterClientInstance, updateSentryClientInstance, updateVercelClientInstance, vercelClientInstance };
|
package/dist/index.d.ts
CHANGED
|
@@ -434,6 +434,25 @@ interface GetAppMonitoringEventsLogResponse {
|
|
|
434
434
|
next_page_from?: string;
|
|
435
435
|
}
|
|
436
436
|
|
|
437
|
+
interface TextPlatformDashboardReportItemDto {
|
|
438
|
+
usage: number;
|
|
439
|
+
amount: number;
|
|
440
|
+
client_id: string;
|
|
441
|
+
api_type: string;
|
|
442
|
+
method: string;
|
|
443
|
+
}
|
|
444
|
+
type TextPlatformDashboardReportDto = Record<string, TextPlatformDashboardReportItemDto[]>;
|
|
445
|
+
|
|
446
|
+
interface GetTextPlatformDashboardReportParams {
|
|
447
|
+
from: string;
|
|
448
|
+
to: string;
|
|
449
|
+
service?: "agent-api" | "customer-api" | "configuration-api" | "lc-webhooks" | "reports-api";
|
|
450
|
+
action?: string;
|
|
451
|
+
source?: string;
|
|
452
|
+
time_distribution: "hour" | "day";
|
|
453
|
+
group_by?: "source" | "service" | "action";
|
|
454
|
+
}
|
|
455
|
+
|
|
437
456
|
interface TextClientInstanceAuthorization {
|
|
438
457
|
token?: string;
|
|
439
458
|
tokenType?: "Basic" | "Bearer";
|
|
@@ -542,6 +561,21 @@ type GetVercelProjectsResult = VercelPaginatedResult & {
|
|
|
542
561
|
projects: VercelProject[];
|
|
543
562
|
};
|
|
544
563
|
|
|
564
|
+
interface AccountDto {
|
|
565
|
+
account_id: string;
|
|
566
|
+
avatar: string;
|
|
567
|
+
id: string;
|
|
568
|
+
job_title: string;
|
|
569
|
+
name: string;
|
|
570
|
+
role: string;
|
|
571
|
+
}
|
|
572
|
+
interface MyAccountDto {
|
|
573
|
+
account_id: string;
|
|
574
|
+
avatar_url: string;
|
|
575
|
+
email: string;
|
|
576
|
+
name: string;
|
|
577
|
+
}
|
|
578
|
+
|
|
545
579
|
interface AuthorizeData {
|
|
546
580
|
account_id: string;
|
|
547
581
|
access_token: string;
|
|
@@ -611,8 +645,9 @@ interface PatDto {
|
|
|
611
645
|
organization_id: string;
|
|
612
646
|
personal_token_id: string;
|
|
613
647
|
scope: string;
|
|
648
|
+
personal_token?: string;
|
|
614
649
|
}
|
|
615
|
-
interface
|
|
650
|
+
interface PatWithSecretDto extends PatDto {
|
|
616
651
|
personal_token: string;
|
|
617
652
|
}
|
|
618
653
|
|
|
@@ -622,6 +657,20 @@ interface ScopeDto {
|
|
|
622
657
|
beta?: boolean;
|
|
623
658
|
}
|
|
624
659
|
|
|
660
|
+
interface OrganizationDto {
|
|
661
|
+
organization_id: string;
|
|
662
|
+
name?: string;
|
|
663
|
+
invitation_mode?: "lax" | "strict";
|
|
664
|
+
company?: {
|
|
665
|
+
phone: string;
|
|
666
|
+
website: string;
|
|
667
|
+
};
|
|
668
|
+
products: {
|
|
669
|
+
product: string;
|
|
670
|
+
client_id: string;
|
|
671
|
+
}[];
|
|
672
|
+
}
|
|
673
|
+
|
|
625
674
|
interface PlatformAccountsClientInstanceAuthorization {
|
|
626
675
|
token?: string;
|
|
627
676
|
}
|
|
@@ -637,6 +686,77 @@ declare function getPlatformAccountsClientAuthorization(req: {
|
|
|
637
686
|
declare function getPlatformAccountsClientConfig(options?: PlatformAccountsClientInstanceOptions): AxiosRequestConfig;
|
|
638
687
|
declare function initPlatformAccountsClientInstance(baseUrl?: string, token?: string): void;
|
|
639
688
|
|
|
689
|
+
interface BillingAccountDto {
|
|
690
|
+
account_code: string;
|
|
691
|
+
state: string;
|
|
692
|
+
username: string;
|
|
693
|
+
email: string;
|
|
694
|
+
first_name: string;
|
|
695
|
+
last_name: string;
|
|
696
|
+
company_name: string;
|
|
697
|
+
vat_number: string;
|
|
698
|
+
tax_exempt: boolean;
|
|
699
|
+
accept_language: string;
|
|
700
|
+
address: {
|
|
701
|
+
first_name: string;
|
|
702
|
+
last_name: string;
|
|
703
|
+
phone: string;
|
|
704
|
+
city: string;
|
|
705
|
+
country: string;
|
|
706
|
+
state: string;
|
|
707
|
+
zip: string;
|
|
708
|
+
};
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
interface BillingAccountInfoDto {
|
|
712
|
+
first_name: string;
|
|
713
|
+
last_name: string;
|
|
714
|
+
company: string;
|
|
715
|
+
address1: string;
|
|
716
|
+
address2: string;
|
|
717
|
+
city: string;
|
|
718
|
+
state: string;
|
|
719
|
+
zip: string;
|
|
720
|
+
country: string;
|
|
721
|
+
phone: string;
|
|
722
|
+
vat_number: string;
|
|
723
|
+
ip_address: string;
|
|
724
|
+
ip_address_country: string;
|
|
725
|
+
card_type: string;
|
|
726
|
+
year: number;
|
|
727
|
+
month: number;
|
|
728
|
+
first_six: string;
|
|
729
|
+
last_four: string;
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
interface BillingInvoiceDto {
|
|
733
|
+
number: number;
|
|
734
|
+
state: string;
|
|
735
|
+
created_at: string;
|
|
736
|
+
total_cents: number;
|
|
737
|
+
currency: string;
|
|
738
|
+
items: {
|
|
739
|
+
description: string;
|
|
740
|
+
unit_amount_cents: number;
|
|
741
|
+
quantity: number;
|
|
742
|
+
total_amount_cents: number;
|
|
743
|
+
origin: string;
|
|
744
|
+
}[];
|
|
745
|
+
}
|
|
746
|
+
|
|
747
|
+
interface PlatformBillingClientInstanceAuthorization {
|
|
748
|
+
token?: string;
|
|
749
|
+
}
|
|
750
|
+
interface PlatformBillingClientInstanceOptions {
|
|
751
|
+
token?: string;
|
|
752
|
+
}
|
|
753
|
+
declare const platformBillingClientInstance: axios.AxiosInstance;
|
|
754
|
+
declare function getPlatformBillingClientAuthorization(req: {
|
|
755
|
+
headers: Record<string, string | string[] | undefined>;
|
|
756
|
+
}): PlatformBillingClientInstanceAuthorization;
|
|
757
|
+
declare function getPlatformBillingClientConfig(options?: PlatformBillingClientInstanceOptions): AxiosRequestConfig;
|
|
758
|
+
declare function initPlatformBillingClientInstance(baseUrl?: string, token?: string): void;
|
|
759
|
+
|
|
640
760
|
interface CreateAppPayload {
|
|
641
761
|
data: {
|
|
642
762
|
app: CreateApplicationPayload;
|
|
@@ -1821,6 +1941,11 @@ declare function initLiveChatClientInstance(baseUrl?: string, token?: string): v
|
|
|
1821
1941
|
declare const api: {
|
|
1822
1942
|
platform: {
|
|
1823
1943
|
accounts: {
|
|
1944
|
+
account: {
|
|
1945
|
+
readonly getAccounts: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<AccountDto[]>>;
|
|
1946
|
+
readonly getAccount: (accountId: string, authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<AccountDto>>;
|
|
1947
|
+
readonly getMeAccount: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<MyAccountDto>>;
|
|
1948
|
+
};
|
|
1824
1949
|
client: {
|
|
1825
1950
|
readonly getClients: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<ClientDto[]>>;
|
|
1826
1951
|
readonly getClient: (clientId: string, authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<ClientDto>>;
|
|
@@ -1833,9 +1958,13 @@ declare const api: {
|
|
|
1833
1958
|
};
|
|
1834
1959
|
pat: {
|
|
1835
1960
|
readonly getPersonalAccessTokens: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<PatDto[]>;
|
|
1836
|
-
readonly createPersonalAccessToken: (name: string, scopes: PatScopeDto[], authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<
|
|
1961
|
+
readonly createPersonalAccessToken: (name: string, scopes: PatScopeDto[], authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<PatWithSecretDto>;
|
|
1837
1962
|
readonly deletePersonalAccessToken: (id: string, authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<void>;
|
|
1838
1963
|
};
|
|
1964
|
+
organization: {
|
|
1965
|
+
readonly getOrganizations: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<OrganizationDto[]>;
|
|
1966
|
+
readonly getMyOrganization: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<OrganizationDto>>;
|
|
1967
|
+
};
|
|
1839
1968
|
products: {
|
|
1840
1969
|
readonly getOrganizationProducts: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<ProductDto[]>;
|
|
1841
1970
|
readonly updateOrganizationProducts: (payload: {
|
|
@@ -1849,6 +1978,18 @@ declare const api: {
|
|
|
1849
1978
|
readonly deleteSessions: (authorization?: PlatformAccountsClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<void>>;
|
|
1850
1979
|
};
|
|
1851
1980
|
};
|
|
1981
|
+
billing: {
|
|
1982
|
+
account: {
|
|
1983
|
+
readonly getAccount: (authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<BillingAccountDto>>;
|
|
1984
|
+
readonly getAccountInfo: (authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<BillingAccountInfoDto>>;
|
|
1985
|
+
};
|
|
1986
|
+
invoices: {
|
|
1987
|
+
readonly getInvoices: (authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<axios.AxiosResponse<{
|
|
1988
|
+
result: BillingInvoiceDto[];
|
|
1989
|
+
}>>;
|
|
1990
|
+
readonly downloadInvoices: (number: number, authorization?: PlatformBillingClientInstanceAuthorization | undefined) => Promise<void>;
|
|
1991
|
+
};
|
|
1992
|
+
};
|
|
1852
1993
|
adapter: {
|
|
1853
1994
|
app: {
|
|
1854
1995
|
blocks: {
|
|
@@ -2300,6 +2441,12 @@ declare const api: {
|
|
|
2300
2441
|
};
|
|
2301
2442
|
};
|
|
2302
2443
|
};
|
|
2444
|
+
platform: {
|
|
2445
|
+
dashboard: {
|
|
2446
|
+
getReport(params: GetTextPlatformDashboardReportParams, authorization?: TextClientInstanceAuthorization | undefined): Promise<TextPlatformDashboardReportDto>;
|
|
2447
|
+
getCredits(authorization?: TextClientInstanceAuthorization | undefined): Promise<unknown>;
|
|
2448
|
+
};
|
|
2449
|
+
};
|
|
2303
2450
|
};
|
|
2304
2451
|
};
|
|
2305
2452
|
isInitialized: boolean;
|
|
@@ -2308,6 +2455,7 @@ declare function initApi(config: {
|
|
|
2308
2455
|
urls: {
|
|
2309
2456
|
platform?: {
|
|
2310
2457
|
accounts?: string;
|
|
2458
|
+
billing?: string;
|
|
2311
2459
|
adapter?: string;
|
|
2312
2460
|
dps?: string;
|
|
2313
2461
|
};
|
|
@@ -2369,4 +2517,4 @@ declare const serializerBase64: {
|
|
|
2369
2517
|
deserialize<T_1>(message?: string): T_1 | undefined;
|
|
2370
2518
|
};
|
|
2371
2519
|
|
|
2372
|
-
export { API_NOTIFICATIONS, AddAppAuthorizationData, AddAppAuthorizationPayload, AddAppAuthorizationResult, AgentDto, ApiError, AppDeployment, AppDeploymentBlock, AppDeploymentMode, AppDeploymentProvider, AppGitHubRepository, AppGitHubRepositoryConfig, AppGitLabRepository, AppInfrastructureBlocks, AppLoggerBlock, AppLoggerProvider, AppMonitoringCustomReport, AppMonitoringCustomReportDataDto, AppMonitoringEvent, AppMonitoringEventData, AppMonitoringEventsLog, AppMonitoringEventsLogItem, AppMonitoringEventsReportDto, AppMonitoringReportParams, AppMonitoringUptimeReportDto, AppNetlifyDeployment, AppNetlifyDeploymentConfig, AppPlanetScaleStorage, AppPlanetScaleStorageConfig, AppRepository, AppRepositoryBlock, AppRepositoryProvider, AppRepositoryTarget, AppResourceDto, AppSentryLogger, AppSentryLoggerConfig, AppStorage, AppStorageBlock, AppStorageProvider, AppVariable, AppVariableExternalProvider, AppVariableLocalProvider, AppVariableProvider, AppVariableStatus, AppVariableType, AppVercelDeployment, AppVercelDeploymentConfig, AppVercelStorage, AppVercelStorageConfig, ApplicationAutoReviewDto, ApplicationAutoReviewPayload, ApplicationBasicDetailsDto, ApplicationBenefitDto, ApplicationDto, ApplicationFeatureDto, ApplicationIconDto, ApplicationOverviewDto, ApplicationPaymentDto, ApplicationPropertyDto, ApplicationScreenshotDto, ApplicationTutorialAndSupportDto, ApplicationUsageOptionsDto, AuthorizeData, Category, ClientDto, ClientInfoDto, ClientScopeDto, ClientWithSecretDto, CreateAppOutput, CreateAppPayload, CreateAppResult, CreateAppStatus, CreateAppStepStatus, CreateApplicationAuthorizationPayload, CreateApplicationChatActionPayload, CreateApplicationPayload, CreateApplicationResponse, CreateApplicationSubmissionPayload, CreateClientPayload, CreateDeveloperMessagePayload,
|
|
2520
|
+
export { API_NOTIFICATIONS, AccountDto, AddAppAuthorizationData, AddAppAuthorizationPayload, AddAppAuthorizationResult, AgentDto, ApiError, AppDeployment, AppDeploymentBlock, AppDeploymentMode, AppDeploymentProvider, AppGitHubRepository, AppGitHubRepositoryConfig, AppGitLabRepository, AppInfrastructureBlocks, AppLoggerBlock, AppLoggerProvider, AppMonitoringCustomReport, AppMonitoringCustomReportDataDto, AppMonitoringEvent, AppMonitoringEventData, AppMonitoringEventsLog, AppMonitoringEventsLogItem, AppMonitoringEventsReportDto, AppMonitoringReportParams, AppMonitoringUptimeReportDto, AppNetlifyDeployment, AppNetlifyDeploymentConfig, AppPlanetScaleStorage, AppPlanetScaleStorageConfig, AppRepository, AppRepositoryBlock, AppRepositoryProvider, AppRepositoryTarget, AppResourceDto, AppSentryLogger, AppSentryLoggerConfig, AppStorage, AppStorageBlock, AppStorageProvider, AppVariable, AppVariableExternalProvider, AppVariableLocalProvider, AppVariableProvider, AppVariableStatus, AppVariableType, AppVercelDeployment, AppVercelDeploymentConfig, AppVercelStorage, AppVercelStorageConfig, ApplicationAutoReviewDto, ApplicationAutoReviewPayload, ApplicationBasicDetailsDto, ApplicationBenefitDto, ApplicationDto, ApplicationFeatureDto, ApplicationIconDto, ApplicationOverviewDto, ApplicationPaymentDto, ApplicationPropertyDto, ApplicationScreenshotDto, ApplicationTutorialAndSupportDto, ApplicationUsageOptionsDto, AuthorizeData, BillingAccountDto, BillingAccountInfoDto, BillingInvoiceDto, Category, ClientDto, ClientInfoDto, ClientScopeDto, ClientWithSecretDto, CreateAppOutput, CreateAppPayload, CreateAppResult, CreateAppStatus, CreateAppStepStatus, CreateApplicationAuthorizationPayload, CreateApplicationChatActionPayload, CreateApplicationPayload, CreateApplicationResponse, CreateApplicationSubmissionPayload, CreateClientPayload, CreateDeveloperMessagePayload, DeveloperLedgerParams, DeveloperMessage, DeveloperMessageBaseDto, DeveloperMessageDto, GetAppMonitoringCustomReportDataPayload, GetAppMonitoringEventsLogPayload, GetAppMonitoringEventsLogResponse, GetAppMonitoringEventsReportPayload, GetAppMonitoringUptimeReportPayload, GetPlanetScaleDatabasePasswordsResult, GetPlanetScaleDatabasesResult, GetPlanetScaleOrganizationsResult, GetTextPlatformDashboardReportParams, GetVercelProjectsResult, GitHubInstallation, GitHubRepository, GitHubRepositoryBranch, GitHubRepositoryHook, GitHubRepositoryKey, GitHubRepositorySeed, GithubClientInstanceAuthorization, GithubClientRequestOptions, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryGitLabData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppSentryLoggerPayload, LinkAppStorageData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LinkAppStorageVercelData, LiveChatClientInstanceAuthorization, LiveChatClientInstanceOptions, MyAccountDto, NetlifyAccount, NetlifyClientInstanceAuthorization, NetlifyClientInstanceOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleClientInstanceAuthorization, PlanetScaleClientInstanceOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientInstanceAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientInstanceAuthorization, PlatformAdapterClientInstanceOptions, PlatformBillingClientInstanceAuthorization, PlatformBillingClientInstanceOptions, PlatformDpsClientInstanceAuthorization, PlatformDpsClientInstanceOptions, ProductDto, PropertiesDto, Property, PropertyAccessDto, PropertyAccessItemDto, PropertyDto, ResearchCustomerItemDto, ResearchCustomerLocationItemDto, ResearchDictionaryParams, ResearchMarketplaceItemDto, ResearchMarketplaceParams, ResearchTrafficItemDto, ResearchTrafficParams, ScopeDto, SeedAppRepositoryPayload, SeedAppRepositoryResult, SentryClientInstanceAuthorization, SentryClientInstanceOptions, SentryIntegration, SentryOrganization, SentryProject, SentryProjectIssue, SentryProjectIssueEvent, SentryProjectKey, SentryRepository, SentryTeam, ShortcutDto, SyncAppVariablePayload, TextClientInstanceAuthorization, TextClientInstanceOptions, TextPlatformDashboardReportDto, TextPlatformDashboardReportItemDto, UnauthorizeApiError, UnauthorizeApiErrorSource, UnlinkAppDeploymentPayload, UnlinkAppRepositoryPayload, UnlinkAppSentryLoggerPayload, UnlinkAppStoragePayload, UpdateAppInfrastructureBlocksPayload, UpdateApplicationChangelogPayload, UpdateApplicationChatActionPayload, UpdateApplicationDirectInstallUrlPayload, UpdateApplicationIconPayload, UpdateApplicationOnboardingPayload, UpdateApplicationProductPayload, UpdateApplicationWebhookPayload, UpdateApplicationWidgetDto, UpdateChatWebhookPayload, UpdateClientPayload, UpdateUserFeatures, UpdateUserIntegrations, UpsertAppResourcePayload, UpsertApplicationChatBoosterPayload, UserDto, UserGitHubIntegrationDto, UserIntegrationsDto, UserNetlifyIntegrationDto, UserPlanetScaleIntegrationDto, UserSentryIntegrationDto, UserVercelIntegrationDto, VercelClientInstanceAuthorization, VercelClientInstanceOptions, VercelDeploy, VercelNamespace, VercelPaginatedResult, VercelPagination, VercelProject, VercelProjectEnv, VercelRepository, VercelSearchRepositoryResponse, Webhook, WebhookDto, api, getAppAutoReviewPayload, getEmptyAppAutoReview, getGitHubClientAuthorization, getGithubClientRequestConfig, getLiveChatClientAuthorization, getLiveChatClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getSentryClientAuthorization, getSentryClientConfig, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClientInstance, initLiveChatClientInstance, initNetlifyClientInstance, initPlanetScaleClientInstance, initPlatformAccountsClientInstance, initPlatformAdapterClientInstance, initPlatformBillingClientInstance, initPlatformDpsClientInstance, initSentryClientInstance, initTextClientInstance, initVercelClientInstance, livechatClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, sentryClientInstance, serializerBase64, textClientInstance, updateGithubClientInstance, updateNetlifyClientInstance, updatePlanetScaleClientInstance, updatePlatformAdapterClientInstance, updateSentryClientInstance, updateVercelClientInstance, vercelClientInstance };
|