asterisk-ari-client 0.0.1

data/lib/ari/resources/device_state.rb

@@ -0,0 +1,98 @@
+#------------------------------------------------------------------------------
+#
+#  WARNING !
+#
+#  This is a generated file. DO NOT EDIT THIS FILE! Your changes will
+#  be lost the next time this file is regenerated.
+#
+#  This file was generated using asterisk-ari-client ruby gem.
+#
+#------------------------------------------------------------------------------
+
+module Ari
+  class DeviceState < Resource
+
+    attr_reader :name, :state
+
+
+    # GET /deviceStates
+    #
+    # Device states
+    #
+    #
+    def self.list(options = {})
+      path = '/deviceStates'
+      response = client(options).get(path, options)
+      response.map { |hash| DeviceState.new(hash.merge(client: options[:client])) }
+    end
+
+    # GET /deviceStates/%{deviceName}
+    #
+    # Device state
+    #
+    #
+    # Parameters:
+    #
+    # deviceName (required) - Name of the device
+    #
+    def self.get(options = {})
+      raise ArgumentError.new("Parameter deviceName must be passed in options hash.") unless options[:deviceName]
+      path = '/deviceStates/%{deviceName}' % options
+      response = client(options).get(path, options)
+      DeviceState.new(response.merge(client: options[:client]))
+    end
+
+    def get(options = {})
+      self.class.get(options.merge(deviceStateId: self.id, client: @client))
+    end
+
+    # PUT /deviceStates/%{deviceName}
+    #
+    # Device state
+    #
+    # Change the state of a device controlled by ARI. (Note - implicitly creates the d
+    #
+    # Parameters:
+    #
+    # deviceName (required) - Name of the device
+    # deviceState (required) - Device state value
+    #
+    def self.update(options = {})
+      raise ArgumentError.new("Parameter deviceName must be passed in options hash.") unless options[:deviceName]
+      raise ArgumentError.new("Parameter deviceState must be passed in options hash.") unless options[:deviceState]
+      path = '/deviceStates/%{deviceName}' % options
+      response = client(options).put(path, options)
+    end
+
+    def update(options = {})
+      self.class.update(options.merge(deviceStateId: self.id, client: @client))
+    end
+
+    # DELETE /deviceStates/%{deviceName}
+    #
+    # Device state
+    #
+    #
+    # Parameters:
+    #
+    # deviceName (required) - Name of the device
+    #
+    def self.delete(options = {})
+      raise ArgumentError.new("Parameter deviceName must be passed in options hash.") unless options[:deviceName]
+      path = '/deviceStates/%{deviceName}' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+
+    def delete(options = {})
+      self.class.delete(options.merge(deviceStateId: self.id, client: @client))
+    end
+
+
+  end
+end
+
+Ari::Client.send :define_method, 'device_states' do
+  Ari::ListResource.new(self, Ari::DeviceState)
+end

data/lib/ari/resources/endpoint.rb

