serwersms 0.0.4 → 2.0.0

data/lib/library/messages.rb

@@ -1,352 +0,0 @@
-class Serwersms::Messages
-  def initialize(obj)
-      @serwersms = obj
-  end
-  '''
-   * Sending messages
-   * 
-   * param string phone
-   * param string text Message
-   * param string sender Sender name only for FULL SMS
-   * param array params
-   *      option bool "details" Show details of messages
-   *      option bool "utf" Change encoding to UTF-8 (Only for FULL SMS)
-   *      option bool "flash"
-   *      option bool "speed" Priority canal only for FULL SMS
-   *      option bool "test" Test mode
-   *      option bool "vcard" vCard message
-   *      option string "wap_push" WAP Push URL address
-   *      option string "date" Set the date of sending
-   *      option int "group_id" Sending to the group instead of a phone number
-   *      option int "contact_id" Sending to phone from contacts
-   *      option string "unique_id" Own identifiers of messages
-   * return array
-   *      option bool "success"
-   *      option int "queued" Number of queued messages
-   *      option int "unsent" Number of unsent messages
-   *      option array "items"
-   *          option string "id"
-   *          option string "phone"
-   *          option string "status" - queued|unsent
-   *          option string "queued" Date of enqueued
-   *          option int "parts" Number of parts a message
-   *          option int "error_code"
-   *          option string "error_message"
-   *          option string "text"
-  '''
-  def sendSms(phone, text, sender = nil, params = {})
-    params['phone']  = phone
-    params['text']   = text
-    params['sender'] = sender
-    @serwersms.call('messages/send_sms',params);
-  end
-  '''
-   * Sending personalized messages
-   * 
-   * param array messages
-   *      option string "phone"
-   *      option string "text"
-   * param string sender Sender name only for FULL SMS
-   * param array params
-   *      option bool "details" Show details of messages
-   *      option bool "utf" Change encoding to UTF-8 (only for FULL SMS)
-   *      option bool "flash"
-   *      option bool "speed" Priority canal only for FULL SMS
-   *      option bool "test" Test mode
-   *      option string "date" Set the date of sending
-   *      option int|array "group_id" Sending to the group instead of a phone number
-   *      option string "text" Message if is set group_id
-   *      option string|array "uniqe_id" Own identifiers of messages
-   *      option bool "voice" Send VMS
-   * return array
-   *      option bool "success"
-   *      option int "queued" Number of queued messages
-   *      option int "unsent" Number of unsent messages
-   *      option array "items"
-   *          option string "id"
-   *          option string "phone"
-   *          option string "status" - queued|unsent
-   *          option string "queued" Date of enqueued
-   *          option int "parts" Number of parts a message
-   *          option int "error_code"
-   *          option string "error_message"
-   *          option string "text"
-  '''
-  def sendPersonalized(messages, sender = nil, params = {})
-    params['messages']  = messages
-    params['sender'] = sender
-    @serwersms.call('messages/send_personalized',params);
-  end
-  '''
-   * Sending Voice message
-   * 
-   * param string phone
-   * param array params
-   *      option string "text" If send of text to voice
-   *      option string "file_id" ID from wav files
-   *      option string "date" Set the date of sending
-   *      option bool "test" Test mode
-   *      option int|array "group_id" Sending to the group instead of a phone number
-   *      option int|array "contact_id" Sending to phone from contacts
-   * return array
-   *      option bool "success"
-   *      option int "queued" Number of queued messages
-   *      option int "unsent" Number of unsent messages
-   *      option array "items"
-   *          option string "id"
-   *          option string "phone"
-   *          option string "status" - queued|unsent
-   *          option string "queued" Date of enqueued
-   *          option int "parts" Number of parts a message
-   *          option int "error_code"
-   *          option string "error_message"
-   *          option string "text"
-   '''
-   def sendVoice(phone, params = {})
-    params['phone']  = phone
-    @serwersms.call('messages/send_voice',params);
-   end
-  '''
-   * Sending MMS
-   * 
-   * param string|array phone
-   * param string title Title of message (max 40 chars)
-   * param array params
-   *      option string "file_id"
-   *      option string|array "file" File in base64 encoding
-   *      option string "date" Set the date of sending
-   *      option bool "test" Test mode
-   *      option int|array "group_id" Sending to the group instead of a phone number
-   * return array
-   *      option bool "success"
-   *      option int "queued" Number of queued messages
-   *      option int "unsent" Number of unsent messages
-   *      option array "items"
-   *          option string "id"
-   *          option string "phone"
-   *          option string "status" - queued|unsent
-   *          option string "queued" Date of enqueued
-   *          option int "parts" Number of parts a message
-   *          option int "error_code"
-   *          option string "error_message"
-   *          option string "text"
-   '''
-   def sendMms(phone,title, params = {})
-    params['phone']  = phone
-    params['title']  = title
-    @serwersms.call('messages/send_mms',params);
-   end
-   '''
-   * View single message
-   * 
-   * param string id
-   * param array params
-   *      option string "unique_id"
-   *      option bool "show_contact" Show details of the recipient from the contacts
-   * return array
-   *      option string "id"
-   *      option string "phone"
-   *      option string "status"
-   *          - delivered: The message is sent and delivered
-   *          - undelivered: The message is sent but not delivered
-   *          - sent: The message is sent and waiting for report
-   *          - unsent: The message wasnt sent
-   *          - in_progress: The message is queued for sending 
-   *          - saved: The message was saved in schedule
-   *      option string "queued" Date of enqueued
-   *      option string "sent" Date of sending
-   *      option string "delivered" Date of deliver
-   *      option string "sender"
-   *      option string "type" - eco|full|mms|voice
-   *      option string "text"
-   *      option string "reason"
-   *          - message_expired
-   *          - unsupported_number
-   *          - message_rejected
-   *          - missed_call
-   *          - wrong_number
-   *          - limit_exhausted
-   *          - lock_send
-   *          - wrong_message
-   *          - operator_error
-   *          - wrong_sender_name
-   *          - number_is_blacklisted
-   *          - sending_to_foreign_networks_is_locked
-   *          - no_permission_to_send_messages
-   *          - other_error
-   *      option array "contact"
-   *          option string "first_name"
-   *          option string "last_name"
-   *          option string "company"
-   *          option string "phone"
-   *          option string "email"
-   *          option string "tax_id"
-   *          option string "city"
-   *          option string "address"
-   *          option string "description"
-   '''
-   def view(id, params = {})
-    params['id']  = id
-    @serwersms.call('messages/view',params);
-   end
-   '''
-   * Checking messages reports
-   * 
-   * param array params
-   *      option string|array "id" ID message
-   *      option string|array "unique_id" ID message
-   *      option string|array "phone"
-   *      option string "date_from" The scope of the initial
-   *      option string "date_to" The scope of the final
-   *      option string "status" delivered|undelivered|pending|sent|unsent
-   *      option string "type" eco|full|mms|voice
-   *      option int "stat_id" Id package messages
-   *      option bool "show_contact" Show details of the recipient from the contacts
-   *      option int "page" The number of the displayed page
-   *      option int "limit" Limit items are displayed on the single page
-     *      option string "order" asc|desc
-   * return array
-   *      option array "paging"
-   *          option int "page" The number of current page
-   *          option int "count" The number of all pages
-   *      option array items
-   *          option string "id"
-   *          option string "phone"
-   *          option string "status"
-   *              - delivered: The message is sent and delivered
-   *              - undelivered: The message is sent but not delivered
-   *              - sent: The message is sent and waiting for report
-   *              - unsent: The message wasnt sent
-   *              - in_progress: The message is queued for sending 
-   *              - saved: The message was saved in the scheduler
-   *          option string "queued" Date of enqueued
-   *          option string "sent" Date of sending
-   *          option string "delivered" Date of deliver
-   *          option string "sender"
-   *          option string "type" - eco|full|mms|voice
-   *          option string "text"
-   *          option string "reason"
-   *              - message_expired
-   *              - unsupported_number
-   *              - message_rejected
-   *              - missed_call
-   *              - wrong_number
-   *              - limit_exhausted
-   *              - lock_send
-   *              - wrong_message
-   *              - operator_error
-   *              - wrong_sender_name
-   *              - number_is_blacklisted
-   *              - sending_to_foreign_networks_is_locked
-   *              - no_permission_to_send_messages
-   *              - other_error
-   *          option array "contact"
-   *              option string "first_name"
-   *              option string "last_name"
-   *              option string "company"
-   *              option string "phone"
-   *              option string "email"
-   *              option string "tax_id"
-   *              option string "city"
-   *              option string "address"
-   *              option string "description"
-   '''
-   def reports(params = {})
-     @serwersms.call('messages/reports',params);
-   end
-   '''
-   * Deleting message from the scheduler
-   * 
-   * param string id
-   * param string unique_id
-   * return array
-   *      option bool "success"
-   '''
-   def delete(id, unique_id = nil )
-     params = {} 
-     params['id']  = id
-     params['unique_id']  = unique_id
-     @serwersms.call('messages/delete',params);
-   end
-   '''
-   * List of received messages
-   * 
-   * param string type
-   *      - eco SMS ECO replies
-   *      - nd Incoming messages to ND number
-   *      - ndi Incoming messages to ND number
-   *      - mms Incoming MMS
-   * param array params
-   *      option string "ndi" Filtering by NDI
-   *      option string "phone" Filtering by phone
-   *      option string "date_from" The scope of the initial
-   *      option string "date_to" The scope of the final
-   *      option bool "read" Mark as read
-   *      option int "page" The number of the displayed page
-   *      option int "limit" Limit items are displayed on the single page
-     *      option string "order" asc|desc
-   * return array
-   *      option array "paging"
-   *          option int "page" The number of current page
-   *          option int "count" The number of all pages
-   *      option array "items"
-   *          option int "id"
-   *          option string "type" eco|nd|ndi|mms
-   *          option string "phone"
-   *          option string "recived" Date of received message
-   *          option string "message_id" ID of outgoing message (only for ECO SMS)
-   *          option bool "blacklist" Is the phone is blacklisted?
-   *          option string "text" Message
-   *          option string "to_number" Number of the recipient (for MMS)
-   *          option string "title" Title of message (for MMS)
-   *          option array "attachments" (for MMS)
-   *              option int "id"
-   *              option string "name"
-   *              option string "content_type"
-   *              option string "data" File
-   *          option array "contact"
-   *              option string "first_name"
-   *              option string "last_name"
-   *              option string "company"
-   *              option string "phone"
-   *              option string "email"
-   *              option string "tax_id"
-   *              option string "city"
-   *              option string "address"
-   *              option string "description"
-   '''
-   def recived(type, params = {} )
-     params['type']  = type
-     @serwersms.call('messages/recived',params);
-   end
-   '''
-   * Sending a message to an ND/SC
-   * 
-   * param string phone Sender phone number
-   * param string text Message
-   * return array
-   *      option bool "success"
-   '''
-   def sendNd(phone, text )
-     params = {}
-     params['phone']  = phone
-     params['text']   = text
-     @serwersms.call('messages/send_nd',params);
-   end
-   '''
-   * Sending a message to an NDI/SCI
-   * 
-   * param string phone Sender phone number
-   * param string text Message
-   * param string ndi_number Recipient phone number
-   * return array
-   *      option bool "success"
-   '''
-   def sendNdi(phone, text, ndi_number )
-     params = {}
-     params['phone']        = phone
-     params['text']         = text
-     params['ndi_number']   = ndi_number
-     @serwersms.call('messages/send_ndi',params);
-   end
-end

