textmagic-ruby 2.0.0

data/lib/textmagic-ruby/rest/senderids.rb

@@ -0,0 +1,114 @@
+module Textmagic
+  module REST
+    class Senderids < ListResource
+      ##
+      # Get senderid by ID.
+      # Returns Senderid object.
+      #
+      # uid:: Senderid ID. Required.
+      #
+      # Example:
+      #
+      #   @senderid = client.senderids.get 1123
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Create new Senderid.
+      # Returns Senderid object contains id and link to new Senderid.
+      #
+      # The following *params* keys are supported:
+      #
+      # sender_id::    Alphanumeric Sender ID (maximum 11 characters). Required.
+      #
+      # explanation::  Explain why do you need this Sender ID. Required.
+      #
+      # Example:
+      #
+      #   @senderid = client.senderids.create {:sender_id => 'MYSENDERID', :explanation => 'For Testing'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user sender ids.
+      # Returns PaginateResource object, contains array of Senderid objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @senderids = client.senderids.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Updating is not supported.
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Delete senderid by ID. Returns *true* if success.
+      #
+      # uid:: Senderid ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.senderids.delete 192881
+      #
+      def delete(uid)
+        super uid
+      end
+    end
+
+    ##
+    # A Senderid resource.
+    #
+    # ==== @id
+    #
+    # ==== @sender_id
+    #
+    # ==== @status
+    #
+    # ==== @user
+    #
+    # Hash like this
+    #   {
+    #     "id": 11111,
+    #     "username": "johndoe",
+    #     "firstName": "John",
+    #     "lastName": "Doe",
+    #     "status": "A",
+    #     "balance": 13.793,
+    #     "company": "TextMagic",
+    #     "currency": {
+    #     "id": "GBP",
+    #     "htmlSymbol": "&pound;"
+    #   },
+    #     "timezone": {
+    #     "id": 2,
+    #     "area": "Pacific",
+    #     "dst": 0,
+    #     "offset": -39600,
+    #     "timezone": "Pacific/Midway"
+    #   },
+    #     "subaccountType": "P"
+    #   }
+    #
+    class Senderid < InstanceResource; end
+  end
+end

data/lib/textmagic-ruby/rest/sessions.rb

@@ -0,0 +1,109 @@
+module Textmagic
+  module REST
+    class Sessions < ListResource
+
+      ##
+      # Get all user message sessions.
+      # Returns PaginateResource object, contains array of Session objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @sessions = client.sessions.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Get session by ID.
+      # Returns Session object.
+      #
+      # uid:: Session ID. Required.
+      #
+      # Example:
+      #
+      #   @session = client.sessions.get 123131
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Fetch messages by given session id.
+      # An useful synonym for "messages/search" command with provided `session_id` parameter.
+      # Returns PaginateResource object, contains array of Message objects.
+      #
+      # uid:: Session ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @messages = client.sessions.messages 123
+      #
+      def messages(uid, params={})
+        response = @client.get "#{@path}/#{uid}/messages", params
+        PaginateResource.new "#{@path}", @client, response, Textmagic::REST::Message
+      end
+
+      ##
+      # Updating is not supported.
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Creating is not supported.
+      #
+      def create(params={})
+        raise '`create` method is not supported for this resource.'
+      end
+
+      ##
+      # Delete session by ID. Returns *true* if success.
+      #
+      # uid:: Session ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.sessions.delete 123123
+      #
+      def delete(uid)
+        super uid
+      end
+    end
+
+    ##
+    # A Session resource.
+    #
+    # ==== @id
+    #
+    # ==== @start_time
+    #
+    # ==== @text
+    #
+    # ==== @source
+    #
+    # ==== @reference_id
+    #
+    # ==== @price
+    #
+    # ==== @numbers_count
+    #
+    class Session < InstanceResource; end
+  end
+end

data/lib/textmagic-ruby/rest/subaccounts.rb

