groupdocs 2.2.0 → 2.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.travis.yml +9 -9
- data/CHANGELOG.md +482 -477
- data/Gemfile +3 -3
- data/LICENSE.txt +21 -21
- data/README.md +94 -94
- data/Rakefile +9 -9
- data/examples/README.md +12 -12
- data/examples/api-samples/Gemfile +5 -5
- data/examples/api-samples/Gemfile.lock +49 -49
- data/examples/api-samples/README.md +23 -23
- data/examples/api-samples/public/css/style.css +229 -229
- data/examples/api-samples/public/docs/annotation-sample.html +167 -167
- data/examples/api-samples/public/docs/docco.css +500 -500
- data/examples/api-samples/public/docs/envelope-sample.html +374 -374
- data/examples/api-samples/public/docs/sample01.html +181 -181
- data/examples/api-samples/public/docs/sample02.html +199 -199
- data/examples/api-samples/public/docs/sample03.html +318 -318
- data/examples/api-samples/public/docs/sample04.html +217 -217
- data/examples/api-samples/public/docs/sample05.html +296 -296
- data/examples/api-samples/public/docs/sample06.html +347 -347
- data/examples/api-samples/public/docs/sample07.html +209 -209
- data/examples/api-samples/public/docs/sample08.html +277 -277
- data/examples/api-samples/public/docs/sample09.html +314 -314
- data/examples/api-samples/public/docs/sample10.html +270 -270
- data/examples/api-samples/public/docs/sample11.html +462 -462
- data/examples/api-samples/public/docs/sample12.html +199 -199
- data/examples/api-samples/public/docs/sample13.html +201 -201
- data/examples/api-samples/public/docs/sample14.html +204 -204
- data/examples/api-samples/public/docs/sample15.html +182 -182
- data/examples/api-samples/public/docs/sample16.html +234 -234
- data/examples/api-samples/public/docs/sample17.html +309 -309
- data/examples/api-samples/public/docs/sample18.html +721 -721
- data/examples/api-samples/public/docs/sample19.html +631 -631
- data/examples/api-samples/public/docs/sample20.html +230 -230
- data/examples/api-samples/public/docs/sample21.html +790 -790
- data/examples/api-samples/public/docs/sample22.html +408 -408
- data/examples/api-samples/public/docs/sample25.html +550 -550
- data/examples/api-samples/public/templates/base-simple_source.html +191 -191
- data/examples/api-samples/public/templates/testdocument.html +100 -100
- data/examples/api-samples/public/templates/welcome.htm +137 -137
- data/examples/api-samples/samples/annotation-sample.rb +56 -56
- data/examples/api-samples/samples/envelope-sample.rb +133 -133
- data/examples/api-samples/samples/sample01.rb +44 -44
- data/examples/api-samples/samples/sample02.rb +50 -50
- data/examples/api-samples/samples/sample03.rb +79 -79
- data/examples/api-samples/samples/sample04.rb +54 -54
- data/examples/api-samples/samples/sample05.rb +83 -83
- data/examples/api-samples/samples/sample06.rb +86 -86
- data/examples/api-samples/samples/sample07.rb +59 -59
- data/examples/api-samples/samples/sample08.rb +76 -76
- data/examples/api-samples/samples/sample09.rb +85 -85
- data/examples/api-samples/samples/sample10.rb +70 -70
- data/examples/api-samples/samples/sample11.rb +132 -132
- data/examples/api-samples/samples/sample12.rb +48 -48
- data/examples/api-samples/samples/sample13.rb +49 -49
- data/examples/api-samples/samples/sample14.rb +54 -54
- data/examples/api-samples/samples/sample15.rb +43 -43
- data/examples/api-samples/samples/sample16.rb +57 -57
- data/examples/api-samples/samples/sample17.rb +70 -70
- data/examples/api-samples/samples/sample18.rb +190 -190
- data/examples/api-samples/samples/sample19.rb +188 -188
- data/examples/api-samples/samples/sample20.rb +68 -68
- data/examples/api-samples/samples/sample21.rb +212 -212
- data/examples/api-samples/samples/sample22.rb +109 -109
- data/examples/api-samples/samples/sample25.rb +127 -127
- data/examples/api-samples/views/_others_samples.haml +233 -233
- data/examples/api-samples/views/annotation_sample.haml +63 -63
- data/examples/api-samples/views/envelope_sample.haml +72 -72
- data/examples/api-samples/views/index.haml +235 -235
- data/examples/api-samples/views/layout.haml +3 -3
- data/examples/api-samples/views/sample01.haml +63 -63
- data/examples/api-samples/views/sample02.haml +52 -52
- data/examples/api-samples/views/sample03.haml +87 -87
- data/examples/api-samples/views/sample04.haml +55 -55
- data/examples/api-samples/views/sample05.haml +86 -86
- data/examples/api-samples/views/sample06.haml +58 -58
- data/examples/api-samples/views/sample07.haml +52 -52
- data/examples/api-samples/views/sample08.haml +100 -100
- data/examples/api-samples/views/sample09.haml +95 -95
- data/examples/api-samples/views/sample10.haml +93 -93
- data/examples/api-samples/views/sample11.haml +140 -140
- data/examples/api-samples/views/sample12.haml +68 -68
- data/examples/api-samples/views/sample13.haml +64 -64
- data/examples/api-samples/views/sample14.haml +60 -60
- data/examples/api-samples/views/sample15.haml +51 -51
- data/examples/api-samples/views/sample16.haml +50 -50
- data/examples/api-samples/views/sample17.haml +54 -54
- data/examples/api-samples/views/sample18.haml +143 -143
- data/examples/api-samples/views/sample19.haml +92 -92
- data/examples/api-samples/views/sample20.haml +54 -54
- data/examples/api-samples/views/sample21.haml +123 -123
- data/examples/api-samples/views/sample22.haml +106 -106
- data/examples/api-samples/views/sample25.haml +101 -101
- data/examples/api-samples/views/sample31.haml +2 -2
- data/examples/api-samples/web.rb +20 -20
- data/examples/viewer/Gemfile +5 -5
- data/examples/viewer/app.rb +52 -52
- data/groupdocs.gemspec +31 -31
- data/lib/groupdocs.rb +62 -62
- data/lib/groupdocs/api.rb +6 -6
- data/lib/groupdocs/api/entity.rb +112 -112
- data/lib/groupdocs/api/helpers.rb +11 -11
- data/lib/groupdocs/api/helpers/access_mode_helper.rb +27 -27
- data/lib/groupdocs/api/helpers/access_rights_helper.rb +55 -55
- data/lib/groupdocs/api/helpers/accessor_helper.rb +30 -30
- data/lib/groupdocs/api/helpers/byte_flag_helper.rb +49 -49
- data/lib/groupdocs/api/helpers/credentials_helper.rb +35 -35
- data/lib/groupdocs/api/helpers/mime_helper.rb +21 -21
- data/lib/groupdocs/api/helpers/path_helper.rb +28 -28
- data/lib/groupdocs/api/helpers/rest_helper.rb +99 -99
- data/lib/groupdocs/api/helpers/signature_public_helper.rb +22 -22
- data/lib/groupdocs/api/helpers/status_helper.rb +27 -27
- data/lib/groupdocs/api/helpers/url_helper.rb +101 -101
- data/lib/groupdocs/api/request.rb +91 -91
- data/lib/groupdocs/datasource.rb +249 -249
- data/lib/groupdocs/datasource/field.rb +39 -39
- data/lib/groupdocs/document.rb +1550 -1550
- data/lib/groupdocs/document/annotation.rb +421 -421
- data/lib/groupdocs/document/annotation/reply.rb +173 -173
- data/lib/groupdocs/document/annotation/reviewer.rb +66 -66
- data/lib/groupdocs/document/change.rb +56 -56
- data/lib/groupdocs/document/field.rb +53 -53
- data/lib/groupdocs/document/metadata.rb +32 -32
- data/lib/groupdocs/document/rectangle.rb +18 -18
- data/lib/groupdocs/document/view.rb +36 -36
- data/lib/groupdocs/errors.rb +8 -8
- data/lib/groupdocs/job.rb +468 -468
- data/lib/groupdocs/questionnaire.rb +530 -530
- data/lib/groupdocs/questionnaire/collector.rb +335 -335
- data/lib/groupdocs/questionnaire/execution.rb +181 -181
- data/lib/groupdocs/questionnaire/page.rb +43 -43
- data/lib/groupdocs/questionnaire/question.rb +108 -108
- data/lib/groupdocs/questionnaire/question/answer.rb +15 -15
- data/lib/groupdocs/signature.rb +380 -380
- data/lib/groupdocs/signature/contact.rb +181 -181
- data/lib/groupdocs/signature/envelope.rb +747 -747
- data/lib/groupdocs/signature/envelope/log.rb +20 -20
- data/lib/groupdocs/signature/field.rb +286 -286
- data/lib/groupdocs/signature/field/location.rb +71 -71
- data/lib/groupdocs/signature/form.rb +804 -804
- data/lib/groupdocs/signature/list.rb +92 -92
- data/lib/groupdocs/signature/recipient.rb +79 -79
- data/lib/groupdocs/signature/role.rb +54 -54
- data/lib/groupdocs/signature/shared.rb +6 -6
- data/lib/groupdocs/signature/shared/document_methods.rb +158 -158
- data/lib/groupdocs/signature/shared/entity_fields.rb +76 -76
- data/lib/groupdocs/signature/shared/entity_methods.rb +144 -144
- data/lib/groupdocs/signature/shared/field_methods.rb +354 -354
- data/lib/groupdocs/signature/shared/recipient_methods.rb +75 -75
- data/lib/groupdocs/signature/shared/resource_methods.rb +65 -65
- data/lib/groupdocs/signature/template.rb +124 -124
- data/lib/groupdocs/storage.rb +44 -44
- data/lib/groupdocs/storage/file.rb +432 -432
- data/lib/groupdocs/storage/folder.rb +288 -288
- data/lib/groupdocs/storage/package.rb +48 -48
- data/lib/groupdocs/storage/provider.rb +32 -32
- data/lib/groupdocs/subscription.rb +323 -323
- data/lib/groupdocs/subscription/limit.rb +20 -20
- data/lib/groupdocs/user.rb +955 -930
- data/lib/groupdocs/version.rb +3 -3
- data/spec/groupdocs/api/entity_spec.rb +55 -55
- data/spec/groupdocs/api/helpers/access_mode_helper_spec.rb +21 -21
- data/spec/groupdocs/api/helpers/access_rights_helper_spec.rb +43 -43
- data/spec/groupdocs/api/helpers/accessor_helper_spec.rb +16 -16
- data/spec/groupdocs/api/helpers/byte_flag_helper_spec.rb +23 -23
- data/spec/groupdocs/api/helpers/credentials_helpers_spec.rb +48 -48
- data/spec/groupdocs/api/helpers/mime_helper_spec.rb +16 -16
- data/spec/groupdocs/api/helpers/path_helper_spec.rb +15 -15
- data/spec/groupdocs/api/helpers/rest_helper_spec.rb +161 -161
- data/spec/groupdocs/api/helpers/signature_public_helper_spec.rb +21 -21
- data/spec/groupdocs/api/helpers/status_helper_spec.rb +22 -22
- data/spec/groupdocs/api/helpers/url_helper_spec.rb +112 -112
- data/spec/groupdocs/api/request_spec.rb +112 -112
- data/spec/groupdocs/datasource/field_spec.rb +29 -29
- data/spec/groupdocs/datasource_spec.rb +145 -145
- data/spec/groupdocs/document/annotation/reply_spec.rb +154 -154
- data/spec/groupdocs/document/annotation/reviewer_spec.rb +51 -51
- data/spec/groupdocs/document/annotation_spec.rb +234 -234
- data/spec/groupdocs/document/change_spec.rb +39 -39
- data/spec/groupdocs/document/field_spec.rb +28 -28
- data/spec/groupdocs/document/metadata_spec.rb +21 -21
- data/spec/groupdocs/document/rectangle_spec.rb +14 -14
- data/spec/groupdocs/document/view_spec.rb +33 -33
- data/spec/groupdocs/document_spec.rb +859 -859
- data/spec/groupdocs/errors_spec.rb +7 -7
- data/spec/groupdocs/job_spec.rb +323 -323
- data/spec/groupdocs/questionnaire/collector_spec.rb +197 -197
- data/spec/groupdocs/questionnaire/execution_spec.rb +162 -162
- data/spec/groupdocs/questionnaire/page_spec.rb +47 -47
- data/spec/groupdocs/questionnaire/question/answer_spec.rb +9 -9
- data/spec/groupdocs/questionnaire/question_spec.rb +75 -75
- data/spec/groupdocs/questionnaire_spec.rb +295 -295
- data/spec/groupdocs/signature/contact_spec.rb +142 -142
- data/spec/groupdocs/signature/envelope/log_spec.rb +15 -15
- data/spec/groupdocs/signature/envelope_spec.rb +384 -384
- data/spec/groupdocs/signature/field/location_spec.rb +40 -40
- data/spec/groupdocs/signature/field_spec.rb +235 -235
- data/spec/groupdocs/signature/form_spec.rb +205 -205
- data/spec/groupdocs/signature/list_spec.rb +87 -87
- data/spec/groupdocs/signature/recipient_spec.rb +26 -26
- data/spec/groupdocs/signature/role_spec.rb +47 -47
- data/spec/groupdocs/signature/template_spec.rb +80 -80
- data/spec/groupdocs/signature_spec.rb +194 -194
- data/spec/groupdocs/storage/file_spec.rb +303 -303
- data/spec/groupdocs/storage/folder_spec.rb +270 -270
- data/spec/groupdocs/storage/package_spec.rb +38 -38
- data/spec/groupdocs/storage/provider_spec.rb +21 -21
- data/spec/groupdocs/storage_spec.rb +27 -27
- data/spec/groupdocs/subscription/limit_spec.rb +16 -16
- data/spec/groupdocs/subscription_spec.rb +74 -74
- data/spec/groupdocs/user_spec.rb +257 -257
- data/spec/groupdocs_spec.rb +63 -63
- data/spec/spec_helper.rb +73 -73
- data/spec/support/json/annotation_access_set.json +11 -11
- data/spec/support/json/annotation_collaborators_get.json +16 -16
- data/spec/support/json/annotation_collaborators_set.json +16 -16
- data/spec/support/json/annotation_create.json +12 -12
- data/spec/support/json/annotation_list.json +32 -32
- data/spec/support/json/annotation_marker_move.json +10 -10
- data/spec/support/json/annotation_move.json +8 -8
- data/spec/support/json/annotation_remove.json +9 -9
- data/spec/support/json/annotation_replies_create.json +9 -9
- data/spec/support/json/annotation_replies_get.json +25 -25
- data/spec/support/json/annotation_reviewers_get.json +18 -18
- data/spec/support/json/comparison_changes.json +46 -46
- data/spec/support/json/comparison_compare.json +8 -8
- data/spec/support/json/comparison_document.json +10 -10
- data/spec/support/json/contact_add.json +12 -12
- data/spec/support/json/contacts_get.json +19 -19
- data/spec/support/json/contacts_import.json +8 -8
- data/spec/support/json/datasource_add.json +8 -8
- data/spec/support/json/datasource_get.json +22 -22
- data/spec/support/json/datasource_remove.json +8 -8
- data/spec/support/json/datasource_update.json +8 -8
- data/spec/support/json/delete_account.json +9 -9
- data/spec/support/json/document_access_info_get.json +14 -14
- data/spec/support/json/document_convert.json +8 -8
- data/spec/support/json/document_datasource.json +10 -10
- data/spec/support/json/document_fields.json +34 -34
- data/spec/support/json/document_formats.json +8 -8
- data/spec/support/json/document_metadata.json +15 -15
- data/spec/support/json/document_page_images_get.json +20 -20
- data/spec/support/json/document_questionnaire_create.json +9 -9
- data/spec/support/json/document_questionnaires.json +23 -23
- data/spec/support/json/document_sharers_remove.json +8 -8
- data/spec/support/json/document_sharers_set.json +16 -16
- data/spec/support/json/document_thumbnails.json +24 -24
- data/spec/support/json/document_views.json +32 -32
- data/spec/support/json/envelope_get.json +46 -46
- data/spec/support/json/envelope_logs.json +16 -16
- data/spec/support/json/envelope_recipient_add.json +26 -26
- data/spec/support/json/envelopes_all.json +48 -48
- data/spec/support/json/envelopes_resources.json +31 -31
- data/spec/support/json/file_compress.json +8 -8
- data/spec/support/json/file_copy.json +14 -14
- data/spec/support/json/file_delete.json +5 -5
- data/spec/support/json/file_move.json +14 -14
- data/spec/support/json/file_upload.json +8 -8
- data/spec/support/json/folder_create.json +8 -8
- data/spec/support/json/folder_delete.json +5 -5
- data/spec/support/json/folder_list.json +22 -22
- data/spec/support/json/folder_move.json +8 -8
- data/spec/support/json/folder_sharers_get.json +16 -16
- data/spec/support/json/folder_sharers_remove.json +8 -8
- data/spec/support/json/folder_sharers_set.json +16 -16
- data/spec/support/json/form_get.json +21 -21
- data/spec/support/json/forms_all.json +23 -23
- data/spec/support/json/job_add_url.json +8 -8
- data/spec/support/json/job_create.json +8 -8
- data/spec/support/json/job_documents.json +40 -40
- data/spec/support/json/job_file_add.json +8 -8
- data/spec/support/json/job_get.json +30 -30
- data/spec/support/json/job_update.json +7 -7
- data/spec/support/json/jobs_get.json +58 -58
- data/spec/support/json/list_add.json +12 -12
- data/spec/support/json/lists_get.json +19 -19
- data/spec/support/json/package_create.json +7 -7
- data/spec/support/json/questionnaire_collector.json +17 -17
- data/spec/support/json/questionnaire_collectors.json +38 -38
- data/spec/support/json/questionnaire_collectors_add.json +10 -10
- data/spec/support/json/questionnaire_create.json +10 -10
- data/spec/support/json/questionnaire_datasources.json +26 -26
- data/spec/support/json/questionnaire_execution_add.json +9 -9
- data/spec/support/json/questionnaire_execution_status_set.json +8 -8
- data/spec/support/json/questionnaire_execution_update.json +8 -8
- data/spec/support/json/questionnaire_executions.json +28 -28
- data/spec/support/json/questionnaire_get.json +17 -17
- data/spec/support/json/questionnaire_remove.json +8 -8
- data/spec/support/json/questionnaire_update.json +8 -8
- data/spec/support/json/questionnaires_get.json +40 -40
- data/spec/support/json/sign_documents.json +16 -16
- data/spec/support/json/signature_create.json +12 -12
- data/spec/support/json/signature_field_add.json +25 -25
- data/spec/support/json/signature_fields_get.json +27 -27
- data/spec/support/json/signature_roles_get.json +17 -17
- data/spec/support/json/signatures_get.json +19 -19
- data/spec/support/json/storage_info.json +10 -10
- data/spec/support/json/subscription_plan_get.json +9 -9
- data/spec/support/json/subscription_plans_get.json +17 -17
- data/spec/support/json/template_get.json +35 -35
- data/spec/support/json/template_get_documents.json +15 -15
- data/spec/support/json/template_get_recipients.json +20 -20
- data/spec/support/json/templates_all.json +37 -37
- data/spec/support/json/templates_get.json +21 -21
- data/spec/support/json/update_account.json +10 -10
- data/spec/support/json/user_area.json +67 -67
- data/spec/support/json/user_embed_key.json +38 -38
- data/spec/support/json/user_get_embed_key.json +67 -67
- data/spec/support/json/user_login.json +67 -67
- data/spec/support/json/user_profile_get.json +24 -24
- data/spec/support/json/user_providers.json +31 -31
- data/spec/support/json/user_roles.json +25 -25
- data/spec/support/json/user_users_get.json +27 -27
- data/spec/support/shared_examples/api/entity.rb +39 -39
- data/spec/support/shared_examples/api/helpers/access_mode_helper.rb +11 -11
- data/spec/support/shared_examples/api/helpers/status_helper.rb +11 -11
- data/spec/support/shared_examples/signature/shared/document_methods.rb +68 -68
- data/spec/support/shared_examples/signature/shared/entity_fields.rb +56 -56
- data/spec/support/shared_examples/signature/shared/entity_methods.rb +116 -116
- data/spec/support/shared_examples/signature/shared/field_methods.rb +220 -220
- data/spec/support/shared_examples/signature/shared/recipient_methods.rb +46 -46
- data/spec/support/shared_examples/signature/shared/resource_methods.rb +46 -46
- metadata +35 -55
@@ -1,92 +1,92 @@
|
|
1
|
-
module GroupDocs
|
2
|
-
class Signature::List < Api::Entity
|
3
|
-
|
4
|
-
#
|
5
|
-
# Returns array of predefined lists.
|
6
|
-
#
|
7
|
-
# @param [Hash] access Access credentials
|
8
|
-
# @option access [String] :client_id
|
9
|
-
# @option access [String] :private_key
|
10
|
-
# @return [Array<GroupDocs::Signature::List>]
|
11
|
-
#
|
12
|
-
def self.get!(access = {})
|
13
|
-
json = Api::Request.new do |request|
|
14
|
-
request[:access] = access
|
15
|
-
request[:method] = :GET
|
16
|
-
request[:path] = '/signature/{{client_id}}/lists'
|
17
|
-
end.execute!
|
18
|
-
|
19
|
-
json[:lists].map do |list|
|
20
|
-
new(list)
|
21
|
-
end
|
22
|
-
end
|
23
|
-
|
24
|
-
# @attr [String] id
|
25
|
-
attr_accessor :id
|
26
|
-
# @attr [String] name
|
27
|
-
attr_accessor :name
|
28
|
-
# @attr [Array<String>] values
|
29
|
-
attr_accessor :values
|
30
|
-
# @attr [String] defaultValue
|
31
|
-
attr_accessor :defaultValue
|
32
|
-
|
33
|
-
# Human-readable accessors
|
34
|
-
alias_accessor :default_value, :defaultValue
|
35
|
-
|
36
|
-
#
|
37
|
-
# Converts values to API compatible view.
|
38
|
-
# @param [Array<String>, String] values
|
39
|
-
#
|
40
|
-
def values=(values)
|
41
|
-
@values = values.is_a?(Array) ? values.join(';') : values
|
42
|
-
end
|
43
|
-
|
44
|
-
#
|
45
|
-
# Returns values as array.
|
46
|
-
# @return [Array<String>]
|
47
|
-
#
|
48
|
-
def values
|
49
|
-
@values.split(';')
|
50
|
-
end
|
51
|
-
|
52
|
-
#
|
53
|
-
# Adds predefined list.
|
54
|
-
#
|
55
|
-
# @example
|
56
|
-
# list = GroupDocs::Signature::List.new
|
57
|
-
# list.name = 'Cities'
|
58
|
-
# list.values = %w(London Paris)
|
59
|
-
# list.add!
|
60
|
-
#
|
61
|
-
# @param [Hash] access Access credentials
|
62
|
-
# @option access [String] :client_id
|
63
|
-
# @option access [String] :private_key
|
64
|
-
#
|
65
|
-
def add!(access = {})
|
66
|
-
json = Api::Request.new do |request|
|
67
|
-
request[:access] = access
|
68
|
-
request[:method] = :POST
|
69
|
-
request[:path] = '/signature/{{client_id}}/list'
|
70
|
-
request[:request_body] = to_hash
|
71
|
-
end.execute!
|
72
|
-
|
73
|
-
self.id = json[:list][:id]
|
74
|
-
end
|
75
|
-
|
76
|
-
#
|
77
|
-
# Deletes predefined list.
|
78
|
-
#
|
79
|
-
# @param [Hash] access Access credentials
|
80
|
-
# @option access [String] :client_id
|
81
|
-
# @option access [String] :private_key
|
82
|
-
#
|
83
|
-
def delete!(access = {})
|
84
|
-
Api::Request.new do |request|
|
85
|
-
request[:access] = access
|
86
|
-
request[:method] = :DELETE
|
87
|
-
request[:path] = "/signature/{{client_id}}/lists/#{id}"
|
88
|
-
end.execute!
|
89
|
-
end
|
90
|
-
|
91
|
-
end # Signature::List
|
92
|
-
end # GroupDocs
|
1
|
+
module GroupDocs
|
2
|
+
class Signature::List < Api::Entity
|
3
|
+
|
4
|
+
#
|
5
|
+
# Returns array of predefined lists.
|
6
|
+
#
|
7
|
+
# @param [Hash] access Access credentials
|
8
|
+
# @option access [String] :client_id
|
9
|
+
# @option access [String] :private_key
|
10
|
+
# @return [Array<GroupDocs::Signature::List>]
|
11
|
+
#
|
12
|
+
def self.get!(access = {})
|
13
|
+
json = Api::Request.new do |request|
|
14
|
+
request[:access] = access
|
15
|
+
request[:method] = :GET
|
16
|
+
request[:path] = '/signature/{{client_id}}/lists'
|
17
|
+
end.execute!
|
18
|
+
|
19
|
+
json[:lists].map do |list|
|
20
|
+
new(list)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
# @attr [String] id
|
25
|
+
attr_accessor :id
|
26
|
+
# @attr [String] name
|
27
|
+
attr_accessor :name
|
28
|
+
# @attr [Array<String>] values
|
29
|
+
attr_accessor :values
|
30
|
+
# @attr [String] defaultValue
|
31
|
+
attr_accessor :defaultValue
|
32
|
+
|
33
|
+
# Human-readable accessors
|
34
|
+
alias_accessor :default_value, :defaultValue
|
35
|
+
|
36
|
+
#
|
37
|
+
# Converts values to API compatible view.
|
38
|
+
# @param [Array<String>, String] values
|
39
|
+
#
|
40
|
+
def values=(values)
|
41
|
+
@values = values.is_a?(Array) ? values.join(';') : values
|
42
|
+
end
|
43
|
+
|
44
|
+
#
|
45
|
+
# Returns values as array.
|
46
|
+
# @return [Array<String>]
|
47
|
+
#
|
48
|
+
def values
|
49
|
+
@values.split(';')
|
50
|
+
end
|
51
|
+
|
52
|
+
#
|
53
|
+
# Adds predefined list.
|
54
|
+
#
|
55
|
+
# @example
|
56
|
+
# list = GroupDocs::Signature::List.new
|
57
|
+
# list.name = 'Cities'
|
58
|
+
# list.values = %w(London Paris)
|
59
|
+
# list.add!
|
60
|
+
#
|
61
|
+
# @param [Hash] access Access credentials
|
62
|
+
# @option access [String] :client_id
|
63
|
+
# @option access [String] :private_key
|
64
|
+
#
|
65
|
+
def add!(access = {})
|
66
|
+
json = Api::Request.new do |request|
|
67
|
+
request[:access] = access
|
68
|
+
request[:method] = :POST
|
69
|
+
request[:path] = '/signature/{{client_id}}/list'
|
70
|
+
request[:request_body] = to_hash
|
71
|
+
end.execute!
|
72
|
+
|
73
|
+
self.id = json[:list][:id]
|
74
|
+
end
|
75
|
+
|
76
|
+
#
|
77
|
+
# Deletes predefined list.
|
78
|
+
#
|
79
|
+
# @param [Hash] access Access credentials
|
80
|
+
# @option access [String] :client_id
|
81
|
+
# @option access [String] :private_key
|
82
|
+
#
|
83
|
+
def delete!(access = {})
|
84
|
+
Api::Request.new do |request|
|
85
|
+
request[:access] = access
|
86
|
+
request[:method] = :DELETE
|
87
|
+
request[:path] = "/signature/{{client_id}}/lists/#{id}"
|
88
|
+
end.execute!
|
89
|
+
end
|
90
|
+
|
91
|
+
end # Signature::List
|
92
|
+
end # GroupDocs
|
@@ -1,79 +1,79 @@
|
|
1
|
-
module GroupDocs
|
2
|
-
class Signature::Recipient < Api::Entity
|
3
|
-
|
4
|
-
STATUSES = {
|
5
|
-
:none => -1,
|
6
|
-
:waiting => 0,
|
7
|
-
:notified => 1,
|
8
|
-
:delegated => 2,
|
9
|
-
:rejected => 3,
|
10
|
-
:signed => 4,
|
11
|
-
}
|
12
|
-
|
13
|
-
# @attr [String] id
|
14
|
-
attr_accessor :id
|
15
|
-
# @attr [String] email
|
16
|
-
attr_accessor :email
|
17
|
-
# @attr [String] firstName
|
18
|
-
attr_accessor :firstName
|
19
|
-
# @attr [String] lastName
|
20
|
-
attr_accessor :lastName
|
21
|
-
# @attr [String] nickname
|
22
|
-
attr_accessor :nickname
|
23
|
-
# @attr [String] roleId
|
24
|
-
attr_accessor :roleId
|
25
|
-
# @attr [String] order
|
26
|
-
attr_accessor :order
|
27
|
-
# @attr [Symbol] status
|
28
|
-
attr_accessor :status
|
29
|
-
|
30
|
-
# added in release 1.7.0
|
31
|
-
|
32
|
-
# @attr [String] userGuid
|
33
|
-
attr_accessor :userGuid
|
34
|
-
# @attr [String] statusMessage
|
35
|
-
attr_accessor :statusMessage
|
36
|
-
# @attr [String] statusDateTime
|
37
|
-
attr_accessor :statusDateTime
|
38
|
-
# @attr [Double] delegatedRecipientId
|
39
|
-
attr_accessor :delegatedRecipientId
|
40
|
-
# @attr [String] signatureFingerprint
|
41
|
-
attr_accessor :signatureFingerprint
|
42
|
-
# @attr [String] signatureHost
|
43
|
-
attr_accessor :signatureHost
|
44
|
-
# @attr [String] signatureLocation
|
45
|
-
attr_accessor :signatureLocation
|
46
|
-
# @attr [String] signatureBrowser
|
47
|
-
attr_accessor :signatureBrowser
|
48
|
-
# @attr [String] embedUrl
|
49
|
-
attr_accessor :embedUrl
|
50
|
-
# @attr [String] comment
|
51
|
-
attr_accessor :comment
|
52
|
-
|
53
|
-
# Human-readable accessors
|
54
|
-
alias_accessor :first_name, :firstName
|
55
|
-
alias_accessor :last_name, :lastName
|
56
|
-
alias_accessor :role_id, :roleId
|
57
|
-
|
58
|
-
# added in release 1.7.0
|
59
|
-
alias_accessor :user_guid, :userGuid
|
60
|
-
alias_accessor :status_message, :statusMessage
|
61
|
-
alias_accessor :status_date_time, :statusDateTime
|
62
|
-
alias_accessor :delegated_recipient_id, :delegatedRecipientId
|
63
|
-
alias_accessor :signature_fingerprint, :signatureFingerprint
|
64
|
-
alias_accessor :signature_host, :signatureHost
|
65
|
-
alias_accessor :signature_location, :signatureLocation
|
66
|
-
alias_accessor :signature_browser, :signatureBrowser
|
67
|
-
alias_accessor :embed_url, :embedUrl
|
68
|
-
|
69
|
-
|
70
|
-
#
|
71
|
-
# Converts status to human-readable format.
|
72
|
-
# @return [Symbol]
|
73
|
-
#
|
74
|
-
def status
|
75
|
-
STATUSES.invert[@status]
|
76
|
-
end
|
77
|
-
|
78
|
-
end # Signature::Recipient
|
79
|
-
end # GroupDocs
|
1
|
+
module GroupDocs
|
2
|
+
class Signature::Recipient < Api::Entity
|
3
|
+
|
4
|
+
STATUSES = {
|
5
|
+
:none => -1,
|
6
|
+
:waiting => 0,
|
7
|
+
:notified => 1,
|
8
|
+
:delegated => 2,
|
9
|
+
:rejected => 3,
|
10
|
+
:signed => 4,
|
11
|
+
}
|
12
|
+
|
13
|
+
# @attr [String] id
|
14
|
+
attr_accessor :id
|
15
|
+
# @attr [String] email
|
16
|
+
attr_accessor :email
|
17
|
+
# @attr [String] firstName
|
18
|
+
attr_accessor :firstName
|
19
|
+
# @attr [String] lastName
|
20
|
+
attr_accessor :lastName
|
21
|
+
# @attr [String] nickname
|
22
|
+
attr_accessor :nickname
|
23
|
+
# @attr [String] roleId
|
24
|
+
attr_accessor :roleId
|
25
|
+
# @attr [String] order
|
26
|
+
attr_accessor :order
|
27
|
+
# @attr [Symbol] status
|
28
|
+
attr_accessor :status
|
29
|
+
|
30
|
+
# added in release 1.7.0
|
31
|
+
|
32
|
+
# @attr [String] userGuid
|
33
|
+
attr_accessor :userGuid
|
34
|
+
# @attr [String] statusMessage
|
35
|
+
attr_accessor :statusMessage
|
36
|
+
# @attr [String] statusDateTime
|
37
|
+
attr_accessor :statusDateTime
|
38
|
+
# @attr [Double] delegatedRecipientId
|
39
|
+
attr_accessor :delegatedRecipientId
|
40
|
+
# @attr [String] signatureFingerprint
|
41
|
+
attr_accessor :signatureFingerprint
|
42
|
+
# @attr [String] signatureHost
|
43
|
+
attr_accessor :signatureHost
|
44
|
+
# @attr [String] signatureLocation
|
45
|
+
attr_accessor :signatureLocation
|
46
|
+
# @attr [String] signatureBrowser
|
47
|
+
attr_accessor :signatureBrowser
|
48
|
+
# @attr [String] embedUrl
|
49
|
+
attr_accessor :embedUrl
|
50
|
+
# @attr [String] comment
|
51
|
+
attr_accessor :comment
|
52
|
+
|
53
|
+
# Human-readable accessors
|
54
|
+
alias_accessor :first_name, :firstName
|
55
|
+
alias_accessor :last_name, :lastName
|
56
|
+
alias_accessor :role_id, :roleId
|
57
|
+
|
58
|
+
# added in release 1.7.0
|
59
|
+
alias_accessor :user_guid, :userGuid
|
60
|
+
alias_accessor :status_message, :statusMessage
|
61
|
+
alias_accessor :status_date_time, :statusDateTime
|
62
|
+
alias_accessor :delegated_recipient_id, :delegatedRecipientId
|
63
|
+
alias_accessor :signature_fingerprint, :signatureFingerprint
|
64
|
+
alias_accessor :signature_host, :signatureHost
|
65
|
+
alias_accessor :signature_location, :signatureLocation
|
66
|
+
alias_accessor :signature_browser, :signatureBrowser
|
67
|
+
alias_accessor :embed_url, :embedUrl
|
68
|
+
|
69
|
+
|
70
|
+
#
|
71
|
+
# Converts status to human-readable format.
|
72
|
+
# @return [Symbol]
|
73
|
+
#
|
74
|
+
def status
|
75
|
+
STATUSES.invert[@status]
|
76
|
+
end
|
77
|
+
|
78
|
+
end # Signature::Recipient
|
79
|
+
end # GroupDocs
|
@@ -1,54 +1,54 @@
|
|
1
|
-
module GroupDocs
|
2
|
-
class Signature::Role < Api::Entity
|
3
|
-
|
4
|
-
#
|
5
|
-
# Returns array of predefined roles.
|
6
|
-
#
|
7
|
-
# @param [Hash] options Hash of options
|
8
|
-
# @option options [String] :id Filter by identifier
|
9
|
-
# @param [Hash] access Access credentials
|
10
|
-
# @option access [String] :client_id
|
11
|
-
# @option access [String] :private_key
|
12
|
-
# @return [Array<GroupDocs::Signature::role>]
|
13
|
-
#
|
14
|
-
def self.get!(options = {}, access = {})
|
15
|
-
api = Api::Request.new do |request|
|
16
|
-
request[:access] = access
|
17
|
-
request[:method] = :GET
|
18
|
-
request[:path] = '/signature/{{client_id}}/roles'
|
19
|
-
end
|
20
|
-
api.add_params(options)
|
21
|
-
json = api.execute!
|
22
|
-
|
23
|
-
json[:roles].map do |role|
|
24
|
-
new(role)
|
25
|
-
end
|
26
|
-
end
|
27
|
-
|
28
|
-
# @attr [String] id
|
29
|
-
attr_accessor :id
|
30
|
-
# @attr [String] name
|
31
|
-
attr_accessor :name
|
32
|
-
# @attr [Integer] canEdit
|
33
|
-
attr_accessor :canEdit
|
34
|
-
# @attr [Integer] canSign
|
35
|
-
attr_accessor :canSign
|
36
|
-
# @attr [Integer] canAnnotate
|
37
|
-
attr_accessor :canAnnotate
|
38
|
-
# @attr [Integer] canDelegate
|
39
|
-
attr_accessor :canDelegate
|
40
|
-
|
41
|
-
# Human-readable accessors
|
42
|
-
alias_accessor :can_edit, :canEdit
|
43
|
-
alias_accessor :can_sign, :canSign
|
44
|
-
alias_accessor :can_annotate, :canAnnotate
|
45
|
-
alias_accessor :can_delegate, :canDelegate
|
46
|
-
|
47
|
-
# Boolean methods for Ruby DSL
|
48
|
-
alias_method :can_edit?, :can_edit
|
49
|
-
alias_method :can_sign?, :can_sign
|
50
|
-
alias_method :can_annotate?, :can_annotate
|
51
|
-
alias_method :can_delegate?, :can_delegate
|
52
|
-
|
53
|
-
end # Signature::Role
|
54
|
-
end # GroupDocs
|
1
|
+
module GroupDocs
|
2
|
+
class Signature::Role < Api::Entity
|
3
|
+
|
4
|
+
#
|
5
|
+
# Returns array of predefined roles.
|
6
|
+
#
|
7
|
+
# @param [Hash] options Hash of options
|
8
|
+
# @option options [String] :id Filter by identifier
|
9
|
+
# @param [Hash] access Access credentials
|
10
|
+
# @option access [String] :client_id
|
11
|
+
# @option access [String] :private_key
|
12
|
+
# @return [Array<GroupDocs::Signature::role>]
|
13
|
+
#
|
14
|
+
def self.get!(options = {}, access = {})
|
15
|
+
api = Api::Request.new do |request|
|
16
|
+
request[:access] = access
|
17
|
+
request[:method] = :GET
|
18
|
+
request[:path] = '/signature/{{client_id}}/roles'
|
19
|
+
end
|
20
|
+
api.add_params(options)
|
21
|
+
json = api.execute!
|
22
|
+
|
23
|
+
json[:roles].map do |role|
|
24
|
+
new(role)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
# @attr [String] id
|
29
|
+
attr_accessor :id
|
30
|
+
# @attr [String] name
|
31
|
+
attr_accessor :name
|
32
|
+
# @attr [Integer] canEdit
|
33
|
+
attr_accessor :canEdit
|
34
|
+
# @attr [Integer] canSign
|
35
|
+
attr_accessor :canSign
|
36
|
+
# @attr [Integer] canAnnotate
|
37
|
+
attr_accessor :canAnnotate
|
38
|
+
# @attr [Integer] canDelegate
|
39
|
+
attr_accessor :canDelegate
|
40
|
+
|
41
|
+
# Human-readable accessors
|
42
|
+
alias_accessor :can_edit, :canEdit
|
43
|
+
alias_accessor :can_sign, :canSign
|
44
|
+
alias_accessor :can_annotate, :canAnnotate
|
45
|
+
alias_accessor :can_delegate, :canDelegate
|
46
|
+
|
47
|
+
# Boolean methods for Ruby DSL
|
48
|
+
alias_method :can_edit?, :can_edit
|
49
|
+
alias_method :can_sign?, :can_sign
|
50
|
+
alias_method :can_annotate?, :can_annotate
|
51
|
+
alias_method :can_delegate?, :can_delegate
|
52
|
+
|
53
|
+
end # Signature::Role
|
54
|
+
end # GroupDocs
|