diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c2e396..a9698be 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## [10.0.1](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/compare/v10.0.0...v10.0.1) (2024-11-15) + + +### Bug Fixes + +* **readme.md:** reviewed readme.md ([a0d7f7c](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/commit/a0d7f7c007f059c8a1cef6977d13101646f15a30)) + # [10.0.0](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/compare/v9.0.8...v10.0.0) (2024-11-15) diff --git a/docs/classes/apiclient.APIClient.html b/docs/classes/apiclient.APIClient.html index 9360f8b..61dc41c 100644 --- a/docs/classes/apiclient.APIClient.html +++ b/docs/classes/apiclient.APIClient.html @@ -1,5 +1,5 @@ APIClient | @cnr/apiconnector

Class APIClient

APIClient class

-

Constructors

constructor +

Constructors

constructor

Properties

socketTimeout

Methods

disableDebugMode enableDebugMode @@ -31,86 +31,86 @@ useHighPerformanceConnectionSetup useLIVESystem useOTESystem -

Constructors

constructor

Properties

Static ReadonlysocketTimeout

socketTimeout: number = 300000

API connection timeout setting

-

Methods

disableDebugMode

  • disableDebugMode(): APIClient

  • Disable Debug Output

    +

Constructors

constructor

Properties

Static ReadonlysocketTimeout

socketTimeout: number = 300000

API connection timeout setting

+

Methods

disableDebugMode

enableDebugMode

enableDebugMode

getPOSTData

  • getPOSTData(cmd, secured?): string

  • Serialize given command for POST request including connection configuration data

    +

getPOSTData

  • getPOSTData(cmd, secured?): string

  • Serialize given command for POST request including connection configuration data

    Parameters

    • cmd: any

      API command to encode

    • secured: boolean = false

    Returns string

    encoded POST data string

    -

getProxy

  • getProxy(): null | string

  • Get the proxy server configuration

    +

getProxy

  • getProxy(): null | string

  • Get the proxy server configuration

    Returns null | string

    proxy server configuration value or null if not set

    -

getReferer

  • getReferer(): null | string

  • Get the referer configuration

    +

getReferer

  • getReferer(): null | string

  • Get the referer configuration

    Returns null | string

    referer configuration value or null if not set

    -

getURL

  • getURL(): string

  • Get the API connection url that is currently set

    +

getURL

  • getURL(): string

  • Get the API connection url that is currently set

    Returns string

    API connection url currently in use

    -

getUserAgent

getUserAgent

  • getUserAgent(): string

  • Get the User Agent

    Returns string

    User Agent string

    -

getVersion

getVersion

  • getVersion(): string

  • Get the current module version

    Returns string

    module version

    -

login

login

  • login(): Promise<Response>

  • Perform API login to start session-based communication

    Returns Promise<Response>

    Promise resolving with API Response

    -

logout

logout

  • logout(): Promise<Response>

  • Perform API logout to close API session in use

    Returns Promise<Response>

    Promise resolving with API Response

    -

request

request

  • request(cmd, setUserView?): Promise<Response>

  • Perform API request using the given command

    Parameters

    • cmd: any

      API command to request

    • setUserView: boolean = true

    Returns Promise<Response>

    Promise resolving with API Response

    -

requestAllResponsePages

  • requestAllResponsePages(cmd): Promise<Response[]>

  • Request all pages/entries for the given query command

    +

requestAllResponsePages

  • requestAllResponsePages(cmd): Promise<Response[]>

  • Request all pages/entries for the given query command

    Parameters

    • cmd: any

      API list command to use

    Returns Promise<Response[]>

    Promise resolving with array of API Responses

    -

requestNextResponsePage

  • requestNextResponsePage(rr): Promise<null | Response>

  • Request the next page of list entries for the current list query +

requestNextResponsePage

  • requestNextResponsePage(rr): Promise<null | Response>

  • Request the next page of list entries for the current list query Useful for tables

    Parameters

    • rr: Response

      API Response of current page

    Returns Promise<null | Response>

    Promise resolving with API Response or null in case there are no further list entries

    -

resetUserView

resetUserView

reuseSession

reuseSession

  • reuseSession(session): APIClient

  • Use existing configuration out of ClientRequest session to rebuild and reuse connection settings

    Parameters

    • session: any

      ClientRequest session instance

    Returns APIClient

    Current APIClient instance for method chaining

    -

