@streetlevel/api-clients 1.0.1

package/src/generated/adrequest/apis/AdRequestsApi.ts

@@ -0,0 +1,539 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Ad Request API
+ * API for managing ad delivery requests
+ *
+ * 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 {
+  AdRequestResponse,
+  AdRequestStatus,
+  CreateAdRequest400Response,
+  CreateAdRequestRequest,
+  FulfillAdRequestRequest,
+  GetAdRequest404Response,
+  GetNextAdsRequest,
+  ListAdRequestsResponse,
+  NextAdsResponse,
+} from '../models/index';
+import {
+    AdRequestResponseFromJSON,
+    AdRequestResponseToJSON,
+    AdRequestStatusFromJSON,
+    AdRequestStatusToJSON,
+    CreateAdRequest400ResponseFromJSON,
+    CreateAdRequest400ResponseToJSON,
+    CreateAdRequestRequestFromJSON,
+    CreateAdRequestRequestToJSON,
+    FulfillAdRequestRequestFromJSON,
+    FulfillAdRequestRequestToJSON,
+    GetAdRequest404ResponseFromJSON,
+    GetAdRequest404ResponseToJSON,
+    GetNextAdsRequestFromJSON,
+    GetNextAdsRequestToJSON,
+    ListAdRequestsResponseFromJSON,
+    ListAdRequestsResponseToJSON,
+    NextAdsResponseFromJSON,
+    NextAdsResponseToJSON,
+} from '../models/index';
+
+export interface CancelAdRequestRequest {
+    requestId: string;
+}
+
+export interface CreateAdRequestOperationRequest {
+    createAdRequestRequest: CreateAdRequestRequest;
+}
+
+export interface FulfillAdRequestOperationRequest {
+    requestId: string;
+    fulfillAdRequestRequest: FulfillAdRequestRequest;
+}
+
+export interface GetAdRequestRequest {
+    requestId: string;
+}
+
+export interface GetNextAdsOperationRequest {
+    getNextAdsRequest: GetNextAdsRequest;
+}
+
+export interface ListAdRequestsRequest {
+    deviceId?: string;
+    zoneId?: string;
+    status?: AdRequestStatus;
+    offset?: number;
+    limit?: number;
+}
+
+/**
+ * AdRequestsApi - interface
+ * 
+ * @export
+ * @interface AdRequestsApiInterface
+ */
+export interface AdRequestsApiInterface {
+    /**
+     * Creates request options for cancelAdRequest without sending the request
+     * @param {string} requestId 
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    cancelAdRequestRequestOpts(requestParameters: CancelAdRequestRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Cancel an ad request
+     * @param {string} requestId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    cancelAdRequestRaw(requestParameters: CancelAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>>;
+
+    /**
+     * Cancel an ad request
+     */
+    cancelAdRequest(requestParameters: CancelAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse>;
+
+    /**
+     * Creates request options for createAdRequest without sending the request
+     * @param {CreateAdRequestRequest} createAdRequestRequest 
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    createAdRequestRequestOpts(requestParameters: CreateAdRequestOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Create a new ad request
+     * @param {CreateAdRequestRequest} createAdRequestRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    createAdRequestRaw(requestParameters: CreateAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>>;
+
+    /**
+     * Create a new ad request
+     */
+    createAdRequest(requestParameters: CreateAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse>;
+
+    /**
+     * Creates request options for fulfillAdRequest without sending the request
+     * @param {string} requestId 
+     * @param {FulfillAdRequestRequest} fulfillAdRequestRequest 
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    fulfillAdRequestRequestOpts(requestParameters: FulfillAdRequestOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Fulfill an ad request with an ad set
+     * @param {string} requestId 
+     * @param {FulfillAdRequestRequest} fulfillAdRequestRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    fulfillAdRequestRaw(requestParameters: FulfillAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>>;
+
+    /**
+     * Fulfill an ad request with an ad set
+     */
+    fulfillAdRequest(requestParameters: FulfillAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse>;
+
+    /**
+     * Creates request options for getAdRequest without sending the request
+     * @param {string} requestId 
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    getAdRequestRequestOpts(requestParameters: GetAdRequestRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get ad request by ID
+     * @param {string} requestId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    getAdRequestRaw(requestParameters: GetAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>>;
+
+    /**
+     * Get ad request by ID
+     */
+    getAdRequest(requestParameters: GetAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse>;
+
+    /**
+     * Creates request options for getNextAds without sending the request
+     * @param {GetNextAdsRequest} getNextAdsRequest 
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    getNextAdsRequestOpts(requestParameters: GetNextAdsOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Called by devices to get the next ad set to display. Automatically creates an ad request, finds matching ads, and fulfills it. 
+     * @summary Get next ads to display for a device
+     * @param {GetNextAdsRequest} getNextAdsRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    getNextAdsRaw(requestParameters: GetNextAdsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NextAdsResponse>>;
+
+    /**
+     * Called by devices to get the next ad set to display. Automatically creates an ad request, finds matching ads, and fulfills it. 
+     * Get next ads to display for a device
+     */
+    getNextAds(requestParameters: GetNextAdsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NextAdsResponse>;
+
+    /**
+     * Creates request options for listAdRequests without sending the request
+     * @param {string} [deviceId] Filter by device ID
+     * @param {string} [zoneId] Filter by zone ID
+     * @param {AdRequestStatus} [status] 
+     * @param {number} [offset] 
+     * @param {number} [limit] 
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    listAdRequestsRequestOpts(requestParameters: ListAdRequestsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List ad requests
+     * @param {string} [deviceId] Filter by device ID
+     * @param {string} [zoneId] Filter by zone ID
+     * @param {AdRequestStatus} [status] 
+     * @param {number} [offset] 
+     * @param {number} [limit] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdRequestsApiInterface
+     */
+    listAdRequestsRaw(requestParameters: ListAdRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAdRequestsResponse>>;
+
+    /**
+     * List ad requests
+     */
+    listAdRequests(requestParameters: ListAdRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAdRequestsResponse>;
+
+}
+
+/**
+ * 
+ */
+export class AdRequestsApi extends runtime.BaseAPI implements AdRequestsApiInterface {
+
+    /**
+     * Creates request options for cancelAdRequest without sending the request
+     */
+    async cancelAdRequestRequestOpts(requestParameters: CancelAdRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['requestId'] == null) {
+            throw new runtime.RequiredError(
+                'requestId',
+                'Required parameter "requestId" was null or undefined when calling cancelAdRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ad-requests/{request_id}/cancel`;
+        urlPath = urlPath.replace(`{${"request_id"}}`, encodeURIComponent(String(requestParameters['requestId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cancel an ad request
+     */
+    async cancelAdRequestRaw(requestParameters: CancelAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>> {
+        const requestOptions = await this.cancelAdRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cancel an ad request
+     */
+    async cancelAdRequest(requestParameters: CancelAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse> {
+        const response = await this.cancelAdRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createAdRequest without sending the request
+     */
+    async createAdRequestRequestOpts(requestParameters: CreateAdRequestOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createAdRequestRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createAdRequestRequest',
+                'Required parameter "createAdRequestRequest" was null or undefined when calling createAdRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/ad-requests`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateAdRequestRequestToJSON(requestParameters['createAdRequestRequest']),
+        };
+    }
+
+    /**
+     * Create a new ad request
+     */
+    async createAdRequestRaw(requestParameters: CreateAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>> {
+        const requestOptions = await this.createAdRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new ad request
+     */
+    async createAdRequest(requestParameters: CreateAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse> {
+        const response = await this.createAdRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for fulfillAdRequest without sending the request
+     */
+    async fulfillAdRequestRequestOpts(requestParameters: FulfillAdRequestOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['requestId'] == null) {
+            throw new runtime.RequiredError(
+                'requestId',
+                'Required parameter "requestId" was null or undefined when calling fulfillAdRequest().'
+            );
+        }
+
+        if (requestParameters['fulfillAdRequestRequest'] == null) {
+            throw new runtime.RequiredError(
+                'fulfillAdRequestRequest',
+                'Required parameter "fulfillAdRequestRequest" was null or undefined when calling fulfillAdRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/ad-requests/{request_id}/fulfill`;
+        urlPath = urlPath.replace(`{${"request_id"}}`, encodeURIComponent(String(requestParameters['requestId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: FulfillAdRequestRequestToJSON(requestParameters['fulfillAdRequestRequest']),
+        };
+    }
+
+    /**
+     * Fulfill an ad request with an ad set
+     */
+    async fulfillAdRequestRaw(requestParameters: FulfillAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>> {
+        const requestOptions = await this.fulfillAdRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Fulfill an ad request with an ad set
+     */
+    async fulfillAdRequest(requestParameters: FulfillAdRequestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse> {
+        const response = await this.fulfillAdRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getAdRequest without sending the request
+     */
+    async getAdRequestRequestOpts(requestParameters: GetAdRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['requestId'] == null) {
+            throw new runtime.RequiredError(
+                'requestId',
+                'Required parameter "requestId" was null or undefined when calling getAdRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/ad-requests/{request_id}`;
+        urlPath = urlPath.replace(`{${"request_id"}}`, encodeURIComponent(String(requestParameters['requestId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get ad request by ID
+     */
+    async getAdRequestRaw(requestParameters: GetAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdRequestResponse>> {
+        const requestOptions = await this.getAdRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get ad request by ID
+     */
+    async getAdRequest(requestParameters: GetAdRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdRequestResponse> {
+        const response = await this.getAdRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getNextAds without sending the request
+     */
+    async getNextAdsRequestOpts(requestParameters: GetNextAdsOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['getNextAdsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'getNextAdsRequest',
+                'Required parameter "getNextAdsRequest" was null or undefined when calling getNextAds().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/ad-requests/next`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetNextAdsRequestToJSON(requestParameters['getNextAdsRequest']),
+        };
+    }
+
+    /**
+     * Called by devices to get the next ad set to display. Automatically creates an ad request, finds matching ads, and fulfills it. 
+     * Get next ads to display for a device
+     */
+    async getNextAdsRaw(requestParameters: GetNextAdsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NextAdsResponse>> {
+        const requestOptions = await this.getNextAdsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NextAdsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Called by devices to get the next ad set to display. Automatically creates an ad request, finds matching ads, and fulfills it. 
+     * Get next ads to display for a device
+     */
+    async getNextAds(requestParameters: GetNextAdsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NextAdsResponse> {
+        const response = await this.getNextAdsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listAdRequests without sending the request
+     */
+    async listAdRequestsRequestOpts(requestParameters: ListAdRequestsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['deviceId'] != null) {
+            queryParameters['device_id'] = requestParameters['deviceId'];
+        }
+
+        if (requestParameters['zoneId'] != null) {
+            queryParameters['zone_id'] = requestParameters['zoneId'];
+        }
+
+        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 = `/ad-requests`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List ad requests
+     */
+    async listAdRequestsRaw(requestParameters: ListAdRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAdRequestsResponse>> {
+        const requestOptions = await this.listAdRequestsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAdRequestsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List ad requests
+     */
+    async listAdRequests(requestParameters: ListAdRequestsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAdRequestsResponse> {
+        const response = await this.listAdRequestsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

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

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

package/src/generated/adrequest/docs/AdForDisplay.md

@@ -0,0 +1,43 @@
+
+# AdForDisplay
+
+Ad ready for display
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`fileUrl` | string
+`contentType` | string
+`fileSize` | number
+
+## Example
+
+```typescript
+import type { AdForDisplay } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "fileUrl": null,
+  "contentType": null,
+  "fileSize": null,
+} satisfies AdForDisplay
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdForDisplay
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/adrequest/docs/AdRequestResponse.md

@@ -0,0 +1,53 @@
+
+# AdRequestResponse
+
+Ad request information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`deviceId` | string
+`zoneId` | string
+`adsetId` | string
+`status` | [AdRequestStatus](AdRequestStatus.md)
+`latitude` | number
+`longitude` | number
+`requestedAt` | Date
+`fulfilledAt` | Date
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { AdRequestResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "deviceId": null,
+  "zoneId": null,
+  "adsetId": null,
+  "status": null,
+  "latitude": null,
+  "longitude": null,
+  "requestedAt": null,
+  "fulfilledAt": null,
+  "expiresAt": null,
+} satisfies AdRequestResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdRequestResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/adrequest/docs/AdRequestStatus.md

@@ -0,0 +1,33 @@
+
+# AdRequestStatus
+
+Ad request status
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { AdRequestStatus } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies AdRequestStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdRequestStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+