telerivet 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 956df92c7601623b5f4cca141712a7f4efa82074
-  data.tar.gz: b6fb090b8d492b7ea8a68ee394793dbfc5f6c890
+  metadata.gz: f29fae453430b0721c120ed759f6471eb6353a5a
+  data.tar.gz: 20efe5389264b4ff2ba936b23a77ff1ade66aec5
 SHA512:
-  metadata.gz: dead19b8d3452ea46c0a3bc819899e59fc6a726df88cf023277031e58ff72f34c3a5b46a17c415afb699a07376a2f41f50833c9e3edc6a19f86464de9fc2c952
-  data.tar.gz: 3132ac8c08c783f6ba7d48cd06416967818bb416292341b472902e45f3bc19280b23d8e39639b7314d805c6dd41436ad89fd5794da242f8d000e4c9b04aa180c
+  metadata.gz: 0caee23855bbca0c7bc86ac0c5c4e057ab11470999871542d884d7c1c381713203f7d2f136653208833a4f5528a40e63965b9a20ea6c8b0fcde6553d2a605ab2
+  data.tar.gz: 39e7a0403bba946173d14ecbe1e02016cf4b160b7e81b06efdd6df18a01178340f015e3b89a93eb5191aa061a04ed30e854cbc31794e8a1cf58007e0fe112d4b

data/lib/telerivet.rb

@@ -8,7 +8,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.2.1'
+    @@client_version = '1.3.0'
 
     #
     # Initializes a client handle to the Telerivet REST API.
@@ -160,6 +160,75 @@ class API
         self.cursor(Project, get_base_api_path() + "/projects", options)
     end
 
+    #
+    # Retrieves the Telerivet organization with the given ID.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the organization -- see <https://telerivet.com/dashboard/api>
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Organization
+    #
+    def get_organization_by_id(id)
+        require_relative 'telerivet/organization'
+        Organization.new(self, self.do_request("GET", get_base_api_path() + "/organizations/#{id}"))
+    end
+
+    #
+    # Initializes the Telerivet organization with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the organization -- see <https://telerivet.com/dashboard/api>
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Organization
+    #
+    def init_organization_by_id(id)
+        require_relative 'telerivet/organization'
+        return Organization.new(self, {'id' => id}, false)
+    end
+
+    #
+    # Queries organizations accessible to the current user account.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - name
+    #         * Filter organizations by name
+    #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
+    #             name[lt], name[lte]
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default, name
+    #         * 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::Organization)
+    #
+    def query_organizations(options = nil)
+        require_relative 'telerivet/organization'
+        self.cursor(Organization, get_base_api_path() + "/organizations", options)
+    end
+
     def get_base_api_path()
         ""
     end

data/lib/telerivet/organization.rb

@@ -0,0 +1,164 @@
+
+module Telerivet
+
+#
+# Represents a Telerivet organization.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the organization
+#       * Read-only
+#   
+#   - name
+#       * Name of the organization
+#       * Updatable via API
+#   
+#   - timezone_id
+#       * Billing quota time zone ID; see
+#           <http://en.wikipedia.org/wiki/List_of_tz_database_time_zones>
+#       * Updatable via API
+#
+class Organization < Entity
+    #
+    # Saves any fields that have changed for this organization.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Retrieves information about the organization's service plan and account balance.
+    # 
+    # Returns:
+    #     (associative array)
+    #       - balance (string)
+    #           * Prepaid account balance
+    #       
+    #       - balance_currency (string)
+    #           * Currency of prepaid account balance
+    #       
+    #       - plan_name (string)
+    #           * Name of service plan
+    #       
+    #       - plan_price (string)
+    #           * Price of service plan
+    #       
+    #       - plan_currency (string)
+    #           * Currency of service plan price
+    #       
+    #       - plan_rrule (string)
+    #           * Service plan recurrence rule (e.g. FREQ=MONTHLY or FREQ=YEARLY)
+    #       
+    #       - plan_paid (boolean)
+    #           * true if the service plan has been paid for the current billing interval; false
+    #               if it is unpaid (free plans are considered paid)
+    #       
+    #       - plan_start_time (UNIX timestamp)
+    #           * Time when the current billing interval started
+    #       
+    #       - plan_end_time (UNIX timestamp)
+    #           * Time when the current billing interval ends
+    #       
+    #       - plan_suspend_time (UNIX timestamp)
+    #           * Time when the account will be suspended, if the plan remains unpaid after
+    #               `plan_end_time` (may be null)
+    #       
+    #       - plan_limits (Hash)
+    #           * Object describing the limits associated with the current service plan. The
+    #               object contains the following keys: `phones`, `projects`, `active_services`,
+    #               `users`, `contacts`, `messages_day`, `stored_messages`, `data_rows`,
+    #               `api_requests_day`. The values corresponding to each key are integers, or null.
+    #       
+    #       - recurring_billing_enabled (boolean)
+    #           * True if recurring billing is enabled, false otherwise
+    #       
+    #       - auto_refill_enabled (boolean)
+    #           * True if auto-refill is enabled, false otherwise
+    #
+    def get_billing_details()
+        data = @api.do_request("GET", get_base_api_path() + "/billing")
+        return data
+    end
+
+    #
+    # Retrieves the current usage count associated with a particular service plan limit. Available
+    # usage types are `phones`, `projects`, `users`, `contacts`, `messages_day`,
+    # `stored_messages`, `data_rows`, and `api_requests_day`.
+    # 
+    # Arguments:
+    #   - usage_type
+    #       * Usage type.
+    #       * Required
+    #   
+    # Returns:
+    #     int
+    #
+    def get_usage(usage_type)
+        return @api.do_request("GET", get_base_api_path() + "/usage/#{usage_type}")
+    end
+
+    #
+    # Queries projects in this organization.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - name
+    #         * Filter projects by name
+    #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
+    #             name[lt], name[lte]
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default, name
+    #         * 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::Project)
+    #
+    def query_projects(options = nil)
+        require_relative 'project'
+        @api.cursor(Project, get_base_api_path() + "/projects", options)
+    end
+
+    def id
+        get('id')
+    end
+
+    def name
+        get('name')
+    end
+
+    def name=(value)
+        set('name', value)
+    end
+
+    def timezone_id
+        get('timezone_id')
+    end
+
+    def timezone_id=(value)
+        set('timezone_id', value)
+    end
+
+    def get_base_api_path()
+        "/organizations/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/phone.rb

