@defoai/ads-client 1.4.0

package/src/generated/models/AdCreate.ts

@@ -0,0 +1,234 @@
+/* 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';
+
+/**
+ * 
+ * @export
+ * @interface AdCreate
+ */
+export interface AdCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    adGroupId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    campaignId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    headlinePart1: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    headlinePart2: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    headlinePart3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    description2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    finalUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    path1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    path2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    status?: AdCreateStatusEnum;
+    /**
+     * 
+     * @type {Array<Sitelink>}
+     * @memberof AdCreate
+     */
+    sitelinks?: Array<Sitelink>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AdCreate
+     */
+    callouts?: Array<string>;
+    /**
+     * 
+     * @type {Array<StructuredSnippet>}
+     * @memberof AdCreate
+     */
+    structuredSnippets?: Array<StructuredSnippet>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AdCreate
+     */
+    customLabels?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdCreate
+     */
+    finalUrlSuffix?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof AdCreate
+     */
+    urlCustomParameters?: { [key: string]: string; };
+}
+
+
+/**
+ * @export
+ */
+export const AdCreateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type AdCreateStatusEnum = typeof AdCreateStatusEnum[keyof typeof AdCreateStatusEnum];
+
+
+/**
+ * Check if a given object implements the AdCreate interface.
+ */
+export function instanceOfAdCreate(value: object): value is AdCreate {
+    if (!('adGroupId' in value) || value['adGroupId'] === undefined) return false;
+    if (!('campaignId' in value) || value['campaignId'] === undefined) return false;
+    if (!('headlinePart1' in value) || value['headlinePart1'] === undefined) return false;
+    if (!('headlinePart2' in value) || value['headlinePart2'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('finalUrl' in value) || value['finalUrl'] === undefined) return false;
+    return true;
+}
+
+export function AdCreateFromJSON(json: any): AdCreate {
+    return AdCreateFromJSONTyped(json, false);
+}
+
+export function AdCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adGroupId': json['adGroupId'],
+        'campaignId': json['campaignId'],
+        'headlinePart1': json['headlinePart1'],
+        'headlinePart2': json['headlinePart2'],
+        'headlinePart3': json['headlinePart3'] == null ? undefined : json['headlinePart3'],
+        'description': json['description'],
+        'description2': json['description2'] == null ? undefined : json['description2'],
+        'finalUrl': 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 AdCreateToJSON(json: any): AdCreate {
+    return AdCreateToJSONTyped(json, false);
+}
+
+export function AdCreateToJSONTyped(value?: AdCreate | 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/AdGroupAudience.ts

@@ -0,0 +1,83 @@
+/* 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 AdGroupAudience
+ */
+export interface AdGroupAudience {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupAudience
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupAudience
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AdGroupAudience
+     */
+    bidAdjustment?: number;
+}
+
+/**
+ * Check if a given object implements the AdGroupAudience interface.
+ */
+export function instanceOfAdGroupAudience(value: object): value is AdGroupAudience {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    return true;
+}
+
+export function AdGroupAudienceFromJSON(json: any): AdGroupAudience {
+    return AdGroupAudienceFromJSONTyped(json, false);
+}
+
+export function AdGroupAudienceFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdGroupAudience {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'id': json['id'],
+        'bidAdjustment': json['bidAdjustment'] == null ? undefined : json['bidAdjustment'],
+    };
+}
+
+export function AdGroupAudienceToJSON(json: any): AdGroupAudience {
+    return AdGroupAudienceToJSONTyped(json, false);
+}
+
+export function AdGroupAudienceToJSONTyped(value?: AdGroupAudience | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'id': value['id'],
+        'bidAdjustment': value['bidAdjustment'],
+    };
+}
+

package/src/generated/models/AdGroupCreate.ts

