Module: Octokit::Client::Marketplace

Included in:

Octokit::Client

Defined in:

lib/octokit/client/marketplace.rb

Overview

Methods for the Marketplace Listing API

See Also:

• https://developer.github.com/v3/apps/marketplace/

Instance Method Summary

• #list_accounts_for_plan(plan_id, options = {}) ⇒ Array<Sawyer::Resource>

  List all GitHub accounts on a specific plan.

• #list_plans(options = {}) ⇒ Array<Sawyer::Resource>

  List all plans for an app’s marketplace listing.

• #marketplace_purchases(options = {}) ⇒ Array<Sawyer::Resource>

  Get user’s Marketplace purchases.

• #plan_for_account(account_id, options = {}) ⇒ Sawyer::Resource

  Get the plan associated with a given GitHub account.

Instance Method Details

#list_accounts_for_plan(plan_id, options = {}) ⇒ Array<Sawyer::Resource>

List all GitHub accounts on a specific plan

Parameters:

• plan_id (Integer) —

  The id of the GitHub plan

• options (Hash) (defaults to: {}) —

  A customizable set of options

Returns:

• (Array<Sawyer::Resource>) —

  A list of accounts

See Also:

• https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan

# File 'lib/octokit/client/marketplace.rb', line 28

def list_accounts_for_plan(plan_id, options = {})
  paginate "/marketplace_listing/plans/#{plan_id}/accounts", options
end

#list_plans(options = {}) ⇒ Array<Sawyer::Resource>

List all plans for an app’s marketplace listing

Parameters:

• options (Hash) (defaults to: {}) —

  A customizable set of options

Returns:

• (Array<Sawyer::Resource>) —

  A list of plans

See Also:

• https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing

# File 'lib/octokit/client/marketplace.rb', line 16

def list_plans(options = {})
  paginate '/marketplace_listing/plans', options
end

#marketplace_purchases(options = {}) ⇒ Array<Sawyer::Resource>

Get user’s Marketplace purchases

Parameters:

• options (Hash) (defaults to: {}) —

  A customizable set of options

Returns:

• (Array<Sawyer::Resource>) —

  A list of Marketplace purchases

See Also:

• https://developer.github.com/v3/apps/marketplace/#get-a-users-marketplace-purchases

# File 'lib/octokit/client/marketplace.rb', line 51

def marketplace_purchases(options = {})
  get '/user/marketplace_purchases', options
end

#plan_for_account(account_id, options = {}) ⇒ Sawyer::Resource

Get the plan associated with a given GitHub account

Parameters:

• account_id (Integer) —

  The id of the GitHub account

• options (Hash) (defaults to: {}) —

  A customizable set of options

Returns:

• (Sawyer::Resource) —

  Account with plan details, or nil

See Also:

• https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing

# File 'lib/octokit/client/marketplace.rb', line 40

def plan_for_account(account_id, options = {})
  get "/marketplace_listing/accounts/#{account_id}", options
end