@defoai/ads-client 1.4.0

package/src/generated/models/SuccessEnvelopeMetaNextCursor.ts

@@ -0,0 +1,46 @@
+/* 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 SuccessEnvelopeMetaNextCursor
+ */
+export interface SuccessEnvelopeMetaNextCursor {
+}
+
+/**
+ * Check if a given object implements the SuccessEnvelopeMetaNextCursor interface.
+ */
+export function instanceOfSuccessEnvelopeMetaNextCursor(value: object): value is SuccessEnvelopeMetaNextCursor {
+    return true;
+}
+
+export function SuccessEnvelopeMetaNextCursorFromJSON(json: any): SuccessEnvelopeMetaNextCursor {
+    return SuccessEnvelopeMetaNextCursorFromJSONTyped(json, false);
+}
+
+export function SuccessEnvelopeMetaNextCursorFromJSONTyped(json: any, ignoreDiscriminator: boolean): SuccessEnvelopeMetaNextCursor {
+    return json;
+}
+
+export function SuccessEnvelopeMetaNextCursorToJSON(json: any): SuccessEnvelopeMetaNextCursor {
+    return SuccessEnvelopeMetaNextCursorToJSONTyped(json, false);
+}
+
+export function SuccessEnvelopeMetaNextCursorToJSONTyped(value?: SuccessEnvelopeMetaNextCursor | null, ignoreDiscriminator: boolean = false): any {
+    return value;
+}
+

package/src/generated/models/SyncCampaignDetail.ts

@@ -0,0 +1,137 @@
+/* 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-campaign progress entry.
+ * @export
+ * @interface SyncCampaignDetail
+ */
+export interface SyncCampaignDetail {
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncCampaignDetail
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncCampaignDetail
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncCampaignDetail
+     */
+    platform?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncCampaignDetail
+     */
+    phase?: SyncCampaignDetailPhaseEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncCampaignDetail
+     */
+    status?: SyncCampaignDetailStatusEnum;
+    /**
+     * Present when status is `failed`.
+     * @type {string}
+     * @memberof SyncCampaignDetail
+     */
+    error?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SyncCampaignDetail
+     */
+    processedAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const SyncCampaignDetailPhaseEnum = {
+    remove: 'remove',
+    export: 'export',
+    import: 'import'
+} as const;
+export type SyncCampaignDetailPhaseEnum = typeof SyncCampaignDetailPhaseEnum[keyof typeof SyncCampaignDetailPhaseEnum];
+
+/**
+ * @export
+ */
+export const SyncCampaignDetailStatusEnum = {
+    pending: 'pending',
+    in_progress: 'in_progress',
+    completed: 'completed',
+    failed: 'failed',
+    skipped: 'skipped'
+} as const;
+export type SyncCampaignDetailStatusEnum = typeof SyncCampaignDetailStatusEnum[keyof typeof SyncCampaignDetailStatusEnum];
+
+
+/**
+ * Check if a given object implements the SyncCampaignDetail interface.
+ */
+export function instanceOfSyncCampaignDetail(value: object): value is SyncCampaignDetail {
+    return true;
+}
+
+export function SyncCampaignDetailFromJSON(json: any): SyncCampaignDetail {
+    return SyncCampaignDetailFromJSONTyped(json, false);
+}
+
+export function SyncCampaignDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncCampaignDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'platform': json['platform'] == null ? undefined : json['platform'],
+        'phase': json['phase'] == null ? undefined : json['phase'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'processedAt': json['processedAt'] == null ? undefined : (new Date(json['processedAt'])),
+    };
+}
+
+export function SyncCampaignDetailToJSON(json: any): SyncCampaignDetail {
+    return SyncCampaignDetailToJSONTyped(json, false);
+}
+
+export function SyncCampaignDetailToJSONTyped(value?: SyncCampaignDetail | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'platform': value['platform'],
+        'phase': value['phase'],
+        'status': value['status'],
+        'error': value['error'],
+        'processedAt': value['processedAt'] == null ? undefined : ((value['processedAt']).toISOString()),
+    };
+}
+

