org.everit.atlassian.restclient.jiracloud.v3.api

Class UnrestrictedUserEmailApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.UnrestrictedUserEmailApi

public class UnrestrictedUserEmailApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UnrestrictedUserEmailApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<UnrestrictedUserEmail>	getUserEmail(Optional<String> accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user email Returns a user's email address.
io.reactivex.Single<UnrestrictedUserEmail>	getUserEmailBulk(Optional<List<String>> accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user email bulk Returns a user's email address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnrestrictedUserEmailApi

public UnrestrictedUserEmailApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getUserEmail

public io.reactivex.Single<UnrestrictedUserEmail> getUserEmail(Optional<String> accountId,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user email

Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

Parameters:

accountId -

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value). Required.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<UnrestrictedUserEmail>

getUserEmailBulk

public io.reactivex.Single<UnrestrictedUserEmail> getUserEmailBulk(Optional<List<String>> accountId,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user email bulk

Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

Parameters:

accountId -

the account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value).

(optional, default to new ArrayList<>())

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<UnrestrictedUserEmail>