org.kohsuke.github.GHMarketplacePlanForAccountBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of github-api Show documentation

GitHub API for Java

There is a newer version: 2.0.0-alpha-2

package org.kohsuke.github;

import java.io.IOException;

// TODO: Auto-generated Javadoc
/**
 * Returns the plan associated with current account.
 *
 * @author Benoit Lacelle
 * @see GHMarketplacePlan#listAccounts()
 * @see GitHub#listMarketplacePlans()
 */
public class GHMarketplacePlanForAccountBuilder extends GitHubInteractiveObject {
    private final Requester builder;
    private final long accountId;

    /**
     * Instantiates a new GH marketplace list account builder.
     *
     * @param root
     *            the root
     * @param accountId
     *            the account id
     */
    GHMarketplacePlanForAccountBuilder(GitHub root, long accountId) {
        super(root);
        this.builder = root.createRequest();
        this.accountId = accountId;
    }

    /**
     * Fetch the plan associated with the account specified on construction.
     * 
     * GitHub Apps must use a JWT to access this endpoint.
     *
     * @return a GHMarketplaceAccountPlan
     * @throws IOException
     *             on error
     */
    public GHMarketplaceAccountPlan createRequest() throws IOException {
        return builder.withUrlPath(String.format("/marketplace_listing/accounts/%d", this.accountId))
                .fetch(GHMarketplaceAccountPlan.class);
    }

}