@streetlevel/api-clients 1.0.1

package/src/generated/client/apis/ClientsApi.ts

@@ -0,0 +1,604 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Client API
+ * API for managing advertising clients
+ *
+ * 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 * as runtime from '../runtime';
+import type {
+  AssignUserRequest,
+  AssignUserToClient404Response,
+  ClientResponse,
+  CreateClient400Response,
+  CreateClientRequest,
+  ListClientsResponse,
+  UpdateClientRequest,
+} from '../models/index';
+import {
+    AssignUserRequestFromJSON,
+    AssignUserRequestToJSON,
+    AssignUserToClient404ResponseFromJSON,
+    AssignUserToClient404ResponseToJSON,
+    ClientResponseFromJSON,
+    ClientResponseToJSON,
+    CreateClient400ResponseFromJSON,
+    CreateClient400ResponseToJSON,
+    CreateClientRequestFromJSON,
+    CreateClientRequestToJSON,
+    ListClientsResponseFromJSON,
+    ListClientsResponseToJSON,
+    UpdateClientRequestFromJSON,
+    UpdateClientRequestToJSON,
+} from '../models/index';
+
+export interface AssignUserToClientRequest {
+    clientId: string;
+    assignUserRequest: AssignUserRequest;
+}
+
+export interface CreateClientOperationRequest {
+    createClientRequest: CreateClientRequest;
+}
+
+export interface DeleteClientRequest {
+    clientId: string;
+}
+
+export interface GetClientRequest {
+    clientId: string;
+}
+
+export interface ListClientsRequest {
+    offset?: number;
+    limit?: number;
+}
+
+export interface RemoveUserFromClientRequest {
+    clientId: string;
+    userId: string;
+}
+
+export interface UpdateClientOperationRequest {
+    clientId: string;
+    updateClientRequest: UpdateClientRequest;
+}
+
+/**
+ * ClientsApi - interface
+ * 
+ * @export
+ * @interface ClientsApiInterface
+ */
+export interface ClientsApiInterface {
+    /**
+     * Creates request options for assignUserToClient without sending the request
+     * @param {string} clientId 
+     * @param {AssignUserRequest} assignUserRequest 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    assignUserToClientRequestOpts(requestParameters: AssignUserToClientRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Assign a user to the client with a role
+     * @param {string} clientId 
+     * @param {AssignUserRequest} assignUserRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    assignUserToClientRaw(requestParameters: AssignUserToClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>>;
+
+    /**
+     * Assign a user to the client with a role
+     */
+    assignUserToClient(requestParameters: AssignUserToClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse>;
+
+    /**
+     * Creates request options for createClient without sending the request
+     * @param {CreateClientRequest} createClientRequest 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    createClientRequestOpts(requestParameters: CreateClientOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Create a new client
+     * @param {CreateClientRequest} createClientRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    createClientRaw(requestParameters: CreateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>>;
+
+    /**
+     * Create a new client
+     */
+    createClient(requestParameters: CreateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse>;
+
+    /**
+     * Creates request options for deleteClient without sending the request
+     * @param {string} clientId 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    deleteClientRequestOpts(requestParameters: DeleteClientRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Delete a client
+     * @param {string} clientId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    deleteClientRaw(requestParameters: DeleteClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a client
+     */
+    deleteClient(requestParameters: DeleteClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for getClient without sending the request
+     * @param {string} clientId 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    getClientRequestOpts(requestParameters: GetClientRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get client by ID
+     * @param {string} clientId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    getClientRaw(requestParameters: GetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>>;
+
+    /**
+     * Get client by ID
+     */
+    getClient(requestParameters: GetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse>;
+
+    /**
+     * Creates request options for listClients without sending the request
+     * @param {number} [offset] 
+     * @param {number} [limit] 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    listClientsRequestOpts(requestParameters: ListClientsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List all clients
+     * @param {number} [offset] 
+     * @param {number} [limit] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    listClientsRaw(requestParameters: ListClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListClientsResponse>>;
+
+    /**
+     * List all clients
+     */
+    listClients(requestParameters: ListClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListClientsResponse>;
+
+    /**
+     * Creates request options for removeUserFromClient without sending the request
+     * @param {string} clientId 
+     * @param {string} userId 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    removeUserFromClientRequestOpts(requestParameters: RemoveUserFromClientRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Remove a user from the client
+     * @param {string} clientId 
+     * @param {string} userId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    removeUserFromClientRaw(requestParameters: RemoveUserFromClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Remove a user from the client
+     */
+    removeUserFromClient(requestParameters: RemoveUserFromClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for updateClient without sending the request
+     * @param {string} clientId 
+     * @param {UpdateClientRequest} updateClientRequest 
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    updateClientRequestOpts(requestParameters: UpdateClientOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Update a client
+     * @param {string} clientId 
+     * @param {UpdateClientRequest} updateClientRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientsApiInterface
+     */
+    updateClientRaw(requestParameters: UpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>>;
+
+    /**
+     * Update a client
+     */
+    updateClient(requestParameters: UpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ClientsApi extends runtime.BaseAPI implements ClientsApiInterface {
+
+    /**
+     * Creates request options for assignUserToClient without sending the request
+     */
+    async assignUserToClientRequestOpts(requestParameters: AssignUserToClientRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling assignUserToClient().'
+            );
+        }
+
+        if (requestParameters['assignUserRequest'] == null) {
+            throw new runtime.RequiredError(
+                'assignUserRequest',
+                'Required parameter "assignUserRequest" was null or undefined when calling assignUserToClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/clients/{client_id}/users`;
+        urlPath = urlPath.replace(`{${"client_id"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AssignUserRequestToJSON(requestParameters['assignUserRequest']),
+        };
+    }
+
+    /**
+     * Assign a user to the client with a role
+     */
+    async assignUserToClientRaw(requestParameters: AssignUserToClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>> {
+        const requestOptions = await this.assignUserToClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Assign a user to the client with a role
+     */
+    async assignUserToClient(requestParameters: AssignUserToClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse> {
+        const response = await this.assignUserToClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createClient without sending the request
+     */
+    async createClientRequestOpts(requestParameters: CreateClientOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createClientRequest',
+                'Required parameter "createClientRequest" was null or undefined when calling createClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/clients`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateClientRequestToJSON(requestParameters['createClientRequest']),
+        };
+    }
+
+    /**
+     * Create a new client
+     */
+    async createClientRaw(requestParameters: CreateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>> {
+        const requestOptions = await this.createClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new client
+     */
+    async createClient(requestParameters: CreateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse> {
+        const response = await this.createClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteClient without sending the request
+     */
+    async deleteClientRequestOpts(requestParameters: DeleteClientRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling deleteClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/clients/{client_id}`;
+        urlPath = urlPath.replace(`{${"client_id"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete a client
+     */
+    async deleteClientRaw(requestParameters: DeleteClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a client
+     */
+    async deleteClient(requestParameters: DeleteClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteClientRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getClient without sending the request
+     */
+    async getClientRequestOpts(requestParameters: GetClientRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling getClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/clients/{client_id}`;
+        urlPath = urlPath.replace(`{${"client_id"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get client by ID
+     */
+    async getClientRaw(requestParameters: GetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>> {
+        const requestOptions = await this.getClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get client by ID
+     */
+    async getClient(requestParameters: GetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse> {
+        const response = await this.getClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listClients without sending the request
+     */
+    async listClientsRequestOpts(requestParameters: ListClientsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/clients`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List all clients
+     */
+    async listClientsRaw(requestParameters: ListClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListClientsResponse>> {
+        const requestOptions = await this.listClientsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListClientsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all clients
+     */
+    async listClients(requestParameters: ListClientsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListClientsResponse> {
+        const response = await this.listClientsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for removeUserFromClient without sending the request
+     */
+    async removeUserFromClientRequestOpts(requestParameters: RemoveUserFromClientRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling removeUserFromClient().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling removeUserFromClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['user_id'] = requestParameters['userId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/clients/{client_id}/users`;
+        urlPath = urlPath.replace(`{${"client_id"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove a user from the client
+     */
+    async removeUserFromClientRaw(requestParameters: RemoveUserFromClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.removeUserFromClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove a user from the client
+     */
+    async removeUserFromClient(requestParameters: RemoveUserFromClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.removeUserFromClientRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for updateClient without sending the request
+     */
+    async updateClientRequestOpts(requestParameters: UpdateClientOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling updateClient().'
+            );
+        }
+
+        if (requestParameters['updateClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateClientRequest',
+                'Required parameter "updateClientRequest" was null or undefined when calling updateClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/clients/{client_id}`;
+        urlPath = urlPath.replace(`{${"client_id"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateClientRequestToJSON(requestParameters['updateClientRequest']),
+        };
+    }
+
+    /**
+     * Update a client
+     */
+    async updateClientRaw(requestParameters: UpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientResponse>> {
+        const requestOptions = await this.updateClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a client
+     */
+    async updateClient(requestParameters: UpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientResponse> {
+        const response = await this.updateClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/generated/client/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ClientsApi';

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

@@ -0,0 +1,37 @@
+
+# AssignUserRequest
+
+Request to assign a user to a client
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`role` | [Role](Role.md)
+
+## Example
+
+```typescript
+import type { AssignUserRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "role": null,
+} satisfies AssignUserRequest
+
+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 AssignUserRequest
+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/AssignUserToClient404Response.md

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