Package com.twitter.clientlib.api

Class SpacesApi

    • Constructor Detail

      • SpacesApi

        public SpacesApi()

    • Method Detail

      • findSpaceByIdCall

        public okhttp3.Call findSpaceByIdCall​(String id,
                                      Set<String> spaceFields,
                                      Set<String> expansions,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for findSpaceById
        Parameters:
        id - The space id to be retrieved (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • findSpaceById

        public SingleSpaceLookupResponse findSpaceById​(String id,
                                               Set<String> spaceFields,
                                               Set<String> expansions)
                                        throws ApiException
        Space lookup by Space ID Returns a variety of information about the Space specified by the requested ID
        Parameters:
        id - The space id to be retrieved (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        SingleSpaceLookupResponse
        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. -

      • findSpaceByIdWithHttpInfo

        public ApiResponse<SingleSpaceLookupResponse> findSpaceByIdWithHttpInfo​(String id,
                                                                        Set<String> spaceFields,
                                                                        Set<String> expansions)
                                                                 throws ApiException
        Space lookup by Space ID Returns a variety of information about the Space specified by the requested ID
        Parameters:
        id - The space id to be retrieved (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        ApiResponse<SingleSpaceLookupResponse>
        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. -

      • findSpaceByIdAsync

        public okhttp3.Call findSpaceByIdAsync​(String id,
                                       Set<String> spaceFields,
                                       Set<String> expansions,
                                       ApiCallback<SingleSpaceLookupResponse> _callback)
                                throws ApiException
        Space lookup by Space ID (asynchronously) Returns a variety of information about the Space specified by the requested ID
        Parameters:
        id - The space id to be retrieved (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • findSpacesByCreatorIdsCall

        public okhttp3.Call findSpacesByCreatorIdsCall​(List<String> userIds,
                                               Set<String> spaceFields,
                                               Set<String> expansions,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for findSpacesByCreatorIds
        Parameters:
        userIds - The users to search through (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • findSpacesByCreatorIds

        public MultiSpaceLookupResponse findSpacesByCreatorIds​(List<String> userIds,
                                                       Set<String> spaceFields,
                                                       Set<String> expansions)
                                                throws ApiException
        Space lookup by their creators Returns a variety of information about the Spaces created by the provided User IDs
        Parameters:
        userIds - The users to search through (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        MultiSpaceLookupResponse
        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. -

      • findSpacesByCreatorIdsWithHttpInfo

        public ApiResponse<MultiSpaceLookupResponse> findSpacesByCreatorIdsWithHttpInfo​(List<String> userIds,
                                                                                Set<String> spaceFields,
                                                                                Set<String> expansions)
                                                                         throws ApiException
        Space lookup by their creators Returns a variety of information about the Spaces created by the provided User IDs
        Parameters:
        userIds - The users to search through (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        ApiResponse<MultiSpaceLookupResponse>
        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. -

      • findSpacesByCreatorIdsAsync

        public okhttp3.Call findSpacesByCreatorIdsAsync​(List<String> userIds,
                                                Set<String> spaceFields,
                                                Set<String> expansions,
                                                ApiCallback<MultiSpaceLookupResponse> _callback)
                                         throws ApiException
        Space lookup by their creators (asynchronously) Returns a variety of information about the Spaces created by the provided User IDs
        Parameters:
        userIds - The users to search through (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • findSpacesByIdsCall

        public okhttp3.Call findSpacesByIdsCall​(List<String> ids,
                                        Set<String> spaceFields,
                                        Set<String> expansions,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for findSpacesByIds
        Parameters:
        ids - A list of space ids (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • findSpacesByIds

        public MultiSpaceLookupResponse findSpacesByIds​(List<String> ids,
                                                Set<String> spaceFields,
                                                Set<String> expansions)
                                         throws ApiException
        Space lookup up Space IDs Returns a variety of information about the Spaces specified by the requested IDs
        Parameters:
        ids - A list of space ids (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        MultiSpaceLookupResponse
        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. -

      • findSpacesByIdsWithHttpInfo

        public ApiResponse<MultiSpaceLookupResponse> findSpacesByIdsWithHttpInfo​(List<String> ids,
                                                                         Set<String> spaceFields,
                                                                         Set<String> expansions)
                                                                  throws ApiException
        Space lookup up Space IDs Returns a variety of information about the Spaces specified by the requested IDs
        Parameters:
        ids - A list of space ids (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        ApiResponse<MultiSpaceLookupResponse>
        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. -

      • findSpacesByIdsAsync

        public okhttp3.Call findSpacesByIdsAsync​(List<String> ids,
                                         Set<String> spaceFields,
                                         Set<String> expansions,
                                         ApiCallback<MultiSpaceLookupResponse> _callback)
                                  throws ApiException
        Space lookup up Space IDs (asynchronously) Returns a variety of information about the Spaces specified by the requested IDs
        Parameters:
        ids - A list of space ids (required)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • searchSpacesCall

        public okhttp3.Call searchSpacesCall​(String query,
                                     String state,
                                     Integer maxResults,
                                     Set<String> spaceFields,
                                     Set<String> expansions,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for searchSpaces
        Parameters:
        query - The search query (required)
        state - The state of spaces to search for (optional, default to all)
        maxResults - The number of results to return. The maximum for this value is 100. (optional)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • searchSpaces

        public MultiSpaceLookupResponse searchSpaces​(String query,
                                             String state,
                                             Integer maxResults,
                                             Set<String> spaceFields,
                                             Set<String> expansions)
                                      throws ApiException
        Search for Spaces Returns Spaces that match the provided query.
        Parameters:
        query - The search query (required)
        state - The state of spaces to search for (optional, default to all)
        maxResults - The number of results to return. The maximum for this value is 100. (optional)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        MultiSpaceLookupResponse
        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. -

      • searchSpacesWithHttpInfo

        public ApiResponse<MultiSpaceLookupResponse> searchSpacesWithHttpInfo​(String query,
                                                                      String state,
                                                                      Integer maxResults,
                                                                      Set<String> spaceFields,
                                                                      Set<String> expansions)
                                                               throws ApiException
        Search for Spaces Returns Spaces that match the provided query.
        Parameters:
        query - The search query (required)
        state - The state of spaces to search for (optional, default to all)
        maxResults - The number of results to return. The maximum for this value is 100. (optional)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (optional)
        Returns:
        ApiResponse<MultiSpaceLookupResponse>
        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. -

      • searchSpacesAsync

        public okhttp3.Call searchSpacesAsync​(String query,
                                      String state,
                                      Integer maxResults,
                                      Set<String> spaceFields,
                                      Set<String> expansions,
                                      ApiCallback<MultiSpaceLookupResponse> _callback)
                               throws ApiException
        Search for Spaces (asynchronously) Returns Spaces that match the provided query.
        Parameters:
        query - The search query (required)
        state - The state of spaces to search for (optional, default to all)
        maxResults - The number of results to return. The maximum for this value is 100. (optional)
        spaceFields - A comma separated list of Space fields to display. (optional)
        expansions - A comma separated list of fields to expand. (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. -

      • spaceBuyersCall

        public okhttp3.Call spaceBuyersCall​(String id,
                                    Set<String> userFields,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for spaceBuyers
        Parameters:
        id - The space id from which tweets will be retrieved (required)
        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. -

      • spaceBuyers

        public MultiUserLookupResponse spaceBuyers​(String id,
                                           Set<String> userFields)
                                    throws ApiException
        Retrieve the list of users who purchased a ticket to the given space Retrieves the list of users who purchased a ticket to the given space
        Parameters:
        id - The space id from which tweets will be retrieved (required)
        userFields - A comma separated list of User fields to display. (optional)
        Returns:
        MultiUserLookupResponse
        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. -

      • spaceBuyersWithHttpInfo

        public ApiResponse<MultiUserLookupResponse> spaceBuyersWithHttpInfo​(String id,
                                                                    Set<String> userFields)
                                                             throws ApiException
        Retrieve the list of users who purchased a ticket to the given space Retrieves the list of users who purchased a ticket to the given space
        Parameters:
        id - The space id from which tweets will be retrieved (required)
        userFields - A comma separated list of User fields to display. (optional)
        Returns:
        ApiResponse<MultiUserLookupResponse>
        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. -

      • spaceBuyersAsync

        public okhttp3.Call spaceBuyersAsync​(String id,
                                     Set<String> userFields,
                                     ApiCallback<MultiUserLookupResponse> _callback)
                              throws ApiException
        Retrieve the list of users who purchased a ticket to the given space (asynchronously) Retrieves the list of users who purchased a ticket to the given space
        Parameters:
        id - The space id from which tweets will be retrieved (required)
        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. -

      • spaceTweetsCall

        public okhttp3.Call spaceTweetsCall​(Integer maxResults,
                                    String id,
                                    Set<String> tweetFields,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for spaceTweets
        Parameters:
        maxResults - The number of tweets to fetch from the provided space. If not provided, the value will default to the maximum of 100 (optional)
        id - The space id from which tweets will be retrieved (required)
        tweetFields - A comma separated list of Tweet 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. -

      • spaceTweets

        public MultiTweetLookupResponse spaceTweets​(Integer maxResults,
                                            String id,
                                            Set<String> tweetFields)
                                     throws ApiException
        Retrieve tweets from a Space Retrieves tweets shared in the specified space
        Parameters:
        maxResults - The number of tweets to fetch from the provided space. If not provided, the value will default to the maximum of 100 (optional)
        id - The space id from which tweets will be retrieved (required)
        tweetFields - A comma separated list of Tweet fields to display. (optional)
        Returns:
        MultiTweetLookupResponse
        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. -

      • spaceTweetsWithHttpInfo

        public ApiResponse<MultiTweetLookupResponse> spaceTweetsWithHttpInfo​(Integer maxResults,
                                                                     String id,
                                                                     Set<String> tweetFields)
                                                              throws ApiException
        Retrieve tweets from a Space Retrieves tweets shared in the specified space
        Parameters:
        maxResults - The number of tweets to fetch from the provided space. If not provided, the value will default to the maximum of 100 (optional)
        id - The space id from which tweets will be retrieved (required)
        tweetFields - A comma separated list of Tweet fields to display. (optional)
        Returns:
        ApiResponse<MultiTweetLookupResponse>
        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. -

      • spaceTweetsAsync

        public okhttp3.Call spaceTweetsAsync​(Integer maxResults,
                                     String id,
                                     Set<String> tweetFields,
                                     ApiCallback<MultiTweetLookupResponse> _callback)
                              throws ApiException
        Retrieve tweets from a Space (asynchronously) Retrieves tweets shared in the specified space
        Parameters:
        maxResults - The number of tweets to fetch from the provided space. If not provided, the value will default to the maximum of 100 (optional)
        id - The space id from which tweets will be retrieved (required)
        tweetFields - A comma separated list of Tweet 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. -