@@ -0,0 +1,124 @@
+#------------------------------------------------------------------------------
+#
+#  WARNING !
+#
+#  This is a generated file. DO NOT EDIT THIS FILE! Your changes will
+#  be lost the next time this file is regenerated.
+#
+#  This file was generated using asterisk-ari-client ruby gem.
+#
+#------------------------------------------------------------------------------
+
+module Ari
+  class Endpoint < Resource
+
+    attr_reader :technology, :resource, :state, :channel_ids
+
+
+    # GET /endpoints
+    #
+    # Asterisk endpoints
+    #
+    #
+    def self.list(options = {})
+      path = '/endpoints'
+      response = client(options).get(path, options)
+      response.map { |hash| Endpoint.new(hash.merge(client: options[:client])) }
+    end
+
+    # PUT /endpoints/sendMessage
+    #
+    # Send a message to some technology URI or endpoint.
+    #
+    #
+    # Parameters:
+    #
+    # to (required) - The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
+    # from (required) - The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
+    # body  - The body of the message
+    # variables  - 
+    #
+    def self.send_message(options = {})
+      raise ArgumentError.new("Parameter to must be passed in options hash.") unless options[:to]
+      raise ArgumentError.new("Parameter from must be passed in options hash.") unless options[:from]
+      path = '/endpoints/sendMessage'
+      response = client(options).put(path, options)
+    end
+    class << self; alias_method :sendMessage, :send_message; end
+
+    # GET /endpoints/%{tech}
+    #
+    # Asterisk endpoints
+    #
+    #
+    # Parameters:
+    #
+    # tech (required) - Technology of the endpoints (sip,iax2,...)
+    #
+    def self.list_by_tech(options = {})
+      raise ArgumentError.new("Parameter tech must be passed in options hash.") unless options[:tech]
+      path = '/endpoints/%{tech}' % options
+      response = client(options).get(path, options)
+      response.map { |hash| Endpoint.new(hash.merge(client: options[:client])) }
+    end
+    class << self; alias_method :listByTech, :list_by_tech; end
+
+    def list_by_tech(options = {})
+      self.class.list_by_tech(options.merge(endpointId: self.id, client: @client))
+    end
+
+    # GET /endpoints/%{tech}/%{resource}
+    #
+    # Single endpoint
+    #
+    #
+    # Parameters:
+    #
+    # tech (required) - Technology of the endpoint
+    # resource (required) - ID of the endpoint
+    #
+    def self.get(options = {})
+      raise ArgumentError.new("Parameter tech must be passed in options hash.") unless options[:tech]
+      raise ArgumentError.new("Parameter resource must be passed in options hash.") unless options[:resource]
+      path = '/endpoints/%{tech}/%{resource}' % options
+      response = client(options).get(path, options)
+      Endpoint.new(response.merge(client: options[:client]))
+    end
+
+    def get(options = {})
+      self.class.get(options.merge(endpointId: self.id, client: @client))
+    end
+
+    # PUT /endpoints/%{tech}/%{resource}/sendMessage
+    #
+    # Send a message to some endpoint in a technology.
+    #
+    #
+    # Parameters:
+    #
+    # tech (required) - Technology of the endpoint
+    # resource (required) - ID of the endpoint
+    # from (required) - The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
+    # body  - The body of the message
+    # variables  - 
+    #
+    def self.send_message_to_endpoint(options = {})
+      raise ArgumentError.new("Parameter tech must be passed in options hash.") unless options[:tech]
+      raise ArgumentError.new("Parameter resource must be passed in options hash.") unless options[:resource]
+      raise ArgumentError.new("Parameter from must be passed in options hash.") unless options[:from]
+      path = '/endpoints/%{tech}/%{resource}/sendMessage' % options
+      response = client(options).put(path, options)
+    end
+    class << self; alias_method :sendMessageToEndpoint, :send_message_to_endpoint; end
+
+    def send_message_to_endpoint(options = {})
+      self.class.send_message_to_endpoint(options.merge(endpointId: self.id, client: @client))
+    end
+
+
+  end
+end
+
+Ari::Client.send :define_method, 'endpoints' do
+  Ari::ListResource.new(self, Ari::Endpoint)
+end

data/lib/ari/resources/event.rb

@@ -0,0 +1,25 @@
+#------------------------------------------------------------------------------
+#
+#  WARNING !
+#
+#  This is a generated file. DO NOT EDIT THIS FILE! Your changes will
+#  be lost the next time this file is regenerated.
+#
+#  This file was generated using asterisk-ari-client ruby gem.
+#
+#------------------------------------------------------------------------------
+
+module Ari
+  class Event < Model
+
+    attr_reader :application, :timestamp
+
+    def timestamp=(val)
+      @timestamp ||= Time.parse(val)
+    end
+
+
+
+  end
+end
+

data/lib/ari/resources/mailbox.rb

