https://github.com/lab5e/go-userapi
User API Go client library
https://github.com/lab5e/go-userapi
Last synced: 12 days ago
JSON representation
User API Go client library
- Host: GitHub
- URL: https://github.com/lab5e/go-userapi
- Owner: lab5e
- License: apache-2.0
- Created: 2021-04-07T14:32:48.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-06-30T09:17:48.000Z (almost 4 years ago)
- Last Synced: 2025-02-28T22:39:00.889Z (over 1 year ago)
- Language: Shell
- Size: 424 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for userapi
API to manage teams, members and tokens
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 1.3.13 bordering-jerilyn
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://docs.lab5e.com](https://docs.lab5e.com)
## Installation
Install the following dependencies:
```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```golang
import sw "./userapi"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
```golang
ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
```golang
ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
### URLs Configuration per Operation
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identifield by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
```
ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```
## Documentation for API Endpoints
All URIs are relative to *https://api.lab5e.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ProfileApi* | [**GetUserProfile**](docs/ProfileApi.md#getuserprofile) | **Get** /user/profile | Logged in profile
*TeamsApi* | [**AcceptInvite**](docs/TeamsApi.md#acceptinvite) | **Post** /user/teams/accept | Accept invite
*TeamsApi* | [**CreateTeam**](docs/TeamsApi.md#createteam) | **Post** /user/teams | Create team
*TeamsApi* | [**DeleteInvite**](docs/TeamsApi.md#deleteinvite) | **Delete** /user/teams/{teamId}/invites/{code} | Delete invite
*TeamsApi* | [**DeleteMember**](docs/TeamsApi.md#deletemember) | **Delete** /user/teams/{teamId}/members/{userId} | Remove member
*TeamsApi* | [**DeleteTeam**](docs/TeamsApi.md#deleteteam) | **Delete** /user/teams/{teamId} | Remove team
*TeamsApi* | [**GenerateInvite**](docs/TeamsApi.md#generateinvite) | **Post** /user/teams/{teamId}/invites | Generate invite
*TeamsApi* | [**ListInvites**](docs/TeamsApi.md#listinvites) | **Get** /user/teams/{teamId}/invites | List invites
*TeamsApi* | [**ListTeams**](docs/TeamsApi.md#listteams) | **Get** /user/teams | List teams
*TeamsApi* | [**RetrieveInvite**](docs/TeamsApi.md#retrieveinvite) | **Get** /user/teams/{teamId}/invites/{code} | Retrieve invite
*TeamsApi* | [**RetrieveMember**](docs/TeamsApi.md#retrievemember) | **Get** /user/teams/{teamId}/members/{userId} | Retrieve member
*TeamsApi* | [**RetrieveTeam**](docs/TeamsApi.md#retrieveteam) | **Get** /user/teams/{teamId} | Retrieve team
*TeamsApi* | [**RetrieveTeamMembers**](docs/TeamsApi.md#retrieveteammembers) | **Get** /user/teams/{teamId}/members | List members
*TeamsApi* | [**UpdateMember**](docs/TeamsApi.md#updatemember) | **Patch** /user/teams/{teamId}/members/{userId} | Update member
*TeamsApi* | [**UpdateTeam**](docs/TeamsApi.md#updateteam) | **Patch** /user/teams/{teamId} | Update team
*TokensApi* | [**CreateToken**](docs/TokensApi.md#createtoken) | **Post** /user/tokens | Create token
*TokensApi* | [**DeleteToken**](docs/TokensApi.md#deletetoken) | **Delete** /user/tokens/{token} | Remove token
*TokensApi* | [**ListTokens**](docs/TokensApi.md#listtokens) | **Get** /user/tokens | List tokens
*TokensApi* | [**RetrieveToken**](docs/TokensApi.md#retrievetoken) | **Get** /user/tokens/{token} | Retrieve token
*TokensApi* | [**UpdateToken**](docs/TokensApi.md#updatetoken) | **Patch** /user/tokens/{token} | Update token
## Documentation For Models
- [ATeam](docs/ATeam.md)
- [AcceptInviteRequest](docs/AcceptInviteRequest.md)
- [AnAPIToken](docs/AnAPIToken.md)
- [DeleteInviteResponse](docs/DeleteInviteResponse.md)
- [DeleteTokenResponse](docs/DeleteTokenResponse.md)
- [Invite](docs/Invite.md)
- [InviteList](docs/InviteList.md)
- [Member](docs/Member.md)
- [MemberList](docs/MemberList.md)
- [MemberOfATeam](docs/MemberOfATeam.md)
- [ProtobufAny](docs/ProtobufAny.md)
- [RequestInviteDetails](docs/RequestInviteDetails.md)
- [RpcStatus](docs/RpcStatus.md)
- [Team](docs/Team.md)
- [TeamList](docs/TeamList.md)
- [Token](docs/Token.md)
- [TokenList](docs/TokenList.md)
- [UserProfile](docs/UserProfile.md)
## Documentation For Authorization
### APIToken
- **Type**: API key
- **API key parameter name**: X-API-Token
- **Location**: HTTP header
Note, each API key must be added to a map of `map[string]APIKey` where the key is: X-API-Token and passed in as the auth context for each request.
## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`
## Author
dev@lab5e.com