v0.3.9

README.md

@@ -3,9 +3,9 @@
 
 ## Introduction
 
-> Version: **2408.1.8**
+> Version: **2408.1.9**
 > 
-> Date: **September 5, 2024**
+> Date: **September 9, 2024**
 
 ---
 
@@ -55,6 +55,14 @@ require mistapi v0.0.0
 
 - Resolve the dependencies in the updated `go.mod` file, using the `go get` command.
 
+## Test the SDK
+
+`Go Testing` is used as the testing framework. To run the unit tests of the SDK, navigate to the root directory of the SDK and run the following command in the terminal:
+
+```bash
+$ go test
+```
+
 ## Initialize the API Client
 
 **_Note:_** Documentation for the client can be found [here.](doc/client.md)

doc/controllers/admins.md

@@ -36,7 +36,7 @@ GetAdminRegistrationInfo(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `recaptchaFlavor` | [`*models.RecaptchaFlavorEnum`](../../doc/models/recaptcha-flavor-enum.md) | Query, Optional | - |
+| `recaptchaFlavor` | [`*models.RecaptchaFlavorEnum`](../../doc/models/recaptcha-flavor-enum.md) | Query, Optional | **Default**: `"google"` |
 
 ## Response Type
 

doc/controllers/constants-definitions.md

@@ -96,7 +96,7 @@ ListApChannels(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `countryCode` | `*string` | Query, Optional | country code, in two-character |
+| `countryCode` | `*string` | Query, Optional | country code, in two-character<br>**Constraints**: *Pattern*: `^[a-zA-Z]{2}$` |
 
 ## Response Type
 

doc/controllers/installer.md

@@ -78,7 +78,7 @@ AddInstallerDeviceImage(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `imageName` | `string` | Template, Required | - |
-| `deviceMac` | `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 |
@@ -149,7 +149,7 @@ ClaimInstallerDevices(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `body` | `[]string` | Body, Optional | Request Body |
+| `body` | `[]string` | Body, Optional | Request Body<br>**Constraints**: *Unique Items Required* |
 
 ## Response Type
 
@@ -207,6 +207,9 @@ if err != nil {
       "serial": "FXLH2015150027",
       "type": "ap"
     }
+  ],
+  "reason": [
+    "belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))"
   ]
 }
 ```
@@ -215,7 +218,7 @@ if err != nil {
 
 | HTTP Status Code | Error Description | Exception Class |
 |  --- | --- | --- |
-| 400 | Bad Request if none of the entries are valid | `ApiError` |
+| 400 | OK - if any of entries are valid or there’s no errors | [`ResponseInventoryErrorException`](../../doc/models/response-inventory-error-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 | Not found. The API endpoint doesn’t exist or resource doesn’ t exist | [`ResponseHttp404Exception`](../../doc/models/response-http-404-exception.md) |
@@ -562,7 +565,7 @@ DeleteInstallerDeviceImage(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `imageName` | `string` | Template, Required | - |
-| `deviceMac` | `string` | Template, Required | - |
+| `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
 
 ## Response Type
 
@@ -915,7 +918,7 @@ ListInstallerDeviceProfiles(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `mType` | [`*models.DeviceTypeEnum`](../../doc/models/device-type-enum.md) | Query, Optional | - |
+| `mType` | [`*models.DeviceTypeEnum`](../../doc/models/device-type-enum.md) | Query, Optional | **Default**: `"ap"` |
 
 ## Response Type
 
@@ -987,8 +990,8 @@ ListInstallerListOfRenctlyClaimedDevices(
 | `model` | `*string` | Query, Optional | Device Model |
 | `siteName` | `*string` | Query, Optional | Site Name |
 | `siteId` | `*uuid.UUID` | Query, Optional | Site ID |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 
@@ -1466,7 +1469,7 @@ ProvisionInstallerDevices(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `deviceMac` | `string` | Template, Required | - |
+| `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
 | `body` | [`*models.InstallerProvisionDevice`](../../doc/models/installer-provision-device.md) | Body, Optional | Request Body |
 
 ## Response Type
@@ -1530,7 +1533,7 @@ StartInstallerLocateDevice(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `deviceMac` | `string` | Template, Required | - |
+| `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
 
 ## Response Type
 
@@ -1582,7 +1585,7 @@ StopInstallerLocateDevice(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `deviceMac` | `string` | Template, Required | - |
+| `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
 
 ## Response Type
 
@@ -1634,7 +1637,7 @@ UnassignInstallerRecentlyClaimedDevice(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `deviceMac` | `string` | Template, Required | - |
+| `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
 
 ## Response Type
 

doc/controllers/ms-ps-inventory.md

@@ -27,7 +27,7 @@ GetMspInventoryByMac(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `deviceMac` | `string` | Template, Required | - |
+| `deviceMac` | `string` | Template, Required | **Constraints**: *Pattern*: `^[0-9a-fA-F]{12}$` |
 
 ## Response Type
 

doc/controllers/ms-ps-logs.md

@@ -32,7 +32,7 @@ CountMspAuditLogs(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `distinct` | [`*models.MspLogsCountDistinctEnum`](../../doc/models/msp-logs-count-distinct-enum.md) | Query, Optional | - |
+| `distinct` | [`*models.MspLogsCountDistinctEnum`](../../doc/models/msp-logs-count-distinct-enum.md) | Query, Optional | **Default**: `"admin_name"` |
 
 ## Response Type
 
@@ -118,9 +118,9 @@ ListMspAuditLogs(
 | `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 |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `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` |
 
 ## Response Type
 

doc/controllers/ms-ps-marvis.md

@@ -29,9 +29,9 @@ CountMspsMarvisActions(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `distinct` | [`*models.MspMarvisSuggestionsCountDistinctEnum`](../../doc/models/msp-marvis-suggestions-count-distinct-enum.md) | Query, Optional | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `distinct` | [`*models.MspMarvisSuggestionsCountDistinctEnum`](../../doc/models/msp-marvis-suggestions-count-distinct-enum.md) | Query, Optional | **Default**: `"org_id"` |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 

doc/controllers/ms-ps-orgs.md

@@ -243,8 +243,8 @@ ListMspOrgStats(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 
@@ -436,8 +436,8 @@ SearchMspOrgs(
 | `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 |
-| `limit` | `*int` | Query, Optional | - |
+| `usageTypes` | `[]string` | Query, Optional | a 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

@@ -34,7 +34,7 @@ GetMspSle(
 | `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 |
+| `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 |

doc/controllers/ms-ps-tickets.md

@@ -32,7 +32,7 @@ CountMspTickets(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `mspId` | `uuid.UUID` | Template, Required | - |
-| `distinct` | [`*models.MspTicketsCountDistinctEnum`](../../doc/models/msp-tickets-count-distinct-enum.md) | Query, Optional | - |
+| `distinct` | [`*models.MspTicketsCountDistinctEnum`](../../doc/models/msp-tickets-count-distinct-enum.md) | Query, Optional | **Default**: `"status"` |
 
 ## Response Type
 
@@ -108,7 +108,7 @@ ListMspTickets(
 | `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 |
+| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
 
 ## Response Type
 

doc/controllers/ms-ps.md

@@ -216,10 +216,10 @@ SearchMspOrgGroup(
 | `mspId` | `uuid.UUID` | Template, Required | - |
 | `mType` | [`models.MspSearchTypeEnum`](../../doc/models/msp-search-type-enum.md) | Query, Required | orgs |
 | `q` | `*string` | Query, Optional | search string |
-| `limit` | `*int` | Query, Optional | - |
+| `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 |
+| `duration` | `*string` | Query, Optional | duration like 7d, 2w<br>**Default**: `"1d"` |
 
 ## Response Type
 

doc/controllers/orgs-alarm-templates.md

@@ -236,8 +236,8 @@ ListOrgAlarmTemplates(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 
@@ -293,7 +293,7 @@ ListOrgSuppressedAlarms(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `scope` | [`*models.SuppressedAlarmScopeEnum`](../../doc/models/suppressed-alarm-scope-enum.md) | Query, Optional | - |
+| `scope` | [`*models.SuppressedAlarmScopeEnum`](../../doc/models/suppressed-alarm-scope-enum.md) | Query, Optional | **Default**: `"site"` |
 
 ## Response Type
 

doc/controllers/orgs-alarms.md

@@ -217,9 +217,9 @@ CountOrgAlarms(
 | `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 |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `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` |
 
 ## Response Type
 
@@ -310,8 +310,8 @@ SearchOrgAlarms(
 | `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 |
-| `limit` | `*int` | Query, Optional | - |
+| `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

@@ -231,8 +231,8 @@ ListOrgAntivirusProfiles(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 

doc/controllers/orgs-ap-templates.md

@@ -774,8 +774,8 @@ ListOrgAptemplates(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 

doc/controllers/orgs-asset-filters.md

@@ -247,8 +247,8 @@ ListOrgAssetFilters(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type
 

doc/controllers/orgs-assets.md

@@ -295,8 +295,8 @@ ListOrgAssets(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `limit` | `*int` | Query, Optional | - |
-| `page` | `*int` | Query, Optional | - |
+| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
+| `page` | `*int` | Query, Optional | **Default**: `1`<br>**Constraints**: `>= 1` |
 
 ## Response Type