Class: Trav3::Travis

Inherits:

Object

• Object
• Trav3::Travis

Defined in:

lib/trav3.rb

Overview

An abstraction for the Travis CI v3 API

You can get started with the following.

require 'trav3'
project = Trav3::Travis.new("name/example")

When you instantiate an instance of Travis you get some default headers and default options.

Default Options

• limit: 25 - for limiting data queries to 25 items at most

Options can be changed via the #options getter method which will give you a Options instance. All changes to it affect the options that the Travis instance will submit in url requests.

Default Headers

• 'Content-Type': 'application/json'

• 'Accept': 'application/json'

• 'Travis-API-Version': 3

Headers can be changed via the #headers getter method which will give you a Headers instance. All changes to it affect the headers that the Travis instance will submit in url requests.

General Usage

project.owner
project.owner("owner")
project.repositories
project.repositories("owner")
project.repository
project.repository("owner/repo")
project.builds
project.build(12345)
project.build_jobs(12345)
project.job(1234)
project.log(1234)

# API Request Options
project.options.build({limit: 25})

# Pagination
builds = project.builds
builds.page.next
builds.page.first
builds.page.last

# Recommended inspection
builds.keys
builds.dig("some_key")

# Follow `@href`
repositories = project.repositories("owner")['repositories']
repositories.first.follow

Author:

• Daniel P. Clark 6ftdan.com

Instance Attribute Summary

• #api_endpoint ⇒ String

  API endpoint.

• #headers ⇒ Headers readonly

  Request headers object.

• #options ⇒ Options readonly

  Request options object.

Request Parameters

• #authorization=(token) ⇒ Travis

  Set the authorization token in the requests' headers.

• #defaults(key: value, ...) ⇒ Travis

  Set as many options as you'd like for collections queried via an API request.

• #h(key: value, ...) ⇒ Travis

  Set as many headers as you'd like for API requests.

• #repository=(repo_name) ⇒ Travis

  Change the repository this instance of Trav3::Travis uses.

API Endpoints

• #active(owner = username) ⇒ Success, RequestError

  Please Note that the naming of this endpoint may be changed.

• #beta_feature(action, beta_feature_id, user_id) ⇒ Success, RequestError

  A beta feature (a Travis-CI feature currently in beta).

• #beta_features(user_id) ⇒ Success, RequestError

  A list of beta features.

• #beta_migration_request(user_id) ⇒ Success, RequestError

  Request migration to beta.

• #branch(name) ⇒ Success, RequestError

  The branch of a GitHub repository.

• #branches ⇒ Success, RequestError

  A list of branches.

• #broadcasts ⇒ Success, RequestError

  A list of broadcasts for the current user.

• #build(build_id, option = nil) ⇒ Success, RequestError

  An individual build.

• #build_jobs(build_id) ⇒ Success, RequestError

  A list of jobs.

• #builds(repo = true) ⇒ Success, RequestError

  A list of builds.

• #caches(delete = false) ⇒ Success, RequestError

  A list of caches.

• #cron(id: nil, branch_name: nil, create: nil, delete: false) ⇒ Success, RequestError

  An individual cron.

• #crons ⇒ Success, RequestError

  A list of crons.

• #email_resubscribe ⇒ Success, RequestError

  POST /repo/{repository.id}/email_subscription.

• #email_unsubscribe ⇒ Success, RequestError

  DELETE /repo/{repository.id}/email_subscription.

• #env_var(env_var_id, update: nil, delete: nil) ⇒ Success, RequestError

  An individual environment variable.

• #env_vars(create = nil) ⇒ Success, RequestError

  A list of environment variables.

• #installation(installation_id) ⇒ Success, RequestError

  A GitHub App installation.

• #job(job_id, option = nil) ⇒ Success, RequestError

  An individual job.

• #key_pair(create: nil, update: nil, delete: nil) ⇒ Success, RequestError

  Users may add a public/private RSA key pair to a repository.

• #key_pair_generated(action = :get) ⇒ Success, RequestError

  Every repository has an auto-generated RSA key pair.

• #lint(yaml_content) ⇒ Success, RequestError

  This validates the .travis.yml file and returns any warnings.

• #log(job_id, option = nil) ⇒ Success, ...

  An individual log.

• #messages(request_id) ⇒ Success, RequestError

  A list of messages.

• #organization(org_id) ⇒ Success, RequestError

  An individual organization.

• #organizations ⇒ Success, RequestError

  A list of organizations for the current user.

• #owner(owner = username) ⇒ Success, RequestError

  This will be either a user or organization.

• #preference(key, value = nil, org_id: nil) ⇒ Success, RequestError

  Individual preferences for current user or organization.

• #preferences(org_id = nil) ⇒ Success, RequestError

  Preferences for current user or organization.

• #repositories(owner = username) ⇒ Success, RequestError

  A list of repositories for the current user.

• #repository(repo = repository_name, action = nil) ⇒ Success, RequestError

  An individual repository.

• #request(request_id) ⇒ Success, RequestError

  An individual request.

• #requests(**attributes) ⇒ Success, RequestError

  A list of requests.

• #setting(name, value = nil) ⇒ Success, RequestError

  An individual repository setting.

• #settings ⇒ Success, RequestError

  A list of user settings.

• #stages(build_id) ⇒ Success, RequestError

  A list of stages.

• #user(user_id = nil, sync = false) ⇒ Success, RequestError

  An individual user.

Instance Method Summary

• #initialize(repo) ⇒ Travis constructor

Constructor Details

#initialize(repo) ⇒ Travis

Parameters:

• repo (String) —

  github_username/repository_name

Raises:

• (InvalidRepository) —

  if given input does not conform to valid repository identifier format

# File 'lib/trav3.rb', line 95

def initialize(repo)
  @api_endpoint = 'https://api.travis-ci.org'

  self.repository = repo

  initial_defaults
end

Instance Attribute Details

#api_endpoint ⇒ String

Returns API endpoint

Returns:

• (String) —

  API endpoint

# File 'lib/trav3.rb', line 86

