Package com.twitter.clientlib.api

Class ListsApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.ListsApi

public class ListsApi
extends ApiCommon

Field Summary

Fields inherited from class com.twitter.clientlib.api.ApiCommon

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
ListsApi()

Method Summary

Modifier and Type	Method	Description
MultiListResponse	getUserListMemberships(Integer retries, String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Calls the API using a retry mechanism to handle rate limits errors.
MultiListResponse	getUserListMemberships(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get a User's List Memberships Get a User's List Memberships.
okhttp3.Call	getUserListMembershipsAsync(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback<MultiListResponse> _callback)	Get a User's List Memberships (asynchronously) Get a User's List Memberships.
okhttp3.Call	getUserListMembershipsCall(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback _callback)	Build call for getUserListMemberships
ApiResponse<MultiListResponse>	getUserListMembershipsWithHttpInfo(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get a User's List Memberships Get a User's List Memberships.
ListMemberResponse	listAddMember(ListAddMemberRequest listAddMemberRequest, String id)	Add a List member Causes a user to become a member of a List.
ListMemberResponse	listAddMember(Integer retries, ListAddMemberRequest listAddMemberRequest, String id)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	listAddMemberAsync(ListAddMemberRequest listAddMemberRequest, String id, ApiCallback<ListMemberResponse> _callback)	Add a List member (asynchronously) Causes a user to become a member of a List.
okhttp3.Call	listAddMemberCall(ListAddMemberRequest listAddMemberRequest, String id, ApiCallback _callback)	Build call for listAddMember
ApiResponse<ListMemberResponse>	listAddMemberWithHttpInfo(ListAddMemberRequest listAddMemberRequest, String id)	Add a List member Causes a user to become a member of a List.
ListCreateResponse	listIdCreate(ListCreateRequest listCreateRequest)	Create List Creates a new List.
ListCreateResponse	listIdCreate(Integer retries, ListCreateRequest listCreateRequest)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	listIdCreateAsync(ListCreateRequest listCreateRequest, ApiCallback<ListCreateResponse> _callback)	Create List (asynchronously) Creates a new List.
okhttp3.Call	listIdCreateCall(ListCreateRequest listCreateRequest, ApiCallback _callback)	Build call for listIdCreate
ApiResponse<ListCreateResponse>	listIdCreateWithHttpInfo(ListCreateRequest listCreateRequest)	Create List Creates a new List.
ListDeleteResponse	listIdDelete(Integer retries, String id)	Calls the API using a retry mechanism to handle rate limits errors.
ListDeleteResponse	listIdDelete(String id)	Delete List Delete a List that you own.
okhttp3.Call	listIdDeleteAsync(String id, ApiCallback<ListDeleteResponse> _callback)	Delete List (asynchronously) Delete a List that you own.
okhttp3.Call	listIdDeleteCall(String id, ApiCallback _callback)	Build call for listIdDelete
ApiResponse<ListDeleteResponse>	listIdDeleteWithHttpInfo(String id)	Delete List Delete a List that you own.
SingleListLookupResponse	listIdGet(Integer retries, String id, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Calls the API using a retry mechanism to handle rate limits errors.
SingleListLookupResponse	listIdGet(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields)	List lookup by List ID Returns a List
okhttp3.Call	listIdGetAsync(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback<SingleListLookupResponse> _callback)	List lookup by List ID (asynchronously) Returns a List
okhttp3.Call	listIdGetCall(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback _callback)	Build call for listIdGet
ApiResponse<SingleListLookupResponse>	listIdGetWithHttpInfo(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields)	List lookup by List ID Returns a List
ListUpdateResponse	listIdUpdate(ListUpdateRequest listUpdateRequest, String id)	Update List Update a List that you own.
ListUpdateResponse	listIdUpdate(Integer retries, ListUpdateRequest listUpdateRequest, String id)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	listIdUpdateAsync(ListUpdateRequest listUpdateRequest, String id, ApiCallback<ListUpdateResponse> _callback)	Update List (asynchronously) Update a List that you own.
okhttp3.Call	listIdUpdateCall(ListUpdateRequest listUpdateRequest, String id, ApiCallback _callback)	Build call for listIdUpdate
ApiResponse<ListUpdateResponse>	listIdUpdateWithHttpInfo(ListUpdateRequest listUpdateRequest, String id)	Update List Update a List that you own.
ListMemberResponse	listRemoveMember(Integer retries, String id, String userId)	Calls the API using a retry mechanism to handle rate limits errors.
ListMemberResponse	listRemoveMember(String id, String userId)	Remove a List member Causes a user to be removed from the members of a List.
okhttp3.Call	listRemoveMemberAsync(String id, String userId, ApiCallback<ListMemberResponse> _callback)	Remove a List member (asynchronously) Causes a user to be removed from the members of a List.
okhttp3.Call	listRemoveMemberCall(String id, String userId, ApiCallback _callback)	Build call for listRemoveMember
ApiResponse<ListMemberResponse>	listRemoveMemberWithHttpInfo(String id, String userId)	Remove a List member Causes a user to be removed from the members of a List.
ListFollowedResponse	listUserFollow(ListFollowRequest listFollowRequest, String id)	Follow a List Causes a user to follow a List.
ListFollowedResponse	listUserFollow(Integer retries, ListFollowRequest listFollowRequest, String id)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	listUserFollowAsync(ListFollowRequest listFollowRequest, String id, ApiCallback<ListFollowedResponse> _callback)	Follow a List (asynchronously) Causes a user to follow a List.
okhttp3.Call	listUserFollowCall(ListFollowRequest listFollowRequest, String id, ApiCallback _callback)	Build call for listUserFollow
ApiResponse<ListFollowedResponse>	listUserFollowWithHttpInfo(ListFollowRequest listFollowRequest, String id)	Follow a List Causes a user to follow a List.
MultiListResponse	listUserOwnedLists(Integer retries, String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Calls the API using a retry mechanism to handle rate limits errors.
MultiListResponse	listUserOwnedLists(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get a User's Owned Lists Get a User's Owned Lists.
okhttp3.Call	listUserOwnedListsAsync(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback<MultiListResponse> _callback)	Get a User's Owned Lists (asynchronously) Get a User's Owned Lists.
okhttp3.Call	listUserOwnedListsCall(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback _callback)	Build call for listUserOwnedLists
ApiResponse<MultiListResponse>	listUserOwnedListsWithHttpInfo(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get a User's Owned Lists Get a User's Owned Lists.
ListPinnedResponse	listUserPin(ListPinRequest listPinRequest, String id)	Pin a List Causes a user to pin a List.
ListPinnedResponse	listUserPin(Integer retries, ListPinRequest listPinRequest, String id)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	listUserPinAsync(ListPinRequest listPinRequest, String id, ApiCallback<ListPinnedResponse> _callback)	Pin a List (asynchronously) Causes a user to pin a List.
okhttp3.Call	listUserPinCall(ListPinRequest listPinRequest, String id, ApiCallback _callback)	Build call for listUserPin
MultiListNoPaginationResponse	listUserPinnedLists(Integer retries, String id, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Calls the API using a retry mechanism to handle rate limits errors.
MultiListNoPaginationResponse	listUserPinnedLists(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get a User's Pinned Lists Get a User's Pinned Lists.
okhttp3.Call	listUserPinnedListsAsync(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback<MultiListNoPaginationResponse> _callback)	Get a User's Pinned Lists (asynchronously) Get a User's Pinned Lists.
okhttp3.Call	listUserPinnedListsCall(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback _callback)	Build call for listUserPinnedLists
ApiResponse<MultiListNoPaginationResponse>	listUserPinnedListsWithHttpInfo(String id, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get a User's Pinned Lists Get a User's Pinned Lists.
ApiResponse<ListPinnedResponse>	listUserPinWithHttpInfo(ListPinRequest listPinRequest, String id)	Pin a List Causes a user to pin a List.
ListFollowedResponse	listUserUnfollow(Integer retries, String id, String listId)	Calls the API using a retry mechanism to handle rate limits errors.
ListFollowedResponse	listUserUnfollow(String id, String listId)	Unfollow a List Causes a user to unfollow a List.
okhttp3.Call	listUserUnfollowAsync(String id, String listId, ApiCallback<ListFollowedResponse> _callback)	Unfollow a List (asynchronously) Causes a user to unfollow a List.
okhttp3.Call	listUserUnfollowCall(String id, String listId, ApiCallback _callback)	Build call for listUserUnfollow
ApiResponse<ListFollowedResponse>	listUserUnfollowWithHttpInfo(String id, String listId)	Unfollow a List Causes a user to unfollow a List.
ListPinnedResponse	listUserUnpin(Integer retries, String id, String listId)	Calls the API using a retry mechanism to handle rate limits errors.
ListPinnedResponse	listUserUnpin(String id, String listId)	Unpin a List Causes a user to remove a pinned List.
okhttp3.Call	listUserUnpinAsync(String id, String listId, ApiCallback<ListPinnedResponse> _callback)	Unpin a List (asynchronously) Causes a user to remove a pinned List.
okhttp3.Call	listUserUnpinCall(String id, String listId, ApiCallback _callback)	Build call for listUserUnpin
ApiResponse<ListPinnedResponse>	listUserUnpinWithHttpInfo(String id, String listId)	Unpin a List Causes a user to remove a pinned List.
MultiListResponse	userFollowedLists(Integer retries, String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Calls the API using a retry mechanism to handle rate limits errors.
MultiListResponse	userFollowedLists(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get User's Followed Lists Returns a user's followed Lists.
okhttp3.Call	userFollowedListsAsync(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback<MultiListResponse> _callback)	Get User's Followed Lists (asynchronously) Returns a user's followed Lists.
okhttp3.Call	userFollowedListsCall(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields, ApiCallback _callback)	Build call for userFollowedLists
ApiResponse<MultiListResponse>	userFollowedListsWithHttpInfo(String id, Integer maxResults, Long paginationToken, Set<String> listFields, Set<String> expansions, Set<String> userFields)	Get User's Followed Lists Returns a user's followed Lists.

Methods inherited from class com.twitter.clientlib.api.ApiCommon

handleRateLimit, isOAUth2AutoRefreshToken, reduceAuthNames, refreshToken, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListsApi

public ListsApi()

Method Detail

getUserListMembershipsCall

public okhttp3.Call getUserListMembershipsCall(String id,
                                               Integer maxResults,
                                               Long paginationToken,
                                               Set<String> listFields,
                                               Set<String> expansions,
                                               Set<String> userFields,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getUserListMemberships

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getUserListMemberships

public MultiListResponse getUserListMemberships(String id,
                                                Integer maxResults,
                                                Long paginationToken,
                                                Set<String> listFields,
                                                Set<String> expansions,
                                                Set<String> userFields)
                                         throws ApiException

Get a User's List Memberships Get a User's List Memberships.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

MultiListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getUserListMemberships

public MultiListResponse getUserListMemberships(Integer retries,
                                                String id,
                                                Integer maxResults,
                                                Long paginationToken,
                                                Set<String> listFields,
                                                Set<String> expansions,
                                                Set<String> userFields)
                                         throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

getUserListMembershipsWithHttpInfo

public ApiResponse<MultiListResponse> getUserListMembershipsWithHttpInfo(String id,
                                                                         Integer maxResults,
                                                                         Long paginationToken,
                                                                         Set<String> listFields,
                                                                         Set<String> expansions,
                                                                         Set<String> userFields)
                                                                  throws ApiException

Get a User's List Memberships Get a User's List Memberships.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

ApiResponse<MultiListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

getUserListMembershipsAsync

public okhttp3.Call getUserListMembershipsAsync(String id,
                                                Integer maxResults,
                                                Long paginationToken,
                                                Set<String> listFields,
                                                Set<String> expansions,
                                                Set<String> userFields,
                                                ApiCallback<MultiListResponse> _callback)
                                         throws ApiException

Get a User's List Memberships (asynchronously) Get a User's List Memberships.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listAddMemberCall

public okhttp3.Call listAddMemberCall(ListAddMemberRequest listAddMemberRequest,
                                      String id,
                                      ApiCallback _callback)
                               throws ApiException

Build call for listAddMember

Parameters:

listAddMemberRequest - (optional)

id - The ID of the List to add a member (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listAddMember

public ListMemberResponse listAddMember(ListAddMemberRequest listAddMemberRequest,
                                        String id)
                                 throws ApiException

Add a List member Causes a user to become a member of a List.

Parameters:

listAddMemberRequest - (optional)

id - The ID of the List to add a member (required)

Returns:

ListMemberResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listAddMember

public ListMemberResponse listAddMember(Integer retries,
                                        ListAddMemberRequest listAddMemberRequest,
                                        String id)
                                 throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listAddMemberWithHttpInfo

public ApiResponse<ListMemberResponse> listAddMemberWithHttpInfo(ListAddMemberRequest listAddMemberRequest,
                                                                 String id)
                                                          throws ApiException

Add a List member Causes a user to become a member of a List.

Parameters:

listAddMemberRequest - (optional)

id - The ID of the List to add a member (required)

Returns:

ApiResponse<ListMemberResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listAddMemberAsync

public okhttp3.Call listAddMemberAsync(ListAddMemberRequest listAddMemberRequest,
                                       String id,
                                       ApiCallback<ListMemberResponse> _callback)
                                throws ApiException

Add a List member (asynchronously) Causes a user to become a member of a List.

Parameters:

listAddMemberRequest - (optional)

id - The ID of the List to add a member (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdCreateCall

public okhttp3.Call listIdCreateCall(ListCreateRequest listCreateRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listIdCreate

Parameters:

listCreateRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdCreate

public ListCreateResponse listIdCreate(ListCreateRequest listCreateRequest)
                                throws ApiException

Create List Creates a new List.

Parameters:

listCreateRequest - (optional)

Returns:

ListCreateResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdCreate

public ListCreateResponse listIdCreate(Integer retries,
                                       ListCreateRequest listCreateRequest)
                                throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listIdCreateWithHttpInfo

public ApiResponse<ListCreateResponse> listIdCreateWithHttpInfo(ListCreateRequest listCreateRequest)
                                                         throws ApiException

Create List Creates a new List.

Parameters:

listCreateRequest - (optional)

Returns:

ApiResponse<ListCreateResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdCreateAsync

public okhttp3.Call listIdCreateAsync(ListCreateRequest listCreateRequest,
                                      ApiCallback<ListCreateResponse> _callback)
                               throws ApiException

Create List (asynchronously) Creates a new List.

Parameters:

listCreateRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdDeleteCall

public okhttp3.Call listIdDeleteCall(String id,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listIdDelete

Parameters:

id - The ID of the List to delete (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdDelete

public ListDeleteResponse listIdDelete(String id)
                                throws ApiException

Delete List Delete a List that you own.

Parameters:

id - The ID of the List to delete (required)

Returns:

ListDeleteResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdDelete

public ListDeleteResponse listIdDelete(Integer retries,
                                       String id)
                                throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listIdDeleteWithHttpInfo

public ApiResponse<ListDeleteResponse> listIdDeleteWithHttpInfo(String id)
                                                         throws ApiException

Delete List Delete a List that you own.

Parameters:

id - The ID of the List to delete (required)

Returns:

ApiResponse<ListDeleteResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdDeleteAsync

public okhttp3.Call listIdDeleteAsync(String id,
                                      ApiCallback<ListDeleteResponse> _callback)
                               throws ApiException

Delete List (asynchronously) Delete a List that you own.

Parameters:

id - The ID of the List to delete (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdGetCall

public okhttp3.Call listIdGetCall(String id,
                                  Set<String> listFields,
                                  Set<String> expansions,
                                  Set<String> userFields,
                                  ApiCallback _callback)
                           throws ApiException

Build call for listIdGet

Parameters:

id - The ID of the List to get (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdGet

public SingleListLookupResponse listIdGet(String id,
                                          Set<String> listFields,
                                          Set<String> expansions,
                                          Set<String> userFields)
                                   throws ApiException

List lookup by List ID Returns a List

Parameters:

id - The ID of the List to get (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

SingleListLookupResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdGet

public SingleListLookupResponse listIdGet(Integer retries,
                                          String id,
                                          Set<String> listFields,
                                          Set<String> expansions,
                                          Set<String> userFields)
                                   throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listIdGetWithHttpInfo

public ApiResponse<SingleListLookupResponse> listIdGetWithHttpInfo(String id,
                                                                   Set<String> listFields,
                                                                   Set<String> expansions,
                                                                   Set<String> userFields)
                                                            throws ApiException

List lookup by List ID Returns a List

Parameters:

id - The ID of the List to get (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

ApiResponse<SingleListLookupResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdGetAsync

public okhttp3.Call listIdGetAsync(String id,
                                   Set<String> listFields,
                                   Set<String> expansions,
                                   Set<String> userFields,
                                   ApiCallback<SingleListLookupResponse> _callback)
                            throws ApiException

List lookup by List ID (asynchronously) Returns a List

Parameters:

id - The ID of the List to get (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdUpdateCall

public okhttp3.Call listIdUpdateCall(ListUpdateRequest listUpdateRequest,
                                     String id,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listIdUpdate

Parameters:

listUpdateRequest - (optional)

id - The ID of the List to modify (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdUpdate

public ListUpdateResponse listIdUpdate(ListUpdateRequest listUpdateRequest,
                                       String id)
                                throws ApiException

Update List Update a List that you own.

Parameters:

listUpdateRequest - (optional)

id - The ID of the List to modify (required)

Returns:

ListUpdateResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdUpdate

public ListUpdateResponse listIdUpdate(Integer retries,
                                       ListUpdateRequest listUpdateRequest,
                                       String id)
                                throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listIdUpdateWithHttpInfo

public ApiResponse<ListUpdateResponse> listIdUpdateWithHttpInfo(ListUpdateRequest listUpdateRequest,
                                                                String id)
                                                         throws ApiException

Update List Update a List that you own.

Parameters:

listUpdateRequest - (optional)

id - The ID of the List to modify (required)

Returns:

ApiResponse<ListUpdateResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listIdUpdateAsync

public okhttp3.Call listIdUpdateAsync(ListUpdateRequest listUpdateRequest,
                                      String id,
                                      ApiCallback<ListUpdateResponse> _callback)
                               throws ApiException

Update List (asynchronously) Update a List that you own.

Parameters:

listUpdateRequest - (optional)

id - The ID of the List to modify (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listRemoveMemberCall

public okhttp3.Call listRemoveMemberCall(String id,
                                         String userId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for listRemoveMember

Parameters:

id - The ID of the List to remove a member (required)

userId - The ID of user that will be removed from the List (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listRemoveMember

public ListMemberResponse listRemoveMember(String id,
                                           String userId)
                                    throws ApiException

Remove a List member Causes a user to be removed from the members of a List.

Parameters:

id - The ID of the List to remove a member (required)

userId - The ID of user that will be removed from the List (required)

Returns:

ListMemberResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listRemoveMember

public ListMemberResponse listRemoveMember(Integer retries,
                                           String id,
                                           String userId)
                                    throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listRemoveMemberWithHttpInfo

public ApiResponse<ListMemberResponse> listRemoveMemberWithHttpInfo(String id,
                                                                    String userId)
                                                             throws ApiException

Remove a List member Causes a user to be removed from the members of a List.

Parameters:

id - The ID of the List to remove a member (required)

userId - The ID of user that will be removed from the List (required)

Returns:

ApiResponse<ListMemberResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listRemoveMemberAsync

public okhttp3.Call listRemoveMemberAsync(String id,
                                          String userId,
                                          ApiCallback<ListMemberResponse> _callback)
                                   throws ApiException

Remove a List member (asynchronously) Causes a user to be removed from the members of a List.

Parameters:

id - The ID of the List to remove a member (required)

userId - The ID of user that will be removed from the List (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserFollowCall

public okhttp3.Call listUserFollowCall(ListFollowRequest listFollowRequest,
                                       String id,
                                       ApiCallback _callback)
                                throws ApiException

Build call for listUserFollow

Parameters:

listFollowRequest - (optional)

id - The ID of the authenticated source user that will follow the List (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserFollow

public ListFollowedResponse listUserFollow(ListFollowRequest listFollowRequest,
                                           String id)
                                    throws ApiException

Follow a List Causes a user to follow a List.

Parameters:

listFollowRequest - (optional)

id - The ID of the authenticated source user that will follow the List (required)

Returns:

ListFollowedResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserFollow

public ListFollowedResponse listUserFollow(Integer retries,
                                           ListFollowRequest listFollowRequest,
                                           String id)
                                    throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listUserFollowWithHttpInfo

public ApiResponse<ListFollowedResponse> listUserFollowWithHttpInfo(ListFollowRequest listFollowRequest,
                                                                    String id)
                                                             throws ApiException

Follow a List Causes a user to follow a List.

Parameters:

listFollowRequest - (optional)

id - The ID of the authenticated source user that will follow the List (required)

Returns:

ApiResponse<ListFollowedResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserFollowAsync

public okhttp3.Call listUserFollowAsync(ListFollowRequest listFollowRequest,
                                        String id,
                                        ApiCallback<ListFollowedResponse> _callback)
                                 throws ApiException

Follow a List (asynchronously) Causes a user to follow a List.

Parameters:

listFollowRequest - (optional)

id - The ID of the authenticated source user that will follow the List (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserOwnedListsCall

public okhttp3.Call listUserOwnedListsCall(String id,
                                           Integer maxResults,
                                           Long paginationToken,
                                           Set<String> listFields,
                                           Set<String> expansions,
                                           Set<String> userFields,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for listUserOwnedLists

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserOwnedLists

public MultiListResponse listUserOwnedLists(String id,
                                            Integer maxResults,
                                            Long paginationToken,
                                            Set<String> listFields,
                                            Set<String> expansions,
                                            Set<String> userFields)
                                     throws ApiException

Get a User's Owned Lists Get a User's Owned Lists.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

MultiListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserOwnedLists

public MultiListResponse listUserOwnedLists(Integer retries,
                                            String id,
                                            Integer maxResults,
                                            Long paginationToken,
                                            Set<String> listFields,
                                            Set<String> expansions,
                                            Set<String> userFields)
                                     throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listUserOwnedListsWithHttpInfo

public ApiResponse<MultiListResponse> listUserOwnedListsWithHttpInfo(String id,
                                                                     Integer maxResults,
                                                                     Long paginationToken,
                                                                     Set<String> listFields,
                                                                     Set<String> expansions,
                                                                     Set<String> userFields)
                                                              throws ApiException

Get a User's Owned Lists Get a User's Owned Lists.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

ApiResponse<MultiListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserOwnedListsAsync

public okhttp3.Call listUserOwnedListsAsync(String id,
                                            Integer maxResults,
                                            Long paginationToken,
                                            Set<String> listFields,
                                            Set<String> expansions,
                                            Set<String> userFields,
                                            ApiCallback<MultiListResponse> _callback)
                                     throws ApiException

Get a User's Owned Lists (asynchronously) Get a User's Owned Lists.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPinCall

public okhttp3.Call listUserPinCall(ListPinRequest listPinRequest,
                                    String id,
                                    ApiCallback _callback)
                             throws ApiException

Build call for listUserPin

Parameters:

listPinRequest - (optional)

id - The ID of the authenticated source user that will pin the List (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPin

public ListPinnedResponse listUserPin(ListPinRequest listPinRequest,
                                      String id)
                               throws ApiException

Pin a List Causes a user to pin a List.

Parameters:

listPinRequest - (optional)

id - The ID of the authenticated source user that will pin the List (required)

Returns:

ListPinnedResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPin

public ListPinnedResponse listUserPin(Integer retries,
                                      ListPinRequest listPinRequest,
                                      String id)
                               throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listUserPinWithHttpInfo

public ApiResponse<ListPinnedResponse> listUserPinWithHttpInfo(ListPinRequest listPinRequest,
                                                               String id)
                                                        throws ApiException

Pin a List Causes a user to pin a List.

Parameters:

listPinRequest - (optional)

id - The ID of the authenticated source user that will pin the List (required)

Returns:

ApiResponse<ListPinnedResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPinAsync

public okhttp3.Call listUserPinAsync(ListPinRequest listPinRequest,
                                     String id,
                                     ApiCallback<ListPinnedResponse> _callback)
                              throws ApiException

Pin a List (asynchronously) Causes a user to pin a List.

Parameters:

listPinRequest - (optional)

id - The ID of the authenticated source user that will pin the List (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPinnedListsCall

public okhttp3.Call listUserPinnedListsCall(String id,
                                            Set<String> listFields,
                                            Set<String> expansions,
                                            Set<String> userFields,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for listUserPinnedLists

Parameters:

id - The ID of the user for whom to return results (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPinnedLists

public MultiListNoPaginationResponse listUserPinnedLists(String id,
                                                         Set<String> listFields,
                                                         Set<String> expansions,
                                                         Set<String> userFields)
                                                  throws ApiException

Get a User's Pinned Lists Get a User's Pinned Lists.

Parameters:

id - The ID of the user for whom to return results (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

MultiListNoPaginationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPinnedLists

public MultiListNoPaginationResponse listUserPinnedLists(Integer retries,
                                                         String id,
                                                         Set<String> listFields,
                                                         Set<String> expansions,
                                                         Set<String> userFields)
                                                  throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listUserPinnedListsWithHttpInfo

public ApiResponse<MultiListNoPaginationResponse> listUserPinnedListsWithHttpInfo(String id,
                                                                                  Set<String> listFields,
                                                                                  Set<String> expansions,
                                                                                  Set<String> userFields)
                                                                           throws ApiException

Get a User's Pinned Lists Get a User's Pinned Lists.

Parameters:

id - The ID of the user for whom to return results (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

ApiResponse<MultiListNoPaginationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserPinnedListsAsync

public okhttp3.Call listUserPinnedListsAsync(String id,
                                             Set<String> listFields,
                                             Set<String> expansions,
                                             Set<String> userFields,
                                             ApiCallback<MultiListNoPaginationResponse> _callback)
                                      throws ApiException

Get a User's Pinned Lists (asynchronously) Get a User's Pinned Lists.

Parameters:

id - The ID of the user for whom to return results (required)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnfollowCall

public okhttp3.Call listUserUnfollowCall(String id,
                                         String listId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for listUserUnfollow

Parameters:

id - The ID of the authenticated source user that will unfollow the List (required)

listId - The ID of the List to unfollow (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnfollow

public ListFollowedResponse listUserUnfollow(String id,
                                             String listId)
                                      throws ApiException

Unfollow a List Causes a user to unfollow a List.

Parameters:

id - The ID of the authenticated source user that will unfollow the List (required)

listId - The ID of the List to unfollow (required)

Returns:

ListFollowedResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnfollow

public ListFollowedResponse listUserUnfollow(Integer retries,
                                             String id,
                                             String listId)
                                      throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listUserUnfollowWithHttpInfo

public ApiResponse<ListFollowedResponse> listUserUnfollowWithHttpInfo(String id,
                                                                      String listId)
                                                               throws ApiException

Unfollow a List Causes a user to unfollow a List.

Parameters:

id - The ID of the authenticated source user that will unfollow the List (required)

listId - The ID of the List to unfollow (required)

Returns:

ApiResponse<ListFollowedResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnfollowAsync

public okhttp3.Call listUserUnfollowAsync(String id,
                                          String listId,
                                          ApiCallback<ListFollowedResponse> _callback)
                                   throws ApiException

Unfollow a List (asynchronously) Causes a user to unfollow a List.

Parameters:

id - The ID of the authenticated source user that will unfollow the List (required)

listId - The ID of the List to unfollow (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnpinCall

public okhttp3.Call listUserUnpinCall(String id,
                                      String listId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for listUserUnpin

Parameters:

id - The ID of the authenticated source user that will remove the pinned List (required)

listId - The ID of the List to unpin (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnpin

public ListPinnedResponse listUserUnpin(String id,
                                        String listId)
                                 throws ApiException

Unpin a List Causes a user to remove a pinned List.

Parameters:

id - The ID of the authenticated source user that will remove the pinned List (required)

listId - The ID of the List to unpin (required)

Returns:

ListPinnedResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnpin

public ListPinnedResponse listUserUnpin(Integer retries,
                                        String id,
                                        String listId)
                                 throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

listUserUnpinWithHttpInfo

public ApiResponse<ListPinnedResponse> listUserUnpinWithHttpInfo(String id,
                                                                 String listId)
                                                          throws ApiException

Unpin a List Causes a user to remove a pinned List.

Parameters:

id - The ID of the authenticated source user that will remove the pinned List (required)

listId - The ID of the List to unpin (required)

Returns:

ApiResponse<ListPinnedResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

listUserUnpinAsync

public okhttp3.Call listUserUnpinAsync(String id,
                                       String listId,
                                       ApiCallback<ListPinnedResponse> _callback)
                                throws ApiException

Unpin a List (asynchronously) Causes a user to remove a pinned List.

Parameters:

id - The ID of the authenticated source user that will remove the pinned List (required)

listId - The ID of the List to unpin (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

userFollowedListsCall

public okhttp3.Call userFollowedListsCall(String id,
                                          Integer maxResults,
                                          Long paginationToken,
                                          Set<String> listFields,
                                          Set<String> expansions,
                                          Set<String> userFields,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for userFollowedLists

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

userFollowedLists

public MultiListResponse userFollowedLists(String id,
                                           Integer maxResults,
                                           Long paginationToken,
                                           Set<String> listFields,
                                           Set<String> expansions,
                                           Set<String> userFields)
                                    throws ApiException

Get User's Followed Lists Returns a user's followed Lists.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

MultiListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

userFollowedLists

public MultiListResponse userFollowedLists(Integer retries,
                                           String id,
                                           Integer maxResults,
                                           Long paginationToken,
                                           Set<String> listFields,
                                           Set<String> expansions,
                                           Set<String> userFields)
                                    throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

userFollowedListsWithHttpInfo

public ApiResponse<MultiListResponse> userFollowedListsWithHttpInfo(String id,
                                                                    Integer maxResults,
                                                                    Long paginationToken,
                                                                    Set<String> listFields,
                                                                    Set<String> expansions,
                                                                    Set<String> userFields)
                                                             throws ApiException

Get User's Followed Lists Returns a user's followed Lists.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

Returns:

ApiResponse<MultiListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-

userFollowedListsAsync

public okhttp3.Call userFollowedListsAsync(String id,
                                           Integer maxResults,
                                           Long paginationToken,
                                           Set<String> listFields,
                                           Set<String> expansions,
                                           Set<String> userFields,
                                           ApiCallback<MultiListResponse> _callback)
                                    throws ApiException

Get User's Followed Lists (asynchronously) Returns a user's followed Lists.

Parameters:

id - The ID of the user for whom to return results (required)

maxResults - The maximum number of results (optional, default to 100)

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

listFields - A comma separated list of List fields to display. (optional)

expansions - A comma separated list of fields to expand. (optional)

userFields - A comma separated list of User fields to display. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request was successful	-
0	The request has failed.	-