Example #1
0
 /// <summary>
 /// Initializes a new instance of the <see cref="QueueFull" /> class.
 /// </summary>
 /// <param name="Id">Integer ID. Read-only. (required).</param>
 /// <param name="Name">Name. Required. (required).</param>
 /// <param name="Greeting">Greeting to be played when caller first connects. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE. Can be set to NULL to disable the greeting..</param>
 /// <param name="HoldMusic">HoldMusic.</param>
 /// <param name="MaxHoldTime">Maximum hold time in seconds. If provided, must equal one of: 60, 120, 180, 240, 300, 600, 900, 1200, 1800, 2700, 3600. Default is 300..</param>
 /// <param name="CallerIdType">Caller id type to show members. If provided, must equal one of: &#39;called_number&#39;, &#39;calling_number&#39;. Default is &#39;calling_number&#39;..</param>
 /// <param name="RingTime">Number of seconds to ring a member before cycling to the next member. If provided, must equal one of: 5, 10, 15, 20, 25, 30. Default is 5..</param>
 /// <param name="Members">Array of Member Objects. Non-virtual account extensions or phone numbers. See below for details..</param>
 public QueueFull(int?Id = default(int?), string Name = default(string), MediaSummary Greeting = default(MediaSummary), HoldMusic HoldMusic = default(HoldMusic), int?MaxHoldTime = default(int?), string CallerIdType = default(string), int?RingTime = default(int?), List <Member> Members = default(List <Member>))
 {
     // to ensure "Id" is required (not null)
     if (Id == null)
     {
         throw new InvalidDataException("Id is a required property for QueueFull and cannot be null");
     }
     else
     {
         this.Id = Id;
     }
     // to ensure "Name" is required (not null)
     if (Name == null)
     {
         throw new InvalidDataException("Name is a required property for QueueFull and cannot be null");
     }
     else
     {
         this.Name = Name;
     }
     this.Greeting     = Greeting;
     this.HoldMusic    = HoldMusic;
     this.MaxHoldTime  = MaxHoldTime;
     this.CallerIdType = CallerIdType;
     this.RingTime     = RingTime;
     this.Members      = Members;
 }
Example #2
0
 /// <summary>
 /// Initializes a new instance of the <see cref="GreetingInput" /> class.
 /// </summary>
 /// <param name="Type">The greeting to play. Can be \&quot;name\&quot; for the name_greeting as described above, \&quot;standard\&quot; for the standard greeting, or \&quot;alternate\&quot; for an alternate greeting. See below for details..</param>
 /// <param name="Alternate">Greeting to be played when type&#x3D;\&quot;alternate\&quot;. Output is a Greeting Summary Object. Input must be a Greeting Lookup Object..</param>
 /// <param name="Standard">Greeting to be played when type&#x3D;\&quot;standard\&quot;. Output is a Greeting Summary Object. Input must be a Greeting Lookup Object..</param>
 /// <param name="EnableLeaveMessagePrompt">Whether to prompt the caller with the following words after the voicemail greeting has been played: \&quot;Please leave your message after the tone. When finished, hang up or press the pound key.\&quot; Boolean..</param>
 public GreetingInput(string Type = default(string), MediaSummary Alternate = default(MediaSummary), MediaSummary Standard = default(MediaSummary), string EnableLeaveMessagePrompt = default(string))
 {
     this.Type      = Type;
     this.Alternate = Alternate;
     this.Standard  = Standard;
     this.EnableLeaveMessagePrompt = EnableLeaveMessagePrompt;
 }
