dashboard-api 0.9.0 → 1.0.0

data/doc/method_list.html

@@ -77,6 +77,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#claim-instance_method" title="Organizations#claim (method)">#claim</a></span>
+      <small>Organizations</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <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>
       <small>Devices</small>
@@ -84,6 +92,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#clone_organization-instance_method" title="Organizations#clone_organization (method)">#clone_organization</a></span>
+      <small>Organizations</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Networks.html#create_network-instance_method" title="Networks#create_network (method)">#create_network</a></span>
@@ -93,6 +109,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#create_organization-instance_method" title="Organizations#create_organization (method)">#create_organization</a></span>
+      <small>Organizations</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <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>
@@ -100,7 +124,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -108,7 +132,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -116,7 +140,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -124,7 +148,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -132,7 +156,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -140,7 +164,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -148,7 +172,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -156,7 +180,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -164,7 +188,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -172,7 +196,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -180,7 +204,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -188,7 +212,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -196,7 +220,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -204,7 +228,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -212,7 +236,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -220,15 +244,15 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
+      <span class='object_link'><a href="Organizations.html#get_snmp_settings-instance_method" title="Organizations#get_snmp_settings (method)">#get_snmp_settings</a></span>
       <small>Organizations</small>
     </div>
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -236,7 +260,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -244,7 +268,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="DashboardAPI.html#initialize-instance_method" title="DashboardAPI#initialize (method)">#initialize</a></span>
       <small>DashboardAPI</small>
@@ -252,7 +276,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="DashboardAPI.html#key-instance_method" title="DashboardAPI#key (method)">#key</a></span>
       <small>DashboardAPI</small>
@@ -260,7 +284,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -268,6 +292,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#list_all_organizations-instance_method" title="Organizations#list_all_organizations (method)">#list_all_organizations</a></span>
+      <small>Organizations</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>
@@ -421,6 +453,14 @@
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#update_organization-instance_method" title="Organizations#update_organization (method)">#update_organization</a></span>
+      <small>Organizations</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <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>
@@ -428,7 +468,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -436,7 +476,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
       <small>SSIDs</small>
@@ -444,6 +484,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#update_snmp_settings-instance_method" title="Organizations#update_snmp_settings (method)">#update_snmp_settings</a></span>
+      <small>Organizations</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Switchports.html#update_switchport-instance_method" title="Switchports#update_switchport (method)">#update_switchport</a></span>
@@ -453,6 +501,14 @@
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Organizations.html#update_third_party_peers-instance_method" title="Organizations#update_third_party_peers (method)">#update_third_party_peers</a></span>
+      <small>Organizations</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <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>

data/doc/top-level-namespace.html

@@ -104,7 +104,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Nov 16 21:55:08 2016 by
+  Generated on Thu Nov 17 22:15:38 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/lib/dashboard-api.rb

@@ -66,7 +66,9 @@ class DashboardAPI
       end
     when 'PUT'
       res = HTTParty.put("#{self.class.base_uri}/#{endpoint_url}", options)
-      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors']
+      # needs to check for is an array, because when you update a 3rd party VPN peer, it returns as an array
+      # if you screw something up, it returns as a Hash, and will hit the normal if res['errors'
+      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors'] unless JSON.parse(res.body).is_a? Array
       raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
       return JSON.parse(res.body)
     when 'DELETE'

data/lib/dashboard-api/version.rb

@@ -2,5 +2,5 @@
 # @author Joe Letizia
 module DashboardAPIVersion
   # Current version number of the gem
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/networks.rb

@@ -7,7 +7,7 @@ module Networks
   def get_networks(org_id)
     self.make_api_call("/organizations/#{org_id}/networks", 'GET')
   end
-  
+
   # Returns the network details for a single network
   # @param [String] network_id dashboard network ID
   # @return [Hash] a hash containing the network details of the specific network
@@ -26,7 +26,7 @@ module Networks
     options = {:body => options}
     self.make_api_call("/networks/#{network_id}",'PUT', options)
   end
-  
+
   # Create a new Dashboard network
   # @param [String] org_id dashboard organization ID
   # @param [Hash] options a hash containing the following options:
@@ -39,23 +39,22 @@ module Networks
     options = {:body => options}
     self.make_api_call("/organizations/#{org_id}/networks", 'POST', options)
   end
-  
+
   # Delete an existing Dashboard network
   # @param [String] network_id dashboard netwok ID to delete
