log10ts/docs/sdks/feedbacksdk/README.md

FeedbackSDK

(feedback)

Overview

Feedback

Available Operations

• get - Fetch feedback by id.
• upload - Upload a piece of feedback

get

Fetch feedback by id.

Example Usage

import { Log10 } from "log10ts";

const log10 = new Log10({
  log10Token: "<YOUR_API_KEY_HERE>",
  xLog10Organization: "<value>",
});

async function run() {
  const result = await log10.feedback.get("<value>", "<value>");

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
feedbackId	string	✔️	The feedback id to fetch.
xLog10Organization	string	➖	N/A
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.GetResponse>

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

upload

Upload a piece of feedback

Example Usage

import { Log10 } from "log10ts";

const log10 = new Log10({
  log10Token: "<YOUR_API_KEY_HERE>",
  xLog10Organization: "<value>",
});

async function run() {
  const result = await log10.feedback.upload({
      taskId: "<value>",
      jsonValues: {},
      matchedCompletionIds: [
        "<value>",
      ],
      comment: "The slim & simple Maple Gaming Keyboard from Dev Byte comes with a sleek body and 7- Color RGB LED Back-lighting for smart functionality",
      completionTagsSelector: [
        "<value>",
      ],
    }, "<value>");

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
requestBody	models.UploadRequestBody	✔️	N/A
xLog10Organization	string	➖	N/A
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.UploadResponse>

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/