Class: DocuSign_eSign::ListSharedAccessOptions
- Inherits:
-
Object
- Object
- DocuSign_eSign::ListSharedAccessOptions
- Defined in:
- lib/docusign_esign/api/accounts_api.rb
Instance Attribute Summary collapse
-
#count ⇒ Object
Specifies maximum number of results included in the response.
-
#envelopes_not_shared_user_status ⇒ Object
Returns the value of attribute envelopes_not_shared_user_status.
-
#folder_ids ⇒ Object
Returns the value of attribute folder_ids.
-
#item_type ⇒ Object
Specifies the type of shared item being requested.
-
#search_text ⇒ Object
This can be used to filter user names in the response.
-
#shared ⇒ Object
Specifies which users should be included in the response.
-
#start_position ⇒ Object
If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index.
-
#user_ids ⇒ Object
A comma separated list of userIds for whom the shared item information is being requested.
Class Method Summary collapse
Instance Attribute Details
#count ⇒ Object
Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
144 145 146 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 144 def count @count end |
#envelopes_not_shared_user_status ⇒ Object
Returns the value of attribute envelopes_not_shared_user_status.
147 148 149 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 147 def envelopes_not_shared_user_status @envelopes_not_shared_user_status end |
#folder_ids ⇒ Object
Returns the value of attribute folder_ids.
150 151 152 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 150 def folder_ids @folder_ids end |
#item_type ⇒ Object
Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
153 154 155 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 153 def item_type @item_type end |
#search_text ⇒ Object
This can be used to filter user names in the response. The wild-card ‘*’ (asterisk) can be used around the string.
156 157 158 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 156 def search_text @search_text end |
#shared ⇒ Object
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
159 160 161 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 159 def shared @shared end |
#start_position ⇒ Object
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.
162 163 164 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 162 def start_position @start_position end |
#user_ids ⇒ Object
A comma separated list of userIds for whom the shared item information is being requested.
165 166 167 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 165 def user_ids @user_ids end |
Class Method Details
.default ⇒ Object
167 168 169 |
# File 'lib/docusign_esign/api/accounts_api.rb', line 167 def self.default @@default ||= ListSharedAccessOptions.new end |