linkbreakers 1.176.2 → 1.177.1

package/dist/apis/LinksApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.176.2
+ * The version of the OpenAPI document: 1.177.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -303,6 +303,56 @@ class LinksApi extends runtime.BaseAPI {
         const response = await this.linksServiceCreateContactLinkRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for linksServiceCreateFileLink without sending the request
+     */
+    async linksServiceCreateFileLinkRequestOpts(requestParameters) {
+        if (requestParameters['createFileLinkRequest'] == null) {
+            throw new runtime.RequiredError('createFileLinkRequest', 'Required parameter "createFileLinkRequest" was null or undefined when calling linksServiceCreateFileLink().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["links:write"]);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", ["links:write"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/links/file`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateFileLinkRequestToJSON)(requestParameters['createFileLinkRequest']),
+        };
+    }
+    /**
+     * Creates a link, and its QR code, that hands visitors a file from the media library: a PDF menu or brochure, an image or an MP4 video. Upload the file first with usage USAGE_FILE (POST /v1/media, or a direct upload for files over 3 MB), then pass its media_id. The FILE step is the exit step. Swap the file later by pointing the step at another media item.  Requires the `links:write` scope.
+     * Create a new file link
+     */
+    async linksServiceCreateFileLinkRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceCreateFileLinkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateFileLinkResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Creates a link, and its QR code, that hands visitors a file from the media library: a PDF menu or brochure, an image or an MP4 video. Upload the file first with usage USAGE_FILE (POST /v1/media, or a direct upload for files over 3 MB), then pass its media_id. The FILE step is the exit step. Swap the file later by pointing the step at another media item.  Requires the `links:write` scope.
+     * Create a new file link
+     */
+    async linksServiceCreateFileLink(requestParameters, initOverrides) {
+        const response = await this.linksServiceCreateFileLinkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for linksServiceCreateThankYouLink without sending the request
      */

package/dist/apis/MediaApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.176.2
+ * The version of the OpenAPI document: 1.177.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,11 +10,20 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateMediaRequest, CreateMediaResponse, GetMediaResponse, ListMediaResponse } from '../models/index';
+import type { CompleteMediaUploadResponse, CreateMediaRequest, CreateMediaResponse, CreateMediaUploadRequest, CreateMediaUploadResponse, GetMediaResponse, ListMediaResponse } from '../models/index';
+export interface MediaServiceCompleteUploadRequest {
+    id: string;
+    body: object;
+    idempotencyKey?: string;
+}
 export interface MediaServiceCreateRequest {
     createMediaRequest: CreateMediaRequest;
     idempotencyKey?: string;
 }
+export interface MediaServiceCreateUploadRequest {
+    createMediaUploadRequest: CreateMediaUploadRequest;
+    idempotencyKey?: string;
+}
 export interface MediaServiceDeleteRequest {
     id: string;
 }
@@ -24,6 +33,8 @@ export interface MediaServiceGetRequest {
 export interface MediaServiceListRequest {
     pageSize: number;
     pageToken?: string;
+    usage?: string;
+    kind?: string;
     cursor?: string;
 }
 /**
@@ -33,6 +44,31 @@ export interface MediaServiceListRequest {
  * @interface MediaApiInterface
  */
 export interface MediaApiInterface {
+    /**
+     * Creates request options for mediaServiceCompleteUpload without sending the request
+     * @param {string} id The ID of the pending media item (UUID), from CreateUpload
+     * @param {object} body
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
+     * @throws {RequiredError}
+     * @memberof MediaApiInterface
+     */
+    mediaServiceCompleteUploadRequestOpts(requestParameters: MediaServiceCompleteUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Checks the file PUT to the upload_url: its size, its real format read from its first bytes, and the storage allowance. When it matches what CreateUpload declared, the media becomes READY and is returned with a signed URL. When it does not, the file and the media are discarded and the error says why; start a new upload. Completing a media item that is already READY returns it.  Requires the `media:write` scope.
+     * @summary Complete a direct media upload
+     * @param {string} id The ID of the pending media item (UUID), from CreateUpload
+     * @param {object} body
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MediaApiInterface
+     */
+    mediaServiceCompleteUploadRaw(requestParameters: MediaServiceCompleteUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompleteMediaUploadResponse>>;
+    /**
+     * Checks the file PUT to the upload_url: its size, its real format read from its first bytes, and the storage allowance. When it matches what CreateUpload declared, the media becomes READY and is returned with a signed URL. When it does not, the file and the media are discarded and the error says why; start a new upload. Completing a media item that is already READY returns it.  Requires the `media:write` scope.
+     * Complete a direct media upload
+     */
+    mediaServiceCompleteUpload(requestParameters: MediaServiceCompleteUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompleteMediaUploadResponse>;
     /**
      * Creates request options for mediaServiceCreate without sending the request
      * @param {CreateMediaRequest} createMediaRequest
@@ -42,7 +78,7 @@ export interface MediaApiInterface {
      */
     mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise<runtime.RequestOpts>;
     /**
-     * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
+     * Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
      * @summary Upload a media file
      * @param {CreateMediaRequest} createMediaRequest
      * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
@@ -52,10 +88,33 @@ export interface MediaApiInterface {
      */
     mediaServiceCreateRaw(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaResponse>>;
     /**
-     * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
+     * Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
      * Upload a media file
      */
     mediaServiceCreate(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaResponse>;
+    /**
+     * Creates request options for mediaServiceCreateUpload without sending the request
+     * @param {CreateMediaUploadRequest} createMediaUploadRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
+     * @throws {RequiredError}
+     * @memberof MediaApiInterface
+     */
+    mediaServiceCreateUploadRequestOpts(requestParameters: MediaServiceCreateUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, usage, MIME type and exact size in bytes; they are checked against what the usage accepts and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded.  Requires the `media:write` scope.
+     * @summary Start a direct media upload
+     * @param {CreateMediaUploadRequest} createMediaUploadRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MediaApiInterface
+     */
+    mediaServiceCreateUploadRaw(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaUploadResponse>>;
+    /**
+     * Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, usage, MIME type and exact size in bytes; they are checked against what the usage accepts and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded.  Requires the `media:write` scope.
+     * Start a direct media upload
+     */
+    mediaServiceCreateUpload(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaUploadResponse>;
     /**
      * Creates request options for mediaServiceDelete without sending the request
      * @param {string} id The ID of the media file to delete (UUID)
@@ -64,7 +123,7 @@ export interface MediaApiInterface {
      */
     mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise<runtime.RequestOpts>;
     /**
-     * Removes a media file from the workspace. This operation cannot be undone.  Requires the `media:write` scope.
+     * Removes a media file from the workspace and frees its storage. This operation cannot be undone. A FILE media item still handed out by a FILE step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at another file first.  Requires the `media:write` scope.
      * @summary Delete a media file
      * @param {string} id The ID of the media file to delete (UUID)
      * @param {*} [options] Override http request option.
@@ -73,7 +132,7 @@ export interface MediaApiInterface {
      */
     mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Removes a media file from the workspace. This operation cannot be undone.  Requires the `media:write` scope.
+     * Removes a media file from the workspace and frees its storage. This operation cannot be undone. A FILE media item still handed out by a FILE step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at another file first.  Requires the `media:write` scope.
      * Delete a media file
      */
     mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -102,16 +161,20 @@ export interface MediaApiInterface {
      * Creates request options for mediaServiceList without sending the request
      * @param {number} pageSize The maximum number of media files 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
+     * @param {string} [usage] Only media for this usage. Unset lists every usage.   - USAGE_UNSPECIFIED: Not set  - USAGE_CENTRAL_QRCODE_IMAGE: The logo in the center of a QR code  - USAGE_BACKGROUND_COVER: A page theme\&#39;s background cover  - USAGE_BADGE: A page theme\&#39;s badge image  - USAGE_FOOTER_LOGO: A page theme\&#39;s footer logo  - USAGE_FILE: A file a FILE workflow step hands to visitors: a PDF menu or brochure, an image, a video
+     * @param {string} [kind] Only media of this kind. Unset lists every kind.   - KIND_UNSPECIFIED: Not set  - KIND_IMAGE: A PNG, JPEG, WebP or SVG image  - KIND_DOCUMENT: A PDF document  - KIND_VIDEO: An MP4 video
      * @param {string} [cursor] Opaque cursor from the previous page\&#39;s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
      * @throws {RequiredError}
      * @memberof MediaApiInterface
      */
     mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieves the media files for your workspace  Requires the `media:read` scope.
+     * Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one usage or one kind. total_count is every item matching the filters across all pages.  Requires the `media:read` scope.
      * @summary List media files
      * @param {number} pageSize The maximum number of media files 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
+     * @param {string} [usage] Only media for this usage. Unset lists every usage.   - USAGE_UNSPECIFIED: Not set  - USAGE_CENTRAL_QRCODE_IMAGE: The logo in the center of a QR code  - USAGE_BACKGROUND_COVER: A page theme\&#39;s background cover  - USAGE_BADGE: A page theme\&#39;s badge image  - USAGE_FOOTER_LOGO: A page theme\&#39;s footer logo  - USAGE_FILE: A file a FILE workflow step hands to visitors: a PDF menu or brochure, an image, a video
+     * @param {string} [kind] Only media of this kind. Unset lists every kind.   - KIND_UNSPECIFIED: Not set  - KIND_IMAGE: A PNG, JPEG, WebP or SVG image  - KIND_DOCUMENT: A PDF document  - KIND_VIDEO: An MP4 video
      * @param {string} [cursor] Opaque cursor from the previous page\&#39;s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -119,7 +182,7 @@ export interface MediaApiInterface {
      */
     mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMediaResponse>>;
     /**
-     * Retrieves the media files for your workspace  Requires the `media:read` scope.
+     * Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one usage or one kind. total_count is every item matching the filters across all pages.  Requires the `media:read` scope.
      * List media files
      */
     mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMediaResponse>;
@@ -128,31 +191,59 @@ export interface MediaApiInterface {
  *
  */
 export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterface {
+    /**
+     * Creates request options for mediaServiceCompleteUpload without sending the request
+     */
+    mediaServiceCompleteUploadRequestOpts(requestParameters: MediaServiceCompleteUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Checks the file PUT to the upload_url: its size, its real format read from its first bytes, and the storage allowance. When it matches what CreateUpload declared, the media becomes READY and is returned with a signed URL. When it does not, the file and the media are discarded and the error says why; start a new upload. Completing a media item that is already READY returns it.  Requires the `media:write` scope.
+     * Complete a direct media upload
+     */
+    mediaServiceCompleteUploadRaw(requestParameters: MediaServiceCompleteUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompleteMediaUploadResponse>>;
+    /**
+     * Checks the file PUT to the upload_url: its size, its real format read from its first bytes, and the storage allowance. When it matches what CreateUpload declared, the media becomes READY and is returned with a signed URL. When it does not, the file and the media are discarded and the error says why; start a new upload. Completing a media item that is already READY returns it.  Requires the `media:write` scope.
+     * Complete a direct media upload
+     */
+    mediaServiceCompleteUpload(requestParameters: MediaServiceCompleteUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompleteMediaUploadResponse>;
     /**
      * Creates request options for mediaServiceCreate without sending the request
      */
     mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise<runtime.RequestOpts>;
     /**
-     * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
+     * Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
      * Upload a media file
      */
     mediaServiceCreateRaw(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaResponse>>;
     /**
-     * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
+     * Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
      * Upload a media file
      */
     mediaServiceCreate(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaResponse>;
+    /**
+     * Creates request options for mediaServiceCreateUpload without sending the request
+     */
+    mediaServiceCreateUploadRequestOpts(requestParameters: MediaServiceCreateUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, usage, MIME type and exact size in bytes; they are checked against what the usage accepts and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded.  Requires the `media:write` scope.
+     * Start a direct media upload
+     */
+    mediaServiceCreateUploadRaw(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMediaUploadResponse>>;
+    /**
+     * Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, usage, MIME type and exact size in bytes; they are checked against what the usage accepts and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded.  Requires the `media:write` scope.
+     * Start a direct media upload
+     */
+    mediaServiceCreateUpload(requestParameters: MediaServiceCreateUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMediaUploadResponse>;
     /**
      * Creates request options for mediaServiceDelete without sending the request
      */
     mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise<runtime.RequestOpts>;
     /**
-     * Removes a media file from the workspace. This operation cannot be undone.  Requires the `media:write` scope.
+     * Removes a media file from the workspace and frees its storage. This operation cannot be undone. A FILE media item still handed out by a FILE step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at another file first.  Requires the `media:write` scope.
      * Delete a media file
      */
     mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Removes a media file from the workspace. This operation cannot be undone.  Requires the `media:write` scope.
+     * Removes a media file from the workspace and frees its storage. This operation cannot be undone. A FILE media item still handed out by a FILE step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at another file first.  Requires the `media:write` scope.
      * Delete a media file
      */
     mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -175,12 +266,12 @@ export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterfa
      */
     mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieves the media files for your workspace  Requires the `media:read` scope.
+     * Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one usage or one kind. total_count is every item matching the filters across all pages.  Requires the `media:read` scope.
      * List media files
      */
     mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMediaResponse>>;
     /**
-     * Retrieves the media files for your workspace  Requires the `media:read` scope.
+     * Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one usage or one kind. total_count is every item matching the filters across all pages.  Requires the `media:read` scope.
      * List media files
      */
     mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMediaResponse>;

package/dist/apis/MediaApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.176.2
+ * The version of the OpenAPI document: 1.177.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -53,6 +53,60 @@ const index_1 = require("../models/index");
  *
  */
 class MediaApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for mediaServiceCompleteUpload without sending the request
+     */
+    async mediaServiceCompleteUploadRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling mediaServiceCompleteUpload().');
+        }
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling mediaServiceCompleteUpload().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["media:write"]);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", ["media:write"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/media/{id}:complete`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        };
+    }
+    /**
+     * Checks the file PUT to the upload_url: its size, its real format read from its first bytes, and the storage allowance. When it matches what CreateUpload declared, the media becomes READY and is returned with a signed URL. When it does not, the file and the media are discarded and the error says why; start a new upload. Completing a media item that is already READY returns it.  Requires the `media:write` scope.
+     * Complete a direct media upload
+     */
+    async mediaServiceCompleteUploadRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.mediaServiceCompleteUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CompleteMediaUploadResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Checks the file PUT to the upload_url: its size, its real format read from its first bytes, and the storage allowance. When it matches what CreateUpload declared, the media becomes READY and is returned with a signed URL. When it does not, the file and the media are discarded and the error says why; start a new upload. Completing a media item that is already READY returns it.  Requires the `media:write` scope.
+     * Complete a direct media upload
+     */
+    async mediaServiceCompleteUpload(requestParameters, initOverrides) {
+        const response = await this.mediaServiceCompleteUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for mediaServiceCreate without sending the request
      */
@@ -87,7 +141,7 @@ class MediaApi extends runtime.BaseAPI {
         };
     }
     /**
-     * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
+     * Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
      * Upload a media file
      */
     async mediaServiceCreateRaw(requestParameters, initOverrides) {
@@ -96,13 +150,63 @@ class MediaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateMediaResponseFromJSON)(jsonValue));
     }
     /**
-     * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
+     * Uploads a file sent in the request itself, base64 encoded over HTTP, up to 3 MB. Larger files (a PDF brochure, a video) are uploaded straight to storage instead: CreateUpload, a PUT of the file to the returned upload_url, then CompleteUpload. Example: Uploading an image to be placed in the center of a QR Code.  Requires the `media:write` scope.
      * Upload a media file
      */
     async mediaServiceCreate(requestParameters, initOverrides) {
         const response = await this.mediaServiceCreateRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for mediaServiceCreateUpload without sending the request
+     */
+    async mediaServiceCreateUploadRequestOpts(requestParameters) {
+        if (requestParameters['createMediaUploadRequest'] == null) {
+            throw new runtime.RequiredError('createMediaUploadRequest', 'Required parameter "createMediaUploadRequest" was null or undefined when calling mediaServiceCreateUpload().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["media:write"]);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", ["media:write"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/media/uploads`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateMediaUploadRequestToJSON)(requestParameters['createMediaUploadRequest']),
+        };
+    }
+    /**
+     * Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, usage, MIME type and exact size in bytes; they are checked against what the usage accepts and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded.  Requires the `media:write` scope.
+     * Start a direct media upload
+     */
+    async mediaServiceCreateUploadRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.mediaServiceCreateUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateMediaUploadResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Reserves a media item for a file uploaded straight to storage, so large files never pass through the API. Declare the file\'s name, usage, MIME type and exact size in bytes; they are checked against what the usage accepts and against the workspace\'s storage allowance now, and against the uploaded bytes on completion. Then PUT the file\'s bytes to upload_url with the upload_headers (and a Content-Length equal to size) before upload_expires_at, and call CompleteUpload. Until completed the media is PENDING: it is not listed and cannot be used. An upload not completed within an hour is discarded.  Requires the `media:write` scope.
+     * Start a direct media upload
+     */
+    async mediaServiceCreateUpload(requestParameters, initOverrides) {
+        const response = await this.mediaServiceCreateUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for mediaServiceDelete without sending the request
      */
@@ -133,7 +237,7 @@ class MediaApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Removes a media file from the workspace. This operation cannot be undone.  Requires the `media:write` scope.
+     * Removes a media file from the workspace and frees its storage. This operation cannot be undone. A FILE media item still handed out by a FILE step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at another file first.  Requires the `media:write` scope.
      * Delete a media file
      */
     async mediaServiceDeleteRaw(requestParameters, initOverrides) {
@@ -142,7 +246,7 @@ class MediaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Removes a media file from the workspace. This operation cannot be undone.  Requires the `media:write` scope.
+     * Removes a media file from the workspace and frees its storage. This operation cannot be undone. A FILE media item still handed out by a FILE step is refused with MEDIA_IN_USE, naming the links that use it: point those steps at another file first.  Requires the `media:write` scope.
      * Delete a media file
      */
     async mediaServiceDelete(requestParameters, initOverrides) {
@@ -209,6 +313,12 @@ class MediaApi extends runtime.BaseAPI {
         if (requestParameters['pageToken'] != null) {
             queryParameters['pageToken'] = requestParameters['pageToken'];
         }
+        if (requestParameters['usage'] != null) {
+            queryParameters['usage'] = requestParameters['usage'];
+        }
+        if (requestParameters['kind'] != null) {
+            queryParameters['kind'] = requestParameters['kind'];
+        }
         if (requestParameters['cursor'] != null) {
             queryParameters['cursor'] = requestParameters['cursor'];
         }
@@ -233,7 +343,7 @@ class MediaApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Retrieves the media files for your workspace  Requires the `media:read` scope.
+     * Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one usage or one kind. total_count is every item matching the filters across all pages.  Requires the `media:read` scope.
      * List media files
      */
     async mediaServiceListRaw(requestParameters, initOverrides) {
@@ -242,7 +352,7 @@ class MediaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListMediaResponseFromJSON)(jsonValue));
     }
     /**
-     * Retrieves the media files for your workspace  Requires the `media:read` scope.
+     * Retrieves the workspace\'s ready media files, newest first, optionally narrowed to one usage or one kind. total_count is every item matching the filters across all pages.  Requires the `media:read` scope.
      * List media files
      */
     async mediaServiceList(requestParameters, initOverrides) {

package/dist/apis/MembersApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.176.2
+ * The version of the OpenAPI document: 1.177.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MembersApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.176.2
+ * The version of the OpenAPI document: 1.177.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/PageThemeTemplatesApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.176.2
+ * The version of the OpenAPI document: 1.177.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -281,7 +281,7 @@ export interface PageThemeTemplatesApiInterface {
      */
     pageThemeTemplatesServiceResolvePageThemeTemplateImagesRequestOpts(requestParameters: PageThemeTemplatesServiceResolvePageThemeTemplateImagesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Return freshly signed thumbnail, cover and badge URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
+     * Return freshly signed thumbnail, cover, badge and footer logo URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
      * @summary Resolve page theme template images
      * @param {ResolvePageThemeTemplateImagesRequest} resolvePageThemeTemplateImagesRequest
      * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
@@ -291,7 +291,7 @@ export interface PageThemeTemplatesApiInterface {
      */
     pageThemeTemplatesServiceResolvePageThemeTemplateImagesRaw(requestParameters: PageThemeTemplatesServiceResolvePageThemeTemplateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResolvePageThemeTemplateImagesResponse>>;
     /**
-     * Return freshly signed thumbnail, cover and badge URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
+     * Return freshly signed thumbnail, cover, badge and footer logo URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
      * Resolve page theme template images
      */
     pageThemeTemplatesServiceResolvePageThemeTemplateImages(requestParameters: PageThemeTemplatesServiceResolvePageThemeTemplateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResolvePageThemeTemplateImagesResponse>;
@@ -467,12 +467,12 @@ export declare class PageThemeTemplatesApi extends runtime.BaseAPI implements Pa
      */
     pageThemeTemplatesServiceResolvePageThemeTemplateImagesRequestOpts(requestParameters: PageThemeTemplatesServiceResolvePageThemeTemplateImagesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Return freshly signed thumbnail, cover and badge URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
+     * Return freshly signed thumbnail, cover, badge and footer logo URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
      * Resolve page theme template images
      */
     pageThemeTemplatesServiceResolvePageThemeTemplateImagesRaw(requestParameters: PageThemeTemplatesServiceResolvePageThemeTemplateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResolvePageThemeTemplateImagesResponse>>;
     /**
-     * Return freshly signed thumbnail, cover and badge URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
+     * Return freshly signed thumbnail, cover, badge and footer logo URLs for the given templates. The URLs expire, so callers fetch them when they need to render rather than storing them.  Requires the `page_themes:read` scope.
      * Resolve page theme template images
      */
     pageThemeTemplatesServiceResolvePageThemeTemplateImages(requestParameters: PageThemeTemplatesServiceResolvePageThemeTemplateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResolvePageThemeTemplateImagesResponse>;