workspaces

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: 7 Imported by: 0

Documentation

Overview

Package workspaces implements the DocuSign SDK category Workspaces.

A workspace is a collaborative space for sharing documents and managing workflows. A workspace has a single owner who must be a DocuSign user. The owner can invite others to the workspace as collaborators. Individuals who are not DocuSign users must create a DocuSign account to join a workspace as a collaborator.

You can create an envelope directly from a workspace.

Workspaces store the following information:

- **Files:** Files uploaded to a workspace for storage or reuse. - **Documents:** A document is a component of a transaction, template, or workspace. When a file is added to a transaction, template, or workspace, it is copied as a document. Each document in a workspace has a single owner. - **Templates:** A set of documents that you can use to create a transaction or a workspace. - **Transactions:** A transaction is a series of workflow events related to one or more documents. These events route the documents to one or more individuals for the purposes of doing business. Each transaction has a single owner (the sender).

**Note:** Documents in a template are not individually listed as files.

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

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/v2.1/model"
)
...
workspacesService := workspaces.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateOp 

type CreateOp esign.Op

CreateOp implements DocuSign API SDK Workspaces::createWorkspace

func (*CreateOp) Do 

func (op *CreateOp) Do(ctx context.Context) (*model.Workspace, error)

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

type DeleteOp 

type DeleteOp esign.Op

DeleteOp implements DocuSign API SDK Workspaces::deleteWorkspace

func (*DeleteOp) Do 

func (op *DeleteOp) Do(ctx context.Context) (*model.Workspace, error)

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

type GetOp 

type GetOp esign.Op

GetOp implements DocuSign API SDK Workspaces::getWorkspace

func (*GetOp) Do 

func (op *GetOp) Do(ctx context.Context) (*model.Workspace, error)

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

type ItemsCreateFIleOp 

type ItemsCreateFIleOp esign.Op

ItemsCreateFIleOp implements DocuSign API SDK Workspaces::createWorkspaceFile

func (*ItemsCreateFIleOp) Do 

func (op *ItemsCreateFIleOp) Do(ctx context.Context) (*model.WorkspaceItem, error)

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

type ItemsDeleteFolderItemsOp 

type ItemsDeleteFolderItemsOp esign.Op

ItemsDeleteFolderItemsOp implements DocuSign API SDK Workspaces::deleteWorkspaceFolderItems

func (*ItemsDeleteFolderItemsOp) Do 

func (op *ItemsDeleteFolderItemsOp) Do(ctx context.Context) error

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

type ItemsGetFileOp 

type ItemsGetFileOp esign.Op

ItemsGetFileOp implements DocuSign API SDK Workspaces::getWorkspaceFile

func (*ItemsGetFileOp) Do 

func (op *ItemsGetFileOp) Do(ctx context.Context) error

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

func (*ItemsGetFileOp) IsDownload 

func (op *ItemsGetFileOp) IsDownload() *ItemsGetFileOp

IsDownload when **true,** the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false.**

func (*ItemsGetFileOp) PdfVersion 

func (op *ItemsGetFileOp) PdfVersion() *ItemsGetFileOp

PdfVersion when **true** the file is returned in PDF format.

type ItemsListFilePagesOp 

type ItemsListFilePagesOp esign.Op

ItemsListFilePagesOp implements DocuSign API SDK Workspaces::listWorkspaceFilePages

func (*ItemsListFilePagesOp) Count 

func (op *ItemsListFilePagesOp) Count(val int) *ItemsListFilePagesOp

Count is the maximum number of results to return.

Use `start_position` to specify the number of results to skip.

func (*ItemsListFilePagesOp) Do 

func (op *ItemsListFilePagesOp) Do(ctx context.Context) (*model.PageImages, error)

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

func (*ItemsListFilePagesOp) Dpi 

func (op *ItemsListFilePagesOp) Dpi(val int) *ItemsListFilePagesOp

Dpi is the number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.

func (*ItemsListFilePagesOp) MaxHeight 

func (op *ItemsListFilePagesOp) MaxHeight(val int) *ItemsListFilePagesOp

MaxHeight sets the maximum height of the returned images in pixels.

func (*ItemsListFilePagesOp) MaxWidth 

func (op *ItemsListFilePagesOp) MaxWidth(val int) *ItemsListFilePagesOp

MaxWidth sets the maximum width of the returned images in pixels.

func (*ItemsListFilePagesOp) StartPosition 

func (op *ItemsListFilePagesOp) StartPosition(val int) *ItemsListFilePagesOp

StartPosition is the zero-based index of the result from which to start returning results.

Use with `count` to limit the number of results.

The default value is `0`.

type ItemsListFolderItemsOp 

type ItemsListFolderItemsOp esign.Op

ItemsListFolderItemsOp implements DocuSign API SDK Workspaces::listWorkspaceFolderItems

func (*ItemsListFolderItemsOp) Count 

func (op *ItemsListFolderItemsOp) Count(val int) *ItemsListFolderItemsOp

Count is the maximum number of results to return.

Use `start_position` to specify the number of results to skip.

func (*ItemsListFolderItemsOp) Do 

func (op *ItemsListFolderItemsOp) Do(ctx context.Context) (*model.WorkspaceFolderContents, error)

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

func (*ItemsListFolderItemsOp) IncludeFiles 

