Class OrnamentSDK

constructor

• new OrnamentSDK(baseUrl?): OrnamentSDK

• Parameters

  • Optional baseUrl: string

  Returns OrnamentSDK

initialized

patients

init

• init(config): Promise<void>

• Initializes SDK with given Config. Call this method before using SDK

  Parameters

  • config: Config

    object with API key

  Returns Promise<void>

  Throws

  InitializationError

send

• send(payload): Promise<UploadResult[]>

• This method will send PDF files from provided links to the Ornament API.

  If user with given e-mail does not exist, it will be created and connected to your account. Digitized lab reports will be displayed in the Lab Reports section of the patient with given e-mail.

  For every url provided will be created a task. Method will return an array of length equal to urls.length where each item will be UploadResult corresponded to each url by index See UploadResult for more information

  Parameters

  • payload: SendPayload

  Returns Promise<UploadResult[]>

  Throws

  InitializationError ServerError ForbiddenPatientError BadRequestError

  Example

  const result = await OrnamentSDK.send({
    email: '[email protected]',
    urls: [
      'https://example.com/my_lab_report_1.pdf',
      'https://example.com/my_lab_report_2.pdf',
      'https://example.com/my_lab_report_3.pdf',
    ],
  });
  
  * const result = await OrnamentSDK.send({
    email: '[email protected]',
    files: [
      blob1,
      blob2,
    ],
  });
  
  // result = [UploadResult<urls[0]>, UploadResult<urls[1]>, UploadResult<urls[2]>]
  Copy