@defoai/ads-client 1.4.0 → 1.4.1

package/dist/generated/apis/AdGroupsApi.js

@@ -1,205 +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 { AdGroupCreateToJSON, AdGroupUpdateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
-/**
- *
- */
-export class AdGroupsApi extends runtime.BaseAPI {
-    /**
-     * Create ad group
-     */
-    async adGroupsCreateRaw(requestParameters, initOverrides) {
-        if (requestParameters['adGroupCreate'] == null) {
-            throw new runtime.RequiredError('adGroupCreate', 'Required parameter "adGroupCreate" was null or undefined when calling adGroupsCreate().');
-        }
-        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", ["ads:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ad-groups`,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: AdGroupCreateToJSON(requestParameters['adGroupCreate']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Create ad group
-     */
-    async adGroupsCreate(requestParameters, initOverrides) {
-        const response = await this.adGroupsCreateRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Returns 409 CONFLICT with `details: { ads, keywords }` when the ad group still has dependent ads or keywords. Pass `?cascade=true` to delete them in the same request.
-     * Delete ad group
-     */
-    async adGroupsDeleteRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adGroupsDelete().');
-        }
-        const queryParameters = {};
-        if (requestParameters['cascade'] != null) {
-            queryParameters['cascade'] = requestParameters['cascade'];
-        }
-        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", ["ads:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ad-groups/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Returns 409 CONFLICT with `details: { ads, keywords }` when the ad group still has dependent ads or keywords. Pass `?cascade=true` to delete them in the same request.
-     * Delete ad group
-     */
-    async adGroupsDelete(requestParameters, initOverrides) {
-        const response = await this.adGroupsDeleteRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Get ad group
-     */
-    async adGroupsGetRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adGroupsGet().');
-        }
-        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", ["ads:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ad-groups/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Get ad group
-     */
-    async adGroupsGet(requestParameters, initOverrides) {
-        const response = await this.adGroupsGetRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * List ad groups
-     */
-    async adGroupsListRaw(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", ["ads:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ad-groups`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * List ad groups
-     */
-    async adGroupsList(requestParameters = {}, initOverrides) {
-        const response = await this.adGroupsListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Update ad group
-     */
-    async adGroupsUpdateRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adGroupsUpdate().');
-        }
-        if (requestParameters['adGroupUpdate'] == null) {
-            throw new runtime.RequiredError('adGroupUpdate', 'Required parameter "adGroupUpdate" was null or undefined when calling adGroupsUpdate().');
-        }
-        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", ["ads:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ad-groups/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: AdGroupUpdateToJSON(requestParameters['adGroupUpdate']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Update ad group
-     */
-    async adGroupsUpdate(requestParameters, initOverrides) {
-        const response = await this.adGroupsUpdateRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-}

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

@@ -1,160 +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 { AdCreate, AdUpdate, CampaignsListCursorParameter, SuccessEnvelope } from '../models/index';
-export interface AdsCreateRequest {
-    adCreate: AdCreate;
-    xSpaceId?: string;
-}
-export interface AdsDeleteRequest {
-    id: string;
-    xSpaceId?: string;
-}
-export interface AdsGetRequest {
-    id: string;
-    xSpaceId?: string;
-}
-export interface AdsListRequest {
-    limit?: number;
-    cursor?: CampaignsListCursorParameter;
-    xSpaceId?: string;
-}
-export interface AdsUpdateRequest {
-    id: string;
-    adUpdate: AdUpdate;
-    xSpaceId?: string;
-}
-/**
- * AdsApi - interface
- *
- * @export
- * @interface AdsApiInterface
- */
-export interface AdsApiInterface {
-    /**
-     *
-     * @summary Create ad
-     * @param {AdCreate} adCreate
-     * @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 AdsApiInterface
-     */
-    adsCreateRaw(requestParameters: AdsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Create ad
-     */
-    adsCreate(requestParameters: AdsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     *
-     * @summary Delete ad
-     * @param {string} id
-     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AdsApiInterface
-     */
-    adsDeleteRaw(requestParameters: AdsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Delete ad
-     */
-    adsDelete(requestParameters: AdsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     *
-     * @summary Get ad
-     * @param {string} id
-     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AdsApiInterface
-     */
-    adsGetRaw(requestParameters: AdsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Get ad
-     */
-    adsGet(requestParameters: AdsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     *
-     * @summary List ads
-     * @param {number} [limit] Maximum items to return. Default 50, max 200.
-     * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
-     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AdsApiInterface
-     */
-    adsListRaw(requestParameters: AdsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * List ads
-     */
-    adsList(requestParameters: AdsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     *
-     * @summary Update ad (used by partial-resync flows)
-     * @param {string} id
-     * @param {AdUpdate} adUpdate
-     * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AdsApiInterface
-     */
-    adsUpdateRaw(requestParameters: AdsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Update ad (used by partial-resync flows)
-     */
-    adsUpdate(requestParameters: AdsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}
-/**
- *
- */
-export declare class AdsApi extends runtime.BaseAPI implements AdsApiInterface {
-    /**
-     * Create ad
-     */
-    adsCreateRaw(requestParameters: AdsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Create ad
-     */
-    adsCreate(requestParameters: AdsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     * Delete ad
-     */
-    adsDeleteRaw(requestParameters: AdsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Delete ad
-     */
-    adsDelete(requestParameters: AdsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     * Get ad
-     */
-    adsGetRaw(requestParameters: AdsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Get ad
-     */
-    adsGet(requestParameters: AdsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     * List ads
-     */
-    adsListRaw(requestParameters: AdsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * List ads
-     */
-    adsList(requestParameters?: AdsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-    /**
-     * Update ad (used by partial-resync flows)
-     */
-    adsUpdateRaw(requestParameters: AdsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
-    /**
-     * Update ad (used by partial-resync flows)
-     */
-    adsUpdate(requestParameters: AdsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
-}

package/dist/generated/apis/AdsApi.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 { AdCreateToJSON, AdUpdateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
-/**
- *
- */
-export class AdsApi extends runtime.BaseAPI {
-    /**
-     * Create ad
-     */
-    async adsCreateRaw(requestParameters, initOverrides) {
-        if (requestParameters['adCreate'] == null) {
-            throw new runtime.RequiredError('adCreate', 'Required parameter "adCreate" was null or undefined when calling adsCreate().');
-        }
-        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", ["ads:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ads`,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: AdCreateToJSON(requestParameters['adCreate']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Create ad
-     */
-    async adsCreate(requestParameters, initOverrides) {
-        const response = await this.adsCreateRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Delete ad
-     */
-    async adsDeleteRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adsDelete().');
-        }
-        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", ["ads:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ads/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Delete ad
-     */
-    async adsDelete(requestParameters, initOverrides) {
-        const response = await this.adsDeleteRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Get ad
-     */
-    async adsGetRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adsGet().');
-        }
-        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", ["ads:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ads/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Get ad
-     */
-    async adsGet(requestParameters, initOverrides) {
-        const response = await this.adsGetRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * List ads
-     */
-    async adsListRaw(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", ["ads:read"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ads`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * List ads
-     */
-    async adsList(requestParameters = {}, initOverrides) {
-        const response = await this.adsListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Update ad (used by partial-resync flows)
-     */
-    async adsUpdateRaw(requestParameters, initOverrides) {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adsUpdate().');
-        }
-        if (requestParameters['adUpdate'] == null) {
-            throw new runtime.RequiredError('adUpdate', 'Required parameter "adUpdate" was null or undefined when calling adsUpdate().');
-        }
-        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", ["ads:write"]);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/api/v1/ads/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: AdUpdateToJSON(requestParameters['adUpdate']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
-    }
-    /**
-     * Update ad (used by partial-resync flows)
-     */
-    async adsUpdate(requestParameters, initOverrides) {
-        const response = await this.adsUpdateRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-}