Skip to content

Latest commit

 

History

History
133 lines (98 loc) · 8.45 KB

README.md

File metadata and controls

133 lines (98 loc) · 8.45 KB
Raw

Connectors

(connector().connectors())

Overview

Available Operations

  • list - List Connectors
  • get - Get Connector

list

List Connectors

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.ConnectorsFilter;
import com.apideck.unify.models.components.UnifiedApiId;
import com.apideck.unify.models.errors.BadRequestResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.operations.ConnectorConnectorsAllResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_API_KEY_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        ConnectorConnectorsAllResponse res = sdk.connector().connectors().list()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .cursor("<value>")
                .limit(20L)
                .filter(ConnectorsFilter.builder()
                    .unifiedApi(UnifiedApiId.FILE_STORAGE)
                    .build())
                .call();

        if (res.getConnectorsResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
cursor JsonNullable<String> ➖ Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
limit Optional<Long> ➖ Number of results to return. Minimum 1, Maximum 200, Default 20
filter Optional<ConnectorsFilter> ➖ Apply filters {
"unified_api": "file-storage"
}

Response

ConnectorConnectorsAllResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/APIException 4XX, 5XX */*

get

Get Connector

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.NotFoundResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.operations.ConnectorConnectorsOneResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_API_KEY_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        ConnectorConnectorsOneResponse res = sdk.connector().connectors().get()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .id("<id>")
                .call();

        if (res.getConnectorResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
id String ✔️ ID of the record you are acting upon.

Response

ConnectorConnectorsOneResponse

Errors

Error Type Status Code Content Type
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/APIException 4XX, 5XX */*