@defoai/ads-client 1.4.0

package/src/generated/models/KeywordUpdate.ts

@@ -0,0 +1,135 @@
+/* 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';
+/**
+ * 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 const KeywordUpdateMatchTypeEnum = {
+    BROAD: 'BROAD',
+    PHRASE: 'PHRASE',
+    EXACT: 'EXACT'
+} as const;
+export type KeywordUpdateMatchTypeEnum = typeof KeywordUpdateMatchTypeEnum[keyof typeof KeywordUpdateMatchTypeEnum];
+
+/**
+ * @export
+ */
+export const KeywordUpdateStatusEnum = {
+    ENABLED: 'ENABLED',
+    PAUSED: 'PAUSED',
+    REMOVED: 'REMOVED'
+} as const;
+export type KeywordUpdateStatusEnum = typeof KeywordUpdateStatusEnum[keyof typeof KeywordUpdateStatusEnum];
+
+
+/**
+ * Check if a given object implements the KeywordUpdate interface.
+ */
+export function instanceOfKeywordUpdate(value: object): value is KeywordUpdate {
+    return true;
+}
+
+export function KeywordUpdateFromJSON(json: any): KeywordUpdate {
+    return KeywordUpdateFromJSONTyped(json, false);
+}
+
+export function KeywordUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordUpdate {
+    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: any): KeywordUpdate {
+    return KeywordUpdateToJSONTyped(json, false);
+}
+
+export function KeywordUpdateToJSONTyped(value?: KeywordUpdate | 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'],
+    };
+}
+

package/src/generated/models/Location.ts

@@ -0,0 +1,105 @@
+/* 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 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 const LocationTypeEnum = {
+    COUNTRY: 'COUNTRY',
+    CITY: 'CITY',
+    REGION: 'REGION',
+    METRO: 'METRO',
+    GLOBAL: 'GLOBAL'
+} as const;
+export type LocationTypeEnum = typeof LocationTypeEnum[keyof typeof LocationTypeEnum];
+
+
+/**
+ * Check if a given object implements the Location interface.
+ */
+export function instanceOfLocation(value: object): value is Location {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function LocationFromJSON(json: any): Location {
+    return LocationFromJSONTyped(json, false);
+}
+
+export function LocationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Location {
+    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: any): Location {
+    return LocationToJSONTyped(json, false);
+}
+
+export function LocationToJSONTyped(value?: Location | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'criterionId': value['criterionId'],
+        'name': value['name'],
+        'type': value['type'],
+        'countryCode': value['countryCode'],
+    };
+}
+

package/src/generated/models/NegativeKeywordEntry.ts

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

package/src/generated/models/ScheduleWindow.ts

