Interface: SmartLicense
index.SmartLicense
Interface representing the structure of a smart license as returned from the API
Table of contents
Properties
Properties
id
• id: string
smartLicenseHash
• smartLicenseHash: string
fileId
• fileId: string
title
• title: string
description
• description: string
status
• status: string
defaultTerms
• defaultTerms: Object
Index signature
▪ [key: string]: unknown
Type declaration
| Name | Type |
|---|---|
licenseRoyalties | number |
availableAgreements | string |
templateData
• Optional templateData: Object
Type declaration
| Name | Type |
|---|---|
version | number |
elements | { [key: string]: { type: "text" | "image" | "pdf" ; locations?: { page: number ; options: { x: number ; y: number ; width?: number ; height?: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } ; maxWidth?: number ; lineHeight?: number } }[] ; page?: number ; description?: string ; defaultText?: string | { text: string ; options: { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } ; maxWidth?: number ; lineHeight?: number } } }; } |
assets? | { page: number ; options: { thumbnailOptions: { x: number ; y: number ; width: number ; height: number } ; titleOptions: { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } } ; descriptionOptions: { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } } } ; description?: string } |
assets.page | number |
assets.options | { thumbnailOptions: { x: number ; y: number ; width: number ; height: number } ; titleOptions: { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } } ; descriptionOptions: { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } } } |
assets.options.thumbnailOptions | { x: number ; y: number ; width: number ; height: number } |
assets.options.thumbnailOptions.x | number |
assets.options.thumbnailOptions.y | number |
assets.options.thumbnailOptions.width | number |
assets.options.thumbnailOptions.height | number |
assets.options.titleOptions | { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } } |
assets.options.titleOptions.x | number |
assets.options.titleOptions.y | number |
assets.options.titleOptions.size? | number |
assets.options.titleOptions.color? | { type: string ; red: number ; green: number ; blue: number } |
assets.options.titleOptions.color.type | string |
assets.options.titleOptions.color.red | number |
assets.options.titleOptions.color.green | number |
assets.options.titleOptions.color.blue | number |
assets.options.descriptionOptions | { x: number ; y: number ; size?: number ; color?: { type: string ; red: number ; green: number ; blue: number } } |
assets.options.descriptionOptions.x | number |
assets.options.descriptionOptions.y | number |
assets.options.descriptionOptions.size? | number |
assets.options.descriptionOptions.color? | { type: string ; red: number ; green: number ; blue: number } |
assets.options.descriptionOptions.color.type | string |
assets.options.descriptionOptions.color.red | number |
assets.options.descriptionOptions.color.green | number |
assets.options.descriptionOptions.color.blue | number |
assets.description? | string |
steps | { name: "listing" | "signing" ; elementRefs: string[] ; assetRef?: boolean ; mutuallyExclusiveGroups?: { groupName: string ; elements: string[] }[] }[] |
defaultTextOptions? | { size: number ; color: { type: string ; red: number ; green: number ; blue: number } ; font: string } |
defaultTextOptions.size | number |
defaultTextOptions.color | { type: string ; red: number ; green: number ; blue: number } |
defaultTextOptions.color.type | string |
defaultTextOptions.color.red | number |
defaultTextOptions.color.green | number |
defaultTextOptions.color.blue | number |
defaultTextOptions.font | string |
metadata
• Optional metadata: Object
Index signature
▪ [key: string]: unknown
Type declaration
| Name | Type |
|---|---|
properties? | { title: string ; properties: string[] }[] |
templateDefaultValues? | Record<string, string> |