Package com.courier.api.resources.brands

Class BrandsClient

java.lang.Object

com.courier.api.resources.brands.BrandsClient

public class BrandsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
BrandsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Brand	create(BrandParameters request)
Brand	create(BrandParameters request, IdempotentRequestOptions requestOptions)
void	delete(java.lang.String brandId)	Delete a brand by brand ID.
void	delete(java.lang.String brandId, RequestOptions requestOptions)	Delete a brand by brand ID.
Brand	get(java.lang.String brandId)	Fetch a specific brand by brand ID.
Brand	get(java.lang.String brandId, RequestOptions requestOptions)	Fetch a specific brand by brand ID.
BrandsResponse	list()	Get the list of brands.
BrandsResponse	list(ListBrandsRequest request)	Get the list of brands.
BrandsResponse	list(ListBrandsRequest request, RequestOptions requestOptions)	Get the list of brands.
Brand	replace(java.lang.String brandId, BrandUpdateParameters request)	Replace an existing brand with the supplied values.
Brand	replace(java.lang.String brandId, BrandUpdateParameters request, RequestOptions requestOptions)	Replace an existing brand with the supplied values.

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

BrandsClient

public BrandsClient(ClientOptions clientOptions)

Method Detail

create

public Brand create(BrandParameters request)

create

public Brand create(BrandParameters request,
                    IdempotentRequestOptions requestOptions)

get

public Brand get(java.lang.String brandId)

Fetch a specific brand by brand ID.

get

public Brand get(java.lang.String brandId,
                 RequestOptions requestOptions)

Fetch a specific brand by brand ID.

list

public BrandsResponse list()

Get the list of brands.

list

public BrandsResponse list(ListBrandsRequest request)

Get the list of brands.

list

public BrandsResponse list(ListBrandsRequest request,
                           RequestOptions requestOptions)

Get the list of brands.

delete

public void delete(java.lang.String brandId)

Delete a brand by brand ID.

delete

public void delete(java.lang.String brandId,
                   RequestOptions requestOptions)

Delete a brand by brand ID.

replace

public Brand replace(java.lang.String brandId,
                     BrandUpdateParameters request)

Replace an existing brand with the supplied values.

replace

public Brand replace(java.lang.String brandId,
                     BrandUpdateParameters request,
                     RequestOptions requestOptions)

Replace an existing brand with the supplied values.