@defoai/ads-client 1.4.0

package/src/generated/models/SiteLinkEntry.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';
+/**
+ * 
+ * @export
+ * @interface SiteLinkEntry
+ */
+export interface SiteLinkEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteLinkEntry
+     */
+    text?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteLinkEntry
+     */
+    url?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteLinkEntry
+     */
+    description1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteLinkEntry
+     */
+    description2?: string;
+}
+
+/**
+ * Check if a given object implements the SiteLinkEntry interface.
+ */
+export function instanceOfSiteLinkEntry(value: object): value is SiteLinkEntry {
+    return true;
+}
+
+export function SiteLinkEntryFromJSON(json: any): SiteLinkEntry {
+    return SiteLinkEntryFromJSONTyped(json, false);
+}
+
+export function SiteLinkEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SiteLinkEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'text': json['text'] == null ? undefined : json['text'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'description1': json['description1'] == null ? undefined : json['description1'],
+        'description2': json['description2'] == null ? undefined : json['description2'],
+    };
+}
+
+export function SiteLinkEntryToJSON(json: any): SiteLinkEntry {
+    return SiteLinkEntryToJSONTyped(json, false);
+}
+
+export function SiteLinkEntryToJSONTyped(value?: SiteLinkEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'text': value['text'],
+        'url': value['url'],
+        'description1': value['description1'],
+        'description2': value['description2'],
+    };
+}
+

package/src/generated/models/SiteUpdate.ts

@@ -0,0 +1,171 @@
+/* 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';
+
+/**
+ * Partial Site. Omitted fields are unchanged.
+ * @export
+ * @interface SiteUpdate
+ */
+export interface SiteUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteUpdate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteUpdate
+     */
+    url?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteUpdate
+     */
+    description?: string;
+    /**
+     * 
+     * @type {SiteCreateSeoKeywords}
+     * @memberof SiteUpdate
+     */
+    seoKeywords?: SiteCreateSeoKeywords;
+    /**
+     * 
+     * @type {SiteCreateTargetGroups}
+     * @memberof SiteUpdate
+     */
+    targetGroups?: SiteCreateTargetGroups;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteUpdate
+     */
+    status?: SiteUpdateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteUpdate
+     */
+    logoUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SiteUpdate
+     */
+    logoSource?: SiteUpdateLogoSourceEnum | null;
+    /**
+     * 
+     * @type {Array<SiteLinkEntry>}
+     * @memberof SiteUpdate
+     */
+    siteLinks?: Array<SiteLinkEntry>;
+}
+
+
+/**
+ * @export
+ */
+export const SiteUpdateStatusEnum = {
+    ENABLED: 'ENABLED',
+    REMOVED: 'REMOVED'
+} as const;
+export type SiteUpdateStatusEnum = typeof SiteUpdateStatusEnum[keyof typeof SiteUpdateStatusEnum];
+
+/**
+ * @export
+ */
+export const SiteUpdateLogoSourceEnum = {
+    auto_detected: 'auto-detected',
+    uploaded: 'uploaded'
+} as const;
+export type SiteUpdateLogoSourceEnum = typeof SiteUpdateLogoSourceEnum[keyof typeof SiteUpdateLogoSourceEnum];
+
+
+/**
+ * Check if a given object implements the SiteUpdate interface.
+ */
+export function instanceOfSiteUpdate(value: object): value is SiteUpdate {
+    return true;
+}
+
+export function SiteUpdateFromJSON(json: any): SiteUpdate {
+    return SiteUpdateFromJSONTyped(json, false);
+}
+
+export function SiteUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SiteUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'url': json['url'] == null ? undefined : 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 SiteUpdateToJSON(json: any): SiteUpdate {
+    return SiteUpdateToJSONTyped(json, false);
+}
+
+export function SiteUpdateToJSONTyped(value?: SiteUpdate | 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/Sitelink.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 Sitelink
+ */
+export interface Sitelink {
+    /**
+     * 
+     * @type {string}
+     * @memberof Sitelink
+     */
+    text?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Sitelink
+     */
+    url?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Sitelink
+     */
+    description1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Sitelink
+     */
+    description2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Sitelink
+     */
+    trackingUrlTemplate?: string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof Sitelink
+     */
+    urlCustomParameters?: { [key: string]: string; };
+}
+
+/**
+ * Check if a given object implements the Sitelink interface.
+ */
+export function instanceOfSitelink(value: object): value is Sitelink {
+    return true;
+}
+
+export function SitelinkFromJSON(json: any): Sitelink {
+    return SitelinkFromJSONTyped(json, false);
+}
+
+export function SitelinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sitelink {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'text': json['text'] == null ? undefined : json['text'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'description1': json['description1'] == null ? undefined : json['description1'],
+        'description2': json['description2'] == null ? undefined : json['description2'],
+        'trackingUrlTemplate': json['trackingUrlTemplate'] == null ? undefined : json['trackingUrlTemplate'],
+        'urlCustomParameters': json['urlCustomParameters'] == null ? undefined : json['urlCustomParameters'],
+    };
+}
+
+export function SitelinkToJSON(json: any): Sitelink {
+    return SitelinkToJSONTyped(json, false);
+}
+
+export function SitelinkToJSONTyped(value?: Sitelink | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'text': value['text'],
+        'url': value['url'],
+        'description1': value['description1'],
+        'description2': value['description2'],
+        'trackingUrlTemplate': value['trackingUrlTemplate'],
+        'urlCustomParameters': value['urlCustomParameters'],
+    };
+}
+