package/src/generated/models/SyncPlan.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';
+import type { SyncPlanPlatformsValue } from './SyncPlanPlatformsValue';
+import {
+    SyncPlanPlatformsValueFromJSON,
+    SyncPlanPlatformsValueFromJSONTyped,
+    SyncPlanPlatformsValueToJSON,
+    SyncPlanPlatformsValueToJSONTyped,
+} from './SyncPlanPlatformsValue';
+
+/**
+ * Per-platform import/export/remove categorization.
+ * @export
+ * @interface SyncPlan
+ */
+export interface SyncPlan {
+    /**
+     * 
+     * @type {{ [key: string]: SyncPlanPlatformsValue; }}
+     * @memberof SyncPlan
+     */
+    platforms?: { [key: string]: SyncPlanPlatformsValue; };
+}
+
+/**
+ * Check if a given object implements the SyncPlan interface.
+ */
+export function instanceOfSyncPlan(value: object): value is SyncPlan {
+    return true;
+}
+
+export function SyncPlanFromJSON(json: any): SyncPlan {
+    return SyncPlanFromJSONTyped(json, false);
+}
+
+export function SyncPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncPlan {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'platforms': json['platforms'] == null ? undefined : (mapValues(json['platforms'], SyncPlanPlatformsValueFromJSON)),
+    };
+}
+
+export function SyncPlanToJSON(json: any): SyncPlan {
+    return SyncPlanToJSONTyped(json, false);
+}
+
+export function SyncPlanToJSONTyped(value?: SyncPlan | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'platforms': value['platforms'] == null ? undefined : (mapValues(value['platforms'], SyncPlanPlatformsValueToJSON)),
+    };
+}
+

package/src/generated/models/SyncPlanPlatformsValue.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';
+import type { SyncPlanPlatformsValueTotals } from './SyncPlanPlatformsValueTotals';
+import {
+    SyncPlanPlatformsValueTotalsFromJSON,
+    SyncPlanPlatformsValueTotalsFromJSONTyped,
+    SyncPlanPlatformsValueTotalsToJSON,
+    SyncPlanPlatformsValueTotalsToJSONTyped,
+} from './SyncPlanPlatformsValueTotals';
+
+/**
+ * 
+ * @export
+ * @interface SyncPlanPlatformsValue
+ */
+export interface SyncPlanPlatformsValue {
+    /**
+     * 
+     * @type {SyncPlanPlatformsValueTotals}
+     * @memberof SyncPlanPlatformsValue
+     */
+    totals?: SyncPlanPlatformsValueTotals;
+}
+
+/**
+ * Check if a given object implements the SyncPlanPlatformsValue interface.
+ */
+export function instanceOfSyncPlanPlatformsValue(value: object): value is SyncPlanPlatformsValue {
+    return true;
+}
+
+export function SyncPlanPlatformsValueFromJSON(json: any): SyncPlanPlatformsValue {
+    return SyncPlanPlatformsValueFromJSONTyped(json, false);
+}
+
+export function SyncPlanPlatformsValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncPlanPlatformsValue {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'totals': json['totals'] == null ? undefined : SyncPlanPlatformsValueTotalsFromJSON(json['totals']),
+    };
+}
+
+export function SyncPlanPlatformsValueToJSON(json: any): SyncPlanPlatformsValue {
+    return SyncPlanPlatformsValueToJSONTyped(json, false);
+}
+
+export function SyncPlanPlatformsValueToJSONTyped(value?: SyncPlanPlatformsValue | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'totals': SyncPlanPlatformsValueTotalsToJSON(value['totals']),
+    };
+}
+

