@defoai/ads-client 1.4.0

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

@@ -0,0 +1,33 @@
+/**
+ * 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 type { ErrorEnvelopeError } from './ErrorEnvelopeError';
+/**
+ *
+ * @export
+ * @interface ErrorEnvelope
+ */
+export interface ErrorEnvelope {
+    /**
+     *
+     * @type {ErrorEnvelopeError}
+     * @memberof ErrorEnvelope
+     */
+    error: ErrorEnvelopeError;
+}
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export declare function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope;
+export declare function ErrorEnvelopeFromJSON(json: any): ErrorEnvelope;
+export declare function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope;
+export declare function ErrorEnvelopeToJSON(json: any): ErrorEnvelope;
+export declare function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/ErrorEnvelope.js

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

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

@@ -0,0 +1,44 @@
+/**
+ * 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 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 declare function instanceOfErrorEnvelopeError(value: object): value is ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorFromJSON(json: any): ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorToJSON(json: any): ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorToJSONTyped(value?: ErrorEnvelopeError | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/ErrorEnvelopeError.js

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

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

@@ -0,0 +1,86 @@
+/**
+ * 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 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 declare const KeywordCreateMatchTypeEnum: {
+    readonly BROAD: "BROAD";
+    readonly PHRASE: "PHRASE";
+    readonly EXACT: "EXACT";
+};
+export type KeywordCreateMatchTypeEnum = typeof KeywordCreateMatchTypeEnum[keyof typeof KeywordCreateMatchTypeEnum];
+/**
+ * @export
+ */
+export declare const KeywordCreateStatusEnum: {
+    readonly ENABLED: "ENABLED";
+    readonly PAUSED: "PAUSED";
+    readonly REMOVED: "REMOVED";
+};
+export type KeywordCreateStatusEnum = typeof KeywordCreateStatusEnum[keyof typeof KeywordCreateStatusEnum];
+/**
+ * Check if a given object implements the KeywordCreate interface.
+ */
+export declare function instanceOfKeywordCreate(value: object): value is KeywordCreate;
+export declare function KeywordCreateFromJSON(json: any): KeywordCreate;
+export declare function KeywordCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordCreate;
+export declare function KeywordCreateToJSON(json: any): KeywordCreate;
+export declare function KeywordCreateToJSONTyped(value?: KeywordCreate | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/KeywordCreate.js

@@ -0,0 +1,73 @@
+/* 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 KeywordCreateMatchTypeEnum = {
+    BROAD: 'BROAD',
+    PHRASE: 'PHRASE',
+    EXACT: 'EXACT'
+};
+/**
+ * @export
+ */
+export const KeywordCreateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+};
+/**
+ * Check if a given object implements the KeywordCreate interface.
+ */
+export function instanceOfKeywordCreate(value) {
+    if (!('adGroupId' in value) || value['adGroupId'] === undefined)
+        return false;
+    if (!('text' in value) || value['text'] === undefined)
+        return false;
+    return true;
+}
+export function KeywordCreateFromJSON(json) {
+    return KeywordCreateFromJSONTyped(json, false);
+}
+export function KeywordCreateFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return KeywordCreateToJSONTyped(json, false);
+}
+export function KeywordCreateToJSONTyped(value, ignoreDiscriminator = false) {
+    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'],
+    };
+}

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

@@ -0,0 +1,86 @@
+/**
+ * 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 Keyword. Omitted fields are unchanged.
+ * @export
+ * @interface KeywordUpdate
+ */
+export interface KeywordUpdate {
+    /**
+     *
+     * @type {string}
+     * @memberof KeywordUpdate
+     */
+    adGroupId?: string;
+    /**
+     * Optional denormalisation.
+     * @type {string}
+     * @memberof KeywordUpdate
+     */
+    campaignId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KeywordUpdate
+     */
+    text?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KeywordUpdate
+     */
+    matchType?: KeywordUpdateMatchTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof KeywordUpdate
+     */
+    status?: KeywordUpdateStatusEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof KeywordUpdate
+     */
+    isNegative?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof KeywordUpdate
+     */
+    cpcBid?: number | null;
+}
+/**
+ * @export
+ */
+export declare const KeywordUpdateMatchTypeEnum: {
+    readonly BROAD: "BROAD";
+    readonly PHRASE: "PHRASE";
+    readonly EXACT: "EXACT";
+};
+export type KeywordUpdateMatchTypeEnum = typeof KeywordUpdateMatchTypeEnum[keyof typeof KeywordUpdateMatchTypeEnum];
+/**
+ * @export
+ */
+export declare const KeywordUpdateStatusEnum: {
+    readonly ENABLED: "ENABLED";
+    readonly PAUSED: "PAUSED";
+    readonly REMOVED: "REMOVED";
+};
+export type KeywordUpdateStatusEnum = typeof KeywordUpdateStatusEnum[keyof typeof KeywordUpdateStatusEnum];
+/**
+ * Check if a given object implements the KeywordUpdate interface.
+ */
+export declare function instanceOfKeywordUpdate(value: object): value is KeywordUpdate;
+export declare function KeywordUpdateFromJSON(json: any): KeywordUpdate;
+export declare function KeywordUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordUpdate;
+export declare function KeywordUpdateToJSON(json: any): KeywordUpdate;
+export declare function KeywordUpdateToJSONTyped(value?: KeywordUpdate | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/KeywordUpdate.js

@@ -0,0 +1,69 @@
+/* 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 KeywordUpdateMatchTypeEnum = {
+    BROAD: 'BROAD',
+    PHRASE: 'PHRASE',
+    EXACT: 'EXACT'
+};
+/**
+ * @export
+ */
+export const KeywordUpdateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+};
+/**
+ * Check if a given object implements the KeywordUpdate interface.
+ */
+export function instanceOfKeywordUpdate(value) {
+    return true;
+}
+export function KeywordUpdateFromJSON(json) {
+    return KeywordUpdateFromJSONTyped(json, false);
+}
+export function KeywordUpdateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'adGroupId': json['adGroupId'] == null ? undefined : json['adGroupId'],
+        'campaignId': json['campaignId'] == null ? undefined : json['campaignId'],
+        'text': json['text'] == null ? undefined : 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 KeywordUpdateToJSON(json) {
+    return KeywordUpdateToJSONTyped(json, false);
+}
+export function KeywordUpdateToJSONTyped(value, ignoreDiscriminator = false) {
+    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'],
+    };
+}

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

