@streetlevel/api-clients 1.0.1

package/src/generated/clientzone/docs/CreateClientZone400Response.md

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

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

@@ -0,0 +1,39 @@
+
+# CreateClientZoneItemRequest
+
+Request to add an item to a client zone
+
+## Properties
+
+Name | Type
+------------ | -------------
+`adsetId` | string
+`priority` | number
+`weight` | number
+
+## Example
+
+```typescript
+import type { CreateClientZoneItemRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "adsetId": null,
+  "priority": null,
+  "weight": null,
+} satisfies CreateClientZoneItemRequest
+
+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 CreateClientZoneItemRequest
+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/clientzone/docs/CreateClientZoneRequest.md

@@ -0,0 +1,43 @@
+
+# CreateClientZoneRequest
+
+Request to create a client zone
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`zoneId` | string
+`customName` | string
+`priority` | number
+`activeTimeRanges` | [Array<CreateClientZoneRequestActiveTimeRangesInner>](CreateClientZoneRequestActiveTimeRangesInner.md)
+
+## Example
+
+```typescript
+import type { CreateClientZoneRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "clientId": null,
+  "zoneId": null,
+  "customName": null,
+  "priority": null,
+  "activeTimeRanges": null,
+} satisfies CreateClientZoneRequest
+
+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 CreateClientZoneRequest
+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/clientzone/docs/CreateClientZoneRequestActiveTimeRangesInner.md

@@ -0,0 +1,37 @@
+
+# CreateClientZoneRequestActiveTimeRangesInner
+
+Time window for scheduling
+
+## Properties
+
+Name | Type
+------------ | -------------
+`startTime` | string
+`endTime` | string
+
+## Example
+
+```typescript
+import type { CreateClientZoneRequestActiveTimeRangesInner } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "startTime": null,
+  "endTime": null,
+} satisfies CreateClientZoneRequestActiveTimeRangesInner
+
+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 CreateClientZoneRequestActiveTimeRangesInner
+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/clientzone/docs/GetClientZone404Response.md

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

@@ -0,0 +1,35 @@
+
+# ListClientZoneItemsResponse
+
+List of client zone items
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ClientZoneItemResponse>](ClientZoneItemResponse.md)
+
+## Example
+
+```typescript
+import type { ListClientZoneItemsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies ListClientZoneItemsResponse
+
+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 ListClientZoneItemsResponse
+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/clientzone/docs/ListClientZonesResponse.md

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

@@ -0,0 +1,39 @@
+
+# UpdateClientZoneRequest
+
+Request to update a client zone
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customName` | string
+`priority` | number
+`activeTimeRanges` | [Array<CreateClientZoneRequestActiveTimeRangesInner>](CreateClientZoneRequestActiveTimeRangesInner.md)
+
+## Example
+
+```typescript
+import type { UpdateClientZoneRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "customName": null,
+  "priority": null,
+  "activeTimeRanges": null,
+} satisfies UpdateClientZoneRequest
+
+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 UpdateClientZoneRequest
+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/clientzone/index.ts

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

package/src/generated/clientzone/models/ClientZoneItemResponse.ts

@@ -0,0 +1,129 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Client Zone API
+ * API for managing client-zone assignments
+ *
+ * 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';
+/**
+ * Client zone item information
+ * @export
+ * @interface ClientZoneItemResponse
+ */
+export interface ClientZoneItemResponse {
+    /**
+     * Item unique identifier
+     * @type {string}
+     * @memberof ClientZoneItemResponse
+     */
+    id: string;
+    /**
+     * ID of the client zone
+     * @type {string}
+     * @memberof ClientZoneItemResponse
+     */
+    clientZoneId: string;
+    /**
+     * ID of the ad set
+     * @type {string}
+     * @memberof ClientZoneItemResponse
+     */
+    adsetId: string;
+    /**
+     * Display priority
+     * @type {number}
+     * @memberof ClientZoneItemResponse
+     */
+    priority: number;
+    /**
+     * Display weight
+     * @type {number}
+     * @memberof ClientZoneItemResponse
+     */
+    weight: number;
+    /**
+     * Whether item is active
+     * @type {boolean}
+     * @memberof ClientZoneItemResponse
+     */
+    active: boolean;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof ClientZoneItemResponse
+     */
+    createdAt: Date;
+    /**
+     * Last modification timestamp
+     * @type {Date}
+     * @memberof ClientZoneItemResponse
+     */
+    lastModifiedAt: Date;
+}
+
+/**
+ * Check if a given object implements the ClientZoneItemResponse interface.
+ */
+export function instanceOfClientZoneItemResponse(value: object): value is ClientZoneItemResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('clientZoneId' in value) || value['clientZoneId'] === undefined) return false;
+    if (!('adsetId' in value) || value['adsetId'] === undefined) return false;
+    if (!('priority' in value) || value['priority'] === undefined) return false;
+    if (!('weight' in value) || value['weight'] === undefined) return false;
+    if (!('active' in value) || value['active'] === 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 ClientZoneItemResponseFromJSON(json: any): ClientZoneItemResponse {
+    return ClientZoneItemResponseFromJSONTyped(json, false);
+}
+
+export function ClientZoneItemResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientZoneItemResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'clientZoneId': json['client_zone_id'],
+        'adsetId': json['adset_id'],
+        'priority': json['priority'],
+        'weight': json['weight'],
+        'active': json['active'],
+        'createdAt': (new Date(json['created_at'])),
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+    };
+}
+
+export function ClientZoneItemResponseToJSON(json: any): ClientZoneItemResponse {
+    return ClientZoneItemResponseToJSONTyped(json, false);
+}
+
+export function ClientZoneItemResponseToJSONTyped(value?: ClientZoneItemResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'client_zone_id': value['clientZoneId'],
+        'adset_id': value['adsetId'],
+        'priority': value['priority'],
+        'weight': value['weight'],
+        'active': value['active'],
+        'created_at': value['createdAt'].toISOString(),
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+    };
+}
+

