• Home
• com.docusign
• docusign-admin-java
• 1.2.0
• source code
• DsGroupsApi.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.admin.api.DsGroupsApi Maven / Gradle / Ivy

package com.docusign.admin.api;

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

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

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

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

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

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

  /**
   * Add a new DSGroup. Required scopes: user_write
   *
   * @param organizationId The organization ID GUID (required)
   * @param accountId The account ID GUID (required)
   * @param addRequest Add DSGroup request object (required)
   * @return DSGroupResponse
   * @throws ApiException if fails to make API call
   */
  public DSGroupResponse addDSGroup(
      java.util.UUID organizationId, java.util.UUID accountId, DSGroupAddRequest addRequest)
      throws ApiException {
    ApiResponse localVarResponse =
        addDSGroupWithHttpInfo(organizationId, accountId, addRequest);
    return localVarResponse.getData();
  }

  /**
   * Add a new DSGroup Required scopes: user_write
   *
   * @param organizationId The organization ID GUID (required)
   * @param accountId The account ID GUID (required)
   * @param addRequest Add DSGroup request object (required)
   * @return DSGroupResponse
   * @throws ApiException if fails to make API call
   */
  public ApiResponse addDSGroupWithHttpInfo(
      java.util.UUID organizationId, java.util.UUID accountId, DSGroupAddRequest addRequest)
      throws ApiException {
    Object localVarPostBody = addRequest;

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

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

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

    // create path and map variables
    String localVarPath =
        "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups"
            .replaceAll(
                "\\{" + "organizationId" + "\\}", apiClient.escapeString(organizationId.toString()))
            .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 = {"application/json"};
    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

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

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

  /**
   * Add list of users to a DSGroup. Required scopes: user_write
   *
   * @param organizationId The organization ID GUID (required)
   * @param accountId The account ID GUID (required)
   * @param dsGroupId The DSGroup ID GUID (required)
   * @param dSGroupUsersAddRequest Add DSGroup users request object (required)
   * @return AddDSGroupAndUsersResponse
   * @throws ApiException if fails to make API call
   */
  public AddDSGroupAndUsersResponse addDSGroupUsers(
      java.util.UUID organizationId,
      java.util.UUID accountId,
      java.util.UUID dsGroupId,
      DSGroupUsersAddRequest dSGroupUsersAddRequest)
      throws ApiException {
    ApiResponse localVarResponse =
        addDSGroupUsersWithHttpInfo(organizationId, accountId, dsGroupId, dSGroupUsersAddRequest);
    return localVarResponse.getData();
  }

  /**
   * Add list of users to a DSGroup Required scopes: user_write
   *
   * @param organizationId The organization ID GUID (required)
   * @param accountId The account ID GUID (required)
   * @param dsGroupId The DSGroup ID GUID (required)
   * @param dSGroupUsersAddRequest Add DSGroup users request object (required)
   * @return AddDSGroupAndUsersResponse
   * @throws ApiException if fails to make API call
   */
  public ApiResponse addDSGroupUsersWithHttpInfo(
      java.util.UUID organizationId,
      java.util.UUID accountId,
      java.util.UUID dsGroupId,
      DSGroupUsersAddRequest dSGroupUsersAddRequest)
      throws ApiException {
    Object localVarPostBody = dSGroupUsersAddRequest;

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

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

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

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

    // create path and map variables
    String localVarPath =
        "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users"
            .replaceAll(
                "\\{" + "organizationId" + "\\}", apiClient.escapeString(organizationId.toString()))
            .replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
            .replaceAll("\\{" + "dsGroupId" + "\\}", apiClient.escapeString(dsGroupId.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 = {"application/json"};
    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

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

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

  /**
   * Delete a DSGroup. Required scopes: user_write
   *
   * @param organizationId The organization ID GUID (required)
   * @param accountId The account ID GUID (required)
   * @param dsGroupId The DSGroup ID GUID (required)
   * @throws ApiException if fails to make API call
   */
  public void deleteDSGroup(
      java.util.UUID organizationId, java.util.UUID accountId, java.util.UUID dsGroupId)
      throws ApiException {
    deleteDSGroupWithHttpInfo(organizationId, accountId, dsGroupId);
  }

  /**
   * Delete a DSGroup Required scopes: user_write
   *
   * @param organizationId The organization ID GUID (required)
   * @param accountId The account ID GUID (required)
   * @param dsGroupId The DSGroup ID GUID (required)
   * @throws ApiException if fails to make API call
   */
  public ApiResponse