Example #3
0
 /// <summary>
 /// Initializes a new instance of the <see cref="RuleSetAction" /> class.
 /// </summary>
 /// <param name="Action">Required..</param>
 /// <param name="Extension">Extension that this action refers to. Output is an Extension Summary Object. Input must be an Extension Lookup Object. Required..</param>
 /// <param name="Items">This action is for forwarding calls to any number of extensions or phone numbers. The forwarding is handled in parallel, meaning that all phone numbers and/or extensions will ring simultaneously. When the call is answered by any single phone number or extension, ringing will stop for all of them. Subsequent actions in this rule set will be performed if the call is not answered before the timeout period is reached, or if it is forwarded to an extension that has its own route and that route does not result in any actions that disconnect the call or take over call handling..</param>
 /// <param name="Timeout">Seconds that our routing engine should wait until moving on. Optional. Must be an integer between 5 and 90. Default is 5 seconds..</param>
 /// <param name="HoldMusic">Hold Music to be played while callers are waiting. Output is a Media Summary Object. Input must be a Media Lookup Object. Optional. Must refer to a media recording that has is_hold_music set to TRUE. Default is to play a standard ring tone..</param>
 /// <param name="Greeting">Greeting that this action refers to. Output is a Media Summary Object. Input must be a Media Lookup Object. Required. Must refer to a media recording that has is_hold_music set to FALSE..</param>
 /// <param name="Duration">Required. Seconds that the caller should be placed on hold before being moved onto the next action. Must be an integer between 1 and 60 seconds..</param>
 /// <param name="Menu">Menu that this action refers to. Required. Output is a Menu Summary Object. Input must be a Menu Lookup Object..</param>
 /// <param name="Queue">Queue that this action refers to. Required. Output is a Queue Summary Object. Input must be a Queue Lookup Object..</param>
 /// <param name="Trunk">Trunk that this action refers to. Required. Output is a Trunk Summary Object. Input must be a Trunk Lookup Object..</param>
 public RuleSetAction(string Action = default(string), ExtensionSummary Extension = default(ExtensionSummary), List <RuleSetForwardItem> Items = default(List <RuleSetForwardItem>), int?Timeout = default(int?), MediaSummary HoldMusic = default(MediaSummary), MediaSummary Greeting = default(MediaSummary), int?Duration = default(int?), MenuSummary Menu = default(MenuSummary), QueueSummary Queue = default(QueueSummary), TrunkSummary Trunk = default(TrunkSummary))
 {
     this.Action    = Action;
     this.Extension = Extension;
     this.Items     = Items;
     this.Timeout   = Timeout;
     this.HoldMusic = HoldMusic;
     this.Greeting  = Greeting;
     this.Duration  = Duration;
     this.Menu      = Menu;
     this.Queue     = Queue;
     this.Trunk     = Trunk;
 }
Example #4
0
 /// <summary>
 /// Initializes a new instance of the <see cref="MenuFull" /> class.
 /// </summary>
 /// <param name="Id">Integer Menu ID. Read-only..</param>
 /// <param name="Name">Name. Required. Unique..</param>
 /// <param name="AllowExtensionDial">Boolean. Determines whether a caller can enter an extension number to bypass the menu..</param>
 /// <param name="KeypressWaitTime">Number of seconds to wait for the caller to choose a menu option. Must be between 1 and 5 seconds..</param>
 /// <param name="Greeting">Greeting that is played when a caller enters a menu. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE..</param>
 /// <param name="KeypressError">Message that is played when the caller makes a keypress error. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE..</param>
 /// <param name="TimeoutHandler">Route that will be entered when the caller fails to choose a menu option within the allotted time. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route..</param>
 /// <param name="Options">Array of menu option objects. See below for details..</param>
 public MenuFull(int?Id = default(int?), string Name = default(string), bool?AllowExtensionDial = default(bool?), int?KeypressWaitTime = default(int?), MediaSummary Greeting = default(MediaSummary), MediaSummary KeypressError = default(MediaSummary), RouteSummary TimeoutHandler = default(RouteSummary), List <Option> Options = default(List <Option>))
 {
     this.Id   = Id;
     this.Name = Name;
     this.AllowExtensionDial = AllowExtensionDial;
     this.KeypressWaitTime   = KeypressWaitTime;
     this.Greeting           = Greeting;
     this.KeypressError      = KeypressError;
     this.TimeoutHandler     = TimeoutHandler;
     this.Options            = Options;
 }
Example #5
0
 /// <summary>
 /// Initializes a new instance of the <see cref="ExtensionFull" /> class.
 /// </summary>
 /// <param name="Id">ID of the extension. This is the internal Phone.com ID, not the extension number callers may dial..</param>
 /// <param name="Name">User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required..</param>
 /// <param name="Extension">Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required..</param>
 /// <param name="VoipId">API Account ID. Optional, object may return the voip_id..</param>
 /// <param name="FullName">Full name of the individual or department to which this extension is assigned.</param>
 /// <param name="UsageType">Can be \&quot;limited\&quot; or \&quot;unlimited\&quot;. In most cases, changing this will affect your monthly bill. Please see our Control Panel or contact Customer Service for pricing..</param>
 /// <param name="DeviceMembership">DeviceMembership.</param>
 /// <param name="Timezone">Time zone. Can be in any commonly recognized format, such as \&quot;America/Los_Angeles\&quot;..</param>
 /// <param name="NameGreeting">Greeting that communicates the extension&#39;s name. Output is a Greeting Summary Object. Input must be a Greeting Lookup Object..</param>
 /// <param name="IncludeInDirectory">Whether this extension should be included in the dial-by-name directory for this account. Boolean..</param>
 /// <param name="CallerId">Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone numbers. You can use our List Caller Ids service to see a current list. To unassign, you may set this to \&quot;private\&quot;, NULL, or an empty string..</param>
 /// <param name="LocalAreaCode">For outbound calls, this is the North American area code that this extension is calling from..</param>
 /// <param name="EnableCallWaiting">Whether Call Waiting is enabled. Boolean. Default is TRUE..</param>
 /// <param name="EnableOutboundCalls">Whether outgoing calls are enabled. Boolean. Default is TRUE..</param>
 /// <param name="Voicemail">Voicemail.</param>
 /// <param name="CallNotifications">CallNotifications.</param>
 /// <param name="Route">Route which will handle incoming voice and fax calls. Only valid on PUT requests, not POST. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route. Route must belong to this extension already..</param>
 public ExtensionFull(int?Id = default(int?), string Name = default(string), int?Extension = default(int?), int?VoipId = default(int?), string FullName = default(string), string UsageType = default(string), DeviceMembership DeviceMembership = default(DeviceMembership), string Timezone = default(string), MediaSummary NameGreeting = default(MediaSummary), bool?IncludeInDirectory = default(bool?), string CallerId = default(string), string LocalAreaCode = default(string), bool?EnableCallWaiting = default(bool?), bool?EnableOutboundCalls = default(bool?), Voicemail Voicemail = default(Voicemail), Notification CallNotifications = default(Notification), RouteSummary Route = default(RouteSummary))
 {
     this.Id                  = Id;
     this.Name                = Name;
     this.Extension           = Extension;
     this.VoipId              = VoipId;
     this.FullName            = FullName;
     this.UsageType           = UsageType;
     this.DeviceMembership    = DeviceMembership;
     this.Timezone            = Timezone;
     this.NameGreeting        = NameGreeting;
     this.IncludeInDirectory  = IncludeInDirectory;
     this.CallerId            = CallerId;
     this.LocalAreaCode       = LocalAreaCode;
     this.EnableCallWaiting   = EnableCallWaiting;
     this.EnableOutboundCalls = EnableOutboundCalls;
     this.Voicemail           = Voicemail;
     this.CallNotifications   = CallNotifications;
     this.Route               = Route;
 }