saveSession

  • saveSession(session): APIClient

  • Apply session data (session id and system entity) to given client request session

    +

saveSession

  • saveSession(session): APIClient

  • Apply session data (session id and system entity) to given client request session

    Parameters

    • session: any

      ClientRequest session instance

    Returns APIClient

    Current APIClient instance for method chaining

    -

setCredentials

setCredentials

  • setCredentials(uid, pw?): APIClient

  • Set Credentials to be used for API communication

    Parameters

    • uid: string

      account name

    • pw: string = ""

      account password

    Returns APIClient

    Current APIClient instance for method chaining

    -

setCustomLogger

setCustomLogger

  • setCustomLogger(customLogger): APIClient

  • set custom logger to use instead of default one

    Parameters

    Returns APIClient

    Current APIClient instance for method chaining

    -

setDefaultLogger

setDefaultLogger

setPersistent

setPersistent

  • setPersistent(): APIClient

  • Set Persistent to request session id for API communication

    Returns APIClient

    Current APIClient instance for method chaining

    -

setProxy

setProxy

  • setProxy(proxy): APIClient

  • Set the proxy server to use for API communication

    Parameters

    • proxy: string

      proxy server to use for communicatio

    Returns APIClient

    Current APIClient instance for method chaining

    -

setReferer

setReferer

  • setReferer(referer): APIClient

  • Set the referer to use for API communication

    Parameters

    • referer: string

      Referer

    Returns APIClient

    Current APIClient instance for method chaining

    -

setRoleCredentials

setRoleCredentials

  • setRoleCredentials(uid, role, pw?): APIClient

  • Set Credentials to be used for API communication

    Parameters

    • uid: string

      account name

    • role: string

      role user id

    • pw: string = ""

      role user password

    Returns APIClient

    Current APIClient instance for method chaining

    -

setURL

setURL

  • setURL(value): APIClient

  • Set another connection url to be used for API communication

    Parameters

    • value: string

      API connection url to set

    Returns APIClient

    Current APIClient instance for method chaining

    -

setUserAgent

  • setUserAgent(str, rv, modules?): APIClient

  • Possibility to customize default user agent to fit your needs

    +

setUserAgent

  • setUserAgent(str, rv, modules?): APIClient

  • Possibility to customize default user agent to fit your needs

    Parameters

    • str: string

      user agent label

    • rv: string

      revision of user agent

    • modules: any = []

      further modules to add to user agent string, format: ["/", "/", ... ]

    Returns APIClient

    Current APIClient instance for method chaining

    -

setUserView

setUserView

  • setUserView(uid): APIClient

  • Set a data view to a given subuser

    Parameters

    • uid: string

      subuser account name

    Returns APIClient

    Current APIClient instance for method chaining

    -

useDefaultConnectionSetup

useDefaultConnectionSetup

  • useDefaultConnectionSetup(): APIClient

  • Activate Default Connection Setup (the default)

    Returns APIClient

    Current APIClient instance for method chaining

    -

useHighPerformanceConnectionSetup

useHighPerformanceConnectionSetup

useLIVESystem

  • useLIVESystem(): APIClient

  • Set LIVE System for API communication (this is the default setting)

    +

useLIVESystem

useOTESystem

useOTESystem

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/column.Column.html b/docs/classes/column.Column.html index ee438f9..4498fea 100644 --- a/docs/classes/column.Column.html +++ b/docs/classes/column.Column.html @@ -1,15 +1,15 @@ Column | @cnr/apiconnector

Class Column

Column class

-

Constructors

constructor +

Constructors

constructor

Properties

length

Methods

getData getDataByIndex getKey -

Constructors

constructor

Properties

length

length: number

count of column data entries

-

Methods

getData

  • getData(): string[]

  • Get column data

    +

Constructors

constructor

Properties

length

length: number

count of column data entries

+

Methods

getData

  • getData(): string[]

  • Get column data

    Returns string[]

    column data

    -

getDataByIndex

  • getDataByIndex(idx): null | string

  • Get column data at given index

    +

getDataByIndex

  • getDataByIndex(idx): null | string

  • Get column data at given index

    Parameters

    • idx: number

      data index

    Returns null | string

    data at given index

    -

getKey

