Pithub::Orgs::Members(3)

NAME
Pithub::Orgs::Members - Github v3 Org Members API

VERSION
version 0.01043

METHODS

  conceal

•   Conceal a user's membership

        DELETE /orgs/:org/public_members/:user

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->conceal(
            org  => 'CPAN-API',
            user => 'plu',
        );

  delete

•   Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

        DELETE /orgs/:org/members/:user

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->delete(
            org  => 'CPAN-API',
            user => 'plu',
        );

  is_member

•   Check if a user is a member of an organization

        GET /orgs/:org/members/:user

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->is_member(
            org  => 'CPAN-API',
            user => 'plu',
        );

  is_public

•   Get if a user is a public member

        GET /orgs/:org/public_members/:user

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->is_public(
            org  => 'CPAN-API',
            user => 'plu',
        );

  list

•   List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. Otherwise only public members are returned.

        GET /orgs/:org/members

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->list( org => 'CPAN-API' );

  list_public

•   Members of an organization can choose to have their membership publicized or not.

        GET /orgs/:org/public_members

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->list_public( org => 'CPAN-API' );

  publicize

•   Publicize a user's membership

        PUT /orgs/:org/public_members/:user

    Examples:

        my $m = Pithub::Orgs::Members->new;
        my $result = $m->publicize(
            org  => 'CPAN-API',
            user => 'plu',
        );

AUTHOR
Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.