update ApiClient doc

docs/AWS/Olive.Sms.Aws.md

@@ -0,0 +1,80 @@
+# Olive.Sms.Aws
+
+This document provides an overview and usage examples for the public classes and methods in the `Olive.SMS` namespace related to sending SMS messages via Amazon Simple Notification Service (SNS). It integrates with AWS SNS to dispatch SMS messages, supporting optional sender ID and origination number configurations. A configuration section details the optional settings in an `appsettings.json` file.
+
+---
+
+## Table of Contents
+
+1. [SmsDispatcher](#smsdispatcher)
+   - [Overview](#smsdispatcher-overview)
+   - [Methods](#smsdispatcher-methods)
+2. [IServiceCollectionExtension](#iservicecollectionextension)
+   - [Overview](#iservicecollectionextension-overview)
+   - [Methods](#iservicecollectionextension-methods)
+3. [Configuration](#configuration)
+
+---
+
+## SmsDispatcher
+
+### SmsDispatcher Overview
+
+The `SmsDispatcher` class implements `ISmsDispatcher` and `IDisposable` to send SMS messages using Amazon SNS. It uses the `AmazonSimpleNotificationServiceClient` to publish messages and supports optional attributes like sender ID and origination number.
+
+### SmsDispatcher Methods
+
+- **`Dispatch(ISmsMessage sms)`**
+  - Asynchronously sends an SMS message via AWS SNS with configurable attributes.
+  - **Usage Example:**
+    ```csharp  
+    var dispatcher = Context.Current.GetService<ISmsDispatcher>();
+    var sms = new SmsMessage { To = "+1234567890", Text = "Hello from AWS SNS!" }; // Assuming SmsMessage implements ISmsMessage
+    await dispatcher.Dispatch(sms);
+    Console.WriteLine("SMS sent successfully");
+    ``` 
+
+---
+
+## IServiceCollectionExtension
+
+### IServiceCollectionExtension Overview
+
+The `IServiceCollectionExtension` static class provides an extension method to register the AWS SNS SMS dispatcher in an ASP.NET Core dependency injection container.
+
+### IServiceCollectionExtension Methods
+
+- **`AddAwsSms(this IServiceCollection @this)`**
+  - Registers `SmsDispatcher` as the `ISmsDispatcher` in the service collection.
+  - **Usage Example:**
+    ```csharp     
+    services.AddAwsSms();
+    ```
+
+---
+
+## Configuration
+
+The `SmsDispatcher` class supports optional configuration settings stored in an `appsettings.json` file with a JSON structure. These settings enhance the SMS sending process but are not strictly required. Below are the optional settings:
+
+### Optional Settings
+- **`Aws:Sns:SenderId`**
+  - The sender ID to display on the recipient's device (e.g., a brand name). Overrides `ISmsMessage.SenderName` if specified in the message.
+- **`Aws:Sns:OriginationNumber`**
+  - The phone number to use as the origination number for the SMS (must be an AWS SNS-supported number).
+
+### Full `appsettings.json` Example
+```json
+{
+  "Aws": {
+    "Sns": {
+      "SenderId": "MyApp",
+      "OriginationNumber": "+12025550123"
+    }
+  }
+}
+```
+
+### Notes
+- If `SenderId` or `OriginationNumber` are not provided in `appsettings.json`, the dispatcher will use the `SenderName` from the `ISmsMessage` (if available) or omit these attributes.
+- The SMS type is hardcoded to `"Transactional"` for immediate delivery, suitable for critical notifications.

docs/Api/ApiClient.md

@@ -22,7 +22,7 @@ When using HttpClient directly, you should manually take care of:
   * Circuit breaking (to avoid server overloading)
 
 ## Olive.ApiClient
-Olive provides a helper utility class named [ApiClient](https://github.com/Geeksltd/Olive/tree/master/Integration/Olive.ApiClient) which handles all of the above issues for you.
+Olive provides a helper utility class named [ApiClient](https://github.com/Geeksltd/Olive/tree/master/Olive.ApiClient) which handles all of the above issues for you.
 It's built on top of the standard HttpClient, and is ideal for invoking Web Apis.
 
 The following simple line is enough to take care of all aspects of downloading a customer object from a remote Web Api.
@@ -216,3 +216,78 @@ If http exceptions are raised consecutively for the specified number of times, i
 During the break period, any attempt to execute a new request will **immediately throw a BrokenCircuitException**.
 Once the duration is over, if the first action throws http exception again,
 the circuit will break again for the same duration. Otherwise the circuit will reset.
+
+## HTTP Methods
+### GET Request
+
+- **Purpose**: Retrieves data from the API.
+- **Usage**:
+```csharp
+var data = await new ApiClient($"{baseUrl}/customers").Get<Customer>(new { id = 123 });
+```
+
+### POST Request
+
+- **Purpose**: Sends data to the server.
+- **Usage**:
+```csharp
+var data = await new ApiClient($"{baseUrl}/customers").Post<Customer>(new { name = CustomerName });
+```
+
+### PUT Request
+
+- **Purpose**: Updates a resource on the server.
+- **Usage**:
+```csharp
+var data = await new ApiClient($"{baseUrl}/customers").Put<Customer>(new { name = CustomerName });
+```
+
+### DELETE Request
+
+- **Purpose**: Deletes a resource.
+- **Usage**:
+```csharp
+var data = await new ApiClient($"{baseUrl}/customers").Delete(new { id = 123 });
+```
+
+### PATCH Request
+
+- **Purpose**: Partially updates a resource.
+- **Usage**:
+```csharp
+var data = await new ApiClient($"{baseUrl}/customers").Patch<Customer>(new { id = 123 });
+```
+
+## Caching
+
+- **Purpose**: Enables caching for GET requests.
+- **Usage**:
+```csharp
+var data = await new ApiClient($"{baseUrl}/customers")
+    .Cache(CachePolicy.FreshOrCacheOrFail, TimeSpan.FromMinutes(10))
+    .Get<Customer>(new { id = 123 });
+```  
+
+## Custom Headers
+
+- **Purpose**: Adds custom headers to API requests.
+- **Usage**:
+```csharp
+var client = new ApiClient($"{baseUrl}/customers").Header(headers => headers.Add("Authorization", "Bearer token"));
+```
+
+## Authentication
+
+- **Purpose**: Authenticates the client using cookies.
+- **Usage**:
+```csharp
+var client = new ApiClient($"{baseUrl}/customers").Authenticate(cookie1, cookie2);
+```
+
+## Deletes All Cache
+
+- **Purpose**: Deletes all cached Get API results.
+- **Usage**:
+```csharp
+await ApiClient.DisposeCache();
+```

docs/Api/Olive.Cloud.md

@@ -0,0 +1,95 @@
+# Olive.Cloud
+
+## Overview
+The `Olive.Cloud` is an abstract base class designed to manage and load secrets from a cloud-based provider. It stores secrets in a dictionary and updates the application configuration with the retrieved values.
+
+## Namespace
+```csharp
+namespace Olive.Cloud;
+``` 
+
+## Class: `Secrets`
+### Description
+This abstract class facilitates the retrieval and storage of secrets within an application. The secrets are loaded from a cloud-based provider and stored in memory for use during runtime.
+
+### Events
+#### `Loaded`
+- **Type:** `AwaitableEventHandler<Secrets>`
+- **Description:** This event is triggered when the secrets are successfully loaded.
+
+### Fields
+#### `Config`
+- **Type:** `IConfiguration`
+- **Access Modifier:** `protected`
+- **Description:** Holds the application configuration object.
+
+#### `SecretString`
+- **Type:** `string`
+- **Access Modifier:** `protected`
+- **Description:** Stores the downloaded secrets as a JSON string.
+
+### Properties
+#### `SecretId`
+- **Type:** `string`
+- **Access Modifier:** `protected abstract`
+- **Description:** Specifies the unique identifier for the secret in the cloud provider.
+
+### Methods
+#### `DownloadSecrets()`
+- **Access Modifier:** `protected abstract`
+- **Return Type:** `string`
+- **Description:** An abstract method that must be implemented in derived classes to download secrets from a cloud provider.
+
+#### `Load()`
+- **Access Modifier:** `public`
+- **Return Type:** `void`
+- **Description:** Downloads and loads secrets into the application configuration.
+- **Implementation Steps:**
+  1. Calls `Download()` to retrieve the secret values.
+  2. Parses the retrieved secrets as JSON.
+  3. Updates the application configuration with the retrieved secret values.
+  4. Raises the `Loaded` event.
+
+#### `Download()`
+- **Access Modifier:** `private`
+- **Return Type:** `void`
+- **Description:** Downloads secrets and handles any errors that occur during retrieval.
+- **Error Handling:**
+  - Logs errors when secrets cannot be retrieved.
+  - Throws exceptions when retrieval fails.
+- **Implementation Steps:**
+  1. Calls `DownloadSecrets()` to retrieve the secrets.
+  2. Validates the retrieved data to ensure it is not empty.
+  3. Stores the retrieved secrets in `SecretString`.
+
+### Logging
+- Uses `ILogger` for logging errors and exceptions.
+- Logs errors when secret retrieval fails.
+
+## Usage Example
+Since `Secrets` is an abstract class, it must be inherited by a concrete class that implements `DownloadSecrets()`. Below is an example implementation:
+
+```csharp
+public class MyCloudSecrets : Secrets
+{
+    protected override string SecretId => "MySecretKey";
+
+    public MyCloudSecrets(IConfiguration config) : base(config) {}
+
+    protected override string DownloadSecrets()
+    {
+        // Replace this with actual cloud secret retrieval logic.
+        return "{ \"ApiKey\": \"12345\", \"DbPassword\": \"securepassword\" }";
+    }
+}
+```
+
+To use this class in an application:
+
+```csharp
+IConfiguration configuration = new ConfigurationBuilder().Build();
+MyCloudSecrets secrets = new MyCloudSecrets(configuration);
+secrets.Load();
+Console.WriteLine(configuration["ApiKey"]); // Output: 12345
+```
+

docs/Api/Olive.Compression.md

@@ -0,0 +1,56 @@
+**Olive.Compression**
+
+**Overview:**
+The `Olive.Compression` provides methods for compressing and decompressing files and directories using different compression formats, such as ZIP, GZIP, and TAR.
+
+**Methods:**
+
+1. **Compress(IEnumerable<FileInfo>, CompressionFormat)**
+   - Compresses a list of files into a specified compression format.
+   - Throws an exception if duplicate filenames exist.
+   - Returns the compressed data as a byte array.
+
+2. **Compress(DirectoryInfo, CompressionFormat)**
+   - Compresses an entire directory into a specified compression format.
+   - Returns the compressed data as a byte array.
+
+3. **Compress(DirectoryInfo, FileInfo, CompressionFormat, bool)**
+   - Creates a compressed file from a directory and saves it to a specified destination.
+   - Supports ZIP, GZIP, and TAR formats.
+   - Throws an exception if the destination file already exists unless overwrite is set to `true`.
+
+4. **Decompress(FileInfo, DirectoryInfo, bool, bool)**
+   - Decompresses a compressed file into a specified directory.
+   - Supports extracting full paths and overwriting existing files.
+
+---
+
+**SevenZip Documentation**
+
+**Overview:**
+The `SevenZip` class provides an interface to compress and decompress files using the 7-Zip utility.
+
+**Properties:**
+
+- `SEVEN_ZIP_EXE_FILE_PATH`: Specifies the path of the 7-Zip executable.
+
+**Methods:**
+
+1. **Compress(string, string[])**
+   - Compresses specified folders into a 7-Zip archive.
+
+2. **Compress(string, int?, string[])**
+   - Supports splitting archives into parts of a specified size (in KB).
+
+3. **Compress(string, int?, CompressionMode, string, string[], string[])**
+   - Compresses folders into a 7-Zip archive with custom parameters and optional exclusion filters.
+
+4. **Compress(IEnumerable<FileInfo>, CompressionMode, string)**
+   - Compresses a list of files into a temporary 7-Zip file and returns the resulting file.
+
+5. **CompressToBytes(IEnumerable<FileInfo>, CompressionMode, string)**
+   - Compresses a list of files into a 7-Zip archive and returns the compressed data as a byte array.
+
+6. **Compress(FileInfo, IEnumerable<FileInfo>, CompressionMode, string)**
+   - Compresses specified files into a 7-Zip archive and saves it to a specified destination.
+