data/lib/library/payments.rb

@@ -1,55 +0,0 @@
-class Serwersms::Payments
-  def initialize(obj)
-      @serwersms = obj
-  end
-  
-  '''
-   * List of payments
-   * 
-   * return array
-   *      option array "items"
-   *          option int "id"
-   *          option string "number"
-   *          option string "state" paid|not_paid
-   *          option float "paid"
-   *          option float "total"
-   *          option string "payment_to"
-   *          option string "url"
-   '''
-   def index()
-     params = {}
-     @serwersms.call('payments/index',params);
-   end
-   
-   '''
-   * View single payment
-   * 
-   * param int id
-   * return array
-   *      option int "id"
-   *      option string "number"
-   *      option string "state" paid|not_paid
-   *      option float "paid"
-   *      option float "total"
-   *      option string "payment_to"
-   *      option string "url"
-   '''
-   def view(id)
-     params = {}
-     params['id']  = id
-     @serwersms.call('payments/view',params);
-   end
-   
-   '''
-   * Download invoice as PDF
-   * 
-   * param int id
-   * return resource
-   '''
-   def invoice(id)
-     params = {}
-     params['id']  = id
-     @serwersms.call('payments/invoice',params);
-   end
-   
-end

data/lib/library/phones.rb

@@ -1,40 +0,0 @@
-class Serwersms::Phones
-  def initialize(obj)
-      @serwersms = obj
-  end
-  
-  '''
-   * Checking phone in to HLR
-   * 
-   * param string $phone
-   * param string $id Query ID returned if the processing takes longer than 60 seconds
-   * return array
-   *      option string "phone"
-   *      option string "status"
-   *      option int "imsi"
-   *      option string "network"
-   *      option bool "ported"
-   *      option string "network_ported"
-   '''
-   def check(phone, id = nil)
-     params = {}
-     params['id']     = id
-     params['phone']  = phone
-     @serwersms.call('phones/check',params);
-   end
-   
-   '''
-   * Validating phone number
-   * 
-   * param string $phone
-   * return array
-   *      option bool "correct"
-   '''
-   def test(phone)
-     params = {}
-     params['phone']  = phone
-     @serwersms.call('phones/test',params);
-   end
-   
-  
-end

