io.sphere.sdk.projects

Interface Project

All Superinterfaces:

CreationTimestamped, WithKey

public interface Project
extends CreationTimestamped, WithKey

Method Summary

Modifier and Type	Method and Description
CartsConfiguration	getCarts()
List<com.neovisionaries.i18n.CountryCode>	getCountries() Enabled countries.
ZonedDateTime	getCreatedAt()
List<String>	getCurrencies() A three-digit currency code as per ISO 4217.
default List<javax.money.CurrencyUnit>	getCurrencyUnits() Currencies assigned to this project as CurrencyUnit.
ExternalOAuth	getExternalOAuth() If this property is set, it allows to use OAuth2 Bearer tokens issued by another service that provides a RFC 7662-compliant endpoint.
String	getKey() The unique key of the project.
default List<Locale>	getLanguageLocales() The languages as list of Locales of this project.
List<String>	getLanguages() A two-digit language code as per ISO 3166-1 alpha-2 String.
MessagesConfiguration	getMessages()
String	getName() The name of the project.
SearchIndexingConfiguration	getSearchIndexing()
ShippingRateInputType	getShippingRateInputType() The shippingRateInput is used as an input to select a shipping rate price tier at the project level
ShoppingListsConfiguration	getShoppingLists()
ZonedDateTime	getTrialUntil()
Long	getVersion() The current version of the project.
static com.fasterxml.jackson.core.type.TypeReference<Project>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Method Detail

getKey

String getKey()

The unique key of the project.

Specified by:

getKey in interface WithKey

Returns:

key

getVersion

Long getVersion()

The current version of the project.

Returns:

version

getName

String getName()

The name of the project.

Returns:

name

getCountries

List<com.neovisionaries.i18n.CountryCode> getCountries()

Enabled countries.

Returns:

countries

getLanguages

List<String> getLanguages()

A two-digit language code as per ISO 3166-1 alpha-2 String.

Returns:

language

See Also:

getLanguageLocales()

getLanguageLocales

default List<Locale> getLanguageLocales()

The languages as list of Locales of this project.

Returns:

languages

See Also:

getLanguages()

getTrialUntil

@Nullable
ZonedDateTime getTrialUntil()

getCreatedAt

ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface CreationTimestamped

getCurrencies

List<String> getCurrencies()

A three-digit currency code as per ISO 4217.

Returns:

currency codes

See Also:

getCurrencyUnits()

getCurrencyUnits

default List<javax.money.CurrencyUnit> getCurrencyUnits()

Currencies assigned to this project as CurrencyUnit.

Returns:

currencies

See Also:

getCurrencies()

getMessages

MessagesConfiguration getMessages()

getShippingRateInputType

@Nullable
ShippingRateInputType getShippingRateInputType()

The shippingRateInput is used as an input to select a shipping rate price tier at the project level

Returns:

shippingRateInput

getExternalOAuth

@Nullable
ExternalOAuth getExternalOAuth()

If this property is set, it allows to use OAuth2 Bearer tokens issued by another service that provides a RFC 7662-compliant endpoint.

Returns:

external oAuth endpoint

getCarts

CartsConfiguration getCarts()

getShoppingLists

ShoppingListsConfiguration getShoppingLists()

getSearchIndexing

@Nullable
SearchIndexingConfiguration getSearchIndexing()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Project> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)