package/src/generated/models/SyncPlanPlatformsValueTotals.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';
+/**
+ * 
+ * @export
+ * @interface SyncPlanPlatformsValueTotals
+ */
+export interface SyncPlanPlatformsValueTotals {
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncPlanPlatformsValueTotals
+     */
+    _import?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncPlanPlatformsValueTotals
+     */
+    _export?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncPlanPlatformsValueTotals
+     */
+    remove?: number;
+}
+
+/**
+ * Check if a given object implements the SyncPlanPlatformsValueTotals interface.
+ */
+export function instanceOfSyncPlanPlatformsValueTotals(value: object): value is SyncPlanPlatformsValueTotals {
+    return true;
+}
+
+export function SyncPlanPlatformsValueTotalsFromJSON(json: any): SyncPlanPlatformsValueTotals {
+    return SyncPlanPlatformsValueTotalsFromJSONTyped(json, false);
+}
+
+export function SyncPlanPlatformsValueTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncPlanPlatformsValueTotals {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        '_import': json['import'] == null ? undefined : json['import'],
+        '_export': json['export'] == null ? undefined : json['export'],
+        'remove': json['remove'] == null ? undefined : json['remove'],
+    };
+}
+
+export function SyncPlanPlatformsValueTotalsToJSON(json: any): SyncPlanPlatformsValueTotals {
+    return SyncPlanPlatformsValueTotalsToJSONTyped(json, false);
+}
+
+export function SyncPlanPlatformsValueTotalsToJSONTyped(value?: SyncPlanPlatformsValueTotals | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'import': value['_import'],
+        'export': value['_export'],
+        'remove': value['remove'],
+    };
+}
+

package/src/generated/models/SyncProgress.ts

@@ -0,0 +1,105 @@
+/* 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 { SyncCampaignDetail } from './SyncCampaignDetail';
+import {
+    SyncCampaignDetailFromJSON,
+    SyncCampaignDetailFromJSONTyped,
+    SyncCampaignDetailToJSON,
+    SyncCampaignDetailToJSONTyped,
+} from './SyncCampaignDetail';
+
+/**
+ * 
+ * @export
+ * @interface SyncProgress
+ */
+export interface SyncProgress {
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncProgress
+     */
+    currentPlatform?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncProgress
+     */
+    currentPhase?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncProgress
+     */
+    totalCampaigns?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SyncProgress
+     */
+    processedCampaigns?: number;
+    /**
+     * 
+     * @type {Array<SyncCampaignDetail>}
+     * @memberof SyncProgress
+     */
+    campaignDetails?: Array<SyncCampaignDetail>;
+}
+
+/**
+ * Check if a given object implements the SyncProgress interface.
+ */
+export function instanceOfSyncProgress(value: object): value is SyncProgress {
+    return true;
+}
+
+export function SyncProgressFromJSON(json: any): SyncProgress {
+    return SyncProgressFromJSONTyped(json, false);
+}
+
+export function SyncProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncProgress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'currentPlatform': json['currentPlatform'] == null ? undefined : json['currentPlatform'],
+        'currentPhase': json['currentPhase'] == null ? undefined : json['currentPhase'],
+        'totalCampaigns': json['totalCampaigns'] == null ? undefined : json['totalCampaigns'],
+        'processedCampaigns': json['processedCampaigns'] == null ? undefined : json['processedCampaigns'],
+        'campaignDetails': json['campaignDetails'] == null ? undefined : ((json['campaignDetails'] as Array<any>).map(SyncCampaignDetailFromJSON)),
+    };
+}
+
+export function SyncProgressToJSON(json: any): SyncProgress {
+    return SyncProgressToJSONTyped(json, false);
+}
+
+export function SyncProgressToJSONTyped(value?: SyncProgress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'currentPlatform': value['currentPlatform'],
+        'currentPhase': value['currentPhase'],
+        'totalCampaigns': value['totalCampaigns'],
+        'processedCampaigns': value['processedCampaigns'],
+        'campaignDetails': value['campaignDetails'] == null ? undefined : ((value['campaignDetails'] as Array<any>).map(SyncCampaignDetailToJSON)),
+    };
+}
+

package/src/generated/models/SyncRecord.ts