class Travis
  attr_reader :api_endpoint
  attr_reader :options
  attr_reader :headers

  # @param repo [String] github_username/repository_name
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Travis]
  def initialize(repo)
    @api_endpoint = 'https://api.travis-ci.org'

    self.repository = repo

    initial_defaults
  end

  # @!group Request Parameters

  # Set as the API endpoint
  #
  # @param endpoint [String] name for value to set
  # @return [Travis]
  def api_endpoint=(endpoint)
    validate_api_endpoint endpoint
    @api_endpoint = endpoint
  end

  # Set the authorization token in the requests' headers
  #
  # @param token [String] sets authorization token header
  # @return [Travis]
  def authorization=(token)
    validate_string token
    h('Authorization': "token #{token}")
  end

  # Set as many options as you'd like for collections queried via an API request
  #
  # @overload defaults(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def defaults(**args)
    (@options ||= Options.new).build(args)
    self
  end

  # Set as many headers as you'd like for API requests
  #
  #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
  #
  # @overload h(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def h(**args)
    (@headers ||= Headers.new).build(args)
    self
  end

  # Change the repository this instance of `Trav3::Travis` uses.
  #
  # @param repo_name [String] github_username/repository_name
  # @return [Travis]
  def repository=(repo_name)
    validate_repo_format repo_name
    @repo = sanitize_repo_name repo_name
  end

  # @!endgroup

  # @!group API Endpoints

  # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
  #
  # A list of all the builds in an "active" state, either created or started.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     builds  Builds  The active builds.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # Returns a list of "active" builds for the owner.
  #
  # GET <code>/owner/{owner.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/active</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/active</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active(639_823)
  # ```
  #
  # @param owner [String] username, organization name, or github id
  # @return [Success, RequestError]
  def active(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
    get("#{without_repo}/owner/#{owner}/active")
  end

  # A beta feature (a Travis-CI feature currently in beta).
  #
  # ## Attributes
  #
  #     Name          Type     Description
  #     id            Integer  Value uniquely identifying the beta feature.
  #     name          String   The name of the feature.
  #     description   String   Longer description of the feature.
  #     enabled       Boolean  Indicates if the user has this feature turned on.
  #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
  #
  # ## Actions
  #
  # **Update**
  #
  # This will update a user's beta_feature.
  #
  # Use namespaced params in the request body to pass the `enabled` value (either true or false):
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{"beta_feature.enabled":true}' \
  #   https://api.travis-ci.com/user/1234/{beta_feature.id}
  # ```
  #
  # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable     Type     Description
  #     user.id               Integer  Value uniquely identifying the user.
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     Accepted Parameter    Type     Description
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Enable comic-sans for user id 119240
  # travis.beta_feature(:enable, 3, 119_240)
  #
  # # Disable comic-sans for user id 119240
  # travis.beta_feature(:disable, 3, 119_240)
  # ```
  #
  # **Delete**
  #
  # This will delete a user's beta feature.
  #
  # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Disable comic-sans via delete for user id 119240
  # travis.beta_feature(:delete, 3, 119_240)
  # ```
  #
  # @param action [Symbol] either `:enable`, `:disable` or `:delete`
  # @param beta_feature_id [String, Integer] id for the beta feature
  # @param user_id [String] user id
  # @return [Success, RequestError]
  def beta_feature(action, beta_feature_id, user_id)
    validate_number beta_feature_id
    validate_number user_id

    if action != :delete
      params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

      patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
    else
      delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
    end
  end

  # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     beta_features  [Beta feature]  List of beta_features.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of beta features available to a user.
  #
  # GET <code>/user/{user.id}/beta_features</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value  uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240/beta_features
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_features(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_features(user_id)
    validate_number user_id

    get("#{without_repo}/user/#{user_id}/beta_features")
  end

  # Request migration to beta
  #
  # ## Attributes
  #     Name           Type     Description
  #     id             Unknown  The beta_migration_request's id.
  #     owner_id       Unknown  The beta_migration_request's owner_id.
  #     owner_name     Unknown  The beta_migration_request's owner_name.
  #     owner_type     Unknown  The beta_migration_request's owner_type.
  #     accepted_at    Unknown  The beta_migration_request's accepted_at.
  #     organizations  Unknown  The beta_migration_request's organizations.
  #
  # ## Actions
  #
  # **Create**
  #
  # Submits a request for beta migration
  #
  # POST <code>/user/{user.id}/beta_migration_request</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Accepted Parameter                    Type     Description
  #     beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.
  #
  #     Example: POST /user/119240/beta_migration_request
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_migration_request(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_migration_request(user_id)
    create("#{without_repo}/user/#{user_id}/beta_migration_request")
  end

  # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type    Description
  #     name  String  Name of the git branch.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #
  # **Additional Attributes**
  #
  #     Name           Type     Description
  #     recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual branch. The request can include either the repository id or slug.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # @param name [String] the branch name for the current repository
  # @return [Success, RequestError]
  def branch(name)
    get("#{with_repo}/branch/#{name}")
  end

  # A list of branches.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ##Attributes
  #
  #     Name      Type      Description
  #     branches  [Branch]  List of branches.
  #
  # **Collection Items**
  #
  # Each entry in the **branches** array has the following attributes:
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #     recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of branches a repository has on GitHub.
  #
  # GET <code>/repo/{repository.id}/branches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # GET <code>/repo/{repository.slug}/branches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # @return [Success, RequestError]
  def branches
    get("#{with_repo}/branches#{opts}")
  end

  # A list of broadcasts for the current user.
  #
  # ## Attributes
  #
  #     Name        Type         Description
  #     broadcasts  [Broadcast]  List of broadcasts.
  #
  # **Collection Items**
  #
  # Each entry in the broadcasts array has the following attributes:
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the broadcast.
  #     message     String   Message to display to the user.
  #     created_at  String   When the broadcast was created.
  #     category    String   Broadcast category (used for icon and color).
  #     active      Boolean  Whether or not the brodacast should still be displayed.
  #     recipient   Object   Either a user, organization or repository, or null for global.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This will return a list of broadcasts for the current user.
  #
  # GET <code>/broadcasts</code>
  #
  #     Query Parameter   Type       Description
  #     active            [Boolean]  Alias for broadcast.active.
  #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
  #     include           [String]   List of attributes to eager load.
  #
  #     Example: GET /broadcasts
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.broadcasts
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def broadcasts
    get("#{without_repo}/broadcasts")
  end

  # An individual build.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name                 Type     Description
  #     id                   Integer  Value uniquely identifying the build.
  #     number               String   Incremental number for a repository's builds.
  #     state                String   Current state of the build.
  #     duration             Integer  Wall clock time in seconds.
  #     event_type           String   Event that triggered the build.
  #     previous_state       String   State of the previous build (useful to see if state changed).
  #     pull_request_title   String   Title of the build's pull request.
  #     pull_request_number  Integer  Number of the build's pull request.
  #     started_at           String   When the build started.
  #     finished_at          String   When the build finished.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single build.
  #
  # GET <code>/build/{build.id}</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build(351_778_872)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".
  #
  # POST <code>/build/{build.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a build that has completed or been canceled.
  #
  # POST <code>/build/{build.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :restart)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer] the build id number
  # @param option [Symbol] options for :cancel or :restart
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def build(build_id, option = nil)
    validate_number build_id

    case option
    when :cancel
      post("#{without_repo}/build/#{build_id}/cancel")
    when :restart
      post("#{without_repo}/build/#{build_id}/restart")
    else
      get("#{without_repo}/build/#{build_id}")
    end
  end

  # A list of builds.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     builds  [Build]  List of builds.
  #
  # **Collection Items**
  #
  # Each entry in the builds array has the following attributes:
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #     request              Unknown     The build's request.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of builds for the current user. The result is paginated.
  #
  # GET <code>/builds</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many builds to include in the response. Used for pagination.
  #     offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort builds by. Used for pagination.
  #
  #     Example: GET /builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.builds(false)
  # ```
  #
  # **Find**
  #
  # This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
  #
  # GET <code>/repo/{repository.id}/builds</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/891/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # GET <code>/repo/{repository.slug}/builds</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/rails%2Frails/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [Boolean] If true get repo builds, otherwise get user builds
  # @return [Success, RequestError]
  def builds(repo = true)
    repo and return get("#{with_repo}/builds#{opts}")
    get("#{without_repo}/builds#{opts}")
  end

  # A list of jobs.
  #
  # ## Attributes
  #
  #     Name  Type  Description
  #     jobs  [Job]  List of jobs.
  #
  # **Collection Items**
  #
  # Each entry in the jobs array has the following attributes:
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #     config         Object      The job's config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of jobs belonging to an individual build.
  #
  # GET <code>/build/{build.id}/jobs</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/jobs
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build_jobs(86_601_346)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of jobs a current user has access to.
  #
  # GET <code>/jobs</code>
  #
  #     Query Parameter  Type      Description
  #     active           Unknown   Alias for job.active.
  #     created_by       Unknown   Alias for job.created_by.
  #     include          [String]  List of attributes to eager load.
  #     job.active       Unknown   Documentation missing.
  #     job.created_by   Unknown   Documentation missing.
  #     job.state        [String]  Filters jobs by current state of the job.
  #     limit            Integer   How many jobs to include in the response. Used for pagination.
  #     offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort jobs by. Used for pagination.
  #     state            [String]  Alias for job.state.
  #
  #     Example: GET /jobs?limit=5
  #
  # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is id:desc.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.build_jobs(false)
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer, Boolean] the build id number.  If falsey then get all jobs for current user
  # @return [Success, RequestError]
  def build_jobs(build_id)
    build_id and return get("#{without_repo}/build/#{build_id}/jobs")
    get("#{without_repo}/jobs#{opts}")
  end

  # A list of caches.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     branch  String  The branch the cache belongs to.
  #     match   String  The string to match against the cache name.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns all the caches for a repository.
  #
  # It's possible to filter by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches
  # ```
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?match=linux
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({match: :linux})
  # travis.caches
  # ```
  #
  # GET <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/891/caches
  #
  # GET <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/rails%2Frails/caches
  #
  # **Delete**
  #
  # This deletes all caches for a repository.
  #
  # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl -X DELETE \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches(:delete)
  # ```
  #
  # DELETE <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/caches
  #
  # DELETE <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/caches
  #
  # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param delete [Boolean] option for deleting cache(s)
  # @return [Success, RequestError]
  def caches(delete = false)
    without_limit do
      :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
      get("#{with_repo}/caches#{opts}")
    end
  end

  # An individual cron. There can be only one cron per branch on a repository.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the cron.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single cron.
  #
  # GET <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199)
  # ```
  #
  # **Delete**
  #
  # This deletes a single cron.
  #
  # DELETE <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199, delete: true)
  # ```
  #
  # **For Branch**
  #
  # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # **Create**
  #
  # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "cron.interval": "monthly" }' \
  #   https://api.travis-ci.com/repo/1234/branch/master/cron
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })
  # ```
  #
  # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/891/branch/master/cron
  #
  # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/rails%2Frails/branch/master/cron
  #
  # @param id [String, Integer] cron id to get or delete
  # @param branch_name [String] branch name to get cron or create
  # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
  # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
  # @return [Success, RequestError]
  def cron(id: nil, branch_name: nil, create: nil, delete: false)
    if id
      validate_number id

      delete and return delete("#{without_repo}/cron/#{id}")
      return get("#{without_repo}/cron/#{id}")
    end
    raise ArgumentError, 'id or branch_name required' unless branch_name

    create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
    get("#{with_repo}/branch/#{branch_name}/cron")
  end

  # A list of crons.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name   Type    Description
  #     crons  [Cron]  List of crons.
  #
  # **Collection Items**
  #
  # Each entry in the crons array has the following attributes:
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/crons</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # GET <code>/repo/{repository.slug}/crons</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # @return [Success, RequestError]
  def crons
    get("#{with_repo}/crons#{opts}")
  end

  # POST <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # POST <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_resubscribe
    post("#{with_repo}/email_subscription")
  end

  # DELETE <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_unsubscribe
    delete("#{with_repo}/email_subscription")
  end

  # An individual environment variable.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     value   String   The environment variable's value, e.g. bar.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # **Update**
  #
  # This updates a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variable:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/{env_var.id}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Delete**
  #
  # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # @overload env_var(env_var_id)
  #   Gets current env var
  #   @param env_var_id [String] environment variable id
  # @overload env_var(env_var_id, action: params)
  #   Performs action per specific key word argument
  #   @param env_var_id [String] environment variable id
  #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
  #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def env_var(env_var_id, update: nil, delete: nil)
    raise 'Too many options specified' unless [update, delete].compact.count < 2

    validate_string env_var_id

    update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
    delete and return delete("#{with_repo}/env_var/#{env_var_id}")
    get("#{with_repo}/env_var/#{env_var_id}")
  end

  # A list of environment variables.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     env_vars  [Env var]  List of env_vars.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # **Create**
  #
  # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variables:
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/env_vars
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars(name: 'FOO', value: 'bar', public: false)
  # ```
  #
  # POST <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/891/env_vars
  #
  # POST <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/rails%2Frails/env_vars
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
  # @return [Success, RequestError]
  def env_vars(create = nil)
    create and return create("#{with_repo}/env_vars", env_var_keys(create))
    get("#{with_repo}/env_vars")
  end

  # A GitHub App installation.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #     owner      Owner    GitHub user or organization the installation belongs to.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single installation.
  #
  # GET <code>/installation/{installation.github_id}</code>
  #
  #     Template Variable       Type     Description
  #     installation.github_id  Integer  The installation's id on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.installation(617_754)
  # ```
  #
  # @param installation_id [String, Integer] GitHub App installation id
  # @return [Success, RequestError]
  def installation(installation_id)
    validate_number installation_id

    get("#{without_repo}/installation/#{installation_id}")
  end

  # An individual job.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the job.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single job.
  #
  # GET <code>/job/{job.id}</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /job/86601347
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running job.
  #
  # POST <code>/job/{job.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a job that has completed or been canceled.
  #
  # POST <code>/job/{job.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :restart)
  # ```
  #
  # **Debug**
  #
  # This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.
  #
  # POST <code>/job/{job.id}/debug</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/debug
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :debug)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  # @note **Debug** is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :cancel, :restart, or :debug
  # @return [Success, RequestError]
  def job(job_id, option = nil)
    case option
    when :cancel
      post("#{without_repo}/job/#{job_id}/cancel")
    when :restart
      post("#{without_repo}/job/#{job_id}/restart")
    when :debug
      post("#{without_repo}/job/#{job_id}/debug")
    else
      get("#{without_repo}/job/#{job_id}")
    end
  end

  # Users may add a public/private RSA key pair to a repository.
  # This can be used within builds, for example to access third-party services or deploy code to production.
  # Please note this feature is only available on the travis-ci.com domain.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair, if it exists.
  #
  # GET <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # **Create**
  #
  # Creates a new key pair.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })
  # ```
  #
  # POST <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/891/key_pair
  #
  # POST <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/rails%2Frails/key_pair
  #
  # **Update**
  #
  # Update the key pair.
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBarBaz" }' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(update: { description: 'FooBarBaz' })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/891/key_pair
  #
  # PATCH <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/rails%2Frails/key_pair
  #
  # **Delete**
  #
  # Delete the key pair.
  #
  # DELETE <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
  #
  # @overload key_pair()
  #   Gets current key_pair if any
  # @overload key_pair(action: params)
  #   Performs action per specific key word argument
  #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
  #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
  #   @param delete [Boolean] Optional keyword argument.  Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def key_pair(create: nil, update: nil, delete: nil)
    raise 'Too many options specified' unless [create, update, delete].compact.count < 2

    create and return create("#{with_repo}/key_pair", key_pair_keys(create))
    update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
    delete and return delete("#{with_repo}/key_pair")
    get("#{with_repo}/key_pair")
  end

  # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
  #
  # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair.
  #
  # GET <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # **Create**
  #
  # Generate a new key pair, replacing the previous one.
  #
  # POST <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # POST <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
  # @return [Success, RequestError]
  def key_pair_generated(action = :get)
    return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

    get("#{with_repo}/key_pair/generated")
  end

  # This validates the `.travis.yml` file and returns any warnings.
  #
  # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
  #
  # ## Attributes
  #
  #     Name      Type   Description
  #     warnings  Array  An array of hashes with keys and warnings.
  #
  # ## Actions
  #
  # **Lint**
  #
  # POST <code>/lint</code>
  #
  #     Example: POST /lint
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.lint(File.read('.travis.yml'))
  # ```
  #
  # @param yaml_content [String] the contents for the file `.travis.yml`
  # @return [Success, RequestError]
  def lint(yaml_content)
    validate_string yaml_content

    ct = headers.remove(:'Content-Type')
    result = post("#{without_repo}/lint", yaml_content)
    h('Content-Type': ct) if ct
    result
  end

  # An individual log.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Unknown  The log's id.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name       Type     Description
  #     id         Unknown  The log's id.
  #     content    Unknown  The log's content.
  #     log_parts  Unknown  The log's log_parts.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single log.
  #
  # It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.
  #
  #     curl -H "Travis-API-Version: 3" \
  #       -H "Accept: text/plain" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.log(351_778_875)
  # # or
  # travis.log(351_778_875, :text)
  # ```
  #
  # The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see [https://developer.travis-ci.org/format](https://developer.travis-ci.org/format)).
  #
  # GET <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log
  #
  # GET <code>/job/{job.id}/log.txt</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log.txt
  #
  # **Delete**
  #
  # This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.
  #
  #     curl -X DELETE \
  #       -H "Travis-API-Version: 3" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.log(478_772_530, :delete)
  # ```
  #
  # DELETE <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: DELETE /job/86601347/log
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :text or :delete
  # @return [Success, String, RequestError]
  def log(job_id, option = nil)
    case option
    when :text
      get("#{without_repo}/job/#{job_id}/log.txt", true)
    when :delete
      delete("#{without_repo}/job/#{job_id}/log")
    else
      get("#{without_repo}/job/#{job_id}/log")
    end
  end

  # A list of messages. Messages belong to resource types.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     messages  [Message]  List of messages.
  #
  # **Collection Items**
  #
  # Each entry in the messages array has the following attributes:
  #
  #     Name   Type     Description
  #     id     Integer  The message's id.
  #     level  String   The message's level.
  #     key    String   The message's key.
  #     code   String   The message's code.
  #     args   Json     The message's args.
  #
  # ## Actions
  #
  # **For Request**
  #
  # This will return a list of messages created by `travis-yml` for a request, if any exist.
  #
  # GET <code>/repo/{repository.id}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # @param request_id [String, Integer] the request id
  # @return [Success, RequestError]
  def messages(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}/messages")
  end

  # An individual organization.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the organization.
  #     login  String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the organization.
  #     login            String   Login set on GitHub.
  #     name             String   Name set on GitHub.
  #     github_id        Integer  Id set on GitHub.
  #     avatar_url       String   Avatar_url set on GitHub.
  #     education        Boolean  Whether or not the organization has an education account.
  #     allow_migration  Unknown  The organization's allow_migration.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this organization.
  #     installation  Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual organization.
  #
  # GET <code>/org/{organization.id}</code>
  #
  #     Template Variable  Type      Description
  #     organization.id    Integer   Value uniquely identifying the organization.
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.organization(87)
  # ```
  #
  # @param org_id [String, Integer] the organization id
  # @raise [TypeError] if given organization id is not a number
  # @return [Success, RequestError]
  def organization(org_id)
    validate_number org_id

    get("#{without_repo}/org/#{org_id}")
  end

  # A list of organizations for the current user.
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     organizations  [Organization]  List of organizations.
  #
  # **Collection Items**
  #
  # Each entry in the **organizations** array has the following attributes:
  #
  #     Name             Type          Description
  #     id               Integer       Value uniquely identifying the organization.
  #     login            String        Login set on GitHub.
  #     name             String        Name set on GitHub.
  #     github_id        Integer       Id set on GitHub.
  #     avatar_url       String        Avatar_url set on GitHub.
  #     education        Boolean       Whether or not the organization has an education account.
  #     allow_migration  Unknown       The organization's allow_migration.
  #     repositories     [Repository]  Repositories belonging to this organization.
  #     installation     Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of organizations the current user is a member of.
  #
  # GET <code>/orgs</code>
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #     limit              Integer   How many organizations to include in the response. Used for pagination.
  #     offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
  #     organization.role  Unknown   Documentation missing.
  #     role               Unknown   Alias for organization.role.
  #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
  #
  #     Example: GET /orgs?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.organizations
  # ```
  #
  # @return [Success, RequestError]
  def organizations
    get("#{without_repo}/orgs#{opts}")
  end

  # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      Integer  Value uniquely identifying the owner.
  #     login   String   User or organization login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the owner.
  #     login       String   User or organization login set on GitHub.
  #     name        String   User or organization name set on GitHub.
  #     github_id   Integer  User or organization id set on GitHub.
  #     avatar_url  String   Link to user or organization avatar (image) set on GitHub.
  #
  # **Additional Attributes**
  #
  #     Name           Type           Description
  #     repositories   [Repository]   Repositories belonging to this account.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
  #
  # GET <code>/owner/{owner.login}</code>
  #
  #     Template Variable  Type      Description
  #     owner.login        String    User or organization login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}</code>
  #
  #     Template Variable  Type      Description
  #     user.login         String    Login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}</code>
  #
  #     Template Variable   Type      Description
  #     organization.login  String    Login set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}</code>
  #
  #     Template Variable   Type      Description
  #     owner.github_id     Integer   User or organization id set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner(639_823)
  # ```
  #
  # @param owner [String] username or github id
  # @return [Success, RequestError]
  def owner(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
    get("#{without_repo}/owner/#{owner}")
  end

  # Individual preferences for current user or organization.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Get preference for organization.
  #
  # GET <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', org_id: 107_660)
  # ```
  #
  # **Update**
  #
  # Set preference for organization.
  #
  # PATCH <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', 'admins', org_id: 107_660)
  # ```
  #
  # Set preference for current user.
  #
  # PATCH <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails', true)
  # ```
  #
  # **Find**
  #
  # Get preference for current user.
  #
  # GET <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails')
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param key [String] preference name to get or set
  # @param value [String] optional value to set preference
  # @param org_id [String, Integer] optional keyword argument for an organization id
  # @return [Success, RequestError]
  def preference(key, value = nil, org_id: nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
    get("#{without_repo}#{org_id}/preference/#{key}")
  end

  # Preferences for current user or organization.
  #
  # ## Attributes
  #
  #     Name         Type         Description
  #     preferences  [Preferenc]  List of preferences.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Gets preferences for organization.
  #
  # GET <code>/org/{organization.id}/preferences</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87/preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences(107_660)
  # ```
  #
  # **For User**
  #
  # Gets preferences for current user.
  #
  # GET <code>/preferences</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param org_id [String, Integer] optional organization id
  # @return [Success, RequestError]
  def preferences(org_id = nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    get("#{without_repo}#{org_id}/preferences")
  end

  # A list of repositories for the current user.
  #
  # ## Attributes
  #
  #     Name           Type           Description
  #     repositories   [Repository]   List of repositories.
  #
  # **Collection Items**
  #
  # Each entry in the repositories array has the following attributes:
  #
  #     Name                Type     Description
  #     id                  Integer  Value uniquely identifying the repository.
  #     name                String   The repository's name on GitHub.
  #     slug                String   Same as {repository.owner.name}/{repository.name}.
  #     description         String   The repository's description from GitHub.
  #     github_language     String   The main programming language used according to GitHub.
  #     active              Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private             Boolean  Whether or not this repository is private.
  #     owner               Owner    GitHub user or organization the repository belongs to.
  #     default_branch      Branch   The default branch on GitHub.
  #     starred             Boolean  Whether or not this repository is starred.
  #     current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
  #     last_started_build  Build    Alias for current_build.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # This returns a list of repositories an owner has access to.
  #
  # GET <code>/owner/{owner.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/repos</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/repos</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(639_823)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of repositories the current user has access to.
  #
  # GET <code>/repos</code>
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(:self)
  # ```
  #
  # @param owner [String, Integer, Symbol] username, github id, or `:self`
  # @return [Success, RequestError]
  def repositories(owner = username)
    owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
    get("#{without_repo}/owner/#{owner}/repos#{opts}")
  end

  # An individual repository.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the repository.
  #     name   String   The repository's name on GitHub.
  #     slug   String   Same as {repository.owner.name}/{repository.name}.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the repository.
  #     name             String   The repository's name on GitHub.
  #     slug             String   Same as {repository.owner.name}/{repository.name}.
  #     description      String   The repository's description from GitHub.
  #     github_language  String   The main programming language used according to GitHub.
  #     active           Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private          Boolean  Whether or not this repository is private.
  #     owner            Owner    GitHub user or organization the repository belongs to.
  #     default_branch   Branch   The default branch on GitHub.
  #     starred          Boolean  Whether or not this repository is starred.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual repository.
  #
  # GET <code>/repo/{repository.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # GET <code>/repo/{repository.slug}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # **Activate**
  #
  # This will activate a repository, allowing its tests to be run on Travis CI.
  #
  # POST <code>/repo/{repository.id}/activate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/activate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # **Deactivate**
  #
  # This will deactivate a repository, preventing any tests from running on Travis CI.
  #
  # POST <code>/repo/{repository.id}/deactivate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/deactivate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # **Star**
  #
  # This will star a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/star</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # POST <code>/repo/{repository.slug}/star</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # **Unstar**
  #
  # This will unstar a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/unstar</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # POST <code>/repo/{repository.slug}/unstar</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [String] github_username/repository_name
  # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Success, RequestError]
  def repository(repo = repository_name, action = nil)
    validate_repo_format repo

    repo = sanitize_repo_name repo

    action and return post("#{without_repo}/repo/#{repo}/#{action}")
    get("#{without_repo}/repo/#{repo}")
  end

  # An individual request
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name     Type     Description
  #     id       Integer  Value uniquely identifying the request.
  #     state    String   The state of a request (eg. whether it has been processed or not).
  #     result   String   The result of the request (eg. rejected or approved).
  #     message  String   Travis-ci status message attached to the request.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #
  # ## Actions
  #
  # **Find**
  #
  # Get the request by id for the current repository
  #
  # GET <code>/repo/{repository.id}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # @param request_id [String, Integer] request id
  # @return [Success, RequestError]
  def request(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}")
  end

  # A list of requests.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     requests  [Request]  List of requests.
  #
  # **Collection Items**
  #
  # Each entry in the **requests** array has the following attributes:
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #     yaml_config  Unknown     The request's yaml_config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of requests belonging to a repository.
  #
  # GET <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # GET <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # **Create**
  #
  # This will create a request for an individual repository, triggering a build to run on Travis CI.
  #
  # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "request": {
  #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  #   https://api.travis-ci.com/repo/1/requests
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.requests(
  #   message: 'Override the commit message: this is an api request',
  #   branch: 'master'
  # )
  # ```
  #
  # The response includes the following body:
  #
  # ```json
  # {
  #   "@type":              "pending",
  #   "remaining_requests": 1,
  #   "repository":         {
  #     "@type":            "repository",
  #     "@href":            "/repo/1",
  #     "@representation":  "minimal",
  #     "id":               1,
  #     "name":             "test",
  #     "slug":             "owner/repo"
  #   },
  #   "request":            {
  #     "repository":       {
  #       "id":             1,
  #       "owner_name":     "owner",
  #       "name":           "repo"
  #     },
  #     "user":             {
  #       "id":             1
  #     },
  #     "id":               1,
  #     "message":          "Override the commit message: this is an api request",
  #     "branch":           "master",
  #     "config":           { }
  #   },
  #   "resource_type":      "request"
  # }
  # ```
  #
  # POST <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/891/requests
  #
  # POST <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/rails%2Frails/requests
  #
  # @param attributes [Hash] request attributes
  # @return [Success, RequestError]
  def requests(**attributes)
    return get("#{with_repo}/requests") if attributes.empty?

    create("#{with_repo}/requests", 'request': attributes)
  end

  # A list of stages.
  #
  # Currently this is nested within a build.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     stages  [Stage]  List of stages.
  #
  # **Collection Items**
  #
  # Each entry in the stages array has the following attributes:
  #
  #     Name         Type     Description
  #     id           Integer  Value uniquely identifying the stage.
  #     number       Integer  Incremental number for a stage.
  #     name         String   The name of the stage.
  #     state        String   Current state of the stage.
  #     started_at   String   When the stage started.
  #     finished_at  String   When the stage finished.
  #     jobs         [Job]    The jobs of a stage.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of stages belonging to an individual build.
  #
  # GET <code>/build/{build.id}/stages</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/stages
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.stages(479_113_572)
  # ```
  #
  # @param build_id [String, Integer] build id
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def stages(build_id)
    validate_number build_id

    get("#{without_repo}/build/#{build_id}/stages")
  end

  # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #   Name   Type                Description
  #   name   String              The setting's name.
  #   value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single setting. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # **Update**
  #
  # This updates a single setting. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new setting:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "setting.value": true }' \
  #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests', false)
  # ```
  #
  # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # @param name [String] the setting name for the current repository
  # @param value [String] optional argument for setting a value for the setting name
  # @return [Success, RequestError]
  def setting(name, value = nil)
    return get("#{with_repo}/setting/#{name}") if value.nil?

    patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
  end

  # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     settings  [Setting]  List of settings.
  #
  # **Collection Items**
  #
  # Each entry in the settings array has the following attributes:
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/settings</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # GET <code>/repo/{repository.slug}/settings</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # @return [Success, RequestError]
  def settings
    get("#{with_repo}/settings")
  end

  # An individual user.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the user.
  #     login String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type     Description
  #     id                Integer  Value uniquely identifying the user.
  #     login             String   Login set on GitHub.
  #     name              String   Name set on GitHub.
  #     github_id         Integer  Id set on GitHub.
  #     avatar_url        String   Avatar URL set on GitHub.
  #     education         Boolean  Whether or not the user has an education account.
  #     allow_migration   Unknown  The user's allow_migration.
  #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
  #     synced_at         String   The last time the user was synced with GitHub.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this user.
  #     installation  Installation  Installation belonging to the user.
  #     emails        Unknown       The user's emails.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual user.
  #
  # GET <code>/user/{user.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.user(119_240)
  # ```
  #
  # **Sync**
  #
  # This triggers a sync on a user's account with their GitHub account.
  #
  # POST <code>/user/{user.id}/sync</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #
  #     Example: POST /user/119240/sync
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user(114_816, :sync)
  # ```
  #
  # **Current**
  #
  # This will return information about the current user.
  #
  # GET <code>/user</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user
  # ```
  #
  # @note sync feature may not be permitted
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] optional user id
  # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
  # @raise [TypeError] if given user id is not a number
  # @return [Success, RequestError]
  def user(user_id = nil, sync = false)
    return get("#{without_repo}/user") if !user_id && !sync

    validate_number user_id

    sync and return post("#{without_repo}/user/#{user_id}/sync")
    get("#{without_repo}/user/#{user_id}")
  end

  # @!endgroup

  private # @private

  def create(url, data = {})
    Trav3::REST.create(self, url, data)
  end

  def cron_keys(hash)
    inject_property_name('cron', hash)
  end

  def delete(url)
    Trav3::REST.delete(self, url)
  end

  def env_var_keys(hash)
    inject_property_name('env_var', hash)
  end

  def get(url, raw_reply = false)
    Trav3::REST.get(self, url, raw_reply)
  end

  def get_path(url)
    get("#{without_repo}#{url}")
  end

  def get_path_with_opts(url, without_limit = true)
    url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
    opts.immutable do |o|
      o.remove(:limit) if without_limit
      o.send(:update, opt)
      get_path("#{url}#{opts}")
    end
  end

  def initial_defaults
    defaults(limit: 25)
    h('Content-Type': 'application/json')
    h('Accept': 'application/json')
    h('Travis-API-Version': 3)
  end

  def inject_property_name(name, hash)
    raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
    return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)

    hash
  end

  def key_pair_keys(hash)
    inject_property_name('key_pair', hash)
  end

  def number?(input)
    /^\d+$/.match? input.to_s
  end

  def opts
    @options
  end

  def patch(url, data)
    Trav3::REST.patch(self, url, data)
  end

  def post(url, body = nil)
    Trav3::REST.post(self, url, body)
  end

  def validate_api_endpoint(input)
    raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
  end

  def validate_number(input)
    raise TypeError, "Integer expected, #{input.class} given" unless number? input
  end

  def validate_repo_format(input)
    raise InvalidRepository unless repo_slug_or_id? input
  end

  def validate_string(input)
    raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
  end

  def repo_slug_or_id?(input)
    Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
  end

  def repository_name
    @repo
  end

  def sanitize_repo_name(repo)
    repo.to_s.gsub(/\//, '%2F')
  end

  def username
    @repo[/.*?(?=(?:\/|%2F)|$)/]
  end

  def with_repo
    "#{api_endpoint}/repo/#{@repo}"
  end

  def without_repo
    api_endpoint
  end

  def without_limit
    limit = opts.remove(:limit)
    result = yield
    opts.build(limit: limit) if limit
    result
  end
end

#headers ⇒ Headers (readonly)

Returns Request headers object

Returns:

• (Headers) —

  Request headers object

# File 'lib/trav3.rb', line 86

class Travis
  attr_reader :api_endpoint
  attr_reader :options
  attr_reader :headers

  # @param repo [String] github_username/repository_name
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Travis]
  def initialize(repo)
    @api_endpoint = 'https://api.travis-ci.org'

    self.repository = repo

    initial_defaults
  end

  # @!group Request Parameters

  # Set as the API endpoint
  #
  # @param endpoint [String] name for value to set
  # @return [Travis]
  def api_endpoint=(endpoint)
    validate_api_endpoint endpoint
    @api_endpoint = endpoint
  end

  # Set the authorization token in the requests' headers
  #
  # @param token [String] sets authorization token header
  # @return [Travis]
  def authorization=(token)
    validate_string token
    h('Authorization': "token #{token}")
  end

  # Set as many options as you'd like for collections queried via an API request
  #
  # @overload defaults(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def defaults(**args)
    (@options ||= Options.new).build(args)
    self
  end

  # Set as many headers as you'd like for API requests
  #
  #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
  #
  # @overload h(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def h(**args)
    (@headers ||= Headers.new).build(args)
    self
  end

  # Change the repository this instance of `Trav3::Travis` uses.
  #
  # @param repo_name [String] github_username/repository_name
  # @return [Travis]
  def repository=(repo_name)
    validate_repo_format repo_name
    @repo = sanitize_repo_name repo_name
  end

  # @!endgroup

  # @!group API Endpoints

  # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
  #
  # A list of all the builds in an "active" state, either created or started.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     builds  Builds  The active builds.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # Returns a list of "active" builds for the owner.
  #
  # GET <code>/owner/{owner.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/active</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/active</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active(639_823)
  # ```
  #
  # @param owner [String] username, organization name, or github id
  # @return [Success, RequestError]
  def active(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
    get("#{without_repo}/owner/#{owner}/active")
  end

  # A beta feature (a Travis-CI feature currently in beta).
  #
  # ## Attributes
  #
  #     Name          Type     Description
  #     id            Integer  Value uniquely identifying the beta feature.
  #     name          String   The name of the feature.
  #     description   String   Longer description of the feature.
  #     enabled       Boolean  Indicates if the user has this feature turned on.
  #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
  #
  # ## Actions
  #
  # **Update**
  #
  # This will update a user's beta_feature.
  #
  # Use namespaced params in the request body to pass the `enabled` value (either true or false):
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{"beta_feature.enabled":true}' \
  #   https://api.travis-ci.com/user/1234/{beta_feature.id}
  # ```
  #
  # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable     Type     Description
  #     user.id               Integer  Value uniquely identifying the user.
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     Accepted Parameter    Type     Description
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Enable comic-sans for user id 119240
  # travis.beta_feature(:enable, 3, 119_240)
  #
  # # Disable comic-sans for user id 119240
  # travis.beta_feature(:disable, 3, 119_240)
  # ```
  #
  # **Delete**
  #
  # This will delete a user's beta feature.
  #
  # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Disable comic-sans via delete for user id 119240
  # travis.beta_feature(:delete, 3, 119_240)
  # ```
  #
  # @param action [Symbol] either `:enable`, `:disable` or `:delete`
  # @param beta_feature_id [String, Integer] id for the beta feature
  # @param user_id [String] user id
  # @return [Success, RequestError]
  def beta_feature(action, beta_feature_id, user_id)
    validate_number beta_feature_id
    validate_number user_id

    if action != :delete
      params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

      patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
    else
      delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
    end
  end

  # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     beta_features  [Beta feature]  List of beta_features.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of beta features available to a user.
  #
  # GET <code>/user/{user.id}/beta_features</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value  uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240/beta_features
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_features(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_features(user_id)
    validate_number user_id

    get("#{without_repo}/user/#{user_id}/beta_features")
  end

  # Request migration to beta
  #
  # ## Attributes
  #     Name           Type     Description
  #     id             Unknown  The beta_migration_request's id.
  #     owner_id       Unknown  The beta_migration_request's owner_id.
  #     owner_name     Unknown  The beta_migration_request's owner_name.
  #     owner_type     Unknown  The beta_migration_request's owner_type.
  #     accepted_at    Unknown  The beta_migration_request's accepted_at.
  #     organizations  Unknown  The beta_migration_request's organizations.
  #
  # ## Actions
  #
  # **Create**
  #
  # Submits a request for beta migration
  #
  # POST <code>/user/{user.id}/beta_migration_request</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Accepted Parameter                    Type     Description
  #     beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.
  #
  #     Example: POST /user/119240/beta_migration_request
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_migration_request(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_migration_request(user_id)
    create("#{without_repo}/user/#{user_id}/beta_migration_request")
  end

  # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type    Description
  #     name  String  Name of the git branch.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #
  # **Additional Attributes**
  #
  #     Name           Type     Description
  #     recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual branch. The request can include either the repository id or slug.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # @param name [String] the branch name for the current repository
  # @return [Success, RequestError]
  def branch(name)
    get("#{with_repo}/branch/#{name}")
  end

  # A list of branches.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ##Attributes
  #
  #     Name      Type      Description
  #     branches  [Branch]  List of branches.
  #
  # **Collection Items**
  #
  # Each entry in the **branches** array has the following attributes:
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #     recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of branches a repository has on GitHub.
  #
  # GET <code>/repo/{repository.id}/branches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # GET <code>/repo/{repository.slug}/branches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # @return [Success, RequestError]
  def branches
    get("#{with_repo}/branches#{opts}")
  end

  # A list of broadcasts for the current user.
  #
  # ## Attributes
  #
  #     Name        Type         Description
  #     broadcasts  [Broadcast]  List of broadcasts.
  #
  # **Collection Items**
  #
  # Each entry in the broadcasts array has the following attributes:
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the broadcast.
  #     message     String   Message to display to the user.
  #     created_at  String   When the broadcast was created.
  #     category    String   Broadcast category (used for icon and color).
  #     active      Boolean  Whether or not the brodacast should still be displayed.
  #     recipient   Object   Either a user, organization or repository, or null for global.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This will return a list of broadcasts for the current user.
  #
  # GET <code>/broadcasts</code>
  #
  #     Query Parameter   Type       Description
  #     active            [Boolean]  Alias for broadcast.active.
  #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
  #     include           [String]   List of attributes to eager load.
  #
  #     Example: GET /broadcasts
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.broadcasts
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def broadcasts
    get("#{without_repo}/broadcasts")
  end

  # An individual build.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name                 Type     Description
  #     id                   Integer  Value uniquely identifying the build.
  #     number               String   Incremental number for a repository's builds.
  #     state                String   Current state of the build.
  #     duration             Integer  Wall clock time in seconds.
  #     event_type           String   Event that triggered the build.
  #     previous_state       String   State of the previous build (useful to see if state changed).
  #     pull_request_title   String   Title of the build's pull request.
  #     pull_request_number  Integer  Number of the build's pull request.
  #     started_at           String   When the build started.
  #     finished_at          String   When the build finished.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single build.
  #
  # GET <code>/build/{build.id}</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build(351_778_872)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".
  #
  # POST <code>/build/{build.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a build that has completed or been canceled.
  #
  # POST <code>/build/{build.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :restart)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer] the build id number
  # @param option [Symbol] options for :cancel or :restart
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def build(build_id, option = nil)
    validate_number build_id

    case option
    when :cancel
      post("#{without_repo}/build/#{build_id}/cancel")
    when :restart
      post("#{without_repo}/build/#{build_id}/restart")
    else
      get("#{without_repo}/build/#{build_id}")
    end
  end

  # A list of builds.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     builds  [Build]  List of builds.
  #
  # **Collection Items**
  #
  # Each entry in the builds array has the following attributes:
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #     request              Unknown     The build's request.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of builds for the current user. The result is paginated.
  #
  # GET <code>/builds</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many builds to include in the response. Used for pagination.
  #     offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort builds by. Used for pagination.
  #
  #     Example: GET /builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.builds(false)
  # ```
  #
  # **Find**
  #
  # This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
  #
  # GET <code>/repo/{repository.id}/builds</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/891/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # GET <code>/repo/{repository.slug}/builds</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/rails%2Frails/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [Boolean] If true get repo builds, otherwise get user builds
  # @return [Success, RequestError]
  def builds(repo = true)
    repo and return get("#{with_repo}/builds#{opts}")
    get("#{without_repo}/builds#{opts}")
  end

  # A list of jobs.
  #
  # ## Attributes
  #
  #     Name  Type  Description
  #     jobs  [Job]  List of jobs.
  #
  # **Collection Items**
  #
  # Each entry in the jobs array has the following attributes:
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #     config         Object      The job's config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of jobs belonging to an individual build.
  #
  # GET <code>/build/{build.id}/jobs</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/jobs
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build_jobs(86_601_346)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of jobs a current user has access to.
  #
  # GET <code>/jobs</code>
  #
  #     Query Parameter  Type      Description
  #     active           Unknown   Alias for job.active.
  #     created_by       Unknown   Alias for job.created_by.
  #     include          [String]  List of attributes to eager load.
  #     job.active       Unknown   Documentation missing.
  #     job.created_by   Unknown   Documentation missing.
  #     job.state        [String]  Filters jobs by current state of the job.
  #     limit            Integer   How many jobs to include in the response. Used for pagination.
  #     offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort jobs by. Used for pagination.
  #     state            [String]  Alias for job.state.
  #
  #     Example: GET /jobs?limit=5
  #
  # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is id:desc.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.build_jobs(false)
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer, Boolean] the build id number.  If falsey then get all jobs for current user
  # @return [Success, RequestError]
  def build_jobs(build_id)
    build_id and return get("#{without_repo}/build/#{build_id}/jobs")
    get("#{without_repo}/jobs#{opts}")
  end

  # A list of caches.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     branch  String  The branch the cache belongs to.
  #     match   String  The string to match against the cache name.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns all the caches for a repository.
  #
  # It's possible to filter by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches
  # ```
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?match=linux
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({match: :linux})
  # travis.caches
  # ```
  #
  # GET <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/891/caches
  #
  # GET <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/rails%2Frails/caches
  #
  # **Delete**
  #
  # This deletes all caches for a repository.
  #
  # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl -X DELETE \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches(:delete)
  # ```
  #
  # DELETE <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/caches
  #
  # DELETE <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/caches
  #
  # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param delete [Boolean] option for deleting cache(s)
  # @return [Success, RequestError]
  def caches(delete = false)
    without_limit do
      :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
      get("#{with_repo}/caches#{opts}")
    end
  end

  # An individual cron. There can be only one cron per branch on a repository.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the cron.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single cron.
  #
  # GET <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199)
  # ```
  #
  # **Delete**
  #
  # This deletes a single cron.
  #
  # DELETE <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199, delete: true)
  # ```
  #
  # **For Branch**
  #
  # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # **Create**
  #
  # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "cron.interval": "monthly" }' \
  #   https://api.travis-ci.com/repo/1234/branch/master/cron
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })
  # ```
  #
  # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/891/branch/master/cron
  #
  # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/rails%2Frails/branch/master/cron
  #
  # @param id [String, Integer] cron id to get or delete
  # @param branch_name [String] branch name to get cron or create
  # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
  # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
  # @return [Success, RequestError]
  def cron(id: nil, branch_name: nil, create: nil, delete: false)
    if id
      validate_number id

      delete and return delete("#{without_repo}/cron/#{id}")
      return get("#{without_repo}/cron/#{id}")
    end
    raise ArgumentError, 'id or branch_name required' unless branch_name

    create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
    get("#{with_repo}/branch/#{branch_name}/cron")
  end

  # A list of crons.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name   Type    Description
  #     crons  [Cron]  List of crons.
  #
  # **Collection Items**
  #
  # Each entry in the crons array has the following attributes:
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/crons</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # GET <code>/repo/{repository.slug}/crons</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # @return [Success, RequestError]
  def crons
    get("#{with_repo}/crons#{opts}")
  end

  # POST <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # POST <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_resubscribe
    post("#{with_repo}/email_subscription")
  end

  # DELETE <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_unsubscribe
    delete("#{with_repo}/email_subscription")
  end

  # An individual environment variable.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     value   String   The environment variable's value, e.g. bar.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # **Update**
  #
  # This updates a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variable:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/{env_var.id}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Delete**
  #
  # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # @overload env_var(env_var_id)
  #   Gets current env var
  #   @param env_var_id [String] environment variable id
  # @overload env_var(env_var_id, action: params)
  #   Performs action per specific key word argument
  #   @param env_var_id [String] environment variable id
  #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
  #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def env_var(env_var_id, update: nil, delete: nil)
    raise 'Too many options specified' unless [update, delete].compact.count < 2

    validate_string env_var_id

    update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
    delete and return delete("#{with_repo}/env_var/#{env_var_id}")
    get("#{with_repo}/env_var/#{env_var_id}")
  end

  # A list of environment variables.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     env_vars  [Env var]  List of env_vars.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # **Create**
  #
  # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variables:
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/env_vars
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars(name: 'FOO', value: 'bar', public: false)
  # ```
  #
  # POST <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/891/env_vars
  #
  # POST <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/rails%2Frails/env_vars
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
  # @return [Success, RequestError]
  def env_vars(create = nil)
    create and return create("#{with_repo}/env_vars", env_var_keys(create))
    get("#{with_repo}/env_vars")
  end

  # A GitHub App installation.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #     owner      Owner    GitHub user or organization the installation belongs to.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single installation.
  #
  # GET <code>/installation/{installation.github_id}</code>
  #
  #     Template Variable       Type     Description
  #     installation.github_id  Integer  The installation's id on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.installation(617_754)
  # ```
  #
  # @param installation_id [String, Integer] GitHub App installation id
  # @return [Success, RequestError]
  def installation(installation_id)
    validate_number installation_id

    get("#{without_repo}/installation/#{installation_id}")
  end

  # An individual job.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the job.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single job.
  #
  # GET <code>/job/{job.id}</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /job/86601347
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running job.
  #
  # POST <code>/job/{job.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a job that has completed or been canceled.
  #
  # POST <code>/job/{job.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :restart)
  # ```
  #
  # **Debug**
  #
  # This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.
  #
  # POST <code>/job/{job.id}/debug</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/debug
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :debug)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  # @note **Debug** is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :cancel, :restart, or :debug
  # @return [Success, RequestError]
  def job(job_id, option = nil)
    case option
    when :cancel
      post("#{without_repo}/job/#{job_id}/cancel")
    when :restart
      post("#{without_repo}/job/#{job_id}/restart")
    when :debug
      post("#{without_repo}/job/#{job_id}/debug")
    else
      get("#{without_repo}/job/#{job_id}")
    end
  end

  # Users may add a public/private RSA key pair to a repository.
  # This can be used within builds, for example to access third-party services or deploy code to production.
  # Please note this feature is only available on the travis-ci.com domain.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair, if it exists.
  #
  # GET <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # **Create**
  #
  # Creates a new key pair.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })
  # ```
  #
  # POST <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/891/key_pair
  #
  # POST <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/rails%2Frails/key_pair
  #
  # **Update**
  #
  # Update the key pair.
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBarBaz" }' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(update: { description: 'FooBarBaz' })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/891/key_pair
  #
  # PATCH <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/rails%2Frails/key_pair
  #
  # **Delete**
  #
  # Delete the key pair.
  #
  # DELETE <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
  #
  # @overload key_pair()
  #   Gets current key_pair if any
  # @overload key_pair(action: params)
  #   Performs action per specific key word argument
  #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
  #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
  #   @param delete [Boolean] Optional keyword argument.  Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def key_pair(create: nil, update: nil, delete: nil)
    raise 'Too many options specified' unless [create, update, delete].compact.count < 2

    create and return create("#{with_repo}/key_pair", key_pair_keys(create))
    update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
    delete and return delete("#{with_repo}/key_pair")
    get("#{with_repo}/key_pair")
  end

  # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
  #
  # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair.
  #
  # GET <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # **Create**
  #
  # Generate a new key pair, replacing the previous one.
  #
  # POST <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # POST <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
  # @return [Success, RequestError]
  def key_pair_generated(action = :get)
    return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

    get("#{with_repo}/key_pair/generated")
  end

  # This validates the `.travis.yml` file and returns any warnings.
  #
  # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
  #
  # ## Attributes
  #
  #     Name      Type   Description
  #     warnings  Array  An array of hashes with keys and warnings.
  #
  # ## Actions
  #
  # **Lint**
  #
  # POST <code>/lint</code>
  #
  #     Example: POST /lint
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.lint(File.read('.travis.yml'))
  # ```
  #
  # @param yaml_content [String] the contents for the file `.travis.yml`
  # @return [Success, RequestError]
  def lint(yaml_content)
    validate_string yaml_content

    ct = headers.remove(:'Content-Type')
    result = post("#{without_repo}/lint", yaml_content)
    h('Content-Type': ct) if ct
    result
  end

  # An individual log.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Unknown  The log's id.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name       Type     Description
  #     id         Unknown  The log's id.
  #     content    Unknown  The log's content.
  #     log_parts  Unknown  The log's log_parts.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single log.
  #
  # It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.
  #
  #     curl -H "Travis-API-Version: 3" \
  #       -H "Accept: text/plain" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.log(351_778_875)
  # # or
  # travis.log(351_778_875, :text)
  # ```
  #
  # The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see [https://developer.travis-ci.org/format](https://developer.travis-ci.org/format)).
  #
  # GET <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log
  #
  # GET <code>/job/{job.id}/log.txt</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log.txt
  #
  # **Delete**
  #
  # This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.
  #
  #     curl -X DELETE \
  #       -H "Travis-API-Version: 3" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.log(478_772_530, :delete)
  # ```
  #
  # DELETE <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: DELETE /job/86601347/log
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :text or :delete
  # @return [Success, String, RequestError]
  def log(job_id, option = nil)
    case option
    when :text
      get("#{without_repo}/job/#{job_id}/log.txt", true)
    when :delete
      delete("#{without_repo}/job/#{job_id}/log")
    else
      get("#{without_repo}/job/#{job_id}/log")
    end
  end

  # A list of messages. Messages belong to resource types.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     messages  [Message]  List of messages.
  #
  # **Collection Items**
  #
  # Each entry in the messages array has the following attributes:
  #
  #     Name   Type     Description
  #     id     Integer  The message's id.
  #     level  String   The message's level.
  #     key    String   The message's key.
  #     code   String   The message's code.
  #     args   Json     The message's args.
  #
  # ## Actions
  #
  # **For Request**
  #
  # This will return a list of messages created by `travis-yml` for a request, if any exist.
  #
  # GET <code>/repo/{repository.id}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # @param request_id [String, Integer] the request id
  # @return [Success, RequestError]
  def messages(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}/messages")
  end

  # An individual organization.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the organization.
  #     login  String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the organization.
  #     login            String   Login set on GitHub.
  #     name             String   Name set on GitHub.
  #     github_id        Integer  Id set on GitHub.
  #     avatar_url       String   Avatar_url set on GitHub.
  #     education        Boolean  Whether or not the organization has an education account.
  #     allow_migration  Unknown  The organization's allow_migration.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this organization.
  #     installation  Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual organization.
  #
  # GET <code>/org/{organization.id}</code>
  #
  #     Template Variable  Type      Description
  #     organization.id    Integer   Value uniquely identifying the organization.
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.organization(87)
  # ```
  #
  # @param org_id [String, Integer] the organization id
  # @raise [TypeError] if given organization id is not a number
  # @return [Success, RequestError]
  def organization(org_id)
    validate_number org_id

    get("#{without_repo}/org/#{org_id}")
  end

  # A list of organizations for the current user.
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     organizations  [Organization]  List of organizations.
  #
  # **Collection Items**
  #
  # Each entry in the **organizations** array has the following attributes:
  #
  #     Name             Type          Description
  #     id               Integer       Value uniquely identifying the organization.
  #     login            String        Login set on GitHub.
  #     name             String        Name set on GitHub.
  #     github_id        Integer       Id set on GitHub.
  #     avatar_url       String        Avatar_url set on GitHub.
  #     education        Boolean       Whether or not the organization has an education account.
  #     allow_migration  Unknown       The organization's allow_migration.
  #     repositories     [Repository]  Repositories belonging to this organization.
  #     installation     Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of organizations the current user is a member of.
  #
  # GET <code>/orgs</code>
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #     limit              Integer   How many organizations to include in the response. Used for pagination.
  #     offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
  #     organization.role  Unknown   Documentation missing.
  #     role               Unknown   Alias for organization.role.
  #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
  #
  #     Example: GET /orgs?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.organizations
  # ```
  #
  # @return [Success, RequestError]
  def organizations
    get("#{without_repo}/orgs#{opts}")
  end

  # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      Integer  Value uniquely identifying the owner.
  #     login   String   User or organization login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the owner.
  #     login       String   User or organization login set on GitHub.
  #     name        String   User or organization name set on GitHub.
  #     github_id   Integer  User or organization id set on GitHub.
  #     avatar_url  String   Link to user or organization avatar (image) set on GitHub.
  #
  # **Additional Attributes**
  #
  #     Name           Type           Description
  #     repositories   [Repository]   Repositories belonging to this account.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
  #
  # GET <code>/owner/{owner.login}</code>
  #
  #     Template Variable  Type      Description
  #     owner.login        String    User or organization login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}</code>
  #
  #     Template Variable  Type      Description
  #     user.login         String    Login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}</code>
  #
  #     Template Variable   Type      Description
  #     organization.login  String    Login set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}</code>
  #
  #     Template Variable   Type      Description
  #     owner.github_id     Integer   User or organization id set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner(639_823)
  # ```
  #
  # @param owner [String] username or github id
  # @return [Success, RequestError]
  def owner(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
    get("#{without_repo}/owner/#{owner}")
  end

  # Individual preferences for current user or organization.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Get preference for organization.
  #
  # GET <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', org_id: 107_660)
  # ```
  #
  # **Update**
  #
  # Set preference for organization.
  #
  # PATCH <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', 'admins', org_id: 107_660)
  # ```
  #
  # Set preference for current user.
  #
  # PATCH <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails', true)
  # ```
  #
  # **Find**
  #
  # Get preference for current user.
  #
  # GET <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails')
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param key [String] preference name to get or set
  # @param value [String] optional value to set preference
  # @param org_id [String, Integer] optional keyword argument for an organization id
  # @return [Success, RequestError]
  def preference(key, value = nil, org_id: nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
    get("#{without_repo}#{org_id}/preference/#{key}")
  end

  # Preferences for current user or organization.
  #
  # ## Attributes
  #
  #     Name         Type         Description
  #     preferences  [Preferenc]  List of preferences.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Gets preferences for organization.
  #
  # GET <code>/org/{organization.id}/preferences</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87/preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences(107_660)
  # ```
  #
  # **For User**
  #
  # Gets preferences for current user.
  #
  # GET <code>/preferences</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param org_id [String, Integer] optional organization id
  # @return [Success, RequestError]
  def preferences(org_id = nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    get("#{without_repo}#{org_id}/preferences")
  end

  # A list of repositories for the current user.
  #
  # ## Attributes
  #
  #     Name           Type           Description
  #     repositories   [Repository]   List of repositories.
  #
  # **Collection Items**
  #
  # Each entry in the repositories array has the following attributes:
  #
  #     Name                Type     Description
  #     id                  Integer  Value uniquely identifying the repository.
  #     name                String   The repository's name on GitHub.
  #     slug                String   Same as {repository.owner.name}/{repository.name}.
  #     description         String   The repository's description from GitHub.
  #     github_language     String   The main programming language used according to GitHub.
  #     active              Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private             Boolean  Whether or not this repository is private.
  #     owner               Owner    GitHub user or organization the repository belongs to.
  #     default_branch      Branch   The default branch on GitHub.
  #     starred             Boolean  Whether or not this repository is starred.
  #     current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
  #     last_started_build  Build    Alias for current_build.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # This returns a list of repositories an owner has access to.
  #
  # GET <code>/owner/{owner.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/repos</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/repos</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(639_823)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of repositories the current user has access to.
  #
  # GET <code>/repos</code>
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(:self)
  # ```
  #
  # @param owner [String, Integer, Symbol] username, github id, or `:self`
  # @return [Success, RequestError]
  def repositories(owner = username)
    owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
    get("#{without_repo}/owner/#{owner}/repos#{opts}")
  end

  # An individual repository.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the repository.
  #     name   String   The repository's name on GitHub.
  #     slug   String   Same as {repository.owner.name}/{repository.name}.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the repository.
  #     name             String   The repository's name on GitHub.
  #     slug             String   Same as {repository.owner.name}/{repository.name}.
  #     description      String   The repository's description from GitHub.
  #     github_language  String   The main programming language used according to GitHub.
  #     active           Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private          Boolean  Whether or not this repository is private.
  #     owner            Owner    GitHub user or organization the repository belongs to.
  #     default_branch   Branch   The default branch on GitHub.
  #     starred          Boolean  Whether or not this repository is starred.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual repository.
  #
  # GET <code>/repo/{repository.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # GET <code>/repo/{repository.slug}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # **Activate**
  #
  # This will activate a repository, allowing its tests to be run on Travis CI.
  #
  # POST <code>/repo/{repository.id}/activate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/activate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # **Deactivate**
  #
  # This will deactivate a repository, preventing any tests from running on Travis CI.
  #
  # POST <code>/repo/{repository.id}/deactivate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/deactivate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # **Star**
  #
  # This will star a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/star</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # POST <code>/repo/{repository.slug}/star</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # **Unstar**
  #
  # This will unstar a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/unstar</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # POST <code>/repo/{repository.slug}/unstar</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [String] github_username/repository_name
  # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Success, RequestError]
  def repository(repo = repository_name, action = nil)
    validate_repo_format repo

    repo = sanitize_repo_name repo

    action and return post("#{without_repo}/repo/#{repo}/#{action}")
    get("#{without_repo}/repo/#{repo}")
  end

  # An individual request
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name     Type     Description
  #     id       Integer  Value uniquely identifying the request.
  #     state    String   The state of a request (eg. whether it has been processed or not).
  #     result   String   The result of the request (eg. rejected or approved).
  #     message  String   Travis-ci status message attached to the request.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #
  # ## Actions
  #
  # **Find**
  #
  # Get the request by id for the current repository
  #
  # GET <code>/repo/{repository.id}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # @param request_id [String, Integer] request id
  # @return [Success, RequestError]
  def request(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}")
  end

  # A list of requests.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     requests  [Request]  List of requests.
  #
  # **Collection Items**
  #
  # Each entry in the **requests** array has the following attributes:
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #     yaml_config  Unknown     The request's yaml_config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of requests belonging to a repository.
  #
  # GET <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # GET <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # **Create**
  #
  # This will create a request for an individual repository, triggering a build to run on Travis CI.
  #
  # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "request": {
  #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  #   https://api.travis-ci.com/repo/1/requests
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.requests(
  #   message: 'Override the commit message: this is an api request',
  #   branch: 'master'
  # )
  # ```
  #
  # The response includes the following body:
  #
  # ```json
  # {
  #   "@type":              "pending",
  #   "remaining_requests": 1,
  #   "repository":         {
  #     "@type":            "repository",
  #     "@href":            "/repo/1",
  #     "@representation":  "minimal",
  #     "id":               1,
  #     "name":             "test",
  #     "slug":             "owner/repo"
  #   },
  #   "request":            {
  #     "repository":       {
  #       "id":             1,
  #       "owner_name":     "owner",
  #       "name":           "repo"
  #     },
  #     "user":             {
  #       "id":             1
  #     },
  #     "id":               1,
  #     "message":          "Override the commit message: this is an api request",
  #     "branch":           "master",
  #     "config":           { }
  #   },
  #   "resource_type":      "request"
  # }
  # ```
  #
  # POST <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/891/requests
  #
  # POST <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/rails%2Frails/requests
  #
  # @param attributes [Hash] request attributes
  # @return [Success, RequestError]
  def requests(**attributes)
    return get("#{with_repo}/requests") if attributes.empty?

    create("#{with_repo}/requests", 'request': attributes)
  end

  # A list of stages.
  #
  # Currently this is nested within a build.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     stages  [Stage]  List of stages.
  #
  # **Collection Items**
  #
  # Each entry in the stages array has the following attributes:
  #
  #     Name         Type     Description
  #     id           Integer  Value uniquely identifying the stage.
  #     number       Integer  Incremental number for a stage.
  #     name         String   The name of the stage.
  #     state        String   Current state of the stage.
  #     started_at   String   When the stage started.
  #     finished_at  String   When the stage finished.
  #     jobs         [Job]    The jobs of a stage.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of stages belonging to an individual build.
  #
  # GET <code>/build/{build.id}/stages</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/stages
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.stages(479_113_572)
  # ```
  #
  # @param build_id [String, Integer] build id
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def stages(build_id)
    validate_number build_id

    get("#{without_repo}/build/#{build_id}/stages")
  end

  # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #   Name   Type                Description
  #   name   String              The setting's name.
  #   value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single setting. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # **Update**
  #
  # This updates a single setting. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new setting:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "setting.value": true }' \
  #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests', false)
  # ```
  #
  # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # @param name [String] the setting name for the current repository
  # @param value [String] optional argument for setting a value for the setting name
  # @return [Success, RequestError]
  def setting(name, value = nil)
    return get("#{with_repo}/setting/#{name}") if value.nil?

    patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
  end

  # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     settings  [Setting]  List of settings.
  #
  # **Collection Items**
  #
  # Each entry in the settings array has the following attributes:
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/settings</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # GET <code>/repo/{repository.slug}/settings</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # @return [Success, RequestError]
  def settings
    get("#{with_repo}/settings")
  end

  # An individual user.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the user.
  #     login String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type     Description
  #     id                Integer  Value uniquely identifying the user.
  #     login             String   Login set on GitHub.
  #     name              String   Name set on GitHub.
  #     github_id         Integer  Id set on GitHub.
  #     avatar_url        String   Avatar URL set on GitHub.
  #     education         Boolean  Whether or not the user has an education account.
  #     allow_migration   Unknown  The user's allow_migration.
  #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
  #     synced_at         String   The last time the user was synced with GitHub.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this user.
  #     installation  Installation  Installation belonging to the user.
  #     emails        Unknown       The user's emails.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual user.
  #
  # GET <code>/user/{user.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.user(119_240)
  # ```
  #
  # **Sync**
  #
  # This triggers a sync on a user's account with their GitHub account.
  #
  # POST <code>/user/{user.id}/sync</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #
  #     Example: POST /user/119240/sync
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user(114_816, :sync)
  # ```
  #
  # **Current**
  #
  # This will return information about the current user.
  #
  # GET <code>/user</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user
  # ```
  #
  # @note sync feature may not be permitted
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] optional user id
  # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
  # @raise [TypeError] if given user id is not a number
  # @return [Success, RequestError]
  def user(user_id = nil, sync = false)
    return get("#{without_repo}/user") if !user_id && !sync

    validate_number user_id

    sync and return post("#{without_repo}/user/#{user_id}/sync")
    get("#{without_repo}/user/#{user_id}")
  end

  # @!endgroup

  private # @private

  def create(url, data = {})
    Trav3::REST.create(self, url, data)
  end

  def cron_keys(hash)
    inject_property_name('cron', hash)
  end

  def delete(url)
    Trav3::REST.delete(self, url)
  end

  def env_var_keys(hash)
    inject_property_name('env_var', hash)
  end

  def get(url, raw_reply = false)
    Trav3::REST.get(self, url, raw_reply)
  end

  def get_path(url)
    get("#{without_repo}#{url}")
  end

  def get_path_with_opts(url, without_limit = true)
    url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
    opts.immutable do |o|
      o.remove(:limit) if without_limit
      o.send(:update, opt)
      get_path("#{url}#{opts}")
    end
  end

  def initial_defaults
    defaults(limit: 25)
    h('Content-Type': 'application/json')
    h('Accept': 'application/json')
    h('Travis-API-Version': 3)
  end

  def inject_property_name(name, hash)
    raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
    return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)

    hash
  end

  def key_pair_keys(hash)
    inject_property_name('key_pair', hash)
  end

  def number?(input)
    /^\d+$/.match? input.to_s
  end

  def opts
    @options
  end

  def patch(url, data)
    Trav3::REST.patch(self, url, data)
  end

  def post(url, body = nil)
    Trav3::REST.post(self, url, body)
  end

  def validate_api_endpoint(input)
    raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
  end

  def validate_number(input)
    raise TypeError, "Integer expected, #{input.class} given" unless number? input
  end

  def validate_repo_format(input)
    raise InvalidRepository unless repo_slug_or_id? input
  end

  def validate_string(input)
    raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
  end

  def repo_slug_or_id?(input)
    Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
  end

  def repository_name
    @repo
  end

  def sanitize_repo_name(repo)
    repo.to_s.gsub(/\//, '%2F')
  end

  def username
    @repo[/.*?(?=(?:\/|%2F)|$)/]
  end

  def with_repo
    "#{api_endpoint}/repo/#{@repo}"
  end

  def without_repo
    api_endpoint
  end

  def without_limit
    limit = opts.remove(:limit)
    result = yield
    opts.build(limit: limit) if limit
    result
  end
end

#options ⇒ Options (readonly)

Returns Request options object

Returns:

• (Options) —

  Request options object

# File 'lib/trav3.rb', line 86

class Travis
  attr_reader :api_endpoint
  attr_reader :options
  attr_reader :headers

  # @param repo [String] github_username/repository_name
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Travis]
  def initialize(repo)
    @api_endpoint = 'https://api.travis-ci.org'

    self.repository = repo

    initial_defaults
  end

  # @!group Request Parameters

  # Set as the API endpoint
  #
  # @param endpoint [String] name for value to set
  # @return [Travis]
  def api_endpoint=(endpoint)
    validate_api_endpoint endpoint
    @api_endpoint = endpoint
  end

  # Set the authorization token in the requests' headers
  #
  # @param token [String] sets authorization token header
  # @return [Travis]
  def authorization=(token)
    validate_string token
    h('Authorization': "token #{token}")
  end

  # Set as many options as you'd like for collections queried via an API request
  #
  # @overload defaults(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def defaults(**args)
    (@options ||= Options.new).build(args)
    self
  end

  # Set as many headers as you'd like for API requests
  #
  #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
  #
  # @overload h(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def h(**args)
    (@headers ||= Headers.new).build(args)
    self
  end

  # Change the repository this instance of `Trav3::Travis` uses.
  #
  # @param repo_name [String] github_username/repository_name
  # @return [Travis]
  def repository=(repo_name)
    validate_repo_format repo_name
    @repo = sanitize_repo_name repo_name
  end

  # @!endgroup

  # @!group API Endpoints

  # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
  #
  # A list of all the builds in an "active" state, either created or started.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     builds  Builds  The active builds.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # Returns a list of "active" builds for the owner.
  #
  # GET <code>/owner/{owner.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/active</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/active</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active(639_823)
  # ```
  #
  # @param owner [String] username, organization name, or github id
  # @return [Success, RequestError]
  def active(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
    get("#{without_repo}/owner/#{owner}/active")
  end

  # A beta feature (a Travis-CI feature currently in beta).
  #
  # ## Attributes
  #
  #     Name          Type     Description
  #     id            Integer  Value uniquely identifying the beta feature.
  #     name          String   The name of the feature.
  #     description   String   Longer description of the feature.
  #     enabled       Boolean  Indicates if the user has this feature turned on.
  #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
  #
  # ## Actions
  #
  # **Update**
  #
  # This will update a user's beta_feature.
  #
  # Use namespaced params in the request body to pass the `enabled` value (either true or false):
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{"beta_feature.enabled":true}' \
  #   https://api.travis-ci.com/user/1234/{beta_feature.id}
  # ```
  #
  # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable     Type     Description
  #     user.id               Integer  Value uniquely identifying the user.
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     Accepted Parameter    Type     Description
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Enable comic-sans for user id 119240
  # travis.beta_feature(:enable, 3, 119_240)
  #
  # # Disable comic-sans for user id 119240
  # travis.beta_feature(:disable, 3, 119_240)
  # ```
  #
  # **Delete**
  #
  # This will delete a user's beta feature.
  #
  # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Disable comic-sans via delete for user id 119240
  # travis.beta_feature(:delete, 3, 119_240)
  # ```
  #
  # @param action [Symbol] either `:enable`, `:disable` or `:delete`
  # @param beta_feature_id [String, Integer] id for the beta feature
  # @param user_id [String] user id
  # @return [Success, RequestError]
  def beta_feature(action, beta_feature_id, user_id)
    validate_number beta_feature_id
    validate_number user_id

    if action != :delete
      params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

      patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
    else
      delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
    end
  end

  # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     beta_features  [Beta feature]  List of beta_features.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of beta features available to a user.
  #
  # GET <code>/user/{user.id}/beta_features</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value  uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240/beta_features
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_features(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_features(user_id)
    validate_number user_id

    get("#{without_repo}/user/#{user_id}/beta_features")
  end

  # Request migration to beta
  #
  # ## Attributes
  #     Name           Type     Description
  #     id             Unknown  The beta_migration_request's id.
  #     owner_id       Unknown  The beta_migration_request's owner_id.
  #     owner_name     Unknown  The beta_migration_request's owner_name.
  #     owner_type     Unknown  The beta_migration_request's owner_type.
  #     accepted_at    Unknown  The beta_migration_request's accepted_at.
  #     organizations  Unknown  The beta_migration_request's organizations.
  #
  # ## Actions
  #
  # **Create**
  #
  # Submits a request for beta migration
  #
  # POST <code>/user/{user.id}/beta_migration_request</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Accepted Parameter                    Type     Description
  #     beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.
  #
  #     Example: POST /user/119240/beta_migration_request
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_migration_request(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_migration_request(user_id)
    create("#{without_repo}/user/#{user_id}/beta_migration_request")
  end

  # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type    Description
  #     name  String  Name of the git branch.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #
  # **Additional Attributes**
  #
  #     Name           Type     Description
  #     recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual branch. The request can include either the repository id or slug.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # @param name [String] the branch name for the current repository
  # @return [Success, RequestError]
  def branch(name)
    get("#{with_repo}/branch/#{name}")
  end

  # A list of branches.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ##Attributes
  #
  #     Name      Type      Description
  #     branches  [Branch]  List of branches.
  #
  # **Collection Items**
  #
  # Each entry in the **branches** array has the following attributes:
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #     recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of branches a repository has on GitHub.
  #
  # GET <code>/repo/{repository.id}/branches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # GET <code>/repo/{repository.slug}/branches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # @return [Success, RequestError]
  def branches
    get("#{with_repo}/branches#{opts}")
  end

  # A list of broadcasts for the current user.
  #
  # ## Attributes
  #
  #     Name        Type         Description
  #     broadcasts  [Broadcast]  List of broadcasts.
  #
  # **Collection Items**
  #
  # Each entry in the broadcasts array has the following attributes:
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the broadcast.
  #     message     String   Message to display to the user.
  #     created_at  String   When the broadcast was created.
  #     category    String   Broadcast category (used for icon and color).
  #     active      Boolean  Whether or not the brodacast should still be displayed.
  #     recipient   Object   Either a user, organization or repository, or null for global.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This will return a list of broadcasts for the current user.
  #
  # GET <code>/broadcasts</code>
  #
  #     Query Parameter   Type       Description
  #     active            [Boolean]  Alias for broadcast.active.
  #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
  #     include           [String]   List of attributes to eager load.
  #
  #     Example: GET /broadcasts
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.broadcasts
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def broadcasts
    get("#{without_repo}/broadcasts")
  end

  # An individual build.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name                 Type     Description
  #     id                   Integer  Value uniquely identifying the build.
  #     number               String   Incremental number for a repository's builds.
  #     state                String   Current state of the build.
  #     duration             Integer  Wall clock time in seconds.
  #     event_type           String   Event that triggered the build.
  #     previous_state       String   State of the previous build (useful to see if state changed).
  #     pull_request_title   String   Title of the build's pull request.
  #     pull_request_number  Integer  Number of the build's pull request.
  #     started_at           String   When the build started.
  #     finished_at          String   When the build finished.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single build.
  #
  # GET <code>/build/{build.id}</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build(351_778_872)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".
  #
  # POST <code>/build/{build.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a build that has completed or been canceled.
  #
  # POST <code>/build/{build.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :restart)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer] the build id number
  # @param option [Symbol] options for :cancel or :restart
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def build(build_id, option = nil)
    validate_number build_id

    case option
    when :cancel
      post("#{without_repo}/build/#{build_id}/cancel")
    when :restart
      post("#{without_repo}/build/#{build_id}/restart")
    else
      get("#{without_repo}/build/#{build_id}")
    end
  end

  # A list of builds.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     builds  [Build]  List of builds.
  #
  # **Collection Items**
  #
  # Each entry in the builds array has the following attributes:
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #     request              Unknown     The build's request.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of builds for the current user. The result is paginated.
  #
  # GET <code>/builds</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many builds to include in the response. Used for pagination.
  #     offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort builds by. Used for pagination.
  #
  #     Example: GET /builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.builds(false)
  # ```
  #
  # **Find**
  #
  # This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
  #
  # GET <code>/repo/{repository.id}/builds</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/891/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # GET <code>/repo/{repository.slug}/builds</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/rails%2Frails/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [Boolean] If true get repo builds, otherwise get user builds
  # @return [Success, RequestError]
  def builds(repo = true)
    repo and return get("#{with_repo}/builds#{opts}")
    get("#{without_repo}/builds#{opts}")
  end

  # A list of jobs.
  #
  # ## Attributes
  #
  #     Name  Type  Description
  #     jobs  [Job]  List of jobs.
  #
  # **Collection Items**
  #
  # Each entry in the jobs array has the following attributes:
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #     config         Object      The job's config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of jobs belonging to an individual build.
  #
  # GET <code>/build/{build.id}/jobs</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/jobs
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build_jobs(86_601_346)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of jobs a current user has access to.
  #
  # GET <code>/jobs</code>
  #
  #     Query Parameter  Type      Description
  #     active           Unknown   Alias for job.active.
  #     created_by       Unknown   Alias for job.created_by.
  #     include          [String]  List of attributes to eager load.
  #     job.active       Unknown   Documentation missing.
  #     job.created_by   Unknown   Documentation missing.
  #     job.state        [String]  Filters jobs by current state of the job.
  #     limit            Integer   How many jobs to include in the response. Used for pagination.
  #     offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort jobs by. Used for pagination.
  #     state            [String]  Alias for job.state.
  #
  #     Example: GET /jobs?limit=5
  #
  # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is id:desc.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.build_jobs(false)
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer, Boolean] the build id number.  If falsey then get all jobs for current user
  # @return [Success, RequestError]
  def build_jobs(build_id)
    build_id and return get("#{without_repo}/build/#{build_id}/jobs")
    get("#{without_repo}/jobs#{opts}")
  end

  # A list of caches.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     branch  String  The branch the cache belongs to.
  #     match   String  The string to match against the cache name.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns all the caches for a repository.
  #
  # It's possible to filter by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches
  # ```
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?match=linux
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({match: :linux})
  # travis.caches
  # ```
  #
  # GET <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/891/caches
  #
  # GET <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/rails%2Frails/caches
  #
  # **Delete**
  #
  # This deletes all caches for a repository.
  #
  # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl -X DELETE \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches(:delete)
  # ```
  #
  # DELETE <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/caches
  #
  # DELETE <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/caches
  #
  # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param delete [Boolean] option for deleting cache(s)
  # @return [Success, RequestError]
  def caches(delete = false)
    without_limit do
      :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
      get("#{with_repo}/caches#{opts}")
    end
  end

  # An individual cron. There can be only one cron per branch on a repository.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the cron.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single cron.
  #
  # GET <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199)
  # ```
  #
  # **Delete**
  #
  # This deletes a single cron.
  #
  # DELETE <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199, delete: true)
  # ```
  #
  # **For Branch**
  #
  # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # **Create**
  #
  # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "cron.interval": "monthly" }' \
  #   https://api.travis-ci.com/repo/1234/branch/master/cron
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })
  # ```
  #
  # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/891/branch/master/cron
  #
  # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/rails%2Frails/branch/master/cron
  #
  # @param id [String, Integer] cron id to get or delete
  # @param branch_name [String] branch name to get cron or create
  # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
  # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
  # @return [Success, RequestError]
  def cron(id: nil, branch_name: nil, create: nil, delete: false)
    if id
      validate_number id

      delete and return delete("#{without_repo}/cron/#{id}")
      return get("#{without_repo}/cron/#{id}")
    end
    raise ArgumentError, 'id or branch_name required' unless branch_name

    create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
    get("#{with_repo}/branch/#{branch_name}/cron")
  end

  # A list of crons.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name   Type    Description
  #     crons  [Cron]  List of crons.
  #
  # **Collection Items**
  #
  # Each entry in the crons array has the following attributes:
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/crons</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # GET <code>/repo/{repository.slug}/crons</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # @return [Success, RequestError]
  def crons
    get("#{with_repo}/crons#{opts}")
  end

  # POST <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # POST <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_resubscribe
    post("#{with_repo}/email_subscription")
  end

  # DELETE <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_unsubscribe
    delete("#{with_repo}/email_subscription")
  end

  # An individual environment variable.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     value   String   The environment variable's value, e.g. bar.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # **Update**
  #
  # This updates a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variable:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/{env_var.id}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Delete**
  #
  # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # @overload env_var(env_var_id)
  #   Gets current env var
  #   @param env_var_id [String] environment variable id
  # @overload env_var(env_var_id, action: params)
  #   Performs action per specific key word argument
  #   @param env_var_id [String] environment variable id
  #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
  #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def env_var(env_var_id, update: nil, delete: nil)
    raise 'Too many options specified' unless [update, delete].compact.count < 2

    validate_string env_var_id

    update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
    delete and return delete("#{with_repo}/env_var/#{env_var_id}")
    get("#{with_repo}/env_var/#{env_var_id}")
  end

  # A list of environment variables.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     env_vars  [Env var]  List of env_vars.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # **Create**
  #
  # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variables:
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/env_vars
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars(name: 'FOO', value: 'bar', public: false)
  # ```
  #
  # POST <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/891/env_vars
  #
  # POST <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/rails%2Frails/env_vars
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
  # @return [Success, RequestError]
  def env_vars(create = nil)
    create and return create("#{with_repo}/env_vars", env_var_keys(create))
    get("#{with_repo}/env_vars")
  end

  # A GitHub App installation.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #     owner      Owner    GitHub user or organization the installation belongs to.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single installation.
  #
  # GET <code>/installation/{installation.github_id}</code>
  #
  #     Template Variable       Type     Description
  #     installation.github_id  Integer  The installation's id on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.installation(617_754)
  # ```
  #
  # @param installation_id [String, Integer] GitHub App installation id
  # @return [Success, RequestError]
  def installation(installation_id)
    validate_number installation_id

    get("#{without_repo}/installation/#{installation_id}")
  end

  # An individual job.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the job.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single job.
  #
  # GET <code>/job/{job.id}</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /job/86601347
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running job.
  #
  # POST <code>/job/{job.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a job that has completed or been canceled.
  #
  # POST <code>/job/{job.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :restart)
  # ```
  #
  # **Debug**
  #
  # This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.
  #
  # POST <code>/job/{job.id}/debug</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/debug
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :debug)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  # @note **Debug** is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :cancel, :restart, or :debug
  # @return [Success, RequestError]
  def job(job_id, option = nil)
    case option
    when :cancel
      post("#{without_repo}/job/#{job_id}/cancel")
    when :restart
      post("#{without_repo}/job/#{job_id}/restart")
    when :debug
      post("#{without_repo}/job/#{job_id}/debug")
    else
      get("#{without_repo}/job/#{job_id}")
    end
  end

  # Users may add a public/private RSA key pair to a repository.
  # This can be used within builds, for example to access third-party services or deploy code to production.
  # Please note this feature is only available on the travis-ci.com domain.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair, if it exists.
  #
  # GET <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # **Create**
  #
  # Creates a new key pair.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })
  # ```
  #
  # POST <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/891/key_pair
  #
  # POST <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/rails%2Frails/key_pair
  #
  # **Update**
  #
  # Update the key pair.
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBarBaz" }' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(update: { description: 'FooBarBaz' })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/891/key_pair
  #
  # PATCH <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/rails%2Frails/key_pair
  #
  # **Delete**
  #
  # Delete the key pair.
  #
  # DELETE <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
  #
  # @overload key_pair()
  #   Gets current key_pair if any
  # @overload key_pair(action: params)
  #   Performs action per specific key word argument
  #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
  #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
  #   @param delete [Boolean] Optional keyword argument.  Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def key_pair(create: nil, update: nil, delete: nil)
    raise 'Too many options specified' unless [create, update, delete].compact.count < 2

    create and return create("#{with_repo}/key_pair", key_pair_keys(create))
    update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
    delete and return delete("#{with_repo}/key_pair")
    get("#{with_repo}/key_pair")
  end

  # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
  #
  # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair.
  #
  # GET <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # **Create**
  #
  # Generate a new key pair, replacing the previous one.
  #
  # POST <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # POST <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
  # @return [Success, RequestError]
  def key_pair_generated(action = :get)
    return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

    get("#{with_repo}/key_pair/generated")
  end

  # This validates the `.travis.yml` file and returns any warnings.
  #
  # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
  #
  # ## Attributes
  #
  #     Name      Type   Description
  #     warnings  Array  An array of hashes with keys and warnings.
  #
  # ## Actions
  #
  # **Lint**
  #
  # POST <code>/lint</code>
  #
  #     Example: POST /lint
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.lint(File.read('.travis.yml'))
  # ```
  #
  # @param yaml_content [String] the contents for the file `.travis.yml`
  # @return [Success, RequestError]
  def lint(yaml_content)
    validate_string yaml_content

    ct = headers.remove(:'Content-Type')
    result = post("#{without_repo}/lint", yaml_content)
    h('Content-Type': ct) if ct
    result
  end

  # An individual log.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Unknown  The log's id.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name       Type     Description
  #     id         Unknown  The log's id.
  #     content    Unknown  The log's content.
  #     log_parts  Unknown  The log's log_parts.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single log.
  #
  # It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.
  #
  #     curl -H "Travis-API-Version: 3" \
  #       -H "Accept: text/plain" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.log(351_778_875)
  # # or
  # travis.log(351_778_875, :text)
  # ```
  #
  # The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see [https://developer.travis-ci.org/format](https://developer.travis-ci.org/format)).
  #
  # GET <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log
  #
  # GET <code>/job/{job.id}/log.txt</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log.txt
  #
  # **Delete**
  #
  # This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.
  #
  #     curl -X DELETE \
  #       -H "Travis-API-Version: 3" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.log(478_772_530, :delete)
  # ```
  #
  # DELETE <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: DELETE /job/86601347/log
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :text or :delete
  # @return [Success, String, RequestError]
  def log(job_id, option = nil)
    case option
    when :text
      get("#{without_repo}/job/#{job_id}/log.txt", true)
    when :delete
      delete("#{without_repo}/job/#{job_id}/log")
    else
      get("#{without_repo}/job/#{job_id}/log")
    end
  end

  # A list of messages. Messages belong to resource types.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     messages  [Message]  List of messages.
  #
  # **Collection Items**
  #
  # Each entry in the messages array has the following attributes:
  #
  #     Name   Type     Description
  #     id     Integer  The message's id.
  #     level  String   The message's level.
  #     key    String   The message's key.
  #     code   String   The message's code.
  #     args   Json     The message's args.
  #
  # ## Actions
  #
  # **For Request**
  #
  # This will return a list of messages created by `travis-yml` for a request, if any exist.
  #
  # GET <code>/repo/{repository.id}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # @param request_id [String, Integer] the request id
  # @return [Success, RequestError]
  def messages(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}/messages")
  end

  # An individual organization.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the organization.
  #     login  String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the organization.
  #     login            String   Login set on GitHub.
  #     name             String   Name set on GitHub.
  #     github_id        Integer  Id set on GitHub.
  #     avatar_url       String   Avatar_url set on GitHub.
  #     education        Boolean  Whether or not the organization has an education account.
  #     allow_migration  Unknown  The organization's allow_migration.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this organization.
  #     installation  Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual organization.
  #
  # GET <code>/org/{organization.id}</code>
  #
  #     Template Variable  Type      Description
  #     organization.id    Integer   Value uniquely identifying the organization.
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.organization(87)
  # ```
  #
  # @param org_id [String, Integer] the organization id
  # @raise [TypeError] if given organization id is not a number
  # @return [Success, RequestError]
  def organization(org_id)
    validate_number org_id

    get("#{without_repo}/org/#{org_id}")
  end

  # A list of organizations for the current user.
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     organizations  [Organization]  List of organizations.
  #
  # **Collection Items**
  #
  # Each entry in the **organizations** array has the following attributes:
  #
  #     Name             Type          Description
  #     id               Integer       Value uniquely identifying the organization.
  #     login            String        Login set on GitHub.
  #     name             String        Name set on GitHub.
  #     github_id        Integer       Id set on GitHub.
  #     avatar_url       String        Avatar_url set on GitHub.
  #     education        Boolean       Whether or not the organization has an education account.
  #     allow_migration  Unknown       The organization's allow_migration.
  #     repositories     [Repository]  Repositories belonging to this organization.
  #     installation     Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of organizations the current user is a member of.
  #
  # GET <code>/orgs</code>
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #     limit              Integer   How many organizations to include in the response. Used for pagination.
  #     offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
  #     organization.role  Unknown   Documentation missing.
  #     role               Unknown   Alias for organization.role.
  #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
  #
  #     Example: GET /orgs?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.organizations
  # ```
  #
  # @return [Success, RequestError]
  def organizations
    get("#{without_repo}/orgs#{opts}")
  end

  # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      Integer  Value uniquely identifying the owner.
  #     login   String   User or organization login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the owner.
  #     login       String   User or organization login set on GitHub.
  #     name        String   User or organization name set on GitHub.
  #     github_id   Integer  User or organization id set on GitHub.
  #     avatar_url  String   Link to user or organization avatar (image) set on GitHub.
  #
  # **Additional Attributes**
  #
  #     Name           Type           Description
  #     repositories   [Repository]   Repositories belonging to this account.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
  #
  # GET <code>/owner/{owner.login}</code>
  #
  #     Template Variable  Type      Description
  #     owner.login        String    User or organization login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}</code>
  #
  #     Template Variable  Type      Description
  #     user.login         String    Login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}</code>
  #
  #     Template Variable   Type      Description
  #     organization.login  String    Login set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}</code>
  #
  #     Template Variable   Type      Description
  #     owner.github_id     Integer   User or organization id set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner(639_823)
  # ```
  #
  # @param owner [String] username or github id
  # @return [Success, RequestError]
  def owner(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
    get("#{without_repo}/owner/#{owner}")
  end

  # Individual preferences for current user or organization.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Get preference for organization.
  #
  # GET <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', org_id: 107_660)
  # ```
  #
  # **Update**
  #
  # Set preference for organization.
  #
  # PATCH <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', 'admins', org_id: 107_660)
  # ```
  #
  # Set preference for current user.
  #
  # PATCH <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails', true)
  # ```
  #
  # **Find**
  #
  # Get preference for current user.
  #
  # GET <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails')
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param key [String] preference name to get or set
  # @param value [String] optional value to set preference
  # @param org_id [String, Integer] optional keyword argument for an organization id
  # @return [Success, RequestError]
  def preference(key, value = nil, org_id: nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
    get("#{without_repo}#{org_id}/preference/#{key}")
  end

  # Preferences for current user or organization.
  #
  # ## Attributes
  #
  #     Name         Type         Description
  #     preferences  [Preferenc]  List of preferences.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Gets preferences for organization.
  #
  # GET <code>/org/{organization.id}/preferences</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87/preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences(107_660)
  # ```
  #
  # **For User**
  #
  # Gets preferences for current user.
  #
  # GET <code>/preferences</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param org_id [String, Integer] optional organization id
  # @return [Success, RequestError]
  def preferences(org_id = nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    get("#{without_repo}#{org_id}/preferences")
  end

  # A list of repositories for the current user.
  #
  # ## Attributes
  #
  #     Name           Type           Description
  #     repositories   [Repository]   List of repositories.
  #
  # **Collection Items**
  #
  # Each entry in the repositories array has the following attributes:
  #
  #     Name                Type     Description
  #     id                  Integer  Value uniquely identifying the repository.
  #     name                String   The repository's name on GitHub.
  #     slug                String   Same as {repository.owner.name}/{repository.name}.
  #     description         String   The repository's description from GitHub.
  #     github_language     String   The main programming language used according to GitHub.
  #     active              Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private             Boolean  Whether or not this repository is private.
  #     owner               Owner    GitHub user or organization the repository belongs to.
  #     default_branch      Branch   The default branch on GitHub.
  #     starred             Boolean  Whether or not this repository is starred.
  #     current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
  #     last_started_build  Build    Alias for current_build.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # This returns a list of repositories an owner has access to.
  #
  # GET <code>/owner/{owner.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/repos</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/repos</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(639_823)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of repositories the current user has access to.
  #
  # GET <code>/repos</code>
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(:self)
  # ```
  #
  # @param owner [String, Integer, Symbol] username, github id, or `:self`
  # @return [Success, RequestError]
  def repositories(owner = username)
    owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
    get("#{without_repo}/owner/#{owner}/repos#{opts}")
  end

  # An individual repository.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the repository.
  #     name   String   The repository's name on GitHub.
  #     slug   String   Same as {repository.owner.name}/{repository.name}.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the repository.
  #     name             String   The repository's name on GitHub.
  #     slug             String   Same as {repository.owner.name}/{repository.name}.
  #     description      String   The repository's description from GitHub.
  #     github_language  String   The main programming language used according to GitHub.
  #     active           Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private          Boolean  Whether or not this repository is private.
  #     owner            Owner    GitHub user or organization the repository belongs to.
  #     default_branch   Branch   The default branch on GitHub.
  #     starred          Boolean  Whether or not this repository is starred.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual repository.
  #
  # GET <code>/repo/{repository.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # GET <code>/repo/{repository.slug}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # **Activate**
  #
  # This will activate a repository, allowing its tests to be run on Travis CI.
  #
  # POST <code>/repo/{repository.id}/activate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/activate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # **Deactivate**
  #
  # This will deactivate a repository, preventing any tests from running on Travis CI.
  #
  # POST <code>/repo/{repository.id}/deactivate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/deactivate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # **Star**
  #
  # This will star a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/star</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # POST <code>/repo/{repository.slug}/star</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # **Unstar**
  #
  # This will unstar a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/unstar</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # POST <code>/repo/{repository.slug}/unstar</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [String] github_username/repository_name
  # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Success, RequestError]
  def repository(repo = repository_name, action = nil)
    validate_repo_format repo

    repo = sanitize_repo_name repo

    action and return post("#{without_repo}/repo/#{repo}/#{action}")
    get("#{without_repo}/repo/#{repo}")
  end

  # An individual request
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name     Type     Description
  #     id       Integer  Value uniquely identifying the request.
  #     state    String   The state of a request (eg. whether it has been processed or not).
  #     result   String   The result of the request (eg. rejected or approved).
  #     message  String   Travis-ci status message attached to the request.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #
  # ## Actions
  #
  # **Find**
  #
  # Get the request by id for the current repository
  #
  # GET <code>/repo/{repository.id}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # @param request_id [String, Integer] request id
  # @return [Success, RequestError]
  def request(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}")
  end

  # A list of requests.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     requests  [Request]  List of requests.
  #
  # **Collection Items**
  #
  # Each entry in the **requests** array has the following attributes:
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #     yaml_config  Unknown     The request's yaml_config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of requests belonging to a repository.
  #
  # GET <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # GET <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # **Create**
  #
  # This will create a request for an individual repository, triggering a build to run on Travis CI.
  #
  # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "request": {
  #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  #   https://api.travis-ci.com/repo/1/requests
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.requests(
  #   message: 'Override the commit message: this is an api request',
  #   branch: 'master'
  # )
  # ```
  #
  # The response includes the following body:
  #
  # ```json
  # {
  #   "@type":              "pending",
  #   "remaining_requests": 1,
  #   "repository":         {
  #     "@type":            "repository",
  #     "@href":            "/repo/1",
  #     "@representation":  "minimal",
  #     "id":               1,
  #     "name":             "test",
  #     "slug":             "owner/repo"
  #   },
  #   "request":            {
  #     "repository":       {
  #       "id":             1,
  #       "owner_name":     "owner",
  #       "name":           "repo"
  #     },
  #     "user":             {
  #       "id":             1
  #     },
  #     "id":               1,
  #     "message":          "Override the commit message: this is an api request",
  #     "branch":           "master",
  #     "config":           { }
  #   },
  #   "resource_type":      "request"
  # }
  # ```
  #
  # POST <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/891/requests
  #
  # POST <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/rails%2Frails/requests
  #
  # @param attributes [Hash] request attributes
  # @return [Success, RequestError]
  def requests(**attributes)
    return get("#{with_repo}/requests") if attributes.empty?

    create("#{with_repo}/requests", 'request': attributes)
  end

  # A list of stages.
  #
  # Currently this is nested within a build.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     stages  [Stage]  List of stages.
  #
  # **Collection Items**
  #
  # Each entry in the stages array has the following attributes:
  #
  #     Name         Type     Description
  #     id           Integer  Value uniquely identifying the stage.
  #     number       Integer  Incremental number for a stage.
  #     name         String   The name of the stage.
  #     state        String   Current state of the stage.
  #     started_at   String   When the stage started.
  #     finished_at  String   When the stage finished.
  #     jobs         [Job]    The jobs of a stage.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of stages belonging to an individual build.
  #
  # GET <code>/build/{build.id}/stages</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/stages
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.stages(479_113_572)
  # ```
  #
  # @param build_id [String, Integer] build id
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def stages(build_id)
    validate_number build_id

    get("#{without_repo}/build/#{build_id}/stages")
  end

  # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #   Name   Type                Description
  #   name   String              The setting's name.
  #   value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single setting. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # **Update**
  #
  # This updates a single setting. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new setting:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "setting.value": true }' \
  #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests', false)
  # ```
  #
  # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # @param name [String] the setting name for the current repository
  # @param value [String] optional argument for setting a value for the setting name
  # @return [Success, RequestError]
  def setting(name, value = nil)
    return get("#{with_repo}/setting/#{name}") if value.nil?

    patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
  end

  # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     settings  [Setting]  List of settings.
  #
  # **Collection Items**
  #
  # Each entry in the settings array has the following attributes:
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/settings</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # GET <code>/repo/{repository.slug}/settings</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # @return [Success, RequestError]
  def settings
    get("#{with_repo}/settings")
  end

  # An individual user.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the user.
  #     login String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type     Description
  #     id                Integer  Value uniquely identifying the user.
  #     login             String   Login set on GitHub.
  #     name              String   Name set on GitHub.
  #     github_id         Integer  Id set on GitHub.
  #     avatar_url        String   Avatar URL set on GitHub.
  #     education         Boolean  Whether or not the user has an education account.
  #     allow_migration   Unknown  The user's allow_migration.
  #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
  #     synced_at         String   The last time the user was synced with GitHub.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this user.
  #     installation  Installation  Installation belonging to the user.
  #     emails        Unknown       The user's emails.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual user.
  #
  # GET <code>/user/{user.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.user(119_240)
  # ```
  #
  # **Sync**
  #
  # This triggers a sync on a user's account with their GitHub account.
  #
  # POST <code>/user/{user.id}/sync</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #
  #     Example: POST /user/119240/sync
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user(114_816, :sync)
  # ```
  #
  # **Current**
  #
  # This will return information about the current user.
  #
  # GET <code>/user</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user
  # ```
  #
  # @note sync feature may not be permitted
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] optional user id
  # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
  # @raise [TypeError] if given user id is not a number
  # @return [Success, RequestError]
  def user(user_id = nil, sync = false)
    return get("#{without_repo}/user") if !user_id && !sync

    validate_number user_id

    sync and return post("#{without_repo}/user/#{user_id}/sync")
    get("#{without_repo}/user/#{user_id}")
  end

  # @!endgroup

  private # @private

  def create(url, data = {})
    Trav3::REST.create(self, url, data)
  end

  def cron_keys(hash)
    inject_property_name('cron', hash)
  end

  def delete(url)
    Trav3::REST.delete(self, url)
  end

  def env_var_keys(hash)
    inject_property_name('env_var', hash)
  end

  def get(url, raw_reply = false)
    Trav3::REST.get(self, url, raw_reply)
  end

  def get_path(url)
    get("#{without_repo}#{url}")
  end

  def get_path_with_opts(url, without_limit = true)
    url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
    opts.immutable do |o|
      o.remove(:limit) if without_limit
      o.send(:update, opt)
      get_path("#{url}#{opts}")
    end
  end

  def initial_defaults
    defaults(limit: 25)
    h('Content-Type': 'application/json')
    h('Accept': 'application/json')
    h('Travis-API-Version': 3)
  end

  def inject_property_name(name, hash)
    raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
    return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)

    hash
  end

  def key_pair_keys(hash)
    inject_property_name('key_pair', hash)
  end

  def number?(input)
    /^\d+$/.match? input.to_s
  end

  def opts
    @options
  end

  def patch(url, data)
    Trav3::REST.patch(self, url, data)
  end

  def post(url, body = nil)
    Trav3::REST.post(self, url, body)
  end

  def validate_api_endpoint(input)
    raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
  end

  def validate_number(input)
    raise TypeError, "Integer expected, #{input.class} given" unless number? input
  end

  def validate_repo_format(input)
    raise InvalidRepository unless repo_slug_or_id? input
  end

  def validate_string(input)
    raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
  end

  def repo_slug_or_id?(input)
    Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
  end

  def repository_name
    @repo
  end

  def sanitize_repo_name(repo)
    repo.to_s.gsub(/\//, '%2F')
  end

  def username
    @repo[/.*?(?=(?:\/|%2F)|$)/]
  end

  def with_repo
    "#{api_endpoint}/repo/#{@repo}"
  end

  def without_repo
    api_endpoint
  end

  def without_limit
    limit = opts.remove(:limit)
    result = yield
    opts.build(limit: limit) if limit
    result
  end
end

Instance Method Details

#active(owner = username) ⇒ Success, RequestError

Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.

A list of all the builds in an “active” state, either created or started.

Attributes

Name    Type    Description
builds  Builds  The active builds.

Actions

For Owner

Returns a list of “active” builds for the owner.

GET /owner/{owner.login}/active

Template Variable  Type    Description
owner.login        String  User or organization login set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/danielpclark/active

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.active
# or
travis.active('danielpclark')

GET /owner/{user.login}/active

Template Variable  Type    Description
user.login         String  Login set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/danielpclark/active

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.active
# or
travis.active('danielpclark')

GET /owner/{organization.login}/active

Template Variable   Type    Description
organization.login  String  Login set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/travis-ci/active

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.active('travis-ci')

GET /owner/github_id/{owner.github_id}/active

Template Variable  Type     Description
owner.github_id    Integer  User or organization id set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/github_id/639823/active

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.active(639_823)

Parameters:

• owner (String) (defaults to: username) —

  username, organization name, or github id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 241

def active(owner = username)
  number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
  get("#{without_repo}/owner/#{owner}/active")
end

#authorization=(token) ⇒ Travis

Set the authorization token in the requests' headers

Parameters:

• token (String) —

  sets authorization token header

Returns:

• (Travis)

# File 'lib/trav3.rb', line 118

def authorization=(token)
  validate_string token
  h('Authorization': "token #{token}")
end

#beta_feature(action, beta_feature_id, user_id) ⇒ Success, RequestError

A beta feature (a Travis-CI feature currently in beta).

Attributes

Name          Type     Description
id            Integer  Value uniquely identifying the beta feature.
name          String   The name of the feature.
description   String   Longer description of the feature.
enabled       Boolean  Indicates if the user has this feature turned on.
feedback_url  String   Url for users to leave Travis CI feedback on this feature.

Actions

Update

This will update a user's beta_feature.

Use namespaced params in the request body to pass the enabled value (either true or false):

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{"beta_feature.enabled":true}' \
  https://api.travis-ci.com/user/1234/{beta_feature.id}

PATCH /user/{user.id}/beta_feature/{beta_feature.id}

Template Variable     Type     Description
user.id               Integer  Value uniquely identifying the user.
beta_feature.id       Integer  Value uniquely identifying the beta feature.
Accepted Parameter    Type     Description
beta_feature.id       Integer  Value uniquely identifying the beta feature.
beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'

# Enable comic-sans for user id 119240
travis.beta_feature(:enable, 3, 119_240)

# Disable comic-sans for user id 119240
travis.beta_feature(:disable, 3, 119_240)

Delete

This will delete a user's beta feature.

DELETE /user/{user.id}/beta_feature/{beta_feature.id}

Template Variable  Type     Description
user.id            Integer  Value uniquely identifying the user.
beta_feature.id    Integer  Value uniquely identifying the beta feature.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'

# Disable comic-sans via delete for user id 119240
travis.beta_feature(:delete, 3, 119_240)

Parameters:

• action (Symbol) —

  either :enable, :disable or :delete

• beta_feature_id (String, Integer) —

  id for the beta feature

• user_id (String) —

  user id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 320

def beta_feature(action, beta_feature_id, user_id)
  validate_number beta_feature_id
  validate_number user_id

  if action != :delete
    params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

    patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
  else
    delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
  end
end

#beta_features(user_id) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: travis-ci.com/features

Attributes

Name           Type            Description
beta_features  [Beta feature]  List of beta_features.

Actions

Find

This will return a list of beta features available to a user.

GET /user/{user.id}/beta_features

Template Variable  Type     Description
user.id            Integer  Value  uniquely identifying the user.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /user/119240/beta_features

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.beta_features(119_240)

Parameters:

• user_id (String, Integer) —

  user id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 365

def beta_features(user_id)
  validate_number user_id

  get("#{without_repo}/user/#{user_id}/beta_features")
end

#beta_migration_request(user_id) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

Request migration to beta

Attributes

Name           Type     Description
id             Unknown  The beta_migration_request's id.
owner_id       Unknown  The beta_migration_request's owner_id.
owner_name     Unknown  The beta_migration_request's owner_name.
owner_type     Unknown  The beta_migration_request's owner_type.
accepted_at    Unknown  The beta_migration_request's accepted_at.
organizations  Unknown  The beta_migration_request's organizations.

Actions

Create

Submits a request for beta migration

POST /user/{user.id}/beta_migration_request

Template Variable  Type     Description
user.id            Integer  Value uniquely identifying the user.
Accepted Parameter                    Type     Description
beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.

Example: POST /user/119240/beta_migration_request

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.beta_migration_request(119_240)

Parameters:

• user_id (String, Integer) —

  user id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 407

def beta_migration_request(user_id)
  create("#{without_repo}/user/#{user_id}/beta_migration_request")
end

#branch(name) ⇒ Success, RequestError

The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name  Type    Description
name  String  Name of the git branch.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name              Type        Description
name              String      Name of the git branch.
repository        Repository  GitHub user or organization the branch belongs to.
default_branch    Boolean     Whether or not this is the resposiotry's default branch.
exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
last_build        Build       Last build on the branch.

Additional Attributes

Name           Type     Description
recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).

Actions

Find

This will return information about an individual branch. The request can include either the repository id or slug.

GET /repo/{repository.id}/branch/{branch.name}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
branch.name        String   Name of the git branch.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891/branch/master

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.branch('master')

GET /repo/{repository.slug}/branch/{branch.name}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
branch.name        String  Name of the git branch.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails/branch/master

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.branch('master')

Parameters:

• name (String) —

  the branch name for the current repository

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 480

def branch(name)
  get("#{with_repo}/branch/#{name}")
end

#branches ⇒ Success, RequestError

A list of branches.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name      Type      Description
branches  [Branch]  List of branches.

Collection Items

Each entry in the branches array has the following attributes:

Name              Type        Description
name              String      Name of the git branch.
repository        Repository  GitHub user or organization the branch belongs to.
default_branch    Boolean     Whether or not this is the resposiotry's default branch.
exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
last_build        Build       Last build on the branch.
recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).

Actions

Find

This will return a list of branches a repository has on GitHub.

GET /repo/{repository.id}/branches

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter          Type       Description
branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
exists_on_github         [Boolean]  Alias for branch.exists_on_github.
include                  [String]   List of attributes to eager load.
limit                    Integer    How many branches to include in the response. Used for pagination.
offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
sort_by                  [String]   Attributes to sort branches by. Used for pagination.

Example: GET /repo/891/branches?limit=5&exists_on_github=true

Sortable by: name, last_build, exists_on_github, default_branch, append :desc to any attribute to reverse order. The default value is default_branch,exists_on_github,last_build:desc.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5, exists_on_github: true})
travis.branches

GET /repo/{repository.slug}/branches

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter          Type       Description
branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
exists_on_github         [Boolean]  Alias for branch.exists_on_github.
include                  [String]   List of attributes to eager load.
limit                    Integer    How many branches to include in the response. Used for pagination.
offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
sort_by                  [String]   Attributes to sort branches by. Used for pagination.

Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true

Sortable by: name, last_build, exists_on_github, default_branch, append :desc to any attribute to reverse order. The default value is default_branch,exists_on_github,last_build:desc.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5, exists_on_github: true})
travis.branches

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 560

