linkbreakers 1.186.1 → 1.187.0

package/dist/models/RetargetingPixelScope.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfRetargetingPixelScope = instanceOfRetargetingPixelScope;
+exports.RetargetingPixelScopeFromJSON = RetargetingPixelScopeFromJSON;
+exports.RetargetingPixelScopeFromJSONTyped = RetargetingPixelScopeFromJSONTyped;
+exports.RetargetingPixelScopeToJSON = RetargetingPixelScopeToJSON;
+exports.RetargetingPixelScopeToJSONTyped = RetargetingPixelScopeToJSONTyped;
+const RetargetingPixelScopeType_1 = require("./RetargetingPixelScopeType");
+const RetargetingPixel_1 = require("./RetargetingPixel");
+/**
+ * Check if a given object implements the RetargetingPixelScope interface.
+ */
+function instanceOfRetargetingPixelScope(value) {
+    return true;
+}
+function RetargetingPixelScopeFromJSON(json) {
+    return RetargetingPixelScopeFromJSONTyped(json, false);
+}
+function RetargetingPixelScopeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'directoryIds': json['directoryIds'] == null ? undefined : json['directoryIds'],
+        'linkIds': json['linkIds'] == null ? undefined : json['linkIds'],
+        'pixel': json['pixel'] == null ? undefined : (0, RetargetingPixel_1.RetargetingPixelFromJSON)(json['pixel']),
+        'scope': json['scope'] == null ? undefined : (0, RetargetingPixelScopeType_1.RetargetingPixelScopeTypeFromJSON)(json['scope']),
+        'tagIds': json['tagIds'] == null ? undefined : json['tagIds'],
+    };
+}
+function RetargetingPixelScopeToJSON(json) {
+    return RetargetingPixelScopeToJSONTyped(json, false);
+}
+function RetargetingPixelScopeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'directoryIds': value['directoryIds'],
+        'linkIds': value['linkIds'],
+        'pixel': (0, RetargetingPixel_1.RetargetingPixelToJSON)(value['pixel']),
+        'scope': (0, RetargetingPixelScopeType_1.RetargetingPixelScopeTypeToJSON)(value['scope']),
+        'tagIds': value['tagIds'],
+    };
+}

package/dist/models/RetargetingPixelScopeType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * RetargetingPixelScopeType says which links a pixel fires on.
+ *
+ *  - RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS: Every link of the workspace, the default.
+ *  - RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS: Only the chosen links, the links of the chosen directories (and of every
+ * directory below them) and the links carrying the chosen tags.
+ * @export
+ */
+export declare const RetargetingPixelScopeType: {
+    readonly RetargetingPixelScopeTypeUnspecified: "RETARGETING_PIXEL_SCOPE_TYPE_UNSPECIFIED";
+    readonly RetargetingPixelScopeTypeAllLinks: "RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS";
+    readonly RetargetingPixelScopeTypeSelectedLinks: "RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS";
+};
+export type RetargetingPixelScopeType = typeof RetargetingPixelScopeType[keyof typeof RetargetingPixelScopeType];
+export declare function instanceOfRetargetingPixelScopeType(value: any): boolean;
+export declare function RetargetingPixelScopeTypeFromJSON(json: any): RetargetingPixelScopeType;
+export declare function RetargetingPixelScopeTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetargetingPixelScopeType;
+export declare function RetargetingPixelScopeTypeToJSON(value?: RetargetingPixelScopeType | null): any;
+export declare function RetargetingPixelScopeTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): RetargetingPixelScopeType;

