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
|
@@ -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).
|
|
@@ -13,36 +13,47 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import type { GetAttributeDistributionRequest, GetAttributeDistributionResponse, GetAttributeMetricRequest, GetAttributeMetricResponse, GetAttributeValuesRequest, GetAttributeValuesResponse, GetBreakdownRequest, GetBreakdownResponse, GetDeviceDistributionRequest, GetDeviceDistributionResponse, GetGeoBreakdownRequest, GetGeoBreakdownResponse, GetGroupedTimeSeriesRequest, GetGroupedTimeSeriesResponse, GetHourOfDayDistributionRequest, GetHourOfDayDistributionResponse, GetStepFunnelRequest, GetStepFunnelResponse, GetTopLinksRequest, GetTopLinksResponse, GetVisitorTrendsRequest, GetVisitorTrendsResponse } from '../models/index';
|
|
14
14
|
export interface AnalyticsDataServiceGetAttributeDistributionRequest {
|
|
15
15
|
getAttributeDistributionRequest: GetAttributeDistributionRequest;
|
|
16
|
+
idempotencyKey?: string;
|
|
16
17
|
}
|
|
17
18
|
export interface AnalyticsDataServiceGetAttributeMetricRequest {
|
|
18
19
|
getAttributeMetricRequest: GetAttributeMetricRequest;
|
|
20
|
+
idempotencyKey?: string;
|
|
19
21
|
}
|
|
20
22
|
export interface AnalyticsDataServiceGetAttributeValuesRequest {
|
|
21
23
|
getAttributeValuesRequest: GetAttributeValuesRequest;
|
|
24
|
+
idempotencyKey?: string;
|
|
22
25
|
}
|
|
23
26
|
export interface AnalyticsDataServiceGetBreakdownRequest {
|
|
24
27
|
getBreakdownRequest: GetBreakdownRequest;
|
|
28
|
+
idempotencyKey?: string;
|
|
25
29
|
}
|
|
26
30
|
export interface AnalyticsDataServiceGetDeviceDistributionRequest {
|
|
27
31
|
getDeviceDistributionRequest: GetDeviceDistributionRequest;
|
|
32
|
+
idempotencyKey?: string;
|
|
28
33
|
}
|
|
29
34
|
export interface AnalyticsDataServiceGetGeoBreakdownRequest {
|
|
30
35
|
getGeoBreakdownRequest: GetGeoBreakdownRequest;
|
|
36
|
+
idempotencyKey?: string;
|
|
31
37
|
}
|
|
32
38
|
export interface AnalyticsDataServiceGetGroupedTimeSeriesRequest {
|
|
33
39
|
getGroupedTimeSeriesRequest: GetGroupedTimeSeriesRequest;
|
|
40
|
+
idempotencyKey?: string;
|
|
34
41
|
}
|
|
35
42
|
export interface AnalyticsDataServiceGetHourOfDayDistributionRequest {
|
|
36
43
|
getHourOfDayDistributionRequest: GetHourOfDayDistributionRequest;
|
|
44
|
+
idempotencyKey?: string;
|
|
37
45
|
}
|
|
38
46
|
export interface AnalyticsDataServiceGetStepFunnelRequest {
|
|
39
47
|
getStepFunnelRequest: GetStepFunnelRequest;
|
|
48
|
+
idempotencyKey?: string;
|
|
40
49
|
}
|
|
41
50
|
export interface AnalyticsDataServiceGetTopLinksRequest {
|
|
42
51
|
getTopLinksRequest: GetTopLinksRequest;
|
|
52
|
+
idempotencyKey?: string;
|
|
43
53
|
}
|
|
44
54
|
export interface AnalyticsDataServiceGetVisitorTrendsRequest {
|
|
45
55
|
getVisitorTrendsRequest: GetVisitorTrendsRequest;
|
|
56
|
+
idempotencyKey?: string;
|
|
46
57
|
}
|
|
47
58
|
/**
|
|
48
59
|
* AnalyticsDataApi - interface
|
|
@@ -54,6 +65,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
54
65
|
/**
|
|
55
66
|
* Creates request options for analyticsDataServiceGetAttributeDistribution without sending the request
|
|
56
67
|
* @param {GetAttributeDistributionRequest} getAttributeDistributionRequest
|
|
68
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
57
69
|
* @throws {RequiredError}
|
|
58
70
|
* @memberof AnalyticsDataApiInterface
|
|
59
71
|
*/
|
|
@@ -62,6 +74,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
62
74
|
* Returns how visitors are spread across the values of one attribute, for example how many gave each rating. Requires the `analytics:read` scope.
|
|
63
75
|
* @summary Get visitor attribute distribution
|
|
64
76
|
* @param {GetAttributeDistributionRequest} getAttributeDistributionRequest
|
|
77
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
65
78
|
* @param {*} [options] Override http request option.
|
|
66
79
|
* @throws {RequiredError}
|
|
67
80
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -75,6 +88,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
75
88
|
/**
|
|
76
89
|
* Creates request options for analyticsDataServiceGetAttributeMetric without sending the request
|
|
77
90
|
* @param {GetAttributeMetricRequest} getAttributeMetricRequest
|
|
91
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
78
92
|
* @throws {RequiredError}
|
|
79
93
|
* @memberof AnalyticsDataApiInterface
|
|
80
94
|
*/
|
|
@@ -83,6 +97,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
83
97
|
* Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it. Requires the `analytics:read` scope.
|
|
84
98
|
* @summary Get visitor attribute metric
|
|
85
99
|
* @param {GetAttributeMetricRequest} getAttributeMetricRequest
|
|
100
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
86
101
|
* @param {*} [options] Override http request option.
|
|
87
102
|
* @throws {RequiredError}
|
|
88
103
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -96,6 +111,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
96
111
|
/**
|
|
97
112
|
* Creates request options for analyticsDataServiceGetAttributeValues without sending the request
|
|
98
113
|
* @param {GetAttributeValuesRequest} getAttributeValuesRequest
|
|
114
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
99
115
|
* @throws {RequiredError}
|
|
100
116
|
* @memberof AnalyticsDataApiInterface
|
|
101
117
|
*/
|
|
@@ -104,6 +120,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
104
120
|
* Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments. Requires the `analytics:read` scope.
|
|
105
121
|
* @summary List visitor attribute values
|
|
106
122
|
* @param {GetAttributeValuesRequest} getAttributeValuesRequest
|
|
123
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
107
124
|
* @param {*} [options] Override http request option.
|
|
108
125
|
* @throws {RequiredError}
|
|
109
126
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -117,6 +134,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
117
134
|
/**
|
|
118
135
|
* Creates request options for analyticsDataServiceGetBreakdown without sending the request
|
|
119
136
|
* @param {GetBreakdownRequest} getBreakdownRequest
|
|
137
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
120
138
|
* @throws {RequiredError}
|
|
121
139
|
* @memberof AnalyticsDataApiInterface
|
|
122
140
|
*/
|
|
@@ -125,6 +143,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
125
143
|
* Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type). Requires the `analytics:read` scope.
|
|
126
144
|
* @summary Get dimension breakdown
|
|
127
145
|
* @param {GetBreakdownRequest} getBreakdownRequest
|
|
146
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
128
147
|
* @param {*} [options] Override http request option.
|
|
129
148
|
* @throws {RequiredError}
|
|
130
149
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -138,6 +157,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
138
157
|
/**
|
|
139
158
|
* Creates request options for analyticsDataServiceGetDeviceDistribution without sending the request
|
|
140
159
|
* @param {GetDeviceDistributionRequest} getDeviceDistributionRequest
|
|
160
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
141
161
|
* @throws {RequiredError}
|
|
142
162
|
* @memberof AnalyticsDataApiInterface
|
|
143
163
|
*/
|
|
@@ -146,6 +166,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
146
166
|
* Retrieve event distribution across device types. Requires the `analytics:read` scope.
|
|
147
167
|
* @summary Get device distribution
|
|
148
168
|
* @param {GetDeviceDistributionRequest} getDeviceDistributionRequest
|
|
169
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
149
170
|
* @param {*} [options] Override http request option.
|
|
150
171
|
* @throws {RequiredError}
|
|
151
172
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -159,6 +180,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
159
180
|
/**
|
|
160
181
|
* Creates request options for analyticsDataServiceGetGeoBreakdown without sending the request
|
|
161
182
|
* @param {GetGeoBreakdownRequest} getGeoBreakdownRequest
|
|
183
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
162
184
|
* @throws {RequiredError}
|
|
163
185
|
* @memberof AnalyticsDataApiInterface
|
|
164
186
|
*/
|
|
@@ -167,6 +189,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
167
189
|
* Retrieve geographic distribution of events grouped by country or city. Requires the `analytics:read` scope.
|
|
168
190
|
* @summary Get geographic breakdown
|
|
169
191
|
* @param {GetGeoBreakdownRequest} getGeoBreakdownRequest
|
|
192
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
170
193
|
* @param {*} [options] Override http request option.
|
|
171
194
|
* @throws {RequiredError}
|
|
172
195
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -180,6 +203,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
180
203
|
/**
|
|
181
204
|
* Creates request options for analyticsDataServiceGetGroupedTimeSeries without sending the request
|
|
182
205
|
* @param {GetGroupedTimeSeriesRequest} getGroupedTimeSeriesRequest
|
|
206
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
183
207
|
* @throws {RequiredError}
|
|
184
208
|
* @memberof AnalyticsDataApiInterface
|
|
185
209
|
*/
|
|
@@ -188,6 +212,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
188
212
|
* Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type. Requires the `analytics:read` scope.
|
|
189
213
|
* @summary Get grouped time series
|
|
190
214
|
* @param {GetGroupedTimeSeriesRequest} getGroupedTimeSeriesRequest
|
|
215
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
191
216
|
* @param {*} [options] Override http request option.
|
|
192
217
|
* @throws {RequiredError}
|
|
193
218
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -201,6 +226,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
201
226
|
/**
|
|
202
227
|
* Creates request options for analyticsDataServiceGetHourOfDayDistribution without sending the request
|
|
203
228
|
* @param {GetHourOfDayDistributionRequest} getHourOfDayDistributionRequest
|
|
229
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
204
230
|
* @throws {RequiredError}
|
|
205
231
|
* @memberof AnalyticsDataApiInterface
|
|
206
232
|
*/
|
|
@@ -209,6 +235,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
209
235
|
* Retrieve event counts aggregated by hour of day for identifying peak activity times. Requires the `analytics:read` scope.
|
|
210
236
|
* @summary Get hour of day distribution
|
|
211
237
|
* @param {GetHourOfDayDistributionRequest} getHourOfDayDistributionRequest
|
|
238
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
212
239
|
* @param {*} [options] Override http request option.
|
|
213
240
|
* @throws {RequiredError}
|
|
214
241
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -222,6 +249,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
222
249
|
/**
|
|
223
250
|
* Creates request options for analyticsDataServiceGetStepFunnel without sending the request
|
|
224
251
|
* @param {GetStepFunnelRequest} getStepFunnelRequest
|
|
252
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
225
253
|
* @throws {RequiredError}
|
|
226
254
|
* @memberof AnalyticsDataApiInterface
|
|
227
255
|
*/
|
|
@@ -230,6 +258,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
230
258
|
* Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step. Requires the `analytics:read` scope.
|
|
231
259
|
* @summary Get workflow step funnel
|
|
232
260
|
* @param {GetStepFunnelRequest} getStepFunnelRequest
|
|
261
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
233
262
|
* @param {*} [options] Override http request option.
|
|
234
263
|
* @throws {RequiredError}
|
|
235
264
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -243,6 +272,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
243
272
|
/**
|
|
244
273
|
* Creates request options for analyticsDataServiceGetTopLinks without sending the request
|
|
245
274
|
* @param {GetTopLinksRequest} getTopLinksRequest
|
|
275
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
246
276
|
* @throws {RequiredError}
|
|
247
277
|
* @memberof AnalyticsDataApiInterface
|
|
248
278
|
*/
|
|
@@ -251,6 +281,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
251
281
|
* Retrieve links ranked by event count for identifying best performing QR codes and links. Requires the `analytics:read` scope.
|
|
252
282
|
* @summary Get top performing links
|
|
253
283
|
* @param {GetTopLinksRequest} getTopLinksRequest
|
|
284
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
254
285
|
* @param {*} [options] Override http request option.
|
|
255
286
|
* @throws {RequiredError}
|
|
256
287
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -264,6 +295,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
264
295
|
/**
|
|
265
296
|
* Creates request options for analyticsDataServiceGetVisitorTrends without sending the request
|
|
266
297
|
* @param {GetVisitorTrendsRequest} getVisitorTrendsRequest
|
|
298
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
267
299
|
* @throws {RequiredError}
|
|
268
300
|
* @memberof AnalyticsDataApiInterface
|
|
269
301
|
*/
|
|
@@ -272,6 +304,7 @@ export interface AnalyticsDataApiInterface {
|
|
|
272
304
|
* Retrieve new vs returning visitor counts over time. Requires the `analytics:read` scope.
|
|
273
305
|
* @summary Get visitor trends
|
|
274
306
|
* @param {GetVisitorTrendsRequest} getVisitorTrendsRequest
|
|
307
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
275
308
|
* @param {*} [options] Override http request option.
|
|
276
309
|
* @throws {RequiredError}
|
|
277
310
|
* @memberof AnalyticsDataApiInterface
|
|
@@ -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).
|
|
@@ -63,6 +63,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
63
63
|
const queryParameters = {};
|
|
64
64
|
const headerParameters = {};
|
|
65
65
|
headerParameters['Content-Type'] = 'application/json';
|
|
66
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
67
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
68
|
+
}
|
|
66
69
|
if (this.configuration && this.configuration.accessToken) {
|
|
67
70
|
// oauth required
|
|
68
71
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -110,6 +113,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
110
113
|
const queryParameters = {};
|
|
111
114
|
const headerParameters = {};
|
|
112
115
|
headerParameters['Content-Type'] = 'application/json';
|
|
116
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
117
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
118
|
+
}
|
|
113
119
|
if (this.configuration && this.configuration.accessToken) {
|
|
114
120
|
// oauth required
|
|
115
121
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -157,6 +163,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
157
163
|
const queryParameters = {};
|
|
158
164
|
const headerParameters = {};
|
|
159
165
|
headerParameters['Content-Type'] = 'application/json';
|
|
166
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
167
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
168
|
+
}
|
|
160
169
|
if (this.configuration && this.configuration.accessToken) {
|
|
161
170
|
// oauth required
|
|
162
171
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -204,6 +213,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
204
213
|
const queryParameters = {};
|
|
205
214
|
const headerParameters = {};
|
|
206
215
|
headerParameters['Content-Type'] = 'application/json';
|
|
216
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
217
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
218
|
+
}
|
|
207
219
|
if (this.configuration && this.configuration.accessToken) {
|
|
208
220
|
// oauth required
|
|
209
221
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -251,6 +263,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
251
263
|
const queryParameters = {};
|
|
252
264
|
const headerParameters = {};
|
|
253
265
|
headerParameters['Content-Type'] = 'application/json';
|
|
266
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
267
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
268
|
+
}
|
|
254
269
|
if (this.configuration && this.configuration.accessToken) {
|
|
255
270
|
// oauth required
|
|
256
271
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -298,6 +313,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
298
313
|
const queryParameters = {};
|
|
299
314
|
const headerParameters = {};
|
|
300
315
|
headerParameters['Content-Type'] = 'application/json';
|
|
316
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
317
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
318
|
+
}
|
|
301
319
|
if (this.configuration && this.configuration.accessToken) {
|
|
302
320
|
// oauth required
|
|
303
321
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -345,6 +363,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
345
363
|
const queryParameters = {};
|
|
346
364
|
const headerParameters = {};
|
|
347
365
|
headerParameters['Content-Type'] = 'application/json';
|
|
366
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
367
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
368
|
+
}
|
|
348
369
|
if (this.configuration && this.configuration.accessToken) {
|
|
349
370
|
// oauth required
|
|
350
371
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -392,6 +413,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
392
413
|
const queryParameters = {};
|
|
393
414
|
const headerParameters = {};
|
|
394
415
|
headerParameters['Content-Type'] = 'application/json';
|
|
416
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
417
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
418
|
+
}
|
|
395
419
|
if (this.configuration && this.configuration.accessToken) {
|
|
396
420
|
// oauth required
|
|
397
421
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -439,6 +463,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
439
463
|
const queryParameters = {};
|
|
440
464
|
const headerParameters = {};
|
|
441
465
|
headerParameters['Content-Type'] = 'application/json';
|
|
466
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
467
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
468
|
+
}
|
|
442
469
|
if (this.configuration && this.configuration.accessToken) {
|
|
443
470
|
// oauth required
|
|
444
471
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -486,6 +513,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
486
513
|
const queryParameters = {};
|
|
487
514
|
const headerParameters = {};
|
|
488
515
|
headerParameters['Content-Type'] = 'application/json';
|
|
516
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
517
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
518
|
+
}
|
|
489
519
|
if (this.configuration && this.configuration.accessToken) {
|
|
490
520
|
// oauth required
|
|
491
521
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -533,6 +563,9 @@ class AnalyticsDataApi extends runtime.BaseAPI {
|
|
|
533
563
|
const queryParameters = {};
|
|
534
564
|
const headerParameters = {};
|
|
535
565
|
headerParameters['Content-Type'] = 'application/json';
|
|
566
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
567
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
568
|
+
}
|
|
536
569
|
if (this.configuration && this.configuration.accessToken) {
|
|
537
570
|
// oauth required
|
|
538
571
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
|
|
@@ -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).
|
|
@@ -21,9 +21,11 @@ export interface AssistantServiceGetConversationRequest {
|
|
|
21
21
|
}
|
|
22
22
|
export interface AssistantServiceMarkConversationReadRequest {
|
|
23
23
|
assistantMarkConversationReadRequest: AssistantMarkConversationReadRequest;
|
|
24
|
+
idempotencyKey?: string;
|
|
24
25
|
}
|
|
25
26
|
export interface AssistantServiceUploadFileRequest {
|
|
26
27
|
assistantUploadFileRequest: AssistantUploadFileRequest;
|
|
28
|
+
idempotencyKey?: string;
|
|
27
29
|
}
|
|
28
30
|
/**
|
|
29
31
|
* AssistantApi - interface
|
|
@@ -81,6 +83,7 @@ export interface AssistantApiInterface {
|
|
|
81
83
|
/**
|
|
82
84
|
* Creates request options for assistantServiceMarkConversationRead without sending the request
|
|
83
85
|
* @param {AssistantMarkConversationReadRequest} assistantMarkConversationReadRequest
|
|
86
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
84
87
|
* @throws {RequiredError}
|
|
85
88
|
* @memberof AssistantApiInterface
|
|
86
89
|
*/
|
|
@@ -89,6 +92,7 @@ export interface AssistantApiInterface {
|
|
|
89
92
|
* Record that the member has seen every assistant reply in this conversation. Call it when the thread is actually on screen, not when history is fetched. Requires the `assistant:write` scope.
|
|
90
93
|
* @summary Mark assistant conversation read
|
|
91
94
|
* @param {AssistantMarkConversationReadRequest} assistantMarkConversationReadRequest
|
|
95
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
92
96
|
* @param {*} [options] Override http request option.
|
|
93
97
|
* @throws {RequiredError}
|
|
94
98
|
* @memberof AssistantApiInterface
|
|
@@ -102,6 +106,7 @@ export interface AssistantApiInterface {
|
|
|
102
106
|
/**
|
|
103
107
|
* Creates request options for assistantServiceUploadFile without sending the request
|
|
104
108
|
* @param {AssistantUploadFileRequest} assistantUploadFileRequest
|
|
109
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
105
110
|
* @throws {RequiredError}
|
|
106
111
|
* @memberof AssistantApiInterface
|
|
107
112
|
*/
|
|
@@ -110,6 +115,7 @@ export interface AssistantApiInterface {
|
|
|
110
115
|
* Upload a file to attach to the next assistant message. Returns a temporary file ID. Files expire after 5 minutes. Max 20MB. Requires the `assistant:write` scope.
|
|
111
116
|
* @summary Upload file for assistant chat
|
|
112
117
|
* @param {AssistantUploadFileRequest} assistantUploadFileRequest
|
|
118
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
113
119
|
* @param {*} [options] Override http request option.
|
|
114
120
|
* @throws {RequiredError}
|
|
115
121
|
* @memberof AssistantApiInterface
|
|
@@ -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).
|
|
@@ -159,6 +159,9 @@ class AssistantApi extends runtime.BaseAPI {
|
|
|
159
159
|
const queryParameters = {};
|
|
160
160
|
const headerParameters = {};
|
|
161
161
|
headerParameters['Content-Type'] = 'application/json';
|
|
162
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
163
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
164
|
+
}
|
|
162
165
|
if (this.configuration && this.configuration.accessToken) {
|
|
163
166
|
// oauth required
|
|
164
167
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["assistant:write"]);
|
|
@@ -206,6 +209,9 @@ class AssistantApi extends runtime.BaseAPI {
|
|
|
206
209
|
const queryParameters = {};
|
|
207
210
|
const headerParameters = {};
|
|
208
211
|
headerParameters['Content-Type'] = 'application/json';
|
|
212
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
213
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
214
|
+
}
|
|
209
215
|
if (this.configuration && this.configuration.accessToken) {
|
|
210
216
|
// oauth required
|
|
211
217
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["assistant:write"]);
|
|
@@ -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).
|
|
@@ -13,9 +13,11 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import type { CheckCustomDomainResponse, CreateCustomDomainRequest, CreateCustomDomainResponse, CustomDomainsServiceUpdateBody, GetCustomDomainResponse, GetCustomDomainSetupGuideResponse, ListCustomDomainsResponse, UpdateCustomDomainResponse, ValidationInstructionsCustomDomainResponse } from '../models/index';
|
|
14
14
|
export interface CustomDomainsServiceCheckRequest {
|
|
15
15
|
id: string;
|
|
16
|
+
idempotencyKey?: string;
|
|
16
17
|
}
|
|
17
18
|
export interface CustomDomainsServiceCreateRequest {
|
|
18
19
|
createCustomDomainRequest: CreateCustomDomainRequest;
|
|
20
|
+
idempotencyKey?: string;
|
|
19
21
|
}
|
|
20
22
|
export interface CustomDomainsServiceDeleteRequest {
|
|
21
23
|
id: string;
|
|
@@ -30,10 +32,12 @@ export interface CustomDomainsServiceListRequest {
|
|
|
30
32
|
status?: string;
|
|
31
33
|
pageSize?: number;
|
|
32
34
|
pageToken?: string;
|
|
35
|
+
cursor?: string;
|
|
33
36
|
}
|
|
34
37
|
export interface CustomDomainsServiceUpdateRequest {
|
|
35
38
|
id: string;
|
|
36
39
|
customDomainsServiceUpdateBody: CustomDomainsServiceUpdateBody;
|
|
40
|
+
idempotencyKey?: string;
|
|
37
41
|
}
|
|
38
42
|
export interface CustomDomainsServiceValidationInstructionsRequest {
|
|
39
43
|
id: string;
|
|
@@ -48,6 +52,7 @@ export interface CustomDomainsApiInterface {
|
|
|
48
52
|
/**
|
|
49
53
|
* Creates request options for customDomainsServiceCheck without sending the request
|
|
50
54
|
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
55
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
51
56
|
* @throws {RequiredError}
|
|
52
57
|
* @memberof CustomDomainsApiInterface
|
|
53
58
|
*/
|
|
@@ -56,6 +61,7 @@ export interface CustomDomainsApiInterface {
|
|
|
56
61
|
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status. Requires the `domains:write` scope.
|
|
57
62
|
* @summary Check a custom domain
|
|
58
63
|
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
64
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
59
65
|
* @param {*} [options] Override http request option.
|
|
60
66
|
* @throws {RequiredError}
|
|
61
67
|
* @memberof CustomDomainsApiInterface
|
|
@@ -69,6 +75,7 @@ export interface CustomDomainsApiInterface {
|
|
|
69
75
|
/**
|
|
70
76
|
* Creates request options for customDomainsServiceCreate without sending the request
|
|
71
77
|
* @param {CreateCustomDomainRequest} createCustomDomainRequest
|
|
78
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
72
79
|
* @throws {RequiredError}
|
|
73
80
|
* @memberof CustomDomainsApiInterface
|
|
74
81
|
*/
|
|
@@ -77,6 +84,7 @@ export interface CustomDomainsApiInterface {
|
|
|
77
84
|
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace. Requires the `domains:write` scope.
|
|
78
85
|
* @summary Create a custom domain
|
|
79
86
|
* @param {CreateCustomDomainRequest} createCustomDomainRequest
|
|
87
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
80
88
|
* @param {*} [options] Override http request option.
|
|
81
89
|
* @throws {RequiredError}
|
|
82
90
|
* @memberof CustomDomainsApiInterface
|
|
@@ -155,6 +163,7 @@ export interface CustomDomainsApiInterface {
|
|
|
155
163
|
* @param {string} [status] Filter by the status of the custom domains to list. Optional. - STATUS_UNSPECIFIED: The status is not specified - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet. - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain. - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record. - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready. - STATUS_ACTIVE: The domain is fully active - STATUS_RENEWAL_PENDING: The domain is still serving traffic on a valid certificate, but the renewal of that certificate cannot be validated. It stops working at certificate_expires_at. - STATUS_EXPIRED: The certificate expired or was withdrawn. The domain no longer serves HTTPS.
|
|
156
164
|
* @param {number} [pageSize] Maximum number of custom domains to return. Defaults to 100, capped at 1000.
|
|
157
165
|
* @param {string} [pageToken] Cursor from a previous response\'s next_page_token. Empty starts at the first page. Pages are ordered by (created_at, id), which never change, so a record cannot move between pages while a client is walking them.
|
|
166
|
+
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
158
167
|
* @throws {RequiredError}
|
|
159
168
|
* @memberof CustomDomainsApiInterface
|
|
160
169
|
*/
|
|
@@ -165,6 +174,7 @@ export interface CustomDomainsApiInterface {
|
|
|
165
174
|
* @param {string} [status] Filter by the status of the custom domains to list. Optional. - STATUS_UNSPECIFIED: The status is not specified - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet. - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain. - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record. - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready. - STATUS_ACTIVE: The domain is fully active - STATUS_RENEWAL_PENDING: The domain is still serving traffic on a valid certificate, but the renewal of that certificate cannot be validated. It stops working at certificate_expires_at. - STATUS_EXPIRED: The certificate expired or was withdrawn. The domain no longer serves HTTPS.
|
|
166
175
|
* @param {number} [pageSize] Maximum number of custom domains to return. Defaults to 100, capped at 1000.
|
|
167
176
|
* @param {string} [pageToken] Cursor from a previous response\'s next_page_token. Empty starts at the first page. Pages are ordered by (created_at, id), which never change, so a record cannot move between pages while a client is walking them.
|
|
177
|
+
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
168
178
|
* @param {*} [options] Override http request option.
|
|
169
179
|
* @throws {RequiredError}
|
|
170
180
|
* @memberof CustomDomainsApiInterface
|
|
@@ -179,6 +189,7 @@ export interface CustomDomainsApiInterface {
|
|
|
179
189
|
* Creates request options for customDomainsServiceUpdate without sending the request
|
|
180
190
|
* @param {string} id The ID of the custom domain to update (UUID)
|
|
181
191
|
* @param {CustomDomainsServiceUpdateBody} customDomainsServiceUpdateBody
|
|
192
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
182
193
|
* @throws {RequiredError}
|
|
183
194
|
* @memberof CustomDomainsApiInterface
|
|
184
195
|
*/
|
|
@@ -188,6 +199,7 @@ export interface CustomDomainsApiInterface {
|
|
|
188
199
|
* @summary Update a custom domain
|
|
189
200
|
* @param {string} id The ID of the custom domain to update (UUID)
|
|
190
201
|
* @param {CustomDomainsServiceUpdateBody} customDomainsServiceUpdateBody
|
|
202
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
191
203
|
* @param {*} [options] Override http request option.
|
|
192
204
|
* @throws {RequiredError}
|
|
193
205
|
* @memberof CustomDomainsApiInterface
|
|
@@ -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,6 +62,9 @@ class CustomDomainsApi extends runtime.BaseAPI {
|
|
|
62
62
|
}
|
|
63
63
|
const queryParameters = {};
|
|
64
64
|
const headerParameters = {};
|
|
65
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
66
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
67
|
+
}
|
|
65
68
|
if (this.configuration && this.configuration.accessToken) {
|
|
66
69
|
// oauth required
|
|
67
70
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["domains:write"]);
|
|
@@ -109,6 +112,9 @@ class CustomDomainsApi extends runtime.BaseAPI {
|
|
|
109
112
|
const queryParameters = {};
|
|
110
113
|
const headerParameters = {};
|
|
111
114
|
headerParameters['Content-Type'] = 'application/json';
|
|
115
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
116
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
117
|
+
}
|
|
112
118
|
if (this.configuration && this.configuration.accessToken) {
|
|
113
119
|
// oauth required
|
|
114
120
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["domains:write"]);
|
|
@@ -298,6 +304,9 @@ class CustomDomainsApi extends runtime.BaseAPI {
|
|
|
298
304
|
if (requestParameters['pageToken'] != null) {
|
|
299
305
|
queryParameters['pageToken'] = requestParameters['pageToken'];
|
|
300
306
|
}
|
|
307
|
+
if (requestParameters['cursor'] != null) {
|
|
308
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
309
|
+
}
|
|
301
310
|
const headerParameters = {};
|
|
302
311
|
if (this.configuration && this.configuration.accessToken) {
|
|
303
312
|
// oauth required
|
|
@@ -348,6 +357,9 @@ class CustomDomainsApi extends runtime.BaseAPI {
|
|
|
348
357
|
const queryParameters = {};
|
|
349
358
|
const headerParameters = {};
|
|
350
359
|
headerParameters['Content-Type'] = 'application/json';
|
|
360
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
361
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
362
|
+
}
|
|
351
363
|
if (this.configuration && this.configuration.accessToken) {
|
|
352
364
|
// oauth required
|
|
353
365
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["domains:write"]);
|