@@ -90,8 +90,8 @@ module Telerivet
 #   
 #   - 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)
+#           increase this limit, install additional SMS expansion packs in the Telerivet Gateway
+#           app. (only present for Android phones)
 #       * Read-only
 #
 class Phone < Entity

data/lib/telerivet/project.rb

@@ -30,6 +30,10 @@ module Telerivet
 #   - vars (Hash)
 #       * Custom variables stored for this project
 #       * Updatable via API
+#   
+#   - organization_id (string, max 34 characters)
+#       * ID of the organization this project belongs to
+#       * Read-only
 #
 class Project < Entity
     #
@@ -45,8 +49,8 @@ class Project < Entity
     #         * Default: sms
     #     
     #     - content
-    #         * Content of the message to send (if message_type=call, the text will be spoken
-    #             during a text-to-speech call)
+    #         * Content of the message to send (if `message_type` is `call`, the text will be
+    #             spoken during a text-to-speech call)
     #         * Required if sending SMS message
     #     
     #     - to_number (string)
@@ -62,13 +66,14 @@ class Project < Entity
     #         * Default: default sender phone ID for your project
     #     
     #     - service_id
-    #         * Service that defines the call flow of the voice call (when message_type=call)
+    #         * Service that defines the call flow of the voice call (when `message_type` is
+    #             `call`)
     #     
     #     - audio_url
     #         * The URL of an MP3 file to play when the contact answers the call (when
-    #             message_type=call).
+    #             `message_type` is `call`).
     #             
-    #             If audio_url is provided, the text-to-speech voice is not used to say
+    #             If `audio_url` is provided, the text-to-speech voice is not used to say
     #             `content`, although you can optionally use `content` to indicate the script for the
     #             audio.
     #             
@@ -76,7 +81,7 @@ class Project < Entity
     #             recommended because the audio quality will be low when played over a phone line.
     #     
     #     - tts_lang
-    #         * The language of the text-to-speech voice (when message_type=call)
+    #         * The language of the text-to-speech voice (when `message_type` is `call`)
     #         * Allowed values: en-US, en-GB, en-GB-WLS, en-AU, en-IN, da-DK, nl-NL, fr-FR, fr-CA,
     #             de-DE, is-IS, it-IT, pl-PL, pt-BR, pt-PT, ru-RU, es-ES, es-US, sv-SE
     #         * Default: en-US
@@ -155,13 +160,14 @@ class Project < Entity
     #         * Default: default sender phone ID
     #     
     #     - service_id
-    #         * Service that defines the call flow of the voice call (when message_type=call)
+    #         * Service that defines the call flow of the voice call (when `message_type` is
+    #             `call`)
     #     
     #     - audio_url
     #         * The URL of an MP3 file to play when the contact answers the call (when
-    #             message_type=call).
+    #             `message_type` is `call`).
     #             
