DocuSign.Rooms by DocuSign

<PackageReference Include="DocuSign.Rooms" Version="1.2.0-rc" />

.NET API 1,044,992 bytes

 FormGroupsApi

public class FormGroupsApi : IFormGroupsApi, IApiAccessor
Represents a collection of functions to interact with the API endpoints
public class GetFormGroupsOptions

Get account Form Groups. Returns the company form groups to which the current user has access.

public ApiClient ApiClient { get; set; }

Gets or sets the ApiClient object

public ExceptionFactory ExceptionFactory { get; set; }

Provides a factory method hook for the creation of exceptions.

public FormGroupsApi(ApiClient aplClient)

Initializes a new instance of the FormGroupsApi class using AplClient object

public FormGroupFormToAssign AssignFormGroupForm(string accountId, Guid? formGroupId, FormGroupFormToAssign body = null)

Assigns a form to a form group. Assigns the form specified in the `formId` property of the request to the form group `formGroupId`.

public Task<FormGroupFormToAssign> AssignFormGroupFormAsync(string accountId, Guid? formGroupId, FormGroupFormToAssign body = null)

Assigns a form to a form group. Assigns the form specified in the `formId` property of the request to the form group `formGroupId`.

public Task<ApiResponse<FormGroupFormToAssign>> AssignFormGroupFormAsyncWithHttpInfo(string accountId, Guid? formGroupId, FormGroupFormToAssign body = null)

Assigns a form to a form group. Assigns the form specified in the `formId` property of the request to the form group `formGroupId`.

public ApiResponse<FormGroupFormToAssign> AssignFormGroupFormWithHttpInfo(string accountId, Guid? formGroupId, FormGroupFormToAssign body = null)

Assigns a form to a form group. Assigns the form specified in the `formId` property of the request to the form group `formGroupId`.

public FormGroup CreateFormGroup(string accountId, FormGroupForCreate body = null)

Creates a form group. Creates a new form group with the name given in the `name` property of the request body.

public Task<FormGroup> CreateFormGroupAsync(string accountId, FormGroupForCreate body = null)

Creates a form group. Creates a new form group with the name given in the `name` property of the request body.

public Task<ApiResponse<FormGroup>> CreateFormGroupAsyncWithHttpInfo(string accountId, FormGroupForCreate body = null)

Creates a form group. Creates a new form group with the name given in the `name` property of the request body.

public ApiResponse<FormGroup> CreateFormGroupWithHttpInfo(string accountId, FormGroupForCreate body = null)

Creates a form group. Creates a new form group with the name given in the `name` property of the request body.

public void DeleteFormGroup(string accountId, Guid? formGroupId)

Deletes a form group. Deletes the specified form group.

public Task DeleteFormGroupAsync(string accountId, Guid? formGroupId)

Deletes a form group. Deletes the specified form group.

public Task<ApiResponse<object>> DeleteFormGroupAsyncWithHttpInfo(string accountId, Guid? formGroupId)

Deletes a form group. Deletes the specified form group.

public ApiResponse<object> DeleteFormGroupWithHttpInfo(string accountId, Guid? formGroupId)

Deletes a form group. Deletes the specified form group.

public string GetBasePath()

Gets the base path of the API client.

public FormGroup GetFormGroup(string accountId, Guid? formGroupId)

Gets a form group. Get the specified form group.

public Task<FormGroup> GetFormGroupAsync(string accountId, Guid? formGroupId)

Gets a form group. Get the specified form group.

public Task<ApiResponse<FormGroup>> GetFormGroupAsyncWithHttpInfo(string accountId, Guid? formGroupId)

Gets a form group. Get the specified form group.

public FormGroupSummaryList GetFormGroups(string accountId, GetFormGroupsOptions options = null)

Get account Form Groups. Returns the company form groups to which the current user has access.

public Task<FormGroupSummaryList> GetFormGroupsAsync(string accountId, GetFormGroupsOptions options = null)

Get account Form Groups. Returns the company form groups to which the current user has access.

public Task<ApiResponse<FormGroupSummaryList>> GetFormGroupsAsyncWithHttpInfo(string accountId, GetFormGroupsOptions options = null)

