@livechat/developer-studio-api 3.0.8 → 3.0.10
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 +114 -11
- package/dist/index.d.ts +114 -11
- package/dist/index.js +247 -319
- package/dist/index.mjs +218 -291
- package/package.json +3 -2
package/dist/index.d.mts
CHANGED
|
@@ -591,6 +591,7 @@ interface AuthorizeData {
|
|
|
591
591
|
organization_id: string;
|
|
592
592
|
scope: string;
|
|
593
593
|
token_type: "Bearer";
|
|
594
|
+
refresh_token: string;
|
|
594
595
|
}
|
|
595
596
|
|
|
596
597
|
interface ProductDto {
|
|
@@ -708,6 +709,7 @@ declare class UnauthorizeApiError extends Error {
|
|
|
708
709
|
readonly kind: ApiErrorKind;
|
|
709
710
|
readonly code = 401;
|
|
710
711
|
constructor(source: ApiErrorSource, message?: string);
|
|
712
|
+
withCustomMessage(_message: string): this;
|
|
711
713
|
}
|
|
712
714
|
|
|
713
715
|
interface SagaStep<TData = unknown, TOutput = unknown, TStatus = unknown> {
|
|
@@ -770,6 +772,7 @@ interface PlatformAccountsClientInstanceAuthorization {
|
|
|
770
772
|
token?: string;
|
|
771
773
|
}
|
|
772
774
|
interface PlatformAccountsClientInstanceOptions {
|
|
775
|
+
ensureAuthorizationToken?: boolean;
|
|
773
776
|
token?: string;
|
|
774
777
|
}
|
|
775
778
|
declare const platformAccountsClientInstance: axios.AxiosInstance;
|
|
@@ -1055,7 +1058,6 @@ type LinkAppDeploymentData = (({
|
|
|
1055
1058
|
};
|
|
1056
1059
|
type LinkAppDeploymentPayload = {
|
|
1057
1060
|
appId: string;
|
|
1058
|
-
appName: string;
|
|
1059
1061
|
} & LinkAppDeploymentData;
|
|
1060
1062
|
interface LinkAppDeploymentResult {
|
|
1061
1063
|
url: string;
|
|
@@ -1171,7 +1173,6 @@ type LinkAppRepositoryData = {
|
|
|
1171
1173
|
} & LinkAppRepositoryGitHubData);
|
|
1172
1174
|
type LinkAppRepositoryPayload = {
|
|
1173
1175
|
appId: string;
|
|
1174
|
-
appName: string;
|
|
1175
1176
|
} & LinkAppRepositoryData;
|
|
1176
1177
|
interface LinkAppRepositoryResult {
|
|
1177
1178
|
name: string;
|
|
@@ -1252,7 +1253,6 @@ type LinkAppStorageData = (({
|
|
|
1252
1253
|
};
|
|
1253
1254
|
type LinkAppStoragePayload = {
|
|
1254
1255
|
appId: string;
|
|
1255
|
-
appName: string;
|
|
1256
1256
|
} & LinkAppStorageData;
|
|
1257
1257
|
|
|
1258
1258
|
interface UnlinkAppStorageData {
|
|
@@ -1431,6 +1431,105 @@ interface AppTemplates {
|
|
|
1431
1431
|
saas: AppTemplate;
|
|
1432
1432
|
}
|
|
1433
1433
|
|
|
1434
|
+
interface IntegrationFlowContext {
|
|
1435
|
+
userId: string;
|
|
1436
|
+
userToken: string;
|
|
1437
|
+
redirectUrl: string;
|
|
1438
|
+
state: string;
|
|
1439
|
+
}
|
|
1440
|
+
type IntegrationFlowOutput<TFlowResult> = {
|
|
1441
|
+
status: "success";
|
|
1442
|
+
result: TFlowResult;
|
|
1443
|
+
} | {
|
|
1444
|
+
status: "error";
|
|
1445
|
+
message: string;
|
|
1446
|
+
} | {
|
|
1447
|
+
status: "cancel";
|
|
1448
|
+
};
|
|
1449
|
+
|
|
1450
|
+
interface GitHubAuthorizeAppActionResult {
|
|
1451
|
+
appToken: string;
|
|
1452
|
+
}
|
|
1453
|
+
interface GitHubAuthorizeOauthActionResult {
|
|
1454
|
+
oauthToken: string;
|
|
1455
|
+
}
|
|
1456
|
+
type GitHubAuthorizeFlowContext = IntegrationFlowContext;
|
|
1457
|
+
type GitHubAuthorizeFlowResult = GitHubAuthorizeAppActionResult & GitHubAuthorizeOauthActionResult;
|
|
1458
|
+
|
|
1459
|
+
interface GitHubInstallActionContext {
|
|
1460
|
+
targetRepository?: string;
|
|
1461
|
+
isAlreadyInstalled?: true;
|
|
1462
|
+
showInstruction?: true;
|
|
1463
|
+
}
|
|
1464
|
+
interface GitHubInstallActionResult {
|
|
1465
|
+
appToken: string;
|
|
1466
|
+
installationId: string;
|
|
1467
|
+
}
|
|
1468
|
+
type GitHubInstallFlowContext = IntegrationFlowContext & {
|
|
1469
|
+
install: GitHubInstallActionContext;
|
|
1470
|
+
};
|
|
1471
|
+
type GitHubInstallFlowResult = GitHubInstallActionResult;
|
|
1472
|
+
|
|
1473
|
+
interface NeonAuthorizeActionResult {
|
|
1474
|
+
token: string;
|
|
1475
|
+
refreshToken: string;
|
|
1476
|
+
}
|
|
1477
|
+
type NeonAuthorizeFlowContext = IntegrationFlowContext;
|
|
1478
|
+
type NeonAuthorizeFlowResult = NeonAuthorizeActionResult;
|
|
1479
|
+
|
|
1480
|
+
interface NetlifyAuthorizeActionResult {
|
|
1481
|
+
token: string;
|
|
1482
|
+
}
|
|
1483
|
+
type NetlifyAuthorizeFlowContext = IntegrationFlowContext;
|
|
1484
|
+
type NetlifyAuthorizeFlowResult = NetlifyAuthorizeActionResult;
|
|
1485
|
+
|
|
1486
|
+
interface NetlifyInstallActionContext {
|
|
1487
|
+
siteId?: string;
|
|
1488
|
+
token?: string;
|
|
1489
|
+
targetRepository?: string;
|
|
1490
|
+
showInstruction?: true;
|
|
1491
|
+
}
|
|
1492
|
+
interface NetlifyInstallActionResult {
|
|
1493
|
+
installationId: string;
|
|
1494
|
+
}
|
|
1495
|
+
type NetlifyInstallFlowContext = IntegrationFlowContext & {
|
|
1496
|
+
install: NetlifyInstallActionContext;
|
|
1497
|
+
};
|
|
1498
|
+
type NetlifyInstallFlowResult = NetlifyInstallActionResult;
|
|
1499
|
+
|
|
1500
|
+
interface PlanetScaleAuthorizeActionResult {
|
|
1501
|
+
token: string;
|
|
1502
|
+
refreshToken: string;
|
|
1503
|
+
}
|
|
1504
|
+
type PlanetScaleAuthorizeFlowContext = IntegrationFlowContext;
|
|
1505
|
+
type PlanetScaleAuthorizeFlowResult = PlanetScaleAuthorizeActionResult;
|
|
1506
|
+
|
|
1507
|
+
interface VercelConnectActionContext {
|
|
1508
|
+
token: string;
|
|
1509
|
+
}
|
|
1510
|
+
interface VercelConnectActionResult {
|
|
1511
|
+
isConnected: boolean;
|
|
1512
|
+
}
|
|
1513
|
+
interface VercelIntegrateActionResult {
|
|
1514
|
+
token: string;
|
|
1515
|
+
isConnected: boolean;
|
|
1516
|
+
}
|
|
1517
|
+
type VercelAuthorizeFlowContext = IntegrationFlowContext;
|
|
1518
|
+
type VercelAuthorizeFlowResult = VercelConnectActionContext;
|
|
1519
|
+
|
|
1520
|
+
interface VercelInstallActionContext {
|
|
1521
|
+
token: string;
|
|
1522
|
+
targetRepository?: string;
|
|
1523
|
+
showInstruction?: true;
|
|
1524
|
+
}
|
|
1525
|
+
interface VercelInstallActionResult {
|
|
1526
|
+
installationId: string;
|
|
1527
|
+
}
|
|
1528
|
+
type VercelInstallFlowContext = IntegrationFlowContext & {
|
|
1529
|
+
install: VercelInstallActionContext;
|
|
1530
|
+
};
|
|
1531
|
+
type VercelInstallFlowResult = VercelInstallActionResult;
|
|
1532
|
+
|
|
1434
1533
|
interface PlatformAdapterClientInstanceAuthorization {
|
|
1435
1534
|
platform?: {
|
|
1436
1535
|
dps?: string;
|
|
@@ -2938,23 +3037,23 @@ declare function initApi(config: {
|
|
|
2938
3037
|
};
|
|
2939
3038
|
}, tokens?: {
|
|
2940
3039
|
platform?: {
|
|
2941
|
-
dps
|
|
3040
|
+
dps?: string;
|
|
2942
3041
|
};
|
|
2943
3042
|
github?: {
|
|
2944
|
-
apps
|
|
2945
|
-
oauth
|
|
3043
|
+
apps?: string;
|
|
3044
|
+
oauth?: string;
|
|
2946
3045
|
};
|
|
2947
3046
|
netlify?: {
|
|
2948
|
-
token
|
|
3047
|
+
token?: string;
|
|
2949
3048
|
};
|
|
2950
3049
|
vercel?: {
|
|
2951
|
-
token
|
|
3050
|
+
token?: string;
|
|
2952
3051
|
};
|
|
2953
3052
|
planetscale?: {
|
|
2954
|
-
token
|
|
3053
|
+
token?: string;
|
|
2955
3054
|
};
|
|
2956
3055
|
neon?: {
|
|
2957
|
-
token
|
|
3056
|
+
token?: string;
|
|
2958
3057
|
};
|
|
2959
3058
|
}): void;
|
|
2960
3059
|
|
|
@@ -2993,4 +3092,8 @@ declare const API_NOTIFICATIONS: {
|
|
|
2993
3092
|
};
|
|
2994
3093
|
};
|
|
2995
3094
|
|
|
2996
|
-
|
|
3095
|
+
declare function getIntegrationFlowUrl<TContext extends IntegrationFlowContext, TData>(provider: string, flow: string, data: TData, context: Omit<TContext, "state">, config: {
|
|
3096
|
+
adapterUrl: string;
|
|
3097
|
+
}): string;
|
|
3098
|
+
|
|
3099
|
+
export { API_NOTIFICATIONS, AccountDto, AccountsApiError, AdapterApiError, AddAppAuthorizationPayload, AddAppAuthorizationResult, AgentConfigurationDto, AgentDto, ApiError, ApiErrorBase, ApiErrorKind, ApiErrorName, ApiErrorSource, AppAuthorizationData, AppBaseData, AppBaseTemplate, AppDeployment, AppDeploymentBlock, AppDeploymentBlockConfig, AppDeploymentData, AppDeploymentProvider, AppDisplayData, AppEventDto, AppGitHubRepository, AppGitHubRepositoryConfig, AppInfrastructureBlocks, AppManifest, AppMonetizationData, AppMonitoringCustomReport, AppMonitoringCustomReportDataDto, AppMonitoringEvent, AppMonitoringEventData, AppMonitoringEventsLog, AppMonitoringEventsLogItem, AppMonitoringEventsReportDto, AppMonitoringReportParams, AppMonitoringUptimeReportDto, AppNeonStorage, AppNeonStorageConfig, AppNetlifyDeployment, AppNetlifyDeploymentConfig, AppPlanetScaleStorage, AppPlanetScaleStorageConfig, AppPropertiesData, AppPropertyData, AppRepository, AppRepositoryBlock, AppRepositoryBlockConfig, AppRepositoryData, AppRepositoryProvider, AppRepositoryTarget, AppRepositoryTemplate, AppRepositoryTemplates, AppResourceDto, AppStatsDto, AppStorage, AppStorageBlock, AppStorageBlockConfig, AppStorageData, AppStorageProvider, AppTemplate, AppTemplates, AppVariable, AppVariableExternalProvider, AppVariableLocalProvider, AppVariableProvider, AppVariableStatus, AppVariableType, AppVercelDeployment, AppVercelDeploymentConfig, AppWidgetData, AppWidgetsData, ApplicationAutoReviewDto, ApplicationAutoReviewPayload, ApplicationBasicDetailsDto, ApplicationBenefitDto, ApplicationChatBooster, ApplicationDto, ApplicationFeatureDto, ApplicationIconDto, ApplicationOverviewDto, ApplicationPaymentDto, ApplicationPropertyDto, ApplicationScreenshotDto, ApplicationTutorialAndSupportDto, ApplicationUsageOptionsDto, ApplicationWidget, AuthorizeData, BillingAccountDto, BillingAccountInfoDto, BillingInvoiceDto, Category, ClientDto, ClientInfoDto, ClientScopeDto, ClientWithSecretDto, CreateAppVariablePayload, CreateApplicationAuthorizationPayload, CreateApplicationChatActionPayload, CreateApplicationPayload, CreateApplicationResponse, CreateApplicationSubmissionPayload, CreateClientPayload, DeveloperLedgerParams, DpsApiError, EditAppVariablePayload, GetAppMonitoringCustomReportDataPayload, GetAppMonitoringEventsLogPayload, GetAppMonitoringEventsLogResponse, GetAppMonitoringEventsReportPayload, GetAppMonitoringUptimeReportPayload, GetPlanetScaleDatabasePasswordsResult, GetPlanetScaleDatabasesResult, GetPlanetScaleOrganizationsResult, GetTextPlatformDashboardReportParams, GetVercelProjectsResult, GitHubAuthorizeAppActionResult, GitHubAuthorizeFlowContext, GitHubAuthorizeFlowResult, GitHubAuthorizeOauthActionResult, GitHubInstallActionContext, GitHubInstallActionResult, GitHubInstallFlowContext, GitHubInstallFlowResult, GitHubInstallation, GitHubRepository, GitHubRepositoryBranch, GitHubRepositoryHook, GitHubRepositoryIssue, GitHubRepositoryKey, GitHubRepositorySeed, GithubClientInstanceAuthorization, GithubClientRequestOptions, IntegrationFlowContext, IntegrationFlowOutput, IssueLabel, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppStorageData, LinkAppStorageNeonData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LiveChatClientInstanceAuthorization, LiveChatClientInstanceOptions, LiveChatConfigurationApiError, MyAccountDto, NeonAuthorizeActionResult, NeonAuthorizeFlowContext, NeonAuthorizeFlowResult, NeonClientInstanceAuthorization, NeonClientInstanceOptions, NeonProjectBranchDto, NeonProjectBranchesDto, NeonProjectDatabaseDto, NeonProjectDatabasesDto, NeonProjectDto, NeonProjectWithConnectionUriDto, NeonProjectsDto, NeonUser, NetlifyAccount, NetlifyAuthorizeActionResult, NetlifyAuthorizeFlowContext, NetlifyAuthorizeFlowResult, NetlifyClientInstanceAuthorization, NetlifyClientInstanceOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifyInstallActionContext, NetlifyInstallActionResult, NetlifyInstallFlowContext, NetlifyInstallFlowResult, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleAuthorizeActionResult, PlanetScaleAuthorizeFlowContext, PlanetScaleAuthorizeFlowResult, PlanetScaleClientInstanceAuthorization, PlanetScaleClientInstanceOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientInstanceAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientInstanceAuthorization, PlatformAdapterClientInstanceOptions, PlatformBillingClientInstanceAuthorization, PlatformBillingClientInstanceOptions, PlatformDpsClientInstanceAuthorization, PlatformDpsClientInstanceOptions, ProductDto, PropertiesDto, Property, PropertyAccessDto, PropertyAccessItemDto, PropertyDto, PushAppPayload, PushAppResult, PushAppSaga, PushAppSagaAuthorizationStep, PushAppSagaBaseStep, PushAppSagaDeploymentStep, PushAppSagaDisplayStep, PushAppSagaMonetizationStep, PushAppSagaPropertiesStep, PushAppSagaRepositoryStep, PushAppSagaStorageStep, PushAppSagaWidgetsStep, RemoveAppAuthorizationPayload, RemoveAppMonetizationPayload, RemoveAppPropertiesPayload, RemoveAppPropertyPayload, RemoveAppWidgetPayload, RemoveAppWidgetsPayload, ResearchCustomerItemDto, ResearchCustomerLocationItemDto, ResearchDictionaryParams, ResearchMarketplaceItemDto, ResearchMarketplaceParams, ResearchTrafficItemDto, ResearchTrafficParams, Saga, SagaInput, SagaOutput, SagaStep, SagaStepChanges, SagaStepComparer, SagaStepPropertyCompareResult, SagaStepStatus, SagaStepsSchema, ScopeDto, SeedAppRepositoryPayload, SeedAppRepositoryResult, ShortcutDto, SyncAppVariablePayload, TextClientInstanceAuthorization, TextClientInstanceOptions, TextPlatformDashboardCreditsDto, TextPlatformDashboardPaymentDto, TextPlatformDashboardReportDto, TextPlatformDashboardReportItemDto, UnauthorizeApiError, UnlinkAppDeploymentData, UnlinkAppDeploymentPayload, UnlinkAppRepositoryData, UnlinkAppRepositoryPayload, UnlinkAppStorageData, UnlinkAppStoragePayload, UpdateAppAuthorizationPayload, UpdateAppInfrastructureBlocksPayload, UpdateApplicationChangelogPayload, UpdateApplicationChatActionPayload, UpdateApplicationDirectInstallUrlPayload, UpdateApplicationIconPayload, UpdateApplicationOnboardingPayload, UpdateApplicationProductPayload, UpdateApplicationWebhookPayload, UpdateApplicationWidgetDto, UpdateChatWebhookPayload, UpdateClientPayload, UpdateUserFeatures, UpdateUserIntegrations, UpsertAppDeploymentPayload, UpsertAppMonetizationPayload, UpsertAppPropertiesPayload, UpsertAppPropertyPayload, UpsertAppRepositoryPayload, UpsertAppResourcePayload, UpsertAppStoragePayload, UpsertAppWidgetPayload, UpsertAppWidgetsPayload, UpsertApplicationChatBoosterPayload, UserDto, UserGitHubIntegrationDto, UserIntegrationsDto, UserNeonIntegrationDto, UserNetlifyIntegrationDto, UserPlanetScaleIntegrationDto, UserVercelIntegrationDto, VercelAuthorizeFlowContext, VercelAuthorizeFlowResult, VercelClientInstanceAuthorization, VercelClientInstanceOptions, VercelConnectActionContext, VercelConnectActionResult, VercelDeploy, VercelInstallActionContext, VercelInstallActionResult, VercelInstallFlowContext, VercelInstallFlowResult, VercelIntegrateActionResult, VercelNamespace, VercelPaginatedResult, VercelPagination, VercelProject, VercelProjectEnv, VercelRepository, VercelSearchRepositoryResponse, VerifyAppPayload, VerifyAppResult, Webhook, WebhookDto, allAppTemplates, api, appBaseTemplates, appRepositoryTemplates, appRepositoryTemplatesMap, appTemplates, appTemplatesMap, getAppAutoReviewPayload, getEmptyAppAutoReview, getGitHubClientAuthorization, getGithubClientRequestConfig, getIntegrationFlowUrl, getLiveChatClientAuthorization, getLiveChatClientConfig, getNeonClientAuthorization, getNeonClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformAdapterClientDefaultConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClientInstance, initLiveChatClientInstance, initNeonClientInstance, initNetlifyClientInstance, initPlanetScaleClientInstance, initPlatformAccountsClientInstance, initPlatformAdapterClientInstance, initPlatformBillingClientInstance, initPlatformDpsClientInstance, initTextClientInstance, initVercelClientInstance, livechatClientInstance, neonClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, textClientInstance, updateGithubClientInstance, updateNeonClientInstance, updateNetlifyClientInstance, updatePlanetScaleClientInstance, updatePlatformAdapterClientInstance, updateVercelClientInstance, vercelClientInstance };
|
package/dist/index.d.ts
CHANGED
|
@@ -591,6 +591,7 @@ interface AuthorizeData {
|
|
|
591
591
|
organization_id: string;
|
|
592
592
|
scope: string;
|
|
593
593
|
token_type: "Bearer";
|
|
594
|
+
refresh_token: string;
|
|
594
595
|
}
|
|
595
596
|
|
|
596
597
|
interface ProductDto {
|
|
@@ -708,6 +709,7 @@ declare class UnauthorizeApiError extends Error {
|
|
|
708
709
|
readonly kind: ApiErrorKind;
|
|
709
710
|
readonly code = 401;
|
|
710
711
|
constructor(source: ApiErrorSource, message?: string);
|
|
712
|
+
withCustomMessage(_message: string): this;
|
|
711
713
|
}
|
|
712
714
|
|
|
713
715
|
interface SagaStep<TData = unknown, TOutput = unknown, TStatus = unknown> {
|
|
@@ -770,6 +772,7 @@ interface PlatformAccountsClientInstanceAuthorization {
|
|
|
770
772
|
token?: string;
|
|
771
773
|
}
|
|
772
774
|
interface PlatformAccountsClientInstanceOptions {
|
|
775
|
+
ensureAuthorizationToken?: boolean;
|
|
773
776
|
token?: string;
|
|
774
777
|
}
|
|
775
778
|
declare const platformAccountsClientInstance: axios.AxiosInstance;
|
|
@@ -1055,7 +1058,6 @@ type LinkAppDeploymentData = (({
|
|
|
1055
1058
|
};
|
|
1056
1059
|
type LinkAppDeploymentPayload = {
|
|
1057
1060
|
appId: string;
|
|
1058
|
-
appName: string;
|
|
1059
1061
|
} & LinkAppDeploymentData;
|
|
1060
1062
|
interface LinkAppDeploymentResult {
|
|
1061
1063
|
url: string;
|
|
@@ -1171,7 +1173,6 @@ type LinkAppRepositoryData = {
|
|
|
1171
1173
|
} & LinkAppRepositoryGitHubData);
|
|
1172
1174
|
type LinkAppRepositoryPayload = {
|
|
1173
1175
|
appId: string;
|
|
1174
|
-
appName: string;
|
|
1175
1176
|
} & LinkAppRepositoryData;
|
|
1176
1177
|
interface LinkAppRepositoryResult {
|
|
1177
1178
|
name: string;
|
|
@@ -1252,7 +1253,6 @@ type LinkAppStorageData = (({
|
|
|
1252
1253
|
};
|
|
1253
1254
|
type LinkAppStoragePayload = {
|
|
1254
1255
|
appId: string;
|
|
1255
|
-
appName: string;
|
|
1256
1256
|
} & LinkAppStorageData;
|
|
1257
1257
|
|
|
1258
1258
|
interface UnlinkAppStorageData {
|
|
@@ -1431,6 +1431,105 @@ interface AppTemplates {
|
|
|
1431
1431
|
saas: AppTemplate;
|
|
1432
1432
|
}
|
|
1433
1433
|
|
|
1434
|
+
interface IntegrationFlowContext {
|
|
1435
|
+
userId: string;
|
|
1436
|
+
userToken: string;
|
|
1437
|
+
redirectUrl: string;
|
|
1438
|
+
state: string;
|
|
1439
|
+
}
|
|
1440
|
+
type IntegrationFlowOutput<TFlowResult> = {
|
|
1441
|
+
status: "success";
|
|
1442
|
+
result: TFlowResult;
|
|
1443
|
+
} | {
|
|
1444
|
+
status: "error";
|
|
1445
|
+
message: string;
|
|
1446
|
+
} | {
|
|
1447
|
+
status: "cancel";
|
|
1448
|
+
};
|
|
1449
|
+
|
|
1450
|
+
interface GitHubAuthorizeAppActionResult {
|
|
1451
|
+
appToken: string;
|
|
1452
|
+
}
|
|
1453
|
+
interface GitHubAuthorizeOauthActionResult {
|
|
1454
|
+
oauthToken: string;
|
|
1455
|
+
}
|
|
1456
|
+
type GitHubAuthorizeFlowContext = IntegrationFlowContext;
|
|
1457
|
+
type GitHubAuthorizeFlowResult = GitHubAuthorizeAppActionResult & GitHubAuthorizeOauthActionResult;
|
|
1458
|
+
|
|
1459
|
+
interface GitHubInstallActionContext {
|
|
1460
|
+
targetRepository?: string;
|
|
1461
|
+
isAlreadyInstalled?: true;
|
|
1462
|
+
showInstruction?: true;
|
|
1463
|
+
}
|
|
1464
|
+
interface GitHubInstallActionResult {
|
|
1465
|
+
appToken: string;
|
|
1466
|
+
installationId: string;
|
|
1467
|
+
}
|
|
1468
|
+
type GitHubInstallFlowContext = IntegrationFlowContext & {
|
|
1469
|
+
install: GitHubInstallActionContext;
|
|
1470
|
+
};
|
|
1471
|
+
type GitHubInstallFlowResult = GitHubInstallActionResult;
|
|
1472
|
+
|
|
1473
|
+
interface NeonAuthorizeActionResult {
|
|
1474
|
+
token: string;
|
|
1475
|
+
refreshToken: string;
|
|
1476
|
+
}
|
|
1477
|
+
type NeonAuthorizeFlowContext = IntegrationFlowContext;
|
|
1478
|
+
type NeonAuthorizeFlowResult = NeonAuthorizeActionResult;
|
|
1479
|
+
|
|
1480
|
+
interface NetlifyAuthorizeActionResult {
|
|
1481
|
+
token: string;
|
|
1482
|
+
}
|
|
1483
|
+
type NetlifyAuthorizeFlowContext = IntegrationFlowContext;
|
|
1484
|
+
type NetlifyAuthorizeFlowResult = NetlifyAuthorizeActionResult;
|
|
1485
|
+
|
|
1486
|
+
interface NetlifyInstallActionContext {
|
|
1487
|
+
siteId?: string;
|
|
1488
|
+
token?: string;
|
|
1489
|
+
targetRepository?: string;
|
|
1490
|
+
showInstruction?: true;
|
|
1491
|
+
}
|
|
1492
|
+
interface NetlifyInstallActionResult {
|
|
1493
|
+
installationId: string;
|
|
1494
|
+
}
|
|
1495
|
+
type NetlifyInstallFlowContext = IntegrationFlowContext & {
|
|
1496
|
+
install: NetlifyInstallActionContext;
|
|
1497
|
+
};
|
|
1498
|
+
type NetlifyInstallFlowResult = NetlifyInstallActionResult;
|
|
1499
|
+
|
|
1500
|
+
interface PlanetScaleAuthorizeActionResult {
|
|
1501
|
+
token: string;
|
|
1502
|
+
refreshToken: string;
|
|
1503
|
+
}
|
|
1504
|
+
type PlanetScaleAuthorizeFlowContext = IntegrationFlowContext;
|
|
1505
|
+
type PlanetScaleAuthorizeFlowResult = PlanetScaleAuthorizeActionResult;
|
|
1506
|
+
|
|
1507
|
+
interface VercelConnectActionContext {
|
|
1508
|
+
token: string;
|
|
1509
|
+
}
|
|
1510
|
+
interface VercelConnectActionResult {
|
|
1511
|
+
isConnected: boolean;
|
|
1512
|
+
}
|
|
1513
|
+
interface VercelIntegrateActionResult {
|
|
1514
|
+
token: string;
|
|
1515
|
+
isConnected: boolean;
|
|
1516
|
+
}
|
|
1517
|
+
type VercelAuthorizeFlowContext = IntegrationFlowContext;
|
|
1518
|
+
type VercelAuthorizeFlowResult = VercelConnectActionContext;
|
|
1519
|
+
|
|
1520
|
+
interface VercelInstallActionContext {
|
|
1521
|
+
token: string;
|
|
1522
|
+
targetRepository?: string;
|
|
1523
|
+
showInstruction?: true;
|
|
1524
|
+
}
|
|
1525
|
+
interface VercelInstallActionResult {
|
|
1526
|
+
installationId: string;
|
|
1527
|
+
}
|
|
1528
|
+
type VercelInstallFlowContext = IntegrationFlowContext & {
|
|
1529
|
+
install: VercelInstallActionContext;
|
|
1530
|
+
};
|
|
1531
|
+
type VercelInstallFlowResult = VercelInstallActionResult;
|
|
1532
|
+
|
|
1434
1533
|
interface PlatformAdapterClientInstanceAuthorization {
|
|
1435
1534
|
platform?: {
|
|
1436
1535
|
dps?: string;
|
|
@@ -2938,23 +3037,23 @@ declare function initApi(config: {
|
|
|
2938
3037
|
};
|
|
2939
3038
|
}, tokens?: {
|
|
2940
3039
|
platform?: {
|
|
2941
|
-
dps
|
|
3040
|
+
dps?: string;
|
|
2942
3041
|
};
|
|
2943
3042
|
github?: {
|
|
2944
|
-
apps
|
|
2945
|
-
oauth
|
|
3043
|
+
apps?: string;
|
|
3044
|
+
oauth?: string;
|
|
2946
3045
|
};
|
|
2947
3046
|
netlify?: {
|
|
2948
|
-
token
|
|
3047
|
+
token?: string;
|
|
2949
3048
|
};
|
|
2950
3049
|
vercel?: {
|
|
2951
|
-
token
|
|
3050
|
+
token?: string;
|
|
2952
3051
|
};
|
|
2953
3052
|
planetscale?: {
|
|
2954
|
-
token
|
|
3053
|
+
token?: string;
|
|
2955
3054
|
};
|
|
2956
3055
|
neon?: {
|
|
2957
|
-
token
|
|
3056
|
+
token?: string;
|
|
2958
3057
|
};
|
|
2959
3058
|
}): void;
|
|
2960
3059
|
|
|
@@ -2993,4 +3092,8 @@ declare const API_NOTIFICATIONS: {
|
|
|
2993
3092
|
};
|
|
2994
3093
|
};
|
|
2995
3094
|
|
|
2996
|
-
|
|
3095
|
+
declare function getIntegrationFlowUrl<TContext extends IntegrationFlowContext, TData>(provider: string, flow: string, data: TData, context: Omit<TContext, "state">, config: {
|
|
3096
|
+
adapterUrl: string;
|
|
3097
|
+
}): string;
|
|
3098
|
+
|
|
3099
|
+
export { API_NOTIFICATIONS, AccountDto, AccountsApiError, AdapterApiError, AddAppAuthorizationPayload, AddAppAuthorizationResult, AgentConfigurationDto, AgentDto, ApiError, ApiErrorBase, ApiErrorKind, ApiErrorName, ApiErrorSource, AppAuthorizationData, AppBaseData, AppBaseTemplate, AppDeployment, AppDeploymentBlock, AppDeploymentBlockConfig, AppDeploymentData, AppDeploymentProvider, AppDisplayData, AppEventDto, AppGitHubRepository, AppGitHubRepositoryConfig, AppInfrastructureBlocks, AppManifest, AppMonetizationData, AppMonitoringCustomReport, AppMonitoringCustomReportDataDto, AppMonitoringEvent, AppMonitoringEventData, AppMonitoringEventsLog, AppMonitoringEventsLogItem, AppMonitoringEventsReportDto, AppMonitoringReportParams, AppMonitoringUptimeReportDto, AppNeonStorage, AppNeonStorageConfig, AppNetlifyDeployment, AppNetlifyDeploymentConfig, AppPlanetScaleStorage, AppPlanetScaleStorageConfig, AppPropertiesData, AppPropertyData, AppRepository, AppRepositoryBlock, AppRepositoryBlockConfig, AppRepositoryData, AppRepositoryProvider, AppRepositoryTarget, AppRepositoryTemplate, AppRepositoryTemplates, AppResourceDto, AppStatsDto, AppStorage, AppStorageBlock, AppStorageBlockConfig, AppStorageData, AppStorageProvider, AppTemplate, AppTemplates, AppVariable, AppVariableExternalProvider, AppVariableLocalProvider, AppVariableProvider, AppVariableStatus, AppVariableType, AppVercelDeployment, AppVercelDeploymentConfig, AppWidgetData, AppWidgetsData, ApplicationAutoReviewDto, ApplicationAutoReviewPayload, ApplicationBasicDetailsDto, ApplicationBenefitDto, ApplicationChatBooster, ApplicationDto, ApplicationFeatureDto, ApplicationIconDto, ApplicationOverviewDto, ApplicationPaymentDto, ApplicationPropertyDto, ApplicationScreenshotDto, ApplicationTutorialAndSupportDto, ApplicationUsageOptionsDto, ApplicationWidget, AuthorizeData, BillingAccountDto, BillingAccountInfoDto, BillingInvoiceDto, Category, ClientDto, ClientInfoDto, ClientScopeDto, ClientWithSecretDto, CreateAppVariablePayload, CreateApplicationAuthorizationPayload, CreateApplicationChatActionPayload, CreateApplicationPayload, CreateApplicationResponse, CreateApplicationSubmissionPayload, CreateClientPayload, DeveloperLedgerParams, DpsApiError, EditAppVariablePayload, GetAppMonitoringCustomReportDataPayload, GetAppMonitoringEventsLogPayload, GetAppMonitoringEventsLogResponse, GetAppMonitoringEventsReportPayload, GetAppMonitoringUptimeReportPayload, GetPlanetScaleDatabasePasswordsResult, GetPlanetScaleDatabasesResult, GetPlanetScaleOrganizationsResult, GetTextPlatformDashboardReportParams, GetVercelProjectsResult, GitHubAuthorizeAppActionResult, GitHubAuthorizeFlowContext, GitHubAuthorizeFlowResult, GitHubAuthorizeOauthActionResult, GitHubInstallActionContext, GitHubInstallActionResult, GitHubInstallFlowContext, GitHubInstallFlowResult, GitHubInstallation, GitHubRepository, GitHubRepositoryBranch, GitHubRepositoryHook, GitHubRepositoryIssue, GitHubRepositoryKey, GitHubRepositorySeed, GithubClientInstanceAuthorization, GithubClientRequestOptions, IntegrationFlowContext, IntegrationFlowOutput, IssueLabel, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppStorageData, LinkAppStorageNeonData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LiveChatClientInstanceAuthorization, LiveChatClientInstanceOptions, LiveChatConfigurationApiError, MyAccountDto, NeonAuthorizeActionResult, NeonAuthorizeFlowContext, NeonAuthorizeFlowResult, NeonClientInstanceAuthorization, NeonClientInstanceOptions, NeonProjectBranchDto, NeonProjectBranchesDto, NeonProjectDatabaseDto, NeonProjectDatabasesDto, NeonProjectDto, NeonProjectWithConnectionUriDto, NeonProjectsDto, NeonUser, NetlifyAccount, NetlifyAuthorizeActionResult, NetlifyAuthorizeFlowContext, NetlifyAuthorizeFlowResult, NetlifyClientInstanceAuthorization, NetlifyClientInstanceOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifyInstallActionContext, NetlifyInstallActionResult, NetlifyInstallFlowContext, NetlifyInstallFlowResult, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleAuthorizeActionResult, PlanetScaleAuthorizeFlowContext, PlanetScaleAuthorizeFlowResult, PlanetScaleClientInstanceAuthorization, PlanetScaleClientInstanceOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientInstanceAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientInstanceAuthorization, PlatformAdapterClientInstanceOptions, PlatformBillingClientInstanceAuthorization, PlatformBillingClientInstanceOptions, PlatformDpsClientInstanceAuthorization, PlatformDpsClientInstanceOptions, ProductDto, PropertiesDto, Property, PropertyAccessDto, PropertyAccessItemDto, PropertyDto, PushAppPayload, PushAppResult, PushAppSaga, PushAppSagaAuthorizationStep, PushAppSagaBaseStep, PushAppSagaDeploymentStep, PushAppSagaDisplayStep, PushAppSagaMonetizationStep, PushAppSagaPropertiesStep, PushAppSagaRepositoryStep, PushAppSagaStorageStep, PushAppSagaWidgetsStep, RemoveAppAuthorizationPayload, RemoveAppMonetizationPayload, RemoveAppPropertiesPayload, RemoveAppPropertyPayload, RemoveAppWidgetPayload, RemoveAppWidgetsPayload, ResearchCustomerItemDto, ResearchCustomerLocationItemDto, ResearchDictionaryParams, ResearchMarketplaceItemDto, ResearchMarketplaceParams, ResearchTrafficItemDto, ResearchTrafficParams, Saga, SagaInput, SagaOutput, SagaStep, SagaStepChanges, SagaStepComparer, SagaStepPropertyCompareResult, SagaStepStatus, SagaStepsSchema, ScopeDto, SeedAppRepositoryPayload, SeedAppRepositoryResult, ShortcutDto, SyncAppVariablePayload, TextClientInstanceAuthorization, TextClientInstanceOptions, TextPlatformDashboardCreditsDto, TextPlatformDashboardPaymentDto, TextPlatformDashboardReportDto, TextPlatformDashboardReportItemDto, UnauthorizeApiError, UnlinkAppDeploymentData, UnlinkAppDeploymentPayload, UnlinkAppRepositoryData, UnlinkAppRepositoryPayload, UnlinkAppStorageData, UnlinkAppStoragePayload, UpdateAppAuthorizationPayload, UpdateAppInfrastructureBlocksPayload, UpdateApplicationChangelogPayload, UpdateApplicationChatActionPayload, UpdateApplicationDirectInstallUrlPayload, UpdateApplicationIconPayload, UpdateApplicationOnboardingPayload, UpdateApplicationProductPayload, UpdateApplicationWebhookPayload, UpdateApplicationWidgetDto, UpdateChatWebhookPayload, UpdateClientPayload, UpdateUserFeatures, UpdateUserIntegrations, UpsertAppDeploymentPayload, UpsertAppMonetizationPayload, UpsertAppPropertiesPayload, UpsertAppPropertyPayload, UpsertAppRepositoryPayload, UpsertAppResourcePayload, UpsertAppStoragePayload, UpsertAppWidgetPayload, UpsertAppWidgetsPayload, UpsertApplicationChatBoosterPayload, UserDto, UserGitHubIntegrationDto, UserIntegrationsDto, UserNeonIntegrationDto, UserNetlifyIntegrationDto, UserPlanetScaleIntegrationDto, UserVercelIntegrationDto, VercelAuthorizeFlowContext, VercelAuthorizeFlowResult, VercelClientInstanceAuthorization, VercelClientInstanceOptions, VercelConnectActionContext, VercelConnectActionResult, VercelDeploy, VercelInstallActionContext, VercelInstallActionResult, VercelInstallFlowContext, VercelInstallFlowResult, VercelIntegrateActionResult, VercelNamespace, VercelPaginatedResult, VercelPagination, VercelProject, VercelProjectEnv, VercelRepository, VercelSearchRepositoryResponse, VerifyAppPayload, VerifyAppResult, Webhook, WebhookDto, allAppTemplates, api, appBaseTemplates, appRepositoryTemplates, appRepositoryTemplatesMap, appTemplates, appTemplatesMap, getAppAutoReviewPayload, getEmptyAppAutoReview, getGitHubClientAuthorization, getGithubClientRequestConfig, getIntegrationFlowUrl, getLiveChatClientAuthorization, getLiveChatClientConfig, getNeonClientAuthorization, getNeonClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformAdapterClientDefaultConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClientInstance, initLiveChatClientInstance, initNeonClientInstance, initNetlifyClientInstance, initPlanetScaleClientInstance, initPlatformAccountsClientInstance, initPlatformAdapterClientInstance, initPlatformBillingClientInstance, initPlatformDpsClientInstance, initTextClientInstance, initVercelClientInstance, livechatClientInstance, neonClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, textClientInstance, updateGithubClientInstance, updateNeonClientInstance, updateNetlifyClientInstance, updatePlanetScaleClientInstance, updatePlatformAdapterClientInstance, updateVercelClientInstance, vercelClientInstance };
|