repzo 1.0.141 → 1.0.143

package/docs/api/ocr-invoice-job-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 OCR invoice jobs
 
-
 Retrieve a list of all OCR invoice jobs with optional filtering and pagination
 
-
 ```typescript
-
 // GET /ocr-invoice-job
 
 const params = {
-
   limit: 1, // Maximum number of records to return
 
   offset: 1, // Number of records to skip for pagination
 
-  sort: 'example-value', // Field to sort by
-
-  order: 'example-value', // Sort order (asc or desc)
+  sort: "example-value", // Field to sort by
 
-  filter: 'example-value', // Filter conditions in JSON format
+  order: "example-value", // Sort order (asc or desc)
 
-  search: 'example-value', // Search term for text fields
+  filter: "example-value", // Filter conditions in JSON format
 
+  search: "example-value", // Search term for text fields
 };
 
-const result = await fetch(`${baseURL}/ocr-invoice-job?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/ocr-invoice-job?${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);
 }
 ```
 
-
 ---
 
-
 ### Create a new OCR invoice job
 
-
 Create a new OCR invoice job with the provided data
 
-
 ```typescript
-
 // POST /ocr-invoice-job
 
 const requestBody = {
@@ -94,61 +82,48 @@ const requestBody = {
 };
 
 const result = await fetch(`${baseURL}/ocr-invoice-job`, {
-  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 OCR invoice job by ID
 
-
 Retrieve a specific OCR invoice job by its ID
 
-
 ```typescript
-
 // GET /ocr-invoice-job/{id}
 
 const params = {
-
-  id: 'example-value', // OCR invoice job ID
-
+  id: "example-value", // OCR invoice job ID
 };
 
-const result = await fetch(`${baseURL}/ocr-invoice-job/{id}?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/ocr-invoice-job/{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,22 +133,18 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
 ### Update OCR invoice job
 
-
 Update an existing OCR invoice job with new data
 
-
 ```typescript
 
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -183,39 +154,32 @@ Update an existing OCR invoice job with new data
 }
 ```
 
-
 ---
 
-
 ### Delete OCR invoice job
 
-
 Delete an existing OCR invoice job
 
-
 ```typescript
-
 // DELETE /ocr-invoice-job/{id}
 
-const id = 'your-resource-id';
-const deletePath = '/ocr-invoice-job/{id}'.replace('{id}', id);
+const id = "your-resource-id";
+const deletePath = "/ocr-invoice-job/{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,
@@ -225,28 +189,18 @@ console.log(data);
 }
 ```
 
-
 ---
 
-
-
-
 ### Process OCR invoice job
 
-
 Start processing an OCR invoice job
 
-
 ```typescript
-
 // POST /ocr-invoice-job/{id}/process
-
-
-
 ```
 
-
 **Expected Response:**
+
 ```json
 {
   "success": true,
@@ -256,45 +210,36 @@ Start processing an OCR invoice job
 }
 ```
 
-
 ---
 
-
-
-
 ### Get OCR results
 
-
 Retrieve the OCR processing results for a job
 
-
 ```typescript
-
 // GET /ocr-invoice-job/{id}/results
 
 const params = {
-
-  id: 'example-value', // OCR invoice job ID
-
+  id: "example-value", // OCR invoice job ID
 };
 
-const result = await fetch(`${baseURL}/ocr-invoice-job/{id}/results?${new URLSearchParams(params)}`, {
-  method: 'GET',
-  headers: {
-    'Authorization': `Bearer ${apiKey}`,
-    'Content-Type': 'application/json'
+const result = await fetch(
+  `${baseURL}/ocr-invoice-job/{id}/results?${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,
@@ -304,27 +249,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.Ocrinvoicejob types for better type safety
   // This provides intellisense and compile-time type checking
 }
-
 ```
 
 ## Error Handling
@@ -332,11 +271,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) {
@@ -344,14 +283,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;
 }
 ```
@@ -367,18 +306,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);
+```