@streetlevel/api-clients 1.0.1

package/src/generated/campaign/docs/CreateCampaign400ResponseViolationsInner.md

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

@@ -0,0 +1,45 @@
+
+# CreateCampaignRequest
+
+Request to create a campaign
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`name` | string
+`description` | string
+`startDate` | Date
+`endDate` | Date
+`budget` | number
+
+## Example
+
+```typescript
+import type { CreateCampaignRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "clientId": null,
+  "name": null,
+  "description": null,
+  "startDate": null,
+  "endDate": null,
+  "budget": null,
+} satisfies CreateCampaignRequest
+
+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 CreateCampaignRequest
+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/campaign/docs/GetCampaign404Response.md

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

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

@@ -0,0 +1,43 @@
+
+# UpdateCampaignRequest
+
+Request to update a campaign
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`startDate` | Date
+`endDate` | Date
+`budget` | number
+
+## Example
+
+```typescript
+import type { UpdateCampaignRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "startDate": null,
+  "endDate": null,
+  "budget": null,
+} satisfies UpdateCampaignRequest
+
+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 UpdateCampaignRequest
+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/campaign/index.ts

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

package/src/generated/campaign/models/CampaignResponse.ts

@@ -0,0 +1,155 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Campaign API
+ * API for managing advertising campaigns
+ *
+ * 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 { CampaignStatus } from './CampaignStatus';
+import {
+    CampaignStatusFromJSON,
+    CampaignStatusFromJSONTyped,
+    CampaignStatusToJSON,
+    CampaignStatusToJSONTyped,
+} from './CampaignStatus';
+
+/**
+ * Campaign information
+ * @export
+ * @interface CampaignResponse
+ */
+export interface CampaignResponse {
+    /**
+     * Campaign unique identifier
+     * @type {string}
+     * @memberof CampaignResponse
+     */
+    id: string;
+    /**
+     * Owning client ID
+     * @type {string}
+     * @memberof CampaignResponse
+     */
+    clientId: string;
+    /**
+     * Campaign name
+     * @type {string}
+     * @memberof CampaignResponse
+     */
+    name: string;
+    /**
+     * Campaign description
+     * @type {string}
+     * @memberof CampaignResponse
+     */
+    description?: string;
+    /**
+     * Campaign start date
+     * @type {Date}
+     * @memberof CampaignResponse
+     */
+    startDate: Date;
+    /**
+     * Campaign end date
+     * @type {Date}
+     * @memberof CampaignResponse
+     */
+    endDate: Date;
+    /**
+     * Campaign budget
+     * @type {number}
+     * @memberof CampaignResponse
+     */
+    budget?: number;
+    /**
+     * 
+     * @type {CampaignStatus}
+     * @memberof CampaignResponse
+     */
+    status: CampaignStatus;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof CampaignResponse
+     */
+    createdAt: Date;
+    /**
+     * Last modification timestamp
+     * @type {Date}
+     * @memberof CampaignResponse
+     */
+    lastModifiedAt: Date;
+}
+
+
+
+/**
+ * Check if a given object implements the CampaignResponse interface.
+ */
+export function instanceOfCampaignResponse(value: object): value is CampaignResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('clientId' in value) || value['clientId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('endDate' in value) || value['endDate'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('lastModifiedAt' in value) || value['lastModifiedAt'] === undefined) return false;
+    return true;
+}
+
+export function CampaignResponseFromJSON(json: any): CampaignResponse {
+    return CampaignResponseFromJSONTyped(json, false);
+}
+
+export function CampaignResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'clientId': json['client_id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'startDate': (new Date(json['start_date'])),
+        'endDate': (new Date(json['end_date'])),
+        'budget': json['budget'] == null ? undefined : json['budget'],
+        'status': CampaignStatusFromJSON(json['status']),
+        'createdAt': (new Date(json['created_at'])),
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+    };
+}
+
+export function CampaignResponseToJSON(json: any): CampaignResponse {
+    return CampaignResponseToJSONTyped(json, false);
+}
+
+export function CampaignResponseToJSONTyped(value?: CampaignResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'client_id': value['clientId'],
+        'name': value['name'],
+        'description': value['description'],
+        'start_date': value['startDate'].toISOString().substring(0,10),
+        'end_date': value['endDate'].toISOString().substring(0,10),
+        'budget': value['budget'],
+        'status': CampaignStatusToJSON(value['status']),
+        'created_at': value['createdAt'].toISOString(),
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+    };
+}
+

