dashboard-api 0.4.0 → 0.9.0

data/doc/top-level-namespace.html

@@ -84,7 +84,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span>, <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span>, <span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>, <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span>, <span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span>
     
   
     
@@ -104,7 +104,7 @@
 </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/lib/admins.rb

@@ -0,0 +1,37 @@
+# Admins section of the Meraki Dashboard API
+# @author Joe Letizia
+module Admins
+  # List all of the administrators for a given org
+  # @param [String] org_id organization ID you want the list of administrators for
+  # @return [Array] an array of hashes containing each admin and their attributes
+  def list_admins(org_id)
+    self.make_api_call("/organizations/#{org_id}/admins", 'GET')
+  end
+
+  # Add an admin to a specific org
+  # @param [String] org_id organization ID you want to add an administrator to
+  # @param [Hash] options option hash containing attributes for the new admin. Can contain:
+  #   email, name, orgAccess, tags and networks. See the Meraki API Documentation for more details.
+  def add_admin(org_id, options)
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/admins", 'POST', options)
+  end
+ 
+  # Update an administrator for a specific org
+  # @param [String] org_id organization ID you want to update an administrator on
+  # @param [String] admin_id ID of the admin you want to update
+  # @param [Hash] options hash containing the attributes and values you want to update. Can contain:
+  #   email, name, orgAccess, tags and networks. See the Meraki API Documentation for more details.
+  def update_admin(org_id, admin_id, options)
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/admins/#{admin_id}", 'PUT', options)
+  end
+
+  # Revoke an administrator for a specific org
+  # @param [String] org_id organization ID you want to revoke access on
+  # @param [String] admin_id ID of the administrator you want to revoke
+  # @return [Integer] HTTP Code
+  def revoke_admin(org_id, admin_id)
+    self.make_api_call("/organizations/#{org_id}/admins/#{admin_id}", 'DELETE')
+  end
+end

data/lib/dashboard-api.rb

@@ -3,10 +3,15 @@ require 'json'
 require_relative "dashboard-api/version"
 require 'organizations'
 require 'networks'
+require 'admins'
 require 'devices'
+require 'templates'
 require 'clients'
+require 'phones'
 require 'ssids'
+require 'vlans'
 require 'switchports'
+require 'saml'
 
 # Ruby Implementation of the Meraki Dashboard api
 # @author Joe Letizia
@@ -18,7 +23,12 @@ class DashboardAPI
   include Clients
   include Devices
   include SSIDs
+  include Admins
   include Switchports
+  include VLANs
+  include Phones
+  include Templates
+  include SAML
   base_uri "https://dashboard.meraki.com/api/v0"
 
   attr_reader :key
@@ -41,6 +51,7 @@ class DashboardAPI
     when 'GET'
       res = HTTParty.get("#{self.class.base_uri}/#{endpoint_url}", options)
       raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
+      raise "Bad request due to the following error(s): #{JSON.parse(res.body)['errors']}" if res.body.include?('errors')
       return JSON.parse(res.body)
     when 'POST'
       res = HTTParty.post("#{self.class.base_uri}/#{endpoint_url}", options)

data/lib/dashboard-api/version.rb

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

data/lib/networks.rb

@@ -77,4 +77,33 @@ module Networks
     res = self.make_api_call("/networks/#{network_id}/accessPolicies", 'GET')
     return res
   end
