.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Debbugs::SOAP 3pm"
.TH Debbugs::SOAP 3pm "2018-02-26" "perl v5.26.1" "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"
Debbugs::SOAP \-\-
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "BUGS"
.IX Header "BUGS"
None known.
.SS "get_usertag"
.IX Subsection "get_usertag"
.Vb 2
\&     my %ut = get_usertag(\*(Aqdon@donarmstrong.com\*(Aq,\*(Aqthis\-bug\-sucks\*(Aq,\*(Aqeat\-this\-bug\*(Aq);
\&     my %ut = get_usertag(\*(Aqdon@donarmstrong.com\*(Aq);
.Ve
.PP
Returns a hashref of bugs which have the specified usertags for the
user set.
.PP
In the second case, returns all of the usertags for the user passed.
.SS "get_status"
.IX Subsection "get_status"
.Vb 8
\&     my @statuses = get_status(@bugs);
\&     my @statuses = get_status([bug => 304234,
\&                                dist => \*(Aqunstable\*(Aq,
\&                               ],
\&                               [bug => 304233,
\&                                dist => \*(Aqunstable\*(Aq,
\&                               ],
\&                              )
.Ve
.PP
Returns an arrayref of hashrefs which output the status for specific
sets of bugs.
.PP
In the first case, no options are passed to
Debbugs::Status::get_bug_status besides the bug number; in the
second the bug, dist, arch, bugusertags, sourceversions, and version
parameters are passed if they are present.
.PP
As a special case for suboptimal \s-1SOAP\s0 implementations, if only one
argument is passed to get_status and it is an arrayref which either is
empty, has a number as the first element, or contains an arrayref as
the first element, the outer arrayref is dereferenced, and processed
as in the examples above.
.PP
See Debbugs::Status::get_bug_status for details.
.SS "get_bugs"
.IX Subsection "get_bugs"
.Vb 2
\&     my @bugs = get_bugs(...);
\&     my @bugs = get_bugs([...]);
.Ve
.PP
Returns a list of bugs. In the second case, allows the variable
parameters to be specified as an array reference in case your favorite
language's \s-1SOAP\s0 implementation is craptacular.
.PP
See Debbugs::Bugs::get_bugs for details on what \f(CW\*(C`...\*(C'\fR actually
means.
.SS "newest_bugs"
.IX Subsection "newest_bugs"
.Vb 1
\&     my @bugs = newest_bugs(5);
.Ve
.PP
Returns a list of the newest bugs. [Note that all bugs are *not*
guaranteed to exist, but they should in the most common cases.]
.SS "get_bug_log"
.IX Subsection "get_bug_log"
.Vb 2
\&     my $bug_log = get_bug_log($bug);
\&     my $bug_log = get_bug_log($bug,$msg_num);
.Ve
.PP
Retuns a parsed set of the bug log; this is an array of hashes with
the following
.PP
.Vb 12
\& [{html => \*(Aq\*(Aq,
\&   header => \*(Aq\*(Aq,
\&   body    => \*(Aq\*(Aq,
\&   attachments => [],
\&   msg_num     => 5,
\&  },
\&  {html => \*(Aq\*(Aq,
\&   header => \*(Aq\*(Aq,
\&   body    => \*(Aq\*(Aq,
\&   attachments => [],
\&  },
\& ]
.Ve
.PP
Currently \f(CW$msg_num\fR is completely ignored.
.SS "binary_to_source"
.IX Subsection "binary_to_source"
.Vb 1
\&     binary_to_source($binary_name,$binary_version,$binary_architecture)
.Ve
.PP
Returns a reference to the source package name and version pair
corresponding to a given binary package name, version, and
architecture. If undef is passed as the architecture, returns a list
of references to all possible pairs of source package names and
versions for all architectures, with any duplicates removed.
.PP
As of comaptibility version 2, this has changed to use the more
powerful binary_to_source routine, which allows returning source only,
concatenated scalars, and other useful features.
.PP
See the documentation of Debbugs::Packages::binary_to_source for
details.
.SS "source_to_binary"
.IX Subsection "source_to_binary"
.Vb 1
\&     source_to_binary($source_name,$source_version);
.Ve
.PP
Returns a reference to an array of references to binary package name,
version, and architecture corresponding to a given source package name
and version. In the case that the given name and version cannot be
found, the unversioned package to source map is consulted, and the
architecture is not returned.
.PP
(This function corresponds to Debbugs::Packages::sourcetobinary)
.SS "get_versions"
.IX Subsection "get_versions"
.Vb 4
\&     get_version(package=>\*(Aqfoopkg\*(Aq,
\&                 dist => \*(Aqunstable\*(Aq,
\&                 arch => \*(Aqi386\*(Aq,
\&                );
.Ve
.PP
Returns a list of the versions of package in the distributions and
architectures listed. This routine only returns unique values.
.IP "package \*(-- package to return list of versions" 4
.IX Item "package package to return list of versions"
.PD 0
.IP "dist \*(-- distribution (unstable, stable, testing); can be an arrayref" 4
.IX Item "dist distribution (unstable, stable, testing); can be an arrayref"
.IP "arch \*(-- architecture (i386, source, ...); can be an arrayref" 4
.IX Item "arch architecture (i386, source, ...); can be an arrayref"
.IP "time \*(-- returns a version=>time hash at which the newest package matching this version was uploaded" 4
.IX Item "time returns a version=>time hash at which the newest package matching this version was uploaded"
.IP "source \*(-- returns source/version instead of just versions" 4
.IX Item "source returns source/version instead of just versions"
.IP "no_source_arch \*(-- discards the source architecture when arch is not passed. [Used for finding the versions of binary packages only.] Defaults to 0, which does not discard the source architecture. (This may change in the future, so if you care, please code accordingly.)" 4
.IX Item "no_source_arch discards the source architecture when arch is not passed. [Used for finding the versions of binary packages only.] Defaults to 0, which does not discard the source architecture. (This may change in the future, so if you care, please code accordingly.)"
.IP "return_archs \*(-- returns a version=>[archs] hash indicating which architectures are at which versions." 4
.IX Item "return_archs returns a version=>[archs] hash indicating which architectures are at which versions."
.PD
.PP
This function corresponds to Debbugs::Packages::get_versions
.SH "VERSION COMPATIBILITY"
.IX Header "VERSION COMPATIBILITY"
The functionality provided by the \s-1SOAP\s0 interface will change over time.
.PP
To the greatest extent possible, we will attempt to provide backwards
compatibility with previous versions; however, in order to have
backwards compatibility, you need to specify the version with which
you are compatible.