Skip to content

Latest commit

 

History

History
222 lines (145 loc) · 20.4 KB

README.md

File metadata and controls

222 lines (145 loc) · 20.4 KB

Proxy

(proxy)

Available Operations

  • get - Make a GET request with the Proxy.
  • create - Make a POST request with the Proxy.
  • update - Make a PUT request with the Proxy.
  • modify - Make a PATCH request with the Proxy.
  • delete - Make a DELETE request with the Proxy.

get

Make a GET request with the Proxy.

Example Usage

import { Nango } from "@speakeasy-sdks/nango";

const nango = new Nango();

async function run() {
  await nango.proxy.get({
    anyPath: "<value>",
    dollarANYQUERYPARAMS: "<value>",
    connectionId: "<value>",
    providerConfigKey: "<value>",
  });

  
}

run();

Parameters

Parameter Type Required Description
request operations.GetProxyRequest ✔️ 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.

Response

Promise<void>

Errors

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

create

Make a POST request with the Proxy.

Example Usage

import { Nango } from "@speakeasy-sdks/nango";

const nango = new Nango();

async function run() {
  await nango.proxy.create({
    anyPath: "<value>",
    connectionId: "<value>",
    providerConfigKey: "<value>",
  });

  
}

run();

Parameters

Parameter Type Required Description
request operations.CreateProxyRequest ✔️ 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.

Response

Promise<void>

Errors

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

update

Make a PUT request with the Proxy.

Example Usage

import { Nango } from "@speakeasy-sdks/nango";

const nango = new Nango();

async function run() {
  await nango.proxy.update({
    anyPath: "<value>",
    connectionId: "<value>",
    providerConfigKey: "<value>",
  });

  
}

run();

Parameters

Parameter Type Required Description
request operations.PutProxyRequest ✔️ 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.

Response

Promise<void>

Errors

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

modify

Make a PATCH request with the Proxy.

Example Usage

import { Nango } from "@speakeasy-sdks/nango";

const nango = new Nango();

async function run() {
  await nango.proxy.modify({
    anyPath: "<value>",
    connectionId: "<value>",
    providerConfigKey: "<value>",
  });

  
}

run();

Parameters

Parameter Type Required Description
request operations.PatchProxyRequest ✔️ 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.

Response

Promise<void>

Errors

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

delete

Make a DELETE request with the Proxy.

Example Usage

import { Nango } from "@speakeasy-sdks/nango";

const nango = new Nango();

async function run() {
  await nango.proxy.delete({
    anyPath: "<value>",
    dollarANYQUERYPARAMS: "<value>",
    connectionId: "<value>",
    providerConfigKey: "<value>",
  });

  
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteProxyRequest ✔️ 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.

Response

Promise<void>

Errors

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