.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::Duo::Admin::Phone 3pm" .TH Net::Duo::Admin::Phone 3pm "2015-08-16" "perl v5.20.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Duo::Admin::Phone \- Representation of a Duo phone .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& my $decoded_json = get_json(); \& my $phone = Net::Duo::Admin::Phone\->new($decoded_json); \& say $phone\->number; .Ve .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" Perl 5.14 or later and the modules HTTP::Request and HTTP::Response (part of HTTP::Message), \s-1JSON, LWP \s0(also known as libwww-perl), Perl6::Slurp, Sub::Install, and URI::Escape (part of \s-1URI\s0), all of which are available from \s-1CPAN.\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" A Net::Duo::Admin::Phone object is a Perl representation of a Duo phone as returned by the Duo Admin \s-1API,\s0 usually via the \fIphones()\fR method or nested in a user returned by the \fIusers()\fR method. It contains various information about a phone. .SH "CLASS METHODS" .IX Header "CLASS METHODS" .IP "create(\s-1DUO, DATA\s0)" 4 .IX Item "create(DUO, DATA)" Creates a new phone in Duo and returns the resulting phone as a new Net::Duo::Admin::Phone object. \s-1DUO\s0 is the Net::Duo object that should be used to perform the creation. \s-1DATA\s0 is a reference to a hash with the following keys: .RS 4 .IP "extension" 4 .IX Item "extension" The extension. Optional. .IP "name" 4 .IX Item "name" The name of the phone. Optional. .IP "number" 4 .IX Item "number" The phone number. Optional. .IP "platform" 4 .IX Item "platform" The platform of phone for Duo Mobile, or \f(CW\*(C`unknown\*(C'\fR for a generic phone type. For the list of valid values, see the Duo Admin \s-1API\s0 documentation. Optional. .IP "postdelay" 4 .IX Item "postdelay" The time (in seconds) to wait after the extension is dialed and before the speaking the prompt. Optional. .IP "predelay" 4 .IX Item "predelay" The time (in seconds) to wait after the number picks up and before dialing the extension. Optional. .IP "type" 4 .IX Item "type" The type of the phone. See the \*(L"\fItype()\fR\*(R" method below for the possible values. Optional. .RE .RS 4 .RE .IP "new(\s-1DUO, DATA\s0)" 4 .IX Item "new(DUO, DATA)" Creates a new Net::Duo::Admin::Phone object from a full data set. \s-1DUO\s0 is the Net::Duo object that should be used for any further actions on this object. \s-1DATA\s0 should be the data structure returned by the Duo \s-1REST API\s0 for a single user, after \s-1JSON\s0 decoding. .IP "new(\s-1DUO, ID\s0)" 4 .IX Item "new(DUO, ID)" Creates a new Net::Duo::Admin::Phone by \s-1ID. DUO\s0 is the Net::Duo object that is used to retrieve the phone from Duo and will be used for any subsequent operations. The \s-1ID\s0 should be the Duo identifier of the phone. This constructor is distinguished from the previous constructor by checking whether \s-1ID\s0 is a reference. .SH "INSTANCE ACTION METHODS" .IX Header "INSTANCE ACTION METHODS" .IP "activation_url([\s-1ARGS\s0])" 4 .IX Item "activation_url([ARGS])" Request activation URLs (and optionally an install \s-1URL\s0) for this phone. \&\s-1ARGS\s0 is an optional reference to a hash whose keys should be chosen from the following: .RS 4 .IP "install" 4 .IX Item "install" If set to a true value, request an installation \s-1URL\s0 for this phone as well as the activation URLs. This is a \s-1URL\s0 that, when opened, will prompt the user to install Duo Mobile. The default is to not request an installation \&\s-1URL.\s0 .IP "valid_secs" 4 .IX Item "valid_secs" The number of seconds these activation URLs should be valid for. The default is 86,400 (one day). .RE .RS 4 .Sp The return value of this method will be a reference to a hash containing the following keys: .IP "activation_url" 4 .IX Item "activation_url" Opening this \s-1URL\s0 with the Duo Mobile app will complete activation. .IP "activation_barcode" 4 .IX Item "activation_barcode" \&\s-1URL\s0 of an image that can be scanned with Duo Mobile to complete activation. Activating with this image or with the activation \s-1URL\s0 will produce the same result. .IP "installation_url" 4 .IX Item "installation_url" Opening this \s-1URL\s0 on the phone will prompt the user to install Duo Mobile. This will only be present if the install argument is set to a true value. .IP "valid_secs" 4 .IX Item "valid_secs" The number of seconds that the activation code is valid for. Normally this will be the same as the valid_secs argument in the request if it was present, unless Duo rejected the requested validity interval. .RE .RS 4 .RE .IP "\fIcommit()\fR" 4 .IX Item "commit()" Commit all changes made via the set_*() methods to Duo. Until this method is called, any changes made via set_*() are only internal to the object and not reflected in Duo. .Sp After \fIcommit()\fR, the internal representation of the object will be refreshed to match the new data returned by the Duo \s-1API\s0 for that object. Therefore, other fields of the object may change after \fIcommit()\fR if some other user has changed other, unrelated fields in the object. .Sp It's best to think of this method as a synchronize operation: changed data is written back, overwriting what's in Duo, and unchanged data may be overwritten by whatever is currently in Duo, if it is different. .IP "\fIdelete()\fR" 4 .IX Item "delete()" Delete this phone from Duo. After successful completion of this call, the Net::Duo::Admin::Phone object should be considered read-only, since no further changes to the object can be meaningfully sent to Duo. .IP "\fIjson()\fR" 4 .IX Item "json()" Convert the data stored in the object to \s-1JSON\s0 and return the results. The resulting \s-1JSON\s0 should match the \s-1JSON\s0 that one would get back from the Duo web service when retrieving the same object (plus any changes made locally to the object via set_*() methods). This is primarily intended for debugging dumps or for passing Duo objects to other systems via further \&\s-1JSON\s0 APIs. .IP "\fIsend_sms_passcodes()\fR" 4 .IX Item "send_sms_passcodes()" Generate a new batch of \s-1SMS\s0 passcodes and send them to the phone in a single \s-1SMS\s0 message. The number of passcodes sent is a global setting on the Duo account. .SH "INSTANCE DATA METHODS" .IX Header "INSTANCE DATA METHODS" Some fields have set_*() methods. Those methods replace the value of the field in its entirety with the new value passed in. This change is only made locally in the object until \fIcommit()\fR is called. .IP "\fIactivated()\fR" 4 .IX Item "activated()" Whether the phone has been activated for Duo Mobile. .IP "\fIcapabilities()\fR" 4 .IX Item "capabilities()" A list of phone capabilities, chosen from the following values: .RS 4 .ie n .IP """push""" 4 .el .IP "\f(CWpush\fR" 4 .IX Item "push" The device is activated for Duo Push. .ie n .IP """phone""" 4 .el .IP "\f(CWphone\fR" 4 .IX Item "phone" The device can receive phone calls. .ie n .IP """sms""" 4 .el .IP "\f(CWsms\fR" 4 .IX Item "sms" The device can receive batches of \s-1SMS\s0 passcodes. .RE .RS 4 .RE .IP "\fIextension()\fR" 4 .IX Item "extension()" .PD 0 .IP "set_extension(\s-1EXTENSION\s0)" 4 .IX Item "set_extension(EXTENSION)" .PD The extension for this phone, if any. .IP "\fIname()\fR" 4 .IX Item "name()" .PD 0 .IP "set_name(\s-1NAME\s0)" 4 .IX Item "set_name(NAME)" .PD The name of this phone. .IP "\fInumber()\fR" 4 .IX Item "number()" .PD 0 .IP "set_number(\s-1NUMBER\s0)" 4 .IX Item "set_number(NUMBER)" .PD The number for this phone, without any extension. .IP "\fIphone_id()\fR" 4 .IX Item "phone_id()" The unique \s-1ID\s0 of this phone as generated by Duo on phone creation. .IP "\fIplatform()\fR" 4 .IX Item "platform()" .PD 0 .IP "set_platform(\s-1PLATFORM\s0)" 4 .IX Item "set_platform(PLATFORM)" .PD The platform of phone for Duo Mobile, or \f(CW\*(C`unknown\*(C'\fR for a generic phone type. For the list of valid values, see the Duo Admin \s-1API\s0 documentation. .IP "\fIpostdelay()\fR" 4 .IX Item "postdelay()" .PD 0 .IP "set_postdelay(\s-1POSTDELAY\s0)" 4 .IX Item "set_postdelay(POSTDELAY)" .PD The time (in seconds) to wait after the extension is dialed and before the speaking the prompt. .IP "\fIpredelay()\fR" 4 .IX Item "predelay()" .PD 0 .IP "set_predelay(\s-1PREDELAY\s0)" 4 .IX Item "set_predelay(PREDELAY)" .PD The time (in seconds) to wait after the number picks up and before dialing the extension. .IP "\fIsms_passcodes_sent()\fR" 4 .IX Item "sms_passcodes_sent()" Whether \s-1SMS\s0 passcodes have been sent to this phone. .IP "\fItype()\fR" 4 .IX Item "type()" .PD 0 .IP "set_type(\s-1TYPE\s0)" 4 .IX Item "set_type(TYPE)" .PD The type of phone, chosen from \f(CW\*(C`unknown\*(C'\fR, \f(CW\*(C`mobile\*(C'\fR, or \f(CW\*(C`landline\*(C'\fR. .IP "\fIusers()\fR" 4 .IX Item "users()" The users associated with this phone as a list of Net::Duo::Admin::User objects. .SH "AUTHOR" .IX Header "AUTHOR" Russ Allbery .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2014 The Board of Trustees of the Leland Stanford Junior University .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Net::Duo::Admin .PP Duo Admin \s-1API\s0 for phones .PP This module is part of the Net::Duo distribution. The current version of Net::Duo is available from \s-1CPAN,\s0 or directly from its web site at .