@@ -0,0 +1,146 @@
+/* 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 ScheduleWindow
+ */
+export interface ScheduleWindow {
+    /**
+     * 
+     * @type {string}
+     * @memberof ScheduleWindow
+     */
+    day: ScheduleWindowDayEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScheduleWindow
+     */
+    startHour: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScheduleWindow
+     */
+    startMinute?: ScheduleWindowStartMinuteEnum;
+    /**
+     * 24 is the Google end-of-day sentinel and is passed through unchanged.
+     * @type {number}
+     * @memberof ScheduleWindow
+     */
+    endHour: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScheduleWindow
+     */
+    endMinute?: ScheduleWindowEndMinuteEnum;
+    /**
+     * Platform-neutral bid multiplier. 1.0 = no change. On Microsoft Ads, converted to the native -90..+900 percentage delta with clamping (a clamp emits a BID_ADJUSTMENT_CLAMPED warning).
+     * @type {number}
+     * @memberof ScheduleWindow
+     */
+    bidModifier?: number;
+}
+
+
+/**
+ * @export
+ */
+export const ScheduleWindowDayEnum = {
+    MONDAY: 'MONDAY',
+    TUESDAY: 'TUESDAY',
+    WEDNESDAY: 'WEDNESDAY',
+    THURSDAY: 'THURSDAY',
+    FRIDAY: 'FRIDAY',
+    SATURDAY: 'SATURDAY',
+    SUNDAY: 'SUNDAY'
+} as const;
+export type ScheduleWindowDayEnum = typeof ScheduleWindowDayEnum[keyof typeof ScheduleWindowDayEnum];
+
+/**
+ * @export
+ */
+export const ScheduleWindowStartMinuteEnum = {
+    ZERO: 'ZERO',
+    FIFTEEN: 'FIFTEEN',
+    THIRTY: 'THIRTY',
+    FORTY_FIVE: 'FORTY_FIVE'
+} as const;
+export type ScheduleWindowStartMinuteEnum = typeof ScheduleWindowStartMinuteEnum[keyof typeof ScheduleWindowStartMinuteEnum];
+
+/**
+ * @export
+ */
+export const ScheduleWindowEndMinuteEnum = {
+    ZERO: 'ZERO',
+    FIFTEEN: 'FIFTEEN',
+    THIRTY: 'THIRTY',
+    FORTY_FIVE: 'FORTY_FIVE'
+} as const;
+export type ScheduleWindowEndMinuteEnum = typeof ScheduleWindowEndMinuteEnum[keyof typeof ScheduleWindowEndMinuteEnum];
+
+
+/**
+ * Check if a given object implements the ScheduleWindow interface.
+ */
+export function instanceOfScheduleWindow(value: object): value is ScheduleWindow {
+    if (!('day' in value) || value['day'] === undefined) return false;
+    if (!('startHour' in value) || value['startHour'] === undefined) return false;
+    if (!('endHour' in value) || value['endHour'] === undefined) return false;
+    return true;
+}
+
+export function ScheduleWindowFromJSON(json: any): ScheduleWindow {
+    return ScheduleWindowFromJSONTyped(json, false);
+}
+
+export function ScheduleWindowFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleWindow {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'day': json['day'],
+        'startHour': json['startHour'],
+        'startMinute': json['startMinute'] == null ? undefined : json['startMinute'],
+        'endHour': json['endHour'],
+        'endMinute': json['endMinute'] == null ? undefined : json['endMinute'],
+        'bidModifier': json['bidModifier'] == null ? undefined : json['bidModifier'],
+    };
+}
+
+export function ScheduleWindowToJSON(json: any): ScheduleWindow {
+    return ScheduleWindowToJSONTyped(json, false);
+}
+
+export function ScheduleWindowToJSONTyped(value?: ScheduleWindow | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'day': value['day'],
+        'startHour': value['startHour'],
+        'startMinute': value['startMinute'],
+        'endHour': value['endHour'],
+        'endMinute': value['endMinute'],
+        'bidModifier': value['bidModifier'],
+    };
+}
+

package/src/generated/models/SiteCreate.ts