package/src/generated/clientzone/models/ClientZoneResponse.ts

@@ -0,0 +1,168 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Client Zone API
+ * API for managing client-zone assignments
+ *
+ * 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 { CreateClientZoneRequestActiveTimeRangesInner } from './CreateClientZoneRequestActiveTimeRangesInner';
+import {
+    CreateClientZoneRequestActiveTimeRangesInnerFromJSON,
+    CreateClientZoneRequestActiveTimeRangesInnerFromJSONTyped,
+    CreateClientZoneRequestActiveTimeRangesInnerToJSON,
+    CreateClientZoneRequestActiveTimeRangesInnerToJSONTyped,
+} from './CreateClientZoneRequestActiveTimeRangesInner';
+import type { ClientZoneStatus } from './ClientZoneStatus';
+import {
+    ClientZoneStatusFromJSON,
+    ClientZoneStatusFromJSONTyped,
+    ClientZoneStatusToJSON,
+    ClientZoneStatusToJSONTyped,
+} from './ClientZoneStatus';
+
+/**
+ * Client zone information
+ * @export
+ * @interface ClientZoneResponse
+ */
+export interface ClientZoneResponse {
+    /**
+     * Client zone unique identifier
+     * @type {string}
+     * @memberof ClientZoneResponse
+     */
+    id: string;
+    /**
+     * ID of the client
+     * @type {string}
+     * @memberof ClientZoneResponse
+     */
+    clientId: string;
+    /**
+     * ID of the zone
+     * @type {string}
+     * @memberof ClientZoneResponse
+     */
+    zoneId: string;
+    /**
+     * Custom name for this client zone
+     * @type {string}
+     * @memberof ClientZoneResponse
+     */
+    customName?: string;
+    /**
+     * Display priority
+     * @type {number}
+     * @memberof ClientZoneResponse
+     */
+    priority?: number;
+    /**
+     * Time ranges when this client zone is active
+     * @type {Array<CreateClientZoneRequestActiveTimeRangesInner>}
+     * @memberof ClientZoneResponse
+     */
+    activeTimeRanges?: Array<CreateClientZoneRequestActiveTimeRangesInner>;
+    /**
+     * 
+     * @type {ClientZoneStatus}
+     * @memberof ClientZoneResponse
+     */
+    status: ClientZoneStatus;
+    /**
+     * Whether client zone is active (derived from status)
+     * @type {boolean}
+     * @memberof ClientZoneResponse
+     */
+    active?: boolean;
+    /**
+     * Whether client zone is active right now based on time
+     * @type {boolean}
+     * @memberof ClientZoneResponse
+     */
+    isCurrentlyActive?: boolean;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof ClientZoneResponse
+     */
+    createdAt: Date;
+    /**
+     * Last modification timestamp
+     * @type {Date}
+     * @memberof ClientZoneResponse
+     */
+    lastModifiedAt: Date;
+}
+
+
+
+/**
+ * Check if a given object implements the ClientZoneResponse interface.
+ */
+export function instanceOfClientZoneResponse(value: object): value is ClientZoneResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('clientId' in value) || value['clientId'] === undefined) return false;
+    if (!('zoneId' in value) || value['zoneId'] === 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 ClientZoneResponseFromJSON(json: any): ClientZoneResponse {
+    return ClientZoneResponseFromJSONTyped(json, false);
+}
+
+export function ClientZoneResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientZoneResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'clientId': json['client_id'],
+        'zoneId': json['zone_id'],
+        'customName': json['custom_name'] == null ? undefined : json['custom_name'],
+        'priority': json['priority'] == null ? undefined : json['priority'],
+        'activeTimeRanges': json['active_time_ranges'] == null ? undefined : ((json['active_time_ranges'] as Array<any>).map(CreateClientZoneRequestActiveTimeRangesInnerFromJSON)),
+        'status': ClientZoneStatusFromJSON(json['status']),
+        'active': json['active'] == null ? undefined : json['active'],
+        'isCurrentlyActive': json['is_currently_active'] == null ? undefined : json['is_currently_active'],
+        'createdAt': (new Date(json['created_at'])),
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+    };
+}
+
+export function ClientZoneResponseToJSON(json: any): ClientZoneResponse {
+    return ClientZoneResponseToJSONTyped(json, false);
+}
+
+export function ClientZoneResponseToJSONTyped(value?: ClientZoneResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'client_id': value['clientId'],
+        'zone_id': value['zoneId'],
+        'custom_name': value['customName'],
+        'priority': value['priority'],
+        'active_time_ranges': value['activeTimeRanges'] == null ? undefined : ((value['activeTimeRanges'] as Array<any>).map(CreateClientZoneRequestActiveTimeRangesInnerToJSON)),
+        'status': ClientZoneStatusToJSON(value['status']),
+        'active': value['active'],
+        'is_currently_active': value['isCurrentlyActive'],
+        'created_at': value['createdAt'].toISOString(),
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+    };
+}
+