@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,41 @@
+
+# NextAdsResponse
+
+Next ads to display
+
+## Properties
+
+Name | Type
+------------ | -------------
+`requestId` | string
+`adsetId` | string
+`ads` | [Array<AdForDisplay>](AdForDisplay.md)
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { NextAdsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "requestId": null,
+  "adsetId": null,
+  "ads": null,
+  "expiresAt": null,
+} satisfies NextAdsResponse
+
+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 NextAdsResponse
+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/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/generated/adrequest/models/AdForDisplay.ts

@@ -0,0 +1,101 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Ad ready for display
+ * @export
+ * @interface AdForDisplay
+ */
+export interface AdForDisplay {
+    /**
+     * Ad unique identifier
+     * @type {string}
+     * @memberof AdForDisplay
+     */
+    id: string;
+    /**
+     * Ad name
+     * @type {string}
+     * @memberof AdForDisplay
+     */
+    name: string;
+    /**
+     * URL to download the ad content
+     * @type {string}
+     * @memberof AdForDisplay
+     */
+    fileUrl: string;
+    /**
+     * MIME type of the ad content
+     * @type {string}
+     * @memberof AdForDisplay
+     */
+    contentType: string;
+    /**
+     * File size in bytes
+     * @type {number}
+     * @memberof AdForDisplay
+     */
+    fileSize?: number;
+}
+
+/**
+ * Check if a given object implements the AdForDisplay interface.
+ */
+export function instanceOfAdForDisplay(value: object): value is AdForDisplay {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('fileUrl' in value) || value['fileUrl'] === undefined) return false;
+    if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    return true;
+}
+
+export function AdForDisplayFromJSON(json: any): AdForDisplay {
+    return AdForDisplayFromJSONTyped(json, false);
+}
+
+export function AdForDisplayFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdForDisplay {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'fileUrl': json['file_url'],
+        'contentType': json['content_type'],
+        'fileSize': json['file_size'] == null ? undefined : json['file_size'],
+    };
+}
+
+export function AdForDisplayToJSON(json: any): AdForDisplay {
+    return AdForDisplayToJSONTyped(json, false);
+}
+
+export function AdForDisplayToJSONTyped(value?: AdForDisplay | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'file_url': value['fileUrl'],
+        'content_type': value['contentType'],
+        'file_size': value['fileSize'],
+    };
+}
+

package/src/generated/adrequest/models/AdRequestResponse.ts

@@ -0,0 +1,151 @@
+/* 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 { mapValues } from '../runtime';
+import type { AdRequestStatus } from './AdRequestStatus';
+import {
+    AdRequestStatusFromJSON,
+    AdRequestStatusFromJSONTyped,
+    AdRequestStatusToJSON,
+    AdRequestStatusToJSONTyped,
+} from './AdRequestStatus';
+
+/**
+ * Ad request information
+ * @export
+ * @interface AdRequestResponse
+ */
+export interface AdRequestResponse {
+    /**
+     * Ad request unique identifier
+     * @type {string}
+     * @memberof AdRequestResponse
+     */
+    id: string;
+    /**
+     * ID of the requesting device
+     * @type {string}
+     * @memberof AdRequestResponse
+     */
+    deviceId: string;
+    /**
+     * ID of the zone
+     * @type {string}
+     * @memberof AdRequestResponse
+     */
+    zoneId?: string;
+    /**
+     * ID of the fulfilled ad set
+     * @type {string}
+     * @memberof AdRequestResponse
+     */
+    adsetId?: string;
+    /**
+     * 
+     * @type {AdRequestStatus}
+     * @memberof AdRequestResponse
+     */
+    status: AdRequestStatus;
+    /**
+     * Device latitude at request time
+     * @type {number}
+     * @memberof AdRequestResponse
+     */
+    latitude?: number;
+    /**
+     * Device longitude at request time
+     * @type {number}
+     * @memberof AdRequestResponse
+     */
+    longitude?: number;
+    /**
+     * Request timestamp
+     * @type {Date}
+     * @memberof AdRequestResponse
+     */
+    requestedAt: Date;
+    /**
+     * Fulfillment timestamp
+     * @type {Date}
+     * @memberof AdRequestResponse
+     */
+    fulfilledAt?: Date;
+    /**
+     * Expiration timestamp
+     * @type {Date}
+     * @memberof AdRequestResponse
+     */
+    expiresAt?: Date;
+}
+
+
+
+/**
+ * Check if a given object implements the AdRequestResponse interface.
+ */
+export function instanceOfAdRequestResponse(value: object): value is AdRequestResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('deviceId' in value) || value['deviceId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('requestedAt' in value) || value['requestedAt'] === undefined) return false;
+    return true;
+}
+
+export function AdRequestResponseFromJSON(json: any): AdRequestResponse {
+    return AdRequestResponseFromJSONTyped(json, false);
+}
+
+export function AdRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdRequestResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'deviceId': json['device_id'],
+        'zoneId': json['zone_id'] == null ? undefined : json['zone_id'],
+        'adsetId': json['adset_id'] == null ? undefined : json['adset_id'],
+        'status': AdRequestStatusFromJSON(json['status']),
+        'latitude': json['latitude'] == null ? undefined : json['latitude'],
+        'longitude': json['longitude'] == null ? undefined : json['longitude'],
+        'requestedAt': (new Date(json['requested_at'])),
+        'fulfilledAt': json['fulfilled_at'] == null ? undefined : (new Date(json['fulfilled_at'])),
+        'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
+    };
+}
+
+export function AdRequestResponseToJSON(json: any): AdRequestResponse {
+    return AdRequestResponseToJSONTyped(json, false);
+}
+
+export function AdRequestResponseToJSONTyped(value?: AdRequestResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'device_id': value['deviceId'],
+        'zone_id': value['zoneId'],
+        'adset_id': value['adsetId'],
+        'status': AdRequestStatusToJSON(value['status']),
+        'latitude': value['latitude'],
+        'longitude': value['longitude'],
+        'requested_at': value['requestedAt'].toISOString(),
+        'fulfilled_at': value['fulfilledAt'] == null ? value['fulfilledAt'] : value['fulfilledAt'].toISOString(),
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+    };
+}
+

