repzo 1.0.141 → 1.0.142

package/docs/api/checks.md

@@ -6,157 +6,87 @@ OpenAPI specification for Repzo Checks endpoints.
 
 ## Overview
 
-
 ### Base URLs
 
-- ****: `https://sv.api.repzo.me`
-
-
-
-
+- \*\*\*\*: `https://sv.api.repzo.me`
 
 ## Authentication
 
-
 No authentication required.
 
-
 ## Endpoints
 
-
 ### `/checks`
 
-
 #### GET /checks
 
 **Summary:** Find checks
 
-
-
-
-
-
 ##### Parameters
 
 | Name | Location | Type | Required | Description |
-|------|----------|------|----------|-------------|
-
-| `params` | query | object | No | Query parameters for filtering checks |
-
-
+| ---- | -------- | ---- | -------- | ----------- |
 
 
+| `params` | query | object | No | Query parameters for filtering checks |
 
 ##### Responses
 
-
 **200** - A list of checks
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
 #### POST /checks
 
 **Summary:** Create a check
 
-
-
-
-
-
-
-
 ##### Request Body
 
-
-
-
 **Content Types:**
 
 - `application/json`
 
-
-
-
 ##### Responses
 
-
 **201** - Check created
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
-
 ### `/checks/{id}`
 
-
 #### GET /checks/{id}
 
 **Summary:** Get a check by ID
 
-
-
-
-
-
 ##### Parameters
 
 | Name | Location | Type | Required | Description |
-|------|----------|------|----------|-------------|
-
-| `id` | path | string | Yes | No description |
-
-
+| ---- | -------- | ---- | -------- | ----------- |
 
 
+| `id` | path | string | Yes | No description |
 
 ##### Responses
 
-
 **200** - Check details
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
-
-
 ## Data Models
 
-
-
 ### CheckFindResult
 
-
 Result of finding checks
 
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `data` | array | No | No description |
 
@@ -170,20 +100,13 @@ Result of finding checks
 
 | `per_page` | number | No | Number of checks per page |
 
-
-
-
-
-
 ### CheckSchema
 
-
 Check schema
 
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `_id` | string | No | Unique identifier for the check |
 
@@ -219,20 +142,13 @@ Check schema
 
 | `__v` | number | No | Version number |
 
-
-
-
-
-
 ### CheckCreateBody
 
-
 Body for creating a check
 
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `client` | string | Yes | Client ID associated with the check |
 
@@ -254,35 +170,14 @@ Body for creating a check
 
 | `integration_meta` | object | No | Integration metadata |
 
-
-
-
-
-
 ### CheckCreateResult
 
-
 Result of creating a check
 
-
-
-
-
-
-
 ### CheckGetResult
 
-
 Result of getting a check
 
-
-
-
-
-
-
-
-
 ## TypeScript Usage
 
-See [checks-examples.md](./checks-examples.md) for detailed TypeScript usage examples.
+See [checks-examples.md](./checks-examples.md) for detailed TypeScript usage examples.

package/docs/api/client-channel-examples.md

@@ -11,38 +11,32 @@ npm install repzo
 ## Basic Setup
 
 ```typescript
-import { Service } from 'repzo';
+import { Service } from "repzo";
 
 // Initialize with your API key
-const apiKey = 'your-api-key';
-const baseURL = 'https://api.repzo.me/v1';
+const apiKey = "your-api-key";
+const baseURL = "https://api.repzo.me/v1";
 ```
 
 ## API Usage Examples
 
-
-
 ### Get all client channels
 
-
 Retrieve a list of all client channels with optional filtering and pagination
 
-
 ```typescript
-
 // GET /client-channel
 
 const params = {
-
   page: 1, // Page number for pagination
 
   per_page: 1, // Number of items per page
 
-  sort: 'example-value', // Sort field
+  sort: "example-value", // Sort field
 
   _id: null, // Filter by channel ID(s)
 
-  search: 'example-value', // Search text for channel name
+  search: "example-value", // Search text for channel name
 
   name: null, // Filter by channel name(s)
 
@@ -52,31 +46,30 @@ const params = {
 
   from_updatedAt: 1, // Filter channels updated after this timestamp
 
-  from__id: 'example-value', // Filter channels with ID greater than this value
+  from__id: "example-value", // Filter channels with ID greater than this value
 
-  to__id: 'example-value', // Filter channels with ID less than this value
+  to__id: "example-value", // Filter channels with ID less than this value
 
   sortBy: null, // Advanced sorting options
-
 };
 
-const result = await fetch(`${baseURL}/client-channel?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/client-channel?${new URLSearchParams(params)}`,
+  {
+    method: "GET",
+    headers: {
+      Authorization: `Bearer ${apiKey}`,
+      "Content-Type": "application/json",
+    },
   }
-});
+);
 
 const data = await result.json();
 console.log(data);
-
-
-
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -86,18 +79,13 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Create a new client channel
 
-
 Create a new client channel
 
-
 ```typescript
