• Home
• com.docusign
• docusign-esign-java
• 4.5.0
• source code
• ConnectApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.docusign.esign.api.ConnectApi Maven / Gradle / Ivy

package com.docusign.esign.api;

import com.docusign.esign.client.ApiClient;
import com.docusign.esign.client.ApiException;
import com.docusign.esign.client.ApiResponse;
import com.docusign.esign.client.Configuration;
import com.docusign.esign.client.Pair;
import com.docusign.esign.model.*;
import jakarta.ws.rs.core.GenericType;

/** ConnectApi class. */
public class ConnectApi {
  private ApiClient apiClient;

  /** ConnectApi. */
  public ConnectApi() {
    this(Configuration.getDefaultApiClient());
  }

  /** ConnectApi. */
  public ConnectApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * getApiClient Method.
   *
   * @return ApiClient
   */
  public ApiClient getApiClient() {
    return apiClient;
  }

  /** setApiClient Method. */
  public void setApiClient(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Creates a connect configuration for the specified account.. Creates a DocuSign Custom Connect
   * definition for your account. DocuSign Connect enables the sending of real-time data updates to
   * external applications. These updates are generated by user transactions as the envelope
   * progresses through actions to completion. The Connect Service provides updated information
   * about the status of these transactions and returns updates that include the actual content of
   * document form fields. Be aware that, these updates might or might not include the document
   * itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ######
   * Note: Connect must be enabled for your account to use this function. This cannot be used to set
   * up Connect configurations for Salesforce or eOriginal.
   *
   * @param accountId The external account number (int) or account ID Guid. (required)
   * @param connectCustomConfiguration (optional)
   * @return ConnectCustomConfiguration
   * @throws ApiException if fails to make API call
   */
  public ConnectCustomConfiguration createConfiguration(
      String accountId, ConnectCustomConfiguration connectCustomConfiguration) throws ApiException {
    ApiResponse localVarResponse =
        createConfigurationWithHttpInfo(accountId, connectCustomConfiguration);
    return localVarResponse.getData();
  }

  /**
   * Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect
   * definition for your account. DocuSign Connect enables the sending of real-time data updates to
   * external applications. These updates are generated by user transactions as the envelope
   * progresses through actions to completion. The Connect Service provides updated information
   * about the status of these transactions and returns updates that include the actual content of
   * document form fields. Be aware that, these updates might or might not include the document
   * itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ######
   * Note: Connect must be enabled for your account to use this function. This cannot be used to set
   * up Connect configurations for Salesforce or eOriginal.
   *
   * @param accountId The external account number (int) or account ID Guid. (required)
   * @param connectCustomConfiguration (optional)
   * @return ConnectCustomConfiguration
   * @throws ApiException if fails to make API call
   */
  public ApiResponse createConfigurationWithHttpInfo(
      String accountId, ConnectCustomConfiguration connectCustomConfiguration) throws ApiException {
    Object localVarPostBody = connectCustomConfiguration;

    // verify the required parameter 'accountId' is set
    if (accountId == null) {
      throw new ApiException(
          400, "Missing the required parameter 'accountId' when calling createConfiguration");
    }

    // create path and map variables
    String localVarPath =
        "/v2.1/accounts/{accountId}/connect"
            .replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));

    // query params
    java.util.List localVarQueryParams = new java.util.ArrayList();
    java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
    java.util.Map localVarHeaderParams = new java.util.HashMap();
    java.util.Map localVarFormParams = new java.util.HashMap();

    final String[] localVarAccepts = {"application/json"};
    final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

    final String[] localVarContentTypes = {};

    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

    String[] localVarAuthNames = new String[] {"docusignAccessCode"};

    GenericType localVarReturnType =
        new GenericType() {};
    ConnectCustomConfiguration localVarResponse =
        apiClient.invokeAPI(
            localVarPath,
            "POST",
            localVarQueryParams,
            localVarCollectionQueryParams,
            localVarPostBody,
            localVarHeaderParams,
            localVarFormParams,
            localVarAccept,
            localVarContentType,
            localVarAuthNames,
            localVarReturnType);
    return new ApiResponse(
        apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
  }

  /**
   * Sets the Connect OAuth Config for the account..
   *
   * @param accountId The external account number (int) or account ID Guid. (required)
   * @param connectOAuthConfig (optional)
   * @return ConnectOAuthConfig
   * @throws ApiException if fails to make API call
   */
  public ConnectOAuthConfig createConnectOAuthConfig(
      String accountId, ConnectOAuthConfig connectOAuthConfig) throws ApiException {
    ApiResponse localVarResponse =
        createConnectOAuthConfigWithHttpInfo(accountId, connectOAuthConfig);
    return localVarResponse.getData();
  }

  /**
   * Sets the Connect OAuth Config for the account.
   *
   * @param accountId The external account number (int) or account ID Guid. (required)
   * @param connectOAuthConfig (optional)
   * @return ConnectOAuthConfig
   * @throws ApiException if fails to make API call
   */
  public ApiResponse createConnectOAuthConfigWithHttpInfo(
      String accountId, ConnectOAuthConfig connectOAuthConfig) throws ApiException {
    Object localVarPostBody = connectOAuthConfig;

    // verify the required parameter 'accountId' is set
    if (accountId == null) {
      throw new ApiException(
          400, "Missing the required parameter 'accountId' when calling createConnectOAuthConfig");
    }

    // create path and map variables
    String localVarPath =
        "/v2.1/accounts/{accountId}/connect/oauth"
            .replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));

    // query params
    java.util.List localVarQueryParams = new java.util.ArrayList();
    java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
    java.util.Map localVarHeaderParams = new java.util.HashMap();
    java.util.Map localVarFormParams = new java.util.HashMap();

    final String[] localVarAccepts = {"application/json"};
    final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

    final String[] localVarContentTypes = {};

    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

    String[] localVarAuthNames = new String[] {"docusignAccessCode"};

    GenericType localVarReturnType = new GenericType() {};
    ConnectOAuthConfig localVarResponse =
        apiClient.invokeAPI(
            localVarPath,
            "POST",
            localVarQueryParams,
            localVarCollectionQueryParams,
            localVarPostBody,
            localVarHeaderParams,
            localVarFormParams,
            localVarAccept,
            localVarContentType,
            localVarAuthNames,
            localVarReturnType);
    return new ApiResponse(
        apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
  }

  /**
   * Deletes the specified connect configuration.. Deletes the specified DocuSign Connect
   * configuration. ###### Note: Connect must be enabled for your account to use this function.
   *
   * @param accountId The external account number (int) or account ID Guid. (required)
   * @param connectId The ID of the custom Connect configuration being accessed. (required)
   * @throws ApiException if fails to make API call
   */
  public void deleteConfiguration(String accountId, String connectId) throws ApiException {
    deleteConfigurationWithHttpInfo(accountId, connectId);
  }

  /**
   * Deletes the specified connect configuration. Deletes the specified DocuSign Connect
   * configuration. ###### Note: Connect must be enabled for your account to use this function.
   *
   * @param accountId The external account number (int) or account ID Guid. (required)
   * @param connectId The ID of the custom Connect configuration being accessed. (required)
   * @throws ApiException if fails to make API call
   */
  public ApiResponse