Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,348 changes: 1,290 additions & 58 deletions core/api/core.api

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@
* <p> This exception is raised by {@link
* com.dropbox.core.v2.riviera.DbxAppRivieraRequests#getMarkdownAsyncCheck(String)},
* {@link
* com.dropbox.core.v2.riviera.DbxAppRivieraRequests#getMetadataAsyncCheck(String)},
* {@link
* com.dropbox.core.v2.riviera.DbxAppRivieraRequests#getTranscriptAsyncCheck(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersAddJobStatusGet(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersAddJobStatusGetV2(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersBulkSuspendJobStatusCheck(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersMoveFormerMemberFilesJobStatusCheck(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersRemoveJobStatusGet(String)},
Expand Down Expand Up @@ -50,9 +54,11 @@
public class PollErrorException extends DbxApiException {
// exception for routes:
// 2/riviera/get_markdown_async/check
// 2/riviera/get_metadata_async/check
// 2/riviera/get_transcript_async/check
// 2/team/members/add/job_status/get
// 2/team/members/add/job_status/get_v2
// 2/team/members/bulk_suspend/job_status/check
// 2/team/members/move_former_member_files/job_status/check
// 2/team/members/remove/job_status/get
// 2/team/team_folder/archive/check
Expand All @@ -74,12 +80,16 @@ public class PollErrorException extends DbxApiException {
* The error reported by {@link
* com.dropbox.core.v2.riviera.DbxAppRivieraRequests#getMarkdownAsyncCheck(String)},
* {@link
* com.dropbox.core.v2.riviera.DbxAppRivieraRequests#getMetadataAsyncCheck(String)},
* {@link
* com.dropbox.core.v2.riviera.DbxAppRivieraRequests#getTranscriptAsyncCheck(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersAddJobStatusGet(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersAddJobStatusGetV2(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersBulkSuspendJobStatusCheck(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersMoveFormerMemberFilesJobStatusCheck(String)},
* {@link
* com.dropbox.core.v2.team.DbxTeamTeamRequests#membersRemoveJobStatusGet(String)},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ public DbxAppGetThumbnailV2Builder withMode(ThumbnailMode mode) {
* <p> If left unset or set to {@code null}, defaults to {@code
* ThumbnailQuality.QUALITY_80}. </p>
*
* @param quality Quality of the thumbnail image. Must not be {@code null}.
* Defaults to {@code ThumbnailQuality.QUALITY_80} when set to {@code
* null}.
* @param quality Field is only returned for "internal" callers. Quality of
* the thumbnail image. Must not be {@code null}. Defaults to {@code
* ThumbnailQuality.QUALITY_80} when set to {@code null}.
*
* @return this builder
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ public DbxUserGetThumbnailV2Builder withMode(ThumbnailMode mode) {
* <p> If left unset or set to {@code null}, defaults to {@code
* ThumbnailQuality.QUALITY_80}. </p>
*
* @param quality Quality of the thumbnail image. Must not be {@code null}.
* Defaults to {@code ThumbnailQuality.QUALITY_80} when set to {@code
* null}.
* @param quality Field is only returned for "internal" callers. Quality of
* the thumbnail image. Must not be {@code null}. Defaults to {@code
* ThumbnailQuality.QUALITY_80} when set to {@code null}.
*
* @return this builder
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ public GetThumbnailBuilder withMode(ThumbnailMode mode) {
* <p> If left unset or set to {@code null}, defaults to {@code
* ThumbnailQuality.QUALITY_80}. </p>
*
* @param quality Quality of the thumbnail image. Must not be {@code null}.
* Defaults to {@code ThumbnailQuality.QUALITY_80} when set to {@code
* null}.
* @param quality Field is only returned for "internal" callers. Quality of
* the thumbnail image. Must not be {@code null}. Defaults to {@code
* ThumbnailQuality.QUALITY_80} when set to {@code null}.
*
* @return this builder
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ public class ThumbnailArg {
* @param size The size for the thumbnail image. Must not be {@code null}.
* @param mode How to resize and crop the image to achieve the desired
* size. Must not be {@code null}.
* @param quality Quality of the thumbnail image. Must not be {@code null}.
* @param quality Field is only returned for "internal" callers. Quality of
* the thumbnail image. Must not be {@code null}.
* @param excludeMediaInfo Normally, {@link FileMetadata#getMediaInfo} is
* set for photo and video. When this flag is true, {@link
* FileMetadata#getMediaInfo} is not populated. This improves latency
Expand Down Expand Up @@ -150,7 +151,8 @@ public ThumbnailMode getMode() {
}

/**
* Quality of the thumbnail image.
* Field is only returned for "internal" callers. Quality of the thumbnail
* image.
*
* @return value for this field, or {@code null} if not present. Defaults to
* ThumbnailQuality.QUALITY_80.
Expand Down Expand Up @@ -300,9 +302,10 @@ public Builder withMode(ThumbnailMode mode) {
* <p> If left unset or set to {@code null}, defaults to {@code
* ThumbnailQuality.QUALITY_80}. </p>
*
* @param quality Quality of the thumbnail image. Must not be {@code
* null}. Defaults to {@code ThumbnailQuality.QUALITY_80} when set
* to {@code null}.
* @param quality Field is only returned for "internal" callers.
* Quality of the thumbnail image. Must not be {@code null}.
* Defaults to {@code ThumbnailQuality.QUALITY_80} when set to
* {@code null}.
*
* @return this builder
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public enum ThumbnailSize {
*/
W2048H1536,
/**
* 3200 by 2400 px.
* Field is only returned for "internal" callers. 3200 by 2400 px.
*/
W3200H2400;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ class ThumbnailV2Arg {
* @param size The size for the thumbnail image. Must not be {@code null}.
* @param mode How to resize and crop the image to achieve the desired
* size. Must not be {@code null}.
* @param quality Quality of the thumbnail image. Must not be {@code null}.
* @param quality Field is only returned for "internal" callers. Quality of
* the thumbnail image. Must not be {@code null}.
* @param excludeMediaInfo Normally, {@link FileMetadata#getMediaInfo} is
* set for photo and video. When this flag is true, {@link
* FileMetadata#getMediaInfo} is not populated. This improves latency
Expand Down Expand Up @@ -148,7 +149,8 @@ public ThumbnailMode getMode() {
}

/**
* Quality of the thumbnail image.
* Field is only returned for "internal" callers. Quality of the thumbnail
* image.
*
* @return value for this field, or {@code null} if not present. Defaults to
* ThumbnailQuality.QUALITY_80.
Expand Down Expand Up @@ -295,9 +297,10 @@ public Builder withMode(ThumbnailMode mode) {
* <p> If left unset or set to {@code null}, defaults to {@code
* ThumbnailQuality.QUALITY_80}. </p>
*
* @param quality Quality of the thumbnail image. Must not be {@code
* null}. Defaults to {@code ThumbnailQuality.QUALITY_80} when set
* to {@code null}.
* @param quality Field is only returned for "internal" callers.
* Quality of the thumbnail image. Must not be {@code null}.
* Defaults to {@code ThumbnailQuality.QUALITY_80} when set to
* {@code null}.
*
* @return this builder
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ class AddFileMemberArgs {
* level we want to give new members.
* @param addMessageAsComment If the custom message should be added as a
* comment on the file. Only meant for Paper files.
* @param fpSealedResult The FingerprintJS Sealed Client Result value.
* @param fpSealedResult Field is only returned for "internal" callers. The
* FingerprintJS Sealed Client Result value.
*
* @throws IllegalArgumentException If any argument does not meet its
* preconditions.
Expand Down Expand Up @@ -181,7 +182,8 @@ public boolean getAddMessageAsComment() {
}

/**
* The FingerprintJS Sealed Client Result value
* Field is only returned for "internal" callers. The FingerprintJS Sealed
* Client Result value
*
* @return value for this field, or {@code null} if not present.
*/
Expand Down Expand Up @@ -324,7 +326,8 @@ public Builder withAddMessageAsComment(Boolean addMessageAsComment) {
/**
* Set value for optional field.
*
* @param fpSealedResult The FingerprintJS Sealed Client Result value.
* @param fpSealedResult Field is only returned for "internal" callers.
* The FingerprintJS Sealed Client Result value.
*
* @return this builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ public AddFileMemberBuilder withAddMessageAsComment(Boolean addMessageAsComment)
/**
* Set value for optional field.
*
* @param fpSealedResult The FingerprintJS Sealed Client Result value.
* @param fpSealedResult Field is only returned for "internal" callers. The
* FingerprintJS Sealed Client Result value.
*
* @return this builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ class AddFolderMemberArg {
* device notifications of their invite.
* @param customMessage Optional message to display to added members in
* their invitation. Must have length of at least 1.
* @param fpSealedResult The FingerprintJS Sealed Client Result value.
* @param fpSealedResult Field is only returned for "internal" callers. The
* FingerprintJS Sealed Client Result value.
*
* @throws IllegalArgumentException If any argument does not meet its
* preconditions.
Expand Down Expand Up @@ -140,7 +141,8 @@ public String getCustomMessage() {
}

/**
* The FingerprintJS Sealed Client Result value
* Field is only returned for "internal" callers. The FingerprintJS Sealed
* Client Result value
*
* @return value for this field, or {@code null} if not present.
*/
Expand Down Expand Up @@ -246,7 +248,8 @@ public Builder withCustomMessage(String customMessage) {
/**
* Set value for optional field.
*
* @param fpSealedResult The FingerprintJS Sealed Client Result value.
* @param fpSealedResult Field is only returned for "internal" callers.
* The FingerprintJS Sealed Client Result value.
*
* @return this builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ public AddFolderMemberBuilder withCustomMessage(String customMessage) {
/**
* Set value for optional field.
*
* @param fpSealedResult The FingerprintJS Sealed Client Result value.
* @param fpSealedResult Field is only returned for "internal" callers. The
* FingerprintJS Sealed Client Result value.
*
* @return this builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class SharedLinkSettings {
* `link_access_level` field of `LinkPermissions`. This is used in
* conjunction with team policies and shared folder policies to
* determine the final effective audience type in the
* `effective_audience` field of `LinkPermissions.
* `effective_audience` field of `LinkPermissions`.
* @param access Requested access level you want the audience to gain from
* this link. Note, modifying access level for an existing link is not
* supported.
Expand Down Expand Up @@ -119,7 +119,7 @@ public Date getExpires() {
* link's access level specified in the `link_access_level` field of
* `LinkPermissions`. This is used in conjunction with team policies and
* shared folder policies to determine the final effective audience type in
* the `effective_audience` field of `LinkPermissions.
* the `effective_audience` field of `LinkPermissions`.
*
* @return value for this field, or {@code null} if not present.
*/
Expand Down Expand Up @@ -243,7 +243,7 @@ public Builder withExpires(Date expires) {
* `link_access_level` field of `LinkPermissions`. This is used in
* conjunction with team policies and shared folder policies to
* determine the final effective audience type in the
* `effective_audience` field of `LinkPermissions.
* `effective_audience` field of `LinkPermissions`.
*
* @return this builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import com.dropbox.core.v2.DbxRawClientV2;
import com.dropbox.core.v2.account.PhotoSourceArg;
import com.dropbox.core.v2.async.LaunchEmptyResult;
import com.dropbox.core.v2.async.LaunchResultBase;
import com.dropbox.core.v2.async.PollArg;
import com.dropbox.core.v2.async.PollEmptyResult;
import com.dropbox.core.v2.async.PollError;
Expand Down Expand Up @@ -2219,6 +2220,106 @@ public MembersAddJobStatusV2Result membersAddJobStatusGetV2(String asyncJobId) t
return membersAddJobStatusGetV2(_arg);
}

//
// route 2/team/members/bulk_suspend
//

/**
* Launch a bulk suspend job. The server enforces a maximum of 500 members.
*
* @param arg Launches one action-specific bulk suspend job.
*
* @return Result returned by methods that launch an asynchronous job. A
* method who may either launch an asynchronous job, or complete the
* request synchronously, can use this union by extending it, and adding
* a 'complete' field with the type of the synchronous response. See
* {@link LaunchEmptyResult} for an example.
*/
LaunchResultBase membersBulkSuspend(BulkSuspendArg arg) throws BulkSuspendErrorException, DbxException {
try {
return this.client.rpcStyle(this.client.getHost().getApi(),
"2/team/members/bulk_suspend",
arg,
false,
BulkSuspendArg.Serializer.INSTANCE,
LaunchResultBase.Serializer.INSTANCE,
BulkSuspendError.Serializer.INSTANCE);
}
catch (DbxWrappedException ex) {
throw new BulkSuspendErrorException("2/team/members/bulk_suspend", ex.getRequestId(), ex.getUserMessage(), (BulkSuspendError) ex.getErrorValue());
}
}

/**
* Launch a bulk suspend job. The server enforces a maximum of 500 members.
*
* @param members Must contain between 1 and 500 targets. The launch
* handler also rejects duplicate client item IDs and duplicate member
* selectors. Must not contain a {@code null} item and not be {@code
* null}.
*
* @return Result returned by methods that launch an asynchronous job. A
* method who may either launch an asynchronous job, or complete the
* request synchronously, can use this union by extending it, and adding
* a 'complete' field with the type of the synchronous response. See
* {@link LaunchEmptyResult} for an example.
*
* @throws IllegalArgumentException If any argument does not meet its
* preconditions.
*/
public LaunchResultBase membersBulkSuspend(List<BulkSuspendMemberTarget> members) throws BulkSuspendErrorException, DbxException {
BulkSuspendArg _arg = new BulkSuspendArg(members);
return membersBulkSuspend(_arg);
}

//
// route 2/team/members/bulk_suspend/job_status/check
//

/**
* Poll a previously launched bulk suspend job.
*
* @param arg Arguments for methods that poll the status of an asynchronous
* job.
*
* @return Coarse job state. Live row progress and report contents are
* intentionally omitted; callers receive row details in the terminal
* email report.
*/
BulkSuspendJobStatus membersBulkSuspendJobStatusCheck(PollArg arg) throws PollErrorException, DbxException {
try {
return this.client.rpcStyle(this.client.getHost().getApi(),
"2/team/members/bulk_suspend/job_status/check",
arg,
false,
PollArg.Serializer.INSTANCE,
BulkSuspendJobStatus.Serializer.INSTANCE,
PollError.Serializer.INSTANCE);
}
catch (DbxWrappedException ex) {
throw new PollErrorException("2/team/members/bulk_suspend/job_status/check", ex.getRequestId(), ex.getUserMessage(), (PollError) ex.getErrorValue());
}
}

/**
* Poll a previously launched bulk suspend job.
*
* @param asyncJobId Id of the asynchronous job. This is the value of a
* response returned from the method that launched the job. Must have
* length of at least 1 and not be {@code null}.
*
* @return Coarse job state. Live row progress and report contents are
* intentionally omitted; callers receive row details in the terminal
* email report.
*
* @throws IllegalArgumentException If any argument does not meet its
* preconditions.
*/
public BulkSuspendJobStatus membersBulkSuspendJobStatusCheck(String asyncJobId) throws PollErrorException, DbxException {
PollArg _arg = new PollArg(asyncJobId);
return membersBulkSuspendJobStatusCheck(_arg);
}

//
// route 2/team/members/delete_former_member_files
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

import javax.annotation.Nonnull;

class MembersDeactivateArg extends MembersDeactivateBaseArg {
public class MembersDeactivateArg extends MembersDeactivateBaseArg {
// struct team.MembersDeactivateArg (team.stone)

protected final boolean wipeData;
Expand Down
Loading
Loading