com.kaltura.client.services.HouseholdPaymentMethodService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of KalturaOttApiClient Show documentation

KalturaOttApiClient is a library of Java classes that can be used to interact with the Kaltura OTT REST API. More information about the REST API can be found at https://ott.developer.kaltura.com/ Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interact with the API.

There is a newer version: 5.1.2.17630

Show newest version

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.HouseholdPaymentMethod;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using clients-generator\exec.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

public class HouseholdPaymentMethodService {
	
	public static class AddHouseholdPaymentMethodBuilder extends RequestBuilder {
		
		public AddHouseholdPaymentMethodBuilder(HouseholdPaymentMethod householdPaymentMethod) {
			super(HouseholdPaymentMethod.class, "householdpaymentmethod", "add");
			params.add("householdPaymentMethod", householdPaymentMethod);
		}
	}

	/**
	 * Add a new payment method for household
	 * 
	 * @param householdPaymentMethod Household payment method
	 */
    public static AddHouseholdPaymentMethodBuilder add(HouseholdPaymentMethod householdPaymentMethod)  {
		return new AddHouseholdPaymentMethodBuilder(householdPaymentMethod);
	}
	
	public static class ForceRemoveHouseholdPaymentMethodBuilder extends RequestBuilder {
		
		public ForceRemoveHouseholdPaymentMethodBuilder(int paymentGatewayId, int paymentMethodId) {
			super(Boolean.class, "householdpaymentmethod", "forceRemove");
			params.add("paymentGatewayId", paymentGatewayId);
			params.add("paymentMethodId", paymentMethodId);
		}
		
		public void paymentGatewayId(String multirequestToken) {
			params.add("paymentGatewayId", multirequestToken);
		}
		
		public void paymentMethodId(String multirequestToken) {
			params.add("paymentMethodId", multirequestToken);
		}
	}

	/**
	 * Force remove of a payment method of the household.
	 * 
	 * @param paymentGatewayId Payment Gateway Identifier
	 * @param paymentMethodId Payment method Identifier
	 */
    public static ForceRemoveHouseholdPaymentMethodBuilder forceRemove(int paymentGatewayId, int paymentMethodId)  {
		return new ForceRemoveHouseholdPaymentMethodBuilder(paymentGatewayId, paymentMethodId);
	}
	
	public static class ListHouseholdPaymentMethodBuilder extends ListResponseRequestBuilder {
		
		public ListHouseholdPaymentMethodBuilder() {
			super(HouseholdPaymentMethod.class, "householdpaymentmethod", "list");
		}
	}

	/**
	 * Get a list of all payment methods of the household.
	 */
    public static ListHouseholdPaymentMethodBuilder list()  {
		return new ListHouseholdPaymentMethodBuilder();
	}
	
	public static class RemoveHouseholdPaymentMethodBuilder extends RequestBuilder {
		
		public RemoveHouseholdPaymentMethodBuilder(int paymentGatewayId, int paymentMethodId) {
			super(Boolean.class, "householdpaymentmethod", "remove");
			params.add("paymentGatewayId", paymentGatewayId);
			params.add("paymentMethodId", paymentMethodId);
		}
		
		public void paymentGatewayId(String multirequestToken) {
			params.add("paymentGatewayId", multirequestToken);
		}
		
		public void paymentMethodId(String multirequestToken) {
			params.add("paymentMethodId", multirequestToken);
		}
	}

	/**
	 * Removes a payment method of the household.
	 * 
	 * @param paymentGatewayId Payment Gateway Identifier
	 * @param paymentMethodId Payment method Identifier
	 */
    public static RemoveHouseholdPaymentMethodBuilder remove(int paymentGatewayId, int paymentMethodId)  {
		return new RemoveHouseholdPaymentMethodBuilder(paymentGatewayId, paymentMethodId);
	}
	
	public static class SetAsDefaultHouseholdPaymentMethodBuilder extends RequestBuilder {
		
		public SetAsDefaultHouseholdPaymentMethodBuilder(int paymentGatewayId, int paymentMethodId) {
			super(Boolean.class, "householdpaymentmethod", "setAsDefault");
			params.add("paymentGatewayId", paymentGatewayId);
			params.add("paymentMethodId", paymentMethodId);
		}
		
		public void paymentGatewayId(String multirequestToken) {
			params.add("paymentGatewayId", multirequestToken);
		}
		
		public void paymentMethodId(String multirequestToken) {
			params.add("paymentMethodId", multirequestToken);
		}
	}

	/**
	 * Set a payment method as default for the household.
	 * 
	 * @param paymentGatewayId Payment Gateway Identifier
	 * @param paymentMethodId Payment method Identifier
	 */
    public static SetAsDefaultHouseholdPaymentMethodBuilder setAsDefault(int paymentGatewayId, int paymentMethodId)  {
		return new SetAsDefaultHouseholdPaymentMethodBuilder(paymentGatewayId, paymentMethodId);
	}
}