Example #6
0
 /// <summary>
 /// Initializes a new instance of the <see cref="TrunkFull" /> class.
 /// </summary>
 /// <param name="Id">Integer Trunk ID. Read-only. (required).</param>
 /// <param name="Name">Name. Required. (required).</param>
 /// <param name="Uri">Fully-qualified SIP URI. Required. (required).</param>
 /// <param name="MaxConcurrentCalls">Max concurrent calls. Default is 10. (required).</param>
 /// <param name="MaxMinutesPerMonth">Max minutes per month. Default is 750. (required).</param>
 /// <param name="Greeting">Greeting. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE. (required).</param>
 /// <param name="ErrorMessage">Error Message. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE. (required).</param>
 /// <param name="Codecs">Custom audio codec configuration, if any is needed. If provided, must be a simple array containing the prioritized list of desired codecs. Supported codecs are: g711u 64k, g711u 56k, g711a 64k, g711a 56k, g7231, g728, g729, g729A, g729B, g729AB, gms full, rfc2833, t38, ilbc, h263, g722, g722_1, g729D, g729E, amr, amr_wb, efr, evrc, h264, mpeg4, red, cng, SIP Info to 2833 (required).</param>
 public TrunkFull(int?Id = default(int?), string Name = default(string), string Uri = default(string), int?MaxConcurrentCalls = default(int?), int?MaxMinutesPerMonth = default(int?), MediaSummary Greeting = default(MediaSummary), MediaSummary ErrorMessage = default(MediaSummary), List <string> Codecs = default(List <string>))
 {
     // to ensure "Id" is required (not null)
     if (Id == null)
     {
         throw new InvalidDataException("Id is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.Id = Id;
     }
     // to ensure "Name" is required (not null)
     if (Name == null)
     {
         throw new InvalidDataException("Name is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.Name = Name;
     }
     // to ensure "Uri" is required (not null)
     if (Uri == null)
     {
         throw new InvalidDataException("Uri is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.Uri = Uri;
     }
     // to ensure "MaxConcurrentCalls" is required (not null)
     if (MaxConcurrentCalls == null)
     {
         throw new InvalidDataException("MaxConcurrentCalls is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.MaxConcurrentCalls = MaxConcurrentCalls;
     }
     // to ensure "MaxMinutesPerMonth" is required (not null)
     if (MaxMinutesPerMonth == null)
     {
         throw new InvalidDataException("MaxMinutesPerMonth is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.MaxMinutesPerMonth = MaxMinutesPerMonth;
     }
     // to ensure "Greeting" is required (not null)
     if (Greeting == null)
     {
         throw new InvalidDataException("Greeting is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.Greeting = Greeting;
     }
     // to ensure "ErrorMessage" is required (not null)
     if (ErrorMessage == null)
     {
         throw new InvalidDataException("ErrorMessage is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.ErrorMessage = ErrorMessage;
     }
     // to ensure "Codecs" is required (not null)
     if (Codecs == null)
     {
         throw new InvalidDataException("Codecs is a required property for TrunkFull and cannot be null");
     }
     else
     {
         this.Codecs = Codecs;
     }
 }