telerivet 1.6.1 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,8 @@
2
2
  module Telerivet
3
3
 
4
4
  #
5
- # Represents a phone or gateway that you use to send/receive messages via Telerivet.
5
+ # Represents a basic route (i.e. a phone or gateway) that you use to send/receive messages via
6
+ # Telerivet.
6
7
  #
7
8
  # Basic Routes were formerly referred to as "Phones" within Telerivet. API
8
9
  # methods, parameters, and properties related to Basic Routes continue to use the term "Phone"
@@ -44,7 +45,12 @@ module Telerivet
44
45
  # * Read-only
45
46
  #
46
47
  # - vars (Hash)
47
- # * Custom variables stored for this phone
48
+ # * Custom variables stored for this phone. Variable names may be up to 32 characters in
49
+ # length and can contain the characters a-z, A-Z, 0-9, and _.
50
+ # Values may be strings, numbers, or boolean (true/false).
51
+ # String values may be up to 4096 bytes in length when encoded as UTF-8.
52
+ # Up to 100 variables are supported per object.
53
+ # Setting a variable to null will delete the variable.
48
54
  # * Updatable via API
49
55
  #
50
56
  # - project_id
@@ -73,15 +79,16 @@ module Telerivet
73
79
  #
74
80
  # - android_sdk (int)
75
81
  # * Android SDK level, indicating the approximate version of the Android OS installed on
76
- # this phone; see
77
- # <http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels>
82
+ # this phone; see [list of Android SDK
83
+ # levels](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
78
84
  # (only present for Android phones)
79
85
  # * Read-only
80
86
  #
81
87
  # - mccmnc
82
88
  # * Code indicating the Android phone's current country (MCC) and mobile network
83
- # operator (MNC); see <http://en.wikipedia.org/wiki/Mobile_country_code> (only present
84
- # for Android phones). Note this is a string containing numeric digits, not an integer.
89
+ # operator (MNC); see [Mobile country code Wikipedia
90
+ # article](https://en.wikipedia.org/wiki/Mobile_country_code) (only present for Android
91
+ # phones). Note this is a string containing numeric digits, not an integer.
85
92
  # * Read-only
86
93
  #
87
94
  # - manufacturer
@@ -100,7 +107,7 @@ module Telerivet
100
107
  #
101
108
  class Phone < Entity
102
109
  #
103
- # Queries messages sent or received by this phone.
110
+ # Queries messages sent or received by this basic route.
104
111
  #
105
112
  # Arguments:
106
113
  # - options (Hash)
@@ -111,7 +118,7 @@ class Phone < Entity
111
118
  #
112
119
  # - message_type
113
120
  # * Filter messages by message_type
114
- # * Allowed values: sms, mms, ussd, call, service
121
+ # * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
115
122
  #
116
123
  # - source
117
124
  # * Filter messages by source
@@ -182,7 +189,7 @@ class Phone < Entity
182
189
  end
183
190
 
184
191
  #
185
- # Saves any fields or custom variables that have changed for this phone.
192
+ # Saves any fields or custom variables that have changed for this basic route.
186
193
  #
187
194
  def save()
188
195
  super