class DocuSign_eSign::ListSharedAccessOptions

Attributes

count[RW]

Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.

envelopes_not_shared_user_status[RW]
folder_ids[RW]
item_type[RW]

Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.

search_text[RW]

This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.

shared[RW]

Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user

start_position[RW]

If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.

user_ids[RW]

A comma separated list of userIds for whom the shared item information is being requested.

Public Class Methods

default() click to toggle source 
# File lib/docusign_esign/api/accounts_api.rb, line 281
def self.default
  @@default ||= ListSharedAccessOptions.new
end