Class: DocuSign_eSign::ListSharedAccessOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/accounts_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#countObject

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


154
155
156
# File 'lib/docusign_esign/api/accounts_api.rb', line 154

def count
  @count
end

#envelopes_not_shared_user_statusObject

Returns the value of attribute envelopes_not_shared_user_status


157
158
159
# File 'lib/docusign_esign/api/accounts_api.rb', line 157

def envelopes_not_shared_user_status
  @envelopes_not_shared_user_status
end

#folder_idsObject

Returns the value of attribute folder_ids


160
161
162
# File 'lib/docusign_esign/api/accounts_api.rb', line 160

def folder_ids
  @folder_ids
end

#item_typeObject

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


163
164
165
# File 'lib/docusign_esign/api/accounts_api.rb', line 163

def item_type
  @item_type
end

#search_textObject

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


166
167
168
# File 'lib/docusign_esign/api/accounts_api.rb', line 166

def search_text
  @search_text
end

#sharedObject

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


169
170
171
# File 'lib/docusign_esign/api/accounts_api.rb', line 169

def shared
  @shared
end

#start_positionObject

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.


172
173
174
# File 'lib/docusign_esign/api/accounts_api.rb', line 172

def start_position
  @start_position
end

#user_idsObject

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


175
176
177
# File 'lib/docusign_esign/api/accounts_api.rb', line 175

def user_ids
  @user_ids
end

Class Method Details

.defaultObject


177
178
179
# File 'lib/docusign_esign/api/accounts_api.rb', line 177

def self.default
  @@default ||= ListSharedAccessOptions.new
end