getKey

  • getKey(): string

  • Get column name

    Returns string

    column name

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/customlogger.CustomLogger.html b/docs/classes/customlogger.CustomLogger.html index d570d18..a661577 100644 --- a/docs/classes/customlogger.CustomLogger.html +++ b/docs/classes/customlogger.CustomLogger.html @@ -1,9 +1,9 @@ CustomLogger | @cnr/apiconnector

Class CustomLogger

Logger class

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

log

Constructors

constructor

Methods

log

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/logger.Logger.html b/docs/classes/logger.Logger.html index d3cef8c..8d049b3 100644 --- a/docs/classes/logger.Logger.html +++ b/docs/classes/logger.Logger.html @@ -1,9 +1,9 @@ Logger | @cnr/apiconnector

Class Logger

Logger class

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

log

Constructors

constructor

Methods

log

  • log(post, r, error?): Logger

  • output/log given data

    Parameters

    • post: string

      request string used

    • r: Response

      Response object

    • error: null | string = null

      error message or null

    Returns Logger

    current Logger instance for method chaining

    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/record.Record.html b/docs/classes/record.Record.html index bfce60f..73f70c8 100644 --- a/docs/classes/record.Record.html +++ b/docs/classes/record.Record.html @@ -1,12 +1,12 @@ Record | @cnr/apiconnector

Class Record

Record class

-

Constructors

constructor +

Constructors

constructor

Methods

getData getDataByKey

Constructors

constructor

  • new Record(data): Record

  • Constructor

    Parameters

    • data: any

      data object (use column names as object keys)

      -

    Returns Record

Methods

getData

  • getData(): any

  • get row data

    +

Returns Record

Methods

getData

  • getData(): any

  • get row data

    Returns any

    row data

    -

getDataByKey

  • getDataByKey(key): null | string

  • get row data for given column

    +

getDataByKey

  • getDataByKey(key): null | string

  • get row data for given column

    Parameters

    • key: string

      column name

    Returns null | string

    row data for given column or null if column does not exist

    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/response.Response.html b/docs/classes/response.Response.html index 6c13756..02ff1d6 100644 --- a/docs/classes/response.Response.html +++ b/docs/classes/response.Response.html @@ -1,5 +1,5 @@ Response | @cnr/apiconnector

Class Response

Response Class

-

Constructors

constructor +

Constructors

constructor

Properties

hash raw

Methods

addColumn @@ -43,91 +43,91 @@

Parameters

  • raw: string

    API plain response

  • cmd: any = {}

    API command used within this request

  • ph: any = {}

    placeholder array to get vars in response description dynamically replaced

    -

Returns Response

Properties

Protectedhash

hash: any

hash representation of plain API response

-

Protectedraw

raw: string

plain API response

-

Methods

addColumn

  • addColumn(key, data): Response

  • Add a column to the column list

    +

Returns Response

Properties

Protectedhash

hash: any

hash representation of plain API response

+

Protectedraw

raw: string

plain API response

+

Methods

addColumn

  • addColumn(key, data): Response

  • Add a column to the column list

    Parameters

    • key: string

      column name

    • data: string[]

      array of column data

    Returns Response

    Current Response Instance for method chaining

    -

addRecord

addRecord

  • addRecord(h): Response

  • Add a record to the record list

    Parameters

    • h: any

      row hash data

    Returns Response

    Current Response Instance for method chaining

    -

getCode

getCode

  • getCode(): number

  • Get API response code

    Returns number

    API response code

    -

getColumn

getColumn

  • getColumn(key): null | Column

  • Get column by column name

    Parameters

    • key: string

      column name

    Returns null | Column

    column instance or null if column does not exist

    -

getColumnIndex

  • getColumnIndex(colkey, index): null | string

  • Get Data by Column Name and Index

    +

getColumnIndex

  • getColumnIndex(colkey, index): null | string

  • Get Data by Column Name and Index

    Parameters

    • colkey: string

      column name

    • index: number

      column data index

    Returns null | string

    column data at index or null if not found

    -

getColumnKeys

getColumnKeys

  • getColumnKeys(): string[]

  • Get Column Names

    Returns string[]

    Array of Column Names

    -

getColumns

getColumns

getCommand

  • getCommand(): any

  • Get Command used in this request

    +

getCommand

  • getCommand(): any

  • Get Command used in this request

    Returns any

    command

    -

getCommandPlain

  • getCommandPlain(): string

  • Get Command used in this request in plain text format

    +

