@streetlevel/api-clients 1.0.1

package/src/generated/rate/docs/UpdateRateRequest.md

@@ -0,0 +1,41 @@
+
+# UpdateRateRequest
+
+Request to update a rate
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`basePrice` | number
+`period` | [RatePeriod](RatePeriod.md)
+
+## Example
+
+```typescript
+import type { UpdateRateRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "basePrice": null,
+  "period": null,
+} satisfies UpdateRateRequest
+
+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 UpdateRateRequest
+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/rate/index.ts

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

package/src/generated/rate/models/CalculatePriceRequest.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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 calculate price
+ * @export
+ * @interface CalculatePriceRequest
+ */
+export interface CalculatePriceRequest {
+    /**
+     * ID of the rate
+     * @type {string}
+     * @memberof CalculatePriceRequest
+     */
+    rateId: string;
+    /**
+     * ID of the zone (for zone-specific pricing)
+     * @type {string}
+     * @memberof CalculatePriceRequest
+     */
+    zoneId?: string;
+    /**
+     * Number of periods
+     * @type {number}
+     * @memberof CalculatePriceRequest
+     */
+    quantity: number;
+}
+
+/**
+ * Check if a given object implements the CalculatePriceRequest interface.
+ */
+export function instanceOfCalculatePriceRequest(value: object): value is CalculatePriceRequest {
+    if (!('rateId' in value) || value['rateId'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    return true;
+}
+
+export function CalculatePriceRequestFromJSON(json: any): CalculatePriceRequest {
+    return CalculatePriceRequestFromJSONTyped(json, false);
+}
+
+export function CalculatePriceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalculatePriceRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rateId': json['rate_id'],
+        'zoneId': json['zone_id'] == null ? undefined : json['zone_id'],
+        'quantity': json['quantity'],
+    };
+}
+
+export function CalculatePriceRequestToJSON(json: any): CalculatePriceRequest {
+    return CalculatePriceRequestToJSONTyped(json, false);
+}
+
+export function CalculatePriceRequestToJSONTyped(value?: CalculatePriceRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'rate_id': value['rateId'],
+        'zone_id': value['zoneId'],
+        'quantity': value['quantity'],
+    };
+}
+

package/src/generated/rate/models/CalculatePriceResponse.ts

@@ -0,0 +1,109 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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';
+/**
+ * Calculated price
+ * @export
+ * @interface CalculatePriceResponse
+ */
+export interface CalculatePriceResponse {
+    /**
+     * Base price per period
+     * @type {number}
+     * @memberof CalculatePriceResponse
+     */
+    basePrice: number;
+    /**
+     * Zone multiplier (if applicable)
+     * @type {number}
+     * @memberof CalculatePriceResponse
+     */
+    multiplier?: number;
+    /**
+     * Fixed adjustment (if applicable)
+     * @type {number}
+     * @memberof CalculatePriceResponse
+     */
+    fixedAdjustment?: number;
+    /**
+     * Final calculated price
+     * @type {number}
+     * @memberof CalculatePriceResponse
+     */
+    finalPrice: number;
+    /**
+     * Currency code
+     * @type {string}
+     * @memberof CalculatePriceResponse
+     */
+    currency: string;
+    /**
+     * Number of periods
+     * @type {number}
+     * @memberof CalculatePriceResponse
+     */
+    quantity: number;
+}
+
+/**
+ * Check if a given object implements the CalculatePriceResponse interface.
+ */
+export function instanceOfCalculatePriceResponse(value: object): value is CalculatePriceResponse {
+    if (!('basePrice' in value) || value['basePrice'] === undefined) return false;
+    if (!('finalPrice' in value) || value['finalPrice'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    return true;
+}
+
+export function CalculatePriceResponseFromJSON(json: any): CalculatePriceResponse {
+    return CalculatePriceResponseFromJSONTyped(json, false);
+}
+
+export function CalculatePriceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalculatePriceResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'basePrice': json['base_price'],
+        'multiplier': json['multiplier'] == null ? undefined : json['multiplier'],
+        'fixedAdjustment': json['fixed_adjustment'] == null ? undefined : json['fixed_adjustment'],
+        'finalPrice': json['final_price'],
+        'currency': json['currency'],
+        'quantity': json['quantity'],
+    };
+}
+
+export function CalculatePriceResponseToJSON(json: any): CalculatePriceResponse {
+    return CalculatePriceResponseToJSONTyped(json, false);
+}
+
+export function CalculatePriceResponseToJSONTyped(value?: CalculatePriceResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'base_price': value['basePrice'],
+        'multiplier': value['multiplier'],
+        'fixed_adjustment': value['fixedAdjustment'],
+        'final_price': value['finalPrice'],
+        'currency': value['currency'],
+        'quantity': value['quantity'],
+    };
+}
+

package/src/generated/rate/models/CreateRate400Response.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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 { CreateRate400ResponseViolationsInner } from './CreateRate400ResponseViolationsInner';
+import {
+    CreateRate400ResponseViolationsInnerFromJSON,
+    CreateRate400ResponseViolationsInnerFromJSONTyped,
+    CreateRate400ResponseViolationsInnerToJSON,
+    CreateRate400ResponseViolationsInnerToJSONTyped,
+} from './CreateRate400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface CreateRate400Response
+ */
+export interface CreateRate400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateRate400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateRate400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreateRate400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<CreateRate400ResponseViolationsInner>}
+     * @memberof CreateRate400Response
+     */
+    violations: Array<CreateRate400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateRate400Response interface.
+ */
+export function instanceOfCreateRate400Response(value: object): value is CreateRate400Response {
+    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 CreateRate400ResponseFromJSON(json: any): CreateRate400Response {
+    return CreateRate400ResponseFromJSONTyped(json, false);
+}
+
+export function CreateRate400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRate400Response {
+    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(CreateRate400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function CreateRate400ResponseToJSON(json: any): CreateRate400Response {
+    return CreateRate400ResponseToJSONTyped(json, false);
+}
+
+export function CreateRate400ResponseToJSONTyped(value?: CreateRate400Response | 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(CreateRate400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/rate/models/CreateRate400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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 CreateRate400ResponseViolationsInner
+ */
+export interface CreateRate400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof CreateRate400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof CreateRate400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreateRate400ResponseViolationsInner interface.
+ */
+export function instanceOfCreateRate400ResponseViolationsInner(value: object): value is CreateRate400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CreateRate400ResponseViolationsInnerFromJSON(json: any): CreateRate400ResponseViolationsInner {
+    return CreateRate400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function CreateRate400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRate400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function CreateRate400ResponseViolationsInnerToJSON(json: any): CreateRate400ResponseViolationsInner {
+    return CreateRate400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function CreateRate400ResponseViolationsInnerToJSONTyped(value?: CreateRate400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+

package/src/generated/rate/models/CreateRateRequest.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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 { RatePeriod } from './RatePeriod';
+import {
+    RatePeriodFromJSON,
+    RatePeriodFromJSONTyped,
+    RatePeriodToJSON,
+    RatePeriodToJSONTyped,
+} from './RatePeriod';
+
+/**
+ * Request to create a rate
+ * @export
+ * @interface CreateRateRequest
+ */
+export interface CreateRateRequest {
+    /**
+     * Rate name
+     * @type {string}
+     * @memberof CreateRateRequest
+     */
+    name: string;
+    /**
+     * Rate description
+     * @type {string}
+     * @memberof CreateRateRequest
+     */
+    description?: string;
+    /**
+     * Base price amount
+     * @type {number}
+     * @memberof CreateRateRequest
+     */
+    basePrice: number;
+    /**
+     * Currency code (ISO 4217)
+     * @type {string}
+     * @memberof CreateRateRequest
+     */
+    currency: string;
+    /**
+     * 
+     * @type {RatePeriod}
+     * @memberof CreateRateRequest
+     */
+    period?: RatePeriod;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateRateRequest interface.
+ */
+export function instanceOfCreateRateRequest(value: object): value is CreateRateRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('basePrice' in value) || value['basePrice'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    return true;
+}
+
+export function CreateRateRequestFromJSON(json: any): CreateRateRequest {
+    return CreateRateRequestFromJSONTyped(json, false);
+}
+
+export function CreateRateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'basePrice': json['base_price'],
+        'currency': json['currency'],
+        'period': json['period'] == null ? undefined : RatePeriodFromJSON(json['period']),
+    };
+}
+
+export function CreateRateRequestToJSON(json: any): CreateRateRequest {
+    return CreateRateRequestToJSONTyped(json, false);
+}
+
+export function CreateRateRequestToJSONTyped(value?: CreateRateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'base_price': value['basePrice'],
+        'currency': value['currency'],
+        'period': RatePeriodToJSON(value['period']),
+    };
+}
+

package/src/generated/rate/models/CreateRateZoneRequest.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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 a zone-specific rate
+ * @export
+ * @interface CreateRateZoneRequest
+ */
+export interface CreateRateZoneRequest {
+    /**
+     * ID of the zone
+     * @type {string}
+     * @memberof CreateRateZoneRequest
+     */
+    zoneId: string;
+    /**
+     * Price multiplier
+     * @type {number}
+     * @memberof CreateRateZoneRequest
+     */
+    multiplier: number;
+    /**
+     * Fixed price adjustment
+     * @type {number}
+     * @memberof CreateRateZoneRequest
+     */
+    fixedAdjustment?: number;
+}
+
+/**
+ * Check if a given object implements the CreateRateZoneRequest interface.
+ */
+export function instanceOfCreateRateZoneRequest(value: object): value is CreateRateZoneRequest {
+    if (!('zoneId' in value) || value['zoneId'] === undefined) return false;
+    if (!('multiplier' in value) || value['multiplier'] === undefined) return false;
+    return true;
+}
+
+export function CreateRateZoneRequestFromJSON(json: any): CreateRateZoneRequest {
+    return CreateRateZoneRequestFromJSONTyped(json, false);
+}
+
+export function CreateRateZoneRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRateZoneRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'zoneId': json['zone_id'],
+        'multiplier': json['multiplier'],
+        'fixedAdjustment': json['fixed_adjustment'] == null ? undefined : json['fixed_adjustment'],
+    };
+}
+
+export function CreateRateZoneRequestToJSON(json: any): CreateRateZoneRequest {
+    return CreateRateZoneRequestToJSONTyped(json, false);
+}
+
+export function CreateRateZoneRequestToJSONTyped(value?: CreateRateZoneRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'zone_id': value['zoneId'],
+        'multiplier': value['multiplier'],
+        'fixed_adjustment': value['fixedAdjustment'],
+    };
+}
+

package/src/generated/rate/models/GetRate404Response.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Rate API
+ * API for managing pricing rates
+ *
+ * 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';
+/**
+ * Standard error response
+ * @export
+ * @interface GetRate404Response
+ */
+export interface GetRate404Response {
+    /**
+     * Machine-readable error code
+     * @type {string}
+     * @memberof GetRate404Response
+     */
+    errorCode: string;
+    /**
+     * Human-readable error message
+     * @type {string}
+     * @memberof GetRate404Response
+     */
+    message: string;
+    /**
+     * Time when the error occurred
+     * @type {Date}
+     * @memberof GetRate404Response
+     */
+    timestamp: Date;
+    /**
+     * Additional error details
+     * @type {{ [key: string]: any; }}
+     * @memberof GetRate404Response
+     */
+    details?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the GetRate404Response interface.
+ */
+export function instanceOfGetRate404Response(value: object): value is GetRate404Response {
+    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;
+    return true;
+}
+
+export function GetRate404ResponseFromJSON(json: any): GetRate404Response {
+    return GetRate404ResponseFromJSONTyped(json, false);
+}
+
+export function GetRate404ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetRate404Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorCode': json['error_code'],
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+        'details': json['details'] == null ? undefined : json['details'],
+    };
+}
+
+export function GetRate404ResponseToJSON(json: any): GetRate404Response {
+    return GetRate404ResponseToJSONTyped(json, false);
+}
+
+export function GetRate404ResponseToJSONTyped(value?: GetRate404Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error_code': value['errorCode'],
+        'message': value['message'],
+        'timestamp': value['timestamp'].toISOString(),
+        'details': value['details'],
+    };
+}
+