dashboard-api 0.4.0 → 0.9.0

data/doc/_index.html

@@ -78,6 +78,19 @@
     <td valign='top' width="33%">
       
         
+        <ul id="alpha_A" class="alpha">
+          <li class="letter">A</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
         <ul id="alpha_C" class="alpha">
           <li class="letter">C</li>
           <ul>
@@ -140,10 +153,28 @@
         </ul>
       
         
+        <ul id="alpha_P" class="alpha">
+          <li class="letter">P</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
         <ul id="alpha_S" class="alpha">
           <li class="letter">S</li>
           <ul>
             
+              <li>
+                <span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span>
+                
+              </li>
+            
               <li>
                 <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>
                 
@@ -157,6 +188,35 @@
           </ul>
         </ul>
       
+        
+          </td><td valign='top' width="33%">
+          
+        
+        <ul id="alpha_T" class="alpha">
+          <li class="letter">T</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_V" class="alpha">
+          <li class="letter">V</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
     </td>
   </tr>
 </table>
@@ -166,7 +226,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Nov 15 22:02:44 2016 by
+  Generated on Wed Nov 16 21:55:07 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/doc/class_list.html

@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_Clients' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPI' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span> &lt; Object<small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPIVersion' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Devices' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Networks' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Organizations' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_SSIDs' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Switchports' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span><small class='search_info'>Top Level Namespace</small></div></li>
+<li id='object_Admins' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Clients' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPI' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span> &lt; Object<small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPIVersion' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Devices' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Networks' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Organizations' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Phones' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_SAML' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_SSIDs' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Switchports' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Templates' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_VLANs' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span><small class='search_info'>Top Level Namespace</small></div></li>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -60,7 +60,7 @@
       <iframe id="search_frame" src="file_list.html"></iframe>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-Dashboard+API+v0.3.0">Dashboard API v0.3.0</h1>
+<h1 id="label-Dashboard+API+v0.9.0">Dashboard API v0.9.0</h1>
 
 <p>A ruby implementation of the <a
 href="https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API">Meraki
@@ -157,12 +157,17 @@ access policies, etc.</p>
 <p><code>mx_serial</code> A test MX that has client traffic passing through it</p>
 </li><li>
 <p><code>spare_mr</code> A test MR used to claim in and out of networks</p>
+</li><li>
+<p><code>test_admin_id</code> The ID of a test admin used to test updating and
+deleting admins</p>
+</li><li>
+<p><code>config_template_id</code> A test configuration template network ID
+used to test removing a template It is recommended that you set up a test
+organization with test devices in it when working with developing new
+functionality to this gem, as to not potentially disturb any of your
+production networks.</p>
 </li></ul>
 
-<p>It is recommended that you set up a test organization with test devices in
-it when working with developing new functionality to this gem, as to not
-potentially disturb any of your production networks.</p>
-
 <p>Once those are set and dependencies are installed, you can run the tests
 with <code> rake test </code></p>
 
@@ -201,7 +206,7 @@ set as ENV variables above.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Nov 15 22:02:45 2016 by
+  Generated on Wed Nov 16 21:55:08 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/doc/index.html

@@ -60,7 +60,7 @@
       <iframe id="search_frame" src="class_list.html"></iframe>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-Dashboard+API+v0.3.0">Dashboard API v0.3.0</h1>
+<h1 id="label-Dashboard+API+v0.9.0">Dashboard API v0.9.0</h1>
 
 <p>A ruby implementation of the <a
 href="https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API">Meraki
@@ -157,12 +157,17 @@ access policies, etc.</p>
 <p><code>mx_serial</code> A test MX that has client traffic passing through it</p>
 </li><li>
 <p><code>spare_mr</code> A test MR used to claim in and out of networks</p>
+</li><li>
+<p><code>test_admin_id</code> The ID of a test admin used to test updating and
+deleting admins</p>
+</li><li>
+<p><code>config_template_id</code> A test configuration template network ID
+used to test removing a template It is recommended that you set up a test
+organization with test devices in it when working with developing new
+functionality to this gem, as to not potentially disturb any of your
+production networks.</p>
 </li></ul>
 
