linkbreakers 1.186.1 → 1.187.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/APIScopesApi.d.ts +2 -2
- package/dist/apis/APIScopesApi.js +2 -2
- package/dist/apis/AgentIdentityApi.d.ts +2 -2
- package/dist/apis/AgentIdentityApi.js +2 -2
- package/dist/apis/AllowancesApi.d.ts +2 -2
- package/dist/apis/AllowancesApi.js +2 -2
- package/dist/apis/AnalyticsDashboardApi.d.ts +2 -2
- package/dist/apis/AnalyticsDashboardApi.js +2 -2
- package/dist/apis/AnalyticsDataApi.d.ts +36 -3
- package/dist/apis/AnalyticsDataApi.js +44 -2
- package/dist/apis/AssistantApi.d.ts +2 -2
- package/dist/apis/AssistantApi.js +2 -2
- package/dist/apis/AuthApi.d.ts +2 -2
- package/dist/apis/AuthApi.js +2 -2
- package/dist/apis/CustomDomainsApi.d.ts +2 -2
- package/dist/apis/CustomDomainsApi.js +2 -2
- package/dist/apis/DirectoriesApi.d.ts +2 -2
- package/dist/apis/DirectoriesApi.js +2 -2
- package/dist/apis/EventsApi.d.ts +2 -2
- package/dist/apis/EventsApi.js +2 -2
- package/dist/apis/GoogleAnalyticsIntegrationsApi.d.ts +174 -0
- package/dist/apis/GoogleAnalyticsIntegrationsApi.js +241 -0
- package/dist/apis/GoogleFormsIntegrationsApi.d.ts +2 -2
- package/dist/apis/GoogleFormsIntegrationsApi.js +2 -2
- package/dist/apis/IntegrationsServiceApi.d.ts +2 -2
- package/dist/apis/IntegrationsServiceApi.js +2 -2
- package/dist/apis/JobsApi.d.ts +2 -2
- package/dist/apis/JobsApi.js +2 -2
- package/dist/apis/LinkSettingsApi.d.ts +77 -3
- package/dist/apis/LinkSettingsApi.js +94 -2
- package/dist/apis/LinksApi.d.ts +47 -3
- package/dist/apis/LinksApi.js +56 -2
- package/dist/apis/MediaApi.d.ts +2 -2
- package/dist/apis/MediaApi.js +2 -2
- package/dist/apis/MembersApi.d.ts +2 -2
- package/dist/apis/MembersApi.js +2 -2
- package/dist/apis/PageThemeTemplatesApi.d.ts +2 -2
- package/dist/apis/PageThemeTemplatesApi.js +2 -2
- package/dist/apis/PageThemesApi.d.ts +2 -2
- package/dist/apis/PageThemesApi.js +2 -2
- package/dist/apis/PricingApi.d.ts +2 -2
- package/dist/apis/PricingApi.js +2 -2
- package/dist/apis/QRCodeDesignsApi.d.ts +2 -2
- package/dist/apis/QRCodeDesignsApi.js +2 -2
- package/dist/apis/QRCodeTemplatesApi.d.ts +2 -2
- package/dist/apis/QRCodeTemplatesApi.js +2 -2
- package/dist/apis/RetargetingPixelsApi.d.ts +138 -0
- package/dist/apis/RetargetingPixelsApi.js +195 -0
- package/dist/apis/ReviewRewardsApi.d.ts +100 -0
- package/dist/apis/ReviewRewardsApi.js +149 -0
- package/dist/apis/SlackIntegrationsApi.d.ts +2 -2
- package/dist/apis/SlackIntegrationsApi.js +2 -2
- package/dist/apis/TagsApi.d.ts +2 -2
- package/dist/apis/TagsApi.js +2 -2
- package/dist/apis/TimeSeriesApi.d.ts +2 -2
- package/dist/apis/TimeSeriesApi.js +2 -2
- package/dist/apis/VisitorsApi.d.ts +2 -2
- package/dist/apis/VisitorsApi.js +2 -2
- package/dist/apis/WebhooksApi.d.ts +2 -2
- package/dist/apis/WebhooksApi.js +2 -2
- package/dist/apis/WorkflowStepsApi.d.ts +36 -3
- package/dist/apis/WorkflowStepsApi.js +44 -2
- package/dist/apis/WorkspaceMetricsApi.d.ts +2 -2
- package/dist/apis/WorkspaceMetricsApi.js +2 -2
- package/dist/apis/WorkspaceTokensApi.d.ts +2 -2
- package/dist/apis/WorkspaceTokensApi.js +2 -2
- package/dist/apis/WorkspacesApi.d.ts +2 -2
- package/dist/apis/WorkspacesApi.js +2 -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 +2 -2
- package/dist/models/AgentClaim.js +2 -2
- package/dist/models/AgentClaimStatus.d.ts +2 -2
- package/dist/models/AgentClaimStatus.js +2 -2
- 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 +2 -2
- package/dist/models/ApiScopeInfo.js +2 -2
- 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/AssistantCompleteAttachmentUploadResponse.d.ts +2 -2
- package/dist/models/AssistantCompleteAttachmentUploadResponse.js +2 -2
- package/dist/models/AssistantContextType.d.ts +2 -2
- package/dist/models/AssistantContextType.js +2 -2
- package/dist/models/AssistantCreateAttachmentUploadRequest.d.ts +2 -2
- package/dist/models/AssistantCreateAttachmentUploadRequest.js +2 -2
- package/dist/models/AssistantCreateAttachmentUploadResponse.d.ts +2 -2
- package/dist/models/AssistantCreateAttachmentUploadResponse.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/BackButton.d.ts +2 -2
- package/dist/models/BackButton.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 +2 -2
- package/dist/models/ClaimAgentWorkspaceRequest.js +2 -2
- 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/CompleteMediaReplaceResponse.d.ts +2 -2
- package/dist/models/CompleteMediaReplaceResponse.js +2 -2
- package/dist/models/CompleteMediaUploadResponse.d.ts +2 -2
- package/dist/models/CompleteMediaUploadResponse.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 +5 -3
- 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 +20 -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/CreateMediaReplaceUploadResponse.d.ts +2 -2
- package/dist/models/CreateMediaReplaceUploadResponse.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/CreateMediaUploadRequest.d.ts +2 -2
- package/dist/models/CreateMediaUploadRequest.js +2 -2
- package/dist/models/CreateMediaUploadResponse.d.ts +2 -2
- package/dist/models/CreateMediaUploadResponse.js +2 -2
- package/dist/models/CreateMyWorkspaceRequest.d.ts +2 -2
- package/dist/models/CreateMyWorkspaceRequest.js +2 -2
- package/dist/models/CreateMyWorkspaceResponse.d.ts +2 -2
- package/dist/models/CreateMyWorkspaceResponse.js +2 -2
- package/dist/models/CreateOpenMediaLinkRequest.d.ts +5 -3
- package/dist/models/CreateOpenMediaLinkRequest.js +2 -2
- package/dist/models/CreateOpenMediaLinkResponse.d.ts +2 -2
- package/dist/models/CreateOpenMediaLinkResponse.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/CreateThankYouLinkRequest.d.ts +5 -3
- 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 +2 -2
- package/dist/models/CreateWorkspaceTokenRequest.js +2 -2
- 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 +6 -2
- package/dist/models/EventAction.js +7 -3
- package/dist/models/EventTrace.d.ts +2 -2
- package/dist/models/EventTrace.js +2 -2
- package/dist/models/EventTraceData.d.ts +9 -2
- package/dist/models/EventTraceData.js +5 -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/FiringRetargetingPixel.d.ts +47 -0
- package/dist/models/FiringRetargetingPixel.js +54 -0
- 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 +2 -2
- package/dist/models/GetAgentClaimRequest.js +2 -2
- 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/GetDataCollectionResponse.d.ts +33 -0
- package/dist/models/GetDataCollectionResponse.js +49 -0
- 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/GetGoogleAnalyticsIntegrationResponse.d.ts +33 -0
- package/dist/models/GetGoogleAnalyticsIntegrationResponse.js +49 -0
- 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/GetRetargetingPixelsResponse.d.ts +33 -0
- package/dist/models/GetRetargetingPixelsResponse.js +49 -0
- package/dist/models/GetReviewRewardOfferResponse.d.ts +59 -0
- package/dist/models/GetReviewRewardOfferResponse.js +59 -0
- 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/GetWalletPassSupportResponse.d.ts +38 -0
- package/dist/models/GetWalletPassSupportResponse.js +50 -0
- 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/GoogleAnalyticsAttributeKeys.d.ts +33 -0
- package/dist/models/GoogleAnalyticsAttributeKeys.js +48 -0
- package/dist/models/GoogleAnalyticsIntegration.d.ts +85 -0
- package/dist/models/GoogleAnalyticsIntegration.js +64 -0
- 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/ImportMediaRequest.d.ts +2 -2
- package/dist/models/ImportMediaRequest.js +2 -2
- package/dist/models/ImportMediaResponse.d.ts +2 -2
- package/dist/models/ImportMediaResponse.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 +2 -2
- package/dist/models/Job.js +2 -2
- package/dist/models/JobError.d.ts +2 -2
- package/dist/models/JobError.js +2 -2
- package/dist/models/JobStatus.d.ts +2 -2
- package/dist/models/JobStatus.js +2 -2
- package/dist/models/JobType.d.ts +2 -2
- package/dist/models/JobType.js +2 -2
- package/dist/models/JourneyProgress.d.ts +2 -2
- package/dist/models/JourneyProgress.js +2 -2
- package/dist/models/LanguageConditionOutcome.d.ts +39 -0
- package/dist/models/LanguageConditionOutcome.js +50 -0
- package/dist/models/LanguageConditionPayload.d.ts +41 -0
- package/dist/models/LanguageConditionPayload.js +51 -0
- package/dist/models/LanguageConditionTraceData.d.ts +45 -0
- package/dist/models/LanguageConditionTraceData.js +53 -0
- package/dist/models/LanguageConditionTraceOption.d.ts +38 -0
- package/dist/models/LanguageConditionTraceOption.js +50 -0
- package/dist/models/Link.d.ts +4 -3
- 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 +2 -2
- package/dist/models/LinksBulkCreateResult.js +2 -2
- package/dist/models/LinksServiceRenderQrcodeImagesBody.d.ts +47 -0
- package/dist/models/LinksServiceRenderQrcodeImagesBody.js +56 -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/ListMyWorkspacesResponse.d.ts +2 -2
- package/dist/models/ListMyWorkspacesResponse.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/ListRetargetingPixelsForLinkResponse.d.ts +34 -0
- package/dist/models/ListRetargetingPixelsForLinkResponse.js +49 -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/ListVisitorCountriesResponse.d.ts +33 -0
- package/dist/models/ListVisitorCountriesResponse.js +49 -0
- 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/LocationRequestOutcome.d.ts +2 -2
- package/dist/models/LocationRequestOutcome.js +2 -2
- package/dist/models/LocationRequestPayload.d.ts +2 -2
- package/dist/models/LocationRequestPayload.js +2 -2
- package/dist/models/LocationRequestTraceData.d.ts +2 -2
- package/dist/models/LocationRequestTraceData.js +2 -2
- package/dist/models/Media.d.ts +2 -2
- package/dist/models/Media.js +2 -2
- package/dist/models/MediaKind.d.ts +2 -2
- package/dist/models/MediaKind.js +2 -2
- package/dist/models/MediaReference.d.ts +2 -2
- package/dist/models/MediaReference.js +2 -2
- package/dist/models/MediaReferenceType.d.ts +2 -2
- package/dist/models/MediaReferenceType.js +2 -2
- package/dist/models/MediaSelection.d.ts +2 -2
- package/dist/models/MediaSelection.js +2 -2
- package/dist/models/MediaServiceCreateReplaceUploadBody.d.ts +2 -2
- package/dist/models/MediaServiceCreateReplaceUploadBody.js +2 -2
- package/dist/models/MediaServiceReplaceImportBody.d.ts +2 -2
- package/dist/models/MediaServiceReplaceImportBody.js +2 -2
- package/dist/models/MediaStatus.d.ts +2 -2
- package/dist/models/MediaStatus.js +2 -2
- package/dist/models/MediaTraceData.d.ts +2 -2
- package/dist/models/MediaTraceData.js +2 -2
- package/dist/models/MediaType.d.ts +2 -2
- package/dist/models/MediaType.js +2 -2
- package/dist/models/MediaUploadOrigin.d.ts +2 -2
- package/dist/models/MediaUploadOrigin.js +2 -2
- package/dist/models/MediaUsage.d.ts +2 -2
- package/dist/models/MediaUsage.js +2 -2
- package/dist/models/MediaVisibility.d.ts +2 -2
- package/dist/models/MediaVisibility.js +2 -2
- package/dist/models/Member.d.ts +2 -2
- package/dist/models/Member.js +2 -2
- package/dist/models/MembersServiceSwitchWorkspaceBody.d.ts +2 -2
- package/dist/models/MembersServiceSwitchWorkspaceBody.js +2 -2
- package/dist/models/MembersServiceUpdateBody.d.ts +2 -2
- package/dist/models/MembersServiceUpdateBody.js +2 -2
- 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/MyWorkspace.d.ts +2 -2
- package/dist/models/MyWorkspace.js +2 -2
- package/dist/models/OpenMediaPayload.d.ts +2 -2
- package/dist/models/OpenMediaPayload.js +2 -2
- package/dist/models/OutputFileFormat.d.ts +2 -2
- package/dist/models/OutputFileFormat.js +2 -2
- package/dist/models/PageTheme.d.ts +17 -2
- package/dist/models/PageTheme.js +13 -3
- 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 +17 -2
- package/dist/models/PageThemeStyling.js +13 -3
- 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 +17 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.js +13 -3
- package/dist/models/PageThemeVisitorExperience.d.ts +26 -0
- package/dist/models/PageThemeVisitorExperience.js +52 -0
- package/dist/models/PageThemesServiceUpdatePageThemeBody.d.ts +17 -2
- package/dist/models/PageThemesServiceUpdatePageThemeBody.js +13 -3
- 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 +2 -2
- package/dist/models/PricingPlan.js +2 -2
- package/dist/models/PricingPlanId.d.ts +2 -2
- package/dist/models/PricingPlanId.js +2 -2
- 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/QrcodeRenderFormat.d.ts +30 -0
- package/dist/models/QrcodeRenderFormat.js +56 -0
- package/dist/models/QrcodeRenderItem.d.ts +35 -0
- package/dist/models/QrcodeRenderItem.js +48 -0
- 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/RedirectTraceDataFallbackReason.d.ts +2 -2
- package/dist/models/RedirectTraceDataFallbackReason.js +2 -2
- package/dist/models/RenderQrcodeImagesResponse.d.ts +33 -0
- package/dist/models/RenderQrcodeImagesResponse.js +49 -0
- package/dist/models/RenderedQrcode.d.ts +52 -0
- package/dist/models/RenderedQrcode.js +54 -0
- package/dist/models/ReplaceMediaImportResponse.d.ts +2 -2
- package/dist/models/ReplaceMediaImportResponse.js +2 -2
- package/dist/models/ReportStepSearchMissRequest.d.ts +46 -0
- package/dist/models/ReportStepSearchMissRequest.js +52 -0
- package/dist/models/RequestEmailVerificationRequest.d.ts +2 -2
- package/dist/models/RequestEmailVerificationRequest.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/RetargetingPixel.d.ts +35 -0
- package/dist/models/RetargetingPixel.js +61 -0
- package/dist/models/RetargetingPixelScope.d.ts +59 -0
- package/dist/models/RetargetingPixelScope.js +58 -0
- package/dist/models/RetargetingPixelScopeType.d.ts +30 -0
- package/dist/models/RetargetingPixelScopeType.js +56 -0
- package/dist/models/RetargetingPixels.d.ts +72 -0
- package/dist/models/RetargetingPixels.js +61 -0
- package/dist/models/ReviewPlatform.d.ts +32 -0
- package/dist/models/ReviewPlatform.js +58 -0
- package/dist/models/ReviewPlatformProfile.d.ts +45 -0
- package/dist/models/ReviewPlatformProfile.js +53 -0
- package/dist/models/ReviewReward.d.ts +76 -0
- package/dist/models/ReviewReward.js +64 -0
- package/dist/models/ReviewRewardIneligibleReason.d.ts +30 -0
- package/dist/models/ReviewRewardIneligibleReason.js +56 -0
- package/dist/models/ReviewRewardStatus.d.ts +32 -0
- package/dist/models/ReviewRewardStatus.js +58 -0
- package/dist/models/Role.d.ts +2 -2
- package/dist/models/Role.js +2 -2
- 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/SubmitReviewRewardRequest.d.ts +45 -0
- package/dist/models/SubmitReviewRewardRequest.js +53 -0
- package/dist/models/SubmitReviewRewardResponse.d.ts +33 -0
- package/dist/models/SubmitReviewRewardResponse.js +49 -0
- package/dist/models/SubscriptionType.d.ts +4 -2
- package/dist/models/SubscriptionType.js +5 -3
- package/dist/models/SwitchWorkspaceResponse.d.ts +2 -2
- package/dist/models/SwitchWorkspaceResponse.js +2 -2
- package/dist/models/SyncGoogleFormsResponse.d.ts +2 -2
- package/dist/models/SyncGoogleFormsResponse.js +2 -2
- package/dist/models/TestGoogleAnalyticsIntegrationResponse.d.ts +32 -0
- package/dist/models/TestGoogleAnalyticsIntegrationResponse.js +48 -0
- 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/TypeDate.d.ts +2 -2
- package/dist/models/TypeDate.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/UpdateDataCollectionRequest.d.ts +33 -0
- package/dist/models/UpdateDataCollectionRequest.js +49 -0
- package/dist/models/UpdateDataCollectionResponse.d.ts +33 -0
- package/dist/models/UpdateDataCollectionResponse.js +49 -0
- 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/UpdateGoogleAnalyticsIntegrationRequest.d.ts +55 -0
- package/dist/models/UpdateGoogleAnalyticsIntegrationRequest.js +55 -0
- package/dist/models/UpdateGoogleAnalyticsIntegrationResponse.d.ts +33 -0
- package/dist/models/UpdateGoogleAnalyticsIntegrationResponse.js +49 -0
- 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/UpdateRetargetingPixelsRequest.d.ts +66 -0
- package/dist/models/UpdateRetargetingPixelsRequest.js +59 -0
- package/dist/models/UpdateRetargetingPixelsResponse.d.ts +33 -0
- package/dist/models/UpdateRetargetingPixelsResponse.js +49 -0
- 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 +8 -2
- package/dist/models/VCardData.js +4 -2
- package/dist/models/VCardPayload.d.ts +10 -2
- package/dist/models/VCardPayload.js +4 -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/VisitorCountry.d.ts +38 -0
- package/dist/models/VisitorCountry.js +50 -0
- 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 +6 -2
- package/dist/models/WorkflowStep.js +4 -3
- 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 +9 -2
- package/dist/models/WorkflowStepPayload.js +5 -2
- package/dist/models/WorkflowStepsServiceConnectStepBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceConnectStepBody.js +2 -2
- package/dist/models/WorkflowStepsServiceCreateBody.d.ts +6 -2
- package/dist/models/WorkflowStepsServiceCreateBody.js +4 -3
- package/dist/models/WorkflowStepsServiceUpdateBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.js +2 -2
- package/dist/models/Workspace.d.ts +4 -2
- package/dist/models/Workspace.js +4 -3
- 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 +2 -2
- package/dist/models/WorkspaceToken.js +2 -2
- package/dist/models/WorkspaceTokenKeyType.d.ts +2 -2
- package/dist/models/WorkspaceTokenKeyType.js +2 -2
- package/dist/models/WorkspaceTokensServiceUpdateBody.d.ts +2 -2
- package/dist/models/WorkspaceTokensServiceUpdateBody.js +2 -2
- package/dist/models/index.d.ts +40 -0
- package/dist/models/index.js +40 -0
- package/dist/runtime.d.ts +4 -2
- package/dist/runtime.js +25 -4
- package/package.json +1 -1
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.187.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers ## 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.187.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/apis/JobsApi.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.187.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/apis/JobsApi.js
CHANGED
|
@@ -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 ## 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.187.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers ## 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.187.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,10 +10,14 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetLinkSettingResponse, SettingsServiceUpdateLinkSettingBody, UpdateLinkSettingResponse } from '../models/index';
|
|
13
|
+
import type { GetDataCollectionResponse, GetLinkSettingResponse, SettingsServiceUpdateLinkSettingBody, UpdateDataCollectionRequest, UpdateDataCollectionResponse, UpdateLinkSettingResponse } from '../models/index';
|
|
14
14
|
export interface SettingsServiceGetLinkSettingRequest {
|
|
15
15
|
id: string;
|
|
16
16
|
}
|
|
17
|
+
export interface SettingsServiceUpdateDataCollectionRequest {
|
|
18
|
+
updateDataCollectionRequest: UpdateDataCollectionRequest;
|
|
19
|
+
idempotencyKey?: string;
|
|
20
|
+
}
|
|
17
21
|
export interface SettingsServiceUpdateLinkSettingRequest {
|
|
18
22
|
id: string;
|
|
19
23
|
settingsServiceUpdateLinkSettingBody: SettingsServiceUpdateLinkSettingBody;
|
|
@@ -26,6 +30,25 @@ export interface SettingsServiceUpdateLinkSettingRequest {
|
|
|
26
30
|
* @interface LinkSettingsApiInterface
|
|
27
31
|
*/
|
|
28
32
|
export interface LinkSettingsApiInterface {
|
|
33
|
+
/**
|
|
34
|
+
* Creates request options for settingsServiceGetDataCollection without sending the request
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
* @memberof LinkSettingsApiInterface
|
|
37
|
+
*/
|
|
38
|
+
settingsServiceGetDataCollectionRequestOpts(): Promise<runtime.RequestOpts>;
|
|
39
|
+
/**
|
|
40
|
+
* Return the data collection level of the caller\'s workspace, which applies to every link. Requires the `links:read` scope.
|
|
41
|
+
* @summary Get the data collection level
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
* @memberof LinkSettingsApiInterface
|
|
45
|
+
*/
|
|
46
|
+
settingsServiceGetDataCollectionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDataCollectionResponse>>;
|
|
47
|
+
/**
|
|
48
|
+
* Return the data collection level of the caller\'s workspace, which applies to every link. Requires the `links:read` scope.
|
|
49
|
+
* Get the data collection level
|
|
50
|
+
*/
|
|
51
|
+
settingsServiceGetDataCollection(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDataCollectionResponse>;
|
|
29
52
|
/**
|
|
30
53
|
* Creates request options for settingsServiceGetLinkSetting without sending the request
|
|
31
54
|
* @param {string} id Identifier of the link setting profile (UUID)
|
|
@@ -47,6 +70,29 @@ export interface LinkSettingsApiInterface {
|
|
|
47
70
|
* Get a link setting
|
|
48
71
|
*/
|
|
49
72
|
settingsServiceGetLinkSetting(requestParameters: SettingsServiceGetLinkSettingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLinkSettingResponse>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for settingsServiceUpdateDataCollection without sending the request
|
|
75
|
+
* @param {UpdateDataCollectionRequest} updateDataCollectionRequest
|
|
76
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
* @memberof LinkSettingsApiInterface
|
|
79
|
+
*/
|
|
80
|
+
settingsServiceUpdateDataCollectionRequestOpts(requestParameters: SettingsServiceUpdateDataCollectionRequest): Promise<runtime.RequestOpts>;
|
|
81
|
+
/**
|
|
82
|
+
* Set the data collection level of the caller\'s workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.
|
|
83
|
+
* @summary Update the data collection level
|
|
84
|
+
* @param {UpdateDataCollectionRequest} updateDataCollectionRequest
|
|
85
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
* @memberof LinkSettingsApiInterface
|
|
89
|
+
*/
|
|
90
|
+
settingsServiceUpdateDataCollectionRaw(requestParameters: SettingsServiceUpdateDataCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDataCollectionResponse>>;
|
|
91
|
+
/**
|
|
92
|
+
* Set the data collection level of the caller\'s workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.
|
|
93
|
+
* Update the data collection level
|
|
94
|
+
*/
|
|
95
|
+
settingsServiceUpdateDataCollection(requestParameters: SettingsServiceUpdateDataCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDataCollectionResponse>;
|
|
50
96
|
/**
|
|
51
97
|
* Creates request options for settingsServiceUpdateLinkSetting without sending the request
|
|
52
98
|
* @param {string} id The ID of the link setting to update (UUID)
|
|
@@ -77,6 +123,20 @@ export interface LinkSettingsApiInterface {
|
|
|
77
123
|
*
|
|
78
124
|
*/
|
|
79
125
|
export declare class LinkSettingsApi extends runtime.BaseAPI implements LinkSettingsApiInterface {
|
|
126
|
+
/**
|
|
127
|
+
* Creates request options for settingsServiceGetDataCollection without sending the request
|
|
128
|
+
*/
|
|
129
|
+
settingsServiceGetDataCollectionRequestOpts(): Promise<runtime.RequestOpts>;
|
|
130
|
+
/**
|
|
131
|
+
* Return the data collection level of the caller\'s workspace, which applies to every link. Requires the `links:read` scope.
|
|
132
|
+
* Get the data collection level
|
|
133
|
+
*/
|
|
134
|
+
settingsServiceGetDataCollectionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDataCollectionResponse>>;
|
|
135
|
+
/**
|
|
136
|
+
* Return the data collection level of the caller\'s workspace, which applies to every link. Requires the `links:read` scope.
|
|
137
|
+
* Get the data collection level
|
|
138
|
+
*/
|
|
139
|
+
settingsServiceGetDataCollection(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDataCollectionResponse>;
|
|
80
140
|
/**
|
|
81
141
|
* Creates request options for settingsServiceGetLinkSetting without sending the request
|
|
82
142
|
*/
|
|
@@ -91,6 +151,20 @@ export declare class LinkSettingsApi extends runtime.BaseAPI implements LinkSett
|
|
|
91
151
|
* Get a link setting
|
|
92
152
|
*/
|
|
93
153
|
settingsServiceGetLinkSetting(requestParameters: SettingsServiceGetLinkSettingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLinkSettingResponse>;
|
|
154
|
+
/**
|
|
155
|
+
* Creates request options for settingsServiceUpdateDataCollection without sending the request
|
|
156
|
+
*/
|
|
157
|
+
settingsServiceUpdateDataCollectionRequestOpts(requestParameters: SettingsServiceUpdateDataCollectionRequest): Promise<runtime.RequestOpts>;
|
|
158
|
+
/**
|
|
159
|
+
* Set the data collection level of the caller\'s workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.
|
|
160
|
+
* Update the data collection level
|
|
161
|
+
*/
|
|
162
|
+
settingsServiceUpdateDataCollectionRaw(requestParameters: SettingsServiceUpdateDataCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDataCollectionResponse>>;
|
|
163
|
+
/**
|
|
164
|
+
* Set the data collection level of the caller\'s workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.
|
|
165
|
+
* Update the data collection level
|
|
166
|
+
*/
|
|
167
|
+
settingsServiceUpdateDataCollection(requestParameters: SettingsServiceUpdateDataCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDataCollectionResponse>;
|
|
94
168
|
/**
|
|
95
169
|
* Creates request options for settingsServiceUpdateLinkSetting without sending the request
|
|
96
170
|
*/
|
|
@@ -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 ## 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.187.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -53,6 +53,48 @@ const index_1 = require("../models/index");
|
|
|
53
53
|
*
|
|
54
54
|
*/
|
|
55
55
|
class LinkSettingsApi extends runtime.BaseAPI {
|
|
56
|
+
/**
|
|
57
|
+
* Creates request options for settingsServiceGetDataCollection without sending the request
|
|
58
|
+
*/
|
|
59
|
+
async settingsServiceGetDataCollectionRequestOpts() {
|
|
60
|
+
const queryParameters = {};
|
|
61
|
+
const headerParameters = {};
|
|
62
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
63
|
+
// oauth required
|
|
64
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:read"]);
|
|
65
|
+
}
|
|
66
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
67
|
+
const token = this.configuration.accessToken;
|
|
68
|
+
const tokenString = await token("bearerAuth", ["links:read"]);
|
|
69
|
+
if (tokenString) {
|
|
70
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
let urlPath = `/v1/settings/data-collection`;
|
|
74
|
+
return {
|
|
75
|
+
path: urlPath,
|
|
76
|
+
method: 'GET',
|
|
77
|
+
headers: headerParameters,
|
|
78
|
+
query: queryParameters,
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Return the data collection level of the caller\'s workspace, which applies to every link. Requires the `links:read` scope.
|
|
83
|
+
* Get the data collection level
|
|
84
|
+
*/
|
|
85
|
+
async settingsServiceGetDataCollectionRaw(initOverrides) {
|
|
86
|
+
const requestOptions = await this.settingsServiceGetDataCollectionRequestOpts();
|
|
87
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
88
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetDataCollectionResponseFromJSON)(jsonValue));
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Return the data collection level of the caller\'s workspace, which applies to every link. Requires the `links:read` scope.
|
|
92
|
+
* Get the data collection level
|
|
93
|
+
*/
|
|
94
|
+
async settingsServiceGetDataCollection(initOverrides) {
|
|
95
|
+
const response = await this.settingsServiceGetDataCollectionRaw(initOverrides);
|
|
96
|
+
return await response.value();
|
|
97
|
+
}
|
|
56
98
|
/**
|
|
57
99
|
* Creates request options for settingsServiceGetLinkSetting without sending the request
|
|
58
100
|
*/
|
|
@@ -99,6 +141,56 @@ class LinkSettingsApi extends runtime.BaseAPI {
|
|
|
99
141
|
const response = await this.settingsServiceGetLinkSettingRaw(requestParameters, initOverrides);
|
|
100
142
|
return await response.value();
|
|
101
143
|
}
|
|
144
|
+
/**
|
|
145
|
+
* Creates request options for settingsServiceUpdateDataCollection without sending the request
|
|
146
|
+
*/
|
|
147
|
+
async settingsServiceUpdateDataCollectionRequestOpts(requestParameters) {
|
|
148
|
+
if (requestParameters['updateDataCollectionRequest'] == null) {
|
|
149
|
+
throw new runtime.RequiredError('updateDataCollectionRequest', 'Required parameter "updateDataCollectionRequest" was null or undefined when calling settingsServiceUpdateDataCollection().');
|
|
150
|
+
}
|
|
151
|
+
const queryParameters = {};
|
|
152
|
+
const headerParameters = {};
|
|
153
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
154
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
155
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
156
|
+
}
|
|
157
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
158
|
+
// oauth required
|
|
159
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
160
|
+
}
|
|
161
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
162
|
+
const token = this.configuration.accessToken;
|
|
163
|
+
const tokenString = await token("bearerAuth", ["links:write"]);
|
|
164
|
+
if (tokenString) {
|
|
165
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
let urlPath = `/v1/settings/data-collection`;
|
|
169
|
+
return {
|
|
170
|
+
path: urlPath,
|
|
171
|
+
method: 'PUT',
|
|
172
|
+
headers: headerParameters,
|
|
173
|
+
query: queryParameters,
|
|
174
|
+
body: (0, index_1.UpdateDataCollectionRequestToJSON)(requestParameters['updateDataCollectionRequest']),
|
|
175
|
+
};
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Set the data collection level of the caller\'s workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.
|
|
179
|
+
* Update the data collection level
|
|
180
|
+
*/
|
|
181
|
+
async settingsServiceUpdateDataCollectionRaw(requestParameters, initOverrides) {
|
|
182
|
+
const requestOptions = await this.settingsServiceUpdateDataCollectionRequestOpts(requestParameters);
|
|
183
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
184
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateDataCollectionResponseFromJSON)(jsonValue));
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Set the data collection level of the caller\'s workspace. ADVANCED needs a paid plan. Requires the `links:write` scope.
|
|
188
|
+
* Update the data collection level
|
|
189
|
+
*/
|
|
190
|
+
async settingsServiceUpdateDataCollection(requestParameters, initOverrides) {
|
|
191
|
+
const response = await this.settingsServiceUpdateDataCollectionRaw(requestParameters, initOverrides);
|
|
192
|
+
return await response.value();
|
|
193
|
+
}
|
|
102
194
|
/**
|
|
103
195
|
* Creates request options for settingsServiceUpdateLinkSetting without sending the request
|
|
104
196
|
*/
|
package/dist/apis/LinksApi.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.187.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateBulkLinksRequest, CreateBulkLinksResponse, CreateContactLinkRequest, CreateContactLinkResponse, CreateLinkRequest, CreateLinkResponse, CreateOpenMediaLinkRequest, CreateOpenMediaLinkResponse, CreateThankYouLinkRequest, CreateThankYouLinkResponse, GetLinkResponse, Job, LinksServiceUpdateBody, ListLinksResponse, ResolveQrcodeImagesRequest, ResolveQrcodeImagesResponse, ShortlinkAvailabilityResponse, ShortlinkRandomResponse, UpdateLinkResponse } from '../models/index';
|
|
13
|
+
import type { CreateBulkLinksRequest, CreateBulkLinksResponse, CreateContactLinkRequest, CreateContactLinkResponse, CreateLinkRequest, CreateLinkResponse, CreateOpenMediaLinkRequest, CreateOpenMediaLinkResponse, CreateThankYouLinkRequest, CreateThankYouLinkResponse, GetLinkResponse, Job, LinksServiceRenderQrcodeImagesBody, LinksServiceUpdateBody, ListLinksResponse, RenderQrcodeImagesResponse, ResolveQrcodeImagesRequest, ResolveQrcodeImagesResponse, ShortlinkAvailabilityResponse, ShortlinkRandomResponse, UpdateLinkResponse } from '../models/index';
|
|
14
14
|
export interface LinksServiceCreateRequest {
|
|
15
15
|
createLinkRequest: CreateLinkRequest;
|
|
16
16
|
idempotencyKey?: string;
|
|
@@ -58,6 +58,11 @@ export interface LinksServiceListRequest {
|
|
|
58
58
|
directoryId?: string;
|
|
59
59
|
cursor?: string;
|
|
60
60
|
}
|
|
61
|
+
export interface LinksServiceRenderQrcodeImagesRequest {
|
|
62
|
+
id: string;
|
|
63
|
+
linksServiceRenderQrcodeImagesBody: LinksServiceRenderQrcodeImagesBody;
|
|
64
|
+
idempotencyKey?: string;
|
|
65
|
+
}
|
|
61
66
|
export interface LinksServiceResolveQrcodeImagesRequest {
|
|
62
67
|
resolveQrcodeImagesRequest: ResolveQrcodeImagesRequest;
|
|
63
68
|
idempotencyKey?: string;
|
|
@@ -322,6 +327,31 @@ export interface LinksApiInterface {
|
|
|
322
327
|
* List links
|
|
323
328
|
*/
|
|
324
329
|
linksServiceList(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLinksResponse>;
|
|
330
|
+
/**
|
|
331
|
+
* Creates request options for linksServiceRenderQrcodeImages without sending the request
|
|
332
|
+
* @param {string} id The link\'s ID (UUID).
|
|
333
|
+
* @param {LinksServiceRenderQrcodeImagesBody} linksServiceRenderQrcodeImagesBody
|
|
334
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
335
|
+
* @throws {RequiredError}
|
|
336
|
+
* @memberof LinksApiInterface
|
|
337
|
+
*/
|
|
338
|
+
linksServiceRenderQrcodeImagesRequestOpts(requestParameters: LinksServiceRenderQrcodeImagesRequest): Promise<runtime.RequestOpts>;
|
|
339
|
+
/**
|
|
340
|
+
* Draw the link\'s QR code in its saved design for each requested address and return signed image URLs. A dynamic link takes one item per code, each with a value for every {name} variable of its shortlink (up to 100 per call), so a single link can print as hundreds of serialised or GS1 Digital Link codes. A regular link takes one item without values. The address encoded in each code carries lbsrc=qrcode so its scans count as QR code scans. Images are cached per design, values, format and size; the URLs expire, so fetch them when you need them. Requires the `qrcodes:read` scope.
|
|
341
|
+
* @summary Render QR codes for a link
|
|
342
|
+
* @param {string} id The link\'s ID (UUID).
|
|
343
|
+
* @param {LinksServiceRenderQrcodeImagesBody} linksServiceRenderQrcodeImagesBody
|
|
344
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
* @memberof LinksApiInterface
|
|
348
|
+
*/
|
|
349
|
+
linksServiceRenderQrcodeImagesRaw(requestParameters: LinksServiceRenderQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderQrcodeImagesResponse>>;
|
|
350
|
+
/**
|
|
351
|
+
* Draw the link\'s QR code in its saved design for each requested address and return signed image URLs. A dynamic link takes one item per code, each with a value for every {name} variable of its shortlink (up to 100 per call), so a single link can print as hundreds of serialised or GS1 Digital Link codes. A regular link takes one item without values. The address encoded in each code carries lbsrc=qrcode so its scans count as QR code scans. Images are cached per design, values, format and size; the URLs expire, so fetch them when you need them. Requires the `qrcodes:read` scope.
|
|
352
|
+
* Render QR codes for a link
|
|
353
|
+
*/
|
|
354
|
+
linksServiceRenderQrcodeImages(requestParameters: LinksServiceRenderQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderQrcodeImagesResponse>;
|
|
325
355
|
/**
|
|
326
356
|
* Creates request options for linksServiceResolveQrcodeImages without sending the request
|
|
327
357
|
* @param {ResolveQrcodeImagesRequest} resolveQrcodeImagesRequest
|
|
@@ -557,6 +587,20 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
|
|
|
557
587
|
* List links
|
|
558
588
|
*/
|
|
559
589
|
linksServiceList(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLinksResponse>;
|
|
590
|
+
/**
|
|
591
|
+
* Creates request options for linksServiceRenderQrcodeImages without sending the request
|
|
592
|
+
*/
|
|
593
|
+
linksServiceRenderQrcodeImagesRequestOpts(requestParameters: LinksServiceRenderQrcodeImagesRequest): Promise<runtime.RequestOpts>;
|
|
594
|
+
/**
|
|
595
|
+
* Draw the link\'s QR code in its saved design for each requested address and return signed image URLs. A dynamic link takes one item per code, each with a value for every {name} variable of its shortlink (up to 100 per call), so a single link can print as hundreds of serialised or GS1 Digital Link codes. A regular link takes one item without values. The address encoded in each code carries lbsrc=qrcode so its scans count as QR code scans. Images are cached per design, values, format and size; the URLs expire, so fetch them when you need them. Requires the `qrcodes:read` scope.
|
|
596
|
+
* Render QR codes for a link
|
|
597
|
+
*/
|
|
598
|
+
linksServiceRenderQrcodeImagesRaw(requestParameters: LinksServiceRenderQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderQrcodeImagesResponse>>;
|
|
599
|
+
/**
|
|
600
|
+
* Draw the link\'s QR code in its saved design for each requested address and return signed image URLs. A dynamic link takes one item per code, each with a value for every {name} variable of its shortlink (up to 100 per call), so a single link can print as hundreds of serialised or GS1 Digital Link codes. A regular link takes one item without values. The address encoded in each code carries lbsrc=qrcode so its scans count as QR code scans. Images are cached per design, values, format and size; the URLs expire, so fetch them when you need them. Requires the `qrcodes:read` scope.
|
|
601
|
+
* Render QR codes for a link
|
|
602
|
+
*/
|
|
603
|
+
linksServiceRenderQrcodeImages(requestParameters: LinksServiceRenderQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderQrcodeImagesResponse>;
|
|
560
604
|
/**
|
|
561
605
|
* Creates request options for linksServiceResolveQrcodeImages without sending the request
|
|
562
606
|
*/
|
package/dist/apis/LinksApi.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Linkbreakers API
|
|
6
|
-
* This is a documentation of all the APIs of Linkbreakers ## 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.187.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -573,6 +573,60 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
573
573
|
const response = await this.linksServiceListRaw(requestParameters, initOverrides);
|
|
574
574
|
return await response.value();
|
|
575
575
|
}
|
|
576
|
+
/**
|
|
577
|
+
* Creates request options for linksServiceRenderQrcodeImages without sending the request
|
|
578
|
+
*/
|
|
579
|
+
async linksServiceRenderQrcodeImagesRequestOpts(requestParameters) {
|
|
580
|
+
if (requestParameters['id'] == null) {
|
|
581
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling linksServiceRenderQrcodeImages().');
|
|
582
|
+
}
|
|
583
|
+
if (requestParameters['linksServiceRenderQrcodeImagesBody'] == null) {
|
|
584
|
+
throw new runtime.RequiredError('linksServiceRenderQrcodeImagesBody', 'Required parameter "linksServiceRenderQrcodeImagesBody" was null or undefined when calling linksServiceRenderQrcodeImages().');
|
|
585
|
+
}
|
|
586
|
+
const queryParameters = {};
|
|
587
|
+
const headerParameters = {};
|
|
588
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
589
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
590
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
591
|
+
}
|
|
592
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
593
|
+
// oauth required
|
|
594
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["qrcodes:read"]);
|
|
595
|
+
}
|
|
596
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
597
|
+
const token = this.configuration.accessToken;
|
|
598
|
+
const tokenString = await token("bearerAuth", ["qrcodes:read"]);
|
|
599
|
+
if (tokenString) {
|
|
600
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
601
|
+
}
|
|
602
|
+
}
|
|
603
|
+
let urlPath = `/v1/links/{id}/qrcode-images:render`;
|
|
604
|
+
urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
|
|
605
|
+
return {
|
|
606
|
+
path: urlPath,
|
|
607
|
+
method: 'POST',
|
|
608
|
+
headers: headerParameters,
|
|
609
|
+
query: queryParameters,
|
|
610
|
+
body: (0, index_1.LinksServiceRenderQrcodeImagesBodyToJSON)(requestParameters['linksServiceRenderQrcodeImagesBody']),
|
|
611
|
+
};
|
|
612
|
+
}
|
|
613
|
+
/**
|
|
614
|
+
* Draw the link\'s QR code in its saved design for each requested address and return signed image URLs. A dynamic link takes one item per code, each with a value for every {name} variable of its shortlink (up to 100 per call), so a single link can print as hundreds of serialised or GS1 Digital Link codes. A regular link takes one item without values. The address encoded in each code carries lbsrc=qrcode so its scans count as QR code scans. Images are cached per design, values, format and size; the URLs expire, so fetch them when you need them. Requires the `qrcodes:read` scope.
|
|
615
|
+
* Render QR codes for a link
|
|
616
|
+
*/
|
|
617
|
+
async linksServiceRenderQrcodeImagesRaw(requestParameters, initOverrides) {
|
|
618
|
+
const requestOptions = await this.linksServiceRenderQrcodeImagesRequestOpts(requestParameters);
|
|
619
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
620
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RenderQrcodeImagesResponseFromJSON)(jsonValue));
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* Draw the link\'s QR code in its saved design for each requested address and return signed image URLs. A dynamic link takes one item per code, each with a value for every {name} variable of its shortlink (up to 100 per call), so a single link can print as hundreds of serialised or GS1 Digital Link codes. A regular link takes one item without values. The address encoded in each code carries lbsrc=qrcode so its scans count as QR code scans. Images are cached per design, values, format and size; the URLs expire, so fetch them when you need them. Requires the `qrcodes:read` scope.
|
|
624
|
+
* Render QR codes for a link
|
|
625
|
+
*/
|
|
626
|
+
async linksServiceRenderQrcodeImages(requestParameters, initOverrides) {
|
|
627
|
+
const response = await this.linksServiceRenderQrcodeImagesRaw(requestParameters, initOverrides);
|
|
628
|
+
return await response.value();
|
|
629
|
+
}
|
|
576
630
|
/**
|
|
577
631
|
* Creates request options for linksServiceResolveQrcodeImages without sending the request
|
|
578
632
|
*/
|
package/dist/apis/MediaApi.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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.
|
|
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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.187.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|