@@ -0,0 +1,174 @@
+/* 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 { SyncRecordErrorsInner } from './SyncRecordErrorsInner';
+import {
+    SyncRecordErrorsInnerFromJSON,
+    SyncRecordErrorsInnerFromJSONTyped,
+    SyncRecordErrorsInnerToJSON,
+    SyncRecordErrorsInnerToJSONTyped,
+} from './SyncRecordErrorsInner';
+import type { SyncTotals } from './SyncTotals';
+import {
+    SyncTotalsFromJSON,
+    SyncTotalsFromJSONTyped,
+    SyncTotalsToJSON,
+    SyncTotalsToJSONTyped,
+} from './SyncTotals';
+import type { SyncProgress } from './SyncProgress';
+import {
+    SyncProgressFromJSON,
+    SyncProgressFromJSONTyped,
+    SyncProgressToJSON,
+    SyncProgressToJSONTyped,
+} from './SyncProgress';
+
+/**
+ * A sync session. `status` terminal values: completed | partial | failed | cancelled.
+ * @export
+ * @interface SyncRecord
+ */
+export interface SyncRecord {
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncRecord
+     */
+    syncId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncRecord
+     */
+    spaceId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncRecord
+     */
+    status?: SyncRecordStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SyncRecord
+     */
+    startedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SyncRecord
+     */
+    completedAt?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SyncRecord
+     */
+    scheduled?: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof SyncRecord
+     */
+    platforms?: { [key: string]: any; };
+    /**
+     * 
+     * @type {SyncTotals}
+     * @memberof SyncRecord
+     */
+    totals?: SyncTotals;
+    /**
+     * 
+     * @type {SyncProgress}
+     * @memberof SyncRecord
+     */
+    progress?: SyncProgress;
+    /**
+     * 
+     * @type {Array<SyncRecordErrorsInner>}
+     * @memberof SyncRecord
+     */
+    errors?: Array<SyncRecordErrorsInner>;
+}
+
+
+/**
+ * @export
+ */
+export const SyncRecordStatusEnum = {
+    in_progress: 'in_progress',
+    completed: 'completed',
+    partial: 'partial',
+    failed: 'failed',
+    cancelled: 'cancelled',
+    paused: 'paused'
+} as const;
+export type SyncRecordStatusEnum = typeof SyncRecordStatusEnum[keyof typeof SyncRecordStatusEnum];
+
+
+/**
+ * Check if a given object implements the SyncRecord interface.
+ */
+export function instanceOfSyncRecord(value: object): value is SyncRecord {
+    return true;
+}
+
+export function SyncRecordFromJSON(json: any): SyncRecord {
+    return SyncRecordFromJSONTyped(json, false);
+}
+
+export function SyncRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncRecord {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'syncId': json['syncId'] == null ? undefined : json['syncId'],
+        'spaceId': json['spaceId'] == null ? undefined : json['spaceId'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'completedAt': json['completedAt'] == null ? undefined : (new Date(json['completedAt'])),
+        'scheduled': json['scheduled'] == null ? undefined : json['scheduled'],
+        'platforms': json['platforms'] == null ? undefined : json['platforms'],
+        'totals': json['totals'] == null ? undefined : SyncTotalsFromJSON(json['totals']),
+        'progress': json['progress'] == null ? undefined : SyncProgressFromJSON(json['progress']),
+        'errors': json['errors'] == null ? undefined : ((json['errors'] as Array<any>).map(SyncRecordErrorsInnerFromJSON)),
+    };
+}
+
+export function SyncRecordToJSON(json: any): SyncRecord {
+    return SyncRecordToJSONTyped(json, false);
+}
+
+export function SyncRecordToJSONTyped(value?: SyncRecord | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'syncId': value['syncId'],
+        'spaceId': value['spaceId'],
+        'status': value['status'],
+        'startedAt': value['startedAt'] == null ? undefined : ((value['startedAt']).toISOString()),
+        'completedAt': value['completedAt'] == null ? undefined : ((value['completedAt'] as any).toISOString()),
+        'scheduled': value['scheduled'],
+        'platforms': value['platforms'],
+        'totals': SyncTotalsToJSON(value['totals']),
+        'progress': SyncProgressToJSON(value['progress']),
+        'errors': value['errors'] == null ? undefined : ((value['errors'] as Array<any>).map(SyncRecordErrorsInnerToJSON)),
+    };
+}
+