linkbreakers 1.150.0 → 1.158.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 +108 -0
- package/dist/apis/AgentIdentityApi.js +135 -0
- package/dist/apis/AllowancesApi.d.ts +13 -10
- package/dist/apis/AllowancesApi.js +9 -6
- package/dist/apis/AnalyticsDashboardApi.d.ts +38 -26
- package/dist/apis/AnalyticsDashboardApi.js +26 -14
- package/dist/apis/AnalyticsDataApi.d.ts +79 -46
- package/dist/apis/AnalyticsDataApi.js +57 -24
- package/dist/apis/AssistantApi.d.ts +8 -2
- package/dist/apis/AssistantApi.js +8 -2
- package/dist/apis/CustomDomainsApi.d.ts +14 -2
- package/dist/apis/CustomDomainsApi.js +14 -2
- package/dist/apis/DirectoriesApi.d.ts +11 -2
- package/dist/apis/DirectoriesApi.js +11 -2
- package/dist/apis/EventsApi.d.ts +5 -2
- package/dist/apis/EventsApi.js +5 -2
- package/dist/apis/GoogleFormsIntegrationsApi.d.ts +11 -2
- package/dist/apis/GoogleFormsIntegrationsApi.js +11 -2
- package/dist/apis/IntegrationsServiceApi.d.ts +5 -2
- package/dist/apis/IntegrationsServiceApi.js +5 -2
- package/dist/apis/JobsApi.d.ts +64 -0
- package/dist/apis/JobsApi.js +103 -0
- package/dist/apis/LinkSettingsApi.d.ts +5 -2
- package/dist/apis/LinkSettingsApi.js +5 -2
- package/dist/apis/LinksApi.d.ts +106 -3
- package/dist/apis/LinksApi.js +123 -2
- package/dist/apis/MediaApi.d.ts +8 -2
- package/dist/apis/MediaApi.js +8 -2
- package/dist/apis/MembersApi.d.ts +23 -2
- package/dist/apis/MembersApi.js +23 -2
- package/dist/apis/PageThemeTemplatesApi.d.ts +26 -2
- package/dist/apis/PageThemeTemplatesApi.js +26 -2
- package/dist/apis/PageThemesApi.d.ts +11 -2
- package/dist/apis/PageThemesApi.js +11 -2
- package/dist/apis/PricingApi.d.ts +2 -2
- package/dist/apis/PricingApi.js +2 -2
- package/dist/apis/QRCodeDesignsApi.d.ts +11 -2
- package/dist/apis/QRCodeDesignsApi.js +11 -2
- package/dist/apis/QRCodeTemplatesApi.d.ts +23 -2
- package/dist/apis/QRCodeTemplatesApi.js +23 -2
- package/dist/apis/SandboxesApi.d.ts +138 -0
- package/dist/apis/SandboxesApi.js +195 -0
- package/dist/apis/SlackIntegrationsApi.d.ts +11 -2
- package/dist/apis/SlackIntegrationsApi.js +11 -2
- package/dist/apis/TagsApi.d.ts +5 -2
- package/dist/apis/TagsApi.js +5 -2
- package/dist/apis/TimeSeriesApi.d.ts +5 -2
- package/dist/apis/TimeSeriesApi.js +5 -2
- package/dist/apis/VisitorsApi.d.ts +14 -2
- package/dist/apis/VisitorsApi.js +14 -2
- package/dist/apis/WebhooksApi.d.ts +11 -2
- package/dist/apis/WebhooksApi.js +11 -2
- package/dist/apis/WorkflowStepsApi.d.ts +20 -2
- package/dist/apis/WorkflowStepsApi.js +20 -2
- package/dist/apis/WorkspaceMetricsApi.d.ts +2 -2
- package/dist/apis/WorkspaceMetricsApi.js +2 -2
- package/dist/apis/WorkspaceTokensApi.d.ts +11 -2
- package/dist/apis/WorkspaceTokensApi.js +11 -2
- package/dist/apis/WorkspacesApi.d.ts +14 -2
- package/dist/apis/WorkspacesApi.js +14 -2
- package/dist/apis/index.d.ts +3 -0
- package/dist/apis/index.js +3 -0
- package/dist/models/Action.d.ts +2 -2
- package/dist/models/Action.js +2 -2
- package/dist/models/AgentClaim.d.ts +58 -0
- package/dist/models/AgentClaim.js +58 -0
- package/dist/models/AgentClaimStatus.d.ts +31 -0
- package/dist/models/AgentClaimStatus.js +57 -0
- package/dist/models/AnalyticsDashboard.d.ts +2 -2
- package/dist/models/AnalyticsDashboard.js +2 -2
- package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.d.ts +2 -2
- package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.js +2 -2
- package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.d.ts +2 -2
- package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.js +2 -2
- package/dist/models/AnalyticsWidgetResult.d.ts +2 -2
- package/dist/models/AnalyticsWidgetResult.js +2 -2
- package/dist/models/ApiScope.d.ts +2 -2
- package/dist/models/ApiScope.js +2 -2
- package/dist/models/ApiScopeAccess.d.ts +2 -2
- package/dist/models/ApiScopeAccess.js +2 -2
- package/dist/models/ApiScopeInfo.d.ts +74 -6
- package/dist/models/ApiScopeInfo.js +40 -5
- package/dist/models/ApiTag.d.ts +2 -2
- package/dist/models/ApiTag.js +2 -2
- package/dist/models/ApplyPageThemeTemplateRequest.d.ts +2 -2
- package/dist/models/ApplyPageThemeTemplateRequest.js +2 -2
- package/dist/models/ApplyPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/ApplyPageThemeTemplateResponse.js +2 -2
- package/dist/models/ApplyQrcodeTemplateRequest.d.ts +2 -2
- package/dist/models/ApplyQrcodeTemplateRequest.js +2 -2
- package/dist/models/ApplyQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/ApplyQrcodeTemplateResponse.js +2 -2
- package/dist/models/AssistantContextType.d.ts +2 -2
- package/dist/models/AssistantContextType.js +2 -2
- package/dist/models/AssistantDisplayMessage.d.ts +2 -2
- package/dist/models/AssistantDisplayMessage.js +2 -2
- package/dist/models/AssistantDisplayMessageAttachment.d.ts +2 -2
- package/dist/models/AssistantDisplayMessageAttachment.js +2 -2
- package/dist/models/AssistantGetConversationResponse.d.ts +2 -2
- package/dist/models/AssistantGetConversationResponse.js +2 -2
- package/dist/models/AssistantMarkConversationReadRequest.d.ts +2 -2
- package/dist/models/AssistantMarkConversationReadRequest.js +2 -2
- package/dist/models/AssistantMarkConversationReadResponse.d.ts +2 -2
- package/dist/models/AssistantMarkConversationReadResponse.js +2 -2
- package/dist/models/AssistantUploadFileRequest.d.ts +2 -2
- package/dist/models/AssistantUploadFileRequest.js +2 -2
- package/dist/models/AssistantUploadFileResponse.d.ts +2 -2
- package/dist/models/AssistantUploadFileResponse.js +2 -2
- package/dist/models/AttributeCapture.d.ts +2 -2
- package/dist/models/AttributeCapture.js +2 -2
- package/dist/models/AttributeValueDataPoint.d.ts +2 -2
- package/dist/models/AttributeValueDataPoint.js +2 -2
- package/dist/models/AttributeValueEntry.d.ts +2 -2
- package/dist/models/AttributeValueEntry.js +2 -2
- package/dist/models/AttributeWrite.d.ts +2 -2
- package/dist/models/AttributeWrite.js +2 -2
- package/dist/models/AttributeWriteMode.d.ts +2 -2
- package/dist/models/AttributeWriteMode.js +2 -2
- package/dist/models/AutoLayoutWorkflowResponse.d.ts +2 -2
- package/dist/models/AutoLayoutWorkflowResponse.js +2 -2
- package/dist/models/BackgroundOptions.d.ts +2 -2
- package/dist/models/BackgroundOptions.js +2 -2
- package/dist/models/BillingInterval.d.ts +2 -2
- package/dist/models/BillingInterval.js +2 -2
- package/dist/models/BreakdownDataPoint.d.ts +2 -2
- package/dist/models/BreakdownDataPoint.js +2 -2
- package/dist/models/CanvasPosition.d.ts +2 -2
- package/dist/models/CanvasPosition.js +2 -2
- package/dist/models/ChatDisplayMessage.d.ts +2 -2
- package/dist/models/ChatDisplayMessage.js +2 -2
- package/dist/models/ChatUIAction.d.ts +2 -2
- package/dist/models/ChatUIAction.js +2 -2
- package/dist/models/ChatUIOption.d.ts +2 -2
- package/dist/models/ChatUIOption.js +2 -2
- package/dist/models/CheckCustomDomainResponse.d.ts +2 -2
- package/dist/models/CheckCustomDomainResponse.js +2 -2
- package/dist/models/ClaimAgentWorkspaceRequest.d.ts +50 -0
- package/dist/models/ClaimAgentWorkspaceRequest.js +54 -0
- package/dist/models/ClientRedirectPayload.d.ts +2 -2
- package/dist/models/ClientRedirectPayload.js +2 -2
- package/dist/models/CompleteGoogleFormsOAuthRequest.d.ts +2 -2
- package/dist/models/CompleteGoogleFormsOAuthRequest.js +2 -2
- package/dist/models/CompleteGoogleFormsOAuthResponse.d.ts +2 -2
- package/dist/models/CompleteGoogleFormsOAuthResponse.js +2 -2
- package/dist/models/CompleteSlackOAuthRequest.d.ts +2 -2
- package/dist/models/CompleteSlackOAuthRequest.js +2 -2
- package/dist/models/CompleteSlackOAuthResponse.d.ts +2 -2
- package/dist/models/CompleteSlackOAuthResponse.js +2 -2
- package/dist/models/ConnectWorkflowStepResponse.d.ts +2 -2
- package/dist/models/ConnectWorkflowStepResponse.js +2 -2
- package/dist/models/ContactCardTraceCard.d.ts +2 -2
- package/dist/models/ContactCardTraceCard.js +2 -2
- package/dist/models/ContactCardTraceData.d.ts +2 -2
- package/dist/models/ContactCardTraceData.js +2 -2
- package/dist/models/ContainerConfig.d.ts +2 -2
- package/dist/models/ContainerConfig.js +2 -2
- package/dist/models/CornersDotOptions.d.ts +2 -2
- package/dist/models/CornersDotOptions.js +2 -2
- package/dist/models/CornersDotType.d.ts +2 -2
- package/dist/models/CornersDotType.js +2 -2
- package/dist/models/CornersSquareOptions.d.ts +2 -2
- package/dist/models/CornersSquareOptions.js +2 -2
- package/dist/models/CornersSquareType.d.ts +2 -2
- package/dist/models/CornersSquareType.js +2 -2
- package/dist/models/CountryConditionOutcome.d.ts +2 -2
- package/dist/models/CountryConditionOutcome.js +2 -2
- package/dist/models/CountryConditionPayload.d.ts +2 -2
- package/dist/models/CountryConditionPayload.js +2 -2
- package/dist/models/CountryConditionTraceData.d.ts +2 -2
- package/dist/models/CountryConditionTraceData.js +2 -2
- package/dist/models/CountryConditionTraceOption.d.ts +2 -2
- package/dist/models/CountryConditionTraceOption.js +2 -2
- package/dist/models/CreateBulkLinksRequest.d.ts +2 -2
- package/dist/models/CreateBulkLinksRequest.js +2 -2
- package/dist/models/CreateBulkLinksResponse.d.ts +2 -2
- package/dist/models/CreateBulkLinksResponse.js +2 -2
- package/dist/models/CreateContactLinkRequest.d.ts +2 -2
- package/dist/models/CreateContactLinkRequest.js +2 -2
- package/dist/models/CreateContactLinkResponse.d.ts +2 -2
- package/dist/models/CreateContactLinkResponse.js +2 -2
- package/dist/models/CreateCustomDomainRequest.d.ts +2 -2
- package/dist/models/CreateCustomDomainRequest.js +2 -2
- package/dist/models/CreateCustomDomainResponse.d.ts +2 -2
- package/dist/models/CreateCustomDomainResponse.js +2 -2
- package/dist/models/CreateDashboardRequest.d.ts +2 -2
- package/dist/models/CreateDashboardRequest.js +2 -2
- package/dist/models/CreateDashboardResponse.d.ts +2 -2
- package/dist/models/CreateDashboardResponse.js +2 -2
- package/dist/models/CreateDirectoryRequest.d.ts +2 -2
- package/dist/models/CreateDirectoryRequest.js +2 -2
- package/dist/models/CreateDirectoryResponse.d.ts +2 -2
- package/dist/models/CreateDirectoryResponse.js +2 -2
- package/dist/models/CreateEventTraceResponse.d.ts +2 -2
- package/dist/models/CreateEventTraceResponse.js +2 -2
- package/dist/models/CreateLinkRequest.d.ts +2 -2
- package/dist/models/CreateLinkRequest.js +2 -2
- package/dist/models/CreateLinkResponse.d.ts +2 -2
- package/dist/models/CreateLinkResponse.js +2 -2
- package/dist/models/CreateMediaRequest.d.ts +2 -2
- package/dist/models/CreateMediaRequest.js +2 -2
- package/dist/models/CreateMediaResponse.d.ts +2 -2
- package/dist/models/CreateMediaResponse.js +2 -2
- package/dist/models/CreatePageThemeTemplateRequest.d.ts +2 -2
- package/dist/models/CreatePageThemeTemplateRequest.js +2 -2
- package/dist/models/CreatePageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/CreatePageThemeTemplateResponse.js +2 -2
- package/dist/models/CreateQrcodeTemplateRequest.d.ts +2 -2
- package/dist/models/CreateQrcodeTemplateRequest.js +2 -2
- package/dist/models/CreateQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/CreateQrcodeTemplateResponse.js +2 -2
- package/dist/models/CreateSandboxRequest.d.ts +32 -0
- package/dist/models/CreateSandboxRequest.js +48 -0
- package/dist/models/CreateSandboxResponse.d.ts +47 -0
- package/dist/models/CreateSandboxResponse.js +54 -0
- package/dist/models/CreateThankYouLinkRequest.d.ts +2 -2
- package/dist/models/CreateThankYouLinkRequest.js +2 -2
- package/dist/models/CreateThankYouLinkResponse.d.ts +2 -2
- package/dist/models/CreateThankYouLinkResponse.js +2 -2
- package/dist/models/CreateWebhookRequest.d.ts +2 -2
- package/dist/models/CreateWebhookRequest.js +2 -2
- package/dist/models/CreateWebhookResponse.d.ts +2 -2
- package/dist/models/CreateWebhookResponse.js +2 -2
- package/dist/models/CreateWorkflowStepResponse.d.ts +2 -2
- package/dist/models/CreateWorkflowStepResponse.js +2 -2
- package/dist/models/CreateWorkspaceTokenRequest.d.ts +54 -9
- package/dist/models/CreateWorkspaceTokenRequest.js +50 -8
- package/dist/models/CreateWorkspaceTokenResponse.d.ts +2 -2
- package/dist/models/CreateWorkspaceTokenResponse.js +2 -2
- package/dist/models/CreditTopup.d.ts +2 -2
- package/dist/models/CreditTopup.js +2 -2
- package/dist/models/CustomDomain.d.ts +2 -2
- package/dist/models/CustomDomain.js +2 -2
- package/dist/models/CustomDomainDnsRecord.d.ts +2 -2
- package/dist/models/CustomDomainDnsRecord.js +2 -2
- package/dist/models/CustomDomainOneClickSetup.d.ts +2 -2
- package/dist/models/CustomDomainOneClickSetup.js +2 -2
- package/dist/models/CustomDomainSetupGuide.d.ts +2 -2
- package/dist/models/CustomDomainSetupGuide.js +2 -2
- package/dist/models/CustomDomainSetupHint.d.ts +2 -2
- package/dist/models/CustomDomainSetupHint.js +2 -2
- package/dist/models/CustomDomainStatus.d.ts +2 -2
- package/dist/models/CustomDomainStatus.js +2 -2
- package/dist/models/CustomDomainsServiceUpdateBody.d.ts +2 -2
- package/dist/models/CustomDomainsServiceUpdateBody.js +2 -2
- package/dist/models/DashboardConfig.d.ts +2 -2
- package/dist/models/DashboardConfig.js +2 -2
- package/dist/models/DashboardScope.d.ts +2 -2
- package/dist/models/DashboardScope.js +2 -2
- package/dist/models/DashboardWidget.d.ts +2 -2
- package/dist/models/DashboardWidget.js +2 -2
- package/dist/models/DataCollection.d.ts +2 -2
- package/dist/models/DataCollection.js +2 -2
- package/dist/models/DayOfMonthConditionPayload.d.ts +2 -2
- package/dist/models/DayOfMonthConditionPayload.js +2 -2
- package/dist/models/DayOfMonthConditionTraceData.d.ts +2 -2
- package/dist/models/DayOfMonthConditionTraceData.js +2 -2
- package/dist/models/DayOfMonthConditionTraceOption.d.ts +2 -2
- package/dist/models/DayOfMonthConditionTraceOption.js +2 -2
- package/dist/models/DayOfMonthOption.d.ts +2 -2
- package/dist/models/DayOfMonthOption.js +2 -2
- package/dist/models/DayOfWeekConditionPayload.d.ts +2 -2
- package/dist/models/DayOfWeekConditionPayload.js +2 -2
- package/dist/models/DayOfWeekConditionTraceData.d.ts +2 -2
- package/dist/models/DayOfWeekConditionTraceData.js +2 -2
- package/dist/models/DayOfWeekConditionTraceOption.d.ts +2 -2
- package/dist/models/DayOfWeekConditionTraceOption.js +2 -2
- package/dist/models/DayOfWeekOption.d.ts +2 -2
- package/dist/models/DayOfWeekOption.js +2 -2
- package/dist/models/DeleteAttributeResponse.d.ts +2 -2
- package/dist/models/DeleteAttributeResponse.js +2 -2
- package/dist/models/DeleteVisitorResponse.d.ts +2 -2
- package/dist/models/DeleteVisitorResponse.js +2 -2
- package/dist/models/DetectedGoogleForm.d.ts +2 -2
- package/dist/models/DetectedGoogleForm.js +2 -2
- package/dist/models/Device.d.ts +2 -2
- package/dist/models/Device.js +2 -2
- package/dist/models/DeviceActor.d.ts +2 -2
- package/dist/models/DeviceActor.js +2 -2
- package/dist/models/DeviceActorConditionOption.d.ts +2 -2
- package/dist/models/DeviceActorConditionOption.js +2 -2
- package/dist/models/DeviceActorConditionPayload.d.ts +2 -2
- package/dist/models/DeviceActorConditionPayload.js +2 -2
- package/dist/models/DeviceActorConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceActorConditionTraceData.js +2 -2
- package/dist/models/DeviceActorConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceActorConditionTraceOption.js +2 -2
- package/dist/models/DeviceActorConditionValue.d.ts +2 -2
- package/dist/models/DeviceActorConditionValue.js +2 -2
- package/dist/models/DeviceBrandConditionOption.d.ts +2 -2
- package/dist/models/DeviceBrandConditionOption.js +2 -2
- package/dist/models/DeviceBrandConditionPayload.d.ts +2 -2
- package/dist/models/DeviceBrandConditionPayload.js +2 -2
- package/dist/models/DeviceBrandConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceBrandConditionTraceData.js +2 -2
- package/dist/models/DeviceBrandConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceBrandConditionTraceOption.js +2 -2
- package/dist/models/DeviceBrandConditionValue.d.ts +2 -2
- package/dist/models/DeviceBrandConditionValue.js +2 -2
- package/dist/models/DeviceBrowserConditionOption.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionOption.js +2 -2
- package/dist/models/DeviceBrowserConditionPayload.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionPayload.js +2 -2
- package/dist/models/DeviceBrowserConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionTraceData.js +2 -2
- package/dist/models/DeviceBrowserConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionTraceOption.js +2 -2
- package/dist/models/DeviceBrowserConditionValue.d.ts +2 -2
- package/dist/models/DeviceBrowserConditionValue.js +2 -2
- package/dist/models/DeviceDataPoint.d.ts +2 -2
- package/dist/models/DeviceDataPoint.js +2 -2
- package/dist/models/DeviceInput.d.ts +2 -2
- package/dist/models/DeviceInput.js +2 -2
- package/dist/models/DevicePlatformConditionOption.d.ts +2 -2
- package/dist/models/DevicePlatformConditionOption.js +2 -2
- package/dist/models/DevicePlatformConditionPayload.d.ts +2 -2
- package/dist/models/DevicePlatformConditionPayload.js +2 -2
- package/dist/models/DevicePlatformConditionTraceData.d.ts +2 -2
- package/dist/models/DevicePlatformConditionTraceData.js +2 -2
- package/dist/models/DevicePlatformConditionTraceOption.d.ts +2 -2
- package/dist/models/DevicePlatformConditionTraceOption.js +2 -2
- package/dist/models/DevicePlatformConditionValue.d.ts +2 -2
- package/dist/models/DevicePlatformConditionValue.js +2 -2
- package/dist/models/DeviceType.d.ts +2 -2
- package/dist/models/DeviceType.js +2 -2
- package/dist/models/DeviceTypeConditionOption.d.ts +2 -2
- package/dist/models/DeviceTypeConditionOption.js +2 -2
- package/dist/models/DeviceTypeConditionPayload.d.ts +2 -2
- package/dist/models/DeviceTypeConditionPayload.js +2 -2
- package/dist/models/DeviceTypeConditionTraceData.d.ts +2 -2
- package/dist/models/DeviceTypeConditionTraceData.js +2 -2
- package/dist/models/DeviceTypeConditionTraceOption.d.ts +2 -2
- package/dist/models/DeviceTypeConditionTraceOption.js +2 -2
- package/dist/models/DeviceTypeConditionValue.d.ts +2 -2
- package/dist/models/DeviceTypeConditionValue.js +2 -2
- package/dist/models/DigestFrequency.d.ts +2 -2
- package/dist/models/DigestFrequency.js +2 -2
- package/dist/models/DirectoriesServiceUpdateBody.d.ts +2 -2
- package/dist/models/DirectoriesServiceUpdateBody.js +2 -2
- package/dist/models/Directory.d.ts +2 -2
- package/dist/models/Directory.js +2 -2
- package/dist/models/DisconnectWorkflowStepResponse.d.ts +2 -2
- package/dist/models/DisconnectWorkflowStepResponse.js +2 -2
- package/dist/models/DismissAllowanceNoticeRequest.d.ts +2 -2
- package/dist/models/DismissAllowanceNoticeRequest.js +2 -2
- package/dist/models/DnsProvider.d.ts +2 -2
- package/dist/models/DnsProvider.js +2 -2
- package/dist/models/DnsRecordPurpose.d.ts +2 -2
- package/dist/models/DnsRecordPurpose.js +2 -2
- package/dist/models/DnsRecordType.d.ts +2 -2
- package/dist/models/DnsRecordType.js +2 -2
- package/dist/models/DotsOptions.d.ts +2 -2
- package/dist/models/DotsOptions.js +2 -2
- package/dist/models/DotsType.d.ts +2 -2
- package/dist/models/DotsType.js +2 -2
- package/dist/models/EntryAccessTraceData.d.ts +2 -2
- package/dist/models/EntryAccessTraceData.js +2 -2
- package/dist/models/ErrorResponse.d.ts +2 -2
- package/dist/models/ErrorResponse.js +2 -2
- package/dist/models/Event.d.ts +2 -2
- package/dist/models/Event.js +2 -2
- package/dist/models/EventAction.d.ts +2 -2
- package/dist/models/EventAction.js +2 -2
- package/dist/models/EventTrace.d.ts +2 -2
- package/dist/models/EventTrace.js +2 -2
- package/dist/models/EventTraceData.d.ts +2 -2
- package/dist/models/EventTraceData.js +2 -2
- package/dist/models/EventsMetric.d.ts +2 -2
- package/dist/models/EventsMetric.js +2 -2
- package/dist/models/EventsServiceCreateEventTraceBody.d.ts +2 -2
- package/dist/models/EventsServiceCreateEventTraceBody.js +2 -2
- package/dist/models/EventsServiceUpdateDeviceBody.d.ts +2 -2
- package/dist/models/EventsServiceUpdateDeviceBody.js +2 -2
- package/dist/models/EventsTimeSeries.d.ts +2 -2
- package/dist/models/EventsTimeSeries.js +2 -2
- package/dist/models/EventsTimeSeriesData.d.ts +2 -2
- package/dist/models/EventsTimeSeriesData.js +2 -2
- package/dist/models/FindMatchingPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/FindMatchingPageThemeTemplateResponse.js +2 -2
- package/dist/models/FontConfig.d.ts +2 -2
- package/dist/models/FontConfig.js +2 -2
- package/dist/models/FormField.d.ts +2 -2
- package/dist/models/FormField.js +2 -2
- package/dist/models/FormFieldOption.d.ts +2 -2
- package/dist/models/FormFieldOption.js +2 -2
- package/dist/models/FormFieldType.d.ts +2 -2
- package/dist/models/FormFieldType.js +2 -2
- package/dist/models/FormPayload.d.ts +2 -2
- package/dist/models/FormPayload.js +2 -2
- package/dist/models/FormTraceData.d.ts +2 -2
- package/dist/models/FormTraceData.js +2 -2
- package/dist/models/FormTraceDataField.d.ts +2 -2
- package/dist/models/FormTraceDataField.js +2 -2
- package/dist/models/FunnelBranch.d.ts +2 -2
- package/dist/models/FunnelBranch.js +2 -2
- package/dist/models/FunnelStep.d.ts +2 -2
- package/dist/models/FunnelStep.js +2 -2
- package/dist/models/GenerateWidgetSummaryResponse.d.ts +2 -2
- package/dist/models/GenerateWidgetSummaryResponse.js +2 -2
- package/dist/models/GeoDataPoint.d.ts +2 -2
- package/dist/models/GeoDataPoint.js +2 -2
- package/dist/models/GetAgentClaimRequest.d.ts +32 -0
- package/dist/models/GetAgentClaimRequest.js +48 -0
- package/dist/models/GetAttributeDistributionRequest.d.ts +2 -2
- package/dist/models/GetAttributeDistributionRequest.js +2 -2
- package/dist/models/GetAttributeDistributionResponse.d.ts +2 -2
- package/dist/models/GetAttributeDistributionResponse.js +2 -2
- package/dist/models/GetAttributeMetricRequest.d.ts +2 -2
- package/dist/models/GetAttributeMetricRequest.js +2 -2
- package/dist/models/GetAttributeMetricResponse.d.ts +2 -2
- package/dist/models/GetAttributeMetricResponse.js +2 -2
- package/dist/models/GetAttributeValuesRequest.d.ts +2 -2
- package/dist/models/GetAttributeValuesRequest.js +2 -2
- package/dist/models/GetAttributeValuesResponse.d.ts +2 -2
- package/dist/models/GetAttributeValuesResponse.js +2 -2
- package/dist/models/GetBreakdownRequest.d.ts +2 -2
- package/dist/models/GetBreakdownRequest.js +2 -2
- package/dist/models/GetBreakdownResponse.d.ts +2 -2
- package/dist/models/GetBreakdownResponse.js +2 -2
- package/dist/models/GetCustomDomainResponse.d.ts +2 -2
- package/dist/models/GetCustomDomainResponse.js +2 -2
- package/dist/models/GetCustomDomainSetupGuideResponse.d.ts +2 -2
- package/dist/models/GetCustomDomainSetupGuideResponse.js +2 -2
- package/dist/models/GetDeviceDistributionRequest.d.ts +2 -2
- package/dist/models/GetDeviceDistributionRequest.js +2 -2
- package/dist/models/GetDeviceDistributionResponse.d.ts +2 -2
- package/dist/models/GetDeviceDistributionResponse.js +2 -2
- package/dist/models/GetDirectoryResponse.d.ts +2 -2
- package/dist/models/GetDirectoryResponse.js +2 -2
- package/dist/models/GetEventsTimeSeriesRequest.d.ts +2 -2
- package/dist/models/GetEventsTimeSeriesRequest.js +2 -2
- package/dist/models/GetEventsTimeSeriesResponse.d.ts +2 -2
- package/dist/models/GetEventsTimeSeriesResponse.js +2 -2
- package/dist/models/GetGeoBreakdownRequest.d.ts +2 -2
- package/dist/models/GetGeoBreakdownRequest.js +2 -2
- package/dist/models/GetGeoBreakdownResponse.d.ts +2 -2
- package/dist/models/GetGeoBreakdownResponse.js +2 -2
- package/dist/models/GetGoogleFormsIntegrationResponse.d.ts +2 -2
- package/dist/models/GetGoogleFormsIntegrationResponse.js +2 -2
- package/dist/models/GetGoogleFormsOAuthURLResponse.d.ts +2 -2
- package/dist/models/GetGoogleFormsOAuthURLResponse.js +2 -2
- package/dist/models/GetGroupedTimeSeriesRequest.d.ts +2 -2
- package/dist/models/GetGroupedTimeSeriesRequest.js +2 -2
- package/dist/models/GetGroupedTimeSeriesResponse.d.ts +2 -2
- package/dist/models/GetGroupedTimeSeriesResponse.js +2 -2
- package/dist/models/GetHourOfDayDistributionRequest.d.ts +2 -2
- package/dist/models/GetHourOfDayDistributionRequest.js +2 -2
- package/dist/models/GetHourOfDayDistributionResponse.d.ts +2 -2
- package/dist/models/GetHourOfDayDistributionResponse.js +2 -2
- package/dist/models/GetLinkResponse.d.ts +2 -2
- package/dist/models/GetLinkResponse.js +2 -2
- package/dist/models/GetLinkSettingResponse.d.ts +2 -2
- package/dist/models/GetLinkSettingResponse.js +2 -2
- package/dist/models/GetMediaResponse.d.ts +2 -2
- package/dist/models/GetMediaResponse.js +2 -2
- package/dist/models/GetPageThemeResponse.d.ts +2 -2
- package/dist/models/GetPageThemeResponse.js +2 -2
- package/dist/models/GetQrcodeDesignResponse.d.ts +2 -2
- package/dist/models/GetQrcodeDesignResponse.js +2 -2
- package/dist/models/GetSlackIntegrationResponse.d.ts +2 -2
- package/dist/models/GetSlackIntegrationResponse.js +2 -2
- package/dist/models/GetSlackOAuthURLResponse.d.ts +2 -2
- package/dist/models/GetSlackOAuthURLResponse.js +2 -2
- package/dist/models/GetStepFunnelRequest.d.ts +2 -2
- package/dist/models/GetStepFunnelRequest.js +2 -2
- package/dist/models/GetStepFunnelResponse.d.ts +2 -2
- package/dist/models/GetStepFunnelResponse.js +2 -2
- package/dist/models/GetTopLinksRequest.d.ts +2 -2
- package/dist/models/GetTopLinksRequest.js +2 -2
- package/dist/models/GetTopLinksResponse.d.ts +2 -2
- package/dist/models/GetTopLinksResponse.js +2 -2
- package/dist/models/GetVisitorTrendsRequest.d.ts +2 -2
- package/dist/models/GetVisitorTrendsRequest.js +2 -2
- package/dist/models/GetVisitorTrendsResponse.d.ts +2 -2
- package/dist/models/GetVisitorTrendsResponse.js +2 -2
- package/dist/models/GetWebhookResponse.d.ts +2 -2
- package/dist/models/GetWebhookResponse.js +2 -2
- package/dist/models/GetWidgetSummaryResponse.d.ts +2 -2
- package/dist/models/GetWidgetSummaryResponse.js +2 -2
- package/dist/models/GetWorkflowStepResponse.d.ts +2 -2
- package/dist/models/GetWorkflowStepResponse.js +2 -2
- package/dist/models/GetWorkspaceTokenResponse.d.ts +2 -2
- package/dist/models/GetWorkspaceTokenResponse.js +2 -2
- package/dist/models/GoogleFormsIntegration.d.ts +2 -2
- package/dist/models/GoogleFormsIntegration.js +2 -2
- package/dist/models/GoogleFormsIntegrationStatus.d.ts +2 -2
- package/dist/models/GoogleFormsIntegrationStatus.js +2 -2
- package/dist/models/GooglerpcStatus.d.ts +2 -2
- package/dist/models/GooglerpcStatus.js +2 -2
- package/dist/models/GroupByDimension.d.ts +2 -2
- package/dist/models/GroupByDimension.js +2 -2
- package/dist/models/HourOfDayDataPoint.d.ts +2 -2
- package/dist/models/HourOfDayDataPoint.js +2 -2
- package/dist/models/IdentifyRequest.d.ts +2 -2
- package/dist/models/IdentifyRequest.js +2 -2
- package/dist/models/IdentifyResponse.d.ts +2 -2
- package/dist/models/IdentifyResponse.js +2 -2
- package/dist/models/IdentifyVisitorTraceData.d.ts +2 -2
- package/dist/models/IdentifyVisitorTraceData.js +2 -2
- package/dist/models/ImportPageThemeTemplateRequest.d.ts +2 -2
- package/dist/models/ImportPageThemeTemplateRequest.js +2 -2
- package/dist/models/ImportPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/ImportPageThemeTemplateResponse.js +2 -2
- package/dist/models/ImportQrcodeTemplateRequest.d.ts +2 -2
- package/dist/models/ImportQrcodeTemplateRequest.js +2 -2
- package/dist/models/ImportQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/ImportQrcodeTemplateResponse.js +2 -2
- package/dist/models/InviteMemberRequest.d.ts +2 -2
- package/dist/models/InviteMemberRequest.js +2 -2
- package/dist/models/Job.d.ts +110 -0
- package/dist/models/Job.js +84 -0
- package/dist/models/JobError.d.ts +38 -0
- package/dist/models/JobError.js +50 -0
- package/dist/models/JobStatus.d.ts +34 -0
- package/dist/models/JobStatus.js +60 -0
- package/dist/models/JobType.d.ts +28 -0
- package/dist/models/JobType.js +54 -0
- package/dist/models/JourneyProgress.d.ts +2 -2
- package/dist/models/JourneyProgress.js +2 -2
- package/dist/models/Link.d.ts +2 -2
- package/dist/models/Link.js +2 -2
- package/dist/models/LinkSetting.d.ts +2 -2
- package/dist/models/LinkSetting.js +2 -2
- package/dist/models/LinkSortField.d.ts +2 -2
- package/dist/models/LinkSortField.js +2 -2
- package/dist/models/LinkView.d.ts +2 -2
- package/dist/models/LinkView.js +2 -2
- package/dist/models/LinksBulkCreateResult.d.ts +33 -0
- package/dist/models/LinksBulkCreateResult.js +48 -0
- package/dist/models/LinksServiceUpdateBody.d.ts +2 -2
- package/dist/models/LinksServiceUpdateBody.js +2 -2
- package/dist/models/ListAllowancesResponse.d.ts +2 -2
- package/dist/models/ListAllowancesResponse.js +2 -2
- package/dist/models/ListApiScopesResponse.d.ts +2 -2
- package/dist/models/ListApiScopesResponse.js +2 -2
- package/dist/models/ListCustomDomainsResponse.d.ts +2 -2
- package/dist/models/ListCustomDomainsResponse.js +2 -2
- package/dist/models/ListDashboardsResponse.d.ts +2 -2
- package/dist/models/ListDashboardsResponse.js +2 -2
- package/dist/models/ListDetectedGoogleFormsResponse.d.ts +2 -2
- package/dist/models/ListDetectedGoogleFormsResponse.js +2 -2
- package/dist/models/ListDirectoriesResponse.d.ts +2 -2
- package/dist/models/ListDirectoriesResponse.js +2 -2
- package/dist/models/ListEventTracesResponse.d.ts +2 -2
- package/dist/models/ListEventTracesResponse.js +2 -2
- package/dist/models/ListEventsCsvResponse.d.ts +2 -2
- package/dist/models/ListEventsCsvResponse.js +2 -2
- package/dist/models/ListEventsJsonResponse.d.ts +2 -2
- package/dist/models/ListEventsJsonResponse.js +2 -2
- package/dist/models/ListEventsResponse.d.ts +2 -2
- package/dist/models/ListEventsResponse.js +2 -2
- package/dist/models/ListLinksResponse.d.ts +2 -2
- package/dist/models/ListLinksResponse.js +2 -2
- package/dist/models/ListMediaResponse.d.ts +2 -2
- package/dist/models/ListMediaResponse.js +2 -2
- package/dist/models/ListPageThemeTemplatesResponse.d.ts +2 -2
- package/dist/models/ListPageThemeTemplatesResponse.js +2 -2
- package/dist/models/ListPageThemesResponse.d.ts +2 -2
- package/dist/models/ListPageThemesResponse.js +2 -2
- package/dist/models/ListPricingPlansResponse.d.ts +2 -2
- package/dist/models/ListPricingPlansResponse.js +2 -2
- package/dist/models/ListQrcodeTemplatesResponse.d.ts +2 -2
- package/dist/models/ListQrcodeTemplatesResponse.js +2 -2
- package/dist/models/ListResponse.d.ts +2 -2
- package/dist/models/ListResponse.js +2 -2
- package/dist/models/ListSandboxesResponse.d.ts +39 -0
- package/dist/models/ListSandboxesResponse.js +51 -0
- package/dist/models/ListSlackChannelsResponse.d.ts +2 -2
- package/dist/models/ListSlackChannelsResponse.js +2 -2
- package/dist/models/ListTagsResponse.d.ts +2 -2
- package/dist/models/ListTagsResponse.js +2 -2
- package/dist/models/ListVisitorAttributeKeysResponse.d.ts +2 -2
- package/dist/models/ListVisitorAttributeKeysResponse.js +2 -2
- package/dist/models/ListVisitorsCsvResponse.d.ts +2 -2
- package/dist/models/ListVisitorsCsvResponse.js +2 -2
- package/dist/models/ListVisitorsJsonResponse.d.ts +2 -2
- package/dist/models/ListVisitorsJsonResponse.js +2 -2
- package/dist/models/ListVisitorsRequest.d.ts +2 -2
- package/dist/models/ListVisitorsRequest.js +2 -2
- package/dist/models/ListVisitorsResponse.d.ts +2 -2
- package/dist/models/ListVisitorsResponse.js +2 -2
- package/dist/models/ListWebhooksResponse.d.ts +2 -2
- package/dist/models/ListWebhooksResponse.js +2 -2
- package/dist/models/ListWorkflowStepsResponse.d.ts +2 -2
- package/dist/models/ListWorkflowStepsResponse.js +2 -2
- package/dist/models/ListWorkspaceTokensResponse.d.ts +2 -2
- package/dist/models/ListWorkspaceTokensResponse.js +2 -2
- package/dist/models/Media.d.ts +2 -2
- package/dist/models/Media.js +2 -2
- package/dist/models/MediaSelection.d.ts +2 -2
- package/dist/models/MediaSelection.js +2 -2
- package/dist/models/MediaType.d.ts +2 -2
- package/dist/models/MediaType.js +2 -2
- package/dist/models/MediaVisibility.d.ts +2 -2
- package/dist/models/MediaVisibility.js +2 -2
- package/dist/models/Member.d.ts +16 -5
- package/dist/models/Member.js +14 -5
- package/dist/models/MembersServiceUpdateBody.d.ts +16 -5
- package/dist/models/MembersServiceUpdateBody.js +14 -5
- package/dist/models/MessagePageNavigationType.d.ts +2 -2
- package/dist/models/MessagePageNavigationType.js +2 -2
- package/dist/models/MessagePagePayload.d.ts +2 -2
- package/dist/models/MessagePagePayload.js +2 -2
- package/dist/models/ModelHTTPMethod.d.ts +2 -2
- package/dist/models/ModelHTTPMethod.js +2 -2
- package/dist/models/Money.d.ts +2 -2
- package/dist/models/Money.js +2 -2
- package/dist/models/MultiLinkButton.d.ts +2 -2
- package/dist/models/MultiLinkButton.js +2 -2
- package/dist/models/MultiLinkPayload.d.ts +2 -2
- package/dist/models/MultiLinkPayload.js +2 -2
- package/dist/models/MultiLinkTraceButton.d.ts +2 -2
- package/dist/models/MultiLinkTraceButton.js +2 -2
- package/dist/models/MultiLinkTraceData.d.ts +2 -2
- package/dist/models/MultiLinkTraceData.js +2 -2
- package/dist/models/MultiLinkTraceSelectedButton.d.ts +2 -2
- package/dist/models/MultiLinkTraceSelectedButton.js +2 -2
- package/dist/models/OutputFileFormat.d.ts +2 -2
- package/dist/models/OutputFileFormat.js +2 -2
- package/dist/models/PageTheme.d.ts +2 -2
- package/dist/models/PageTheme.js +2 -2
- package/dist/models/PageThemeBadgeShape.d.ts +2 -2
- package/dist/models/PageThemeBadgeShape.js +2 -2
- package/dist/models/PageThemeBorderStyle.d.ts +2 -2
- package/dist/models/PageThemeBorderStyle.js +2 -2
- package/dist/models/PageThemeCanvasCoverMode.d.ts +2 -2
- package/dist/models/PageThemeCanvasCoverMode.js +2 -2
- package/dist/models/PageThemeContainerVariant.d.ts +2 -2
- package/dist/models/PageThemeContainerVariant.js +2 -2
- package/dist/models/PageThemeFontFamily.d.ts +2 -2
- package/dist/models/PageThemeFontFamily.js +2 -2
- package/dist/models/PageThemeStyling.d.ts +2 -2
- package/dist/models/PageThemeStyling.js +2 -2
- package/dist/models/PageThemeTemplate.d.ts +2 -2
- package/dist/models/PageThemeTemplate.js +2 -2
- package/dist/models/PageThemeTemplateImages.d.ts +2 -2
- package/dist/models/PageThemeTemplateImages.js +2 -2
- package/dist/models/PageThemeTemplateScope.d.ts +2 -2
- package/dist/models/PageThemeTemplateScope.js +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateBody.d.ts +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateBody.js +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.d.ts +2 -2
- package/dist/models/PageThemeTemplatesServiceUpdatePageThemeTemplateStylingBody.js +2 -2
- package/dist/models/PageThemesServiceUpdatePageThemeBody.d.ts +2 -2
- package/dist/models/PageThemesServiceUpdatePageThemeBody.js +2 -2
- package/dist/models/PasswordPayload.d.ts +2 -2
- package/dist/models/PasswordPayload.js +2 -2
- package/dist/models/PasswordTraceData.d.ts +2 -2
- package/dist/models/PasswordTraceData.js +2 -2
- package/dist/models/PlanFeature.d.ts +2 -2
- package/dist/models/PlanFeature.js +2 -2
- package/dist/models/PlanLimit.d.ts +2 -2
- package/dist/models/PlanLimit.js +2 -2
- package/dist/models/PlanLimitKey.d.ts +2 -2
- package/dist/models/PlanLimitKey.js +2 -2
- package/dist/models/PlanLimitKind.d.ts +2 -2
- package/dist/models/PlanLimitKind.js +2 -2
- package/dist/models/PlanPrice.d.ts +2 -2
- package/dist/models/PlanPrice.js +2 -2
- package/dist/models/PlanTrial.d.ts +2 -2
- package/dist/models/PlanTrial.js +2 -2
- package/dist/models/PreferredLinkType.d.ts +2 -2
- package/dist/models/PreferredLinkType.js +2 -2
- package/dist/models/PricingPlan.d.ts +5 -12
- package/dist/models/PricingPlan.js +2 -5
- package/dist/models/PricingPlanId.d.ts +3 -3
- package/dist/models/PricingPlanId.js +3 -3
- package/dist/models/ProtobufAny.d.ts +2 -2
- package/dist/models/ProtobufAny.js +2 -2
- package/dist/models/ProtobufNullValue.d.ts +2 -2
- package/dist/models/ProtobufNullValue.js +2 -2
- package/dist/models/PublicCreateQrcodeDesignRequest.d.ts +2 -2
- package/dist/models/PublicCreateQrcodeDesignRequest.js +2 -2
- package/dist/models/PublicCreateQrcodeDesignResponse.d.ts +2 -2
- package/dist/models/PublicCreateQrcodeDesignResponse.js +2 -2
- package/dist/models/PublicListPageThemeTemplatesResponse.d.ts +2 -2
- package/dist/models/PublicListPageThemeTemplatesResponse.js +2 -2
- package/dist/models/PublicListQrcodeTemplatesResponse.d.ts +2 -2
- package/dist/models/PublicListQrcodeTemplatesResponse.js +2 -2
- package/dist/models/PublicPageThemeTemplate.d.ts +2 -2
- package/dist/models/PublicPageThemeTemplate.js +2 -2
- package/dist/models/PublicQrcodeTemplate.d.ts +2 -2
- package/dist/models/PublicQrcodeTemplate.js +2 -2
- package/dist/models/PublicWorkspace.d.ts +2 -2
- package/dist/models/PublicWorkspace.js +2 -2
- package/dist/models/PublishPageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/PublishPageThemeTemplateResponse.js +2 -2
- package/dist/models/PublishQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/PublishQrcodeTemplateResponse.js +2 -2
- package/dist/models/QrcodeDesign.d.ts +2 -2
- package/dist/models/QrcodeDesign.js +2 -2
- package/dist/models/QrcodeDesignServiceUpdateBody.d.ts +2 -2
- package/dist/models/QrcodeDesignServiceUpdateBody.js +2 -2
- package/dist/models/QrcodeTemplate.d.ts +2 -2
- package/dist/models/QrcodeTemplate.js +2 -2
- package/dist/models/QrcodeTemplateScope.d.ts +2 -2
- package/dist/models/QrcodeTemplateScope.js +2 -2
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.d.ts +2 -2
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.js +2 -2
- package/dist/models/RedirectTraceData.d.ts +2 -2
- package/dist/models/RedirectTraceData.js +2 -2
- package/dist/models/RequestWorkspaceEnrollmentRequest.d.ts +2 -2
- package/dist/models/RequestWorkspaceEnrollmentRequest.js +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesRequest.d.ts +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesRequest.js +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesResponse.d.ts +2 -2
- package/dist/models/ResolvePageThemeTemplateImagesResponse.js +2 -2
- package/dist/models/ResolveQrcodeImagesRequest.d.ts +2 -2
- package/dist/models/ResolveQrcodeImagesRequest.js +2 -2
- package/dist/models/ResolveQrcodeImagesResponse.d.ts +2 -2
- package/dist/models/ResolveQrcodeImagesResponse.js +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesRequest.d.ts +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesRequest.js +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesResponse.d.ts +2 -2
- package/dist/models/ResolveQrcodeTemplateImagesResponse.js +2 -2
- package/dist/models/ResolveStepCollisionsResponse.d.ts +2 -2
- package/dist/models/ResolveStepCollisionsResponse.js +2 -2
- package/dist/models/ResponseFormat.d.ts +2 -2
- package/dist/models/ResponseFormat.js +2 -2
- package/dist/models/Role.d.ts +2 -2
- package/dist/models/Role.js +2 -2
- package/dist/models/Sandbox.d.ts +51 -0
- package/dist/models/Sandbox.js +52 -0
- package/dist/models/SettingsServiceUpdateLinkSettingBody.d.ts +2 -2
- package/dist/models/SettingsServiceUpdateLinkSettingBody.js +2 -2
- package/dist/models/Shape.d.ts +2 -2
- package/dist/models/Shape.js +2 -2
- package/dist/models/ShortlinkAvailabilityResponse.d.ts +2 -2
- package/dist/models/ShortlinkAvailabilityResponse.js +2 -2
- package/dist/models/ShortlinkRandomResponse.d.ts +2 -2
- package/dist/models/ShortlinkRandomResponse.js +2 -2
- package/dist/models/SlackChannel.d.ts +2 -2
- package/dist/models/SlackChannel.js +2 -2
- package/dist/models/SlackIntegration.d.ts +2 -2
- package/dist/models/SlackIntegration.js +2 -2
- package/dist/models/SlackIntegrationStatus.d.ts +2 -2
- package/dist/models/SlackIntegrationStatus.js +2 -2
- package/dist/models/SocialLinkButton.d.ts +2 -2
- package/dist/models/SocialLinkButton.js +2 -2
- package/dist/models/SocialLinkTraceButton.d.ts +2 -2
- package/dist/models/SocialLinkTraceButton.js +2 -2
- package/dist/models/SocialLinksDisplayStyle.d.ts +2 -2
- package/dist/models/SocialLinksDisplayStyle.js +2 -2
- package/dist/models/SocialLinksPayload.d.ts +2 -2
- package/dist/models/SocialLinksPayload.js +2 -2
- package/dist/models/SocialLinksTraceData.d.ts +2 -2
- package/dist/models/SocialLinksTraceData.js +2 -2
- package/dist/models/SocketAssistantErrorMessage.d.ts +2 -2
- package/dist/models/SocketAssistantErrorMessage.js +2 -2
- package/dist/models/SocketAssistantProgressMessage.d.ts +2 -2
- package/dist/models/SocketAssistantProgressMessage.js +2 -2
- package/dist/models/SocketAssistantResponseMessage.d.ts +2 -2
- package/dist/models/SocketAssistantResponseMessage.js +2 -2
- package/dist/models/SocketAssistantSendRequest.d.ts +2 -2
- package/dist/models/SocketAssistantSendRequest.js +2 -2
- package/dist/models/SocketConnectedMessage.d.ts +2 -2
- package/dist/models/SocketConnectedMessage.js +2 -2
- package/dist/models/SocketContract.d.ts +2 -2
- package/dist/models/SocketContract.js +2 -2
- package/dist/models/SocketErrorCode.d.ts +2 -2
- package/dist/models/SocketErrorCode.js +2 -2
- package/dist/models/SocketEventMessage.d.ts +2 -2
- package/dist/models/SocketEventMessage.js +2 -2
- package/dist/models/SocketMessageType.d.ts +2 -2
- package/dist/models/SocketMessageType.js +2 -2
- package/dist/models/SocketPingRequest.d.ts +2 -2
- package/dist/models/SocketPingRequest.js +2 -2
- package/dist/models/SocketPongMessage.d.ts +2 -2
- package/dist/models/SocketPongMessage.js +2 -2
- package/dist/models/SocketSubscribeDeniedMessage.d.ts +2 -2
- package/dist/models/SocketSubscribeDeniedMessage.js +2 -2
- package/dist/models/SocketSubscribeRequest.d.ts +2 -2
- package/dist/models/SocketSubscribeRequest.js +2 -2
- package/dist/models/SocketSubscribedMessage.d.ts +2 -2
- package/dist/models/SocketSubscribedMessage.js +2 -2
- package/dist/models/SocketUnsubscribeRequest.d.ts +2 -2
- package/dist/models/SocketUnsubscribeRequest.js +2 -2
- package/dist/models/SortDirection.d.ts +2 -2
- package/dist/models/SortDirection.js +2 -2
- package/dist/models/SpecificDateConditionPayload.d.ts +2 -2
- package/dist/models/SpecificDateConditionPayload.js +2 -2
- package/dist/models/SpecificDateConditionTraceData.d.ts +2 -2
- package/dist/models/SpecificDateConditionTraceData.js +2 -2
- package/dist/models/SpecificDateConditionTraceOption.d.ts +2 -2
- package/dist/models/SpecificDateConditionTraceOption.js +2 -2
- package/dist/models/SpecificDateOption.d.ts +2 -2
- package/dist/models/SpecificDateOption.js +2 -2
- package/dist/models/SubscriptionType.d.ts +2 -2
- package/dist/models/SubscriptionType.js +2 -2
- package/dist/models/SyncGoogleFormsResponse.d.ts +2 -2
- package/dist/models/SyncGoogleFormsResponse.js +2 -2
- package/dist/models/TestSlackIntegrationResponse.d.ts +2 -2
- package/dist/models/TestSlackIntegrationResponse.js +2 -2
- package/dist/models/ThankYouPagePayload.d.ts +2 -2
- package/dist/models/ThankYouPagePayload.js +2 -2
- package/dist/models/ThemeColor.d.ts +2 -2
- package/dist/models/ThemeColor.js +2 -2
- package/dist/models/ThemeColorThemeColorType.d.ts +2 -2
- package/dist/models/ThemeColorThemeColorType.js +2 -2
- package/dist/models/TimeOfDayConditionPayload.d.ts +2 -2
- package/dist/models/TimeOfDayConditionPayload.js +2 -2
- package/dist/models/TimeOfDayConditionTraceData.d.ts +2 -2
- package/dist/models/TimeOfDayConditionTraceData.js +2 -2
- package/dist/models/TimeOfDayConditionTraceRange.d.ts +2 -2
- package/dist/models/TimeOfDayConditionTraceRange.js +2 -2
- package/dist/models/TimeOfDayRange.d.ts +2 -2
- package/dist/models/TimeOfDayRange.js +2 -2
- package/dist/models/TimeSeriesPoint.d.ts +2 -2
- package/dist/models/TimeSeriesPoint.js +2 -2
- package/dist/models/TimeSeriesSeries.d.ts +2 -2
- package/dist/models/TimeSeriesSeries.js +2 -2
- package/dist/models/TopLinkDataPoint.d.ts +2 -2
- package/dist/models/TopLinkDataPoint.js +2 -2
- package/dist/models/TriggeredBy.d.ts +2 -2
- package/dist/models/TriggeredBy.js +2 -2
- package/dist/models/UpdateCustomDomainResponse.d.ts +2 -2
- package/dist/models/UpdateCustomDomainResponse.js +2 -2
- package/dist/models/UpdateDashboardResponse.d.ts +2 -2
- package/dist/models/UpdateDashboardResponse.js +2 -2
- package/dist/models/UpdateDeviceResponse.d.ts +2 -2
- package/dist/models/UpdateDeviceResponse.js +2 -2
- package/dist/models/UpdateDirectoryResponse.d.ts +2 -2
- package/dist/models/UpdateDirectoryResponse.js +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationRequest.d.ts +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationRequest.js +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationResponse.d.ts +2 -2
- package/dist/models/UpdateGoogleFormsIntegrationResponse.js +2 -2
- package/dist/models/UpdateLinkResponse.d.ts +2 -2
- package/dist/models/UpdateLinkResponse.js +2 -2
- package/dist/models/UpdateLinkSettingResponse.d.ts +2 -2
- package/dist/models/UpdateLinkSettingResponse.js +2 -2
- package/dist/models/UpdateMeRequest.d.ts +2 -2
- package/dist/models/UpdateMeRequest.js +2 -2
- package/dist/models/UpdatePageThemeResponse.d.ts +2 -2
- package/dist/models/UpdatePageThemeResponse.js +2 -2
- package/dist/models/UpdatePageThemeTemplateResponse.d.ts +2 -2
- package/dist/models/UpdatePageThemeTemplateResponse.js +2 -2
- package/dist/models/UpdatePageThemeTemplateStylingResponse.d.ts +2 -2
- package/dist/models/UpdatePageThemeTemplateStylingResponse.js +2 -2
- package/dist/models/UpdateQrcodeDesignResponse.d.ts +2 -2
- package/dist/models/UpdateQrcodeDesignResponse.js +2 -2
- package/dist/models/UpdateQrcodeTemplateResponse.d.ts +2 -2
- package/dist/models/UpdateQrcodeTemplateResponse.js +2 -2
- package/dist/models/UpdateSlackIntegrationRequest.d.ts +2 -2
- package/dist/models/UpdateSlackIntegrationRequest.js +2 -2
- package/dist/models/UpdateSlackIntegrationResponse.d.ts +2 -2
- package/dist/models/UpdateSlackIntegrationResponse.js +2 -2
- package/dist/models/UpdateWebhookResponse.d.ts +2 -2
- package/dist/models/UpdateWebhookResponse.js +2 -2
- package/dist/models/UpdateWorkflowStepResponse.d.ts +2 -2
- package/dist/models/UpdateWorkflowStepResponse.js +2 -2
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.d.ts +2 -2
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.js +2 -2
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.d.ts +2 -2
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.js +2 -2
- package/dist/models/UpdateWorkspaceRequest.d.ts +2 -2
- package/dist/models/UpdateWorkspaceRequest.js +2 -2
- package/dist/models/UpdateWorkspaceTokenResponse.d.ts +2 -2
- package/dist/models/UpdateWorkspaceTokenResponse.js +2 -2
- package/dist/models/VCardData.d.ts +2 -2
- package/dist/models/VCardData.js +2 -2
- package/dist/models/VCardPayload.d.ts +2 -2
- package/dist/models/VCardPayload.js +2 -2
- package/dist/models/VCardSocialLink.d.ts +2 -2
- package/dist/models/VCardSocialLink.js +2 -2
- package/dist/models/ValidateWorkflowResponse.d.ts +2 -2
- package/dist/models/ValidateWorkflowResponse.js +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponse.d.ts +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponse.js +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.d.ts +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.js +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.d.ts +2 -2
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.js +2 -2
- package/dist/models/ValidationPurpose.d.ts +2 -2
- package/dist/models/ValidationPurpose.js +2 -2
- package/dist/models/VisitType.d.ts +2 -2
- package/dist/models/VisitType.js +2 -2
- package/dist/models/VisitTypeConditionOption.d.ts +2 -2
- package/dist/models/VisitTypeConditionOption.js +2 -2
- package/dist/models/VisitTypeConditionPayload.d.ts +2 -2
- package/dist/models/VisitTypeConditionPayload.js +2 -2
- package/dist/models/VisitTypeConditionTraceData.d.ts +2 -2
- package/dist/models/VisitTypeConditionTraceData.js +2 -2
- package/dist/models/VisitTypeConditionTraceOption.d.ts +2 -2
- package/dist/models/VisitTypeConditionTraceOption.js +2 -2
- package/dist/models/Visitor.d.ts +2 -2
- package/dist/models/Visitor.js +2 -2
- package/dist/models/VisitorAttribute.d.ts +2 -2
- package/dist/models/VisitorAttribute.js +2 -2
- package/dist/models/VisitorAttributeFilter.d.ts +2 -2
- package/dist/models/VisitorAttributeFilter.js +2 -2
- package/dist/models/VisitorAttributeFilterOperator.d.ts +2 -2
- package/dist/models/VisitorAttributeFilterOperator.js +2 -2
- package/dist/models/VisitorAttributeKey.d.ts +2 -2
- package/dist/models/VisitorAttributeKey.js +2 -2
- package/dist/models/VisitorAttributeType.d.ts +2 -2
- package/dist/models/VisitorAttributeType.js +2 -2
- package/dist/models/VisitorDataConditionOption.d.ts +2 -2
- package/dist/models/VisitorDataConditionOption.js +2 -2
- package/dist/models/VisitorDataConditionPayload.d.ts +2 -2
- package/dist/models/VisitorDataConditionPayload.js +2 -2
- package/dist/models/VisitorDataConditionTraceData.d.ts +2 -2
- package/dist/models/VisitorDataConditionTraceData.js +2 -2
- package/dist/models/VisitorDataConditionTraceOption.d.ts +2 -2
- package/dist/models/VisitorDataConditionTraceOption.js +2 -2
- package/dist/models/VisitorEvent.d.ts +2 -2
- package/dist/models/VisitorEvent.js +2 -2
- package/dist/models/VisitorInput.d.ts +2 -2
- package/dist/models/VisitorInput.js +2 -2
- package/dist/models/VisitorLink.d.ts +2 -2
- package/dist/models/VisitorLink.js +2 -2
- package/dist/models/VisitorSortField.d.ts +2 -2
- package/dist/models/VisitorSortField.js +2 -2
- package/dist/models/VisitorTrendDataPoint.d.ts +2 -2
- package/dist/models/VisitorTrendDataPoint.js +2 -2
- package/dist/models/VisitorsServiceUpdateBody.d.ts +2 -2
- package/dist/models/VisitorsServiceUpdateBody.js +2 -2
- package/dist/models/Webhook.d.ts +2 -2
- package/dist/models/Webhook.js +2 -2
- package/dist/models/WebhookSource.d.ts +2 -2
- package/dist/models/WebhookSource.js +2 -2
- package/dist/models/WebhookStatus.d.ts +2 -2
- package/dist/models/WebhookStatus.js +2 -2
- package/dist/models/WebhooksServiceUpdateBody.d.ts +2 -2
- package/dist/models/WebhooksServiceUpdateBody.js +2 -2
- package/dist/models/WidgetDataSource.d.ts +2 -2
- package/dist/models/WidgetDataSource.js +2 -2
- package/dist/models/WidgetFieldMapping.d.ts +2 -2
- package/dist/models/WidgetFieldMapping.js +2 -2
- package/dist/models/WidgetPosition.d.ts +2 -2
- package/dist/models/WidgetPosition.js +2 -2
- package/dist/models/WidgetSize.d.ts +2 -2
- package/dist/models/WidgetSize.js +2 -2
- package/dist/models/WidgetTab.d.ts +2 -2
- package/dist/models/WidgetTab.js +2 -2
- package/dist/models/WidgetTabMode.d.ts +2 -2
- package/dist/models/WidgetTabMode.js +2 -2
- package/dist/models/WidgetTabView.d.ts +2 -2
- package/dist/models/WidgetTabView.js +2 -2
- package/dist/models/WidgetVisualization.d.ts +2 -2
- package/dist/models/WidgetVisualization.js +2 -2
- package/dist/models/WorkflowIssue.d.ts +2 -2
- package/dist/models/WorkflowIssue.js +2 -2
- package/dist/models/WorkflowStep.d.ts +2 -2
- package/dist/models/WorkflowStep.js +2 -2
- package/dist/models/WorkflowStepBranch.d.ts +2 -2
- package/dist/models/WorkflowStepBranch.js +2 -2
- package/dist/models/WorkflowStepKind.d.ts +2 -2
- package/dist/models/WorkflowStepKind.js +2 -2
- package/dist/models/WorkflowStepNodeType.d.ts +2 -2
- package/dist/models/WorkflowStepNodeType.js +2 -2
- package/dist/models/WorkflowStepPayload.d.ts +2 -2
- package/dist/models/WorkflowStepPayload.js +2 -2
- package/dist/models/WorkflowStepsServiceConnectStepBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceConnectStepBody.js +2 -2
- package/dist/models/WorkflowStepsServiceCreateBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceCreateBody.js +2 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.d.ts +2 -2
- package/dist/models/WorkflowStepsServiceUpdateBody.js +2 -2
- package/dist/models/Workspace.d.ts +15 -3
- package/dist/models/Workspace.js +4 -2
- package/dist/models/WorkspaceAllowance.d.ts +2 -2
- package/dist/models/WorkspaceAllowance.js +2 -2
- package/dist/models/WorkspaceInsight.d.ts +2 -2
- package/dist/models/WorkspaceInsight.js +2 -2
- package/dist/models/WorkspaceMetric.d.ts +2 -2
- package/dist/models/WorkspaceMetric.js +2 -2
- package/dist/models/WorkspaceToken.d.ts +54 -9
- package/dist/models/WorkspaceToken.js +49 -7
- package/dist/models/WorkspaceTokenKeyType.d.ts +2 -2
- package/dist/models/WorkspaceTokenKeyType.js +2 -2
- package/dist/models/WorkspaceTokensServiceUpdateBody.d.ts +40 -5
- package/dist/models/WorkspaceTokensServiceUpdateBody.js +40 -5
- package/dist/models/index.d.ts +13 -2
- package/dist/models/index.js +13 -2
- package/dist/runtime.d.ts +2 -2
- package/dist/runtime.js +2 -2
- package/package.json +1 -1
- package/dist/models/MeteredPrice.d.ts +0 -40
- package/dist/models/MeteredPrice.js +0 -52
- package/dist/models/MeteredUnit.d.ts +0 -32
- package/dist/models/MeteredUnit.js +0 -58
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Linkbreakers API
|
|
3
|
-
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
|
|
3
|
+
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.158.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -17,6 +17,7 @@ export interface SettingsServiceGetLinkSettingRequest {
|
|
|
17
17
|
export interface SettingsServiceUpdateLinkSettingRequest {
|
|
18
18
|
id: string;
|
|
19
19
|
settingsServiceUpdateLinkSettingBody: SettingsServiceUpdateLinkSettingBody;
|
|
20
|
+
idempotencyKey?: string;
|
|
20
21
|
}
|
|
21
22
|
/**
|
|
22
23
|
* LinkSettingsApi - interface
|
|
@@ -50,6 +51,7 @@ export interface LinkSettingsApiInterface {
|
|
|
50
51
|
* Creates request options for settingsServiceUpdateLinkSetting without sending the request
|
|
51
52
|
* @param {string} id The ID of the link setting to update (UUID)
|
|
52
53
|
* @param {SettingsServiceUpdateLinkSettingBody} settingsServiceUpdateLinkSettingBody
|
|
54
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
53
55
|
* @throws {RequiredError}
|
|
54
56
|
* @memberof LinkSettingsApiInterface
|
|
55
57
|
*/
|
|
@@ -59,6 +61,7 @@ export interface LinkSettingsApiInterface {
|
|
|
59
61
|
* @summary Update a link setting
|
|
60
62
|
* @param {string} id The ID of the link setting to update (UUID)
|
|
61
63
|
* @param {SettingsServiceUpdateLinkSettingBody} settingsServiceUpdateLinkSettingBody
|
|
64
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
62
65
|
* @param {*} [options] Override http request option.
|
|
63
66
|
* @throws {RequiredError}
|
|
64
67
|
* @memberof LinkSettingsApiInterface
|
|
@@ -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: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
|
|
6
|
+
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.158.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -112,6 +112,9 @@ class LinkSettingsApi extends runtime.BaseAPI {
|
|
|
112
112
|
const queryParameters = {};
|
|
113
113
|
const headerParameters = {};
|
|
114
114
|
headerParameters['Content-Type'] = 'application/json';
|
|
115
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
116
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
117
|
+
}
|
|
115
118
|
if (this.configuration && this.configuration.accessToken) {
|
|
116
119
|
// oauth required
|
|
117
120
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
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: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
|
|
3
|
+
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.158.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,18 +10,30 @@
|
|
|
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, CreateThankYouLinkRequest, CreateThankYouLinkResponse, GetLinkResponse, LinksServiceUpdateBody, ListLinksResponse, ResolveQrcodeImagesRequest, ResolveQrcodeImagesResponse, ShortlinkAvailabilityResponse, ShortlinkRandomResponse, UpdateLinkResponse } from '../models/index';
|
|
13
|
+
import type { CreateBulkLinksRequest, CreateBulkLinksResponse, CreateContactLinkRequest, CreateContactLinkResponse, CreateLinkRequest, CreateLinkResponse, CreateThankYouLinkRequest, CreateThankYouLinkResponse, GetLinkResponse, Job, LinksServiceUpdateBody, ListLinksResponse, ResolveQrcodeImagesRequest, ResolveQrcodeImagesResponse, ShortlinkAvailabilityResponse, ShortlinkRandomResponse, UpdateLinkResponse } from '../models/index';
|
|
14
14
|
export interface LinksServiceCreateRequest {
|
|
15
15
|
createLinkRequest: CreateLinkRequest;
|
|
16
|
+
idempotencyKey?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface LinksServiceCreateBatchRequest {
|
|
19
|
+
createLinkRequest: Array<CreateLinkRequest>;
|
|
20
|
+
idempotencyKey?: string;
|
|
16
21
|
}
|
|
17
22
|
export interface LinksServiceCreateBulkRequest {
|
|
18
23
|
createBulkLinksRequest: CreateBulkLinksRequest;
|
|
24
|
+
idempotencyKey?: string;
|
|
25
|
+
}
|
|
26
|
+
export interface LinksServiceCreateBulkAsyncRequest {
|
|
27
|
+
createBulkLinksRequest: CreateBulkLinksRequest;
|
|
28
|
+
idempotencyKey?: string;
|
|
19
29
|
}
|
|
20
30
|
export interface LinksServiceCreateContactLinkRequest {
|
|
21
31
|
createContactLinkRequest: CreateContactLinkRequest;
|
|
32
|
+
idempotencyKey?: string;
|
|
22
33
|
}
|
|
23
34
|
export interface LinksServiceCreateThankYouLinkRequest {
|
|
24
35
|
createThankYouLinkRequest: CreateThankYouLinkRequest;
|
|
36
|
+
idempotencyKey?: string;
|
|
25
37
|
}
|
|
26
38
|
export interface LinksServiceDeleteRequest {
|
|
27
39
|
id: string;
|
|
@@ -40,9 +52,11 @@ export interface LinksServiceListRequest {
|
|
|
40
52
|
sortDirection?: string;
|
|
41
53
|
view?: string;
|
|
42
54
|
directoryId?: string;
|
|
55
|
+
cursor?: string;
|
|
43
56
|
}
|
|
44
57
|
export interface LinksServiceResolveQrcodeImagesRequest {
|
|
45
58
|
resolveQrcodeImagesRequest: ResolveQrcodeImagesRequest;
|
|
59
|
+
idempotencyKey?: string;
|
|
46
60
|
}
|
|
47
61
|
export interface LinksServiceShortlinkAvailabilityRequest {
|
|
48
62
|
shortlink?: string;
|
|
@@ -51,6 +65,7 @@ export interface LinksServiceShortlinkAvailabilityRequest {
|
|
|
51
65
|
export interface LinksServiceUpdateRequest {
|
|
52
66
|
id: string;
|
|
53
67
|
linksServiceUpdateBody: LinksServiceUpdateBody;
|
|
68
|
+
idempotencyKey?: string;
|
|
54
69
|
}
|
|
55
70
|
/**
|
|
56
71
|
* LinksApi - interface
|
|
@@ -62,6 +77,7 @@ export interface LinksApiInterface {
|
|
|
62
77
|
/**
|
|
63
78
|
* Creates request options for linksServiceCreate without sending the request
|
|
64
79
|
* @param {CreateLinkRequest} createLinkRequest
|
|
80
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
65
81
|
* @throws {RequiredError}
|
|
66
82
|
* @memberof LinksApiInterface
|
|
67
83
|
*/
|
|
@@ -70,6 +86,7 @@ export interface LinksApiInterface {
|
|
|
70
86
|
* This endpoint allows users to create a new shortened URL link in their Linkbreakers workspace. The URL will be checked for malicious content before being shortened. Requires the `links:write` scope.
|
|
71
87
|
* @summary Create a new link
|
|
72
88
|
* @param {CreateLinkRequest} createLinkRequest
|
|
89
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
73
90
|
* @param {*} [options] Override http request option.
|
|
74
91
|
* @throws {RequiredError}
|
|
75
92
|
* @memberof LinksApiInterface
|
|
@@ -80,9 +97,33 @@ export interface LinksApiInterface {
|
|
|
80
97
|
* Create a new link
|
|
81
98
|
*/
|
|
82
99
|
linksServiceCreate(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLinkResponse>;
|
|
100
|
+
/**
|
|
101
|
+
* Creates request options for linksServiceCreateBatch without sending the request
|
|
102
|
+
* @param {Array<CreateLinkRequest>} createLinkRequest
|
|
103
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
* @memberof LinksApiInterface
|
|
106
|
+
*/
|
|
107
|
+
linksServiceCreateBatchRequestOpts(requestParameters: LinksServiceCreateBatchRequest): Promise<runtime.RequestOpts>;
|
|
108
|
+
/**
|
|
109
|
+
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
110
|
+
* @summary Create multiple links in a single request
|
|
111
|
+
* @param {Array<CreateLinkRequest>} createLinkRequest
|
|
112
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
* @memberof LinksApiInterface
|
|
116
|
+
*/
|
|
117
|
+
linksServiceCreateBatchRaw(requestParameters: LinksServiceCreateBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBulkLinksResponse>>;
|
|
118
|
+
/**
|
|
119
|
+
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
120
|
+
* Create multiple links in a single request
|
|
121
|
+
*/
|
|
122
|
+
linksServiceCreateBatch(requestParameters: LinksServiceCreateBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
|
|
83
123
|
/**
|
|
84
124
|
* Creates request options for linksServiceCreateBulk without sending the request
|
|
85
125
|
* @param {CreateBulkLinksRequest} createBulkLinksRequest
|
|
126
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
86
127
|
* @throws {RequiredError}
|
|
87
128
|
* @memberof LinksApiInterface
|
|
88
129
|
*/
|
|
@@ -91,6 +132,7 @@ export interface LinksApiInterface {
|
|
|
91
132
|
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
92
133
|
* @summary Create multiple links in a single request
|
|
93
134
|
* @param {CreateBulkLinksRequest} createBulkLinksRequest
|
|
135
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
94
136
|
* @param {*} [options] Override http request option.
|
|
95
137
|
* @throws {RequiredError}
|
|
96
138
|
* @memberof LinksApiInterface
|
|
@@ -101,9 +143,33 @@ export interface LinksApiInterface {
|
|
|
101
143
|
* Create multiple links in a single request
|
|
102
144
|
*/
|
|
103
145
|
linksServiceCreateBulk(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
|
|
146
|
+
/**
|
|
147
|
+
* Creates request options for linksServiceCreateBulkAsync without sending the request
|
|
148
|
+
* @param {CreateBulkLinksRequest} createBulkLinksRequest
|
|
149
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
* @memberof LinksApiInterface
|
|
152
|
+
*/
|
|
153
|
+
linksServiceCreateBulkAsyncRequestOpts(requestParameters: LinksServiceCreateBulkAsyncRequest): Promise<runtime.RequestOpts>;
|
|
154
|
+
/**
|
|
155
|
+
* Accepts the same batch as POST /v1/links/bulk, answers 202 Accepted at once with a job and a Location header, and creates the links in the background. Poll GET /v1/jobs/{id} for the result. The batch is transactional: when the job fails, no link was created. Requires the `links:write` scope.
|
|
156
|
+
* @summary Create links in bulk in the background
|
|
157
|
+
* @param {CreateBulkLinksRequest} createBulkLinksRequest
|
|
158
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
* @memberof LinksApiInterface
|
|
162
|
+
*/
|
|
163
|
+
linksServiceCreateBulkAsyncRaw(requestParameters: LinksServiceCreateBulkAsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Job>>;
|
|
164
|
+
/**
|
|
165
|
+
* Accepts the same batch as POST /v1/links/bulk, answers 202 Accepted at once with a job and a Location header, and creates the links in the background. Poll GET /v1/jobs/{id} for the result. The batch is transactional: when the job fails, no link was created. Requires the `links:write` scope.
|
|
166
|
+
* Create links in bulk in the background
|
|
167
|
+
*/
|
|
168
|
+
linksServiceCreateBulkAsync(requestParameters: LinksServiceCreateBulkAsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Job>;
|
|
104
169
|
/**
|
|
105
170
|
* Creates request options for linksServiceCreateContactLink without sending the request
|
|
106
171
|
* @param {CreateContactLinkRequest} createContactLinkRequest
|
|
172
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
107
173
|
* @throws {RequiredError}
|
|
108
174
|
* @memberof LinksApiInterface
|
|
109
175
|
*/
|
|
@@ -112,6 +178,7 @@ export interface LinksApiInterface {
|
|
|
112
178
|
* This endpoint allows users to create a new vCard contact link in their Linkbreakers workspace. The link will generate a vCard file for contact information sharing. Requires the `links:write` scope.
|
|
113
179
|
* @summary Create a new contact card link
|
|
114
180
|
* @param {CreateContactLinkRequest} createContactLinkRequest
|
|
181
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
115
182
|
* @param {*} [options] Override http request option.
|
|
116
183
|
* @throws {RequiredError}
|
|
117
184
|
* @memberof LinksApiInterface
|
|
@@ -125,6 +192,7 @@ export interface LinksApiInterface {
|
|
|
125
192
|
/**
|
|
126
193
|
* Creates request options for linksServiceCreateThankYouLink without sending the request
|
|
127
194
|
* @param {CreateThankYouLinkRequest} createThankYouLinkRequest
|
|
195
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
128
196
|
* @throws {RequiredError}
|
|
129
197
|
* @memberof LinksApiInterface
|
|
130
198
|
*/
|
|
@@ -133,6 +201,7 @@ export interface LinksApiInterface {
|
|
|
133
201
|
* This endpoint allows users to create a new link with a thank you page as the exit step. Requires the `links:write` scope.
|
|
134
202
|
* @summary Create a new thank you page link
|
|
135
203
|
* @param {CreateThankYouLinkRequest} createThankYouLinkRequest
|
|
204
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
136
205
|
* @param {*} [options] Override http request option.
|
|
137
206
|
* @throws {RequiredError}
|
|
138
207
|
* @memberof LinksApiInterface
|
|
@@ -198,6 +267,7 @@ export interface LinksApiInterface {
|
|
|
198
267
|
* @param {string} [sortDirection] Sort direction (defaults to descending if not specified) Sort direction (ascending or descending) - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending) - SORT_DIRECTION_ASC: Sort in ascending order - SORT_DIRECTION_DESC: Sort in descending order
|
|
199
268
|
* @param {string} [view] View mode. Default returns all links. LINK_VIEW_DIRECTORY scopes to a directory (or root when directory_id is empty). - LINK_VIEW_UNSPECIFIED: Return all links regardless of directory (default) - LINK_VIEW_DIRECTORY: Return links scoped to a directory. When directory_id is set, returns links in that directory. When directory_id is empty, returns root-level links (no directory).
|
|
200
269
|
* @param {string} [directoryId] Directory ID to scope to when view is LINK_VIEW_DIRECTORY. When empty with LINK_VIEW_DIRECTORY, returns root-level links.
|
|
270
|
+
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
201
271
|
* @throws {RequiredError}
|
|
202
272
|
* @memberof LinksApiInterface
|
|
203
273
|
*/
|
|
@@ -214,6 +284,7 @@ export interface LinksApiInterface {
|
|
|
214
284
|
* @param {string} [sortDirection] Sort direction (defaults to descending if not specified) Sort direction (ascending or descending) - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending) - SORT_DIRECTION_ASC: Sort in ascending order - SORT_DIRECTION_DESC: Sort in descending order
|
|
215
285
|
* @param {string} [view] View mode. Default returns all links. LINK_VIEW_DIRECTORY scopes to a directory (or root when directory_id is empty). - LINK_VIEW_UNSPECIFIED: Return all links regardless of directory (default) - LINK_VIEW_DIRECTORY: Return links scoped to a directory. When directory_id is set, returns links in that directory. When directory_id is empty, returns root-level links (no directory).
|
|
216
286
|
* @param {string} [directoryId] Directory ID to scope to when view is LINK_VIEW_DIRECTORY. When empty with LINK_VIEW_DIRECTORY, returns root-level links.
|
|
287
|
+
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
217
288
|
* @param {*} [options] Override http request option.
|
|
218
289
|
* @throws {RequiredError}
|
|
219
290
|
* @memberof LinksApiInterface
|
|
@@ -227,6 +298,7 @@ export interface LinksApiInterface {
|
|
|
227
298
|
/**
|
|
228
299
|
* Creates request options for linksServiceResolveQrcodeImages without sending the request
|
|
229
300
|
* @param {ResolveQrcodeImagesRequest} resolveQrcodeImagesRequest
|
|
301
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
230
302
|
* @throws {RequiredError}
|
|
231
303
|
* @memberof LinksApiInterface
|
|
232
304
|
*/
|
|
@@ -235,6 +307,7 @@ export interface LinksApiInterface {
|
|
|
235
307
|
* Return freshly signed QR code image URLs for the given links. The URLs expire, so callers fetch them when they need to render rather than storing them. Requires the `links:read` scope.
|
|
236
308
|
* @summary Resolve QR code image URLs
|
|
237
309
|
* @param {ResolveQrcodeImagesRequest} resolveQrcodeImagesRequest
|
|
310
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
238
311
|
* @param {*} [options] Override http request option.
|
|
239
312
|
* @throws {RequiredError}
|
|
240
313
|
* @memberof LinksApiInterface
|
|
@@ -291,6 +364,7 @@ export interface LinksApiInterface {
|
|
|
291
364
|
* Creates request options for linksServiceUpdate without sending the request
|
|
292
365
|
* @param {string} id The ID of the link to update (UUID)
|
|
293
366
|
* @param {LinksServiceUpdateBody} linksServiceUpdateBody
|
|
367
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
294
368
|
* @throws {RequiredError}
|
|
295
369
|
* @memberof LinksApiInterface
|
|
296
370
|
*/
|
|
@@ -300,6 +374,7 @@ export interface LinksApiInterface {
|
|
|
300
374
|
* @summary Update a link
|
|
301
375
|
* @param {string} id The ID of the link to update (UUID)
|
|
302
376
|
* @param {LinksServiceUpdateBody} linksServiceUpdateBody
|
|
377
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
303
378
|
* @param {*} [options] Override http request option.
|
|
304
379
|
* @throws {RequiredError}
|
|
305
380
|
* @memberof LinksApiInterface
|
|
@@ -329,6 +404,20 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
|
|
|
329
404
|
* Create a new link
|
|
330
405
|
*/
|
|
331
406
|
linksServiceCreate(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLinkResponse>;
|
|
407
|
+
/**
|
|
408
|
+
* Creates request options for linksServiceCreateBatch without sending the request
|
|
409
|
+
*/
|
|
410
|
+
linksServiceCreateBatchRequestOpts(requestParameters: LinksServiceCreateBatchRequest): Promise<runtime.RequestOpts>;
|
|
411
|
+
/**
|
|
412
|
+
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
413
|
+
* Create multiple links in a single request
|
|
414
|
+
*/
|
|
415
|
+
linksServiceCreateBatchRaw(requestParameters: LinksServiceCreateBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBulkLinksResponse>>;
|
|
416
|
+
/**
|
|
417
|
+
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
418
|
+
* Create multiple links in a single request
|
|
419
|
+
*/
|
|
420
|
+
linksServiceCreateBatch(requestParameters: LinksServiceCreateBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
|
|
332
421
|
/**
|
|
333
422
|
* Creates request options for linksServiceCreateBulk without sending the request
|
|
334
423
|
*/
|
|
@@ -343,6 +432,20 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
|
|
|
343
432
|
* Create multiple links in a single request
|
|
344
433
|
*/
|
|
345
434
|
linksServiceCreateBulk(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
|
|
435
|
+
/**
|
|
436
|
+
* Creates request options for linksServiceCreateBulkAsync without sending the request
|
|
437
|
+
*/
|
|
438
|
+
linksServiceCreateBulkAsyncRequestOpts(requestParameters: LinksServiceCreateBulkAsyncRequest): Promise<runtime.RequestOpts>;
|
|
439
|
+
/**
|
|
440
|
+
* Accepts the same batch as POST /v1/links/bulk, answers 202 Accepted at once with a job and a Location header, and creates the links in the background. Poll GET /v1/jobs/{id} for the result. The batch is transactional: when the job fails, no link was created. Requires the `links:write` scope.
|
|
441
|
+
* Create links in bulk in the background
|
|
442
|
+
*/
|
|
443
|
+
linksServiceCreateBulkAsyncRaw(requestParameters: LinksServiceCreateBulkAsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Job>>;
|
|
444
|
+
/**
|
|
445
|
+
* Accepts the same batch as POST /v1/links/bulk, answers 202 Accepted at once with a job and a Location header, and creates the links in the background. Poll GET /v1/jobs/{id} for the result. The batch is transactional: when the job fails, no link was created. Requires the `links:write` scope.
|
|
446
|
+
* Create links in bulk in the background
|
|
447
|
+
*/
|
|
448
|
+
linksServiceCreateBulkAsync(requestParameters: LinksServiceCreateBulkAsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Job>;
|
|
346
449
|
/**
|
|
347
450
|
* Creates request options for linksServiceCreateContactLink without sending the request
|
|
348
451
|
*/
|
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: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
|
|
6
|
+
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.158.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -63,6 +63,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
63
63
|
const queryParameters = {};
|
|
64
64
|
const headerParameters = {};
|
|
65
65
|
headerParameters['Content-Type'] = 'application/json';
|
|
66
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
67
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
68
|
+
}
|
|
66
69
|
if (this.configuration && this.configuration.accessToken) {
|
|
67
70
|
// oauth required
|
|
68
71
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
@@ -100,6 +103,56 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
100
103
|
const response = await this.linksServiceCreateRaw(requestParameters, initOverrides);
|
|
101
104
|
return await response.value();
|
|
102
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Creates request options for linksServiceCreateBatch without sending the request
|
|
108
|
+
*/
|
|
109
|
+
async linksServiceCreateBatchRequestOpts(requestParameters) {
|
|
110
|
+
if (requestParameters['createLinkRequest'] == null) {
|
|
111
|
+
throw new runtime.RequiredError('createLinkRequest', 'Required parameter "createLinkRequest" was null or undefined when calling linksServiceCreateBatch().');
|
|
112
|
+
}
|
|
113
|
+
const queryParameters = {};
|
|
114
|
+
const headerParameters = {};
|
|
115
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
116
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
117
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
118
|
+
}
|
|
119
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
120
|
+
// oauth required
|
|
121
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
122
|
+
}
|
|
123
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
124
|
+
const token = this.configuration.accessToken;
|
|
125
|
+
const tokenString = await token("bearerAuth", ["links:write"]);
|
|
126
|
+
if (tokenString) {
|
|
127
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
let urlPath = `/v1/links/batch`;
|
|
131
|
+
return {
|
|
132
|
+
path: urlPath,
|
|
133
|
+
method: 'POST',
|
|
134
|
+
headers: headerParameters,
|
|
135
|
+
query: queryParameters,
|
|
136
|
+
body: requestParameters['createLinkRequest'].map(index_1.CreateLinkRequestToJSON),
|
|
137
|
+
};
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
141
|
+
* Create multiple links in a single request
|
|
142
|
+
*/
|
|
143
|
+
async linksServiceCreateBatchRaw(requestParameters, initOverrides) {
|
|
144
|
+
const requestOptions = await this.linksServiceCreateBatchRequestOpts(requestParameters);
|
|
145
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
146
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateBulkLinksResponseFromJSON)(jsonValue));
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created. Requires the `links:write` scope.
|
|
150
|
+
* Create multiple links in a single request
|
|
151
|
+
*/
|
|
152
|
+
async linksServiceCreateBatch(requestParameters, initOverrides) {
|
|
153
|
+
const response = await this.linksServiceCreateBatchRaw(requestParameters, initOverrides);
|
|
154
|
+
return await response.value();
|
|
155
|
+
}
|
|
103
156
|
/**
|
|
104
157
|
* Creates request options for linksServiceCreateBulk without sending the request
|
|
105
158
|
*/
|
|
@@ -110,6 +163,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
110
163
|
const queryParameters = {};
|
|
111
164
|
const headerParameters = {};
|
|
112
165
|
headerParameters['Content-Type'] = 'application/json';
|
|
166
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
167
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
168
|
+
}
|
|
113
169
|
if (this.configuration && this.configuration.accessToken) {
|
|
114
170
|
// oauth required
|
|
115
171
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
@@ -147,6 +203,56 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
147
203
|
const response = await this.linksServiceCreateBulkRaw(requestParameters, initOverrides);
|
|
148
204
|
return await response.value();
|
|
149
205
|
}
|
|
206
|
+
/**
|
|
207
|
+
* Creates request options for linksServiceCreateBulkAsync without sending the request
|
|
208
|
+
*/
|
|
209
|
+
async linksServiceCreateBulkAsyncRequestOpts(requestParameters) {
|
|
210
|
+
if (requestParameters['createBulkLinksRequest'] == null) {
|
|
211
|
+
throw new runtime.RequiredError('createBulkLinksRequest', 'Required parameter "createBulkLinksRequest" was null or undefined when calling linksServiceCreateBulkAsync().');
|
|
212
|
+
}
|
|
213
|
+
const queryParameters = {};
|
|
214
|
+
const headerParameters = {};
|
|
215
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
216
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
217
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
218
|
+
}
|
|
219
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
220
|
+
// oauth required
|
|
221
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
222
|
+
}
|
|
223
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
224
|
+
const token = this.configuration.accessToken;
|
|
225
|
+
const tokenString = await token("bearerAuth", ["links:write"]);
|
|
226
|
+
if (tokenString) {
|
|
227
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
let urlPath = `/v1/links/bulk/jobs`;
|
|
231
|
+
return {
|
|
232
|
+
path: urlPath,
|
|
233
|
+
method: 'POST',
|
|
234
|
+
headers: headerParameters,
|
|
235
|
+
query: queryParameters,
|
|
236
|
+
body: (0, index_1.CreateBulkLinksRequestToJSON)(requestParameters['createBulkLinksRequest']),
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Accepts the same batch as POST /v1/links/bulk, answers 202 Accepted at once with a job and a Location header, and creates the links in the background. Poll GET /v1/jobs/{id} for the result. The batch is transactional: when the job fails, no link was created. Requires the `links:write` scope.
|
|
241
|
+
* Create links in bulk in the background
|
|
242
|
+
*/
|
|
243
|
+
async linksServiceCreateBulkAsyncRaw(requestParameters, initOverrides) {
|
|
244
|
+
const requestOptions = await this.linksServiceCreateBulkAsyncRequestOpts(requestParameters);
|
|
245
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
246
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JobFromJSON)(jsonValue));
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Accepts the same batch as POST /v1/links/bulk, answers 202 Accepted at once with a job and a Location header, and creates the links in the background. Poll GET /v1/jobs/{id} for the result. The batch is transactional: when the job fails, no link was created. Requires the `links:write` scope.
|
|
250
|
+
* Create links in bulk in the background
|
|
251
|
+
*/
|
|
252
|
+
async linksServiceCreateBulkAsync(requestParameters, initOverrides) {
|
|
253
|
+
const response = await this.linksServiceCreateBulkAsyncRaw(requestParameters, initOverrides);
|
|
254
|
+
return await response.value();
|
|
255
|
+
}
|
|
150
256
|
/**
|
|
151
257
|
* Creates request options for linksServiceCreateContactLink without sending the request
|
|
152
258
|
*/
|
|
@@ -157,6 +263,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
157
263
|
const queryParameters = {};
|
|
158
264
|
const headerParameters = {};
|
|
159
265
|
headerParameters['Content-Type'] = 'application/json';
|
|
266
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
267
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
268
|
+
}
|
|
160
269
|
if (this.configuration && this.configuration.accessToken) {
|
|
161
270
|
// oauth required
|
|
162
271
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
@@ -204,6 +313,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
204
313
|
const queryParameters = {};
|
|
205
314
|
const headerParameters = {};
|
|
206
315
|
headerParameters['Content-Type'] = 'application/json';
|
|
316
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
317
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
318
|
+
}
|
|
207
319
|
if (this.configuration && this.configuration.accessToken) {
|
|
208
320
|
// oauth required
|
|
209
321
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
|
@@ -371,6 +483,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
371
483
|
if (requestParameters['directoryId'] != null) {
|
|
372
484
|
queryParameters['directoryId'] = requestParameters['directoryId'];
|
|
373
485
|
}
|
|
486
|
+
if (requestParameters['cursor'] != null) {
|
|
487
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
488
|
+
}
|
|
374
489
|
const headerParameters = {};
|
|
375
490
|
if (this.configuration && this.configuration.accessToken) {
|
|
376
491
|
// oauth required
|
|
@@ -418,6 +533,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
418
533
|
const queryParameters = {};
|
|
419
534
|
const headerParameters = {};
|
|
420
535
|
headerParameters['Content-Type'] = 'application/json';
|
|
536
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
537
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
538
|
+
}
|
|
421
539
|
if (this.configuration && this.configuration.accessToken) {
|
|
422
540
|
// oauth required
|
|
423
541
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:read"]);
|
|
@@ -558,6 +676,9 @@ class LinksApi extends runtime.BaseAPI {
|
|
|
558
676
|
const queryParameters = {};
|
|
559
677
|
const headerParameters = {};
|
|
560
678
|
headerParameters['Content-Type'] = 'application/json';
|
|
679
|
+
if (requestParameters['idempotencyKey'] != null) {
|
|
680
|
+
headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
|
|
681
|
+
}
|
|
561
682
|
if (this.configuration && this.configuration.accessToken) {
|
|
562
683
|
// oauth required
|
|
563
684
|
headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
|
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: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
|
|
3
|
+
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.158.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,6 +13,7 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import type { CreateMediaRequest, CreateMediaResponse, GetMediaResponse, ListMediaResponse } from '../models/index';
|
|
14
14
|
export interface MediaServiceCreateRequest {
|
|
15
15
|
createMediaRequest: CreateMediaRequest;
|
|
16
|
+
idempotencyKey?: string;
|
|
16
17
|
}
|
|
17
18
|
export interface MediaServiceDeleteRequest {
|
|
18
19
|
id: string;
|
|
@@ -23,6 +24,7 @@ export interface MediaServiceGetRequest {
|
|
|
23
24
|
export interface MediaServiceListRequest {
|
|
24
25
|
pageSize: number;
|
|
25
26
|
pageToken?: string;
|
|
27
|
+
cursor?: string;
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
28
30
|
* MediaApi - interface
|
|
@@ -34,6 +36,7 @@ export interface MediaApiInterface {
|
|
|
34
36
|
/**
|
|
35
37
|
* Creates request options for mediaServiceCreate without sending the request
|
|
36
38
|
* @param {CreateMediaRequest} createMediaRequest
|
|
39
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
37
40
|
* @throws {RequiredError}
|
|
38
41
|
* @memberof MediaApiInterface
|
|
39
42
|
*/
|
|
@@ -42,6 +45,7 @@ export interface MediaApiInterface {
|
|
|
42
45
|
* This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code. Requires the `media:write` scope.
|
|
43
46
|
* @summary Upload a media file
|
|
44
47
|
* @param {CreateMediaRequest} createMediaRequest
|
|
48
|
+
* @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
|
|
45
49
|
* @param {*} [options] Override http request option.
|
|
46
50
|
* @throws {RequiredError}
|
|
47
51
|
* @memberof MediaApiInterface
|
|
@@ -98,6 +102,7 @@ export interface MediaApiInterface {
|
|
|
98
102
|
* Creates request options for mediaServiceList without sending the request
|
|
99
103
|
* @param {number} pageSize The maximum number of media files to return.
|
|
100
104
|
* @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
|
|
105
|
+
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
101
106
|
* @throws {RequiredError}
|
|
102
107
|
* @memberof MediaApiInterface
|
|
103
108
|
*/
|
|
@@ -107,6 +112,7 @@ export interface MediaApiInterface {
|
|
|
107
112
|
* @summary List media files
|
|
108
113
|
* @param {number} pageSize The maximum number of media files to return.
|
|
109
114
|
* @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
|
|
115
|
+
* @param {string} [cursor] Opaque cursor from the previous page\'s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
|
|
110
116
|
* @param {*} [options] Override http request option.
|
|
111
117
|
* @throws {RequiredError}
|
|
112
118
|
* @memberof MediaApiInterface
|