@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,430 @@
+# AdRequestsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelAdRequest**](AdRequestsApi.md#canceladrequest) | **POST** /ad-requests/{request_id}/cancel | Cancel an ad request |
+| [**createAdRequest**](AdRequestsApi.md#createadrequestoperation) | **POST** /ad-requests | Create a new ad request |
+| [**fulfillAdRequest**](AdRequestsApi.md#fulfilladrequestoperation) | **POST** /ad-requests/{request_id}/fulfill | Fulfill an ad request with an ad set |
+| [**getAdRequest**](AdRequestsApi.md#getadrequest) | **GET** /ad-requests/{request_id} | Get ad request by ID |
+| [**getNextAds**](AdRequestsApi.md#getnextadsoperation) | **POST** /ad-requests/next | Get next ads to display for a device |
+| [**listAdRequests**](AdRequestsApi.md#listadrequests) | **GET** /ad-requests | List ad requests |
+
+
+
+## cancelAdRequest
+
+> AdRequestResponse cancelAdRequest(requestId)
+
+Cancel an ad request
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdRequestsApi,
+} from '';
+import type { CancelAdRequestRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdRequestsApi();
+
+  const body = {
+    // string
+    requestId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CancelAdRequestRequest;
+
+  try {
+    const data = await api.cancelAdRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **requestId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdRequestResponse**](AdRequestResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad request cancelled |  -  |
+| **404** | Ad request not found |  -  |
+| **409** | Invalid ad request state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createAdRequest
+
+> AdRequestResponse createAdRequest(createAdRequestRequest)
+
+Create a new ad request
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdRequestsApi,
+} from '';
+import type { CreateAdRequestOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdRequestsApi();
+
+  const body = {
+    // CreateAdRequestRequest
+    createAdRequestRequest: ...,
+  } satisfies CreateAdRequestOperationRequest;
+
+  try {
+    const data = await api.createAdRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAdRequestRequest** | [CreateAdRequestRequest](CreateAdRequestRequest.md) |  | |
+
+### Return type
+
+[**AdRequestResponse**](AdRequestResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Ad request created |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## fulfillAdRequest
+
+> AdRequestResponse fulfillAdRequest(requestId, fulfillAdRequestRequest)
+
+Fulfill an ad request with an ad set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdRequestsApi,
+} from '';
+import type { FulfillAdRequestOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdRequestsApi();
+
+  const body = {
+    // string
+    requestId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // FulfillAdRequestRequest
+    fulfillAdRequestRequest: ...,
+  } satisfies FulfillAdRequestOperationRequest;
+
+  try {
+    const data = await api.fulfillAdRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **requestId** | `string` |  | [Defaults to `undefined`] |
+| **fulfillAdRequestRequest** | [FulfillAdRequestRequest](FulfillAdRequestRequest.md) |  | |
+
+### Return type
+
+[**AdRequestResponse**](AdRequestResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad request fulfilled |  -  |
+| **400** | Validation error |  -  |
+| **404** | Ad request not found |  -  |
+| **409** | Invalid ad request state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAdRequest
+
+> AdRequestResponse getAdRequest(requestId)
+
+Get ad request by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdRequestsApi,
+} from '';
+import type { GetAdRequestRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdRequestsApi();
+
+  const body = {
+    // string
+    requestId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdRequestRequest;
+
+  try {
+    const data = await api.getAdRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **requestId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdRequestResponse**](AdRequestResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad request found |  -  |
+| **404** | Ad request not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNextAds
+
+> NextAdsResponse getNextAds(getNextAdsRequest)
+
+Get next ads to display for a device
+
+Called by devices to get the next ad set to display. Automatically creates an ad request, finds matching ads, and fulfills it. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdRequestsApi,
+} from '';
+import type { GetNextAdsOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdRequestsApi();
+
+  const body = {
+    // GetNextAdsRequest
+    getNextAdsRequest: ...,
+  } satisfies GetNextAdsOperationRequest;
+
+  try {
+    const data = await api.getNextAds(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getNextAdsRequest** | [GetNextAdsRequest](GetNextAdsRequest.md) |  | |
+
+### Return type
+
+[**NextAdsResponse**](NextAdsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ads to display |  -  |
+| **400** | Validation error |  -  |
+| **404** | Device not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listAdRequests
+
+> ListAdRequestsResponse listAdRequests(deviceId, zoneId, status, offset, limit)
+
+List ad requests
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdRequestsApi,
+} from '';
+import type { ListAdRequestsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdRequestsApi();
+
+  const body = {
+    // string | Filter by device ID (optional)
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Filter by zone ID (optional)
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AdRequestStatus (optional)
+    status: ...,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListAdRequestsRequest;
+
+  try {
+    const data = await api.listAdRequests(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` | Filter by device ID | [Optional] [Defaults to `undefined`] |
+| **zoneId** | `string` | Filter by zone ID | [Optional] [Defaults to `undefined`] |
+| **status** | `AdRequestStatus` |  | [Optional] [Defaults to `undefined`] [Enum: PENDING, FULFILLED, EXPIRED, CANCELLED] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListAdRequestsResponse**](ListAdRequestsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of ad requests |  -  |
+
+[[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/CreateAdRequest400Response.md

@@ -0,0 +1,41 @@
+
+# CreateAdRequest400Response
+
+Validation error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`violations` | [Array<CreateAdRequest400ResponseViolationsInner>](CreateAdRequest400ResponseViolationsInner.md)
+
+## Example
+
+```typescript
+import type { CreateAdRequest400Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": VALIDATION_ERROR,
+  "message": null,
+  "timestamp": null,
+  "violations": null,
+} satisfies CreateAdRequest400Response
+
+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 CreateAdRequest400Response
+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/CreateAdRequest400ResponseViolationsInner.md

@@ -0,0 +1,37 @@
+
+# CreateAdRequest400ResponseViolationsInner
+
+Validation violation for a specific field
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CreateAdRequest400ResponseViolationsInner } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "field": null,
+  "message": null,
+} satisfies CreateAdRequest400ResponseViolationsInner
+
+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 CreateAdRequest400ResponseViolationsInner
+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/CreateAdRequestRequest.md

@@ -0,0 +1,41 @@
+
+# CreateAdRequestRequest
+
+Request to create an ad request
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceId` | string
+`zoneId` | string
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { CreateAdRequestRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceId": null,
+  "zoneId": null,
+  "latitude": null,
+  "longitude": null,
+} satisfies CreateAdRequestRequest
+
+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 CreateAdRequestRequest
+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/FulfillAdRequestRequest.md

@@ -0,0 +1,35 @@
+
+# FulfillAdRequestRequest
+
+Request to fulfill an ad request
+
+## Properties
+
+Name | Type
+------------ | -------------
+`adsetId` | string
+
+## Example
+
+```typescript
+import type { FulfillAdRequestRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "adsetId": null,
+} satisfies FulfillAdRequestRequest
+
+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 FulfillAdRequestRequest
+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/GetAdRequest404Response.md

@@ -0,0 +1,41 @@
+
+# GetAdRequest404Response
+
+Standard error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetAdRequest404Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": null,
+  "message": null,
+  "timestamp": null,
+  "details": null,
+} satisfies GetAdRequest404Response
+
+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 GetAdRequest404Response
+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/GetNextAdsRequest.md

@@ -0,0 +1,39 @@
+
+# GetNextAdsRequest
+
+Request to get next ads for a device
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceId` | string
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { GetNextAdsRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceId": null,
+  "latitude": null,
+  "longitude": null,
+} satisfies GetNextAdsRequest
+
+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 GetNextAdsRequest
+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/ListAdRequestsResponse.md

@@ -0,0 +1,41 @@
+
+# ListAdRequestsResponse
+
+Paginated list of ad requests
+
+## Properties
+
+Name | Type
+------------ | -------------
+`adRequests` | [Array<AdRequestResponse>](AdRequestResponse.md)
+`total` | number
+`offset` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { ListAdRequestsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "adRequests": null,
+  "total": null,
+  "offset": null,
+  "limit": null,
+} satisfies ListAdRequestsResponse
+
+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 ListAdRequestsResponse
+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)
+
+