@defoai/ads-client 1.4.0

package/src/generated/models/AdUpdate.ts

@@ -0,0 +1,228 @@
+/* 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 { Sitelink } from './Sitelink';
+import {
+    SitelinkFromJSON,
+    SitelinkFromJSONTyped,
+    SitelinkToJSON,
+    SitelinkToJSONTyped,
+} from './Sitelink';
+import type { StructuredSnippet } from './StructuredSnippet';
+import {
+    StructuredSnippetFromJSON,
+    StructuredSnippetFromJSONTyped,
+    StructuredSnippetToJSON,
+    StructuredSnippetToJSONTyped,
+} from './StructuredSnippet';
+
+/**
+ * Partial Ad. Omitted fields are unchanged.
+ * @export
+ * @interface AdUpdate
+ */
+export interface AdUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    adGroupId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    campaignId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    headlinePart1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    headlinePart2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    headlinePart3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    description2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    finalUrl?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    path1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    path2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    status?: AdUpdateStatusEnum;
+    /**
+     * 
+     * @type {Array<Sitelink>}
+     * @memberof AdUpdate
+     */
+    sitelinks?: Array<Sitelink>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AdUpdate
+     */
+    callouts?: Array<string>;
+    /**
+     * 
+     * @type {Array<StructuredSnippet>}
+     * @memberof AdUpdate
+     */
+    structuredSnippets?: Array<StructuredSnippet>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AdUpdate
+     */
+    customLabels?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdUpdate
+     */
+    finalUrlSuffix?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof AdUpdate
+     */
+    urlCustomParameters?: { [key: string]: string; };
+}
+
+
+/**
+ * @export
+ */
+export const AdUpdateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type AdUpdateStatusEnum = typeof AdUpdateStatusEnum[keyof typeof AdUpdateStatusEnum];
+
+
+/**
+ * Check if a given object implements the AdUpdate interface.
+ */
+export function instanceOfAdUpdate(value: object): value is AdUpdate {
+    return true;
+}
+
+export function AdUpdateFromJSON(json: any): AdUpdate {
+    return AdUpdateFromJSONTyped(json, false);
+}
+
+export function AdUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adGroupId': json['adGroupId'] == null ? undefined : json['adGroupId'],
+        'campaignId': json['campaignId'] == null ? undefined : json['campaignId'],
+        'headlinePart1': json['headlinePart1'] == null ? undefined : json['headlinePart1'],
+        'headlinePart2': json['headlinePart2'] == null ? undefined : json['headlinePart2'],
+        'headlinePart3': json['headlinePart3'] == null ? undefined : json['headlinePart3'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'description2': json['description2'] == null ? undefined : json['description2'],
+        'finalUrl': json['finalUrl'] == null ? undefined : json['finalUrl'],
+        'path1': json['path1'] == null ? undefined : json['path1'],
+        'path2': json['path2'] == null ? undefined : json['path2'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'sitelinks': json['sitelinks'] == null ? undefined : ((json['sitelinks'] as Array<any>).map(SitelinkFromJSON)),
+        'callouts': json['callouts'] == null ? undefined : json['callouts'],
+        'structuredSnippets': json['structuredSnippets'] == null ? undefined : ((json['structuredSnippets'] as Array<any>).map(StructuredSnippetFromJSON)),
+        'customLabels': json['customLabels'] == null ? undefined : json['customLabels'],
+        'trackingUrlTemplate': json['trackingUrlTemplate'] == null ? undefined : json['trackingUrlTemplate'],
+        'finalUrlSuffix': json['finalUrlSuffix'] == null ? undefined : json['finalUrlSuffix'],
+        'urlCustomParameters': json['urlCustomParameters'] == null ? undefined : json['urlCustomParameters'],
+    };
+}
+
+export function AdUpdateToJSON(json: any): AdUpdate {
+    return AdUpdateToJSONTyped(json, false);
+}
+
+export function AdUpdateToJSONTyped(value?: AdUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'adGroupId': value['adGroupId'],
+        'campaignId': value['campaignId'],
+        'headlinePart1': value['headlinePart1'],
+        'headlinePart2': value['headlinePart2'],
+        'headlinePart3': value['headlinePart3'],
+        'description': value['description'],
+        'description2': value['description2'],
+        'finalUrl': value['finalUrl'],
+        'path1': value['path1'],
+        'path2': value['path2'],
+        'status': value['status'],
+        'sitelinks': value['sitelinks'] == null ? undefined : ((value['sitelinks'] as Array<any>).map(SitelinkToJSON)),
+        'callouts': value['callouts'],
+        'structuredSnippets': value['structuredSnippets'] == null ? undefined : ((value['structuredSnippets'] as Array<any>).map(StructuredSnippetToJSON)),
+        'customLabels': value['customLabels'],
+        'trackingUrlTemplate': value['trackingUrlTemplate'],
+        'finalUrlSuffix': value['finalUrlSuffix'],
+        'urlCustomParameters': value['urlCustomParameters'],
+    };
+}
+

