1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: <?php
namespace Angelfon\SDK\Rest\Api\V099\User;
use Angelfon\SDK\Options;
use Angelfon\SDK\Values;
abstract class CallOptions
{
/**
* Build filters for the API response according to the specified parameters
*
* @param string $recipient The phone number to call
* @param string $batchId The ID of the batch to which this call will be added
* @param string $startedBefore Filters calls answered before the datetime specified
* @param string $startedAfter Filters calls answered after the datetime specified
* @param string $scheduledBefore Filters calls scheduled before the datetime specified
* @param string $scheduledAfter Filters calls scheduled after the datetime specified
* @param string $callFrom Filters by phone number used to make the call
* @param int $status Filters by call status (0 => pending, 1 => failed, 2 => answered)
* @param int $answer Filters by numeric option dialed during the call
* @return \Angelfon\SDK\Rest\Api\V099\User\ReadCallOptions The builder for read calls options
*/
public static function read(
$recipient = Values::NONE,
$batch = Values::NONE,
$startedBefore = Values::NONE,
$startedAfter = Values::NONE,
$scheduledBefore = Values::NONE,
$scheduledAfter = Values::NONE,
$callFrom = Values::NONE,
$status = Values::NONE,
$answer = Values::NONE
){
return new ReadCallOptions(
$recipient,
$batch,
$startedBefore,
$startedAfter,
$scheduledBefore,
$scheduledAfter,
$callFrom,
$status,
$answer
);
}
/**
* Build options for a new call
*
* @param int $type The call type
* @param int $audioId1 The ID of the audio first in the play queue
* @param string $tts1 A text to be readed
* @param int $audioId2 The ID of the audio third in the play queue
* @param string $tts2 A text to be readed
* @param int $audioId3 The ID of the audio fifth in the play queue
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $recipientName The name of the recipient
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @param string $batchId Add this call to a specific batch
* @param string $batchName Name this batch
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
public static function create(
$type = Values::NONE,
$audioId1 = Values::NONE,
$tts1 = Values::NONE,
$audioId2 = Values::NONE,
$tts2 = Values::NONE,
$audioId3 = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$recipientName = Values::NONE,
$callAt = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE,
$batchId = Values::NONE,
$batchName = Values::NONE
){
return new CreateCallOptions(
$type,
$audioId1,
$tts1,
$audioId2,
$tts2,
$audioId3,
$callerId,
$callFrom,
$recipientName,
$callAt,
$forceSchedule,
$adjustSchedule,
$batchId,
$batchName
);
}
/**
* Build options for a new call of type 0, which has no cost.
*
* @param int $audioId1 The ID of the audio to play in the call
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $batchName Name this batch
* @param string $batchId Add this call to a specific batch
* @param string $recipientName The name of the recipient
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
public static function createFree(
$audioId1 = Values::NONE,
$callAt = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$batchName = Values::NONE,
$batchId = Values::NONE,
$recipientName = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE
){
return new CreateCallOptions(
0,
$audioId1,
Values::NONE,
Values::NONE,
Values::NONE,
Values::NONE,
$callerId,
$callFrom,
$recipientName,
$callAt,
$forceSchedule,
$adjustSchedule,
$batchId,
$batchName
);
}
/**
* Build options for a new call of type 1, with a single audio.
*
* @param int $audioId1 The ID of the audio to play in the call
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $batchName Name this batch
* @param string $batchId Add this call to a specific batch
* @param string $recipientName The name of the recipient
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
public static function createWithSingleAudio(
$audioId1 = Values::NONE,
$callAt = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$batchName = Values::NONE,
$batchId = Values::NONE,
$recipientName = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE
){
return new CreateCallOptions(
1,
$audioId1,
Values::NONE,
Values::NONE,
Values::NONE,
Values::NONE,
$callerId,
$callFrom,
$recipientName,
$callAt,
$forceSchedule,
$adjustSchedule,
$batchId,
$batchName
);
}
/**
* Build options for a new call of type 2, with a single audio and answer registration.
*
* @param int $audioId1 The ID of the audio to play in the call
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $batchName Name this batch
* @param string $batchId Add this call to a specific batch
* @param string $recipientName The name of the recipient
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
public static function createWithAnswer(
$audioId1 = Values::NONE,
$callAt = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$batchName = Values::NONE,
$batchId = Values::NONE,
$recipientName = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE
){
return new CreateCallOptions(
2,
$audioId1,
Values::NONE,
Values::NONE,
Values::NONE,
Values::NONE,
$callerId,
$callFrom,
$recipientName,
$callAt,
$forceSchedule,
$adjustSchedule,
$batchId,
$batchName
);
}
/**
* Build options for a new call of type 6, with a single TTS.
*
* @param string $tts1 The text to be readed in the call
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $batchName Name this batch
* @param string $batchId Add this call to a specific batch
* @param string $recipientName The name of the recipient
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
public static function createWithSingleTts(
$tts1 = Values::NONE,
$callAt = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$batchName = Values::NONE,
$batchId = Values::NONE,
$recipientName = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE
){
return new CreateCallOptions(
6,
Values::NONE,
$tts1,
Values::NONE,
Values::NONE,
Values::NONE,
$callerId,
$callFrom,
$recipientName,
$callAt,
$forceSchedule,
$adjustSchedule,
$batchId,
$batchName
);
}
/**
* Build options for a new call of type 4, with two TTS and three Audios.
*
* @param int $audioId1 The ID of the audio first in the play queue
* @param string $tts1 A text to be readed
* @param int $audioId2 The ID of the audio third in the play queue
* @param string $tts2 A text to be readed
* @param int $audioId3 The ID of the audio fifth in the play queue
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $batchName Name this batch
* @param string $batchId Add this call to a specific batch
* @param string $recipientName The name of the recipient
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
public static function createWithAudioAndTts(
$audioId1 = Values::NONE,
$tts1 = Values::NONE,
$audioId2 = Values::NONE,
$tts2 = Values::NONE,
$audioId3 = Values::NONE,
$callAt = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$batchName = Values::NONE,
$batchId = Values::NONE,
$recipientName = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE
){
return new CreateCallOptions(
4,
$audioId1,
$tts1,
$audioId2,
$tts2,
$audioId3,
$callerId,
$callFrom,
$recipientName,
$callAt,
$forceSchedule,
$adjustSchedule,
$batchId,
$batchName
);
}
}
class ReadCallOptions extends Options
{
/**
* @param string $recipient The phone number to filter the results
* @param string $batchId Returns only calls in this batch
* @param string $startedBefore Returns calls started before the date time specified
* @param string $startedAfter Returns calls started after the date time specified
* @param string $scheduledBefore Returns calls scheduled before the date time specified
* @param string $scheduledAfter Returns calls scheduled after the date time specified
* @param string $callFrom Filters by phone number used to make the call
* @param int $status Filter by call status
* @param int $answer Filter by call answer
*/
public function __construct(
$recipient = Values::NONE,
$batchId = Values::NONE,
$startedBefore = Values::NONE,
$startedAfter = Values::NONE,
$scheduledBefore = Values::NONE,
$scheduledAfter = Values::NONE,
$callFrom = Values::NONE,
$status = Values::NONE,
$answer = Values::NONE
){
$this->options['recipient'] = $recipient;
$this->options['batchId'] = $batchId;
$this->options['startedBefore'] = $startedBefore;
$this->options['startedAfter'] = $startedAfter;
$this->options['scheduledBefore'] = $scheduledBefore;
$this->options['scheduledAfter'] = $scheduledAfter;
$this->options['callFrom'] = $callFrom;
$this->options['status'] = $status;
$this->options['answer'] = $answer;
}
public function setRecipient($recipient)
{
$this->options['recipient'] = $recipient;
}
public function setBatchId($batchId)
{
$this->options['batchId'] = $batchId;
}
public function setStartedBefore($datetime)
{
$this->options['startedBefore'] = $datetime;
}
public function setStartedAfter($datetime)
{
$this->options['startedAfter'] = $datetime;
}
public function setScheduledBefore($datetime)
{
$this->options['scheduledBefore'] = $datetime;
}
public function setScheduledAfter($datetime)
{
$this->options['scheduledAfter'] = $datetime;
}
public function setCallFrom($callFrom)
{
$this->options['callFrom'] = $callFrom;
}
public function setStatus($status)
{
$this->options['status'] = $status;
}
public function setAnswer($answer)
{
$this->options['answer'] = $answer;
}
}
class CreateCallOptions extends Options
{
/**
* @param int $type The call type
* @param int $audioId1 The ID of the audio first in the play queue
* @param string $tts1 A text to be readed
* @param int $audioId2 The ID of the audio third in the play queue
* @param string $tts2 A text to be readed
* @param int $audioId3 The ID of the audio fifth in the play queue
* @param boolean $callerId Use a validated phone to show on the call
* @param string $callFrom Use a phone number to make the call from (special users only)
* @param string $recipientName The name of the recipient
* @param string $callAt UTC time to schedule the call ie. '2017-05-15 14:15:00'
* @param boolean $forceSchedule Schedule call regardless of user's defined restriction periods
* @param boolean $adjustSchedule Schedule call at the end of the restricted period
* @param string $batchId Add this call to a specific batch
* @param string $batchName Name this batch
* @return \Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions The builder for create call options
*/
function __construct(
$type = Values::NONE,
$audioId1 = Values::NONE,
$tts1 = Values::NONE,
$audioId2 = Values::NONE,
$tts2 = Values::NONE,
$audioId3 = Values::NONE,
$callerId = Values::NONE,
$callFrom = Values::NONE,
$recipientName = Values::NONE,
$callAt = Values::NONE,
$forceSchedule = Values::NONE,
$adjustSchedule = Values::NONE,
$batchId = Values::NONE,
$batchName = Values::NONE
){
$this->options['type'] = $type;
$this->options['audioId1'] = $audioId1;
$this->options['audioId2'] = $audioId2;
$this->options['audioId3'] = $audioId3;
$this->options['tts1'] = $tts1;
$this->options['tts2'] = $tts2;
$this->options['callerId'] = $callerId;
$this->options['callFrom'] = $callFrom;
$this->options['recipientName'] = $recipientName;
$this->options['callAt'] = $callAt;
$this->options['forceSchedule'] = $forceSchedule;
$this->options['adjustSchedule'] = $adjustSchedule;
$this->options['batchId'] = $batchId;
$this->options['batchName'] = $batchName;
}
public function setBatchId($batchId)
{
$this->options['batchId'] = $batchId;
}
public function setBatchName($batchName)
{
$this->options['batchName'] = $batchName;
}
public function setType($type)
{
$this->options['type'] = $type;
}
public function setAudio1($audioId1)
{
$this->options['audioId1'] = $audioId1;
}
public function setAudio2($audioId2)
{
$this->options['audioId2'] = $audioId2;
}
public function setAudio3($audioId3)
{
$this->options['audioId3'] = $audioId3;
}
public function setTts1($tts)
{
$this->options['tts1'] = $tts;
}
public function setTts2($tts)
{
$this->options['tts2'] = $tts;
}
public function setCallerId($callerId)
{
$this->options['callerId'] = $callerId;
}
public function setCallFrom($callFrom)
{
$this->options['callFrom'] = $callFrom;
}
public function setRecipientName($recipientName)
{
$this->options['recipientName'] = $recipientName;
}
public function setCallAt($callAt)
{
$this->options['callAt'] = $callAt;
}
public function setForceSchedule($forceSchedule)
{
$this->options['forceSchedule'] = $forceSchedule;
}
public function setAdjustSchedule($adjustSchedule)
{
$this->options['adjustSchedule'] = $adjustSchedule;
}
}