@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,761 @@
+# RatesApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateRate**](RatesApi.md#activaterate) | **POST** /rates/{rate_id}/activate | Activate a rate |
+| [**calculatePrice**](RatesApi.md#calculatepriceoperation) | **POST** /rates/calculate | Calculate price for ad display |
+| [**createRate**](RatesApi.md#createrateoperation) | **POST** /rates | Create a new rate |
+| [**createRateZone**](RatesApi.md#createratezoneoperation) | **POST** /rates/{rate_id}/zones | Create a zone-specific rate |
+| [**deactivateRate**](RatesApi.md#deactivaterate) | **POST** /rates/{rate_id}/deactivate | Deactivate a rate |
+| [**deleteRate**](RatesApi.md#deleterate) | **DELETE** /rates/{rate_id} | Delete a rate |
+| [**deleteRateZone**](RatesApi.md#deleteratezone) | **DELETE** /rates/{rate_id}/zones/{rate_zone_id} | Delete a zone-specific rate |
+| [**getRate**](RatesApi.md#getrate) | **GET** /rates/{rate_id} | Get rate by ID |
+| [**listRateZones**](RatesApi.md#listratezones) | **GET** /rates/{rate_id}/zones | List zone-specific rates |
+| [**listRates**](RatesApi.md#listrates) | **GET** /rates | List rates |
+| [**updateRate**](RatesApi.md#updaterateoperation) | **PUT** /rates/{rate_id} | Update a rate |
+
+
+
+## activateRate
+
+> RateResponse activateRate(rateId)
+
+Activate a rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { ActivateRateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateRateRequest;
+
+  try {
+    const data = await api.activateRate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**RateResponse**](RateResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rate activated |  -  |
+| **404** | Rate 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)
+
+
+## calculatePrice
+
+> CalculatePriceResponse calculatePrice(calculatePriceRequest)
+
+Calculate price for ad display
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { CalculatePriceOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // CalculatePriceRequest
+    calculatePriceRequest: ...,
+  } satisfies CalculatePriceOperationRequest;
+
+  try {
+    const data = await api.calculatePrice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **calculatePriceRequest** | [CalculatePriceRequest](CalculatePriceRequest.md) |  | |
+
+### Return type
+
+[**CalculatePriceResponse**](CalculatePriceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Price calculated |  -  |
+| **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)
+
+
+## createRate
+
+> RateResponse createRate(createRateRequest)
+
+Create a new rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { CreateRateOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // CreateRateRequest
+    createRateRequest: ...,
+  } satisfies CreateRateOperationRequest;
+
+  try {
+    const data = await api.createRate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createRateRequest** | [CreateRateRequest](CreateRateRequest.md) |  | |
+
+### Return type
+
+[**RateResponse**](RateResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Rate 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)
+
+
+## createRateZone
+
+> RateZoneResponse createRateZone(rateId, createRateZoneRequest)
+
+Create a zone-specific rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { CreateRateZoneOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CreateRateZoneRequest
+    createRateZoneRequest: ...,
+  } satisfies CreateRateZoneOperationRequest;
+
+  try {
+    const data = await api.createRateZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+| **createRateZoneRequest** | [CreateRateZoneRequest](CreateRateZoneRequest.md) |  | |
+
+### Return type
+
+[**RateZoneResponse**](RateZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Rate zone created |  -  |
+| **400** | Validation error |  -  |
+| **404** | Rate 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)
+
+
+## deactivateRate
+
+> RateResponse deactivateRate(rateId)
+
+Deactivate a rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { DeactivateRateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeactivateRateRequest;
+
+  try {
+    const data = await api.deactivateRate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**RateResponse**](RateResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rate deactivated |  -  |
+| **404** | Rate 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)
+
+
+## deleteRate
+
+> deleteRate(rateId)
+
+Delete a rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { DeleteRateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteRateRequest;
+
+  try {
+    const data = await api.deleteRate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Rate deleted |  -  |
+| **404** | Rate 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)
+
+
+## deleteRateZone
+
+> deleteRateZone(rateId, rateZoneId)
+
+Delete a zone-specific rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { DeleteRateZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    rateZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteRateZoneRequest;
+
+  try {
+    const data = await api.deleteRateZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+| **rateZoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Rate zone deleted |  -  |
+| **404** | Rate zone 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)
+
+
+## getRate
+
+> RateResponse getRate(rateId)
+
+Get rate by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { GetRateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetRateRequest;
+
+  try {
+    const data = await api.getRate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**RateResponse**](RateResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rate found |  -  |
+| **404** | Rate 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)
+
+
+## listRateZones
+
+> ListRateZonesResponse listRateZones(rateId)
+
+List zone-specific rates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { ListRateZonesRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ListRateZonesRequest;
+
+  try {
+    const data = await api.listRateZones(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ListRateZonesResponse**](ListRateZonesResponse.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 rate zones |  -  |
+| **404** | Rate 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)
+
+
+## listRates
+
+> ListRatesResponse listRates(active, offset, limit)
+
+List rates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { ListRatesRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // boolean | Filter by active status (optional)
+    active: true,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListRatesRequest;
+
+  try {
+    const data = await api.listRates(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **active** | `boolean` | Filter by active status | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListRatesResponse**](ListRatesResponse.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 rates |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateRate
+
+> RateResponse updateRate(rateId, updateRateRequest)
+
+Update a rate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RatesApi,
+} from '';
+import type { UpdateRateOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RatesApi();
+
+  const body = {
+    // string
+    rateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateRateRequest
+    updateRateRequest: ...,
+  } satisfies UpdateRateOperationRequest;
+
+  try {
+    const data = await api.updateRate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rateId** | `string` |  | [Defaults to `undefined`] |
+| **updateRateRequest** | [UpdateRateRequest](UpdateRateRequest.md) |  | |
+
+### Return type
+
+[**RateResponse**](RateResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rate updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Rate 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)
+