@defoai/ads-client 1.4.0

package/src/generated/models/CampaignUpdate.ts

@@ -0,0 +1,261 @@
+/* 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';
+
+/**
+ * Partial Campaign — any subset of CampaignCreate fields. Omitted fields are unchanged.
+ * @export
+ * @interface CampaignUpdate
+ */
+export interface CampaignUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CampaignUpdate
+     */
+    budget?: number;
+    /**
+     * ISO 4217 (USD, EUR, …).
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    currency?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    status?: CampaignUpdateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    type?: CampaignUpdateTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    networks?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    languages?: string;
+    /**
+     * String ID link to a Site.
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    siteId?: string;
+    /**
+     * Free-form goal text consumed by AI.
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    goal?: string;
+    /**
+     * 
+     * @type {Array<Location>}
+     * @memberof CampaignUpdate
+     */
+    targetLocations?: Array<Location>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CampaignUpdate
+     */
+    customLabels?: Array<string>;
+    /**
+     * 
+     * @type {CampaignAdScheduleField}
+     * @memberof CampaignUpdate
+     */
+    adSchedule?: CampaignAdScheduleField;
+    /**
+     * 
+     * @type {BiddingStrategy}
+     * @memberof CampaignUpdate
+     */
+    biddingStrategy?: BiddingStrategy;
+    /**
+     * 
+     * @type {CampaignTargeting}
+     * @memberof CampaignUpdate
+     */
+    targeting?: CampaignTargeting;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CampaignUpdate
+     */
+    finalUrlSuffix?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof CampaignUpdate
+     */
+    urlCustomParameters?: { [key: string]: string; };
+    /**
+     * 
+     * @type {Array<NegativeKeywordEntry>}
+     * @memberof CampaignUpdate
+     */
+    negativeKeywords?: Array<NegativeKeywordEntry>;
+}
+
+
+/**
+ * @export
+ */
+export const CampaignUpdateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type CampaignUpdateStatusEnum = typeof CampaignUpdateStatusEnum[keyof typeof CampaignUpdateStatusEnum];
+
+/**
+ * @export
+ */
+export const CampaignUpdateTypeEnum = {
+    SEARCH: 'SEARCH',
+    DISPLAY: 'DISPLAY',
+    VIDEO: 'VIDEO',
+    SHOPPING: 'SHOPPING',
+    PERFORMANCE_MAX: 'PERFORMANCE_MAX'
+} as const;
+export type CampaignUpdateTypeEnum = typeof CampaignUpdateTypeEnum[keyof typeof CampaignUpdateTypeEnum];
+
+
+/**
+ * Check if a given object implements the CampaignUpdate interface.
+ */
+export function instanceOfCampaignUpdate(value: object): value is CampaignUpdate {
+    return true;
+}
+
+export function CampaignUpdateFromJSON(json: any): CampaignUpdate {
+    return CampaignUpdateFromJSONTyped(json, false);
+}
+
+export function CampaignUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'budget': json['budget'] == null ? undefined : 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 CampaignUpdateToJSON(json: any): CampaignUpdate {
+    return CampaignUpdateToJSONTyped(json, false);
+}
+
+export function CampaignUpdateToJSONTyped(value?: CampaignUpdate | 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/CampaignsListCursorParameter.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 CampaignsListCursorParameter
+ */
+export interface CampaignsListCursorParameter {
+}
+
+/**
+ * Check if a given object implements the CampaignsListCursorParameter interface.
+ */
+export function instanceOfCampaignsListCursorParameter(value: object): value is CampaignsListCursorParameter {
+    return true;
+}
+
+export function CampaignsListCursorParameterFromJSON(json: any): CampaignsListCursorParameter {
+    return CampaignsListCursorParameterFromJSONTyped(json, false);
+}
+
+export function CampaignsListCursorParameterFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignsListCursorParameter {
+    return json;
+}
+
+export function CampaignsListCursorParameterToJSON(json: any): CampaignsListCursorParameter {
+    return CampaignsListCursorParameterToJSONTyped(json, false);
+}
+
+export function CampaignsListCursorParameterToJSONTyped(value?: CampaignsListCursorParameter | null, ignoreDiscriminator: boolean = false): any {
+    return value;
+}
+

package/src/generated/models/ErrorEnvelope.ts

@@ -0,0 +1,74 @@
+/* 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 { ErrorEnvelopeError } from './ErrorEnvelopeError';
+import {
+    ErrorEnvelopeErrorFromJSON,
+    ErrorEnvelopeErrorFromJSONTyped,
+    ErrorEnvelopeErrorToJSON,
+    ErrorEnvelopeErrorToJSONTyped,
+} from './ErrorEnvelopeError';
+
+/**
+ * 
+ * @export
+ * @interface ErrorEnvelope
+ */
+export interface ErrorEnvelope {
+    /**
+     * 
+     * @type {ErrorEnvelopeError}
+     * @memberof ErrorEnvelope
+     */
+    error: ErrorEnvelopeError;
+}
+
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope {
+    if (!('error' in value) || value['error'] === undefined) return false;
+    return true;
+}
+
+export function ErrorEnvelopeFromJSON(json: any): ErrorEnvelope {
+    return ErrorEnvelopeFromJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': ErrorEnvelopeErrorFromJSON(json['error']),
+    };
+}
+
+export function ErrorEnvelopeToJSON(json: any): ErrorEnvelope {
+    return ErrorEnvelopeToJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': ErrorEnvelopeErrorToJSON(value['error']),
+    };
+}
+

