com.yodlee.api.model.consent.request.UpdateConsentRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model-beta Show documentation

Yodlee API Model Beta is the stage version

There is a newer version: 1.0.29.beta1

Show newest version

/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model.consent.request;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.AbstractModelComponent;
import com.yodlee.api.model.Request;
import com.yodlee.api.model.consent.enums.DataCluster;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"scopeId"})
public class UpdateConsentRequest extends AbstractModelComponent implements Request {

	@ApiModelProperty(value = "Applicable Open Banking data cluster values."//
			+ "

"//
			+ "Endpoints:"//
			+ ""//
			+ "PUT Consent"//
			+ "")
	@JsonProperty(value = "scopeId", required = true)
	private List scopeIds;

	/**
	 * Applicable Open Banking data cluster values. 

	 * 

	 * Endpoints:
	 * 
	 * PUT Consent
	 * 
	 * 
	 * @return scopeIds
	 */
	@JsonProperty("scopeId")
	public List getScopeIds() {
		return scopeIds == null ? null : Collections.unmodifiableList(scopeIds);
	}

	@JsonProperty("scopeId")
	public void setScopeIds(List scopeId) {
		if (scopeIds == null) {
			scopeIds = new ArrayList<>();
		}
		this.scopeIds = scopeId;
	}

	public boolean addScopeId(DataCluster scopeId) {
		if (scopeIds == null) {
			scopeIds = new ArrayList<>();
		}
		return this.scopeIds.add(scopeId);
	}

	public boolean removeScopeId(DataCluster scopeId) {
		if (scopeIds != null) {
			return this.scopeIds.remove(scopeId);
		}
		return false;
	}

	public void clearScopeIds() {
		if (scopeIds != null) {
			scopeIds.clear();
		}
	}

	@Override
	public String toString() {
		return "UpdatedConsentRequest [scopeId = " + scopeIds + "]";
	}
}