package/src/generated/models/AssetCreate.ts

@@ -0,0 +1,175 @@
+/* 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';
+/**
+ * URL-by-reference asset creation. The asset is stored as a pointer to the remote URL and is marked READY immediately. Platform syncs fetch the bytes lazily.
+ * @export
+ * @interface AssetCreate
+ */
+export interface AssetCreate {
+    /**
+     * Public http(s) URL.
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    url: string;
+    /**
+     * Defaults to the URL filename.
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    type?: AssetCreateTypeEnum;
+    /**
+     * Generic media bucket. Defaults from `type` when omitted (IMAGE for IMAGE/LOGO, VIDEO for VIDEO).
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    mediaType?: AssetCreateMediaTypeEnum;
+    /**
+     * YouTube video id for VIDEO assets (no hosting/transcoding; referenced by id).
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    youtubeVideoId?: string;
+    /**
+     * MIME type. Inferred from the URL when absent.
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    contentType?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AssetCreate
+     */
+    sizeBytes?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AssetCreate
+     */
+    width?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AssetCreate
+     */
+    height?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AssetCreate
+     */
+    tags?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetCreate
+     */
+    altText?: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof AssetCreate
+     */
+    metadata?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const AssetCreateTypeEnum = {
+    IMAGE: 'IMAGE',
+    LOGO: 'LOGO',
+    VIDEO: 'VIDEO'
+} as const;
+export type AssetCreateTypeEnum = typeof AssetCreateTypeEnum[keyof typeof AssetCreateTypeEnum];
+
+/**
+ * @export
+ */
+export const AssetCreateMediaTypeEnum = {
+    IMAGE: 'IMAGE',
+    VIDEO: 'VIDEO'
+} as const;
+export type AssetCreateMediaTypeEnum = typeof AssetCreateMediaTypeEnum[keyof typeof AssetCreateMediaTypeEnum];
+
+
+/**
+ * Check if a given object implements the AssetCreate interface.
+ */
+export function instanceOfAssetCreate(value: object): value is AssetCreate {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    return true;
+}
+
+export function AssetCreateFromJSON(json: any): AssetCreate {
+    return AssetCreateFromJSONTyped(json, false);
+}
+
+export function AssetCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'mediaType': json['mediaType'] == null ? undefined : json['mediaType'],
+        'youtubeVideoId': json['youtubeVideoId'] == null ? undefined : json['youtubeVideoId'],
+        'contentType': json['contentType'] == null ? undefined : json['contentType'],
+        'sizeBytes': json['sizeBytes'] == null ? undefined : json['sizeBytes'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function AssetCreateToJSON(json: any): AssetCreate {
+    return AssetCreateToJSONTyped(json, false);
+}
+
+export function AssetCreateToJSONTyped(value?: AssetCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+        'name': value['name'],
+        'type': value['type'],
+        'mediaType': value['mediaType'],
+        'youtubeVideoId': value['youtubeVideoId'],
+        'contentType': value['contentType'],
+        'sizeBytes': value['sizeBytes'],
+        'width': value['width'],
+        'height': value['height'],
+        'tags': value['tags'],
+        'altText': value['altText'],
+        'metadata': value['metadata'],
+    };
+}
+

package/src/generated/models/AssetUpdate.ts

@@ -0,0 +1,125 @@
+/* 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';
+/**
+ * Partial Asset. Only the curated fields below are accepted; identity fields (id, url, contentType, sizeBytes, source) are immutable post-creation.
+ * @export
+ * @interface AssetUpdate
+ */
+export interface AssetUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetUpdate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetUpdate
+     */
+    altText?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AssetUpdate
+     */
+    tags?: Array<string>;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof AssetUpdate
+     */
+    metadata?: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetUpdate
+     */
+    status?: AssetUpdateStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof AssetUpdate
+     */
+    width?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AssetUpdate
+     */
+    height?: number;
+}
+
+
+/**
+ * @export
+ */
+export const AssetUpdateStatusEnum = {
+    PROCESSING: 'PROCESSING',
+    READY: 'READY',
+    FAILED: 'FAILED'
+} as const;
+export type AssetUpdateStatusEnum = typeof AssetUpdateStatusEnum[keyof typeof AssetUpdateStatusEnum];
+
+
+/**
+ * Check if a given object implements the AssetUpdate interface.
+ */
+export function instanceOfAssetUpdate(value: object): value is AssetUpdate {
+    return true;
+}
+
+export function AssetUpdateFromJSON(json: any): AssetUpdate {
+    return AssetUpdateFromJSONTyped(json, false);
+}
+
+export function AssetUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+    };
+}
+
+export function AssetUpdateToJSON(json: any): AssetUpdate {
+    return AssetUpdateToJSONTyped(json, false);
+}
+
+export function AssetUpdateToJSONTyped(value?: AssetUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'altText': value['altText'],
+        'tags': value['tags'],
+        'metadata': value['metadata'],
+        'status': value['status'],
+        'width': value['width'],
+        'height': value['height'],
+    };
+}
+