Get account Form Groups. Returns the company form groups to which the current user has access.

public ApiResponse<FormGroupSummaryList> GetFormGroupsWithHttpInfo(string accountId, GetFormGroupsOptions options = null)

Get account Form Groups. Returns the company form groups to which the current user has access.

public ApiResponse<FormGroup> GetFormGroupWithHttpInfo(string accountId, Guid? formGroupId)

Gets a form group. Get the specified form group.

public void GrantOfficeAccessToFormGroup(string accountId, Guid? formGroupId, int? officeId)

Assign office to a form group so the specified office has access to the form group. \"Grants the office `officeId` access to the form group `formGroupId`.

public Task GrantOfficeAccessToFormGroupAsync(string accountId, Guid? formGroupId, int? officeId)

Assign office to a form group so the specified office has access to the form group. \"Grants the office `officeId` access to the form group `formGroupId`.

public Task<ApiResponse<object>> GrantOfficeAccessToFormGroupAsyncWithHttpInfo(string accountId, Guid? formGroupId, int? officeId)

Assign office to a form group so the specified office has access to the form group. \"Grants the office `officeId` access to the form group `formGroupId`.

public ApiResponse<object> GrantOfficeAccessToFormGroupWithHttpInfo(string accountId, Guid? formGroupId, int? officeId)

Assign office to a form group so the specified office has access to the form group. \"Grants the office `officeId` access to the form group `formGroupId`.

public void RemoveFormGroupForm(string accountId, Guid? formGroupId, Guid? formId)

Removes a form from a form group. Removes the form `formId` from the form group `formGroupId`.

public Task RemoveFormGroupFormAsync(string accountId, Guid? formGroupId, Guid? formId)

Removes a form from a form group. Removes the form `formId` from the form group `formGroupId`.

public Task<ApiResponse<object>> RemoveFormGroupFormAsyncWithHttpInfo(string accountId, Guid? formGroupId, Guid? formId)

Removes a form from a form group. Removes the form `formId` from the form group `formGroupId`.

public ApiResponse<object> RemoveFormGroupFormWithHttpInfo(string accountId, Guid? formGroupId, Guid? formId)

Removes a form from a form group. Removes the form `formId` from the form group `formGroupId`.

public FormGroup RenameFormGroup(string accountId, Guid? formGroupId, FormGroupForUpdate body = null)

Renames a form group. Renames the specified form group with the name given in the `name` property of the request.

public Task<FormGroup> RenameFormGroupAsync(string accountId, Guid? formGroupId, FormGroupForUpdate body = null)

Renames a form group. Renames the specified form group with the name given in the `name` property of the request.

public Task<ApiResponse<FormGroup>> RenameFormGroupAsyncWithHttpInfo(string accountId, Guid? formGroupId, FormGroupForUpdate body = null)

Renames a form group. Renames the specified form group with the name given in the `name` property of the request.

public ApiResponse<FormGroup> RenameFormGroupWithHttpInfo(string accountId, Guid? formGroupId, FormGroupForUpdate body = null)

Renames a form group. Renames the specified form group with the name given in the `name` property of the request.

public void RevokeOfficeAccessFromFormGroup(string accountId, Guid? formGroupId, int? officeId)

Remove office to a form group so the specified office doesn't have access to the form group. Revoke access to the form group `formGroupId` from the office `officeId`.

public Task RevokeOfficeAccessFromFormGroupAsync(string accountId, Guid? formGroupId, int? officeId)

Remove office to a form group so the specified office doesn't have access to the form group. Revoke access to the form group `formGroupId` from the office `officeId`.

public Task<ApiResponse<object>> RevokeOfficeAccessFromFormGroupAsyncWithHttpInfo(string accountId, Guid? formGroupId, int? officeId)

Remove office to a form group so the specified office doesn't have access to the form group. Revoke access to the form group `formGroupId` from the office `officeId`.

public ApiResponse<object> RevokeOfficeAccessFromFormGroupWithHttpInfo(string accountId, Guid? formGroupId, int? officeId)

Remove office to a form group so the specified office doesn't have access to the form group. Revoke access to the form group `formGroupId` from the office `officeId`.