-<p>It is recommended that you set up a test organization with test devices in
-it when working with developing new functionality to this gem, as to not
-potentially disturb any of your production networks.</p>
-
 <p>Once those are set and dependencies are installed, you can run the tests
 with <code> rake test </code></p>
 
@@ -201,7 +206,7 @@ set as ENV variables above.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Nov 15 22:02:45 2016 by
+  Generated on Wed Nov 16 21:55:07 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/doc/method_list.html

@@ -44,6 +44,38 @@
       <ul id="full_list" class="method">
         
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Admins.html#add_admin-instance_method" title="Admins#add_admin (method)">#add_admin</a></span>
+      <small>Admins</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Phones.html#add_phone_contact-instance_method" title="Phones#add_phone_contact (method)">#add_phone_contact</a></span>
+      <small>Phones</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="VLANs.html#add_vlan-instance_method" title="VLANs#add_vlan (method)">#add_vlan</a></span>
+      <small>VLANs</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Networks.html#bind_network_to_template-instance_method" title="Networks#bind_network_to_template (method)">#bind_network_to_template</a></span>
+      <small>Networks</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Devices.html#claim_device_into_network-instance_method" title="Devices#claim_device_into_network (method)">#claim_device_into_network</a></span>
@@ -61,6 +93,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="SAML.html#create_saml_role-instance_method" title="SAML#create_saml_role (method)">#create_saml_role</a></span>
+      <small>SAML</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#delete_network-instance_method" title="Networks#delete_network (method)">#delete_network</a></span>
       <small>Networks</small>
@@ -68,7 +108,23 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Phones.html#delete_phone_contact-instance_method" title="Phones#delete_phone_contact (method)">#delete_phone_contact</a></span>
+      <small>Phones</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="VLANs.html#delete_vlan-instance_method" title="VLANs#delete_vlan (method)">#delete_vlan</a></span>
+      <small>VLANs</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#get_auto_vpn_settings-instance_method" title="Networks#get_auto_vpn_settings (method)">#get_auto_vpn_settings</a></span>
       <small>Networks</small>
@@ -76,7 +132,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Clients.html#get_client_info_for_device-instance_method" title="Clients#get_client_info_for_device (method)">#get_client_info_for_device</a></span>
       <small>Clients</small>
@@ -84,7 +140,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Devices.html#get_device_uplink_stats-instance_method" title="Devices#get_device_uplink_stats (method)">#get_device_uplink_stats</a></span>
       <small>Devices</small>
@@ -92,7 +148,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_inventory-instance_method" title="Organizations#get_inventory (method)">#get_inventory</a></span>
       <small>Organizations</small>
@@ -100,7 +156,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_license_state-instance_method" title="Organizations#get_license_state (method)">#get_license_state</a></span>
       <small>Organizations</small>
@@ -108,7 +164,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#get_ms_access_policies-instance_method" title="Networks#get_ms_access_policies (method)">#get_ms_access_policies</a></span>
       <small>Networks</small>
@@ -116,7 +172,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#get_networks-instance_method" title="Networks#get_networks (method)">#get_networks</a></span>
       <small>Networks</small>
@@ -124,7 +180,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_organization-instance_method" title="Organizations#get_organization (method)">#get_organization</a></span>
       <small>Organizations</small>
@@ -132,7 +188,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Devices.html#get_single_device-instance_method" title="Devices#get_single_device (method)">#get_single_device</a></span>
       <small>Devices</small>
@@ -140,7 +196,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#get_single_network-instance_method" title="Networks#get_single_network (method)">#get_single_network</a></span>
       <small>Networks</small>
@@ -148,7 +204,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="SSIDs.html#get_single_ssid-instance_method" title="SSIDs#get_single_ssid (method)">#get_single_ssid</a></span>
       <small>SSIDs</small>
@@ -156,7 +212,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Switchports.html#get_single_switch_port-instance_method" title="Switchports#get_single_switch_port (method)">#get_single_switch_port</a></span>
       <small>Switchports</small>
@@ -164,7 +220,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_snmp_status-instance_method" title="Organizations#get_snmp_status (method)">#get_snmp_status</a></span>
       <small>Organizations</small>