-  # @return [Bool] status true if the network was deleted, false if not 
+  # @return [Bool] status true if the network was deleted, false if not
   def delete_network(network_id)
     res = self.make_api_call("/networks/#{network_id}", 'DELETE')
-    puts res
     return res.code == 204 ? true : false
   end
-  
+
   # Get AutoVPN settings for a specific network
   # @param [String] network_id dashboard network ID to get AutoVPN settings for
   # @return [Hash] a hash containing the AutoVPN details for the network
   def get_auto_vpn_settings(network_id)
     res = self.make_api_call("/networks/#{network_id}/siteToSiteVpn", 'GET')
   end
-  
+
   # Update AutoVPN for a specific network
   # @param [String] network_id dashboard network ID to update AutoVPN settings for
   # @param [Hash] options options hash containing the following options:
@@ -69,7 +68,7 @@ module Networks
     options = {:body => options}
     res = self.make_api_call("/networks/#{network_id}/siteToSiteVpn", 'PUT', options)
   end
-  
+
   # Get all MS access policies configured for a specific Dashboard network
   # @param [String] network_id dashboard network ID to get MS policies for
   # @return [Array] an array of hashes for containing the policy information

data/lib/organizations.rb

@@ -25,10 +25,23 @@ module Organizations
   # Returns the current SNMP status for an organization
   # @param [String] org_id dashboard organization ID
   # @return [Hash] a hash containing all SNMP configuration information for an organization
-  def get_snmp_status(org_id)
+  def get_snmp_settings(org_id)
     self.make_api_call("/organizations/#{org_id}/snmp", 'GET')
   end
 
+  # Updates the current SNMP status for an organization
+  # @param [String] org_id dashboard organization ID
+  # @param [Hash] options a hash containing all updated SNMP configuration information for an organization. Please
+  #   refer to official Dashboard API documentation for more information on these options: v2cEnabled, v3Enabled,
+  #   v3AuthMode, v3AuthPass, v3PrivMode, v3PrivPass, peerIps
+  # @return [Hash] a hash containing all SNMP configuration information for an organization
+  def update_snmp_settings(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/snmp", 'PUT', options)
+  end
+
   # Returns the configurations for an organizations 3rd party VPN peers
   # @param [String] org_id dashboard organization ID
   # @return [Array] an arrry of hashes containing the configuration information
@@ -36,4 +49,67 @@ module Organizations
   def get_third_party_peers(org_id)
     self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'GET')
   end
+
+  # Updates your third party peers
+  # @param [String] org_id dashboard organization ID
+  # @params [Array] options An array of Hashes representing all configured third party peer. Takes the keys of name,
+  #   publicIp, privateSubnets and secret
+  # @return [Array] returns the array of hashes for all currently configured 3rd party peers
+  def update_third_party_peers(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'PUT', options)
+  end
+
+  # Returns all organizations a user is an administrator on
+  # @return [Array] an array of hashes containing the organizations and their attributes
+  def list_all_organizations
+    self.make_api_call("/organizations", 'GET')
+  end
+
+  # Update an organization
+  # @param [String] org_id the organization ID that you want to update
+  # @param [Hash] options an options hash containing the org ID and new name of the org
+  # @return [Hash] the updated attributes of the organization
+  def update_organization(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}", 'PUT', options)
+  end
+
+  # Create a new organization
+  # @param [Hash] options an options hash containing the name of the new organization
+  # @return [Hash] the attributes of the newly created organization
+  def create_organization(options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    options = {:body => options}
+    self.make_api_call("/organizations", 'POST', options)
+  end
+
+  # Clone an organization
+  # @param [String] source_org_id the source organization that we want to clone from
+  # @param [Hash] options options hash containing the attributes for the new organization
+  # @return [Hash] the attributes of the newly cloned organization
+  def clone_organization(source_org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    options = {:body => options}
+    self.make_api_call("/organizations/#{source_org_id}/clone", 'POST', options)
+  end
+
+  # Claim something
+  # @param [String] org_id the organization that you want to claim to
+  # @param [Hash] options a hash containing information about what you want to claim. This can be order,
+  #   serial, licenseKey and licenseMode. Refer to the official Dashboard API documentation for more information
+  #   about these
+  # @return [Integer] HTTP Code
+  def claim(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/claim", 'POST', options)
+  end
 end