package/src/generated/models/StructuredSchedule.ts

@@ -0,0 +1,82 @@
+/* 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 { ScheduleWindow } from './ScheduleWindow';
+import {
+    ScheduleWindowFromJSON,
+    ScheduleWindowFromJSONTyped,
+    ScheduleWindowToJSON,
+    ScheduleWindowToJSONTyped,
+} from './ScheduleWindow';
+
+/**
+ * 
+ * @export
+ * @interface StructuredSchedule
+ */
+export interface StructuredSchedule {
+    /**
+     * 
+     * @type {Array<ScheduleWindow>}
+     * @memberof StructuredSchedule
+     */
+    windows: Array<ScheduleWindow>;
+    /**
+     * IANA timezone (e.g. "Europe/Berlin"). Defaults to the account timezone if omitted.
+     * @type {string}
+     * @memberof StructuredSchedule
+     */
+    timezone?: string;
+}
+
+/**
+ * Check if a given object implements the StructuredSchedule interface.
+ */
+export function instanceOfStructuredSchedule(value: object): value is StructuredSchedule {
+    if (!('windows' in value) || value['windows'] === undefined) return false;
+    return true;
+}
+
+export function StructuredScheduleFromJSON(json: any): StructuredSchedule {
+    return StructuredScheduleFromJSONTyped(json, false);
+}
+
+export function StructuredScheduleFromJSONTyped(json: any, ignoreDiscriminator: boolean): StructuredSchedule {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'windows': ((json['windows'] as Array<any>).map(ScheduleWindowFromJSON)),
+        'timezone': json['timezone'] == null ? undefined : json['timezone'],
+    };
+}
+
+export function StructuredScheduleToJSON(json: any): StructuredSchedule {
+    return StructuredScheduleToJSONTyped(json, false);
+}
+
+export function StructuredScheduleToJSONTyped(value?: StructuredSchedule | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'windows': ((value['windows'] as Array<any>).map(ScheduleWindowToJSON)),
+        'timezone': value['timezone'],
+    };
+}
+

package/src/generated/models/StructuredSnippet.ts

@@ -0,0 +1,75 @@
+/* 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 StructuredSnippet
+ */
+export interface StructuredSnippet {
+    /**
+     * 
+     * @type {string}
+     * @memberof StructuredSnippet
+     */
+    header: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof StructuredSnippet
+     */
+    values: Array<string>;
+}
+
+/**
+ * Check if a given object implements the StructuredSnippet interface.
+ */
+export function instanceOfStructuredSnippet(value: object): value is StructuredSnippet {
+    if (!('header' in value) || value['header'] === undefined) return false;
+    if (!('values' in value) || value['values'] === undefined) return false;
+    return true;
+}
+
+export function StructuredSnippetFromJSON(json: any): StructuredSnippet {
+    return StructuredSnippetFromJSONTyped(json, false);
+}
+
+export function StructuredSnippetFromJSONTyped(json: any, ignoreDiscriminator: boolean): StructuredSnippet {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'header': json['header'],
+        'values': json['values'],
+    };
+}
+
+export function StructuredSnippetToJSON(json: any): StructuredSnippet {
+    return StructuredSnippetToJSONTyped(json, false);
+}
+
+export function StructuredSnippetToJSONTyped(value?: StructuredSnippet | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'header': value['header'],
+        'values': value['values'],
+    };
+}
+