getCommandPlain

  • getCommandPlain(): string

  • Get Command used in this request in plain text format

    Returns string

    command as plain text

    -

getCurrentPageNumber

  • getCurrentPageNumber(): null | number

  • Get Page Number of current List Query

    +

getCurrentPageNumber

  • getCurrentPageNumber(): null | number

  • Get Page Number of current List Query

    Returns null | number

    page number or null in case of a non-list response

    -

getCurrentRecord

getCurrentRecord

  • getCurrentRecord(): null | Record

  • Get Record of current record index

    Returns null | Record

    Record or null in case of a non-list response

    -

getDescription

  • getDescription(): string

  • Get API response description

    +

getDescription

  • getDescription(): string

  • Get API response description

    Returns string

    API response description

    -

getFirstRecordIndex

  • getFirstRecordIndex(): null | number

  • Get Index of first row in this response

    +

getFirstRecordIndex

  • getFirstRecordIndex(): null | number

  • Get Index of first row in this response

    Returns null | number

    first row index

    -

getHash

getHash

  • getHash(): any

  • Get API response as Hash

    Returns any

    API response hash

    -

getLastRecordIndex

  • getLastRecordIndex(): null | number

  • Get last record index of the current list query

    +

getLastRecordIndex

  • getLastRecordIndex(): null | number

  • Get last record index of the current list query

    Returns null | number

    record index or null for a non-list response

    -

getListHash

  • getListHash(): any

  • Get Response as List Hash including useful meta data for tables

    +

getListHash

  • getListHash(): any

  • Get Response as List Hash including useful meta data for tables

    Returns any

    hash including list meta data and array of rows in hash notation

    -

getNextPageNumber

  • getNextPageNumber(): null | number

  • Get Page Number of next list query

    +

getNextPageNumber

  • getNextPageNumber(): null | number

  • Get Page Number of next list query

    Returns null | number

    page number or null if there's no next page

    -

getNextRecord

getNextRecord

  • getNextRecord(): null | Record

  • Get next record in record list

    Returns null | Record

    Record or null in case there's no further record

    -

getNumberOfPages

  • getNumberOfPages(): number

  • Get the number of pages available for this list query

    +

getNumberOfPages

  • getNumberOfPages(): number

  • Get the number of pages available for this list query

    Returns number

    number of pages

    -

getPagination

  • getPagination(): any

  • Get object containing all paging data

    +

getPagination

  • getPagination(): any

  • Get object containing all paging data

    Returns any

    paginator data

    -

getPlain

getPlain

  • getPlain(): string

  • Get Plain API response

    Returns string

    Plain API response

    -

getPreviousPageNumber

  • getPreviousPageNumber(): null | number

  • Get Page Number of previous list query

    +

getPreviousPageNumber

  • getPreviousPageNumber(): null | number

  • Get Page Number of previous list query

    Returns null | number

    page number or null if there's no previous page

    -

getPreviousRecord

getPreviousRecord

  • getPreviousRecord(): null | Record

  • Get previous record in record list

    Returns null | Record

    Record or null if there's no previous record

    -

getQueuetime

  • getQueuetime(): number

  • Get Queuetime of API response

    +

getQueuetime

  • getQueuetime(): number

  • Get Queuetime of API response

    Returns number

    Queuetime of API response

    -

getRecord

getRecord

  • getRecord(idx): null | Record

  • Get Record at given index

    Parameters

    • idx: number

      record index

    Returns null | Record

    Record or null if index does not exist

    -

getRecords

getRecords

getRecordsCount

  • getRecordsCount(): number

  • Get count of rows in this response

    +

getRecordsCount

  • getRecordsCount(): number

  • Get count of rows in this response

    Returns number

    count of rows

    -

getRecordsLimitation

  • getRecordsLimitation(): number

  • Get limit(ation) setting of the current list query +

getRecordsLimitation

  • getRecordsLimitation(): number

  • Get limit(ation) setting of the current list query This is the count of requested rows

    Returns number

    limit setting or count requested rows

    -

getRecordsTotalCount

  • getRecordsTotalCount(): number

  • Get total count of records available for the list query

    +

getRecordsTotalCount

  • getRecordsTotalCount(): number

  • Get total count of records available for the list query

    Returns number

    total count of records or count of records for a non-list response

    -

getRuntime

  • getRuntime(): number

  • Get Runtime of API response

    +

