Package com.onshape.api.requests

Class AccountsGetPlanPurchasesRequest.Builder

java.lang.Object

com.onshape.api.requests.AccountsGetPlanPurchasesRequest.Builder

Enclosing class:

AccountsGetPlanPurchasesRequest

public static final class AccountsGetPlanPurchasesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AccountsGetPlanPurchasesResponse	call(String planId)	Calls getPlanPurchases method, Return a list of purchases associated with a plan, along with user information for the subscribers involved.
Number	limit()	Get Number of results to return per page (max is 20)
AccountsGetPlanPurchasesRequest.Builder	limit(Number value)	Set Number of results to return per page (max is 20)
Number	offset()	Get Where to begin search results
AccountsGetPlanPurchasesRequest.Builder	offset(Number value)	Set Where to begin search results

Methods inherited from class java.lang.Object

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

Method Detail

offset

public final Number offset()

Get Where to begin search results

Returns:

Where to begin search results

offset

public final AccountsGetPlanPurchasesRequest.Builder offset(Number value)

Set Where to begin search results

Parameters:

value - Where to begin search results

Returns:

the Builder object.

limit

public final Number limit()

Get Number of results to return per page (max is 20)

Returns:

Number of results to return per page (max is 20)

limit

public final AccountsGetPlanPurchasesRequest.Builder limit(Number value)

Set Number of results to return per page (max is 20)

Parameters:

value - Number of results to return per page (max is 20)

Returns:

the Builder object.

call

public final AccountsGetPlanPurchasesResponse call(String planId)
                                            throws OnshapeException

Calls getPlanPurchases method, Return a list of purchases associated with a plan, along with user information for the subscribers involved. Information returned depends on whether the app associated with the plan has the OAuth2ReadPII scope. This API can only be called by an admin of the app associated with the plan.

Parameters:

planId - Plan Id

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error