@defoai/ads-client 1.4.0

package/dist/generated/apis/SitesApi.d.ts

@@ -0,0 +1,163 @@
+/**
+ * Defo Ads Public API
+ * Stable public API for managing campaigns, ads, keywords, and sites.
+ *
+ * The version of the OpenAPI document: 1.4.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 * as runtime from '../runtime';
+import type { CampaignsListCursorParameter, SiteCreate, SiteUpdate, SuccessEnvelope } from '../models/index';
+export interface SitesCreateRequest {
+    siteCreate: SiteCreate;
+    xSpaceId?: string;
+}
+export interface SitesDeleteRequest {
+    id: string;
+    xSpaceId?: string;
+}
+export interface SitesGetRequest {
+    id: string;
+    xSpaceId?: string;
+}
+export interface SitesListRequest {
+    limit?: number;
+    cursor?: CampaignsListCursorParameter;
+    xSpaceId?: string;
+}
+export interface SitesUpdateRequest {
+    id: string;
+    siteUpdate: SiteUpdate;
+    xSpaceId?: string;
+}
+/**
+ * SitesApi - interface
+ *
+ * @export
+ * @interface SitesApiInterface
+ */
+export interface SitesApiInterface {
+    /**
+     *
+     * @summary Create site
+     * @param {SiteCreate} siteCreate
+     * @param {string} [xSpaceId] Target Space ID (e.g. `spc_…`). Omit to use the caller\'s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SitesApiInterface
+     */
+    sitesCreateRaw(requestParameters: SitesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Create site
+     */
+    sitesCreate(requestParameters: SitesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Returns 409 CONFLICT with `details: { campaigns }` when one or more campaigns still reference the site. Delete or reassign those campaigns first; no cascade is offered.
+     * @summary Delete site
+     * @param {string} id
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SitesApiInterface
+     */
+    sitesDeleteRaw(requestParameters: SitesDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Returns 409 CONFLICT with `details: { campaigns }` when one or more campaigns still reference the site. Delete or reassign those campaigns first; no cascade is offered.
+     * Delete site
+     */
+    sitesDelete(requestParameters: SitesDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     *
+     * @summary Get site
+     * @param {string} id
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SitesApiInterface
+     */
+    sitesGetRaw(requestParameters: SitesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Get site
+     */
+    sitesGet(requestParameters: SitesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     *
+     * @summary List sites
+     * @param {number} [limit] Maximum items to return. Default 50, max 200.
+     * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SitesApiInterface
+     */
+    sitesListRaw(requestParameters: SitesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * List sites
+     */
+    sitesList(requestParameters: SitesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     *
+     * @summary Update site
+     * @param {string} id
+     * @param {SiteUpdate} siteUpdate
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SitesApiInterface
+     */
+    sitesUpdateRaw(requestParameters: SitesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Update site
+     */
+    sitesUpdate(requestParameters: SitesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+}
+/**
+ *
+ */
+export declare class SitesApi extends runtime.BaseAPI implements SitesApiInterface {
+    /**
+     * Create site
+     */
+    sitesCreateRaw(requestParameters: SitesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Create site
+     */
+    sitesCreate(requestParameters: SitesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Returns 409 CONFLICT with `details: { campaigns }` when one or more campaigns still reference the site. Delete or reassign those campaigns first; no cascade is offered.
+     * Delete site
+     */
+    sitesDeleteRaw(requestParameters: SitesDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Returns 409 CONFLICT with `details: { campaigns }` when one or more campaigns still reference the site. Delete or reassign those campaigns first; no cascade is offered.
+     * Delete site
+     */
+    sitesDelete(requestParameters: SitesDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Get site
+     */
+    sitesGetRaw(requestParameters: SitesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Get site
+     */
+    sitesGet(requestParameters: SitesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * List sites
+     */
+    sitesListRaw(requestParameters: SitesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * List sites
+     */
+    sitesList(requestParameters?: SitesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Update site
+     */
+    sitesUpdateRaw(requestParameters: SitesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Update site
+     */
+    sitesUpdate(requestParameters: SitesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+}

package/dist/generated/apis/SitesApi.js

@@ -0,0 +1,202 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Defo Ads Public API
+ * Stable public API for managing campaigns, ads, keywords, and sites.
+ *
+ * The version of the OpenAPI document: 1.4.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 * as runtime from '../runtime';
+import { SiteCreateToJSON, SiteUpdateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class SitesApi extends runtime.BaseAPI {
+    /**
+     * Create site
+     */
+    async sitesCreateRaw(requestParameters, initOverrides) {
+        if (requestParameters['siteCreate'] == null) {
+            throw new runtime.RequiredError('siteCreate', 'Required parameter "siteCreate" was null or undefined when calling sitesCreate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xSpaceId'] != null) {
+            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiToken", ["sites:write"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sites`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SiteCreateToJSON(requestParameters['siteCreate']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+    /**
+     * Create site
+     */
+    async sitesCreate(requestParameters, initOverrides) {
+        const response = await this.sitesCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns 409 CONFLICT with `details: { campaigns }` when one or more campaigns still reference the site. Delete or reassign those campaigns first; no cascade is offered.
+     * Delete site
+     */
+    async sitesDeleteRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling sitesDelete().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xSpaceId'] != null) {
+            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiToken", ["sites:write"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sites/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+    /**
+     * Returns 409 CONFLICT with `details: { campaigns }` when one or more campaigns still reference the site. Delete or reassign those campaigns first; no cascade is offered.
+     * Delete site
+     */
+    async sitesDelete(requestParameters, initOverrides) {
+        const response = await this.sitesDeleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Get site
+     */
+    async sitesGetRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling sitesGet().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xSpaceId'] != null) {
+            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiToken", ["sites:read"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sites/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+    /**
+     * Get site
+     */
+    async sitesGet(requestParameters, initOverrides) {
+        const response = await this.sitesGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * List sites
+     */
+    async sitesListRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+        const headerParameters = {};
+        if (requestParameters['xSpaceId'] != null) {
+            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiToken", ["sites:read"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sites`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+    /**
+     * List sites
+     */
+    async sitesList(requestParameters = {}, initOverrides) {
+        const response = await this.sitesListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Update site
+     */
+    async sitesUpdateRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling sitesUpdate().');
+        }
+        if (requestParameters['siteUpdate'] == null) {
+            throw new runtime.RequiredError('siteUpdate', 'Required parameter "siteUpdate" was null or undefined when calling sitesUpdate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xSpaceId'] != null) {
+            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiToken", ["sites:write"]);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sites/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SiteUpdateToJSON(requestParameters['siteUpdate']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+    /**
+     * Update site
+     */
+    async sitesUpdate(requestParameters, initOverrides) {
+        const response = await this.sitesUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}

package/dist/generated/apis/SyncApi.d.ts

@@ -0,0 +1,199 @@
+/**
+ * Defo Ads Public API
+ * Stable public API for managing campaigns, ads, keywords, and sites.
+ *
+ * The version of the OpenAPI document: 1.4.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 * as runtime from '../runtime';
+import type { CampaignsListCursorParameter, SuccessEnvelope, SyncTriggerRequest, SyncUnlinkRequest } from '../models/index';
+export interface SyncCancelRequest {
+    id: string;
+    xSpaceId?: string;
+}
+export interface SyncGetRequest {
+    id: string;
+    xSpaceId?: string;
+}
+export interface SyncListRequest {
+    limit?: number;
+    cursor?: CampaignsListCursorParameter;
+    xSpaceId?: string;
+}
+export interface SyncPlanRequest {
+    platforms?: string;
+    xSpaceId?: string;
+}
+export interface SyncTriggerOperationRequest {
+    syncTriggerRequest: SyncTriggerRequest;
+    xSpaceId?: string;
+}
+export interface SyncUnlinkOperationRequest {
+    syncUnlinkRequest: SyncUnlinkRequest;
+    xSpaceId?: string;
+}
+/**
+ * SyncApi - interface
+ *
+ * @export
+ * @interface SyncApiInterface
+ */
+export interface SyncApiInterface {
+    /**
+     * Cancellation takes effect at the next campaign boundary.
+     * @summary Request cancellation of a running sync
+     * @param {string} id
+     * @param {string} [xSpaceId] Target Space ID (e.g. `spc_…`). Omit to use the caller\'s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SyncApiInterface
+     */
+    syncCancelRaw(requestParameters: SyncCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Cancellation takes effect at the next campaign boundary.
+     * Request cancellation of a running sync
+     */
+    syncCancel(requestParameters: SyncCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Returns the full record including per-campaign progress and structured errors. 404 if the id is outside the caller\'s Space.
+     * @summary Get a sync record (status, progress, totals, errors)
+     * @param {string} id
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SyncApiInterface
+     */
+    syncGetRaw(requestParameters: SyncGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Returns the full record including per-campaign progress and structured errors. 404 if the id is outside the caller\'s Space.
+     * Get a sync record (status, progress, totals, errors)
+     */
+    syncGet(requestParameters: SyncGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     *
+     * @summary List recent syncs for the active Space
+     * @param {number} [limit] Maximum items to return. Default 50, max 200.
+     * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SyncApiInterface
+     */
+    syncListRaw(requestParameters: SyncListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * List recent syncs for the active Space
+     */
+    syncList(requestParameters: SyncListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Computes the import/export/remove plan for the active Space without executing.
+     * @summary Preview what a sync would do (dry run)
+     * @param {string} [platforms] Comma-separated platform ids (e.g. &#x60;google-ads,microsoft-ads&#x60;). Defaults to all connected platforms.
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SyncApiInterface
+     */
+    syncPlanRaw(requestParameters: SyncPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Computes the import/export/remove plan for the active Space without executing.
+     * Preview what a sync would do (dry run)
+     */
+    syncPlan(requestParameters: SyncPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Pushes the active Space\'s campaign tree to the connected ad platforms (and imports remote changes). Asynchronous: returns a `syncId` immediately with status `started` (or `nothing_to_sync`). Poll `GET /api/v1/sync/{id}` for progress and errors. Returns 409 CONFLICT (details: { activeSyncId, startedAt }) if a sync is already running in this Space. The platform connection used is account-wide; the campaigns synced are the active Space\'s.
+     * @summary Trigger a sync for the active Space
+     * @param {SyncTriggerRequest} syncTriggerRequest
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SyncApiInterface
+     */
+    syncTriggerRaw(requestParameters: SyncTriggerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Pushes the active Space\'s campaign tree to the connected ad platforms (and imports remote changes). Asynchronous: returns a `syncId` immediately with status `started` (or `nothing_to_sync`). Poll `GET /api/v1/sync/{id}` for progress and errors. Returns 409 CONFLICT (details: { activeSyncId, startedAt }) if a sync is already running in this Space. The platform connection used is account-wide; the campaigns synced are the active Space\'s.
+     * Trigger a sync for the active Space
+     */
+    syncTrigger(requestParameters: SyncTriggerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Clears the platform link (and optionally removes the remote campaign) while keeping the local campaign. Returns a per-id result map; already-unlinked ids report `not_linked`. Unlink then sync to re-create campaigns cleanly on the platform.
+     * @summary Unlink the active Space\'s campaigns from a platform
+     * @param {SyncUnlinkRequest} syncUnlinkRequest
+     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SyncApiInterface
+     */
+    syncUnlinkRaw(requestParameters: SyncUnlinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Clears the platform link (and optionally removes the remote campaign) while keeping the local campaign. Returns a per-id result map; already-unlinked ids report `not_linked`. Unlink then sync to re-create campaigns cleanly on the platform.
+     * Unlink the active Space\'s campaigns from a platform
+     */
+    syncUnlink(requestParameters: SyncUnlinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+}
+/**
+ *
+ */
+export declare class SyncApi extends runtime.BaseAPI implements SyncApiInterface {
+    /**
+     * Cancellation takes effect at the next campaign boundary.
+     * Request cancellation of a running sync
+     */
+    syncCancelRaw(requestParameters: SyncCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Cancellation takes effect at the next campaign boundary.
+     * Request cancellation of a running sync
+     */
+    syncCancel(requestParameters: SyncCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Returns the full record including per-campaign progress and structured errors. 404 if the id is outside the caller\'s Space.
+     * Get a sync record (status, progress, totals, errors)
+     */
+    syncGetRaw(requestParameters: SyncGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Returns the full record including per-campaign progress and structured errors. 404 if the id is outside the caller\'s Space.
+     * Get a sync record (status, progress, totals, errors)
+     */
+    syncGet(requestParameters: SyncGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * List recent syncs for the active Space
+     */
+    syncListRaw(requestParameters: SyncListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * List recent syncs for the active Space
+     */
+    syncList(requestParameters?: SyncListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Computes the import/export/remove plan for the active Space without executing.
+     * Preview what a sync would do (dry run)
+     */
+    syncPlanRaw(requestParameters: SyncPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Computes the import/export/remove plan for the active Space without executing.
+     * Preview what a sync would do (dry run)
+     */
+    syncPlan(requestParameters?: SyncPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Pushes the active Space\'s campaign tree to the connected ad platforms (and imports remote changes). Asynchronous: returns a `syncId` immediately with status `started` (or `nothing_to_sync`). Poll `GET /api/v1/sync/{id}` for progress and errors. Returns 409 CONFLICT (details: { activeSyncId, startedAt }) if a sync is already running in this Space. The platform connection used is account-wide; the campaigns synced are the active Space\'s.
+     * Trigger a sync for the active Space
+     */
+    syncTriggerRaw(requestParameters: SyncTriggerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Pushes the active Space\'s campaign tree to the connected ad platforms (and imports remote changes). Asynchronous: returns a `syncId` immediately with status `started` (or `nothing_to_sync`). Poll `GET /api/v1/sync/{id}` for progress and errors. Returns 409 CONFLICT (details: { activeSyncId, startedAt }) if a sync is already running in this Space. The platform connection used is account-wide; the campaigns synced are the active Space\'s.
+     * Trigger a sync for the active Space
+     */
+    syncTrigger(requestParameters: SyncTriggerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+    /**
+     * Clears the platform link (and optionally removes the remote campaign) while keeping the local campaign. Returns a per-id result map; already-unlinked ids report `not_linked`. Unlink then sync to re-create campaigns cleanly on the platform.
+     * Unlink the active Space\'s campaigns from a platform
+     */
+    syncUnlinkRaw(requestParameters: SyncUnlinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+    /**
+     * Clears the platform link (and optionally removes the remote campaign) while keeping the local campaign. Returns a per-id result map; already-unlinked ids report `not_linked`. Unlink then sync to re-create campaigns cleanly on the platform.
+     * Unlink the active Space\'s campaigns from a platform
+     */
+    syncUnlink(requestParameters: SyncUnlinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+}