Class: Telerivet::Label

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

Overview

Represents a label used to organize messages within Telerivet.

Fields:

- id (string, max 34 characters)
    * ID of the label
    * Read-only

- name
    * Name of the label
    * Updatable via API

- time_created (UNIX timestamp)
    * Time the label was created in Telerivet
    * Read-only

- vars (Hash)
    * Custom variables stored for this label. Variable names may be up to 32 characters in
        length and can contain the characters a-z, A-Z, 0-9, and _.
        Values may be strings, numbers, or boolean (true/false).
        String values may be up to 4096 bytes in length when encoded as UTF-8.
        Up to 100 variables are supported per object.
        Setting a variable to null will delete the variable.
    * Updatable via API

- project_id
    * ID of the project this label belongs to
    * Read-only

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

#delete ⇒ Object

Deletes the given label (Note: no messages are deleted.)



127
128
129
 
# File 'lib/telerivet/label.rb', line 127

def delete()
    @api.do_request("DELETE", get_base_api_path())
end

#get_base_api_path ⇒ Object 



151
152
153
 
# File 'lib/telerivet/label.rb', line 151

def get_base_api_path()
    "/projects/#{get('project_id')}/labels/#{get('id')}"
end

#id ⇒ Object 



131
132
133
 
# File 'lib/telerivet/label.rb', line 131

def id
    get('id')
end

#name ⇒ Object 



135
136
137
 
# File 'lib/telerivet/label.rb', line 135

def name
    get('name')
end

#name=(value) ⇒ Object 



139
140
141
 
# File 'lib/telerivet/label.rb', line 139

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

#project_id ⇒ Object 



147
148
149
 
# File 'lib/telerivet/label.rb', line 147

def project_id
    get('project_id')
end

#query_messages(options = nil) ⇒ Object

Queries messages with the given label.

Arguments:

- options (Hash)

  - direction
      * Filter messages by direction
      * Allowed values: incoming, outgoing

  - message_type
      * Filter messages by message_type
      * Allowed values: sms, mms, ussd, ussd_session, call, chat, service

  - source
      * Filter messages by source
      * Allowed values: phone, provider, web, api, service, webhook, scheduled,
          integration

  - 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, read

  - 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

  - external_id
      * Filter messages by ID from an external provider
      * Allowed modifiers: external_id[ne], external_id[exists]

  - contact_id
      * ID of the contact who sent/received the message
      * Allowed modifiers: contact_id[ne], contact_id[exists]

  - phone_id
      * ID of the phone (basic route) that sent/received the message

  - broadcast_id
      * ID of the broadcast containing the message
      * Allowed modifiers: broadcast_id[ne], broadcast_id[exists]

  - scheduled_id
      * ID of the scheduled message that created this message
      * Allowed modifiers: scheduled_id[ne], scheduled_id[exists]

  - group_id
      * Filter messages sent or received by contacts in a particular group. The group must
          be a normal group, not a dynamic group.

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

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

Returns:

Telerivet::APICursor (of Telerivet::Message)



112
113
114
115
 
# File 'lib/telerivet/label.rb', line 112

def query_messages(options = nil)
    require_relative 'message'
    @api.cursor(Message, get_base_api_path() + "/messages", options)
end

#save ⇒ Object

Saves any fields that have changed for the label.



120
121
122
 
# File 'lib/telerivet/label.rb', line 120

def save()
    super
end

#time_created ⇒ Object 



143
144
145
 
# File 'lib/telerivet/label.rb', line 143

def time_created
    get('time_created')
end