Skip to content

Latest commit

 

History

History
177 lines (126 loc) · 13.4 KB

README.md

File metadata and controls

177 lines (126 loc) · 13.4 KB

ObjectsAndFields

(objectsAndFields)

Overview

Available Operations

getMetadataForInstallation

Retrieves metadata about an object in a customer's SaaS instance, including its fields. This endpoint requires that an Installation exists for the given groupRef. It applies object mappings.

Example Usage

import { SDK } from "@amp-labs/sdk-node";

const sdk = new SDK({
  apiKeyHeader: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.objectsAndFields.getMetadataForInstallation({
    projectIdOrName: "<value>",
    integrationId: "<id>",
    objectName: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SDKCore } from "@amp-labs/sdk-node/core.js";
import { objectsAndFieldsGetMetadataForInstallation } from "@amp-labs/sdk-node/funcs/objectsAndFieldsGetMetadataForInstallation.js";

// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
  apiKeyHeader: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await objectsAndFieldsGetMetadataForInstallation(sdk, {
    projectIdOrName: "<value>",
    integrationId: "<id>",
    objectName: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.GetObjectMetadataForInstallationRequest ✔️ 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.
options.serverURL string ➖ An optional server URL to use.

Response

Promise<operations.GetObjectMetadataForInstallationResponse>

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

getMetadataForConnection

Retrieves metadata about an object in a customer's SaaS instance, including its fields. This endpoint only requires that a Connection exists for the given groupRef. It does not apply any object mappings.

Example Usage

import { SDK } from "@amp-labs/sdk-node";

const sdk = new SDK({
  apiKeyHeader: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.objectsAndFields.getMetadataForConnection({
    projectIdOrName: "<value>",
    provider: "<value>",
    objectName: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SDKCore } from "@amp-labs/sdk-node/core.js";
import { objectsAndFieldsGetMetadataForConnection } from "@amp-labs/sdk-node/funcs/objectsAndFieldsGetMetadataForConnection.js";

// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
  apiKeyHeader: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await objectsAndFieldsGetMetadataForConnection(sdk, {
    projectIdOrName: "<value>",
    provider: "<value>",
    objectName: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.GetObjectMetadataForConnectionRequest ✔️ 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.
options.serverURL string ➖ An optional server URL to use.

Response

Promise<operations.GetObjectMetadataForConnectionResponse>

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*