com.microsoft.store.partnercenter.invoices.InvoiceCollection 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.invoices;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collection;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.microsoft.store.partnercenter.BasePartnerComponentString;
import com.microsoft.store.partnercenter.IPartner;
import com.microsoft.store.partnercenter.PartnerService;
import com.microsoft.store.partnercenter.exception.PartnerErrorCategory;
import com.microsoft.store.partnercenter.exception.PartnerException;
import com.microsoft.store.partnercenter.models.ResourceCollection;
import com.microsoft.store.partnercenter.models.SeekBasedResourceCollection;
import com.microsoft.store.partnercenter.models.invoices.Invoice;
import com.microsoft.store.partnercenter.models.query.IQuery;
import com.microsoft.store.partnercenter.models.query.QueryType;
import com.microsoft.store.partnercenter.models.utils.KeyValuePair;
import com.microsoft.store.partnercenter.utils.ParameterValidator;
import com.microsoft.store.partnercenter.utils.StringHelper;

/**
 * Represents the operations that can be done on Partner's invoices
 */
public class InvoiceCollection
	extends BasePartnerComponentString
	implements IInvoiceCollection
{
	/**
	 * The maximum allowed page size
	 */
	private static final int MaxPageSize = 200;

	/**
	 * The minimum allowed page size
	 */
	private static final int MinPageSize = 1;

	/**
	 * Initializes a new instance of the InvoiceCollection class.
	 * 
	 * @param rootPartnerOperations The root partner operations instance.
	 */
	public InvoiceCollection( IPartner rootPartnerOperations )
	{
		super( rootPartnerOperations );
	}

	/**
	 * Gets a single invoice operations.
	 * 
	 * @param invoiceId The invoice id.
	 * @return The invoice operations.
	 */
	@Override
	public IInvoice byId( String invoiceId )
	{
		if ( StringHelper.isNullOrWhiteSpace( invoiceId ) )
		{
			throw new IllegalArgumentException( "invoiceId has to be set." );
		}
		return new InvoiceOperations( this.getPartner(), invoiceId );
	}

    /**
     * Gets the available estimate operations.
     * 
     * @return THe available estimate operations.
     */
	public IEstimateCollection getEstimates()
	{
		return new EstimateCollectionOperations(this.getPartner());
	}

	/**
	 * Gets the partner's current account balance.
	 * 
	 * @return The account balance.
	 */
	public IInvoiceSummary getSummary()
	{
		return new InvoiceSummaryOperations( this.getPartner() );
	}

	/**
	 * Gets the invoice summary collection operations.
	 * 
	 * @return The invoice summary collection operations.
	 */
	public IInvoiceSummaryCollection getSummaries()
	{ 
		return new InvoiceSummaryCollectionOperations( this.getPartner() );
	}

	/**
	 * Gets all invoices associated to the partner.
	 * 
	 * @return The collection of invoices.
	 */
	@Override
	public SeekBasedResourceCollection get()
	{
		return this.getPartner().getServiceClient().get(
			this.getPartner(),
			new TypeReference>(){}, 
			PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getPath());
	}

	/**
	 * Gets all invoices associated to the partner.
	 * 
	 * @param offset The page offset.
	 * @param size The maximum number of invoices to return.
	 * @return The subset of invoices.
	 */
	@Override
	public SeekBasedResourceCollection get(int offset, int size)
	{
		ParameterValidator.isIntInclusive( 0, Integer.MAX_VALUE, offset,
										   "The value of the page offset should be at least 0." );
		ParameterValidator.isIntInclusive( MinPageSize, MaxPageSize, size,
										   MessageFormat.format( "The page size must be an integer within the allowed range: {0}-{1}.",
																 MinPageSize, MaxPageSize ) );

		Collection> parameters = new ArrayList>();

		parameters.add(
			new KeyValuePair(
				PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getParameters().get("Offset"),
				String.valueOf(offset)));

		parameters.add(
			new KeyValuePair(
				PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getParameters().get("Size"),
				String.valueOf(size)));

		return this.getPartner().getServiceClient().get(
			this.getPartner(),
			new TypeReference>(){}, 
			PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getPath(),
			parameters);
	}
	
	/**
	 * Asynchronously Gets all invoices associated to the partner.
	 * @param query The query parameter
	 * @return The subset of invoices.
	 */
	public ResourceCollection query( IQuery query )
	{
		if ( query == null )
		{
			throw new IllegalArgumentException( "query can't be null" );
		}

		if ( query.getType() != QueryType.INDEXED && query.getType() != QueryType.SIMPLE )
		{
			throw new IllegalArgumentException( "This type of query is not supported." );
		}

		Collection> parameters = new ArrayList>();

		if ( query.getType() == QueryType.INDEXED )
		{
			parameters.add(
				new KeyValuePair(
					PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getParameters().get("Size"),
					String.valueOf(query.getPageSize())));

			parameters.add(
				new KeyValuePair(
					PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getParameters().get("Offset"),
					String.valueOf(query.getIndex())));      
		}

		if ( query.getFilter() != null )
		{
			ObjectMapper mapper = new ObjectMapper();

			try
			{
				parameters.add(
					new KeyValuePair( 
						PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getParameters().get("Filter"),
						URLEncoder.encode( mapper.writeValueAsString(query.getFilter()),
						"UTF-8")));            	
			}
			catch ( UnsupportedEncodingException e )
			{
				throw new PartnerException( "", null, PartnerErrorCategory.REQUEST_PARSING, e );
			}
			catch ( JsonProcessingException e )
			{
				throw new PartnerException( "", null, PartnerErrorCategory.REQUEST_PARSING, e );
			}
		}

		return this.getPartner().getServiceClient().get(
			this.getPartner(),
			new TypeReference>(){}, 
			PartnerService.getInstance().getConfiguration().getApis().get("GetInvoices").getPath(),
			parameters);
	}
}