Skip to content

Files

204 lines (111 loc) · 4.78 KB

Communication_configuration.Configuration.md

File metadata and controls

204 lines (111 loc) · 4.78 KB

saasus-sdk / Communication/configuration / Configuration

Class: Configuration

Communication/configuration.Configuration

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Configuration(param?): Configuration

Parameters

Name Type
param ConfigurationParameters

Returns

Configuration

Defined in

src/generated/Communication/configuration.ts:77

Properties

accessToken

Optional accessToken: string | Promise<string> | (name?: string, scopes?: string[]) => string | (name?: string, scopes?: string[]) => Promise<string>

parameter for oauth2 security

Param

security name

Param

oauth2 scope

Memberof

Configuration

Defined in

src/generated/Communication/configuration.ts:53


apiKey

Optional apiKey: string | Promise<string> | (name: string) => string | (name: string) => Promise<string>

parameter for apiKey security

Param

security name

Memberof

Configuration

Defined in

src/generated/Communication/configuration.ts:32


baseOptions

Optional baseOptions: any

base options for axios calls

Memberof

Configuration

Defined in

src/generated/Communication/configuration.ts:67


basePath

Optional basePath: string

override base path

Memberof

Configuration

Defined in

src/generated/Communication/configuration.ts:60


formDataCtor

Optional formDataCtor: () => any

The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.

Type declaration

new formDataCtor(): any

Returns

any

Defined in

src/generated/Communication/configuration.ts:75


password

Optional password: string

parameter for basic security

Memberof

Configuration

Defined in

src/generated/Communication/configuration.ts:46


username

Optional username: string

parameter for basic security

Memberof

Configuration

Defined in

src/generated/Communication/configuration.ts:39

Methods

isJsonMime

isJsonMime(mime): boolean

Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

Parameters

Name Type Description
mime string MIME (Multipurpose Internet Mail Extensions)

Returns

boolean

True if the given MIME is JSON, false otherwise.

Defined in

src/generated/Communication/configuration.ts:97