Package org.kohsuke.github

Class GHMarketplaceAccount

java.lang.Object

org.kohsuke.github.GHMarketplaceAccount

Direct Known Subclasses:

GHMarketplaceAccountPlan

public class GHMarketplaceAccount
extends Object

Base class for Github Marketplace Account.

Author:

Paulo Miguel Almeida

See Also:

GitHub.getMyMarketplacePurchases(), GHMarketplaceListAccountBuilder.createRequest()

Constructor Summary

Constructors

Constructor	Description
GHMarketplaceAccount()

Method Summary

Modifier and Type	Method	Description
String	getEmail()	Gets email.
long	getId()	Gets id.
String	getLogin()	Gets login.
String	getOrganizationBillingEmail()	Gets organization billing email.
GHMarketplaceAccountPlan	getPlan()	Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHMarketplaceAccountType	getType()	Gets type.
URL	getUrl()	Gets url.

Methods inherited from class java.lang.Object

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

Constructor Detail

GHMarketplaceAccount

public GHMarketplaceAccount()

Method Detail

getUrl

public URL getUrl()

Gets url.

Returns:

the url

getId

public long getId()

Gets id.

Returns:

the id

getLogin

public String getLogin()

Gets login.

Returns:

the login

getEmail

public String getEmail()

Gets email.

Returns:

the email

getOrganizationBillingEmail

public String getOrganizationBillingEmail()

Gets organization billing email.

Returns:

the organization billing email

getType

public GHMarketplaceAccountType getType()

Gets type.

Returns:

the type

getPlan

public GHMarketplaceAccountPlan getPlan()
                                 throws IOException

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a JWT to access this endpoint.

OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

Returns:

a GHMarketplaceListAccountBuilder instance

Throws:

IOException - in case of IOException

See Also:

Get a subscription plan for an account

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance