@defoai/ads-client 1.4.0

package/src/generated/apis/AdGroupsApi.ts

@@ -0,0 +1,408 @@
+/* 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 type {
+  AdGroupCreate,
+  AdGroupUpdate,
+  CampaignsListCursorParameter,
+  ErrorEnvelope,
+  SuccessEnvelope,
+} from '../models/index';
+import {
+    AdGroupCreateFromJSON,
+    AdGroupCreateToJSON,
+    AdGroupUpdateFromJSON,
+    AdGroupUpdateToJSON,
+    CampaignsListCursorParameterFromJSON,
+    CampaignsListCursorParameterToJSON,
+    ErrorEnvelopeFromJSON,
+    ErrorEnvelopeToJSON,
+    SuccessEnvelopeFromJSON,
+    SuccessEnvelopeToJSON,
+} from '../models/index';
+
+export interface AdGroupsCreateRequest {
+    adGroupCreate: AdGroupCreate;
+    xSpaceId?: string;
+}
+
+export interface AdGroupsDeleteRequest {
+    id: string;
+    cascade?: boolean;
+    xSpaceId?: string;
+}
+
+export interface AdGroupsGetRequest {
+    id: string;
+    xSpaceId?: string;
+}
+
+export interface AdGroupsListRequest {
+    limit?: number;
+    cursor?: CampaignsListCursorParameter;
+    xSpaceId?: string;
+}
+
+export interface AdGroupsUpdateRequest {
+    id: string;
+    adGroupUpdate: AdGroupUpdate;
+    xSpaceId?: string;
+}
+
+/**
+ * AdGroupsApi - interface
+ * 
+ * @export
+ * @interface AdGroupsApiInterface
+ */
+export interface AdGroupsApiInterface {
+    /**
+     * 
+     * @summary Create ad group
+     * @param {AdGroupCreate} adGroupCreate 
+     * @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 AdGroupsApiInterface
+     */
+    adGroupsCreateRaw(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * Create ad group
+     */
+    adGroupsCreate(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 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.
+     * @summary Delete ad group
+     * @param {string} id 
+     * @param {boolean} [cascade] Set to &#x60;true&#x60; to delete dependent ads and keywords along with the ad group.
+     * @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 AdGroupsApiInterface
+     */
+    adGroupsDeleteRaw(requestParameters: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * 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
+     */
+    adGroupsDelete(requestParameters: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 
+     * @summary Get ad group
+     * @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 AdGroupsApiInterface
+     */
+    adGroupsGetRaw(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * Get ad group
+     */
+    adGroupsGet(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 
+     * @summary List ad groups
+     * @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 AdGroupsApiInterface
+     */
+    adGroupsListRaw(requestParameters: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * List ad groups
+     */
+    adGroupsList(requestParameters: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 
+     * @summary Update ad group
+     * @param {string} id 
+     * @param {AdGroupUpdate} adGroupUpdate 
+     * @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 AdGroupsApiInterface
+     */
+    adGroupsUpdateRaw(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * Update ad group
+     */
+    adGroupsUpdate(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+}
+
+/**
+ * 
+ */
+export class AdGroupsApi extends runtime.BaseAPI implements AdGroupsApiInterface {
+
+    /**
+     * Create ad group
+     */
+    async adGroupsCreateRaw(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>> {
+        if (requestParameters['adGroupCreate'] == null) {
+            throw new runtime.RequiredError(
+                'adGroupCreate',
+                'Required parameter "adGroupCreate" was null or undefined when calling adGroupsCreate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        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: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling adGroupsDelete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['cascade'] != null) {
+            queryParameters['cascade'] = requestParameters['cascade'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.adGroupsDeleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get ad group
+     */
+    async adGroupsGetRaw(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling adGroupsGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.adGroupsGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List ad groups
+     */
+    async adGroupsListRaw(requestParameters: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: AdGroupsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.adGroupsListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update ad group
+     */
+    async adGroupsUpdateRaw(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.adGroupsUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}