getRuntime

  • getRuntime(): number

  • Get Runtime of API response

    Returns number

    Runtime of API response

    -

hasNextPage

  • hasNextPage(): boolean

  • Check if this list query has a next page

    +

hasNextPage

  • hasNextPage(): boolean

  • Check if this list query has a next page

    Returns boolean

    boolean result

    -

hasPreviousPage

  • hasPreviousPage(): boolean

  • Check if this list query has a previous page

    +

hasPreviousPage

  • hasPreviousPage(): boolean

  • Check if this list query has a previous page

    Returns boolean

    boolean result

    -

isError

  • isError(): boolean

  • Check if current API response represents an error case +

isError

  • isError(): boolean

  • Check if current API response represents an error case API response code is an 5xx code

    Returns boolean

    boolean result

    -

isPending

  • isPending(): boolean

  • Check if current operation is returned as pending

    +

isPending

  • isPending(): boolean

  • Check if current operation is returned as pending

    Returns boolean

    boolean result

    -

isSuccess

  • isSuccess(): boolean

  • Check if current API response represents a success case +

isSuccess

  • isSuccess(): boolean

  • Check if current API response represents a success case API response code is an 2xx code

    Returns boolean

    boolean result

    -

isTmpError

  • isTmpError(): boolean

  • Check if current API response represents a temporary error case +

isTmpError

  • isTmpError(): boolean

  • Check if current API response represents a temporary error case API response code is an 4xx code

    Returns boolean

    boolean result

    -

rewindRecordList

rewindRecordList

  • rewindRecordList(): Response

  • Reset index in record list back to zero

    Returns Response

    Current Response Instance for method chaining

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/responsetemplatemanager.ResponseTemplateManager.html b/docs/classes/responsetemplatemanager.ResponseTemplateManager.html index 675341d..c6d4865 100644 --- a/docs/classes/responsetemplatemanager.ResponseTemplateManager.html +++ b/docs/classes/responsetemplatemanager.ResponseTemplateManager.html @@ -1,5 +1,5 @@ ResponseTemplateManager | @cnr/apiconnector

Class ResponseTemplateManager

ResponseTemplateManager Singleton Class

-

Properties

templates +

Properties

templates

Methods

addTemplate generateTemplate getTemplate @@ -9,30 +9,30 @@ isTemplateMatchPlain getInstance

Properties

templates

templates: any

template container

-

Methods

addTemplate

Methods

addTemplate

generateTemplate

  • generateTemplate(code, description): string

  • Generate API response template string for given code and description

    +

generateTemplate

  • generateTemplate(code, description): string

  • Generate API response template string for given code and description

    Parameters

    • code: string

      API response code

    • description: string

      API response description

    Returns string

    generate response template string

    -

getTemplate

getTemplate

getTemplates

getTemplates

  • getTemplates(): any

  • Return all available response templates

    Returns any

    all available response template instances

    -

hasTemplate

hasTemplate

  • hasTemplate(id): boolean

  • Check if given template exists in template container

    Parameters

    • id: string

      template id

    Returns boolean

    boolean result

    -

isTemplateMatchHash

  • isTemplateMatchHash(tpl2, id): boolean

  • Check if given API response hash matches a given template by code and description

    +

isTemplateMatchHash

  • isTemplateMatchHash(tpl2, id): boolean

  • Check if given API response hash matches a given template by code and description

    Parameters

    • tpl2: any

      api response hash

    • id: string

      template id

    Returns boolean

    boolean result

    -

isTemplateMatchPlain

  • isTemplateMatchPlain(plain, id): boolean

  • Check if given API plain response matches a given template by code and description

    +

isTemplateMatchPlain

  • isTemplateMatchPlain(plain, id): boolean

  • Check if given API plain response matches a given template by code and description

    Parameters

    • plain: string

      API plain response

    • id: string

      template id

    Returns boolean

    boolean result

    -

StaticgetInstance

StaticgetInstance

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/classes/responsetranslator.ResponseTranslator.html b/docs/classes/responsetranslator.ResponseTranslator.html index 83fc989..4da8064 100644 --- a/docs/classes/responsetranslator.ResponseTranslator.html +++ b/docs/classes/responsetranslator.ResponseTranslator.html @@ -1,5 +1,5 @@ ResponseTranslator | @cnr/apiconnector

Class ResponseTranslator

ResponseTranslator class

-

Constructors

constructor +