def branches
  get("#{with_repo}/branches#{opts}")
end

#broadcasts ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

A list of broadcasts for the current user.

Attributes

Name        Type         Description
broadcasts  [Broadcast]  List of broadcasts.

Collection Items

Each entry in the broadcasts array has the following attributes:

Name        Type     Description
id          Integer  Value uniquely identifying the broadcast.
message     String   Message to display to the user.
created_at  String   When the broadcast was created.
category    String   Broadcast category (used for icon and color).
active      Boolean  Whether or not the brodacast should still be displayed.
recipient   Object   Either a user, organization or repository, or null for global.

Actions

For Current User

This will return a list of broadcasts for the current user.

GET /broadcasts

Query Parameter   Type       Description
active            [Boolean]  Alias for broadcast.active.
broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
include           [String]   List of attributes to eager load.

Example: GET /broadcasts

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.broadcasts

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 608

def broadcasts
  get("#{without_repo}/broadcasts")
end

#build(build_id, option = nil) ⇒ Success, RequestError

Note:

POST requests require an authorization token set in the headers. See: #authorization=

An individual build.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name                 Type     Description
id                   Integer  Value uniquely identifying the build.
number               String   Incremental number for a repository's builds.
state                String   Current state of the build.
duration             Integer  Wall clock time in seconds.
event_type           String   Event that triggered the build.
previous_state       String   State of the previous build (useful to see if state changed).
pull_request_title   String   Title of the build's pull request.
pull_request_number  Integer  Number of the build's pull request.
started_at           String   When the build started.
finished_at          String   When the build finished.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name                 Type        Description
id                   Integer     Value uniquely identifying the build.
number               String      Incremental number for a repository's builds.
state                String      Current state of the build.
duration             Integer     Wall clock time in seconds.
event_type           String      Event that triggered the build.
previous_state       String      State of the previous build (useful to see if state changed).
pull_request_title   String      Title of the build's pull request.
pull_request_number  Integer     Number of the build's pull request.
started_at           String      When the build started.
finished_at          String      When the build finished.
repository           Repository  GitHub user or organization the build belongs to.
branch               Branch      The branch the build is associated with.
tag                  Unknown     The build's tag.
commit               Commit      The commit the build is associated with.
jobs                 Jobs        List of jobs that are part of the build's matrix.
stages               [Stage]     The stages of a build.
created_by           Owner       The User or Organization that created the build.
updated_at           Unknown     The build's updated_at.

