@defoai/ads-client 1.4.0

package/src/generated/apis/CampaignAssetsApi.ts

@@ -0,0 +1,330 @@
+/* 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 {
+  CampaignAssetCreate,
+  CampaignsListCursorParameter,
+  ErrorEnvelope,
+  SuccessEnvelope,
+} from '../models/index';
+import {
+    CampaignAssetCreateFromJSON,
+    CampaignAssetCreateToJSON,
+    CampaignsListCursorParameterFromJSON,
+    CampaignsListCursorParameterToJSON,
+    ErrorEnvelopeFromJSON,
+    ErrorEnvelopeToJSON,
+    SuccessEnvelopeFromJSON,
+    SuccessEnvelopeToJSON,
+} from '../models/index';
+
+export interface CampaignAssetsCreateRequest {
+    campaignAssetCreate: CampaignAssetCreate;
+    xSpaceId?: string;
+}
+
+export interface CampaignAssetsDeleteRequest {
+    id: string;
+    xSpaceId?: string;
+}
+
+export interface CampaignAssetsGetRequest {
+    id: string;
+    xSpaceId?: string;
+}
+
+export interface CampaignAssetsListRequest {
+    limit?: number;
+    cursor?: CampaignsListCursorParameter;
+    campaignId?: string;
+    assetId?: string;
+    xSpaceId?: string;
+}
+
+/**
+ * CampaignAssetsApi - interface
+ * 
+ * @export
+ * @interface CampaignAssetsApiInterface
+ */
+export interface CampaignAssetsApiInterface {
+    /**
+     * 
+     * @summary Bind an asset to a campaign with a role
+     * @param {CampaignAssetCreate} campaignAssetCreate 
+     * @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 CampaignAssetsApiInterface
+     */
+    campaignAssetsCreateRaw(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * Bind an asset to a campaign with a role
+     */
+    campaignAssetsCreate(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 
+     * @summary Remove a campaign-asset binding
+     * @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 CampaignAssetsApiInterface
+     */
+    campaignAssetsDeleteRaw(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * Remove a campaign-asset binding
+     */
+    campaignAssetsDelete(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 
+     * @summary Get campaign-asset binding
+     * @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 CampaignAssetsApiInterface
+     */
+    campaignAssetsGetRaw(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * Get campaign-asset binding
+     */
+    campaignAssetsGet(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+    /**
+     * 
+     * @summary List campaign-asset bindings (filter by campaignId/assetId)
+     * @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} [campaignId] Restrict to bindings for a specific campaign.
+     * @param {string} [assetId] Restrict to bindings for a specific asset.
+     * @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 CampaignAssetsApiInterface
+     */
+    campaignAssetsListRaw(requestParameters: CampaignAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
+
+    /**
+     * List campaign-asset bindings (filter by campaignId/assetId)
+     */
+    campaignAssetsList(requestParameters: CampaignAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
+
+}
+
+/**
+ * 
+ */
+export class CampaignAssetsApi extends runtime.BaseAPI implements CampaignAssetsApiInterface {
+
+    /**
+     * Bind an asset to a campaign with a role
+     */
+    async campaignAssetsCreateRaw(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>> {
+        if (requestParameters['campaignAssetCreate'] == null) {
+            throw new runtime.RequiredError(
+                'campaignAssetCreate',
+                'Required parameter "campaignAssetCreate" was null or undefined when calling campaignAssetsCreate().'
+            );
+        }
+
+        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", ["assets:write"]);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/campaign-assets`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CampaignAssetCreateToJSON(requestParameters['campaignAssetCreate']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+
+    /**
+     * Bind an asset to a campaign with a role
+     */
+    async campaignAssetsCreate(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.campaignAssetsCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Remove a campaign-asset binding
+     */
+    async campaignAssetsDeleteRaw(requestParameters: CampaignAssetsDeleteRequest, 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 campaignAssetsDelete().'
+            );
+        }
+
+        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", ["assets:write"]);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/campaign-assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+
+    /**
+     * Remove a campaign-asset binding
+     */
+    async campaignAssetsDelete(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.campaignAssetsDeleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get campaign-asset binding
+     */
+    async campaignAssetsGetRaw(requestParameters: CampaignAssetsGetRequest, 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 campaignAssetsGet().'
+            );
+        }
+
+        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", ["assets:read"]);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/campaign-assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+
+    /**
+     * Get campaign-asset binding
+     */
+    async campaignAssetsGet(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.campaignAssetsGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List campaign-asset bindings (filter by campaignId/assetId)
+     */
+    async campaignAssetsListRaw(requestParameters: CampaignAssetsListRequest, 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'];
+        }
+
+        if (requestParameters['campaignId'] != null) {
+            queryParameters['campaignId'] = requestParameters['campaignId'];
+        }
+
+        if (requestParameters['assetId'] != null) {
+            queryParameters['assetId'] = requestParameters['assetId'];
+        }
+
+        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", ["assets:read"]);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/campaign-assets`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
+    }
+
+    /**
+     * List campaign-asset bindings (filter by campaignId/assetId)
+     */
+    async campaignAssetsList(requestParameters: CampaignAssetsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope> {
+        const response = await this.campaignAssetsListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}