v0.4.18

tmunzer · Dec 12, 2024 · d31337f · d31337f
1 parent 53c8ba2
commit d31337f
Show file tree

Hide file tree

Showing 83 changed files with 4,310 additions and 262 deletions.
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@
 
 ## Introduction
 
-> Version: **2412.1.1**
+> Version: **2412.1.2**
 > 
-> Date: **December 6, 2024**
+> Date: **December 12, 2024**
 
 ---
 

diff --git a/Third_Party_Code/NOTICES.md b/Third_Party_Code/NOTICES.md
@@ -2,8 +2,8 @@
 ## github.com/apimatic/go-core-runtime
 
 * Name: github.com/apimatic/go-core-runtime
-* Version: v0.0.26
-* License: [MIT](https://github.com/apimatic/go-core-runtime/blob/v0.0.26/LICENSE)
+* Version: v0.0.27
+* License: [MIT](https://github.com/apimatic/go-core-runtime/blob/v0.0.27/LICENSE)
 
 ```
 MIT License

diff --git a/doc/controllers/admins.md b/doc/controllers/admins.md
@@ -2,7 +2,7 @@
 
 Admin API calls can be used to create, manage or authenticate Mist administrators.
 
-To register administrators into an existing MSP account or Organization, please check: * [Invite Msp Admin]($e/MSPs%20Admins/inviteMspAdmin) * [Invite Org Admin]($e/Orgs%20Admins/inviteOrgAdmin)
+To register administrators into an existing MSP account or Organization, please check: * [Invite Msp Admin](../../doc/controllers/ms-ps-admins.md#invite-msp-admin) * [Invite Org Admin](../../doc/controllers/orgs-admins.md#invite-org-admin)
 
 ```go
 admins := client.Admins()

diff --git a/doc/controllers/constants-definitions.md b/doc/controllers/constants-definitions.md
@@ -1265,7 +1265,7 @@ ListStates(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `countryCode` | `string` | Query, Required | country code, in [two-character]($e/Constants%20Definitions/listCountryCodes) |
+| `countryCode` | `string` | Query, Required | country code, in [two-character](../../doc/controllers/constants-definitions.md#list-country-codes) |
 
 ## Response Type
 

diff --git a/doc/controllers/constants-models.md b/doc/controllers/constants-models.md
@@ -180,6 +180,90 @@ if err != nil {
 }
 ```
 
+## Example Response
+
+```
+[
+  {
+    "ap_type": "jewel",
+    "band24": {
+      "band5_channels_op": "low",
+      "max_clients": 128,
+      "max_power": 19,
+      "min_power": 8
+    },
+    "band5": {
+      "max_clients": 128,
+      "max_power": 17,
+      "min_power": 8
+    },
+    "band6": {
+      "max_clients": 128,
+      "max_power": 17,
+      "min_power": 8
+    },
+    "band_24_usages": [
+      "5"
+    ],
+    "ce_dfs_ok": true,
+    "cisco_pace": true,
+    "description": "AP-45",
+    "disallowed_channels": {
+      "property1": {
+        "property1": [
+          0
+        ],
+        "property2": [
+          0
+        ]
+      },
+      "property2": {
+        "property1": [
+          0
+        ],
+        "property2": [
+          0
+        ]
+      }
+    },
+    "display": "AP45",
+    "fcc_dfs_ok": true,
+    "has_11ax": true,
+    "has_compass": false,
+    "has_ext_ant": true,
+    "has_extio": false,
+    "has_height": false,
+    "has_module_port": true,
+    "has_poe_out": true,
+    "has_scanning_radio": true,
+    "has_selectable_radio": true,
+    "has_usb": true,
+    "has_vble": true,
+    "has_wifi_band24": true,
+    "has_wifi_band5": true,
+    "has_wifi_band6": true,
+    "max_poe_out": 15400,
+    "max_wlans": 0,
+    "model": "AP45",
+    "other_dfs_ok": true,
+    "outdoor": false,
+    "radios": {
+      "r0": "6",
+      "r1": "5",
+      "r2": "24"
+    },
+    "shared_scanning_radio": true,
+    "type": "ap",
+    "unmanaged": true,
+    "vble": {
+      "beacon_rate": 4,
+      "beams": 9,
+      "power": 8
+    }
+  }
+]
+```
+
 ## Errors
 
 | HTTP Status Code | Error Description | Exception Class |

diff --git a/doc/controllers/orgs-clients-nac.md b/doc/controllers/orgs-clients-nac.md
@@ -40,7 +40,7 @@ CountOrgNacClientEvents(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `distinct` | [`*models.OrgNacClientEventsCountDistinctEnum`](../../doc/models/org-nac-client-events-count-distinct-enum.md) | Query, Optional | - |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listNacEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-nac-events-definitions) |
 | `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"` |
@@ -310,7 +310,7 @@ SearchOrgNacClientEvents(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listNacEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-nac-events-definitions) |
 | `nacruleId` | `*uuid.UUID` | Query, Optional | NAC Policy Rule ID, if matched |
 | `nacruleMatched` | `*bool` | Query, Optional | NAC Policy Rule Matched |
 | `dryrunNacruleId` | `*string` | Query, Optional | NAC Policy Dry Run Rule ID, if present and matched |

diff --git a/doc/controllers/orgs-clients-wan.md b/doc/controllers/orgs-clients-wan.md
@@ -40,7 +40,7 @@ CountOrgWanClientEvents(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `distinct` | [`*models.OrgWanClientsEventsCountDistinctEnum`](../../doc/models/org-wan-clients-events-count-distinct-enum.md) | Query, Optional | **Default**: `"type"` |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listDeviceEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-device-events-definitions) |
 | `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"` |
@@ -227,7 +227,7 @@ SearchOrgWanClientEvents(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listDeviceEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-device-events-definitions) |
 | `mac` | `*string` | Query, Optional | partial / full MAC address |
 | `hostname` | `*string` | Query, Optional | partial / full hostname |
 | `ip` | `*string` | Query, Optional | client IP |

diff --git a/doc/controllers/orgs-clients-wired.md b/doc/controllers/orgs-clients-wired.md
@@ -18,7 +18,7 @@ orgsClientsWired := client.OrgsClientsWired()
 
 Count by Distinct Attributes of Clients
 
-Note: For list of avaialable `type` values, please refer to [listClientEventsDefinitions]($e/Constants%20Events/listClientEventsDefinitions)
+Note: For list of avaialable `type` values, please refer to [listClientEventsDefinitions](../../doc/controllers/constants-events.md#list-client-events-definitions)
 
 ```go
 CountOrgWiredClients(
@@ -112,7 +112,7 @@ if err != nil {
 
 Search for Wired Clients in org
 
-Note: For list of avaialable `type` values, please refer to [listClientEventsDefinitions]($e/Constants%20Events/listClientEventsDefinitions)
+Note: For list of avaialable `type` values, please refer to [listClientEventsDefinitions](../../doc/controllers/constants-events.md#list-client-events-definitions)
 
 ```go
 SearchOrgWiredClients(

diff --git a/doc/controllers/orgs-clients-wireless.md b/doc/controllers/orgs-clients-wireless.md
@@ -298,7 +298,7 @@ SearchOrgWirelessClientEvents(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listDeviceEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-device-events-definitions) |
 | `reasonCode` | `*int` | Query, Optional | for assoc/disassoc events |
 | `ssid` | `*string` | Query, Optional | SSID Name |
 | `ap` | `*string` | Query, Optional | AP MAC |

diff --git a/doc/controllers/orgs-device-profiles.md b/doc/controllers/orgs-device-profiles.md
@@ -528,6 +528,103 @@ if err != nil {
 }
 ```
 
+## Example Response
+
+```
+[
+  {
+    "aeroscout": {
+      "enabled": false,
+      "host": "aero.pvt.net",
+      "locate_connected": true
+    },
+    "ble_config": {
+      "beacon_enabled": false,
+      "beacon_rate": 3,
+      "beacon_rate_mode": "custom",
+      "beam_disabled": [
+        1,
+        3,
+        6
+      ],
+      "custom_ble_packet_enabled": false,
+      "custom_ble_packet_frame": "0x........",
+      "custom_ble_packet_freq_msec": 300,
+      "eddystone_uid_adv_power": -65,
+      "eddystone_uid_beams": "2-4,7",
+      "eddystone_uid_enabled": false,
+      "eddystone_uid_freq_msec": 200,
+      "eddystone_uid_instance": "5c5b35000001",
+      "eddystone_uid_namespace": "2818e3868dec25629ede",
+      "eddystone_url_adv_power": -65,
+      "eddystone_url_beams": "2-4,7",
+      "eddystone_url_enabled": true,
+      "eddystone_url_freq_msec": 1000,
+      "eddystone_url_url": "https://www.abc.com",
+      "ibeacon_adv_power": -65,
+      "ibeacon_beams": "2-4,7",
+      "ibeacon_enabled": false,
+      "ibeacon_freq_msec": 0,
+      "ibeacon_major": 13,
+      "ibeacon_minor": 138,
+      "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
+      "power": 7,
+      "power_mode": "custom"
+    },
+    "created_time": 0,
+    "disable_eth1": false,
+    "disable_eth2": false,
+    "disable_eth3": false,
+    "disable_module": false,
+    "for_site": true,
+    "height": 0,
+    "id": "497f6eca-6276-4993-bfeb-53cbbbba6108",
+    "ip_config": {
+      "dns": [
+        "8.8.8.8",
+        "4.4.4.4"
+      ],
+      "dns_suffix": [
+        ".mist.local",
+        ".mist.com"
+      ],
+      "gateway": "10.2.1.254",
+      "gateway6": "2607:f8b0:4005:808::1",
+      "ip": "10.2.1.1",
+      "ip6": "2607:f8b0:4005:808::2004",
+      "netmask": "255.255.255.0",
+      "netmask6": "/32",
+      "type": "static",
+      "type6": "static",
+      "vlan_id": 1
+    },
+    "led": {
+      "brightness": 255,
+      "enabled": true
+    },
+    "map_id": "09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1",
+    "mesh": {
+      "enabled": false,
+      "group": 1,
+      "role": "base"
+    },
+    "modified_time": 0,
+    "name": "string",
+    "notes": "string",
+    "ntp_servers": [
+      "string"
+    ],
+    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
+    "orientation": 0,
+    "poe_passthrough": false,
+    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
+    "type": "ap",
+    "x": 0,
+    "y": 0
+  }
+]
+```
+
 ## Errors
 
 | HTTP Status Code | Error Description | Exception Class |

diff --git a/doc/controllers/orgs-devices-others.md b/doc/controllers/orgs-devices-others.md
@@ -44,7 +44,7 @@ CountOrgOtherDeviceEvents(
 |  --- | --- | --- | --- |
 | `orgId` | `uuid.UUID` | Template, Required | - |
 | `distinct` | [`*models.OrgOtherdevicesEventsCountDistinctEnum`](../../doc/models/org-otherdevices-events-count-distinct-enum.md) | Query, Optional | **Default**: `"mac"` |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listOtherDeviceEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-other-device-events-definitions) |
 | `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"` |
@@ -418,7 +418,7 @@ SearchOrgOtherDeviceEvents(
 | `deviceMac` | `*string` | Query, Optional | mac of attached device |
 | `model` | `*string` | Query, Optional | device model |
 | `vendor` | `*string` | Query, Optional | vendor name |
-| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listOtherDeviceEventsDefinitions) |
+| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions](../../doc/controllers/constants-events.md#list-other-device-events-definitions) |
 | `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"` |