Actions

Find

This returns a single build.

GET /build/{build.id}

Template Variable  Type     Description
build.id           Integer  Value uniquely identifying the build.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /build/86601346

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.build(351_778_872)

Cancel

This cancels a currently running build. It will set the build and associated jobs to “state”: “canceled”.

POST /build/{build.id}/cancel

Template Variable  Type     Description
build.id           Integer  Value uniquely identifying the build.

Example: POST /build/86601346/cancel

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.build(478_772_528, :cancel)

Restart

This restarts a build that has completed or been canceled.

POST /build/{build.id}/restart

Template Variable  Type     Description
build.id           Integer  Value uniquely identifying the build.

Example: POST /build/86601346/restart

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.build(478_772_528, :restart)

Parameters:

• build_id (String, Integer) —

  the build id number

• option (Symbol) (defaults to: nil) —

  options for :cancel or :restart

Returns:

• (Success, RequestError)

Raises:

• (TypeError) —

  if given build id is not a number

# File 'lib/trav3.rb', line 720

def build(build_id, option = nil)
  validate_number build_id

  case option
  when :cancel
    post("#{without_repo}/build/#{build_id}/cancel")
  when :restart
    post("#{without_repo}/build/#{build_id}/restart")
  else
    get("#{without_repo}/build/#{build_id}")
  end
