CINXE.COM
Class: Bugsnag::Api::Client — Documentation for bugsnag-api (3.0.1)
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Bugsnag::Api::Client — Documentation for bugsnag-api (3.0.1) </title> <link rel="stylesheet" href="/static/gems/bugsnag-api/css/style.css?1739984883" type="text/css" /> <link rel="stylesheet" href="/static/gems/bugsnag-api/css/common.css?1739984883" type="text/css" /> <link rel="stylesheet" href="/static/gems/bugsnag-api/css/custom.css?1739984883" type="text/css" /> <script type="text/javascript" charset="utf-8"> pathId = "Bugsnag::Api::Client" relpath = '/'; docsPrefix = '/gems/bugsnag-api'; listPrefix = '/list/gems/bugsnag-api'; searchPrefix = '/search/gems/bugsnag-api'; </script> <script type="text/javascript" charset="utf-8" src="/static/gems/bugsnag-api/js/jquery.js?1739984883"></script> <script type="text/javascript" charset="utf-8" src="/static/gems/bugsnag-api/js/app.js?1739984883"></script> <script type="text/javascript" charset="utf-8" src="/static/gems/bugsnag-api/js/autocomplete.js?1739984883"></script> <script type="text/javascript" charset="utf-8" src="/static/gems/bugsnag-api/js/rubydoc_custom.js?1739984883"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="/list/gems/bugsnag-api/class?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <form class="search" method="get" action="/search/gems/bugsnag-api"> <input name="q" type="search" placeholder="Search" id="search_box" size="30" value="" /> </form> <script type="text/javascript" charset="utf-8"> $(function() { $('#search_box').autocomplete($('#search_box').parent().attr('action'), { width: 200, formatItem: function(item) { var values = item[0].split(","); return values[0] + (values[1] == '' ? "" : " <small>(" + values[1] + ")</small>"); } }).result(function(event, item) { var values = item[0].split(",") $('#search_box').val(values[1]); location.href = values[3]; return false; }); }); </script> <div id="menu"> <a href="/gems" target="_top">Libraries</a> » <span class="title">bugsnag-api <small>(3.0.1)</small></span> » <a href="/gems/bugsnag-api/index">Index (C)</a> » <span class='title'><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag" title="Bugsnag (module)">Bugsnag</a></span></span> » <span class='title'><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api" title="Bugsnag::Api (module)">Api</a></span></span> » <span class='title'>Client</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="/list/gems/bugsnag-api/class"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: Bugsnag::Api::Client </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">Bugsnag::Api::Client</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Includes:</dt> <dd><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators" title="Bugsnag::Api::Client::Collaborators (module)">Collaborators</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments" title="Bugsnag::Api::Client::Comments (module)">Comments</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/CurrentUser" title="Bugsnag::Api::Client::CurrentUser (module)">CurrentUser</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Errors" title="Bugsnag::Api::Client::Errors (module)">Errors</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields" title="Bugsnag::Api::Client::EventFields (module)">EventFields</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events" title="Bugsnag::Api::Client::Events (module)">Events</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations" title="Bugsnag::Api::Client::Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Pivots" title="Bugsnag::Api::Client::Pivots (module)">Pivots</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects" title="Bugsnag::Api::Client::Projects (module)">Projects</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Releases" title="Bugsnag::Api::Client::Releases (module)">Releases</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Stability" title="Bugsnag::Api::Client::Stability (module)">Stability</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Trends" title="Bugsnag::Api::Client::Trends (module)">Trends</a></span></dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/bugsnag/api/client.rb<span class="defines">,<br /> lib/bugsnag/api/client/errors.rb,<br /> lib/bugsnag/api/client/events.rb,<br /> lib/bugsnag/api/client/pivots.rb,<br /> lib/bugsnag/api/client/trends.rb,<br /> lib/bugsnag/api/client/comments.rb,<br /> lib/bugsnag/api/client/projects.rb,<br /> lib/bugsnag/api/client/releases.rb,<br /> lib/bugsnag/api/client/stability.rb,<br /> lib/bugsnag/api/client/currentuser.rb,<br /> lib/bugsnag/api/client/eventfields.rb,<br /> lib/bugsnag/api/client/collaborators.rb,<br /> lib/bugsnag/api/client/organizations.rb</span> </dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Client for the Bugsnag API</p> </div> </div> <div class="tags"> <p class="tag_title">See Also:</p> <ul class="see"> <li><a href="http://docs.bugsnagapiv2.apiary.io/" target="_parent" title="http://docs.bugsnagapiv2.apiary.io/">http://docs.bugsnagapiv2.apiary.io/</a></li> </ul> </div><h2>Defined Under Namespace</h2> <p class="children"> <strong class="modules">Modules:</strong> <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators" title="Bugsnag::Api::Client::Collaborators (module)">Collaborators</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments" title="Bugsnag::Api::Client::Comments (module)">Comments</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/CurrentUser" title="Bugsnag::Api::Client::CurrentUser (module)">CurrentUser</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Errors" title="Bugsnag::Api::Client::Errors (module)">Errors</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields" title="Bugsnag::Api::Client::EventFields (module)">EventFields</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events" title="Bugsnag::Api::Client::Events (module)">Events</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations" title="Bugsnag::Api::Client::Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Pivots" title="Bugsnag::Api::Client::Pivots (module)">Pivots</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects" title="Bugsnag::Api::Client::Projects (module)">Projects</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Releases" title="Bugsnag::Api::Client::Releases (module)">Releases</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Stability" title="Bugsnag::Api::Client::Stability (module)">Stability</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Trends" title="Bugsnag::Api::Client::Trends (module)">Trends</a></span> </p> <h2> Constant Summary <small><a href="#" class="constants_summary_toggle">collapse</a></small> </h2> <dl class="constants"> <dt id="CONVENIENCE_HEADERS-constant" class="">CONVENIENCE_HEADERS = <div class="docstring"> <div class="discussion"> <p>Header keys that can be passed in options hash to <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client#get-instance_method" title="Bugsnag::Api::Client#get (method)">#get</a></span>,#head</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:accept</span><span class='comma'>,</span> <span class='symbol'>:content_type</span><span class='rbracket'>]</span><span class='rparen'>)</span></pre></dd> </dl> <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#basic_authenticated%3F-instance_method" title="#basic_authenticated? (instance method)">#<strong>basic_authenticated?</strong> ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'><p>Indicates if the client was supplied Basic Auth username and password.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#configuration-instance_method" title="#configuration (instance method)">#<strong>configuration</strong> ⇒ Bugsnag::Api::Configuration </a> </span> <span class="summary_desc"><div class='inline'><p>Get client's configuration options.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong> {|configuration| ... } ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Set configuration options using a block.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#deep_merge-instance_method" title="#deep_merge (instance method)">#<strong>deep_merge</strong>(l_hash, r_hash) ⇒ Hash </a> </span> <span class="summary_desc"><div class='inline'><p>Merges hashes together cleanly, favouring RHS values.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(url, options = {}) ⇒ Sawyer::Resource </a> </span> <span class="summary_desc"><div class='inline'><p>Make a HTTP DELETE request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#get-instance_method" title="#get (instance method)">#<strong>get</strong>(url, options = {}) ⇒ Sawyer::Resource </a> </span> <span class="summary_desc"><div class='inline'><p>Make a HTTP GET request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) {|configuration| ... } ⇒ Client </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of Client.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#last_response-instance_method" title="#last_response (instance method)">#<strong>last_response</strong> ⇒ Sawyer::Response </a> </span> <span class="summary_desc"><div class='inline'><p>Response for last HTTP request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#paginate-instance_method" title="#paginate (instance method)">#<strong>paginate</strong>(url, options = {}, &block) ⇒ Sawyer::Resource </a> </span> <span class="summary_desc"><div class='inline'><p>Make one or more HTTP GET requests, optionally fetching the next page of results from URL in Link response header based on value in #auto_paginate.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#patch-instance_method" title="#patch (instance method)">#<strong>patch</strong>(url, options = {}) ⇒ Sawyer::Resource </a> </span> <span class="summary_desc"><div class='inline'><p>Make a HTTP PATCH request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#post-instance_method" title="#post (instance method)">#<strong>post</strong>(url, options = {}) ⇒ Sawyer::Resource </a> </span> <span class="summary_desc"><div class='inline'><p>Make a HTTP POST request.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/bugsnag-api/Bugsnag/Api/Client#token_authenticated%3F-instance_method" title="#token_authenticated? (instance method)">#<strong>token_authenticated?</strong> ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'><p>Indicates if the client was supplied an auth token.</p> </div></span> </li> </ul> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Releases" title="Bugsnag::Api::Client::Releases (module)">Releases</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Releases#release-instance_method" title="Bugsnag::Api::Client::Releases#release (method)">#release</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Releases#releases-instance_method" title="Bugsnag::Api::Client::Releases#releases (method)">#releases</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Releases#releases_in_group-instance_method" title="Bugsnag::Api::Client::Releases#releases_in_group (method)">#releases_in_group</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Stability" title="Bugsnag::Api::Client::Stability (module)">Stability</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Stability#stability_trend-instance_method" title="Bugsnag::Api::Client::Stability#stability_trend (method)">#stability_trend</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments" title="Bugsnag::Api::Client::Comments (module)">Comments</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments#comment-instance_method" title="Bugsnag::Api::Client::Comments#comment (method)">#comment</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments#comments-instance_method" title="Bugsnag::Api::Client::Comments#comments (method)">#comments</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments#create_comment-instance_method" title="Bugsnag::Api::Client::Comments#create_comment (method)">#create_comment</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments#delete_comment-instance_method" title="Bugsnag::Api::Client::Comments#delete_comment (method)">#delete_comment</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Comments#update_comment-instance_method" title="Bugsnag::Api::Client::Comments#update_comment (method)">#update_comment</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Trends" title="Bugsnag::Api::Client::Trends (module)">Trends</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Trends#trends_buckets-instance_method" title="Bugsnag::Api::Client::Trends#trends_buckets (method)">#trends_buckets</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Trends#trends_resolution-instance_method" title="Bugsnag::Api::Client::Trends#trends_resolution (method)">#trends_resolution</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Pivots" title="Bugsnag::Api::Client::Pivots (module)">Pivots</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Pivots#pivot_values-instance_method" title="Bugsnag::Api::Client::Pivots#pivot_values (method)">#pivot_values</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Pivots#pivots-instance_method" title="Bugsnag::Api::Client::Pivots#pivots (method)">#pivots</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events" title="Bugsnag::Api::Client::Events (module)">Events</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events#delete_event-instance_method" title="Bugsnag::Api::Client::Events#delete_event (method)">#delete_event</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events#error_events-instance_method" title="Bugsnag::Api::Client::Events#error_events (method)">#error_events</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events#event-instance_method" title="Bugsnag::Api::Client::Events#event (method)">#event</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events#events-instance_method" title="Bugsnag::Api::Client::Events#events (method)">#events</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Events#latest_event-instance_method" title="Bugsnag::Api::Client::Events#latest_event (method)">#latest_event</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Errors" title="Bugsnag::Api::Client::Errors (module)">Errors</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Errors#delete_errors-instance_method" title="Bugsnag::Api::Client::Errors#delete_errors (method)">#delete_errors</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Errors#errors-instance_method" title="Bugsnag::Api::Client::Errors#errors (method)">#errors</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Errors#update_errors-instance_method" title="Bugsnag::Api::Client::Errors#update_errors (method)">#update_errors</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/CurrentUser" title="Bugsnag::Api::Client::CurrentUser (module)">CurrentUser</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/CurrentUser#organizations-instance_method" title="Bugsnag::Api::Client::CurrentUser#organizations (method)">#organizations</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/CurrentUser#projects-instance_method" title="Bugsnag::Api::Client::CurrentUser#projects (method)">#projects</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields" title="Bugsnag::Api::Client::EventFields (module)">EventFields</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields#create_event_field-instance_method" title="Bugsnag::Api::Client::EventFields#create_event_field (method)">#create_event_field</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields#delete_event_field-instance_method" title="Bugsnag::Api::Client::EventFields#delete_event_field (method)">#delete_event_field</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields#event_fields-instance_method" title="Bugsnag::Api::Client::EventFields#event_fields (method)">#event_fields</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/EventFields#update_event_field-instance_method" title="Bugsnag::Api::Client::EventFields#update_event_field (method)">#update_event_field</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects" title="Bugsnag::Api::Client::Projects (module)">Projects</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects#create_project-instance_method" title="Bugsnag::Api::Client::Projects#create_project (method)">#create_project</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects#delete_project-instance_method" title="Bugsnag::Api::Client::Projects#delete_project (method)">#delete_project</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects#project-instance_method" title="Bugsnag::Api::Client::Projects#project (method)">#project</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects#regenerate_api_key-instance_method" title="Bugsnag::Api::Client::Projects#regenerate_api_key (method)">#regenerate_api_key</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Projects#update_project-instance_method" title="Bugsnag::Api::Client::Projects#update_project (method)">#update_project</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators" title="Bugsnag::Api::Client::Collaborators (module)">Collaborators</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators#collaborator-instance_method" title="Bugsnag::Api::Client::Collaborators#collaborator (method)">#collaborator</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators#collaborators-instance_method" title="Bugsnag::Api::Client::Collaborators#collaborators (method)">#collaborators</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators#delete_collaborator-instance_method" title="Bugsnag::Api::Client::Collaborators#delete_collaborator (method)">#delete_collaborator</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators#invite_collaborators-instance_method" title="Bugsnag::Api::Client::Collaborators#invite_collaborators (method)">#invite_collaborators</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators#update_collaborator_permissions-instance_method" title="Bugsnag::Api::Client::Collaborators#update_collaborator_permissions (method)">#update_collaborator_permissions</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Collaborators#view_collaborator_projects-instance_method" title="Bugsnag::Api::Client::Collaborators#view_collaborator_projects (method)">#view_collaborator_projects</a></span></p> <h3 class="inherited">Methods included from <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations" title="Bugsnag::Api::Client::Organizations (module)">Organizations</a></span></h3> <p class="inherited"><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations#create_organization-instance_method" title="Bugsnag::Api::Client::Organizations#create_organization (method)">#create_organization</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations#delete_organization-instance_method" title="Bugsnag::Api::Client::Organizations#delete_organization (method)">#delete_organization</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations#organization-instance_method" title="Bugsnag::Api::Client::Organizations#organization (method)">#organization</a></span>, <span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client/Organizations#update_organization-instance_method" title="Bugsnag::Api::Client::Organizations#update_organization (method)">#update_organization</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong>(options = {}) {|configuration| ... } ⇒ <tt><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client" title="Bugsnag::Api::Client (class)">Client</a></span></tt> </h3><script> $(document.getElementById("initialize-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:initialize">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Returns a new instance of Client.</p> </div> </div> <div class="tags"> <p class="tag_title">Yields:</p> <ul class="yield"> <li> <span class='type'>(<tt><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client#configuration-instance_method" title="Bugsnag::Api::Client#configuration (method)">configuration</a></span></tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 41 42 43 44</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 41</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='kw'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="basic_authenticated?-instance_method"> #<strong>basic_authenticated?</strong> ⇒ <tt>Boolean</tt> </h3><script> $(document.getElementById("basic_authenticated?-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:basic_authenticated%3F">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Indicates if the client was supplied Basic Auth username and password</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><a href="https://bugsnag.com/docs/api#user-authentication" target="_parent" title="https://bugsnag.com/docs/api#user-authentication">https://bugsnag.com/docs/api#user-authentication</a></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 140 141 142</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 140</span> <span class='kw'>def</span> <span class='id identifier rubyid_basic_authenticated?'>basic_authenticated?</span> <span class='op'>!</span><span class='op'>!</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_email'>email</span> <span class='op'>&&</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configuration-instance_method"> #<strong>configuration</strong> ⇒ <tt><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Configuration" title="Bugsnag::Api::Configuration (class)">Bugsnag::Api::Configuration</a></span></tt> </h3><script> $(document.getElementById("configuration-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:configuration">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Get client's configuration options</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Configuration" title="Bugsnag::Api::Configuration (class)">Bugsnag::Api::Configuration</a></span></tt>)</span> — <div class='inline'><p>configuration wrapper</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 55 56 57</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 55</span> <span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span> <span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Configuration" title="Bugsnag::Api::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Configuration#initialize-instance_method" title="Bugsnag::Api::Configuration#initialize (method)">new</a></span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure-instance_method"> #<strong>configure</strong> {|configuration| ... } ⇒ <tt>Object</tt> </h3><script> $(document.getElementById("configure-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:configure">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Set configuration options using a block</p> </div> </div> <div class="tags"> <p class="tag_title">Yields:</p> <ul class="yield"> <li> <span class='type'>(<tt><span class='object_link'><a href="/gems/bugsnag-api/Bugsnag/Api/Client#configuration-instance_method" title="Bugsnag::Api::Client#configuration (method)">configuration</a></span></tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 47 48 49 50</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 47</span> <span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span> <span class='kw'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span> <span class='id identifier rubyid_reset_agent'>reset_agent</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="deep_merge-instance_method"> #<strong>deep_merge</strong>(l_hash, r_hash) ⇒ <tt>Hash</tt> </h3><script> $(document.getElementById("deep_merge-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:deep_merge">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Merges hashes together cleanly, favouring RHS values</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Hash</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 155 156 157 158 159 160 161 162 163</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 155</span> <span class='kw'>def</span> <span class='id identifier rubyid_deep_merge'>deep_merge</span><span class='lparen'>(</span><span class='id identifier rubyid_l_hash'>l_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_r_hash'>r_hash</span><span class='rparen'>)</span> <span class='id identifier rubyid_l_hash'>l_hash</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_r_hash'>r_hash</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__key'>_key</span><span class='comma'>,</span> <span class='id identifier rubyid_l_val'>l_val</span><span class='comma'>,</span> <span class='id identifier rubyid_r_val'>r_val</span><span class='op'>|</span> <span class='kw'>if</span> <span class='id identifier rubyid_l_val'>l_val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_r_val'>r_val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='id identifier rubyid_deep_merge'>deep_merge</span><span class='lparen'>(</span><span class='id identifier rubyid_l_val'>l_val</span><span class='comma'>,</span> <span class='id identifier rubyid_r_val'>r_val</span><span class='rparen'>)</span> <span class='kw'>else</span> <span class='id identifier rubyid_r_val'>r_val</span> <span class='kw'>end</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete-instance_method"> #<strong>delete</strong>(url, options = {}) ⇒ <tt>Sawyer::Resource</tt> </h3><script> $(document.getElementById("delete-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:delete">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Make a HTTP DELETE request</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>url</span> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>The path, relative to #endpoint</p> </div> </li> <li> <span class='name'>options</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>Query and header params for request</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Sawyer::Resource</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 91 92 93</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 91</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_request'>request</span> <span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="get-instance_method"> #<strong>get</strong>(url, options = {}) ⇒ <tt>Sawyer::Resource</tt> </h3><script> $(document.getElementById("get-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:get">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Make a HTTP GET request</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>url</span> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>The path, relative to #endpoint</p> </div> </li> <li> <span class='name'>options</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>Query and header params for request</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Sawyer::Resource</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 64 65 66</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 64</span> <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_request'>request</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_query_and_convenience_headers'>parse_query_and_convenience_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="last_response-instance_method"> #<strong>last_response</strong> ⇒ <tt>Sawyer::Response</tt> </h3><script> $(document.getElementById("last_response-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:last_response">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Response for last HTTP request</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Sawyer::Response</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 131 132 133</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 131</span> <span class='kw'>def</span> <span class='id identifier rubyid_last_response'>last_response</span> <span class='ivar'>@last_response</span> <span class='kw'>if</span> <span class='kw'>defined?</span> <span class='ivar'>@last_response</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="paginate-instance_method"> #<strong>paginate</strong>(url, options = {}, &block) ⇒ <tt>Sawyer::Resource</tt> </h3><script> $(document.getElementById("paginate-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:paginate">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Make one or more HTTP GET requests, optionally fetching the next page of results from URL in Link response header based on value in #auto_paginate.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>url</span> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>The path, relative to #endpoint</p> </div> </li> <li> <span class='name'>options</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>Query and header params for request</p> </div> </li> <li> <span class='name'>block</span> <span class='type'>(<tt>Block</tt>)</span> — <div class='inline'><p>Block to perform the data concatination of the multiple requests. The block is called with two parameters, the first contains the contents of the requests so far and the second parameter contains the latest response.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Sawyer::Resource</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 106</span> <span class='kw'>def</span> <span class='id identifier rubyid_paginate'>paginate</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_query_and_convenience_headers'>parse_query_and_convenience_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_auto_paginate'>auto_paginate</span> <span class='op'>||</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_per_page'>per_page</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:per_page</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_per_page'>per_page</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_auto_paginate'>auto_paginate</span> <span class='op'>?</span> <span class='int'>100</span> <span class='op'>:</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_auto_paginate'>auto_paginate</span> <span class='kw'>while</span> <span class='ivar'>@last_response</span><span class='period'>.</span><span class='id identifier rubyid_rels'>rels</span><span class='lbracket'>[</span><span class='symbol'>:next</span><span class='rbracket'>]</span> <span class='ivar'>@last_response</span> <span class='op'>=</span> <span class='ivar'>@last_response</span><span class='period'>.</span><span class='id identifier rubyid_rels'>rels</span><span class='lbracket'>[</span><span class='symbol'>:next</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span> <span class='kw'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='ivar'>@last_response</span><span class='rparen'>)</span> <span class='kw'>else</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='ivar'>@last_response</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@last_response</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span> <span class='kw'>end</span> <span class='id identifier rubyid_data'>data</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="patch-instance_method"> #<strong>patch</strong>(url, options = {}) ⇒ <tt>Sawyer::Resource</tt> </h3><script> $(document.getElementById("patch-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:patch">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Make a HTTP PATCH request</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>url</span> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>The path, relative to #endpoint</p> </div> </li> <li> <span class='name'>options</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>Body and header params for request</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Sawyer::Resource</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 82 83 84</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 82</span> <span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_request'>request</span> <span class='symbol'>:patch</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="post-instance_method"> #<strong>post</strong>(url, options = {}) ⇒ <tt>Sawyer::Resource</tt> </h3><script> $(document.getElementById("post-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:post">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Make a HTTP POST request</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>url</span> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>The path, relative to #endpoint</p> </div> </li> <li> <span class='name'>options</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>Body and header params for request</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Sawyer::Resource</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 73 74 75</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 73</span> <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_request'>request</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="token_authenticated?-instance_method"> #<strong>token_authenticated?</strong> ⇒ <tt>Boolean</tt> </h3><script> $(document.getElementById("token_authenticated?-instance_method")).prepend( '<a class="permalink" href="/gems/bugsnag-api/Bugsnag%2FApi%2FClient:token_authenticated%3F">permalink</a>'); </script> <div class="docstring"> <div class="discussion"> <p>Indicates if the client was supplied an auth token</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><a href="https://bugsnag.com/docs/api#account-authentication" target="_parent" title="https://bugsnag.com/docs/api#account-authentication">https://bugsnag.com/docs/api#account-authentication</a></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 148 149 150</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/bugsnag/api/client.rb', line 148</span> <span class='kw'>def</span> <span class='id identifier rubyid_token_authenticated?'>token_authenticated?</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_auth_token'>auth_token</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Wed Feb 19 22:16:18 2025 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.37 (ruby-3.3.7). </div> <script> window.yard_library_name = 'bugsnag-api'; window.yard_library_version = '3.0.1'; </script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-7172246-5', 'auto'); ga('send', 'pageview'); </script> </div> </body> </html>