package/src/generated/models/SuccessEnvelope.ts

@@ -0,0 +1,82 @@
+/* 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 { SuccessEnvelopeMeta } from './SuccessEnvelopeMeta';
+import {
+    SuccessEnvelopeMetaFromJSON,
+    SuccessEnvelopeMetaFromJSONTyped,
+    SuccessEnvelopeMetaToJSON,
+    SuccessEnvelopeMetaToJSONTyped,
+} from './SuccessEnvelopeMeta';
+
+/**
+ * 
+ * @export
+ * @interface SuccessEnvelope
+ */
+export interface SuccessEnvelope {
+    /**
+     * 
+     * @type {any}
+     * @memberof SuccessEnvelope
+     */
+    data: any | null;
+    /**
+     * 
+     * @type {SuccessEnvelopeMeta}
+     * @memberof SuccessEnvelope
+     */
+    meta?: SuccessEnvelopeMeta;
+}
+
+/**
+ * Check if a given object implements the SuccessEnvelope interface.
+ */
+export function instanceOfSuccessEnvelope(value: object): value is SuccessEnvelope {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function SuccessEnvelopeFromJSON(json: any): SuccessEnvelope {
+    return SuccessEnvelopeFromJSONTyped(json, false);
+}
+
+export function SuccessEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SuccessEnvelope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'],
+        'meta': json['meta'] == null ? undefined : SuccessEnvelopeMetaFromJSON(json['meta']),
+    };
+}
+
+export function SuccessEnvelopeToJSON(json: any): SuccessEnvelope {
+    return SuccessEnvelopeToJSONTyped(json, false);
+}
+
+export function SuccessEnvelopeToJSONTyped(value?: SuccessEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'],
+        'meta': SuccessEnvelopeMetaToJSON(value['meta']),
+    };
+}
+

package/src/generated/models/SuccessEnvelopeMeta.ts

@@ -0,0 +1,81 @@
+/* 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 { SuccessEnvelopeMetaNextCursor } from './SuccessEnvelopeMetaNextCursor';
+import {
+    SuccessEnvelopeMetaNextCursorFromJSON,
+    SuccessEnvelopeMetaNextCursorFromJSONTyped,
+    SuccessEnvelopeMetaNextCursorToJSON,
+    SuccessEnvelopeMetaNextCursorToJSONTyped,
+} from './SuccessEnvelopeMetaNextCursor';
+
+/**
+ * 
+ * @export
+ * @interface SuccessEnvelopeMeta
+ */
+export interface SuccessEnvelopeMeta {
+    /**
+     * 
+     * @type {SuccessEnvelopeMetaNextCursor}
+     * @memberof SuccessEnvelopeMeta
+     */
+    nextCursor?: SuccessEnvelopeMetaNextCursor | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof SuccessEnvelopeMeta
+     */
+    total?: number;
+}
+
+/**
+ * Check if a given object implements the SuccessEnvelopeMeta interface.
+ */
+export function instanceOfSuccessEnvelopeMeta(value: object): value is SuccessEnvelopeMeta {
+    return true;
+}
+
+export function SuccessEnvelopeMetaFromJSON(json: any): SuccessEnvelopeMeta {
+    return SuccessEnvelopeMetaFromJSONTyped(json, false);
+}
+
+export function SuccessEnvelopeMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): SuccessEnvelopeMeta {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nextCursor': json['nextCursor'] == null ? undefined : SuccessEnvelopeMetaNextCursorFromJSON(json['nextCursor']),
+        'total': json['total'] == null ? undefined : json['total'],
+    };
+}
+
+export function SuccessEnvelopeMetaToJSON(json: any): SuccessEnvelopeMeta {
+    return SuccessEnvelopeMetaToJSONTyped(json, false);
+}
+
+export function SuccessEnvelopeMetaToJSONTyped(value?: SuccessEnvelopeMeta | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'nextCursor': SuccessEnvelopeMetaNextCursorToJSON(value['nextCursor']),
+        'total': value['total'],
+    };
+}
+