end

#build_jobs(build_id) ⇒ Success, RequestError

Note:

requests may require an authorization token set in the headers. See: #authorization=

A list of jobs.

Attributes

Name  Type  Description
jobs  [Job]  List of jobs.

Collection Items

Each entry in the jobs array has the following attributes:

Name           Type        Description
id             Integer     Value uniquely identifying the job.
allow_failure  Unknown     The job's allow_failure.
number         String      Incremental number for a repository's builds.
state          String      Current state of the job.
started_at     String      When the job started.
finished_at    String      When the job finished.
build          Build       The build the job is associated with.
queue          String      Worker queue this job is/was scheduled on.
repository     Repository  GitHub user or organization the job belongs to.
commit         Commit      The commit the job is associated with.
owner          Owner       GitHub user or organization the job belongs to.
stage          [Stage]     The stages of a job.
created_at     String      When the job was created.
updated_at     String      When the job was updated.
config         Object      The job's config.

Actions

Find

This returns a list of jobs belonging to an individual build.

GET /build/{build.id}/jobs

Template Variable  Type     Description
build.id           Integer  Value uniquely identifying the build.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /build/86601346/jobs

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.build_jobs(86_601_346)

For Current User

This returns a list of jobs a current user has access to.

GET /jobs

Query Parameter  Type      Description
active           Unknown   Alias for job.active.
created_by       Unknown   Alias for job.created_by.
include          [String]  List of attributes to eager load.
job.active       Unknown   Documentation missing.
job.created_by   Unknown   Documentation missing.
job.state        [String]  Filters jobs by current state of the job.
limit            Integer   How many jobs to include in the response. Used for pagination.
offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
sort_by          [String]  Attributes to sort jobs by. Used for pagination.
state            [String]  Alias for job.state.

