com.microsoft.store.partnercenter.network.IPartnerServiceClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of partnercenter Show documentation
SDK for accessing Microsoft Partner Center API.
There is a newer version: 1.15.3
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See the LICENSE file in the project root for full license information.

package com.microsoft.store.partnercenter.network;

import java.io.InputStream;
import java.util.Collection;
import java.util.Map;

import com.fasterxml.jackson.core.type.TypeReference;
import com.microsoft.store.partnercenter.IPartner;
import com.microsoft.store.partnercenter.models.Link;
import com.microsoft.store.partnercenter.models.utils.KeyValuePair;

public interface IPartnerServiceClient 
{
    /**
     * Executes a GET operation against the partner service. 
     * 
     * @param  The type of the response. 
     * @param rootPartnerOperations An instance of the partner operations.
     * @param responseType The type of object to be returned.
     * @param link A link object that represents the action for accessing the resource. 
     * @return The response from the GET operation.
     */
     T get(IPartner rootPartnerOperations, TypeReference responseType, Link link);

    /**
     * Executes a GET operation against the partner service. 
     * 
     * @param  The type of the response. 
     * @param rootPartnerOperations An instance of the partner operations.
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address of the request. 
     * @return The response from the GET operation.
     */
     T get(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri);

    /**
     * Executes a GET operation against the partner service. 
     * 
     * @param  The type of the response. 
     * @param rootPartnerOperations An instance of the partner operations.
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address of the request. 
     * @param headers Headers to be added to the request.
     * @param parameters Parameters to be added to the request.
     * @return The response from the GET operation. 
     */
     T get(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, Map headers, Collection> parameters);

    /**
     * Executes a GET operation against the partner service. 
     * 
     * @param  The type of the response. 
     * @param rootPartnerOperations An instance of the partner operations.
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address of the request. 
     * @param parameters Parameters to be added to the request.
     * @return The response from the GET operation.
     */
     T get(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, Collection> parameters);
    
    /**
     * Executes a file content request against the partner service.
     * 
     * @param rootPartnerOperations An instance of the partner operations.
     * @param relativeUri The relative address of the request. 
     * @param acceptType The value for the accept type header.
     * @return The response from the file content request.
     */
    InputStream getFileContents(IPartner rootPartnerOperations, String relativeUri, String acceptType);

    /**
     * Executes a HEAD operation against the partner service. 
     * 
     * @param  The type to the response.
     * @param rootPartnerOperations An instance of the partner operations.
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address of the request. 
     * @return The response from the HEAD operation.
     */
     T head(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri);

    /**
     * Executes a PATCH operation against the partner service.
     * 
     * @param  The type of the request.
     * @param  The type of the response.
     * @param rootPartnerOperations An instance of the partner operations.
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address of the request. 
     * @param content The content for the body of the request.
     * @return The response from the PATCH operation.
     */
     U patch(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content);

    /**
     * Executes a POST operation against the partner service. 
     * 
     * @param  The type of the request.
     * @param  The type of the response.
     * @param rootPartnerOperations An instance of the partner operations. 
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address fo the request.
     * @param content The content for the body of the request.
     * @return The response from the POST operation.
     */
     U post(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content);

    /**
     * Executes a POST operation against the partner service. 
     * 
     * @param  The type of the request.
     * @param  The type of the response.
     * @param rootPartnerOperations An instance of the partner operations. 
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address fo the request.
     * @param content The content for the body of the request.
     * @param parameters Parameters to be added to the request.
     * @return The response from the POST operation.
     */
     U post(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content, Collection> parameters);

    /**
     * Executes a PUT operation against the partner service. 
     * 
     * @param  The type of the request.
     * @param  The type of the response.
     * @param rootPartnerOperations An instance of the partner operations. 
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address fo the request.
     * @param content The content for the body of the request.
     * @return The response from the PUT operation.    
     */
     U put(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content);

    /**
     * Executes a DELETE operation against the partner service. 
     * 
     * @param  The type of the response. 
     * @param rootPartnerOperations An instance of the partner operations. 
     * @param responseType The type of object to be returned.
     * @param relativeUri The relative address fo the request.
     */
     void delete(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri);
}