linkbreakers 1.34.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/LICENSE +21 -0
- package/README.md +87 -0
- package/dist/apis/CustomDomainsApi.d.ts +254 -0
- package/dist/apis/CustomDomainsApi.js +309 -0
- package/dist/apis/EventsApi.d.ts +161 -0
- package/dist/apis/EventsApi.js +205 -0
- package/dist/apis/IntegrationsServiceApi.d.ts +60 -0
- package/dist/apis/IntegrationsServiceApi.js +96 -0
- package/dist/apis/LinkSettingsApi.d.ts +105 -0
- package/dist/apis/LinkSettingsApi.js +146 -0
- package/dist/apis/LinksApi.d.ts +431 -0
- package/dist/apis/LinksApi.js +510 -0
- package/dist/apis/MediaApi.d.ts +181 -0
- package/dist/apis/MediaApi.js +231 -0
- package/dist/apis/MembersApi.d.ts +408 -0
- package/dist/apis/MembersApi.js +491 -0
- package/dist/apis/PageThemesApi.d.ts +138 -0
- package/dist/apis/PageThemesApi.js +184 -0
- package/dist/apis/QRCodeDesignsApi.d.ts +181 -0
- package/dist/apis/QRCodeDesignsApi.js +231 -0
- package/dist/apis/QRCodeTemplatesApi.d.ts +401 -0
- package/dist/apis/QRCodeTemplatesApi.js +472 -0
- package/dist/apis/TagsApi.d.ts +108 -0
- package/dist/apis/TagsApi.js +151 -0
- package/dist/apis/TimeSeriesApi.d.ts +61 -0
- package/dist/apis/TimeSeriesApi.js +98 -0
- package/dist/apis/VisitorsApi.d.ts +281 -0
- package/dist/apis/VisitorsApi.js +339 -0
- package/dist/apis/WebhooksApi.d.ts +219 -0
- package/dist/apis/WebhooksApi.js +272 -0
- package/dist/apis/WorkflowStepsApi.d.ts +325 -0
- package/dist/apis/WorkflowStepsApi.js +396 -0
- package/dist/apis/WorkspaceMetricsApi.d.ts +136 -0
- package/dist/apis/WorkspaceMetricsApi.js +180 -0
- package/dist/apis/WorkspaceTokensApi.d.ts +173 -0
- package/dist/apis/WorkspaceTokensApi.js +222 -0
- package/dist/apis/WorkspacesApi.d.ts +320 -0
- package/dist/apis/WorkspacesApi.js +389 -0
- package/dist/apis/index.d.ts +18 -0
- package/dist/apis/index.js +36 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/Action.d.ts +28 -0
- package/dist/models/Action.js +54 -0
- package/dist/models/AddWorkflowStepRelationshipResponse.d.ts +32 -0
- package/dist/models/AddWorkflowStepRelationshipResponse.js +48 -0
- package/dist/models/ApiTag.d.ts +51 -0
- package/dist/models/ApiTag.js +52 -0
- package/dist/models/BackgroundOptions.d.ts +33 -0
- package/dist/models/BackgroundOptions.js +49 -0
- package/dist/models/CanvasPosition.d.ts +38 -0
- package/dist/models/CanvasPosition.js +50 -0
- package/dist/models/CheckCustomDomainResponse.d.ts +33 -0
- package/dist/models/CheckCustomDomainResponse.js +49 -0
- package/dist/models/ClientRedirectPayload.d.ts +38 -0
- package/dist/models/ClientRedirectPayload.js +50 -0
- package/dist/models/ContactCardTraceCard.d.ts +104 -0
- package/dist/models/ContactCardTraceCard.js +72 -0
- package/dist/models/ContactCardTraceData.d.ts +33 -0
- package/dist/models/ContactCardTraceData.js +49 -0
- package/dist/models/ContainerConfig.d.ts +85 -0
- package/dist/models/ContainerConfig.js +80 -0
- package/dist/models/CornersDotOptions.d.ts +39 -0
- package/dist/models/CornersDotOptions.js +51 -0
- package/dist/models/CornersSquareOptions.d.ts +39 -0
- package/dist/models/CornersSquareOptions.js +51 -0
- package/dist/models/CountryConditionOutcome.d.ts +38 -0
- package/dist/models/CountryConditionOutcome.js +50 -0
- package/dist/models/CountryConditionPayload.d.ts +39 -0
- package/dist/models/CountryConditionPayload.js +51 -0
- package/dist/models/CountryConditionTraceData.d.ts +39 -0
- package/dist/models/CountryConditionTraceData.js +51 -0
- package/dist/models/CountryConditionTraceOption.d.ts +38 -0
- package/dist/models/CountryConditionTraceOption.js +50 -0
- package/dist/models/CreateBulkLinksRequest.d.ts +34 -0
- package/dist/models/CreateBulkLinksRequest.js +51 -0
- package/dist/models/CreateBulkLinksResponse.d.ts +33 -0
- package/dist/models/CreateBulkLinksResponse.js +49 -0
- package/dist/models/CreateContactLinkRequest.d.ts +108 -0
- package/dist/models/CreateContactLinkRequest.js +73 -0
- package/dist/models/CreateContactLinkResponse.d.ts +33 -0
- package/dist/models/CreateContactLinkResponse.js +49 -0
- package/dist/models/CreateCustomDomainRequest.d.ts +32 -0
- package/dist/models/CreateCustomDomainRequest.js +48 -0
- package/dist/models/CreateCustomDomainResponse.d.ts +33 -0
- package/dist/models/CreateCustomDomainResponse.js +49 -0
- package/dist/models/CreateEventTraceResponse.d.ts +33 -0
- package/dist/models/CreateEventTraceResponse.js +49 -0
- package/dist/models/CreateLinkRequest.d.ts +107 -0
- package/dist/models/CreateLinkRequest.js +72 -0
- package/dist/models/CreateLinkResponse.d.ts +33 -0
- package/dist/models/CreateLinkResponse.js +49 -0
- package/dist/models/CreateMediaRequest.d.ts +54 -0
- package/dist/models/CreateMediaRequest.js +56 -0
- package/dist/models/CreateMediaResponse.d.ts +33 -0
- package/dist/models/CreateMediaResponse.js +49 -0
- package/dist/models/CreateQrcodeTemplateRequest.d.ts +63 -0
- package/dist/models/CreateQrcodeTemplateRequest.js +58 -0
- package/dist/models/CreateQrcodeTemplateResponse.d.ts +33 -0
- package/dist/models/CreateQrcodeTemplateResponse.js +49 -0
- package/dist/models/CreateWebhookRequest.d.ts +62 -0
- package/dist/models/CreateWebhookRequest.js +62 -0
- package/dist/models/CreateWebhookResponse.d.ts +33 -0
- package/dist/models/CreateWebhookResponse.js +49 -0
- package/dist/models/CreateWorkflowStepResponse.d.ts +33 -0
- package/dist/models/CreateWorkflowStepResponse.js +49 -0
- package/dist/models/CreateWorkspaceTokenRequest.d.ts +32 -0
- package/dist/models/CreateWorkspaceTokenRequest.js +48 -0
- package/dist/models/CreateWorkspaceTokenResponse.d.ts +40 -0
- package/dist/models/CreateWorkspaceTokenResponse.js +51 -0
- package/dist/models/CustomDomain.d.ts +94 -0
- package/dist/models/CustomDomain.js +70 -0
- package/dist/models/CustomDomainStatus.d.ts +36 -0
- package/dist/models/CustomDomainStatus.js +62 -0
- package/dist/models/DataCollection.d.ts +32 -0
- package/dist/models/DataCollection.js +58 -0
- package/dist/models/DayOfMonthConditionPayload.d.ts +39 -0
- package/dist/models/DayOfMonthConditionPayload.js +51 -0
- package/dist/models/DayOfMonthConditionTraceData.d.ts +39 -0
- package/dist/models/DayOfMonthConditionTraceData.js +51 -0
- package/dist/models/DayOfMonthConditionTraceOption.d.ts +50 -0
- package/dist/models/DayOfMonthConditionTraceOption.js +54 -0
- package/dist/models/DayOfMonthOption.d.ts +50 -0
- package/dist/models/DayOfMonthOption.js +54 -0
- package/dist/models/DayOfWeekConditionPayload.d.ts +39 -0
- package/dist/models/DayOfWeekConditionPayload.js +51 -0
- package/dist/models/DayOfWeekConditionTraceData.d.ts +39 -0
- package/dist/models/DayOfWeekConditionTraceData.js +51 -0
- package/dist/models/DayOfWeekConditionTraceOption.d.ts +50 -0
- package/dist/models/DayOfWeekConditionTraceOption.js +54 -0
- package/dist/models/DayOfWeekOption.d.ts +50 -0
- package/dist/models/DayOfWeekOption.js +54 -0
- package/dist/models/DeleteAttributeResponse.d.ts +32 -0
- package/dist/models/DeleteAttributeResponse.js +48 -0
- package/dist/models/DeleteVisitorResponse.d.ts +32 -0
- package/dist/models/DeleteVisitorResponse.js +48 -0
- package/dist/models/Device.d.ts +232 -0
- package/dist/models/Device.js +121 -0
- package/dist/models/DeviceInput.d.ts +134 -0
- package/dist/models/DeviceInput.js +82 -0
- package/dist/models/DeviceType.d.ts +36 -0
- package/dist/models/DeviceType.js +62 -0
- package/dist/models/DotsOptions.d.ts +39 -0
- package/dist/models/DotsOptions.js +51 -0
- package/dist/models/EntryAccessTraceData.d.ts +56 -0
- package/dist/models/EntryAccessTraceData.js +56 -0
- package/dist/models/ErrorResponse.d.ts +50 -0
- package/dist/models/ErrorResponse.js +62 -0
- package/dist/models/Event.d.ts +170 -0
- package/dist/models/Event.js +101 -0
- package/dist/models/EventAction.d.ts +50 -0
- package/dist/models/EventAction.js +76 -0
- package/dist/models/EventTrace.d.ts +94 -0
- package/dist/models/EventTrace.js +69 -0
- package/dist/models/EventTraceData.d.ts +110 -0
- package/dist/models/EventTraceData.js +82 -0
- package/dist/models/EventsMetric.d.ts +105 -0
- package/dist/models/EventsMetric.js +79 -0
- package/dist/models/EventsServiceCreateEventTraceBody.d.ts +45 -0
- package/dist/models/EventsServiceCreateEventTraceBody.js +53 -0
- package/dist/models/EventsServiceUpdateDeviceBody.d.ts +33 -0
- package/dist/models/EventsServiceUpdateDeviceBody.js +49 -0
- package/dist/models/EventsTimeSeries.d.ts +45 -0
- package/dist/models/EventsTimeSeries.js +53 -0
- package/dist/models/EventsTimeSeriesData.d.ts +38 -0
- package/dist/models/EventsTimeSeriesData.js +50 -0
- package/dist/models/FontConfig.d.ts +71 -0
- package/dist/models/FontConfig.js +71 -0
- package/dist/models/FormField.d.ts +94 -0
- package/dist/models/FormField.js +70 -0
- package/dist/models/FormFieldOption.d.ts +38 -0
- package/dist/models/FormFieldOption.js +50 -0
- package/dist/models/FormFieldType.d.ts +34 -0
- package/dist/models/FormFieldType.js +60 -0
- package/dist/models/FormPayload.d.ts +69 -0
- package/dist/models/FormPayload.js +61 -0
- package/dist/models/FormTraceData.d.ts +75 -0
- package/dist/models/FormTraceData.js +63 -0
- package/dist/models/FormTraceDataField.d.ts +56 -0
- package/dist/models/FormTraceDataField.js +56 -0
- package/dist/models/GetCustomDomainResponse.d.ts +33 -0
- package/dist/models/GetCustomDomainResponse.js +49 -0
- package/dist/models/GetEventsTimeSeriesRequest.d.ts +50 -0
- package/dist/models/GetEventsTimeSeriesRequest.js +54 -0
- package/dist/models/GetEventsTimeSeriesResponse.d.ts +33 -0
- package/dist/models/GetEventsTimeSeriesResponse.js +49 -0
- package/dist/models/GetLeadScoreExplanationResponse.d.ts +51 -0
- package/dist/models/GetLeadScoreExplanationResponse.js +55 -0
- package/dist/models/GetLinkResponse.d.ts +33 -0
- package/dist/models/GetLinkResponse.js +49 -0
- package/dist/models/GetLinkSettingResponse.d.ts +33 -0
- package/dist/models/GetLinkSettingResponse.js +49 -0
- package/dist/models/GetMediaResponse.d.ts +33 -0
- package/dist/models/GetMediaResponse.js +49 -0
- package/dist/models/GetPageThemeResponse.d.ts +33 -0
- package/dist/models/GetPageThemeResponse.js +49 -0
- package/dist/models/GetQrcodeDesignResponse.d.ts +33 -0
- package/dist/models/GetQrcodeDesignResponse.js +49 -0
- package/dist/models/GetWebhookResponse.d.ts +33 -0
- package/dist/models/GetWebhookResponse.js +49 -0
- package/dist/models/GetWorkflowStepResponse.d.ts +33 -0
- package/dist/models/GetWorkflowStepResponse.js +49 -0
- package/dist/models/GetWorkspaceTokenResponse.d.ts +33 -0
- package/dist/models/GetWorkspaceTokenResponse.js +49 -0
- package/dist/models/GooglerpcStatus.d.ts +45 -0
- package/dist/models/GooglerpcStatus.js +53 -0
- package/dist/models/IdentifyRequest.d.ts +45 -0
- package/dist/models/IdentifyRequest.js +53 -0
- package/dist/models/IdentifyResponse.d.ts +39 -0
- package/dist/models/IdentifyResponse.js +51 -0
- package/dist/models/ImportQrcodeTemplateRequest.d.ts +32 -0
- package/dist/models/ImportQrcodeTemplateRequest.js +48 -0
- package/dist/models/ImportQrcodeTemplateResponse.d.ts +33 -0
- package/dist/models/ImportQrcodeTemplateResponse.js +49 -0
- package/dist/models/InviteMemberRequest.d.ts +44 -0
- package/dist/models/InviteMemberRequest.js +52 -0
- package/dist/models/LeadScore.d.ts +111 -0
- package/dist/models/LeadScore.js +74 -0
- package/dist/models/LeadScoreBreakdown.d.ts +56 -0
- package/dist/models/LeadScoreBreakdown.js +56 -0
- package/dist/models/Link.d.ts +182 -0
- package/dist/models/Link.js +88 -0
- package/dist/models/LinkSetting.d.ts +51 -0
- package/dist/models/LinkSetting.js +55 -0
- package/dist/models/LinkSortField.d.ts +34 -0
- package/dist/models/LinkSortField.js +60 -0
- package/dist/models/LinksServiceUpdateBody.d.ts +84 -0
- package/dist/models/LinksServiceUpdateBody.js +64 -0
- package/dist/models/ListCustomDomainsResponse.d.ts +33 -0
- package/dist/models/ListCustomDomainsResponse.js +49 -0
- package/dist/models/ListEventTracesResponse.d.ts +33 -0
- package/dist/models/ListEventTracesResponse.js +49 -0
- package/dist/models/ListEventsCsvResponse.d.ts +38 -0
- package/dist/models/ListEventsCsvResponse.js +50 -0
- package/dist/models/ListEventsJsonResponse.d.ts +51 -0
- package/dist/models/ListEventsJsonResponse.js +55 -0
- package/dist/models/ListEventsResponse.d.ts +40 -0
- package/dist/models/ListEventsResponse.js +52 -0
- package/dist/models/ListLinksResponse.d.ts +45 -0
- package/dist/models/ListLinksResponse.js +53 -0
- package/dist/models/ListMediaResponse.d.ts +39 -0
- package/dist/models/ListMediaResponse.js +51 -0
- package/dist/models/ListPageThemesResponse.d.ts +33 -0
- package/dist/models/ListPageThemesResponse.js +49 -0
- package/dist/models/ListQrcodeTemplatesResponse.d.ts +45 -0
- package/dist/models/ListQrcodeTemplatesResponse.js +53 -0
- package/dist/models/ListResponse.d.ts +33 -0
- package/dist/models/ListResponse.js +49 -0
- package/dist/models/ListTagsResponse.d.ts +39 -0
- package/dist/models/ListTagsResponse.js +51 -0
- package/dist/models/ListVisitorsCsvResponse.d.ts +38 -0
- package/dist/models/ListVisitorsCsvResponse.js +50 -0
- package/dist/models/ListVisitorsJsonResponse.d.ts +51 -0
- package/dist/models/ListVisitorsJsonResponse.js +55 -0
- package/dist/models/ListVisitorsResponse.d.ts +40 -0
- package/dist/models/ListVisitorsResponse.js +52 -0
- package/dist/models/ListWebhooksResponse.d.ts +33 -0
- package/dist/models/ListWebhooksResponse.js +49 -0
- package/dist/models/ListWorkflowStepsResponse.d.ts +39 -0
- package/dist/models/ListWorkflowStepsResponse.js +51 -0
- package/dist/models/ListWorkspaceTokensResponse.d.ts +33 -0
- package/dist/models/ListWorkspaceTokensResponse.js +49 -0
- package/dist/models/Media.d.ts +96 -0
- package/dist/models/Media.js +65 -0
- package/dist/models/MediaSelection.d.ts +38 -0
- package/dist/models/MediaSelection.js +50 -0
- package/dist/models/MediaType.d.ts +30 -0
- package/dist/models/MediaType.js +56 -0
- package/dist/models/MediaVisibility.d.ts +29 -0
- package/dist/models/MediaVisibility.js +55 -0
- package/dist/models/Member.d.ts +124 -0
- package/dist/models/Member.js +79 -0
- package/dist/models/MembersServiceUpdateBody.d.ts +57 -0
- package/dist/models/MembersServiceUpdateBody.js +57 -0
- package/dist/models/ModelHTTPMethod.d.ts +31 -0
- package/dist/models/ModelHTTPMethod.js +57 -0
- package/dist/models/MultiLinkButton.d.ts +50 -0
- package/dist/models/MultiLinkButton.js +54 -0
- package/dist/models/MultiLinkPayload.d.ts +45 -0
- package/dist/models/MultiLinkPayload.js +53 -0
- package/dist/models/MultiLinkSelectedButton.d.ts +44 -0
- package/dist/models/MultiLinkSelectedButton.js +52 -0
- package/dist/models/MultiLinkTraceData.d.ts +33 -0
- package/dist/models/MultiLinkTraceData.js +49 -0
- package/dist/models/OutputFileFormat.d.ts +32 -0
- package/dist/models/OutputFileFormat.js +58 -0
- package/dist/models/PageTheme.d.ts +145 -0
- package/dist/models/PageTheme.js +96 -0
- package/dist/models/PageThemeBadgeShape.d.ts +27 -0
- package/dist/models/PageThemeBadgeShape.js +53 -0
- package/dist/models/PageThemeBorderStyle.d.ts +30 -0
- package/dist/models/PageThemeBorderStyle.js +56 -0
- package/dist/models/PageThemeCanvasCoverMode.d.ts +27 -0
- package/dist/models/PageThemeCanvasCoverMode.js +53 -0
- package/dist/models/PageThemeContainerVariant.d.ts +26 -0
- package/dist/models/PageThemeContainerVariant.js +52 -0
- package/dist/models/PageThemeFontFamily.d.ts +31 -0
- package/dist/models/PageThemeFontFamily.js +57 -0
- package/dist/models/PageThemesServiceUpdatePageThemeBody.d.ts +122 -0
- package/dist/models/PageThemesServiceUpdatePageThemeBody.js +93 -0
- package/dist/models/PasswordPayload.d.ts +44 -0
- package/dist/models/PasswordPayload.js +52 -0
- package/dist/models/PasswordTraceData.d.ts +32 -0
- package/dist/models/PasswordTraceData.js +48 -0
- package/dist/models/PreferredLinkType.d.ts +32 -0
- package/dist/models/PreferredLinkType.js +58 -0
- package/dist/models/ProtobufAny.d.ts +33 -0
- package/dist/models/ProtobufAny.js +50 -0
- package/dist/models/ProtobufNullValue.d.ts +29 -0
- package/dist/models/ProtobufNullValue.js +55 -0
- package/dist/models/PublicCreateQrcodeDesignRequest.d.ts +134 -0
- package/dist/models/PublicCreateQrcodeDesignRequest.js +95 -0
- package/dist/models/PublicCreateQrcodeDesignResponse.d.ts +33 -0
- package/dist/models/PublicCreateQrcodeDesignResponse.js +49 -0
- package/dist/models/PublicListQrcodeTemplatesResponse.d.ts +45 -0
- package/dist/models/PublicListQrcodeTemplatesResponse.js +53 -0
- package/dist/models/PublicQrcodeTemplate.d.ts +87 -0
- package/dist/models/PublicQrcodeTemplate.js +67 -0
- package/dist/models/PublicWorkspace.d.ts +74 -0
- package/dist/models/PublicWorkspace.js +62 -0
- package/dist/models/PublishQrcodeTemplateResponse.d.ts +33 -0
- package/dist/models/PublishQrcodeTemplateResponse.js +49 -0
- package/dist/models/QrcodeDesign.d.ts +157 -0
- package/dist/models/QrcodeDesign.js +98 -0
- package/dist/models/QrcodeDesignServiceUpdateBody.d.ts +140 -0
- package/dist/models/QrcodeDesignServiceUpdateBody.js +97 -0
- package/dist/models/QrcodeTemplate.d.ts +135 -0
- package/dist/models/QrcodeTemplate.js +81 -0
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.d.ts +62 -0
- package/dist/models/QrcodeTemplatesServiceUpdateQrcodeTemplateBody.js +58 -0
- package/dist/models/RedirectTraceData.d.ts +44 -0
- package/dist/models/RedirectTraceData.js +52 -0
- package/dist/models/RemoveWorkflowStepRelationshipResponse.d.ts +32 -0
- package/dist/models/RemoveWorkflowStepRelationshipResponse.js +48 -0
- package/dist/models/RequestWorkspaceEnrollmentRequest.d.ts +32 -0
- package/dist/models/RequestWorkspaceEnrollmentRequest.js +48 -0
- package/dist/models/ResponseFormat.d.ts +30 -0
- package/dist/models/ResponseFormat.js +56 -0
- package/dist/models/Role.d.ts +29 -0
- package/dist/models/Role.js +55 -0
- package/dist/models/SettingsServiceUpdateLinkSettingBody.d.ts +33 -0
- package/dist/models/SettingsServiceUpdateLinkSettingBody.js +49 -0
- package/dist/models/Shape.d.ts +28 -0
- package/dist/models/Shape.js +54 -0
- package/dist/models/ShortlinkAvailabilityResponse.d.ts +32 -0
- package/dist/models/ShortlinkAvailabilityResponse.js +48 -0
- package/dist/models/ShortlinkRandomResponse.d.ts +32 -0
- package/dist/models/ShortlinkRandomResponse.js +48 -0
- package/dist/models/SocialLinkButton.d.ts +50 -0
- package/dist/models/SocialLinkButton.js +54 -0
- package/dist/models/SocialLinksDisplayStyle.d.ts +27 -0
- package/dist/models/SocialLinksDisplayStyle.js +53 -0
- package/dist/models/SocialLinksPayload.d.ts +52 -0
- package/dist/models/SocialLinksPayload.js +56 -0
- package/dist/models/SortDirection.d.ts +28 -0
- package/dist/models/SortDirection.js +54 -0
- package/dist/models/SpecificDateConditionPayload.d.ts +39 -0
- package/dist/models/SpecificDateConditionPayload.js +51 -0
- package/dist/models/SpecificDateConditionTraceData.d.ts +39 -0
- package/dist/models/SpecificDateConditionTraceData.js +51 -0
- package/dist/models/SpecificDateConditionTraceOption.d.ts +62 -0
- package/dist/models/SpecificDateConditionTraceOption.js +58 -0
- package/dist/models/SpecificDateOption.d.ts +62 -0
- package/dist/models/SpecificDateOption.js +58 -0
- package/dist/models/SubscriptionType.d.ts +34 -0
- package/dist/models/SubscriptionType.js +60 -0
- package/dist/models/ThemeColor.d.ts +61 -0
- package/dist/models/ThemeColor.js +68 -0
- package/dist/models/ThemeColorThemeColorType.d.ts +27 -0
- package/dist/models/ThemeColorThemeColorType.js +53 -0
- package/dist/models/TimeOfDayConditionPayload.d.ts +39 -0
- package/dist/models/TimeOfDayConditionPayload.js +51 -0
- package/dist/models/TimeOfDayConditionTraceData.d.ts +39 -0
- package/dist/models/TimeOfDayConditionTraceData.js +51 -0
- package/dist/models/TimeOfDayConditionTraceRange.d.ts +56 -0
- package/dist/models/TimeOfDayConditionTraceRange.js +56 -0
- package/dist/models/TimeOfDayRange.d.ts +56 -0
- package/dist/models/TimeOfDayRange.js +56 -0
- package/dist/models/TriggeredBy.d.ts +26 -0
- package/dist/models/TriggeredBy.js +52 -0
- package/dist/models/UpdateDeviceResponse.d.ts +32 -0
- package/dist/models/UpdateDeviceResponse.js +48 -0
- package/dist/models/UpdateLinkResponse.d.ts +33 -0
- package/dist/models/UpdateLinkResponse.js +49 -0
- package/dist/models/UpdateLinkSettingResponse.d.ts +33 -0
- package/dist/models/UpdateLinkSettingResponse.js +49 -0
- package/dist/models/UpdateMeRequest.d.ts +50 -0
- package/dist/models/UpdateMeRequest.js +54 -0
- package/dist/models/UpdatePageThemeResponse.d.ts +33 -0
- package/dist/models/UpdatePageThemeResponse.js +49 -0
- package/dist/models/UpdateQrcodeDesignResponse.d.ts +33 -0
- package/dist/models/UpdateQrcodeDesignResponse.js +49 -0
- package/dist/models/UpdateQrcodeTemplateResponse.d.ts +33 -0
- package/dist/models/UpdateQrcodeTemplateResponse.js +49 -0
- package/dist/models/UpdateWebhookResponse.d.ts +33 -0
- package/dist/models/UpdateWebhookResponse.js +49 -0
- package/dist/models/UpdateWorkflowStepResponse.d.ts +33 -0
- package/dist/models/UpdateWorkflowStepResponse.js +49 -0
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.d.ts +32 -0
- package/dist/models/UpdateWorkspaceOriginInquiryRequest.js +48 -0
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.d.ts +32 -0
- package/dist/models/UpdateWorkspaceOriginPurposeRequest.js +48 -0
- package/dist/models/UpdateWorkspaceRequest.d.ts +74 -0
- package/dist/models/UpdateWorkspaceRequest.js +62 -0
- package/dist/models/VCardData.d.ts +104 -0
- package/dist/models/VCardData.js +72 -0
- package/dist/models/VCardPayload.d.ts +104 -0
- package/dist/models/VCardPayload.js +72 -0
- package/dist/models/ValidationInstructionsCustomDomainResponse.d.ts +33 -0
- package/dist/models/ValidationInstructionsCustomDomainResponse.js +49 -0
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.d.ts +52 -0
- package/dist/models/ValidationInstructionsCustomDomainResponseValidation.js +56 -0
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.d.ts +26 -0
- package/dist/models/ValidationInstructionsCustomDomainResponseValidationType.js +52 -0
- package/dist/models/ValidationPurpose.d.ts +28 -0
- package/dist/models/ValidationPurpose.js +54 -0
- package/dist/models/VisitType.d.ts +28 -0
- package/dist/models/VisitType.js +54 -0
- package/dist/models/VisitTypeConditionOption.d.ts +38 -0
- package/dist/models/VisitTypeConditionOption.js +50 -0
- package/dist/models/VisitTypeConditionPayload.d.ts +39 -0
- package/dist/models/VisitTypeConditionPayload.js +51 -0
- package/dist/models/VisitTypeConditionTraceData.d.ts +45 -0
- package/dist/models/VisitTypeConditionTraceData.js +53 -0
- package/dist/models/VisitTypeConditionTraceOption.d.ts +38 -0
- package/dist/models/VisitTypeConditionTraceOption.js +50 -0
- package/dist/models/Visitor.d.ts +102 -0
- package/dist/models/Visitor.js +73 -0
- package/dist/models/VisitorEvent.d.ts +62 -0
- package/dist/models/VisitorEvent.js +58 -0
- package/dist/models/VisitorInput.d.ts +34 -0
- package/dist/models/VisitorInput.js +48 -0
- package/dist/models/VisitorLink.d.ts +68 -0
- package/dist/models/VisitorLink.js +60 -0
- package/dist/models/VisitorsServiceUpdateBody.d.ts +33 -0
- package/dist/models/VisitorsServiceUpdateBody.js +49 -0
- package/dist/models/Webhook.d.ts +128 -0
- package/dist/models/Webhook.js +73 -0
- package/dist/models/WebhookSource.d.ts +30 -0
- package/dist/models/WebhookSource.js +56 -0
- package/dist/models/WebhookStatus.d.ts +30 -0
- package/dist/models/WebhookStatus.js +56 -0
- package/dist/models/WebhooksServiceUpdateBody.d.ts +69 -0
- package/dist/models/WebhooksServiceUpdateBody.js +61 -0
- package/dist/models/WorkflowStep.d.ts +149 -0
- package/dist/models/WorkflowStep.js +97 -0
- package/dist/models/WorkflowStepKind.d.ts +32 -0
- package/dist/models/WorkflowStepKind.js +58 -0
- package/dist/models/WorkflowStepNodeType.d.ts +56 -0
- package/dist/models/WorkflowStepNodeType.js +82 -0
- package/dist/models/WorkflowStepPayload.d.ts +116 -0
- package/dist/models/WorkflowStepPayload.js +84 -0
- package/dist/models/WorkflowStepsServiceAddRelationshipBody.d.ts +32 -0
- package/dist/models/WorkflowStepsServiceAddRelationshipBody.js +48 -0
- package/dist/models/WorkflowStepsServiceCreateBody.d.ts +85 -0
- package/dist/models/WorkflowStepsServiceCreateBody.js +76 -0
- package/dist/models/WorkflowStepsServiceUpdateBody.d.ts +40 -0
- package/dist/models/WorkflowStepsServiceUpdateBody.js +52 -0
- package/dist/models/Workspace.d.ts +158 -0
- package/dist/models/Workspace.js +96 -0
- package/dist/models/WorkspaceInsight.d.ts +34 -0
- package/dist/models/WorkspaceInsight.js +49 -0
- package/dist/models/WorkspaceMetric.d.ts +68 -0
- package/dist/models/WorkspaceMetric.js +60 -0
- package/dist/models/WorkspaceToken.d.ts +69 -0
- package/dist/models/WorkspaceToken.js +57 -0
- package/dist/models/index.d.ts +212 -0
- package/dist/models/index.js +230 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +338 -0
- package/package.json +40 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Linkbreakers
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# linkbreakers
|
|
2
|
+
|
|
3
|
+
Official TypeScript/JavaScript SDK for the Linkbreakers API.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/linkbreakers)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install linkbreakers
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { Configuration, LinksApi } from 'linkbreakers';
|
|
18
|
+
|
|
19
|
+
// Configure API client
|
|
20
|
+
const config = new Configuration({
|
|
21
|
+
apiKey: 'your_api_key_here',
|
|
22
|
+
basePath: 'https://api.linkbreakers.com',
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
const linksApi = new LinksApi(config);
|
|
26
|
+
|
|
27
|
+
// Create a shortened link
|
|
28
|
+
const link = await linksApi.createLink({
|
|
29
|
+
destination: 'https://example.com',
|
|
30
|
+
name: 'My Link',
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
console.log('Short link:', link.shortlink);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Full API Support
|
|
37
|
+
|
|
38
|
+
The SDK provides type-safe methods for all API operations:
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
// Get a link by ID
|
|
42
|
+
const link = await linksApi.getLink({ id: 'link-id' });
|
|
43
|
+
|
|
44
|
+
// Update a link
|
|
45
|
+
const updated = await linksApi.updateLink({
|
|
46
|
+
id: 'link-id',
|
|
47
|
+
updateLinkRequest: {
|
|
48
|
+
name: 'Updated Name',
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
// Delete a link
|
|
53
|
+
await linksApi.deleteLink({ id: 'link-id' });
|
|
54
|
+
|
|
55
|
+
// List links with filtering
|
|
56
|
+
const links = await linksApi.listLinks({
|
|
57
|
+
pageSize: 50,
|
|
58
|
+
search: 'my-search',
|
|
59
|
+
tags: ['tag1', 'tag2'],
|
|
60
|
+
});
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Features
|
|
64
|
+
|
|
65
|
+
- ✅ Full TypeScript support with type definitions
|
|
66
|
+
- ✅ Works in Node.js and browsers
|
|
67
|
+
- ✅ Auto-generated from OpenAPI specification
|
|
68
|
+
- ✅ Automatically updated when API changes
|
|
69
|
+
|
|
70
|
+
## Documentation
|
|
71
|
+
|
|
72
|
+
For complete API documentation, visit [https://docs.linkbreakers.com](https://docs.linkbreakers.com)
|
|
73
|
+
|
|
74
|
+
## Auto-Generated SDK
|
|
75
|
+
|
|
76
|
+
This SDK is automatically generated from the Linkbreakers OpenAPI specification. When the API is updated, this SDK is automatically regenerated and published.
|
|
77
|
+
|
|
78
|
+
**Current API Version:** See [OPENAPI_VERSION](./OPENAPI_VERSION)
|
|
79
|
+
|
|
80
|
+
## Support
|
|
81
|
+
|
|
82
|
+
- **Issues:** [GitHub Issues](https://github.com/linkbreakers-com/linkbreakers-typescript/issues)
|
|
83
|
+
- **Documentation:** [https://docs.linkbreakers.com](https://docs.linkbreakers.com)
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
MIT License - see [LICENSE](./LICENSE) for details.
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Linkbreakers API
|
|
3
|
+
* This is a documentation of all the APIs of Linkbreakers
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.34.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { CheckCustomDomainResponse, CreateCustomDomainRequest, CreateCustomDomainResponse, GetCustomDomainResponse, ListCustomDomainsResponse, ValidationInstructionsCustomDomainResponse } from '../models/index';
|
|
14
|
+
export interface CustomDomainsServiceCheckRequest {
|
|
15
|
+
id: string;
|
|
16
|
+
}
|
|
17
|
+
export interface CustomDomainsServiceCreateRequest {
|
|
18
|
+
createCustomDomainRequest: CreateCustomDomainRequest;
|
|
19
|
+
}
|
|
20
|
+
export interface CustomDomainsServiceDeleteRequest {
|
|
21
|
+
id: string;
|
|
22
|
+
}
|
|
23
|
+
export interface CustomDomainsServiceGetRequest {
|
|
24
|
+
id: string;
|
|
25
|
+
}
|
|
26
|
+
export interface CustomDomainsServiceListRequest {
|
|
27
|
+
status?: string;
|
|
28
|
+
}
|
|
29
|
+
export interface CustomDomainsServiceValidationInstructionsRequest {
|
|
30
|
+
id: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* CustomDomainsApi - interface
|
|
34
|
+
*
|
|
35
|
+
* @export
|
|
36
|
+
* @interface CustomDomainsApiInterface
|
|
37
|
+
*/
|
|
38
|
+
export interface CustomDomainsApiInterface {
|
|
39
|
+
/**
|
|
40
|
+
* Creates request options for customDomainsServiceCheck without sending the request
|
|
41
|
+
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
* @memberof CustomDomainsApiInterface
|
|
44
|
+
*/
|
|
45
|
+
customDomainsServiceCheckRequestOpts(requestParameters: CustomDomainsServiceCheckRequest): Promise<runtime.RequestOpts>;
|
|
46
|
+
/**
|
|
47
|
+
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status.
|
|
48
|
+
* @summary Check a custom domain
|
|
49
|
+
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
* @memberof CustomDomainsApiInterface
|
|
53
|
+
*/
|
|
54
|
+
customDomainsServiceCheckRaw(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckCustomDomainResponse>>;
|
|
55
|
+
/**
|
|
56
|
+
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status.
|
|
57
|
+
* Check a custom domain
|
|
58
|
+
*/
|
|
59
|
+
customDomainsServiceCheck(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckCustomDomainResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* Creates request options for customDomainsServiceCreate without sending the request
|
|
62
|
+
* @param {CreateCustomDomainRequest} createCustomDomainRequest
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
* @memberof CustomDomainsApiInterface
|
|
65
|
+
*/
|
|
66
|
+
customDomainsServiceCreateRequestOpts(requestParameters: CustomDomainsServiceCreateRequest): Promise<runtime.RequestOpts>;
|
|
67
|
+
/**
|
|
68
|
+
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace.
|
|
69
|
+
* @summary Create a custom domain
|
|
70
|
+
* @param {CreateCustomDomainRequest} createCustomDomainRequest
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
* @memberof CustomDomainsApiInterface
|
|
74
|
+
*/
|
|
75
|
+
customDomainsServiceCreateRaw(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCustomDomainResponse>>;
|
|
76
|
+
/**
|
|
77
|
+
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace.
|
|
78
|
+
* Create a custom domain
|
|
79
|
+
*/
|
|
80
|
+
customDomainsServiceCreate(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCustomDomainResponse>;
|
|
81
|
+
/**
|
|
82
|
+
* Creates request options for customDomainsServiceDelete without sending the request
|
|
83
|
+
* @param {string} id The ID of the custom domain to delete (UUID)
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
* @memberof CustomDomainsApiInterface
|
|
86
|
+
*/
|
|
87
|
+
customDomainsServiceDeleteRequestOpts(requestParameters: CustomDomainsServiceDeleteRequest): Promise<runtime.RequestOpts>;
|
|
88
|
+
/**
|
|
89
|
+
* Removes a custom domain from the workspace. This operation cannot be undone.
|
|
90
|
+
* @summary Delete a custom domain
|
|
91
|
+
* @param {string} id The ID of the custom domain to delete (UUID)
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
* @memberof CustomDomainsApiInterface
|
|
95
|
+
*/
|
|
96
|
+
customDomainsServiceDeleteRaw(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
97
|
+
/**
|
|
98
|
+
* Removes a custom domain from the workspace. This operation cannot be undone.
|
|
99
|
+
* Delete a custom domain
|
|
100
|
+
*/
|
|
101
|
+
customDomainsServiceDelete(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
102
|
+
/**
|
|
103
|
+
* Creates request options for customDomainsServiceGet without sending the request
|
|
104
|
+
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
* @memberof CustomDomainsApiInterface
|
|
107
|
+
*/
|
|
108
|
+
customDomainsServiceGetRequestOpts(requestParameters: CustomDomainsServiceGetRequest): Promise<runtime.RequestOpts>;
|
|
109
|
+
/**
|
|
110
|
+
* Retrieves information about a custom domain including its verification status and timestamps.
|
|
111
|
+
* @summary Get custom domain details
|
|
112
|
+
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
* @memberof CustomDomainsApiInterface
|
|
116
|
+
*/
|
|
117
|
+
customDomainsServiceGetRaw(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCustomDomainResponse>>;
|
|
118
|
+
/**
|
|
119
|
+
* Retrieves information about a custom domain including its verification status and timestamps.
|
|
120
|
+
* Get custom domain details
|
|
121
|
+
*/
|
|
122
|
+
customDomainsServiceGet(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCustomDomainResponse>;
|
|
123
|
+
/**
|
|
124
|
+
* Creates request options for customDomainsServiceList without sending the request
|
|
125
|
+
* @param {string} [status] Filter by the status of the custom domains to list. Optional. - STATUS_UNSPECIFIED: The status is not specified - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet. - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain. - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record. - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready. - STATUS_ACTIVE: The domain is fully active
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
* @memberof CustomDomainsApiInterface
|
|
128
|
+
*/
|
|
129
|
+
customDomainsServiceListRequestOpts(requestParameters: CustomDomainsServiceListRequest): Promise<runtime.RequestOpts>;
|
|
130
|
+
/**
|
|
131
|
+
* Retrieves the custom domains for your workspace
|
|
132
|
+
* @summary List custom domains
|
|
133
|
+
* @param {string} [status] Filter by the status of the custom domains to list. Optional. - STATUS_UNSPECIFIED: The status is not specified - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet. - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain. - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record. - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready. - STATUS_ACTIVE: The domain is fully active
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
* @memberof CustomDomainsApiInterface
|
|
137
|
+
*/
|
|
138
|
+
customDomainsServiceListRaw(requestParameters: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCustomDomainsResponse>>;
|
|
139
|
+
/**
|
|
140
|
+
* Retrieves the custom domains for your workspace
|
|
141
|
+
* List custom domains
|
|
142
|
+
*/
|
|
143
|
+
customDomainsServiceList(requestParameters: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCustomDomainsResponse>;
|
|
144
|
+
/**
|
|
145
|
+
* Creates request options for customDomainsServiceValidationInstructions without sending the request
|
|
146
|
+
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
* @memberof CustomDomainsApiInterface
|
|
149
|
+
*/
|
|
150
|
+
customDomainsServiceValidationInstructionsRequestOpts(requestParameters: CustomDomainsServiceValidationInstructionsRequest): Promise<runtime.RequestOpts>;
|
|
151
|
+
/**
|
|
152
|
+
* Get the instructions for validating a custom domain. There may be a delay before the instructions are available.
|
|
153
|
+
* @summary Get the validation instructions
|
|
154
|
+
* @param {string} id The ID of the custom domain to retrieve (UUID)
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
* @memberof CustomDomainsApiInterface
|
|
158
|
+
*/
|
|
159
|
+
customDomainsServiceValidationInstructionsRaw(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidationInstructionsCustomDomainResponse>>;
|
|
160
|
+
/**
|
|
161
|
+
* Get the instructions for validating a custom domain. There may be a delay before the instructions are available.
|
|
162
|
+
* Get the validation instructions
|
|
163
|
+
*/
|
|
164
|
+
customDomainsServiceValidationInstructions(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidationInstructionsCustomDomainResponse>;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
*/
|
|
169
|
+
export declare class CustomDomainsApi extends runtime.BaseAPI implements CustomDomainsApiInterface {
|
|
170
|
+
/**
|
|
171
|
+
* Creates request options for customDomainsServiceCheck without sending the request
|
|
172
|
+
*/
|
|
173
|
+
customDomainsServiceCheckRequestOpts(requestParameters: CustomDomainsServiceCheckRequest): Promise<runtime.RequestOpts>;
|
|
174
|
+
/**
|
|
175
|
+
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status.
|
|
176
|
+
* Check a custom domain
|
|
177
|
+
*/
|
|
178
|
+
customDomainsServiceCheckRaw(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckCustomDomainResponse>>;
|
|
179
|
+
/**
|
|
180
|
+
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status.
|
|
181
|
+
* Check a custom domain
|
|
182
|
+
*/
|
|
183
|
+
customDomainsServiceCheck(requestParameters: CustomDomainsServiceCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckCustomDomainResponse>;
|
|
184
|
+
/**
|
|
185
|
+
* Creates request options for customDomainsServiceCreate without sending the request
|
|
186
|
+
*/
|
|
187
|
+
customDomainsServiceCreateRequestOpts(requestParameters: CustomDomainsServiceCreateRequest): Promise<runtime.RequestOpts>;
|
|
188
|
+
/**
|
|
189
|
+
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace.
|
|
190
|
+
* Create a custom domain
|
|
191
|
+
*/
|
|
192
|
+
customDomainsServiceCreateRaw(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCustomDomainResponse>>;
|
|
193
|
+
/**
|
|
194
|
+
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace.
|
|
195
|
+
* Create a custom domain
|
|
196
|
+
*/
|
|
197
|
+
customDomainsServiceCreate(requestParameters: CustomDomainsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCustomDomainResponse>;
|
|
198
|
+
/**
|
|
199
|
+
* Creates request options for customDomainsServiceDelete without sending the request
|
|
200
|
+
*/
|
|
201
|
+
customDomainsServiceDeleteRequestOpts(requestParameters: CustomDomainsServiceDeleteRequest): Promise<runtime.RequestOpts>;
|
|
202
|
+
/**
|
|
203
|
+
* Removes a custom domain from the workspace. This operation cannot be undone.
|
|
204
|
+
* Delete a custom domain
|
|
205
|
+
*/
|
|
206
|
+
customDomainsServiceDeleteRaw(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
207
|
+
/**
|
|
208
|
+
* Removes a custom domain from the workspace. This operation cannot be undone.
|
|
209
|
+
* Delete a custom domain
|
|
210
|
+
*/
|
|
211
|
+
customDomainsServiceDelete(requestParameters: CustomDomainsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
212
|
+
/**
|
|
213
|
+
* Creates request options for customDomainsServiceGet without sending the request
|
|
214
|
+
*/
|
|
215
|
+
customDomainsServiceGetRequestOpts(requestParameters: CustomDomainsServiceGetRequest): Promise<runtime.RequestOpts>;
|
|
216
|
+
/**
|
|
217
|
+
* Retrieves information about a custom domain including its verification status and timestamps.
|
|
218
|
+
* Get custom domain details
|
|
219
|
+
*/
|
|
220
|
+
customDomainsServiceGetRaw(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCustomDomainResponse>>;
|
|
221
|
+
/**
|
|
222
|
+
* Retrieves information about a custom domain including its verification status and timestamps.
|
|
223
|
+
* Get custom domain details
|
|
224
|
+
*/
|
|
225
|
+
customDomainsServiceGet(requestParameters: CustomDomainsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCustomDomainResponse>;
|
|
226
|
+
/**
|
|
227
|
+
* Creates request options for customDomainsServiceList without sending the request
|
|
228
|
+
*/
|
|
229
|
+
customDomainsServiceListRequestOpts(requestParameters: CustomDomainsServiceListRequest): Promise<runtime.RequestOpts>;
|
|
230
|
+
/**
|
|
231
|
+
* Retrieves the custom domains for your workspace
|
|
232
|
+
* List custom domains
|
|
233
|
+
*/
|
|
234
|
+
customDomainsServiceListRaw(requestParameters: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCustomDomainsResponse>>;
|
|
235
|
+
/**
|
|
236
|
+
* Retrieves the custom domains for your workspace
|
|
237
|
+
* List custom domains
|
|
238
|
+
*/
|
|
239
|
+
customDomainsServiceList(requestParameters?: CustomDomainsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCustomDomainsResponse>;
|
|
240
|
+
/**
|
|
241
|
+
* Creates request options for customDomainsServiceValidationInstructions without sending the request
|
|
242
|
+
*/
|
|
243
|
+
customDomainsServiceValidationInstructionsRequestOpts(requestParameters: CustomDomainsServiceValidationInstructionsRequest): Promise<runtime.RequestOpts>;
|
|
244
|
+
/**
|
|
245
|
+
* Get the instructions for validating a custom domain. There may be a delay before the instructions are available.
|
|
246
|
+
* Get the validation instructions
|
|
247
|
+
*/
|
|
248
|
+
customDomainsServiceValidationInstructionsRaw(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidationInstructionsCustomDomainResponse>>;
|
|
249
|
+
/**
|
|
250
|
+
* Get the instructions for validating a custom domain. There may be a delay before the instructions are available.
|
|
251
|
+
* Get the validation instructions
|
|
252
|
+
*/
|
|
253
|
+
customDomainsServiceValidationInstructions(requestParameters: CustomDomainsServiceValidationInstructionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidationInstructionsCustomDomainResponse>;
|
|
254
|
+
}
|
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Linkbreakers API
|
|
6
|
+
* This is a documentation of all the APIs of Linkbreakers
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.34.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
16
|
+
if (k2 === undefined) k2 = k;
|
|
17
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
18
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
19
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
20
|
+
}
|
|
21
|
+
Object.defineProperty(o, k2, desc);
|
|
22
|
+
}) : (function(o, m, k, k2) {
|
|
23
|
+
if (k2 === undefined) k2 = k;
|
|
24
|
+
o[k2] = m[k];
|
|
25
|
+
}));
|
|
26
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
27
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
28
|
+
}) : function(o, v) {
|
|
29
|
+
o["default"] = v;
|
|
30
|
+
});
|
|
31
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
32
|
+
var ownKeys = function(o) {
|
|
33
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
34
|
+
var ar = [];
|
|
35
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
36
|
+
return ar;
|
|
37
|
+
};
|
|
38
|
+
return ownKeys(o);
|
|
39
|
+
};
|
|
40
|
+
return function (mod) {
|
|
41
|
+
if (mod && mod.__esModule) return mod;
|
|
42
|
+
var result = {};
|
|
43
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
44
|
+
__setModuleDefault(result, mod);
|
|
45
|
+
return result;
|
|
46
|
+
};
|
|
47
|
+
})();
|
|
48
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
49
|
+
exports.CustomDomainsApi = void 0;
|
|
50
|
+
const runtime = __importStar(require("../runtime"));
|
|
51
|
+
const index_1 = require("../models/index");
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
class CustomDomainsApi extends runtime.BaseAPI {
|
|
56
|
+
/**
|
|
57
|
+
* Creates request options for customDomainsServiceCheck without sending the request
|
|
58
|
+
*/
|
|
59
|
+
async customDomainsServiceCheckRequestOpts(requestParameters) {
|
|
60
|
+
if (requestParameters['id'] == null) {
|
|
61
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling customDomainsServiceCheck().');
|
|
62
|
+
}
|
|
63
|
+
const queryParameters = {};
|
|
64
|
+
const headerParameters = {};
|
|
65
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
66
|
+
const token = this.configuration.accessToken;
|
|
67
|
+
const tokenString = await token("bearerAuth", []);
|
|
68
|
+
if (tokenString) {
|
|
69
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
let urlPath = `/v1/custom-domains/{id}/check`;
|
|
73
|
+
urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
|
|
74
|
+
return {
|
|
75
|
+
path: urlPath,
|
|
76
|
+
method: 'POST',
|
|
77
|
+
headers: headerParameters,
|
|
78
|
+
query: queryParameters,
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status.
|
|
83
|
+
* Check a custom domain
|
|
84
|
+
*/
|
|
85
|
+
async customDomainsServiceCheckRaw(requestParameters, initOverrides) {
|
|
86
|
+
const requestOptions = await this.customDomainsServiceCheckRequestOpts(requestParameters);
|
|
87
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
88
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CheckCustomDomainResponseFromJSON)(jsonValue));
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Check a custom domain by looking up its DNS records and TLS status. This is automatically done when the domain is created. It will update the domain status.
|
|
92
|
+
* Check a custom domain
|
|
93
|
+
*/
|
|
94
|
+
async customDomainsServiceCheck(requestParameters, initOverrides) {
|
|
95
|
+
const response = await this.customDomainsServiceCheckRaw(requestParameters, initOverrides);
|
|
96
|
+
return await response.value();
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Creates request options for customDomainsServiceCreate without sending the request
|
|
100
|
+
*/
|
|
101
|
+
async customDomainsServiceCreateRequestOpts(requestParameters) {
|
|
102
|
+
if (requestParameters['createCustomDomainRequest'] == null) {
|
|
103
|
+
throw new runtime.RequiredError('createCustomDomainRequest', 'Required parameter "createCustomDomainRequest" was null or undefined when calling customDomainsServiceCreate().');
|
|
104
|
+
}
|
|
105
|
+
const queryParameters = {};
|
|
106
|
+
const headerParameters = {};
|
|
107
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
108
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
109
|
+
const token = this.configuration.accessToken;
|
|
110
|
+
const tokenString = await token("bearerAuth", []);
|
|
111
|
+
if (tokenString) {
|
|
112
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
let urlPath = `/v1/custom-domains`;
|
|
116
|
+
return {
|
|
117
|
+
path: urlPath,
|
|
118
|
+
method: 'POST',
|
|
119
|
+
headers: headerParameters,
|
|
120
|
+
query: queryParameters,
|
|
121
|
+
body: (0, index_1.CreateCustomDomainRequestToJSON)(requestParameters['createCustomDomainRequest']),
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace.
|
|
126
|
+
* Create a custom domain
|
|
127
|
+
*/
|
|
128
|
+
async customDomainsServiceCreateRaw(requestParameters, initOverrides) {
|
|
129
|
+
const requestOptions = await this.customDomainsServiceCreateRequestOpts(requestParameters);
|
|
130
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
131
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateCustomDomainResponseFromJSON)(jsonValue));
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* This endpoint allows users to register a new custom domain that can be used with their Linkbreakers workspace.
|
|
135
|
+
* Create a custom domain
|
|
136
|
+
*/
|
|
137
|
+
async customDomainsServiceCreate(requestParameters, initOverrides) {
|
|
138
|
+
const response = await this.customDomainsServiceCreateRaw(requestParameters, initOverrides);
|
|
139
|
+
return await response.value();
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Creates request options for customDomainsServiceDelete without sending the request
|
|
143
|
+
*/
|
|
144
|
+
async customDomainsServiceDeleteRequestOpts(requestParameters) {
|
|
145
|
+
if (requestParameters['id'] == null) {
|
|
146
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling customDomainsServiceDelete().');
|
|
147
|
+
}
|
|
148
|
+
const queryParameters = {};
|
|
149
|
+
const headerParameters = {};
|
|
150
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
151
|
+
const token = this.configuration.accessToken;
|
|
152
|
+
const tokenString = await token("bearerAuth", []);
|
|
153
|
+
if (tokenString) {
|
|
154
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
let urlPath = `/v1/custom-domains/{id}`;
|
|
158
|
+
urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
|
|
159
|
+
return {
|
|
160
|
+
path: urlPath,
|
|
161
|
+
method: 'DELETE',
|
|
162
|
+
headers: headerParameters,
|
|
163
|
+
query: queryParameters,
|
|
164
|
+
};
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Removes a custom domain from the workspace. This operation cannot be undone.
|
|
168
|
+
* Delete a custom domain
|
|
169
|
+
*/
|
|
170
|
+
async customDomainsServiceDeleteRaw(requestParameters, initOverrides) {
|
|
171
|
+
const requestOptions = await this.customDomainsServiceDeleteRequestOpts(requestParameters);
|
|
172
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
173
|
+
return new runtime.JSONApiResponse(response);
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Removes a custom domain from the workspace. This operation cannot be undone.
|
|
177
|
+
* Delete a custom domain
|
|
178
|
+
*/
|
|
179
|
+
async customDomainsServiceDelete(requestParameters, initOverrides) {
|
|
180
|
+
const response = await this.customDomainsServiceDeleteRaw(requestParameters, initOverrides);
|
|
181
|
+
return await response.value();
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Creates request options for customDomainsServiceGet without sending the request
|
|
185
|
+
*/
|
|
186
|
+
async customDomainsServiceGetRequestOpts(requestParameters) {
|
|
187
|
+
if (requestParameters['id'] == null) {
|
|
188
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling customDomainsServiceGet().');
|
|
189
|
+
}
|
|
190
|
+
const queryParameters = {};
|
|
191
|
+
const headerParameters = {};
|
|
192
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
193
|
+
const token = this.configuration.accessToken;
|
|
194
|
+
const tokenString = await token("bearerAuth", []);
|
|
195
|
+
if (tokenString) {
|
|
196
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
let urlPath = `/v1/custom-domains/{id}`;
|
|
200
|
+
urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
|
|
201
|
+
return {
|
|
202
|
+
path: urlPath,
|
|
203
|
+
method: 'GET',
|
|
204
|
+
headers: headerParameters,
|
|
205
|
+
query: queryParameters,
|
|
206
|
+
};
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Retrieves information about a custom domain including its verification status and timestamps.
|
|
210
|
+
* Get custom domain details
|
|
211
|
+
*/
|
|
212
|
+
async customDomainsServiceGetRaw(requestParameters, initOverrides) {
|
|
213
|
+
const requestOptions = await this.customDomainsServiceGetRequestOpts(requestParameters);
|
|
214
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
215
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCustomDomainResponseFromJSON)(jsonValue));
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Retrieves information about a custom domain including its verification status and timestamps.
|
|
219
|
+
* Get custom domain details
|
|
220
|
+
*/
|
|
221
|
+
async customDomainsServiceGet(requestParameters, initOverrides) {
|
|
222
|
+
const response = await this.customDomainsServiceGetRaw(requestParameters, initOverrides);
|
|
223
|
+
return await response.value();
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Creates request options for customDomainsServiceList without sending the request
|
|
227
|
+
*/
|
|
228
|
+
async customDomainsServiceListRequestOpts(requestParameters) {
|
|
229
|
+
const queryParameters = {};
|
|
230
|
+
if (requestParameters['status'] != null) {
|
|
231
|
+
queryParameters['status'] = requestParameters['status'];
|
|
232
|
+
}
|
|
233
|
+
const headerParameters = {};
|
|
234
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
235
|
+
const token = this.configuration.accessToken;
|
|
236
|
+
const tokenString = await token("bearerAuth", []);
|
|
237
|
+
if (tokenString) {
|
|
238
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
let urlPath = `/v1/custom-domains`;
|
|
242
|
+
return {
|
|
243
|
+
path: urlPath,
|
|
244
|
+
method: 'GET',
|
|
245
|
+
headers: headerParameters,
|
|
246
|
+
query: queryParameters,
|
|
247
|
+
};
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Retrieves the custom domains for your workspace
|
|
251
|
+
* List custom domains
|
|
252
|
+
*/
|
|
253
|
+
async customDomainsServiceListRaw(requestParameters, initOverrides) {
|
|
254
|
+
const requestOptions = await this.customDomainsServiceListRequestOpts(requestParameters);
|
|
255
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
256
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListCustomDomainsResponseFromJSON)(jsonValue));
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Retrieves the custom domains for your workspace
|
|
260
|
+
* List custom domains
|
|
261
|
+
*/
|
|
262
|
+
async customDomainsServiceList(requestParameters = {}, initOverrides) {
|
|
263
|
+
const response = await this.customDomainsServiceListRaw(requestParameters, initOverrides);
|
|
264
|
+
return await response.value();
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* Creates request options for customDomainsServiceValidationInstructions without sending the request
|
|
268
|
+
*/
|
|
269
|
+
async customDomainsServiceValidationInstructionsRequestOpts(requestParameters) {
|
|
270
|
+
if (requestParameters['id'] == null) {
|
|
271
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling customDomainsServiceValidationInstructions().');
|
|
272
|
+
}
|
|
273
|
+
const queryParameters = {};
|
|
274
|
+
const headerParameters = {};
|
|
275
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
276
|
+
const token = this.configuration.accessToken;
|
|
277
|
+
const tokenString = await token("bearerAuth", []);
|
|
278
|
+
if (tokenString) {
|
|
279
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
let urlPath = `/v1/custom-domains/{id}/validation_instructions`;
|
|
283
|
+
urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
|
|
284
|
+
return {
|
|
285
|
+
path: urlPath,
|
|
286
|
+
method: 'GET',
|
|
287
|
+
headers: headerParameters,
|
|
288
|
+
query: queryParameters,
|
|
289
|
+
};
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Get the instructions for validating a custom domain. There may be a delay before the instructions are available.
|
|
293
|
+
* Get the validation instructions
|
|
294
|
+
*/
|
|
295
|
+
async customDomainsServiceValidationInstructionsRaw(requestParameters, initOverrides) {
|
|
296
|
+
const requestOptions = await this.customDomainsServiceValidationInstructionsRequestOpts(requestParameters);
|
|
297
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
298
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ValidationInstructionsCustomDomainResponseFromJSON)(jsonValue));
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Get the instructions for validating a custom domain. There may be a delay before the instructions are available.
|
|
302
|
+
* Get the validation instructions
|
|
303
|
+
*/
|
|
304
|
+
async customDomainsServiceValidationInstructions(requestParameters, initOverrides) {
|
|
305
|
+
const response = await this.customDomainsServiceValidationInstructionsRaw(requestParameters, initOverrides);
|
|
306
|
+
return await response.value();
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
exports.CustomDomainsApi = CustomDomainsApi;
|