ibm-cloud-sdk-core
Version:
Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.
1,410 lines • 335 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.52.8",
"schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"noStandardTags": true,
"tagDefinitions": [
{
"tagName": "@alpha",
"syntaxKind": "modifier"
},
{
"tagName": "@beta",
"syntaxKind": "modifier"
},
{
"tagName": "@defaultValue",
"syntaxKind": "block"
},
{
"tagName": "@decorator",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@deprecated",
"syntaxKind": "block"
},
{
"tagName": "@eventProperty",
"syntaxKind": "modifier"
},
{
"tagName": "@example",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@experimental",
"syntaxKind": "modifier"
},
{
"tagName": "@inheritDoc",
"syntaxKind": "inline"
},
{
"tagName": "@internal",
"syntaxKind": "modifier"
},
{
"tagName": "@label",
"syntaxKind": "inline"
},
{
"tagName": "@link",
"syntaxKind": "inline",
"allowMultiple": true
},
{
"tagName": "@override",
"syntaxKind": "modifier"
},
{
"tagName": "@packageDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@param",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@privateRemarks",
"syntaxKind": "block"
},
{
"tagName": "@public",
"syntaxKind": "modifier"
},
{
"tagName": "@readonly",
"syntaxKind": "modifier"
},
{
"tagName": "@remarks",
"syntaxKind": "block"
},
{
"tagName": "@returns",
"syntaxKind": "block"
},
{
"tagName": "@sealed",
"syntaxKind": "modifier"
},
{
"tagName": "@see",
"syntaxKind": "block"
},
{
"tagName": "@throws",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@typeParam",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@virtual",
"syntaxKind": "modifier"
},
{
"tagName": "@betaDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@internalRemarks",
"syntaxKind": "block"
},
{
"tagName": "@preapproved",
"syntaxKind": "modifier"
}
],
"supportForTags": {
"@alpha": true,
"@beta": true,
"@defaultValue": true,
"@decorator": true,
"@deprecated": true,
"@eventProperty": true,
"@example": true,
"@experimental": true,
"@inheritDoc": true,
"@internal": true,
"@label": true,
"@link": true,
"@override": true,
"@packageDocumentation": true,
"@param": true,
"@privateRemarks": true,
"@public": true,
"@readonly": true,
"@remarks": true,
"@returns": true,
"@sealed": true,
"@see": true,
"@throws": true,
"@typeParam": true,
"@virtual": true,
"@betaDocumentation": true,
"@internalRemarks": true,
"@preapproved": true
},
"reportUnsupportedHtmlElements": false
}
},
"kind": "Package",
"canonicalReference": "ibm-cloud-sdk-core!",
"docComment": "",
"name": "ibm-cloud-sdk-core",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "ibm-cloud-sdk-core!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "Function",
"canonicalReference": "ibm-cloud-sdk-core!atLeastOne:function(1)",
"docComment": "/**\n * Checks for at least one of the given elements being defined.\n *\n * @param args - The spread of arguments to check\n *\n * @returns true if one or more are defined; false if all are undefined\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function atLeastOne(...args: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "args",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "atLeastOne"
},
{
"kind": "Function",
"canonicalReference": "ibm-cloud-sdk-core!atMostOne:function(1)",
"docComment": "/**\n * Verifies that no more than one of the given elements are defined. Returns true if one or none are defined, and false otherwise.\n *\n * @param args - The spread of arguments to check\n *\n * @returns false if more than one elements are defined, true otherwise\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function atMostOne(...args: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "args",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "atMostOne"
},
{
"kind": "Class",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator:class",
"docComment": "/**\n * Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class Authenticator implements "
},
{
"kind": "Reference",
"text": "AuthenticatorInterface",
"canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "dist/es/auth/authenticators/authenticator.d.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "Authenticator",
"preserveMemberOrder": false,
"members": [
{
"kind": "Constructor",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator:constructor(1)",
"docComment": "/**\n * Create a new Authenticator instance.\n *\n * @throws\n *\n * Error: the \"new\" keyword was not used to construct the authenticator.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor();"
}
],
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": []
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator#authenticate:member(1)",
"docComment": "/**\n * Augment the request with authentication information.\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @throws\n *\n * Error: The authenticate method was not implemented by a subclass.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "authenticate(requestOptions: "
},
{
"kind": "Reference",
"text": "AuthenticateOptions",
"canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "requestOptions",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "authenticate"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator#authenticationType:member(1)",
"docComment": "/**\n * Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the \\<service_name\\>_AUTH_TYPE configuration property (e.g. \"basic\", \"iam\", etc.). This function should be overridden in each authenticator implementation class that extends this class.\n *\n * @returns a string that indicates the authenticator's type\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "authenticationType(): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "authenticationType"
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_BASIC:member",
"docComment": "/**\n * Constants that define the various authenticator types.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_BASIC: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_BASIC",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_BEARERTOKEN:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_BEARERTOKEN: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_BEARERTOKEN",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_CONTAINER:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_CONTAINER: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_CONTAINER",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_CP4D:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_CP4D: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_CP4D",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_IAM_ASSUME:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_IAM_ASSUME: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_IAM_ASSUME",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_IAM:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_IAM: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_IAM",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_MCSP:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_MCSP: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_MCSP",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_MCSPV2:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_MCSPV2: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_MCSPV2",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_NOAUTH:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_NOAUTH: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_NOAUTH",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_UNKNOWN:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_UNKNOWN: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_UNKNOWN",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_VPC:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static AUTHTYPE_VPC: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "AUTHTYPE_VPC",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "Interface",
"canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface:interface",
"docComment": "/**\n * This interface defines the common methods associated with an Authenticator implementation.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface AuthenticatorInterface "
}
],
"fileUrlPath": "dist/es/auth/authenticators/authenticator-interface.d.ts",
"releaseTag": "Public",
"name": "AuthenticatorInterface",
"preserveMemberOrder": false,
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface#authenticate:member(1)",
"docComment": "/**\n * Add authentication information to the specified request.\n *\n * @param requestOptions - The request to which authentication information is added (in the headers field).\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "authenticate(requestOptions: "
},
{
"kind": "Reference",
"text": "AuthenticateOptions",
"canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "requestOptions",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "authenticate"
},
{
"kind": "MethodSignature",
"canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface#authenticationType:member(1)",
"docComment": "/**\n * Returns a string that indicates the authentication type.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "authenticationType(): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "authenticationType"
}
],
"extendsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "ibm-cloud-sdk-core!BaseService:class",
"docComment": "/**\n * Common functionality shared by generated service classes.\n *\n * The base service authenticates requests via its authenticator, and sends them to the service endpoint.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class BaseService "
}
],
"fileUrlPath": "dist/es/lib/base-service.d.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "BaseService",
"preserveMemberOrder": false,
"members": [
{
"kind": "Constructor",
"canonicalReference": "ibm-cloud-sdk-core!BaseService:constructor(1)",
"docComment": "/**\n * Configuration values for a service.\n *\n * @param userOptions - the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(userOptions: "
},
{
"kind": "Reference",
"text": "UserOptions",
"canonicalReference": "ibm-cloud-sdk-core!UserOptions:interface"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "userOptions",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
]
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#baseOptions:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected baseOptions: "
},
{
"kind": "Reference",
"text": "BaseServiceOptions",
"canonicalReference": "ibm-cloud-sdk-core!~BaseServiceOptions:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "baseOptions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": true,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#configureService:member(1)",
"docComment": "/**\n * Configure the service using external configuration\n *\n * @param serviceName - the name of the service. This will be used to read from external configuration.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected configureService(serviceName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": true,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "serviceName",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "configureService"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService.convertModel:member(1)",
"docComment": "/**\n * Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.\n *\n * @param input - the input model object\n *\n * @param converterFn - the function that is applied on the input object\n *\n * @param isMap - is `true` when the input object should be handled as a map\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static convertModel(input: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", converterFn: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", isMap?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "input",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "converterFn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "isMap",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"isOptional": false,
"isAbstract": false,
"name": "convertModel"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequest:member(1)",
"docComment": "/**\n * Wrapper around `sendRequest` that enforces the request will be authenticated.\n *\n * @param parameters - Service request options passed in by user. This should be an object with the following fields: - options.method: the http method - options.url: the path portion of the URL to be appended to the serviceUrl - options.path: the path parameters to be inserted into the URL - options.qs: the querystring to be included in the URL - options.body: the data to be sent as the request body - options.form: an object containing the key/value pairs for a www-form-urlencoded request. - options.formData: an object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above - defaultOptions.serviceUrl: the base URL of the service - defaultOptions.headers: additional HTTP headers to be sent with the request\n *\n * @returns a Promise\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected createRequest(parameters: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": true,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "parameters",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "createRequest"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequestAndDeserializeResponse:member(1)",
"docComment": "/**\n * Wrapper around `createRequest` that enforces arrived response to be deserialized.\n *\n * @param parameters - see `parameters` in `createRequest`\n *\n * @param deserializerFn - the deserializer function that is applied on the response object\n *\n * @param isMap - is `true` when the response object should be handled as a map\n *\n * @returns a Promise\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected createRequestAndDeserializeResponse(parameters: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", deserializerFn: "
},
{
"kind": "Content",
"text": "(any: any) => any"
},
{
"kind": "Content",
"text": ", isMap?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"isProtected": true,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "parameters",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "deserializerFn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "isMap",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"isOptional": false,
"isAbstract": false,
"name": "createRequestAndDeserializeResponse"
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!BaseService.DEFAULT_SERVICE_NAME:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static DEFAULT_SERVICE_NAME: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "DEFAULT_SERVICE_NAME",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "ibm-cloud-sdk-core!BaseService.DEFAULT_SERVICE_URL:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static DEFAULT_SERVICE_URL: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "DEFAULT_SERVICE_URL",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#disableRetries:member(1)",
"docComment": "/**\n * Disables retries.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "disableRetries(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "disableRetries"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#enableRetries:member(1)",
"docComment": "/**\n * Enable retries for unfulfilled requests.\n *\n * @param retryOptions - the configuration for retries\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "enableRetries(retryOptions?: "
},
{
"kind": "Reference",
"text": "RetryOptions",
"canonicalReference": "ibm-cloud-sdk-core!~RetryOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "retryOptions",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": true
}
],
"isOptional": false,
"isAbstract": false,
"name": "enableRetries"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#getAuthenticator:member(1)",
"docComment": "/**\n * Get the instance of the authenticator set on the service.\n *\n * @returns the Authenticator instance\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getAuthenticator(): "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getAuthenticator"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#getHttpClient:member(1)",
"docComment": "/**\n * Get the Axios instance set on the service. All requests will be made using this instance.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getHttpClient(): "
},
{
"kind": "Content",
"text": "import(\"axios\")."
},
{
"kind": "Reference",
"text": "AxiosInstance",
"canonicalReference": "axios!AxiosInstance:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getHttpClient"
},
{
"kind": "Method",
"canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)",
"docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - the map of headers to include in requests.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setDefaultHeaders(headers: "
},
{
"kind": "Reference",
"text": "OutgoingHttpHeaders",
"canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Publi