regions

Documentation

Overview

Package regions implements the DocuSign SDK category Regions.

This section shows you how to create and manage regions for a Rooms account.

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

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/rooms"
)
...
regionsService := regions.New(esignCredential)

Index

• type CreateRegionOp
  • func (op *CreateRegionOp) Do(ctx context.Context) (*rooms.Region, error)
• type DeleteRegionOp
  • func (op *DeleteRegionOp) Do(ctx context.Context) error
• type GetRegionOp
  • func (op *GetRegionOp) Do(ctx context.Context) (*rooms.Region, error)
• type GetRegionReferenceCountsOp
  • func (op *GetRegionReferenceCountsOp) Do(ctx context.Context) (*rooms.RegionReferenceCountList, error)
• type GetRegionsOp
  • func (op *GetRegionsOp) Count(val int) *GetRegionsOp
  • func (op *GetRegionsOp) Do(ctx context.Context) (*rooms.RegionSummaryList, error)
  • func (op *GetRegionsOp) ManagedOnly() *GetRegionsOp
  • func (op *GetRegionsOp) StartPosition(val int) *GetRegionsOp
• type Service
  • func New(cred esign.Credential) *Service
  • func (s *Service) CreateRegion(body *rooms.Region) *CreateRegionOp
  • func (s *Service) DeleteRegion(regionID string) *DeleteRegionOp
  • func (s *Service) GetRegion(regionID string) *GetRegionOp
  • func (s *Service) GetRegionReferenceCounts(regionID string) *GetRegionReferenceCountsOp
  • func (s *Service) GetRegions() *GetRegionsOp

Types

type CreateRegionOp

type CreateRegionOp esign.Op

CreateRegionOp implements DocuSign API SDK Regions::CreateRegion

func (*CreateRegionOp) Do

func (op *CreateRegionOp) Do(ctx context.Context) (*rooms.Region, error)

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

type DeleteRegionOp

type DeleteRegionOp esign.Op

DeleteRegionOp implements DocuSign API SDK Regions::DeleteRegion

func (*DeleteRegionOp) Do

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

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

type GetRegionOp

type GetRegionOp esign.Op

GetRegionOp implements DocuSign API SDK Regions::GetRegion

func (*GetRegionOp) Do

func (op *GetRegionOp) Do(ctx context.Context) (*rooms.Region, error)

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

type GetRegionReferenceCountsOp

type GetRegionReferenceCountsOp esign.Op

GetRegionReferenceCountsOp implements DocuSign API SDK Regions::GetRegionReferenceCounts

func (*GetRegionReferenceCountsOp) Do

func (op *GetRegionReferenceCountsOp) Do(ctx context.Context) (*rooms.RegionReferenceCountList, error)

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

type GetRegionsOp

type GetRegionsOp esign.Op

GetRegionsOp implements DocuSign API SDK Regions::GetRegions

func (*GetRegionsOp) Count

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

Count (Optional) The number of results to return. This value must be a number between `1` and `100` (default).

func (*GetRegionsOp) Do

func (op *GetRegionsOp) Do(ctx context.Context) (*rooms.RegionSummaryList, error)

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

func (*GetRegionsOp) ManagedOnly

func (op *GetRegionsOp) ManagedOnly() *GetRegionsOp

ManagedOnly (Optional) When set to **true**, only the regions that the current user manages are returned. The default value is **false**.

func (*GetRegionsOp) StartPosition

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

StartPosition (Optional) The starting zero-based index position of the results set from which to begin returning values. The default value is `0`.

type Service

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

Service implements DocuSign Regions API operations

func New

func New(cred esign.Credential) *Service

New initializes a regions service using cred to authorize ops.

func (*Service) CreateRegion

func (s *Service) CreateRegion(body *rooms.Region) *CreateRegionOp

CreateRegion creates a region.

https://developers.docusign.com/docs/rooms-api/reference/regions/regions/createregion

SDK Method Regions::CreateRegion

func (*Service) DeleteRegion

func (s *Service) DeleteRegion(regionID string) *DeleteRegionOp

DeleteRegion deletes a region.

https://developers.docusign.com/docs/rooms-api/reference/regions/regions/deleteregion

SDK Method Regions::DeleteRegion

func (*Service) GetRegion

func (s *Service) GetRegion(regionID string) *GetRegionOp

GetRegion gets information about a region.

https://developers.docusign.com/docs/rooms-api/reference/regions/regions/getregion

SDK Method Regions::GetRegion

func (*Service) GetRegionReferenceCounts

func (s *Service) GetRegionReferenceCounts(regionID string) *GetRegionReferenceCountsOp

GetRegionReferenceCounts retrieves the number and type of objects that reference a region.

https://developers.docusign.com/docs/rooms-api/reference/regions/regions/getregionreferencecounts

SDK Method Regions::GetRegionReferenceCounts

func (*Service) GetRegions

func (s *Service) GetRegions() *GetRegionsOp

GetRegions gets regions.

https://developers.docusign.com/docs/rooms-api/reference/regions/regions/getregions

SDK Method Regions::GetRegions