Scroll to navigation

Pithub::Orgs(3pm) User Contributed Perl Documentation Pithub::Orgs(3pm)

NAME

Pithub::Orgs - Github v3 Orgs API

VERSION

version 0.01039

METHODS

get

Get an organization

    GET /orgs/:org
    

Examples:

    my $o = Pithub::Orgs->new;
    my $result = $o->get( org => 'CPAN-API' );
    

list

  • List all public organizations for a user.

        GET /users/:user/orgs
        

    Examples:

        my $o = Pithub::Orgs->new;
        my $result = $o->list( user => 'plu' );
        
  • List public and private organizations for the authenticated user.

        GET /user/orgs
        

    Examples:

        my $o = Pithub::Orgs->new;
        my $result = $o->list;
        

members

Provides access to Pithub::Orgs::Members.

teams

Provides access to Pithub::Orgs::Teams.

update

Edit an organization

    PATCH /orgs/:org
    

Examples:

    my $o = Pithub::Orgs->new;
    my $result = $o->update(
        org  => 'CPAN-API',
        data => {
            billing_email => 'support@github.com',
            blog          => 'https://github.com/blog',
            company       => 'GitHub',
            email         => 'support@github.com',
            location      => 'San Francisco',
            name          => 'github',
        }
    );
    

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.

2022-08-12 perl v5.34.0