package/src/generated/models/BiddingStrategy.ts

@@ -0,0 +1,114 @@
+/* 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 BiddingStrategy
+ */
+export interface BiddingStrategy {
+    /**
+     * 
+     * @type {string}
+     * @memberof BiddingStrategy
+     */
+    type?: BiddingStrategyTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof BiddingStrategy
+     */
+    targetCpa?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof BiddingStrategy
+     */
+    targetRoas?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof BiddingStrategy
+     */
+    targetImpressionShare?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof BiddingStrategy
+     */
+    maxCpcBidCeiling?: number;
+}
+
+
+/**
+ * @export
+ */
+export const BiddingStrategyTypeEnum = {
+    MANUAL_CPC: 'MANUAL_CPC',
+    ENHANCED_CPC: 'ENHANCED_CPC',
+    MAXIMIZE_CLICKS: 'MAXIMIZE_CLICKS',
+    MAXIMIZE_CONVERSIONS: 'MAXIMIZE_CONVERSIONS',
+    MAXIMIZE_CONVERSION_VALUE: 'MAXIMIZE_CONVERSION_VALUE',
+    TARGET_CPA: 'TARGET_CPA',
+    TARGET_ROAS: 'TARGET_ROAS',
+    TARGET_IMPRESSION_SHARE: 'TARGET_IMPRESSION_SHARE'
+} as const;
+export type BiddingStrategyTypeEnum = typeof BiddingStrategyTypeEnum[keyof typeof BiddingStrategyTypeEnum];
+
+
+/**
+ * Check if a given object implements the BiddingStrategy interface.
+ */
+export function instanceOfBiddingStrategy(value: object): value is BiddingStrategy {
+    return true;
+}
+
+export function BiddingStrategyFromJSON(json: any): BiddingStrategy {
+    return BiddingStrategyFromJSONTyped(json, false);
+}
+
+export function BiddingStrategyFromJSONTyped(json: any, ignoreDiscriminator: boolean): BiddingStrategy {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'] == null ? undefined : json['type'],
+        'targetCpa': json['targetCpa'] == null ? undefined : json['targetCpa'],
+        'targetRoas': json['targetRoas'] == null ? undefined : json['targetRoas'],
+        'targetImpressionShare': json['targetImpressionShare'] == null ? undefined : json['targetImpressionShare'],
+        'maxCpcBidCeiling': json['maxCpcBidCeiling'] == null ? undefined : json['maxCpcBidCeiling'],
+    };
+}
+
+export function BiddingStrategyToJSON(json: any): BiddingStrategy {
+    return BiddingStrategyToJSONTyped(json, false);
+}
+
+export function BiddingStrategyToJSONTyped(value?: BiddingStrategy | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'targetCpa': value['targetCpa'],
+        'targetRoas': value['targetRoas'],
+        'targetImpressionShare': value['targetImpressionShare'],
+        'maxCpcBidCeiling': value['maxCpcBidCeiling'],
+    };
+}
+

package/src/generated/models/CampaignAdScheduleField.ts

@@ -0,0 +1,16 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Patched by scripts/patch-generated.mjs (US-ADS-267).
+ * OpenAPI Generator emits broken codecs for oneOf schemas that mix a primitive
+ * with an object/array. The union type is correct; these identity codecs replace
+ * the broken generated ones (the values are plain JSON — no (de)serialization).
+ */
+import type { StructuredSchedule } from './StructuredSchedule';
+
+export type CampaignAdScheduleField = StructuredSchedule | string;
+
+export function CampaignAdScheduleFieldFromJSON(json: any): CampaignAdScheduleField { return json; }
+export function CampaignAdScheduleFieldFromJSONTyped(json: any, _ignoreDiscriminator: boolean): CampaignAdScheduleField { return json; }
+export function CampaignAdScheduleFieldToJSON(value?: CampaignAdScheduleField | null): any { return value; }
+export function CampaignAdScheduleFieldToJSONTyped(value?: CampaignAdScheduleField | null, _ignoreDiscriminator: boolean = false): any { return value; }