bt_test

BtTest - the Ruby gem for the BT Test

You can update this description in config/locales/en/application.en.yml.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 3.0.3
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build bt_test.gemspec

Then either install the gem locally:

gem install ./bt_test-3.0.3.gem

(for development, run gem install --dev ./bt_test-3.0.3.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'bt_test', '~> 3.0.3'

Install from Git

If the Ruby gem is hosted at a git repository: https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'bt_test', :git => 'https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'bt_test'

# Setup authorization
BtTest.configure do |config|
  # Configure Bearer authorization (Auth token): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = BtTest::PlatformApi.new
project_id = 56 # Integer | Project ID
opts = {
  create_goal_request: BtTest::CreateGoalRequest.new # CreateGoalRequest | 
}

begin
  result = api_instance.create_goal(project_id, opts)
  p result
rescue BtTest::ApiError => e
  puts "Exception when calling PlatformApi->create_goal: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://btapi.eu.ngrok.io/api/v1

Class Method HTTP request Description
BtTest::PlatformApi create_goal POST /projects/project_id/goals
BtTest::PlatformApi create_project POST /teams/team_id/projects
BtTest::PlatformApi create_projects_tag POST /teams/team_id/projects/tags
BtTest::PlatformApi create_scaffolding_absolutely_abstract_creative_concept POST /teams/team_id/scaffolding/absolutely_abstract/creative_concepts
BtTest::PlatformApi create_scaffolding_completely_concrete_tangible_thing POST /scaffolding/absolutely_abstract/creative_concepts/absolutely_abstract_creative_concept_id/completely_concrete/tangible_things
BtTest::PlatformApi create_team POST /teams
BtTest::PlatformApi create_webhooks_outgoing_endpoint POST /teams/team_id/webhooks/outgoing/endpoints
BtTest::PlatformApi delete_goal DELETE /goals/id
BtTest::PlatformApi delete_project DELETE /projects/id
BtTest::PlatformApi delete_projects_tag DELETE /projects/tags/id
BtTest::PlatformApi delete_scaffolding_absolutely_abstract_creative_concept DELETE /scaffolding/absolutely_abstract/creative_concepts/id
BtTest::PlatformApi delete_scaffolding_completely_concrete_tangible_thing DELETE /scaffolding/completely_concrete/tangible_things/id
BtTest::PlatformApi delete_webhooks_outgoing_endpoint DELETE /webhooks/outgoing/endpoints/id
BtTest::PlatformApi get_goal GET /goals/id
BtTest::PlatformApi get_me GET /me
BtTest::PlatformApi get_project GET /projects/id
BtTest::PlatformApi get_projects_tag GET /projects/tags/id
BtTest::PlatformApi get_scaffolding_absolutely_abstract_creative_concept GET /scaffolding/absolutely_abstract/creative_concepts/id
BtTest::PlatformApi get_scaffolding_completely_concrete_tangible_thing GET /scaffolding/completely_concrete/tangible_things/id
BtTest::PlatformApi get_team GET /teams/id
BtTest::PlatformApi get_webhooks_outgoing_delivery GET /webhooks/outgoing/deliveries/id
BtTest::PlatformApi get_webhooks_outgoing_delivery_attempt GET /webhooks/outgoing/delivery_attempts/id
BtTest::PlatformApi get_webhooks_outgoing_endpoint GET /webhooks/outgoing/endpoints/id
BtTest::PlatformApi list_goals GET /projects/project_id/goals
BtTest::PlatformApi list_projects GET /teams/team_id/projects
BtTest::PlatformApi list_projects_tags GET /teams/team_id/projects/tags
BtTest::PlatformApi list_scaffolding_absolutely_abstract_creative_concepts GET /teams/team_id/scaffolding/absolutely_abstract/creative_concepts
BtTest::PlatformApi list_scaffolding_completely_concrete_tangible_things GET /scaffolding/absolutely_abstract/creative_concepts/absolutely_abstract_creative_concept_id/completely_concrete/tangible_things
BtTest::PlatformApi list_teams GET /teams
BtTest::PlatformApi list_webhooks_outgoing_delivery_attempts GET /webhooks/outgoing/deliveries/delivery_id/delivery_attempts
BtTest::PlatformApi list_webhooks_outgoing_deliverys GET /webhooks/outgoing/endpoints/endpoint_id/deliveries
BtTest::PlatformApi list_webhooks_outgoing_endpoints GET /teams/team_id/webhooks/outgoing/endpoints
BtTest::PlatformApi update_goal PUT /goals/id
BtTest::PlatformApi update_project PUT /projects/id
BtTest::PlatformApi update_projects_tag PUT /projects/tags/id
BtTest::PlatformApi update_scaffolding_absolutely_abstract_creative_concept PUT /scaffolding/absolutely_abstract/creative_concepts/id
BtTest::PlatformApi update_scaffolding_completely_concrete_tangible_thing PUT /scaffolding/completely_concrete/tangible_things/id
BtTest::PlatformApi update_team PUT /teams/id
BtTest::PlatformApi update_webhooks_outgoing_endpoint PUT /webhooks/outgoing/endpoints/id

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: Bearer authentication (Auth token)