package/src/generated/campaign/models/CampaignStatus.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Campaign API
+ * API for managing advertising campaigns
+ *
+ * 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.
+ */
+
+
+/**
+ * Campaign lifecycle status
+ * @export
+ */
+export const CampaignStatus = {
+    Draft: 'DRAFT',
+    PendingApproval: 'PENDING_APPROVAL',
+    Active: 'ACTIVE',
+    Paused: 'PAUSED',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED'
+} as const;
+export type CampaignStatus = typeof CampaignStatus[keyof typeof CampaignStatus];
+
+
+export function instanceOfCampaignStatus(value: any): boolean {
+    for (const key in CampaignStatus) {
+        if (Object.prototype.hasOwnProperty.call(CampaignStatus, key)) {
+            if (CampaignStatus[key as keyof typeof CampaignStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CampaignStatusFromJSON(json: any): CampaignStatus {
+    return CampaignStatusFromJSONTyped(json, false);
+}
+
+export function CampaignStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignStatus {
+    return json as CampaignStatus;
+}
+
+export function CampaignStatusToJSON(value?: CampaignStatus | null): any {
+    return value as any;
+}
+
+export function CampaignStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): CampaignStatus {
+    return value as CampaignStatus;
+}
+

package/src/generated/campaign/models/CreateCampaign400Response.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Campaign API
+ * API for managing advertising campaigns
+ *
+ * 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 { CreateCampaign400ResponseViolationsInner } from './CreateCampaign400ResponseViolationsInner';
+import {
+    CreateCampaign400ResponseViolationsInnerFromJSON,
+    CreateCampaign400ResponseViolationsInnerFromJSONTyped,
+    CreateCampaign400ResponseViolationsInnerToJSON,
+    CreateCampaign400ResponseViolationsInnerToJSONTyped,
+} from './CreateCampaign400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface CreateCampaign400Response
+ */
+export interface CreateCampaign400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCampaign400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCampaign400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreateCampaign400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<CreateCampaign400ResponseViolationsInner>}
+     * @memberof CreateCampaign400Response
+     */
+    violations: Array<CreateCampaign400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateCampaign400Response interface.
+ */
+export function instanceOfCreateCampaign400Response(value: object): value is CreateCampaign400Response {
+    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 CreateCampaign400ResponseFromJSON(json: any): CreateCampaign400Response {
+    return CreateCampaign400ResponseFromJSONTyped(json, false);
+}
+
+export function CreateCampaign400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCampaign400Response {
+    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(CreateCampaign400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function CreateCampaign400ResponseToJSON(json: any): CreateCampaign400Response {
+    return CreateCampaign400ResponseToJSONTyped(json, false);
+}
+
+export function CreateCampaign400ResponseToJSONTyped(value?: CreateCampaign400Response | 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(CreateCampaign400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/campaign/models/CreateCampaign400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Campaign API
+ * API for managing advertising campaigns
+ *
+ * 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 CreateCampaign400ResponseViolationsInner
+ */
+export interface CreateCampaign400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof CreateCampaign400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof CreateCampaign400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreateCampaign400ResponseViolationsInner interface.
+ */
+export function instanceOfCreateCampaign400ResponseViolationsInner(value: object): value is CreateCampaign400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CreateCampaign400ResponseViolationsInnerFromJSON(json: any): CreateCampaign400ResponseViolationsInner {
+    return CreateCampaign400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function CreateCampaign400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCampaign400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function CreateCampaign400ResponseViolationsInnerToJSON(json: any): CreateCampaign400ResponseViolationsInner {
+    return CreateCampaign400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function CreateCampaign400ResponseViolationsInnerToJSONTyped(value?: CreateCampaign400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+