coding_as_activism

CodingAsActivism - JavaScript client for coding_as_activism TODO: Add Description This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 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 coding_as_activism --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 coding_as_activism from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

var defaultClient = CodingAsActivism.ApiClient.instance;

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

var api = new CodingAsActivism.MiscApi()

var contentType = "contentType_example"; // {String} 

var body = new CodingAsActivism.HelloworldRequest(); // {HelloworldRequest} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.echoesPost(contentType, body, callback);

Documentation for API Endpoints

All URIs are relative to https://api.securevan.com/v4

Class	Method	HTTP request	Description
CodingAsActivism.MiscApi	echoesPost	POST /echoes	Hello world
CodingAsActivism.MiscApi	events4306Get	GET /events/4306	Get event details
CodingAsActivism.MiscApi	people100879417CanvassResponsesPost	POST /people/100879417/canvassResponses	Collect canvass data
CodingAsActivism.MiscApi	peopleFindOrCreatePost	POST /people/findOrCreate	Create a volunteer record
CodingAsActivism.MiscApi	signupsPost	POST /signups	RSVP to an event

Documentation for Models

• CodingAsActivism.CanvassContext
• CodingAsActivism.CollectcanvassdataRequest
• CodingAsActivism.CreateavolunteerrecordRequest
• CodingAsActivism.Email
• CodingAsActivism.Event
• CodingAsActivism.HelloworldRequest
• CodingAsActivism.Location
• CodingAsActivism.Person
• CodingAsActivism.RSVPtoaneventRequest
• CodingAsActivism.Response
• CodingAsActivism.Role
• CodingAsActivism.Shift
• CodingAsActivism.Status

Documentation for Authorization

auth

• Type: HTTP basic authentication