@streetlevel/api-clients 1.0.1

package/src/generated/client/docs/ClientResponse.md

@@ -0,0 +1,43 @@
+
+# ClientResponse
+
+Client information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`email` | string
+`createdAt` | Date
+`lastModifiedAt` | Date
+
+## Example
+
+```typescript
+import type { ClientResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "email": null,
+  "createdAt": null,
+  "lastModifiedAt": null,
+} satisfies ClientResponse
+
+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 ClientResponse
+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/client/docs/ClientsApi.md

@@ -0,0 +1,489 @@
+# ClientsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**assignUserToClient**](ClientsApi.md#assignusertoclient) | **POST** /clients/{client_id}/users | Assign a user to the client with a role |
+| [**createClient**](ClientsApi.md#createclientoperation) | **POST** /clients | Create a new client |
+| [**deleteClient**](ClientsApi.md#deleteclient) | **DELETE** /clients/{client_id} | Delete a client |
+| [**getClient**](ClientsApi.md#getclient) | **GET** /clients/{client_id} | Get client by ID |
+| [**listClients**](ClientsApi.md#listclients) | **GET** /clients | List all clients |
+| [**removeUserFromClient**](ClientsApi.md#removeuserfromclient) | **DELETE** /clients/{client_id}/users | Remove a user from the client |
+| [**updateClient**](ClientsApi.md#updateclientoperation) | **PUT** /clients/{client_id} | Update a client |
+
+
+
+## assignUserToClient
+
+> ClientResponse assignUserToClient(clientId, assignUserRequest)
+
+Assign a user to the client with a role
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { AssignUserToClientRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // string
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AssignUserRequest
+    assignUserRequest: ...,
+  } satisfies AssignUserToClientRequest;
+
+  try {
+    const data = await api.assignUserToClient(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` |  | [Defaults to `undefined`] |
+| **assignUserRequest** | [AssignUserRequest](AssignUserRequest.md) |  | |
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | User assigned |  -  |
+| **404** | Client 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)
+
+
+## createClient
+
+> ClientResponse createClient(createClientRequest)
+
+Create a new client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { CreateClientOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // CreateClientRequest
+    createClientRequest: ...,
+  } satisfies CreateClientOperationRequest;
+
+  try {
+    const data = await api.createClient(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createClientRequest** | [CreateClientRequest](CreateClientRequest.md) |  | |
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Client 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)
+
+
+## deleteClient
+
+> deleteClient(clientId)
+
+Delete a client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { DeleteClientRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // string
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteClientRequest;
+
+  try {
+    const data = await api.deleteClient(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `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** | Client deleted |  -  |
+| **404** | Client 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)
+
+
+## getClient
+
+> ClientResponse getClient(clientId)
+
+Get client by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { GetClientRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // string
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetClientRequest;
+
+  try {
+    const data = await api.getClient(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Client found |  -  |
+| **404** | Client 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)
+
+
+## listClients
+
+> ListClientsResponse listClients(offset, limit)
+
+List all clients
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { ListClientsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListClientsRequest;
+
+  try {
+    const data = await api.listClients(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListClientsResponse**](ListClientsResponse.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 clients |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeUserFromClient
+
+> removeUserFromClient(clientId, userId)
+
+Remove a user from the client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { RemoveUserFromClientRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // string
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies RemoveUserFromClientRequest;
+
+  try {
+    const data = await api.removeUserFromClient(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `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** | User removed |  -  |
+| **404** | Client or user 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)
+
+
+## updateClient
+
+> ClientResponse updateClient(clientId, updateClientRequest)
+
+Update a client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientsApi,
+} from '';
+import type { UpdateClientOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientsApi();
+
+  const body = {
+    // string
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateClientRequest
+    updateClientRequest: ...,
+  } satisfies UpdateClientOperationRequest;
+
+  try {
+    const data = await api.updateClient(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` |  | [Defaults to `undefined`] |
+| **updateClientRequest** | [UpdateClientRequest](UpdateClientRequest.md) |  | |
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Client updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Client 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)
+

package/src/generated/client/docs/CreateClient400Response.md

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

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

@@ -0,0 +1,37 @@
+
+# CreateClientRequest
+
+Request to create a new client
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { CreateClientRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "email": null,
+} satisfies CreateClientRequest
+
+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 CreateClientRequest
+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/client/docs/ListClientsResponse.md

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

@@ -0,0 +1,33 @@
+
+# Role
+
+User role within a client
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { Role } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies Role
+
+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 Role
+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)
+
+