Class: Telerivet::Organization

Inherits:
Entity
  • Object
show all
Defined in:
lib/telerivet/organization.rb

Overview

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 [List of tz database time zones Wikipedia
        article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
    * Updatable via API

Instance Method Summary collapse

Methods inherited from Entity

#get, #initialize, #load, #set, #set_data, #to_s, #vars

Constructor Details

This class inherits a constructor from Telerivet::Entity

Instance Method Details

#create_project(options) ⇒ Object

Creates a new project.

Some project settings are not currently possible to configure via the API, and can only be edited via the web app after the project is created.

Arguments:

- options (Hash)
    * Required

  - name (string)
      * Name of the project to create, which must be unique in the organization.
      * Required

  - timezone_id
      * Default TZ database timezone ID; see [List of tz database time zones Wikipedia
          article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). This timezone
          is used when computing statistics by date.

  - url_slug
      * Unique string used as a component of the project's URL in the Telerivet web app.
          If not provided, a URL slug will be generated automatically.

  - auto_create_contacts (bool)
      * If true, a contact will be automatically created for each unique phone number that
          a message is sent to or received from. If false, contacts will not automatically be
          created (unless contact information is modified by an automated service). The
          Conversations tab in the web app will only show messages that are associated with a
          contact.
      * Default: 1

  - message_retention_days (int)
      * Number of days to retain messages in this project. Messages older than this will
          be automatically deleted. If null or not provided, messages will be retained
          forever.

  - short_link_scheme (bool)
      * If true (the default), short links in messages will include the scheme (e.g.,
          'https://rvt.me/xxxxxxxxx'). If false, short links will not include the scheme
          (e.g., 'rvt.me/xxxxxxxxx').
      * Default: 1

  - vars
      * Custom variables and values to set for this project

Returns:

Telerivet::Project



71
72
73
74
 
# File 'lib/telerivet/organization.rb', line 71

def create_project(options)
    require_relative 'project'
    Project.new(@api, @api.do_request("POST", get_base_api_path() + "/projects", options))
end

#get_base_api_path ⇒ Object 



270
271
272
 
# File 'lib/telerivet/organization.rb', line 270

def get_base_api_path()
    "/organizations/#{get('id')}"
end

#get_billing_details ⇒ Object

Retrieves information about the organization’s service plan and account balance.

Returns:

(associative array)
  - balance (string)
      * Prepaid  balance

  - balance_currency (string)
      * Currency of prepaid  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  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



132
133
134
135
 
# File 'lib/telerivet/organization.rb', line 132

def get_billing_details()
    data = @api.do_request("GET", get_base_api_path() + "/billing")
    return data
end

#get_message_stats(options) ⇒ Object

Retrieves statistics about messages sent or received via Telerivet. This endpoint returns historical data that is computed shortly after midnight each day in the project’s time zone, and does not contain message statistics for the current day.

Arguments:

- options (Hash)
    * Required

  - start_date (string)
      * Start date of message statistics, in YYYY-MM-DD format
      * Required

  - end_date (string)
      * End date of message statistics (inclusive), in YYYY-MM-DD format
      * Required

  - rollup (string)
      * Date interval to group by
      * Allowed values: day, week, month, year, all
      * Default: day

  - properties (string)
      * Comma separated list of properties to group by
      * Allowed values: org_id, org_name, org_industry, project_id, project_name, user_id,
          user_email, user_name, phone_id, phone_name, phone_type, direction, source, status,
          network_code, network_name, message_type, service_id, service_name, simulated, link

  - metrics (string)
      * Comma separated list of metrics to return (summed for each distinct value of the
          requested properties)
      * Allowed values: count, num_parts, duration, price
      * Required

  - currency (string)
      * Three-letter ISO 4217 currency code used when returning the 'price' field. If the
          original price was in a different currency, it will be converted to the requested
          currency using the approximate current exchange rate.
      * Default: USD

  - filters (Hash)
      * Key-value pairs of properties and corresponding values; the returned statistics
          will only include messages where the property matches the provided value. Only the
          following properties are supported for filters: `user_id`, `phone_id`, `direction`,
          `source`, `status`, `service_id`, `simulated`, `message_type`, `network_code`

Returns:

(associative array)
  - intervals (array)
      * List of objects representing each date interval containing at least one message
          matching the filters.



208
209
210
211
 
# File 'lib/telerivet/organization.rb', line 208

def get_message_stats(options)
    data = @api.do_request("GET", get_base_api_path() + "/message_stats", options)
    return data
end

#get_usage(usage_type) ⇒ Object

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.
    * Allowed values: phones, projects, users, contacts, messages_day, stored_messages,
        data_rows, api_requests_day
    * Required

Returns:

int



152
153
154
 
# File 'lib/telerivet/organization.rb', line 152

def get_usage(usage_type)
    return @api.do_request("GET", get_base_api_path() + "/usage/#{usage_type}")
end

#id ⇒ Object 



250
251
252
 
# File 'lib/telerivet/organization.rb', line 250

def id
    get('id')
end

#name ⇒ Object 



254
255
256
 
# File 'lib/telerivet/organization.rb', line 254

def name
    get('name')
end

#name=(value) ⇒ Object 



258
259
260
 
# File 'lib/telerivet/organization.rb', line 258

def name=(value)
    set('name', value)
end

#query_projects(options = nil) ⇒ Object

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 500)
      * Default: 50

  - offset (int)
      * Number of items to skip from beginning of result set
      * Default: 0

Returns:

Telerivet::APICursor (of Telerivet::Project)



245
246
247
248
 
# File 'lib/telerivet/organization.rb', line 245

def query_projects(options = nil)
    require_relative 'project'
    @api.cursor(Project, get_base_api_path() + "/projects", options)
end

#save ⇒ Object

Saves any fields that have changed for this organization.



79
80
81
 
# File 'lib/telerivet/organization.rb', line 79

def save()
    super
end

#timezone_id ⇒ Object 



262
263
264
 
# File 'lib/telerivet/organization.rb', line 262

def timezone_id
    get('timezone_id')
end

#timezone_id=(value) ⇒ Object 



266
267
268
 
# File 'lib/telerivet/organization.rb', line 266

def timezone_id=(value)
    set('timezone_id', value)
end