repzo 1.0.141 → 1.0.142

package/docs/api/mail-unsubscribe-examples.md

@@ -11,60 +11,53 @@ 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 unsubscribed emails
 
-
 Retrieve a list of all unsubscribed email addresses with optional filtering and pagination
 
-
 ```typescript
-
 // GET /mail-unsubscribe
 
 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
 
-  email: 'example-value', // Filter by email address
+  email: "example-value", // Filter by email address
 
   company_namespace: null, // Company namespace for filtering
 
   _id: null, // Filter by ID
-
 };
 
-const result = await fetch(`${baseURL}/mail-unsubscribe?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/mail-unsubscribe?${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,
@@ -74,18 +67,13 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Add email to unsubscribe list
 
-
 Add an email address to the unsubscribe list
 
-
 ```typescript
-
 // POST /mail-unsubscribe
 
 const requestBody = {
@@ -94,61 +82,48 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/mail-unsubscribe`, {
-  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 unsubscribe record by ID
 
-
 Retrieve a specific unsubscribe record by its ID
 
-
 ```typescript
-
 // GET /mail-unsubscribe/{id}
 
 const params = {
-
-  id: 'example-value', // Unsubscribe record ID
-
+  id: "example-value", // Unsubscribe record ID
 };
 
-const result = await fetch(`${baseURL}/mail-unsubscribe/{id}?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/mail-unsubscribe/{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,
@@ -158,39 +133,32 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Remove email from unsubscribe list
 
-
 Remove an email address from the unsubscribe list (re-subscribe)
 
-
 ```typescript
-
 // DELETE /mail-unsubscribe/{id}
 
-const id = 'your-resource-id';
-const deletePath = '/mail-unsubscribe/{id}'.replace('{id}', id);
+const id = "your-resource-id";
+const deletePath = "/mail-unsubscribe/{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,
@@ -200,20 +168,13 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
-
-
 ### Bulk remove emails from unsubscribe list
 
-
 Remove multiple email addresses from the unsubscribe list
 
-
 ```typescript
-
 // POST /mail-unsubscribe/remove
 
 const requestBody = {
@@ -222,23 +183,20 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/mail-unsubscribe/remove`, {
-  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,
@@ -248,20 +206,13 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
-
-
 ### Check if email is unsubscribed
 
-
 Check if an email address is in the unsubscribe list
 
-
 ```typescript
-
 // POST /mail-unsubscribe/check
 
 const requestBody = {
@@ -270,23 +221,20 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/mail-unsubscribe/check`, {
-  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,
@@ -296,27 +244,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.Mailunsubscribe types for better type safety
   // This provides intellisense and compile-time type checking
 }
-
 ```
 
 ## Error Handling
@@ -324,11 +266,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) {
@@ -336,14 +278,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;
 }
 ```
@@ -359,18 +301,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);
+```