revdoku 4.0.0 → 5.0.0
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/README.md +53 -30
- package/REFERENCE.md +41 -150
- package/dist/apis/DefaultApi.d.ts +72 -326
- package/dist/apis/DefaultApi.js +104 -614
- package/dist/client.d.ts +1 -14
- package/dist/client.js +0 -43
- package/dist/models/AccountIdentity.d.ts +2 -2
- package/dist/models/AccountIdentity.js +2 -2
- package/dist/models/AccountIdentityAgencyAccount.d.ts +2 -2
- package/dist/models/AccountIdentityAgencyAccount.js +2 -2
- package/dist/models/AccountIdentityPermissions.d.ts +2 -2
- package/dist/models/AccountIdentityPermissions.js +2 -2
- package/dist/models/AccountLimits.d.ts +2 -2
- package/dist/models/AccountLimits.js +2 -2
- package/dist/models/AccountList.d.ts +2 -2
- package/dist/models/AccountList.js +2 -2
- package/dist/models/ActionRequest.d.ts +2 -2
- package/dist/models/ActionRequest.js +2 -2
- package/dist/models/AgentConnection.d.ts +2 -2
- package/dist/models/AgentConnection.js +2 -2
- package/dist/models/AnalyticsMetric.d.ts +2 -2
- package/dist/models/AnalyticsMetric.js +2 -2
- package/dist/models/ApiError.d.ts +2 -2
- package/dist/models/ApiError.js +2 -2
- package/dist/models/ApiErrorError.d.ts +2 -2
- package/dist/models/ApiErrorError.js +2 -2
- package/dist/models/BrowserLink.d.ts +2 -2
- package/dist/models/BrowserLink.js +2 -2
- package/dist/models/Bucket.d.ts +5 -5
- package/dist/models/Bucket.js +2 -2
- package/dist/models/BucketAction.d.ts +2 -2
- package/dist/models/BucketAction.js +2 -2
- package/dist/models/BucketAnalytics.d.ts +2 -2
- package/dist/models/BucketAnalytics.js +2 -2
- package/dist/models/BucketAnalyticsAskAi.d.ts +2 -2
- package/dist/models/BucketAnalyticsAskAi.js +2 -2
- package/dist/models/BucketAnalyticsAskAiPagesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsAskAiPagesInner.js +2 -2
- package/dist/models/BucketAnalyticsGaps.d.ts +2 -2
- package/dist/models/BucketAnalyticsGaps.js +2 -2
- package/dist/models/BucketAnalyticsGapsSearchesWithoutResultsInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsGapsSearchesWithoutResultsInner.js +2 -2
- package/dist/models/BucketAnalyticsGapsUnansweredQuestionsInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsGapsUnansweredQuestionsInner.js +2 -2
- package/dist/models/BucketAnalyticsGapsUnhelpfulPagesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsGapsUnhelpfulPagesInner.js +2 -2
- package/dist/models/BucketAnalyticsPages.d.ts +2 -2
- package/dist/models/BucketAnalyticsPages.js +2 -2
- package/dist/models/BucketAnalyticsPagesMissingPagesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsPagesMissingPagesInner.js +2 -2
- package/dist/models/BucketAnalyticsPagesPagesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsPagesPagesInner.js +2 -2
- package/dist/models/BucketAnalyticsPreviousPeriod.d.ts +2 -2
- package/dist/models/BucketAnalyticsPreviousPeriod.js +2 -2
- package/dist/models/BucketAnalyticsSearch.d.ts +2 -2
- package/dist/models/BucketAnalyticsSearch.js +2 -2
- package/dist/models/BucketAnalyticsSearchAiAgents.d.ts +12 -2
- package/dist/models/BucketAnalyticsSearchAiAgents.js +8 -2
- package/dist/models/BucketAnalyticsSearchAiAgentsAgentsInner.d.ts +34 -0
- package/dist/models/BucketAnalyticsSearchAiAgentsAgentsInner.js +50 -0
- package/dist/models/BucketAnalyticsSearchAiAgentsByAgentInner.d.ts +39 -0
- package/dist/models/BucketAnalyticsSearchAiAgentsByAgentInner.js +53 -0
- package/dist/models/BucketAnalyticsSearchAiAgentsByAgentInnerAgentsInner.d.ts +34 -0
- package/dist/models/BucketAnalyticsSearchAiAgentsByAgentInnerAgentsInner.js +50 -0
- package/dist/models/BucketAnalyticsSearchHumans.d.ts +7 -2
- package/dist/models/BucketAnalyticsSearchHumans.js +5 -2
- package/dist/models/BucketAnalyticsSearchHumansCountriesInner.d.ts +39 -0
- package/dist/models/BucketAnalyticsSearchHumansCountriesInner.js +53 -0
- package/dist/models/BucketAnalyticsSearchHumansTopInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSearchHumansTopInner.js +2 -2
- package/dist/models/BucketAnalyticsSearchHumansWithoutResultsInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSearchHumansWithoutResultsInner.js +2 -2
- package/dist/models/BucketAnalyticsSeriesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSeriesInner.js +2 -2
- package/dist/models/BucketAnalyticsSources.d.ts +2 -2
- package/dist/models/BucketAnalyticsSources.js +2 -2
- package/dist/models/BucketAnalyticsSourcesAiAgents.d.ts +7 -2
- package/dist/models/BucketAnalyticsSourcesAiAgents.js +5 -2
- package/dist/models/BucketAnalyticsSourcesAiAgentsActivityInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesAiAgentsActivityInner.js +2 -2
- package/dist/models/BucketAnalyticsSourcesAiAgentsAgentsInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesAiAgentsAgentsInner.js +2 -2
- package/dist/models/BucketAnalyticsSourcesAiAgentsCountriesInner.d.ts +35 -0
- package/dist/models/BucketAnalyticsSourcesAiAgentsCountriesInner.js +51 -0
- package/dist/models/BucketAnalyticsSourcesAiAgentsSearchesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesAiAgentsSearchesInner.js +2 -2
- package/dist/models/BucketAnalyticsSourcesBots.d.ts +7 -2
- package/dist/models/BucketAnalyticsSourcesBots.js +5 -2
- package/dist/models/BucketAnalyticsSourcesHumans.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesHumans.js +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansCountriesInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansCountriesInner.js +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansDownloadsInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansDownloadsInner.js +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansOutboundLinksInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansOutboundLinksInner.js +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansReferrersInner.d.ts +2 -2
- package/dist/models/BucketAnalyticsSourcesHumansReferrersInner.js +2 -2
- package/dist/models/BucketAnalyticsSupport.d.ts +2 -2
- package/dist/models/BucketAnalyticsSupport.js +2 -2
- package/dist/models/BucketAnalyticsTraffic.d.ts +2 -2
- package/dist/models/BucketAnalyticsTraffic.js +2 -2
- package/dist/models/BucketAnalyticsViewLimit.d.ts +2 -2
- package/dist/models/BucketAnalyticsViewLimit.js +2 -2
- package/dist/models/BucketCounts.d.ts +2 -2
- package/dist/models/BucketCounts.js +2 -2
- package/dist/models/BucketCreate.d.ts +2 -14
- package/dist/models/BucketCreate.js +2 -12
- package/dist/models/BucketEmail.d.ts +2 -2
- package/dist/models/BucketEmail.js +2 -2
- package/dist/models/BucketEmailOptions.d.ts +2 -2
- package/dist/models/BucketEmailOptions.js +2 -2
- package/dist/models/BucketFile.d.ts +2 -2
- package/dist/models/BucketFile.js +2 -2
- package/dist/models/BucketList.d.ts +2 -2
- package/dist/models/BucketList.js +2 -2
- package/dist/models/BucketLock.d.ts +2 -2
- package/dist/models/BucketLock.js +2 -2
- package/dist/models/BucketUpdate.d.ts +2 -2
- package/dist/models/BucketUpdate.js +2 -2
- package/dist/models/CodeRequested.d.ts +2 -2
- package/dist/models/CodeRequested.js +2 -2
- package/dist/models/ConnectGithubRepository201Response.d.ts +2 -2
- package/dist/models/ConnectGithubRepository201Response.js +2 -2
- package/dist/models/ConnectGithubRepository201ResponseData.d.ts +2 -2
- package/dist/models/ConnectGithubRepository201ResponseData.js +2 -2
- package/dist/models/ConnectGithubRepositoryRequest.d.ts +2 -2
- package/dist/models/ConnectGithubRepositoryRequest.js +2 -2
- package/dist/models/Connection.d.ts +2 -2
- package/dist/models/Connection.js +2 -2
- package/dist/models/ConnectionPermissions.d.ts +2 -2
- package/dist/models/ConnectionPermissions.js +2 -2
- package/dist/models/ConnectionRenewal.d.ts +2 -2
- package/dist/models/ConnectionRenewal.js +2 -2
- package/dist/models/CreateBucket201Response.d.ts +2 -2
- package/dist/models/CreateBucket201Response.js +2 -2
- package/dist/models/CreateBucket201ResponseData.d.ts +2 -2
- package/dist/models/CreateBucket201ResponseData.js +2 -2
- package/dist/models/CreateBucketRequest.d.ts +2 -2
- package/dist/models/CreateBucketRequest.js +2 -2
- package/dist/models/CreateClientAccount201Response.d.ts +2 -2
- package/dist/models/CreateClientAccount201Response.js +2 -2
- package/dist/models/CreateClientAccount201ResponseData.d.ts +2 -2
- package/dist/models/CreateClientAccount201ResponseData.js +2 -2
- package/dist/models/CreateClientAccountRequest.d.ts +2 -2
- package/dist/models/CreateClientAccountRequest.js +2 -2
- package/dist/models/CreateDashboardLink201Response.d.ts +2 -2
- package/dist/models/CreateDashboardLink201Response.js +2 -2
- package/dist/models/CreateDashboardLinkRequest.d.ts +2 -2
- package/dist/models/CreateDashboardLinkRequest.js +2 -2
- package/dist/models/CreateFileUpload201Response.d.ts +35 -0
- package/dist/models/CreateFileUpload201Response.js +55 -0
- package/dist/models/CreditsUsed.d.ts +2 -2
- package/dist/models/CreditsUsed.js +2 -2
- package/dist/models/DecodedEmailAddress.d.ts +2 -2
- package/dist/models/DecodedEmailAddress.js +2 -2
- package/dist/models/DecodedIncomingMessage.d.ts +2 -2
- package/dist/models/DecodedIncomingMessage.js +2 -2
- package/dist/models/DecodedIncomingMessageAttachmentsInner.d.ts +2 -2
- package/dist/models/DecodedIncomingMessageAttachmentsInner.js +2 -2
- package/dist/models/DeleteBucket200Response.d.ts +2 -2
- package/dist/models/DeleteBucket200Response.js +2 -2
- package/dist/models/DeleteBucketRequest.d.ts +2 -2
- package/dist/models/DeleteBucketRequest.js +2 -2
- package/dist/models/DeleteResult.d.ts +2 -2
- package/dist/models/DeleteResult.js +2 -2
- package/dist/models/Download.d.ts +2 -2
- package/dist/models/Download.js +2 -2
- package/dist/models/EmailAttachment.d.ts +3 -7
- package/dist/models/EmailAttachment.js +5 -7
- package/dist/models/EmailDelivery.d.ts +2 -2
- package/dist/models/EmailDelivery.js +2 -2
- package/dist/models/EmailForwarding.d.ts +2 -2
- package/dist/models/EmailForwarding.js +2 -2
- package/dist/models/EmailForwardingContent.d.ts +2 -2
- package/dist/models/EmailForwardingContent.js +2 -2
- package/dist/models/EmailLabel.d.ts +2 -2
- package/dist/models/EmailLabel.js +2 -2
- package/dist/models/EmailSummary.d.ts +3 -16
- package/dist/models/EmailSummary.js +2 -9
- package/dist/models/ErrorCode.d.ts +5 -25
- package/dist/models/ErrorCode.js +5 -25
- package/dist/models/EventSubscription.d.ts +2 -2
- package/dist/models/EventSubscription.js +2 -2
- package/dist/models/ExchangeConnectionGrantRequest.d.ts +2 -2
- package/dist/models/ExchangeConnectionGrantRequest.js +2 -2
- package/dist/models/FileActor.d.ts +2 -2
- package/dist/models/FileActor.js +2 -2
- package/dist/models/FileDownload.d.ts +2 -2
- package/dist/models/FileDownload.js +2 -2
- package/dist/models/FileKey.d.ts +2 -2
- package/dist/models/FileKey.js +2 -2
- package/dist/models/FileList.d.ts +2 -2
- package/dist/models/FileList.js +2 -2
- package/dist/models/FileMoveRequest.d.ts +38 -0
- package/dist/models/FileMoveRequest.js +54 -0
- package/dist/models/FileMoveResult.d.ts +48 -0
- package/dist/models/FileMoveResult.js +68 -0
- package/dist/models/FileRestoreResult.d.ts +44 -0
- package/dist/models/{RestoredFileVersion.js → FileRestoreResult.js} +19 -15
- package/dist/models/FileUpload.d.ts +39 -0
- package/dist/models/FileUpload.js +59 -0
- package/dist/models/FileUploadRequest.d.ts +50 -0
- package/dist/models/FileUploadRequest.js +66 -0
- package/dist/models/FileUploadUpload.d.ts +47 -0
- package/dist/models/FileUploadUpload.js +67 -0
- package/dist/models/FileVersion.d.ts +2 -2
- package/dist/models/FileVersion.js +2 -2
- package/dist/models/FileVersionList.d.ts +2 -2
- package/dist/models/FileVersionList.js +2 -2
- package/dist/models/FileVersionReason.d.ts +2 -2
- package/dist/models/FileVersionReason.js +2 -2
- package/dist/models/FileWriteRequest.d.ts +54 -0
- package/dist/models/FileWriteRequest.js +62 -0
- package/dist/models/FileWriteResult.d.ts +48 -0
- package/dist/models/{UploadedFile.js → FileWriteResult.js} +19 -17
- package/dist/models/GetAccountLimits200Response.d.ts +2 -2
- package/dist/models/GetAccountLimits200Response.js +2 -2
- package/dist/models/GetAccountLimits200ResponseData.d.ts +2 -2
- package/dist/models/GetAccountLimits200ResponseData.js +2 -2
- package/dist/models/GetAccountLimits200ResponseDataCredits.d.ts +2 -2
- package/dist/models/GetAccountLimits200ResponseDataCredits.js +2 -2
- package/dist/models/GetAccountLimits200ResponseDataUsage.d.ts +2 -2
- package/dist/models/GetAccountLimits200ResponseDataUsage.js +2 -2
- package/dist/models/GetAccountLimits200ResponseDataUsageBucketCreations.d.ts +2 -2
- package/dist/models/GetAccountLimits200ResponseDataUsageBucketCreations.js +2 -2
- package/dist/models/GetBucketAnalytics200Response.d.ts +2 -2
- package/dist/models/GetBucketAnalytics200Response.js +2 -2
- package/dist/models/GetBucketAnalytics200ResponseData.d.ts +2 -2
- package/dist/models/GetBucketAnalytics200ResponseData.js +2 -2
- package/dist/models/GetEventSubscription200Response.d.ts +2 -2
- package/dist/models/GetEventSubscription200Response.js +2 -2
- package/dist/models/GetEventSubscription200ResponseData.d.ts +2 -2
- package/dist/models/GetEventSubscription200ResponseData.js +2 -2
- package/dist/models/GetFileByPath200Response.d.ts +2 -2
- package/dist/models/GetFileByPath200Response.js +2 -2
- package/dist/models/GetFileByPath200ResponseData.d.ts +2 -2
- package/dist/models/GetFileByPath200ResponseData.js +2 -2
- package/dist/models/GetFileDownload200Response.d.ts +2 -2
- package/dist/models/GetFileDownload200Response.js +2 -2
- package/dist/models/GetGithubSetupLink200Response.d.ts +2 -2
- package/dist/models/GetGithubSetupLink200Response.js +2 -2
- package/dist/models/GetGithubSetupLink200ResponseData.d.ts +2 -2
- package/dist/models/GetGithubSetupLink200ResponseData.js +2 -2
- package/dist/models/GetGithubSync200Response.d.ts +2 -2
- package/dist/models/GetGithubSync200Response.js +2 -2
- package/dist/models/GetGithubSync200ResponseData.d.ts +2 -2
- package/dist/models/GetGithubSync200ResponseData.js +2 -2
- package/dist/models/GetPublication200Response.d.ts +2 -2
- package/dist/models/GetPublication200Response.js +2 -2
- package/dist/models/GetPublication200ResponseData.d.ts +2 -2
- package/dist/models/GetPublication200ResponseData.js +2 -2
- package/dist/models/GetStatus200Response.d.ts +2 -2
- package/dist/models/GetStatus200Response.js +2 -2
- package/dist/models/GetTicket200Response.d.ts +2 -2
- package/dist/models/GetTicket200Response.js +2 -2
- package/dist/models/GetTicket200ResponseData.d.ts +2 -2
- package/dist/models/GetTicket200ResponseData.js +2 -2
- package/dist/models/GetTicketMessage200Response.d.ts +2 -2
- package/dist/models/GetTicketMessage200Response.js +2 -2
- package/dist/models/GetTicketMessage200ResponseData.d.ts +2 -2
- package/dist/models/GetTicketMessage200ResponseData.js +2 -2
- package/dist/models/GetTicketMessageOriginalDownload200Response.d.ts +2 -2
- package/dist/models/GetTicketMessageOriginalDownload200Response.js +2 -2
- package/dist/models/GetTicketMessageOriginalDownload200ResponseData.d.ts +2 -2
- package/dist/models/GetTicketMessageOriginalDownload200ResponseData.js +2 -2
- package/dist/models/GetWebhook200Response.d.ts +2 -2
- package/dist/models/GetWebhook200Response.js +2 -2
- package/dist/models/GetWebhook200ResponseData.d.ts +2 -2
- package/dist/models/GetWebhook200ResponseData.js +2 -2
- package/dist/models/GithubConnect.d.ts +4 -9
- package/dist/models/GithubConnect.js +2 -5
- package/dist/models/GithubInstallation.d.ts +2 -2
- package/dist/models/GithubInstallation.js +2 -2
- package/dist/models/GithubRepository.d.ts +2 -2
- package/dist/models/GithubRepository.js +2 -2
- package/dist/models/GithubSetupLink.d.ts +2 -2
- package/dist/models/GithubSetupLink.js +2 -2
- package/dist/models/GithubSync.d.ts +3 -25
- package/dist/models/GithubSync.js +2 -24
- package/dist/models/GithubSyncError.d.ts +2 -2
- package/dist/models/GithubSyncError.js +2 -2
- package/dist/models/GithubSyncSettings.d.ts +2 -10
- package/dist/models/GithubSyncSettings.js +2 -6
- package/dist/models/GithubSyncSkippedFilesInner.d.ts +2 -2
- package/dist/models/GithubSyncSkippedFilesInner.js +2 -2
- package/dist/models/ListAccounts200Response.d.ts +2 -2
- package/dist/models/ListAccounts200Response.js +2 -2
- package/dist/models/ListBuckets200Response.d.ts +2 -2
- package/dist/models/ListBuckets200Response.js +2 -2
- package/dist/models/ListFileVersions200Response.d.ts +2 -2
- package/dist/models/ListFileVersions200Response.js +2 -2
- package/dist/models/ListFiles200Response.d.ts +2 -2
- package/dist/models/ListFiles200Response.js +2 -2
- package/dist/models/ListGithubBranches200Response.d.ts +2 -2
- package/dist/models/ListGithubBranches200Response.js +2 -2
- package/dist/models/ListGithubBranches200ResponseData.d.ts +2 -2
- package/dist/models/ListGithubBranches200ResponseData.js +2 -2
- package/dist/models/ListGithubInstallations200Response.d.ts +2 -2
- package/dist/models/ListGithubInstallations200Response.js +2 -2
- package/dist/models/ListGithubInstallations200ResponseData.d.ts +2 -2
- package/dist/models/ListGithubInstallations200ResponseData.js +2 -2
- package/dist/models/ListGithubRepositories200Response.d.ts +2 -2
- package/dist/models/ListGithubRepositories200Response.js +2 -2
- package/dist/models/ListGithubRepositories200ResponseData.d.ts +2 -2
- package/dist/models/ListGithubRepositories200ResponseData.js +2 -2
- package/dist/models/ListTicketMessages200Response.d.ts +2 -2
- package/dist/models/ListTicketMessages200Response.js +2 -2
- package/dist/models/ListTickets200Response.d.ts +2 -2
- package/dist/models/ListTickets200Response.js +2 -2
- package/dist/models/MoveFile200Response.d.ts +35 -0
- package/dist/models/MoveFile200Response.js +55 -0
- package/dist/models/Pagination.d.ts +2 -2
- package/dist/models/Pagination.js +2 -2
- package/dist/models/PreviewBucket202Response.d.ts +2 -2
- package/dist/models/PreviewBucket202Response.js +2 -2
- package/dist/models/PreviewBucket202ResponseData.d.ts +2 -2
- package/dist/models/PreviewBucket202ResponseData.js +2 -2
- package/dist/models/PreviewRequest.d.ts +2 -2
- package/dist/models/PreviewRequest.js +2 -2
- package/dist/models/Publication.d.ts +2 -2
- package/dist/models/Publication.js +2 -2
- package/dist/models/PublishBucket202Response.d.ts +2 -2
- package/dist/models/PublishBucket202Response.js +2 -2
- package/dist/models/PublishBucket202ResponseData.d.ts +2 -2
- package/dist/models/PublishBucket202ResponseData.js +2 -2
- package/dist/models/PublishBucket202ResponseDataPlanNotice.d.ts +2 -2
- package/dist/models/PublishBucket202ResponseDataPlanNotice.js +2 -2
- package/dist/models/PublishRequest.d.ts +2 -2
- package/dist/models/PublishRequest.js +2 -2
- package/dist/models/ReplyToTicket202Response.d.ts +2 -2
- package/dist/models/ReplyToTicket202Response.js +2 -2
- package/dist/models/ReplyToTicket202ResponseData.d.ts +2 -2
- package/dist/models/ReplyToTicket202ResponseData.js +2 -2
- package/dist/models/RequestSignInCode200Response.d.ts +2 -2
- package/dist/models/RequestSignInCode200Response.js +2 -2
- package/dist/models/RequestSignInCodeRequest.d.ts +2 -2
- package/dist/models/RequestSignInCodeRequest.js +2 -2
- package/dist/models/RestoreFileVersion201Response.d.ts +4 -4
- package/dist/models/RestoreFileVersion201Response.js +5 -5
- package/dist/models/SetWebhook200Response.d.ts +2 -2
- package/dist/models/SetWebhook200Response.js +2 -2
- package/dist/models/SetWebhook200ResponseData.d.ts +2 -2
- package/dist/models/SetWebhook200ResponseData.js +2 -2
- package/dist/models/SetWebhookRequest.d.ts +2 -2
- package/dist/models/SetWebhookRequest.js +2 -2
- package/dist/models/Status.d.ts +2 -2
- package/dist/models/Status.js +2 -2
- package/dist/models/StatusFeatures.d.ts +2 -2
- package/dist/models/StatusFeatures.js +2 -2
- package/dist/models/StatusUser.d.ts +2 -2
- package/dist/models/StatusUser.js +2 -2
- package/dist/models/SyncGithubRepository202Response.d.ts +2 -2
- package/dist/models/SyncGithubRepository202Response.js +2 -2
- package/dist/models/SyncGithubRepository202ResponseData.d.ts +2 -2
- package/dist/models/SyncGithubRepository202ResponseData.js +2 -2
- package/dist/models/Ticket.d.ts +13 -3
- package/dist/models/Ticket.js +12 -2
- package/dist/models/TicketEvent.d.ts +2 -2
- package/dist/models/TicketEvent.js +2 -2
- package/dist/models/TicketEventData.d.ts +2 -2
- package/dist/models/TicketEventData.js +2 -2
- package/dist/models/TicketList.d.ts +2 -2
- package/dist/models/TicketList.js +2 -2
- package/dist/models/TicketMessage.d.ts +3 -16
- package/dist/models/TicketMessage.js +2 -9
- package/dist/models/TicketMessageList.d.ts +2 -2
- package/dist/models/TicketMessageList.js +2 -2
- package/dist/models/TicketReplyRequest.d.ts +2 -2
- package/dist/models/TicketReplyRequest.js +2 -2
- package/dist/models/TicketSourcesInner.d.ts +43 -0
- package/dist/models/TicketSourcesInner.js +63 -0
- package/dist/models/TicketUpdateRequest.d.ts +7 -2
- package/dist/models/TicketUpdateRequest.js +5 -2
- package/dist/models/UpdateBucketRequest.d.ts +2 -2
- package/dist/models/UpdateBucketRequest.js +2 -2
- package/dist/models/UpdateGithubSyncRequest.d.ts +2 -2
- package/dist/models/UpdateGithubSyncRequest.js +2 -2
- package/dist/models/VerifySignInCode201Response.d.ts +2 -2
- package/dist/models/VerifySignInCode201Response.js +2 -2
- package/dist/models/VerifySignInCodeRequest.d.ts +2 -2
- package/dist/models/VerifySignInCodeRequest.js +2 -2
- package/dist/models/Webhook.d.ts +2 -2
- package/dist/models/Webhook.js +2 -2
- package/dist/models/WebhookWithSecret.d.ts +2 -2
- package/dist/models/WebhookWithSecret.js +2 -2
- package/dist/models/WriteFile201Response.d.ts +35 -0
- package/dist/models/WriteFile201Response.js +55 -0
- package/dist/models/index.d.ts +17 -34
- package/dist/models/index.js +17 -34
- package/dist/runtime.d.ts +2 -2
- package/dist/runtime.js +2 -2
- package/package.json +1 -1
- package/dist/models/AddUploadSessionFilesRequest.d.ts +0 -39
- package/dist/models/AddUploadSessionFilesRequest.js +0 -55
- package/dist/models/AppendText200Response.d.ts +0 -35
- package/dist/models/AppendText200Response.js +0 -55
- package/dist/models/AppendTextRequest.d.ts +0 -50
- package/dist/models/AppendTextRequest.js +0 -62
- package/dist/models/AppendTextResult.d.ts +0 -52
- package/dist/models/AppendTextResult.js +0 -72
- package/dist/models/CreateUploadSession201Response.d.ts +0 -35
- package/dist/models/CreateUploadSession201Response.js +0 -55
- package/dist/models/CreateUploadSessionRequest.d.ts +0 -63
- package/dist/models/CreateUploadSessionRequest.js +0 -69
- package/dist/models/EmailSummaryFiles.d.ts +0 -42
- package/dist/models/EmailSummaryFiles.js +0 -60
- package/dist/models/FileUploadSkip.d.ts +0 -52
- package/dist/models/FileUploadSkip.js +0 -58
- package/dist/models/FinalizeUploadSessionRequest.d.ts +0 -38
- package/dist/models/FinalizeUploadSessionRequest.js +0 -52
- package/dist/models/GithubSyncPendingChangesInner.d.ts +0 -34
- package/dist/models/GithubSyncPendingChangesInner.js +0 -54
- package/dist/models/GithubSyncPullRequest.d.ts +0 -38
- package/dist/models/GithubSyncPullRequest.js +0 -58
- package/dist/models/LockBucket200Response.d.ts +0 -35
- package/dist/models/LockBucket200Response.js +0 -55
- package/dist/models/LockBucket200ResponseData.d.ts +0 -36
- package/dist/models/LockBucket200ResponseData.js +0 -52
- package/dist/models/LockRequest.d.ts +0 -46
- package/dist/models/LockRequest.js +0 -58
- package/dist/models/MoveFileRequest.d.ts +0 -46
- package/dist/models/MoveFileRequest.js +0 -56
- package/dist/models/PathOperationResult.d.ts +0 -73
- package/dist/models/PathOperationResult.js +0 -81
- package/dist/models/PrepareFileUpload201Response.d.ts +0 -35
- package/dist/models/PrepareFileUpload201Response.js +0 -55
- package/dist/models/PrepareFileUploadRequest.d.ts +0 -55
- package/dist/models/PrepareFileUploadRequest.js +0 -69
- package/dist/models/PreparedFileUpload.d.ts +0 -79
- package/dist/models/PreparedFileUpload.js +0 -73
- package/dist/models/RenameFile200Response.d.ts +0 -35
- package/dist/models/RenameFile200Response.js +0 -55
- package/dist/models/RenameFileRequest.d.ts +0 -38
- package/dist/models/RenameFileRequest.js +0 -54
- package/dist/models/RestoredFileVersion.d.ts +0 -40
- package/dist/models/SaveUploadSessionBatchRequest.d.ts +0 -38
- package/dist/models/SaveUploadSessionBatchRequest.js +0 -52
- package/dist/models/SaveUploadedFile201Response.d.ts +0 -35
- package/dist/models/SaveUploadedFile201Response.js +0 -55
- package/dist/models/SaveUploadedFileRequest.d.ts +0 -78
- package/dist/models/SaveUploadedFileRequest.js +0 -85
- package/dist/models/SavedFile.d.ts +0 -49
- package/dist/models/SavedFile.js +0 -65
- package/dist/models/StorageUpload.d.ts +0 -36
- package/dist/models/StorageUpload.js +0 -54
- package/dist/models/UnlockRequest.d.ts +0 -38
- package/dist/models/UnlockRequest.js +0 -52
- package/dist/models/UploadBlob.d.ts +0 -57
- package/dist/models/UploadBlob.js +0 -79
- package/dist/models/UploadSession.d.ts +0 -94
- package/dist/models/UploadSession.js +0 -91
- package/dist/models/UploadSessionFile.d.ts +0 -46
- package/dist/models/UploadSessionFile.js +0 -66
- package/dist/models/UploadSessionResult.d.ts +0 -82
- package/dist/models/UploadSessionResult.js +0 -86
- package/dist/models/UploadSessionUpload.d.ts +0 -47
- package/dist/models/UploadSessionUpload.js +0 -61
- package/dist/models/UploadedFile.d.ts +0 -48
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Revdoku API
|
|
3
|
-
*
|
|
3
|
+
* A bucket is the project of one docs site: its files, the published site, the site analytics, and the support email address with its tickets. Create buckets, publish sites, read and reply to support requests and store files. The dashboard calls a bucket a site. Guide: https://docs.revdoku.com/api/. Create an account at https://app.revdoku.com/users/sign_up.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 5.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -11,9 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { type ActionRequest } from '../models/ActionRequest';
|
|
14
|
-
import { type AddUploadSessionFilesRequest } from '../models/AddUploadSessionFilesRequest';
|
|
15
|
-
import { type AppendText200Response } from '../models/AppendText200Response';
|
|
16
|
-
import { type AppendTextRequest } from '../models/AppendTextRequest';
|
|
17
14
|
import { type ConnectGithubRepository201Response } from '../models/ConnectGithubRepository201Response';
|
|
18
15
|
import { type ConnectGithubRepositoryRequest } from '../models/ConnectGithubRepositoryRequest';
|
|
19
16
|
import { type CreateBucket201Response } from '../models/CreateBucket201Response';
|
|
@@ -22,12 +19,13 @@ import { type CreateClientAccount201Response } from '../models/CreateClientAccou
|
|
|
22
19
|
import { type CreateClientAccountRequest } from '../models/CreateClientAccountRequest';
|
|
23
20
|
import { type CreateDashboardLink201Response } from '../models/CreateDashboardLink201Response';
|
|
24
21
|
import { type CreateDashboardLinkRequest } from '../models/CreateDashboardLinkRequest';
|
|
25
|
-
import { type
|
|
26
|
-
import { type CreateUploadSessionRequest } from '../models/CreateUploadSessionRequest';
|
|
22
|
+
import { type CreateFileUpload201Response } from '../models/CreateFileUpload201Response';
|
|
27
23
|
import { type DeleteBucket200Response } from '../models/DeleteBucket200Response';
|
|
28
24
|
import { type DeleteBucketRequest } from '../models/DeleteBucketRequest';
|
|
29
25
|
import { type ExchangeConnectionGrantRequest } from '../models/ExchangeConnectionGrantRequest';
|
|
30
|
-
import { type
|
|
26
|
+
import { type FileMoveRequest } from '../models/FileMoveRequest';
|
|
27
|
+
import { type FileUploadRequest } from '../models/FileUploadRequest';
|
|
28
|
+
import { type FileWriteRequest } from '../models/FileWriteRequest';
|
|
31
29
|
import { type GetAccountLimits200Response } from '../models/GetAccountLimits200Response';
|
|
32
30
|
import { type GetBucketAnalytics200Response } from '../models/GetBucketAnalytics200Response';
|
|
33
31
|
import { type GetEventSubscription200Response } from '../models/GetEventSubscription200Response';
|
|
@@ -50,58 +48,25 @@ import { type ListGithubInstallations200Response } from '../models/ListGithubIns
|
|
|
50
48
|
import { type ListGithubRepositories200Response } from '../models/ListGithubRepositories200Response';
|
|
51
49
|
import { type ListTicketMessages200Response } from '../models/ListTicketMessages200Response';
|
|
52
50
|
import { type ListTickets200Response } from '../models/ListTickets200Response';
|
|
53
|
-
import { type
|
|
54
|
-
import { type LockRequest } from '../models/LockRequest';
|
|
55
|
-
import { type MoveFileRequest } from '../models/MoveFileRequest';
|
|
56
|
-
import { type PrepareFileUpload201Response } from '../models/PrepareFileUpload201Response';
|
|
57
|
-
import { type PrepareFileUploadRequest } from '../models/PrepareFileUploadRequest';
|
|
51
|
+
import { type MoveFile200Response } from '../models/MoveFile200Response';
|
|
58
52
|
import { type PreviewBucket202Response } from '../models/PreviewBucket202Response';
|
|
59
53
|
import { type PreviewRequest } from '../models/PreviewRequest';
|
|
60
54
|
import { type PublishBucket202Response } from '../models/PublishBucket202Response';
|
|
61
55
|
import { type PublishRequest } from '../models/PublishRequest';
|
|
62
|
-
import { type RenameFile200Response } from '../models/RenameFile200Response';
|
|
63
|
-
import { type RenameFileRequest } from '../models/RenameFileRequest';
|
|
64
56
|
import { type ReplyToTicket202Response } from '../models/ReplyToTicket202Response';
|
|
65
57
|
import { type RequestSignInCode200Response } from '../models/RequestSignInCode200Response';
|
|
66
58
|
import { type RequestSignInCodeRequest } from '../models/RequestSignInCodeRequest';
|
|
67
59
|
import { type RestoreFileVersion201Response } from '../models/RestoreFileVersion201Response';
|
|
68
|
-
import { type SaveUploadSessionBatchRequest } from '../models/SaveUploadSessionBatchRequest';
|
|
69
|
-
import { type SaveUploadedFile201Response } from '../models/SaveUploadedFile201Response';
|
|
70
|
-
import { type SaveUploadedFileRequest } from '../models/SaveUploadedFileRequest';
|
|
71
60
|
import { type SetWebhook200Response } from '../models/SetWebhook200Response';
|
|
72
61
|
import { type SetWebhookRequest } from '../models/SetWebhookRequest';
|
|
73
62
|
import { type SyncGithubRepository202Response } from '../models/SyncGithubRepository202Response';
|
|
74
63
|
import { type TicketReplyRequest } from '../models/TicketReplyRequest';
|
|
75
64
|
import { type TicketUpdateRequest } from '../models/TicketUpdateRequest';
|
|
76
|
-
import { type UnlockRequest } from '../models/UnlockRequest';
|
|
77
65
|
import { type UpdateBucketRequest } from '../models/UpdateBucketRequest';
|
|
78
66
|
import { type UpdateGithubSyncRequest } from '../models/UpdateGithubSyncRequest';
|
|
79
67
|
import { type VerifySignInCode201Response } from '../models/VerifySignInCode201Response';
|
|
80
68
|
import { type VerifySignInCodeRequest } from '../models/VerifySignInCodeRequest';
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
*
|
|
84
|
-
*/
|
|
85
|
-
bucketId: string;
|
|
86
|
-
/**
|
|
87
|
-
* bucket_upload_session.id from the create response.
|
|
88
|
-
*/
|
|
89
|
-
sessionId: string;
|
|
90
|
-
/**
|
|
91
|
-
*
|
|
92
|
-
*/
|
|
93
|
-
addUploadSessionFilesRequest: AddUploadSessionFilesRequest;
|
|
94
|
-
}
|
|
95
|
-
export interface AppendTextOperationRequest {
|
|
96
|
-
/**
|
|
97
|
-
*
|
|
98
|
-
*/
|
|
99
|
-
bucketId: string;
|
|
100
|
-
/**
|
|
101
|
-
*
|
|
102
|
-
*/
|
|
103
|
-
appendTextRequest: AppendTextRequest;
|
|
104
|
-
}
|
|
69
|
+
import { type WriteFile201Response } from '../models/WriteFile201Response';
|
|
105
70
|
export interface ArchiveBucketRequest {
|
|
106
71
|
/**
|
|
107
72
|
*
|
|
@@ -122,20 +87,6 @@ export interface ConnectGithubRepositoryOperationRequest {
|
|
|
122
87
|
*/
|
|
123
88
|
connectGithubRepositoryRequest: ConnectGithubRepositoryRequest;
|
|
124
89
|
}
|
|
125
|
-
export interface CopyFileRequest {
|
|
126
|
-
/**
|
|
127
|
-
*
|
|
128
|
-
*/
|
|
129
|
-
bucketId: string;
|
|
130
|
-
/**
|
|
131
|
-
*
|
|
132
|
-
*/
|
|
133
|
-
fileId: string;
|
|
134
|
-
/**
|
|
135
|
-
*
|
|
136
|
-
*/
|
|
137
|
-
moveFileRequest: MoveFileRequest;
|
|
138
|
-
}
|
|
139
90
|
export interface CreateBucketOperationRequest {
|
|
140
91
|
/**
|
|
141
92
|
*
|
|
@@ -154,7 +105,7 @@ export interface CreateDashboardLinkOperationRequest {
|
|
|
154
105
|
*/
|
|
155
106
|
createDashboardLinkRequest: CreateDashboardLinkRequest;
|
|
156
107
|
}
|
|
157
|
-
export interface
|
|
108
|
+
export interface CreateFileUploadRequest {
|
|
158
109
|
/**
|
|
159
110
|
*
|
|
160
111
|
*/
|
|
@@ -162,7 +113,7 @@ export interface CreateUploadSessionOperationRequest {
|
|
|
162
113
|
/**
|
|
163
114
|
*
|
|
164
115
|
*/
|
|
165
|
-
|
|
116
|
+
fileUploadRequest: FileUploadRequest;
|
|
166
117
|
}
|
|
167
118
|
export interface DeleteBucketOperationRequest {
|
|
168
119
|
/**
|
|
@@ -244,20 +195,6 @@ export interface ExchangeConnectionGrantOperationRequest {
|
|
|
244
195
|
*/
|
|
245
196
|
exchangeConnectionGrantRequest: ExchangeConnectionGrantRequest;
|
|
246
197
|
}
|
|
247
|
-
export interface FinalizeUploadSessionOperationRequest {
|
|
248
|
-
/**
|
|
249
|
-
*
|
|
250
|
-
*/
|
|
251
|
-
bucketId: string;
|
|
252
|
-
/**
|
|
253
|
-
* bucket_upload_session.id from the create response.
|
|
254
|
-
*/
|
|
255
|
-
sessionId: string;
|
|
256
|
-
/**
|
|
257
|
-
*
|
|
258
|
-
*/
|
|
259
|
-
finalizeUploadSessionRequest?: FinalizeUploadSessionRequest;
|
|
260
|
-
}
|
|
261
198
|
export interface GetAccountRequest {
|
|
262
199
|
/**
|
|
263
200
|
* Granted account to read.
|
|
@@ -455,10 +392,6 @@ export interface GetTicketMessageRequest {
|
|
|
455
392
|
*
|
|
456
393
|
*/
|
|
457
394
|
reason?: string | null;
|
|
458
|
-
/**
|
|
459
|
-
* Include backing file IDs for file-browser integrations.
|
|
460
|
-
*/
|
|
461
|
-
includeStorage?: boolean;
|
|
462
395
|
}
|
|
463
396
|
export interface GetTicketMessageAttachmentDownloadRequest {
|
|
464
397
|
/**
|
|
@@ -677,10 +610,6 @@ export interface ListTicketMessagesRequest {
|
|
|
677
610
|
* pagination.next_cursor from the previous page.
|
|
678
611
|
*/
|
|
679
612
|
cursor?: string;
|
|
680
|
-
/**
|
|
681
|
-
* Include backing file IDs for file-browser integrations.
|
|
682
|
-
*/
|
|
683
|
-
includeStorage?: boolean;
|
|
684
613
|
}
|
|
685
614
|
export interface ListTicketsRequest {
|
|
686
615
|
/**
|
|
@@ -720,17 +649,7 @@ export interface ListTicketsRequest {
|
|
|
720
649
|
*/
|
|
721
650
|
updatedAfter?: Date;
|
|
722
651
|
}
|
|
723
|
-
export interface
|
|
724
|
-
/**
|
|
725
|
-
*
|
|
726
|
-
*/
|
|
727
|
-
bucketId: string;
|
|
728
|
-
/**
|
|
729
|
-
*
|
|
730
|
-
*/
|
|
731
|
-
lockRequest: LockRequest;
|
|
732
|
-
}
|
|
733
|
-
export interface MoveFileOperationRequest {
|
|
652
|
+
export interface MoveFileRequest {
|
|
734
653
|
/**
|
|
735
654
|
*
|
|
736
655
|
*/
|
|
@@ -742,17 +661,7 @@ export interface MoveFileOperationRequest {
|
|
|
742
661
|
/**
|
|
743
662
|
*
|
|
744
663
|
*/
|
|
745
|
-
|
|
746
|
-
}
|
|
747
|
-
export interface PrepareFileUploadOperationRequest {
|
|
748
|
-
/**
|
|
749
|
-
*
|
|
750
|
-
*/
|
|
751
|
-
bucketId: string;
|
|
752
|
-
/**
|
|
753
|
-
*
|
|
754
|
-
*/
|
|
755
|
-
prepareFileUploadRequest: PrepareFileUploadRequest;
|
|
664
|
+
fileMoveRequest: FileMoveRequest;
|
|
756
665
|
}
|
|
757
666
|
export interface PreviewBucketRequest {
|
|
758
667
|
/**
|
|
@@ -774,20 +683,6 @@ export interface PublishBucketRequest {
|
|
|
774
683
|
*/
|
|
775
684
|
publishRequest?: PublishRequest;
|
|
776
685
|
}
|
|
777
|
-
export interface RenameFileOperationRequest {
|
|
778
|
-
/**
|
|
779
|
-
*
|
|
780
|
-
*/
|
|
781
|
-
bucketId: string;
|
|
782
|
-
/**
|
|
783
|
-
*
|
|
784
|
-
*/
|
|
785
|
-
fileId: string;
|
|
786
|
-
/**
|
|
787
|
-
*
|
|
788
|
-
*/
|
|
789
|
-
renameFileRequest: RenameFileRequest;
|
|
790
|
-
}
|
|
791
686
|
export interface ReplyToTicketRequest {
|
|
792
687
|
/**
|
|
793
688
|
*
|
|
@@ -818,37 +713,13 @@ export interface RestoreFileVersionRequest {
|
|
|
818
713
|
*/
|
|
819
714
|
fileId: string;
|
|
820
715
|
/**
|
|
821
|
-
*
|
|
716
|
+
* A version ID of the file's version list.
|
|
822
717
|
*/
|
|
823
718
|
versionId: string;
|
|
824
719
|
/**
|
|
825
720
|
*
|
|
826
721
|
*/
|
|
827
|
-
actionRequest
|
|
828
|
-
}
|
|
829
|
-
export interface SaveUploadSessionBatchOperationRequest {
|
|
830
|
-
/**
|
|
831
|
-
*
|
|
832
|
-
*/
|
|
833
|
-
bucketId: string;
|
|
834
|
-
/**
|
|
835
|
-
* bucket_upload_session.id from the create response.
|
|
836
|
-
*/
|
|
837
|
-
sessionId: string;
|
|
838
|
-
/**
|
|
839
|
-
*
|
|
840
|
-
*/
|
|
841
|
-
saveUploadSessionBatchRequest?: SaveUploadSessionBatchRequest;
|
|
842
|
-
}
|
|
843
|
-
export interface SaveUploadedFileOperationRequest {
|
|
844
|
-
/**
|
|
845
|
-
*
|
|
846
|
-
*/
|
|
847
|
-
bucketId: string;
|
|
848
|
-
/**
|
|
849
|
-
*
|
|
850
|
-
*/
|
|
851
|
-
saveUploadedFileRequest: SaveUploadedFileRequest;
|
|
722
|
+
actionRequest?: ActionRequest;
|
|
852
723
|
}
|
|
853
724
|
export interface SetWebhookOperationRequest {
|
|
854
725
|
/**
|
|
@@ -880,16 +751,6 @@ export interface UnarchiveBucketRequest {
|
|
|
880
751
|
*/
|
|
881
752
|
actionRequest: ActionRequest;
|
|
882
753
|
}
|
|
883
|
-
export interface UnlockBucketRequest {
|
|
884
|
-
/**
|
|
885
|
-
*
|
|
886
|
-
*/
|
|
887
|
-
bucketId: string;
|
|
888
|
-
/**
|
|
889
|
-
*
|
|
890
|
-
*/
|
|
891
|
-
unlockRequest: UnlockRequest;
|
|
892
|
-
}
|
|
893
754
|
export interface UnpublishBucketRequest {
|
|
894
755
|
/**
|
|
895
756
|
*
|
|
@@ -936,38 +797,20 @@ export interface VerifySignInCodeOperationRequest {
|
|
|
936
797
|
*/
|
|
937
798
|
verifySignInCodeRequest: VerifySignInCodeRequest;
|
|
938
799
|
}
|
|
939
|
-
|
|
940
|
-
*
|
|
941
|
-
*/
|
|
942
|
-
export declare class DefaultApi extends runtime.BaseAPI {
|
|
943
|
-
/**
|
|
944
|
-
* Creates request options for addUploadSessionFiles without sending the request
|
|
945
|
-
*/
|
|
946
|
-
addUploadSessionFilesRequestOpts(requestParameters: AddUploadSessionFilesOperationRequest): Promise<runtime.RequestOpts>;
|
|
947
|
-
/**
|
|
948
|
-
* Returns upload.url and upload.headers for each file that needs bytes. Repeating a path returns a fresh target, for example after a failed PUT. Files with identical content are skipped.
|
|
949
|
-
* Get storage targets for a batch
|
|
950
|
-
*/
|
|
951
|
-
addUploadSessionFilesRaw(requestParameters: AddUploadSessionFilesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateUploadSession201Response>>;
|
|
952
|
-
/**
|
|
953
|
-
* Returns upload.url and upload.headers for each file that needs bytes. Repeating a path returns a fresh target, for example after a failed PUT. Files with identical content are skipped.
|
|
954
|
-
* Get storage targets for a batch
|
|
955
|
-
*/
|
|
956
|
-
addUploadSessionFiles(requestParameters: AddUploadSessionFilesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateUploadSession201Response>;
|
|
957
|
-
/**
|
|
958
|
-
* Creates request options for appendText without sending the request
|
|
959
|
-
*/
|
|
960
|
-
appendTextRequestOpts(requestParameters: AppendTextOperationRequest): Promise<runtime.RequestOpts>;
|
|
800
|
+
export interface WriteFileRequest {
|
|
961
801
|
/**
|
|
962
|
-
*
|
|
963
|
-
* Append text to a file
|
|
802
|
+
*
|
|
964
803
|
*/
|
|
965
|
-
|
|
804
|
+
bucketId: string;
|
|
966
805
|
/**
|
|
967
|
-
*
|
|
968
|
-
* Append text to a file
|
|
806
|
+
*
|
|
969
807
|
*/
|
|
970
|
-
|
|
808
|
+
fileWriteRequest: FileWriteRequest;
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
*
|
|
812
|
+
*/
|
|
813
|
+
export declare class DefaultApi extends runtime.BaseAPI {
|
|
971
814
|
/**
|
|
972
815
|
* Creates request options for archiveBucket without sending the request
|
|
973
816
|
*/
|
|
@@ -987,40 +830,26 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
987
830
|
*/
|
|
988
831
|
connectGithubRepositoryRequestOpts(requestParameters: ConnectGithubRepositoryOperationRequest): Promise<runtime.RequestOpts>;
|
|
989
832
|
/**
|
|
990
|
-
* Makes the bucket\'s files a copy of one branch of a repository, or of one folder of it. The first sync copies the files, and each later push to the branch updates them. A bucket that has files needs bucket_files: replace (the repository\'s files replace them)
|
|
833
|
+
* Makes the bucket\'s files a read-only copy of one branch of a repository, or of one folder of it. The first sync copies the files, and each later push to the branch updates them. Revdoku never writes to the repository. The copy is in the bucket folder _repo/. A bucket that has files there needs bucket_files: replace (the repository\'s files replace them); its knowledge base (_kb/), its tickets and its agent folders stay. GitHub is the source: change the files there. Needs an account owner or administrator key with admin access to all buckets. A connected GitHub account must read the repository: 403 GITHUB_APP_NOT_INSTALLED gives the links for the person in error.details.
|
|
991
834
|
* Connect a GitHub repository
|
|
992
835
|
*/
|
|
993
836
|
connectGithubRepositoryRaw(requestParameters: ConnectGithubRepositoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConnectGithubRepository201Response>>;
|
|
994
837
|
/**
|
|
995
|
-
* Makes the bucket\'s files a copy of one branch of a repository, or of one folder of it. The first sync copies the files, and each later push to the branch updates them. A bucket that has files needs bucket_files: replace (the repository\'s files replace them)
|
|
838
|
+
* Makes the bucket\'s files a read-only copy of one branch of a repository, or of one folder of it. The first sync copies the files, and each later push to the branch updates them. Revdoku never writes to the repository. The copy is in the bucket folder _repo/. A bucket that has files there needs bucket_files: replace (the repository\'s files replace them); its knowledge base (_kb/), its tickets and its agent folders stay. GitHub is the source: change the files there. Needs an account owner or administrator key with admin access to all buckets. A connected GitHub account must read the repository: 403 GITHUB_APP_NOT_INSTALLED gives the links for the person in error.details.
|
|
996
839
|
* Connect a GitHub repository
|
|
997
840
|
*/
|
|
998
841
|
connectGithubRepository(requestParameters: ConnectGithubRepositoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConnectGithubRepository201Response>;
|
|
999
|
-
/**
|
|
1000
|
-
* Creates request options for copyFile without sending the request
|
|
1001
|
-
*/
|
|
1002
|
-
copyFileRequestOpts(requestParameters: CopyFileRequest): Promise<runtime.RequestOpts>;
|
|
1003
|
-
/**
|
|
1004
|
-
* Works in the same bucket or into target_bucket_id. Content is not uploaded again. Send target_path for an exact path or target_folder to keep the name.
|
|
1005
|
-
* Copy a file
|
|
1006
|
-
*/
|
|
1007
|
-
copyFileRaw(requestParameters: CopyFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenameFile200Response>>;
|
|
1008
|
-
/**
|
|
1009
|
-
* Works in the same bucket or into target_bucket_id. Content is not uploaded again. Send target_path for an exact path or target_folder to keep the name.
|
|
1010
|
-
* Copy a file
|
|
1011
|
-
*/
|
|
1012
|
-
copyFile(requestParameters: CopyFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenameFile200Response>;
|
|
1013
842
|
/**
|
|
1014
843
|
* Creates request options for createBucket without sending the request
|
|
1015
844
|
*/
|
|
1016
845
|
createBucketRequestOpts(requestParameters: CreateBucketOperationRequest): Promise<runtime.RequestOpts>;
|
|
1017
846
|
/**
|
|
1018
|
-
* Waits until the address can receive email. On revdokumail.com, email.username is the bucket\'s name, with no suffix: lowercase letters, digits and single hyphens, 3 to 63 characters, also the name of its site. A name that another bucket uses as an address or a site address, or that another account used, returns EMAIL_ALREADY_EXISTS; your account can use its own earlier names again. Without email.username the address takes the title\'s name when it is free, else two readable words. A custom domain takes the exact name. If confirmation does not finish, EMAIL_NOT_READY returns the created bucket_id in error.details: read that bucket instead of creating another. The title defaults to email.username; a title that another active bucket uses returns 409 BUCKET_TITLE_TAKEN.
|
|
847
|
+
* Waits until the address can receive email. On revdokumail.com, email.username is the bucket\'s name, with no suffix: lowercase letters, digits and single hyphens, 3 to 63 characters, also the name of its site. A name that another bucket uses as an address or a site address, or that another account used, returns EMAIL_ALREADY_EXISTS; your account can use its own earlier names again. Without email.username the address takes the title\'s name when it is free, else two readable words. A custom domain takes the exact name. If confirmation does not finish, EMAIL_NOT_READY returns the created bucket_id in error.details: read that bucket instead of creating another. The title defaults to email.username; a title that another active bucket uses returns 409 BUCKET_TITLE_TAKEN. Its files come from a GitHub repository: connect one with the GitHub operations. Never retry a creation automatically.
|
|
1019
848
|
* Create a bucket
|
|
1020
849
|
*/
|
|
1021
850
|
createBucketRaw(requestParameters: CreateBucketOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBucket201Response>>;
|
|
1022
851
|
/**
|
|
1023
|
-
* Waits until the address can receive email. On revdokumail.com, email.username is the bucket\'s name, with no suffix: lowercase letters, digits and single hyphens, 3 to 63 characters, also the name of its site. A name that another bucket uses as an address or a site address, or that another account used, returns EMAIL_ALREADY_EXISTS; your account can use its own earlier names again. Without email.username the address takes the title\'s name when it is free, else two readable words. A custom domain takes the exact name. If confirmation does not finish, EMAIL_NOT_READY returns the created bucket_id in error.details: read that bucket instead of creating another. The title defaults to email.username; a title that another active bucket uses returns 409 BUCKET_TITLE_TAKEN.
|
|
852
|
+
* Waits until the address can receive email. On revdokumail.com, email.username is the bucket\'s name, with no suffix: lowercase letters, digits and single hyphens, 3 to 63 characters, also the name of its site. A name that another bucket uses as an address or a site address, or that another account used, returns EMAIL_ALREADY_EXISTS; your account can use its own earlier names again. Without email.username the address takes the title\'s name when it is free, else two readable words. A custom domain takes the exact name. If confirmation does not finish, EMAIL_NOT_READY returns the created bucket_id in error.details: read that bucket instead of creating another. The title defaults to email.username; a title that another active bucket uses returns 409 BUCKET_TITLE_TAKEN. Its files come from a GitHub repository: connect one with the GitHub operations. Never retry a creation automatically.
|
|
1024
853
|
* Create a bucket
|
|
1025
854
|
*/
|
|
1026
855
|
createBucket(requestParameters: CreateBucketOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBucket201Response>;
|
|
@@ -1053,19 +882,19 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1053
882
|
*/
|
|
1054
883
|
createDashboardLink(requestParameters: CreateDashboardLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDashboardLink201Response>;
|
|
1055
884
|
/**
|
|
1056
|
-
* Creates request options for
|
|
885
|
+
* Creates request options for createFileUpload without sending the request
|
|
1057
886
|
*/
|
|
1058
|
-
|
|
887
|
+
createFileUploadRequestOpts(requestParameters: CreateFileUploadRequest): Promise<runtime.RequestOpts>;
|
|
1059
888
|
/**
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
889
|
+
* Requires bucket write permission. For an image of the knowledge base that is larger than 256 KB, or for a client that sends files itself. Send the bytes with PUT to upload.url with upload.headers, then call POST /files with path and signed_blob_id. The link works for one hour. The size limit is the account\'s file size limit. A path outside _kb/ or another file type returns 422 KB_PATH_REQUIRED or KB_FILE_TYPE_UNSUPPORTED, and a file above the limit 413 FILE_TOO_LARGE.
|
|
890
|
+
* Get an upload link for an image
|
|
1062
891
|
*/
|
|
1063
|
-
|
|
892
|
+
createFileUploadRaw(requestParameters: CreateFileUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateFileUpload201Response>>;
|
|
1064
893
|
/**
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
894
|
+
* Requires bucket write permission. For an image of the knowledge base that is larger than 256 KB, or for a client that sends files itself. Send the bytes with PUT to upload.url with upload.headers, then call POST /files with path and signed_blob_id. The link works for one hour. The size limit is the account\'s file size limit. A path outside _kb/ or another file type returns 422 KB_PATH_REQUIRED or KB_FILE_TYPE_UNSUPPORTED, and a file above the limit 413 FILE_TOO_LARGE.
|
|
895
|
+
* Get an upload link for an image
|
|
1067
896
|
*/
|
|
1068
|
-
|
|
897
|
+
createFileUpload(requestParameters: CreateFileUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateFileUpload201Response>;
|
|
1069
898
|
/**
|
|
1070
899
|
* Creates request options for deleteBucket without sending the request
|
|
1071
900
|
*/
|
|
@@ -1085,13 +914,13 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1085
914
|
*/
|
|
1086
915
|
deleteFileRequestOpts(requestParameters: DeleteFileRequest): Promise<runtime.RequestOpts>;
|
|
1087
916
|
/**
|
|
1088
|
-
* Requires bucket
|
|
1089
|
-
* Delete a file
|
|
917
|
+
* Requires bucket write permission, and publish permission for a file in _kb/public/. Deletes one file of the knowledge base. Its versions stay: keep the file ID of the answer, list the versions with GET /files/{file_id}/versions and restore one to bring the file back. A path outside _kb/ returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
918
|
+
* Delete a knowledge base file
|
|
1090
919
|
*/
|
|
1091
920
|
deleteFileRaw(requestParameters: DeleteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteBucket200Response>>;
|
|
1092
921
|
/**
|
|
1093
|
-
* Requires bucket
|
|
1094
|
-
* Delete a file
|
|
922
|
+
* Requires bucket write permission, and publish permission for a file in _kb/public/. Deletes one file of the knowledge base. Its versions stay: keep the file ID of the answer, list the versions with GET /files/{file_id}/versions and restore one to bring the file back. A path outside _kb/ returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
923
|
+
* Delete a knowledge base file
|
|
1095
924
|
*/
|
|
1096
925
|
deleteFile(requestParameters: DeleteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteBucket200Response>;
|
|
1097
926
|
/**
|
|
@@ -1150,20 +979,6 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1150
979
|
* Exchange a one-time dashboard connection code for an API key
|
|
1151
980
|
*/
|
|
1152
981
|
exchangeConnectionGrant(requestParameters: ExchangeConnectionGrantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerifySignInCode201Response>;
|
|
1153
|
-
/**
|
|
1154
|
-
* Creates request options for finalizeUploadSession without sending the request
|
|
1155
|
-
*/
|
|
1156
|
-
finalizeUploadSessionRequestOpts(requestParameters: FinalizeUploadSessionOperationRequest): Promise<runtime.RequestOpts>;
|
|
1157
|
-
/**
|
|
1158
|
-
* complete=true saves the remaining uploaded files, creates one bucket version and releases the lock. A 202 response with finalize_pending=true means more files remain: call finalize again after Retry-After. complete=false cancels the session and discards its unsaved files. Finalizing a finished session returns it unchanged.
|
|
1159
|
-
* Finish or cancel a batch upload
|
|
1160
|
-
*/
|
|
1161
|
-
finalizeUploadSessionRaw(requestParameters: FinalizeUploadSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateUploadSession201Response>>;
|
|
1162
|
-
/**
|
|
1163
|
-
* complete=true saves the remaining uploaded files, creates one bucket version and releases the lock. A 202 response with finalize_pending=true means more files remain: call finalize again after Retry-After. complete=false cancels the session and discards its unsaved files. Finalizing a finished session returns it unchanged.
|
|
1164
|
-
* Finish or cancel a batch upload
|
|
1165
|
-
*/
|
|
1166
|
-
finalizeUploadSession(requestParameters: FinalizeUploadSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateUploadSession201Response>;
|
|
1167
982
|
/**
|
|
1168
983
|
* Creates request options for getAccount without sending the request
|
|
1169
984
|
*/
|
|
@@ -1463,12 +1278,12 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1463
1278
|
*/
|
|
1464
1279
|
listFilesRequestOpts(requestParameters: ListFilesRequest): Promise<runtime.RequestOpts>;
|
|
1465
1280
|
/**
|
|
1466
|
-
* Lists current files,
|
|
1281
|
+
* Lists current files with their real paths: _repo/ holds the read-only copy of the GitHub repository, and _kb/ holds the knowledge base (_kb/public/ and _kb/private/). Listing never marks files read.
|
|
1467
1282
|
* List files
|
|
1468
1283
|
*/
|
|
1469
1284
|
listFilesRaw(requestParameters: ListFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFiles200Response>>;
|
|
1470
1285
|
/**
|
|
1471
|
-
* Lists current files,
|
|
1286
|
+
* Lists current files with their real paths: _repo/ holds the read-only copy of the GitHub repository, and _kb/ holds the knowledge base (_kb/public/ and _kb/private/). Listing never marks files read.
|
|
1472
1287
|
* List files
|
|
1473
1288
|
*/
|
|
1474
1289
|
listFiles(requestParameters: ListFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFiles200Response>;
|
|
@@ -1542,48 +1357,20 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1542
1357
|
* List tickets
|
|
1543
1358
|
*/
|
|
1544
1359
|
listTickets(requestParameters: ListTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListTickets200Response>;
|
|
1545
|
-
/**
|
|
1546
|
-
* Creates request options for lockBucket without sending the request
|
|
1547
|
-
*/
|
|
1548
|
-
lockBucketRequestOpts(requestParameters: LockBucketRequest): Promise<runtime.RequestOpts>;
|
|
1549
|
-
/**
|
|
1550
|
-
* Tells other people and agents to wait while you edit. Without paths it locks the whole bucket and requires bucket-admin permission; with paths it locks those files and requires write permission. Others get 423 BUCKET_LOCKED or FILE_LOCKED until you unlock or the lock expires. A lock of someone else also returns 423. Locks never block incoming email. A batch upload (upload_sessions) locks the bucket by itself until it finishes. The MCP tool bucket_lock has the same contract.
|
|
1551
|
-
* Lock a bucket or some of its files
|
|
1552
|
-
*/
|
|
1553
|
-
lockBucketRaw(requestParameters: LockBucketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LockBucket200Response>>;
|
|
1554
|
-
/**
|
|
1555
|
-
* Tells other people and agents to wait while you edit. Without paths it locks the whole bucket and requires bucket-admin permission; with paths it locks those files and requires write permission. Others get 423 BUCKET_LOCKED or FILE_LOCKED until you unlock or the lock expires. A lock of someone else also returns 423. Locks never block incoming email. A batch upload (upload_sessions) locks the bucket by itself until it finishes. The MCP tool bucket_lock has the same contract.
|
|
1556
|
-
* Lock a bucket or some of its files
|
|
1557
|
-
*/
|
|
1558
|
-
lockBucket(requestParameters: LockBucketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LockBucket200Response>;
|
|
1559
1360
|
/**
|
|
1560
1361
|
* Creates request options for moveFile without sending the request
|
|
1561
1362
|
*/
|
|
1562
|
-
moveFileRequestOpts(requestParameters:
|
|
1563
|
-
/**
|
|
1564
|
-
* Works in the same bucket or into target_bucket_id. Content is not uploaded again. Send target_path for an exact path or target_folder to keep the name.
|
|
1565
|
-
* Move a file
|
|
1566
|
-
*/
|
|
1567
|
-
moveFileRaw(requestParameters: MoveFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenameFile200Response>>;
|
|
1568
|
-
/**
|
|
1569
|
-
* Works in the same bucket or into target_bucket_id. Content is not uploaded again. Send target_path for an exact path or target_folder to keep the name.
|
|
1570
|
-
* Move a file
|
|
1571
|
-
*/
|
|
1572
|
-
moveFile(requestParameters: MoveFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenameFile200Response>;
|
|
1363
|
+
moveFileRequestOpts(requestParameters: MoveFileRequest): Promise<runtime.RequestOpts>;
|
|
1573
1364
|
/**
|
|
1574
|
-
*
|
|
1365
|
+
* Requires bucket write permission. Moves one file inside the knowledge base to new_path: a new name (a rename), another folder, or from _kb/private/ to _kb/public/ and back. A move to or from _kb/public/ needs publish permission (403 KB_PUBLISH_PERMISSION_REQUIRED). The file keeps its ID and its versions. A file at the new path returns 409 BUCKET_FILE_PATH_EXISTS. The site changes after the next publish. A path outside _kb/ returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
1366
|
+
* Move or rename a knowledge base file
|
|
1575
1367
|
*/
|
|
1576
|
-
|
|
1368
|
+
moveFileRaw(requestParameters: MoveFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MoveFile200Response>>;
|
|
1577
1369
|
/**
|
|
1578
|
-
*
|
|
1579
|
-
*
|
|
1370
|
+
* Requires bucket write permission. Moves one file inside the knowledge base to new_path: a new name (a rename), another folder, or from _kb/private/ to _kb/public/ and back. A move to or from _kb/public/ needs publish permission (403 KB_PUBLISH_PERMISSION_REQUIRED). The file keeps its ID and its versions. A file at the new path returns 409 BUCKET_FILE_PATH_EXISTS. The site changes after the next publish. A path outside _kb/ returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
1371
|
+
* Move or rename a knowledge base file
|
|
1580
1372
|
*/
|
|
1581
|
-
|
|
1582
|
-
/**
|
|
1583
|
-
* Returns a storage URL. Then PUT the bytes to direct_upload.url with exactly direct_upload.headers and no API key (step 2), and save the file with POST /v1/buckets/{bucket_id}/files (step 3). Identical content at the same path returns skipped=true and duplicate=true without an upload.
|
|
1584
|
-
* Prepare a file upload (step 1 of 3)
|
|
1585
|
-
*/
|
|
1586
|
-
prepareFileUpload(requestParameters: PrepareFileUploadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PrepareFileUpload201Response>;
|
|
1373
|
+
moveFile(requestParameters: MoveFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MoveFile200Response>;
|
|
1587
1374
|
/**
|
|
1588
1375
|
* Creates request options for previewBucket without sending the request
|
|
1589
1376
|
*/
|
|
@@ -1612,20 +1399,6 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1612
1399
|
* Publish the site
|
|
1613
1400
|
*/
|
|
1614
1401
|
publishBucket(requestParameters: PublishBucketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublishBucket202Response>;
|
|
1615
|
-
/**
|
|
1616
|
-
* Creates request options for renameFile without sending the request
|
|
1617
|
-
*/
|
|
1618
|
-
renameFileRequestOpts(requestParameters: RenameFileOperationRequest): Promise<runtime.RequestOpts>;
|
|
1619
|
-
/**
|
|
1620
|
-
* Changes the path without uploading the content again.
|
|
1621
|
-
* Rename or move a file in the same bucket
|
|
1622
|
-
*/
|
|
1623
|
-
renameFileRaw(requestParameters: RenameFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenameFile200Response>>;
|
|
1624
|
-
/**
|
|
1625
|
-
* Changes the path without uploading the content again.
|
|
1626
|
-
* Rename or move a file in the same bucket
|
|
1627
|
-
*/
|
|
1628
|
-
renameFile(requestParameters: RenameFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenameFile200Response>;
|
|
1629
1402
|
/**
|
|
1630
1403
|
* Creates request options for replyToTicket without sending the request
|
|
1631
1404
|
*/
|
|
@@ -1659,43 +1432,15 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1659
1432
|
*/
|
|
1660
1433
|
restoreFileVersionRequestOpts(requestParameters: RestoreFileVersionRequest): Promise<runtime.RequestOpts>;
|
|
1661
1434
|
/**
|
|
1662
|
-
*
|
|
1435
|
+
* Requires bucket write permission, and publish permission for a file in _kb/public/. Makes an earlier version of a knowledge base file the current one, as a new version. A deleted file comes back with it: use the file ID that the delete returned. When another file took its path meanwhile, the answer is 409 BUCKET_FILE_PATH_EXISTS. The current version returns 422 FILE_VERSION_ALREADY_CURRENT. A path outside _kb/ returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
1663
1436
|
* Restore a file version
|
|
1664
1437
|
*/
|
|
1665
1438
|
restoreFileVersionRaw(requestParameters: RestoreFileVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RestoreFileVersion201Response>>;
|
|
1666
1439
|
/**
|
|
1667
|
-
*
|
|
1440
|
+
* Requires bucket write permission, and publish permission for a file in _kb/public/. Makes an earlier version of a knowledge base file the current one, as a new version. A deleted file comes back with it: use the file ID that the delete returned. When another file took its path meanwhile, the answer is 409 BUCKET_FILE_PATH_EXISTS. The current version returns 422 FILE_VERSION_ALREADY_CURRENT. A path outside _kb/ returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
1668
1441
|
* Restore a file version
|
|
1669
1442
|
*/
|
|
1670
1443
|
restoreFileVersion(requestParameters: RestoreFileVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RestoreFileVersion201Response>;
|
|
1671
|
-
/**
|
|
1672
|
-
* Creates request options for saveUploadSessionBatch without sending the request
|
|
1673
|
-
*/
|
|
1674
|
-
saveUploadSessionBatchRequestOpts(requestParameters: SaveUploadSessionBatchOperationRequest): Promise<runtime.RequestOpts>;
|
|
1675
|
-
/**
|
|
1676
|
-
* Saves up to limit files whose bytes were uploaded. Call it after each batch to keep each request short. DIRECT_UPLOAD_NOT_FOUND names a file whose bytes are missing in error.details.path; upload it again and retry.
|
|
1677
|
-
* Save uploaded files
|
|
1678
|
-
*/
|
|
1679
|
-
saveUploadSessionBatchRaw(requestParameters: SaveUploadSessionBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateUploadSession201Response>>;
|
|
1680
|
-
/**
|
|
1681
|
-
* Saves up to limit files whose bytes were uploaded. Call it after each batch to keep each request short. DIRECT_UPLOAD_NOT_FOUND names a file whose bytes are missing in error.details.path; upload it again and retry.
|
|
1682
|
-
* Save uploaded files
|
|
1683
|
-
*/
|
|
1684
|
-
saveUploadSessionBatch(requestParameters: SaveUploadSessionBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateUploadSession201Response>;
|
|
1685
|
-
/**
|
|
1686
|
-
* Creates request options for saveUploadedFile without sending the request
|
|
1687
|
-
*/
|
|
1688
|
-
saveUploadedFileRequestOpts(requestParameters: SaveUploadedFileOperationRequest): Promise<runtime.RequestOpts>;
|
|
1689
|
-
/**
|
|
1690
|
-
* Saves the uploaded blob at path. An existing path gets a new version.
|
|
1691
|
-
* Save an uploaded file (step 3 of 3)
|
|
1692
|
-
*/
|
|
1693
|
-
saveUploadedFileRaw(requestParameters: SaveUploadedFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveUploadedFile201Response>>;
|
|
1694
|
-
/**
|
|
1695
|
-
* Saves the uploaded blob at path. An existing path gets a new version.
|
|
1696
|
-
* Save an uploaded file (step 3 of 3)
|
|
1697
|
-
*/
|
|
1698
|
-
saveUploadedFile(requestParameters: SaveUploadedFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveUploadedFile201Response>;
|
|
1699
1444
|
/**
|
|
1700
1445
|
* Creates request options for setWebhook without sending the request
|
|
1701
1446
|
*/
|
|
@@ -1738,20 +1483,6 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1738
1483
|
* Unarchive a bucket
|
|
1739
1484
|
*/
|
|
1740
1485
|
unarchiveBucket(requestParameters: UnarchiveBucketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBucket201Response>;
|
|
1741
|
-
/**
|
|
1742
|
-
* Creates request options for unlockBucket without sending the request
|
|
1743
|
-
*/
|
|
1744
|
-
unlockBucketRequestOpts(requestParameters: UnlockBucketRequest): Promise<runtime.RequestOpts>;
|
|
1745
|
-
/**
|
|
1746
|
-
* Removes your lock of the whole bucket (bucket-admin permission) or of the listed files (write permission). A lock of someone else, a running batch upload or a deletion returns 423 BUCKET_LOCKED or FILE_LOCKED. Unlocking an unlocked bucket returns its lock state.
|
|
1747
|
-
* Remove your lock
|
|
1748
|
-
*/
|
|
1749
|
-
unlockBucketRaw(requestParameters: UnlockBucketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LockBucket200Response>>;
|
|
1750
|
-
/**
|
|
1751
|
-
* Removes your lock of the whole bucket (bucket-admin permission) or of the listed files (write permission). A lock of someone else, a running batch upload or a deletion returns 423 BUCKET_LOCKED or FILE_LOCKED. Unlocking an unlocked bucket returns its lock state.
|
|
1752
|
-
* Remove your lock
|
|
1753
|
-
*/
|
|
1754
|
-
unlockBucket(requestParameters: UnlockBucketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LockBucket200Response>;
|
|
1755
1486
|
/**
|
|
1756
1487
|
* Creates request options for unpublishBucket without sending the request
|
|
1757
1488
|
*/
|
|
@@ -1785,12 +1516,12 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1785
1516
|
*/
|
|
1786
1517
|
updateGithubSyncRequestOpts(requestParameters: UpdateGithubSyncOperationRequest): Promise<runtime.RequestOpts>;
|
|
1787
1518
|
/**
|
|
1788
|
-
* Sets auto_publish
|
|
1519
|
+
* Sets auto_publish: whether the site publishes again after each sync. Needs an account owner or administrator key with admin access to all buckets.
|
|
1789
1520
|
* Change GitHub sync settings
|
|
1790
1521
|
*/
|
|
1791
1522
|
updateGithubSyncRaw(requestParameters: UpdateGithubSyncOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConnectGithubRepository201Response>>;
|
|
1792
1523
|
/**
|
|
1793
|
-
* Sets auto_publish
|
|
1524
|
+
* Sets auto_publish: whether the site publishes again after each sync. Needs an account owner or administrator key with admin access to all buckets.
|
|
1794
1525
|
* Change GitHub sync settings
|
|
1795
1526
|
*/
|
|
1796
1527
|
updateGithubSync(requestParameters: UpdateGithubSyncOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConnectGithubRepository201Response>;
|
|
@@ -1799,13 +1530,13 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1799
1530
|
*/
|
|
1800
1531
|
updateTicketRequestOpts(requestParameters: UpdateTicketRequest): Promise<runtime.RequestOpts>;
|
|
1801
1532
|
/**
|
|
1802
|
-
* Requires bucket write permission. status
|
|
1803
|
-
*
|
|
1533
|
+
* Requires bucket write permission. status is open, pending (it waits for the requester) or solved; it changes every ticket of a merged conversation. internal_note sets the team\'s note on the ticket: it is never sent to the requester, and a change of it is no activity of the ticket. add_labels labels the first message; remove_labels removes the labels from every message. Built-in labels such as Junk change only in the dashboard. While an agent works on a message, a label change returns 423 EMAIL_LOCKED.
|
|
1534
|
+
* Change a ticket: status, internal note or labels
|
|
1804
1535
|
*/
|
|
1805
1536
|
updateTicketRaw(requestParameters: UpdateTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTicket200Response>>;
|
|
1806
1537
|
/**
|
|
1807
|
-
* Requires bucket write permission. status
|
|
1808
|
-
*
|
|
1538
|
+
* Requires bucket write permission. status is open, pending (it waits for the requester) or solved; it changes every ticket of a merged conversation. internal_note sets the team\'s note on the ticket: it is never sent to the requester, and a change of it is no activity of the ticket. add_labels labels the first message; remove_labels removes the labels from every message. Built-in labels such as Junk change only in the dashboard. While an agent works on a message, a label change returns 423 EMAIL_LOCKED.
|
|
1539
|
+
* Change a ticket: status, internal note or labels
|
|
1809
1540
|
*/
|
|
1810
1541
|
updateTicket(requestParameters: UpdateTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTicket200Response>;
|
|
1811
1542
|
/**
|
|
@@ -1822,6 +1553,20 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
1822
1553
|
* Exchange a sign-in code for an API key
|
|
1823
1554
|
*/
|
|
1824
1555
|
verifySignInCode(requestParameters: VerifySignInCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerifySignInCode201Response>;
|
|
1556
|
+
/**
|
|
1557
|
+
* Creates request options for writeFile without sending the request
|
|
1558
|
+
*/
|
|
1559
|
+
writeFileRequestOpts(requestParameters: WriteFileRequest): Promise<runtime.RequestOpts>;
|
|
1560
|
+
/**
|
|
1561
|
+
* Requires bucket write permission. The knowledge base is the bucket folder _kb/: _kb/public/ is published with the site, and _kb/private/ is never published. Every other file of a bucket is read-only: the files of _repo/ change on GitHub. Send one of content (a page), content_base64 (a small image) or signed_blob_id (an uploaded image). A file at the path gets a new version. A file in _kb/public/ needs publish permission; without it the answer is 403 KB_PUBLISH_PERMISSION_REQUIRED. A write never publishes: the site shows a public file after the next publish. Another path returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH, and another file type 422 KB_FILE_TYPE_UNSUPPORTED. A page of _kb/public/ with the front matter line do_not_publish: true stays off the site, and the site\'s AI Support Agent still answers visitors from it: put only facts that visitors may know there, never secrets. A file above the account\'s file size limit returns 413 FILE_TOO_LARGE. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
1562
|
+
* Write a knowledge base file
|
|
1563
|
+
*/
|
|
1564
|
+
writeFileRaw(requestParameters: WriteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WriteFile201Response>>;
|
|
1565
|
+
/**
|
|
1566
|
+
* Requires bucket write permission. The knowledge base is the bucket folder _kb/: _kb/public/ is published with the site, and _kb/private/ is never published. Every other file of a bucket is read-only: the files of _repo/ change on GitHub. Send one of content (a page), content_base64 (a small image) or signed_blob_id (an uploaded image). A file at the path gets a new version. A file in _kb/public/ needs publish permission; without it the answer is 403 KB_PUBLISH_PERMISSION_REQUIRED. A write never publishes: the site shows a public file after the next publish. Another path returns 422 KB_PATH_REQUIRED, SYNCED_COPY_READ_ONLY or RESERVED_PATH, and another file type 422 KB_FILE_TYPE_UNSUPPORTED. A page of _kb/public/ with the front matter line do_not_publish: true stays off the site, and the site\'s AI Support Agent still answers visitors from it: put only facts that visitors may know there, never secrets. A file above the account\'s file size limit returns 413 FILE_TOO_LARGE. A locked bucket or file returns 423 BUCKET_LOCKED or FILE_LOCKED.
|
|
1567
|
+
* Write a knowledge base file
|
|
1568
|
+
*/
|
|
1569
|
+
writeFile(requestParameters: WriteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WriteFile201Response>;
|
|
1825
1570
|
}
|
|
1826
1571
|
/**
|
|
1827
1572
|
* @export
|
|
@@ -1877,6 +1622,7 @@ export type ListBucketsStatusEnum = typeof ListBucketsStatusEnum[keyof typeof Li
|
|
|
1877
1622
|
*/
|
|
1878
1623
|
export declare const ListTicketsStatusEnum: {
|
|
1879
1624
|
readonly Open: "open";
|
|
1625
|
+
readonly Pending: "pending";
|
|
1880
1626
|
readonly Solved: "solved";
|
|
1881
1627
|
readonly All: "all";
|
|
1882
1628
|
};
|