func (op *ItemsListFolderItemsOp) IncludeFiles() *ItemsListFolderItemsOp

IncludeFiles when **true,** the response includes file information (in addition to folder information). The default is **false.**

func (*ItemsListFolderItemsOp) IncludeSubFolders 

func (op *ItemsListFolderItemsOp) IncludeSubFolders() *ItemsListFolderItemsOp

IncludeSubFolders when **true,** the response includes information about the sub-folders of the current folder. The default is **false.**

func (*ItemsListFolderItemsOp) IncludeThumbnails 

func (op *ItemsListFolderItemsOp) IncludeThumbnails() *ItemsListFolderItemsOp

IncludeThumbnails when **true,** the response returns thumbnails. The default is **false.**

func (*ItemsListFolderItemsOp) IncludeUserDetail 

func (op *ItemsListFolderItemsOp) IncludeUserDetail() *ItemsListFolderItemsOp

IncludeUserDetail when **true,** the response includes extended details about the user. The default is **false.**

func (*ItemsListFolderItemsOp) StartPosition 

func (op *ItemsListFolderItemsOp) StartPosition(val int) *ItemsListFolderItemsOp

StartPosition is the zero-based index of the result from which to start returning results.

Use with `count` to limit the number of results.

The default value is `0`.

func (*ItemsListFolderItemsOp) WorkspaceUserID 

func (op *ItemsListFolderItemsOp) WorkspaceUserID(val string) *ItemsListFolderItemsOp

WorkspaceUserID if set, the response only includes results associated with the `userId` that you specify.

type ItemsUpdateFileOp 

type ItemsUpdateFileOp esign.Op

ItemsUpdateFileOp implements DocuSign API SDK Workspaces::updateWorkspaceFile

func (*ItemsUpdateFileOp) Do 

func (op *ItemsUpdateFileOp) Do(ctx context.Context) (*model.WorkspaceItem, error)

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

type ListOp 

type ListOp esign.Op

ListOp implements DocuSign API SDK Workspaces::listWorkspaces

func (*ListOp) Do 

func (op *ListOp) Do(ctx context.Context) (*model.WorkspaceList, error)

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

type Service 

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

Service implements DocuSign Workspaces API operations

func New 

func New(cred esign.Credential) *Service

New initializes a workspaces service using cred to authorize ops.

func (*Service) Create 

func (s *Service) Create(workspace *model.Workspace) *CreateOp

Create create a Workspace

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/create

SDK Method Workspaces::createWorkspace

func (*Service) Delete 

func (s *Service) Delete(workspaceID string) *DeleteOp

Delete delete Workspace

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/delete

SDK Method Workspaces::deleteWorkspace

func (*Service) Get 

func (s *Service) Get(workspaceID string) *GetOp

Get get Workspace

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/get

SDK Method Workspaces::getWorkspace

func (*Service) ItemsCreateFIle 

func (s *Service) ItemsCreateFIle(folderID string, workspaceID string, media io.Reader, mimeType string) *ItemsCreateFIleOp

ItemsCreateFIle creates a workspace file. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/createfile

SDK Method Workspaces::createWorkspaceFile

func (*Service) ItemsDeleteFolderItems 

func (s *Service) ItemsDeleteFolderItems(folderID string, workspaceID string, workspaceItemList *model.WorkspaceItemList) *ItemsDeleteFolderItemsOp

ItemsDeleteFolderItems deletes files or sub-folders from a workspace.

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/deletefolderitems

SDK Method Workspaces::deleteWorkspaceFolderItems

func (*Service) ItemsGetFile 

func (s *Service) ItemsGetFile(fileID string, folderID string, workspaceID string) *ItemsGetFileOp

ItemsGetFile gets a workspace file

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/getfile

SDK Method Workspaces::getWorkspaceFile

func (*Service) ItemsListFilePages 

func (s *Service) ItemsListFilePages(fileID string, folderID string, workspaceID string) *ItemsListFilePagesOp

ItemsListFilePages list File Pages

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/listfilepages

SDK Method Workspaces::listWorkspaceFilePages

func (*Service) ItemsListFolderItems 

func (s *Service) ItemsListFolderItems(folderID string, workspaceID string) *ItemsListFolderItemsOp

ItemsListFolderItems list workspace folder contents

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/listfolderitems

SDK Method Workspaces::listWorkspaceFolderItems

func (*Service) ItemsUpdateFile 

func (s *Service) ItemsUpdateFile(fileID string, folderID string, workspaceID string, media io.Reader, mimeType string) *ItemsUpdateFileOp

ItemsUpdateFile update workspace file or folder metadata If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/updatefile

SDK Method Workspaces::updateWorkspaceFile

func (*Service) List 

func (s *Service) List() *ListOp

List list Workspaces

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/list

SDK Method Workspaces::listWorkspaces

func (*Service) Update 

func (s *Service) Update(workspaceID string, workspace *model.Workspace) *UpdateOp

Update update Workspace

https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/update

SDK Method Workspaces::updateWorkspace

type UpdateOp 

type UpdateOp esign.Op

UpdateOp implements DocuSign API SDK Workspaces::updateWorkspace

func (*UpdateOp) Do 

func (op *UpdateOp) Do(ctx context.Context) (*model.Workspace, 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.