@streetlevel/api-clients 1.0.1

package/src/generated/ad/apis/AdsApi.ts

@@ -0,0 +1,670 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Ad API
+ * API for managing advertisements
+ *
+ * The version of the OpenAPI document: 1.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 {
+  AdResponse,
+  AdStatus,
+  CreateAd400Response,
+  CreateAdRequest,
+  GetAd404Response,
+  ListAdsResponse,
+  RejectAdRequest,
+  UploadUrlResponse,
+} from '../models/index';
+import {
+    AdResponseFromJSON,
+    AdResponseToJSON,
+    AdStatusFromJSON,
+    AdStatusToJSON,
+    CreateAd400ResponseFromJSON,
+    CreateAd400ResponseToJSON,
+    CreateAdRequestFromJSON,
+    CreateAdRequestToJSON,
+    GetAd404ResponseFromJSON,
+    GetAd404ResponseToJSON,
+    ListAdsResponseFromJSON,
+    ListAdsResponseToJSON,
+    RejectAdRequestFromJSON,
+    RejectAdRequestToJSON,
+    UploadUrlResponseFromJSON,
+    UploadUrlResponseToJSON,
+} from '../models/index';
+
+export interface ApproveAdRequest {
+    adId: string;
+}
+
+export interface CreateAdOperationRequest {
+    createAdRequest: CreateAdRequest;
+}
+
+export interface DeleteAdRequest {
+    adId: string;
+}
+
+export interface GetAdRequest {
+    adId: string;
+}
+
+export interface GetAdUploadUrlRequest {
+    adId: string;
+}
+
+export interface ListAdsRequest {
+    campaignId?: string;
+    status?: AdStatus;
+    offset?: number;
+    limit?: number;
+}
+
+export interface RejectAdOperationRequest {
+    adId: string;
+    rejectAdRequest: RejectAdRequest;
+}
+
+export interface SubmitAdRequest {
+    adId: string;
+}
+
+/**
+ * AdsApi - interface
+ * 
+ * @export
+ * @interface AdsApiInterface
+ */
+export interface AdsApiInterface {
+    /**
+     * Creates request options for approveAd without sending the request
+     * @param {string} adId 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    approveAdRequestOpts(requestParameters: ApproveAdRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Approve an ad
+     * @param {string} adId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    approveAdRaw(requestParameters: ApproveAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>>;
+
+    /**
+     * Approve an ad
+     */
+    approveAd(requestParameters: ApproveAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse>;
+
+    /**
+     * Creates request options for createAd without sending the request
+     * @param {CreateAdRequest} createAdRequest 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    createAdRequestOpts(requestParameters: CreateAdOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Create a new ad
+     * @param {CreateAdRequest} createAdRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    createAdRaw(requestParameters: CreateAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>>;
+
+    /**
+     * Create a new ad
+     */
+    createAd(requestParameters: CreateAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse>;
+
+    /**
+     * Creates request options for deleteAd without sending the request
+     * @param {string} adId 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    deleteAdRequestOpts(requestParameters: DeleteAdRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Delete an ad
+     * @param {string} adId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    deleteAdRaw(requestParameters: DeleteAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete an ad
+     */
+    deleteAd(requestParameters: DeleteAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for getAd without sending the request
+     * @param {string} adId 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    getAdRequestOpts(requestParameters: GetAdRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get ad by ID
+     * @param {string} adId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    getAdRaw(requestParameters: GetAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>>;
+
+    /**
+     * Get ad by ID
+     */
+    getAd(requestParameters: GetAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse>;
+
+    /**
+     * Creates request options for getAdUploadUrl without sending the request
+     * @param {string} adId 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    getAdUploadUrlRequestOpts(requestParameters: GetAdUploadUrlRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get presigned URL for ad file upload
+     * @param {string} adId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    getAdUploadUrlRaw(requestParameters: GetAdUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadUrlResponse>>;
+
+    /**
+     * Get presigned URL for ad file upload
+     */
+    getAdUploadUrl(requestParameters: GetAdUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadUrlResponse>;
+
+    /**
+     * Creates request options for listAds without sending the request
+     * @param {string} [campaignId] Filter by campaign ID
+     * @param {AdStatus} [status] 
+     * @param {number} [offset] 
+     * @param {number} [limit] 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    listAdsRequestOpts(requestParameters: ListAdsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List ads
+     * @param {string} [campaignId] Filter by campaign ID
+     * @param {AdStatus} [status] 
+     * @param {number} [offset] 
+     * @param {number} [limit] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    listAdsRaw(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAdsResponse>>;
+
+    /**
+     * List ads
+     */
+    listAds(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAdsResponse>;
+
+    /**
+     * Creates request options for rejectAd without sending the request
+     * @param {string} adId 
+     * @param {RejectAdRequest} rejectAdRequest 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    rejectAdRequestOpts(requestParameters: RejectAdOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Reject an ad
+     * @param {string} adId 
+     * @param {RejectAdRequest} rejectAdRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    rejectAdRaw(requestParameters: RejectAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>>;
+
+    /**
+     * Reject an ad
+     */
+    rejectAd(requestParameters: RejectAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse>;
+
+    /**
+     * Creates request options for submitAd without sending the request
+     * @param {string} adId 
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    submitAdRequestOpts(requestParameters: SubmitAdRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Transitions ad from PENDING_UPLOAD to PENDING_APPROVAL. Requires the file to have been uploaded to S3 first. This transition triggers the media upload to the LED cloud provider. 
+     * @summary Submit ad for approval (triggers file upload to LED cloud)
+     * @param {string} adId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdsApiInterface
+     */
+    submitAdRaw(requestParameters: SubmitAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>>;
+
+    /**
+     * Transitions ad from PENDING_UPLOAD to PENDING_APPROVAL. Requires the file to have been uploaded to S3 first. This transition triggers the media upload to the LED cloud provider. 
+     * Submit ad for approval (triggers file upload to LED cloud)
+     */
+    submitAd(requestParameters: SubmitAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse>;
+
+}
+
+/**
+ * 
+ */
+export class AdsApi extends runtime.BaseAPI implements AdsApiInterface {
+
+    /**
+     * Creates request options for approveAd without sending the request
+     */
+    async approveAdRequestOpts(requestParameters: ApproveAdRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['adId'] == null) {
+            throw new runtime.RequiredError(
+                'adId',
+                'Required parameter "adId" was null or undefined when calling approveAd().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ads/{ad_id}/approve`;
+        urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Approve an ad
+     */
+    async approveAdRaw(requestParameters: ApproveAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>> {
+        const requestOptions = await this.approveAdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Approve an ad
+     */
+    async approveAd(requestParameters: ApproveAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse> {
+        const response = await this.approveAdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createAd without sending the request
+     */
+    async createAdRequestOpts(requestParameters: CreateAdOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createAdRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createAdRequest',
+                'Required parameter "createAdRequest" was null or undefined when calling createAd().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/ads`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateAdRequestToJSON(requestParameters['createAdRequest']),
+        };
+    }
+
+    /**
+     * Create a new ad
+     */
+    async createAdRaw(requestParameters: CreateAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>> {
+        const requestOptions = await this.createAdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new ad
+     */
+    async createAd(requestParameters: CreateAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse> {
+        const response = await this.createAdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteAd without sending the request
+     */
+    async deleteAdRequestOpts(requestParameters: DeleteAdRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['adId'] == null) {
+            throw new runtime.RequiredError(
+                'adId',
+                'Required parameter "adId" was null or undefined when calling deleteAd().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ads/{ad_id}`;
+        urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete an ad
+     */
+    async deleteAdRaw(requestParameters: DeleteAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteAdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete an ad
+     */
+    async deleteAd(requestParameters: DeleteAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteAdRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getAd without sending the request
+     */
+    async getAdRequestOpts(requestParameters: GetAdRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['adId'] == null) {
+            throw new runtime.RequiredError(
+                'adId',
+                'Required parameter "adId" was null or undefined when calling getAd().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ads/{ad_id}`;
+        urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get ad by ID
+     */
+    async getAdRaw(requestParameters: GetAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>> {
+        const requestOptions = await this.getAdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get ad by ID
+     */
+    async getAd(requestParameters: GetAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse> {
+        const response = await this.getAdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getAdUploadUrl without sending the request
+     */
+    async getAdUploadUrlRequestOpts(requestParameters: GetAdUploadUrlRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['adId'] == null) {
+            throw new runtime.RequiredError(
+                'adId',
+                'Required parameter "adId" was null or undefined when calling getAdUploadUrl().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ads/{ad_id}/upload-url`;
+        urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get presigned URL for ad file upload
+     */
+    async getAdUploadUrlRaw(requestParameters: GetAdUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadUrlResponse>> {
+        const requestOptions = await this.getAdUploadUrlRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UploadUrlResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get presigned URL for ad file upload
+     */
+    async getAdUploadUrl(requestParameters: GetAdUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadUrlResponse> {
+        const response = await this.getAdUploadUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listAds without sending the request
+     */
+    async listAdsRequestOpts(requestParameters: ListAdsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['campaignId'] != null) {
+            queryParameters['campaign_id'] = requestParameters['campaignId'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ads`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List ads
+     */
+    async listAdsRaw(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAdsResponse>> {
+        const requestOptions = await this.listAdsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAdsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List ads
+     */
+    async listAds(requestParameters: ListAdsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAdsResponse> {
+        const response = await this.listAdsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for rejectAd without sending the request
+     */
+    async rejectAdRequestOpts(requestParameters: RejectAdOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['adId'] == null) {
+            throw new runtime.RequiredError(
+                'adId',
+                'Required parameter "adId" was null or undefined when calling rejectAd().'
+            );
+        }
+
+        if (requestParameters['rejectAdRequest'] == null) {
+            throw new runtime.RequiredError(
+                'rejectAdRequest',
+                'Required parameter "rejectAdRequest" was null or undefined when calling rejectAd().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/ads/{ad_id}/reject`;
+        urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RejectAdRequestToJSON(requestParameters['rejectAdRequest']),
+        };
+    }
+
+    /**
+     * Reject an ad
+     */
+    async rejectAdRaw(requestParameters: RejectAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>> {
+        const requestOptions = await this.rejectAdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Reject an ad
+     */
+    async rejectAd(requestParameters: RejectAdOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse> {
+        const response = await this.rejectAdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for submitAd without sending the request
+     */
+    async submitAdRequestOpts(requestParameters: SubmitAdRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['adId'] == null) {
+            throw new runtime.RequiredError(
+                'adId',
+                'Required parameter "adId" was null or undefined when calling submitAd().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ads/{ad_id}/submit`;
+        urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Transitions ad from PENDING_UPLOAD to PENDING_APPROVAL. Requires the file to have been uploaded to S3 first. This transition triggers the media upload to the LED cloud provider. 
+     * Submit ad for approval (triggers file upload to LED cloud)
+     */
+    async submitAdRaw(requestParameters: SubmitAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdResponse>> {
+        const requestOptions = await this.submitAdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Transitions ad from PENDING_UPLOAD to PENDING_APPROVAL. Requires the file to have been uploaded to S3 first. This transition triggers the media upload to the LED cloud provider. 
+     * Submit ad for approval (triggers file upload to LED cloud)
+     */
+    async submitAd(requestParameters: SubmitAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdResponse> {
+        const response = await this.submitAdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/generated/ad/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AdsApi';