+
+  # Bind a single network to a configuration template
+  # @param [String] network_id the source network that you want to bind to a tempalte
+  # @param [Hash] options options hash that contains configTemplateId and autoBind values. Refer to the official
+  #   Meraki Dashboard API documentation for more information on these.
+  # @return [Integer] HTTP Code
+  def bind_network_to_template(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    options = {:body => options}
+
+    self.make_api_call("/networks/#{network_id}/bind", 'POST', options)
+  end
+
+  # Unbind a single network from a configuration template
+  # @param [String] network_id the network that you want to unbind from it's template
+  # @return [Integer] HTTP Code
+  def unbind_network_to_template(network_id)
+    self.make_api_call("/networks/#{network_id}/unbind", 'POST')
+  end
+
+  # Return traffic analysis data for a network
+  # @param [String] network_id network that you want data for
+  # @param [Hash] options options hash containing a timespan and deviceType. Refer to the official
+  #   Meraki Dashboard API documentation for more information on these.
+  def traffic_analysis(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    options = {:body => options}
+    self.make_api_call("/networks/#{network_id}/traffic", 'GET', options)
+  end
 end

data/lib/phones.rb

@@ -0,0 +1,40 @@
+# Phones section of the Meraki Dashboard API
+# @author Joe Letizia
+module Phones
+
+  # Get list of phone contacts
+  # @param [String] network_id the network id you want to list contacts for
+  # @return [Array] an array of hashes containing attribute information for each contact
+  def list_phone_contacts(network_id)
+    self.make_api_call("/networks/#{network_id}/phoneContacts", 'GET')
+  end
+
+  # Add a single phone contact
+  # @param [String] network_id the network id you want to add the contact to
+  # @param [Hash] options an options hash that contains the contact attributes. Currently only supports the name attribute.
+  # @return [Hash] returns the hash containing the contact attributes
+  def add_phone_contact(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    options = {:body => options}
+    self.make_api_call("/networks/#{network_id}/phoneContacts", 'POST', options)
+  end
+
+  # Update a single phone contact
+  # @param [String] network_id the network id you want to update the contact in
+  # @param [String] contact_id the ID of the contact you want to update
+  # @param [Hash] options an options hash that contains the contact attributes. Currently only supports the name attribute.
+  # @return [Hash] returns the hash containing the contacts updated attributes
+  def update_phone_contact(network_id, contact_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    options = {:body => options}
+    self.make_api_call("/networks/#{network_id}/phoneContacts/#{contact_id}", 'PUT', options)
+  end
+
+  # Delete a single phone contact
+  # @param [String] network_id the network id you want to delete the contact on
+  # @param [String] contact_id the ID of the contact you want to delete
+  # @return [Integer] HTTP Code
+  def delete_phone_contact(network_id, contact_id)
+    self.make_api_call("/networks/#{network_id}/phoneContacts/#{contact_id}", 'DELETE')
+  end
+end

data/lib/saml.rb

@@ -0,0 +1,47 @@
+# SAML section of the Meraki Dashboard API
+# @author Joe Letizia
+module SAML
+  # List all SAML roles defined on an organization
+  # @param [String] org_id organization ID you want the SAML roles from
+  # @return [Array] an array of hashes containing each SAML role and it's attributes
+  def list_saml_roles(org_id)
+    self.make_api_call("/organizations/#{org_id}/samlRoles", 'GET')
+  end
+
+  # Create a new SAML role on an organization
+  # @param [String] org_id organization ID you want to create the SAML roles on
+  # @param [Hash] options an options hash containing the attributes for the SAML role. Can include role, orgAccess, tags, and networks.
+  #   Refer to the Meraki Dashboard API for more information on these tags
+  # @return [Hash] returns the newly created SAML role
+  def create_saml_role(org_id, options)
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/samlRoles", 'POST', options)
+  end
+
+  # Update an existing SAML role on an organization
+  # @param [String] org_id organization ID you want to update the SAML roles on
+  # @param [String] saml_id the ID of the SAML role that you want to update
+  # @param [Hash] options an options hash containing the attributes for the SAML role. Can include role, orgAccess, tags, and networks.
+  #   Refer to the Meraki Dashboard API for more information on these tags
+  # @return [Hahs] returns the updated SAML role
+  def update_saml_role(org_id, saml_id, options)
+    options = {:body => options}
+    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'PUT', options)
+  end
+
+  # Return a single SAML role
+  # @param [String] org_id organization ID you want to return the SAML roles on
+  # @param [String] saml_id the ID of the SAML role that you want to return
+  # @return [Hash] returns the request SAML role
+  def return_saml_role(org_id, saml_id)
+    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'GET')
+  end
+
+  # Remove a single SAML role
+  # @param [String] org_id organization ID you want to remove the SAML roles on
+  # @param [String] saml_id the ID of the SAML role that you want to remove
+  # @return [Integer] HTTP Code
+  def remove_saml_role(org_id, saml_id)
+    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'DELETE')
+  end
+end

data/lib/templates.rb

@@ -0,0 +1,18 @@
+# Templates section of the Meraki Dashboard API
+# @author Joe Letizia
+module Templates
+  # Return a list of all templates for a specific organization
+  # @param [String] org_id organization ID where that we want to list all of the templates from
+  # @return [Array] an array of hashes containing the attributes for all configuration templates
+  def list_templates(org_id)
+    self.make_api_call("/organizations/#{org_id}/configTemplates", 'GET')
+  end
+  
+  # Remove a single configuration template
+  # @param [String] org_id organization ID where that we want to remove the templates from
+  # @param [String] template_id the template ID we want to delete
+  # @return [Integer] HTTP code
+  def remove_template(org_id, template_id)
+    self.make_api_call("/organizations/#{org_id}/configTemplates/#{template_id}", 'DELETE')
+  end
+end

data/lib/vlans.rb

@@ -0,0 +1,49 @@
+# VLANs section of the Meraki Dashboard API
+# @author Joe Letizia
+module VLANs
+  # Returns a list of the configured VLANs in a Dashboard network
+  # @param [String] network_id the network ID you want the VLANs for
+  # @return [Array] an array of hashes containing each VLAN and it's attributes
+  def list_vlans(network_id)
+    self.make_api_call("/networks/#{network_id}/vlans", 'GET')
+  end
+ 
+  # Return a single configured VLAN for a network
+  # @param [String] network_id the network ID the VLAN exists in
+  # @param [Integer] vlan_id the VLAN ID you want the attributes for
+  # @return [Hash] a hash of the VLAN's attributes 
+  def return_vlan(network_id, vlan_id)
+    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'GET')
+  end
+
+  # Add a single VLAN to a network
+  # @param [String] network_id the network you want to add a VLAN to
+  # @param [Hash] options a hash containing the attributes of id, name, subnet and applianceIp
+  #   additional details on these can be found in the official Meraki API Documentation
+  # @return [Hash] the attributes of the newly created vlan
+  def add_vlan(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    options = {:body => options}
+    self.make_api_call("/networks/#{network_id}/vlans", 'POST', options)
+  end
+
+  # Update the attributes for a single VLAN
+  # @param [String] network_id the network ID for the VLAN you want to update
+  # @param [Integer] vlan_id the VLAN ID you want to update
+  # @param [Hash] options a hash containing the attributes of name, subnet and applianceIp.
+  #   additional details on these can be found in the official Meraki API Documentation
+  # @return [Hash] the updated attributes for the VLAN
+  def update_vlan(network_id, vlan_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    options = {:body => options}
+    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'PUT', options)
+  end
+
+  # Delete a single vlan
+  # @param [String] network_id the Network ID for the VLAN you want to delete
+  # @param [Integer] vlan_id the VLAN ID you want to delete
+  # @return [Integer] code HTTP return code
+  def delete_vlan(network_id, vlan_id)
+    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'DELETE')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dashboard-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Joe Letizia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,14 +108,19 @@ files:
 - README.md
 - Rakefile
 - dashboard-api.gemspec
+- doc/Admins.html
 - doc/Clients.html
 - doc/DashboardAPI.html
 - doc/DashboardAPIVersion.html
 - doc/Devices.html
 - doc/Networks.html
 - doc/Organizations.html
+- doc/Phones.html
+- doc/SAML.html
 - doc/SSIDs.html
 - doc/Switchports.html
+- doc/Templates.html
+- doc/VLANs.html
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -130,14 +135,19 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
+- lib/admins.rb
 - lib/clients.rb
 - lib/dashboard-api.rb
 - lib/dashboard-api/version.rb
 - lib/devices.rb
 - lib/networks.rb
 - lib/organizations.rb
+- lib/phones.rb
+- lib/saml.rb
 - lib/ssids.rb
 - lib/switchports.rb
+- lib/templates.rb
+- lib/vlans.rb
 homepage: https://github.com/jletizia/dashboardapi
 licenses: []
 metadata: {}