@skylab-tech/skylab-studio

    1.0.1 • Public • Published

    Skylab Studio JavaScript Client

    CircleCI Maintainability Test Coverage

    SkylabTech Studio JavaScript client.

    studio.skylabtech.ai

    Installation

    npm install skylab-studio
    

    Usage

    All callbacks accept err and response:

    var api = require('skylab-studio')('API_KEY')
    
    var callback = function (err, response) {
      if (err) {
        console.log(err.statusCode, response)
      } else {
        console.log(response)
      }
    }
    
    api.createJob(data, callback)

    Jobs

    List all Jobs

    api.listJobs({}, callback)

    Create a Job

    api.createJob(
      {
        job: {
          profile_id: 123
        }
      },
      callback
    )

    Get a Job

    api.getJob({ id: 1 }, callback)

    Update a Job

    api.updateJob(
      {
        id: 1,
        job: {
          profile_id: 456
        }
      },
      callback
    )

    Delete a Job

    api.deleteJob({ id: 1 }, callback)

    Process a Job

    api.processJob({ id: 1 }, callback)

    Cancel a Job

    api.cancelJob({ id: 1 }, callback)

    Profiles

    List all Profiles

    api.listProfiles({}, callback)

    Create a Profile

    api.createProfile(
      {
        profile: {
          name: 'My Profile'
        }
      },
      callback
    )

    Get a Profile

    api.getProfile({ id: 1 }, callback)

    Update a Profile

    api.updateProfile(
      {
        id: 1,
        job: {
          name: 'Updated Name'
        }
      },
      callback
    )

    Delete a Profile

    api.deleteProfile({ id: 1 }, callback)

    Photos

    List all Photos

    api.listPhotos({}, callback)

    Create a Photo

    api.createPhoto(
      {
        profile: {
          name: 'My Photo'
        }
      },
      callback
    )

    Get a Photo

    api.getPhoto({ id: 1 }, callback)

    Update a Photo

    api.updatePhoto(
      {
        id: 1,
        job: {
          name: 'Updated Name'
        }
      },
      callback
    )

    Delete a Photo

    api.deletePhoto({ id: 1 }, callback)

    Troubleshooting

    General Troubleshooting

    • Enable debug mode
    • Make sure you're using the latest Node client
    • Capture the response data and check your logs — often this will have the exact error

    Enable Debug Mode

    Debug mode prints out the underlying request information as well as the data payload that gets sent to Skylab. You will most likely find this information in your logs. To enable it, simply put debug=true as a parameter when instantiating the API object.

    var api = require('skylab-studio')('API_KEY', (debug = true))

    Response Ranges

    SkylabTech's API typically sends responses back in these ranges:

    • 2xx – Successful Request
    • 4xx – Failed Request (Client error)
    • 5xx – Failed Request (Server error)

    If you're receiving an error in the 400 response range follow these steps:

    • Double check the data and ID's getting passed to Skylab
    • Ensure your API key is correct
    • Log and check the body of the response

    Tests

    To run the tests:

    $ npm run test

    Install

    npm i @skylab-tech/skylab-studio

    DownloadsWeekly Downloads

    7

    Version

    1.0.1

    License

    Apache-2.0

    Unpacked Size

    41 kB

    Total Files

    16

    Last publish

    Collaborators

    • kev-le
    • paul-skylab-tech