telerivet 1.0.2

data/lib/telerivet/message.rb

@@ -0,0 +1,300 @@
+module Telerivet
+
+#
+# Represents a single message.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the message
+#       * Read-only
+#   
+#   - direction
+#       * Direction of the message: incoming messages are sent from one of your contacts to
+#           your phone; outgoing messages are sent from your phone to one of your contacts
+#       * Allowed values: incoming, outgoing
+#       * Read-only
+#   
+#   - status
+#       * Current status of the message
+#       * Allowed values: ignored, processing, received, sent, queued, failed, failed_queued,
+#           cancelled, delivered, not_delivered
+#       * Read-only
+#   
+#   - message_type
+#       * Type of the message
+#       * Allowed values: sms, mms, ussd, call
+#       * Read-only
+#   
+#   - source
+#       * How the message originated within Telerivet
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * The time that the message was created on Telerivet's servers
+#       * Read-only
+#   
+#   - time_sent (UNIX timestamp)
+#       * The time that the message was reported to have been sent (null for incoming messages
+#           and messages that have not yet been sent)
+#       * Read-only
+#   
+#   - from_number (string)
+#       * The phone number that the message originated from (your number for outgoing
+#           messages, the contact's number for incoming messages)
+#       * Read-only
+#   
+#   - to_number (string)
+#       * The phone number that the message was sent to (your number for incoming messages,
+#           the contact's number for outgoing messages)
+#       * Read-only
+#   
+#   - content (string)
+#       * The text content of the message (null for USSD messages and calls)
+#       * Read-only
+#   
+#   - starred (bool)
+#       * Whether this message is starred in Telerivet
+#       * Updatable via API
+#   
+#   - simulated (bool)
+#       * Whether this message is was simulated within Telerivet for testing (and not actually
+#           sent to or received by a real phone)
+#       * Read-only
+#   
+#   - label_ids (array)
+#       * List of IDs of labels applied to this message
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this message
+#       * Updatable via API
+#   
+#   - error_message
+#       * A description of the error encountered while sending a message. (This field is
+#           omitted from the API response if there is no error message.)
+#       * Updatable via API
+#   
+#   - external_id
+#       * The ID of this message from an external SMS gateway provider (e.g. Twilio or Nexmo),
+#           if available.
+#       * Read-only
+#   
+#   - price
+#       * The price of this message, if known. By convention, message prices are negative.
+#       * Read-only
+#   
+#   - price_currency
+#       * The currency of the message price, if applicable.
+#       * Read-only
+#   
+#   - mms_parts (array)
+#       * A list of parts in the MMS message, the same as returned by the
+#           [getMMSParts](#Message.getMMSParts) method.
+#           
+#           Note: This property is only present when retrieving an individual
+#           MMS message by ID, not when querying a list of messages. In other cases, use
+#           [getMMSParts](#Message.getMMSParts).
+#       * Read-only
+#   
+#   - phone_id (string, max 34 characters)
+#       * ID of the phone that sent or received the message
+#       * Read-only
+#   
+#   - contact_id (string, max 34 characters)
+#       * ID of the contact that sent or received the message
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this contact belongs to
+#       * Read-only
+#
+class Message < Entity
+
+    #
+    # Returns true if this message has a particular label, false otherwise.
+    # 
+    # Arguments:
+    #   - label (Telerivet::Label)
+    #       * Required
+    #   
+    # Returns:
+    #     bool
+    #
+    def has_label?(label)
+        load_data()
+        return @label_ids_set.has_key?(label.id)
+    end
+      
+    #
+    # Adds a label to the given message.
+    # 
+    # Arguments:
+    #   - label (Telerivet::Label)
+    #       * Required
+    #
+    def add_label(label)
+        @api.do_request("PUT", label.get_base_api_path() + "/messages/" + get('id'));
+        @label_ids_set[label.id] = true
+    end
+    
+    #
+    # Removes a label from the given message.
+    # 
+    # Arguments:
+    #   - label (Telerivet::Label)
+    #       * Required
+    #
+    def remove_label(label)
+        @api.do_request("DELETE", label.get_base_api_path() + "/messages/" + get('id'))
+        if @label_ids_set.has_key?(label.id)
+            @label_ids_set.delete(label.id)
+        end
+    end
+
+    #
+    # Retrieves a list of MMS parts for this message (empty for non-MMS messages).
+    # 
+    # Each MMS part in the list is an object with the following
+    # properties:
+    # 
+    # - cid: MMS content-id
+    # - type: MIME type
+    # - filename: original filename
+    # - size (int): number of bytes
+    # - url: URL where the content for this part is stored (secret but
+    # publicly accessible, so you could link/embed it in a web page without having to re-host it
+    # yourself)
+    # 
+    # Returns:
+    #     array
+    #
+    def get_mmsparts()
+        return @api.do_request("GET", get_base_api_path() + "/mms_parts")
+    end
+
+    #
+    # Saves any fields that have changed for this message.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Deletes this message.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def direction
+        get('direction')
+    end
+
+    def status
+        get('status')
+    end
+
+    def message_type
+        get('message_type')
+    end
+
+    def source
+        get('source')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def time_sent
+        get('time_sent')
+    end
+
+    def from_number
+        get('from_number')
+    end
+
+    def to_number
+        get('to_number')
+    end
+
+    def content
+        get('content')
+    end
+
+    def starred
+        get('starred')
+    end
+
+    def starred=(value)
+        set('starred', value)
+    end
+
+    def simulated
+        get('simulated')
+    end
+
+    def label_ids
+        get('label_ids')
+    end
+
+    def error_message
+        get('error_message')
+    end
+
+    def error_message=(value)
+        set('error_message', value)
+    end
+
+    def external_id
+        get('external_id')
+    end
+
+    def price
+        get('price')
+    end
+
+    def price_currency
+        get('price_currency')
+    end
+
+    def mms_parts
+        get('mms_parts')
+    end
+
+    def phone_id
+        get('phone_id')
+    end
+
+    def contact_id
+        get('contact_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/messages/#{get('id')}"
+    end
+ 
+    
+    def set_data(data)
+        super
+        
+        @label_ids_set = {}
+        
+        if data.has_key?('label_ids')
+            data['label_ids'].each { |id| @label_ids_set[id] = true }
+        end
+    end
+
+end
+
+end

data/lib/telerivet/mobilemoneyreceipt.rb

@@ -0,0 +1,187 @@
+
+module Telerivet
+
+#
+# Represents a receipt received from a mobile money system such as Safaricom M-Pesa (Kenya),
+# Vodacom M-Pesa (Tanzania), or Tigo Pesa (Tanzania).
+# 
+# When your Android phone receives a SMS receipt from a supported mobile money
+# service that Telerivet can understand, Telerivet will automatically parse it and create a
+# MobileMoneyReceipt object.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * Telerivet's internal ID for the receipt
+#       * Read-only
+#   
+#   - tx_id
+#       * Transaction ID from the receipt
+#       * Read-only
+#   
+#   - tx_type
+#       * Type of mobile money transaction
+#       * Allowed values: receive_money, send_money, pay_bill, deposit, withdrawal,
+#           airtime_purchase, balance_inquiry, reversal
+#       * Read-only
+#   
+#   - currency
+#       * [ISO 4217 Currency code](http://en.wikipedia.org/wiki/ISO_4217) for the transaction,
+#           e.g. KES or TZS. Amount, balance, and fee are expressed in units of this currency.
+#       * Read-only
+#   
+#   - amount (number)
+#       * Amount of this transaction; positive numbers indicate money added to your account,
+#           negative numbers indicate money removed from your account
+#       * Read-only
+#   
+#   - balance (number)
+#       * The current balance of your mobile money account (null if not available)
+#       * Read-only
+#   
+#   - fee (number)
+#       * The transaction fee charged by the mobile money system (null if not available)
+#       * Read-only
+#   
+#   - name
+#       * The name of the other person in the transaction (null if not available)
+#       * Read-only
+#   
+#   - phone_number
+#       * The phone number of the other person in the transaction (null if not available)
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * The time this receipt was created in Telerivet
+#       * Read-only
+#   
+#   - other_tx_id
+#       * The other transaction ID listed in the receipt (e.g. the transaction ID for a
+#           reversed transaction)
+#       * Read-only
+#   
+#   - content
+#       * The raw content of the mobile money receipt
+#       * Read-only
+#   
+#   - provider_id
+#       * Telerivet's internal ID for the mobile money provider
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this mobile money receipt
+#       * Updatable via API
+#   
+#   - contact_id
+#       * ID of the contact associated with the name/phone number on the receipt. Note that
+#           some mobile money systems do not provide the other person's phone number, so it's
+#           possible Telerivet may not automatically assign a contact_id, or may assign it to a
+#           different contact with the same name.
+#       * Updatable via API
+#   
+#   - phone_id
+#       * ID of the phone that received the receipt
+#       * Read-only
+#   
+#   - message_id
+#       * ID of the message corresponding to the receipt
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this receipt belongs to
+#       * Read-only
+#
+class MobileMoneyReceipt < Entity
+    #
+    # Saves any fields or custom variables that have changed for this mobile money receipt.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Deletes this receipt.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def tx_id
+        get('tx_id')
+    end
+
+    def tx_type
+        get('tx_type')
+    end
+
+    def currency
+        get('currency')
+    end
+
+    def amount
+        get('amount')
+    end
+
+    def balance
+        get('balance')
+    end
+
+    def fee
+        get('fee')
+    end
+
+    def name
+        get('name')
+    end
+
+    def phone_number
+        get('phone_number')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def other_tx_id
+        get('other_tx_id')
+    end
+
+    def content
+        get('content')
+    end
+
+    def provider_id
+        get('provider_id')
+    end
+
+    def contact_id
+        get('contact_id')
+    end
+
+    def contact_id=(value)
+        set('contact_id', value)
+    end
+
+    def phone_id
+        get('phone_id')
+    end
+
+    def message_id
+        get('message_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/receipts/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/phone.rb

@@ -0,0 +1,229 @@
+
+module Telerivet
+
+#
+# Represents a phone or gateway that you use to send/receive messages via Telerivet.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the phone
+#       * Read-only
+#   
+#   - name
+#       * Name of the phone
+#       * Updatable via API
+#   
+#   - phone_number (string)
+#       * Phone number of the phone
+#       * Updatable via API
+#   
+#   - phone_type
+#       * Type of this phone/gateway (e.g. android, twilio, nexmo, etc)
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the phone was created in Telerivet
+#       * Read-only
+#   
+#   - last_active_time (UNIX timestamp)
+#       * Approximate time this phone last connected to Telerivet
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this phone
+#       * Updatable via API
+#   
+#   - project_id
+#       * ID of the project this phone belongs to
+#       * Read-only
+#   
+#   - battery (int)
+#       * Current battery level, on a scale from 0 to 100, as of the last time the phone
+#           connected to Telerivet (only present for Android phones)
+#       * Read-only
+#   
+#   - charging (bool)
+#       * True if the phone is currently charging, false if it is running on battery, as of
+#           the last time it connected to Telerivet (only present for Android phones)
+#       * Read-only
+#   
+#   - app_version
+#       * Currently installed version of Telerivet Android app (only present for Android
+#           phones)
+#       * Read-only
+#   
+#   - android_sdk (int)
+#       * Android SDK level, indicating the approximate version of the Android OS installed on
+#           this phone; see
+#           <http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels>
+#           (only present for Android phones)
+#       * Read-only
+#   
+#   - mccmnc
+#       * Code indicating the Android phone's current country (MCC) and mobile network
+#           operator (MNC); see <http://en.wikipedia.org/wiki/Mobile_country_code> (only present
+#           for Android phones). Note this is a string containing numeric digits, not an integer.
+#       * Read-only
+#   
+#   - manufacturer
+#       * Android phone manufacturer (only present for Android phones)
+#       * Read-only
+#   
+#   - model
+#       * Android phone model (only present for Android phones)
+#       * Read-only
+#   
+#   - send_limit (int)
+#       * Maximum number of SMS messages per hour that can be sent by this Android phone. To
+#           increase this limit, install additional SMS expansion packs in the Telerivet app.
+#           (only present for Android phones)
+#       * Read-only
+#
+class Phone < Entity
+    #
+    # Queries messages sent or received by this phone.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - direction
+    #         * Filter messages by direction
+    #         * Allowed values: incoming, outgoing
+    #     
+    #     - message_type
+    #         * Filter messages by message_type
+    #         * Allowed values: sms, mms, ussd, call
+    #     
+    #     - source
+    #         * Filter messages by source
+    #         * Allowed values: phone, provider, web, api, service, webhook, scheduled
+    #     
+    #     - starred (bool)
+    #         * Filter messages by starred/unstarred
+    #     
+    #     - status
+    #         * Filter messages by status
+    #         * Allowed values: ignored, processing, received, sent, queued, failed,
+    #             failed_queued, cancelled, delivered, not_delivered
+    #     
+    #     - time_created[min] (UNIX timestamp)
+    #         * Filter messages created on or after a particular time
+    #     
+    #     - time_created[max] (UNIX timestamp)
+    #         * Filter messages created before a particular time
+    #     
+    #     - contact_id
+    #         * ID of the contact who sent/received the message
+    #     
+    #     - phone_id
+    #         * ID of the phone that sent/received the message
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default
+    #         * Default: default
+    #     
+    #     - sort_dir
+    #         * Sort the results in ascending or descending order
+    #         * Allowed values: asc, desc
+    #         * Default: asc
+    #     
+    #     - page_size (int)
+    #         * Number of results returned per page (max 200)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::Message)
+    #
+    def query_messages(options = nil)
+        require_relative 'message'
+        @api.cursor(Message, get_base_api_path() + "/messages", options)
+    end
+
+    #
+    # Saves any fields or custom variables that have changed for this phone.
+    #
+    def save()
+        super
+    end
+
+    def id
+        get('id')
+    end
+
+    def name
+        get('name')
+    end
+
+    def name=(value)
+        set('name', value)
+    end
+
+    def phone_number
+        get('phone_number')
+    end
+
+    def phone_number=(value)
+        set('phone_number', value)
+    end
+
+    def phone_type
+        get('phone_type')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def last_active_time
+        get('last_active_time')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def battery
+        get('battery')
+    end
+
+    def charging
+        get('charging')
+    end
+
+    def app_version
+        get('app_version')
+    end
+
+    def android_sdk
+        get('android_sdk')
+    end
+
+    def mccmnc
+        get('mccmnc')
+    end
+
+    def manufacturer
+        get('manufacturer')
+    end
+
+    def model
+        get('model')
+    end
+
+    def send_limit
+        get('send_limit')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/phones/#{get('id')}"
+    end
+ 
+end
+
+end