Example: GET /jobs?limit=5

Sortable by: id, append :desc to any attribute to reverse order. The default value is id:desc.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.build_jobs(false)

Parameters:

• build_id (String, Integer, Boolean) —

  the build id number. If falsey then get all jobs for current user

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 951

def build_jobs(build_id)
  build_id and return get("#{without_repo}/build/#{build_id}/jobs")
  get("#{without_repo}/jobs#{opts}")
end

#builds(repo = true) ⇒ Success, RequestError

Note:

requests may require an authorization token set in the headers. See: #authorization=

A list of builds.

Attributes

Name    Type     Description
builds  [Build]  List of builds.

Collection Items

Each entry in the builds array has the following attributes:

Name                 Type        Description
id                   Integer     Value uniquely identifying the build.
number               String      Incremental number for a repository's builds.
state                String      Current state of the build.
duration             Integer     Wall clock time in seconds.
event_type           String      Event that triggered the build.
previous_state       String      State of the previous build (useful to see if state changed).
pull_request_title   String      Title of the build's pull request.
pull_request_number  Integer     Number of the build's pull request.
started_at           String      When the build started.
finished_at          String      When the build finished.
repository           Repository  GitHub user or organization the build belongs to.
branch               Branch      The branch the build is associated with.
tag                  Unknown     The build's tag.
commit               Commit      The commit the build is associated with.
jobs                 Jobs        List of jobs that are part of the build's matrix.
stages               [Stage]     The stages of a build.
created_by           Owner       The User or Organization that created the build.
updated_at           Unknown     The build's updated_at.
request              Unknown     The build's request.

Actions

For Current User

This returns a list of builds for the current user. The result is paginated.

GET /builds

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many builds to include in the response. Used for pagination.
offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
sort_by          [String]  Attributes to sort builds by. Used for pagination.

Example: GET /builds?limit=5

Sortable by: id, started_at, finished_at, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.builds(false)

Find

This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.

GET /repo/{repository.id}/builds

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Query Parameter       Type      Description
branch.name           [String]  Filters builds by name of the git branch.
build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
build.event_type      [String]  Filters builds by event that triggered the build.
build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
build.state           [String]  Filters builds by current state of the build.
created_by            [Owner]   Alias for build.created_by.
event_type            [String]  Alias for build.event_type.
include               [String]  List of attributes to eager load.
limit                 Integer   How many builds to include in the response. Used for pagination.
offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
previous_state        [String]  Alias for build.previous_state.
sort_by               [String]  Attributes to sort builds by. Used for pagination.
state                 [String]  Alias for build.state.

Example: GET /repo/891/builds?limit=5

Sortable by: id, started_at, finished_at, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5})
travis.builds

GET /repo/{repository.slug}/builds

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Query Parameter       Type      Description
branch.name           [String]  Filters builds by name of the git branch.
build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
build.event_type      [String]  Filters builds by event that triggered the build.
build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
build.state           [String]  Filters builds by current state of the build.
created_by            [Owner]   Alias for build.created_by.
event_type            [String]  Alias for build.event_type.
include               [String]  List of attributes to eager load.
limit                 Integer   How many builds to include in the response. Used for pagination.
offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
previous_state        [String]  Alias for build.previous_state.
sort_by               [String]  Attributes to sort builds by. Used for pagination.
state                 [String]  Alias for build.state.

Example: GET /repo/rails%2Frails/builds?limit=5

Sortable by: id, started_at, finished_at, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5})
travis.builds

Parameters:

• repo (Boolean) (defaults to: true) —

  If true get repo builds, otherwise get user builds

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 861

def builds(repo = true)
  repo and return get("#{with_repo}/builds#{opts}")
  get("#{without_repo}/builds#{opts}")
end

#caches(delete = false) ⇒ Success, RequestError

Note:

DELETE requests require an authorization token set in the headers. See: #authorization=

A list of caches.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name    Type    Description
branch  String  The branch the cache belongs to.
match   String  The string to match against the cache name.

Actions

Find

This returns all the caches for a repository.

It's possible to filter by branch or by regexp match of a string to the cache name.

curl \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  https://api.travis-ci.com/repo/1234/caches?branch=master

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({branch: :master})
travis.caches

curl \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  https://api.travis-ci.com/repo/1234/caches?match=linux

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({match: :linux})
travis.caches

GET /repo/{repository.id}/caches

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
branch           [String]  Alias for caches.branch.
caches.branch    [String]  Filters caches by the branch the cache belongs to.
caches.match     [String]  Filters caches by the string to match against the cache name.
include          [String]  List of attributes to eager load.
match            [String]  Alias for caches.match.

Example: GET /repo/891/caches

GET /repo/{repository.slug}/caches

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
branch           [String]  Alias for caches.branch.
caches.branch    [String]  Filters caches by the branch the cache belongs to.
caches.match     [String]  Filters caches by the string to match against the cache name.
include          [String]  List of attributes to eager load.
match            [String]  Alias for caches.match.

Example: GET /repo/rails%2Frails/caches

Delete

This deletes all caches for a repository.

As with find it's possible to delete by branch or by regexp match of a string to the cache name.

curl -X DELETE \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  https://api.travis-ci.com/repo/1234/caches?branch=master

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({branch: :master})
travis.caches(:delete)

DELETE /repo/{repository.id}/caches

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: DELETE /repo/891/caches

DELETE /repo/{repository.slug}/caches

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: DELETE /repo/rails%2Frails/caches

Parameters:

• delete (Boolean) (defaults to: false) —

  option for deleting cache(s)

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1072

def caches(delete = false)
  without_limit do
    :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
    get("#{with_repo}/caches#{opts}")
  end
end

#cron(id: nil, branch_name: nil, create: nil, delete: false) ⇒ Success, RequestError

An individual cron. There can be only one cron per branch on a repository.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name  Type     Description
id    Integer  Value uniquely identifying the cron.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name                             Type        Description
id                               Integer     Value uniquely identifying the cron.
repository                       Repository  Github repository to which this cron belongs.
branch                           Branch      Git branch of repository to which this cron belongs.
interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
last_run                         String      When the cron ran last.
next_run                         String      When the cron is scheduled to run next.
created_at                       String      When the cron was created.
active                           Unknown     The cron's active.

Actions

Find

This returns a single cron.

GET /cron/{cron.id}

Template Variable  Type     Description
cron.id            Integer  Value uniquely identifying the cron.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.cron(id: 78_199)

Delete

This deletes a single cron.

DELETE /cron/{cron.id}

Template Variable  Type     Description
cron.id            Integer  Value uniquely identifying the cron.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.cron(id: 78_199, delete: true)

For Branch

This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.

GET /repo/{repository.id}/branch/{branch.name}/cron

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
branch.name        String   Name of the git branch.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891/branch/master/cron

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.cron(branch_name: 'master')

GET /repo/{repository.slug}/branch/{branch.name}/cron

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
branch.name        String  Name of the git branch.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails/branch/master/cron

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.cron(branch_name: 'master')

Create

This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "cron.interval": "monthly" }' \
  https://api.travis-ci.com/repo/1234/branch/master/cron

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })

POST /repo/{repository.id}/branch/{branch.name}/cron

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
branch.name        String   Name of the git branch.
Accepted Parameter                    Type     Description
cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.

Example: POST /repo/891/branch/master/cron

POST /repo/{repository.slug}/branch/{branch.name}/cron

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
branch.name        String  Name of the git branch.
Accepted Parameter                    Type     Description
cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.

Example: POST /repo/rails%2Frails/branch/master/cron

Parameters:

• id (String, Integer) —

  cron id to get or delete

• branch_name (String) —

  branch name to get cron or create

• create (Hash) —

  Properties for creating the cron. branch_name keyword argument required and interval key/value required.

• delete (Boolean) —

  option for deleting cron. Cron id keyword argument required.

Returns:

• (Success, RequestError)

Raises:

• (ArgumentError)

# File 'lib/trav3.rb', line 1228

def cron(id: nil, branch_name: nil, create: nil, delete: false)
  if id
    validate_number id

    delete and return delete("#{without_repo}/cron/#{id}")
    return get("#{without_repo}/cron/#{id}")
  end
  raise ArgumentError, 'id or branch_name required' unless branch_name

  create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
  get("#{with_repo}/branch/#{branch_name}/cron")
