@mocart-io/api 1.5.0 → 1.7.0

package/dist/generated/types.gen.d.ts

@@ -123,6 +123,26 @@ export type ProblemDetails = {
      * Present on `CREATIVE_NOT_PENDING` only: the status the creative is actually in, so a caller can reconcile without a second read.
      */
     currentStatus?: 'NOT_GENERATED' | 'QUEUED' | 'GENERATING' | 'PENDING' | 'APPROVED' | 'REJECTED' | 'FAILED';
+    /**
+     * Present on `CAMPAIGN_NOT_DELETABLE` when creatives are still generating: how many are `QUEUED` or `GENERATING`. Retry the delete once they settle.
+     */
+    generatingCount?: number;
+    /**
+     * Present on `CAMPAIGN_NOT_DELETABLE` when the campaign is still being created (`still_being_created`): retry shortly.
+     */
+    reason?: string;
+    /**
+     * Present on `LIMIT_EXCEEDED` only: the plan limit that was reached.
+     */
+    limitKey?: string;
+    /**
+     * Present on `LIMIT_EXCEEDED` only: what the plan allows.
+     */
+    limit?: number;
+    /**
+     * Present on `LIMIT_EXCEEDED` only: what the account already holds.
+     */
+    current?: number;
 };
 export type Creative = {
     /**
@@ -261,6 +281,20 @@ export type Asset = {
      * Asset creation time as an ISO-8601 string; `null` only for a legacy doc lacking a coercible one.
      */
     createdAt: string | null;
+    /**
+     * Your own key/value labels for the asset. ABSENT until the asset has at least one key.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Free-text note on the asset (at most 500 characters). ABSENT until the asset has a non-empty note.
+     */
+    notes?: string;
+    /**
+     * When the asset was deleted, as an ISO-8601 string (`null` on a live one). ABSENT on a default read; present on a read opted in with `?showDeleted=true`, and on the `DELETE` response.
+     */
+    deletedAt?: string | null;
 };
 export type AssetList = {
     /**
@@ -299,6 +333,16 @@ export type Campaign = {
      * Campaign creation time as an ISO-8601 string; `null` only for a legacy doc lacking a coercible one.
      */
     createdAt: string | null;
+    /**
+     * The partner's own string map (Stripe-style `metadata`), present ONLY when it holds at least one key — ABSENT otherwise, so a campaign that never had metadata reads exactly as before. Set it on `POST /campaigns` or `PATCH /campaigns/{id}`.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * When the campaign was deleted, as an ISO-8601 string; `null` when it is live. PRESENT ONLY when the read opted in with `?showDeleted=true`, and on the `DELETE` response. ABSENT on every other read, so a default response is byte-identical to before this field existed.
+     */
+    deletedAt?: string | null;
 };
 export type CampaignList = {
     /**
@@ -472,6 +516,62 @@ export type UpdateCreativeRequest = {
         [key: string]: string | null;
     };
 };
+export type UpdateAssetRequest = {
+    /**
+     * Shortlist the asset (`true`) or take it off the shortlist.
+     */
+    favorited?: boolean;
+    /**
+     * Free-text note, at most 500 characters. `""` clears it.
+     */
+    notes?: string;
+    /**
+     * Merged into the asset metadata: a string sets a key, `null` deletes it, an unmentioned key is untouched.
+     */
+    metadata?: {
+        [key: string]: string | null;
+    };
+};
+export type CreateCampaignRequest = {
+    /**
+     * The campaign name — 1 to 200 characters after trimming.
+     */
+    name: string;
+    /**
+     * The id of one of the account's brands.
+     */
+    brandId: string;
+    /**
+     * What the campaign produces: `STATIC` (images), `VIDEO`, `3D` or `PLAYABLE`.
+     */
+    assetType: 'VIDEO' | '3D' | 'STATIC' | 'PLAYABLE';
+    /**
+     * The output aspect ratio, e.g. `1:1` or `9:16`. A `VIDEO` campaign accepts only the video ratios.
+     */
+    format: '1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '16:9' | '21:9';
+    /**
+     * The products the campaign covers — at least one, each one of the brand's own products. One empty creative is opened per product.
+     */
+    productIds: Array<string>;
+    /**
+     * Your own string map, stored on the campaign and returned as `metadata`. Up to 50 keys; a value is a string, never `null` here (`null` only deletes a key on `PATCH`).
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+};
+export type UpdateCampaignRequest = {
+    /**
+     * The new campaign name — 1 to 200 characters after trimming.
+     */
+    name?: string;
+    /**
+     * Your own string map. Merged into the stored map key by key: a string sets the key, `null` deletes it, an unmentioned key is untouched. `{}` changes nothing.
+     */
+    metadata?: {
+        [key: string]: string | null;
+    };
+};
 export type RunCompletionEstimate = {
     /**
      * `createdAt + durationSeconds`, as an ISO 8601 UTC instant.
@@ -1155,6 +1255,10 @@ export type ListAssetsData = {
          * Optional TRUE-ONLY shortlist filter: pass `true` to return only shortlisted (favorited) assets; omit for all. Any non-`true` value is ignored (no filter). Combinable with `type` and `status`.
          */
         favorited?: boolean;
+        /**
+         * Pass `true` to include deleted resources; each one then carries a `deletedAt` timestamp (`null` on a live one). Any other value, or omitting it, keeps deleted resources hidden and the response exactly as it was before this parameter existed.
+         */
+        showDeleted?: 'true';
     };
     url: '/assets';
 };