Constructors

constructor

Methods

findMatch translate

Constructors

constructor

Methods

Protected StaticfindMatch

  • findMatch(regex, newraw, val, cmd?, ph?): string

  • Finds a match in the given text and performs replacements based on patterns and placeholders.

    @@ -11,9 +11,9 @@
  • cmd: any = {}

    The command data containing replacements, if applicable.

  • ph: any = {}

    An array of placeholder values for further replacements.

Returns string

Returns non-empty string if replacements were performed, empty string otherwise.

-

Statictranslate

Statictranslate

  • translate(raw, cmd, ph?): string

  • translate a raw api response

    Parameters

    • raw: string

      API raw response

    • cmd: any

      requested API command

    • ph: any = {}

      list of place holder vars

    Returns string

    new translated raw response

    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/socketconfig.SocketConfig.html b/docs/classes/socketconfig.SocketConfig.html index de6eb61..8d309a8 100644 --- a/docs/classes/socketconfig.SocketConfig.html +++ b/docs/classes/socketconfig.SocketConfig.html @@ -1,5 +1,5 @@ SocketConfig | @cnr/apiconnector

Class SocketConfig

SocketConfig Class

-

Constructors

constructor +

Constructors

constructor

Methods

getLogin getPOSTData getSession @@ -7,21 +7,21 @@ setPassword setPersistent setSession -

Constructors

constructor

Methods

getLogin

  • getLogin(): string

  • Get account login to use

    +

Constructors

constructor

Methods

getLogin

  • getLogin(): string

  • Get account login to use

    Returns string

    Current login

    -

getPOSTData

  • getPOSTData(): string

  • Create POST data string out of connection data

    +

getPOSTData

  • getPOSTData(): string

  • Create POST data string out of connection data

    Returns string

    POST data string

    -

getSession

getSession

  • getSession(): string

  • Get API Session ID in use

    Returns string

    API Session ID

    -

setLogin

setLogin

setPassword

setPassword

setPersistent

setPersistent

setSession

setSession

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/functions/socketconfig.fixedURLEnc.html b/docs/functions/socketconfig.fixedURLEnc.html index 168c7d5..408b071 100644 --- a/docs/functions/socketconfig.fixedURLEnc.html +++ b/docs/functions/socketconfig.fixedURLEnc.html @@ -1 +1 @@ -fixedURLEnc | @cnr/apiconnector

Function fixedURLEnc

  • fixedURLEnc(str): string

  • Parameters

    • str: string

    Returns string

Settings

Member Visibility
+fixedURLEnc | @cnr/apiconnector

Function fixedURLEnc

  • fixedURLEnc(str): string

  • Parameters

    • str: string

    Returns string

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 529928b..5ee7e03 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,11 +1,11 @@ -@cnr/apiconnector

@cnr/apiconnector

node-sdk

Contributor Covenant +@cnr/apiconnector

@cnr/apiconnector

CentralNic Reseller NODE-SDK

Contributor Covenant npm version node semantic-release Build Status License: MIT PRs welcome

-

This module is a connector library for the insanely fast CentralNic Reseller Backend API. For further informations visit our homepage and do not hesitate to contact us.

+

This module is a connector library for the insanely fast CentralNic Reseller (formerly RRPProxy) Backend API. For further informations visit our homepage and do not hesitate to contact us.

Deprecation Notice: Hexonet Node.js SDK

This SDK succeeds the deprecated Hexonet Node.js SDK. It is an enhanced version that builds upon the foundation laid by the Hexonet SDK, offering improved features and performance. Hexonet is migrating to CentralNic Reseller, ensuring continued support and development under the new branding.

Resources

FAQ / Notes

ESM/CJS Support: We followed the ESM-NODE Guide of TypeScript.

License

MIT

-

Settings

Member Visibility

On This Page

node-sdk
+

Settings

Member Visibility

On This Page

CentralNic Reseller NODE-SDK
diff --git a/docs/modules/apiclient.html b/docs/modules/apiclient.html index e64d71f..95009d8 100644 --- a/docs/modules/apiclient.html +++ b/docs/modules/apiclient.html @@ -1,4 +1,4 @@ -apiclient | @cnr/apiconnector

Module apiclient

Index

Classes

APIClient +apiclient | @cnr/apiconnector

Module apiclient

Index

Classes

APIClient

Variables