end

#crons ⇒ Success, RequestError

A list of crons.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name   Type    Description
crons  [Cron]  List of crons.

Collection Items

Each entry in the crons array has the following attributes:

Name                             Type        Description
id                               Integer     Value uniquely identifying the cron.
repository                       Repository  Github repository to which this cron belongs.
branch                           Branch      Git branch of repository to which this cron belongs.
interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
last_run                         String      When the cron ran last.
next_run                         String      When the cron is scheduled to run next.
created_at                       String      When the cron was created.
active                           Unknown     The cron's active.

Actions

For Repository

This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.

GET /repo/{repository.id}/crons

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many crons to include in the response. Used for pagination.
offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.

Example: GET /repo/891/crons?limit=5

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.crons

GET /repo/{repository.slug}/crons

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many crons to include in the response. Used for pagination.
offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.

Example: GET /repo/rails%2Frails/crons?limit=5

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.crons

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1310

def crons
  get("#{with_repo}/crons#{opts}")
end

#defaults(key: value, ...) ⇒ Travis

Set as many options as you'd like for collections queried via an API request

Parameters:

• key (Symbol) —

  name for value to set

• value (Symbol, String, Integer) —

  value for key

Returns:

• (Travis)

# File 'lib/trav3.rb', line 129

def defaults(**args)
  (@options ||= Options.new).build(args)
  self
end

#email_resubscribe ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

POST /repo/{repository.id}/email_subscription

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: POST /repo/891/email_subscription

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.email_resubscribe

POST /repo/{repository.slug}/email_subscription

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: POST /repo/rails%2Frails/email_subscription

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.email_resubscribe

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1345

def email_resubscribe
  post("#{with_repo}/email_subscription")
end

#email_unsubscribe ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

DELETE /repo/{repository.id}/email_subscription

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: DELETE /repo/891/email_subscription

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.email_unsubscribe

DELETE /repo/{repository.slug}/email_subscription

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: DELETE /repo/rails%2Frails/email_subscription

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.email_unsubscribe

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1380

def email_unsubscribe
  delete("#{with_repo}/email_subscription")
end

#env_var(env_var_id) ⇒ Success, RequestError #env_var(env_var_id, action: params) ⇒ Success, RequestError

An individual environment variable.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name    Type     Description
id      String   The environment variable id.
name    String   The environment variable name, e.g. FOO.
value   String   The environment variable's value, e.g. bar.
public  Boolean  Whether this environment variable should be publicly visible or not.

Minimal Representation

Included when the resource is returned as part of another resource.

Name    Type     Description
id      String   The environment variable id.
name    String   The environment variable name, e.g. FOO.
public  Boolean  Whether this environment variable should be publicly visible or not.

Actions

Find

This returns a single environment variable. It is possible to use the repository id or slug in the request.

GET /repo/{repository.id}/env_var/{env_var.id}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
env_var.id         String   The environment variable id.
Query Parameter  Type      Description
env_var.id       String    The environment variable id.
id               String    Alias for env_var.id.
include          [String]  List of attributes to eager load.
repository.id    Integer   Value uniquely identifying the repository.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')

GET /repo/{repository.slug}/env_var/{env_var.id}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
env_var.id         String  The environment variable id.
Query Parameter  Type      Description
env_var.id       String    The environment variable id.
id               String    Alias for env_var.id.
include          [String]  List of attributes to eager load.
repository.id    Integer   Value uniquely identifying the repository.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')

Update

This updates a single environment variable. It is possible to use the repository id or slug in the request.

Use namespaced params in the request body to pass the new environment variable:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "env_var.value": "bar", "env_var.public": false }' \
  https://api.travis-ci.com/repo/1234/{env_var.id}

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })

PATCH /repo/{repository.id}/env_var/{env_var.id}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
env_var.id         String   The environment variable id.
Accepted Parameter  Type     Description
env_var.name        String   The environment variable name, e.g. FOO.
env_var.value       String   The environment variable's value, e.g. bar.
env_var.public      Boolean  Whether this environment variable should be publicly visible or not.

PATCH /repo/{repository.slug}/env_var/{env_var.id}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
env_var.id         String  The environment variable id.
Accepted Parameter  Type     Description
env_var.name        String   The environment variable name, e.g. FOO.
env_var.value       String   The environment variable's value, e.g. bar.
env_var.public      Boolean  Whether this environment variable should be publicly visible or not.

Delete

This deletes a single environment variable. It is possible to use the repository id or slug in the request.

DELETE /repo/{repository.id}/env_var/{env_var.id}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
env_var.id         String   The environment variable id.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)

DELETE /repo/{repository.slug}/env_var/{env_var.id}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
env_var.id         String  The environment variable id.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)

Overloads:

• #env_var(env_var_id) ⇒ Success, RequestError

  Gets current env var

  Parameters:

  • env_var_id (String) —

    environment variable id

• #env_var(env_var_id, action: params) ⇒ Success, RequestError

  Performs action per specific key word argument

  Parameters:

  • env_var_id (String) —

    environment variable id

  • update (Hash) —

    Optional keyword argument. Update key pair with hash { value: "new value" }

  • delete (Boolean) —

    Optional keyword argument. Use truthy value to delete current key pair

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1532

def env_var(env_var_id, update: nil, delete: nil)
  raise 'Too many options specified' unless [update, delete].compact.count < 2

  validate_string env_var_id

  update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
  delete and return delete("#{with_repo}/env_var/#{env_var_id}")
  get("#{with_repo}/env_var/#{env_var_id}")
end

#env_vars(create = nil) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

A list of environment variables.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name      Type       Description
env_vars  [Env var]  List of env_vars.

Actions

For Repository

This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.

GET /repo/{repository.id}/env_vars

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891/env_vars

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_vars

GET /repo/{repository.slug}/env_vars

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails/env_vars

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_vars

Create

This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.

Use namespaced params in the request body to pass the new environment variables:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  https://api.travis-ci.com/repo/1234/env_vars

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.env_vars(name: 'FOO', value: 'bar', public: false)

POST /repo/{repository.id}/env_vars

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Accepted Parameter  Type     Description
env_var.name        String   The environment variable name, e.g. FOO.
env_var.value       String   The environment variable's value, e.g. bar.
env_var.public      Boolean  Whether this environment variable should be publicly visible or not.

Example: POST /repo/891/env_vars

POST /repo/{repository.slug}/env_vars

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Accepted Parameter  Type     Description
env_var.name        String   The environment variable name, e.g. FOO.
env_var.value       String   The environment variable's value, e.g. bar.
env_var.public      Boolean  Whether this environment variable should be publicly visible or not.

Example: POST /repo/rails%2Frails/env_vars

Parameters:

• create (Hash) (defaults to: nil) —

  Optional argument. A hash of the name, value, and public visibleness for a env var to create

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1637

def env_vars(create = nil)
  create and return create("#{with_repo}/env_vars", env_var_keys(create))
  get("#{with_repo}/env_vars")
end

#h(key: value, ...) ⇒ Travis

Set as many headers as you'd like for API requests

h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")

Parameters:

• key (Symbol) —

  name for value to set

• value (Symbol, String, Integer) —

  value for key

Returns:

• (Travis)

# File 'lib/trav3.rb', line 142

def h(**args)
  (@headers ||= Headers.new).build(args)
  self
end

#installation(installation_id) ⇒ Success, RequestError

A GitHub App installation.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name       Type     Description
id         Integer  The installation id.
github_id  Integer  The installation's id on GitHub.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name       Type     Description
id         Integer  The installation id.
github_id  Integer  The installation's id on GitHub.
owner      Owner    GitHub user or organization the installation belongs to.

Actions

Find

This returns a single installation.

GET /installation/{installation.github_id}

Template Variable       Type     Description
installation.github_id  Integer  The installation's id on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.installation(617_754)

Parameters:

• installation_id (String, Integer) —

  GitHub App installation id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1686

def installation(installation_id)
  validate_number installation_id

  get("#{without_repo}/installation/#{installation_id}")
end

#job(job_id, option = nil) ⇒ Success, RequestError

Note:

POST requests require an authorization token set in the headers. See: #authorization=

Note:

Debug is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.

An individual job.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name  Type     Description
id    Integer  Value uniquely identifying the job.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name           Type        Description
id             Integer     Value uniquely identifying the job.
allow_failure  Unknown     The job's allow_failure.
number         String      Incremental number for a repository's builds.
state          String      Current state of the job.
started_at     String      When the job started.
finished_at    String      When the job finished.
build          Build       The build the job is associated with.
queue          String      Worker queue this job is/was scheduled on.
repository     Repository  GitHub user or organization the job belongs to.
commit         Commit      The commit the job is associated with.
owner          Owner       GitHub user or organization the job belongs to.
stage          [Stage]     The stages of a job.
created_at     String      When the job was created.
updated_at     String      When the job was updated.

Actions

Find

This returns a single job.

GET /job/{job.id}

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /job/86601347

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.job(351_778_875)

Cancel

This cancels a currently running job.

POST /job/{job.id}/cancel

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Example: POST /job/86601347/cancel

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.job(351_778_875, :cancel)

Restart

This restarts a job that has completed or been canceled.

POST /job/{job.id}/restart

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Example: POST /job/86601347/restart

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.job(351_778_875, :restart)

Debug

This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.

POST /job/{job.id}/debug

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Example: POST /job/86601347/debug

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.job(351_778_875, :debug)

Parameters:

• job_id (String, Integer) —

  the job id number

• option (Symbol) (defaults to: nil) —

  options for :cancel, :restart, or :debug

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 1807

def job(job_id, option = nil)
  case option
  when :cancel
    post("#{without_repo}/job/#{job_id}/cancel")
  when :restart
    post("#{without_repo}/job/#{job_id}/restart")
  when :debug
    post("#{without_repo}/job/#{job_id}/debug")
  else
    get("#{without_repo}/job/#{job_id}")
  end
end

#key_pair ⇒ Success, RequestError #key_pair(action: params) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

Note:

API enpoint needs to be set to https://api.travis-ci.com See: #api_endpoint=

Users may add a public/private RSA key pair to a repository. This can be used within builds, for example to access third-party services or deploy code to production. Please note this feature is only available on the travis-ci.com domain.

Attributes

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name         Type    Description
description  String  A text description.
public_key   String  The public key.
fingerprint  String  The fingerprint.

Minimal Representation

Included when the resource is returned as part of another resource.

Name         Type    Description
description  String  A text description.
public_key   String  The public key.
fingerprint  String  The fingerprint.

Actions

Find

Return the current key pair, if it exists.

GET /repo/{repository.id}/key_pair

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891/key_pair

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair

GET /repo/{repository.slug}/key_pair

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails/key_pair

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair

Create

Creates a new key pair.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  https://api.travis-ci.com/repo/1234/key_pair

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })

POST /repo/{repository.id}/key_pair

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Accepted Parameter    Type    Description
key_pair.description  String  A text description.
key_pair.value        String  The private key.

Example: POST /repo/891/key_pair

POST /repo/{repository.slug}/key_pair

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Accepted Parameter    Type    Description
key_pair.description  String  A text description.
key_pair.value        String  The private key.

Example: POST /repo/rails%2Frails/key_pair

Update

Update the key pair.

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "key_pair.description": "FooBarBaz" }' \
  https://api.travis-ci.com/repo/1234/key_pair

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair(update: { description: 'FooBarBaz' })

PATCH /repo/{repository.id}/key_pair

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Accepted Parameter    Type    Description
key_pair.description  String  A text description.
key_pair.value        String  The private key.

Example: PATCH /repo/891/key_pair

PATCH /repo/{repository.slug}/key_pair

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Accepted Parameter    Type    Description
key_pair.description  String  A text description.
key_pair.value        String  The private key.

Example: PATCH /repo/rails%2Frails/key_pair

Delete

Delete the key pair.

DELETE /repo/{repository.id}/key_pair

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: DELETE /repo/891/key_pair

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair(delete: true)

DELETE /repo/{repository.slug}/key_pair

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: DELETE /repo/rails%2Frails/key_pair

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair(delete: true)

Overloads:

• #key_pair ⇒ Success, RequestError

  Gets current key_pair if any
• #key_pair(action: params) ⇒ Success, RequestError

  Performs action per specific key word argument

  Parameters:

  • create (Hash) —

    Optional keyword argument. Create a new key pair from provided private key { description: "name", value: "private key" }

  • update (Hash) —

    Optional keyword argument. Update key pair with hash { description: "new name" }

  • delete (Boolean) —

    Optional keyword argument. Use truthy value to delete current key pair

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2011

def key_pair(create: nil, update: nil, delete: nil)
  raise 'Too many options specified' unless [create, update, delete].compact.count < 2

  create and return create("#{with_repo}/key_pair", key_pair_keys(create))
  update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
  delete and return delete("#{with_repo}/key_pair")
  get("#{with_repo}/key_pair")
end

#key_pair_generated(action = :get) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.

Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.

Attributes

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name         Type    Description
description  String  A text description.
public_key   String  The public key.
fingerprint  String  The fingerprint.

Minimal Representation

Included when the resource is returned as part of another resource.

Name         Type    Description
description  String  A text description.
public_key   String  The public key.
fingerprint  String  The fingerprint.

Actions

Find

Return the current key pair.

GET /repo/{repository.id}/key_pair/generated

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891/key_pair/generated

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair_generated

GET /repo/{repository.slug}/key_pair/generated

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails/key_pair/generated

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair_generated

Create

Generate a new key pair, replacing the previous one.

POST /repo/{repository.id}/key_pair/generated

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: POST /repo/891/key_pair/generated

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair_generated(:create)

POST /repo/{repository.slug}/key_pair/generated

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: POST /repo/rails%2Frails/key_pair/generated

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.api_endpoint = 'https://api.travis-ci.com'
travis.authorization = 'xxxx'
travis.key_pair_generated(:create)

Parameters:

• action (String, Symbol) (defaults to: :get) —

  defaults to getting current key pair, use :create if you would like to generate a new key pair

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2122

def key_pair_generated(action = :get)
  return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

  get("#{with_repo}/key_pair/generated")
end

#lint(yaml_content) ⇒ Success, RequestError

This validates the .travis.yml file and returns any warnings.

The request body can contain the content of the .travis.yml file directly as a string, eg “foo: bar”.

Attributes

Name      Type   Description
warnings  Array  An array of hashes with keys and warnings.

Actions

Lint

POST /lint

Example: POST /lint

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.lint(File.read('.travis.yml'))

Parameters:

• yaml_content (String) —

  the contents for the file .travis.yml

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2153

def lint(yaml_content)
  validate_string yaml_content

  ct = headers.remove(:'Content-Type')
  result = post("#{without_repo}/lint", yaml_content)
  h('Content-Type': ct) if ct
  result
end

#log(job_id, option = nil) ⇒ Success, ...

An individual log.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name  Type     Description
id    Unknown  The log's id.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name       Type     Description
id         Unknown  The log's id.
content    Unknown  The log's content.
log_parts  Unknown  The log's log_parts.

Actions

Find

This returns a single log.

It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.

curl -H "Travis-API-Version: 3" \
  -H "Accept: text/plain" \
  -H "Authorization: token xxxxxxxxxxxx" \
  https://api.travis-ci.org/job/{job.id}/log

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.log(351_778_875)
# or
travis.log(351_778_875, :text)

The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see developer.travis-ci.org/format).

GET /job/{job.id}/log

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
log.token        Unknown   Documentation missing.

Example: GET /job/86601347/log

GET /job/{job.id}/log.txt

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
log.token        Unknown   Documentation missing.

Example: GET /job/86601347/log.txt

Delete

This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.

curl -X DELETE \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  https://api.travis-ci.org/job/{job.id}/log

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.log(478_772_530, :delete)

DELETE /job/{job.id}/log

Template Variable  Type     Description
job.id             Integer  Value uniquely identifying the job.

Example: DELETE /job/86601347/log

Parameters:

• job_id (String, Integer) —

  the job id number

• option (Symbol) (defaults to: nil) —

  options for :text or :delete

Returns:

• (Success, String, RequestError)

# File 'lib/trav3.rb', line 2253

def log(job_id, option = nil)
  case option
  when :text
    get("#{without_repo}/job/#{job_id}/log.txt", true)
  when :delete
    delete("#{without_repo}/job/#{job_id}/log")
  else
    get("#{without_repo}/job/#{job_id}/log")
  end
end

#messages(request_id) ⇒ Success, RequestError

A list of messages. Messages belong to resource types.

Attributes

Name      Type       Description
messages  [Message]  List of messages.

Collection Items

Each entry in the messages array has the following attributes:

Name   Type     Description
id     Integer  The message's id.
level  String   The message's level.
key    String   The message's key.
code   String   The message's code.
args   Json     The message's args.

Actions

For Request

This will return a list of messages created by travis-yml for a request, if any exist.

GET /repo/{repository.id}/request/{request.id}/messages

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
request.id         Integer  Value uniquely identifying the request.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many messages to include in the response. Used for pagination.
offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.messages(147_731_561)

GET /repo/{repository.slug}/request/{request.id}/messages

Template Variable  Type     Description
repository.slug    String   Same as {repository.owner.name}/{repository.name}.
request.id         Integer  Value uniquely identifying the request.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many messages to include in the response. Used for pagination.
offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.messages(147_731_561)

Parameters:

• request_id (String, Integer) —

  the request id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2324

def messages(request_id)
  validate_number request_id

  get("#{with_repo}/request/#{request_id}/messages")
end

#organization(org_id) ⇒ Success, RequestError

An individual organization.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name   Type     Description
id     Integer  Value uniquely identifying the organization.
login  String   Login set on GitHub.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name             Type     Description
id               Integer  Value uniquely identifying the organization.
login            String   Login set on GitHub.
name             String   Name set on GitHub.
github_id        Integer  Id set on GitHub.
avatar_url       String   Avatar_url set on GitHub.
education        Boolean  Whether or not the organization has an education account.
allow_migration  Unknown  The organization's allow_migration.

Additional Attributes

Name          Type          Description
repositories  [Repository]  Repositories belonging to this organization.
installation  Installation  Installation belonging to the organization.

Actions

Find

This returns an individual organization.

GET /org/{organization.id}

Template Variable  Type      Description
organization.id    Integer   Value uniquely identifying the organization.
Query Parameter    Type      Description
include            [String]  List of attributes to eager load.

Example: GET /org/87

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.organization(87)

Parameters:

• org_id (String, Integer) —

  the organization id

Returns:

• (Success, RequestError)

Raises:

• (TypeError) —

  if given organization id is not a number

# File 'lib/trav3.rb', line 2385

def organization(org_id)
  validate_number org_id

  get("#{without_repo}/org/#{org_id}")
end

#organizations ⇒ Success, RequestError

A list of organizations for the current user.

Attributes

Name           Type            Description
organizations  [Organization]  List of organizations.

Collection Items

Each entry in the organizations array has the following attributes:

Name             Type          Description
id               Integer       Value uniquely identifying the organization.
login            String        Login set on GitHub.
name             String        Name set on GitHub.
github_id        Integer       Id set on GitHub.
avatar_url       String        Avatar_url set on GitHub.
education        Boolean       Whether or not the organization has an education account.
allow_migration  Unknown       The organization's allow_migration.
repositories     [Repository]  Repositories belonging to this organization.
installation     Installation  Installation belonging to the organization.

Actions

For Current User

This returns a list of organizations the current user is a member of.

GET /orgs

Query Parameter    Type      Description
include            [String]  List of attributes to eager load.
limit              Integer   How many organizations to include in the response. Used for pagination.
offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
organization.role  Unknown   Documentation missing.
role               Unknown   Alias for organization.role.
sort_by            [String]  Attributes to sort organizations by. Used for pagination.

Example: GET /orgs?limit=5

Sortable by: id, login, name, github_id, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.organizations

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2442

def organizations
  get("#{without_repo}/orgs#{opts}")
end

#owner(owner = username) ⇒ Success, RequestError

This will be either a user or organization.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name    Type     Description
id      Integer  Value uniquely identifying the owner.
login   String   User or organization login set on GitHub.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name        Type     Description
id          Integer  Value uniquely identifying the owner.
login       String   User or organization login set on GitHub.
name        String   User or organization name set on GitHub.
github_id   Integer  User or organization id set on GitHub.
avatar_url  String   Link to user or organization avatar (image) set on GitHub.

Additional Attributes

Name           Type           Description
repositories   [Repository]   Repositories belonging to this account.

Actions

Find

This returns an individual owner. It is possible to use the GitHub login or github_id in the request.

GET /owner/{owner.login}

Template Variable  Type      Description
owner.login        String    User or organization login set on GitHub.

Query Parameter    Type      Description
include            [String]  List of attributes to eager load.

Example: GET /owner/danielpclark

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.owner
# or
travis.owner('danielpclark')

GET /owner/{user.login}

Template Variable  Type      Description
user.login         String    Login set on GitHub.

Query Parameter    Type      Description
include            [String]  List of attributes to eager load.