package/src/generated/adrequest/models/AdRequestStatus.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * Ad request status
+ * @export
+ */
+export const AdRequestStatus = {
+    Pending: 'PENDING',
+    Fulfilled: 'FULFILLED',
+    Expired: 'EXPIRED',
+    Cancelled: 'CANCELLED'
+} as const;
+export type AdRequestStatus = typeof AdRequestStatus[keyof typeof AdRequestStatus];
+
+
+export function instanceOfAdRequestStatus(value: any): boolean {
+    for (const key in AdRequestStatus) {
+        if (Object.prototype.hasOwnProperty.call(AdRequestStatus, key)) {
+            if (AdRequestStatus[key as keyof typeof AdRequestStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AdRequestStatusFromJSON(json: any): AdRequestStatus {
+    return AdRequestStatusFromJSONTyped(json, false);
+}
+
+export function AdRequestStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdRequestStatus {
+    return json as AdRequestStatus;
+}
+
+export function AdRequestStatusToJSON(value?: AdRequestStatus | null): any {
+    return value as any;
+}
+
+export function AdRequestStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): AdRequestStatus {
+    return value as AdRequestStatus;
+}
+

package/src/generated/adrequest/models/CreateAdRequest400Response.ts

@@ -0,0 +1,101 @@
+/* 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 { mapValues } from '../runtime';
+import type { CreateAdRequest400ResponseViolationsInner } from './CreateAdRequest400ResponseViolationsInner';
+import {
+    CreateAdRequest400ResponseViolationsInnerFromJSON,
+    CreateAdRequest400ResponseViolationsInnerFromJSONTyped,
+    CreateAdRequest400ResponseViolationsInnerToJSON,
+    CreateAdRequest400ResponseViolationsInnerToJSONTyped,
+} from './CreateAdRequest400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface CreateAdRequest400Response
+ */
+export interface CreateAdRequest400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateAdRequest400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateAdRequest400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreateAdRequest400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<CreateAdRequest400ResponseViolationsInner>}
+     * @memberof CreateAdRequest400Response
+     */
+    violations: Array<CreateAdRequest400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateAdRequest400Response interface.
+ */
+export function instanceOfCreateAdRequest400Response(value: object): value is CreateAdRequest400Response {
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('violations' in value) || value['violations'] === undefined) return false;
+    return true;
+}
+
+export function CreateAdRequest400ResponseFromJSON(json: any): CreateAdRequest400Response {
+    return CreateAdRequest400ResponseFromJSONTyped(json, false);
+}
+
+export function CreateAdRequest400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAdRequest400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorCode': json['error_code'],
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+        'violations': ((json['violations'] as Array<any>).map(CreateAdRequest400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function CreateAdRequest400ResponseToJSON(json: any): CreateAdRequest400Response {
+    return CreateAdRequest400ResponseToJSONTyped(json, false);
+}
+
+export function CreateAdRequest400ResponseToJSONTyped(value?: CreateAdRequest400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error_code': value['errorCode'],
+        'message': value['message'],
+        'timestamp': value['timestamp'].toISOString(),
+        'violations': ((value['violations'] as Array<any>).map(CreateAdRequest400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/adrequest/models/CreateAdRequest400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Validation violation for a specific field
+ * @export
+ * @interface CreateAdRequest400ResponseViolationsInner
+ */
+export interface CreateAdRequest400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof CreateAdRequest400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof CreateAdRequest400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreateAdRequest400ResponseViolationsInner interface.
+ */
+export function instanceOfCreateAdRequest400ResponseViolationsInner(value: object): value is CreateAdRequest400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CreateAdRequest400ResponseViolationsInnerFromJSON(json: any): CreateAdRequest400ResponseViolationsInner {
+    return CreateAdRequest400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function CreateAdRequest400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAdRequest400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function CreateAdRequest400ResponseViolationsInnerToJSON(json: any): CreateAdRequest400ResponseViolationsInner {
+    return CreateAdRequest400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function CreateAdRequest400ResponseViolationsInnerToJSONTyped(value?: CreateAdRequest400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+

package/src/generated/adrequest/models/CreateAdRequestRequest.ts

@@ -0,0 +1,90 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Request to create an ad request
+ * @export
+ * @interface CreateAdRequestRequest
+ */
+export interface CreateAdRequestRequest {
+    /**
+     * ID of the device requesting ads
+     * @type {string}
+     * @memberof CreateAdRequestRequest
+     */
+    deviceId: string;
+    /**
+     * ID of the zone (optional, can be determined from location)
+     * @type {string}
+     * @memberof CreateAdRequestRequest
+     */
+    zoneId?: string;
+    /**
+     * Device latitude
+     * @type {number}
+     * @memberof CreateAdRequestRequest
+     */
+    latitude?: number;
+    /**
+     * Device longitude
+     * @type {number}
+     * @memberof CreateAdRequestRequest
+     */
+    longitude?: number;
+}
+
+/**
+ * Check if a given object implements the CreateAdRequestRequest interface.
+ */
+export function instanceOfCreateAdRequestRequest(value: object): value is CreateAdRequestRequest {
+    if (!('deviceId' in value) || value['deviceId'] === undefined) return false;
+    return true;
+}
+
+export function CreateAdRequestRequestFromJSON(json: any): CreateAdRequestRequest {
+    return CreateAdRequestRequestFromJSONTyped(json, false);
+}
+
+export function CreateAdRequestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAdRequestRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'deviceId': json['device_id'],
+        'zoneId': json['zone_id'] == null ? undefined : json['zone_id'],
+        'latitude': json['latitude'] == null ? undefined : json['latitude'],
+        'longitude': json['longitude'] == null ? undefined : json['longitude'],
+    };
+}
+
+export function CreateAdRequestRequestToJSON(json: any): CreateAdRequestRequest {
+    return CreateAdRequestRequestToJSONTyped(json, false);
+}
+
+export function CreateAdRequestRequestToJSONTyped(value?: CreateAdRequestRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'device_id': value['deviceId'],
+        'zone_id': value['zoneId'],
+        'latitude': value['latitude'],
+        'longitude': value['longitude'],
+    };
+}
+

package/src/generated/adrequest/models/FulfillAdRequestRequest.ts

@@ -0,0 +1,66 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Request to fulfill an ad request
+ * @export
+ * @interface FulfillAdRequestRequest
+ */
+export interface FulfillAdRequestRequest {
+    /**
+     * ID of the ad set to display
+     * @type {string}
+     * @memberof FulfillAdRequestRequest
+     */
+    adsetId: string;
+}
+
+/**
+ * Check if a given object implements the FulfillAdRequestRequest interface.
+ */
+export function instanceOfFulfillAdRequestRequest(value: object): value is FulfillAdRequestRequest {
+    if (!('adsetId' in value) || value['adsetId'] === undefined) return false;
+    return true;
+}
+
+export function FulfillAdRequestRequestFromJSON(json: any): FulfillAdRequestRequest {
+    return FulfillAdRequestRequestFromJSONTyped(json, false);
+}
+
+export function FulfillAdRequestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FulfillAdRequestRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adsetId': json['adset_id'],
+    };
+}
+
+export function FulfillAdRequestRequestToJSON(json: any): FulfillAdRequestRequest {
+    return FulfillAdRequestRequestToJSONTyped(json, false);
+}
+
+export function FulfillAdRequestRequestToJSONTyped(value?: FulfillAdRequestRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'adset_id': value['adsetId'],
+    };
+}
+