netlifys_api_definition

    0.2.0 • Public • Published

    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

    Class Method HTTP request Description
    NetlifysApiDefinition.DefaultApi addMemberToAccount POST /{account_slug}/members
    NetlifysApiDefinition.DefaultApi cancelAccount DELETE /accounts/{account_id}
    NetlifysApiDefinition.DefaultApi configureDNSForSite PUT /sites/{site_id}/dns
    NetlifysApiDefinition.DefaultApi createAccount POST /accounts
    NetlifysApiDefinition.DefaultApi createDeployKey POST /deploy_keys
    NetlifysApiDefinition.DefaultApi createHookBySiteId POST /hooks
    NetlifysApiDefinition.DefaultApi createSite POST /sites
    NetlifysApiDefinition.DefaultApi createSiteAsset POST /sites/{site_id}/assets
    NetlifysApiDefinition.DefaultApi createSiteBuildHook POST /sites/{site_id}/build_hooks
    NetlifysApiDefinition.DefaultApi createSiteDeploy POST /sites/{site_id}/deploys
    NetlifysApiDefinition.DefaultApi createSiteInTeam POST /{account_slug}/sites
    NetlifysApiDefinition.DefaultApi createSiteSnippet POST /sites/{site_id}/snippets
    NetlifysApiDefinition.DefaultApi createTicket POST /oauth/tickets
    NetlifysApiDefinition.DefaultApi deleteDeployKey DELETE /deploy_keys/{key_id}
    NetlifysApiDefinition.DefaultApi deleteHookBySiteId DELETE /hooks/{hook_id}
    NetlifysApiDefinition.DefaultApi deleteSite DELETE /sites/{site_id}
    NetlifysApiDefinition.DefaultApi deleteSiteAsset DELETE /sites/{site_id}/assets/{asset_id}
    NetlifysApiDefinition.DefaultApi deleteSiteBuildHook DELETE /sites/{site_id}/build_hooks/{id}
    NetlifysApiDefinition.DefaultApi deleteSiteSnippet DELETE /sites/{site_id}/snippets/{snippet_id}
    NetlifysApiDefinition.DefaultApi deleteSubmission DELETE /submissions/{submission_id}
    NetlifysApiDefinition.DefaultApi enableHook POST /hooks/{hook_id}/enable
    NetlifysApiDefinition.DefaultApi exchangeTicket POST /oauth/tickets/{ticket_id}/exchange
    NetlifysApiDefinition.DefaultApi getCurrentUser GET /user
    NetlifysApiDefinition.DefaultApi getDNSForSite GET /sites/{site_id}/dns
    NetlifysApiDefinition.DefaultApi getDeploy GET /deploys/{deploy_id}
    NetlifysApiDefinition.DefaultApi getDeployKey GET /deploy_keys/{key_id}
    NetlifysApiDefinition.DefaultApi getHook GET /hooks/{hook_id}
    NetlifysApiDefinition.DefaultApi getSite GET /sites/{site_id}
    NetlifysApiDefinition.DefaultApi getSiteAssetInfo GET /sites/{site_id}/assets/{asset_id}
    NetlifysApiDefinition.DefaultApi getSiteAssetPublicSignature GET /sites/{site_id}/assets/{asset_id}/public_signature
    NetlifysApiDefinition.DefaultApi getSiteBuild GET /builds/{build_id}
    NetlifysApiDefinition.DefaultApi getSiteBuildHook GET /sites/{site_id}/build_hooks/{id}
    NetlifysApiDefinition.DefaultApi getSiteDeploy GET /sites/{site_id}/deploys/{deploy_id}
    NetlifysApiDefinition.DefaultApi getSiteFileByPathName GET /sites/{site_id}/files/{file_path}
    NetlifysApiDefinition.DefaultApi getSiteMetadata GET /sites/{site_id}/metadata
    NetlifysApiDefinition.DefaultApi getSiteSnippet GET /sites/{site_id}/snippets/{snippet_id}
    NetlifysApiDefinition.DefaultApi listAccountAuditEvents GET /accounts/{account_id}/audit
    NetlifysApiDefinition.DefaultApi listAccountTypesForUser GET /accounts/types
    NetlifysApiDefinition.DefaultApi listAccountsForUser GET /accounts
    NetlifysApiDefinition.DefaultApi listDeployKeys GET /deploy_keys
    NetlifysApiDefinition.DefaultApi listFormSubmission GET /submissions/{submission_id}
    NetlifysApiDefinition.DefaultApi listFormSubmissions GET /forms/{form_id}/submissions
    NetlifysApiDefinition.DefaultApi listForms GET /forms
    NetlifysApiDefinition.DefaultApi listHookTypes GET /hooks/types
    NetlifysApiDefinition.DefaultApi listHooksBySiteId GET /hooks
    NetlifysApiDefinition.DefaultApi listMembersForAccount GET /{account_slug}/members
    NetlifysApiDefinition.DefaultApi listPaymentMethodsForUser GET /billing/payment_methods
    NetlifysApiDefinition.DefaultApi listSiteAssets GET /sites/{site_id}/assets
    NetlifysApiDefinition.DefaultApi listSiteBuildHooks GET /sites/{site_id}/build_hooks
    NetlifysApiDefinition.DefaultApi listSiteBuilds GET /sites/{site_id}/builds
    NetlifysApiDefinition.DefaultApi listSiteDeployedBranches GET /sites/{site_id}/deployed-branches
    NetlifysApiDefinition.DefaultApi listSiteDeploys GET /sites/{site_id}/deploys
    NetlifysApiDefinition.DefaultApi listSiteFiles GET /sites/{site_id}/files
    NetlifysApiDefinition.DefaultApi listSiteForms GET /sites/{site_id}/forms
    NetlifysApiDefinition.DefaultApi listSiteSnippets GET /sites/{site_id}/snippets
    NetlifysApiDefinition.DefaultApi listSiteSubmissions GET /sites/{site_id}/submissions
    NetlifysApiDefinition.DefaultApi listSites GET /sites
    NetlifysApiDefinition.DefaultApi listSitesForAccount GET /{account_slug}/sites
    NetlifysApiDefinition.DefaultApi lockDeploy POST /deploys/{deploy_id}/lock
    NetlifysApiDefinition.DefaultApi notifyBuildStart POST /builds/{build_id}/start
    NetlifysApiDefinition.DefaultApi provisionSiteTLSCertificate POST /sites/{site_id}/ssl
    NetlifysApiDefinition.DefaultApi restoreSiteDeploy POST /sites/{site_id}/deploys/{deploy_id}/restore
    NetlifysApiDefinition.DefaultApi showSiteTLSCertificate GET /sites/{site_id}/ssl
    NetlifysApiDefinition.DefaultApi showTicket GET /oauth/tickets/{ticket_id}
    NetlifysApiDefinition.DefaultApi unlockDeploy POST /deploys/{deploy_id}/unlock
    NetlifysApiDefinition.DefaultApi updateAccount PUT /accounts/{account_id}
    NetlifysApiDefinition.DefaultApi updateHook PUT /hooks/{hook_id}
    NetlifysApiDefinition.DefaultApi updateSite PATCH /sites/{site_id}
    NetlifysApiDefinition.DefaultApi updateSiteAsset PUT /sites/{site_id}/assets/{asset_id}
    NetlifysApiDefinition.DefaultApi updateSiteBuildHook PUT /sites/{site_id}/build_hooks/{id}
    NetlifysApiDefinition.DefaultApi updateSiteBuildLog POST /builds/{build_id}/log
    NetlifysApiDefinition.DefaultApi updateSiteDeploy PUT /sites/{site_id}/deploys/{deploy_id}
    NetlifysApiDefinition.DefaultApi updateSiteMetadata PUT /sites/{site_id}/metadata
    NetlifysApiDefinition.DefaultApi updateSiteSnippet PUT /sites/{site_id}/snippets/{snippet_id}
    NetlifysApiDefinition.DefaultApi uploadDeployFile PUT /deploys/{deploy_id}/files/{path}
    NetlifysApiDefinition.DefaultApi uploadDeployFunction PUT /deploys/{deploy_id}/functions/{name}

    Documentation for Models

    Documentation for Authorization

    netlifyAuth

    Keywords

    none

    Install

    npm i netlifys_api_definition

    DownloadsWeekly Downloads

    3

    Version

    0.2.0

    License

    Unlicense

    Unpacked Size

    623 kB

    Total Files

    144

    Last publish

    Collaborators

    • lukeoliff
    • ascorbic
    • zachleat
    • nasiba
    • netlify-bot
    • charliegerard
    • eduardoboucas
    • jgantunes
    • biilmann
    • benaiah
    • erquhart
    • shortdiv
    • marcus.netlify
    • ehmicky
    • erezro
    • lesliecdubs
    • futuregerald
    • neolegends
    • lindsaylevine
    • bret