@@ -0,0 +1,173 @@
+/* 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 { SiteLinkEntry } from './SiteLinkEntry';
+import {
+    SiteLinkEntryFromJSON,
+    SiteLinkEntryFromJSONTyped,
+    SiteLinkEntryToJSON,
+    SiteLinkEntryToJSONTyped,
+} from './SiteLinkEntry';
+import type { SiteCreateSeoKeywords } from './SiteCreateSeoKeywords';
+import {
+    SiteCreateSeoKeywordsFromJSON,
+    SiteCreateSeoKeywordsFromJSONTyped,
+    SiteCreateSeoKeywordsToJSON,
+    SiteCreateSeoKeywordsToJSONTyped,
+} from './SiteCreateSeoKeywords';
+import type { SiteCreateTargetGroups } from './SiteCreateTargetGroups';
+import {
+    SiteCreateTargetGroupsFromJSON,
+    SiteCreateTargetGroupsFromJSONTyped,
+    SiteCreateTargetGroupsToJSON,
+    SiteCreateTargetGroupsToJSONTyped,
+} from './SiteCreateTargetGroups';
+
+/**
+ * 
+ * @export
+ * @interface SiteCreate
+ */
+export interface SiteCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteCreate
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteCreate
+     */
+    url: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteCreate
+     */
+    description?: string;
+    /**
+     * 
+     * @type {SiteCreateSeoKeywords}
+     * @memberof SiteCreate
+     */
+    seoKeywords?: SiteCreateSeoKeywords;
+    /**
+     * 
+     * @type {SiteCreateTargetGroups}
+     * @memberof SiteCreate
+     */
+    targetGroups?: SiteCreateTargetGroups;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteCreate
+     */
+    status?: SiteCreateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteCreate
+     */
+    logoUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteCreate
+     */
+    logoSource?: SiteCreateLogoSourceEnum | null;
+    /**
+     * 
+     * @type {Array<SiteLinkEntry>}
+     * @memberof SiteCreate
+     */
+    siteLinks?: Array<SiteLinkEntry>;
+}
+
+
+/**
+ * @export
+ */
+export const SiteCreateStatusEnum = {
+    ENABLED: 'ENABLED',
+    REMOVED: 'REMOVED'
+} as const;
+export type SiteCreateStatusEnum = typeof SiteCreateStatusEnum[keyof typeof SiteCreateStatusEnum];
+
+/**
+ * @export
+ */
+export const SiteCreateLogoSourceEnum = {
+    auto_detected: 'auto-detected',
+    uploaded: 'uploaded'
+} as const;
+export type SiteCreateLogoSourceEnum = typeof SiteCreateLogoSourceEnum[keyof typeof SiteCreateLogoSourceEnum];
+
+
+/**
+ * Check if a given object implements the SiteCreate interface.
+ */
+export function instanceOfSiteCreate(value: object): value is SiteCreate {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    return true;
+}
+
+export function SiteCreateFromJSON(json: any): SiteCreate {
+    return SiteCreateFromJSONTyped(json, false);
+}
+
+export function SiteCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SiteCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'url': json['url'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'seoKeywords': json['seoKeywords'] == null ? undefined : SiteCreateSeoKeywordsFromJSON(json['seoKeywords']),
+        'targetGroups': json['targetGroups'] == null ? undefined : SiteCreateTargetGroupsFromJSON(json['targetGroups']),
+        'status': json['status'] == null ? undefined : json['status'],
+        'logoUrl': json['logoUrl'] == null ? undefined : json['logoUrl'],
+        'logoSource': json['logoSource'] == null ? undefined : json['logoSource'],
+        'siteLinks': json['siteLinks'] == null ? undefined : ((json['siteLinks'] as Array<any>).map(SiteLinkEntryFromJSON)),
+    };
+}
+
+export function SiteCreateToJSON(json: any): SiteCreate {
+    return SiteCreateToJSONTyped(json, false);
+}
+
+export function SiteCreateToJSONTyped(value?: SiteCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'url': value['url'],
+        'description': value['description'],
+        'seoKeywords': SiteCreateSeoKeywordsToJSON(value['seoKeywords']),
+        'targetGroups': SiteCreateTargetGroupsToJSON(value['targetGroups']),
+        'status': value['status'],
+        'logoUrl': value['logoUrl'],
+        'logoSource': value['logoSource'],
+        'siteLinks': value['siteLinks'] == null ? undefined : ((value['siteLinks'] as Array<any>).map(SiteLinkEntryToJSON)),
+    };
+}
+

package/src/generated/models/SiteCreateSeoKeywords.ts

@@ -0,0 +1,16 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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).
+ */
+
+
+export type SiteCreateSeoKeywords = Array<string> | string;
+
+export function SiteCreateSeoKeywordsFromJSON(json: any): SiteCreateSeoKeywords { return json; }
+export function SiteCreateSeoKeywordsFromJSONTyped(json: any, _ignoreDiscriminator: boolean): SiteCreateSeoKeywords { return json; }
+export function SiteCreateSeoKeywordsToJSON(value?: SiteCreateSeoKeywords | null): any { return value; }
+export function SiteCreateSeoKeywordsToJSONTyped(value?: SiteCreateSeoKeywords | null, _ignoreDiscriminator: boolean = false): any { return value; }

package/src/generated/models/SiteCreateTargetGroups.ts

@@ -0,0 +1,16 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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).
+ */
+
+
+export type SiteCreateTargetGroups = Array<string> | string;
+
+export function SiteCreateTargetGroupsFromJSON(json: any): SiteCreateTargetGroups { return json; }
+export function SiteCreateTargetGroupsFromJSONTyped(json: any, _ignoreDiscriminator: boolean): SiteCreateTargetGroups { return json; }
+export function SiteCreateTargetGroupsToJSON(value?: SiteCreateTargetGroups | null): any { return value; }
+export function SiteCreateTargetGroupsToJSONTyped(value?: SiteCreateTargetGroups | null, _ignoreDiscriminator: boolean = false): any { return value; }