repzo 1.0.141 → 1.0.142

package/docs/api/contract.md

@@ -6,255 +6,141 @@ OpenAPI specification for Repzo Contract endpoints.
 
 ## Overview
 
-
 ### Base URLs
 
-- ****: `https://sv.api.repzo.me`
-
-
-
-
+- \*\*\*\*: `https://sv.api.repzo.me`
 
 ## Authentication
 
-
 No authentication required.
 
-
 ## Endpoints
 
-
 ### `/contract`
 
-
 #### GET /contract
 
 **Summary:** Find contracts
 
-
-
-
-
-
 ##### Parameters
 
 | Name | Location | Type | Required | Description |
-|------|----------|------|----------|-------------|
-
-| `params` | query | object | No | Query parameters for filtering contracts |
-
-
+| ---- | -------- | ---- | -------- | ----------- |
 
 
+| `params` | query | object | No | Query parameters for filtering contracts |
 
 ##### Responses
 
-
 **200** - A list of contracts
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
 #### POST /contract
 
 **Summary:** Create a contract
 
-
-
-
-
-
-
-
 ##### Request Body
 
-
-
-
 **Content Types:**
 
 - `application/json`
 
-
-
-
 ##### Responses
 
-
 **201** - Contract created
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
-
 ### `/contract/{id}`
 
-
 #### GET /contract/{id}
 
 **Summary:** Get a contract by ID
 
-
-
-
-
-
 ##### Parameters
 
 | Name | Location | Type | Required | Description |
-|------|----------|------|----------|-------------|
-
-| `id` | path | string | Yes | No description |
-
-
+| ---- | -------- | ---- | -------- | ----------- |
 
 
+| `id` | path | string | Yes | No description |
 
 ##### Responses
 
-
 **200** - Contract details
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
 #### PUT /contract/{id}
 
 **Summary:** Update a contract
 
-
-
-
-
-
 ##### Parameters
 
 | Name | Location | Type | Required | Description |
-|------|----------|------|----------|-------------|
-
-| `id` | path | string | Yes | No description |
-
+| ---- | -------- | ---- | -------- | ----------- |
 
 
+| `id` | path | string | Yes | No description |
 
 ##### Request Body
 
-
-
-
 **Content Types:**
 
 - `application/json`
 
-
-
-
 ##### Responses
 
-
 **200** - Contract updated
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
 #### DELETE /contract/{id}
 
 **Summary:** Remove a contract
 
-
-
-
-
-
 ##### Parameters
 
 | Name | Location | Type | Required | Description |
-|------|----------|------|----------|-------------|
-
-| `id` | path | string | Yes | No description |
-
-
+| ---- | -------- | ---- | -------- | ----------- |
 
 
+| `id` | path | string | Yes | No description |
 
 ##### Responses
 
-
 **200** - Contract removed
 
-
-
 Content-Type: `application/json`
 
-
-
-
-
 ---
 
-
-
-
 ## Data Models
 
-
-
 ### ContractFindResult
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `data` | array | No | No description |
 
 | `meta` | object | No | No description |
 
-
-
-
-
-
 ### ContractCreateBody
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `title` | string | No | No description |
 
@@ -274,48 +160,27 @@ Content-Type: `application/json`
 
 | `installments` | array | No | No description |
 
-
-
-
-
-
 ### ContractCreateResult
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
-
-| `data` | object | No | No description |
-
-
-
+| -------- | ---- | -------- | ----------- |
 
 
+| `data` | object | No | No description |
 
 ### ContractGetResult
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
-
-| `data` | object | No | No description |
-
-
-
+| -------- | ---- | -------- | ----------- |
 
 
+| `data` | object | No | No description |
 
 ### ContractUpdateBody
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `title` | string | No | No description |
 
@@ -335,48 +200,27 @@ Content-Type: `application/json`
 
 | `installments` | array | No | No description |
 
-
-
-
-
-
 ### ContractUpdateResult
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
-
-| `data` | object | No | No description |
-
-
-
+| -------- | ---- | -------- | ----------- |
 
 
+| `data` | object | No | No description |
 
 ### ContractRemoveResult
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
-
-| `success` | boolean | No | No description |
-
-
-
+| -------- | ---- | -------- | ----------- |
 
 
+| `success` | boolean | No | No description |
 
 ### Contract
 
-
-
-
 | Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| -------- | ---- | -------- | ----------- |
+
 
 | `_id` | string | No | No description |
 
@@ -402,13 +246,6 @@ Content-Type: `application/json`
 
 | `updatedAt` | string | No | No description |
 
-
-
-
-
-
-
-
 ## TypeScript Usage
 
-See [contract-examples.md](./contract-examples.md) for detailed TypeScript usage examples.
+See [contract-examples.md](./contract-examples.md) for detailed TypeScript usage examples.

package/docs/api/custom-list-examples.md

@@ -11,48 +11,41 @@ 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
 
-
-
 ### Find custom lists
 
-
-
 ```typescript
-
 // GET /custom-list
 
 const params = {
-
   params: null, // Query parameters for filtering custom lists
-
 };
 
-const result = await fetch(`${baseURL}/custom-list?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/custom-list?${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,
@@ -62,16 +55,11 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Create a custom list
 
-
-
 ```typescript
-
 // POST /custom-list
 
 const requestBody = {
@@ -80,59 +68,46 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/custom-list`, {
-  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 custom list by ID
 
-
-
 ```typescript
-
 // GET /custom-list/{id}
 
 const params = {
-
-  id: 'example-value', // No description
-
+  id: "example-value", // No description
 };
 
-const result = await fetch(`${baseURL}/custom-list/{id}?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/custom-list/{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,
@@ -142,20 +117,16 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Update a custom list
 
-
-
 ```typescript
 
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -165,37 +136,30 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Remove a custom list
 
-
-
 ```typescript
-
 // DELETE /custom-list/{id}
 
-const id = 'your-resource-id';
-const deletePath = '/custom-list/{id}'.replace('{id}', id);
+const id = "your-resource-id";
+const deletePath = "/custom-list/{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,
@@ -205,27 +169,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.Customlist types for better type safety
   // This provides intellisense and compile-time type checking
 }
-
 ```
 
 ## Error Handling
@@ -233,11 +191,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) {
@@ -245,14 +203,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;
 }
 ```
@@ -268,18 +226,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);
+```