@defoai/ads-client 1.4.0

package/src/generated/models/SyncRecordErrorsInner.ts

@@ -0,0 +1,73 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SyncRecordErrorsInner
+ */
+export interface SyncRecordErrorsInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncRecordErrorsInner
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SyncRecordErrorsInner
+     */
+    timestamp?: Date;
+}
+
+/**
+ * Check if a given object implements the SyncRecordErrorsInner interface.
+ */
+export function instanceOfSyncRecordErrorsInner(value: object): value is SyncRecordErrorsInner {
+    return true;
+}
+
+export function SyncRecordErrorsInnerFromJSON(json: any): SyncRecordErrorsInner {
+    return SyncRecordErrorsInnerFromJSONTyped(json, false);
+}
+
+export function SyncRecordErrorsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncRecordErrorsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'] == null ? undefined : json['message'],
+        'timestamp': json['timestamp'] == null ? undefined : (new Date(json['timestamp'])),
+    };
+}
+
+export function SyncRecordErrorsInnerToJSON(json: any): SyncRecordErrorsInner {
+    return SyncRecordErrorsInnerToJSONTyped(json, false);
+}
+
+export function SyncRecordErrorsInnerToJSONTyped(value?: SyncRecordErrorsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'timestamp': value['timestamp'] == null ? undefined : ((value['timestamp']).toISOString()),
+    };
+}
+

package/src/generated/models/SyncTotals.ts

@@ -0,0 +1,113 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SyncTotals
+ */
+export interface SyncTotals {
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    campaigns?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    adGroups?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    keywords?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    ads?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    conversionActions?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    removals?: number;
+    /**
+     * Count of failed campaign operations. >0 ⇒ status `partial`.
+     * @type {number}
+     * @memberof SyncTotals
+     */
+    errors?: number;
+}
+
+/**
+ * Check if a given object implements the SyncTotals interface.
+ */
+export function instanceOfSyncTotals(value: object): value is SyncTotals {
+    return true;
+}
+
+export function SyncTotalsFromJSON(json: any): SyncTotals {
+    return SyncTotalsFromJSONTyped(json, false);
+}
+
+export function SyncTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncTotals {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'campaigns': json['campaigns'] == null ? undefined : json['campaigns'],
+        'adGroups': json['adGroups'] == null ? undefined : json['adGroups'],
+        'keywords': json['keywords'] == null ? undefined : json['keywords'],
+        'ads': json['ads'] == null ? undefined : json['ads'],
+        'conversionActions': json['conversionActions'] == null ? undefined : json['conversionActions'],
+        'removals': json['removals'] == null ? undefined : json['removals'],
+        'errors': json['errors'] == null ? undefined : json['errors'],
+    };
+}
+
+export function SyncTotalsToJSON(json: any): SyncTotals {
+    return SyncTotalsToJSONTyped(json, false);
+}
+
+export function SyncTotalsToJSONTyped(value?: SyncTotals | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'campaigns': value['campaigns'],
+        'adGroups': value['adGroups'],
+        'keywords': value['keywords'],
+        'ads': value['ads'],
+        'conversionActions': value['conversionActions'],
+        'removals': value['removals'],
+        'errors': value['errors'],
+    };
+}
+

package/src/generated/models/SyncTriggerRequest.ts

@@ -0,0 +1,81 @@
+/* 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 { mapValues } from '../runtime';
+import type { SyncTriggerRequestOptions } from './SyncTriggerRequestOptions';
+import {
+    SyncTriggerRequestOptionsFromJSON,
+    SyncTriggerRequestOptionsFromJSONTyped,
+    SyncTriggerRequestOptionsToJSON,
+    SyncTriggerRequestOptionsToJSONTyped,
+} from './SyncTriggerRequestOptions';
+
+/**
+ * All fields optional. Omit `platforms` to sync every connected platform.
+ * @export
+ * @interface SyncTriggerRequest
+ */
+export interface SyncTriggerRequest {
+    /**
+     * Platform ids to sync (e.g. ["google-ads"]). Defaults to all connected.
+     * @type {Array<string>}
+     * @memberof SyncTriggerRequest
+     */
+    platforms?: Array<string>;
+    /**
+     * 
+     * @type {SyncTriggerRequestOptions}
+     * @memberof SyncTriggerRequest
+     */
+    options?: SyncTriggerRequestOptions;
+}
+
+/**
+ * Check if a given object implements the SyncTriggerRequest interface.
+ */
+export function instanceOfSyncTriggerRequest(value: object): value is SyncTriggerRequest {
+    return true;
+}
+
+export function SyncTriggerRequestFromJSON(json: any): SyncTriggerRequest {
+    return SyncTriggerRequestFromJSONTyped(json, false);
+}
+
+export function SyncTriggerRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncTriggerRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'platforms': json['platforms'] == null ? undefined : json['platforms'],
+        'options': json['options'] == null ? undefined : SyncTriggerRequestOptionsFromJSON(json['options']),
+    };
+}
+
+export function SyncTriggerRequestToJSON(json: any): SyncTriggerRequest {
+    return SyncTriggerRequestToJSONTyped(json, false);
+}
+
+export function SyncTriggerRequestToJSONTyped(value?: SyncTriggerRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'platforms': value['platforms'],
+        'options': SyncTriggerRequestOptionsToJSON(value['options']),
+    };
+}
+

