linkbreakers 1.149.2 → 1.157.1
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 +2 -2
- package/dist/apis/APIScopesApi.js +2 -2
- package/dist/apis/AgentIdentityApi.d.ts +108 -0
- package/dist/apis/AgentIdentityApi.js +135 -0
- package/dist/apis/AllowancesApi.d.ts +5 -2
- package/dist/apis/AllowancesApi.js +5 -2
- package/dist/apis/AnalyticsDashboardApi.d.ts +14 -2
- package/dist/apis/AnalyticsDashboardApi.js +14 -2
- package/dist/apis/AnalyticsDataApi.d.ts +35 -2
- package/dist/apis/AnalyticsDataApi.js +35 -2
- package/dist/apis/AssistantApi.d.ts +8 -2
- package/dist/apis/AssistantApi.js +8 -2
- package/dist/apis/CustomDomainsApi.d.ts +14 -2
- package/dist/apis/CustomDomainsApi.js +14 -2
- package/dist/apis/DirectoriesApi.d.ts +11 -2
- package/dist/apis/DirectoriesApi.js +11 -2
- package/dist/apis/EventsApi.d.ts +5 -2
- package/dist/apis/EventsApi.js +5 -2
- package/dist/apis/GoogleFormsIntegrationsApi.d.ts +11 -2
- package/dist/apis/GoogleFormsIntegrationsApi.js +11 -2
- package/dist/apis/IntegrationsServiceApi.d.ts +5 -2
- package/dist/apis/IntegrationsServiceApi.js +5 -2
- package/dist/apis/JobsApi.d.ts +64 -0
- package/dist/apis/JobsApi.js +103 -0
- package/dist/apis/LinkSettingsApi.d.ts +5 -2
- package/dist/apis/LinkSettingsApi.js +5 -2
- package/dist/apis/LinksApi.d.ts +106 -3
- package/dist/apis/LinksApi.js +123 -2
- package/dist/apis/MediaApi.d.ts +8 -2
- package/dist/apis/MediaApi.js +8 -2
- package/dist/apis/MembersApi.d.ts +23 -2
- package/dist/apis/MembersApi.js +23 -2
- package/dist/apis/PageThemeTemplatesApi.d.ts +26 -2
- package/dist/apis/PageThemeTemplatesApi.js +26 -2
- package/dist/apis/PageThemesApi.d.ts +11 -2
- package/dist/apis/PageThemesApi.js +11 -2
- package/dist/apis/PricingApi.d.ts +2 -2
- package/dist/apis/PricingApi.js +2 -2
- package/dist/apis/QRCodeDesignsApi.d.ts +11 -2
- package/dist/apis/QRCodeDesignsApi.js +11 -2
- package/dist/apis/QRCodeTemplatesApi.d.ts +23 -2
- package/dist/apis/QRCodeTemplatesApi.js +23 -2
- package/dist/apis/SandboxesApi.d.ts +138 -0
- package/dist/apis/SandboxesApi.js +195 -0
- package/dist/apis/SlackIntegrationsApi.d.ts +11 -2
- package/dist/apis/SlackIntegrationsApi.js +11 -2
- package/dist/apis/TagsApi.d.ts +5 -2
- package/dist/apis/TagsApi.js +5 -2
- package/dist/apis/TimeSeriesApi.d.ts +5 -2
- package/dist/apis/TimeSeriesApi.js +5 -2
- package/dist/apis/VisitorsApi.d.ts +14 -2
- package/dist/apis/VisitorsApi.js +14 -2
- package/dist/apis/WebhooksApi.d.ts +11 -2
- package/dist/apis/WebhooksApi.js +11 -2
- package/dist/apis/WorkflowStepsApi.d.ts +20 -2
- package/dist/apis/WorkflowStepsApi.js +20 -2
- package/dist/apis/WorkspaceMetricsApi.d.ts +2 -2
- package/dist/apis/WorkspaceMetricsApi.js +2 -2
- package/dist/apis/WorkspaceTokensApi.d.ts +11 -2
- package/dist/apis/WorkspaceTokensApi.js +11 -2
- package/dist/apis/WorkspacesApi.d.ts +14 -2
- package/dist/apis/WorkspacesApi.js +14 -2
- package/dist/apis/index.d.ts +3 -0
- package/dist/apis/index.js +3 -0
- package/dist/models/Action.d.ts +2 -2
- package/dist/models/Action.js +2 -2
- package/dist/models/AgentClaim.d.ts +58 -0
- package/dist/models/AgentClaim.js +58 -0
- package/dist/models/AgentClaimStatus.d.ts +31 -0
- package/dist/models/AgentClaimStatus.js +57 -0
- package/dist/models/AnalyticsDashboard.d.ts +2 -2
- package/dist/models/AnalyticsDashboard.js +2 -2
- package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.d.ts +2 -2
- package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.js +2 -2
- package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.d.ts +2 -2
- package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.js +2 -2
- package/dist/models/AnalyticsWidgetResult.d.ts +2 -2
- package/dist/models/AnalyticsWidgetResult.js +2 -2
- package/dist/models/ApiScope.d.ts +2 -2
- package/dist/models/ApiScope.js +2 -2
- package/dist/models/ApiScopeAccess.d.ts +2 -2
- package/dist/models/ApiScopeAccess.js +2 -2
- package/dist/models/ApiScopeInfo.d.ts +74 -6
- package/dist/models/ApiScopeInfo.js +40 -5
- package/dist/models/ApiTag.d.ts +2 -2
- package/dist/models/ApiTag.js +2 -2
- package/dist/models/ApplyPageThemeTemplateRequest.d.ts +2 -2
- package/dist/models/ApplyPageThemeTemplateRequest.js +2 -2
- package/dist/models/ApplyPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/ApplyPageThemeTemplateResponse.js +2 -2
- package/dist/models/ApplyQrcodeTemplateRequest.d.ts +2 -2
- package/dist/models/ApplyQrcodeTemplateRequest.js +2 -2
- package/dist/models/ApplyQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/ApplyQrcodeTemplateResponse.js +2 -2
- package/dist/models/AssistantContextType.d.ts +2 -2
- package/dist/models/AssistantContextType.js +2 -2
- package/dist/models/AssistantDisplayMessage.d.ts +2 -2
- package/dist/models/AssistantDisplayMessage.js +2 -2
- package/dist/models/AssistantDisplayMessageAttachment.d.ts +2 -2
- package/dist/models/AssistantDisplayMessageAttachment.js +2 -2
- package/dist/models/AssistantGetConversationResponse.d.ts +2 -2
- package/dist/models/AssistantGetConversationResponse.js +2 -2
- package/dist/models/AssistantMarkConversationReadRequest.d.ts +2 -2
- package/dist/models/AssistantMarkConversationReadRequest.js +2 -2
- package/dist/models/AssistantMarkConversationReadResponse.d.ts +2 -2
- package/dist/models/AssistantMarkConversationReadResponse.js +2 -2
- package/dist/models/AssistantUploadFileRequest.d.ts +2 -2
- package/dist/models/AssistantUploadFileRequest.js +2 -2
- package/dist/models/AssistantUploadFileResponse.d.ts +2 -2
- package/dist/models/AssistantUploadFileResponse.js +2 -2
- package/dist/models/AttributeCapture.d.ts +2 -2
- package/dist/models/AttributeCapture.js +2 -2
- package/dist/models/AttributeValueDataPoint.d.ts +2 -2
- package/dist/models/AttributeValueDataPoint.js +2 -2
- package/dist/models/AttributeValueEntry.d.ts +2 -2
- package/dist/models/AttributeValueEntry.js +2 -2
- package/dist/models/AttributeWrite.d.ts +2 -2
- package/dist/models/AttributeWrite.js +2 -2
- package/dist/models/AttributeWriteMode.d.ts +2 -2
- package/dist/models/AttributeWriteMode.js +2 -2
- package/dist/models/AutoLayoutWorkflowResponse.d.ts +2 -2
- package/dist/models/AutoLayoutWorkflowResponse.js +2 -2
- package/dist/models/BackgroundOptions.d.ts +2 -2
- package/dist/models/BackgroundOptions.js +2 -2
- package/dist/models/BillingInterval.d.ts +2 -2
- package/dist/models/BillingInterval.js +2 -2
- package/dist/models/BreakdownDataPoint.d.ts +2 -2
- package/dist/models/BreakdownDataPoint.js +2 -2
- package/dist/models/CanvasPosition.d.ts +2 -2
- package/dist/models/CanvasPosition.js +2 -2
- package/dist/models/ChatDisplayMessage.d.ts +2 -2
- package/dist/models/ChatDisplayMessage.js +2 -2
- package/dist/models/ChatUIAction.d.ts +2 -2
- package/dist/models/ChatUIAction.js +2 -2
- package/dist/models/ChatUIOption.d.ts +2 -2
- package/dist/models/ChatUIOption.js +2 -2
- package/dist/models/CheckCustomDomainResponse.d.ts +2 -2
- package/dist/models/CheckCustomDomainResponse.js +2 -2
- package/dist/models/ClaimAgentWorkspaceRequest.d.ts +50 -0
- package/dist/models/ClaimAgentWorkspaceRequest.js +54 -0
- package/dist/models/ClientRedirectPayload.d.ts +2 -2
- package/dist/models/ClientRedirectPayload.js +2 -2
- package/dist/models/CompleteGoogleFormsOAuthRequest.d.ts +2 -2
- package/dist/models/CompleteGoogleFormsOAuthRequest.js +2 -2
- package/dist/models/CompleteGoogleFormsOAuthResponse.d.ts +2 -2
- package/dist/models/CompleteGoogleFormsOAuthResponse.js +2 -2
- package/dist/models/CompleteSlackOAuthRequest.d.ts +2 -2
- package/dist/models/CompleteSlackOAuthRequest.js +2 -2
- package/dist/models/CompleteSlackOAuthResponse.d.ts +2 -2
- package/dist/models/CompleteSlackOAuthResponse.js +2 -2
- package/dist/models/ConnectWorkflowStepResponse.d.ts +2 -2
- package/dist/models/ConnectWorkflowStepResponse.js +2 -2
- package/dist/models/ContactCardTraceCard.d.ts +2 -2
- package/dist/models/ContactCardTraceCard.js +2 -2
- package/dist/models/ContactCardTraceData.d.ts +2 -2
- package/dist/models/ContactCardTraceData.js +2 -2
- package/dist/models/ContainerConfig.d.ts +2 -2
- package/dist/models/ContainerConfig.js +2 -2
- package/dist/models/CornersDotOptions.d.ts +2 -2
- package/dist/models/CornersDotOptions.js +2 -2
- package/dist/models/CornersDotType.d.ts +2 -2
- package/dist/models/CornersDotType.js +2 -2
- package/dist/models/CornersSquareOptions.d.ts +2 -2
- package/dist/models/CornersSquareOptions.js +2 -2
- package/dist/models/CornersSquareType.d.ts +2 -2
- package/dist/models/CornersSquareType.js +2 -2
- package/dist/models/CountryConditionOutcome.d.ts +2 -2
- package/dist/models/CountryConditionOutcome.js +2 -2
- package/dist/models/CountryConditionPayload.d.ts +2 -2
- package/dist/models/CountryConditionPayload.js +2 -2
- package/dist/models/CountryConditionTraceData.d.ts +2 -2
- package/dist/models/CountryConditionTraceData.js +2 -2
- package/dist/models/CountryConditionTraceOption.d.ts +2 -2
- package/dist/models/CountryConditionTraceOption.js +2 -2
- package/dist/models/CreateBulkLinksRequest.d.ts +2 -2
- package/dist/models/CreateBulkLinksRequest.js +2 -2
- package/dist/models/CreateBulkLinksResponse.d.ts +2 -2
- package/dist/models/CreateBulkLinksResponse.js +2 -2
- package/dist/models/CreateContactLinkRequest.d.ts +2 -2
- package/dist/models/CreateContactLinkRequest.js +2 -2
- package/dist/models/CreateContactLinkResponse.d.ts +2 -2
- package/dist/models/CreateContactLinkResponse.js +2 -2
- package/dist/models/CreateCustomDomainRequest.d.ts +2 -2
- package/dist/models/CreateCustomDomainRequest.js +2 -2
- package/dist/models/CreateCustomDomainResponse.d.ts +2 -2
- package/dist/models/CreateCustomDomainResponse.js +2 -2
- package/dist/models/CreateDashboardRequest.d.ts +2 -2
- package/dist/models/CreateDashboardRequest.js +2 -2
- package/dist/models/CreateDashboardResponse.d.ts +2 -2
- package/dist/models/CreateDashboardResponse.js +2 -2
- package/dist/models/CreateDirectoryRequest.d.ts +2 -2
- package/dist/models/CreateDirectoryRequest.js +2 -2
- package/dist/models/CreateDirectoryResponse.d.ts +2 -2
- package/dist/models/CreateDirectoryResponse.js +2 -2
- package/dist/models/CreateEventTraceResponse.d.ts +2 -2
- package/dist/models/CreateEventTraceResponse.js +2 -2
- package/dist/models/CreateLinkRequest.d.ts +2 -2
- package/dist/models/CreateLinkRequest.js +2 -2
- package/dist/models/CreateLinkResponse.d.ts +2 -2
- package/dist/models/CreateLinkResponse.js +2 -2
- package/dist/models/CreateMediaRequest.d.ts +2 -2
- package/dist/models/CreateMediaRequest.js +2 -2
- package/dist/models/CreateMediaResponse.d.ts +2 -2
- package/dist/models/CreateMediaResponse.js +2 -2
- package/dist/models/CreatePageThemeTemplateRequest.d.ts +2 -2
- package/dist/models/CreatePageThemeTemplateRequest.js +2 -2
- package/dist/models/CreatePageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/CreatePageThemeTemplateResponse.js +2 -2
- package/dist/models/CreateQrcodeTemplateRequest.d.ts +2 -2
- package/dist/models/CreateQrcodeTemplateRequest.js +2 -2
- package/dist/models/CreateQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/CreateQrcodeTemplateResponse.js +2 -2
- package/dist/models/CreateSandboxRequest.d.ts +32 -0
- package/dist/models/CreateSandboxRequest.js +48 -0
- package/dist/models/CreateSandboxResponse.d.ts +47 -0
- package/dist/models/CreateSandboxResponse.js +54 -0
- package/dist/models/CreateThankYouLinkRequest.d.ts +2 -2
- package/dist/models/CreateThankYouLinkRequest.js +2 -2
- package/dist/models/CreateThankYouLinkResponse.d.ts +2 -2
- package/dist/models/CreateThankYouLinkResponse.js +2 -2
- package/dist/models/CreateWebhookRequest.d.ts +2 -2
- package/dist/models/CreateWebhookRequest.js +2 -2
- package/dist/models/CreateWebhookResponse.d.ts +2 -2
- package/dist/models/CreateWebhookResponse.js +2 -2
- package/dist/models/CreateWorkflowStepResponse.d.ts +2 -2
- package/dist/models/CreateWorkflowStepResponse.js +2 -2
- package/dist/models/CreateWorkspaceTokenRequest.d.ts +54 -9
- package/dist/models/CreateWorkspaceTokenRequest.js +50 -8
- package/dist/models/CreateWorkspaceTokenResponse.d.ts +2 -2
- package/dist/models/CreateWorkspaceTokenResponse.js +2 -2
- package/dist/models/CreditTopup.d.ts +2 -2
- package/dist/models/CreditTopup.js +2 -2
- package/dist/models/CustomDomain.d.ts +2 -2
- package/dist/models/CustomDomain.js +2 -2
- package/dist/models/CustomDomainDnsRecord.d.ts +2 -2
- package/dist/models/CustomDomainDnsRecord.js +2 -2
- package/dist/models/CustomDomainOneClickSetup.d.ts +2 -2
- package/dist/models/CustomDomainOneClickSetup.js +2 -2
- package/dist/models/CustomDomainSetupGuide.d.ts +2 -2
- package/dist/models/CustomDomainSetupGuide.js +2 -2
- package/dist/models/CustomDomainSetupHint.d.ts +2 -2
- package/dist/models/CustomDomainSetupHint.js +2 -2
- package/dist/models/CustomDomainStatus.d.ts +2 -2
- package/dist/models/CustomDomainStatus.js +2 -2
- package/dist/models/CustomDomainsServiceUpdateBody.d.ts +2 -2
- package/dist/models/CustomDomainsServiceUpdateBody.js +2 -2
- package/dist/models/DashboardConfig.d.ts +2 -2
- package/dist/models/DashboardConfig.js +2 -2
- package/dist/models/DashboardScope.d.ts +2 -2
- package/dist/models/DashboardScope.js +2 -2
- package/dist/models/DashboardWidget.d.ts +2 -2
- package/dist/models/DashboardWidget.js +2 -2
- package/dist/models/DataCollection.d.ts +2 -2
- package/dist/models/DataCollection.js +2 -2
- package/dist/models/DayOfMonthConditionPayload.d.ts +2 -2
- package/dist/models/DayOfMonthConditionPayload.js +2 -2
- package/dist/models/DayOfMonthConditionTraceData.d.ts +2 -2
- package/dist/models/DayOfMonthConditionTraceData.js +2 -2
- package/dist/models/DayOfMonthConditionTraceOption.d.ts +2 -2
- package/dist/models/DayOfMonthConditionTraceOption.js +2 -2
- package/dist/models/DayOfMonthOption.d.ts +2 -2
- package/dist/models/DayOfMonthOption.js +2 -2
- package/dist/models/DayOfWeekConditionPayload.d.ts +2 -2
- package/dist/models/DayOfWeekConditionPayload.js +2 -2
- package/dist/models/DayOfWeekConditionTraceData.d.ts +2 -2
- package/dist/models/DayOfWeekConditionTraceData.js +2 -2
- package/dist/models/DayOfWeekConditionTraceOption.d.ts +2 -2
- package/dist/models/DayOfWeekConditionTraceOption.js +2 -2
- package/dist/models/DayOfWeekOption.d.ts +2 -2
- package/dist/models/DayOfWeekOption.js +2 -2
- package/dist/models/DeleteAttributeResponse.d.ts +2 -2
- package/dist/models/DeleteAttributeResponse.js +2 -2
- package/dist/models/DeleteVisitorResponse.d.ts +2 -2
- package/dist/models/DeleteVisitorResponse.js +2 -2
- package/dist/models/DetectedGoogleForm.d.ts +2 -2
- package/dist/models/DetectedGoogleForm.js +2 -2
- package/dist/models/Device.d.ts +2 -2
- package/dist/models/Device.js +2 -2
- package/dist/models/DeviceActor.d.ts +2 -2
- package/dist/models/DeviceActor.js +2 -2
- package/dist/models/DeviceActorConditionOption.d.ts +2 -2
- package/dist/models/DeviceActorConditionOption.js +2 -2
- package/dist/models/DeviceActorConditionPayload.d.ts +2 -2
- package/dist/models/DeviceActorConditionPayload.js +2 -2
- package/dist/models/DeviceActorConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceActorConditionTraceData.js +2 -2
- package/dist/models/DeviceActorConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceActorConditionTraceOption.js +2 -2
- package/dist/models/DeviceActorConditionValue.d.ts +2 -2
- package/dist/models/DeviceActorConditionValue.js +2 -2
- package/dist/models/DeviceBrandConditionOption.d.ts +2 -2
- package/dist/models/DeviceBrandConditionOption.js +2 -2
- package/dist/models/DeviceBrandConditionPayload.d.ts +2 -2
- package/dist/models/DeviceBrandConditionPayload.js +2 -2
- package/dist/models/DeviceBrandConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceBrandConditionTraceData.js +2 -2
- package/dist/models/DeviceBrandConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceBrandConditionTraceOption.js +2 -2
- package/dist/models/DeviceBrandConditionValue.d.ts +2 -2
- package/dist/models/DeviceBrandConditionValue.js +2 -2
- package/dist/models/DeviceBrowserConditionOption.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionOption.js +2 -2
- package/dist/models/DeviceBrowserConditionPayload.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionPayload.js +2 -2
- package/dist/models/DeviceBrowserConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionTraceData.js +2 -2
- package/dist/models/DeviceBrowserConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionTraceOption.js +2 -2
- package/dist/models/DeviceBrowserConditionValue.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionValue.js +2 -2
- package/dist/models/DeviceDataPoint.d.ts +2 -2
- package/dist/models/DeviceDataPoint.js +2 -2
- package/dist/models/DeviceInput.d.ts +2 -2
- package/dist/models/DeviceInput.js +2 -2
- package/dist/models/DevicePlatformConditionOption.d.ts +2 -2
- package/dist/models/DevicePlatformConditionOption.js +2 -2
- package/dist/models/DevicePlatformConditionPayload.d.ts +2 -2
- package/dist/models/DevicePlatformConditionPayload.js +2 -2
- package/dist/models/DevicePlatformConditionTraceData.d.ts +2 -2
- package/dist/models/DevicePlatformConditionTraceData.js +2 -2
- package/dist/models/DevicePlatformConditionTraceOption.d.ts +2 -2
- package/dist/models/DevicePlatformConditionTraceOption.js +2 -2
- package/dist/models/DevicePlatformConditionValue.d.ts +2 -2
- package/dist/models/DevicePlatformConditionValue.js +2 -2
- package/dist/models/DeviceType.d.ts +2 -2
- package/dist/models/DeviceType.js +2 -2
- package/dist/models/DeviceTypeConditionOption.d.ts +2 -2
- package/dist/models/DeviceTypeConditionOption.js +2 -2
- package/dist/models/DeviceTypeConditionPayload.d.ts +2 -2
- package/dist/models/DeviceTypeConditionPayload.js +2 -2
- package/dist/models/DeviceTypeConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceTypeConditionTraceData.js +2 -2
- package/dist/models/DeviceTypeConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceTypeConditionTraceOption.js +2 -2
- package/dist/models/DeviceTypeConditionValue.d.ts +2 -2
- package/dist/models/DeviceTypeConditionValue.js +2 -2
- package/dist/models/DigestFrequency.d.ts +2 -2
- package/dist/models/DigestFrequency.js +2 -2
- package/dist/models/DirectoriesServiceUpdateBody.d.ts +2 -2
- package/dist/models/DirectoriesServiceUpdateBody.js +2 -2
- package/dist/models/Directory.d.ts +2 -2
- package/dist/models/Directory.js +2 -2
- package/dist/models/DisconnectWorkflowStepResponse.d.ts +2 -2
- package/dist/models/DisconnectWorkflowStepResponse.js +2 -2
- package/dist/models/DismissAllowanceNoticeRequest.d.ts +2 -2
- package/dist/models/DismissAllowanceNoticeRequest.js +2 -2
- package/dist/models/DnsProvider.d.ts +2 -2
- package/dist/models/DnsProvider.js +2 -2
- package/dist/models/DnsRecordPurpose.d.ts +2 -2
- package/dist/models/DnsRecordPurpose.js +2 -2
- package/dist/models/DnsRecordType.d.ts +2 -2
- package/dist/models/DnsRecordType.js +2 -2
- package/dist/models/DotsOptions.d.ts +2 -2
- package/dist/models/DotsOptions.js +2 -2
- package/dist/models/DotsType.d.ts +2 -2
- package/dist/models/DotsType.js +2 -2
- package/dist/models/EntryAccessTraceData.d.ts +2 -2
- package/dist/models/EntryAccessTraceData.js +2 -2
- package/dist/models/ErrorResponse.d.ts +2 -2
- package/dist/models/ErrorResponse.js +2 -2
- package/dist/models/Event.d.ts +2 -2
- package/dist/models/Event.js +2 -2
- package/dist/models/EventAction.d.ts +2 -2
- package/dist/models/EventAction.js +2 -2
- package/dist/models/EventTrace.d.ts +2 -2
- package/dist/models/EventTrace.js +2 -2
- package/dist/models/EventTraceData.d.ts +2 -2
- package/dist/models/EventTraceData.js +2 -2
- package/dist/models/EventsMetric.d.ts +2 -2
- package/dist/models/EventsMetric.js +2 -2
- package/dist/models/EventsServiceCreateEventTraceBody.d.ts +2 -2
- package/dist/models/EventsServiceCreateEventTraceBody.js +2 -2
- package/dist/models/EventsServiceUpdateDeviceBody.d.ts +2 -2
- package/dist/models/EventsServiceUpdateDeviceBody.js +2 -2
- package/dist/models/EventsTimeSeries.d.ts +2 -2
- package/dist/models/EventsTimeSeries.js +2 -2
- package/dist/models/EventsTimeSeriesData.d.ts +2 -2
- package/dist/models/EventsTimeSeriesData.js +2 -2
- package/dist/models/FindMatchingPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/FindMatchingPageThemeTemplateResponse.js +2 -2
- package/dist/models/FontConfig.d.ts +2 -2
- package/dist/models/FontConfig.js +2 -2
- package/dist/models/FormField.d.ts +2 -2
- package/dist/models/FormField.js +2 -2
- package/dist/models/FormFieldOption.d.ts +2 -2
- package/dist/models/FormFieldOption.js +2 -2
- package/dist/models/FormFieldType.d.ts +2 -2
- package/dist/models/FormFieldType.js +2 -2
- package/dist/models/FormPayload.d.ts +2 -2
- package/dist/models/FormPayload.js +2 -2
- package/dist/models/FormTraceData.d.ts +2 -2
- package/dist/models/FormTraceData.js +2 -2
- package/dist/models/FormTraceDataField.d.ts +2 -2
- package/dist/models/FormTraceDataField.js +2 -2
- package/dist/models/FunnelBranch.d.ts +2 -2
- package/dist/models/FunnelBranch.js +2 -2
- package/dist/models/FunnelStep.d.ts +2 -2
- package/dist/models/FunnelStep.js +2 -2
- package/dist/models/GenerateWidgetSummaryResponse.d.ts +2 -2
- package/dist/models/GenerateWidgetSummaryResponse.js +2 -2
- package/dist/models/GeoDataPoint.d.ts +2 -2
- package/dist/models/GeoDataPoint.js +2 -2
- package/dist/models/GetAgentClaimRequest.d.ts +32 -0
- package/dist/models/GetAgentClaimRequest.js +48 -0
- package/dist/models/GetAttributeDistributionRequest.d.ts +2 -2
- package/dist/models/GetAttributeDistributionRequest.js +2 -2
- package/dist/models/GetAttributeDistributionResponse.d.ts +2 -2
- package/dist/models/GetAttributeDistributionResponse.js +2 -2
- package/dist/models/GetAttributeMetricRequest.d.ts +2 -2
- package/dist/models/GetAttributeMetricRequest.js +2 -2
- package/dist/models/GetAttributeMetricResponse.d.ts +2 -2
- package/dist/models/GetAttributeMetricResponse.js +2 -2
- package/dist/models/GetAttributeValuesRequest.d.ts +2 -2
- package/dist/models/GetAttributeValuesRequest.js +2 -2
- package/dist/models/GetAttributeValuesResponse.d.ts +2 -2
- package/dist/models/GetAttributeValuesResponse.js +2 -2
- package/dist/models/GetBreakdownRequest.d.ts +2 -2
- package/dist/models/GetBreakdownRequest.js +2 -2
- package/dist/models/GetBreakdownResponse.d.ts +2 -2
- package/dist/models/GetBreakdownResponse.js +2 -2
- package/dist/models/GetCustomDomainResponse.d.ts +2 -2
- package/dist/models/GetCustomDomainResponse.js +2 -2
- package/dist/models/GetCustomDomainSetupGuideResponse.d.ts +2 -2
- package/dist/models/GetCustomDomainSetupGuideResponse.js +2 -2
- package/dist/models/GetDeviceDistributionRequest.d.ts +2 -2
- package/dist/models/GetDeviceDistributionRequest.js +2 -2
- package/dist/models/GetDeviceDistributionResponse.d.ts +2 -2
- package/dist/models/GetDeviceDistributionResponse.js +2 -2
- package/dist/models/GetDirectoryResponse.d.ts +2 -2
- package/dist/models/GetDirectoryResponse.js +2 -2
- package/dist/models/GetEventsTimeSeriesRequest.d.ts +2 -2
- package/dist/models/GetEventsTimeSeriesRequest.js +2 -2
- package/dist/models/GetEventsTimeSeriesResponse.d.ts +2 -2
- package/dist/models/GetEventsTimeSeriesResponse.js +2 -2
- package/dist/models/GetGeoBreakdownRequest.d.ts +2 -2
- package/dist/models/GetGeoBreakdownRequest.js +2 -2
- package/dist/models/GetGeoBreakdownResponse.d.ts +2 -2
- package/dist/models/GetGeoBreakdownResponse.js +2 -2
- package/dist/models/GetGoogleFormsIntegrationResponse.d.ts +2 -2
- package/dist/models/GetGoogleFormsIntegrationResponse.js +2 -2
- package/dist/models/GetGoogleFormsOAuthURLResponse.d.ts +2 -2
- package/dist/models/GetGoogleFormsOAuthURLResponse.js +2 -2
- package/dist/models/GetGroupedTimeSeriesRequest.d.ts +2 -2
- package/dist/models/GetGroupedTimeSeriesRequest.js +2 -2
- package/dist/models/GetGroupedTimeSeriesResponse.d.ts +2 -2
- package/dist/models/GetGroupedTimeSeriesResponse.js +2 -2
- package/dist/models/GetHourOfDayDistributionRequest.d.ts +2 -2
- package/dist/models/GetHourOfDayDistributionRequest.js +2 -2
- package/dist/models/GetHourOfDayDistributionResponse.d.ts +2 -2
- package/dist/models/GetHourOfDayDistributionResponse.js +2 -2
- package/dist/models/GetLinkResponse.d.ts +2 -2
- package/dist/models/GetLinkResponse.js +2 -2
- package/dist/models/GetLinkSettingResponse.d.ts +2 -2
- package/dist/models/GetLinkSettingResponse.js +2 -2
- package/dist/models/GetMediaResponse.d.ts +2 -2
- package/dist/models/GetMediaResponse.js +2 -2
- package/dist/models/GetPageThemeResponse.d.ts +2 -2
- package/dist/models/GetPageThemeResponse.js +2 -2
- package/dist/models/GetQrcodeDesignResponse.d.ts +2 -2
- package/dist/models/GetQrcodeDesignResponse.js +2 -2
- package/dist/models/GetSlackIntegrationResponse.d.ts +2 -2
- package/dist/models/GetSlackIntegrationResponse.js +2 -2
- package/dist/models/GetSlackOAuthURLResponse.d.ts +2 -2
- package/dist/models/GetSlackOAuthURLResponse.js +2 -2
- package/dist/models/GetStepFunnelRequest.d.ts +2 -2
- package/dist/models/GetStepFunnelRequest.js +2 -2
- package/dist/models/GetStepFunnelResponse.d.ts +2 -2
- package/dist/models/GetStepFunnelResponse.js +2 -2
- package/dist/models/GetTopLinksRequest.d.ts +2 -2
- package/dist/models/GetTopLinksRequest.js +2 -2
- package/dist/models/GetTopLinksResponse.d.ts +2 -2
- package/dist/models/GetTopLinksResponse.js +2 -2
- package/dist/models/GetVisitorTrendsRequest.d.ts +2 -2
- package/dist/models/GetVisitorTrendsRequest.js +2 -2
- package/dist/models/GetVisitorTrendsResponse.d.ts +2 -2
- package/dist/models/GetVisitorTrendsResponse.js +2 -2
- package/dist/models/GetWebhookResponse.d.ts +2 -2
- package/dist/models/GetWebhookResponse.js +2 -2
- package/dist/models/GetWidgetSummaryResponse.d.ts +2 -2
- package/dist/models/GetWidgetSummaryResponse.js +2 -2
- package/dist/models/GetWorkflowStepResponse.d.ts +2 -2
- package/dist/models/GetWorkflowStepResponse.js +2 -2
- package/dist/models/GetWorkspaceTokenResponse.d.ts +2 -2
- package/dist/models/GetWorkspaceTokenResponse.js +2 -2
- package/dist/models/GoogleFormsIntegration.d.ts +2 -2
- package/dist/models/GoogleFormsIntegration.js +2 -2
- package/dist/models/GoogleFormsIntegrationStatus.d.ts +2 -2
- package/dist/models/GoogleFormsIntegrationStatus.js +2 -2
- package/dist/models/GooglerpcStatus.d.ts +2 -2
- package/dist/models/GooglerpcStatus.js +2 -2
- package/dist/models/GroupByDimension.d.ts +2 -2
- package/dist/models/GroupByDimension.js +2 -2
- package/dist/models/HourOfDayDataPoint.d.ts +2 -2
- package/dist/models/HourOfDayDataPoint.js +2 -2
- package/dist/models/IdentifyRequest.d.ts +2 -2
- package/dist/models/IdentifyRequest.js +2 -2
- package/dist/models/IdentifyResponse.d.ts +2 -2
- package/dist/models/IdentifyResponse.js +2 -2
- package/dist/models/IdentifyVisitorTraceData.d.ts +2 -2
- package/dist/models/IdentifyVisitorTraceData.js +2 -2
- package/dist/models/ImportPageThemeTemplateRequest.d.ts +2 -2
- package/dist/models/ImportPageThemeTemplateRequest.js +2 -2
- package/dist/models/ImportPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/ImportPageThemeTemplateResponse.js +2 -2
- package/dist/models/ImportQrcodeTemplateRequest.d.ts +2 -2
- package/dist/models/ImportQrcodeTemplateRequest.js +2 -2
- package/dist/models/ImportQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/ImportQrcodeTemplateResponse.js +2 -2
- package/dist/models/InviteMemberRequest.d.ts +2 -2
- package/dist/models/InviteMemberRequest.js +2 -2
- package/dist/models/Job.d.ts +110 -0
- package/dist/models/Job.js +84 -0
- package/dist/models/JobError.d.ts +38 -0
- package/dist/models/JobError.js +50 -0
- package/dist/models/JobStatus.d.ts +34 -0
- package/dist/models/JobStatus.js +60 -0
- package/dist/models/JobType.d.ts +28 -0
- package/dist/models/JobType.js +54 -0
- package/dist/models/JourneyProgress.d.ts +2 -2
- package/dist/models/JourneyProgress.js +2 -2
- package/dist/models/Link.d.ts +2 -2
- package/dist/models/Link.js +2 -2
- package/dist/models/LinkSetting.d.ts +2 -2
- package/dist/models/LinkSetting.js +2 -2
- package/dist/models/LinkSortField.d.ts +2 -2
- package/dist/models/LinkSortField.js +2 -2
- package/dist/models/LinkView.d.ts +2 -2
- package/dist/models/LinkView.js +2 -2
- package/dist/models/LinksBulkCreateResult.d.ts +33 -0
- package/dist/models/LinksBulkCreateResult.js +48 -0
- package/dist/models/LinksServiceUpdateBody.d.ts +2 -2
- package/dist/models/LinksServiceUpdateBody.js +2 -2
- package/dist/models/ListAllowancesResponse.d.ts +2 -2
- package/dist/models/ListAllowancesResponse.js +2 -2
- package/dist/models/ListApiScopesResponse.d.ts +2 -2
- package/dist/models/ListApiScopesResponse.js +2 -2
- package/dist/models/ListCustomDomainsResponse.d.ts +2 -2
- package/dist/models/ListCustomDomainsResponse.js +2 -2
- package/dist/models/ListDashboardsResponse.d.ts +2 -2
- package/dist/models/ListDashboardsResponse.js +2 -2
- package/dist/models/ListDetectedGoogleFormsResponse.d.ts +2 -2
- package/dist/models/ListDetectedGoogleFormsResponse.js +2 -2
- package/dist/models/ListDirectoriesResponse.d.ts +2 -2
- package/dist/models/ListDirectoriesResponse.js +2 -2
- package/dist/models/ListEventTracesResponse.d.ts +2 -2
- package/dist/models/ListEventTracesResponse.js +2 -2
- package/dist/models/ListEventsCsvResponse.d.ts +2 -2
- package/dist/models/ListEventsCsvResponse.js +2 -2
- package/dist/models/ListEventsJsonResponse.d.ts +2 -2
- package/dist/models/ListEventsJsonResponse.js +2 -2
- package/dist/models/ListEventsResponse.d.ts +2 -2
- package/dist/models/ListEventsResponse.js +2 -2
- package/dist/models/ListLinksResponse.d.ts +2 -2
- package/dist/models/ListLinksResponse.js +2 -2
- package/dist/models/ListMediaResponse.d.ts +2 -2
- package/dist/models/ListMediaResponse.js +2 -2
- package/dist/models/ListPageThemeTemplatesResponse.d.ts +2 -2
- package/dist/models/ListPageThemeTemplatesResponse.js +2 -2
- package/dist/models/ListPageThemesResponse.d.ts +2 -2
- package/dist/models/ListPageThemesResponse.js +2 -2
- package/dist/models/ListPricingPlansResponse.d.ts +2 -2
- package/dist/models/ListPricingPlansResponse.js +2 -2
- package/dist/models/ListQrcodeTemplatesResponse.d.ts +2 -2
- package/dist/models/ListQrcodeTemplatesResponse.js +2 -2
- package/dist/models/ListResponse.d.ts +2 -2
- package/dist/models/ListResponse.js +2 -2
- package/dist/models/ListSandboxesResponse.d.ts +39 -0
- package/dist/models/ListSandboxesResponse.js +51 -0
- package/dist/models/ListSlackChannelsResponse.d.ts +2 -2
- package/dist/models/ListSlackChannelsResponse.js +2 -2
- package/dist/models/ListTagsResponse.d.ts +2 -2
- package/dist/models/ListTagsResponse.js +2 -2
- package/dist/models/ListVisitorAttributeKeysResponse.d.ts +2 -2
- package/dist/models/ListVisitorAttributeKeysResponse.js +2 -2
- package/dist/models/ListVisitorsCsvResponse.d.ts +2 -2
- package/dist/models/ListVisitorsCsvResponse.js +2 -2
- package/dist/models/ListVisitorsJsonResponse.d.ts +2 -2
- package/dist/models/ListVisitorsJsonResponse.js +2 -2
- package/dist/models/ListVisitorsRequest.d.ts +2 -2
- package/dist/models/ListVisitorsRequest.js +2 -2
- package/dist/models/ListVisitorsResponse.d.ts +2 -2
- package/dist/models/ListVisitorsResponse.js +2 -2
- package/dist/models/ListWebhooksResponse.d.ts +2 -2
- package/dist/models/ListWebhooksResponse.js +2 -2
- package/dist/models/ListWorkflowStepsResponse.d.ts +2 -2
- package/dist/models/ListWorkflowStepsResponse.js +2 -2
- package/dist/models/ListWorkspaceTokensResponse.d.ts +2 -2
- package/dist/models/ListWorkspaceTokensResponse.js +2 -2
- package/dist/models/Media.d.ts +2 -2
- package/dist/models/Media.js +2 -2
- package/dist/models/MediaSelection.d.ts +2 -2
- package/dist/models/MediaSelection.js +2 -2
- package/dist/models/MediaType.d.ts +2 -2
- package/dist/models/MediaType.js +2 -2
- package/dist/models/MediaVisibility.d.ts +2 -2
- package/dist/models/MediaVisibility.js +2 -2
- package/dist/models/Member.d.ts +16 -5
- package/dist/models/Member.js +14 -5
- package/dist/models/MembersServiceUpdateBody.d.ts +16 -5
- package/dist/models/MembersServiceUpdateBody.js +14 -5
- package/dist/models/MessagePageNavigationType.d.ts +2 -2
- package/dist/models/MessagePageNavigationType.js +2 -2
- package/dist/models/MessagePagePayload.d.ts +2 -2
- package/dist/models/MessagePagePayload.js +2 -2
- package/dist/models/ModelHTTPMethod.d.ts +2 -2
- package/dist/models/ModelHTTPMethod.js +2 -2
- package/dist/models/Money.d.ts +2 -2
- package/dist/models/Money.js +2 -2
- package/dist/models/MultiLinkButton.d.ts +2 -2
- package/dist/models/MultiLinkButton.js +2 -2
- package/dist/models/MultiLinkPayload.d.ts +2 -2
- package/dist/models/MultiLinkPayload.js +2 -2
- package/dist/models/MultiLinkTraceButton.d.ts +2 -2
- package/dist/models/MultiLinkTraceButton.js +2 -2
- package/dist/models/MultiLinkTraceData.d.ts +2 -2
- package/dist/models/MultiLinkTraceData.js +2 -2
- package/dist/models/MultiLinkTraceSelectedButton.d.ts +2 -2
- package/dist/models/MultiLinkTraceSelectedButton.js +2 -2
- package/dist/models/OutputFileFormat.d.ts +2 -2
- package/dist/models/OutputFileFormat.js +2 -2
- package/dist/models/PageTheme.d.ts +2 -2
- package/dist/models/PageTheme.js +2 -2
- package/dist/models/PageThemeBadgeShape.d.ts +2 -2
- package/dist/models/PageThemeBadgeShape.js +2 -2
- package/dist/models/PageThemeBorderStyle.d.ts +2 -2
- package/dist/models/PageThemeBorderStyle.js +2 -2
- package/dist/models/PageThemeCanvasCoverMode.d.ts +2 -2
- package/dist/models/PageThemeCanvasCoverMode.js +2 -2
- package/dist/models/PageThemeContainerVariant.d.ts +2 -2
- package/dist/models/PageThemeContainerVariant.js +2 -2
- package/dist/models/PageThemeFontFamily.d.ts +2 -2
- package/dist/models/PageThemeFontFamily.js +2 -2
- package/dist/models/PageThemeStyling.d.ts +2 -2
- package/dist/models/PageThemeStyling.js +2 -2
- package/dist/models/PageThemeTemplate.d.ts +2 -2
- package/dist/models/PageThemeTemplate.js +2 -2
- package/dist/models/PageThemeTemplateImages.d.ts +2 -2
- package/dist/models/PageThemeTemplateImages.js +2 -2
- package/dist/models/PageThemeTemplateScope.d.ts +2 -2
- package/dist/models/PageThemeTemplateScope.js +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateBody.d.ts +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateBody.js +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.d.ts +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.js +2 -2
- package/dist/models/PageThemesServiceUpdatePageThemeBody.d.ts +2 -2
- package/dist/models/PageThemesServiceUpdatePageThemeBody.js +2 -2
- package/dist/models/PasswordPayload.d.ts +2 -2
- package/dist/models/PasswordPayload.js +2 -2
- package/dist/models/PasswordTraceData.d.ts +2 -2
- package/dist/models/PasswordTraceData.js +2 -2
- package/dist/models/PlanFeature.d.ts +2 -2
- package/dist/models/PlanFeature.js +2 -2
- package/dist/models/PlanLimit.d.ts +2 -2
- package/dist/models/PlanLimit.js +2 -2
- package/dist/models/PlanLimitKey.d.ts +2 -2
- package/dist/models/PlanLimitKey.js +2 -2
- package/dist/models/PlanLimitKind.d.ts +2 -2
- package/dist/models/PlanLimitKind.js +2 -2
- package/dist/models/PlanPrice.d.ts +2 -2
- package/dist/models/PlanPrice.js +2 -2
- package/dist/models/PlanTrial.d.ts +2 -2
- package/dist/models/PlanTrial.js +2 -2
- package/dist/models/PreferredLinkType.d.ts +2 -2
- package/dist/models/PreferredLinkType.js +2 -2
- package/dist/models/PricingPlan.d.ts +5 -12
- package/dist/models/PricingPlan.js +2 -5
- package/dist/models/PricingPlanId.d.ts +3 -3
- package/dist/models/PricingPlanId.js +3 -3
- package/dist/models/ProtobufAny.d.ts +2 -2
- package/dist/models/ProtobufAny.js +2 -2
- package/dist/models/ProtobufNullValue.d.ts +2 -2
- package/dist/models/ProtobufNullValue.js +2 -2
- package/dist/models/PublicCreateQrcodeDesignRequest.d.ts +2 -2
- package/dist/models/PublicCreateQrcodeDesignRequest.js +2 -2
- package/dist/models/PublicCreateQrcodeDesignResponse.d.ts +2 -2
- package/dist/models/PublicCreateQrcodeDesignResponse.js +2 -2
- package/dist/models/PublicListPageThemeTemplatesResponse.d.ts +2 -2
- package/dist/models/PublicListPageThemeTemplatesResponse.js +2 -2
- package/dist/models/PublicListQrcodeTemplatesResponse.d.ts +2 -2
- package/dist/models/PublicListQrcodeTemplatesResponse.js +2 -2
- package/dist/models/PublicPageThemeTemplate.d.ts +2 -2
- package/dist/models/PublicPageThemeTemplate.js +2 -2
- package/dist/models/PublicQrcodeTemplate.d.ts +2 -2
- package/dist/models/PublicQrcodeTemplate.js +2 -2
- package/dist/models/PublicWorkspace.d.ts +2 -2
- package/dist/models/PublicWorkspace.js +2 -2
- package/dist/models/PublishPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/PublishPageThemeTemplateResponse.js +2 -2
- package/dist/models/PublishQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/PublishQrcodeTemplateResponse.js +2 -2
- package/dist/models/QrcodeDesign.d.ts +2 -2
- package/dist/models/QrcodeDesign.js +2 -2
- package/dist/models/QrcodeDesignServiceUpdateBody.d.ts +2 -2
- package/dist/models/QrcodeDesignServiceUpdateBody.js +2 -2
- package/dist/models/QrcodeTemplate.d.ts +2 -2
- package/dist/models/QrcodeTemplate.js +2 -2
- package/dist/models/QrcodeTemplateScope.d.ts +2 -2
- package/dist/models/QrcodeTemplateScope.js +2 -2
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.d.ts +2 -2
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.js +2 -2
- package/dist/models/RedirectTraceData.d.ts +2 -2
- package/dist/models/RedirectTraceData.js +2 -2
- package/dist/models/RequestWorkspaceEnrollmentRequest.d.ts +2 -2
- package/dist/models/RequestWorkspaceEnrollmentRequest.js +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesRequest.d.ts +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesRequest.js +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesResponse.d.ts +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesResponse.js +2 -2
- package/dist/models/ResolveQrcodeImagesRequest.d.ts +2 -2
- package/dist/models/ResolveQrcodeImagesRequest.js +2 -2
- package/dist/models/ResolveQrcodeImagesResponse.d.ts +2 -2
- package/dist/models/ResolveQrcodeImagesResponse.js +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesRequest.d.ts +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesRequest.js +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesResponse.d.ts +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesResponse.js +2 -2
- package/dist/models/ResolveStepCollisionsResponse.d.ts +2 -2
- package/dist/models/ResolveStepCollisionsResponse.js +2 -2
- package/dist/models/ResponseFormat.d.ts +2 -2
- package/dist/models/ResponseFormat.js +2 -2
- package/dist/models/Role.d.ts +2 -2
- package/dist/models/Role.js +2 -2
- package/dist/models/Sandbox.d.ts +51 -0
- package/dist/models/Sandbox.js +52 -0
- package/dist/models/SettingsServiceUpdateLinkSettingBody.d.ts +2 -2
- package/dist/models/SettingsServiceUpdateLinkSettingBody.js +2 -2
- package/dist/models/Shape.d.ts +2 -2
- package/dist/models/Shape.js +2 -2
- package/dist/models/ShortlinkAvailabilityResponse.d.ts +2 -2
- package/dist/models/ShortlinkAvailabilityResponse.js +2 -2
- package/dist/models/ShortlinkRandomResponse.d.ts +2 -2
- package/dist/models/ShortlinkRandomResponse.js +2 -2
- package/dist/models/SlackChannel.d.ts +2 -2
- package/dist/models/SlackChannel.js +2 -2
- package/dist/models/SlackIntegration.d.ts +2 -2
- package/dist/models/SlackIntegration.js +2 -2
- package/dist/models/SlackIntegrationStatus.d.ts +2 -2
- package/dist/models/SlackIntegrationStatus.js +2 -2
- package/dist/models/SocialLinkButton.d.ts +2 -2
- package/dist/models/SocialLinkButton.js +2 -2
- package/dist/models/SocialLinkTraceButton.d.ts +2 -2
- package/dist/models/SocialLinkTraceButton.js +2 -2
- package/dist/models/SocialLinksDisplayStyle.d.ts +2 -2
- package/dist/models/SocialLinksDisplayStyle.js +2 -2
- package/dist/models/SocialLinksPayload.d.ts +2 -2
- package/dist/models/SocialLinksPayload.js +2 -2
- package/dist/models/SocialLinksTraceData.d.ts +2 -2
- package/dist/models/SocialLinksTraceData.js +2 -2
- package/dist/models/SocketAssistantErrorMessage.d.ts +2 -2
- package/dist/models/SocketAssistantErrorMessage.js +2 -2
- package/dist/models/SocketAssistantProgressMessage.d.ts +2 -2
- package/dist/models/SocketAssistantProgressMessage.js +2 -2
- package/dist/models/SocketAssistantResponseMessage.d.ts +2 -2
- package/dist/models/SocketAssistantResponseMessage.js +2 -2
- package/dist/models/SocketAssistantSendRequest.d.ts +2 -2
- package/dist/models/SocketAssistantSendRequest.js +2 -2
- package/dist/models/SocketConnectedMessage.d.ts +2 -2
- package/dist/models/SocketConnectedMessage.js +2 -2
- package/dist/models/SocketContract.d.ts +2 -2
- package/dist/models/SocketContract.js +2 -2
- package/dist/models/SocketErrorCode.d.ts +2 -2
- package/dist/models/SocketErrorCode.js +2 -2
- package/dist/models/SocketEventMessage.d.ts +2 -2
- package/dist/models/SocketEventMessage.js +2 -2
- package/dist/models/SocketMessageType.d.ts +2 -2
- package/dist/models/SocketMessageType.js +2 -2
- package/dist/models/SocketPingRequest.d.ts +2 -2
- package/dist/models/SocketPingRequest.js +2 -2
- package/dist/models/SocketPongMessage.d.ts +2 -2
- package/dist/models/SocketPongMessage.js +2 -2
- package/dist/models/SocketSubscribeDeniedMessage.d.ts +2 -2
- package/dist/models/SocketSubscribeDeniedMessage.js +2 -2
- package/dist/models/SocketSubscribeRequest.d.ts +2 -2
- package/dist/models/SocketSubscribeRequest.js +2 -2
- package/dist/models/SocketSubscribedMessage.d.ts +2 -2
- package/dist/models/SocketSubscribedMessage.js +2 -2
- package/dist/models/SocketUnsubscribeRequest.d.ts +2 -2
- package/dist/models/SocketUnsubscribeRequest.js +2 -2
- package/dist/models/SortDirection.d.ts +2 -2
- package/dist/models/SortDirection.js +2 -2
- package/dist/models/SpecificDateConditionPayload.d.ts +2 -2
- package/dist/models/SpecificDateConditionPayload.js +2 -2
- package/dist/models/SpecificDateConditionTraceData.d.ts +2 -2
- package/dist/models/SpecificDateConditionTraceData.js +2 -2
- package/dist/models/SpecificDateConditionTraceOption.d.ts +2 -2
- package/dist/models/SpecificDateConditionTraceOption.js +2 -2
- package/dist/models/SpecificDateOption.d.ts +2 -2
- package/dist/models/SpecificDateOption.js +2 -2
- package/dist/models/SubscriptionType.d.ts +2 -2
- package/dist/models/SubscriptionType.js +2 -2
- package/dist/models/SyncGoogleFormsResponse.d.ts +2 -2
- package/dist/models/SyncGoogleFormsResponse.js +2 -2
- package/dist/models/TestSlackIntegrationResponse.d.ts +2 -2
- package/dist/models/TestSlackIntegrationResponse.js +2 -2
- package/dist/models/ThankYouPagePayload.d.ts +2 -2
- package/dist/models/ThankYouPagePayload.js +2 -2
- package/dist/models/ThemeColor.d.ts +2 -2
- package/dist/models/ThemeColor.js +2 -2
- package/dist/models/ThemeColorThemeColorType.d.ts +2 -2
- package/dist/models/ThemeColorThemeColorType.js +2 -2
- package/dist/models/TimeOfDayConditionPayload.d.ts +2 -2
- package/dist/models/TimeOfDayConditionPayload.js +2 -2
- package/dist/models/TimeOfDayConditionTraceData.d.ts +2 -2
- package/dist/models/TimeOfDayConditionTraceData.js +2 -2
- package/dist/models/TimeOfDayConditionTraceRange.d.ts +2 -2
- package/dist/models/TimeOfDayConditionTraceRange.js +2 -2
- package/dist/models/TimeOfDayRange.d.ts +2 -2
- package/dist/models/TimeOfDayRange.js +2 -2
- package/dist/models/TimeSeriesPoint.d.ts +2 -2
- package/dist/models/TimeSeriesPoint.js +2 -2
- package/dist/models/TimeSeriesSeries.d.ts +2 -2
- package/dist/models/TimeSeriesSeries.js +2 -2
- package/dist/models/TopLinkDataPoint.d.ts +2 -2
- package/dist/models/TopLinkDataPoint.js +2 -2
- package/dist/models/TriggeredBy.d.ts +2 -2
- package/dist/models/TriggeredBy.js +2 -2
- package/dist/models/UpdateCustomDomainResponse.d.ts +2 -2
- package/dist/models/UpdateCustomDomainResponse.js +2 -2
- package/dist/models/UpdateDashboardResponse.d.ts +2 -2
- package/dist/models/UpdateDashboardResponse.js +2 -2
- package/dist/models/UpdateDeviceResponse.d.ts +2 -2
- package/dist/models/UpdateDeviceResponse.js +2 -2
- package/dist/models/UpdateDirectoryResponse.d.ts +2 -2
- package/dist/models/UpdateDirectoryResponse.js +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationRequest.d.ts +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationRequest.js +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationResponse.d.ts +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationResponse.js +2 -2
- package/dist/models/UpdateLinkResponse.d.ts +2 -2
- package/dist/models/UpdateLinkResponse.js +2 -2
- package/dist/models/UpdateLinkSettingResponse.d.ts +2 -2
- package/dist/models/UpdateLinkSettingResponse.js +2 -2
- package/dist/models/UpdateMeRequest.d.ts +2 -2
- package/dist/models/UpdateMeRequest.js +2 -2
- package/dist/models/UpdatePageThemeResponse.d.ts +2 -2
- package/dist/models/UpdatePageThemeResponse.js +2 -2
- package/dist/models/UpdatePageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/UpdatePageThemeTemplateResponse.js +2 -2
- package/dist/models/UpdatePageThemeTemplateStylingResponse.d.ts +2 -2
- package/dist/models/UpdatePageThemeTemplateStylingResponse.js +2 -2
- package/dist/models/UpdateQrcodeDesignResponse.d.ts +2 -2
- package/dist/models/UpdateQrcodeDesignResponse.js +2 -2
- package/dist/models/UpdateQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/UpdateQrcodeTemplateResponse.js +2 -2
- package/dist/models/UpdateSlackIntegrationRequest.d.ts +2 -2
- package/dist/models/UpdateSlackIntegrationRequest.js +2 -2
- package/dist/models/UpdateSlackIntegrationResponse.d.ts +2 -2
- package/dist/models/UpdateSlackIntegrationResponse.js +2 -2
- package/dist/models/UpdateWebhookResponse.d.ts +2 -2
- package/dist/models/UpdateWebhookResponse.js +2 -2
- package/dist/models/UpdateWorkflowStepResponse.d.ts +2 -2
- package/dist/models/UpdateWorkflowStepResponse.js +2 -2
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.d.ts +2 -2
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.js +2 -2
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.d.ts +2 -2
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.js +2 -2
- package/dist/models/UpdateWorkspaceRequest.d.ts +2 -2
- package/dist/models/UpdateWorkspaceRequest.js +2 -2
- package/dist/models/UpdateWorkspaceTokenResponse.d.ts +2 -2
- package/dist/models/UpdateWorkspaceTokenResponse.js +2 -2
- package/dist/models/VCardData.d.ts +2 -2
- package/dist/models/VCardData.js +2 -2
- package/dist/models/VCardPayload.d.ts +2 -2
- package/dist/models/VCardPayload.js +2 -2
- package/dist/models/VCardSocialLink.d.ts +2 -2
- package/dist/models/VCardSocialLink.js +2 -2
- package/dist/models/ValidateWorkflowResponse.d.ts +2 -2
- package/dist/models/ValidateWorkflowResponse.js +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponse.d.ts +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponse.js +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.d.ts +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.js +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.d.ts +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.js +2 -2
- package/dist/models/ValidationPurpose.d.ts +2 -2
- package/dist/models/ValidationPurpose.js +2 -2
- package/dist/models/VisitType.d.ts +2 -2
- package/dist/models/VisitType.js +2 -2
- package/dist/models/VisitTypeConditionOption.d.ts +2 -2
- package/dist/models/VisitTypeConditionOption.js +2 -2
- package/dist/models/VisitTypeConditionPayload.d.ts +2 -2
- package/dist/models/VisitTypeConditionPayload.js +2 -2
- package/dist/models/VisitTypeConditionTraceData.d.ts +2 -2
- package/dist/models/VisitTypeConditionTraceData.js +2 -2
- package/dist/models/VisitTypeConditionTraceOption.d.ts +2 -2
- package/dist/models/VisitTypeConditionTraceOption.js +2 -2
- package/dist/models/Visitor.d.ts +2 -2
- package/dist/models/Visitor.js +2 -2
- package/dist/models/VisitorAttribute.d.ts +2 -2
- package/dist/models/VisitorAttribute.js +2 -2
- package/dist/models/VisitorAttributeFilter.d.ts +2 -2
- package/dist/models/VisitorAttributeFilter.js +2 -2
- package/dist/models/VisitorAttributeFilterOperator.d.ts +2 -2
- package/dist/models/VisitorAttributeFilterOperator.js +2 -2
- package/dist/models/VisitorAttributeKey.d.ts +2 -2
- package/dist/models/VisitorAttributeKey.js +2 -2
- package/dist/models/VisitorAttributeType.d.ts +2 -2
- package/dist/models/VisitorAttributeType.js +2 -2
- package/dist/models/VisitorDataConditionOption.d.ts +2 -2
- package/dist/models/VisitorDataConditionOption.js +2 -2
- package/dist/models/VisitorDataConditionPayload.d.ts +2 -2
- package/dist/models/VisitorDataConditionPayload.js +2 -2
- package/dist/models/VisitorDataConditionTraceData.d.ts +2 -2
- package/dist/models/VisitorDataConditionTraceData.js +2 -2
- package/dist/models/VisitorDataConditionTraceOption.d.ts +2 -2
- package/dist/models/VisitorDataConditionTraceOption.js +2 -2
- package/dist/models/VisitorEvent.d.ts +2 -2
- package/dist/models/VisitorEvent.js +2 -2
- package/dist/models/VisitorInput.d.ts +2 -2
- package/dist/models/VisitorInput.js +2 -2
- package/dist/models/VisitorLink.d.ts +2 -2
- package/dist/models/VisitorLink.js +2 -2
- package/dist/models/VisitorSortField.d.ts +2 -2
- package/dist/models/VisitorSortField.js +2 -2
- package/dist/models/VisitorTrendDataPoint.d.ts +2 -2
- package/dist/models/VisitorTrendDataPoint.js +2 -2
- package/dist/models/VisitorsServiceUpdateBody.d.ts +2 -2
- package/dist/models/VisitorsServiceUpdateBody.js +2 -2
- package/dist/models/Webhook.d.ts +2 -2
- package/dist/models/Webhook.js +2 -2
- package/dist/models/WebhookSource.d.ts +2 -2
- package/dist/models/WebhookSource.js +2 -2
- package/dist/models/WebhookStatus.d.ts +2 -2
- package/dist/models/WebhookStatus.js +2 -2
- package/dist/models/WebhooksServiceUpdateBody.d.ts +2 -2
- package/dist/models/WebhooksServiceUpdateBody.js +2 -2
- package/dist/models/WidgetDataSource.d.ts +2 -2
- package/dist/models/WidgetDataSource.js +2 -2
- package/dist/models/WidgetFieldMapping.d.ts +2 -2
- package/dist/models/WidgetFieldMapping.js +2 -2
- package/dist/models/WidgetPosition.d.ts +2 -2
- package/dist/models/WidgetPosition.js +2 -2
- package/dist/models/WidgetSize.d.ts +2 -2
- package/dist/models/WidgetSize.js +2 -2
- package/dist/models/WidgetTab.d.ts +2 -2
- package/dist/models/WidgetTab.js +2 -2
- package/dist/models/WidgetTabMode.d.ts +2 -2
- package/dist/models/WidgetTabMode.js +2 -2
- package/dist/models/WidgetTabView.d.ts +2 -2
- package/dist/models/WidgetTabView.js +2 -2
- package/dist/models/WidgetVisualization.d.ts +2 -2
- package/dist/models/WidgetVisualization.js +2 -2
- package/dist/models/WorkflowIssue.d.ts +2 -2
- package/dist/models/WorkflowIssue.js +2 -2
- package/dist/models/WorkflowStep.d.ts +2 -2
- package/dist/models/WorkflowStep.js +2 -2
- package/dist/models/WorkflowStepBranch.d.ts +2 -2
- package/dist/models/WorkflowStepBranch.js +2 -2
- package/dist/models/WorkflowStepKind.d.ts +2 -2
- package/dist/models/WorkflowStepKind.js +2 -2
- package/dist/models/WorkflowStepNodeType.d.ts +2 -2
- package/dist/models/WorkflowStepNodeType.js +2 -2
- package/dist/models/WorkflowStepPayload.d.ts +2 -2
- package/dist/models/WorkflowStepPayload.js +2 -2
- package/dist/models/WorkflowStepsServiceConnectStepBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceConnectStepBody.js +2 -2
- package/dist/models/WorkflowStepsServiceCreateBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceCreateBody.js +2 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.js +2 -2
- package/dist/models/Workspace.d.ts +15 -3
- package/dist/models/Workspace.js +4 -2
- package/dist/models/WorkspaceAllowance.d.ts +2 -2
- package/dist/models/WorkspaceAllowance.js +2 -2
- package/dist/models/WorkspaceInsight.d.ts +2 -2
- package/dist/models/WorkspaceInsight.js +2 -2
- package/dist/models/WorkspaceMetric.d.ts +2 -2
- package/dist/models/WorkspaceMetric.js +2 -2
- package/dist/models/WorkspaceToken.d.ts +54 -9
- package/dist/models/WorkspaceToken.js +49 -7
- package/dist/models/WorkspaceTokenKeyType.d.ts +2 -2
- package/dist/models/WorkspaceTokenKeyType.js +2 -2
- package/dist/models/WorkspaceTokensServiceUpdateBody.d.ts +40 -5
- package/dist/models/WorkspaceTokensServiceUpdateBody.js +40 -5
- package/dist/models/index.d.ts +13 -2
- package/dist/models/index.js +13 -2
- package/dist/runtime.d.ts +2 -2
- package/dist/runtime.js +2 -2
- package/package.json +1 -1
- package/dist/models/MeteredPrice.d.ts +0 -40
- package/dist/models/MeteredPrice.js +0 -52
- package/dist/models/MeteredUnit.d.ts +0 -32
- package/dist/models/MeteredUnit.js +0 -58
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -73,6 +73,12 @@ export interface Workspace {
|
|
|
73
73
|
* @memberof Workspace
|
|
74
74
|
*/
|
|
75
75
|
inactiveSince?: Date;
|
|
76
|
+
/**
|
|
77
|
+
* True for a sandbox workspace: API-only, with its own caps, never billed.
|
|
78
|
+
* @type {boolean}
|
|
79
|
+
* @memberof Workspace
|
|
80
|
+
*/
|
|
81
|
+
readonly isSandbox?: boolean;
|
|
76
82
|
/**
|
|
77
83
|
*
|
|
78
84
|
* @type {string}
|
|
@@ -91,6 +97,12 @@ export interface Workspace {
|
|
|
91
97
|
* @memberof Workspace
|
|
92
98
|
*/
|
|
93
99
|
publishedAt?: Date;
|
|
100
|
+
/**
|
|
101
|
+
* When a sandbox workspace is deleted. Unset for a live workspace.
|
|
102
|
+
* @type {Date}
|
|
103
|
+
* @memberof Workspace
|
|
104
|
+
*/
|
|
105
|
+
readonly sandboxExpiresAt?: Date;
|
|
94
106
|
/**
|
|
95
107
|
*
|
|
96
108
|
* @type {string}
|
|
@@ -180,4 +192,4 @@ export declare function instanceOfWorkspace(value: object): value is Workspace;
|
|
|
180
192
|
export declare function WorkspaceFromJSON(json: any): Workspace;
|
|
181
193
|
export declare function WorkspaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Workspace;
|
|
182
194
|
export declare function WorkspaceToJSON(json: any): Workspace;
|
|
183
|
-
export declare function WorkspaceToJSONTyped(value?: Workspace | null, ignoreDiscriminator?: boolean): any;
|
|
195
|
+
export declare function WorkspaceToJSONTyped(value?: Omit<Workspace, 'isSandbox' | 'sandboxExpiresAt'> | null, ignoreDiscriminator?: boolean): any;
|
package/dist/models/Workspace.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,9 +62,11 @@ function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
62
62
|
'faq': json['faq'] == null ? undefined : json['faq'],
|
|
63
63
|
'id': json['id'] == null ? undefined : json['id'],
|
|
64
64
|
'inactiveSince': json['inactiveSince'] == null ? undefined : (new Date(json['inactiveSince'])),
|
|
65
|
+
'isSandbox': json['isSandbox'] == null ? undefined : json['isSandbox'],
|
|
65
66
|
'linkSettingId': json['linkSettingId'] == null ? undefined : json['linkSettingId'],
|
|
66
67
|
'name': json['name'] == null ? undefined : json['name'],
|
|
67
68
|
'publishedAt': json['publishedAt'] == null ? undefined : (new Date(json['publishedAt'])),
|
|
69
|
+
'sandboxExpiresAt': json['sandboxExpiresAt'] == null ? undefined : (new Date(json['sandboxExpiresAt'])),
|
|
68
70
|
'shortDescription': json['shortDescription'] == null ? undefined : json['shortDescription'],
|
|
69
71
|
'slug': json['slug'] == null ? undefined : json['slug'],
|
|
70
72
|
'subscriptionType': json['subscriptionType'] == null ? undefined : json['subscriptionType'],
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,16 +1,14 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type { ApiScope } from './ApiScope';
|
|
13
|
-
import type { WorkspaceTokenKeyType } from './WorkspaceTokenKeyType';
|
|
14
12
|
/**
|
|
15
13
|
* Describes a long-lived credential Linkbreakers issues so back-end integrations can call workspace APIs
|
|
16
14
|
* without a human session, while keeping auditing metadata for security reviews.
|
|
@@ -44,11 +42,13 @@ export interface WorkspaceToken {
|
|
|
44
42
|
*/
|
|
45
43
|
id?: string;
|
|
46
44
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
45
|
+
* - WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED: Default value (should not be used)
|
|
46
|
+
* - WORKSPACE_TOKEN_KEY_TYPE_SECRET: Secret key with full API access
|
|
47
|
+
* - WORKSPACE_TOKEN_KEY_TYPE_PUBLISHABLE: Publishable key with limited access
|
|
48
|
+
* @type {WorkspaceTokenKeyTypeEnum}
|
|
49
49
|
* @memberof WorkspaceToken
|
|
50
50
|
*/
|
|
51
|
-
readonly keyType?:
|
|
51
|
+
readonly keyType?: WorkspaceTokenKeyTypeEnum;
|
|
52
52
|
/**
|
|
53
53
|
*
|
|
54
54
|
* @type {Date}
|
|
@@ -63,10 +63,10 @@ export interface WorkspaceToken {
|
|
|
63
63
|
name?: string;
|
|
64
64
|
/**
|
|
65
65
|
* The scopes the token holds. With full access, every scope that exists today.
|
|
66
|
-
* @type {Array<
|
|
66
|
+
* @type {Array<WorkspaceTokenScopesEnum>}
|
|
67
67
|
* @memberof WorkspaceToken
|
|
68
68
|
*/
|
|
69
|
-
scopes?: Array<
|
|
69
|
+
scopes?: Array<WorkspaceTokenScopesEnum>;
|
|
70
70
|
/**
|
|
71
71
|
*
|
|
72
72
|
* @type {Date}
|
|
@@ -80,6 +80,51 @@ export interface WorkspaceToken {
|
|
|
80
80
|
*/
|
|
81
81
|
workspaceId?: string;
|
|
82
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* @export
|
|
85
|
+
*/
|
|
86
|
+
export declare const WorkspaceTokenKeyTypeEnum: {
|
|
87
|
+
readonly WorkspaceTokenKeyTypeUnspecified: "WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED";
|
|
88
|
+
readonly WorkspaceTokenKeyTypeSecret: "WORKSPACE_TOKEN_KEY_TYPE_SECRET";
|
|
89
|
+
readonly WorkspaceTokenKeyTypePublishable: "WORKSPACE_TOKEN_KEY_TYPE_PUBLISHABLE";
|
|
90
|
+
};
|
|
91
|
+
export type WorkspaceTokenKeyTypeEnum = typeof WorkspaceTokenKeyTypeEnum[keyof typeof WorkspaceTokenKeyTypeEnum];
|
|
92
|
+
/**
|
|
93
|
+
* @export
|
|
94
|
+
*/
|
|
95
|
+
export declare const WorkspaceTokenScopesEnum: {
|
|
96
|
+
readonly ApiScopeUnspecified: "API_SCOPE_UNSPECIFIED";
|
|
97
|
+
readonly ApiScopeLinksRead: "API_SCOPE_LINKS_READ";
|
|
98
|
+
readonly ApiScopeLinksWrite: "API_SCOPE_LINKS_WRITE";
|
|
99
|
+
readonly ApiScopeWorkflowsRead: "API_SCOPE_WORKFLOWS_READ";
|
|
100
|
+
readonly ApiScopeWorkflowsWrite: "API_SCOPE_WORKFLOWS_WRITE";
|
|
101
|
+
readonly ApiScopeQrcodesRead: "API_SCOPE_QRCODES_READ";
|
|
102
|
+
readonly ApiScopeQrcodesWrite: "API_SCOPE_QRCODES_WRITE";
|
|
103
|
+
readonly ApiScopePageThemesRead: "API_SCOPE_PAGE_THEMES_READ";
|
|
104
|
+
readonly ApiScopePageThemesWrite: "API_SCOPE_PAGE_THEMES_WRITE";
|
|
105
|
+
readonly ApiScopeMediaRead: "API_SCOPE_MEDIA_READ";
|
|
106
|
+
readonly ApiScopeMediaWrite: "API_SCOPE_MEDIA_WRITE";
|
|
107
|
+
readonly ApiScopeDomainsRead: "API_SCOPE_DOMAINS_READ";
|
|
108
|
+
readonly ApiScopeDomainsWrite: "API_SCOPE_DOMAINS_WRITE";
|
|
109
|
+
readonly ApiScopeVisitorsRead: "API_SCOPE_VISITORS_READ";
|
|
110
|
+
readonly ApiScopeVisitorsWrite: "API_SCOPE_VISITORS_WRITE";
|
|
111
|
+
readonly ApiScopeAnalyticsRead: "API_SCOPE_ANALYTICS_READ";
|
|
112
|
+
readonly ApiScopeAnalyticsWrite: "API_SCOPE_ANALYTICS_WRITE";
|
|
113
|
+
readonly ApiScopeWebhooksRead: "API_SCOPE_WEBHOOKS_READ";
|
|
114
|
+
readonly ApiScopeWebhooksWrite: "API_SCOPE_WEBHOOKS_WRITE";
|
|
115
|
+
readonly ApiScopeIntegrationsRead: "API_SCOPE_INTEGRATIONS_READ";
|
|
116
|
+
readonly ApiScopeIntegrationsWrite: "API_SCOPE_INTEGRATIONS_WRITE";
|
|
117
|
+
readonly ApiScopeWorkspaceRead: "API_SCOPE_WORKSPACE_READ";
|
|
118
|
+
readonly ApiScopeWorkspaceWrite: "API_SCOPE_WORKSPACE_WRITE";
|
|
119
|
+
readonly ApiScopeMembersRead: "API_SCOPE_MEMBERS_READ";
|
|
120
|
+
readonly ApiScopeMembersWrite: "API_SCOPE_MEMBERS_WRITE";
|
|
121
|
+
readonly ApiScopeTokensRead: "API_SCOPE_TOKENS_READ";
|
|
122
|
+
readonly ApiScopeTokensWrite: "API_SCOPE_TOKENS_WRITE";
|
|
123
|
+
readonly ApiScopeBillingWrite: "API_SCOPE_BILLING_WRITE";
|
|
124
|
+
readonly ApiScopeAssistantRead: "API_SCOPE_ASSISTANT_READ";
|
|
125
|
+
readonly ApiScopeAssistantWrite: "API_SCOPE_ASSISTANT_WRITE";
|
|
126
|
+
};
|
|
127
|
+
export type WorkspaceTokenScopesEnum = typeof WorkspaceTokenScopesEnum[keyof typeof WorkspaceTokenScopesEnum];
|
|
83
128
|
/**
|
|
84
129
|
* Check if a given object implements the WorkspaceToken interface.
|
|
85
130
|
*/
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,13 +13,55 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WorkspaceTokenScopesEnum = exports.WorkspaceTokenKeyTypeEnum = void 0;
|
|
16
17
|
exports.instanceOfWorkspaceToken = instanceOfWorkspaceToken;
|
|
17
18
|
exports.WorkspaceTokenFromJSON = WorkspaceTokenFromJSON;
|
|
18
19
|
exports.WorkspaceTokenFromJSONTyped = WorkspaceTokenFromJSONTyped;
|
|
19
20
|
exports.WorkspaceTokenToJSON = WorkspaceTokenToJSON;
|
|
20
21
|
exports.WorkspaceTokenToJSONTyped = WorkspaceTokenToJSONTyped;
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.WorkspaceTokenKeyTypeEnum = {
|
|
26
|
+
WorkspaceTokenKeyTypeUnspecified: 'WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED',
|
|
27
|
+
WorkspaceTokenKeyTypeSecret: 'WORKSPACE_TOKEN_KEY_TYPE_SECRET',
|
|
28
|
+
WorkspaceTokenKeyTypePublishable: 'WORKSPACE_TOKEN_KEY_TYPE_PUBLISHABLE'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
exports.WorkspaceTokenScopesEnum = {
|
|
34
|
+
ApiScopeUnspecified: 'API_SCOPE_UNSPECIFIED',
|
|
35
|
+
ApiScopeLinksRead: 'API_SCOPE_LINKS_READ',
|
|
36
|
+
ApiScopeLinksWrite: 'API_SCOPE_LINKS_WRITE',
|
|
37
|
+
ApiScopeWorkflowsRead: 'API_SCOPE_WORKFLOWS_READ',
|
|
38
|
+
ApiScopeWorkflowsWrite: 'API_SCOPE_WORKFLOWS_WRITE',
|
|
39
|
+
ApiScopeQrcodesRead: 'API_SCOPE_QRCODES_READ',
|
|
40
|
+
ApiScopeQrcodesWrite: 'API_SCOPE_QRCODES_WRITE',
|
|
41
|
+
ApiScopePageThemesRead: 'API_SCOPE_PAGE_THEMES_READ',
|
|
42
|
+
ApiScopePageThemesWrite: 'API_SCOPE_PAGE_THEMES_WRITE',
|
|
43
|
+
ApiScopeMediaRead: 'API_SCOPE_MEDIA_READ',
|
|
44
|
+
ApiScopeMediaWrite: 'API_SCOPE_MEDIA_WRITE',
|
|
45
|
+
ApiScopeDomainsRead: 'API_SCOPE_DOMAINS_READ',
|
|
46
|
+
ApiScopeDomainsWrite: 'API_SCOPE_DOMAINS_WRITE',
|
|
47
|
+
ApiScopeVisitorsRead: 'API_SCOPE_VISITORS_READ',
|
|
48
|
+
ApiScopeVisitorsWrite: 'API_SCOPE_VISITORS_WRITE',
|
|
49
|
+
ApiScopeAnalyticsRead: 'API_SCOPE_ANALYTICS_READ',
|
|
50
|
+
ApiScopeAnalyticsWrite: 'API_SCOPE_ANALYTICS_WRITE',
|
|
51
|
+
ApiScopeWebhooksRead: 'API_SCOPE_WEBHOOKS_READ',
|
|
52
|
+
ApiScopeWebhooksWrite: 'API_SCOPE_WEBHOOKS_WRITE',
|
|
53
|
+
ApiScopeIntegrationsRead: 'API_SCOPE_INTEGRATIONS_READ',
|
|
54
|
+
ApiScopeIntegrationsWrite: 'API_SCOPE_INTEGRATIONS_WRITE',
|
|
55
|
+
ApiScopeWorkspaceRead: 'API_SCOPE_WORKSPACE_READ',
|
|
56
|
+
ApiScopeWorkspaceWrite: 'API_SCOPE_WORKSPACE_WRITE',
|
|
57
|
+
ApiScopeMembersRead: 'API_SCOPE_MEMBERS_READ',
|
|
58
|
+
ApiScopeMembersWrite: 'API_SCOPE_MEMBERS_WRITE',
|
|
59
|
+
ApiScopeTokensRead: 'API_SCOPE_TOKENS_READ',
|
|
60
|
+
ApiScopeTokensWrite: 'API_SCOPE_TOKENS_WRITE',
|
|
61
|
+
ApiScopeBillingWrite: 'API_SCOPE_BILLING_WRITE',
|
|
62
|
+
ApiScopeAssistantRead: 'API_SCOPE_ASSISTANT_READ',
|
|
63
|
+
ApiScopeAssistantWrite: 'API_SCOPE_ASSISTANT_WRITE'
|
|
64
|
+
};
|
|
23
65
|
/**
|
|
24
66
|
* Check if a given object implements the WorkspaceToken interface.
|
|
25
67
|
*/
|
|
@@ -38,10 +80,10 @@ function WorkspaceTokenFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
80
|
'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
|
|
39
81
|
'fullAccess': json['fullAccess'] == null ? undefined : json['fullAccess'],
|
|
40
82
|
'id': json['id'] == null ? undefined : json['id'],
|
|
41
|
-
'keyType': json['keyType'] == null ? undefined :
|
|
83
|
+
'keyType': json['keyType'] == null ? undefined : json['keyType'],
|
|
42
84
|
'lastUsedAt': json['lastUsedAt'] == null ? undefined : (new Date(json['lastUsedAt'])),
|
|
43
85
|
'name': json['name'] == null ? undefined : json['name'],
|
|
44
|
-
'scopes': json['scopes'] == null ? undefined :
|
|
86
|
+
'scopes': json['scopes'] == null ? undefined : json['scopes'],
|
|
45
87
|
'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
|
|
46
88
|
'workspaceId': json['workspaceId'] == null ? undefined : json['workspaceId'],
|
|
47
89
|
};
|
|
@@ -57,7 +99,7 @@ function WorkspaceTokenToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
57
99
|
'createdBy': value['createdBy'],
|
|
58
100
|
'id': value['id'],
|
|
59
101
|
'name': value['name'],
|
|
60
|
-
'scopes': value['scopes']
|
|
102
|
+
'scopes': value['scopes'],
|
|
61
103
|
'workspaceId': value['workspaceId'],
|
|
62
104
|
};
|
|
63
105
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers
|
|
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.157.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|