CNR_CONNECTION_URL_LIVE CNR_CONNECTION_URL_OTE CNR_CONNECTION_URL_PROXY diff --git a/docs/modules/column.html b/docs/modules/column.html index 14dd40f..56d16ad 100644 --- a/docs/modules/column.html +++ b/docs/modules/column.html @@ -1,2 +1,2 @@ -column | @cnr/apiconnector

Module column

Index

Classes

Column +column | @cnr/apiconnector

Module column

Index

Classes

Column

Settings

Member Visibility
diff --git a/docs/modules/customlogger.html b/docs/modules/customlogger.html index 32dc274..cc59a09 100644 --- a/docs/modules/customlogger.html +++ b/docs/modules/customlogger.html @@ -1,2 +1,2 @@ -customlogger | @cnr/apiconnector

Module customlogger

Index

Classes

CustomLogger +customlogger | @cnr/apiconnector

Module customlogger

Index

Classes

CustomLogger

Settings

Member Visibility
diff --git a/docs/modules/index.html b/docs/modules/index.html index 5646233..e8c9737 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | @cnr/apiconnector

Module index

References

APIClient +index | @cnr/apiconnector

Module index

References

APIClient Response ResponseTemplateManager

References

APIClient

Re-exports APIClient

Response

Re-exports Response

ResponseTemplateManager

Re-exports ResponseTemplateManager

Settings

Member Visibility

On This Page

References
diff --git a/docs/modules/logger.html b/docs/modules/logger.html index 89cdb6a..0acf6b6 100644 --- a/docs/modules/logger.html +++ b/docs/modules/logger.html @@ -1,2 +1,2 @@ -logger | @cnr/apiconnector

Module logger

Index

Classes

Logger +logger | @cnr/apiconnector

Module logger

Index

Classes

Logger

Settings

Member Visibility
diff --git a/docs/modules/record.html b/docs/modules/record.html index 1fcdfeb..3cec3c8 100644 --- a/docs/modules/record.html +++ b/docs/modules/record.html @@ -1,2 +1,2 @@ -record | @cnr/apiconnector

Module record

Index

Classes

Record +record | @cnr/apiconnector

Module record

Index

Classes

Record

Settings

Member Visibility
diff --git a/docs/modules/response.html b/docs/modules/response.html index 8888354..a806bab 100644 --- a/docs/modules/response.html +++ b/docs/modules/response.html @@ -1,2 +1,2 @@ -response | @cnr/apiconnector

Module response

Index

Classes

Response +response | @cnr/apiconnector

Module response

Index

Classes

Response

Settings

Member Visibility
diff --git a/docs/modules/responseparser.html b/docs/modules/responseparser.html index cd18440..1ae0e29 100644 --- a/docs/modules/responseparser.html +++ b/docs/modules/responseparser.html @@ -1,2 +1,2 @@ -responseparser | @cnr/apiconnector

Module responseparser

Index

Variables

ResponseParser +responseparser | @cnr/apiconnector

Module responseparser

Index

Variables

ResponseParser

Settings

Member Visibility
diff --git a/docs/modules/responsetemplatemanager.html b/docs/modules/responsetemplatemanager.html index a59d2f2..088bfd7 100644 --- a/docs/modules/responsetemplatemanager.html +++ b/docs/modules/responsetemplatemanager.html @@ -1,2 +1,2 @@ -responsetemplatemanager | @cnr/apiconnector

Module responsetemplatemanager

Index

Classes

ResponseTemplateManager +responsetemplatemanager | @cnr/apiconnector

Module responsetemplatemanager

Index

Classes

ResponseTemplateManager

Settings

Member Visibility
diff --git a/docs/modules/responsetranslator.html b/docs/modules/responsetranslator.html index cd71b79..e2c47e5 100644 --- a/docs/modules/responsetranslator.html +++ b/docs/modules/responsetranslator.html @@ -1,2 +1,2 @@ -responsetranslator | @cnr/apiconnector

Module responsetranslator

Index

Classes

ResponseTranslator +responsetranslator | @cnr/apiconnector

Module responsetranslator

Index

Classes

ResponseTranslator

Settings

Member Visibility
diff --git a/docs/modules/socketconfig.html b/docs/modules/socketconfig.html index c12a43c..40ce3ad 100644 --- a/docs/modules/socketconfig.html +++ b/docs/modules/socketconfig.html @@ -1,3 +1,3 @@ -socketconfig | @cnr/apiconnector