-
 // POST /client-channel
 
 const requestBody = {
@@ -106,61 +94,48 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/client-channel`, {
-  method: 'POST',
+  method: "POST",
   headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+    Authorization: `Bearer ${apiKey}`,
+    "Content-Type": "application/json",
   },
-  body: JSON.stringify(requestBody)
+  body: JSON.stringify(requestBody),
 });
 
 const data = await result.json();
 console.log(data);
-
-
-
 ```
 
-
-
 ---
 
-
-
-
 ### Get a specific client channel
 
-
 Retrieve a specific client channel by ID
 
-
 ```typescript
-
 // GET /client-channel/{id}
 
 const params = {
-
-  id: 'example-value', // Channel ID
-
+  id: "example-value", // Channel ID
 };
 
-const result = await fetch(`${baseURL}/client-channel/{id}?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/client-channel/{id}?${new URLSearchParams(params)}`,
+  {
+    method: "GET",
+    headers: {
+      Authorization: `Bearer ${apiKey}`,
+      "Content-Type": "application/json",
+    },
   }
-});
+);
 
 const data = await result.json();
 console.log(data);
-
-
-
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -170,22 +145,18 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Update a client channel
 
-
 Update an existing client channel
 
-
 ```typescript
 
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -195,39 +166,32 @@ Update an existing client channel
 }
 ```
 
-
 ---
 
-
 ### Delete a client channel
 
-
 Delete an existing client channel
 
-
 ```typescript
-
 // DELETE /client-channel/{id}
 
-const id = 'your-resource-id';
-const deletePath = '/client-channel/{id}'.replace('{id}', id);
+const id = "your-resource-id";
+const deletePath = "/client-channel/{id}".replace("{id}", id);
 
 const result = await fetch(`${baseURL}${deletePath}`, {
-  method: 'DELETE',
+  method: "DELETE",
   headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
-  }
+    Authorization: `Bearer ${apiKey}`,
+    "Content-Type": "application/json",
+  },
 });
 
 const data = await result.json();
 console.log(data);
-
-
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -237,27 +201,21 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
-
-
 ## Using with Repzo SDK Service Types
 
 The Repzo SDK provides TypeScript interfaces for type safety:
 
 ```typescript
-import { Service } from 'repzo';
+import { Service } from "repzo";
 
 // Example using SDK types
 
-
 async function example() {
   // Use the Service.Clientchannel types for better type safety
   // This provides intellisense and compile-time type checking
 }
-
 ```
 
 ## Error Handling
@@ -265,11 +223,11 @@ async function example() {
 ```typescript
 try {
   const result = await fetch(`${baseURL}/endpoint`, {
-    method: 'GET',
+    method: "GET",
     headers: {
-      'Authorization': `Bearer ${apiKey}`,
-      'Content-Type': 'application/json'
-    }
+      Authorization: `Bearer ${apiKey}`,
+      "Content-Type": "application/json",
+    },
   });
 
   if (!result.ok) {
@@ -277,14 +235,14 @@ try {
   }
 
   const data = await result.json();
-  
+
   if (!data.success) {
-    throw new Error(data.error || 'API request failed');
+    throw new Error(data.error || "API request failed");
   }
-  
+
   return data.data;
 } catch (error) {
-  console.error('API request failed:', error);
+  console.error("API request failed:", error);
   throw error;
 }
 ```
@@ -300,18 +258,21 @@ const params = {
   // other filters...
 };
 
-const result = await fetch(`${baseURL}/endpoint?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/endpoint?${new URLSearchParams(params)}`,
+  {
+    method: "GET",
+    headers: {
+      Authorization: `Bearer ${apiKey}`,
+      "Content-Type": "application/json",
+    },
   }
-});
+);
 
 const data = await result.json();
 
 // Access pagination info
-console.log('Total items:', data.paging.total);
-console.log('Current page:', data.paging.page);
-console.log('Total pages:', data.paging.pages);
-```
+console.log("Total items:", data.paging.total);
+console.log("Current page:", data.paging.page);
+console.log("Total pages:", data.paging.pages);
+```