Sha256: 22f52b44870585e63ef4f00181cb8c3849640cf2a44079195d5694b3e73dd8ec

Contents?: true

Size: 1.92 KB

Versions: 32

Compression:

Stored size: 1.92 KB

Contents

# Phrase::InvitationCreateParameters

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **String** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. | [optional] 
**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. | [optional] 
**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 <code>create_upload</code> and <code>review_translations</code> | [optional] 

## Code Sample

```ruby
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})
```


Version data entries

32 entries across 32 versions & 1 rubygems

Version Path
phrase-2.8.7 docs/InvitationCreateParameters.md
phrase-2.8.3 docs/InvitationCreateParameters.md
phrase-2.8.2 docs/InvitationCreateParameters.md
phrase-2.8.1 docs/InvitationCreateParameters.md
phrase-2.8.0 docs/InvitationCreateParameters.md
phrase-2.7.2 docs/InvitationCreateParameters.md
phrase-2.7.1 docs/InvitationCreateParameters.md
phrase-2.7.0 docs/InvitationCreateParameters.md
phrase-2.6.0 docs/InvitationCreateParameters.md
phrase-2.5.1 docs/InvitationCreateParameters.md
phrase-2.5.0 docs/InvitationCreateParameters.md
phrase-2.4.0 docs/InvitationCreateParameters.md