@@ -0,0 +1,99 @@
+#------------------------------------------------------------------------------
+#
+#  WARNING !
+#
+#  This is a generated file. DO NOT EDIT THIS FILE! Your changes will
+#  be lost the next time this file is regenerated.
+#
+#  This file was generated using asterisk-ari-client ruby gem.
+#
+#------------------------------------------------------------------------------
+
+module Ari
+  class Mailbox < Resource
+
+    attr_reader :name, :old_messages, :new_messages
+
+
+    # GET /mailboxes
+    #
+    # Mailboxes
+    #
+    #
+    def self.list(options = {})
+      path = '/mailboxes'
+      response = client(options).get(path, options)
+      response.map { |hash| Mailbox.new(hash.merge(client: options[:client])) }
+    end
+
+    # GET /mailboxes/%{mailboxName}
+    #
+    # Mailbox state
+    #
+    #
+    # Parameters:
+    #
+    # mailboxName (required) - Name of the mailbox
+    #
+    def self.get(options = {})
+      raise ArgumentError.new("Parameter mailboxName must be passed in options hash.") unless options[:mailboxName]
+      path = '/mailboxes/%{mailboxName}' % options
+      response = client(options).get(path, options)
+      Mailbox.new(response.merge(client: options[:client]))
+    end
+
+    def get(options = {})
+      self.class.get(options.merge(mailboxId: self.id, client: @client))
+    end
+
+    # PUT /mailboxes/%{mailboxName}
+    #
+    # Mailbox state
+    #
+    #
+    # Parameters:
+    #
+    # mailboxName (required) - Name of the mailbox
+    # oldMessages (required) - Count of old messages in the mailbox
+    # newMessages (required) - Count of new messages in the mailbox
+    #
+    def self.update(options = {})
+      raise ArgumentError.new("Parameter mailboxName must be passed in options hash.") unless options[:mailboxName]
+      raise ArgumentError.new("Parameter oldMessages must be passed in options hash.") unless options[:oldMessages]
+      raise ArgumentError.new("Parameter newMessages must be passed in options hash.") unless options[:newMessages]
+      path = '/mailboxes/%{mailboxName}' % options
+      response = client(options).put(path, options)
+    end
+
+    def update(options = {})
+      self.class.update(options.merge(mailboxId: self.id, client: @client))
+    end
+
+    # DELETE /mailboxes/%{mailboxName}
+    #
+    # Mailbox state
+    #
+    #
+    # Parameters:
+    #
+    # mailboxName (required) - Name of the mailbox
+    #
+    def self.delete(options = {})
+      raise ArgumentError.new("Parameter mailboxName must be passed in options hash.") unless options[:mailboxName]
+      path = '/mailboxes/%{mailboxName}' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+
+    def delete(options = {})
+      self.class.delete(options.merge(mailboxId: self.id, client: @client))
+    end
+
+
+  end
+end
+
+Ari::Client.send :define_method, 'mailboxes' do
+  Ari::ListResource.new(self, Ari::Mailbox)
+end

data/lib/ari/resources/playback.rb

@@ -0,0 +1,86 @@
+#------------------------------------------------------------------------------
+#
+#  WARNING !
+#
+#  This is a generated file. DO NOT EDIT THIS FILE! Your changes will
+#  be lost the next time this file is regenerated.
+#
+#  This file was generated using asterisk-ari-client ruby gem.
+#
+#------------------------------------------------------------------------------
+
+module Ari
+  class Playback < Resource
+
+    attr_reader :id, :media_uri, :target_uri, :language, :state
+
+
+    # GET /playbacks/%{playbackId}
+    #
+    # Control object for a playback operation.
+    #
+    #
+    # Parameters:
+    #
+    # playbackId (required) - Playback's id
+    #
+    def self.get(options = {})
+      raise ArgumentError.new("Parameter playbackId must be passed in options hash.") unless options[:playbackId]
+      path = '/playbacks/%{playbackId}' % options
+      response = client(options).get(path, options)
+      Playback.new(response.merge(client: options[:client]))
+    end
+
+    def get(options = {})
+      self.class.get(options.merge(playbackId: self.id, client: @client))
+    end
+
+    # DELETE /playbacks/%{playbackId}
+    #
+    # Control object for a playback operation.
+    #
+    #
+    # Parameters:
+    #
+    # playbackId (required) - Playback's id
+    #
+    def self.stop(options = {})
+      raise ArgumentError.new("Parameter playbackId must be passed in options hash.") unless options[:playbackId]
+      path = '/playbacks/%{playbackId}' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+
+    def stop(options = {})
+      self.class.stop(options.merge(playbackId: self.id, client: @client))
+    end
+
+    # POST /playbacks/%{playbackId}/control
+    #
+    # Control object for a playback operation.
+    #
+    #
+    # Parameters:
+    #
+    # playbackId (required) - Playback's id
+    # operation (required) - Operation to perform on the playback.
+    #
+    def self.control(options = {})
+      raise ArgumentError.new("Parameter playbackId must be passed in options hash.") unless options[:playbackId]
+      raise ArgumentError.new("Parameter operation must be passed in options hash.") unless options[:operation]
+      path = '/playbacks/%{playbackId}/control' % options
+      response = client(options).post(path, options)
+    end
+
+    def control(options = {})
+      self.class.control(options.merge(playbackId: self.id, client: @client))
+    end
+
+
+  end
+end
+
+Ari::Client.send :define_method, 'playbacks' do
+  Ari::ListResource.new(self, Ari::Playback)
+end