@@ -172,7 +228,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Switchports.html#get_switch_ports-instance_method" title="Switchports#get_switch_ports (method)">#get_switch_ports</a></span>
       <small>Switchports</small>
@@ -180,7 +236,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_third_party_peers-instance_method" title="Organizations#get_third_party_peers (method)">#get_third_party_peers</a></span>
       <small>Organizations</small>
@@ -188,7 +244,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="DashboardAPI.html#initialize-instance_method" title="DashboardAPI#initialize (method)">#initialize</a></span>
       <small>DashboardAPI</small>
@@ -196,7 +252,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="DashboardAPI.html#key-instance_method" title="DashboardAPI#key (method)">#key</a></span>
       <small>DashboardAPI</small>
@@ -204,6 +260,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Admins.html#list_admins-instance_method" title="Admins#list_admins (method)">#list_admins</a></span>
+      <small>Admins</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Devices.html#list_devices_in_network-instance_method" title="Devices#list_devices_in_network (method)">#list_devices_in_network</a></span>
@@ -212,6 +276,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Phones.html#list_phone_contacts-instance_method" title="Phones#list_phone_contacts (method)">#list_phone_contacts</a></span>
+      <small>Phones</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="SAML.html#list_saml_roles-instance_method" title="SAML#list_saml_roles (method)">#list_saml_roles</a></span>
+      <small>SAML</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="SSIDs.html#list_ssids_in_network-instance_method" title="SSIDs#list_ssids_in_network (method)">#list_ssids_in_network</a></span>
@@ -220,6 +300,22 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Templates.html#list_templates-instance_method" title="Templates#list_templates (method)">#list_templates</a></span>
+      <small>Templates</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="VLANs.html#list_vlans-instance_method" title="VLANs#list_vlans (method)">#list_vlans</a></span>
+      <small>VLANs</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="DashboardAPI.html#make_api_call-instance_method" title="DashboardAPI#make_api_call (method)">#make_api_call</a></span>
@@ -236,6 +332,70 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="SAML.html#remove_saml_role-instance_method" title="SAML#remove_saml_role (method)">#remove_saml_role</a></span>
+      <small>SAML</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Templates.html#remove_template-instance_method" title="Templates#remove_template (method)">#remove_template</a></span>
+      <small>Templates</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="SAML.html#return_saml_role-instance_method" title="SAML#return_saml_role (method)">#return_saml_role</a></span>
+      <small>SAML</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="VLANs.html#return_vlan-instance_method" title="VLANs#return_vlan (method)">#return_vlan</a></span>
+      <small>VLANs</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Admins.html#revoke_admin-instance_method" title="Admins#revoke_admin (method)">#revoke_admin</a></span>
+      <small>Admins</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Networks.html#traffic_analysis-instance_method" title="Networks#traffic_analysis (method)">#traffic_analysis</a></span>
+      <small>Networks</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Networks.html#unbind_network_to_template-instance_method" title="Networks#unbind_network_to_template (method)">#unbind_network_to_template</a></span>
+      <small>Networks</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Admins.html#update_admin-instance_method" title="Admins#update_admin (method)">#update_admin</a></span>
+      <small>Admins</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#update_auto_vpn_settings-instance_method" title="Networks#update_auto_vpn_settings (method)">#update_auto_vpn_settings</a></span>
@@ -260,6 +420,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Phones.html#update_phone_contact-instance_method" title="Phones#update_phone_contact (method)">#update_phone_contact</a></span>
+      <small>Phones</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="SAML.html#update_saml_role-instance_method" title="SAML#update_saml_role (method)">#update_saml_role</a></span>
+      <small>SAML</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="SSIDs.html#update_single_ssid-instance_method" title="SSIDs#update_single_ssid (method)">#update_single_ssid</a></span>
@@ -276,6 +452,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="VLANs.html#update_vlan-instance_method" title="VLANs#update_vlan (method)">#update_vlan</a></span>
+      <small>VLANs</small>
+    </div>
+  </li>
+  
+
 
       </ul>
     </div>