Skip to content

InvitationCreateParameters.md

Latest commit

 

History

History
31 lines (24 loc) · 1.79 KB

InvitationCreateParameters.md

File metadata and controls

31 lines (24 loc) · 1.79 KB
Raw

Phrase::InvitationCreateParameters

Properties

Name Type Description Notes
email String The email of the invited user. The `email` can not be updated once created. Create a new invitation for each unique email.
role String Invitiation role, can be any of Manager, Developer, Translator.
project_ids String List of project ids the invited user has access to. [optional]
locale_ids String List of locale ids the invited user has access to. [optional]
space_ids Array<String> List of spaces the user is assigned to. [optional]
team_ids Array<String> List of teams the user is assigned to. [optional]
default_locale_codes Array<String> List of default locales for the user. [optional]
permissions Hash<String, String> Additional permissions depending on invitation role. Available permissions are `create_upload` and `review_translations` [optional]

Code Sample

require 'phrase'

instance = Phrase::InvitationCreateParameters.new(email: 'example@mail.com',
                                 role: 'Developer',
                                 project_ids: 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
                                 locale_ids: 'abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235',
                                 space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
                                 team_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
                                 default_locale_codes: ["en","de"],
                                 permissions: {"create_upload":true,"review_translations":true})