README.md

AuditLogs

Overview

Available Operations

• list - List audit log entries

list

Returns a list of activity by dashboard users.

Example Usage

import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
    id: "example",
    server: "sandbox",
    merchantAccountId: "default",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.auditLogs.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Standalone function

The standalone function version of this method:

import { Gr4vyCore } from "@gr4vy/sdk/core.js";
import { auditLogsList } from "@gr4vy/sdk/funcs/auditLogsList.js";

// Use `Gr4vyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const gr4vy = new Gr4vyCore({
  merchantAccountId: "<id>",
  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await auditLogsList(gr4vy);
  if (res.ok) {
    const { value: result } = res;
    for await (const page of result) {
    console.log(page);
  }
  } else {
    console.log("auditLogsList failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.ListAuditLogsRequest	✔️	The request object to use for the request.
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.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ListAuditLogsResponse>

Errors

Error Type	Status Code	Content Type
errors.Error400	400	application/json
errors.Error401	401	application/json
errors.Error403	403	application/json
errors.Error404	404	application/json
errors.Error405	405	application/json
errors.Error409	409	application/json
errors.HTTPValidationError	422	application/json
errors.Error425	425	application/json
errors.Error429	429	application/json
errors.Error500	500	application/json
errors.Error502	502	application/json
errors.Error504	504	application/json
errors.SDKError	4XX, 5XX	*/*