@@ -0,0 +1,167 @@
+/* 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 { AdGroupAudience } from './AdGroupAudience';
+import {
+    AdGroupAudienceFromJSON,
+    AdGroupAudienceFromJSONTyped,
+    AdGroupAudienceToJSON,
+    AdGroupAudienceToJSONTyped,
+} from './AdGroupAudience';
+
+/**
+ * 
+ * @export
+ * @interface AdGroupCreate
+ */
+export interface AdGroupCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupCreate
+     */
+    campaignId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupCreate
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupCreate
+     */
+    status?: AdGroupCreateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupCreate
+     */
+    type?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AdGroupCreate
+     */
+    cpc?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AdGroupCreate
+     */
+    cpcBid?: number;
+    /**
+     * 
+     * @type {Array<AdGroupAudience>}
+     * @memberof AdGroupCreate
+     */
+    audiences?: Array<AdGroupAudience>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AdGroupCreate
+     */
+    customLabels?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupCreate
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupCreate
+     */
+    finalUrlSuffix?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof AdGroupCreate
+     */
+    urlCustomParameters?: { [key: string]: string; };
+}
+
+
+/**
+ * @export
+ */
+export const AdGroupCreateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type AdGroupCreateStatusEnum = typeof AdGroupCreateStatusEnum[keyof typeof AdGroupCreateStatusEnum];
+
+
+/**
+ * Check if a given object implements the AdGroupCreate interface.
+ */
+export function instanceOfAdGroupCreate(value: object): value is AdGroupCreate {
+    if (!('campaignId' in value) || value['campaignId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function AdGroupCreateFromJSON(json: any): AdGroupCreate {
+    return AdGroupCreateFromJSONTyped(json, false);
+}
+
+export function AdGroupCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdGroupCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'campaignId': json['campaignId'],
+        'name': json['name'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'cpc': json['cpc'] == null ? undefined : json['cpc'],
+        'cpcBid': json['cpcBid'] == null ? undefined : json['cpcBid'],
+        'audiences': json['audiences'] == null ? undefined : ((json['audiences'] as Array<any>).map(AdGroupAudienceFromJSON)),
+        '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 AdGroupCreateToJSON(json: any): AdGroupCreate {
+    return AdGroupCreateToJSONTyped(json, false);
+}
+
+export function AdGroupCreateToJSONTyped(value?: AdGroupCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'campaignId': value['campaignId'],
+        'name': value['name'],
+        'status': value['status'],
+        'type': value['type'],
+        'cpc': value['cpc'],
+        'cpcBid': value['cpcBid'],
+        'audiences': value['audiences'] == null ? undefined : ((value['audiences'] as Array<any>).map(AdGroupAudienceToJSON)),
+        'customLabels': value['customLabels'],
+        'trackingUrlTemplate': value['trackingUrlTemplate'],
+        'finalUrlSuffix': value['finalUrlSuffix'],
+        'urlCustomParameters': value['urlCustomParameters'],
+    };
+}
+

package/src/generated/models/AdGroupUpdate.ts

@@ -0,0 +1,165 @@
+/* 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 { AdGroupAudience } from './AdGroupAudience';
+import {
+    AdGroupAudienceFromJSON,
+    AdGroupAudienceFromJSONTyped,
+    AdGroupAudienceToJSON,
+    AdGroupAudienceToJSONTyped,
+} from './AdGroupAudience';
+
+/**
+ * Partial AdGroup. Omitted fields are unchanged.
+ * @export
+ * @interface AdGroupUpdate
+ */
+export interface AdGroupUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupUpdate
+     */
+    campaignId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupUpdate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupUpdate
+     */
+    status?: AdGroupUpdateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupUpdate
+     */
+    type?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AdGroupUpdate
+     */
+    cpc?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AdGroupUpdate
+     */
+    cpcBid?: number;
+    /**
+     * 
+     * @type {Array<AdGroupAudience>}
+     * @memberof AdGroupUpdate
+     */
+    audiences?: Array<AdGroupAudience>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof AdGroupUpdate
+     */
+    customLabels?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupUpdate
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdGroupUpdate
+     */
+    finalUrlSuffix?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof AdGroupUpdate
+     */
+    urlCustomParameters?: { [key: string]: string; };
+}
+
+
+/**
+ * @export
+ */
+export const AdGroupUpdateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type AdGroupUpdateStatusEnum = typeof AdGroupUpdateStatusEnum[keyof typeof AdGroupUpdateStatusEnum];
+
+
+/**
+ * Check if a given object implements the AdGroupUpdate interface.
+ */
+export function instanceOfAdGroupUpdate(value: object): value is AdGroupUpdate {
+    return true;
+}
+
+export function AdGroupUpdateFromJSON(json: any): AdGroupUpdate {
+    return AdGroupUpdateFromJSONTyped(json, false);
+}
+
+export function AdGroupUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdGroupUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'campaignId': json['campaignId'] == null ? undefined : json['campaignId'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'cpc': json['cpc'] == null ? undefined : json['cpc'],
+        'cpcBid': json['cpcBid'] == null ? undefined : json['cpcBid'],
+        'audiences': json['audiences'] == null ? undefined : ((json['audiences'] as Array<any>).map(AdGroupAudienceFromJSON)),
+        '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 AdGroupUpdateToJSON(json: any): AdGroupUpdate {
+    return AdGroupUpdateToJSONTyped(json, false);
+}
+
+export function AdGroupUpdateToJSONTyped(value?: AdGroupUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'campaignId': value['campaignId'],
+        'name': value['name'],
+        'status': value['status'],
+        'type': value['type'],
+        'cpc': value['cpc'],
+        'cpcBid': value['cpcBid'],
+        'audiences': value['audiences'] == null ? undefined : ((value['audiences'] as Array<any>).map(AdGroupAudienceToJSON)),
+        'customLabels': value['customLabels'],
+        'trackingUrlTemplate': value['trackingUrlTemplate'],
+        'finalUrlSuffix': value['finalUrlSuffix'],
+        'urlCustomParameters': value['urlCustomParameters'],
+    };
+}
+