linkbreakers 1.177.2 → 1.179.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/dist/apis/APIScopesApi.d.ts +1 -1
- package/dist/apis/APIScopesApi.js +1 -1
- package/dist/apis/AgentIdentityApi.d.ts +1 -1
- package/dist/apis/AgentIdentityApi.js +1 -1
- package/dist/apis/AllowancesApi.d.ts +1 -1
- package/dist/apis/AllowancesApi.js +1 -1
- package/dist/apis/AnalyticsDashboardApi.d.ts +1 -1
- package/dist/apis/AnalyticsDashboardApi.js +1 -1
- package/dist/apis/AnalyticsDataApi.d.ts +1 -1
- package/dist/apis/AnalyticsDataApi.js +1 -1
- package/dist/apis/AssistantApi.d.ts +91 -6
- package/dist/apis/AssistantApi.js +107 -3
- package/dist/apis/CustomDomainsApi.d.ts +1 -1
- package/dist/apis/CustomDomainsApi.js +1 -1
- package/dist/apis/DirectoriesApi.d.ts +1 -1
- package/dist/apis/DirectoriesApi.js +1 -1
- package/dist/apis/EventsApi.d.ts +1 -1
- package/dist/apis/EventsApi.js +1 -1
- package/dist/apis/GoogleFormsIntegrationsApi.d.ts +1 -1
- package/dist/apis/GoogleFormsIntegrationsApi.js +1 -1
- package/dist/apis/IntegrationsServiceApi.d.ts +1 -1
- package/dist/apis/IntegrationsServiceApi.js +1 -1
- package/dist/apis/JobsApi.d.ts +1 -1
- package/dist/apis/JobsApi.js +1 -1
- package/dist/apis/LinkSettingsApi.d.ts +1 -1
- package/dist/apis/LinkSettingsApi.js +1 -1
- package/dist/apis/LinksApi.d.ts +22 -22
- package/dist/apis/LinksApi.js +16 -16
- package/dist/apis/MediaApi.d.ts +64 -20
- package/dist/apis/MediaApi.js +62 -9
- package/dist/apis/MembersApi.d.ts +1 -1
- package/dist/apis/MembersApi.js +1 -1
- package/dist/apis/PageThemeTemplatesApi.d.ts +1 -1
- package/dist/apis/PageThemeTemplatesApi.js +1 -1
- package/dist/apis/PageThemesApi.d.ts +1 -1
- package/dist/apis/PageThemesApi.js +1 -1
- package/dist/apis/PricingApi.d.ts +1 -1
- package/dist/apis/PricingApi.js +1 -1
- package/dist/apis/QRCodeDesignsApi.d.ts +1 -1
- package/dist/apis/QRCodeDesignsApi.js +1 -1
- package/dist/apis/QRCodeTemplatesApi.d.ts +1 -1
- package/dist/apis/QRCodeTemplatesApi.js +1 -1
- package/dist/apis/SandboxesApi.d.ts +1 -1
- package/dist/apis/SandboxesApi.js +1 -1
- package/dist/apis/SlackIntegrationsApi.d.ts +1 -1
- package/dist/apis/SlackIntegrationsApi.js +1 -1
- package/dist/apis/TagsApi.d.ts +1 -1
- package/dist/apis/TagsApi.js +1 -1
- package/dist/apis/TimeSeriesApi.d.ts +1 -1
- package/dist/apis/TimeSeriesApi.js +1 -1
- package/dist/apis/VisitorsApi.d.ts +1 -1
- package/dist/apis/VisitorsApi.js +1 -1
- package/dist/apis/WebhooksApi.d.ts +1 -1
- package/dist/apis/WebhooksApi.js +1 -1
- package/dist/apis/WorkflowStepsApi.d.ts +1 -1
- package/dist/apis/WorkflowStepsApi.js +1 -1
- package/dist/apis/WorkspaceMetricsApi.d.ts +1 -1
- package/dist/apis/WorkspaceMetricsApi.js +1 -1
- package/dist/apis/WorkspaceTokensApi.d.ts +1 -1
- package/dist/apis/WorkspaceTokensApi.js +1 -1
- package/dist/apis/WorkspacesApi.d.ts +1 -1
- package/dist/apis/WorkspacesApi.js +1 -1
- package/dist/models/Action.d.ts +1 -1
- package/dist/models/Action.js +1 -1
- package/dist/models/AgentClaim.d.ts +1 -1
- package/dist/models/AgentClaim.js +1 -1
- package/dist/models/AgentClaimStatus.d.ts +1 -1
- package/dist/models/AgentClaimStatus.js +1 -1
- package/dist/models/AnalyticsDashboard.d.ts +1 -1
- package/dist/models/AnalyticsDashboard.js +1 -1
- package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.d.ts +1 -1
- package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.js +1 -1
- package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.d.ts +1 -1
- package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.js +1 -1
- package/dist/models/AnalyticsWidgetResult.d.ts +1 -1
- package/dist/models/AnalyticsWidgetResult.js +1 -1
- package/dist/models/ApiScope.d.ts +1 -1
- package/dist/models/ApiScope.js +1 -1
- package/dist/models/ApiScopeAccess.d.ts +1 -1
- package/dist/models/ApiScopeAccess.js +1 -1
- package/dist/models/ApiScopeInfo.d.ts +1 -1
- package/dist/models/ApiScopeInfo.js +1 -1
- package/dist/models/ApiTag.d.ts +1 -1
- package/dist/models/ApiTag.js +1 -1
- package/dist/models/ApplyPageThemeTemplateRequest.d.ts +1 -1
- package/dist/models/ApplyPageThemeTemplateRequest.js +1 -1
- package/dist/models/ApplyPageThemeTemplateResponse.d.ts +1 -1
- package/dist/models/ApplyPageThemeTemplateResponse.js +1 -1
- package/dist/models/ApplyQrcodeTemplateRequest.d.ts +1 -1
- package/dist/models/ApplyQrcodeTemplateRequest.js +1 -1
- package/dist/models/ApplyQrcodeTemplateResponse.d.ts +1 -1
- package/dist/models/ApplyQrcodeTemplateResponse.js +1 -1
- package/dist/models/AssistantCompleteAttachmentUploadResponse.d.ts +50 -0
- package/dist/models/AssistantCompleteAttachmentUploadResponse.js +54 -0
- package/dist/models/AssistantContextType.d.ts +1 -1
- package/dist/models/AssistantContextType.js +1 -1
- package/dist/models/AssistantCreateAttachmentUploadRequest.d.ts +45 -0
- package/dist/models/AssistantCreateAttachmentUploadRequest.js +56 -0
- package/dist/models/AssistantCreateAttachmentUploadResponse.d.ts +58 -0
- package/dist/models/AssistantCreateAttachmentUploadResponse.js +56 -0
- package/dist/models/AssistantDisplayMessage.d.ts +1 -1
- package/dist/models/AssistantDisplayMessage.js +1 -1
- package/dist/models/AssistantDisplayMessageAttachment.d.ts +1 -1
- package/dist/models/AssistantDisplayMessageAttachment.js +1 -1
- package/dist/models/AssistantGetConversationResponse.d.ts +1 -1
- package/dist/models/AssistantGetConversationResponse.js +1 -1
- package/dist/models/AssistantMarkConversationReadRequest.d.ts +1 -1
- package/dist/models/AssistantMarkConversationReadRequest.js +1 -1
- package/dist/models/AssistantMarkConversationReadResponse.d.ts +1 -1
- package/dist/models/AssistantMarkConversationReadResponse.js +1 -1
- package/dist/models/AssistantUploadFileRequest.d.ts +1 -1
- package/dist/models/AssistantUploadFileRequest.js +1 -1
- package/dist/models/AssistantUploadFileResponse.d.ts +1 -1
- package/dist/models/AssistantUploadFileResponse.js +1 -1
- package/dist/models/AttributeCapture.d.ts +1 -1
- package/dist/models/AttributeCapture.js +1 -1
- package/dist/models/AttributeValueDataPoint.d.ts +1 -1
- package/dist/models/AttributeValueDataPoint.js +1 -1
- package/dist/models/AttributeValueEntry.d.ts +1 -1
- package/dist/models/AttributeValueEntry.js +1 -1
- package/dist/models/AttributeWrite.d.ts +1 -1
- package/dist/models/AttributeWrite.js +1 -1
- package/dist/models/AttributeWriteMode.d.ts +1 -1
- package/dist/models/AttributeWriteMode.js +1 -1
- package/dist/models/AutoLayoutWorkflowResponse.d.ts +1 -1
- package/dist/models/AutoLayoutWorkflowResponse.js +1 -1
- package/dist/models/BackButton.d.ts +1 -1
- package/dist/models/BackButton.js +1 -1
- package/dist/models/BackgroundOptions.d.ts +1 -1
- package/dist/models/BackgroundOptions.js +1 -1
- package/dist/models/BillingInterval.d.ts +1 -1
- package/dist/models/BillingInterval.js +1 -1
- package/dist/models/BreakdownDataPoint.d.ts +1 -1
- package/dist/models/BreakdownDataPoint.js +1 -1
- package/dist/models/CanvasPosition.d.ts +1 -1
- package/dist/models/CanvasPosition.js +1 -1
- package/dist/models/ChatDisplayMessage.d.ts +1 -1
- package/dist/models/ChatDisplayMessage.js +1 -1
- package/dist/models/ChatUIAction.d.ts +1 -1
- package/dist/models/ChatUIAction.js +1 -1
- package/dist/models/ChatUIOption.d.ts +1 -1
- package/dist/models/ChatUIOption.js +1 -1
- package/dist/models/CheckCustomDomainResponse.d.ts +1 -1
- package/dist/models/CheckCustomDomainResponse.js +1 -1
- package/dist/models/ClaimAgentWorkspaceRequest.d.ts +1 -1
- package/dist/models/ClaimAgentWorkspaceRequest.js +1 -1
- package/dist/models/ClientRedirectPayload.d.ts +1 -1
- package/dist/models/ClientRedirectPayload.js +1 -1
- package/dist/models/CompleteGoogleFormsOAuthRequest.d.ts +1 -1
- package/dist/models/CompleteGoogleFormsOAuthRequest.js +1 -1
- package/dist/models/CompleteGoogleFormsOAuthResponse.d.ts +1 -1
- package/dist/models/CompleteGoogleFormsOAuthResponse.js +1 -1
- package/dist/models/CompleteMediaUploadResponse.d.ts +1 -1
- package/dist/models/CompleteMediaUploadResponse.js +1 -1
- package/dist/models/CompleteSlackOAuthRequest.d.ts +1 -1
- package/dist/models/CompleteSlackOAuthRequest.js +1 -1
- package/dist/models/CompleteSlackOAuthResponse.d.ts +1 -1
- package/dist/models/CompleteSlackOAuthResponse.js +1 -1
- package/dist/models/ConnectWorkflowStepResponse.d.ts +1 -1
- package/dist/models/ConnectWorkflowStepResponse.js +1 -1
- package/dist/models/ContactCardTraceCard.d.ts +1 -1
- package/dist/models/ContactCardTraceCard.js +1 -1
- package/dist/models/ContactCardTraceData.d.ts +1 -1
- package/dist/models/ContactCardTraceData.js +1 -1
- package/dist/models/ContainerConfig.d.ts +1 -1
- package/dist/models/ContainerConfig.js +1 -1
- package/dist/models/CornersDotOptions.d.ts +1 -1
- package/dist/models/CornersDotOptions.js +1 -1
- package/dist/models/CornersDotType.d.ts +1 -1
- package/dist/models/CornersDotType.js +1 -1
- package/dist/models/CornersSquareOptions.d.ts +1 -1
- package/dist/models/CornersSquareOptions.js +1 -1
- package/dist/models/CornersSquareType.d.ts +1 -1
- package/dist/models/CornersSquareType.js +1 -1
- package/dist/models/CountryConditionOutcome.d.ts +1 -1
- package/dist/models/CountryConditionOutcome.js +1 -1
- package/dist/models/CountryConditionPayload.d.ts +1 -1
- package/dist/models/CountryConditionPayload.js +1 -1
- package/dist/models/CountryConditionTraceData.d.ts +1 -1
- package/dist/models/CountryConditionTraceData.js +1 -1
- package/dist/models/CountryConditionTraceOption.d.ts +1 -1
- package/dist/models/CountryConditionTraceOption.js +1 -1
- package/dist/models/CreateBulkLinksRequest.d.ts +1 -1
- package/dist/models/CreateBulkLinksRequest.js +1 -1
- package/dist/models/CreateBulkLinksResponse.d.ts +1 -1
- package/dist/models/CreateBulkLinksResponse.js +1 -1
- package/dist/models/CreateContactLinkRequest.d.ts +1 -1
- package/dist/models/CreateContactLinkRequest.js +1 -1
- package/dist/models/CreateContactLinkResponse.d.ts +1 -1
- package/dist/models/CreateContactLinkResponse.js +1 -1
- package/dist/models/CreateCustomDomainRequest.d.ts +1 -1
- package/dist/models/CreateCustomDomainRequest.js +1 -1
- package/dist/models/CreateCustomDomainResponse.d.ts +1 -1
- package/dist/models/CreateCustomDomainResponse.js +1 -1
- package/dist/models/CreateDashboardRequest.d.ts +1 -1
- package/dist/models/CreateDashboardRequest.js +1 -1
- package/dist/models/CreateDashboardResponse.d.ts +1 -1
- package/dist/models/CreateDashboardResponse.js +1 -1
- package/dist/models/CreateDirectoryRequest.d.ts +1 -1
- package/dist/models/CreateDirectoryRequest.js +1 -1
- package/dist/models/CreateDirectoryResponse.d.ts +1 -1
- package/dist/models/CreateDirectoryResponse.js +1 -1
- package/dist/models/CreateEventTraceResponse.d.ts +1 -1
- package/dist/models/CreateEventTraceResponse.js +1 -1
- package/dist/models/CreateLinkRequest.d.ts +1 -1
- package/dist/models/CreateLinkRequest.js +1 -1
- package/dist/models/CreateLinkResponse.d.ts +1 -1
- package/dist/models/CreateLinkResponse.js +1 -1
- package/dist/models/CreateMediaRequest.d.ts +16 -4
- package/dist/models/CreateMediaRequest.js +4 -1
- package/dist/models/CreateMediaResponse.d.ts +1 -1
- package/dist/models/CreateMediaResponse.js +1 -1
- package/dist/models/CreateMediaUploadRequest.d.ts +14 -3
- package/dist/models/CreateMediaUploadRequest.js +5 -4
- package/dist/models/CreateMediaUploadResponse.d.ts +1 -1
- package/dist/models/CreateMediaUploadResponse.js +1 -1
- package/dist/models/{CreateFileLinkRequest.d.ts → CreateOpenMediaLinkRequest.d.ts} +25 -25
- package/dist/models/{CreateFileLinkRequest.js → CreateOpenMediaLinkRequest.js} +14 -14
- package/dist/models/{CreateFileLinkResponse.d.ts → CreateOpenMediaLinkResponse.d.ts} +11 -11
- package/dist/models/{CreateFileLinkResponse.js → CreateOpenMediaLinkResponse.js} +14 -14
- package/dist/models/CreatePageThemeTemplateRequest.d.ts +1 -1
- package/dist/models/CreatePageThemeTemplateRequest.js +1 -1
- package/dist/models/CreatePageThemeTemplateResponse.d.ts +1 -1
- package/dist/models/CreatePageThemeTemplateResponse.js +1 -1
- package/dist/models/CreateQrcodeTemplateRequest.d.ts +1 -1
- package/dist/models/CreateQrcodeTemplateRequest.js +1 -1
- package/dist/models/CreateQrcodeTemplateResponse.d.ts +1 -1
- package/dist/models/CreateQrcodeTemplateResponse.js +1 -1
- package/dist/models/CreateSandboxRequest.d.ts +1 -1
- package/dist/models/CreateSandboxRequest.js +1 -1
- package/dist/models/CreateSandboxResponse.d.ts +1 -1
- package/dist/models/CreateSandboxResponse.js +1 -1
- package/dist/models/CreateThankYouLinkRequest.d.ts +1 -1
- package/dist/models/CreateThankYouLinkRequest.js +1 -1
- package/dist/models/CreateThankYouLinkResponse.d.ts +1 -1
- package/dist/models/CreateThankYouLinkResponse.js +1 -1
- package/dist/models/CreateWebhookRequest.d.ts +1 -1
- package/dist/models/CreateWebhookRequest.js +1 -1
- package/dist/models/CreateWebhookResponse.d.ts +1 -1
- package/dist/models/CreateWebhookResponse.js +1 -1
- package/dist/models/CreateWorkflowStepResponse.d.ts +1 -1
- package/dist/models/CreateWorkflowStepResponse.js +1 -1
- package/dist/models/CreateWorkspaceTokenRequest.d.ts +1 -1
- package/dist/models/CreateWorkspaceTokenRequest.js +1 -1
- package/dist/models/CreateWorkspaceTokenResponse.d.ts +1 -1
- package/dist/models/CreateWorkspaceTokenResponse.js +1 -1
- package/dist/models/CreditTopup.d.ts +1 -1
- package/dist/models/CreditTopup.js +1 -1
- package/dist/models/CustomDomain.d.ts +1 -1
- package/dist/models/CustomDomain.js +1 -1
- package/dist/models/CustomDomainDnsRecord.d.ts +1 -1
- package/dist/models/CustomDomainDnsRecord.js +1 -1
- package/dist/models/CustomDomainOneClickSetup.d.ts +1 -1
- package/dist/models/CustomDomainOneClickSetup.js +1 -1
- package/dist/models/CustomDomainSetupGuide.d.ts +1 -1
- package/dist/models/CustomDomainSetupGuide.js +1 -1
- package/dist/models/CustomDomainSetupHint.d.ts +1 -1
- package/dist/models/CustomDomainSetupHint.js +1 -1
- package/dist/models/CustomDomainStatus.d.ts +1 -1
- package/dist/models/CustomDomainStatus.js +1 -1
- package/dist/models/CustomDomainsServiceUpdateBody.d.ts +1 -1
- package/dist/models/CustomDomainsServiceUpdateBody.js +1 -1
- package/dist/models/DashboardConfig.d.ts +1 -1
- package/dist/models/DashboardConfig.js +1 -1
- package/dist/models/DashboardScope.d.ts +1 -1
- package/dist/models/DashboardScope.js +1 -1
- package/dist/models/DashboardWidget.d.ts +1 -1
- package/dist/models/DashboardWidget.js +1 -1
- package/dist/models/DataCollection.d.ts +1 -1
- package/dist/models/DataCollection.js +1 -1
- package/dist/models/DayOfMonthConditionPayload.d.ts +1 -1
- package/dist/models/DayOfMonthConditionPayload.js +1 -1
- package/dist/models/DayOfMonthConditionTraceData.d.ts +1 -1
- package/dist/models/DayOfMonthConditionTraceData.js +1 -1
- package/dist/models/DayOfMonthConditionTraceOption.d.ts +1 -1
- package/dist/models/DayOfMonthConditionTraceOption.js +1 -1
- package/dist/models/DayOfMonthOption.d.ts +1 -1
- package/dist/models/DayOfMonthOption.js +1 -1
- package/dist/models/DayOfWeekConditionPayload.d.ts +1 -1
- package/dist/models/DayOfWeekConditionPayload.js +1 -1
- package/dist/models/DayOfWeekConditionTraceData.d.ts +1 -1
- package/dist/models/DayOfWeekConditionTraceData.js +1 -1
- package/dist/models/DayOfWeekConditionTraceOption.d.ts +1 -1
- package/dist/models/DayOfWeekConditionTraceOption.js +1 -1
- package/dist/models/DayOfWeekOption.d.ts +1 -1
- package/dist/models/DayOfWeekOption.js +1 -1
- package/dist/models/DeleteAttributeResponse.d.ts +1 -1
- package/dist/models/DeleteAttributeResponse.js +1 -1
- package/dist/models/DeleteVisitorResponse.d.ts +1 -1
- package/dist/models/DeleteVisitorResponse.js +1 -1
- package/dist/models/DetectedGoogleForm.d.ts +1 -1
- package/dist/models/DetectedGoogleForm.js +1 -1
- package/dist/models/Device.d.ts +1 -1
- package/dist/models/Device.js +1 -1
- package/dist/models/DeviceActor.d.ts +1 -1
- package/dist/models/DeviceActor.js +1 -1
- package/dist/models/DeviceActorConditionOption.d.ts +1 -1
- package/dist/models/DeviceActorConditionOption.js +1 -1
- package/dist/models/DeviceActorConditionPayload.d.ts +1 -1
- package/dist/models/DeviceActorConditionPayload.js +1 -1
- package/dist/models/DeviceActorConditionTraceData.d.ts +1 -1
- package/dist/models/DeviceActorConditionTraceData.js +1 -1
- package/dist/models/DeviceActorConditionTraceOption.d.ts +1 -1
- package/dist/models/DeviceActorConditionTraceOption.js +1 -1
- package/dist/models/DeviceActorConditionValue.d.ts +1 -1
- package/dist/models/DeviceActorConditionValue.js +1 -1
- package/dist/models/DeviceBrandConditionOption.d.ts +1 -1
- package/dist/models/DeviceBrandConditionOption.js +1 -1
- package/dist/models/DeviceBrandConditionPayload.d.ts +1 -1
- package/dist/models/DeviceBrandConditionPayload.js +1 -1
- package/dist/models/DeviceBrandConditionTraceData.d.ts +1 -1
- package/dist/models/DeviceBrandConditionTraceData.js +1 -1
- package/dist/models/DeviceBrandConditionTraceOption.d.ts +1 -1
- package/dist/models/DeviceBrandConditionTraceOption.js +1 -1
- package/dist/models/DeviceBrandConditionValue.d.ts +1 -1
- package/dist/models/DeviceBrandConditionValue.js +1 -1
- package/dist/models/DeviceBrowserConditionOption.d.ts +1 -1
- package/dist/models/DeviceBrowserConditionOption.js +1 -1
- package/dist/models/DeviceBrowserConditionPayload.d.ts +1 -1
- package/dist/models/DeviceBrowserConditionPayload.js +1 -1
- package/dist/models/DeviceBrowserConditionTraceData.d.ts +1 -1
- package/dist/models/DeviceBrowserConditionTraceData.js +1 -1
- package/dist/models/DeviceBrowserConditionTraceOption.d.ts +1 -1
- package/dist/models/DeviceBrowserConditionTraceOption.js +1 -1
- package/dist/models/DeviceBrowserConditionValue.d.ts +1 -1
- package/dist/models/DeviceBrowserConditionValue.js +1 -1
- package/dist/models/DeviceDataPoint.d.ts +1 -1
- package/dist/models/DeviceDataPoint.js +1 -1
- package/dist/models/DeviceInput.d.ts +1 -1
- package/dist/models/DeviceInput.js +1 -1
- package/dist/models/DevicePlatformConditionOption.d.ts +1 -1
- package/dist/models/DevicePlatformConditionOption.js +1 -1
- package/dist/models/DevicePlatformConditionPayload.d.ts +1 -1
- package/dist/models/DevicePlatformConditionPayload.js +1 -1
- package/dist/models/DevicePlatformConditionTraceData.d.ts +1 -1
- package/dist/models/DevicePlatformConditionTraceData.js +1 -1
- package/dist/models/DevicePlatformConditionTraceOption.d.ts +1 -1
- package/dist/models/DevicePlatformConditionTraceOption.js +1 -1
- package/dist/models/DevicePlatformConditionValue.d.ts +1 -1
- package/dist/models/DevicePlatformConditionValue.js +1 -1
- package/dist/models/DeviceType.d.ts +1 -1
- package/dist/models/DeviceType.js +1 -1
- package/dist/models/DeviceTypeConditionOption.d.ts +1 -1
- package/dist/models/DeviceTypeConditionOption.js +1 -1
- package/dist/models/DeviceTypeConditionPayload.d.ts +1 -1
- package/dist/models/DeviceTypeConditionPayload.js +1 -1
- package/dist/models/DeviceTypeConditionTraceData.d.ts +1 -1
- package/dist/models/DeviceTypeConditionTraceData.js +1 -1
- package/dist/models/DeviceTypeConditionTraceOption.d.ts +1 -1
- package/dist/models/DeviceTypeConditionTraceOption.js +1 -1
- package/dist/models/DeviceTypeConditionValue.d.ts +1 -1
- package/dist/models/DeviceTypeConditionValue.js +1 -1
- package/dist/models/DigestFrequency.d.ts +1 -1
- package/dist/models/DigestFrequency.js +1 -1
- package/dist/models/DirectoriesServiceUpdateBody.d.ts +1 -1
- package/dist/models/DirectoriesServiceUpdateBody.js +1 -1
- package/dist/models/Directory.d.ts +1 -1
- package/dist/models/Directory.js +1 -1
- package/dist/models/DisconnectWorkflowStepResponse.d.ts +1 -1
- package/dist/models/DisconnectWorkflowStepResponse.js +1 -1
- package/dist/models/DismissAllowanceNoticeRequest.d.ts +1 -1
- package/dist/models/DismissAllowanceNoticeRequest.js +1 -1
- package/dist/models/DnsProvider.d.ts +1 -1
- package/dist/models/DnsProvider.js +1 -1
- package/dist/models/DnsRecordPurpose.d.ts +1 -1
- package/dist/models/DnsRecordPurpose.js +1 -1
- package/dist/models/DnsRecordType.d.ts +1 -1
- package/dist/models/DnsRecordType.js +1 -1
- package/dist/models/DotsOptions.d.ts +1 -1
- package/dist/models/DotsOptions.js +1 -1
- package/dist/models/DotsType.d.ts +1 -1
- package/dist/models/DotsType.js +1 -1
- package/dist/models/EntryAccessTraceData.d.ts +1 -1
- package/dist/models/EntryAccessTraceData.js +1 -1
- package/dist/models/ErrorResponse.d.ts +1 -1
- package/dist/models/ErrorResponse.js +1 -1
- package/dist/models/Event.d.ts +1 -1
- package/dist/models/Event.js +1 -1
- package/dist/models/EventAction.d.ts +9 -9
- package/dist/models/EventAction.js +9 -9
- package/dist/models/EventTrace.d.ts +1 -1
- package/dist/models/EventTrace.js +1 -1
- package/dist/models/EventTraceData.d.ts +8 -8
- package/dist/models/EventTraceData.js +4 -4
- package/dist/models/EventsMetric.d.ts +1 -1
- package/dist/models/EventsMetric.js +1 -1
- package/dist/models/EventsServiceCreateEventTraceBody.d.ts +1 -1
- package/dist/models/EventsServiceCreateEventTraceBody.js +1 -1
- package/dist/models/EventsServiceUpdateDeviceBody.d.ts +1 -1
- package/dist/models/EventsServiceUpdateDeviceBody.js +1 -1
- package/dist/models/EventsTimeSeries.d.ts +1 -1
- package/dist/models/EventsTimeSeries.js +1 -1
- package/dist/models/EventsTimeSeriesData.d.ts +1 -1
- package/dist/models/EventsTimeSeriesData.js +1 -1
- package/dist/models/FindMatchingPageThemeTemplateResponse.d.ts +1 -1
- package/dist/models/FindMatchingPageThemeTemplateResponse.js +1 -1
- package/dist/models/FontConfig.d.ts +1 -1
- package/dist/models/FontConfig.js +1 -1
- package/dist/models/FormField.d.ts +1 -1
- package/dist/models/FormField.js +1 -1
- package/dist/models/FormFieldOption.d.ts +1 -1
- package/dist/models/FormFieldOption.js +1 -1
- package/dist/models/FormFieldType.d.ts +1 -1
- package/dist/models/FormFieldType.js +1 -1
- package/dist/models/FormPayload.d.ts +1 -1
- package/dist/models/FormPayload.js +1 -1
- package/dist/models/FormTraceData.d.ts +1 -1
- package/dist/models/FormTraceData.js +1 -1
- package/dist/models/FormTraceDataField.d.ts +1 -1
- package/dist/models/FormTraceDataField.js +1 -1
- package/dist/models/FunnelBranch.d.ts +1 -1
- package/dist/models/FunnelBranch.js +1 -1
- package/dist/models/FunnelStep.d.ts +1 -1
- package/dist/models/FunnelStep.js +1 -1
- package/dist/models/GenerateWidgetSummaryResponse.d.ts +1 -1
- package/dist/models/GenerateWidgetSummaryResponse.js +1 -1
- package/dist/models/GeoDataPoint.d.ts +1 -1
- package/dist/models/GeoDataPoint.js +1 -1
- package/dist/models/GetAgentClaimRequest.d.ts +1 -1
- package/dist/models/GetAgentClaimRequest.js +1 -1
- package/dist/models/GetAttributeDistributionRequest.d.ts +1 -1
- package/dist/models/GetAttributeDistributionRequest.js +1 -1
- package/dist/models/GetAttributeDistributionResponse.d.ts +1 -1
- package/dist/models/GetAttributeDistributionResponse.js +1 -1
- package/dist/models/GetAttributeMetricRequest.d.ts +1 -1
- package/dist/models/GetAttributeMetricRequest.js +1 -1
- package/dist/models/GetAttributeMetricResponse.d.ts +1 -1
- package/dist/models/GetAttributeMetricResponse.js +1 -1
- package/dist/models/GetAttributeValuesRequest.d.ts +1 -1
- package/dist/models/GetAttributeValuesRequest.js +1 -1
- package/dist/models/GetAttributeValuesResponse.d.ts +1 -1
- package/dist/models/GetAttributeValuesResponse.js +1 -1
- package/dist/models/GetBreakdownRequest.d.ts +1 -1
- package/dist/models/GetBreakdownRequest.js +1 -1
- package/dist/models/GetBreakdownResponse.d.ts +1 -1
- package/dist/models/GetBreakdownResponse.js +1 -1
- package/dist/models/GetCustomDomainResponse.d.ts +1 -1
- package/dist/models/GetCustomDomainResponse.js +1 -1
- package/dist/models/GetCustomDomainSetupGuideResponse.d.ts +1 -1
- package/dist/models/GetCustomDomainSetupGuideResponse.js +1 -1
- package/dist/models/GetDeviceDistributionRequest.d.ts +1 -1
- package/dist/models/GetDeviceDistributionRequest.js +1 -1
- package/dist/models/GetDeviceDistributionResponse.d.ts +1 -1
- package/dist/models/GetDeviceDistributionResponse.js +1 -1
- package/dist/models/GetDirectoryResponse.d.ts +1 -1
- package/dist/models/GetDirectoryResponse.js +1 -1
- package/dist/models/GetEventsTimeSeriesRequest.d.ts +1 -1
- package/dist/models/GetEventsTimeSeriesRequest.js +1 -1
- package/dist/models/GetEventsTimeSeriesResponse.d.ts +1 -1
- package/dist/models/GetEventsTimeSeriesResponse.js +1 -1
- package/dist/models/GetGeoBreakdownRequest.d.ts +1 -1
- package/dist/models/GetGeoBreakdownRequest.js +1 -1
- package/dist/models/GetGeoBreakdownResponse.d.ts +1 -1
- package/dist/models/GetGeoBreakdownResponse.js +1 -1
- package/dist/models/GetGoogleFormsIntegrationResponse.d.ts +1 -1
- package/dist/models/GetGoogleFormsIntegrationResponse.js +1 -1
- package/dist/models/GetGoogleFormsOAuthURLResponse.d.ts +1 -1
- package/dist/models/GetGoogleFormsOAuthURLResponse.js +1 -1
- package/dist/models/GetGroupedTimeSeriesRequest.d.ts +1 -1
- package/dist/models/GetGroupedTimeSeriesRequest.js +1 -1
- package/dist/models/GetGroupedTimeSeriesResponse.d.ts +1 -1
- package/dist/models/GetGroupedTimeSeriesResponse.js +1 -1
- package/dist/models/GetHourOfDayDistributionRequest.d.ts +1 -1
- package/dist/models/GetHourOfDayDistributionRequest.js +1 -1
- package/dist/models/GetHourOfDayDistributionResponse.d.ts +1 -1
- package/dist/models/GetHourOfDayDistributionResponse.js +1 -1
- package/dist/models/GetLinkResponse.d.ts +1 -1
- package/dist/models/GetLinkResponse.js +1 -1
- package/dist/models/GetLinkSettingResponse.d.ts +1 -1
- package/dist/models/GetLinkSettingResponse.js +1 -1
- package/dist/models/GetMediaResponse.d.ts +1 -1
- package/dist/models/GetMediaResponse.js +1 -1
- package/dist/models/GetPageThemeResponse.d.ts +1 -1
- package/dist/models/GetPageThemeResponse.js +1 -1
- package/dist/models/GetQrcodeDesignResponse.d.ts +1 -1
- package/dist/models/GetQrcodeDesignResponse.js +1 -1
- package/dist/models/GetSlackIntegrationResponse.d.ts +1 -1
- package/dist/models/GetSlackIntegrationResponse.js +1 -1
- package/dist/models/GetSlackOAuthURLResponse.d.ts +1 -1
- package/dist/models/GetSlackOAuthURLResponse.js +1 -1
- package/dist/models/GetStepFunnelRequest.d.ts +1 -1
- package/dist/models/GetStepFunnelRequest.js +1 -1
- package/dist/models/GetStepFunnelResponse.d.ts +1 -1
- package/dist/models/GetStepFunnelResponse.js +1 -1
- package/dist/models/GetTopLinksRequest.d.ts +1 -1
- package/dist/models/GetTopLinksRequest.js +1 -1
- package/dist/models/GetTopLinksResponse.d.ts +1 -1
- package/dist/models/GetTopLinksResponse.js +1 -1
- package/dist/models/GetVisitorTrendsRequest.d.ts +1 -1
- package/dist/models/GetVisitorTrendsRequest.js +1 -1
- package/dist/models/GetVisitorTrendsResponse.d.ts +1 -1
- package/dist/models/GetVisitorTrendsResponse.js +1 -1
- package/dist/models/GetWebhookResponse.d.ts +1 -1
- package/dist/models/GetWebhookResponse.js +1 -1
- package/dist/models/GetWidgetSummaryResponse.d.ts +1 -1
- package/dist/models/GetWidgetSummaryResponse.js +1 -1
- package/dist/models/GetWorkflowStepResponse.d.ts +1 -1
- package/dist/models/GetWorkflowStepResponse.js +1 -1
- package/dist/models/GetWorkspaceTokenResponse.d.ts +1 -1
- package/dist/models/GetWorkspaceTokenResponse.js +1 -1
- package/dist/models/GoogleFormsIntegration.d.ts +1 -1
- package/dist/models/GoogleFormsIntegration.js +1 -1
- package/dist/models/GoogleFormsIntegrationStatus.d.ts +1 -1
- package/dist/models/GoogleFormsIntegrationStatus.js +1 -1
- package/dist/models/GooglerpcStatus.d.ts +1 -1
- package/dist/models/GooglerpcStatus.js +1 -1
- package/dist/models/GroupByDimension.d.ts +1 -1
- package/dist/models/GroupByDimension.js +1 -1
- package/dist/models/HourOfDayDataPoint.d.ts +1 -1
- package/dist/models/HourOfDayDataPoint.js +1 -1
- package/dist/models/IdentifyRequest.d.ts +1 -1
- package/dist/models/IdentifyRequest.js +1 -1
- package/dist/models/IdentifyResponse.d.ts +1 -1
- package/dist/models/IdentifyResponse.js +1 -1
- package/dist/models/IdentifyVisitorTraceData.d.ts +1 -1
- package/dist/models/IdentifyVisitorTraceData.js +1 -1
- package/dist/models/ImportMediaRequest.d.ts +55 -0
- package/dist/models/ImportMediaRequest.js +55 -0
- package/dist/models/ImportMediaResponse.d.ts +33 -0
- package/dist/models/ImportMediaResponse.js +49 -0
- package/dist/models/ImportPageThemeTemplateRequest.d.ts +1 -1
- package/dist/models/ImportPageThemeTemplateRequest.js +1 -1
- package/dist/models/ImportPageThemeTemplateResponse.d.ts +1 -1
- package/dist/models/ImportPageThemeTemplateResponse.js +1 -1
- package/dist/models/ImportQrcodeTemplateRequest.d.ts +1 -1
- package/dist/models/ImportQrcodeTemplateRequest.js +1 -1
- package/dist/models/ImportQrcodeTemplateResponse.d.ts +1 -1
- package/dist/models/ImportQrcodeTemplateResponse.js +1 -1
- package/dist/models/InviteMemberRequest.d.ts +1 -1
- package/dist/models/InviteMemberRequest.js +1 -1
- package/dist/models/Job.d.ts +1 -1
- package/dist/models/Job.js +1 -1
- package/dist/models/JobError.d.ts +1 -1
- package/dist/models/JobError.js +1 -1
- package/dist/models/JobStatus.d.ts +1 -1
- package/dist/models/JobStatus.js +1 -1
- package/dist/models/JobType.d.ts +1 -1
- package/dist/models/JobType.js +1 -1
- package/dist/models/JourneyProgress.d.ts +1 -1
- package/dist/models/JourneyProgress.js +1 -1
- package/dist/models/Link.d.ts +1 -1
- package/dist/models/Link.js +1 -1
- package/dist/models/LinkSetting.d.ts +1 -1
- package/dist/models/LinkSetting.js +1 -1
- package/dist/models/LinkSortField.d.ts +1 -1
- package/dist/models/LinkSortField.js +1 -1
- package/dist/models/LinkView.d.ts +1 -1
- package/dist/models/LinkView.js +1 -1
- package/dist/models/LinksBulkCreateResult.d.ts +1 -1
- package/dist/models/LinksBulkCreateResult.js +1 -1
- package/dist/models/LinksServiceUpdateBody.d.ts +1 -1
- package/dist/models/LinksServiceUpdateBody.js +1 -1
- package/dist/models/ListAllowancesResponse.d.ts +1 -1
- package/dist/models/ListAllowancesResponse.js +1 -1
- package/dist/models/ListApiScopesResponse.d.ts +1 -1
- package/dist/models/ListApiScopesResponse.js +1 -1
- package/dist/models/ListCustomDomainsResponse.d.ts +1 -1
- package/dist/models/ListCustomDomainsResponse.js +1 -1
- package/dist/models/ListDashboardsResponse.d.ts +1 -1
- package/dist/models/ListDashboardsResponse.js +1 -1
- package/dist/models/ListDetectedGoogleFormsResponse.d.ts +1 -1
- package/dist/models/ListDetectedGoogleFormsResponse.js +1 -1
- package/dist/models/ListDirectoriesResponse.d.ts +1 -1
- package/dist/models/ListDirectoriesResponse.js +1 -1
- package/dist/models/ListEventTracesResponse.d.ts +1 -1
- package/dist/models/ListEventTracesResponse.js +1 -1
- package/dist/models/ListEventsCsvResponse.d.ts +1 -1
- package/dist/models/ListEventsCsvResponse.js +1 -1
- package/dist/models/ListEventsJsonResponse.d.ts +1 -1
- package/dist/models/ListEventsJsonResponse.js +1 -1
- package/dist/models/ListEventsResponse.d.ts +1 -1
- package/dist/models/ListEventsResponse.js +1 -1
- package/dist/models/ListLinksResponse.d.ts +1 -1
- package/dist/models/ListLinksResponse.js +1 -1
- package/dist/models/ListMediaResponse.d.ts +1 -1
- package/dist/models/ListMediaResponse.js +1 -1
- package/dist/models/ListMyWorkspacesResponse.d.ts +1 -1
- package/dist/models/ListMyWorkspacesResponse.js +1 -1
- package/dist/models/ListPageThemeTemplatesResponse.d.ts +1 -1
- package/dist/models/ListPageThemeTemplatesResponse.js +1 -1
- package/dist/models/ListPageThemesResponse.d.ts +1 -1
- package/dist/models/ListPageThemesResponse.js +1 -1
- package/dist/models/ListPricingPlansResponse.d.ts +1 -1
- package/dist/models/ListPricingPlansResponse.js +1 -1
- package/dist/models/ListQrcodeTemplatesResponse.d.ts +1 -1
- package/dist/models/ListQrcodeTemplatesResponse.js +1 -1
- package/dist/models/ListResponse.d.ts +1 -1
- package/dist/models/ListResponse.js +1 -1
- package/dist/models/ListSandboxesResponse.d.ts +1 -1
- package/dist/models/ListSandboxesResponse.js +1 -1
- package/dist/models/ListSlackChannelsResponse.d.ts +1 -1
- package/dist/models/ListSlackChannelsResponse.js +1 -1
- package/dist/models/ListTagsResponse.d.ts +1 -1
- package/dist/models/ListTagsResponse.js +1 -1
- package/dist/models/ListVisitorAttributeKeysResponse.d.ts +1 -1
- package/dist/models/ListVisitorAttributeKeysResponse.js +1 -1
- package/dist/models/ListVisitorsCsvResponse.d.ts +1 -1
- package/dist/models/ListVisitorsCsvResponse.js +1 -1
- package/dist/models/ListVisitorsJsonResponse.d.ts +1 -1
- package/dist/models/ListVisitorsJsonResponse.js +1 -1
- package/dist/models/ListVisitorsRequest.d.ts +1 -1
- package/dist/models/ListVisitorsRequest.js +1 -1
- package/dist/models/ListVisitorsResponse.d.ts +1 -1
- package/dist/models/ListVisitorsResponse.js +1 -1
- package/dist/models/ListWebhooksResponse.d.ts +1 -1
- package/dist/models/ListWebhooksResponse.js +1 -1
- package/dist/models/ListWorkflowStepsResponse.d.ts +1 -1
- package/dist/models/ListWorkflowStepsResponse.js +1 -1
- package/dist/models/ListWorkspaceTokensResponse.d.ts +1 -1
- package/dist/models/ListWorkspaceTokensResponse.js +1 -1
- package/dist/models/Media.d.ts +25 -14
- package/dist/models/Media.js +3 -1
- package/dist/models/MediaKind.d.ts +1 -1
- package/dist/models/MediaKind.js +1 -1
- package/dist/models/MediaReference.d.ts +19 -5
- package/dist/models/MediaReference.js +3 -1
- package/dist/models/MediaReferenceType.d.ts +6 -3
- package/dist/models/MediaReferenceType.js +7 -4
- package/dist/models/MediaSelection.d.ts +5 -2
- package/dist/models/MediaSelection.js +1 -1
- package/dist/models/MediaStatus.d.ts +1 -1
- package/dist/models/MediaStatus.js +1 -1
- package/dist/models/{FileTraceData.d.ts → MediaTraceData.d.ts} +14 -14
- package/dist/models/{FileTraceData.js → MediaTraceData.js} +14 -14
- package/dist/models/MediaType.d.ts +6 -4
- package/dist/models/MediaType.js +6 -4
- package/dist/models/MediaUploadOrigin.d.ts +42 -0
- package/dist/models/MediaUploadOrigin.js +68 -0
- package/dist/models/MediaUsage.d.ts +7 -6
- package/dist/models/MediaUsage.js +7 -6
- package/dist/models/MediaVisibility.d.ts +1 -1
- package/dist/models/MediaVisibility.js +1 -1
- package/dist/models/Member.d.ts +1 -1
- package/dist/models/Member.js +1 -1
- package/dist/models/MembersServiceSwitchWorkspaceBody.d.ts +1 -1
- package/dist/models/MembersServiceSwitchWorkspaceBody.js +1 -1
- package/dist/models/MembersServiceUpdateBody.d.ts +1 -1
- package/dist/models/MembersServiceUpdateBody.js +1 -1
- package/dist/models/MessagePageNavigationType.d.ts +1 -1
- package/dist/models/MessagePageNavigationType.js +1 -1
- package/dist/models/MessagePagePayload.d.ts +1 -1
- package/dist/models/MessagePagePayload.js +1 -1
- package/dist/models/ModelHTTPMethod.d.ts +1 -1
- package/dist/models/ModelHTTPMethod.js +1 -1
- package/dist/models/Money.d.ts +1 -1
- package/dist/models/Money.js +1 -1
- package/dist/models/MultiLinkButton.d.ts +1 -1
- package/dist/models/MultiLinkButton.js +1 -1
- package/dist/models/MultiLinkPayload.d.ts +1 -1
- package/dist/models/MultiLinkPayload.js +1 -1
- package/dist/models/MultiLinkTraceButton.d.ts +1 -1
- package/dist/models/MultiLinkTraceButton.js +1 -1
- package/dist/models/MultiLinkTraceData.d.ts +1 -1
- package/dist/models/MultiLinkTraceData.js +1 -1
- package/dist/models/MultiLinkTraceSelectedButton.d.ts +1 -1
- package/dist/models/MultiLinkTraceSelectedButton.js +1 -1
- package/dist/models/MyWorkspace.d.ts +1 -1
- package/dist/models/MyWorkspace.js +1 -1
- package/dist/models/{FilePayload.d.ts → OpenMediaPayload.d.ts} +11 -11
- package/dist/models/{FilePayload.js → OpenMediaPayload.js} +14 -14
- package/dist/models/OutputFileFormat.d.ts +1 -1
- package/dist/models/OutputFileFormat.js +1 -1
- package/dist/models/PageTheme.d.ts +1 -1
- package/dist/models/PageTheme.js +1 -1
- package/dist/models/PageThemeBadgeShape.d.ts +1 -1
- package/dist/models/PageThemeBadgeShape.js +1 -1
- package/dist/models/PageThemeBorderStyle.d.ts +1 -1
- package/dist/models/PageThemeBorderStyle.js +1 -1
- package/dist/models/PageThemeCanvasCoverMode.d.ts +1 -1
- package/dist/models/PageThemeCanvasCoverMode.js +1 -1
- package/dist/models/PageThemeContainerVariant.d.ts +1 -1
- package/dist/models/PageThemeContainerVariant.js +1 -1
- package/dist/models/PageThemeFontFamily.d.ts +1 -1
- package/dist/models/PageThemeFontFamily.js +1 -1
- package/dist/models/PageThemeStyling.d.ts +1 -1
- package/dist/models/PageThemeStyling.js +1 -1
- package/dist/models/PageThemeTemplate.d.ts +1 -1
- package/dist/models/PageThemeTemplate.js +1 -1
- package/dist/models/PageThemeTemplateImages.d.ts +1 -1
- package/dist/models/PageThemeTemplateImages.js +1 -1
- package/dist/models/PageThemeTemplateScope.d.ts +1 -1
- package/dist/models/PageThemeTemplateScope.js +1 -1
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateBody.d.ts +1 -1
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateBody.js +1 -1
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.d.ts +1 -1
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.js +1 -1
- package/dist/models/PageThemesServiceUpdatePageThemeBody.d.ts +2 -2
- package/dist/models/PageThemesServiceUpdatePageThemeBody.js +1 -1
- package/dist/models/PasswordPayload.d.ts +1 -1
- package/dist/models/PasswordPayload.js +1 -1
- package/dist/models/PasswordTraceData.d.ts +1 -1
- package/dist/models/PasswordTraceData.js +1 -1
- package/dist/models/PlanFeature.d.ts +1 -1
- package/dist/models/PlanFeature.js +1 -1
- package/dist/models/PlanLimit.d.ts +2 -2
- package/dist/models/PlanLimit.js +1 -1
- package/dist/models/PlanLimitKey.d.ts +2 -2
- package/dist/models/PlanLimitKey.js +2 -2
- package/dist/models/PlanLimitKind.d.ts +1 -1
- package/dist/models/PlanLimitKind.js +1 -1
- package/dist/models/PlanPrice.d.ts +1 -1
- package/dist/models/PlanPrice.js +1 -1
- package/dist/models/PlanTrial.d.ts +1 -1
- package/dist/models/PlanTrial.js +1 -1
- package/dist/models/PreferredLinkType.d.ts +3 -3
- package/dist/models/PreferredLinkType.js +3 -3
- package/dist/models/PricingPlan.d.ts +1 -1
- package/dist/models/PricingPlan.js +1 -1
- package/dist/models/PricingPlanId.d.ts +1 -1
- package/dist/models/PricingPlanId.js +1 -1
- package/dist/models/ProtobufAny.d.ts +1 -1
- package/dist/models/ProtobufAny.js +1 -1
- package/dist/models/ProtobufNullValue.d.ts +1 -1
- package/dist/models/ProtobufNullValue.js +1 -1
- package/dist/models/PublicCreateQrcodeDesignRequest.d.ts +3 -1
- package/dist/models/PublicCreateQrcodeDesignRequest.js +1 -1
- package/dist/models/PublicCreateQrcodeDesignResponse.d.ts +1 -1
- package/dist/models/PublicCreateQrcodeDesignResponse.js +1 -1
- package/dist/models/PublicListPageThemeTemplatesResponse.d.ts +1 -1
- package/dist/models/PublicListPageThemeTemplatesResponse.js +1 -1
- package/dist/models/PublicListQrcodeTemplatesResponse.d.ts +1 -1
- package/dist/models/PublicListQrcodeTemplatesResponse.js +1 -1
- package/dist/models/PublicPageThemeTemplate.d.ts +1 -1
- package/dist/models/PublicPageThemeTemplate.js +1 -1
- package/dist/models/PublicQrcodeTemplate.d.ts +1 -1
- package/dist/models/PublicQrcodeTemplate.js +1 -1
- package/dist/models/PublicWorkspace.d.ts +1 -1
- package/dist/models/PublicWorkspace.js +1 -1
- package/dist/models/PublishPageThemeTemplateResponse.d.ts +1 -1
- package/dist/models/PublishPageThemeTemplateResponse.js +1 -1
- package/dist/models/PublishQrcodeTemplateResponse.d.ts +1 -1
- package/dist/models/PublishQrcodeTemplateResponse.js +1 -1
- package/dist/models/QrcodeDesign.d.ts +10 -2
- package/dist/models/QrcodeDesign.js +2 -1
- package/dist/models/QrcodeDesignServiceUpdateBody.d.ts +12 -1
- package/dist/models/QrcodeDesignServiceUpdateBody.js +3 -1
- package/dist/models/QrcodeTemplate.d.ts +1 -1
- package/dist/models/QrcodeTemplate.js +1 -1
- package/dist/models/QrcodeTemplateScope.d.ts +1 -1
- package/dist/models/QrcodeTemplateScope.js +1 -1
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.d.ts +1 -1
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.js +1 -1
- package/dist/models/RedirectTraceData.d.ts +1 -1
- package/dist/models/RedirectTraceData.js +1 -1
- package/dist/models/RedirectTraceDataFallbackReason.d.ts +3 -3
- package/dist/models/RedirectTraceDataFallbackReason.js +3 -3
- package/dist/models/RequestWorkspaceEnrollmentRequest.d.ts +1 -1
- package/dist/models/RequestWorkspaceEnrollmentRequest.js +1 -1
- package/dist/models/ResolvePageThemeTemplateImagesRequest.d.ts +1 -1
- package/dist/models/ResolvePageThemeTemplateImagesRequest.js +1 -1
- package/dist/models/ResolvePageThemeTemplateImagesResponse.d.ts +1 -1
- package/dist/models/ResolvePageThemeTemplateImagesResponse.js +1 -1
- package/dist/models/ResolveQrcodeImagesRequest.d.ts +1 -1
- package/dist/models/ResolveQrcodeImagesRequest.js +1 -1
- package/dist/models/ResolveQrcodeImagesResponse.d.ts +1 -1
- package/dist/models/ResolveQrcodeImagesResponse.js +1 -1
- package/dist/models/ResolveQrcodeTemplateImagesRequest.d.ts +1 -1
- package/dist/models/ResolveQrcodeTemplateImagesRequest.js +1 -1
- package/dist/models/ResolveQrcodeTemplateImagesResponse.d.ts +1 -1
- package/dist/models/ResolveQrcodeTemplateImagesResponse.js +1 -1
- package/dist/models/ResolveStepCollisionsResponse.d.ts +1 -1
- package/dist/models/ResolveStepCollisionsResponse.js +1 -1
- package/dist/models/ResponseFormat.d.ts +1 -1
- package/dist/models/ResponseFormat.js +1 -1
- package/dist/models/Role.d.ts +1 -1
- package/dist/models/Role.js +1 -1
- package/dist/models/Sandbox.d.ts +1 -1
- package/dist/models/Sandbox.js +1 -1
- package/dist/models/SettingsServiceUpdateLinkSettingBody.d.ts +1 -1
- package/dist/models/SettingsServiceUpdateLinkSettingBody.js +1 -1
- package/dist/models/Shape.d.ts +1 -1
- package/dist/models/Shape.js +1 -1
- package/dist/models/ShortlinkAvailabilityResponse.d.ts +1 -1
- package/dist/models/ShortlinkAvailabilityResponse.js +1 -1
- package/dist/models/ShortlinkRandomResponse.d.ts +1 -1
- package/dist/models/ShortlinkRandomResponse.js +1 -1
- package/dist/models/SlackChannel.d.ts +1 -1
- package/dist/models/SlackChannel.js +1 -1
- package/dist/models/SlackIntegration.d.ts +1 -1
- package/dist/models/SlackIntegration.js +1 -1
- package/dist/models/SlackIntegrationStatus.d.ts +1 -1
- package/dist/models/SlackIntegrationStatus.js +1 -1
- package/dist/models/SocialLinkButton.d.ts +1 -1
- package/dist/models/SocialLinkButton.js +1 -1
- package/dist/models/SocialLinkTraceButton.d.ts +1 -1
- package/dist/models/SocialLinkTraceButton.js +1 -1
- package/dist/models/SocialLinksDisplayStyle.d.ts +1 -1
- package/dist/models/SocialLinksDisplayStyle.js +1 -1
- package/dist/models/SocialLinksPayload.d.ts +1 -1
- package/dist/models/SocialLinksPayload.js +1 -1
- package/dist/models/SocialLinksTraceData.d.ts +1 -1
- package/dist/models/SocialLinksTraceData.js +1 -1
- package/dist/models/SocketAssistantErrorMessage.d.ts +1 -1
- package/dist/models/SocketAssistantErrorMessage.js +1 -1
- package/dist/models/SocketAssistantProgressMessage.d.ts +1 -1
- package/dist/models/SocketAssistantProgressMessage.js +1 -1
- package/dist/models/SocketAssistantResponseMessage.d.ts +1 -1
- package/dist/models/SocketAssistantResponseMessage.js +1 -1
- package/dist/models/SocketAssistantSendRequest.d.ts +1 -1
- package/dist/models/SocketAssistantSendRequest.js +1 -1
- package/dist/models/SocketConnectedMessage.d.ts +1 -1
- package/dist/models/SocketConnectedMessage.js +1 -1
- package/dist/models/SocketContract.d.ts +1 -1
- package/dist/models/SocketContract.js +1 -1
- package/dist/models/SocketErrorCode.d.ts +1 -1
- package/dist/models/SocketErrorCode.js +1 -1
- package/dist/models/SocketEventMessage.d.ts +1 -1
- package/dist/models/SocketEventMessage.js +1 -1
- package/dist/models/SocketMessageType.d.ts +1 -1
- package/dist/models/SocketMessageType.js +1 -1
- package/dist/models/SocketPingRequest.d.ts +1 -1
- package/dist/models/SocketPingRequest.js +1 -1
- package/dist/models/SocketPongMessage.d.ts +1 -1
- package/dist/models/SocketPongMessage.js +1 -1
- package/dist/models/SocketSubscribeDeniedMessage.d.ts +1 -1
- package/dist/models/SocketSubscribeDeniedMessage.js +1 -1
- package/dist/models/SocketSubscribeRequest.d.ts +1 -1
- package/dist/models/SocketSubscribeRequest.js +1 -1
- package/dist/models/SocketSubscribedMessage.d.ts +1 -1
- package/dist/models/SocketSubscribedMessage.js +1 -1
- package/dist/models/SocketUnsubscribeRequest.d.ts +1 -1
- package/dist/models/SocketUnsubscribeRequest.js +1 -1
- package/dist/models/SortDirection.d.ts +1 -1
- package/dist/models/SortDirection.js +1 -1
- package/dist/models/SpecificDateConditionPayload.d.ts +1 -1
- package/dist/models/SpecificDateConditionPayload.js +1 -1
- package/dist/models/SpecificDateConditionTraceData.d.ts +1 -1
- package/dist/models/SpecificDateConditionTraceData.js +1 -1
- package/dist/models/SpecificDateConditionTraceOption.d.ts +1 -1
- package/dist/models/SpecificDateConditionTraceOption.js +1 -1
- package/dist/models/SpecificDateOption.d.ts +1 -1
- package/dist/models/SpecificDateOption.js +1 -1
- package/dist/models/SubscriptionType.d.ts +1 -1
- package/dist/models/SubscriptionType.js +1 -1
- package/dist/models/SwitchWorkspaceResponse.d.ts +1 -1
- package/dist/models/SwitchWorkspaceResponse.js +1 -1
- package/dist/models/SyncGoogleFormsResponse.d.ts +1 -1
- package/dist/models/SyncGoogleFormsResponse.js +1 -1
- package/dist/models/TestSlackIntegrationResponse.d.ts +1 -1
- package/dist/models/TestSlackIntegrationResponse.js +1 -1
- package/dist/models/ThankYouPagePayload.d.ts +1 -1
- package/dist/models/ThankYouPagePayload.js +1 -1
- package/dist/models/ThemeColor.d.ts +1 -1
- package/dist/models/ThemeColor.js +1 -1
- package/dist/models/ThemeColorThemeColorType.d.ts +1 -1
- package/dist/models/ThemeColorThemeColorType.js +1 -1
- package/dist/models/TimeOfDayConditionPayload.d.ts +1 -1
- package/dist/models/TimeOfDayConditionPayload.js +1 -1
- package/dist/models/TimeOfDayConditionTraceData.d.ts +1 -1
- package/dist/models/TimeOfDayConditionTraceData.js +1 -1
- package/dist/models/TimeOfDayConditionTraceRange.d.ts +1 -1
- package/dist/models/TimeOfDayConditionTraceRange.js +1 -1
- package/dist/models/TimeOfDayRange.d.ts +1 -1
- package/dist/models/TimeOfDayRange.js +1 -1
- package/dist/models/TimeSeriesPoint.d.ts +1 -1
- package/dist/models/TimeSeriesPoint.js +1 -1
- package/dist/models/TimeSeriesSeries.d.ts +1 -1
- package/dist/models/TimeSeriesSeries.js +1 -1
- package/dist/models/TopLinkDataPoint.d.ts +1 -1
- package/dist/models/TopLinkDataPoint.js +1 -1
- package/dist/models/TriggeredBy.d.ts +1 -1
- package/dist/models/TriggeredBy.js +1 -1
- package/dist/models/TypeDate.d.ts +1 -1
- package/dist/models/TypeDate.js +1 -1
- package/dist/models/UpdateCustomDomainResponse.d.ts +1 -1
- package/dist/models/UpdateCustomDomainResponse.js +1 -1
- package/dist/models/UpdateDashboardResponse.d.ts +1 -1
- package/dist/models/UpdateDashboardResponse.js +1 -1
- package/dist/models/UpdateDeviceResponse.d.ts +1 -1
- package/dist/models/UpdateDeviceResponse.js +1 -1
- package/dist/models/UpdateDirectoryResponse.d.ts +1 -1
- package/dist/models/UpdateDirectoryResponse.js +1 -1
- package/dist/models/UpdateGoogleFormsIntegrationRequest.d.ts +1 -1
- package/dist/models/UpdateGoogleFormsIntegrationRequest.js +1 -1
- package/dist/models/UpdateGoogleFormsIntegrationResponse.d.ts +1 -1
- package/dist/models/UpdateGoogleFormsIntegrationResponse.js +1 -1
- package/dist/models/UpdateLinkResponse.d.ts +1 -1
- package/dist/models/UpdateLinkResponse.js +1 -1
- package/dist/models/UpdateLinkSettingResponse.d.ts +1 -1
- package/dist/models/UpdateLinkSettingResponse.js +1 -1
- package/dist/models/UpdateMeRequest.d.ts +1 -1
- package/dist/models/UpdateMeRequest.js +1 -1
- package/dist/models/UpdatePageThemeResponse.d.ts +1 -1
- package/dist/models/UpdatePageThemeResponse.js +1 -1
- package/dist/models/UpdatePageThemeTemplateResponse.d.ts +1 -1
- package/dist/models/UpdatePageThemeTemplateResponse.js +1 -1
- package/dist/models/UpdatePageThemeTemplateStylingResponse.d.ts +1 -1
- package/dist/models/UpdatePageThemeTemplateStylingResponse.js +1 -1
- package/dist/models/UpdateQrcodeDesignResponse.d.ts +1 -1
- package/dist/models/UpdateQrcodeDesignResponse.js +1 -1
- package/dist/models/UpdateQrcodeTemplateResponse.d.ts +1 -1
- package/dist/models/UpdateQrcodeTemplateResponse.js +1 -1
- package/dist/models/UpdateSlackIntegrationRequest.d.ts +1 -1
- package/dist/models/UpdateSlackIntegrationRequest.js +1 -1
- package/dist/models/UpdateSlackIntegrationResponse.d.ts +1 -1
- package/dist/models/UpdateSlackIntegrationResponse.js +1 -1
- package/dist/models/UpdateWebhookResponse.d.ts +1 -1
- package/dist/models/UpdateWebhookResponse.js +1 -1
- package/dist/models/UpdateWorkflowStepResponse.d.ts +1 -1
- package/dist/models/UpdateWorkflowStepResponse.js +1 -1
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.d.ts +1 -1
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.js +1 -1
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.d.ts +1 -1
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.js +1 -1
- package/dist/models/UpdateWorkspaceRequest.d.ts +1 -1
- package/dist/models/UpdateWorkspaceRequest.js +1 -1
- package/dist/models/UpdateWorkspaceTokenResponse.d.ts +1 -1
- package/dist/models/UpdateWorkspaceTokenResponse.js +1 -1
- package/dist/models/VCardData.d.ts +1 -1
- package/dist/models/VCardData.js +1 -1
- package/dist/models/VCardPayload.d.ts +1 -1
- package/dist/models/VCardPayload.js +1 -1
- package/dist/models/VCardSocialLink.d.ts +1 -1
- package/dist/models/VCardSocialLink.js +1 -1
- package/dist/models/ValidateWorkflowResponse.d.ts +1 -1
- package/dist/models/ValidateWorkflowResponse.js +1 -1
- package/dist/models/ValidationInstructionsCustomDomainResponse.d.ts +1 -1
- package/dist/models/ValidationInstructionsCustomDomainResponse.js +1 -1
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.d.ts +1 -1
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.js +1 -1
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.d.ts +1 -1
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.js +1 -1
- package/dist/models/ValidationPurpose.d.ts +1 -1
- package/dist/models/ValidationPurpose.js +1 -1
- package/dist/models/VisitType.d.ts +1 -1
- package/dist/models/VisitType.js +1 -1
- package/dist/models/VisitTypeConditionOption.d.ts +1 -1
- package/dist/models/VisitTypeConditionOption.js +1 -1
- package/dist/models/VisitTypeConditionPayload.d.ts +1 -1
- package/dist/models/VisitTypeConditionPayload.js +1 -1
- package/dist/models/VisitTypeConditionTraceData.d.ts +1 -1
- package/dist/models/VisitTypeConditionTraceData.js +1 -1
- package/dist/models/VisitTypeConditionTraceOption.d.ts +1 -1
- package/dist/models/VisitTypeConditionTraceOption.js +1 -1
- package/dist/models/Visitor.d.ts +1 -1
- package/dist/models/Visitor.js +1 -1
- package/dist/models/VisitorAttribute.d.ts +1 -1
- package/dist/models/VisitorAttribute.js +1 -1
- package/dist/models/VisitorAttributeFilter.d.ts +1 -1
- package/dist/models/VisitorAttributeFilter.js +1 -1
- package/dist/models/VisitorAttributeFilterOperator.d.ts +1 -1
- package/dist/models/VisitorAttributeFilterOperator.js +1 -1
- package/dist/models/VisitorAttributeKey.d.ts +1 -1
- package/dist/models/VisitorAttributeKey.js +1 -1
- package/dist/models/VisitorAttributeType.d.ts +1 -1
- package/dist/models/VisitorAttributeType.js +1 -1
- package/dist/models/VisitorDataConditionOption.d.ts +1 -1
- package/dist/models/VisitorDataConditionOption.js +1 -1
- package/dist/models/VisitorDataConditionPayload.d.ts +1 -1
- package/dist/models/VisitorDataConditionPayload.js +1 -1
- package/dist/models/VisitorDataConditionTraceData.d.ts +1 -1
- package/dist/models/VisitorDataConditionTraceData.js +1 -1
- package/dist/models/VisitorDataConditionTraceOption.d.ts +1 -1
- package/dist/models/VisitorDataConditionTraceOption.js +1 -1
- package/dist/models/VisitorEvent.d.ts +1 -1
- package/dist/models/VisitorEvent.js +1 -1
- package/dist/models/VisitorInput.d.ts +1 -1
- package/dist/models/VisitorInput.js +1 -1
- package/dist/models/VisitorLink.d.ts +1 -1
- package/dist/models/VisitorLink.js +1 -1
- package/dist/models/VisitorSortField.d.ts +1 -1
- package/dist/models/VisitorSortField.js +1 -1
- package/dist/models/VisitorTrendDataPoint.d.ts +1 -1
- package/dist/models/VisitorTrendDataPoint.js +1 -1
- package/dist/models/VisitorsServiceUpdateBody.d.ts +1 -1
- package/dist/models/VisitorsServiceUpdateBody.js +1 -1
- package/dist/models/Webhook.d.ts +1 -1
- package/dist/models/Webhook.js +1 -1
- package/dist/models/WebhookSource.d.ts +1 -1
- package/dist/models/WebhookSource.js +1 -1
- package/dist/models/WebhookStatus.d.ts +1 -1
- package/dist/models/WebhookStatus.js +1 -1
- package/dist/models/WebhooksServiceUpdateBody.d.ts +1 -1
- package/dist/models/WebhooksServiceUpdateBody.js +1 -1
- package/dist/models/WidgetDataSource.d.ts +1 -1
- package/dist/models/WidgetDataSource.js +1 -1
- package/dist/models/WidgetFieldMapping.d.ts +1 -1
- package/dist/models/WidgetFieldMapping.js +1 -1
- package/dist/models/WidgetPosition.d.ts +1 -1
- package/dist/models/WidgetPosition.js +1 -1
- package/dist/models/WidgetSize.d.ts +1 -1
- package/dist/models/WidgetSize.js +1 -1
- package/dist/models/WidgetTab.d.ts +1 -1
- package/dist/models/WidgetTab.js +1 -1
- package/dist/models/WidgetTabMode.d.ts +1 -1
- package/dist/models/WidgetTabMode.js +1 -1
- package/dist/models/WidgetTabView.d.ts +1 -1
- package/dist/models/WidgetTabView.js +1 -1
- package/dist/models/WidgetVisualization.d.ts +1 -1
- package/dist/models/WidgetVisualization.js +1 -1
- package/dist/models/WorkflowIssue.d.ts +1 -1
- package/dist/models/WorkflowIssue.js +1 -1
- package/dist/models/WorkflowStep.d.ts +9 -9
- package/dist/models/WorkflowStep.js +2 -2
- package/dist/models/WorkflowStepBranch.d.ts +1 -1
- package/dist/models/WorkflowStepBranch.js +1 -1
- package/dist/models/WorkflowStepKind.d.ts +1 -1
- package/dist/models/WorkflowStepKind.js +1 -1
- package/dist/models/WorkflowStepNodeType.d.ts +1 -1
- package/dist/models/WorkflowStepNodeType.js +1 -1
- package/dist/models/WorkflowStepPayload.d.ts +8 -8
- package/dist/models/WorkflowStepPayload.js +4 -4
- package/dist/models/WorkflowStepsServiceConnectStepBody.d.ts +1 -1
- package/dist/models/WorkflowStepsServiceConnectStepBody.js +1 -1
- package/dist/models/WorkflowStepsServiceCreateBody.d.ts +9 -9
- package/dist/models/WorkflowStepsServiceCreateBody.js +2 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.d.ts +1 -1
- package/dist/models/WorkflowStepsServiceUpdateBody.js +1 -1
- package/dist/models/Workspace.d.ts +1 -1
- package/dist/models/Workspace.js +1 -1
- package/dist/models/WorkspaceAllowance.d.ts +1 -1
- package/dist/models/WorkspaceAllowance.js +1 -1
- package/dist/models/WorkspaceInsight.d.ts +1 -1
- package/dist/models/WorkspaceInsight.js +1 -1
- package/dist/models/WorkspaceMetric.d.ts +1 -1
- package/dist/models/WorkspaceMetric.js +1 -1
- package/dist/models/WorkspaceToken.d.ts +1 -1
- package/dist/models/WorkspaceToken.js +1 -1
- package/dist/models/WorkspaceTokenKeyType.d.ts +1 -1
- package/dist/models/WorkspaceTokenKeyType.js +1 -1
- package/dist/models/WorkspaceTokensServiceUpdateBody.d.ts +1 -1
- package/dist/models/WorkspaceTokensServiceUpdateBody.js +1 -1
- package/dist/models/index.d.ts +10 -4
- package/dist/models/index.js +10 -4
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/package.json +1 -1
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Linkbreakers API
|
|
6
6
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.179.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Linkbreakers API
|
|
3
3
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.179.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Linkbreakers API
|
|
6
6
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.179.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/apis/JobsApi.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Linkbreakers API
|
|
3
3
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.179.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/apis/JobsApi.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Linkbreakers API
|
|
6
6
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.179.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Linkbreakers API
|
|
3
3
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.179.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Linkbreakers API
|
|
6
6
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.179.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/apis/LinksApi.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Linkbreakers API
|
|
3
3
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.179.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateBulkLinksRequest, CreateBulkLinksResponse, CreateContactLinkRequest, CreateContactLinkResponse,
|
|
13
|
+
import type { CreateBulkLinksRequest, CreateBulkLinksResponse, CreateContactLinkRequest, CreateContactLinkResponse, CreateLinkRequest, CreateLinkResponse, CreateOpenMediaLinkRequest, CreateOpenMediaLinkResponse, CreateThankYouLinkRequest, CreateThankYouLinkResponse, GetLinkResponse, Job, LinksServiceUpdateBody, ListLinksResponse, ResolveQrcodeImagesRequest, ResolveQrcodeImagesResponse, ShortlinkAvailabilityResponse, ShortlinkRandomResponse, UpdateLinkResponse } from '../models/index';
|
|
14
14
|
export interface LinksServiceCreateRequest {
|
|
15
15
|
createLinkRequest: CreateLinkRequest;
|
|
16
16
|
idempotencyKey?: string;
|
|
@@ -31,8 +31,8 @@ export interface LinksServiceCreateContactLinkRequest {
|
|
|
31
31
|
createContactLinkRequest: CreateContactLinkRequest;
|
|
32
32
|
idempotencyKey?: string;
|
|
33
33
|
}
|
|
34
|
-
export interface
|
|
35
|
-
|
|
34
|
+
export interface LinksServiceCreateOpenMediaLinkRequest {
|
|
35
|
+
createOpenMediaLinkRequest: CreateOpenMediaLinkRequest;
|
|
36
36
|
idempotencyKey?: string;
|
|
37
37
|
}
|
|
38
38
|
export interface LinksServiceCreateThankYouLinkRequest {
|
|
@@ -194,28 +194,28 @@ export interface LinksApiInterface {
|
|
|
194
194
|
*/
|
|
195
195
|
linksServiceCreateContactLink(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateContactLinkResponse>;
|
|
196
196
|
/**
|
|
197
|
-
* Creates request options for
|
|
198
|
-
* @param {
|
|
197
|
+
* Creates request options for linksServiceCreateOpenMediaLink without sending the request
|
|
198
|
+
* @param {CreateOpenMediaLinkRequest} createOpenMediaLinkRequest
|
|
199
199
|
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
200
200
|
* @throws {RequiredError}
|
|
201
201
|
* @memberof LinksApiInterface
|
|
202
202
|
*/
|
|
203
|
-
|
|
203
|
+
linksServiceCreateOpenMediaLinkRequestOpts(requestParameters: LinksServiceCreateOpenMediaLinkRequest): Promise<runtime.RequestOpts>;
|
|
204
204
|
/**
|
|
205
|
-
* Creates a link, and its QR code, that hands visitors
|
|
206
|
-
* @summary Create a new
|
|
207
|
-
* @param {
|
|
205
|
+
* Creates a link, and its QR code, that hands visitors one piece of media from the media library: a PDF (a menu or brochure), an image (PNG, JPEG, WebP, SVG) or an MP4 video. Upload the media first (POST /v1/media, or a direct upload for media over 3 MB; no usage is needed), then pass its media_id. Any media of the library can be opened. The Open media step is the exit step. Swap the media later by pointing the step at another media item. Requires the `links:write` scope.
|
|
206
|
+
* @summary Create a new media link
|
|
207
|
+
* @param {CreateOpenMediaLinkRequest} createOpenMediaLinkRequest
|
|
208
208
|
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
209
209
|
* @param {*} [options] Override http request option.
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
* @memberof LinksApiInterface
|
|
212
212
|
*/
|
|
213
|
-
|
|
213
|
+
linksServiceCreateOpenMediaLinkRaw(requestParameters: LinksServiceCreateOpenMediaLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOpenMediaLinkResponse>>;
|
|
214
214
|
/**
|
|
215
|
-
* Creates a link, and its QR code, that hands visitors
|
|
216
|
-
* Create a new
|
|
215
|
+
* Creates a link, and its QR code, that hands visitors one piece of media from the media library: a PDF (a menu or brochure), an image (PNG, JPEG, WebP, SVG) or an MP4 video. Upload the media first (POST /v1/media, or a direct upload for media over 3 MB; no usage is needed), then pass its media_id. Any media of the library can be opened. The Open media step is the exit step. Swap the media later by pointing the step at another media item. Requires the `links:write` scope.
|
|
216
|
+
* Create a new media link
|
|
217
217
|
*/
|
|
218
|
-
|
|
218
|
+
linksServiceCreateOpenMediaLink(requestParameters: LinksServiceCreateOpenMediaLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOpenMediaLinkResponse>;
|
|
219
219
|
/**
|
|
220
220
|
* Creates request options for linksServiceCreateThankYouLink without sending the request
|
|
221
221
|
* @param {CreateThankYouLinkRequest} createThankYouLinkRequest
|
|
@@ -488,19 +488,19 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
|
|
|
488
488
|
*/
|
|
489
489
|
linksServiceCreateContactLink(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateContactLinkResponse>;
|
|
490
490
|
/**
|
|
491
|
-
* Creates request options for
|
|
491
|
+
* Creates request options for linksServiceCreateOpenMediaLink without sending the request
|
|
492
492
|
*/
|
|
493
|
-
|
|
493
|
+
linksServiceCreateOpenMediaLinkRequestOpts(requestParameters: LinksServiceCreateOpenMediaLinkRequest): Promise<runtime.RequestOpts>;
|
|
494
494
|
/**
|
|
495
|
-
* Creates a link, and its QR code, that hands visitors
|
|
496
|
-
* Create a new
|
|
495
|
+
* Creates a link, and its QR code, that hands visitors one piece of media from the media library: a PDF (a menu or brochure), an image (PNG, JPEG, WebP, SVG) or an MP4 video. Upload the media first (POST /v1/media, or a direct upload for media over 3 MB; no usage is needed), then pass its media_id. Any media of the library can be opened. The Open media step is the exit step. Swap the media later by pointing the step at another media item. Requires the `links:write` scope.
|
|
496
|
+
* Create a new media link
|
|
497
497
|
*/
|
|
498
|
-
|
|
498
|
+
linksServiceCreateOpenMediaLinkRaw(requestParameters: LinksServiceCreateOpenMediaLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOpenMediaLinkResponse>>;
|
|
499
499
|
/**
|
|
500
|
-
* Creates a link, and its QR code, that hands visitors
|
|
501
|
-
* Create a new
|
|
500
|
+
* Creates a link, and its QR code, that hands visitors one piece of media from the media library: a PDF (a menu or brochure), an image (PNG, JPEG, WebP, SVG) or an MP4 video. Upload the media first (POST /v1/media, or a direct upload for media over 3 MB; no usage is needed), then pass its media_id. Any media of the library can be opened. The Open media step is the exit step. Swap the media later by pointing the step at another media item. Requires the `links:write` scope.
|
|
501
|
+
* Create a new media link
|
|
502
502
|
*/
|
|
503
|
-
|
|
503
|
+
linksServiceCreateOpenMediaLink(requestParameters: LinksServiceCreateOpenMediaLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOpenMediaLinkResponse>;
|
|
504
504
|
/**
|
|
505
505
|
* Creates request options for linksServiceCreateThankYouLink without sending the request
|
|
506
506
|
*/
|
package/dist/apis/LinksApi.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Linkbreakers API
|
|
6
6
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.179.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -304,11 +304,11 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
304
304
|
return await response.value();
|
|
305
305
|
}
|
|
306
306
|
/**
|
|
307
|
-
* Creates request options for
|
|
307
|
+
* Creates request options for linksServiceCreateOpenMediaLink without sending the request
|
|
308
308
|
*/
|
|
309
|
-
async
|
|
310
|
-
if (requestParameters['
|
|
311
|
-
throw new runtime.RequiredError('
|
|
309
|
+
async linksServiceCreateOpenMediaLinkRequestOpts(requestParameters) {
|
|
310
|
+
if (requestParameters['createOpenMediaLinkRequest'] == null) {
|
|
311
|
+
throw new runtime.RequiredError('createOpenMediaLinkRequest', 'Required parameter "createOpenMediaLinkRequest" was null or undefined when calling linksServiceCreateOpenMediaLink().');
|
|
312
312
|
}
|
|
313
313
|
const queryParameters = {};
|
|
314
314
|
const headerParameters = {};
|
|
@@ -327,30 +327,30 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
327
327
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
328
328
|
}
|
|
329
329
|
}
|
|
330
|
-
let urlPath = `/v1/links/
|
|
330
|
+
let urlPath = `/v1/links/open-media`;
|
|
331
331
|
return {
|
|
332
332
|
path: urlPath,
|
|
333
333
|
method: 'POST',
|
|
334
334
|
headers: headerParameters,
|
|
335
335
|
query: queryParameters,
|
|
336
|
-
body: (0, index_1.
|
|
336
|
+
body: (0, index_1.CreateOpenMediaLinkRequestToJSON)(requestParameters['createOpenMediaLinkRequest']),
|
|
337
337
|
};
|
|
338
338
|
}
|
|
339
339
|
/**
|
|
340
|
-
* Creates a link, and its QR code, that hands visitors
|
|
341
|
-
* Create a new
|
|
340
|
+
* Creates a link, and its QR code, that hands visitors one piece of media from the media library: a PDF (a menu or brochure), an image (PNG, JPEG, WebP, SVG) or an MP4 video. Upload the media first (POST /v1/media, or a direct upload for media over 3 MB; no usage is needed), then pass its media_id. Any media of the library can be opened. The Open media step is the exit step. Swap the media later by pointing the step at another media item. Requires the `links:write` scope.
|
|
341
|
+
* Create a new media link
|
|
342
342
|
*/
|
|
343
|
-
async
|
|
344
|
-
const requestOptions = await this.
|
|
343
|
+
async linksServiceCreateOpenMediaLinkRaw(requestParameters, initOverrides) {
|
|
344
|
+
const requestOptions = await this.linksServiceCreateOpenMediaLinkRequestOpts(requestParameters);
|
|
345
345
|
const response = await this.request(requestOptions, initOverrides);
|
|
346
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.
|
|
346
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateOpenMediaLinkResponseFromJSON)(jsonValue));
|
|
347
347
|
}
|
|
348
348
|
/**
|
|
349
|
-
* Creates a link, and its QR code, that hands visitors
|
|
350
|
-
* Create a new
|
|
349
|
+
* Creates a link, and its QR code, that hands visitors one piece of media from the media library: a PDF (a menu or brochure), an image (PNG, JPEG, WebP, SVG) or an MP4 video. Upload the media first (POST /v1/media, or a direct upload for media over 3 MB; no usage is needed), then pass its media_id. Any media of the library can be opened. The Open media step is the exit step. Swap the media later by pointing the step at another media item. Requires the `links:write` scope.
|
|
350
|
+
* Create a new media link
|
|
351
351
|
*/
|
|
352
|
-
async
|
|
353
|
-
const response = await this.
|
|
352
|
+
async linksServiceCreateOpenMediaLink(requestParameters, initOverrides) {
|
|
353
|
+
const response = await this.linksServiceCreateOpenMediaLinkRaw(requestParameters, initOverrides);
|
|
354
354
|
return await response.value();
|
|
355
355
|
}
|
|
356
356
|
/**
|
package/dist/apis/MediaApi.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Linkbreakers API
|
|
3
3
|
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.179.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CompleteMediaUploadResponse, CreateMediaRequest, CreateMediaResponse, CreateMediaUploadRequest, CreateMediaUploadResponse, GetMediaResponse, ListMediaResponse } from '../models/index';
|
|
13
|
+
import type { CompleteMediaUploadResponse, CreateMediaRequest, CreateMediaResponse, CreateMediaUploadRequest, CreateMediaUploadResponse, GetMediaResponse, ImportMediaRequest, ImportMediaResponse, ListMediaResponse } from '../models/index';
|
|
14
14
|
export interface MediaServiceCompleteUploadRequest {
|
|
15
15
|
id: string;
|
|
16
16
|
body: object;
|
|
@@ -30,11 +30,16 @@ export interface MediaServiceDeleteRequest {
|
|
|
30
30
|
export interface MediaServiceGetRequest {
|
|
31
31
|
id: string;
|
|
32
32
|
}
|
|
33
|
+
export interface MediaServiceImportRequest {
|
|
34
|
+
importMediaRequest: ImportMediaRequest;
|
|
35
|
+
idempotencyKey?: string;
|
|
36
|
+
}
|
|
33
37
|
export interface MediaServiceListRequest {
|
|
34
38
|
pageSize: number;
|
|
35
39
|
pageToken?: string;
|
|
36
40
|
usage?: string;
|
|
37
41
|
kind?: string;
|
|
42
|
+
uploadedFrom?: string;
|
|
38
43
|
cursor?: string;
|
|
39
44
|
}
|
|
40
45
|
/**
|
|
@@ -78,7 +83,7 @@ export interface MediaApiInterface {
|
|
|
78
83
|
*/
|
|
79
84
|
mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise<runtime.RequestOpts>;
|
|
80
85
|
/**
|
|
81
|
-
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload.
|
|
86
|
+
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. A media item only has a kind, read from its bytes: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB. Nothing about where it will be used is needed at upload: any image can then be a QR code logo, a background cover, a badge or a footer logo (up to 3 MB for those), and any media can be opened by an Open media step. Requires the `media:write` scope.
|
|
82
87
|
* @summary Upload a media file
|
|
83
88
|
* @param {CreateMediaRequest} createMediaRequest
|
|
84
89
|
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
@@ -88,7 +93,7 @@ export interface MediaApiInterface {
|
|
|
88
93
|
*/
|
|
89
94
|
mediaServiceCreateRaw(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaResponse>>;
|
|
90
95
|
/**
|
|
91
|
-
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload.
|
|
96
|
+
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. A media item only has a kind, read from its bytes: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB. Nothing about where it will be used is needed at upload: any image can then be a QR code logo, a background cover, a badge or a footer logo (up to 3 MB for those), and any media can be opened by an Open media step. Requires the `media:write` scope.
|
|
92
97
|
* Upload a media file
|
|
93
98
|
*/
|
|
94
99
|
mediaServiceCreate(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaResponse>;
|
|
@@ -101,7 +106,7 @@ export interface MediaApiInterface {
|
|
|
101
106
|
*/
|
|
102
107
|
mediaServiceCreateUploadRequestOpts(requestParameters: MediaServiceCreateUploadRequest): Promise<runtime.RequestOpts>;
|
|
103
108
|
/**
|
|
104
|
-
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name,
|
|
109
|
+
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, MIME type and exact size in bytes; they are checked against the limit for the file\'s kind (images up to 10 MB, PDF documents up to 25 MB, MP4 videos up to 50 MB) and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded. Requires the `media:write` scope.
|
|
105
110
|
* @summary Start a direct media upload
|
|
106
111
|
* @param {CreateMediaUploadRequest} createMediaUploadRequest
|
|
107
112
|
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
@@ -111,7 +116,7 @@ export interface MediaApiInterface {
|
|
|
111
116
|
*/
|
|
112
117
|
mediaServiceCreateUploadRaw(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaUploadResponse>>;
|
|
113
118
|
/**
|
|
114
|
-
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name,
|
|
119
|
+
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, MIME type and exact size in bytes; they are checked against the limit for the file\'s kind (images up to 10 MB, PDF documents up to 25 MB, MP4 videos up to 50 MB) and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded. Requires the `media:write` scope.
|
|
115
120
|
* Start a direct media upload
|
|
116
121
|
*/
|
|
117
122
|
mediaServiceCreateUpload(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaUploadResponse>;
|
|
@@ -123,7 +128,7 @@ export interface MediaApiInterface {
|
|
|
123
128
|
*/
|
|
124
129
|
mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise<runtime.RequestOpts>;
|
|
125
130
|
/**
|
|
126
|
-
* Removes a media file from the workspace and frees its storage. This operation cannot be undone.
|
|
131
|
+
* Removes a media file from the workspace and frees its storage. This operation cannot be undone. Media still opened by an Open media step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at other media first. Deleting an image a page theme or a QR code design uses is allowed: the page theme loses the image, and a QR code keeps its own copy of the logo. Requires the `media:write` scope.
|
|
127
132
|
* @summary Delete a media file
|
|
128
133
|
* @param {string} id The ID of the media file to delete (UUID)
|
|
129
134
|
* @param {*} [options] Override http request option.
|
|
@@ -132,7 +137,7 @@ export interface MediaApiInterface {
|
|
|
132
137
|
*/
|
|
133
138
|
mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
134
139
|
/**
|
|
135
|
-
* Removes a media file from the workspace and frees its storage. This operation cannot be undone.
|
|
140
|
+
* Removes a media file from the workspace and frees its storage. This operation cannot be undone. Media still opened by an Open media step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at other media first. Deleting an image a page theme or a QR code design uses is allowed: the page theme loses the image, and a QR code keeps its own copy of the logo. Requires the `media:write` scope.
|
|
136
141
|
* Delete a media file
|
|
137
142
|
*/
|
|
138
143
|
mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -157,24 +162,49 @@ export interface MediaApiInterface {
|
|
|
157
162
|
* Get media file details
|
|
158
163
|
*/
|
|
159
164
|
mediaServiceGet(requestParameters: MediaServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetMediaResponse>;
|
|
165
|
+
/**
|
|
166
|
+
* Creates request options for mediaServiceImport without sending the request
|
|
167
|
+
* @param {ImportMediaRequest} importMediaRequest
|
|
168
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
* @memberof MediaApiInterface
|
|
171
|
+
*/
|
|
172
|
+
mediaServiceImportRequestOpts(requestParameters: MediaServiceImportRequest): Promise<runtime.RequestOpts>;
|
|
173
|
+
/**
|
|
174
|
+
* Fetches a file server-side and stores it as a READY media item, so a file that is already online, or one attached to an Assistant conversation, never has to be downloaded and uploaded again. Give exactly one source: url, a public https address the file is downloaded from, or assistant_attachment_id, a file the caller attached to their own Assistant conversation. The kind is read from the file\'s bytes, never from its name or a Content-Type header, and the same limits as every upload apply: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB, within the workspace\'s media storage allowance. A URL must be https on port 443 and resolve to a public address; redirects are followed only to other such URLs, at most five. Requires the `media:write` scope.
|
|
175
|
+
* @summary Import a media file from a URL
|
|
176
|
+
* @param {ImportMediaRequest} importMediaRequest
|
|
177
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
* @memberof MediaApiInterface
|
|
181
|
+
*/
|
|
182
|
+
mediaServiceImportRaw(requestParameters: MediaServiceImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportMediaResponse>>;
|
|
183
|
+
/**
|
|
184
|
+
* Fetches a file server-side and stores it as a READY media item, so a file that is already online, or one attached to an Assistant conversation, never has to be downloaded and uploaded again. Give exactly one source: url, a public https address the file is downloaded from, or assistant_attachment_id, a file the caller attached to their own Assistant conversation. The kind is read from the file\'s bytes, never from its name or a Content-Type header, and the same limits as every upload apply: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB, within the workspace\'s media storage allowance. A URL must be https on port 443 and resolve to a public address; redirects are followed only to other such URLs, at most five. Requires the `media:write` scope.
|
|
185
|
+
* Import a media file from a URL
|
|
186
|
+
*/
|
|
187
|
+
mediaServiceImport(requestParameters: MediaServiceImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportMediaResponse>;
|
|
160
188
|
/**
|
|
161
189
|
* Creates request options for mediaServiceList without sending the request
|
|
162
190
|
* @param {number} pageSize The maximum number of media files to return.
|
|
163
191
|
* @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
|
|
164
|
-
* @param {string} [usage]
|
|
192
|
+
* @param {string} [usage] Deprecated: filter by uploaded_from instead. Still matches the value recorded at upload, which says nothing about where the media is used. - USAGE_UNSPECIFIED: Not set - USAGE_CENTRAL_QRCODE_IMAGE: The logo in the center of a QR code - USAGE_BACKGROUND_COVER: A page theme\'s background cover - USAGE_BADGE: A page theme\'s badge image - USAGE_FOOTER_LOGO: A page theme\'s footer logo - USAGE_OPEN_MEDIA: Media an Open media workflow step hands to visitors: a PDF menu or brochure, an image or an MP4 video
|
|
165
193
|
* @param {string} [kind] Only media of this kind. Unset lists every kind. - KIND_UNSPECIFIED: Not set - KIND_IMAGE: A PNG, JPEG, WebP or SVG image - KIND_DOCUMENT: A PDF document - KIND_VIDEO: An MP4 video
|
|
194
|
+
* @param {string} [uploadedFrom] Only media uploaded from this place. Unset lists media from everywhere. Where media was uploaded from says nothing about where it can be used: read references for that. - UPLOAD_ORIGIN_UNSPECIFIED: Not set. Uploads that do not say where they come from are recorded as UPLOAD_ORIGIN_MEDIA_LIBRARY. - UPLOAD_ORIGIN_MEDIA_LIBRARY: Uploaded from the media library itself - UPLOAD_ORIGIN_QR_CODE_LOGO: Uploaded while picking a QR code\'s logo - UPLOAD_ORIGIN_BACKGROUND_COVER: Uploaded while picking a page theme\'s background cover - UPLOAD_ORIGIN_BADGE: Uploaded while picking a page theme\'s badge - UPLOAD_ORIGIN_FOOTER_LOGO: Uploaded while picking a page theme\'s footer logo - UPLOAD_ORIGIN_OPEN_MEDIA: Uploaded while picking the media an Open media step opens - UPLOAD_ORIGIN_ASSISTANT: Imported by the Assistant, from a file attached to a conversation or a URL
|
|
166
195
|
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
167
196
|
* @throws {RequiredError}
|
|
168
197
|
* @memberof MediaApiInterface
|
|
169
198
|
*/
|
|
170
199
|
mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise<runtime.RequestOpts>;
|
|
171
200
|
/**
|
|
172
|
-
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one
|
|
201
|
+
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one kind or to where they were uploaded from. total_count is every item matching the filters across all pages. Each item lists its references: where it is used. Requires the `media:read` scope.
|
|
173
202
|
* @summary List media files
|
|
174
203
|
* @param {number} pageSize The maximum number of media files to return.
|
|
175
204
|
* @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
|
|
176
|
-
* @param {string} [usage]
|
|
205
|
+
* @param {string} [usage] Deprecated: filter by uploaded_from instead. Still matches the value recorded at upload, which says nothing about where the media is used. - USAGE_UNSPECIFIED: Not set - USAGE_CENTRAL_QRCODE_IMAGE: The logo in the center of a QR code - USAGE_BACKGROUND_COVER: A page theme\'s background cover - USAGE_BADGE: A page theme\'s badge image - USAGE_FOOTER_LOGO: A page theme\'s footer logo - USAGE_OPEN_MEDIA: Media an Open media workflow step hands to visitors: a PDF menu or brochure, an image or an MP4 video
|
|
177
206
|
* @param {string} [kind] Only media of this kind. Unset lists every kind. - KIND_UNSPECIFIED: Not set - KIND_IMAGE: A PNG, JPEG, WebP or SVG image - KIND_DOCUMENT: A PDF document - KIND_VIDEO: An MP4 video
|
|
207
|
+
* @param {string} [uploadedFrom] Only media uploaded from this place. Unset lists media from everywhere. Where media was uploaded from says nothing about where it can be used: read references for that. - UPLOAD_ORIGIN_UNSPECIFIED: Not set. Uploads that do not say where they come from are recorded as UPLOAD_ORIGIN_MEDIA_LIBRARY. - UPLOAD_ORIGIN_MEDIA_LIBRARY: Uploaded from the media library itself - UPLOAD_ORIGIN_QR_CODE_LOGO: Uploaded while picking a QR code\'s logo - UPLOAD_ORIGIN_BACKGROUND_COVER: Uploaded while picking a page theme\'s background cover - UPLOAD_ORIGIN_BADGE: Uploaded while picking a page theme\'s badge - UPLOAD_ORIGIN_FOOTER_LOGO: Uploaded while picking a page theme\'s footer logo - UPLOAD_ORIGIN_OPEN_MEDIA: Uploaded while picking the media an Open media step opens - UPLOAD_ORIGIN_ASSISTANT: Imported by the Assistant, from a file attached to a conversation or a URL
|
|
178
208
|
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
179
209
|
* @param {*} [options] Override http request option.
|
|
180
210
|
* @throws {RequiredError}
|
|
@@ -182,7 +212,7 @@ export interface MediaApiInterface {
|
|
|
182
212
|
*/
|
|
183
213
|
mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMediaResponse>>;
|
|
184
214
|
/**
|
|
185
|
-
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one
|
|
215
|
+
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one kind or to where they were uploaded from. total_count is every item matching the filters across all pages. Each item lists its references: where it is used. Requires the `media:read` scope.
|
|
186
216
|
* List media files
|
|
187
217
|
*/
|
|
188
218
|
mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMediaResponse>;
|
|
@@ -210,12 +240,12 @@ export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterfa
|
|
|
210
240
|
*/
|
|
211
241
|
mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise<runtime.RequestOpts>;
|
|
212
242
|
/**
|
|
213
|
-
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload.
|
|
243
|
+
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. A media item only has a kind, read from its bytes: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB. Nothing about where it will be used is needed at upload: any image can then be a QR code logo, a background cover, a badge or a footer logo (up to 3 MB for those), and any media can be opened by an Open media step. Requires the `media:write` scope.
|
|
214
244
|
* Upload a media file
|
|
215
245
|
*/
|
|
216
246
|
mediaServiceCreateRaw(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaResponse>>;
|
|
217
247
|
/**
|
|
218
|
-
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload.
|
|
248
|
+
* Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. A media item only has a kind, read from its bytes: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB. Nothing about where it will be used is needed at upload: any image can then be a QR code logo, a background cover, a badge or a footer logo (up to 3 MB for those), and any media can be opened by an Open media step. Requires the `media:write` scope.
|
|
219
249
|
* Upload a media file
|
|
220
250
|
*/
|
|
221
251
|
mediaServiceCreate(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaResponse>;
|
|
@@ -224,12 +254,12 @@ export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterfa
|
|
|
224
254
|
*/
|
|
225
255
|
mediaServiceCreateUploadRequestOpts(requestParameters: MediaServiceCreateUploadRequest): Promise<runtime.RequestOpts>;
|
|
226
256
|
/**
|
|
227
|
-
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name,
|
|
257
|
+
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, MIME type and exact size in bytes; they are checked against the limit for the file\'s kind (images up to 10 MB, PDF documents up to 25 MB, MP4 videos up to 50 MB) and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded. Requires the `media:write` scope.
|
|
228
258
|
* Start a direct media upload
|
|
229
259
|
*/
|
|
230
260
|
mediaServiceCreateUploadRaw(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaUploadResponse>>;
|
|
231
261
|
/**
|
|
232
|
-
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name,
|
|
262
|
+
* Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, MIME type and exact size in bytes; they are checked against the limit for the file\'s kind (images up to 10 MB, PDF documents up to 25 MB, MP4 videos up to 50 MB) and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded. Requires the `media:write` scope.
|
|
233
263
|
* Start a direct media upload
|
|
234
264
|
*/
|
|
235
265
|
mediaServiceCreateUpload(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaUploadResponse>;
|
|
@@ -238,12 +268,12 @@ export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterfa
|
|
|
238
268
|
*/
|
|
239
269
|
mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise<runtime.RequestOpts>;
|
|
240
270
|
/**
|
|
241
|
-
* Removes a media file from the workspace and frees its storage. This operation cannot be undone.
|
|
271
|
+
* Removes a media file from the workspace and frees its storage. This operation cannot be undone. Media still opened by an Open media step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at other media first. Deleting an image a page theme or a QR code design uses is allowed: the page theme loses the image, and a QR code keeps its own copy of the logo. Requires the `media:write` scope.
|
|
242
272
|
* Delete a media file
|
|
243
273
|
*/
|
|
244
274
|
mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
245
275
|
/**
|
|
246
|
-
* Removes a media file from the workspace and frees its storage. This operation cannot be undone.
|
|
276
|
+
* Removes a media file from the workspace and frees its storage. This operation cannot be undone. Media still opened by an Open media step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at other media first. Deleting an image a page theme or a QR code design uses is allowed: the page theme loses the image, and a QR code keeps its own copy of the logo. Requires the `media:write` scope.
|
|
247
277
|
* Delete a media file
|
|
248
278
|
*/
|
|
249
279
|
mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -261,17 +291,31 @@ export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterfa
|
|
|
261
291
|
* Get media file details
|
|
262
292
|
*/
|
|
263
293
|
mediaServiceGet(requestParameters: MediaServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetMediaResponse>;
|
|
294
|
+
/**
|
|
295
|
+
* Creates request options for mediaServiceImport without sending the request
|
|
296
|
+
*/
|
|
297
|
+
mediaServiceImportRequestOpts(requestParameters: MediaServiceImportRequest): Promise<runtime.RequestOpts>;
|
|
298
|
+
/**
|
|
299
|
+
* Fetches a file server-side and stores it as a READY media item, so a file that is already online, or one attached to an Assistant conversation, never has to be downloaded and uploaded again. Give exactly one source: url, a public https address the file is downloaded from, or assistant_attachment_id, a file the caller attached to their own Assistant conversation. The kind is read from the file\'s bytes, never from its name or a Content-Type header, and the same limits as every upload apply: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB, within the workspace\'s media storage allowance. A URL must be https on port 443 and resolve to a public address; redirects are followed only to other such URLs, at most five. Requires the `media:write` scope.
|
|
300
|
+
* Import a media file from a URL
|
|
301
|
+
*/
|
|
302
|
+
mediaServiceImportRaw(requestParameters: MediaServiceImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportMediaResponse>>;
|
|
303
|
+
/**
|
|
304
|
+
* Fetches a file server-side and stores it as a READY media item, so a file that is already online, or one attached to an Assistant conversation, never has to be downloaded and uploaded again. Give exactly one source: url, a public https address the file is downloaded from, or assistant_attachment_id, a file the caller attached to their own Assistant conversation. The kind is read from the file\'s bytes, never from its name or a Content-Type header, and the same limits as every upload apply: images (PNG, JPEG, WebP, SVG) up to 10 MB, PDF documents up to 25 MB and MP4 videos up to 50 MB, within the workspace\'s media storage allowance. A URL must be https on port 443 and resolve to a public address; redirects are followed only to other such URLs, at most five. Requires the `media:write` scope.
|
|
305
|
+
* Import a media file from a URL
|
|
306
|
+
*/
|
|
307
|
+
mediaServiceImport(requestParameters: MediaServiceImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportMediaResponse>;
|
|
264
308
|
/**
|
|
265
309
|
* Creates request options for mediaServiceList without sending the request
|
|
266
310
|
*/
|
|
267
311
|
mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise<runtime.RequestOpts>;
|
|
268
312
|
/**
|
|
269
|
-
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one
|
|
313
|
+
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one kind or to where they were uploaded from. total_count is every item matching the filters across all pages. Each item lists its references: where it is used. Requires the `media:read` scope.
|
|
270
314
|
* List media files
|
|
271
315
|
*/
|
|
272
316
|
mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMediaResponse>>;
|
|
273
317
|
/**
|
|
274
|
-
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one
|
|
318
|
+
* Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one kind or to where they were uploaded from. total_count is every item matching the filters across all pages. Each item lists its references: where it is used. Requires the `media:read` scope.
|
|
275
319
|
* List media files
|
|
276
320
|
*/
|
|
277
321
|
mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMediaResponse>;
|