@@ -0,0 +1,61 @@
+/**
+ * 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 Location
+ */
+export interface Location {
+    /**
+     * Google Ads geo target constant ID.
+     * @type {string}
+     * @memberof Location
+     */
+    criterionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Location
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Location
+     */
+    type: LocationTypeEnum;
+    /**
+     * ISO country code; null for GLOBAL.
+     * @type {string}
+     * @memberof Location
+     */
+    countryCode?: string | null;
+}
+/**
+ * @export
+ */
+export declare const LocationTypeEnum: {
+    readonly COUNTRY: "COUNTRY";
+    readonly CITY: "CITY";
+    readonly REGION: "REGION";
+    readonly METRO: "METRO";
+    readonly GLOBAL: "GLOBAL";
+};
+export type LocationTypeEnum = typeof LocationTypeEnum[keyof typeof LocationTypeEnum];
+/**
+ * Check if a given object implements the Location interface.
+ */
+export declare function instanceOfLocation(value: object): value is Location;
+export declare function LocationFromJSON(json: any): Location;
+export declare function LocationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Location;
+export declare function LocationToJSON(json: any): Location;
+export declare function LocationToJSONTyped(value?: Location | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/Location.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 LocationTypeEnum = {
+    COUNTRY: 'COUNTRY',
+    CITY: 'CITY',
+    REGION: 'REGION',
+    METRO: 'METRO',
+    GLOBAL: 'GLOBAL'
+};
+/**
+ * Check if a given object implements the Location interface.
+ */
+export function instanceOfLocation(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+export function LocationFromJSON(json) {
+    return LocationFromJSONTyped(json, false);
+}
+export function LocationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'criterionId': json['criterionId'] == null ? undefined : json['criterionId'],
+        'name': json['name'],
+        'type': json['type'],
+        'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
+    };
+}
+export function LocationToJSON(json) {
+    return LocationToJSONTyped(json, false);
+}
+export function LocationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'criterionId': value['criterionId'],
+        'name': value['name'],
+        'type': value['type'],
+        'countryCode': value['countryCode'],
+    };
+}

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

@@ -0,0 +1,47 @@
+/**
+ * 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 NegativeKeywordEntry
+ */
+export interface NegativeKeywordEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof NegativeKeywordEntry
+     */
+    text: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NegativeKeywordEntry
+     */
+    matchType: NegativeKeywordEntryMatchTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const NegativeKeywordEntryMatchTypeEnum: {
+    readonly EXACT: "EXACT";
+    readonly PHRASE: "PHRASE";
+    readonly BROAD: "BROAD";
+};
+export type NegativeKeywordEntryMatchTypeEnum = typeof NegativeKeywordEntryMatchTypeEnum[keyof typeof NegativeKeywordEntryMatchTypeEnum];
+/**
+ * Check if a given object implements the NegativeKeywordEntry interface.
+ */
+export declare function instanceOfNegativeKeywordEntry(value: object): value is NegativeKeywordEntry;
+export declare function NegativeKeywordEntryFromJSON(json: any): NegativeKeywordEntry;
+export declare function NegativeKeywordEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): NegativeKeywordEntry;
+export declare function NegativeKeywordEntryToJSON(json: any): NegativeKeywordEntry;
+export declare function NegativeKeywordEntryToJSONTyped(value?: NegativeKeywordEntry | null, ignoreDiscriminator?: boolean): any;