@defoai/ads-client 1.4.0

package/dist/generated/models/AssetCreate.d.ts

@@ -0,0 +1,117 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const AssetCreateTypeEnum: {
+    readonly IMAGE: "IMAGE";
+    readonly LOGO: "LOGO";
+    readonly VIDEO: "VIDEO";
+};
+export type AssetCreateTypeEnum = typeof AssetCreateTypeEnum[keyof typeof AssetCreateTypeEnum];
+/**
+ * @export
+ */
+export declare const AssetCreateMediaTypeEnum: {
+    readonly IMAGE: "IMAGE";
+    readonly VIDEO: "VIDEO";
+};
+export type AssetCreateMediaTypeEnum = typeof AssetCreateMediaTypeEnum[keyof typeof AssetCreateMediaTypeEnum];
+/**
+ * Check if a given object implements the AssetCreate interface.
+ */
+export declare function instanceOfAssetCreate(value: object): value is AssetCreate;
+export declare function AssetCreateFromJSON(json: any): AssetCreate;
+export declare function AssetCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetCreate;
+export declare function AssetCreateToJSON(json: any): AssetCreate;
+export declare function AssetCreateToJSONTyped(value?: AssetCreate | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/AssetCreate.js

@@ -0,0 +1,80 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const AssetCreateTypeEnum = {
+    IMAGE: 'IMAGE',
+    LOGO: 'LOGO',
+    VIDEO: 'VIDEO'
+};
+/**
+ * @export
+ */
+export const AssetCreateMediaTypeEnum = {
+    IMAGE: 'IMAGE',
+    VIDEO: 'VIDEO'
+};
+/**
+ * Check if a given object implements the AssetCreate interface.
+ */
+export function instanceOfAssetCreate(value) {
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    return true;
+}
+export function AssetCreateFromJSON(json) {
+    return AssetCreateFromJSONTyped(json, false);
+}
+export function AssetCreateFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return AssetCreateToJSONTyped(json, false);
+}
+export function AssetCreateToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/generated/models/AssetUpdate.d.ts

@@ -0,0 +1,79 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const AssetUpdateStatusEnum: {
+    readonly PROCESSING: "PROCESSING";
+    readonly READY: "READY";
+    readonly FAILED: "FAILED";
+};
+export type AssetUpdateStatusEnum = typeof AssetUpdateStatusEnum[keyof typeof AssetUpdateStatusEnum];
+/**
+ * Check if a given object implements the AssetUpdate interface.
+ */
+export declare function instanceOfAssetUpdate(value: object): value is AssetUpdate;
+export declare function AssetUpdateFromJSON(json: any): AssetUpdate;
+export declare function AssetUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetUpdate;
+export declare function AssetUpdateToJSON(json: any): AssetUpdate;
+export declare function AssetUpdateToJSONTyped(value?: AssetUpdate | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/AssetUpdate.js

@@ -0,0 +1,61 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const AssetUpdateStatusEnum = {
+    PROCESSING: 'PROCESSING',
+    READY: 'READY',
+    FAILED: 'FAILED'
+};
+/**
+ * Check if a given object implements the AssetUpdate interface.
+ */
+export function instanceOfAssetUpdate(value) {
+    return true;
+}
+export function AssetUpdateFromJSON(json) {
+    return AssetUpdateFromJSONTyped(json, false);
+}
+export function AssetUpdateFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return AssetUpdateToJSONTyped(json, false);
+}
+export function AssetUpdateToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/generated/models/BiddingStrategy.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const BiddingStrategyTypeEnum: {
+    readonly MANUAL_CPC: "MANUAL_CPC";
+    readonly ENHANCED_CPC: "ENHANCED_CPC";
+    readonly MAXIMIZE_CLICKS: "MAXIMIZE_CLICKS";
+    readonly MAXIMIZE_CONVERSIONS: "MAXIMIZE_CONVERSIONS";
+    readonly MAXIMIZE_CONVERSION_VALUE: "MAXIMIZE_CONVERSION_VALUE";
+    readonly TARGET_CPA: "TARGET_CPA";
+    readonly TARGET_ROAS: "TARGET_ROAS";
+    readonly TARGET_IMPRESSION_SHARE: "TARGET_IMPRESSION_SHARE";
+};
+export type BiddingStrategyTypeEnum = typeof BiddingStrategyTypeEnum[keyof typeof BiddingStrategyTypeEnum];
+/**
+ * Check if a given object implements the BiddingStrategy interface.
+ */
+export declare function instanceOfBiddingStrategy(value: object): value is BiddingStrategy;
+export declare function BiddingStrategyFromJSON(json: any): BiddingStrategy;
+export declare function BiddingStrategyFromJSONTyped(json: any, ignoreDiscriminator: boolean): BiddingStrategy;
+export declare function BiddingStrategyToJSON(json: any): BiddingStrategy;
+export declare function BiddingStrategyToJSONTyped(value?: BiddingStrategy | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/BiddingStrategy.js

@@ -0,0 +1,62 @@
+/* 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.
+ */
+/**
+ * @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'
+};
+/**
+ * Check if a given object implements the BiddingStrategy interface.
+ */
+export function instanceOfBiddingStrategy(value) {
+    return true;
+}
+export function BiddingStrategyFromJSON(json) {
+    return BiddingStrategyFromJSONTyped(json, false);
+}
+export function BiddingStrategyFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return BiddingStrategyToJSONTyped(json, false);
+}
+export function BiddingStrategyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'targetCpa': value['targetCpa'],
+        'targetRoas': value['targetRoas'],
+        'targetImpressionShare': value['targetImpressionShare'],
+        'maxCpcBidCeiling': value['maxCpcBidCeiling'],
+    };
+}