package/src/generated/models/SyncTriggerRequestOptions.ts

@@ -0,0 +1,97 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Per-entity-type toggles + force controls.
+ * @export
+ * @interface SyncTriggerRequestOptions
+ */
+export interface SyncTriggerRequestOptions {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SyncTriggerRequestOptions
+     */
+    includeAdGroups?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SyncTriggerRequestOptions
+     */
+    includeKeywords?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SyncTriggerRequestOptions
+     */
+    includeAds?: boolean;
+    /**
+     * Re-export linked campaigns even when change-detection sees no change — re-runs the full tree + targeting/extensions/labels. Use to repair campaigns synced before a fix. Applies to campaigns whose remote still exists; for campaigns deleted in the ad platform, unlink then sync to recreate.
+     * @type {boolean}
+     * @memberof SyncTriggerRequestOptions
+     */
+    force?: boolean;
+    /**
+     * Restrict `force` to these campaign ids. Omit to force the whole Space.
+     * @type {Array<string>}
+     * @memberof SyncTriggerRequestOptions
+     */
+    campaignIds?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the SyncTriggerRequestOptions interface.
+ */
+export function instanceOfSyncTriggerRequestOptions(value: object): value is SyncTriggerRequestOptions {
+    return true;
+}
+
+export function SyncTriggerRequestOptionsFromJSON(json: any): SyncTriggerRequestOptions {
+    return SyncTriggerRequestOptionsFromJSONTyped(json, false);
+}
+
+export function SyncTriggerRequestOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncTriggerRequestOptions {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'includeAdGroups': json['includeAdGroups'] == null ? undefined : json['includeAdGroups'],
+        'includeKeywords': json['includeKeywords'] == null ? undefined : json['includeKeywords'],
+        'includeAds': json['includeAds'] == null ? undefined : json['includeAds'],
+        'force': json['force'] == null ? undefined : json['force'],
+        'campaignIds': json['campaignIds'] == null ? undefined : json['campaignIds'],
+    };
+}
+
+export function SyncTriggerRequestOptionsToJSON(json: any): SyncTriggerRequestOptions {
+    return SyncTriggerRequestOptionsToJSONTyped(json, false);
+}
+
+export function SyncTriggerRequestOptionsToJSONTyped(value?: SyncTriggerRequestOptions | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'includeAdGroups': value['includeAdGroups'],
+        'includeKeywords': value['includeKeywords'],
+        'includeAds': value['includeAds'],
+        'force': value['force'],
+        'campaignIds': value['campaignIds'],
+    };
+}
+

package/src/generated/models/SyncTriggerResponse.ts

@@ -0,0 +1,108 @@
+/* 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 { mapValues } from '../runtime';
+import type { SyncPlan } from './SyncPlan';
+import {
+    SyncPlanFromJSON,
+    SyncPlanFromJSONTyped,
+    SyncPlanToJSON,
+    SyncPlanToJSONTyped,
+} from './SyncPlan';
+
+/**
+ * 
+ * @export
+ * @interface SyncTriggerResponse
+ */
+export interface SyncTriggerResponse {
+    /**
+     * Poll GET /api/v1/sync/{id} with this id. Null when nothing to sync.
+     * @type {string}
+     * @memberof SyncTriggerResponse
+     */
+    syncId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncTriggerResponse
+     */
+    status?: SyncTriggerResponseStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncTriggerResponse
+     */
+    spaceId?: string;
+    /**
+     * 
+     * @type {SyncPlan}
+     * @memberof SyncTriggerResponse
+     */
+    plan?: SyncPlan;
+}
+
+
+/**
+ * @export
+ */
+export const SyncTriggerResponseStatusEnum = {
+    started: 'started',
+    nothing_to_sync: 'nothing_to_sync'
+} as const;
+export type SyncTriggerResponseStatusEnum = typeof SyncTriggerResponseStatusEnum[keyof typeof SyncTriggerResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the SyncTriggerResponse interface.
+ */
+export function instanceOfSyncTriggerResponse(value: object): value is SyncTriggerResponse {
+    return true;
+}
+
+export function SyncTriggerResponseFromJSON(json: any): SyncTriggerResponse {
+    return SyncTriggerResponseFromJSONTyped(json, false);
+}
+
+export function SyncTriggerResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncTriggerResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'syncId': json['syncId'] == null ? undefined : json['syncId'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'spaceId': json['spaceId'] == null ? undefined : json['spaceId'],
+        'plan': json['plan'] == null ? undefined : SyncPlanFromJSON(json['plan']),
+    };
+}
+
+export function SyncTriggerResponseToJSON(json: any): SyncTriggerResponse {
+    return SyncTriggerResponseToJSONTyped(json, false);
+}
+
+export function SyncTriggerResponseToJSONTyped(value?: SyncTriggerResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'syncId': value['syncId'],
+        'status': value['status'],
+        'spaceId': value['spaceId'],
+        'plan': SyncPlanToJSON(value['plan']),
+    };
+}
+

