linkbreakers 1.144.0 → 1.148.0

package/dist/apis/LinksApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.144.0
+ * The version of the OpenAPI document: 1.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -67,7 +67,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateRequestOpts(requestParameters: LinksServiceCreateRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * @summary Create a new link
      * @param {CreateLinkRequest} createLinkRequest
      * @param {*} [options] Override http request option.
@@ -76,7 +76,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateRaw(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLinkResponse>>;
     /**
-     * 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.
+     * 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.
      * Create a new link
      */
     linksServiceCreate(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLinkResponse>;
@@ -88,7 +88,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateBulkRequestOpts(requestParameters: LinksServiceCreateBulkRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * @summary Create multiple links in a single request
      * @param {CreateBulkLinksRequest} createBulkLinksRequest
      * @param {*} [options] Override http request option.
@@ -97,7 +97,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateBulkRaw(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBulkLinksResponse>>;
     /**
-     * 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.
+     * 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.
      * Create multiple links in a single request
      */
     linksServiceCreateBulk(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
@@ -109,7 +109,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateContactLinkRequestOpts(requestParameters: LinksServiceCreateContactLinkRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * @summary Create a new contact card link
      * @param {CreateContactLinkRequest} createContactLinkRequest
      * @param {*} [options] Override http request option.
@@ -118,7 +118,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateContactLinkRaw(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateContactLinkResponse>>;
     /**
-     * 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.
+     * 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.
      * Create a new contact card link
      */
     linksServiceCreateContactLink(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateContactLinkResponse>;
@@ -130,7 +130,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateThankYouLinkRequestOpts(requestParameters: LinksServiceCreateThankYouLinkRequest): Promise<runtime.RequestOpts>;
     /**
-     * This endpoint allows users to create a new link with a thank you page as the exit step.
+     * This endpoint allows users to create a new link with a thank you page as the exit step.  Requires the `links:write` scope.
      * @summary Create a new thank you page link
      * @param {CreateThankYouLinkRequest} createThankYouLinkRequest
      * @param {*} [options] Override http request option.
@@ -139,7 +139,7 @@ export interface LinksApiInterface {
      */
     linksServiceCreateThankYouLinkRaw(requestParameters: LinksServiceCreateThankYouLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateThankYouLinkResponse>>;
     /**
-     * This endpoint allows users to create a new link with a thank you page as the exit step.
+     * This endpoint allows users to create a new link with a thank you page as the exit step.  Requires the `links:write` scope.
      * Create a new thank you page link
      */
     linksServiceCreateThankYouLink(requestParameters: LinksServiceCreateThankYouLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateThankYouLinkResponse>;
@@ -151,7 +151,7 @@ export interface LinksApiInterface {
      */
     linksServiceDeleteRequestOpts(requestParameters: LinksServiceDeleteRequest): Promise<runtime.RequestOpts>;
     /**
-     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Removes a shortened link from the workspace. This operation cannot be undone.  Requires the `links:write` scope.
      * @summary Delete a link
      * @param {string} id The ID of the link to delete (UUID)
      * @param {*} [options] Override http request option.
@@ -160,7 +160,7 @@ export interface LinksApiInterface {
      */
     linksServiceDeleteRaw(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Removes a shortened link from the workspace. This operation cannot be undone.  Requires the `links:write` scope.
      * Delete a link
      */
     linksServiceDelete(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -173,7 +173,7 @@ export interface LinksApiInterface {
      */
     linksServiceGetRequestOpts(requestParameters: LinksServiceGetRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieves information about a shortened link including its metadata and metrics.
+     * Retrieves information about a shortened link including its metadata and metrics.  Requires the `links:read` scope.
      * @summary Get link details
      * @param {string} id The ID of the link to retrieve (UUID)
      * @param {Array<string>} [include] List of related resources to include in the response. Supported values: \&quot;customDomain\&quot;, \&quot;qrcodeDesign\&quot;, \&quot;qrcodeSignedUrl\&quot;, \&quot;tags\&quot;, \&quot;pageTheme\&quot;. Use \&quot;qrcodeSignedUrl\&quot; to fetch signed QR image URLs—they are omitted by default to keep requests fast.
@@ -183,7 +183,7 @@ export interface LinksApiInterface {
      */
     linksServiceGetRaw(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLinkResponse>>;
     /**
-     * Retrieves information about a shortened link including its metadata and metrics.
+     * Retrieves information about a shortened link including its metadata and metrics.  Requires the `links:read` scope.
      * Get link details
      */
     linksServiceGet(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLinkResponse>;
@@ -203,7 +203,7 @@ export interface LinksApiInterface {
      */
     linksServiceListRequestOpts(requestParameters: LinksServiceListRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieves the shortened links for your workspace
+     * Retrieves the shortened links for your workspace  Requires the `links:read` scope.
      * @summary List links
      * @param {number} pageSize The maximum number of links to return.
      * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
@@ -220,7 +220,7 @@ export interface LinksApiInterface {
      */
     linksServiceListRaw(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListLinksResponse>>;
     /**
-     * Retrieves the shortened links for your workspace
+     * Retrieves the shortened links for your workspace  Requires the `links:read` scope.
      * List links
      */
     linksServiceList(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLinksResponse>;
@@ -232,7 +232,7 @@ export interface LinksApiInterface {
      */
     linksServiceResolveQrcodeImagesRequestOpts(requestParameters: LinksServiceResolveQrcodeImagesRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * @summary Resolve QR code image URLs
      * @param {ResolveQrcodeImagesRequest} resolveQrcodeImagesRequest
      * @param {*} [options] Override http request option.
@@ -241,7 +241,7 @@ export interface LinksApiInterface {
      */
     linksServiceResolveQrcodeImagesRaw(requestParameters: LinksServiceResolveQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResolveQrcodeImagesResponse>>;
     /**
-     * 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.
+     * 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.
      * Resolve QR code image URLs
      */
     linksServiceResolveQrcodeImages(requestParameters: LinksServiceResolveQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResolveQrcodeImagesResponse>;
@@ -254,7 +254,7 @@ export interface LinksApiInterface {
      */
     linksServiceShortlinkAvailabilityRequestOpts(requestParameters: LinksServiceShortlinkAvailabilityRequest): Promise<runtime.RequestOpts>;
     /**
-     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.  Requires the `links:read` scope.
      * @summary Check shortlink availability
      * @param {string} [shortlink] The shortlink to check availability for.
      * @param {string} [customDomainId] The ID of the custom domain to check against (UUID) If not provided, checks against the default domain
@@ -264,7 +264,7 @@ export interface LinksApiInterface {
      */
     linksServiceShortlinkAvailabilityRaw(requestParameters: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkAvailabilityResponse>>;
     /**
-     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.  Requires the `links:read` scope.
      * Check shortlink availability
      */
     linksServiceShortlinkAvailability(requestParameters: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkAvailabilityResponse>;
@@ -275,7 +275,7 @@ export interface LinksApiInterface {
      */
     linksServiceShortlinkRandomRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Generates a random availableshortlink for a new link.
+     * Generates a random availableshortlink for a new link.  Requires the `links:read` scope.
      * @summary Get a random shortlink
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -283,7 +283,7 @@ export interface LinksApiInterface {
      */
     linksServiceShortlinkRandomRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkRandomResponse>>;
     /**
-     * Generates a random availableshortlink for a new link.
+     * Generates a random availableshortlink for a new link.  Requires the `links:read` scope.
      * Get a random shortlink
      */
     linksServiceShortlinkRandom(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkRandomResponse>;
@@ -296,7 +296,7 @@ export interface LinksApiInterface {
      */
     linksServiceUpdateRequestOpts(requestParameters: LinksServiceUpdateRequest): Promise<runtime.RequestOpts>;
     /**
-     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Updates an existing shortened link in your Linkbreakers workspace.  Requires the `links:write` scope.
      * @summary Update a link
      * @param {string} id The ID of the link to update (UUID)
      * @param {LinksServiceUpdateBody} linksServiceUpdateBody
@@ -306,7 +306,7 @@ export interface LinksApiInterface {
      */
     linksServiceUpdateRaw(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateLinkResponse>>;
     /**
-     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Updates an existing shortened link in your Linkbreakers workspace.  Requires the `links:write` scope.
      * Update a link
      */
     linksServiceUpdate(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateLinkResponse>;
@@ -320,12 +320,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceCreateRequestOpts(requestParameters: LinksServiceCreateRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * Create a new link
      */
     linksServiceCreateRaw(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLinkResponse>>;
     /**
-     * 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.
+     * 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.
      * Create a new link
      */
     linksServiceCreate(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLinkResponse>;
@@ -334,12 +334,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceCreateBulkRequestOpts(requestParameters: LinksServiceCreateBulkRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * Create multiple links in a single request
      */
     linksServiceCreateBulkRaw(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBulkLinksResponse>>;
     /**
-     * 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.
+     * 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.
      * Create multiple links in a single request
      */
     linksServiceCreateBulk(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
@@ -348,12 +348,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceCreateContactLinkRequestOpts(requestParameters: LinksServiceCreateContactLinkRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * Create a new contact card link
      */
     linksServiceCreateContactLinkRaw(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateContactLinkResponse>>;
     /**
-     * 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.
+     * 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.
      * Create a new contact card link
      */
     linksServiceCreateContactLink(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateContactLinkResponse>;
@@ -362,12 +362,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceCreateThankYouLinkRequestOpts(requestParameters: LinksServiceCreateThankYouLinkRequest): Promise<runtime.RequestOpts>;
     /**
-     * This endpoint allows users to create a new link with a thank you page as the exit step.
+     * This endpoint allows users to create a new link with a thank you page as the exit step.  Requires the `links:write` scope.
      * Create a new thank you page link
      */
     linksServiceCreateThankYouLinkRaw(requestParameters: LinksServiceCreateThankYouLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateThankYouLinkResponse>>;
     /**
-     * This endpoint allows users to create a new link with a thank you page as the exit step.
+     * This endpoint allows users to create a new link with a thank you page as the exit step.  Requires the `links:write` scope.
      * Create a new thank you page link
      */
     linksServiceCreateThankYouLink(requestParameters: LinksServiceCreateThankYouLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateThankYouLinkResponse>;
@@ -376,12 +376,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceDeleteRequestOpts(requestParameters: LinksServiceDeleteRequest): Promise<runtime.RequestOpts>;
     /**
-     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Removes a shortened link from the workspace. This operation cannot be undone.  Requires the `links:write` scope.
      * Delete a link
      */
     linksServiceDeleteRaw(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Removes a shortened link from the workspace. This operation cannot be undone.  Requires the `links:write` scope.
      * Delete a link
      */
     linksServiceDelete(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -390,12 +390,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceGetRequestOpts(requestParameters: LinksServiceGetRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieves information about a shortened link including its metadata and metrics.
+     * Retrieves information about a shortened link including its metadata and metrics.  Requires the `links:read` scope.
      * Get link details
      */
     linksServiceGetRaw(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLinkResponse>>;
     /**
-     * Retrieves information about a shortened link including its metadata and metrics.
+     * Retrieves information about a shortened link including its metadata and metrics.  Requires the `links:read` scope.
      * Get link details
      */
     linksServiceGet(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLinkResponse>;
@@ -404,12 +404,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceListRequestOpts(requestParameters: LinksServiceListRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieves the shortened links for your workspace
+     * Retrieves the shortened links for your workspace  Requires the `links:read` scope.
      * List links
      */
     linksServiceListRaw(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListLinksResponse>>;
     /**
-     * Retrieves the shortened links for your workspace
+     * Retrieves the shortened links for your workspace  Requires the `links:read` scope.
      * List links
      */
     linksServiceList(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLinksResponse>;
@@ -418,12 +418,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceResolveQrcodeImagesRequestOpts(requestParameters: LinksServiceResolveQrcodeImagesRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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.
      * Resolve QR code image URLs
      */
     linksServiceResolveQrcodeImagesRaw(requestParameters: LinksServiceResolveQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResolveQrcodeImagesResponse>>;
     /**
-     * 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.
+     * 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.
      * Resolve QR code image URLs
      */
     linksServiceResolveQrcodeImages(requestParameters: LinksServiceResolveQrcodeImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResolveQrcodeImagesResponse>;
@@ -432,12 +432,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceShortlinkAvailabilityRequestOpts(requestParameters: LinksServiceShortlinkAvailabilityRequest): Promise<runtime.RequestOpts>;
     /**
-     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.  Requires the `links:read` scope.
      * Check shortlink availability
      */
     linksServiceShortlinkAvailabilityRaw(requestParameters: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkAvailabilityResponse>>;
     /**
-     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.  Requires the `links:read` scope.
      * Check shortlink availability
      */
     linksServiceShortlinkAvailability(requestParameters?: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkAvailabilityResponse>;
@@ -446,12 +446,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceShortlinkRandomRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Generates a random availableshortlink for a new link.
+     * Generates a random availableshortlink for a new link.  Requires the `links:read` scope.
      * Get a random shortlink
      */
     linksServiceShortlinkRandomRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkRandomResponse>>;
     /**
-     * Generates a random availableshortlink for a new link.
+     * Generates a random availableshortlink for a new link.  Requires the `links:read` scope.
      * Get a random shortlink
      */
     linksServiceShortlinkRandom(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkRandomResponse>;
@@ -460,12 +460,12 @@ export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterfa
      */
     linksServiceUpdateRequestOpts(requestParameters: LinksServiceUpdateRequest): Promise<runtime.RequestOpts>;
     /**
-     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Updates an existing shortened link in your Linkbreakers workspace.  Requires the `links:write` scope.
      * Update a link
      */
     linksServiceUpdateRaw(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateLinkResponse>>;
     /**
-     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Updates an existing shortened link in your Linkbreakers workspace.  Requires the `links:write` scope.
      * Update a link
      */
     linksServiceUpdate(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateLinkResponse>;