Connector API

All URIs are relative to http://localhost:1000

Method	HTTP request	Description
connect	POST /connect	/connect [POST]
intention	POST /{application}/intention	/{application}/intention [POST]
onboarded	POST /{application}/onboarded	/onboarded [POST]
react	POST /{application}/reaction	/{application}/reaction [POST]
suggest	POST /{application}/suggestion	/{application}/suggestion [POST]
track	POST /{application}/track	/{application}/track [POST]

connect

Context connect(seededConnectorConnection)

/connect [POST]

Abstracts a bootup/connection for a specific context.

Example

import 'package:core_openapi/api.dart';

final api_instance = ConnectorApi();
final seededConnectorConnection = SeededConnectorConnection(); // SeededConnectorConnection | 

try {
    final result = api_instance.connect(seededConnectorConnection);
    print(result);
} catch (e) {
    print('Exception when calling ConnectorApi->connect: $e\n');
}

Parameters

Name	Type	Description	Notes
seededConnectorConnection	SeededConnectorConnection		[optional]

Return type

Context

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

intention

String intention(application, seededConnectorAsset)

/{application}/intention [POST]

Allows you to send a SeededAsset for future comparison.

Example

import 'package:core_openapi/api.dart';

final api_instance = ConnectorApi();
final application = application_example; // String | 
final seededConnectorAsset = SeededConnectorAsset(); // SeededConnectorAsset | 

try {
    final result = api_instance.intention(application, seededConnectorAsset);
    print(result);
} catch (e) {
    print('Exception when calling ConnectorApi->intention: $e\n');
}

Parameters

Name	Type	Description	Notes
application	String
seededConnectorAsset	SeededConnectorAsset		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain

onboarded

String onboarded(application, body)

/onboarded [POST]

A central endpoint to manage updates to the onboarding process.

Example

import 'package:core_openapi/api.dart';

final api_instance = ConnectorApi();
final application = application_example; // String | This is a uuid that represents an application
final body = bool(); // bool | Whether or not that application has been onboarded.

try {
    final result = api_instance.onboarded(application, body);
    print(result);
} catch (e) {
    print('Exception when calling ConnectorApi->onboarded: $e\n');
}

Parameters

Name	Type	Description	Notes
application	String	This is a uuid that represents an application
body	bool	Whether or not that application has been onboarded.	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain

react

String react(application, reaction)

/{application}/reaction [POST]

This will respond to the output generated by the /suggest endpoint.

Example

import 'package:core_openapi/api.dart';

final api_instance = ConnectorApi();
final application = application_example; // String | 
final reaction = Reaction(); // Reaction | ** This body will need to be modified.

try {
    final result = api_instance.react(application, reaction);
    print(result);
} catch (e) {
    print('Exception when calling ConnectorApi->react: $e\n');
}

Parameters

Name	Type	Description	Notes
application	String
reaction	Reaction	** This body will need to be modified.	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain

suggest

Suggestion suggest(application, seededConnectorCreation)

/{application}/suggestion [POST]

Invoked whenever a code snippet is copied from an integration. For instance, if a JetBrains user copies code, this endpoint can be called to assess whether to suggest reusing a piece (if reuse is true, the endpoint provides assets that the user may consider using), saving the code snippet, or taking no action. **Note: This endpoint could potentially accept a SeededFormat for the request body if required.

Example

import 'package:core_openapi/api.dart';

final api_instance = ConnectorApi();
final application = application_example; // String | 
final seededConnectorCreation = SeededConnectorCreation(); // SeededConnectorCreation | This is the Snippet that we will compare to all the saved assets to determine what we want to do with it!

try {
    final result = api_instance.suggest(application, seededConnectorCreation);
    print(result);
} catch (e) {
    print('Exception when calling ConnectorApi->suggest: $e\n');
}

Parameters

Name	Type	Description	Notes
application	String
seededConnectorCreation	SeededConnectorCreation	This is the Snippet that we will compare to all the saved assets to determine what we want to do with it!	[optional]

Return type

Suggestion

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

track

String track(application, seededConnectorTracking)

/{application}/track [POST]

Abstracts the process of packaging segments on a per-context basis.

Example

import 'package:core_openapi/api.dart';

final api_instance = ConnectorApi();
final application = application_example; // String | This is a uuid that represents an application
final seededConnectorTracking = SeededConnectorTracking(); // SeededConnectorTracking | The body is able to take in several properties 

try {
    final result = api_instance.track(application, seededConnectorTracking);
    print(result);
} catch (e) {
    print('Exception when calling ConnectorApi->track: $e\n');
}

Parameters

Name	Type	Description	Notes
application	String	This is a uuid that represents an application
seededConnectorTracking	SeededConnectorTracking	The body is able to take in several properties	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain