@defoai/ads-client 1.4.0

package/src/generated/models/CampaignAssetCreate.ts

@@ -0,0 +1,100 @@
+/* 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 CampaignAssetCreate
+ */
+export interface CampaignAssetCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignAssetCreate
+     */
+    campaignId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignAssetCreate
+     */
+    assetId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignAssetCreate
+     */
+    role: CampaignAssetCreateRoleEnum;
+}
+
+
+/**
+ * @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'
+} as const;
+export type CampaignAssetCreateRoleEnum = typeof CampaignAssetCreateRoleEnum[keyof typeof CampaignAssetCreateRoleEnum];
+
+
+/**
+ * Check if a given object implements the CampaignAssetCreate interface.
+ */
+export function instanceOfCampaignAssetCreate(value: object): value is CampaignAssetCreate {
+    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: any): CampaignAssetCreate {
+    return CampaignAssetCreateFromJSONTyped(json, false);
+}
+
+export function CampaignAssetCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignAssetCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'campaignId': json['campaignId'],
+        'assetId': json['assetId'],
+        'role': json['role'],
+    };
+}
+
+export function CampaignAssetCreateToJSON(json: any): CampaignAssetCreate {
+    return CampaignAssetCreateToJSONTyped(json, false);
+}
+
+export function CampaignAssetCreateToJSONTyped(value?: CampaignAssetCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'campaignId': value['campaignId'],
+        'assetId': value['assetId'],
+        'role': value['role'],
+    };
+}
+

package/src/generated/models/CampaignCreate.ts

@@ -0,0 +1,263 @@
+/* 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 { CampaignAdScheduleField } from './CampaignAdScheduleField';
+import {
+    CampaignAdScheduleFieldFromJSON,
+    CampaignAdScheduleFieldFromJSONTyped,
+    CampaignAdScheduleFieldToJSON,
+    CampaignAdScheduleFieldToJSONTyped,
+} from './CampaignAdScheduleField';
+import type { BiddingStrategy } from './BiddingStrategy';
+import {
+    BiddingStrategyFromJSON,
+    BiddingStrategyFromJSONTyped,
+    BiddingStrategyToJSON,
+    BiddingStrategyToJSONTyped,
+} from './BiddingStrategy';
+import type { CampaignTargeting } from './CampaignTargeting';
+import {
+    CampaignTargetingFromJSON,
+    CampaignTargetingFromJSONTyped,
+    CampaignTargetingToJSON,
+    CampaignTargetingToJSONTyped,
+} from './CampaignTargeting';
+import type { NegativeKeywordEntry } from './NegativeKeywordEntry';
+import {
+    NegativeKeywordEntryFromJSON,
+    NegativeKeywordEntryFromJSONTyped,
+    NegativeKeywordEntryToJSON,
+    NegativeKeywordEntryToJSONTyped,
+} from './NegativeKeywordEntry';
+import type { Location } from './Location';
+import {
+    LocationFromJSON,
+    LocationFromJSONTyped,
+    LocationToJSON,
+    LocationToJSONTyped,
+} from './Location';
+
+/**
+ * 
+ * @export
+ * @interface CampaignCreate
+ */
+export interface CampaignCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    name: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CampaignCreate
+     */
+    budget: number;
+    /**
+     * ISO 4217 (USD, EUR, …).
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    currency?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    status?: CampaignCreateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    type?: CampaignCreateTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    networks?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    languages?: string;
+    /**
+     * String ID link to a Site.
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    siteId?: string;
+    /**
+     * Free-form goal text consumed by AI.
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    goal?: string;
+    /**
+     * 
+     * @type {Array<Location>}
+     * @memberof CampaignCreate
+     */
+    targetLocations?: Array<Location>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CampaignCreate
+     */
+    customLabels?: Array<string>;
+    /**
+     * 
+     * @type {CampaignAdScheduleField}
+     * @memberof CampaignCreate
+     */
+    adSchedule?: CampaignAdScheduleField;
+    /**
+     * 
+     * @type {BiddingStrategy}
+     * @memberof CampaignCreate
+     */
+    biddingStrategy?: BiddingStrategy;
+    /**
+     * 
+     * @type {CampaignTargeting}
+     * @memberof CampaignCreate
+     */
+    targeting?: CampaignTargeting;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignCreate
+     */
+    finalUrlSuffix?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof CampaignCreate
+     */
+    urlCustomParameters?: { [key: string]: string; };
+    /**
+     * 
+     * @type {Array<NegativeKeywordEntry>}
+     * @memberof CampaignCreate
+     */
+    negativeKeywords?: Array<NegativeKeywordEntry>;
+}
+
+
+/**
+ * @export
+ */
+export const CampaignCreateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type CampaignCreateStatusEnum = typeof CampaignCreateStatusEnum[keyof typeof CampaignCreateStatusEnum];
+
+/**
+ * @export
+ */
+export const CampaignCreateTypeEnum = {
+    SEARCH: 'SEARCH',
+    DISPLAY: 'DISPLAY',
+    VIDEO: 'VIDEO',
+    SHOPPING: 'SHOPPING',
+    PERFORMANCE_MAX: 'PERFORMANCE_MAX'
+} as const;
+export type CampaignCreateTypeEnum = typeof CampaignCreateTypeEnum[keyof typeof CampaignCreateTypeEnum];
+
+
+/**
+ * Check if a given object implements the CampaignCreate interface.
+ */
+export function instanceOfCampaignCreate(value: object): value is CampaignCreate {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('budget' in value) || value['budget'] === undefined) return false;
+    return true;
+}
+
+export function CampaignCreateFromJSON(json: any): CampaignCreate {
+    return CampaignCreateFromJSONTyped(json, false);
+}
+
+export function CampaignCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'budget': json['budget'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'networks': json['networks'] == null ? undefined : json['networks'],
+        'languages': json['languages'] == null ? undefined : json['languages'],
+        'siteId': json['siteId'] == null ? undefined : json['siteId'],
+        'goal': json['goal'] == null ? undefined : json['goal'],
+        'targetLocations': json['targetLocations'] == null ? undefined : ((json['targetLocations'] as Array<any>).map(LocationFromJSON)),
+        'customLabels': json['customLabels'] == null ? undefined : json['customLabels'],
+        'adSchedule': json['adSchedule'] == null ? undefined : CampaignAdScheduleFieldFromJSON(json['adSchedule']),
+        'biddingStrategy': json['biddingStrategy'] == null ? undefined : BiddingStrategyFromJSON(json['biddingStrategy']),
+        'targeting': json['targeting'] == null ? undefined : CampaignTargetingFromJSON(json['targeting']),
+        'trackingUrlTemplate': json['trackingUrlTemplate'] == null ? undefined : json['trackingUrlTemplate'],
+        'finalUrlSuffix': json['finalUrlSuffix'] == null ? undefined : json['finalUrlSuffix'],
+        'urlCustomParameters': json['urlCustomParameters'] == null ? undefined : json['urlCustomParameters'],
+        'negativeKeywords': json['negativeKeywords'] == null ? undefined : ((json['negativeKeywords'] as Array<any>).map(NegativeKeywordEntryFromJSON)),
+    };
+}
+
+export function CampaignCreateToJSON(json: any): CampaignCreate {
+    return CampaignCreateToJSONTyped(json, false);
+}
+
+export function CampaignCreateToJSONTyped(value?: CampaignCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'budget': value['budget'],
+        'currency': value['currency'],
+        'status': value['status'],
+        'type': value['type'],
+        'networks': value['networks'],
+        'languages': value['languages'],
+        'siteId': value['siteId'],
+        'goal': value['goal'],
+        'targetLocations': value['targetLocations'] == null ? undefined : ((value['targetLocations'] as Array<any>).map(LocationToJSON)),
+        'customLabels': value['customLabels'],
+        'adSchedule': CampaignAdScheduleFieldToJSON(value['adSchedule']),
+        'biddingStrategy': BiddingStrategyToJSON(value['biddingStrategy']),
+        'targeting': CampaignTargetingToJSON(value['targeting']),
+        'trackingUrlTemplate': value['trackingUrlTemplate'],
+        'finalUrlSuffix': value['finalUrlSuffix'],
+        'urlCustomParameters': value['urlCustomParameters'],
+        'negativeKeywords': value['negativeKeywords'] == null ? undefined : ((value['negativeKeywords'] as Array<any>).map(NegativeKeywordEntryToJSON)),
+    };
+}
+

package/src/generated/models/CampaignTargeting.ts

@@ -0,0 +1,89 @@
+/* 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';
+/**
+ * US-ADS-132 structured targeting (schedule, devices, radius, LinkedIn).
+ * @export
+ * @interface CampaignTargeting
+ */
+export interface CampaignTargeting {
+    /**
+     * 
+     * @type {Array<object>}
+     * @memberof CampaignTargeting
+     */
+    schedule?: Array<object>;
+    /**
+     * 
+     * @type {object}
+     * @memberof CampaignTargeting
+     */
+    devices?: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof CampaignTargeting
+     */
+    radius?: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof CampaignTargeting
+     */
+    linkedin?: object;
+}
+
+/**
+ * Check if a given object implements the CampaignTargeting interface.
+ */
+export function instanceOfCampaignTargeting(value: object): value is CampaignTargeting {
+    return true;
+}
+
+export function CampaignTargetingFromJSON(json: any): CampaignTargeting {
+    return CampaignTargetingFromJSONTyped(json, false);
+}
+
+export function CampaignTargetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignTargeting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'schedule': json['schedule'] == null ? undefined : json['schedule'],
+        'devices': json['devices'] == null ? undefined : json['devices'],
+        'radius': json['radius'] == null ? undefined : json['radius'],
+        'linkedin': json['linkedin'] == null ? undefined : json['linkedin'],
+    };
+}
+
+export function CampaignTargetingToJSON(json: any): CampaignTargeting {
+    return CampaignTargetingToJSONTyped(json, false);
+}
+
+export function CampaignTargetingToJSONTyped(value?: CampaignTargeting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'schedule': value['schedule'],
+        'devices': value['devices'],
+        'radius': value['radius'],
+        'linkedin': value['linkedin'],
+    };
+}
+