Module: Vindi::Rest::Issue

Included in:

Vindi::Rest

Defined in:

lib/vindi/rest/issue.rb

Overview

Methods for the issues API

See Also:

• https://vindi.github.io/api-docs/dist/#!/issues

Instance Method Summary

• #issue(issue_id, options = {}) ⇒ Hash

  Get a single issue from a merchant.

• #list_issues(options = {}) ⇒ Array<Hash>

  List issues for the authenticate user.

• #update_issue(issue_id, options = {}) ⇒ Object

  Edit a issue.

Instance Method Details

#issue(issue_id, options = {}) ⇒ Hash

Get a single issue from a merchant

Examples:

Get issue #154 from vindi

client.issue(2)

Parameters:

• issue_id (Integer) —

  ID of the issue

Returns:

• (Hash) —

  The issue you requested, if it exists

See Also:

• https://vindi.github.io/api-docs/dist/#!/issues/GET_version_issues_id_format

# File 'lib/vindi/rest/issue.rb', line 24

def issue(issue_id, options = {})
  get("issues/#{issue_id}", options)[:issue]
end

#list_issues(options = {}) ⇒ Array<Hash>

List issues for the authenticate user

Examples:

Get all issues from merchant vindi

Parameters:

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

  a customizable set of options

Options Hash (options):

• :page (Integer) — default: 1 —

  Page number.

• :merchant (Integer) —

  Merchant account

Returns:

• (Array<Hash>) —

  A list of issues for a merchant.

# File 'lib/vindi/rest/issue.rb', line 13

def list_issues(options = {})
  get('issues', options)[:issues]
end

#update_issue(issue_id, options = {}) ⇒ Object

Edit a issue

Examples:

update issue #2

client.update_issue(2, status: "open")

Parameters:

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

  a customizable set of options

Options Hash (options):

• :options (Hash) —

  issue attributes

See Also:

• https://vindi.github.io/api-docs/dist/#!/issues/PUT_version_issues_id_format

# File 'lib/vindi/rest/issue.rb', line 35

def update_issue(issue_id, options = {})
  put("issues/#{issue_id}", options)[:issue]
end