Commit 7fec358f authored by Roman Lacko's avatar Roman Lacko
Browse files

Update pod-GitLab.md

parent 8cf66d7f

pod-GitLab.md

+30 −20
Original line number Diff line number Diff line 
# NAME



    GitLab - convenience wrapper for GitLab::API that provides useful constants

GitLab - convenience wrapper for [GitLab::API](pod-GitLab-api.md) that provides useful constants



# SYNOPSIS



```{.pl}

use GitLab qw(:utils);



my $gitlab = GitLab::API->new(...);

my $users  = $gitlab->users();

```



# DESCRIPTION
@@ -20,34 +22,42 @@ for explanation. 


Import with `:group_visibility` tag.



    10 GROUP_PRIVATE

    20 GROUP_INTERNAL

    30 GROUP_PUBLIC

| code  | constant               |

| ----: | ---------------------- |

| 10    | `GROUP_PRIVATE`        |

| 20    | `GROUP_INTERNAL`       |

| 30    | ` GROUP_PUBLIC`        |



### Member access



Import with `:member_access` tag.



    10 MEMBER_GUEST

    20 MEMBER_REPORTER

    30 MEMBER_DEVELOPER

    40 MEMBER_MASTER

    50 MEMBER_OWNER

| code  | constant               |

| ----: | ---------------------- |

| 10    | `MEMBER_GUEST`         |

| 20    | `MEMBER_REPORTER`      |

| 30    | `MEMBER_DEVELOPER`     |

| 40    | `MEMBER_MASTER`        |

| 50    | `MEMBER_OWNER`         |



## Utilities



Import with `:utils` tag.



- group\_visibility\_name()

- `group_visibility_name()`



    ```{.pl}

    $name = GitLab::group_visibility_name($code)

    ```



    Translates a Group Visibility code to its string representation, i.e. _Private_, _Internal_ or _Public_.

    If the parameter does not represent a valid GitLab Group Visibility code, returns _Invalid_.



- member\_access\_name()

- `member_access_name()`



    ```{.pl}

    $name = GitLab::member_access_name($code);

    ```



    Translates a Member Access code to its string representation, i.e. _Guest_, _Reporter_, _Developer_, _Master_ and _Owner_.

    If the parameter does not represent a valid GitLab Member Access code, returns _Invalid_.
@@ -62,18 +72,18 @@ Roman Lacko <[xlacko1@fi.muni.cz](https://metacpan.org/pod/xlacko1@fi.muni.cz)> 


    Complete GitLab API v3 implementation with CLI support.



- [GitLab::API](https://metacpan.org/pod/GitLab::API)

- [GitLab::API](pod-GitLab-API.md)



    implementation of the [GitLab API](http://docs.gitlab.com/ce/api/) client.



- [GitLab::Groups](https://metacpan.org/pod/GitLab::Groups)

- [GitLab::Groups](pod-GitLab-Groups.md)



    [GitLab Groups](http://docs.gitlab.com/ce/api/groups.html) methods.



- [GitLab::Namespaces](https://metacpan.org/pod/GitLab::Namespaces)

- [GitLab::Namespaces](pod-GitLab-Namespaces.md)



    [GitLab Namespaces](http://docs.gitlab.com/ce/api/namespaces.html) methods.



- [GitLab::Users](https://metacpan.org/pod/GitLab::Users)

- [GitLab::Users](pod-GitLab-Users.md)



    [GitLab Users](http://docs.gitlab.com/ce/api/users.html) methods.