package/dist/models/RetargetingPixelScopeType.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetargetingPixelScopeType = void 0;
+exports.instanceOfRetargetingPixelScopeType = instanceOfRetargetingPixelScopeType;
+exports.RetargetingPixelScopeTypeFromJSON = RetargetingPixelScopeTypeFromJSON;
+exports.RetargetingPixelScopeTypeFromJSONTyped = RetargetingPixelScopeTypeFromJSONTyped;
+exports.RetargetingPixelScopeTypeToJSON = RetargetingPixelScopeTypeToJSON;
+exports.RetargetingPixelScopeTypeToJSONTyped = RetargetingPixelScopeTypeToJSONTyped;
+/**
+ * RetargetingPixelScopeType says which links a pixel fires on.
+ *
+ *  - RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS: Every link of the workspace, the default.
+ *  - RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS: Only the chosen links, the links of the chosen directories (and of every
+ * directory below them) and the links carrying the chosen tags.
+ * @export
+ */
+exports.RetargetingPixelScopeType = {
+    RetargetingPixelScopeTypeUnspecified: 'RETARGETING_PIXEL_SCOPE_TYPE_UNSPECIFIED',
+    RetargetingPixelScopeTypeAllLinks: 'RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS',
+    RetargetingPixelScopeTypeSelectedLinks: 'RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS'
+};
+function instanceOfRetargetingPixelScopeType(value) {
+    for (const key in exports.RetargetingPixelScopeType) {
+        if (Object.prototype.hasOwnProperty.call(exports.RetargetingPixelScopeType, key)) {
+            if (exports.RetargetingPixelScopeType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function RetargetingPixelScopeTypeFromJSON(json) {
+    return RetargetingPixelScopeTypeFromJSONTyped(json, false);
+}
+function RetargetingPixelScopeTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function RetargetingPixelScopeTypeToJSON(value) {
+    return value;
+}
+function RetargetingPixelScopeTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/RetargetingPixels.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { RetargetingPixelScope } from './RetargetingPixelScope';
+/**
+ * The ad platform pixels a workspace fires on visits to its links.
+ * @export
+ * @interface RetargetingPixels
+ */
+export interface RetargetingPixels {
+    /**
+     * Google tag ID: a Google Analytics 4 measurement ID ("G-XXXXXXX") or a
+     * Google Ads tag ("AW-123456789").
+     * @type {string}
+     * @memberof RetargetingPixels
+     */
+    googleTagId?: string;
+    /**
+     * Google Tag Manager container ID ("GTM-XXXXXXX"), to fire anything else
+     * set up in that container.
+     * @type {string}
+     * @memberof RetargetingPixels
+     */
+    gtmContainerId?: string;
+    /**
+     * LinkedIn Insight Tag partner ID, digits only, e.g. "1234567".
+     * @type {string}
+     * @memberof RetargetingPixels
+     */
+    linkedinPartnerId?: string;
+    /**
+     * Meta (Facebook, Instagram) Pixel ID, digits only, e.g. "123456789012345".
+     * @type {string}
+     * @memberof RetargetingPixels
+     */
+    metaPixelId?: string;
+    /**
+     * One scope per pixel that is set: which links it fires on. A deleted
+     * link, directory or tag no longer appears in a selection.
+     * @type {Array<RetargetingPixelScope>}
+     * @memberof RetargetingPixels
+     */
+    scopes?: Array<RetargetingPixelScope>;
+    /**
+     * TikTok pixel ID, e.g. "C4ABCDEFGHIJKLMNOPQR".
+     * @type {string}
+     * @memberof RetargetingPixels
+     */
+    tiktokPixelId?: string;
+    /**
+     * When the pixels were last changed. Absent when none were ever set.
+     * @type {Date}
+     * @memberof RetargetingPixels
+     */
+    updatedAt?: Date;
+}
+/**
+ * Check if a given object implements the RetargetingPixels interface.
+ */
+export declare function instanceOfRetargetingPixels(value: object): value is RetargetingPixels;
+export declare function RetargetingPixelsFromJSON(json: any): RetargetingPixels;
+export declare function RetargetingPixelsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetargetingPixels;
+export declare function RetargetingPixelsToJSON(json: any): RetargetingPixels;
+export declare function RetargetingPixelsToJSONTyped(value?: RetargetingPixels | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RetargetingPixels.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfRetargetingPixels = instanceOfRetargetingPixels;
+exports.RetargetingPixelsFromJSON = RetargetingPixelsFromJSON;
+exports.RetargetingPixelsFromJSONTyped = RetargetingPixelsFromJSONTyped;
+exports.RetargetingPixelsToJSON = RetargetingPixelsToJSON;
+exports.RetargetingPixelsToJSONTyped = RetargetingPixelsToJSONTyped;
+const RetargetingPixelScope_1 = require("./RetargetingPixelScope");
+/**
+ * Check if a given object implements the RetargetingPixels interface.
+ */
+function instanceOfRetargetingPixels(value) {
+    return true;
+}
+function RetargetingPixelsFromJSON(json) {
+    return RetargetingPixelsFromJSONTyped(json, false);
+}
+function RetargetingPixelsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'googleTagId': json['googleTagId'] == null ? undefined : json['googleTagId'],
+        'gtmContainerId': json['gtmContainerId'] == null ? undefined : json['gtmContainerId'],
+        'linkedinPartnerId': json['linkedinPartnerId'] == null ? undefined : json['linkedinPartnerId'],
+        'metaPixelId': json['metaPixelId'] == null ? undefined : json['metaPixelId'],
+        'scopes': json['scopes'] == null ? undefined : (json['scopes'].map(RetargetingPixelScope_1.RetargetingPixelScopeFromJSON)),
+        'tiktokPixelId': json['tiktokPixelId'] == null ? undefined : json['tiktokPixelId'],
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+function RetargetingPixelsToJSON(json) {
+    return RetargetingPixelsToJSONTyped(json, false);
+}
+function RetargetingPixelsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'googleTagId': value['googleTagId'],
+        'gtmContainerId': value['gtmContainerId'],
+        'linkedinPartnerId': value['linkedinPartnerId'],
+        'metaPixelId': value['metaPixelId'],
+        'scopes': value['scopes'] == null ? undefined : (value['scopes'].map(RetargetingPixelScope_1.RetargetingPixelScopeToJSON)),
+        'tiktokPixelId': value['tiktokPixelId'],
+        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+    };
+}

package/dist/models/ReviewPlatform.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * ReviewPlatform is a site where Linkbreakers can be reviewed.
+ *
+ *  - REVIEW_PLATFORM_UNSPECIFIED: Not specified
+ *  - REVIEW_PLATFORM_G2: G2 (g2.com)
+ *  - REVIEW_PLATFORM_CAPTERRA: Capterra (capterra.com)
+ *  - REVIEW_PLATFORM_TRUSTPILOT: Trustpilot (trustpilot.com)
+ * @export
+ */
+export declare const ReviewPlatform: {
+    readonly ReviewPlatformUnspecified: "REVIEW_PLATFORM_UNSPECIFIED";
+    readonly ReviewPlatformG2: "REVIEW_PLATFORM_G2";
+    readonly ReviewPlatformCapterra: "REVIEW_PLATFORM_CAPTERRA";
+    readonly ReviewPlatformTrustpilot: "REVIEW_PLATFORM_TRUSTPILOT";
+};
+export type ReviewPlatform = typeof ReviewPlatform[keyof typeof ReviewPlatform];
+export declare function instanceOfReviewPlatform(value: any): boolean;
+export declare function ReviewPlatformFromJSON(json: any): ReviewPlatform;
+export declare function ReviewPlatformFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewPlatform;
+export declare function ReviewPlatformToJSON(value?: ReviewPlatform | null): any;
+export declare function ReviewPlatformToJSONTyped(value: any, ignoreDiscriminator: boolean): ReviewPlatform;

package/dist/models/ReviewPlatform.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReviewPlatform = void 0;
+exports.instanceOfReviewPlatform = instanceOfReviewPlatform;
+exports.ReviewPlatformFromJSON = ReviewPlatformFromJSON;
+exports.ReviewPlatformFromJSONTyped = ReviewPlatformFromJSONTyped;
+exports.ReviewPlatformToJSON = ReviewPlatformToJSON;
+exports.ReviewPlatformToJSONTyped = ReviewPlatformToJSONTyped;
+/**
+ * ReviewPlatform is a site where Linkbreakers can be reviewed.
+ *
+ *  - REVIEW_PLATFORM_UNSPECIFIED: Not specified
+ *  - REVIEW_PLATFORM_G2: G2 (g2.com)
+ *  - REVIEW_PLATFORM_CAPTERRA: Capterra (capterra.com)
+ *  - REVIEW_PLATFORM_TRUSTPILOT: Trustpilot (trustpilot.com)
+ * @export
+ */
+exports.ReviewPlatform = {
+    ReviewPlatformUnspecified: 'REVIEW_PLATFORM_UNSPECIFIED',
+    ReviewPlatformG2: 'REVIEW_PLATFORM_G2',
+    ReviewPlatformCapterra: 'REVIEW_PLATFORM_CAPTERRA',
+    ReviewPlatformTrustpilot: 'REVIEW_PLATFORM_TRUSTPILOT'
+};
+function instanceOfReviewPlatform(value) {
+    for (const key in exports.ReviewPlatform) {
+        if (Object.prototype.hasOwnProperty.call(exports.ReviewPlatform, key)) {
+            if (exports.ReviewPlatform[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ReviewPlatformFromJSON(json) {
+    return ReviewPlatformFromJSONTyped(json, false);
+}
+function ReviewPlatformFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ReviewPlatformToJSON(value) {
+    return value;
+}
+function ReviewPlatformToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/ReviewPlatformProfile.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReviewPlatform } from './ReviewPlatform';
+/**
+ * ReviewPlatformProfile is the Linkbreakers page on a review site.
+ * @export
+ * @interface ReviewPlatformProfile
+ */
+export interface ReviewPlatformProfile {
+    /**
+     * Display name, e.g. "G2".
+     * @type {string}
+     * @memberof ReviewPlatformProfile
+     */
+    name?: string;
+    /**
+     *
+     * @type {ReviewPlatform}
+     * @memberof ReviewPlatformProfile
+     */
+    platform?: ReviewPlatform;
+    /**
+     * Where to write the review.
+     * @type {string}
+     * @memberof ReviewPlatformProfile
+     */
+    url?: string;
+}
+/**
+ * Check if a given object implements the ReviewPlatformProfile interface.
+ */
+export declare function instanceOfReviewPlatformProfile(value: object): value is ReviewPlatformProfile;
+export declare function ReviewPlatformProfileFromJSON(json: any): ReviewPlatformProfile;
+export declare function ReviewPlatformProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewPlatformProfile;
+export declare function ReviewPlatformProfileToJSON(json: any): ReviewPlatformProfile;
+export declare function ReviewPlatformProfileToJSONTyped(value?: ReviewPlatformProfile | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReviewPlatformProfile.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReviewPlatformProfile = instanceOfReviewPlatformProfile;
+exports.ReviewPlatformProfileFromJSON = ReviewPlatformProfileFromJSON;
+exports.ReviewPlatformProfileFromJSONTyped = ReviewPlatformProfileFromJSONTyped;
+exports.ReviewPlatformProfileToJSON = ReviewPlatformProfileToJSON;
+exports.ReviewPlatformProfileToJSONTyped = ReviewPlatformProfileToJSONTyped;
+const ReviewPlatform_1 = require("./ReviewPlatform");
+/**
+ * Check if a given object implements the ReviewPlatformProfile interface.
+ */
+function instanceOfReviewPlatformProfile(value) {
+    return true;
+}
+function ReviewPlatformProfileFromJSON(json) {
+    return ReviewPlatformProfileFromJSONTyped(json, false);
+}
+function ReviewPlatformProfileFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'platform': json['platform'] == null ? undefined : (0, ReviewPlatform_1.ReviewPlatformFromJSON)(json['platform']),
+        'url': json['url'] == null ? undefined : json['url'],
+    };
+}
+function ReviewPlatformProfileToJSON(json) {
+    return ReviewPlatformProfileToJSONTyped(json, false);
+}
+function ReviewPlatformProfileToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'platform': (0, ReviewPlatform_1.ReviewPlatformToJSON)(value['platform']),
+        'url': value['url'],
+    };
+}

package/dist/models/ReviewReward.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.  ## Identifying your client  Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
+ *
+ * The version of the OpenAPI document: 1.187.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReviewRewardStatus } from './ReviewRewardStatus';
+import type { ReviewPlatform } from './ReviewPlatform';
+/**
+ * A review a member submitted in exchange for free Pro months.
+ * @export
+ * @interface ReviewReward
+ */
+export interface ReviewReward {
+    /**
+     * When the team approved or disregarded it.
+     * @type {Date}
+     * @memberof ReviewReward
+     */
+    decidedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof ReviewReward
+     */
+    id?: string;
+    /**
+     *
+     * @type {ReviewPlatform}
+     * @memberof ReviewReward
+     */
+    platform?: ReviewPlatform;
+    /**
+     * Link to the review on the platform.
+     * @type {string}
+     * @memberof ReviewReward
+     */
+    reviewUrl?: string;
+    /**
+     * The name the review was posted under, to help find it.
+     * @type {string}
+     * @memberof ReviewReward
+     */
+    reviewerName?: string;
+    /**
+     * When the free Pro months end, once approved.
+     * @type {Date}
+     * @memberof ReviewReward
+     */
+    rewardEndsAt?: Date;
+    /**
+     *
+     * @type {ReviewRewardStatus}
+     * @memberof ReviewReward
+     */
+    status?: ReviewRewardStatus;
+    /**
+     *
+     * @type {Date}
+     * @memberof ReviewReward
+     */
+    submittedAt?: Date;
+}
+/**
+ * Check if a given object implements the ReviewReward interface.
+ */
+export declare function instanceOfReviewReward(value: object): value is ReviewReward;
+export declare function ReviewRewardFromJSON(json: any): ReviewReward;
+export declare function ReviewRewardFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewReward;
+export declare function ReviewRewardToJSON(json: any): ReviewReward;
+export declare function ReviewRewardToJSONTyped(value?: ReviewReward | null, ignoreDiscriminator?: boolean): any;