linkbreakers 1.176.0 → 1.177.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 +1 -1
- package/dist/apis/AssistantApi.js +1 -1
- 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 +43 -2
- package/dist/apis/LinksApi.js +51 -1
- package/dist/apis/MediaApi.d.ts +105 -14
- package/dist/apis/MediaApi.js +117 -7
- package/dist/apis/MembersApi.d.ts +1 -1
- package/dist/apis/MembersApi.js +1 -1
- package/dist/apis/PageThemeTemplatesApi.d.ts +5 -5
- package/dist/apis/PageThemeTemplatesApi.js +3 -3
- package/dist/apis/PageThemesApi.d.ts +5 -5
- package/dist/apis/PageThemesApi.js +3 -3
- 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/AssistantContextType.d.ts +1 -1
- package/dist/models/AssistantContextType.js +1 -1
- 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 +49 -0
- package/dist/models/BackButton.js +50 -0
- 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 +33 -0
- package/dist/models/CompleteMediaUploadResponse.js +49 -0
- 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/CreateFileLinkRequest.d.ts +126 -0
- package/dist/models/CreateFileLinkRequest.js +76 -0
- package/dist/models/CreateFileLinkResponse.d.ts +40 -0
- package/dist/models/CreateFileLinkResponse.js +51 -0
- 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 +10 -3
- 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 +58 -0
- package/dist/models/CreateMediaUploadRequest.js +66 -0
- package/dist/models/CreateMediaUploadResponse.d.ts +59 -0
- package/dist/models/CreateMediaUploadResponse.js +57 -0
- 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 +13 -3
- package/dist/models/EventAction.js +14 -4
- package/dist/models/EventTrace.d.ts +1 -1
- package/dist/models/EventTrace.js +1 -1
- package/dist/models/EventTraceData.d.ts +8 -1
- package/dist/models/EventTraceData.js +4 -1
- 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/FilePayload.d.ts +32 -0
- package/dist/models/FilePayload.js +50 -0
- package/dist/models/FileTraceData.d.ts +52 -0
- package/dist/models/FileTraceData.js +55 -0
- 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/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 +7 -1
- package/dist/models/ListMediaResponse.js +3 -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 +39 -5
- package/dist/models/Media.js +17 -1
- package/dist/models/MediaKind.d.ts +30 -0
- package/dist/models/MediaKind.js +56 -0
- package/dist/models/MediaSelection.d.ts +1 -1
- package/dist/models/MediaSelection.js +1 -1
- package/dist/models/MediaStatus.d.ts +28 -0
- package/dist/models/MediaStatus.js +54 -0
- package/dist/models/MediaType.d.ts +5 -1
- package/dist/models/MediaType.js +6 -2
- package/dist/models/MediaUsage.d.ts +38 -0
- package/dist/models/MediaUsage.js +64 -0
- 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/OutputFileFormat.d.ts +1 -1
- package/dist/models/OutputFileFormat.js +1 -1
- package/dist/models/PageTheme.d.ts +16 -1
- package/dist/models/PageTheme.js +5 -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 +13 -1
- package/dist/models/PageThemeStyling.js +5 -1
- package/dist/models/PageThemeTemplate.d.ts +7 -1
- package/dist/models/PageThemeTemplate.js +3 -1
- package/dist/models/PageThemeTemplateImages.d.ts +7 -1
- package/dist/models/PageThemeTemplateImages.js +3 -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 +13 -1
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.js +5 -1
- package/dist/models/PageThemesServiceUpdatePageThemeBody.d.ts +13 -1
- package/dist/models/PageThemesServiceUpdatePageThemeBody.js +5 -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 +3 -1
- package/dist/models/PlanLimit.js +3 -2
- package/dist/models/PlanLimitKey.d.ts +3 -1
- package/dist/models/PlanLimitKey.js +4 -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 -1
- package/dist/models/PreferredLinkType.js +4 -2
- 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 +1 -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 +7 -1
- package/dist/models/PublicPageThemeTemplate.js +3 -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 +1 -1
- package/dist/models/QrcodeDesign.js +1 -1
- package/dist/models/QrcodeDesignServiceUpdateBody.d.ts +1 -1
- package/dist/models/QrcodeDesignServiceUpdateBody.js +1 -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/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 +13 -1
- package/dist/models/VCardData.js +5 -1
- package/dist/models/VCardPayload.d.ts +13 -1
- package/dist/models/VCardPayload.js +5 -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 +30 -4
- package/dist/models/WorkflowStep.js +7 -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 -1
- package/dist/models/WorkflowStepPayload.js +4 -1
- package/dist/models/WorkflowStepsServiceConnectStepBody.d.ts +1 -1
- package/dist/models/WorkflowStepsServiceConnectStepBody.js +1 -1
- package/dist/models/WorkflowStepsServiceCreateBody.d.ts +23 -3
- package/dist/models/WorkflowStepsServiceCreateBody.js +6 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.d.ts +12 -1
- package/dist/models/WorkflowStepsServiceUpdateBody.js +4 -1
- package/dist/models/Workspace.d.ts +1 -1
- package/dist/models/Workspace.js +1 -1
- package/dist/models/WorkspaceAllowance.d.ts +13 -1
- package/dist/models/WorkspaceAllowance.js +5 -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 +11 -0
- package/dist/models/index.js +11 -0
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/package.json +1 -1
|
@@ -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.177.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { AttributeCapture } from './AttributeCapture';
|
|
13
13
|
import type { WorkflowStepPayload } from './WorkflowStepPayload';
|
|
14
|
+
import type { BackButton } from './BackButton';
|
|
14
15
|
import type { CanvasPosition } from './CanvasPosition';
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
@@ -24,6 +25,15 @@ export interface WorkflowStepsServiceCreateBody {
|
|
|
24
25
|
* @memberof WorkflowStepsServiceCreateBody
|
|
25
26
|
*/
|
|
26
27
|
attributeCapture?: AttributeCapture;
|
|
28
|
+
/**
|
|
29
|
+
* The page's optional back button, which returns the visitor to the
|
|
30
|
+
* previous page (such as the menu) without wiring a connection. Page steps
|
|
31
|
+
* only: MESSAGE_PAGE, MULTI_LINK, CONTACT_CARD, SOCIAL_LINKS_PAGE,
|
|
32
|
+
* FORM_SUBMIT, PASSWORD_VERIFY and THANK_YOU_PAGE. Hidden right after a scan.
|
|
33
|
+
* @type {BackButton}
|
|
34
|
+
* @memberof WorkflowStepsServiceCreateBody
|
|
35
|
+
*/
|
|
36
|
+
backButton?: BackButton;
|
|
27
37
|
/**
|
|
28
38
|
*
|
|
29
39
|
* @type {CanvasPosition}
|
|
@@ -40,7 +50,10 @@ export interface WorkflowStepsServiceCreateBody {
|
|
|
40
50
|
* - EVENT_ACTION_MULTI_LINK: A page of buttons where each one continues into more workflow: the button
|
|
41
51
|
* leads to a next step, not straight out. Records which button the visitor
|
|
42
52
|
* pressed, so use it over SOCIAL_LINKS_PAGE when that choice is worth
|
|
43
|
-
* measuring or when a branch needs to do more than redirect.
|
|
53
|
+
* measuring or when a branch needs to do more than redirect. This is the
|
|
54
|
+
* menu step: for several documents or PDFs, give each one a button
|
|
55
|
+
* connected to a FILE step for a file uploaded to the media library, or to
|
|
56
|
+
* a CLIENT_REDIRECT when the file is already hosted at a URL.
|
|
44
57
|
* - EVENT_ACTION_VISIT_TYPE_CONDITION: Route visitors based on whether it's a first or returning visit
|
|
45
58
|
* - EVENT_ACTION_COUNTRY_CONDITION: Route visitors based on their country location
|
|
46
59
|
* - EVENT_ACTION_DAY_OF_WEEK_CONDITION: Route visitors based on day of week
|
|
@@ -62,7 +75,13 @@ export interface WorkflowStepsServiceCreateBody {
|
|
|
62
75
|
* visitor automatically. It carries no list of destinations, so a page that
|
|
63
76
|
* should offer a choice between two or more places is not this step. Use
|
|
64
77
|
* SOCIAL_LINKS_PAGE when the choices leave for external URLs, or MULTI_LINK
|
|
65
|
-
* when each choice continues into more workflow.
|
|
78
|
+
* when each choice continues into more workflow. Never put links, documents
|
|
79
|
+
* or PDFs on it: it is a message, nothing else.
|
|
80
|
+
* - EVENT_ACTION_FILE: Hand the visitor an uploaded file (PDF, image or MP4 video), opened in their browser (exit step).
|
|
81
|
+
* The visitor is sent straight to the file, with no page of its own. The
|
|
82
|
+
* file is uploaded once to media with usage FILE and referenced by its
|
|
83
|
+
* media_id; swapping the file means pointing the step at another media
|
|
84
|
+
* item, and the QR code never changes.
|
|
66
85
|
* @type {WorkflowStepsServiceCreateBodyEventActionEnum}
|
|
67
86
|
* @memberof WorkflowStepsServiceCreateBody
|
|
68
87
|
*/
|
|
@@ -114,6 +133,7 @@ export declare const WorkflowStepsServiceCreateBodyEventActionEnum: {
|
|
|
114
133
|
readonly EventActionVisitorDataCondition: "EVENT_ACTION_VISITOR_DATA_CONDITION";
|
|
115
134
|
readonly EventActionThankYouPage: "EVENT_ACTION_THANK_YOU_PAGE";
|
|
116
135
|
readonly EventActionMessagePage: "EVENT_ACTION_MESSAGE_PAGE";
|
|
136
|
+
readonly EventActionFile: "EVENT_ACTION_FILE";
|
|
117
137
|
};
|
|
118
138
|
export type WorkflowStepsServiceCreateBodyEventActionEnum = typeof WorkflowStepsServiceCreateBodyEventActionEnum[keyof typeof WorkflowStepsServiceCreateBodyEventActionEnum];
|
|
119
139
|
/**
|
|
@@ -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.177.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -21,6 +21,7 @@ exports.WorkflowStepsServiceCreateBodyToJSON = WorkflowStepsServiceCreateBodyToJ
|
|
|
21
21
|
exports.WorkflowStepsServiceCreateBodyToJSONTyped = WorkflowStepsServiceCreateBodyToJSONTyped;
|
|
22
22
|
const AttributeCapture_1 = require("./AttributeCapture");
|
|
23
23
|
const WorkflowStepPayload_1 = require("./WorkflowStepPayload");
|
|
24
|
+
const BackButton_1 = require("./BackButton");
|
|
24
25
|
const CanvasPosition_1 = require("./CanvasPosition");
|
|
25
26
|
/**
|
|
26
27
|
* @export
|
|
@@ -47,7 +48,8 @@ exports.WorkflowStepsServiceCreateBodyEventActionEnum = {
|
|
|
47
48
|
EventActionDeviceActorCondition: 'EVENT_ACTION_DEVICE_ACTOR_CONDITION',
|
|
48
49
|
EventActionVisitorDataCondition: 'EVENT_ACTION_VISITOR_DATA_CONDITION',
|
|
49
50
|
EventActionThankYouPage: 'EVENT_ACTION_THANK_YOU_PAGE',
|
|
50
|
-
EventActionMessagePage: 'EVENT_ACTION_MESSAGE_PAGE'
|
|
51
|
+
EventActionMessagePage: 'EVENT_ACTION_MESSAGE_PAGE',
|
|
52
|
+
EventActionFile: 'EVENT_ACTION_FILE'
|
|
51
53
|
};
|
|
52
54
|
/**
|
|
53
55
|
* Check if a given object implements the WorkflowStepsServiceCreateBody interface.
|
|
@@ -64,6 +66,7 @@ function WorkflowStepsServiceCreateBodyFromJSONTyped(json, ignoreDiscriminator)
|
|
|
64
66
|
}
|
|
65
67
|
return {
|
|
66
68
|
'attributeCapture': json['attributeCapture'] == null ? undefined : (0, AttributeCapture_1.AttributeCaptureFromJSON)(json['attributeCapture']),
|
|
69
|
+
'backButton': json['backButton'] == null ? undefined : (0, BackButton_1.BackButtonFromJSON)(json['backButton']),
|
|
67
70
|
'canvasPosition': json['canvasPosition'] == null ? undefined : (0, CanvasPosition_1.CanvasPositionFromJSON)(json['canvasPosition']),
|
|
68
71
|
'eventAction': json['eventAction'] == null ? undefined : json['eventAction'],
|
|
69
72
|
'id': json['id'] == null ? undefined : json['id'],
|
|
@@ -80,6 +83,7 @@ function WorkflowStepsServiceCreateBodyToJSONTyped(value, ignoreDiscriminator =
|
|
|
80
83
|
}
|
|
81
84
|
return {
|
|
82
85
|
'attributeCapture': (0, AttributeCapture_1.AttributeCaptureToJSON)(value['attributeCapture']),
|
|
86
|
+
'backButton': (0, BackButton_1.BackButtonToJSON)(value['backButton']),
|
|
83
87
|
'canvasPosition': (0, CanvasPosition_1.CanvasPositionToJSON)(value['canvasPosition']),
|
|
84
88
|
'eventAction': value['eventAction'],
|
|
85
89
|
'id': value['id'],
|
|
@@ -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.177.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { AttributeCapture } from './AttributeCapture';
|
|
13
13
|
import type { WorkflowStepPayload } from './WorkflowStepPayload';
|
|
14
|
+
import type { BackButton } from './BackButton';
|
|
14
15
|
import type { CanvasPosition } from './CanvasPosition';
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
@@ -25,6 +26,16 @@ export interface WorkflowStepsServiceUpdateBody {
|
|
|
25
26
|
* @memberof WorkflowStepsServiceUpdateBody
|
|
26
27
|
*/
|
|
27
28
|
attributeCapture?: AttributeCapture;
|
|
29
|
+
/**
|
|
30
|
+
* Replaces the page's back button, which returns the visitor to the
|
|
31
|
+
* previous page (such as the menu) without wiring a connection. Leave it
|
|
32
|
+
* out to keep the current one. Page steps only: MESSAGE_PAGE, MULTI_LINK,
|
|
33
|
+
* CONTACT_CARD, SOCIAL_LINKS_PAGE, FORM_SUBMIT, PASSWORD_VERIFY and
|
|
34
|
+
* THANK_YOU_PAGE. Hidden right after a scan.
|
|
35
|
+
* @type {BackButton}
|
|
36
|
+
* @memberof WorkflowStepsServiceUpdateBody
|
|
37
|
+
*/
|
|
38
|
+
backButton?: BackButton;
|
|
28
39
|
/**
|
|
29
40
|
*
|
|
30
41
|
* @type {CanvasPosition}
|
|
@@ -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.177.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -20,6 +20,7 @@ exports.WorkflowStepsServiceUpdateBodyToJSON = WorkflowStepsServiceUpdateBodyToJ
|
|
|
20
20
|
exports.WorkflowStepsServiceUpdateBodyToJSONTyped = WorkflowStepsServiceUpdateBodyToJSONTyped;
|
|
21
21
|
const AttributeCapture_1 = require("./AttributeCapture");
|
|
22
22
|
const WorkflowStepPayload_1 = require("./WorkflowStepPayload");
|
|
23
|
+
const BackButton_1 = require("./BackButton");
|
|
23
24
|
const CanvasPosition_1 = require("./CanvasPosition");
|
|
24
25
|
/**
|
|
25
26
|
* Check if a given object implements the WorkflowStepsServiceUpdateBody interface.
|
|
@@ -36,6 +37,7 @@ function WorkflowStepsServiceUpdateBodyFromJSONTyped(json, ignoreDiscriminator)
|
|
|
36
37
|
}
|
|
37
38
|
return {
|
|
38
39
|
'attributeCapture': json['attributeCapture'] == null ? undefined : (0, AttributeCapture_1.AttributeCaptureFromJSON)(json['attributeCapture']),
|
|
40
|
+
'backButton': json['backButton'] == null ? undefined : (0, BackButton_1.BackButtonFromJSON)(json['backButton']),
|
|
39
41
|
'canvasPosition': json['canvasPosition'] == null ? undefined : (0, CanvasPosition_1.CanvasPositionFromJSON)(json['canvasPosition']),
|
|
40
42
|
'payload': json['payload'] == null ? undefined : (0, WorkflowStepPayload_1.WorkflowStepPayloadFromJSON)(json['payload']),
|
|
41
43
|
};
|
|
@@ -49,6 +51,7 @@ function WorkflowStepsServiceUpdateBodyToJSONTyped(value, ignoreDiscriminator =
|
|
|
49
51
|
}
|
|
50
52
|
return {
|
|
51
53
|
'attributeCapture': (0, AttributeCapture_1.AttributeCaptureToJSON)(value['attributeCapture']),
|
|
54
|
+
'backButton': (0, BackButton_1.BackButtonToJSON)(value['backButton']),
|
|
52
55
|
'canvasPosition': (0, CanvasPosition_1.CanvasPositionToJSON)(value['canvasPosition']),
|
|
53
56
|
'payload': (0, WorkflowStepPayload_1.WorkflowStepPayloadToJSON)(value['payload']),
|
|
54
57
|
};
|
|
@@ -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.177.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/models/Workspace.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.177.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.177.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -54,6 +54,12 @@ export interface WorkspaceAllowance {
|
|
|
54
54
|
* @memberof WorkspaceAllowance
|
|
55
55
|
*/
|
|
56
56
|
limit?: number;
|
|
57
|
+
/**
|
|
58
|
+
* Media storage only: the most media the workspace may hold, in bytes. Absent for other limits and when there is no ceiling.
|
|
59
|
+
* @type {number}
|
|
60
|
+
* @memberof WorkspaceAllowance
|
|
61
|
+
*/
|
|
62
|
+
limitBytes?: number;
|
|
57
63
|
/**
|
|
58
64
|
* Tracked visits only: visits recorded past the limit in the current cycle that the workspace's plan still locks. Absent for other limits.
|
|
59
65
|
* @type {number}
|
|
@@ -102,6 +108,12 @@ export interface WorkspaceAllowance {
|
|
|
102
108
|
* @memberof WorkspaceAllowance
|
|
103
109
|
*/
|
|
104
110
|
used?: number;
|
|
111
|
+
/**
|
|
112
|
+
* Media storage only: the bytes the workspace's media holds, exact. used is the same figure in megabytes, rounded up. Absent for other limits.
|
|
113
|
+
* @type {number}
|
|
114
|
+
* @memberof WorkspaceAllowance
|
|
115
|
+
*/
|
|
116
|
+
usedBytes?: number;
|
|
105
117
|
}
|
|
106
118
|
/**
|
|
107
119
|
* Check if a given object implements the WorkspaceAllowance interface.
|
|
@@ -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.177.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -41,6 +41,7 @@ function WorkspaceAllowanceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
41
41
|
'key': json['key'] == null ? undefined : (0, PlanLimitKey_1.PlanLimitKeyFromJSON)(json['key']),
|
|
42
42
|
'kind': json['kind'] == null ? undefined : (0, PlanLimitKind_1.PlanLimitKindFromJSON)(json['kind']),
|
|
43
43
|
'limit': json['limit'] == null ? undefined : json['limit'],
|
|
44
|
+
'limitBytes': json['limitBytes'] == null ? undefined : json['limitBytes'],
|
|
44
45
|
'lockedCount': json['lockedCount'] == null ? undefined : json['lockedCount'],
|
|
45
46
|
'lockedTotalCount': json['lockedTotalCount'] == null ? undefined : json['lockedTotalCount'],
|
|
46
47
|
'noticeDismissed': json['noticeDismissed'] == null ? undefined : json['noticeDismissed'],
|
|
@@ -49,6 +50,7 @@ function WorkspaceAllowanceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
50
|
'remaining': json['remaining'] == null ? undefined : json['remaining'],
|
|
50
51
|
'resetsOn': json['resetsOn'] == null ? undefined : (0, TypeDate_1.TypeDateFromJSON)(json['resetsOn']),
|
|
51
52
|
'used': json['used'] == null ? undefined : json['used'],
|
|
53
|
+
'usedBytes': json['usedBytes'] == null ? undefined : json['usedBytes'],
|
|
52
54
|
};
|
|
53
55
|
}
|
|
54
56
|
function WorkspaceAllowanceToJSON(json) {
|
|
@@ -65,6 +67,7 @@ function WorkspaceAllowanceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
65
67
|
'key': (0, PlanLimitKey_1.PlanLimitKeyToJSON)(value['key']),
|
|
66
68
|
'kind': (0, PlanLimitKind_1.PlanLimitKindToJSON)(value['kind']),
|
|
67
69
|
'limit': value['limit'],
|
|
70
|
+
'limitBytes': value['limitBytes'],
|
|
68
71
|
'lockedCount': value['lockedCount'],
|
|
69
72
|
'lockedTotalCount': value['lockedTotalCount'],
|
|
70
73
|
'noticeDismissed': value['noticeDismissed'],
|
|
@@ -73,5 +76,6 @@ function WorkspaceAllowanceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
73
76
|
'remaining': value['remaining'],
|
|
74
77
|
'resetsOn': (0, TypeDate_1.TypeDateToJSON)(value['resetsOn']),
|
|
75
78
|
'used': value['used'],
|
|
79
|
+
'usedBytes': value['usedBytes'],
|
|
76
80
|
};
|
|
77
81
|
}
|
|
@@ -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.177.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.177.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.177.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.177.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.177.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.177.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.177.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.177.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.177.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.177.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/models/index.d.ts
CHANGED
|
@@ -27,6 +27,7 @@ export * from './AttributeValueEntry';
|
|
|
27
27
|
export * from './AttributeWrite';
|
|
28
28
|
export * from './AttributeWriteMode';
|
|
29
29
|
export * from './AutoLayoutWorkflowResponse';
|
|
30
|
+
export * from './BackButton';
|
|
30
31
|
export * from './BackgroundOptions';
|
|
31
32
|
export * from './BillingInterval';
|
|
32
33
|
export * from './BreakdownDataPoint';
|
|
@@ -39,6 +40,7 @@ export * from './ClaimAgentWorkspaceRequest';
|
|
|
39
40
|
export * from './ClientRedirectPayload';
|
|
40
41
|
export * from './CompleteGoogleFormsOAuthRequest';
|
|
41
42
|
export * from './CompleteGoogleFormsOAuthResponse';
|
|
43
|
+
export * from './CompleteMediaUploadResponse';
|
|
42
44
|
export * from './CompleteSlackOAuthRequest';
|
|
43
45
|
export * from './CompleteSlackOAuthResponse';
|
|
44
46
|
export * from './ConnectWorkflowStepResponse';
|
|
@@ -64,10 +66,14 @@ export * from './CreateDashboardResponse';
|
|
|
64
66
|
export * from './CreateDirectoryRequest';
|
|
65
67
|
export * from './CreateDirectoryResponse';
|
|
66
68
|
export * from './CreateEventTraceResponse';
|
|
69
|
+
export * from './CreateFileLinkRequest';
|
|
70
|
+
export * from './CreateFileLinkResponse';
|
|
67
71
|
export * from './CreateLinkRequest';
|
|
68
72
|
export * from './CreateLinkResponse';
|
|
69
73
|
export * from './CreateMediaRequest';
|
|
70
74
|
export * from './CreateMediaResponse';
|
|
75
|
+
export * from './CreateMediaUploadRequest';
|
|
76
|
+
export * from './CreateMediaUploadResponse';
|
|
71
77
|
export * from './CreatePageThemeTemplateRequest';
|
|
72
78
|
export * from './CreatePageThemeTemplateResponse';
|
|
73
79
|
export * from './CreateQrcodeTemplateRequest';
|
|
@@ -155,6 +161,8 @@ export * from './EventsServiceCreateEventTraceBody';
|
|
|
155
161
|
export * from './EventsServiceUpdateDeviceBody';
|
|
156
162
|
export * from './EventsTimeSeries';
|
|
157
163
|
export * from './EventsTimeSeriesData';
|
|
164
|
+
export * from './FilePayload';
|
|
165
|
+
export * from './FileTraceData';
|
|
158
166
|
export * from './FindMatchingPageThemeTemplateResponse';
|
|
159
167
|
export * from './FontConfig';
|
|
160
168
|
export * from './FormField';
|
|
@@ -262,8 +270,11 @@ export * from './ListWebhooksResponse';
|
|
|
262
270
|
export * from './ListWorkflowStepsResponse';
|
|
263
271
|
export * from './ListWorkspaceTokensResponse';
|
|
264
272
|
export * from './Media';
|
|
273
|
+
export * from './MediaKind';
|
|
265
274
|
export * from './MediaSelection';
|
|
275
|
+
export * from './MediaStatus';
|
|
266
276
|
export * from './MediaType';
|
|
277
|
+
export * from './MediaUsage';
|
|
267
278
|
export * from './MediaVisibility';
|
|
268
279
|
export * from './Member';
|
|
269
280
|
export * from './MembersServiceSwitchWorkspaceBody';
|
package/dist/models/index.js
CHANGED
|
@@ -45,6 +45,7 @@ __exportStar(require("./AttributeValueEntry"), exports);
|
|
|
45
45
|
__exportStar(require("./AttributeWrite"), exports);
|
|
46
46
|
__exportStar(require("./AttributeWriteMode"), exports);
|
|
47
47
|
__exportStar(require("./AutoLayoutWorkflowResponse"), exports);
|
|
48
|
+
__exportStar(require("./BackButton"), exports);
|
|
48
49
|
__exportStar(require("./BackgroundOptions"), exports);
|
|
49
50
|
__exportStar(require("./BillingInterval"), exports);
|
|
50
51
|
__exportStar(require("./BreakdownDataPoint"), exports);
|
|
@@ -57,6 +58,7 @@ __exportStar(require("./ClaimAgentWorkspaceRequest"), exports);
|
|
|
57
58
|
__exportStar(require("./ClientRedirectPayload"), exports);
|
|
58
59
|
__exportStar(require("./CompleteGoogleFormsOAuthRequest"), exports);
|
|
59
60
|
__exportStar(require("./CompleteGoogleFormsOAuthResponse"), exports);
|
|
61
|
+
__exportStar(require("./CompleteMediaUploadResponse"), exports);
|
|
60
62
|
__exportStar(require("./CompleteSlackOAuthRequest"), exports);
|
|
61
63
|
__exportStar(require("./CompleteSlackOAuthResponse"), exports);
|
|
62
64
|
__exportStar(require("./ConnectWorkflowStepResponse"), exports);
|
|
@@ -82,10 +84,14 @@ __exportStar(require("./CreateDashboardResponse"), exports);
|
|
|
82
84
|
__exportStar(require("./CreateDirectoryRequest"), exports);
|
|
83
85
|
__exportStar(require("./CreateDirectoryResponse"), exports);
|
|
84
86
|
__exportStar(require("./CreateEventTraceResponse"), exports);
|
|
87
|
+
__exportStar(require("./CreateFileLinkRequest"), exports);
|
|
88
|
+
__exportStar(require("./CreateFileLinkResponse"), exports);
|
|
85
89
|
__exportStar(require("./CreateLinkRequest"), exports);
|
|
86
90
|
__exportStar(require("./CreateLinkResponse"), exports);
|
|
87
91
|
__exportStar(require("./CreateMediaRequest"), exports);
|
|
88
92
|
__exportStar(require("./CreateMediaResponse"), exports);
|
|
93
|
+
__exportStar(require("./CreateMediaUploadRequest"), exports);
|
|
94
|
+
__exportStar(require("./CreateMediaUploadResponse"), exports);
|
|
89
95
|
__exportStar(require("./CreatePageThemeTemplateRequest"), exports);
|
|
90
96
|
__exportStar(require("./CreatePageThemeTemplateResponse"), exports);
|
|
91
97
|
__exportStar(require("./CreateQrcodeTemplateRequest"), exports);
|
|
@@ -173,6 +179,8 @@ __exportStar(require("./EventsServiceCreateEventTraceBody"), exports);
|
|
|
173
179
|
__exportStar(require("./EventsServiceUpdateDeviceBody"), exports);
|
|
174
180
|
__exportStar(require("./EventsTimeSeries"), exports);
|
|
175
181
|
__exportStar(require("./EventsTimeSeriesData"), exports);
|
|
182
|
+
__exportStar(require("./FilePayload"), exports);
|
|
183
|
+
__exportStar(require("./FileTraceData"), exports);
|
|
176
184
|
__exportStar(require("./FindMatchingPageThemeTemplateResponse"), exports);
|
|
177
185
|
__exportStar(require("./FontConfig"), exports);
|
|
178
186
|
__exportStar(require("./FormField"), exports);
|
|
@@ -280,8 +288,11 @@ __exportStar(require("./ListWebhooksResponse"), exports);
|
|
|
280
288
|
__exportStar(require("./ListWorkflowStepsResponse"), exports);
|
|
281
289
|
__exportStar(require("./ListWorkspaceTokensResponse"), exports);
|
|
282
290
|
__exportStar(require("./Media"), exports);
|
|
291
|
+
__exportStar(require("./MediaKind"), exports);
|
|
283
292
|
__exportStar(require("./MediaSelection"), exports);
|
|
293
|
+
__exportStar(require("./MediaStatus"), exports);
|
|
284
294
|
__exportStar(require("./MediaType"), exports);
|
|
295
|
+
__exportStar(require("./MediaUsage"), exports);
|
|
285
296
|
__exportStar(require("./MediaVisibility"), exports);
|
|
286
297
|
__exportStar(require("./Member"), exports);
|
|
287
298
|
__exportStar(require("./MembersServiceSwitchWorkspaceBody"), exports);
|