bitbucket-swagger-client v0.0.1

bitbucket_api

BitbucketApi - JavaScript client for bitbucket_api Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0
• Package version: 2.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://support.atlassian.com/bitbucket-cloud/

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 bitbucket_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your bitbucket_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 BitbucketApi = require('bitbucket_api');

var defaultClient = BitbucketApi.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"
// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME'
basic.password = 'YOUR PASSWORD'
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

Documentation for API Endpoints

All URIs are relative to https://api.bitbucket.org/2.0

Documentation for Models

• BitbucketApi.Account
• BitbucketApi.AccountAllOf
• BitbucketApi.AccountAllOfLinks
• BitbucketApi.Author
• BitbucketApi.AuthorAllOf
• BitbucketApi.BaseCommit
• BitbucketApi.BaseCommitAllOf
• BitbucketApi.Branch
• BitbucketApi.BranchingModel
• BitbucketApi.BranchingModelAllOf
• BitbucketApi.BranchingModelAllOfBranchTypes
• BitbucketApi.BranchingModelAllOfDevelopment
• BitbucketApi.BranchingModelSettings
• BitbucketApi.BranchingModelSettingsAllOf
• BitbucketApi.BranchingModelSettingsAllOfBranchTypes
• BitbucketApi.BranchingModelSettingsAllOfDevelopment
• BitbucketApi.BranchingModelSettingsAllOfProduction
• BitbucketApi.Branchrestriction
• BitbucketApi.BranchrestrictionAllOf
• BitbucketApi.Comment
• BitbucketApi.CommentAllOf
• BitbucketApi.CommentAllOfInline
• BitbucketApi.CommentAllOfLinks
• BitbucketApi.Commit
• BitbucketApi.CommitAllOf
• BitbucketApi.CommitComment
• BitbucketApi.CommitCommentAllOf
• BitbucketApi.CommitFile
• BitbucketApi.Commitstatus
• BitbucketApi.CommitstatusAllOf
• BitbucketApi.CommitstatusAllOfLinks
• BitbucketApi.Component
• [Bitbucke