com.amazon.ask.model.services.monetization

Class MonetizationServiceClient

java.lang.Object

com.amazon.ask.model.services.BaseServiceClient

com.amazon.ask.model.services.monetization.MonetizationServiceClient

All Implemented Interfaces:

MonetizationService

public class MonetizationServiceClient
extends com.amazon.ask.model.services.BaseServiceClient
implements MonetizationService

Field Summary

Fields inherited from class com.amazon.ask.model.services.BaseServiceClient

apiClient, apiEndpoint, authorizationValue, serializer

Constructor Summary

Constructors

Constructor and Description
MonetizationServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)

Method Summary

Modifier and Type	Method and Description
com.amazon.ask.model.services.ApiResponse<InSkillProduct>	callGetInSkillProduct(String acceptLanguage, String productId) Get In-Skill Product information based on user context for the Skill.
com.amazon.ask.model.services.ApiResponse<InSkillProductsResponse>	callGetInSkillProducts(String acceptLanguage, String purchasable, String entitled, String productType, String nextToken, BigDecimal maxResults) Gets In-Skill Products based on user's context for the Skill.
com.amazon.ask.model.services.ApiResponse<InSkillProductTransactionsResponse>	callGetInSkillProductsTransactions(String acceptLanguage, String productId, String status, OffsetDateTime fromLastModifiedTime, OffsetDateTime toLastModifiedTime, String nextToken, BigDecimal maxResults) Returns transactions of all in skill products purchases of the customer
com.amazon.ask.model.services.ApiResponse<Boolean>	callGetVoicePurchaseSetting() Returns whether or not voice purchasing is enabled for the skill
InSkillProduct	getInSkillProduct(String acceptLanguage, String productId) Get In-Skill Product information based on user context for the Skill.
InSkillProductsResponse	getInSkillProducts(String acceptLanguage, String purchasable, String entitled, String productType, String nextToken, BigDecimal maxResults) Gets In-Skill Products based on user's context for the Skill.
InSkillProductTransactionsResponse	getInSkillProductsTransactions(String acceptLanguage, String productId, String status, OffsetDateTime fromLastModifiedTime, OffsetDateTime toLastModifiedTime, String nextToken, BigDecimal maxResults) Returns transactions of all in skill products purchases of the customer
Boolean	getVoicePurchaseSetting() Returns whether or not voice purchasing is enabled for the skill

Methods inherited from class com.amazon.ask.model.services.BaseServiceClient

executeRequest, invoke, invoke

Methods inherited from class java.lang.Object

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

Constructor Detail

MonetizationServiceClient

public MonetizationServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)

Method Detail

callGetInSkillProducts

public com.amazon.ask.model.services.ApiResponse<InSkillProductsResponse> callGetInSkillProducts(String acceptLanguage,
                                                                                                 String purchasable,
                                                                                                 String entitled,
                                                                                                 String productType,
                                                                                                 String nextToken,
                                                                                                 BigDecimal maxResults)
                                                                                          throws com.amazon.ask.model.services.ServiceException

Gets In-Skill Products based on user's context for the Skill.

Specified by:

callGetInSkillProducts in interface MonetizationService

Parameters:

acceptLanguage - User's locale/language in context (required)

purchasable - Filter products based on whether they are purchasable by the user or not. * 'PURCHASABLE' - Products that are purchasable by the user. * 'NOT_PURCHASABLE' - Products that are not purchasable by the user. (optional)

entitled - Filter products based on whether they are entitled to the user or not. * 'ENTITLED' - Products that the user is entitled to. * 'NOT_ENTITLED' - Products that the user is not entitled to. (optional)

productType - Product type. * 'SUBSCRIPTION' - Once purchased, customers will own the content for the subscription period. * 'ENTITLEMENT' - Once purchased, customers will own the content forever. * 'CONSUMABLE' - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased. (optional)

nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours. (optional)

maxResults - sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains isTruncated = true. (optional)

Returns:

com.amazon.ask.model.services.monetization.InSkillProductsResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getInSkillProducts

public InSkillProductsResponse getInSkillProducts(String acceptLanguage,
                                                  String purchasable,
                                                  String entitled,
                                                  String productType,
                                                  String nextToken,
                                                  BigDecimal maxResults)
                                           throws com.amazon.ask.model.services.ServiceException

Gets In-Skill Products based on user's context for the Skill.

Specified by:

getInSkillProducts in interface MonetizationService

Parameters:

acceptLanguage - User's locale/language in context (required)

purchasable - Filter products based on whether they are purchasable by the user or not. * 'PURCHASABLE' - Products that are purchasable by the user. * 'NOT_PURCHASABLE' - Products that are not purchasable by the user. (optional)

entitled - Filter products based on whether they are entitled to the user or not. * 'ENTITLED' - Products that the user is entitled to. * 'NOT_ENTITLED' - Products that the user is not entitled to. (optional)

productType - Product type. * 'SUBSCRIPTION' - Once purchased, customers will own the content for the subscription period. * 'ENTITLEMENT' - Once purchased, customers will own the content forever. * 'CONSUMABLE' - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased. (optional)

nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours. (optional)

maxResults - sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains isTruncated = true. (optional)

Returns:

