com.atlassian.marketplace.client.api

Interface Vendors

public interface Vendors

Starting point for all resources that return vendor information. Use MarketplaceClient.vendors() to access this API.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
Vendor	createVendor(Vendor vendor) Creates a new vendor.
Page<VendorSummary>	find(VendorQuery query) Gets a list of vendors.
com.atlassian.fugue.Option<Vendor>	getById(VendorId id) Queries a single vendor.
Vendor	updateVendor(Vendor original, Vendor updated) Attempts to modify an existing vendor.

Method Detail

getById

com.atlassian.fugue.Option<Vendor> getById(VendorId id)
                                           throws MpacException

Queries a single vendor.

Parameters:

id - the unique identifier of the vendor

Returns:

the vendor information, or Option.none() if there is no match

Throws:

MpacException - if the server was unavailable or returned an error

find

Page<VendorSummary> find(VendorQuery query)
                         throws MpacException

Gets a list of vendors.

Parameters:

query - a VendorQuery which can constrain the result set

Returns:

the vendors

Throws:

MpacException - if the server was unavailable or returned an error

createVendor

Vendor createVendor(Vendor vendor)
                    throws MpacException

Creates a new vendor. You must be authenticated to perform this action.

Use ModelBuilders.vendor() to build a new Vendor object.

Parameters:

vendor - the vendor to create

Returns:

a Vendor representing the vendor in its current state after being created

Throws:

MpacException - if the server was unavailable or returned an error

updateVendor

Vendor updateVendor(Vendor original,
                  Vendor updated)
                    throws MpacException

Attempts to modify an existing vendor. You must have already queried the current state of the vendor with getById(VendorId); then, build another instance that includes any changes you want to make, using ModelBuilders.vendor(Vendor).

Parameters:

original - the existing vendor

updated - a copy of the vendor that includes some changes

Returns:

the updated vendor (re-queried from the server) if successful

Throws:

MpacException - if the server was unavailable or returned an error