@livechat/developer-studio-api 3.0.46 → 3.0.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -591,7 +591,7 @@ interface MailchimpListWebhook {
591
591
  };
592
592
  }
593
593
 
594
- type ApiErrorName = "adapter" | "accounts" | "dps" | "github" | "vercel" | "netlify" | "planetscale" | "neon" | "mailchimp" | "shopify";
594
+ type ApiErrorName = "adapter" | "accounts" | "livechat" | "dps" | "github" | "vercel" | "netlify" | "planetscale" | "neon" | "mailchimp" | "shopify";
595
595
  type ApiErrorSource = "accounts" | "github" | "vercel" | "netlify" | "planetscale" | "neon" | "mailchimp" | "shopify";
596
596
  type ApiErrorKind = "unauthorized" | "error";
597
597
  type ApiError<TData = unknown> = {
@@ -2468,9 +2468,9 @@ interface Webhook {
2468
2468
  url: string;
2469
2469
  api_version?: string;
2470
2470
  action: string;
2471
- description: string;
2471
+ description?: string;
2472
2472
  secret_key: string;
2473
- owner_client_id: string;
2473
+ owner_client_id?: string;
2474
2474
  type: "bot" | "license";
2475
2475
  filters?: {
2476
2476
  author_type?: "agent" | "customer";
@@ -2488,6 +2488,14 @@ type LiveChatClientAuthorization = PlatformClientAuthorization;
2488
2488
  interface LiveChatClientOptions extends LiveChatClientAuthorization {
2489
2489
  ensureAuthorizationToken?: boolean;
2490
2490
  }
2491
+ declare class LivechatApiError extends ApiErrorBase<{
2492
+ error: {
2493
+ type: string;
2494
+ message: string;
2495
+ };
2496
+ }> {
2497
+ name: "livechat";
2498
+ }
2491
2499
  declare const livechatClientInstance: axios.AxiosInstance;
2492
2500
  declare function getLiveChatClientAuthorization(req: {
2493
2501
  headers: Record<string, string | string[] | undefined>;
@@ -2877,13 +2885,14 @@ declare const api: {
2877
2885
  unregisterProperties(clientId: string, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2878
2886
  };
2879
2887
  webhook: {
2880
- getWebhooks(clientId: string, isAgent?: boolean | undefined, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<WebhookDto[], any>>;
2881
- unregisterWebhook(clientId: string, webhookId: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<undefined, any>>;
2882
- unregisterWebhooks(clientId: string, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2888
+ getWebhooks(clientId?: string | undefined, isAgent?: boolean | undefined, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<WebhookDto[], any>>;
2889
+ unregisterWebhook(clientId: string | undefined, webhookId: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<undefined, any>>;
2890
+ unregisterWebhooks(clientId?: string | undefined, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2891
+ registerWebhook(webhook: Webhook, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2883
2892
  registerWebhooks(webhooks: Webhook[], authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2884
2893
  migrateWebhooks(webhooks: Webhook[], clientId: string, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2885
- getLicenseWebhooksList(isAgent: boolean, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<any, any> | {
2886
- data: never[];
2894
+ getLicenseWebhooksList(isAgent: boolean, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<WebhookDto[], any> | {
2895
+ data: WebhookDto[];
2887
2896
  }>;
2888
2897
  deleteLicenseWebhook(id: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<undefined, any>>;
2889
2898
  getWebhookNamesList(version: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<any, any>>;
@@ -3217,4 +3226,4 @@ declare function getIntegrationFlowUrl<TContext extends IntegrationFlowContext,
3217
3226
  adapterUrl: string;
3218
3227
  }): string;
3219
3228
 
3220
- 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, GithubClientAuthorization, GithubClientOptions, IntegrationFlowContext, IntegrationFlowOutput, IssueLabel, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppStorageData, LinkAppStorageNeonData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LiveChatClientAuthorization, LiveChatClientOptions, LiveChatConfigurationApiError, MailchimpApiError, MailchimpAuthorizeActionResult, MailchimpAuthorizeFlowContext, MailchimpAuthorizeFlowResult, MailchimpClientAuthorization, MailchimpClientInstanceOptions, MailchimpListWebhook, MyAccountDto, NeonAuthorizeActionResult, NeonAuthorizeFlowContext, NeonAuthorizeFlowResult, NeonClientAuthorization, NeonClientOptions, NeonProjectBranchDto, NeonProjectBranchesDto, NeonProjectDatabaseDto, NeonProjectDatabasesDto, NeonProjectDto, NeonProjectRoleDto, NeonProjectRolesDto, NeonProjectWithConnectionUriDto, NeonProjectsDto, NeonUser, NetlifyAccount, NetlifyAuthorizeActionResult, NetlifyAuthorizeFlowContext, NetlifyAuthorizeFlowResult, NetlifyClientAuthorization, NetlifyClientOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifyInstallActionContext, NetlifyInstallActionResult, NetlifyInstallFlowContext, NetlifyInstallFlowResult, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleAuthorizeActionResult, PlanetScaleAuthorizeFlowContext, PlanetScaleAuthorizeFlowResult, PlanetScaleClientAuthorization, PlanetScaleClientOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientAuthorization, PlatformAdapterClientOptions, PlatformBillingClientAuthorization, PlatformBillingClientOptions, PlatformClientAuthorization, PlatformDpsClientAuthorization, PlatformDpsClientOptions, 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, ShopifyApiError, ShopifyAuthorizeActionContext, ShopifyAuthorizeActionResult, ShopifyAuthorizeFlowContext, ShopifyAuthorizeFlowResult, ShopifyClientAuthorization, ShopifyClientOptions, ShortcutDto, SyncAppVariablePayload, TextClientAuthorization, TextClientOptions, 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, VercelClientAuthorization, VercelClientOptions, 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, getGithubClientConfig, getIntegrationFlowUrl, getLiveChatClientAuthorization, getLiveChatClientConfig, getMailchimpClientAuthorization, getMailchimpClientConfig, getMailchimpClientUrl, getNeonClientAuthorization, getNeonClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformAdapterClientDefaultConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getShopifyClientAuthorization, getShopifyClientConfig, getShopifyClientUrl, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClient, initLiveChatClient, initMailchimpClient, initNeonClient, initNetlifyClient, initPlanetScaleClient, initPlatformAccountsClient, initPlatformAdapterClient, initPlatformBillingClient, initPlatformDpsClient, initShopifyClient, initTextClient, initVercelClient, livechatClientInstance, mailchimpClientInstance, neonClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, shopifyClientInstance, textClientInstance, updateGithubClient, updateMailchimpClient, updateNeonClient, updateNetlifyClient, updatePlanetScaleClient, updatePlatformAdapterClient, updateShopifyClient, updateVercelClient, vercelClientInstance };
3229
+ 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, GithubClientAuthorization, GithubClientOptions, IntegrationFlowContext, IntegrationFlowOutput, IssueLabel, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppStorageData, LinkAppStorageNeonData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LiveChatClientAuthorization, LiveChatClientOptions, LiveChatConfigurationApiError, LivechatApiError, MailchimpApiError, MailchimpAuthorizeActionResult, MailchimpAuthorizeFlowContext, MailchimpAuthorizeFlowResult, MailchimpClientAuthorization, MailchimpClientInstanceOptions, MailchimpListWebhook, MyAccountDto, NeonAuthorizeActionResult, NeonAuthorizeFlowContext, NeonAuthorizeFlowResult, NeonClientAuthorization, NeonClientOptions, NeonProjectBranchDto, NeonProjectBranchesDto, NeonProjectDatabaseDto, NeonProjectDatabasesDto, NeonProjectDto, NeonProjectRoleDto, NeonProjectRolesDto, NeonProjectWithConnectionUriDto, NeonProjectsDto, NeonUser, NetlifyAccount, NetlifyAuthorizeActionResult, NetlifyAuthorizeFlowContext, NetlifyAuthorizeFlowResult, NetlifyClientAuthorization, NetlifyClientOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifyInstallActionContext, NetlifyInstallActionResult, NetlifyInstallFlowContext, NetlifyInstallFlowResult, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleAuthorizeActionResult, PlanetScaleAuthorizeFlowContext, PlanetScaleAuthorizeFlowResult, PlanetScaleClientAuthorization, PlanetScaleClientOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientAuthorization, PlatformAdapterClientOptions, PlatformBillingClientAuthorization, PlatformBillingClientOptions, PlatformClientAuthorization, PlatformDpsClientAuthorization, PlatformDpsClientOptions, 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, ShopifyApiError, ShopifyAuthorizeActionContext, ShopifyAuthorizeActionResult, ShopifyAuthorizeFlowContext, ShopifyAuthorizeFlowResult, ShopifyClientAuthorization, ShopifyClientOptions, ShortcutDto, SyncAppVariablePayload, TextClientAuthorization, TextClientOptions, 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, VercelClientAuthorization, VercelClientOptions, 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, getGithubClientConfig, getIntegrationFlowUrl, getLiveChatClientAuthorization, getLiveChatClientConfig, getMailchimpClientAuthorization, getMailchimpClientConfig, getMailchimpClientUrl, getNeonClientAuthorization, getNeonClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformAdapterClientDefaultConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getShopifyClientAuthorization, getShopifyClientConfig, getShopifyClientUrl, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClient, initLiveChatClient, initMailchimpClient, initNeonClient, initNetlifyClient, initPlanetScaleClient, initPlatformAccountsClient, initPlatformAdapterClient, initPlatformBillingClient, initPlatformDpsClient, initShopifyClient, initTextClient, initVercelClient, livechatClientInstance, mailchimpClientInstance, neonClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, shopifyClientInstance, textClientInstance, updateGithubClient, updateMailchimpClient, updateNeonClient, updateNetlifyClient, updatePlanetScaleClient, updatePlatformAdapterClient, updateShopifyClient, updateVercelClient, vercelClientInstance };
package/dist/index.d.ts CHANGED
@@ -591,7 +591,7 @@ interface MailchimpListWebhook {
591
591
  };
592
592
  }
593
593
 
594
- type ApiErrorName = "adapter" | "accounts" | "dps" | "github" | "vercel" | "netlify" | "planetscale" | "neon" | "mailchimp" | "shopify";
594
+ type ApiErrorName = "adapter" | "accounts" | "livechat" | "dps" | "github" | "vercel" | "netlify" | "planetscale" | "neon" | "mailchimp" | "shopify";
595
595
  type ApiErrorSource = "accounts" | "github" | "vercel" | "netlify" | "planetscale" | "neon" | "mailchimp" | "shopify";
596
596
  type ApiErrorKind = "unauthorized" | "error";
597
597
  type ApiError<TData = unknown> = {
@@ -2468,9 +2468,9 @@ interface Webhook {
2468
2468
  url: string;
2469
2469
  api_version?: string;
2470
2470
  action: string;
2471
- description: string;
2471
+ description?: string;
2472
2472
  secret_key: string;
2473
- owner_client_id: string;
2473
+ owner_client_id?: string;
2474
2474
  type: "bot" | "license";
2475
2475
  filters?: {
2476
2476
  author_type?: "agent" | "customer";
@@ -2488,6 +2488,14 @@ type LiveChatClientAuthorization = PlatformClientAuthorization;
2488
2488
  interface LiveChatClientOptions extends LiveChatClientAuthorization {
2489
2489
  ensureAuthorizationToken?: boolean;
2490
2490
  }
2491
+ declare class LivechatApiError extends ApiErrorBase<{
2492
+ error: {
2493
+ type: string;
2494
+ message: string;
2495
+ };
2496
+ }> {
2497
+ name: "livechat";
2498
+ }
2491
2499
  declare const livechatClientInstance: axios.AxiosInstance;
2492
2500
  declare function getLiveChatClientAuthorization(req: {
2493
2501
  headers: Record<string, string | string[] | undefined>;
@@ -2877,13 +2885,14 @@ declare const api: {
2877
2885
  unregisterProperties(clientId: string, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2878
2886
  };
2879
2887
  webhook: {
2880
- getWebhooks(clientId: string, isAgent?: boolean | undefined, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<WebhookDto[], any>>;
2881
- unregisterWebhook(clientId: string, webhookId: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<undefined, any>>;
2882
- unregisterWebhooks(clientId: string, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2888
+ getWebhooks(clientId?: string | undefined, isAgent?: boolean | undefined, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<WebhookDto[], any>>;
2889
+ unregisterWebhook(clientId: string | undefined, webhookId: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<undefined, any>>;
2890
+ unregisterWebhooks(clientId?: string | undefined, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2891
+ registerWebhook(webhook: Webhook, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2883
2892
  registerWebhooks(webhooks: Webhook[], authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2884
2893
  migrateWebhooks(webhooks: Webhook[], clientId: string, authorization?: PlatformClientAuthorization | undefined): Promise<void>;
2885
- getLicenseWebhooksList(isAgent: boolean, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<any, any> | {
2886
- data: never[];
2894
+ getLicenseWebhooksList(isAgent: boolean, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<WebhookDto[], any> | {
2895
+ data: WebhookDto[];
2887
2896
  }>;
2888
2897
  deleteLicenseWebhook(id: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<undefined, any>>;
2889
2898
  getWebhookNamesList(version: string, authorization?: PlatformClientAuthorization | undefined): Promise<axios.AxiosResponse<any, any>>;
@@ -3217,4 +3226,4 @@ declare function getIntegrationFlowUrl<TContext extends IntegrationFlowContext,
3217
3226
  adapterUrl: string;
3218
3227
  }): string;
3219
3228
 
3220
- 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, GithubClientAuthorization, GithubClientOptions, IntegrationFlowContext, IntegrationFlowOutput, IssueLabel, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppStorageData, LinkAppStorageNeonData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LiveChatClientAuthorization, LiveChatClientOptions, LiveChatConfigurationApiError, MailchimpApiError, MailchimpAuthorizeActionResult, MailchimpAuthorizeFlowContext, MailchimpAuthorizeFlowResult, MailchimpClientAuthorization, MailchimpClientInstanceOptions, MailchimpListWebhook, MyAccountDto, NeonAuthorizeActionResult, NeonAuthorizeFlowContext, NeonAuthorizeFlowResult, NeonClientAuthorization, NeonClientOptions, NeonProjectBranchDto, NeonProjectBranchesDto, NeonProjectDatabaseDto, NeonProjectDatabasesDto, NeonProjectDto, NeonProjectRoleDto, NeonProjectRolesDto, NeonProjectWithConnectionUriDto, NeonProjectsDto, NeonUser, NetlifyAccount, NetlifyAuthorizeActionResult, NetlifyAuthorizeFlowContext, NetlifyAuthorizeFlowResult, NetlifyClientAuthorization, NetlifyClientOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifyInstallActionContext, NetlifyInstallActionResult, NetlifyInstallFlowContext, NetlifyInstallFlowResult, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleAuthorizeActionResult, PlanetScaleAuthorizeFlowContext, PlanetScaleAuthorizeFlowResult, PlanetScaleClientAuthorization, PlanetScaleClientOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientAuthorization, PlatformAdapterClientOptions, PlatformBillingClientAuthorization, PlatformBillingClientOptions, PlatformClientAuthorization, PlatformDpsClientAuthorization, PlatformDpsClientOptions, 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, ShopifyApiError, ShopifyAuthorizeActionContext, ShopifyAuthorizeActionResult, ShopifyAuthorizeFlowContext, ShopifyAuthorizeFlowResult, ShopifyClientAuthorization, ShopifyClientOptions, ShortcutDto, SyncAppVariablePayload, TextClientAuthorization, TextClientOptions, 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, VercelClientAuthorization, VercelClientOptions, 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, getGithubClientConfig, getIntegrationFlowUrl, getLiveChatClientAuthorization, getLiveChatClientConfig, getMailchimpClientAuthorization, getMailchimpClientConfig, getMailchimpClientUrl, getNeonClientAuthorization, getNeonClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformAdapterClientDefaultConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getShopifyClientAuthorization, getShopifyClientConfig, getShopifyClientUrl, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClient, initLiveChatClient, initMailchimpClient, initNeonClient, initNetlifyClient, initPlanetScaleClient, initPlatformAccountsClient, initPlatformAdapterClient, initPlatformBillingClient, initPlatformDpsClient, initShopifyClient, initTextClient, initVercelClient, livechatClientInstance, mailchimpClientInstance, neonClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, shopifyClientInstance, textClientInstance, updateGithubClient, updateMailchimpClient, updateNeonClient, updateNetlifyClient, updatePlanetScaleClient, updatePlatformAdapterClient, updateShopifyClient, updateVercelClient, vercelClientInstance };
3229
+ 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, GithubClientAuthorization, GithubClientOptions, IntegrationFlowContext, IntegrationFlowOutput, IssueLabel, LinkAppDeploymentData, LinkAppDeploymentNetlifyData, LinkAppDeploymentNetlifySiteData, LinkAppDeploymentPayload, LinkAppDeploymentResult, LinkAppDeploymentVercelData, LinkAppDeploymentVercelProjectData, LinkAppRepositoryData, LinkAppRepositoryGitHubData, LinkAppRepositoryPayload, LinkAppRepositoryResult, LinkAppStorageData, LinkAppStorageNeonData, LinkAppStoragePayload, LinkAppStoragePlanetScaleData, LinkAppStoragePlanetScaleDatabaseData, LiveChatClientAuthorization, LiveChatClientOptions, LiveChatConfigurationApiError, LivechatApiError, MailchimpApiError, MailchimpAuthorizeActionResult, MailchimpAuthorizeFlowContext, MailchimpAuthorizeFlowResult, MailchimpClientAuthorization, MailchimpClientInstanceOptions, MailchimpListWebhook, MyAccountDto, NeonAuthorizeActionResult, NeonAuthorizeFlowContext, NeonAuthorizeFlowResult, NeonClientAuthorization, NeonClientOptions, NeonProjectBranchDto, NeonProjectBranchesDto, NeonProjectDatabaseDto, NeonProjectDatabasesDto, NeonProjectDto, NeonProjectRoleDto, NeonProjectRolesDto, NeonProjectWithConnectionUriDto, NeonProjectsDto, NeonUser, NetlifyAccount, NetlifyAuthorizeActionResult, NetlifyAuthorizeFlowContext, NetlifyAuthorizeFlowResult, NetlifyClientAuthorization, NetlifyClientOptions, NetlifyDeploy, NetlifyDeployKey, NetlifyEnv, NetlifyInstallActionContext, NetlifyInstallActionResult, NetlifyInstallFlowContext, NetlifyInstallFlowResult, NetlifySite, OrganizationDto, PatDto, PatScopeDto, PatWithSecretDto, PlanetScaleAuthorizeActionResult, PlanetScaleAuthorizeFlowContext, PlanetScaleAuthorizeFlowResult, PlanetScaleClientAuthorization, PlanetScaleClientOptions, PlanetScaleDatabase, PlanetScaleDatabasePassword, PlanetScaleOrganization, PlanetScalePaginatedResult, PlanetScalePagination, PlanetScaleUser, PlatformAccountsClientAuthorization, PlatformAccountsClientInstanceOptions, PlatformAdapterClientAuthorization, PlatformAdapterClientOptions, PlatformBillingClientAuthorization, PlatformBillingClientOptions, PlatformClientAuthorization, PlatformDpsClientAuthorization, PlatformDpsClientOptions, 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, ShopifyApiError, ShopifyAuthorizeActionContext, ShopifyAuthorizeActionResult, ShopifyAuthorizeFlowContext, ShopifyAuthorizeFlowResult, ShopifyClientAuthorization, ShopifyClientOptions, ShortcutDto, SyncAppVariablePayload, TextClientAuthorization, TextClientOptions, 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, VercelClientAuthorization, VercelClientOptions, 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, getGithubClientConfig, getIntegrationFlowUrl, getLiveChatClientAuthorization, getLiveChatClientConfig, getMailchimpClientAuthorization, getMailchimpClientConfig, getMailchimpClientUrl, getNeonClientAuthorization, getNeonClientConfig, getNetlifyClientAuthorization, getNetlifyClientConfig, getPlanetScaleClientAuthorization, getPlanetScaleClientConfig, getPlatformAccountsClientAuthorization, getPlatformAccountsClientConfig, getPlatformAdapterClientAuthorization, getPlatformAdapterClientConfig, getPlatformAdapterClientDefaultConfig, getPlatformBillingClientAuthorization, getPlatformBillingClientConfig, getPlatformDpsAdminClientAuthorization, getPlatformDpsClientAuthorization, getPlatformDpsClientConfig, getRegion, getShopifyClientAuthorization, getShopifyClientConfig, getShopifyClientUrl, getTextClientAuthorization, getTextClientConfig, getVercelClientAuthorization, getVercelClientConfig, githubClientInstance, initApi, initGithubClient, initLiveChatClient, initMailchimpClient, initNeonClient, initNetlifyClient, initPlanetScaleClient, initPlatformAccountsClient, initPlatformAdapterClient, initPlatformBillingClient, initPlatformDpsClient, initShopifyClient, initTextClient, initVercelClient, livechatClientInstance, mailchimpClientInstance, neonClientInstance, netlifyClientInstance, planetScaleClientInstance, platformAccountsClientInstance, platformAdapterClientInstance, platformBillingClientInstance, platformDpsClientInstance, shopifyClientInstance, textClientInstance, updateGithubClient, updateMailchimpClient, updateNeonClient, updateNetlifyClient, updatePlanetScaleClient, updatePlatformAdapterClient, updateShopifyClient, updateVercelClient, vercelClientInstance };
package/dist/index.js CHANGED
@@ -72,6 +72,7 @@ __export(src_exports, {
72
72
  AdapterApiError: () => AdapterApiError,
73
73
  ApiErrorBase: () => ApiErrorBase,
74
74
  DpsApiError: () => DpsApiError,
75
+ LivechatApiError: () => LivechatApiError,
75
76
  MailchimpApiError: () => MailchimpApiError,
76
77
  ShopifyApiError: () => ShopifyApiError,
77
78
  UnauthorizeApiError: () => UnauthorizeApiError,
@@ -2704,9 +2705,31 @@ var getRegion = (token) => {
2704
2705
  return region;
2705
2706
  }
2706
2707
  };
2708
+ var LivechatApiError = class extends ApiErrorBase {
2709
+ constructor() {
2710
+ super(...arguments);
2711
+ this.name = "livechat";
2712
+ }
2713
+ };
2707
2714
  var livechatClientInstance = import_axios17.default.create({
2708
2715
  baseURL: "https://api.labs.livechatinc.com"
2709
2716
  });
2717
+ livechatClientInstance.interceptors.response.use(
2718
+ (response) => response,
2719
+ (error) => {
2720
+ var _a, _b, _c, _d;
2721
+ if (((_a = error.response) == null ? void 0 : _a.status) === 401) {
2722
+ return Promise.reject(new UnauthorizeApiError("accounts"));
2723
+ }
2724
+ return Promise.reject(
2725
+ new LivechatApiError(
2726
+ error.message,
2727
+ (_b = error.response) == null ? void 0 : _b.data,
2728
+ (_d = (_c = error.response) == null ? void 0 : _c.status) != null ? _d : 400
2729
+ )
2730
+ );
2731
+ }
2732
+ );
2710
2733
  function getLiveChatClientAuthorization(req) {
2711
2734
  return {
2712
2735
  token: req.headers["platform-token"]
@@ -3006,8 +3029,8 @@ var livechatWebhookApi = {
3006
3029
  );
3007
3030
  return response;
3008
3031
  } catch (error) {
3009
- if (error instanceof Error) {
3010
- throw new Error(
3032
+ if (error instanceof LivechatApiError) {
3033
+ throw error.withCustomMessage(
3011
3034
  `Registered Webhooks couldn't be fetched. [${error.message}]`
3012
3035
  );
3013
3036
  } else {
@@ -3029,8 +3052,8 @@ var livechatWebhookApi = {
3029
3052
  );
3030
3053
  return response;
3031
3054
  } catch (error) {
3032
- if (error instanceof Error) {
3033
- throw new Error(
3055
+ if (error instanceof LivechatApiError) {
3056
+ throw error.withCustomMessage(
3034
3057
  `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.DELETED} [${error.message}]`
3035
3058
  );
3036
3059
  } else {
@@ -3042,7 +3065,11 @@ var livechatWebhookApi = {
3042
3065
  unregisterWebhooks(clientId, authorization) {
3043
3066
  return __async(this, null, function* () {
3044
3067
  try {
3045
- const { data: webhooks } = yield this.getWebhooks(clientId);
3068
+ const { data: webhooks } = yield this.getWebhooks(
3069
+ clientId,
3070
+ void 0,
3071
+ authorization
3072
+ );
3046
3073
  yield Promise.all(
3047
3074
  webhooks.map((webhook) => __async(this, null, function* () {
3048
3075
  return livechatClientInstance.post(
@@ -3056,8 +3083,8 @@ var livechatWebhookApi = {
3056
3083
  }))
3057
3084
  );
3058
3085
  } catch (error) {
3059
- if (error instanceof Error) {
3060
- throw new Error(
3086
+ if (error instanceof LivechatApiError) {
3087
+ throw error.withCustomMessage(
3061
3088
  `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.DELETED} [${error.message}]`
3062
3089
  );
3063
3090
  } else {
@@ -3066,10 +3093,31 @@ var livechatWebhookApi = {
3066
3093
  }
3067
3094
  });
3068
3095
  },
3096
+ registerWebhook(webhook, authorization) {
3097
+ return __async(this, null, function* () {
3098
+ yield livechatClientInstance.post(
3099
+ `/v${webhook.api_version || "3.5"}/configuration/action/register_webhook`,
3100
+ {
3101
+ url: webhook.url,
3102
+ action: webhook.action,
3103
+ secret_key: webhook.secret_key,
3104
+ owner_client_id: webhook.owner_client_id,
3105
+ type: webhook.type,
3106
+ description: webhook.description,
3107
+ filters: webhook.filters
3108
+ },
3109
+ getLiveChatClientConfig(authorization)
3110
+ ).catch((error) => {
3111
+ throw error.withCustomMessage(
3112
+ `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.CREATED} [${error.message}]`
3113
+ );
3114
+ });
3115
+ });
3116
+ },
3069
3117
  registerWebhooks(webhooks, authorization) {
3070
3118
  return __async(this, null, function* () {
3071
3119
  try {
3072
- yield this.unregisterWebhooks(webhooks[0].owner_client_id);
3120
+ yield this.unregisterWebhooks(webhooks[0].owner_client_id, authorization);
3073
3121
  yield Promise.all(
3074
3122
  webhooks.map((webhook) => __async(this, null, function* () {
3075
3123
  return livechatClientInstance.post(
@@ -3088,8 +3136,8 @@ var livechatWebhookApi = {
3088
3136
  }))
3089
3137
  );
3090
3138
  } catch (error) {
3091
- if (error instanceof Error) {
3092
- throw new Error(
3139
+ if (error instanceof LivechatApiError) {
3140
+ throw error.withCustomMessage(
3093
3141
  `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.CREATED} [${error.message}]`
3094
3142
  );
3095
3143
  } else {
@@ -3127,9 +3175,9 @@ var livechatWebhookApi = {
3127
3175
  getLiveChatClientConfig(authorization)
3128
3176
  );
3129
3177
  } catch (error) {
3130
- if (error instanceof Error) {
3131
- throw new Error(
3132
- `Migration failed. It looks like one of the webhooks you're trying to migrate doesn't exist in the new version or exists under a different name. Migrate the webhook manually via the Configuration API. `
3178
+ if (error instanceof LivechatApiError) {
3179
+ throw error.withCustomMessage(
3180
+ `Migration failed. It looks like one of the webhooks you're trying to migrate doesn't exist in the new version or exists under a different name. Migrate the webhook manually via the Configuration API.`
3133
3181
  );
3134
3182
  } else {
3135
3183
  throw error;
@@ -3152,8 +3200,8 @@ var livechatWebhookApi = {
3152
3200
  );
3153
3201
  return response;
3154
3202
  } catch (error) {
3155
- if (error instanceof Error) {
3156
- throw new Error(
3203
+ if (error instanceof LivechatApiError) {
3204
+ throw error.withCustomMessage(
3157
3205
  `Registered Webhooks couldn't be fetched. [${error.message}]`
3158
3206
  );
3159
3207
  } else {
@@ -3172,8 +3220,8 @@ var livechatWebhookApi = {
3172
3220
  );
3173
3221
  return response;
3174
3222
  } catch (error) {
3175
- if (error instanceof Error) {
3176
- throw new Error(
3223
+ if (error instanceof LivechatApiError) {
3224
+ throw error.withCustomMessage(
3177
3225
  `Registered Webhooks couldn't be deleted. [${error.message}]`
3178
3226
  );
3179
3227
  } else {
@@ -6061,6 +6109,7 @@ function getIntegrationFlowUrl(provider, flow, data, context, config) {
6061
6109
  AdapterApiError,
6062
6110
  ApiErrorBase,
6063
6111
  DpsApiError,
6112
+ LivechatApiError,
6064
6113
  MailchimpApiError,
6065
6114
  ShopifyApiError,
6066
6115
  UnauthorizeApiError,
package/dist/index.mjs CHANGED
@@ -2588,9 +2588,31 @@ var getRegion = (token) => {
2588
2588
  return region;
2589
2589
  }
2590
2590
  };
2591
+ var LivechatApiError = class extends ApiErrorBase {
2592
+ constructor() {
2593
+ super(...arguments);
2594
+ this.name = "livechat";
2595
+ }
2596
+ };
2591
2597
  var livechatClientInstance = axios15.create({
2592
2598
  baseURL: "https://api.labs.livechatinc.com"
2593
2599
  });
2600
+ livechatClientInstance.interceptors.response.use(
2601
+ (response) => response,
2602
+ (error) => {
2603
+ var _a, _b, _c, _d;
2604
+ if (((_a = error.response) == null ? void 0 : _a.status) === 401) {
2605
+ return Promise.reject(new UnauthorizeApiError("accounts"));
2606
+ }
2607
+ return Promise.reject(
2608
+ new LivechatApiError(
2609
+ error.message,
2610
+ (_b = error.response) == null ? void 0 : _b.data,
2611
+ (_d = (_c = error.response) == null ? void 0 : _c.status) != null ? _d : 400
2612
+ )
2613
+ );
2614
+ }
2615
+ );
2594
2616
  function getLiveChatClientAuthorization(req) {
2595
2617
  return {
2596
2618
  token: req.headers["platform-token"]
@@ -2890,8 +2912,8 @@ var livechatWebhookApi = {
2890
2912
  );
2891
2913
  return response;
2892
2914
  } catch (error) {
2893
- if (error instanceof Error) {
2894
- throw new Error(
2915
+ if (error instanceof LivechatApiError) {
2916
+ throw error.withCustomMessage(
2895
2917
  `Registered Webhooks couldn't be fetched. [${error.message}]`
2896
2918
  );
2897
2919
  } else {
@@ -2913,8 +2935,8 @@ var livechatWebhookApi = {
2913
2935
  );
2914
2936
  return response;
2915
2937
  } catch (error) {
2916
- if (error instanceof Error) {
2917
- throw new Error(
2938
+ if (error instanceof LivechatApiError) {
2939
+ throw error.withCustomMessage(
2918
2940
  `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.DELETED} [${error.message}]`
2919
2941
  );
2920
2942
  } else {
@@ -2926,7 +2948,11 @@ var livechatWebhookApi = {
2926
2948
  unregisterWebhooks(clientId, authorization) {
2927
2949
  return __async(this, null, function* () {
2928
2950
  try {
2929
- const { data: webhooks } = yield this.getWebhooks(clientId);
2951
+ const { data: webhooks } = yield this.getWebhooks(
2952
+ clientId,
2953
+ void 0,
2954
+ authorization
2955
+ );
2930
2956
  yield Promise.all(
2931
2957
  webhooks.map((webhook) => __async(this, null, function* () {
2932
2958
  return livechatClientInstance.post(
@@ -2940,8 +2966,8 @@ var livechatWebhookApi = {
2940
2966
  }))
2941
2967
  );
2942
2968
  } catch (error) {
2943
- if (error instanceof Error) {
2944
- throw new Error(
2969
+ if (error instanceof LivechatApiError) {
2970
+ throw error.withCustomMessage(
2945
2971
  `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.DELETED} [${error.message}]`
2946
2972
  );
2947
2973
  } else {
@@ -2950,10 +2976,31 @@ var livechatWebhookApi = {
2950
2976
  }
2951
2977
  });
2952
2978
  },
2979
+ registerWebhook(webhook, authorization) {
2980
+ return __async(this, null, function* () {
2981
+ yield livechatClientInstance.post(
2982
+ `/v${webhook.api_version || "3.5"}/configuration/action/register_webhook`,
2983
+ {
2984
+ url: webhook.url,
2985
+ action: webhook.action,
2986
+ secret_key: webhook.secret_key,
2987
+ owner_client_id: webhook.owner_client_id,
2988
+ type: webhook.type,
2989
+ description: webhook.description,
2990
+ filters: webhook.filters
2991
+ },
2992
+ getLiveChatClientConfig(authorization)
2993
+ ).catch((error) => {
2994
+ throw error.withCustomMessage(
2995
+ `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.CREATED} [${error.message}]`
2996
+ );
2997
+ });
2998
+ });
2999
+ },
2953
3000
  registerWebhooks(webhooks, authorization) {
2954
3001
  return __async(this, null, function* () {
2955
3002
  try {
2956
- yield this.unregisterWebhooks(webhooks[0].owner_client_id);
3003
+ yield this.unregisterWebhooks(webhooks[0].owner_client_id, authorization);
2957
3004
  yield Promise.all(
2958
3005
  webhooks.map((webhook) => __async(this, null, function* () {
2959
3006
  return livechatClientInstance.post(
@@ -2972,8 +3019,8 @@ var livechatWebhookApi = {
2972
3019
  }))
2973
3020
  );
2974
3021
  } catch (error) {
2975
- if (error instanceof Error) {
2976
- throw new Error(
3022
+ if (error instanceof LivechatApiError) {
3023
+ throw error.withCustomMessage(
2977
3024
  `${API_NOTIFICATIONS.BUILDING_BLOCKS.FAILURE.CREATED} [${error.message}]`
2978
3025
  );
2979
3026
  } else {
@@ -3011,9 +3058,9 @@ var livechatWebhookApi = {
3011
3058
  getLiveChatClientConfig(authorization)
3012
3059
  );
3013
3060
  } catch (error) {
3014
- if (error instanceof Error) {
3015
- throw new Error(
3016
- `Migration failed. It looks like one of the webhooks you're trying to migrate doesn't exist in the new version or exists under a different name. Migrate the webhook manually via the Configuration API. `
3061
+ if (error instanceof LivechatApiError) {
3062
+ throw error.withCustomMessage(
3063
+ `Migration failed. It looks like one of the webhooks you're trying to migrate doesn't exist in the new version or exists under a different name. Migrate the webhook manually via the Configuration API.`
3017
3064
  );
3018
3065
  } else {
3019
3066
  throw error;
@@ -3036,8 +3083,8 @@ var livechatWebhookApi = {
3036
3083
  );
3037
3084
  return response;
3038
3085
  } catch (error) {
3039
- if (error instanceof Error) {
3040
- throw new Error(
3086
+ if (error instanceof LivechatApiError) {
3087
+ throw error.withCustomMessage(
3041
3088
  `Registered Webhooks couldn't be fetched. [${error.message}]`
3042
3089
  );
3043
3090
  } else {
@@ -3056,8 +3103,8 @@ var livechatWebhookApi = {
3056
3103
  );
3057
3104
  return response;
3058
3105
  } catch (error) {
3059
- if (error instanceof Error) {
3060
- throw new Error(
3106
+ if (error instanceof LivechatApiError) {
3107
+ throw error.withCustomMessage(
3061
3108
  `Registered Webhooks couldn't be deleted. [${error.message}]`
3062
3109
  );
3063
3110
  } else {
@@ -5944,6 +5991,7 @@ export {
5944
5991
  AdapterApiError,
5945
5992
  ApiErrorBase,
5946
5993
  DpsApiError,
5994
+ LivechatApiError,
5947
5995
  MailchimpApiError,
5948
5996
  ShopifyApiError,
5949
5997
  UnauthorizeApiError,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@livechat/developer-studio-api",
3
- "version": "3.0.46",
3
+ "version": "3.0.47",
4
4
  "description": "This project is API for LiveChat Developer Studio.",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -20,8 +20,8 @@
20
20
  "tsup": "^7.1.0",
21
21
  "typescript": "^5.1.6",
22
22
  "eslint-config-custom": "0.0.7",
23
- "tsconfig": "0.0.1",
24
- "utils": "0.0.4"
23
+ "utils": "0.0.4",
24
+ "tsconfig": "0.0.1"
25
25
  },
26
26
  "scripts": {
27
27
  "build": "tsup",