Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiRequestOptions

Hierarchy

  • ApiRequestOptions

Index

Properties

endpoint

endpoint: string

The desired endpoint (e.g. 'vendors'); don't include a leading slash.

method

method: "GET" | "POST" | "PUT" | "DELETE"

The HTTP method for this request.

Optional query

query?: {}

Any desired query params as an object (e.g. { name: 'Acme' } will become ?name=Acme).

Type declaration

  • [key: string]: any

Optional body

body?: any

Request body.

Optional apiVersion

apiVersion?: string

The API version.

Optional idempotency_key

idempotency_key?: string

An idempotency key for the request (by default, a UUID is generated for each request, but you should provide one manually to ensure true idempotency).

Generated using TypeDoc