netlifys_api_definition v0.2.0

netlifys_api_definition

NetlifysApiDefinition - JavaScript client for netlifys_api_definition 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: 0.2.0
• Package version: 0.2.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 netlifys_api_definition --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 netlifys_api_definition from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('netlifys_api_definition') 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 NetlifysApiDefinition = require('netlifys_api_definition');

var defaultClient = NetlifysApiDefinition.ApiClient.instance;

// Configure OAuth2 access token for authorization: netlifyAuth
var netlifyAuth = defaultClient.authentications['netlifyAuth'];
netlifyAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new NetlifysApiDefinition.DefaultApi()

var accountSlug = "accountSlug_example"; // {String} 

var email = "email_example"; // {String} 

var opts = { 
  'role': "role_example" // {String} 
};

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

Documentation for API Endpoints

All URIs are relative to https://api.netlify.com/api/v1

Documentation for Models

• NetlifysApiDefinition.AccessToken
• NetlifysApiDefinition.AccountMembership
• NetlifysApiDefinition.AccountMembershipCapabilities
• NetlifysApiDefinition.AccountSetup
• NetlifysApiDefinition.AccountType
• NetlifysApiDefinition.AccountUpdateSetup
• NetlifysApiDefinition.AccountUsageCapability
• NetlifysApiDefinition.Asset
• NetlifysApiDefinition.AssetForm
• NetlifysApiDefinition.AssetPublicSignature
• NetlifysApiDefinition.AssetSignature
• NetlifysApiDefinition.AuditLog
• NetlifysApiDefinition.Build
• NetlifysApiDefinition.BuildHook
• NetlifysApiDefinition.BuildLogMsg
• NetlifysApiDefinition.Deploy
• NetlifysApiDefinition.DeployFiles
• NetlifysApiDefinition.DeployKey
• NetlifysApiDefinition.DeployedBranch
• NetlifysApiDefinition.DnsRecord
• NetlifysApiDefinition.DnsZone
• NetlifysApiDefinition.Error
• NetlifysApiDefinition.File
• NetlifysApiDefinition.Form
• NetlifysApiDefinition.Hook
• NetlifysApiDefinition.HookType
• NetlifysApiDefinition.Member
• NetlifysApiDefinition.Metadata
• NetlifysApiDefinition.MinifyOptions
• NetlifysApiDefinition.ModelFunction
• NetlifysApiDefinition.PaymentMethod
• NetlifysApiDefinition.PaymentMethodData
• NetlifysApiDefinition.RepoInfo
• NetlifysApiDefinition.Site
• NetlifysApiDefinition.SiteProcessingSettings
• NetlifysApiDefinition.SiteProcessingSettingsHtml
• NetlifysApiDefinition.SiteProcessingSettingsImages
• NetlifysApiDefinition.SniCertificate
• NetlifysApiDefinition.Snippet
• NetlifysApiDefinition.Submission
• NetlifysApiDefinition.Ticket
• NetlifysApiDefinition.User
• NetlifysApiDefinition.UserOnboardingProgress
• NetlifysApiDefinition.SiteSetup

Documentation for Authorization

netlifyAuth

• Type: OAuth
• Flow: implicit
• Authorization URL: https://app.netlify.com/authorize
• Scopes: N/A