0.2.0

README.md

@@ -1,132 +1,139 @@
-
-# Getting Started with Mist API
-
-## Introduction
-
-> Version: **2406.1.22**
+
+# Getting Started with Mist API
+
+## Introduction
+
+> Version: **2406.1.27**
 > 
-> Date: **July 9, 2024**
-
+> Date: **July 12, 2024**
+
 ---
-
-
-### Additional Documentation
-
+
+
+### Additional Documentation
+
 * [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
 * [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location_services/topics/concept/mist-how-get-mist-sdk.html)
-* [Mist Product Updates](https://www.mist.com/documentation/category/product-updates/)
-
+* [Mist Product Updates](https://www.mist.com/documentation/category/product-updates/)
+
 ---
-
-
-### Helpful Resources
-
+
+
+### Helpful Resources
+
 * [API Sandbox and Exercises](https://api-class.mist.com/)
 * [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
 * [API Demo Apps](https://apps.mist-lab.fr/)
-* [Juniper Blog](https://blogs.juniper.net/)
-
+* [Juniper Blog](https://blogs.juniper.net/)
+
 ---
-
-
-### Requirements
-
-The SDK requires **Go version 1.18 or above**.
-
-## Building
-
-### Install Dependencies
-
-Resolve all the SDK dependencies, using the `go get` command.
-
-## Installation
-
-The following section explains how to use the mistapigo library in a new project.
-
-### 1. Add SDK as a Dependency to the Application
-
-- Add the following lines to your application's `go.mod` file:
-
+
+
+### Requirements
+
+The SDK requires **Go version 1.18 or above**.
+
+## Building
+
+### Install Dependencies
+
+Resolve all the SDK dependencies, using the `go get` command.
+
+## Installation
+
+The following section explains how to use the mistapi library in a new project.
+
+### 1. Add SDK as a Dependency to the Application
+
+- Add the following lines to your application's `go.mod` file:
+
 ```go
-replace mistapigo => ".\\mist-api-go_generic_lib" // local path to the SDK
-
-require mistapigo v0.0.0
-```
-
-- Resolve the dependencies in the updated `go.mod` file, using the `go get` command.
-
-## Initialize the API Client
-
-**_Note:_** Documentation for the client can be found [here.](doc/client.md)
-
-The following parameters are configurable for the API Client:
-
-| Parameter | Type | Description |
-|  --- | --- | --- |
-| `environment` | `Environment` | The API environment. <br> **Default: `Environment.MIST_GLOBAL_01`** |
-| `httpConfiguration` | [`HttpConfiguration`](doc/http-configuration.md) | Configurable http client options like timeout and retries. |
-| `loggerConfiguration` | [`LoggerConfiguration`](doc/logger-configuration.md) | Represents the logger configurations for API calls |
-| `apiTokenCredentials` | [`ApiTokenCredentials`](doc/auth/custom-header-signature.md) | The Credentials Setter for Custom Header Signature |
-| `basicAuthCredentials` | [`BasicAuthCredentials`](doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
-
-The API client can be initialized as follows:
-
-```go
-client := mistapigo.NewClient(
-    mistapigo.CreateConfiguration(
-        mistapigo.WithHttpConfiguration(
-            mistapigo.CreateHttpConfiguration(
-                mistapigo.WithTimeout(0),
+replace mistapi => ".\\mist-api-go_generic_lib" // local path to the SDK
+
+require mistapi v0.0.0
+```
+
+- Resolve the dependencies in the updated `go.mod` file, using the `go get` command.
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `environment` | `Environment` | The API environment. <br> **Default: `Environment.MIST_GLOBAL_01`** |
+| `httpConfiguration` | [`HttpConfiguration`](doc/http-configuration.md) | Configurable http client options like timeout and retries. |
+| `loggerConfiguration` | [`LoggerConfiguration`](doc/logger-configuration.md) | Represents the logger configurations for API calls |
+| `apiTokenCredentials` | [`ApiTokenCredentials`](doc/auth/custom-header-signature.md) | The Credentials Setter for Custom Header Signature |
+| `basicAuthCredentials` | [`BasicAuthCredentials`](doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
+| `csrfTokenCredentials` | [`CsrfTokenCredentials`](doc/auth/custom-header-signature-1.md) | The Credentials Setter for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+```go
+client := mistapi.NewClient(
+    mistapi.CreateConfiguration(
+        mistapi.WithHttpConfiguration(
+            mistapi.CreateHttpConfiguration(
+                mistapi.WithTimeout(0),
             ),
         ),
-        mistapigo.WithEnvironment(mistapigo.MIST_GLOBAL_01),
-        mistapigo.WithApiTokenCredentials(
-            mistapigo.NewApiTokenCredentials("Authorization"),
+        mistapi.WithEnvironment(mistapi.MIST_GLOBAL_01),
+        mistapi.WithApiTokenCredentials(
+            mistapi.NewApiTokenCredentials("Authorization"),
         ),
-        mistapigo.WithBasicAuthCredentials(
-            mistapigo.NewBasicAuthCredentials(
+        mistapi.WithBasicAuthCredentials(
+            mistapi.NewBasicAuthCredentials(
                 "Username",
                 "Password",
             ),
         ),
-        mistapigo.WithLoggerConfiguration(
-            mistapigo.WithLevel("info"),
-            mistapigo.WithRequestConfiguration(
-                mistapigo.WithRequestBody(true),
+        mistapi.WithCsrfTokenCredentials(
+            mistapi.NewCsrfTokenCredentials("X-CSRFToken"),
+        ),
+        mistapi.WithLoggerConfiguration(
+            mistapi.WithLevel("info"),
+            mistapi.WithRequestConfiguration(
+                mistapi.WithRequestBody(true),
             ),
-            mistapigo.WithResponseConfiguration(
-                mistapigo.WithResponseHeaders(true),
+            mistapi.WithResponseConfiguration(
+                mistapi.WithResponseHeaders(true),
             ),
         ),
     ),
-)
-```
-
-## Environments
-
-The SDK can be configured to use a different environment for making API calls. Available environments are:
-
-### Fields
-
-| Name | Description |
-|  --- | --- |
-| Mist Global 01 | **Default** |
-| Mist Global 02 | - |
-| Mist Global 03 | - |
-| Mist Global 04 | - |
-| Mist EMEA 01 | - |
-| Mist EMEA 02 | - |
-| Mist APAC 01 | - |
-
-## Authorization
-
+)
+```
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| Mist Global 01 | **Default** |
+| Mist Global 02 | - |
+| Mist Global 03 | - |
+| Mist Global 04 | - |
+| Mist EMEA 01 | - |
+| Mist EMEA 02 | - |
+| Mist EMEA 03 | - |
+| Mist APAC 01 | - |
+| AWS Staging | - |
+
+## Authorization
+
 This API uses the following authentication schemes.
 
 * [`apiToken (Custom Header Signature)`](doc/auth/custom-header-signature.md)
 * [`basicAuth (Basic Authentication)`](doc/auth/basic-authentication.md)
-
-## List of APIs
-
+* [`csrfToken (Custom Header Signature)`](doc/auth/custom-header-signature-1.md)
+
+## List of APIs
+
 * [Admins](doc/controllers/admins.md)
 * [Admins Login](doc/controllers/admins-login.md)
 * [Admins Login-O Auth 2](doc/controllers/admins-login-o-auth-2.md)
@@ -299,13 +306,13 @@ This API uses the following authentication schemes.
 * [Utilities PCA Ps](doc/controllers/utilities-pca-ps.md)
 * [Utilities Upgrade](doc/controllers/utilities-upgrade.md)
 * [Utilities WAN](doc/controllers/utilities-wan.md)
-* [Utilities Wi-Fi](doc/controllers/utilities-wi-fi.md)
-
-## Classes Documentation
-
+* [Utilities Wi-Fi](doc/controllers/utilities-wi-fi.md)
+
+## Classes Documentation
+
 * [HttpConfiguration](doc/http-configuration.md)
 * [RetryConfiguration](doc/retry-configuration.md)
 * [LoggerConfiguration](doc/logger-configuration.md)
 * [RequestLoggerConfiguration](doc/request-logger-configuration.md)
-* [ResponseLoggerConfiguration](doc/response-logger-configuration.md)
-
+* [ResponseLoggerConfiguration](doc/response-logger-configuration.md)
+