package/src/generated/models/ErrorEnvelopeError.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 ErrorEnvelopeError
+ */
+export interface ErrorEnvelopeError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ErrorEnvelopeError
+     */
+    code: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ErrorEnvelopeError
+     */
+    message: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof ErrorEnvelopeError
+     */
+    details?: any | null;
+}
+
+/**
+ * Check if a given object implements the ErrorEnvelopeError interface.
+ */
+export function instanceOfErrorEnvelopeError(value: object): value is ErrorEnvelopeError {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function ErrorEnvelopeErrorFromJSON(json: any): ErrorEnvelopeError {
+    return ErrorEnvelopeErrorFromJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelopeError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'],
+        'details': json['details'] == null ? undefined : json['details'],
+    };
+}
+
+export function ErrorEnvelopeErrorToJSON(json: any): ErrorEnvelopeError {
+    return ErrorEnvelopeErrorToJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeErrorToJSONTyped(value?: ErrorEnvelopeError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'details': value['details'],
+    };
+}
+

package/src/generated/models/KeywordCreate.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';
+/**
+ * 
+ * @export
+ * @interface KeywordCreate
+ */
+export interface KeywordCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof KeywordCreate
+     */
+    adGroupId: string;
+    /**
+     * Optional denormalisation.
+     * @type {string}
+     * @memberof KeywordCreate
+     */
+    campaignId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KeywordCreate
+     */
+    text: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KeywordCreate
+     */
+    matchType?: KeywordCreateMatchTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof KeywordCreate
+     */
+    status?: KeywordCreateStatusEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof KeywordCreate
+     */
+    isNegative?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof KeywordCreate
+     */
+    cpcBid?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const KeywordCreateMatchTypeEnum = {
+    BROAD: 'BROAD',
+    PHRASE: 'PHRASE',
+    EXACT: 'EXACT'
+} as const;
+export type KeywordCreateMatchTypeEnum = typeof KeywordCreateMatchTypeEnum[keyof typeof KeywordCreateMatchTypeEnum];
+
+/**
+ * @export
+ */
+export const KeywordCreateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type KeywordCreateStatusEnum = typeof KeywordCreateStatusEnum[keyof typeof KeywordCreateStatusEnum];
+
+
+/**
+ * Check if a given object implements the KeywordCreate interface.
+ */
+export function instanceOfKeywordCreate(value: object): value is KeywordCreate {
+    if (!('adGroupId' in value) || value['adGroupId'] === undefined) return false;
+    if (!('text' in value) || value['text'] === undefined) return false;
+    return true;
+}
+
+export function KeywordCreateFromJSON(json: any): KeywordCreate {
+    return KeywordCreateFromJSONTyped(json, false);
+}
+
+export function KeywordCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adGroupId': json['adGroupId'],
+        'campaignId': json['campaignId'] == null ? undefined : json['campaignId'],
+        'text': json['text'],
+        'matchType': json['matchType'] == null ? undefined : json['matchType'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'isNegative': json['isNegative'] == null ? undefined : json['isNegative'],
+        'cpcBid': json['cpcBid'] == null ? undefined : json['cpcBid'],
+    };
+}
+
+export function KeywordCreateToJSON(json: any): KeywordCreate {
+    return KeywordCreateToJSONTyped(json, false);
+}
+
+export function KeywordCreateToJSONTyped(value?: KeywordCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'adGroupId': value['adGroupId'],
+        'campaignId': value['campaignId'],
+        'text': value['text'],
+        'matchType': value['matchType'],
+        'status': value['status'],
+        'isNegative': value['isNegative'],
+        'cpcBid': value['cpcBid'],
+    };
+}
+