repzo 1.0.141 → 1.0.143

package/docs/api/contract-installment-examples.md

@@ -11,66 +11,59 @@ 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 contract installments
 
-
 Retrieve a list of all contract installments with optional filtering and pagination
 
-
 ```typescript
-
 // GET /contract-installment
 
 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
 
   company_namespace: null, // Company namespace for filtering
 
-  contract: 'example-value', // Filter by contract ID
+  contract: "example-value", // Filter by contract ID
 
-  status: 'example-value', // Filter by payment status
+  status: "example-value", // Filter by payment status
 
-  due_date_from: 'example-value', // Filter by due date from
+  due_date_from: "example-value", // Filter by due date from
 
-  due_date_to: 'example-value', // Filter by due date to
+  due_date_to: "example-value", // Filter by due date to
 
   _id: null, // Filter by ID
-
 };
 
-const result = await fetch(`${baseURL}/contract-installment?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/contract-installment?${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,
@@ -80,18 +73,13 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Create a new contract installment
 
-
 Create a new contract installment
 
-
 ```typescript
-
 // POST /contract-installment
 
 const requestBody = {
@@ -100,61 +88,48 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/contract-installment`, {
-  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 contract installment by ID
 
-
 Retrieve a specific contract installment by its ID
 
-
 ```typescript
-
 // GET /contract-installment/{id}
 
 const params = {
-
-  id: 'example-value', // Contract installment ID
-
+  id: "example-value", // Contract installment ID
 };
 
-const result = await fetch(`${baseURL}/contract-installment/{id}?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/contract-installment/{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,
@@ -164,47 +139,37 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Update contract installment
 
-
 Update an existing contract installment
 
-
 ```typescript
-
 // PATCH /contract-installment/{id}
 
-const id = 'your-resource-id';
-const updatePath = '/contract-installment/{id}'.replace('{id}', id);
-
-
+const id = "your-resource-id";
+const updatePath = "/contract-installment/{id}".replace("{id}", id);
 
 const updateData = {
   // Add your update properties here
 };
 
 const result = await fetch(`${baseURL}${updatePath}`, {
-  method: 'PATCH',
+  method: "PATCH",
   headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+    Authorization: `Bearer ${apiKey}`,
+    "Content-Type": "application/json",
   },
-  body: JSON.stringify(updateData)
+  body: JSON.stringify(updateData),
 });
 
 const data = await result.json();
 console.log(data);
-
-
-
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -214,39 +179,32 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Delete contract installment
 
-
 Delete a contract installment by ID
 
-
 ```typescript
-
 // DELETE /contract-installment/{id}
 
-const id = 'your-resource-id';
-const deletePath = '/contract-installment/{id}'.replace('{id}', id);
+const id = "your-resource-id";
+const deletePath = "/contract-installment/{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,
@@ -256,20 +214,13 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
-
-
 ### Mark installment as paid
 
-
 Mark a contract installment as paid
 
-
 ```typescript
-
 // POST /contract-installment/{id}/pay
 
 const requestBody = {
@@ -278,23 +229,20 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/contract-installment/{id}/pay`, {
-  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);
-
-
-
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -304,49 +252,40 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
-
-
 ### Get overdue installments
 
-
 Get all overdue contract installments
 
-
 ```typescript
-
 // GET /contract-installment/overdue
 
 const params = {
-
   page: 1, // Page number for pagination
 
   per_page: 1, // Number of items per page
 
   days_overdue: 1, // Minimum days overdue
-
 };
 
-const result = await fetch(`${baseURL}/contract-installment/overdue?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/contract-installment/overdue?${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,
@@ -356,27 +295,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.Contractinstallment types for better type safety
   // This provides intellisense and compile-time type checking
 }
-
 ```
 
 ## Error Handling
@@ -384,11 +317,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) {
@@ -396,14 +329,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;
 }
 ```
@@ -419,18 +352,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);
+```