data/lib/library/premium.rb

@@ -1,58 +0,0 @@
-class Serwersms::Premium
-  def initialize(obj)
-      @serwersms = obj
-  end
-  
-  '''
-   * List of received SMS Premium
-   * 
-   * return array
-   *      option array "items"
-   *          option int "id"
-   *          option string "to_number" Premium number
-   *          option string "from_number" Sender phone number
-   *          option string "date"
-   *          option int "limit" Limitation the number of responses
-   *          option string "text" Message
-   '''
-   def index()
-     params = {}
-     @serwersms.call('premium/index',params);
-   end
-
-   '''
-   * Sending replies for received SMS Premium
-   * 
-   * param string phone
-   * param string text Message
-   * param string gate Premium number
-   * param int $id ID received SMS Premium
-   * return array
-   *      option bool "success"
-   '''
-   def send(phone, text, gate, id)
-     params = {}
-     params['text']   = text
-     params['phone']  = phone
-     params['gate']   = gate
-     params['id']   = id
-     @serwersms.call('premium/send',params);
-   end
- 
-   '''
-   * View quiz results
-   * 
-   * param int id
-   * return array
-   *      option int "id"
-   *      option string "name"
-   *      option array "items"
-   *          option int "id"
-   *          option int "count" Number of response
-   '''
-   def quiz(id)
-     params = {}
-     params['id']   = id
-     @serwersms.call('quiz/view',params);
-   end
-end