com.amazon.ask.model.services.monetization.InSkillProductsResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetInSkillProduct

public com.amazon.ask.model.services.ApiResponse<InSkillProduct> callGetInSkillProduct(String acceptLanguage,
                                                                                       String productId)
                                                                                throws com.amazon.ask.model.services.ServiceException

Get In-Skill Product information based on user context for the Skill.

Specified by:

callGetInSkillProduct in interface MonetizationService

Parameters:

acceptLanguage - User's locale/language in context (required)

productId - Product Id. (required)

Returns:

com.amazon.ask.model.services.monetization.InSkillProduct

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getInSkillProduct

public InSkillProduct getInSkillProduct(String acceptLanguage,
                                        String productId)
                                 throws com.amazon.ask.model.services.ServiceException

Get In-Skill Product information based on user context for the Skill.

Specified by:

getInSkillProduct in interface MonetizationService

Parameters:

acceptLanguage - User's locale/language in context (required)

productId - Product Id. (required)

Returns:

com.amazon.ask.model.services.monetization.InSkillProduct

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetInSkillProductsTransactions

public com.amazon.ask.model.services.ApiResponse<InSkillProductTransactionsResponse> callGetInSkillProductsTransactions(String acceptLanguage,
                                                                                                                        String productId,
                                                                                                                        String status,
                                                                                                                        OffsetDateTime fromLastModifiedTime,
                                                                                                                        OffsetDateTime toLastModifiedTime,
                                                                                                                        String nextToken,
                                                                                                                        BigDecimal maxResults)
                                                                                                                 throws com.amazon.ask.model.services.ServiceException

Returns transactions of all in skill products purchases of the customer

Specified by:

callGetInSkillProductsTransactions in interface MonetizationService

Parameters:

acceptLanguage - User's locale/language in context (required)

productId - Product Id. (optional)

status - Transaction status for in skill product purchases. * 'PENDING_APPROVAL_BY_PARENT' - The transaction is pending approval from parent. * 'APPROVED_BY_PARENT' - The transaction was approved by parent and fulfilled successfully.. * 'DENIED_BY_PARENT' - The transaction was declined by parent and hence not fulfilled. * 'EXPIRED_NO_ACTION_BY_PARENT' - The transaction was expired due to no response from parent and hence not fulfilled. * 'ERROR' - The transaction was not fullfiled as there was an error while processing the transaction. (optional)

fromLastModifiedTime - Filter transactions based on last modified time stamp, FROM duration in format (UTC ISO 8601) i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (optional)

toLastModifiedTime - Filter transactions based on last modified time stamp, TO duration in format (UTC ISO 8601) i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (optional)

nextToken - When response to this API call is truncated, the response also includes the nextToken in metadata, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours. (optional)

maxResults - sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains nextToken which can be used to fetch next set of result. (optional)

Returns:

com.amazon.ask.model.services.monetization.InSkillProductTransactionsResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getInSkillProductsTransactions

public InSkillProductTransactionsResponse getInSkillProductsTransactions(String acceptLanguage,
                                                                         String productId,
                                                                         String status,
                                                                         OffsetDateTime fromLastModifiedTime,
                                                                         OffsetDateTime toLastModifiedTime,
                                                                         String nextToken,
                                                                         BigDecimal maxResults)
                                                                  throws com.amazon.ask.model.services.ServiceException

Returns transactions of all in skill products purchases of the customer

Specified by:

getInSkillProductsTransactions in interface MonetizationService

Parameters:

acceptLanguage - User's locale/language in context (required)

productId - Product Id. (optional)

status - Transaction status for in skill product purchases. * 'PENDING_APPROVAL_BY_PARENT' - The transaction is pending approval from parent. * 'APPROVED_BY_PARENT' - The transaction was approved by parent and fulfilled successfully.. * 'DENIED_BY_PARENT' - The transaction was declined by parent and hence not fulfilled. * 'EXPIRED_NO_ACTION_BY_PARENT' - The transaction was expired due to no response from parent and hence not fulfilled. * 'ERROR' - The transaction was not fullfiled as there was an error while processing the transaction. (optional)

fromLastModifiedTime - Filter transactions based on last modified time stamp, FROM duration in format (UTC ISO 8601) i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (optional)

toLastModifiedTime - Filter transactions based on last modified time stamp, TO duration in format (UTC ISO 8601) i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (optional)

nextToken - When response to this API call is truncated, the response also includes the nextToken in metadata, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours. (optional)

maxResults - sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains nextToken which can be used to fetch next set of result. (optional)

Returns:

com.amazon.ask.model.services.monetization.InSkillProductTransactionsResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetVoicePurchaseSetting

public com.amazon.ask.model.services.ApiResponse<Boolean> callGetVoicePurchaseSetting()
                                                                               throws com.amazon.ask.model.services.ServiceException

Returns whether or not voice purchasing is enabled for the skill

Specified by:

callGetVoicePurchaseSetting in interface MonetizationService

Returns:

Boolean

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getVoicePurchaseSetting

public Boolean getVoicePurchaseSetting()
                                throws com.amazon.ask.model.services.ServiceException

Returns whether or not voice purchasing is enabled for the skill

Specified by:

getVoicePurchaseSetting in interface MonetizationService

Returns:

Boolean

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call