@@ -1188,6 +1292,69 @@ export type ListAssetsResponses = {
     200: AssetList;
 };
 export type ListAssetsResponse = ListAssetsResponses[keyof ListAssetsResponses];
+export type DeleteAssetData = {
+    body?: never;
+    headers?: {
+        /**
+         * The `ETag` of the asset as you last read it. If the asset has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`). Omit it to act regardless; `*` matches any existing asset.
+         */
+        'If-Match'?: string;
+        /**
+         * Optional (16–255 characters). With one, a retry of the same request returns the same answer and records nothing new; without one the request just runs.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path: {
+        /**
+         * Stable Mocart asset document id (the `assetId` a `GET /assets` row carries).
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/assets/{id}';
+};
+export type DeleteAssetErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `assets:write` scope (`API_TOKEN_SCOPE_DENIED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found (`ASSET_NOT_FOUND`). No usable asset with this id belongs to the key's account. An asset of another account, a deleted one (except for `DELETE` and `undelete`, which act on it), or one without a stored url returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. A request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the asset. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now. Nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
+};
+export type DeleteAssetError = DeleteAssetErrors[keyof DeleteAssetErrors];
+export type DeleteAssetResponses = {
+    /**
+     * OK. The deleted asset, `deletedAt` set (or the replay of an earlier delete).
+     */
+    200: Asset;
+};
+export type DeleteAssetResponse = DeleteAssetResponses[keyof DeleteAssetResponses];
 export type GetAssetByIdData = {
     body?: never;
     path: {
@@ -1196,7 +1363,12 @@ export type GetAssetByIdData = {
          */
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Pass `true` to include deleted resources; each one then carries a `deletedAt` timestamp (`null` on a live one). Any other value, or omitting it, keeps deleted resources hidden and the response exactly as it was before this parameter existed.
+         */
+        showDeleted?: 'true';
+    };
     url: '/assets/{id}';
 };
 export type GetAssetByIdErrors = {
@@ -1209,7 +1381,7 @@ export type GetAssetByIdErrors = {
      */
     403: ProblemDetails;
     /**
-     * Not Found. No asset matched the identifier (`ASSET_NOT_FOUND`). A cross-tenant, soft-deleted, or non-usable (no stored url) asset id returns this SAME uniform 404 (no-leak).
+     * Not Found. No asset matched the identifier (`ASSET_NOT_FOUND`). A cross-tenant, soft-deleted (without `?showDeleted=true`), or non-usable (no stored url) asset id returns this SAME uniform 404 (no-leak).
      */
     404: ProblemDetails;
     /**
@@ -1225,24 +1397,33 @@ export type GetAssetByIdResponses = {
     200: Asset;
 };
 export type GetAssetByIdResponse = GetAssetByIdResponses[keyof GetAssetByIdResponses];
-export type ListCampaignsData = {
-    body?: never;
-    path?: never;
-    query?: {
+export type UpdateAssetData = {
+    /**
+     * The fields to change. The body itself may be omitted.
+     */
+    body: UpdateAssetRequest;
+    headers?: {
         /**
-         * Opaque base64url keyset cursor from a prior page's `pagination.nextCursor`. Omit for the first page; pass it back verbatim to continue.
+         * The `ETag` of the asset as you last read it. If the asset has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`). Omit it to act regardless; `*` matches any existing asset.
          */
-        cursor?: string;
+        'If-Match'?: string;
         /**
-         * Optional filter by campaign lifecycle status. When omitted, ALL non-deleted campaigns are returned (there is NO default status).
+         * Optional (16–255 characters). With one, a retry of the same request returns the same answer and records nothing new; without one the request just runs.
          */
-        status?: 'IN_PROGRESS' | 'READY' | 'BLOCKED' | 'COMPLETED';
+        'Idempotency-Key'?: string;
     };
-    url: '/campaigns';
+    path: {
+        /**
+         * Stable Mocart asset document id (the `assetId` a `GET /assets` row carries).
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/assets/{id}';
 };
-export type ListCampaignsErrors = {
+export type UpdateAssetErrors = {
     /**
-     * Bad Request. The `cursor` query parameter is not a valid opaque keyset cursor (`INVALID_CURSOR`).
+     * Bad Request. The `Idempotency-Key` header is malformed (`INVALID_IDEMPOTENCY_KEY`).
      */
     400: ProblemDetails;
     /**
@@ -1250,63 +1431,563 @@ export type ListCampaignsErrors = {
      */
     401: ProblemDetails;
     /**
-     * Forbidden. The token does not carry the required scope (`API_TOKEN_SCOPE_DENIED`).
+     * Forbidden. The key lacks the `assets:write` scope (`API_TOKEN_SCOPE_DENIED`).
      */
     403: ProblemDetails;
     /**
-     * Unprocessable Content. A query parameter failed field validation (e.g. a non-string shape); the offending fields are enumerated in `errors[]`.
+     * Not Found (`ASSET_NOT_FOUND`). No usable asset with this id belongs to the key's account. An asset of another account, a deleted one (except for `DELETE` and `undelete`, which act on it), or one without a stored url returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. A request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the asset. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Unprocessable Content (`VALIDATION_ERROR`). The body is malformed: an unknown field (`status` is never writable), `notes` over the limit, or `metadata` breaking its rules. Every offending field is listed in `errors[]`.
      */
     422: ProblemDetails;
     /**
-     * Too Many Requests. The per-token sliding window of 200 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
      */
     429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now. Nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
 };
-export type ListCampaignsError = ListCampaignsErrors[keyof ListCampaignsErrors];
-export type ListCampaignsResponses = {
+export type UpdateAssetError = UpdateAssetErrors[keyof UpdateAssetErrors];
+export type UpdateAssetResponses = {
     /**
-     * OK. One keyset-paginated page of campaigns.
+     * OK. The edited asset (or the replay of an earlier edit with this key).
      */
-    200: CampaignList;
+    200: Asset;
 };
-export type ListCampaignsResponse = ListCampaignsResponses[keyof ListCampaignsResponses];
-export type GetCampaignByIdData = {
+export type UpdateAssetResponse = UpdateAssetResponses[keyof UpdateAssetResponses];
+export type ArchiveAssetData = {
     body?: never;
+    headers: {
+        /**
+         * The `ETag` of the asset as you last read it. If the asset has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`). Omit it to act regardless; `*` matches any existing asset.
+         */
+        'If-Match'?: string;
+        /**
+         * One unique value (16–255 characters) per logical request. A retry with the same key and request returns the same asset and records nothing new.
+         */
+        'Idempotency-Key': string;
+    };
     path: {
         /**
-         * Stable Mocart campaign document id.
+         * Stable Mocart asset document id (the `assetId` a `GET /assets` row carries).
          */
-        id: string;
+        assetId: string;
     };
     query?: never;
-    url: '/campaigns/{id}';
+    url: '/assets/{assetId}/archive';
 };
-export type GetCampaignByIdErrors = {
+export type ArchiveAssetErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is missing (`IDEMPOTENCY_KEY_REQUIRED`) or malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
     /**
      * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
      */
     401: ProblemDetails;
     /**
-     * Forbidden. The token does not carry the required scope (`API_TOKEN_SCOPE_DENIED`).
+     * Forbidden. The key lacks the `assets:write` scope (`API_TOKEN_SCOPE_DENIED`).
      */
     403: ProblemDetails;
     /**
-     * Not Found. No campaign matched the identifier (`CAMPAIGN_NOT_FOUND`). A cross-tenant or soft-deleted campaign id returns this SAME uniform 404 (no-leak).
+     * Not Found (`ASSET_NOT_FOUND`). No usable asset with this id belongs to the key's account. An asset of another account, a deleted one (except for `DELETE` and `undelete`, which act on it), or one without a stored url returns this SAME uniform 404 (no-leak).
      */
     404: ProblemDetails;
     /**
-     * Too Many Requests. The per-token sliding window of 200 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     * Conflict. A request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the asset. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
      */
     429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now. Nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
 };
-export type GetCampaignByIdError = GetCampaignByIdErrors[keyof GetCampaignByIdErrors];
-export type GetCampaignByIdResponses = {
+export type ArchiveAssetError = ArchiveAssetErrors[keyof ArchiveAssetErrors];
+export type ArchiveAssetResponses = {
     /**
-     * OK. The single campaign.
+     * OK. The archived asset (or the replay of an earlier archive with this key).
      */
-    200: Campaign;
+    200: Asset;
 };
-export type GetCampaignByIdResponse = GetCampaignByIdResponses[keyof GetCampaignByIdResponses];
+export type ArchiveAssetResponse = ArchiveAssetResponses[keyof ArchiveAssetResponses];
+export type UnarchiveAssetData = {
+    body?: never;
+    headers: {
+        /**
+         * The `ETag` of the asset as you last read it. If the asset has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`). Omit it to act regardless; `*` matches any existing asset.
+         */
+        'If-Match'?: string;
+        /**
+         * One unique value (16–255 characters) per logical request. A retry with the same key and request returns the same asset and records nothing new.
+         */
+        'Idempotency-Key': string;
+    };
+    path: {
+        /**
+         * Stable Mocart asset document id (the `assetId` a `GET /assets` row carries).
+         */
+        assetId: string;
+    };
+    query?: never;
+    url: '/assets/{assetId}/unarchive';
+};
+export type UnarchiveAssetErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is missing (`IDEMPOTENCY_KEY_REQUIRED`) or malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `assets:write` scope (`API_TOKEN_SCOPE_DENIED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found (`ASSET_NOT_FOUND`). No usable asset with this id belongs to the key's account. An asset of another account, a deleted one (except for `DELETE` and `undelete`, which act on it), or one without a stored url returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. A request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the asset. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now. Nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
+};
+export type UnarchiveAssetError = UnarchiveAssetErrors[keyof UnarchiveAssetErrors];
+export type UnarchiveAssetResponses = {
+    /**
+     * OK. The unarchived asset (or the replay of an earlier unarchive with this key).
+     */
+    200: Asset;
+};
+export type UnarchiveAssetResponse = UnarchiveAssetResponses[keyof UnarchiveAssetResponses];
+export type UndeleteAssetData = {
+    body?: never;
+    headers: {
+        /**
+         * The `ETag` of the asset as you last read it. If the asset has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`). Omit it to act regardless; `*` matches any existing asset.
+         */
+        'If-Match'?: string;
+        /**
+         * One unique value (16–255 characters) per logical request. A retry with the same key and request returns the same asset and records nothing new.
+         */
+        'Idempotency-Key': string;
+    };
+    path: {
+        /**
+         * Stable Mocart asset document id (the `assetId` a `GET /assets` row carries).
+         */
+        assetId: string;
+    };
+    query?: never;
+    url: '/assets/{assetId}/undelete';
+};
+export type UndeleteAssetErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is missing (`IDEMPOTENCY_KEY_REQUIRED`) or malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `assets:write` scope (`API_TOKEN_SCOPE_DENIED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found (`ASSET_NOT_FOUND`). No usable asset with this id belongs to the key's account. An asset of another account, a deleted one (except for `DELETE` and `undelete`, which act on it), or one without a stored url returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. A request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the asset. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now. Nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
+};
+export type UndeleteAssetError = UndeleteAssetErrors[keyof UndeleteAssetErrors];
+export type UndeleteAssetResponses = {
+    /**
+     * OK. The restored asset (or the replay of an earlier restore with this key).
+     */
+    200: Asset;
+};
+export type UndeleteAssetResponse = UndeleteAssetResponses[keyof UndeleteAssetResponses];
+export type ListCampaignsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Opaque base64url keyset cursor from a prior page's `pagination.nextCursor`. Omit for the first page; pass it back verbatim to continue.
+         */
+        cursor?: string;
+        /**
+         * Optional filter by campaign lifecycle status. When omitted, ALL non-deleted campaigns are returned (there is NO default status).
+         */
+        status?: 'IN_PROGRESS' | 'READY' | 'BLOCKED' | 'COMPLETED';
+        /**
+         * Pass `true` to include deleted resources; each one then carries a `deletedAt` timestamp (`null` on a live one). Any other value, or omitting it, keeps deleted resources hidden and the response exactly as it was before this parameter existed.
+         */
+        showDeleted?: 'true';
+    };
+    url: '/campaigns';
+};
+export type ListCampaignsErrors = {
+    /**
+     * Bad Request. The `cursor` query parameter is not a valid opaque keyset cursor (`INVALID_CURSOR`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The token does not carry the required scope (`API_TOKEN_SCOPE_DENIED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Unprocessable Content. A query parameter failed field validation (e.g. a non-string shape); the offending fields are enumerated in `errors[]`.
+     */
+    422: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 200 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+};
+export type ListCampaignsError = ListCampaignsErrors[keyof ListCampaignsErrors];
+export type ListCampaignsResponses = {
+    /**
+     * OK. One keyset-paginated page of campaigns.
+     */
+    200: CampaignList;
+};
+export type ListCampaignsResponse = ListCampaignsResponses[keyof ListCampaignsResponses];
+export type CreateCampaignData = {
+    /**
+     * The campaign to create. `productIds` is required and non-empty; an unknown field is a 422.
+     */
+    body: CreateCampaignRequest;
+    headers: {
+        /**
+         * One unique value (16–255 characters) per logical request. A retry with the same key and request returns the same campaign and records nothing new.
+         */
+        'Idempotency-Key': string;
+    };
+    path?: never;
+    query?: never;
+    url: '/campaigns';
+};
+export type CreateCampaignErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is missing (`IDEMPOTENCY_KEY_REQUIRED`) or malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `campaigns:write` scope (`API_TOKEN_SCOPE_DENIED`); the account's plan does not include campaigns (`TIER_REQUIRED`); or the account is at its plan's campaign or products-per-campaign limit (`LIMIT_EXCEEDED`, with `limitKey`, `limit` and `current`) — a plan limit is `403`, never `429`.
+     */
+    403: ProblemDetails;
+    /**
+     * Conflict. a request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Unprocessable Content (`VALIDATION_ERROR`). The body is malformed — an unknown field, an empty `productIds`, a `VIDEO` format outside the video ratios, an invalid `metadata` — or `brandId` or a product id is not the account's own (a missing id and another account's are the same answer); every offending field is listed in `errors[]`.
+     */
+    422: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable. Writes are paused for this account (`WRITES_PAUSED`), or too many campaigns were being created at once and this one lost the race (`SERVICE_UNAVAILABLE`). Nothing was created and the `Idempotency-Key` is still usable: retry the SAME request after `Retry-After`.
+     */
+    503: ProblemDetails;
+};
+export type CreateCampaignError = CreateCampaignErrors[keyof CreateCampaignErrors];
+export type CreateCampaignResponses = {
+    /**
+     * Created — or the replay of an earlier create with this key.
+     */
+    201: Campaign;
+};
+export type CreateCampaignResponse = CreateCampaignResponses[keyof CreateCampaignResponses];
+export type DeleteCampaignData = {
+    body?: never;
+    headers?: {
+        /**
+         * Optional. The strong `ETag` of the campaign as you last read it (`GET /campaigns/{id}`), or `*`. When the campaign has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`).
+         */
+        'If-Match'?: string;
+        /**
+         * Optional (16–255 characters). With one, a retry of the same request returns the same answer and records nothing new; without one the request just runs.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path: {
+        /**
+         * Stable Mocart campaign document id (the `campaignId` a `GET /campaigns` row carries).
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/campaigns/{id}';
+};
+export type DeleteCampaignErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `campaigns:write` scope (`API_TOKEN_SCOPE_DENIED`), or the account's plan does not include campaigns (`TIER_REQUIRED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found (`CAMPAIGN_NOT_FOUND`). No campaign with this id belongs to the key's account — a campaign of another account returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. The campaign holds creatives that are `QUEUED` or `GENERATING` (`CAMPAIGN_NOT_DELETABLE`, how many in `generatingCount`), or is still being created (the same code, `reason` `still_being_created`); or its previous change is still finishing (`CAMPAIGN_CASCADE_PENDING`, retry after `Retry-After`); or a request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the campaign. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now — nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
+};
+export type DeleteCampaignError = DeleteCampaignErrors[keyof DeleteCampaignErrors];
+export type DeleteCampaignResponses = {
+    /**
+     * OK. The deleted campaign, `deletedAt` set (or the replay of an earlier delete with this key).
+     */
+    200: Campaign;
+};
+export type DeleteCampaignResponse = DeleteCampaignResponses[keyof DeleteCampaignResponses];
+export type GetCampaignByIdData = {
+    body?: never;
+    path: {
+        /**
+         * Stable Mocart campaign document id.
+         */
+        id: string;
+    };
+    query?: {
+        /**
+         * Pass `true` to include deleted resources; each one then carries a `deletedAt` timestamp (`null` on a live one). Any other value, or omitting it, keeps deleted resources hidden and the response exactly as it was before this parameter existed.
+         */
+        showDeleted?: 'true';
+    };
+    url: '/campaigns/{id}';
+};
+export type GetCampaignByIdErrors = {
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The token does not carry the required scope (`API_TOKEN_SCOPE_DENIED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found. No campaign matched the identifier (`CAMPAIGN_NOT_FOUND`). A cross-tenant or soft-deleted (without `?showDeleted=true`) campaign id returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 200 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+};
+export type GetCampaignByIdError = GetCampaignByIdErrors[keyof GetCampaignByIdErrors];
+export type GetCampaignByIdResponses = {
+    /**
+     * OK. The single campaign.
+     */
+    200: Campaign;
+};
+export type GetCampaignByIdResponse = GetCampaignByIdResponses[keyof GetCampaignByIdResponses];
+export type UpdateCampaignData = {
+    /**
+     * The fields to change. Every field is optional; an unknown field is a 422.
+     */
+    body: UpdateCampaignRequest;
+    headers?: {
+        /**
+         * Optional. The strong `ETag` of the campaign as you last read it (`GET /campaigns/{id}`), or `*`. When the campaign has changed since, nothing is done and the answer is `412` (`PRECONDITION_FAILED`).
+         */
+        'If-Match'?: string;
+        /**
+         * Optional (16–255 characters). With one, a retry of the same request returns the same answer and records nothing new; without one the request just runs.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path: {
+        /**
+         * Stable Mocart campaign document id (the `campaignId` a `GET /campaigns` row carries).
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/campaigns/{id}';
+};
+export type UpdateCampaignErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `campaigns:write` scope (`API_TOKEN_SCOPE_DENIED`), or the account's plan does not include campaigns (`TIER_REQUIRED`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found (`CAMPAIGN_NOT_FOUND`). No campaign with this id belongs to the key's account — a campaign of another account returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. a request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Precondition Failed (`PRECONDITION_FAILED`). `If-Match` no longer matches the campaign. Nothing was changed; read it again and retry.
+     */
+    412: ProblemDetails;
+    /**
+     * Unprocessable Content (`VALIDATION_ERROR`). The body is malformed — an unknown field, an empty or over-long `name`, an invalid `metadata` key or value, or a merge that would leave more than 50 keys; every offending field is listed in `errors[]`.
+     */
+    422: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable (`WRITES_PAUSED`). Writes are paused for this account right now — nothing was changed and the `Idempotency-Key` was not consumed, so retry the SAME request after `Retry-After`. Reads are unaffected.
+     */
+    503: ProblemDetails;
+};
+export type UpdateCampaignError = UpdateCampaignErrors[keyof UpdateCampaignErrors];
+export type UpdateCampaignResponses = {
+    /**
+     * OK. The campaign after the edit (or the replay of an earlier edit with this key).
+     */
+    200: Campaign;
+};
+export type UpdateCampaignResponse = UpdateCampaignResponses[keyof UpdateCampaignResponses];
+export type UndeleteCampaignData = {
+    body?: never;
+    headers: {
+        /**
+         * One unique value (16–255 characters) per logical request. A retry with the same key and request returns the same campaign and records nothing new.
+         */
+        'Idempotency-Key': string;
+    };
+    path: {
+        /**
+         * Stable Mocart campaign document id (the `campaignId` a `GET /campaigns` row carries).
+         */
+        campaignId: string;
+    };
+    query?: never;
+    url: '/campaigns/{campaignId}/undelete';
+};
+export type UndeleteCampaignErrors = {
+    /**
+     * Bad Request. The `Idempotency-Key` header is missing (`IDEMPOTENCY_KEY_REQUIRED`) or malformed (`INVALID_IDEMPOTENCY_KEY`).
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized. Missing, malformed, unknown, revoked, or expired bearer token — or the token owner no longer holds the required entitlement (`ENTITLEMENT_LOST`). A uniform problem body is returned with a distinct `code`; no owner/condition detail (no-leak).
+     */
+    401: ProblemDetails;
+    /**
+     * Forbidden. The key lacks the `campaigns:write` scope, the account's plan does not include campaigns, or restoring would put the account over its plan’s campaign limit (`LIMIT_EXCEEDED`, with `limitKey`, `limit` and `current`).
+     */
+    403: ProblemDetails;
+    /**
+     * Not Found (`CAMPAIGN_NOT_FOUND`). No campaign with this id belongs to the key's account — a campaign of another account returns this SAME uniform 404 (no-leak).
+     */
+    404: ProblemDetails;
+    /**
+     * Conflict. The campaign's previous change is still finishing (`CAMPAIGN_CASCADE_PENDING`, retry after `Retry-After`); or a request under this key is still in progress (`IDEMPOTENCY_IN_PROGRESS`, retry after `Retry-After`); or the key was already used for a different request (`IDEMPOTENCY_KEY_REUSED`).
+     */
+    409: ProblemDetails;
+    /**
+     * Too Many Requests. The per-token sliding window of 60 requests/minute was exceeded. The body is express-rate-limit's DEFAULT plain-text message (NOT the JSON problem+json envelope).
+     */
+    429: string;
+    /**
+     * Service Unavailable. Writes are paused for this account (`WRITES_PAUSED`), or another campaign write raced this restore at the plan limit and it lost (`SERVICE_UNAVAILABLE`). Nothing was changed and the `Idempotency-Key` is still usable: retry the SAME request after `Retry-After`.
+     */
+    503: ProblemDetails;
+};
+export type UndeleteCampaignError = UndeleteCampaignErrors[keyof UndeleteCampaignErrors];
+export type UndeleteCampaignResponses = {
+    /**
+     * OK. The restored campaign (or the replay of an earlier restore with this key).
+     */
+    200: Campaign;
+};
+export type UndeleteCampaignResponse = UndeleteCampaignResponses[keyof UndeleteCampaignResponses];
 export type ListDeliveriesData = {
     body?: never;
     path?: never;