Module: Octokit::Client::Marketplace

Included in:
Octokit::Client
Defined in:
lib/octokit/client/marketplace.rb

Overview

Methods for the Marketplace Listing API

Instance Method Summary collapse

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:


28
29
30
# 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:


16
17
18
# 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:


51
52
53
# 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:


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

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