data/lib/ari/resources/recording.rb

@@ -0,0 +1,241 @@
+#------------------------------------------------------------------------------
+#
+#  WARNING !
+#
+#  This is a generated file. DO NOT EDIT THIS FILE! Your changes will
+#  be lost the next time this file is regenerated.
+#
+#  This file was generated using asterisk-ari-client ruby gem.
+#
+#------------------------------------------------------------------------------
+
+module Ari
+  class Recording < Resource
+
+
+    # GET /recordings/stored
+    #
+    # Recordings
+    #
+    #
+    def self.list_stored(options = {})
+      path = '/recordings/stored'
+      response = client(options).get(path, options)
+      response.map { |hash| StoredRecording.new(hash.merge(client: options[:client])) }
+    end
+    class << self; alias_method :listStored, :list_stored; end
+
+    # GET /recordings/stored/%{recordingName}
+    #
+    # Individual recording
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.get_stored(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/stored/%{recordingName}' % options
+      response = client(options).get(path, options)
+      StoredRecording.new(response.merge(client: options[:client]))
+    end
+    class << self; alias_method :getStored, :get_stored; end
+
+    def get_stored(options = {})
+      self.class.get_stored(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # DELETE /recordings/stored/%{recordingName}
+    #
+    # Individual recording
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.delete_stored(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/stored/%{recordingName}' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+    class << self; alias_method :deleteStored, :delete_stored; end
+
+    def delete_stored(options = {})
+      self.class.delete_stored(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # POST /recordings/stored/%{recordingName}/copy
+    #
+    # Copy an individual recording
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording to copy
+    # destinationRecordingName (required) - The destination name of the recording
+    #
+    def self.copy_stored(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      raise ArgumentError.new("Parameter destinationRecordingName must be passed in options hash.") unless options[:destinationRecordingName]
+      path = '/recordings/stored/%{recordingName}/copy' % options
+      response = client(options).post(path, options)
+      StoredRecording.new(response.merge(client: options[:client]))
+    end
+    class << self; alias_method :copyStored, :copy_stored; end
+
+    def copy_stored(options = {})
+      self.class.copy_stored(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # GET /recordings/live/%{recordingName}
+    #
+    # A recording that is in progress
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.get_live(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}' % options
+      response = client(options).get(path, options)
+      LiveRecording.new(response.merge(client: options[:client]))
+    end
+    class << self; alias_method :getLive, :get_live; end
+
+    def get_live(options = {})
+      self.class.get_live(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # DELETE /recordings/live/%{recordingName}
+    #
+    # A recording that is in progress
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.cancel(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+
+    def cancel(options = {})
+      self.class.cancel(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # POST /recordings/live/%{recordingName}/stop
+    #
+    # 
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.stop(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}/stop' % options
+      response = client(options).post(path, options)
+    end
+
+    def stop(options = {})
+      self.class.stop(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # POST /recordings/live/%{recordingName}/pause
+    #
+    # 
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.pause(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}/pause' % options
+      response = client(options).post(path, options)
+    end
+
+    def pause(options = {})
+      self.class.pause(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # DELETE /recordings/live/%{recordingName}/pause
+    #
+    # 
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.unpause(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}/pause' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+
+    def unpause(options = {})
+      self.class.unpause(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # POST /recordings/live/%{recordingName}/mute
+    #
+    # 
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.mute(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}/mute' % options
+      response = client(options).post(path, options)
+    end
+
+    def mute(options = {})
+      self.class.mute(options.merge(recordingId: self.id, client: @client))
+    end
+
+    # DELETE /recordings/live/%{recordingName}/mute
+    #
+    # 
+    #
+    #
+    # Parameters:
+    #
+    # recordingName (required) - The name of the recording
+    #
+    def self.unmute(options = {})
+      raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
+      path = '/recordings/live/%{recordingName}/mute' % options
+      response = client(options).delete(path, options)
+    rescue Ari::RequestError => e
+      raise unless e.code == '404'
+    end
+
+    def unmute(options = {})
+      self.class.unmute(options.merge(recordingId: self.id, client: @client))
+    end
+
+
+  end
+end
+
+Ari::Client.send :define_method, 'recordings' do
+  Ari::ListResource.new(self, Ari::Recording)
+end