@@ -0,0 +1,135 @@
+module Textmagic
+  module REST
+    class Subaccounts < ListResource
+
+      ##
+      # Get subaccount by ID.
+      # Returns Subaccount object.
+      #
+      # uid:: Subaccount ID. Required.
+      #
+      # Example:
+      #
+      #   @subaccount = client.subaccounts.get 123131
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Get all user subaccounts.
+      # Returns PaginateResource object, contains array of Subaccount objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @subaccounts = client.subaccounts.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+
+      ##
+      # Invite new subaccount.
+      # Returns True if success.
+      #
+      # The following *params* keys are supported:
+      #
+      # email:: Subaccount email. Required.
+      #
+      # role::  Subaccount role: `A` for administrator or `U` for regular user. Required.
+      #
+      # Example:
+      #
+      #   @subaccount = client.subaccounts.create {:email => 'sub_email@gmail.com', :role => 'A'}
+      #
+      def create(params={})
+        self.send_invite params
+      end
+
+      ##
+      # Invite new subaccount. Alias for 'create' method.
+      # Returns True if success.
+      #
+      # The following *params* keys are supported:
+      #
+      # email:: Subaccount email. Required.
+      #
+      # role::  Subaccount role: `A` for administrator or `U` for regular user. Required.
+      #
+      # Example:
+      #
+      #   @subaccount = client.subaccounts.send_invite {:email => 'sub_email@gmail.com', :role => 'A'}
+      #
+      def send_invite(params={})
+        response = @client.post "#{@path}", params
+      end
+
+      ##
+      # Updating is not supported.
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Close the subaccount. Returns *true* if success.
+      #
+      # uid:: Subaccount ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.subaccounts.delete 123123
+      #
+      def delete(uid)
+        super uid
+      end
+    end
+
+    ##
+    # A Subaccount resource.
+    #
+    # ==== @id
+    #
+    # ==== @username
+    #
+    # ==== @first_name
+    #
+    # ==== @last_name
+    #
+    # ==== @balance
+    #
+    # ==== @company
+    #
+    # ==== @currency
+    #
+    # Hash like this:
+    #   {
+    #     "id": "GBP",
+    #     "htmlSymbol": "&pound;"
+    #   }
+    #
+    # ==== @timezone
+    #
+    # Hash like this:
+    #   {
+    #     "area": "Pacific",
+    #     "dst": "0",
+    #     "offset": "-39600",
+    #     "timezone": "Pacific/Midway"
+    #   }
+    #
+    # ==== @subaccount_type
+    #
+    class Subaccount < InstanceResource; end
+  end
+end

data/lib/textmagic-ruby/rest/templates.rb

@@ -0,0 +1,107 @@
+module Textmagic
+  module REST
+    class Templates < ListResource
+      ##
+      # Get template by ID.
+      # Returns Template object.
+      #
+      # uid:: Template ID. Required.
+      #
+      # Example:
+      #
+      #   @template = client.templates.get 987
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Create new Template.
+      # Returns Template object contains id and link to new Template.
+      #
+      # The following *params* keys are supported:
+      #
+      # name::    Template name. Required.
+      #
+      # content:: Template text. May contain tags inside braces. Required.
+      #
+      # Example:
+      #
+      #   @template = client.templates.create {:name => 'MyTemplate'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user templates.
+      # Returns PaginateResource object, contains array of Template objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # search::  If *true* then search templates using `name` and/or `content`. Defaults *false*.
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # name::    Find template by name. Using with `search`=*true*.
+      #
+      # content:: Find template by content. Using with `search`=*true*..
+      #
+      # Example:
+      #
+      #   @templates = client.templates.list
+      #
+      def list(params={})
+        super params
+      end
+
+      ##
+      # Updates the existing Template for the given unique id.
+      # Returns Template object contains id and link to updated Template.
+      #
+      # uid:: Template ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # name::    Template name. Required.
+      #
+      # content:: Template text. May contain tags inside braces. Required.
+      #
+      # Example:
+      #
+      #   @template = client.templates.update 123, {:name => 'Updated Template'}
+      #
+      def update(uid, params={})
+        super uid, params
+      end
+
+      ##
+      # Delete template by ID. Returns *true* if success.
+      #
+      # uid:: Template ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.templates.delete 987
+      #
+      def delete(uid)
+        super uid
+      end
+    end
+
+    ##
+    # A Template resource.
+    #
+    # ==== @id
+    #
+    # ==== @name
+    #
+    # ==== @content
+    #
+    # ==== @last_modified
+    #
+    class Template < InstanceResource; end
+  end
+end