package/dist/generated/models/CampaignAdScheduleField.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 declare function CampaignAdScheduleFieldFromJSON(json: any): CampaignAdScheduleField;
+export declare function CampaignAdScheduleFieldFromJSONTyped(json: any, _ignoreDiscriminator: boolean): CampaignAdScheduleField;
+export declare function CampaignAdScheduleFieldToJSON(value?: CampaignAdScheduleField | null): any;
+export declare function CampaignAdScheduleFieldToJSONTyped(value?: CampaignAdScheduleField | null, _ignoreDiscriminator?: boolean): any;

package/dist/generated/models/CampaignAdScheduleField.js

@@ -0,0 +1,4 @@
+export function CampaignAdScheduleFieldFromJSON(json) { return json; }
+export function CampaignAdScheduleFieldFromJSONTyped(json, _ignoreDiscriminator) { return json; }
+export function CampaignAdScheduleFieldToJSON(value) { return value; }
+export function CampaignAdScheduleFieldToJSONTyped(value, _ignoreDiscriminator = false) { return value; }

package/dist/generated/models/CampaignAssetCreate.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CampaignAssetCreate
+ */
+export interface CampaignAssetCreate {
+    /**
+     *
+     * @type {string}
+     * @memberof CampaignAssetCreate
+     */
+    campaignId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CampaignAssetCreate
+     */
+    assetId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CampaignAssetCreate
+     */
+    role: CampaignAssetCreateRoleEnum;
+}
+/**
+ * @export
+ */
+export declare const CampaignAssetCreateRoleEnum: {
+    readonly MARKETING_IMAGE: "MARKETING_IMAGE";
+    readonly SQUARE_MARKETING_IMAGE: "SQUARE_MARKETING_IMAGE";
+    readonly PORTRAIT_MARKETING_IMAGE: "PORTRAIT_MARKETING_IMAGE";
+    readonly LOGO: "LOGO";
+    readonly LANDSCAPE_LOGO: "LANDSCAPE_LOGO";
+    readonly YOUTUBE_VIDEO: "YOUTUBE_VIDEO";
+    readonly VIDEO: "VIDEO";
+};
+export type CampaignAssetCreateRoleEnum = typeof CampaignAssetCreateRoleEnum[keyof typeof CampaignAssetCreateRoleEnum];
+/**
+ * Check if a given object implements the CampaignAssetCreate interface.
+ */
+export declare function instanceOfCampaignAssetCreate(value: object): value is CampaignAssetCreate;
+export declare function CampaignAssetCreateFromJSON(json: any): CampaignAssetCreate;
+export declare function CampaignAssetCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignAssetCreate;
+export declare function CampaignAssetCreateToJSON(json: any): CampaignAssetCreate;
+export declare function CampaignAssetCreateToJSONTyped(value?: CampaignAssetCreate | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/CampaignAssetCreate.js

@@ -0,0 +1,63 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CampaignAssetCreateRoleEnum = {
+    MARKETING_IMAGE: 'MARKETING_IMAGE',
+    SQUARE_MARKETING_IMAGE: 'SQUARE_MARKETING_IMAGE',
+    PORTRAIT_MARKETING_IMAGE: 'PORTRAIT_MARKETING_IMAGE',
+    LOGO: 'LOGO',
+    LANDSCAPE_LOGO: 'LANDSCAPE_LOGO',
+    YOUTUBE_VIDEO: 'YOUTUBE_VIDEO',
+    VIDEO: 'VIDEO'
+};
+/**
+ * Check if a given object implements the CampaignAssetCreate interface.
+ */
+export function instanceOfCampaignAssetCreate(value) {
+    if (!('campaignId' in value) || value['campaignId'] === undefined)
+        return false;
+    if (!('assetId' in value) || value['assetId'] === undefined)
+        return false;
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    return true;
+}
+export function CampaignAssetCreateFromJSON(json) {
+    return CampaignAssetCreateFromJSONTyped(json, false);
+}
+export function CampaignAssetCreateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'campaignId': json['campaignId'],
+        'assetId': json['assetId'],
+        'role': json['role'],
+    };
+}
+export function CampaignAssetCreateToJSON(json) {
+    return CampaignAssetCreateToJSONTyped(json, false);
+}
+export function CampaignAssetCreateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'campaignId': value['campaignId'],
+        'assetId': value['assetId'],
+        'role': value['role'],
+    };
+}