Example: GET /owner/danielpclark

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.owner
# or
travis.owner('danielpclark')

GET /owner/{organization.login}

Template Variable   Type      Description
organization.login  String    Login set on GitHub.

Query Parameter     Type      Description
include             [String]  List of attributes to eager load.

Example: GET /owner/travis-ci

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.owner('travis-ci')

GET /owner/github_id/{owner.github_id}

Template Variable   Type      Description
owner.github_id     Integer   User or organization id set on GitHub.

Query Parameter     Type      Description
include             [String]  List of attributes to eager load.

Example: GET /owner/github_id/639823

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.owner(639_823)

Parameters:

• owner (String) (defaults to: username) —

  username or github id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2554

def owner(owner = username)
  number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
  get("#{without_repo}/owner/#{owner}")
end

#preference(key, value = nil, org_id: nil) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

Individual preferences for current user or organization.

Attributes

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name   Type     Description
name   Unknown  The preference's name.
value  Unknown  The preference's value.

Minimal Representation

Included when the resource is returned as part of another resource.

Name   Type     Description
name   Unknown  The preference's name.
value  Unknown  The preference's value.

Actions

For Organization

Get preference for organization.

GET /org/{organization.id}/preference/{preference.name}

Template Variable  Type     Description
organization.id    Integer  Value uniquely identifying the organization.
preference.name    Unknown  The preference's name.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.preference('private_insights_visibility', org_id: 107_660)

Update

Set preference for organization.

PATCH /org/{organization.id}/preference/{preference.name}

Template Variable  Type     Description
organization.id    Integer  Value uniquely identifying the organization.
preference.name    Unknown  The preference's name.
Accepted Parameter  Type     Description
preference.value    Unknown  The preference's value.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.preference('private_insights_visibility', 'admins', org_id: 107_660)

Set preference for current user.

PATCH /preference/{preference.name}

Template Variable  Type     Description
preference.name    Unknown  The preference's name.
Accepted Parameter  Type     Description
preference.value    Unknown  The preference's value.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.preference('build_emails', true)

Find

Get preference for current user.

GET /preference/{preference.name}

Template Variable  Type     Description
preference.name    Unknown  The preference's name.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.preference('build_emails')

Parameters:

• key (String) —

  preference name to get or set

• value (String) (defaults to: nil) —

  optional value to set preference

• org_id (String, Integer) —

  optional keyword argument for an organization id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2659

def preference(key, value = nil, org_id: nil)
  if org_id
    validate_number org_id
    org_id = "/org/#{org_id}"
  end

  value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
  get("#{without_repo}#{org_id}/preference/#{key}")
end

#preferences(org_id = nil) ⇒ Success, RequestError

Note:

requests require an authorization token set in the headers. See: #authorization=

Preferences for current user or organization.

Attributes

Name         Type         Description
preferences  [Preferenc]  List of preferences.

Actions

For Organization

Gets preferences for organization.

GET /org/{organization.id}/preferences

Template Variable  Type     Description
organization.id    Integer  Value uniquely identifying the organization.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /org/87/preferences

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.preferences(107_660)

For User

Gets preferences for current user.

GET /preferences

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /preferences

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.preferences

Parameters:

• org_id (String, Integer) (defaults to: nil) —

  optional organization id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2720

def preferences(org_id = nil)
  if org_id
    validate_number org_id
    org_id = "/org/#{org_id}"
  end

  get("#{without_repo}#{org_id}/preferences")
end

#repositories(owner = username) ⇒ Success, RequestError

A list of repositories for the current user.

Attributes

Name           Type           Description
repositories   [Repository]   List of repositories.

Collection Items

Each entry in the repositories array has the following attributes:

Name                Type     Description
id                  Integer  Value uniquely identifying the repository.
name                String   The repository's name on GitHub.
slug                String   Same as {repository.owner.name}/{repository.name}.
description         String   The repository's description from GitHub.
github_language     String   The main programming language used according to GitHub.
active              Boolean  Whether or not this repository is currently enabled on Travis CI.
private             Boolean  Whether or not this repository is private.
owner               Owner    GitHub user or organization the repository belongs to.
default_branch      Branch   The default branch on GitHub.
starred             Boolean  Whether or not this repository is starred.
current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
last_started_build  Build    Alias for current_build.

Actions

For Owner

This returns a list of repositories an owner has access to.

GET /owner/{owner.login}/repos

Template Variable  Type    Description
owner.login        String  User or organization login set on GitHub.

Query Parameter     Type       Description
active              [Boolean]  Alias for repository.active.
include             [String]   List of attributes to eager load.
limit               Integer    How many repositories to include in the response. Used for pagination.
offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
private             [Boolean]  Alias for repository.private.
repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
sort_by             [String]   Attributes to sort repositories by. Used for pagination.
starred             [Boolean]  Alias for repository.starred.

Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name

Sortable by: id, github_id, owner_name, name, active, default_branch.last_build, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5, sort_by: 'active,name'})
travis.repositories
# or
travis.repositories('danielpclark')

GET /owner/{user.login}/repos

Template Variable  Type    Description
user.login         String  Login set on GitHub.

Query Parameter     Type       Description
active              [Boolean]  Alias for repository.active.
include             [String]   List of attributes to eager load.
limit               Integer    How many repositories to include in the response. Used for pagination.
offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
private             [Boolean]  Alias for repository.private.
repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
sort_by             [String]   Attributes to sort repositories by. Used for pagination.
starred             [Boolean]  Alias for repository.starred.

Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name

Sortable by: id, github_id, owner_name, name, active, default_branch.last_build, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5, sort_by: 'active,name'})
travis.repositories
# or
travis.repositories('danielpclark')

GET /owner/{organization.login}/repos

Template Variable   Type    Description
organization.login  String  Login set on GitHub.

Query Parameter     Type       Description
active              [Boolean]  Alias for repository.active.
include             [String]   List of attributes to eager load.
limit               Integer    How many repositories to include in the response. Used for pagination.
offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
private             [Boolean]  Alias for repository.private.
repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
sort_by             [String]   Attributes to sort repositories by. Used for pagination.
starred             [Boolean]  Alias for repository.starred.

Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name

Sortable by: id, github_id, owner_name, name, active, default_branch.last_build, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5, sort_by: 'active,name'})
travis.repositories('travis-ci')

GET /owner/github_id/{owner.github_id}/repos

Template Variable  Type     Description
owner.github_id    Integer  User or organization id set on GitHub.

Query Parameter     Type       Description
active              [Boolean]  Alias for repository.active.
include             [String]   List of attributes to eager load.
limit               Integer    How many repositories to include in the response. Used for pagination.
offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
private             [Boolean]  Alias for repository.private.
repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
sort_by             [String]   Attributes to sort repositories by. Used for pagination.
starred             [Boolean]  Alias for repository.starred.

Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name

Sortable by: id, github_id, owner_name, name, active, default_branch.last_build, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.options.build({limit: 5, sort_by: 'active,name'})
travis.repositories(639_823)

For Current User

This returns a list of repositories the current user has access to.

GET /repos

Query Parameter     Type       Description
active              [Boolean]  Alias for repository.active.
include             [String]   List of attributes to eager load.
limit               Integer    How many repositories to include in the response. Used for pagination.
offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
private             [Boolean]  Alias for repository.private.
repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
sort_by             [String]   Attributes to sort repositories by. Used for pagination.
starred             [Boolean]  Alias for repository.starred.

Example: GET /repos?limit=5&sort_by=active,name

Sortable by: id, github_id, owner_name, name, active, default_branch.last_build, append :desc to any attribute to reverse order.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5, sort_by: 'active,name'})
travis.repositories(:self)

Parameters:

• owner (String, Integer, Symbol) (defaults to: username) —

  username, github id, or :self

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 2909

def repositories(owner = username)
  owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
  number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
  get("#{without_repo}/owner/#{owner}/repos#{opts}")
end

#repository(repo = repository_name, action = nil) ⇒ Success, RequestError

Note:

POST requests require an authorization token set in the headers. See: #authorization=

An individual repository.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name   Type     Description
id     Integer  Value uniquely identifying the repository.
name   String   The repository's name on GitHub.
slug   String   Same as {repository.owner.name}/{repository.name}.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name             Type     Description
id               Integer  Value uniquely identifying the repository.
name             String   The repository's name on GitHub.
slug             String   Same as {repository.owner.name}/{repository.name}.
description      String   The repository's description from GitHub.
github_language  String   The main programming language used according to GitHub.
active           Boolean  Whether or not this repository is currently enabled on Travis CI.
private          Boolean  Whether or not this repository is private.
owner            Owner    GitHub user or organization the repository belongs to.
default_branch   Branch   The default branch on GitHub.
starred          Boolean  Whether or not this repository is starred.

Actions

Find

This returns an individual repository.

GET /repo/{repository.id}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.repository('danielpclark/trav3')

GET /repo/{repository.slug}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.repository('danielpclark/trav3')

Activate

This will activate a repository, allowing its tests to be run on Travis CI.

POST /repo/{repository.id}/activate

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: POST /repo/891/activate

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :activate)

POST /repo/{repository.slug}/activate

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: POST /repo/rails%2Frails/activate

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :activate)

Deactivate

This will deactivate a repository, preventing any tests from running on Travis CI.

POST /repo/{repository.id}/deactivate

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: POST /repo/891/deactivate

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :deactivate)

POST /repo/{repository.slug}/deactivate

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: POST /repo/rails%2Frails/deactivate

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :deactivate)

Star

This will star a repository based on the currently logged in user.

POST /repo/{repository.id}/star

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: POST /repo/891/star

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :star)

POST /repo/{repository.slug}/star

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: POST /repo/rails%2Frails/star

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :star)

Unstar

This will unstar a repository based on the currently logged in user.

POST /repo/{repository.id}/unstar

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.

Example: POST /repo/891/unstar

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :unstar)

POST /repo/{repository.slug}/unstar

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.

Example: POST /repo/rails%2Frails/unstar

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.repository('danielpclark/trav3', :unstar)

Parameters:

• repo (String) (defaults to: repository_name) —

  github_username/repository_name

• action (String, Symbol) (defaults to: nil) —

  Optional argument for star/unstar/activate/deactivate

Returns:

• (Success, RequestError)

Raises:

• (InvalidRepository) —

  if given input does not conform to valid repository identifier format

# File 'lib/trav3.rb', line 3117

def repository(repo = repository_name, action = nil)
  validate_repo_format repo

  repo = sanitize_repo_name repo

  action and return post("#{without_repo}/repo/#{repo}/#{action}")
  get("#{without_repo}/repo/#{repo}")
end

#repository=(repo_name) ⇒ Travis

Change the repository this instance of Trav3::Travis uses.

Parameters:

• repo_name (String) —

  github_username/repository_name

Returns:

• (Travis)

# File 'lib/trav3.rb', line 151

def repository=(repo_name)
  validate_repo_format repo_name
  @repo = sanitize_repo_name repo_name
end

#request(request_id) ⇒ Success, RequestError

An individual request

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name     Type     Description
id       Integer  Value uniquely identifying the request.
state    String   The state of a request (eg. whether it has been processed or not).
result   String   The result of the request (eg. rejected or approved).
message  String   Travis-ci status message attached to the request.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name         Type        Description
id           Integer     Value uniquely identifying the request.
state        String      The state of a request (eg. whether it has been processed or not).
result       String      The result of the request (eg. rejected or approved).
message      String      Travis-ci status message attached to the request.
repository   Repository  GitHub user or organization the request belongs to.
branch_name  String      Name of the branch requested to be built.
commit       Commit      The commit the request is associated with.
builds       [Build]     The request's builds.
owner        Owner       GitHub user or organization the request belongs to.
created_at   String      When Travis CI created the request.
event_type   String      Origin of request (push, pull request, api).
base_commit  String      The base commit the request is associated with.
head_commit  String      The head commit the request is associated with.

Actions

Find

Get the request by id for the current repository

GET /repo/{repository.id}/request/{request.id}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
request.id         Integer  Value uniquely identifying the request.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.request(147_776_757)

GET /repo/{repository.slug}/request/{request.id}

Template Variable  Type     Description
repository.slug    String   Same as {repository.owner.name}/{repository.name}.
request.id         Integer  Value uniquely identifying the request.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.request(147_776_757)

Parameters:

• request_id (String, Integer) —

  request id

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 3197

def request(request_id)
  validate_number request_id

  get("#{with_repo}/request/#{request_id}")
end

#requests(**attributes) ⇒ Success, RequestError

A list of requests.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name      Type       Description
requests  [Request]  List of requests.

Collection Items

Each entry in the requests array has the following attributes:

Name         Type        Description
id           Integer     Value uniquely identifying the request.
state        String      The state of a request (eg. whether it has been processed or not).
result       String      The result of the request (eg. rejected or approved).
message      String      Travis-ci status message attached to the request.
repository   Repository  GitHub user or organization the request belongs to.
branch_name  String      Name of the branch requested to be built.
commit       Commit      The commit the request is associated with.
builds       [Build]     The request's builds.
owner        Owner       GitHub user or organization the request belongs to.
created_at   String      When Travis CI created the request.
event_type   String      Origin of request (push, pull request, api).
base_commit  String      The base commit the request is associated with.
head_commit  String      The head commit the request is associated with.
yaml_config  Unknown     The request's yaml_config.

Actions

Find

This will return a list of requests belonging to a repository.

GET /repo/{repository.id}/requests

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many requests to include in the response. Used for pagination.
offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.

Example: GET /repo/891/requests?limit=5

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.requests

GET /repo/{repository.slug}/requests

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.
limit            Integer   How many requests to include in the response. Used for pagination.
offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.

Example: GET /repo/rails%2Frails/requests?limit=5

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.options.build({limit: 5})
travis.requests

Create

This will create a request for an individual repository, triggering a build to run on Travis CI.

Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the .travis.yml.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "request": {
        "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  https://api.travis-ci.com/repo/1/requests

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.requests(
  message: 'Override the commit message: this is an api request',
  branch: 'master'
)

The response includes the following body:

{
  "@type":              "pending",
  "remaining_requests": 1,
  "repository":         {
    "@type":            "repository",
    "@href":            "/repo/1",
    "@representation":  "minimal",
    "id":               1,
    "name":             "test",
    "slug":             "owner/repo"
  },
  "request":            {
    "repository":       {
      "id":             1,
      "owner_name":     "owner",
      "name":           "repo"
    },
    "user":             {
      "id":             1
    },
    "id":               1,
    "message":          "Override the commit message: this is an api request",
    "branch":           "master",
    "config":           { }
  },
  "resource_type":      "request"
}

POST /repo/{repository.id}/requests

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Accepted Parameter  Type    Description
request.config      String  Build configuration (as parsed from .travis.yml).
request.message     String  Travis-ci status message attached to the request.
request.branch      String  Branch requested to be built.
request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).

Example: POST /repo/891/requests

POST /repo/{repository.slug}/requests

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Accepted Parameter  Type    Description
request.config      String  Build configuration (as parsed from .travis.yml).
request.message     String  Travis-ci status message attached to the request.
request.branch      String  Branch requested to be built.
request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).

Example: POST /repo/rails%2Frails/requests

Parameters:

• attributes (Hash) —

  request attributes

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 3360

def requests(**attributes)
  return get("#{with_repo}/requests") if attributes.empty?

  create("#{with_repo}/requests", 'request': attributes)
end

#setting(name, value = nil) ⇒ Success, RequestError

An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:

• builds_only_with_travis_yml (boolean)

• build_pushes (boolean)

• build_pull_requests (boolean)

• maximum_number_of_builds (integer)

• auto_cancel_pushes (boolean)

• auto_cancel_pull_requests (boolean)

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name   Type                Description
name   String              The setting's name.
value  Boolean or integer  The setting's value.

Minimal Representation

Included when the resource is returned as part of another resource.

Name Type Description name String The setting's name. value Boolean or integer The setting's value.

Actions

Find

This returns a single setting. It is possible to use the repository id or slug in the request.

GET /repo/{repository.id}/setting/{setting.name}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
setting.name       String   The setting's name.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.setting('auto_cancel_pull_requests')

GET /repo/{repository.slug}/setting/{setting.name}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
setting.name       String  The setting's name.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.setting('auto_cancel_pull_requests')

Update

This updates a single setting. It is possible to use the repository id or slug in the request.

Use namespaced params in the request body to pass the new setting:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "setting.value": true }' \
  https://api.travis-ci.com/repo/1234/setting/{setting.name}

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.setting('auto_cancel_pull_requests', false)

PATCH /repo/{repository.id}/setting/{setting.name}

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
setting.name       String   The setting's name.
Accepted Parameter  Type                Description
setting.value       Boolean or integer  The setting's value.

PATCH /repo/{repository.slug}/setting/{setting.name}

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
setting.name       String  The setting's name.
Accepted Parameter  Type                Description
setting.value       Boolean or integer  The setting's value.

Parameters:

• name (String) —

  the setting name for the current repository

• value (String) (defaults to: nil) —

  optional argument for setting a value for the setting name

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 3525

def setting(name, value = nil)
  return get("#{with_repo}/setting/#{name}") if value.nil?

  patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
end

#settings ⇒ Success, RequestError

A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:

• builds_only_with_travis_yml (boolean)

• build_pushes (boolean)

• build_pull_requests (boolean)

• maximum_number_of_builds (integer)

• auto_cancel_pushes (boolean)

• auto_cancel_pull_requests (boolean)

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Name      Type       Description
settings  [Setting]  List of settings.

Collection Items

Each entry in the settings array has the following attributes:

Name   Type                Description
name   String              The setting's name.
value  Boolean or integer  The setting's value.

Actions

For Repository

This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.

GET /repo/{repository.id}/settings

Template Variable  Type     Description
repository.id      Integer  Value uniquely identifying the repository.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/891/settings

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.settings

GET /repo/{repository.slug}/settings

Template Variable  Type    Description
repository.slug    String  Same as {repository.owner.name}/{repository.name}.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /repo/rails%2Frails/settings

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.settings

Returns:

• (Success, RequestError)

# File 'lib/trav3.rb', line 3594

def settings
  get("#{with_repo}/settings")
end

#stages(build_id) ⇒ Success, RequestError

A list of stages.

Currently this is nested within a build.

Attributes

Name    Type     Description
stages  [Stage]  List of stages.

Collection Items

Each entry in the stages array has the following attributes:

Name         Type     Description
id           Integer  Value uniquely identifying the stage.
number       Integer  Incremental number for a stage.
name         String   The name of the stage.
state        String   Current state of the stage.
started_at   String   When the stage started.
finished_at  String   When the stage finished.
jobs         [Job]    The jobs of a stage.

Actions

Find

This returns a list of stages belonging to an individual build.

GET /build/{build.id}/stages

Template Variable  Type     Description
build.id           Integer  Value uniquely identifying the build.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /build/86601346/stages

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.stages(479_113_572)

Parameters:

• build_id (String, Integer) —

  build id

Returns:

• (Success, RequestError)

Raises:

• (TypeError) —

  if given build id is not a number

# File 'lib/trav3.rb', line 3413

def stages(build_id)
  validate_number build_id

  get("#{without_repo}/build/#{build_id}/stages")
end

#user(user_id = nil, sync = false) ⇒ Success, RequestError

Note:

sync feature may not be permitted

Note:

POST requests require an authorization token set in the headers. See: #authorization=

An individual user.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

Name  Type     Description
id    Integer  Value uniquely identifying the user.
login String   Login set on GitHub.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

Name              Type     Description
id                Integer  Value uniquely identifying the user.
login             String   Login set on GitHub.
name              String   Name set on GitHub.
github_id         Integer  Id set on GitHub.
avatar_url        String   Avatar URL set on GitHub.
education         Boolean  Whether or not the user has an education account.
allow_migration   Unknown  The user's allow_migration.
is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
synced_at         String   The last time the user was synced with GitHub.

Additional Attributes

Name          Type          Description
repositories  [Repository]  Repositories belonging to this user.
installation  Installation  Installation belonging to the user.
emails        Unknown       The user's emails.

Actions

Find

This will return information about an individual user.

GET /user/{user.id}

Template Variable  Type     Description
user.id            Integer  Value uniquely identifying the user.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /user/119240

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.user(119_240)

Sync

This triggers a sync on a user's account with their GitHub account.

POST /user/{user.id}/sync

Template Variable  Type     Description
user.id            Integer  Value uniquely identifying the user.

Example: POST /user/119240/sync

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.user(114_816, :sync)

Current

This will return information about the current user.

GET /user

Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /user

# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.authorization = 'xxxx'
travis.user

Parameters:

• user_id (String, Integer) (defaults to: nil) —

  optional user id

• sync (Boolean) (defaults to: false) —

  optional argument for syncing your Travis CI account with GitHub

Returns:

• (Success, RequestError)

Raises:

• (TypeError) —

  if given user id is not a number

# File 'lib/trav3.rb', line 3696

def user(user_id = nil, sync = false)
  return get("#{without_repo}/user") if !user_id && !sync

  validate_number user_id

  sync and return post("#{without_repo}/user/#{user_id}/sync")
  get("#{without_repo}/user/#{user_id}")
end