cloudstorage

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jun 13, 2021 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Overview

Package cloudstorage implements the DocuSign SDK category CloudStorage.

Use the Cloud Storage category to list the user's cloud storage document contents.

It is also used to manage the user's authentication/accounts with cloud storage service providers.

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

import (
    "github.com/ICGGroup/esign"
    "github.com/ICGGroup/esign/v2.1/cloudstorage"
    "github.com/ICGGroup/esign/v2.1/model"
)
...
cloudstorageService := cloudstorage.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ListFoldersOp 

type ListFoldersOp esign.Op

ListFoldersOp implements DocuSign API SDK CloudStorage::listFolders

func (*ListFoldersOp) CloudStorageFolderPath 

func (op *ListFoldersOp) CloudStorageFolderPath(val ...string) *ListFoldersOp

CloudStorageFolderPath is a comma separated list of folder IDs included in the request.

func (*ListFoldersOp) Count 

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

Count is an optional value that sets how many items are included in the response.

The default setting for this is 25.

func (*ListFoldersOp) Do 

func (op *ListFoldersOp) Do(ctx context.Context) (*model.ExternalFolder, error)

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

func (*ListFoldersOp) Order 

func (op *ListFoldersOp) Order(val string) *ListFoldersOp

Order (Optional) The order in which to sort the results.

Valid values are:

* `asc`: Ascending order. * `desc`: Descending order.

func (*ListFoldersOp) OrderBy 

func (op *ListFoldersOp) OrderBy(val string) *ListFoldersOp

OrderBy (Optional) The file attribute to use to sort the results.

Valid values are:

* `modified` * `name`

func (*ListFoldersOp) SearchText 

func (op *ListFoldersOp) SearchText(val string) *ListFoldersOp

SearchText set the call query parameter search_text

func (*ListFoldersOp) StartPosition 

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

StartPosition indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

type ListOp 

type ListOp esign.Op

ListOp implements DocuSign API SDK CloudStorage::list

func (*ListOp) CloudStorageFolderPath 

func (op *ListOp) CloudStorageFolderPath(val string) *ListOp

CloudStorageFolderPath set the call query parameter cloud_storage_folder_path

func (*ListOp) CloudStorageFolderidPlain 

func (op *ListOp) CloudStorageFolderidPlain(val string) *ListOp

CloudStorageFolderidPlain set the call query parameter cloud_storage_folderid_plain

func (*ListOp) Count 

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

Count is an optional value that sets how many items are included in the response.

The default setting for this is 25.

func (*ListOp) Do 

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

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

func (*ListOp) Order 

func (op *ListOp) Order(val string) *ListOp

Order (Optional) The order in which to sort the results.

Valid values are:

* `asc`: Ascending order. * `desc`: Descending order.

func (*ListOp) OrderBy 

func (op *ListOp) OrderBy(val string) *ListOp

OrderBy (Optional) The file attribute to use to sort the results.

Valid values are:

* `modified` * `name`

func (*ListOp) SearchText 

func (op *ListOp) SearchText(val string) *ListOp

SearchText set the call query parameter search_text

func (*ListOp) StartPosition 

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

StartPosition indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

type ProvidersCreateOp 

type ProvidersCreateOp esign.Op

ProvidersCreateOp implements DocuSign API SDK CloudStorage::createProvider

func (*ProvidersCreateOp) Do 

func (op *ProvidersCreateOp) Do(ctx context.Context) (*model.CloudStorageProviders, error)

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

type ProvidersDeleteListOp 

type ProvidersDeleteListOp esign.Op

ProvidersDeleteListOp implements DocuSign API SDK CloudStorage::deleteProviders

func (*ProvidersDeleteListOp) Do 

func (op *ProvidersDeleteListOp) Do(ctx context.Context) (*model.CloudStorageProviders, error)

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

type ProvidersDeleteOp 

type ProvidersDeleteOp esign.Op

ProvidersDeleteOp implements DocuSign API SDK CloudStorage::deleteProvider

func (*ProvidersDeleteOp) Do 

func (op *ProvidersDeleteOp) Do(ctx context.Context) (*model.CloudStorageProviders, error)

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

type ProvidersGetOp 

type ProvidersGetOp esign.Op

ProvidersGetOp implements DocuSign API SDK CloudStorage::getProvider

func (*ProvidersGetOp) Do 

func (op *ProvidersGetOp) Do(ctx context.Context) (*model.CloudStorageProviders, error)

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

func (*ProvidersGetOp) RedirectURL 

func (op *ProvidersGetOp) RedirectURL(val string) *ProvidersGetOp

RedirectURL is the URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.

The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

type ProvidersListOp 

type ProvidersListOp esign.Op

ProvidersListOp implements DocuSign API SDK CloudStorage::listProviders

func (*ProvidersListOp) Do 

func (op *ProvidersListOp) Do(ctx context.Context) (*model.CloudStorageProviders, error)

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

func (*ProvidersListOp) RedirectURL 

func (op *ProvidersListOp) RedirectURL(val string) *ProvidersListOp

RedirectURL is the URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.

The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

type Service 

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

Service implements DocuSign CloudStorage Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a cloudstorage service using cred to authorize ops.

func (*Service) List 

func (s *Service) List(folderID string, serviceID string, userID string) *ListOp

List gets a list of all the items from the specified cloud storage provider.

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

SDK Method CloudStorage::list

func (*Service) ListFolders 

func (s *Service) ListFolders(serviceID string, userID string) *ListFoldersOp

ListFolders retrieves a list of all the items in a specified folder from the specified cloud storage provider.

https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders

SDK Method CloudStorage::listFolders

func (*Service) ProvidersCreate 

func (s *Service) ProvidersCreate(userID string, cloudStorageProviders *model.CloudStorageProviders) *ProvidersCreateOp

ProvidersCreate configures the redirect URL information for one or more cloud storage providers for the specified user.

https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorageproviders/create

SDK Method CloudStorage::createProvider

func (*Service) ProvidersDelete 

func (s *Service) ProvidersDelete(serviceID string, userID string) *ProvidersDeleteOp

ProvidersDelete deletes the user authentication information for the specified cloud storage provider.

https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorageproviders/delete

SDK Method CloudStorage::deleteProvider

func (*Service) ProvidersDeleteList 

func (s *Service) ProvidersDeleteList(userID string, cloudStorageProviders *model.CloudStorageProviders) *ProvidersDeleteListOp

ProvidersDeleteList deletes the user authentication information for one or more cloud storage providers.

https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorageproviders/deletelist

SDK Method CloudStorage::deleteProviders

func (*Service) ProvidersGet 

func (s *Service) ProvidersGet(serviceID string, userID string) *ProvidersGetOp

ProvidersGet gets the specified Cloud Storage Provider configuration for the User.

https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorageproviders/get

SDK Method CloudStorage::getProvider

func (*Service) ProvidersList 

func (s *Service) ProvidersList(userID string) *ProvidersListOp

ProvidersList get the Cloud Storage Provider configuration for the specified user.

https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorageproviders/list

SDK Method CloudStorage::listProviders

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.