Module socketconfig

Index

Classes

SocketConfig +socketconfig | @cnr/apiconnector

Module socketconfig

Index

Classes

SocketConfig

Functions

fixedURLEnc

Settings

Member Visibility
diff --git a/docs/variables/apiclient.CNR_CONNECTION_URL_LIVE.html b/docs/variables/apiclient.CNR_CONNECTION_URL_LIVE.html index 8403fcf..db431aa 100644 --- a/docs/variables/apiclient.CNR_CONNECTION_URL_LIVE.html +++ b/docs/variables/apiclient.CNR_CONNECTION_URL_LIVE.html @@ -1 +1 @@ -CNR_CONNECTION_URL_LIVE | @cnr/apiconnector

Variable CNR_CONNECTION_URL_LIVEConst

CNR_CONNECTION_URL_LIVE = "https://api.rrpproxy.net/api/call.cgi"

Settings

Member Visibility
+CNR_CONNECTION_URL_LIVE | @cnr/apiconnector

Variable CNR_CONNECTION_URL_LIVEConst

CNR_CONNECTION_URL_LIVE = "https://api.rrpproxy.net/api/call.cgi"

Settings

Member Visibility
diff --git a/docs/variables/apiclient.CNR_CONNECTION_URL_OTE.html b/docs/variables/apiclient.CNR_CONNECTION_URL_OTE.html index a412c3e..651651d 100644 --- a/docs/variables/apiclient.CNR_CONNECTION_URL_OTE.html +++ b/docs/variables/apiclient.CNR_CONNECTION_URL_OTE.html @@ -1 +1 @@ -CNR_CONNECTION_URL_OTE | @cnr/apiconnector

Variable CNR_CONNECTION_URL_OTEConst

CNR_CONNECTION_URL_OTE = "https://api-ote.rrpproxy.net/api/call.cgi"

Settings

Member Visibility
+CNR_CONNECTION_URL_OTE | @cnr/apiconnector

Variable CNR_CONNECTION_URL_OTEConst

CNR_CONNECTION_URL_OTE = "https://api-ote.rrpproxy.net/api/call.cgi"

Settings

Member Visibility
diff --git a/docs/variables/apiclient.CNR_CONNECTION_URL_PROXY.html b/docs/variables/apiclient.CNR_CONNECTION_URL_PROXY.html index 886b1bb..b3c64ba 100644 --- a/docs/variables/apiclient.CNR_CONNECTION_URL_PROXY.html +++ b/docs/variables/apiclient.CNR_CONNECTION_URL_PROXY.html @@ -1 +1 @@ -CNR_CONNECTION_URL_PROXY | @cnr/apiconnector

Variable CNR_CONNECTION_URL_PROXYConst

CNR_CONNECTION_URL_PROXY = "http://127.0.0.1/api/call.cgi"

Settings

Member Visibility
+CNR_CONNECTION_URL_PROXY | @cnr/apiconnector

Variable CNR_CONNECTION_URL_PROXYConst

CNR_CONNECTION_URL_PROXY = "http://127.0.0.1/api/call.cgi"

Settings

Member Visibility
diff --git a/docs/variables/responseparser.ResponseParser.html b/docs/variables/responseparser.ResponseParser.html index ba56f7e..09069de 100644 --- a/docs/variables/responseparser.ResponseParser.html +++ b/docs/variables/responseparser.ResponseParser.html @@ -1 +1 @@ -ResponseParser | @cnr/apiconnector

Variable ResponseParserConst

ResponseParser: any = ...

Settings

Member Visibility
+ResponseParser | @cnr/apiconnector

Variable ResponseParserConst

ResponseParser: any = ...

Settings

Member Visibility
diff --git a/package-lock.json b/package-lock.json index f7095a5..b68d282 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@cnr/apiconnector", - "version": "10.0.0", + "version": "10.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@cnr/apiconnector", - "version": "10.0.0", + "version": "10.0.1", "license": "MIT", "dependencies": { "cross-fetch": "^4.0.0", diff --git a/package.json b/package.json index 55f35d9..ad08e30 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@team-internet/apiconnector", "description": "Node.js SDK for the insanely fast CentralNic Reseller (fka RRPProxy) API", - "version": "10.0.0", + "version": "10.0.1", "private": false, "publishConfig": { "access": "public"