com.kaltura.client.services.HouseholdPaymentGatewayService 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.HouseholdPaymentGateway;
import com.kaltura.client.types.KeyValue;
import com.kaltura.client.types.PaymentGatewayConfiguration;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import java.util.List;

/**
 * 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 HouseholdPaymentGatewayService {
	
	public static class DisableHouseholdPaymentGatewayBuilder extends RequestBuilder {
		
		public DisableHouseholdPaymentGatewayBuilder(int paymentGatewayId) {
			super(Boolean.class, "householdpaymentgateway", "disable");
			params.add("paymentGatewayId", paymentGatewayId);
		}
		
		public void paymentGatewayId(String multirequestToken) {
			params.add("paymentGatewayId", multirequestToken);
		}
	}

	/**
	 * Disable payment-gateway on the household
	 * 
	 * @param paymentGatewayId Payment Gateway Identifier
	 */
    public static DisableHouseholdPaymentGatewayBuilder disable(int paymentGatewayId)  {
		return new DisableHouseholdPaymentGatewayBuilder(paymentGatewayId);
	}
	
	public static class EnableHouseholdPaymentGatewayBuilder extends RequestBuilder {
		
		public EnableHouseholdPaymentGatewayBuilder(int paymentGatewayId) {
			super(Boolean.class, "householdpaymentgateway", "enable");
			params.add("paymentGatewayId", paymentGatewayId);
		}
		
		public void paymentGatewayId(String multirequestToken) {
			params.add("paymentGatewayId", multirequestToken);
		}
	}

	/**
	 * Enable a payment-gateway provider for the household.
	 * 
	 * @param paymentGatewayId Payment Gateway Identifier
	 */
    public static EnableHouseholdPaymentGatewayBuilder enable(int paymentGatewayId)  {
		return new EnableHouseholdPaymentGatewayBuilder(paymentGatewayId);
	}
	
	public static class GetChargeIDHouseholdPaymentGatewayBuilder extends RequestBuilder {
		
		public GetChargeIDHouseholdPaymentGatewayBuilder(String paymentGatewayExternalId) {
			super(String.class, "householdpaymentgateway", "getChargeID");
			params.add("paymentGatewayExternalId", paymentGatewayExternalId);
		}
		
		public void paymentGatewayExternalId(String multirequestToken) {
			params.add("paymentGatewayExternalId", multirequestToken);
		}
	}

	/**
	 * Get a household’s billing account identifier (charge ID) for a given payment
	  gateway
	 * 
	 * @param paymentGatewayExternalId External identifier for the payment gateway
	 */
    public static GetChargeIDHouseholdPaymentGatewayBuilder getChargeID(String paymentGatewayExternalId)  {
		return new GetChargeIDHouseholdPaymentGatewayBuilder(paymentGatewayExternalId);
	}
	
	public static class InvokeHouseholdPaymentGatewayBuilder extends RequestBuilder {
		
		public InvokeHouseholdPaymentGatewayBuilder(int paymentGatewayId, String intent, List extraParameters) {
			super(PaymentGatewayConfiguration.class, "householdpaymentgateway", "invoke");
			params.add("paymentGatewayId", paymentGatewayId);
			params.add("intent", intent);
			params.add("extraParameters", extraParameters);
		}
		
		public void paymentGatewayId(String multirequestToken) {
			params.add("paymentGatewayId", multirequestToken);
		}
		
		public void intent(String multirequestToken) {
			params.add("intent", multirequestToken);
		}
	}

	/**
	 * Gets the Payment Gateway Configuration for the payment gateway identifier given
	 * 
	 * @param paymentGatewayId The payemnt gateway for which to return the registration URL/s for the
	 * household. If omitted – return the regisration URL for the household for the
	 * default payment gateway
	 * @param intent Represent the client’s intent for working with the payment gateway. Intent
	 * options to be coordinated with the applicable payment gateway adapter.
	 * @param extraParameters Additional parameters to send to the payment gateway adapter.
	 */
    public static InvokeHouseholdPaymentGatewayBuilder invoke(int paymentGatewayId, String intent, List extraParameters)  {
		return new InvokeHouseholdPaymentGatewayBuilder(paymentGatewayId, intent, extraParameters);
	}
	
	public static class ListHouseholdPaymentGatewayBuilder extends ListResponseRequestBuilder {
		
		public ListHouseholdPaymentGatewayBuilder() {
			super(HouseholdPaymentGateway.class, "householdpaymentgateway", "list");
		}
	}

	/**
	 * Get a list of all configured Payment Gateways providers available for the
	  account. For each payment is provided with the household associated payment
	  methods.
	 */
    public static ListHouseholdPaymentGatewayBuilder list()  {
		return new ListHouseholdPaymentGatewayBuilder();
	}
	
	public static class SetChargeIDHouseholdPaymentGatewayBuilder extends RequestBuilder {
		
		public SetChargeIDHouseholdPaymentGatewayBuilder(String paymentGatewayExternalId, String chargeId) {
			super(Boolean.class, "householdpaymentgateway", "setChargeID");
			params.add("paymentGatewayExternalId", paymentGatewayExternalId);
			params.add("chargeId", chargeId);
		}
		
		public void paymentGatewayExternalId(String multirequestToken) {
			params.add("paymentGatewayExternalId", multirequestToken);
		}
		
		public void chargeId(String multirequestToken) {
			params.add("chargeId", multirequestToken);
		}
	}

	/**
	 * Set user billing account identifier (charge ID), for a specific household and a
	  specific payment gateway
	 * 
	 * @param paymentGatewayExternalId External identifier for the payment gateway
	 * @param chargeId The billing user account identifier for this household at the given payment
	 * gateway
	 */
    public static SetChargeIDHouseholdPaymentGatewayBuilder setChargeID(String paymentGatewayExternalId, String chargeId)  {
		return new SetChargeIDHouseholdPaymentGatewayBuilder(paymentGatewayExternalId, chargeId);
	}
}