twitter4j.api.TwitterAdsFundingInstrumentApi Maven / Gradle / Ivy
package twitter4j.api;
import com.google.common.base.Optional;
import twitter4j.BaseAdsListResponseIterable;
import twitter4j.BaseAdsResponse;
import twitter4j.TwitterException;
import twitter4j.models.ads.FundingInstrument;
import twitter4j.models.ads.sort.FundingInstrumentSortByField;
import java.util.Collection;
/**
* User: abhay
* Date: 4/5/16
* Time: 10:36 AM
*/
public interface TwitterAdsFundingInstrumentApi {
/**
* @param accountId The identifier for the leveraged account.
* @param withDeleted Include deleted results in your request. Defaults to false.
* @param fundingInstrumentIds (optional) Scope the response to just the desired funding instruments by specifying a Collection of identifiers. Up to 50 ids may be provided.
* @param sortByField (optional) Sorts by supported attribute in ascending or descending order.
* @return Retrieve some or all funding instruments associated with the account.
* @throws TwitterException
* @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/funding_instruments
*/
BaseAdsListResponseIterable getAllFundingInstruments(String accountId,boolean withDeleted, Optional> fundingInstrumentIds,
Optional sortByField) throws TwitterException;
/**
* @param accountId The identifier for the leveraged account.
* @param fundingInstrumentId The identifier for a funding instrument associated with the current account.
* @param withDeleted Include deleted results in your request. Defaults to false.
* @return Retrieve a specific funding instrument associated with the account.
* @throws TwitterException
* @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/funding_instruments/%3Aid
*/
BaseAdsResponse getFundingInstrumentById(String accountId, String fundingInstrumentId, boolean withDeleted)
throws TwitterException;
}