bulkoperations

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 12, 2023 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Overview

Package bulkoperations implements the DocuSign SDK category BulkOperations.

Methods to import and export users and accounts.

Service Api documentation may be found at: https://developers.docusign.com/docs/admin-api/reference/BulkOperations Usage example: 

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/admin"
)
...
bulkoperationsService := bulkoperations.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddBulkAccountSettingsImportOp 

type AddBulkAccountSettingsImportOp esign.Op

AddBulkAccountSettingsImportOp implements DocuSign API SDK BulkOperations::addBulkAccountSettingsImport

func (*AddBulkAccountSettingsImportOp) Do 

func (op *AddBulkAccountSettingsImportOp) Do(ctx context.Context) (*admin.OrganizationAccountSettingsImportResponse, error)

Do executes the op. A nil context will return error.

type AddBulkUserImportOp 

type AddBulkUserImportOp esign.Op

AddBulkUserImportOp implements DocuSign API SDK BulkOperations::addBulkUserImport

func (*AddBulkUserImportOp) Do 

func (op *AddBulkUserImportOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

type CloseBulkExternalUserImportRequestOp 

type CloseBulkExternalUserImportRequestOp esign.Op

CloseBulkExternalUserImportRequestOp implements DocuSign API SDK BulkOperations::closeBulkExternalUserImportRequest

func (*CloseBulkExternalUserImportRequestOp) Do 

func (op *CloseBulkExternalUserImportRequestOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

type CloseBulkUserImportRequestOp 

type CloseBulkUserImportRequestOp esign.Op

CloseBulkUserImportRequestOp implements DocuSign API SDK BulkOperations::closeBulkUserImportRequest

func (*CloseBulkUserImportRequestOp) Do 

func (op *CloseBulkUserImportRequestOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

type CreateAccountSettingsExportOp 

type CreateAccountSettingsExportOp esign.Op

CreateAccountSettingsExportOp implements DocuSign API SDK BulkOperations::createAccountSettingsExport

func (*CreateAccountSettingsExportOp) Do 

func (op *CreateAccountSettingsExportOp) Do(ctx context.Context) (*admin.OrganizationExportResponse, error)

Do executes the op. A nil context will return error.

type CreateBulkImportSingleAccountAddUsersRequestOp 

type CreateBulkImportSingleAccountAddUsersRequestOp esign.Op

CreateBulkImportSingleAccountAddUsersRequestOp implements DocuSign API SDK BulkOperations::createBulkImportSingleAccountAddUsersRequest

func (*CreateBulkImportSingleAccountAddUsersRequestOp) Do 

func (op *CreateBulkImportSingleAccountAddUsersRequestOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

type CreateBulkImportSingleAccountUpdateUsersRequestOp 

type CreateBulkImportSingleAccountUpdateUsersRequestOp esign.Op

CreateBulkImportSingleAccountUpdateUsersRequestOp implements DocuSign API SDK BulkOperations::createBulkImportSingleAccountUpdateUsersRequest

func (*CreateBulkImportSingleAccountUpdateUsersRequestOp) Do 

func (op *CreateBulkImportSingleAccountUpdateUsersRequestOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

type CreateUserListExportOp 

type CreateUserListExportOp esign.Op

CreateUserListExportOp implements DocuSign API SDK BulkOperations::createUserListExport

func (*CreateUserListExportOp) Do 

func (op *CreateUserListExportOp) Do(ctx context.Context) (*admin.OrganizationExportResponse, error)

Do executes the op. A nil context will return error.

type DeleteAccountSettingsExportOp 

type DeleteAccountSettingsExportOp esign.Op

DeleteAccountSettingsExportOp implements DocuSign API SDK BulkOperations::deleteAccountSettingsExport

func (*DeleteAccountSettingsExportOp) Do 

func (op *DeleteAccountSettingsExportOp) Do(ctx context.Context) (map[string]interface{}, error)

Do executes the op. A nil context will return error.

type DeleteBulkAccountSettingsImportOp 

type DeleteBulkAccountSettingsImportOp esign.Op

DeleteBulkAccountSettingsImportOp implements DocuSign API SDK BulkOperations::deleteBulkAccountSettingsImport

func (*DeleteBulkAccountSettingsImportOp) Do 

func (op *DeleteBulkAccountSettingsImportOp) Do(ctx context.Context) (map[string]interface{}, error)

Do executes the op. A nil context will return error.

type DeleteBulkUserImportOp 

type DeleteBulkUserImportOp esign.Op

DeleteBulkUserImportOp implements DocuSign API SDK BulkOperations::deleteBulkUserImport

func (*DeleteBulkUserImportOp) Do 

func (op *DeleteBulkUserImportOp) Do(ctx context.Context) (map[string]interface{}, error)

Do executes the op. A nil context will return error.

type DeleteUserListExportOp 

type DeleteUserListExportOp esign.Op

DeleteUserListExportOp implements DocuSign API SDK BulkOperations::deleteUserListExport

func (*DeleteUserListExportOp) Do 

func (op *DeleteUserListExportOp) Do(ctx context.Context) (map[string]interface{}, error)

Do executes the op. A nil context will return error.

type GetAccountSettingsExportOp 

type GetAccountSettingsExportOp esign.Op

GetAccountSettingsExportOp implements DocuSign API SDK BulkOperations::getAccountSettingsExport

func (*GetAccountSettingsExportOp) Do 

func (op *GetAccountSettingsExportOp) Do(ctx context.Context) (*admin.OrganizationExportResponse, error)

Do executes the op. A nil context will return error.

type GetAccountSettingsExportsOp 

type GetAccountSettingsExportsOp esign.Op

GetAccountSettingsExportsOp implements DocuSign API SDK BulkOperations::getAccountSettingsExports

func (*GetAccountSettingsExportsOp) Do 

func (op *GetAccountSettingsExportsOp) Do(ctx context.Context) (*admin.OrganizationExportsResponse, error)

Do executes the op. A nil context will return error.

type GetBulkAccountSettingsImportOp 

type GetBulkAccountSettingsImportOp esign.Op

GetBulkAccountSettingsImportOp implements DocuSign API SDK BulkOperations::getBulkAccountSettingsImport

func (*GetBulkAccountSettingsImportOp) Do 

func (op *GetBulkAccountSettingsImportOp) Do(ctx context.Context) (*admin.OrganizationAccountSettingsImportResponse, error)

Do executes the op. A nil context will return error.

type GetBulkAccountSettingsImportsOp 

type GetBulkAccountSettingsImportsOp esign.Op

GetBulkAccountSettingsImportsOp implements DocuSign API SDK BulkOperations::getBulkAccountSettingsImports

func (*GetBulkAccountSettingsImportsOp) Do 

func (op *GetBulkAccountSettingsImportsOp) Do(ctx context.Context) ([]interface{}, error)

Do executes the op. A nil context will return error.

type GetBulkUserImportCSVOp 

type GetBulkUserImportCSVOp esign.Op

GetBulkUserImportCSVOp implements DocuSign API SDK BulkOperations::getBulkUserImportCSV

func (*GetBulkUserImportCSVOp) Do 

func (op *GetBulkUserImportCSVOp) Do(ctx context.Context) (map[string]interface{}, error)

Do executes the op. A nil context will return error.

type GetBulkUserImportRequestOp 

type GetBulkUserImportRequestOp esign.Op

GetBulkUserImportRequestOp implements DocuSign API SDK BulkOperations::getBulkUserImportRequest

func (*GetBulkUserImportRequestOp) Do 

func (op *GetBulkUserImportRequestOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

type GetBulkUserImportRequestsOp 

type GetBulkUserImportRequestsOp esign.Op

GetBulkUserImportRequestsOp implements DocuSign API SDK BulkOperations::getBulkUserImportRequests

func (*GetBulkUserImportRequestsOp) Do 

func (op *GetBulkUserImportRequestsOp) Do(ctx context.Context) (*admin.OrganizationImportsResponse, error)

Do executes the op. A nil context will return error.

type GetUserListExportOp 

type GetUserListExportOp esign.Op

GetUserListExportOp implements DocuSign API SDK BulkOperations::getUserListExport

func (*GetUserListExportOp) Do 

func (op *GetUserListExportOp) Do(ctx context.Context) (*admin.OrganizationExportResponse, error)

Do executes the op. A nil context will return error.

type GetUserListExportsOp 

type GetUserListExportsOp esign.Op

GetUserListExportsOp implements DocuSign API SDK BulkOperations::getUserListExports

func (*GetUserListExportsOp) Do 

func (op *GetUserListExportsOp) Do(ctx context.Context) (*admin.OrganizationExportsResponse, error)

Do executes the op. A nil context will return error.

type Service 

type Service struct {
	// contains filtered or unexported fields
}

Service implements DocuSign BulkOperations API operations

func New 

func New(cred esign.Credential) *Service

New initializes a bulkoperations service using cred to authorize ops.

func (*Service) AddBulkAccountSettingsImport 

func (s *Service) AddBulkAccountSettingsImport(organizationID string, media io.Reader, mimeType string) *AddBulkAccountSettingsImportOp

AddBulkAccountSettingsImport creates a new account settings import request. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsimport/addbulkaccountsettingsimport

SDK Method BulkOperations::addBulkAccountSettingsImport

func (*Service) AddBulkUserImport 

func (s *Service) AddBulkUserImport(organizationID string, media io.Reader, mimeType string) *AddBulkUserImportOp

AddBulkUserImport creates a request to import new users into an account. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/addbulkuserimport

SDK Method BulkOperations::addBulkUserImport

func (*Service) CloseBulkExternalUserImportRequest 

func (s *Service) CloseBulkExternalUserImportRequest(organizationID string, media io.Reader, mimeType string) *CloseBulkExternalUserImportRequestOp

CloseBulkExternalUserImportRequest closes external memberships. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/closebulkexternaluserimportrequest

SDK Method BulkOperations::closeBulkExternalUserImportRequest

func (*Service) CloseBulkUserImportRequest 

func (s *Service) CloseBulkUserImportRequest(organizationID string, media io.Reader, mimeType string) *CloseBulkUserImportRequestOp

CloseBulkUserImportRequest creates a request to close the accounts of existing users. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/closebulkuserimportrequest

SDK Method BulkOperations::closeBulkUserImportRequest

func (*Service) CreateAccountSettingsExport 

func (s *Service) CreateAccountSettingsExport(organizationID string, request *admin.OrganizationAccountsRequest) *CreateAccountSettingsExportOp

CreateAccountSettingsExport creates a new account settings export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsexport/createaccountsettingsexport

SDK Method BulkOperations::createAccountSettingsExport

func (*Service) CreateBulkImportSingleAccountAddUsersRequest 

func (s *Service) CreateBulkImportSingleAccountAddUsersRequest(organizationID string, media io.Reader, mimeType string) *CreateBulkImportSingleAccountAddUsersRequestOp

CreateBulkImportSingleAccountAddUsersRequest import request for adding user to a single account within the organization.

If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/singleaccountuserimport/createbulkimportsingleaccountaddusersrequest

SDK Method BulkOperations::createBulkImportSingleAccountAddUsersRequest

func (*Service) CreateBulkImportSingleAccountUpdateUsersRequest 

func (s *Service) CreateBulkImportSingleAccountUpdateUsersRequest(organizationID string, media io.Reader, mimeType string) *CreateBulkImportSingleAccountUpdateUsersRequestOp

CreateBulkImportSingleAccountUpdateUsersRequest import request for updating users for a single account within the organization. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/singleaccountuserimport/createbulkimportsingleaccountupdateusersrequest

SDK Method BulkOperations::createBulkImportSingleAccountUpdateUsersRequest

func (*Service) CreateUserListExport 

func (s *Service) CreateUserListExport(organizationID string, request *admin.OrganizationExportRequest) *CreateUserListExportOp

CreateUserListExport creates a user list export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/createuserlistexport

SDK Method BulkOperations::createUserListExport

func (*Service) DeleteAccountSettingsExport 

func (s *Service) DeleteAccountSettingsExport(organizationID string, exportID string) *DeleteAccountSettingsExportOp

DeleteAccountSettingsExport deletes a single account settings export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsexport/deleteaccountsettingsexport

SDK Method BulkOperations::deleteAccountSettingsExport

func (*Service) DeleteBulkAccountSettingsImport 

func (s *Service) DeleteBulkAccountSettingsImport(organizationID string, importID string) *DeleteBulkAccountSettingsImportOp

DeleteBulkAccountSettingsImport deletes a Bulk Account Settings Import request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsimport/deletebulkaccountsettingsimport

SDK Method BulkOperations::deleteBulkAccountSettingsImport

func (*Service) DeleteBulkUserImport 

func (s *Service) DeleteBulkUserImport(organizationID string, importID string) *DeleteBulkUserImportOp

DeleteBulkUserImport deletes a specific user import request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/deletebulkuserimport

SDK Method BulkOperations::deleteBulkUserImport

func (*Service) DeleteUserListExport 

func (s *Service) DeleteUserListExport(organizationID string, exportID string) *DeleteUserListExportOp

DeleteUserListExport deletes a single user list export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/deleteuserlistexport

SDK Method BulkOperations::deleteUserListExport

func (*Service) GetAccountSettingsExport 

func (s *Service) GetAccountSettingsExport(organizationID string, exportID string) *GetAccountSettingsExportOp

GetAccountSettingsExport returns the results for a single account settings export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsexport/getaccountsettingsexport

SDK Method BulkOperations::getAccountSettingsExport

func (*Service) GetAccountSettingsExports 

func (s *Service) GetAccountSettingsExports(organizationID string) *GetAccountSettingsExportsOp

GetAccountSettingsExports returns a list of pending and completed account settings export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsexport/getaccountsettingsexports

SDK Method BulkOperations::getAccountSettingsExports

func (*Service) GetBulkAccountSettingsImport 

func (s *Service) GetBulkAccountSettingsImport(organizationID string, importID string) *GetBulkAccountSettingsImportOp

GetBulkAccountSettingsImport returns the details/metadata for a Bulk Account Settings Import request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsimport/getbulkaccountsettingsimport

SDK Method BulkOperations::getBulkAccountSettingsImport

func (*Service) GetBulkAccountSettingsImports 

func (s *Service) GetBulkAccountSettingsImports(organizationID string) *GetBulkAccountSettingsImportsOp

GetBulkAccountSettingsImports returns the details and metadata for Bulk Account Settings Import requests in the organization.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/accountsettingsimport/getbulkaccountsettingsimports

SDK Method BulkOperations::getBulkAccountSettingsImports

func (*Service) GetBulkUserImportCSV 

func (s *Service) GetBulkUserImportCSV(organizationID string, importID string) *GetBulkUserImportCSVOp

GetBulkUserImportCSV given the ID of a user import request, return the CSV file that was imported.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/getbulkuserimportcsv

SDK Method BulkOperations::getBulkUserImportCSV

func (*Service) GetBulkUserImportRequest 

func (s *Service) GetBulkUserImportRequest(organizationID string, importID string) *GetBulkUserImportRequestOp

GetBulkUserImportRequest returns the details of a single user import request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/getbulkuserimportrequest

SDK Method BulkOperations::getBulkUserImportRequest

func (*Service) GetBulkUserImportRequests 

func (s *Service) GetBulkUserImportRequests(organizationID string) *GetBulkUserImportRequestsOp

GetBulkUserImportRequests gets a list of all of the user import requests.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/getbulkuserimportrequests

SDK Method BulkOperations::getBulkUserImportRequests

func (*Service) GetUserListExport 

func (s *Service) GetUserListExport(organizationID string, exportID string) *GetUserListExportOp

GetUserListExport returns the results for single user list export request.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/getuserlistexport

SDK Method BulkOperations::getUserListExport

func (*Service) GetUserListExports 

func (s *Service) GetUserListExports(organizationID string) *GetUserListExportsOp

GetUserListExports returns a list of pending and completed export requests.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/getuserlistexports

SDK Method BulkOperations::getUserListExports

func (*Service) UpdateBulkUserImports 

func (s *Service) UpdateBulkUserImports(organizationID string, media io.Reader, mimeType string) *UpdateBulkUserImportsOp

UpdateBulkUserImports bulk updates information for existing users. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/updatebulkuserimports

SDK Method BulkOperations::updateBulkUserImports

type UpdateBulkUserImportsOp 

type UpdateBulkUserImportsOp esign.Op

UpdateBulkUserImportsOp implements DocuSign API SDK BulkOperations::updateBulkUserImports

func (*UpdateBulkUserImportsOp) Do 

func (op *UpdateBulkUserImportsOp) Do(ctx context.Context) (*admin.OrganizationImportResponse, error)

Do executes the op. A nil context will return error.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.