@defoai/ads-client 1.4.0 → 1.4.1

package/dist/generated/apis/KeywordsApi.js

@@ -1,200 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import { KeywordCreateToJSON, KeywordUpdateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
-/**
- *
- */
-export class KeywordsApi extends runtime.BaseAPI {
-    /**
-     * Create keyword
-     */
-    async keywordsCreateRaw(requestParameters, initOverrides) {
-        if (requestParameters['keywordCreate'] == null) {
-            throw new runtime.RequiredError('keywordCreate', 'Required parameter "keywordCreate" was null or undefined when calling keywordsCreate().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        headerParameters['Content-Type'] = 'application/json';
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", ["keywords:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/keywords`,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: KeywordCreateToJSON(requestParameters['keywordCreate']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Create keyword
-     */
-    async keywordsCreate(requestParameters, initOverrides) {
-        const response = await this.keywordsCreateRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Delete keyword
-     */
-    async keywordsDeleteRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling keywordsDelete().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", ["keywords:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/keywords/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Delete keyword
-     */
-    async keywordsDelete(requestParameters, initOverrides) {
-        const response = await this.keywordsDeleteRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Get keyword
-     */
-    async keywordsGetRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling keywordsGet().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", ["keywords:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/keywords/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Get keyword
-     */
-    async keywordsGet(requestParameters, initOverrides) {
-        const response = await this.keywordsGetRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * List keywords
-     */
-    async keywordsListRaw(requestParameters, initOverrides) {
-        const queryParameters = {};
-        if (requestParameters['limit'] != null) {
-            queryParameters['limit'] = requestParameters['limit'];
-        }
-        if (requestParameters['cursor'] != null) {
-            queryParameters['cursor'] = requestParameters['cursor'];
-        }
-        const headerParameters = {};
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", ["keywords:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/keywords`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * List keywords
-     */
-    async keywordsList(requestParameters = {}, initOverrides) {
-        const response = await this.keywordsListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Update keyword
-     */
-    async keywordsUpdateRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling keywordsUpdate().');
-        }
-        if (requestParameters['keywordUpdate'] == null) {
-            throw new runtime.RequiredError('keywordUpdate', 'Required parameter "keywordUpdate" was null or undefined when calling keywordsUpdate().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        headerParameters['Content-Type'] = 'application/json';
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", ["keywords:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/keywords/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: KeywordUpdateToJSON(requestParameters['keywordUpdate']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Update keyword
-     */
-    async keywordsUpdate(requestParameters, initOverrides) {
-        const response = await this.keywordsUpdateRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-}

package/dist/generated/apis/MediaApi.d.ts

@@ -1,50 +0,0 @@
-/**
- * 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 * as runtime from '../runtime';
-import type { SuccessEnvelope } from '../models/index';
-export interface MediaMatrixRequest {
-    xSpaceId?: string;
-}
-/**
- * MediaApi - interface
- *
- * @export
- * @interface MediaApiInterface
- */
-export interface MediaApiInterface {
-    /**
-     *
-     * @summary Media requirements matrix (per platform/campaign type: required & optional roles, scope, ad format). Versioned so consumers can detect drift.
-     * @param {string} [xSpaceId] Target Space ID (e.g. `spc_…`). Omit to use the caller\'s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MediaApiInterface
-     */
-    mediaMatrixRaw(requestParameters: MediaMatrixRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Media requirements matrix (per platform/campaign type: required & optional roles, scope, ad format). Versioned so consumers can detect drift.
-     */
-    mediaMatrix(requestParameters: MediaMatrixRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}
-/**
- *
- */
-export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterface {
-    /**
-     * Media requirements matrix (per platform/campaign type: required & optional roles, scope, ad format). Versioned so consumers can detect drift.
-     */
-    mediaMatrixRaw(requestParameters: MediaMatrixRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Media requirements matrix (per platform/campaign type: required & optional roles, scope, ad format). Versioned so consumers can detect drift.
-     */
-    mediaMatrix(requestParameters?: MediaMatrixRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}

package/dist/generated/apis/MediaApi.js

@@ -1,51 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import { SuccessEnvelopeFromJSON, } from '../models/index';
-/**
- *
- */
-export class MediaApi extends runtime.BaseAPI {
-    /**
-     * Media requirements matrix (per platform/campaign type: required & optional roles, scope, ad format). Versioned so consumers can detect drift.
-     */
-    async mediaMatrixRaw(requestParameters, initOverrides) {
-        const queryParameters = {};
-        const headerParameters = {};
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/media/matrix`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Media requirements matrix (per platform/campaign type: required & optional roles, scope, ad format). Versioned so consumers can detect drift.
-     */
-    async mediaMatrix(requestParameters = {}, initOverrides) {
-        const response = await this.mediaMatrixRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-}

package/dist/generated/apis/MetaApi.d.ts

@@ -1,86 +0,0 @@
-/**
- * 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 * as runtime from '../runtime';
-import type { SuccessEnvelope } from '../models/index';
-/**
- * MetaApi - interface
- *
- * @export
- * @interface MetaApiInterface
- */
-export interface MetaApiInterface {
-    /**
-     *
-     * @summary Introspect the authenticated API token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetaApiInterface
-     */
-    meGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Introspect the authenticated API token
-     */
-    meGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     *
-     * @summary OpenAPI specification for this API
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetaApiInterface
-     */
-    openapiGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * OpenAPI specification for this API
-     */
-    openapiGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     *
-     * @summary List Spaces the token owner is a member of
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetaApiInterface
-     */
-    spacesListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * List Spaces the token owner is a member of
-     */
-    spacesList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}
-/**
- *
- */
-export declare class MetaApi extends runtime.BaseAPI implements MetaApiInterface {
-    /**
-     * Introspect the authenticated API token
-     */
-    meGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Introspect the authenticated API token
-     */
-    meGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     * OpenAPI specification for this API
-     */
-    openapiGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * OpenAPI specification for this API
-     */
-    openapiGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     * List Spaces the token owner is a member of
-     */
-    spacesListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * List Spaces the token owner is a member of
-     */
-    spacesList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}

package/dist/generated/apis/MetaApi.js

@@ -1,104 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import { SuccessEnvelopeFromJSON, } from '../models/index';
-/**
- *
- */
-export class MetaApi extends runtime.BaseAPI {
-    /**
-     * Introspect the authenticated API token
-     */
-    async meGetRaw(initOverrides) {
-        const queryParameters = {};
-        const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/me`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Introspect the authenticated API token
-     */
-    async meGet(initOverrides) {
-        const response = await this.meGetRaw(initOverrides);
-        return await response.value();
-    }
-    /**
-     * OpenAPI specification for this API
-     */
-    async openapiGetRaw(initOverrides) {
-        const queryParameters = {};
-        const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/openapi.json`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * OpenAPI specification for this API
-     */
-    async openapiGet(initOverrides) {
-        const response = await this.openapiGetRaw(initOverrides);
-        return await response.value();
-    }
-    /**
-     * List Spaces the token owner is a member of
-     */
-    async spacesListRaw(initOverrides) {
-        const queryParameters = {};
-        const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/spaces`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * List Spaces the token owner is a member of
-     */
-    async spacesList(initOverrides) {
-        const response = await this.spacesListRaw(initOverrides);
-        return await response.value();
-    }
-}

package/dist/generated/apis/ReportsApi.d.ts

@@ -1,50 +0,0 @@
-/**
- * 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 * as runtime from '../runtime';
-import type { SuccessEnvelope } from '../models/index';
-export interface ReportsStatsRequest {
-    xSpaceId?: string;
-}
-/**
- * ReportsApi - interface
- *
- * @export
- * @interface ReportsApiInterface
- */
-export interface ReportsApiInterface {
-    /**
-     *
-     * @summary Account-wide stats
-     * @param {string} [xSpaceId] Target Space ID (e.g. `spc_…`). Omit to use the caller\'s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ReportsApiInterface
-     */
-    reportsStatsRaw(requestParameters: ReportsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Account-wide stats
-     */
-    reportsStats(requestParameters: ReportsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}
-/**
- *
- */
-export declare class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
-    /**
-     * Account-wide stats
-     */
-    reportsStatsRaw(requestParameters: ReportsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Account-wide stats
-     */
-    reportsStats(requestParameters?: ReportsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}

package/dist/generated/apis/ReportsApi.js

@@ -1,51 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import { SuccessEnvelopeFromJSON, } from '../models/index';
-/**
- *
- */
-export class ReportsApi extends runtime.BaseAPI {
-    /**
-     * Account-wide stats
-     */
-    async reportsStatsRaw(requestParameters, initOverrides) {
-        const queryParameters = {};
-        const headerParameters = {};
-        if (requestParameters['xSpaceId'] != null) {
-            headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
-        }
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("ApiToken", ["reports:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/reports/stats`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Account-wide stats
-     */
-    async reportsStats(requestParameters = {}, initOverrides) {
-        const response = await this.reportsStatsRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-}