SegmentApi

new SegmentApi()

Source:

index.js, line 8

Methods

(static) createDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default
`destination`	String
`source`	String
`destinationConfig`	Object
`path`	String	<optional>
`workspace`	String	<optional>
`enabled`	Boolean	<optional>	true

Source:

methods.js, line 241

(static) createSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`source`	String	<optional>
`path`	String	<optional>
`workspace`	String	<optional>
`catalogName`	String	<optional>

Source:

methods.js, line 146

(static) deleteDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`path`	String	<optional>
`source`	String	<optional>
`destination`	String	<optional>
`workspace`	String	<optional>

Source:

methods.js, line 369

(static) deleteSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`source`	String
`workspace`	String	<optional>

Source:

methods.js, line 218

(static) getCatalogDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`destination`	String

Source:

methods.js, line 127

(static) getCatalogDestinationList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 105

(static) getCatalogSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`source`	String

Source:

methods.js, line 88

(static) getCatalogSourceList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 66

(static) getDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`destination`	String	<optional>
`source`	String	<optional>
`path`	String	<optional>
`workspace`	String	<optional>

Source:

methods.js, line 302

(static) getDestinationList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`source`	String
`path`	String	<optional>
`workspace`	String	<optional>
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 275

(static) getSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`path`	String	<optional>
`source`	String	<optional>
`workspace`	String	<optional>

Source:

methods.js, line 199

(static) getSourceList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`path`	String	<optional>
`workspace`	String	<optional>
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 174

(static) getTokenList(config) → {Object}

Parameters:

Name Type Description

config

Properties

Name	Type	Attributes	Default	Description
`username`		<optional>	Default Username
`password`		<optional>	Default Password

Source:

methods.js, line 14

(static) getWorkspace(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`workspace`	String
`path`	String	<optional>

Source:

methods.js, line 48

(static) updateDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default
`destination`	String
`source`	String
`destinationConfig`	Object
`path`	String	<optional>
`workspace`	String	<optional>
`enabled`	Boolean	<optional>	true

Source:

methods.js, line 326

SegmentApi

new SegmentApi(config)

Parameters:

Name Type Description

config

Properties

Name	Type	Attributes	Description
`WORKSPACE`
`BASE_URL`		<optional>
`TOKEN`		<optional>
`CATALOG_SOURCE`		<optional>
`CONNECTION_MODE`		<optional>
`transformApiConfig`		<optional>

Source:

index.js, line 22

Methods

(static) createDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default
`destination`	String
`source`	String
`destinationConfig`	Object
`path`	String	<optional>
`workspace`	String	<optional>
`enabled`	Boolean	<optional>	true

Source:

methods.js, line 241

(static) createSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`source`	String	<optional>
`path`	String	<optional>
`workspace`	String	<optional>
`catalogName`	String	<optional>

Source:

methods.js, line 146

(static) deleteDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`path`	String	<optional>
`source`	String	<optional>
`destination`	String	<optional>
`workspace`	String	<optional>

Source:

methods.js, line 369

(static) deleteSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`source`	String
`workspace`	String	<optional>

Source:

methods.js, line 218

(static) getCatalogDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`destination`	String

Source:

methods.js, line 127

(static) getCatalogDestinationList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 105

(static) getCatalogSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`source`	String

Source:

methods.js, line 88

(static) getCatalogSourceList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 66

(static) getDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`destination`	String	<optional>
`source`	String	<optional>
`path`	String	<optional>
`workspace`	String	<optional>

Source:

methods.js, line 302

(static) getDestinationList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`source`	String
`path`	String	<optional>
`workspace`	String	<optional>
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 275

(static) getSource(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`path`	String	<optional>
`source`	String	<optional>
`workspace`	String	<optional>

Source:

methods.js, line 199

(static) getSourceList(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes
`path`	String	<optional>
`workspace`	String	<optional>
`pageSize`	String	<optional>
`pageToken`	String	<optional>

Source:

methods.js, line 174

(static) getTokenList(config) → {Object}

Parameters:

Name Type Description

config

Properties

Name	Type	Attributes	Default	Description
`username`		<optional>	Default Username
`password`		<optional>	Default Password

Source:

methods.js, line 14

(static) getWorkspace(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`workspace`	String
`path`	String	<optional>

Source:

methods.js, line 48

(static) updateDestination(config) → {Object}

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default
`destination`	String
`source`	String
`destinationConfig`	Object
`path`	String	<optional>
`workspace`	String	<optional>
`enabled`	Boolean	<optional>	true

Source:

methods.js, line 326