v0.4.40

README.md

@@ -3,9 +3,9 @@
 
 ## Introduction
 
-> Version: **2412.1.28**
+> Version: **2412.1.29**
 > 
-> Date: **January 30, 2024**
+> Date: **February 3, 2025**
 
 ---
 

doc/controllers/admins-login-o-auth-2.md

@@ -33,7 +33,7 @@ GetOauth2AuthorizationUrlForLogin(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `provider` | `string` | Template, Required | - |
-| `forward` | `*string` | Query, Optional | callback URL |
+| `forward` | `*string` | Query, Optional | Callback URL |
 
 ## Response Type
 

doc/controllers/admins-login.md

@@ -124,6 +124,6 @@ if err != nil {
 | 400 | Bad Syntax | [`ResponseHttp400Exception`](../../doc/models/response-http-400-exception.md) |
 | 401 | two_factor code is incorrect or the user hasn’t login yet | `ApiError` |
 | 403 | Permission Denied | [`ResponseHttp403ErrorException`](../../doc/models/response-http-403-error-exception.md) |
-| 404 | the user doesn’t have 2FA enabled | `ApiError` |
+| 404 | The user doesn’t have 2FA enabled | `ApiError` |
 | 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
 

doc/controllers/admins-lookup.md

@@ -65,6 +65,6 @@ if err != nil {
 | 400 | Bad Syntax | [`ResponseHttp400Exception`](../../doc/models/response-http-400-exception.md) |
 | 401 | Unauthorized | [`ResponseHttp401ErrorException`](../../doc/models/response-http-401-error-exception.md) |
 | 403 | Permission Denied | [`ResponseHttp403ErrorException`](../../doc/models/response-http-403-error-exception.md) |
-| 404 | user does not exist | `ApiError` |
+| 404 | User does not exist | `ApiError` |
 | 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
 

doc/controllers/constants-definitions.md

@@ -180,7 +180,7 @@ ListApChannels(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `countryCode` | `*string` | Query, Optional | country code, in two-character<br>**Constraints**: *Pattern*: `^[a-zA-Z]{2}$` |
+| `countryCode` | `*string` | Query, Optional | Country code, in two-character<br>**Constraints**: *Pattern*: `^[a-zA-Z]{2}$` |
 
 ## Response Type
 
@@ -900,7 +900,7 @@ ListCountryCodes(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `extend` | `*bool` | Query, Optional | will include more country codes if true<br>**Default**: `false` |
+| `extend` | `*bool` | Query, Optional | Will include more country codes if true<br>**Default**: `false` |
 
 ## Response Type
 
@@ -1036,7 +1036,7 @@ if err != nil {
 ```json
 {
   "bytes": {
-    "description": "aggregated bytes over time",
+    "description": "Aggregated bytes over time",
     "example": [
       185,
       197,
@@ -1075,7 +1075,7 @@ if err != nil {
     "unit": "byte"
   },
   "num_clients": {
-    "description": "number of client over time",
+    "description": "Number of client over time",
     "example": [
       18,
       null,
@@ -1265,7 +1265,7 @@ ListStates(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `countryCode` | `string` | Query, Required | country code, in [two-character](../../doc/controllers/constants-definitions.md#list-country-codes) |
+| `countryCode` | `string` | Query, Required | Country code, in [two-character](../../doc/controllers/constants-definitions.md#list-country-codes) |
 
 ## Response Type
 

doc/controllers/constants-models.md

@@ -33,8 +33,8 @@ GetGatewayDefaultConfig(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `model` | `string` | Query, Required | model the default gateway config is intended (as the default LAN/WAN port can differ) |
-| `ha` | `*string` | Query, Optional | whether the config is intended for HA |
+| `model` | `string` | Query, Required | Model the default gateway config is intended (as the default LAN/WAN port can differ) |
+| `ha` | `*string` | Query, Optional | Whether the config is intended for HA |
 
 ## Response Type
 

doc/controllers/installer.md

@@ -79,9 +79,9 @@ AddInstallerDeviceImage(
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `imageName` | `string` | Template, Required | - |
 | `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
-| `autoDeviceprofileAssignment` | `*bool` | Form, Optional | whether to auto assign device to deviceprofile by name |
-| `csv` | `*models.FileWrapper` | Form, Optional | csv file for ap name mapping, optional |
-| `file` | `*models.FileWrapper` | Form, Optional | ekahau or ibwave file |
+| `autoDeviceprofileAssignment` | `*bool` | Form, Optional | Whether to auto assign device to deviceprofile by name |
+| `csv` | `*models.FileWrapper` | Form, Optional | CSV file for ap name mapping, optional |
+| `file` | `*models.FileWrapper` | Form, Optional | Ekahau or ibwave file |
 | `json` | [`*models.MapImportJson`](../../doc/models/map-import-json.md) | Form, Optional | - |
 
 ## Response Type
@@ -742,7 +742,7 @@ if err != nil {
 
 # Delete Installer Device Image
 
-delete image
+Delete image
 
 ```go
 DeleteInstallerDeviceImage(
@@ -1146,9 +1146,9 @@ ImportInstallerMap(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `siteName` | `string` | Template, Required | - |
-| `autoDeviceprofileAssignment` | `*bool` | Form, Optional | whether to auto assign device to deviceprofile by name |
-| `csv` | `*models.FileWrapper` | Form, Optional | csv file for ap name mapping, optional |
-| `file` | `*models.FileWrapper` | Form, Optional | ekahau or ibwave file |
+| `autoDeviceprofileAssignment` | `*bool` | Form, Optional | Whether to auto assign device to deviceprofile by name |
+| `csv` | `*models.FileWrapper` | Form, Optional | CSV file for ap name mapping, optional |
+| `file` | `*models.FileWrapper` | Form, Optional | Ekahau or ibwave file |
 | `json` | [`*models.MapImportJson`](../../doc/models/map-import-json.md) | Form, Optional | - |
 
 ## Response Type

doc/controllers/ms-ps-logs.md

@@ -112,13 +112,13 @@ ListMspAuditLogs(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `siteId` | `*string` | Query, Optional | site id |
-| `adminName` | `*string` | Query, Optional | admin name or email |
-| `message` | `*string` | Query, Optional | message |
-| `sort` | [`*models.ListMspLogsSortEnum`](../../doc/models/list-msp-logs-sort-enum.md) | Query, Optional | sort order |
-| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
-| `end` | `*int` | Query, Optional | end datetime, can be epoch or relative time like -1d, -2h; now if not specified |
-| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
+| `siteId` | `*string` | Query, Optional | Site id |
+| `adminName` | `*string` | Query, Optional | Admin name or email |
+| `message` | `*string` | Query, Optional | Message |
+| `sort` | [`*models.ListMspLogsSortEnum`](../../doc/models/list-msp-logs-sort-enum.md) | Query, Optional | Sort order |
+| `start` | `*int` | Query, Optional | Start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
+| `end` | `*int` | Query, Optional | End datetime, can be epoch or relative time like -1d, -2h; now if not specified |
+| `duration` | `*string` | Query, Optional | Duration like 7d, 2w<br>**Default**: `"1d"` |
 | `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
 | `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 

doc/controllers/ms-ps-orgs.md

@@ -102,7 +102,7 @@ if err != nil {
 
 # Delete Msp Org
 
-delete MSP Org
+Delete MSP Org
 
 ```go
 DeleteMspOrg(
@@ -433,10 +433,10 @@ SearchMspOrgs(
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
 | `name` | `*string` | Query, Optional | - |
-| `orgId` | `*uuid.UUID` | Query, Optional | org id |
-| `subInsufficient` | `*bool` | Query, Optional | if this org has sufficient subscription |
-| `trialEnabled` | `*bool` | Query, Optional | if this org is under trial period |
-| `usageTypes` | `[]string` | Query, Optional | a list of types that enabled by usage<br>**Constraints**: *Unique Items Required* |
+| `orgId` | `*uuid.UUID` | Query, Optional | Org id |
+| `subInsufficient` | `*bool` | Query, Optional | If this org has sufficient subscription |
+| `trialEnabled` | `*bool` | Query, Optional | If this org is under trial period |
+| `usageTypes` | `[]string` | Query, Optional | List of types that enabled by usage<br>**Constraints**: *Unique Items Required* |
 | `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
 
 ## Response Type

doc/controllers/ms-ps-sl-es.md

@@ -32,12 +32,12 @@ GetMspSle(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `metric` | `string` | Template, Required | see /api/v1/const/insight_metrics for available metrics |
-| `sle` | `*string` | Query, Optional | see /api/v1/const/insight_metrics for more details |
-| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
+| `metric` | `string` | Template, Required | See /api/v1/const/insight_metrics for available metrics |
+| `sle` | `*string` | Query, Optional | See /api/v1/const/insight_metrics for more details |
+| `duration` | `*string` | Query, Optional | Duration like 7d, 2w<br>**Default**: `"1d"` |
 | `interval` | `*string` | Query, Optional | Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to. |
-| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
-| `end` | `*int` | Query, Optional | end datetime, can be epoch or relative time like -1d, -2h; now if not specified |
+| `start` | `*int` | Query, Optional | Start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
+| `end` | `*int` | Query, Optional | End datetime, can be epoch or relative time like -1d, -2h; now if not specified |
 
 ## Response Type
 

doc/controllers/ms-ps-tickets.md

@@ -106,9 +106,9 @@ ListMspTickets(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
-| `end` | `*int` | Query, Optional | end datetime, can be epoch or relative time like -1d, -2h; now if not specified |
-| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
+| `start` | `*int` | Query, Optional | Start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
+| `end` | `*int` | Query, Optional | End datetime, can be epoch or relative time like -1d, -2h; now if not specified |
+| `duration` | `*string` | Query, Optional | Duration like 7d, 2w<br>**Default**: `"1d"` |
 
 ## Response Type
 

doc/controllers/ms-ps.md

@@ -214,12 +214,12 @@ SearchMspOrgGroup(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `mType` | [`models.MspSearchTypeEnum`](../../doc/models/msp-search-type-enum.md) | Query, Required | orgs |
-| `q` | `*string` | Query, Optional | search string |
+| `mType` | [`models.MspSearchTypeEnum`](../../doc/models/msp-search-type-enum.md) | Query, Required | Orgs |
+| `q` | `*string` | Query, Optional | Search string |
 | `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
-| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
-| `end` | `*int` | Query, Optional | end datetime, can be epoch or relative time like -1d, -2h; now if not specified |
-| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
+| `start` | `*int` | Query, Optional | Start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
+| `end` | `*int` | Query, Optional | End datetime, can be epoch or relative time like -1d, -2h; now if not specified |
+| `duration` | `*string` | Query, Optional | Duration like 7d, 2w<br>**Default**: `"1d"` |
 
 ## Response Type
 

doc/controllers/orgs-alarm-templates.md

@@ -289,7 +289,7 @@ ListOrgSuppressedAlarms(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `scope` | [`*models.SuppressedAlarmScopeEnum`](../../doc/models/suppressed-alarm-scope-enum.md) | Query, Optional | returns both scopes if not specified<br>**Default**: `"site"` |
+| `scope` | [`*models.SuppressedAlarmScopeEnum`](../../doc/models/suppressed-alarm-scope-enum.md) | Query, Optional | Returns both scopes if not specified<br>**Default**: `"site"` |
 
 ## Response Type
 

doc/controllers/orgs-alarms.md

@@ -215,9 +215,9 @@ CountOrgAlarms(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `distinct` | `*string` | Query, Optional | - |
-| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
-| `end` | `*int` | Query, Optional | end datetime, can be epoch or relative time like -1d, -2h; now if not specified |
-| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
+| `start` | `*int` | Query, Optional | Start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
+| `end` | `*int` | Query, Optional | End datetime, can be epoch or relative time like -1d, -2h; now if not specified |
+| `duration` | `*string` | Query, Optional | Duration like 7d, 2w<br>**Default**: `"1d"` |
 | `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
 | `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
@@ -306,11 +306,11 @@ SearchOrgAlarms(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `siteId` | `*uuid.UUID` | Query, Optional | site ID |
-| `mType` | `*string` | Query, Optional | alarm type |
-| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
-| `end` | `*int` | Query, Optional | end datetime, can be epoch or relative time like -1d, -2h; now if not specified |
-| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
+| `siteId` | `*uuid.UUID` | Query, Optional | Site ID |
+| `mType` | `*string` | Query, Optional | Alarm type |
+| `start` | `*int` | Query, Optional | Start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
+| `end` | `*int` | Query, Optional | End datetime, can be epoch or relative time like -1d, -2h; now if not specified |
+| `duration` | `*string` | Query, Optional | Duration like 7d, 2w<br>**Default**: `"1d"` |
 | `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
 
 ## Response Type

doc/controllers/orgs-antivirus-profiles.md

@@ -98,7 +98,7 @@ if err != nil {
 
 # Delete Org Antivirus Profile
 
-deleteOrgAntivirusProfile
+DeleteOrgAntivirusProfile
 
 ```go
 DeleteOrgAntivirusProfile(
@@ -290,7 +290,7 @@ if err != nil {
 
 # Update Org Antivirus Profile
 
-update Org Antivirus Profile
+Update Org Antivirus Profile
 
 ```go
 UpdateOrgAntivirusProfile(