data/lib/library/senders.rb

@@ -1,36 +0,0 @@
-class Serwersms::Senders
-  def initialize(obj)
-      @serwersms = obj
-  end
-  
-  '''
-   * Creating new Sender name
-   * 
-   * param string name
-   * return array
-   *      option bool "success"
-   '''
-   def add(name)
-     params = {}
-     params['name']   = name
-     @serwersms.call('senders/add',params);
-   end
-  
-   '''
-   * Senders list
-   * 
-   * param array params
-   *      option bool "predefined"
-     *      option string "sort" Values: name
-     *      option string "order" Values: asc|desc
-   * return array
-   *      option array "items"
-   *          option string "name"
-   *          option string "agreement" delivered|required|not_required
-   *          option string "status" pending_authorization|authorized|rejected|deactivated
-   '''
-   def index(params = {})
-     @serwersms.call('senders/index',params);
-   end
-  
-end

data/lib/library/stats.rb

@@ -1,31 +0,0 @@
-class Serwersms::Stats
-  def initialize(obj)
-      @serwersms = obj
-  end
-  
-  '''
-   * Statistics an sending
-   * 
-   * param array params
-   *      option string "type" eco|full|voice|mms
-   *      option string "begin" Start date
-   *      option string "end" End date
-   * return array
-   *      option array "items"
-   *          option int "id"
-   *          option string "name"
-   *          option int "delivered"
-   *          option int "pending"
-   *          option int "undelivered"
-   *          option int "unsent"
-   *          option string "begin"
-   *          option string "end"
-   *          option string "text"
-   *          option string "type" eco|full|voice|mms
-   '''
-   def index(params = {} )
-     
-     @serwersms.call('stats/index',params);
-   end
-  
-end

data/lib/library/subaccounts.rb

@@ -1,87 +0,0 @@
-class Serwersms::Subaccounts
-  def initialize(obj)
-      @serwersms = obj
-  end
-  
-  '''
-   * Creating new subaccount
-   * 
-   * param string $subaccount_username
-   * param string $subaccount_password
-   * param int $subaccount_id Subaccount ID, which is template of powers
-   * param array $params
-   *      option string "name"
-   *      option string "phone"
-   *      option string "email"
-   * return type
-   '''
-   def add(subaccount_username, subaccount_password, subaccount_id, params = {})
-
-     params['subaccount_username']  = subaccount_username
-     params['subaccount_password']  = subaccount_password
-     params['subaccount_id']        = subaccount_id
-     @serwersms.call('subaccounts/add',params);
-   end
- 
-   '''
-   * List of subaccounts
-   * 
-   * return array
-   *      option array "items"
-   *          option int "id"
-   *          option string "username"
-   '''
-   def index()
-     params = {}
-     @serwersms.call('subaccounts/index',params);
-   end
-  
-   '''
-   * View details of subaccount
-   * 
-   * param int $id
-   * return array
-   *      option int "id"
-   *      option string "username"
-   *      option string "name"
-   *      option string "phone"
-   *      option string "email"
-   '''
-   def view(id)
-     params = {}
-     params['id']  = id
-     @serwersms.call('subaccounts/view',params);
-   end
-   
-   '''
-   * Setting the limit on subaccount
-   * 
-   * param int $id
-   * param string $type Message type: eco|full|voice|mms|hlr
-   * param int $value
-   * return array
-   *      option bool "success"
-   *      option int "id"
-   '''
-   def limit(id, type, value)
-     params = {}
-     params['id']     = id
-     params['type']   = type
-     params['value']  = value
-     @serwersms.call('subaccounts/limit',params);
-   end
-   
-   '''
-   * Deleting a subaccount
-   * 
-   * param int $id
-   * return array
-   *      option bool "success"
-   '''
-   def delete(id)
-     params = {}
-     params['id']     = id
-     @serwersms.call('subaccounts/delete',params);
-   end
-   
-end