com.ingenico.connect.gateway.sdk.java.merchant.productgroups.GetProductgroupParams Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of connect-sdk-java Show documentation
SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API
There is a newer version: 6.47.0
/*
 * This class was auto-generated from the API references found at
 * https://epayments-api.developer-ingenico.com/s2sapi/v1/
 */
package com.ingenico.connect.gateway.sdk.java.merchant.productgroups;

import java.util.LinkedList;
import java.util.List;

import com.ingenico.connect.gateway.sdk.java.ParamRequest;
import com.ingenico.connect.gateway.sdk.java.RequestParam;

/**
 * Query parameters for
 * Get payment product group
 */
public class GetProductgroupParams implements ParamRequest {

	private String countryCode;

	private String currencyCode;

	private String locale;

	private Long amount;

	private Boolean isRecurring;

	private List hide;

	/**
	 * ISO 3166-1 alpha-2 country code of the transaction
	 */
	public String getCountryCode() {
		return countryCode;
	}

	/**
	 * ISO 3166-1 alpha-2 country code of the transaction
	 */
	public void setCountryCode(String value) {
		this.countryCode = value;
	}

	/**
	 * Three-letter ISO currency code representing the currency for the amount
	 */
	public String getCurrencyCode() {
		return currencyCode;
	}

	/**
	 * Three-letter ISO currency code representing the currency for the amount
	 */
	public void setCurrencyCode(String value) {
		this.currencyCode = value;
	}

	/**
	 * Locale used in the GUI towards the consumer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
	 */
	public String getLocale() {
		return locale;
	}

	/**
	 * Locale used in the GUI towards the consumer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
	 */
	public void setLocale(String value) {
		this.locale = value;
	}

	/**
	 * Amount  of the transaction in cents and always having 2 decimals.
	 */
	public Long getAmount() {
		return amount;
	}

	/**
	 * Amount  of the transaction in cents and always having 2 decimals.
	 */
	public void setAmount(Long value) {
		this.amount = value;
	}

	/**
	 * Toggles filtering on support for recurring payments. Default value is false.
	 * 
	 * true - filter out groups that do not support recurring payments, where a group supports recurring payments if it has at least one payment product that supports recurring.
	 * 
false - do not filter
	 * 
	 */
	public Boolean getIsRecurring() {
		return isRecurring;
	}

	/**
	 * Toggles filtering on support for recurring payments. Default value is false.
	 * 
	 * true - filter out groups that do not support recurring payments, where a group supports recurring payments if it has at least one payment product that supports recurring.
	 * 
false - do not filter
	 * 
	 */
	public void setIsRecurring(Boolean value) {
		this.isRecurring = value;
	}

	/**
	 * Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
	 * 
	 * fields - Don't return any data on fields of the payment product
	 * 
accountsOnFile - Don't return any accounts on file data
	 * 
translations - Don't return any label texts associated with the payment products
	 * 
	 */
	public List getHide() {
		return hide;
	}

	/**
	 * Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
	 * 
	 * fields - Don't return any data on fields of the payment product
	 * 
accountsOnFile - Don't return any accounts on file data
	 * 
translations - Don't return any label texts associated with the payment products
	 * 
	 */
	public void setHide(List value) {
		this.hide = value;
	}

	/**
	 * Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
	 * 
	 * fields - Don't return any data on fields of the payment product
	 * 
accountsOnFile - Don't return any accounts on file data
	 * 
translations - Don't return any label texts associated with the payment products
	 * 
	 */
	public void addHide(String value) {
		if (this.hide == null) {
			this.hide = new LinkedList();
		}
		this.hide.add(value);
	}

	@Override
	public List toRequestParameters() {
		List result = new LinkedList();
		if (countryCode != null) {
			result.add(new RequestParam("countryCode", countryCode));
		}
		if (currencyCode != null) {
			result.add(new RequestParam("currencyCode", currencyCode));
		}
		if (locale != null) {
			result.add(new RequestParam("locale", locale));
		}
		if (amount != null) {
			result.add(new RequestParam("amount", amount.toString()));
		}
		if (isRecurring != null) {
			result.add(new RequestParam("isRecurring", isRecurring.toString()));
		}
		if (hide != null) {
			for (String hideElement : hide) {
				if (hideElement != null) {
					result.add(new RequestParam("hide", hideElement));
				}
			}
		}
		return result;
	}
}