package/src/generated/models/SyncUnlinkRequest.ts

@@ -0,0 +1,82 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Clear a platform link from the active Space's campaigns, keeping the local campaigns. After unlinking, a subsequent sync re-creates them on the platform.
+ * @export
+ * @interface SyncUnlinkRequest
+ */
+export interface SyncUnlinkRequest {
+    /**
+     * Platform id, e.g. "microsoft-ads".
+     * @type {string}
+     * @memberof SyncUnlinkRequest
+     */
+    platform: string;
+    /**
+     * Campaigns to unlink. Omit to unlink every campaign linked to the platform.
+     * @type {Array<string>}
+     * @memberof SyncUnlinkRequest
+     */
+    campaignIds?: Array<string>;
+    /**
+     * Also remove the campaign on the ad platform (already-removed counts as success). When false, only the local link is cleared and the remote is untouched.
+     * @type {boolean}
+     * @memberof SyncUnlinkRequest
+     */
+    deleteRemote?: boolean;
+}
+
+/**
+ * Check if a given object implements the SyncUnlinkRequest interface.
+ */
+export function instanceOfSyncUnlinkRequest(value: object): value is SyncUnlinkRequest {
+    if (!('platform' in value) || value['platform'] === undefined) return false;
+    return true;
+}
+
+export function SyncUnlinkRequestFromJSON(json: any): SyncUnlinkRequest {
+    return SyncUnlinkRequestFromJSONTyped(json, false);
+}
+
+export function SyncUnlinkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncUnlinkRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'platform': json['platform'],
+        'campaignIds': json['campaignIds'] == null ? undefined : json['campaignIds'],
+        'deleteRemote': json['deleteRemote'] == null ? undefined : json['deleteRemote'],
+    };
+}
+
+export function SyncUnlinkRequestToJSON(json: any): SyncUnlinkRequest {
+    return SyncUnlinkRequestToJSONTyped(json, false);
+}
+
+export function SyncUnlinkRequestToJSONTyped(value?: SyncUnlinkRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'platform': value['platform'],
+        'campaignIds': value['campaignIds'],
+        'deleteRemote': value['deleteRemote'],
+    };
+}
+

package/src/generated/models/index.ts

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AdAssetCreate';
+export * from './AdCreate';
+export * from './AdGroupAudience';
+export * from './AdGroupCreate';
+export * from './AdGroupUpdate';
+export * from './AdUpdate';
+export * from './AssetCreate';
+export * from './AssetUpdate';
+export * from './BiddingStrategy';
+export * from './CampaignAdScheduleField';
+export * from './CampaignAssetCreate';
+export * from './CampaignCreate';
+export * from './CampaignTargeting';
+export * from './CampaignUpdate';
+export * from './CampaignsListCursorParameter';
+export * from './ErrorEnvelope';
+export * from './ErrorEnvelopeError';
+export * from './KeywordCreate';
+export * from './KeywordUpdate';
+export * from './Location';
+export * from './NegativeKeywordEntry';
+export * from './ScheduleWindow';
+export * from './SiteCreate';
+export * from './SiteCreateSeoKeywords';
+export * from './SiteCreateTargetGroups';
+export * from './SiteLinkEntry';
+export * from './SiteUpdate';
+export * from './Sitelink';
+export * from './StructuredSchedule';
+export * from './StructuredSnippet';
+export * from './SuccessEnvelope';
+export * from './SuccessEnvelopeMeta';
+export * from './SuccessEnvelopeMetaNextCursor';
+export * from './SyncCampaignDetail';
+export * from './SyncPlan';
+export * from './SyncPlanPlatformsValue';
+export * from './SyncPlanPlatformsValueTotals';
+export * from './SyncProgress';
+export * from './SyncRecord';
+export * from './SyncRecordErrorsInner';
+export * from './SyncTotals';
+export * from './SyncTriggerRequest';
+export * from './SyncTriggerRequestOptions';
+export * from './SyncTriggerResponse';
+export * from './SyncUnlinkRequest';