-    #             If audio_url is provided, the text-to-speech voice is not used to say
+    #             If `audio_url` is provided, the text-to-speech voice is not used to say
     #             `content`, although you can optionally use `content` to indicate the script for the
     #             audio.
     #             
@@ -169,7 +175,7 @@ class Project < Entity
     #             recommended because the audio quality will be low when played over a phone line.
     #     
     #     - tts_lang
-    #         * The language of the text-to-speech voice (when message_type=call)
+    #         * The language of the text-to-speech voice (when `message_type` is `call`)
     #         * Allowed values: en-US, en-GB, en-GB-WLS, en-AU, en-IN, da-DK, nl-NL, fr-FR, fr-CA,
     #             de-DE, is-IS, it-IT, pl-PL, pt-BR, pt-PT, ru-RU, es-ES, es-US, sv-SE
     #         * Default: en-US
@@ -206,8 +212,8 @@ class Project < Entity
     #           * Number of messages queued to send
     #       
     #       - broadcast_id
-    #           * ID of broadcast created for this message batch. If count\_queued is 0 or 1, a
-    #               broadcast will not be created, and the broadcast\_id property will be null.
+    #           * ID of broadcast created for this message batch. If `count_queued` is 0 or 1, a
+    #               broadcast will not be created, and the `broadcast_id` property will be null.
     #
     def send_messages(options)
         data = @api.do_request("POST", get_base_api_path() + "/messages/send_batch", options)
@@ -215,8 +221,8 @@ class Project < Entity
     end
 
     #
-    # Schedules an SMS message to a group or single contact. Note that Telerivet only sends
-    # scheduled messages approximately once per minute, so it is not possible to control the exact
+    # Schedules a message to a group or single contact. Note that Telerivet only sends scheduled
+    # messages approximately once every 15 seconds, so it is not possible to control the exact
     # second at which a scheduled message is sent.
     # 
     # Arguments:
@@ -225,7 +231,7 @@ class Project < Entity
     #     
     #     - message_type
     #         * Type of message to send
-    #         * Allowed values: sms, ussd
+    #         * Allowed values: sms, ussd, call
     #         * Default: sms
     #     
     #     - content
@@ -259,13 +265,14 @@ class Project < Entity
     #         * Default: default sender phone ID
     #     
     #     - service_id
-    #         * Service that defines the call flow of the voice call (when message_type=call)
+    #         * Service that defines the call flow of the voice call (when `message_type` is
+    #             `call`)
     #     
     #     - audio_url
     #         * The URL of an MP3 file to play when the contact answers the call (when
-    #             message_type=call).
+    #             `message_type` is `call`).
     #             
-    #             If audio_url is provided, the text-to-speech voice is not used to say
+    #             If `audio_url` is provided, the text-to-speech voice is not used to say
     #             `content`, although you can optionally use `content` to indicate the script for the
     #             audio.
     #             
@@ -273,7 +280,7 @@ class Project < Entity
     #             recommended because the audio quality will be low when played over a phone line.
     #     
     #     - tts_lang
-    #         * The language of the text-to-speech voice (when message_type=call)
+    #         * The language of the text-to-speech voice (when `message_type` is `call`)
     #         * Allowed values: en-US, en-GB, en-GB-WLS, en-AU, en-IN, da-DK, nl-NL, fr-FR, fr-CA,
     #             de-DE, is-IS, it-IT, pl-PL, pt-BR, pt-PT, ru-RU, es-ES, es-US, sv-SE
     #         * Default: en-US
@@ -320,7 +327,7 @@ class Project < Entity
     #     
     #     - content
     #         * Content of the incoming message
-    #         * Required unless message_type is call
+    #         * Required unless `message_type` is `call`
     #     
     #     - message_type
     #         * Type of message
@@ -366,14 +373,14 @@ class Project < Entity
     # an existing contact with that phone number (including suffix matches to allow finding
     # contacts with phone numbers in a different format). If a phone number is not provided but a
     # name is provided, Telerivet will search for a contact with that exact name (case
-    # insensitive). This behavior can be modified by setting the lookup_key parameter to look up a
-    # contact by another field, including a custom variable.
+    # insensitive). This behavior can be modified by setting the `lookup_key` parameter to look up
+    # a contact by another field, including a custom variable.
     # 
     # If no existing contact is found, a new contact will be created.
     # 
     # Then that contact will be updated with any parameters provided
-    # (name, phone_number, vars, default\_route\_id, send\_blocked, add\_group\_ids,
-    # remove\_group\_ids).
+    # (`name`, `phone_number`, `vars`, `default_route_id`, `send_blocked`, `add_group_ids`,
+    # `remove_group_ids`).
     # 
     # Arguments:
     #   - options (Hash)
