@papersites/sdk

papersites-sdk

How to use this SDK

1. Configure settings

   • for local test & debug purposes you can use staticSettingsProvider that is provided as part of this API

   • in production you need to implement ISettingsProvider that provides the followin configuration settings:

     • api/async-operation-timeout-ms - async operation timeout, e.g. work request
     • tenant/viewlinktemplate - public papersites-managed site URL
     • tenant/managelinktemplate - admin papersites-managed site URL
     • api-spec/host - API hostname
     • api-spec/schemes - arrays of allowed schemes: http or https or both
     • api-spec/port -API port
     • api-spec/basePath - base path for API operations
     • api-spec/accepts - accepted content type
     • api-spec/securityDefinitions - security mechanism to use. For Papersites currently only papersites_auth is supported and it has the following configuration settings:

     {
         "papersites_auth": {
             "type": "papersites_auth",
             "description": "Papersites via Auth0",
             "name": "papersites_auth"
         }
     }
     

2. How to build and deploy

• bump version in the package.json
• npm run deploy