lab5e / swift-userapi

Swift User API client library

Swift5 API client for User

API to manage teams, members and tokens

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 1.3.13 bordering-jerilyn
• Package version:
• Build package: org.openapitools.codegen.languages.Swift5ClientCodegen For more information, please visit https://docs.lab5e.com

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

All URIs are relative to https://api.lab5e.com

Class	Method	HTTP request	Description
ProfileAPI	getUserProfile	GET /user/profile	Logged in profile
TeamsAPI	acceptInvite	POST /user/teams/accept	Accept invite
TeamsAPI	createTeam	POST /user/teams	Create team
TeamsAPI	deleteInvite	DELETE /user/teams/{teamId}/invites/{code}	Delete invite
TeamsAPI	deleteMember	DELETE /user/teams/{teamId}/members/{userId}	Remove member
TeamsAPI	deleteTeam	DELETE /user/teams/{teamId}	Remove team
TeamsAPI	generateInvite	POST /user/teams/{teamId}/invites	Generate invite
TeamsAPI	listInvites	GET /user/teams/{teamId}/invites	List invites
TeamsAPI	listTeams	GET /user/teams	List teams
TeamsAPI	retrieveInvite	GET /user/teams/{teamId}/invites/{code}	Retrieve invite
TeamsAPI	retrieveMember	GET /user/teams/{teamId}/members/{userId}	Retrieve member
TeamsAPI	retrieveTeam	GET /user/teams/{teamId}	Retrieve team
TeamsAPI	retrieveTeamMembers	GET /user/teams/{teamId}/members	List members
TeamsAPI	updateMember	PATCH /user/teams/{teamId}/members/{userId}	Update member
TeamsAPI	updateTeam	PATCH /user/teams/{teamId}	Update team
TokensAPI	createToken	POST /user/tokens	Create token
TokensAPI	deleteToken	DELETE /user/tokens/{token}	Remove token
TokensAPI	listTokens	GET /user/tokens	List tokens
TokensAPI	retrieveToken	GET /user/tokens/{token}	Retrieve token
TokensAPI	updateToken	PATCH /user/tokens/{token}	Update token

Documentation For Models

• ATeam
• AcceptInviteRequest
• AnAPIToken
• DeleteInviteResponse
• DeleteTokenResponse
• Invite
• InviteList
• Member
• MemberList
• MemberOfATeam
• ProtobufAny
• RequestInviteDetails
• RpcStatus
• Team
• TeamList
• Token
• TokenList
• UserProfile

Documentation For Authorization

APIToken

• Type: API key
• API key parameter name: X-API-Token
• Location: HTTP header

Author

[e-mail]