@@ -400,7 +407,7 @@ class Project < Entity
     #         * ID of one or more groups to add this contact as a member (max 20)
     #     
     #     - id
-    #         * ID of an existing contact (only used if lookup_key is 'id')
+    #         * ID of an existing contact (only used if `lookup_key` is 'id')
     #     
     #     - remove_group_ids (array)
     #         * ID of one or more groups to remove this contact as a member (max 20)
@@ -1392,6 +1399,10 @@ class Project < Entity
         get('url_slug')
     end
 
+    def organization_id
+        get('organization_id')
+    end
+
     def get_base_api_path()
         "/projects/#{get('id')}"
     end

data/lib/telerivet/scheduledmessage.rb

@@ -24,16 +24,41 @@ module Telerivet
 #           <http://en.wikipedia.org/wiki/List_of_tz_database_time_zones>
 #       * Read-only
 #   
+#   - recipients (array of objects)
+#       * List of recipients. Each recipient is an object with a string `type` property, which
+#           may be `"phone_number"`, `"group"`, or `"filter"`.
+#           
+#           If the type is `"phone_number"`, the `phone_number` property will
+#           be set to the recipient's phone number.
+#           
+#           If the type is `"group"`, the `group_id` property will be set to
+#           the ID of the group, and the `group_name` property will be set to the name of the
+#           group.
+#           
+#           If the type is `"filter"`, the `filter_type` property (string) and
+#           `filter_params` property (object) describe the filter used to send the broadcast. (API
+#           clients should not rely on a particular value or format of the `filter_type` or
+#           `filter_params` properties, as they may change without notice.)
+#       * Read-only
+#   
+#   - recipients_str
+#       * A string with a human readable description of the first few recipients (possibly
+#           truncated)
+#       * Read-only
+#   
 #   - group_id
-#       * ID of the group to send the message to (null if scheduled to an individual contact)
+#       * ID of the group to send the message to (null if the recipient is an individual
+#           contact, or if there are multiple recipients)
 #       * Read-only
 #   
 #   - contact_id
-#       * ID of the contact to send the message to (null if scheduled to a group)
+#       * ID of the contact to send the message to (null if the recipient is a group, or if
+#           there are multiple recipients)
 #       * Read-only
 #   
 #   - to_number
-#       * Phone number to send the message to (null if scheduled to a group)
+#       * Phone number to send the message to (null if the recipient is a group, or if there
+#           are multiple recipients)
 #       * Read-only
 #   
 #   - route_id
@@ -140,6 +165,14 @@ class ScheduledMessage < Entity
         get('timezone_id')
     end
 
+    def recipients
+        get('recipients')
+    end
+
+    def recipients_str
+        get('recipients_str')
+    end
+
     def group_id
         get('group_id')
     end

data/lib/telerivet/service.rb

@@ -70,8 +70,9 @@ module Telerivet
 #   
 #   - questions (array)
 #       * Array of objects describing each question in a poll (only used for polls). Each
-#           object has the properties "id" (the question ID), "content" (the text of the
-#           question), and "question_type" (either "multiple_choice", "missed_call", or "open").
+#           object has the properties `"id"` (the question ID), `"content"` (the text of the
+#           question), and `"question_type"` (either `"multiple_choice"`, `"missed_call"`, or
+#           `"open"`).
 #       * Read-only
 #
 class Service < Entity
@@ -80,13 +81,13 @@ class Service < Entity
     # Manually invoke this service in a particular context.
     # 
     # For example, to send a poll to a particular contact (or resend the
-    # current question), you can invoke the poll service with context=contact, and contact_id as
+    # current question), you can invoke the poll service with context=contact, and `contact_id` as
     # the ID of the contact to send the poll to.
     # 
     # Or, to manually apply a service for an incoming message, you can
-    # invoke the service with context=message, event=incoming\_message, and message_id as the ID
-    # of the incoming message. (This is normally not necessary, but could be used if you want to
-    # override Telerivet's standard priority-ordering of services.)
+    # invoke the service with `context`=`message`, `event`=`incoming_message`, and `message_id` as
+    # the ID of the incoming message. (This is normally not necessary, but could be used if you
+    # want to override Telerivet's standard priority-ordering of services.)
     # 
     # Arguments:
     #   - options (Hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -29,6 +29,7 @@ files:
 - lib/telerivet/label.rb
 - lib/telerivet/message.rb
 - lib/telerivet/mobilemoneyreceipt.rb
+- lib/telerivet/organization.rb
 - lib/telerivet/phone.rb
 - lib/telerivet/project.rb
 - lib/telerivet/route.rb