insomnia-importers
Version:
Various data importers for Insomnia
647 lines (643 loc) • 18.9 kB
text/typescript
// generated from https://schema.getpostman.com/json/collection/v2.1.0/collection.json
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and run json-schema-to-typescript to regenerate this file.
*/
/**
* A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content.
*/
export type NameOfTheCollection = string;
/**
* A Description can be a raw text, or be an object, which holds the description along with its format.
*/
export type DefinitionsDescription = Description | string | null;
/**
* Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!
*/
export type CollectionVersion =
| {
/**
* Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).
*/
major: number;
/**
* You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.
*/
minor: number;
/**
* Ideally, minor changes to a collection should result in the increment of this number.
*/
patch: number;
/**
* A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'
*/
identifier?: string;
meta?: unknown;
[]: unknown;
}
| string;
export type Items = Item | Folder;
/**
* Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.
*/
export type Variable = Variable1 & Variable2;
export type Variable1 =
| {
[]: unknown;
}
| {
[]: unknown;
}
| {
[]: unknown;
};
/**
* Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.
* *Note: Collection variables must not contain any sensitive information.*
*/
export type VariableList = Variable[];
/**
* If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
*/
export type Url =
| {
/**
* The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).
*/
raw?: string;
/**
* The protocol associated with the request, E.g: 'http'
*/
protocol?: string;
host?: Host;
path?:
| string
| (
| string
| {
type?: string;
value?: string;
[]: unknown;
}
)[];
/**
* The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.
*/
port?: string;
/**
* An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables
*/
query?: QueryParam[];
/**
* Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.
*/
hash?: string;
/**
* Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.
*/
variable?: Variable1[];
[]: unknown;
}
| string;
/**
* The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.
*/
export type Host = string | string[];
/**
* Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.
*/
export type EventList = Event[];
/**
* A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.
*/
export type Request = Request1 | string;
/**
* The attributes for API Key Authentication.
*/
export type APIKeyAuthentication = Auth1[];
/**
* The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
*/
export type AWSSignatureV4 = Auth1[];
/**
* The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).
*/
export type BasicAuthentication = Auth1[];
/**
* The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)
*/
export type BearerTokenAuthentication = Auth1[];
/**
* The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).
*/
export type DigestAuthentication = Auth1[];
/**
* The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).
*/
export type EdgeGridAuthentication = Auth1[];
/**
* The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)
*/
export type HawkAuthentication = Auth1[];
/**
* The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)
*/
export type NTLMAuthentication = Auth1[];
/**
* The attributes for [OAuth2](https://oauth.net/1/)
*/
export type OAuth1 = Auth1[];
/**
* Helper attributes for [OAuth2](https://oauth.net/2/)
*/
export type OAuth2 = Auth1[];
/**
* A representation for a list of headers
*/
export type HeaderList = Header[];
export type FormParameter =
| {
key: string;
value?: string;
/**
* When set to true, prevents this form data entity from being sent.
*/
disabled?: boolean;
type?: 'text';
/**
* Override Content-Type header of this form data entity.
*/
contentType?: string;
description?: DefinitionsDescription;
[]: unknown;
}
| {
key: string;
src?: string | null | unknown[];
/**
* When set to true, prevents this form data entity from being sent.
*/
disabled?: boolean;
type?: 'file';
/**
* Override Content-Type header of this form data entity.
*/
contentType?: string;
description?: DefinitionsDescription;
[]: unknown;
};
/**
* The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`.
*/
export type ResponseTime = null | string | number;
/**
* Set of timing information related to request and response in milliseconds
*/
export type ResponseTimings = {
[]: unknown;
} | null;
export type Headers = Header1 | string | null;
export type Header2 = string;
/**
* No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.
*/
export type Header1 = (Header | Header2)[];
export type Responses = Response[];
export type Items1 = Item | Folder;
export interface HttpsSchemaGetpostmanComJsonCollectionV210 {
info: Information;
/**
* Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.
*/
item: Items[];
event?: EventList;
variable?: VariableList;
auth?: null | Auth;
protocolProfileBehavior?: ProtocolProfileBehavior;
[]: unknown;
}
/**
* Detailed description of the info block
*/
export interface Information {
name: NameOfTheCollection;
/**
* Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.
* *Note: This field exists for compatibility reasons with Collection Format V1.*
*/
_postman_id?: string;
description?: DefinitionsDescription;
version?: CollectionVersion;
/**
* This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1
*/
schema: string;
[]: unknown;
}
export interface Description {
/**
* The content of the description goes here, as a raw string.
*/
content?: string;
/**
* Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.
* The type is used to correctly render the description when generating documentation, or in the Postman app.
*/
type?: string;
/**
* Description can have versions associated with it, which should be put in this property.
*/
version?: {
[]: unknown;
};
[]: unknown;
}
/**
* Items are entities which contain an actual HTTP request, and sample responses attached to it.
*/
export interface Item {
/**
* A unique ID that is used to identify collections internally
*/
id?: string;
/**
* A human readable identifier for the current item.
*/
name?: string;
description?: DefinitionsDescription;
variable?: VariableList;
event?: EventList;
request: Request;
response?: Responses;
protocolProfileBehavior?: ProtocolProfileBehavior;
[]: unknown;
}
export interface Variable2 {
/**
* A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.
*/
id?: string;
/**
* A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.
*/
key?: string;
/**
* The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection
*/
value?: {
[]: unknown;
};
/**
* A variable may have multiple types. This field specifies the type of the variable.
*/
type?: 'string' | 'boolean' | 'any' | 'number';
/**
* Variable name
*/
name?: string;
description?: DefinitionsDescription;
/**
* When set to true, indicates that this variable has been set by Postman
*/
system?: boolean;
disabled?: boolean;
[]: unknown;
}
/**
* Defines a script associated with an associated event name
*/
export interface Event {
/**
* A unique identifier for the enclosing event.
*/
id?: string;
/**
* Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.
*/
listen: string;
script?: Script;
/**
* Indicates whether the event is disabled. If absent, the event is assumed to be enabled.
*/
disabled?: boolean;
[]: unknown;
}
/**
* A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.
*/
export interface Script {
/**
* A unique, user defined identifier that can be used to refer to this script from requests.
*/
id?: string;
/**
* Type of the script. E.g: 'text/javascript'
*/
type?: string;
exec?: string[] | string;
src?: Url;
/**
* Script name
*/
name?: string;
[]: unknown;
}
export interface QueryParam {
key?: string | null;
value?: string | null;
/**
* If set to true, the current query parameter will not be sent with the request.
*/
disabled?: boolean;
description?: DefinitionsDescription;
[]: unknown;
}
export interface Request1 {
url?: Url;
auth?: null | Auth;
proxy?: ProxyConfig;
certificate?: Certificate;
method?:
| (
| 'GET'
| 'PUT'
| 'POST'
| 'PATCH'
| 'DELETE'
| 'COPY'
| 'HEAD'
| 'OPTIONS'
| 'LINK'
| 'UNLINK'
| 'PURGE'
| 'LOCK'
| 'UNLOCK'
| 'PROPFIND'
| 'VIEW'
)
| string;
description?: DefinitionsDescription;
header?: HeaderList | string;
body?: {
/**
* Postman stores the type of data associated with this request in this field.
*/
mode?: 'raw' | 'urlencoded' | 'formdata' | 'file' | 'graphql';
raw?: string;
urlencoded?: UrlEncodedParameter[];
formdata?: FormParameter[];
file?: {
src?: string | null;
content?: string;
[]: unknown;
};
graphql?: {
[]: unknown;
};
/**
* Additional configurations and options set for various body modes.
*/
options?: {
[]: unknown;
};
/**
* When set to true, prevents request body from being sent.
*/
disabled?: boolean;
[]: unknown;
} | null;
[]: unknown;
}
/**
* Represents authentication helpers provided by Postman
*/
export interface Auth {
type:
| 'apikey'
| 'awsv4'
| 'basic'
| 'bearer'
| 'digest'
| 'edgegrid'
| 'hawk'
| 'noauth'
| 'oauth1'
| 'oauth2'
| 'ntlm';
noauth?: unknown;
apikey?: APIKeyAuthentication;
awsv4?: AWSSignatureV4;
basic?: BasicAuthentication;
bearer?: BearerTokenAuthentication;
digest?: DigestAuthentication;
edgegrid?: EdgeGridAuthentication;
hawk?: HawkAuthentication;
ntlm?: NTLMAuthentication;
oauth1?: OAuth1;
oauth2?: OAuth2;
[]: unknown;
}
/**
* Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.
*/
export interface Auth1 {
key: string;
value?: unknown;
type?: string;
[]: unknown;
}
/**
* Using the Proxy, you can configure your custom proxy into the postman for particular url match
*/
export interface ProxyConfig {
/**
* The Url match for which the proxy config is defined
*/
match?: string;
/**
* The proxy server host
*/
host?: string;
/**
* The proxy server port
*/
port?: number;
/**
* The tunneling details for the proxy config
*/
tunnel?: boolean;
/**
* When set to true, ignores this proxy configuration entity
*/
disabled?: boolean;
[]: unknown;
}
/**
* A representation of an ssl certificate
*/
export interface Certificate {
/**
* A name for the certificate for user reference
*/
name?: string;
/**
* A list of Url match pattern strings, to identify Urls this certificate can be used for.
*/
matches?: string[];
/**
* An object containing path to file containing private key, on the file system
*/
key?: {
/**
* The path to file containing key for certificate, on the file system
*/
src?: {
[]: unknown;
};
[]: unknown;
};
/**
* An object containing path to file certificate, on the file system
*/
cert?: {
/**
* The path to file containing key for certificate, on the file system
*/
src?: {
[]: unknown;
};
[]: unknown;
};
/**
* The passphrase for the certificate
*/
passphrase?: string;
[]: unknown;
}
/**
* Represents a single HTTP Header
*/
export interface Header {
/**
* This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``
*/
key: string;
/**
* The value (or the RHS) of the Header is stored in this field.
*/
value: string;
/**
* If set to true, the current header will not be sent with requests.
*/
disabled?: boolean;
description?: DefinitionsDescription;
[]: unknown;
}
export interface UrlEncodedParameter {
key: string;
value?: string;
disabled?: boolean;
description?: DefinitionsDescription;
[]: unknown;
}
/**
* A response represents an HTTP response.
*/
export interface Response {
/**
* A unique, user defined identifier that can be used to refer to this response from requests.
*/
id?: string;
originalRequest?: Request;
responseTime?: ResponseTime;
timings?: ResponseTimings;
header?: Headers;
cookie?: Cookie[];
/**
* The raw text of the response.
*/
body?: null | string;
/**
* The response status, e.g: '200 OK'
*/
status?: string;
/**
* The numerical response code, example: 200, 201, 404, etc.
*/
code?: number;
[]: unknown;
}
/**
* A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)
*/
export interface Cookie {
/**
* The domain for which this cookie is valid.
*/
domain: string;
/**
* When the cookie expires.
*/
expires?: string | number;
maxAge?: string;
/**
* True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie).
*/
hostOnly?: boolean;
/**
* Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)
*/
httpOnly?: boolean;
/**
* This is the name of the Cookie.
*/
name?: string;
/**
* The path associated with the Cookie.
*/
path: string;
/**
* Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)
*/
secure?: boolean;
/**
* True if the cookie is a session cookie.
*/
session?: boolean;
/**
* The value of the Cookie.
*/
value?: string;
/**
* Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)
*/
extensions?: unknown[];
[]: unknown;
}
/**
* Set of configurations used to alter the usual behavior of sending the request
*/
export interface ProtocolProfileBehavior {
[]: unknown;
}
/**
* One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.
*/
export interface Folder {
/**
* A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder.
*/
name?: string;
description?: DefinitionsDescription;
variable?: VariableList;
/**
* Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.
*/
item: Items1[];
event?: EventList;
auth?: null | Auth;
protocolProfileBehavior?: ProtocolProfileBehavior;
[]: unknown;
}