Skip to content

Files

Latest commit

 

History

History
550 lines (309 loc) · 15.1 KB

TeamsApi.md

File metadata and controls

550 lines (309 loc) · 15.1 KB

\TeamsApi

All URIs are relative to https://api.phrase.com/v2

Method HTTP request Description
TeamCreate Post /accounts/{account_id}/teams Create a Team
TeamDelete Delete /accounts/{account_id}/teams/{id} Delete Team
TeamShow Get /accounts/{account_id}/teams/{id} Get Team
TeamUpdate Patch /accounts/{account_id}/teams/{id} Update Team
TeamsList Get /accounts/{account_id}/teams List Teams
TeamsProjectsCreate Post /accounts/{account_id}/teams/{team_id}/projects Add Project to Team
TeamsProjectsDelete Delete /accounts/{account_id}/teams/{team_id}/projects/{id} Remove Project from Team
TeamsSpacesCreate Post /accounts/{account_id}/teams/{team_id}/spaces Add Space
TeamsSpacesDelete Delete /accounts/{account_id}/teams/{team_id}/spaces/{id} Remove Space
TeamsUsersCreate Post /accounts/{account_id}/teams/{team_id}/users Add User
TeamsUsersDelete Delete /accounts/{account_id}/teams/{team_id}/users/{id} Remove User

TeamCreate

TeamDetail TeamCreate(ctx, accountId, teamCreateParameters, optional)

Create a Team

Create a new Team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamCreateParameters TeamCreateParameters
optional *TeamCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

TeamDetail

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamDelete

TeamDelete(ctx, accountId, id, optional)

Delete Team

Delete the specified Team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
id string ID
optional *TeamDeleteOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamDeleteOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamShow

TeamDetail TeamShow(ctx, accountId, id, optional)

Get Team

Show the specified Team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
id string ID
optional *TeamShowOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamShowOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

TeamDetail

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamUpdate

TeamDetail TeamUpdate(ctx, accountId, id, teamUpdateParameters, optional)

Update Team

Update the specified Team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
id string ID
teamUpdateParameters TeamUpdateParameters
optional *TeamUpdateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamUpdateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

TeamDetail

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsList

[]Team TeamsList(ctx, accountId, optional)

List Teams

List all Teams for the given account.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
optional *TeamsListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsListOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default |

Return type

[]Team

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsProjectsCreate

TeamsProjectsCreate(ctx, accountId, teamId, teamsProjectsCreateParameters, optional)

Add Project to Team

Adds an existing project to the team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamId string Team ID
teamsProjectsCreateParameters TeamsProjectsCreateParameters
optional *TeamsProjectsCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsProjectsCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsProjectsDelete

TeamsProjectsDelete(ctx, accountId, teamId, id, optional)

Remove Project from Team

Removes a specified project from the specified team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamId string Team ID
id string ID
optional *TeamsProjectsDeleteOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsProjectsDeleteOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsSpacesCreate

TeamsSpacesCreate(ctx, accountId, teamId, teamsSpacesCreateParameters, optional)

Add Space

Adds an existing space to the team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamId string Team ID
teamsSpacesCreateParameters TeamsSpacesCreateParameters
optional *TeamsSpacesCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsSpacesCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsSpacesDelete

TeamsSpacesDelete(ctx, accountId, teamId, id, optional)

Remove Space

Removes a specified space from the specified team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamId string Team ID
id string ID
optional *TeamsSpacesDeleteOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsSpacesDeleteOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsUsersCreate

TeamsUsersCreate(ctx, accountId, teamId, teamsUsersCreateParameters, optional)

Add User

Adds an existing user to the team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamId string Team ID
teamsUsersCreateParameters TeamsUsersCreateParameters
optional *TeamsUsersCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsUsersCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsUsersDelete

TeamsUsersDelete(ctx, accountId, teamId, id, optional)

Remove User

Removes a specified user from the specified team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId string Account ID
teamId string Team ID
id string ID
optional *TeamsUsersDeleteOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TeamsUsersDeleteOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]