com.kaltura.client.services.HouseholdService 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.enums.HouseholdFrequencyType;
import com.kaltura.client.types.Household;
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 HouseholdService {
	
	public static class AddHouseholdBuilder extends RequestBuilder {
		
		public AddHouseholdBuilder(Household household) {
			super(Household.class, "household", "add");
			params.add("household", household);
		}
	}

	/**
	 * Creates a household for the user
	 * 
	 * @param household Household object
	 */
    public static AddHouseholdBuilder add(Household household)  {
		return new AddHouseholdBuilder(household);
	}
	
	public static class DeleteHouseholdBuilder extends RequestBuilder {
		
		public DeleteHouseholdBuilder(int id) {
			super(Boolean.class, "household", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	public static DeleteHouseholdBuilder delete()  {
		return delete(Integer.MIN_VALUE);
	}

	/**
	 * Fully delete a household. Delete all of the household information, including
	  users, devices, entitlements, payment methods and notification date.
	 * 
	 * @param id Household identifier
	 */
    public static DeleteHouseholdBuilder delete(int id)  {
		return new DeleteHouseholdBuilder(id);
	}
	
	public static class GetHouseholdBuilder extends RequestBuilder {
		
		public GetHouseholdBuilder(int id) {
			super(Household.class, "household", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	public static GetHouseholdBuilder get()  {
		return get(Integer.MIN_VALUE);
	}

	/**
	 * Returns the household model
	 * 
	 * @param id Household identifier
	 */
    public static GetHouseholdBuilder get(int id)  {
		return new GetHouseholdBuilder(id);
	}
	
	public static class ResetFrequencyHouseholdBuilder extends RequestBuilder {
		
		public ResetFrequencyHouseholdBuilder(HouseholdFrequencyType frequencyType) {
			super(Household.class, "household", "resetFrequency");
			params.add("frequencyType", frequencyType);
		}
		
		public void frequencyType(String multirequestToken) {
			params.add("frequencyType", multirequestToken);
		}
	}

	/**
	 * Reset a household’s time limitation for removing user or device
	 * 
	 * @param frequencyType Possible values: devices – reset the device change frequency. 
	 *             users – reset the user add/remove frequency
	 */
    public static ResetFrequencyHouseholdBuilder resetFrequency(HouseholdFrequencyType frequencyType)  {
		return new ResetFrequencyHouseholdBuilder(frequencyType);
	}
	
	public static class ResumeHouseholdBuilder extends RequestBuilder {
		
		public ResumeHouseholdBuilder() {
			super(Boolean.class, "household", "resume");
		}
	}

	/**
	 * Resumed a given household service to its previous service settings
	 */
    public static ResumeHouseholdBuilder resume()  {
		return new ResumeHouseholdBuilder();
	}
	
	public static class SuspendHouseholdBuilder extends RequestBuilder {
		
		public SuspendHouseholdBuilder() {
			super(Boolean.class, "household", "suspend");
		}
	}

	/**
	 * Suspend a given household service. Sets the household status to
	  “suspended&quot;.The household service settings are maintained for later
	  resume
	 */
    public static SuspendHouseholdBuilder suspend()  {
		return new SuspendHouseholdBuilder();
	}
	
	public static class UpdateHouseholdBuilder extends RequestBuilder {
		
		public UpdateHouseholdBuilder(Household household) {
			super(Household.class, "household", "update");
			params.add("household", household);
		}
	}

	/**
	 * Update the household name and description
	 * 
	 * @param household Household object
	 */
    public static UpdateHouseholdBuilder update(Household household)  {
		return new UpdateHouseholdBuilder(household);
	}
}