JS Quickstart

npm install @cloudterms/js

# Your application ID
CLOUDTERMS_APP_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# Your application secret
CLOUDTERMS_APP_SECRET="sk_live.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

import { CloudTerms } from '@cloudterms/js'
 
// Initialize the SDK
const cloudterms = CloudTerms()
// You can also pass in your application ID and secret, this will override the environment variables
const cloudterms2 = CloudTerms({ appId: 'my-app-id', secret: 'my-app-secret' })
 
// Get all your applications terms
const terms = await cloudterms.terms.get()
 
// Check if a user has agreed to the latest terms
const hasAgreed = await cloudterms.user.hasAgreed('some-unique-user-id')
 
// Set that a user has agreed to the latest terms
const setAgreed = await cloudterms.user.setAgreed('some-unique-user-id')

{
  terms: [
    {
      id: number
      applicationId: string // Your application ID
      name: string // Name of the term
      userId: string // Unique user ID provided by your application
      orgId: string | null // Your organization ID in CloudTerms, if applicable
      termId: string
      content: string // HTML content of the term
      createdAt: Date
      updatedAt: Date
    }
  ]
}

{
  userId: string // Unique user ID provided by your application
}

{
  hasAgreed: boolean
}

{
  userId: string // Unique user ID provided by your application
}

{
  userId: string
  applicationId: string
  lastAgreed: Date | null // Date the user last agreed to the terms, or null if they have never agreed
}