bend-api v0.1.0

bend-api

BendApi - JavaScript client for bend-api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 0.1.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bend-api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your bend-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('bend-api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var BendApi = require('bend-api');

var defaultClient = BendApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure API key authorization: TokenAuthentication
var TokenAuthentication = defaultClient.authentications['TokenAuthentication'];
TokenAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TokenAuthentication.apiKeyPrefix['Authorization'] = "Token"

var api = new BendApi.AnnouncementsApi()

var id = 56; // {Number} A unique integer value identifying this announcement.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.announcementsDismiss(id, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v1

Documentation for Models

• BendApi.AddWidgetViaDashboard
• BendApi.Announcement
• BendApi.AsyncStepErrorGroup
• BendApi.Attachment
• BendApi.Attribute
• BendApi.Build
• BendApi.BuildJiraIssue
• BendApi.BuildReportItem
• BendApi.BulkCreate
• BendApi.BulkCreateAttachment
• BendApi.BulkCreateStep
• BendApi.BulkCreateTest
• BendApi.BulkUpdate
• BendApi.BulkUpdateReviewTest
• BendApi.CsvExportRequest
• BendApi.DSLQuery
• BendApi.Dashboard
• BendApi.Disposition
• BendApi.EnumValue
• BendApi.ExportedTestCase
• BendApi.Group
• BendApi.Host
• BendApi.InlineResponse200
• BendApi.InlineResponse2001
• BendApi.InlineResponse20010
• BendApi.InlineResponse20011
• BendApi.InlineResponse20012
• BendApi.InlineResponse20013
• BendApi.InlineResponse20014
• BendApi.InlineResponse20015
• BendApi.InlineResponse20016
• BendApi.InlineResponse20017
• BendApi.InlineResponse20018
• BendApi.InlineResponse20019
• BendApi.InlineResponse2002
• BendApi.InlineResponse2003
• BendApi.InlineResponse2004
• BendApi.InlineResponse2005
• BendApi.InlineResponse2006
• BendApi.InlineResponse2007
• BendApi.InlineResponse2008
• BendApi.InlineResponse2009
• BendApi.IssueRegex
• BendApi.JiraExportRequest
• BendApi.JiraIssue
• BendApi.JiraIssueTypesResponse
• BendApi.JiraProjectResponse
• BendApi.LinkJiraIssue
• BendApi.ManualTestStatuses
• BendApi.Milestone
• BendApi.NewIssueTest
• BendApi.Permission
• BendApi.PermissionSchema
• BendApi.Project
• BendApi.ProjectPreferences
• BendApi.ProjectRole
• BendApi.Regex
• BendApi.ReportItem
• BendApi.ReportType
• BendApi.ResponseTcExportedData
• BendApi.ResponseTcExportedItem
• BendApi.Review
• BendApi.ReviewHistory
• BendApi.ReviewPreferences
• BendApi.ReviewTemplate
• BendApi.ReviewTest
• BendApi.Role
• BendApi.Run
• BendApi.RunModel
• BendApi.SendReport
• BendApi.SendReportItem
• BendApi.SerializerImportCaseView
• BendApi.SimilarStepsParams
• BendApi.StatusChange
• BendApi.Step
• BendApi.StepErrorGroup
• BendApi.StepErrorSingleGroup
• BendApi.TMTExecuteTcByDsl
• BendApi.TMTExecuteTcByTestList
• BendApi.TMTIdentifier
• BendApi.TaskProgress
• BendApi.TaskState
• BendApi.Test
• BendApi.TestDslString
• BendApi.TestHistory
• BendApi.TestIds
• BendApi.TestLinkSnapshotRequest
• BendApi.TestModel
• BendApi.TestPlan
• BendApi.UploadBackup
• BendApi.User
• BendApi.UserRun
• BendApi.UserSetting
• BendApi.Widget

Documentation for Authorization

BasicAuthentication

• Type: HTTP basic authentication

TokenAuthentication

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header