docusign_esign 3.11.0 → 3.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/docusign_esign.gemspec +1 -0
- data/lib/docusign_esign/api/accounts_api.rb +8 -8
- data/lib/docusign_esign/api/billing_api.rb +6 -2
- data/lib/docusign_esign/api/connect_api.rb +91 -5
- data/lib/docusign_esign/api/envelopes_api.rb +137 -3
- data/lib/docusign_esign/client/api_client.rb +3 -2
- data/lib/docusign_esign/configuration.rb +2 -1
- data/lib/docusign_esign/models/account_billing_plan.rb +21 -1
- data/lib/docusign_esign/models/account_billing_plan_response.rb +20 -1
- data/lib/docusign_esign/models/account_settings_information.rb +144 -1
- data/lib/docusign_esign/models/account_signature_definition.rb +11 -1
- data/lib/docusign_esign/models/agent.rb +1 -10
- data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
- data/lib/docusign_esign/models/billing_charge.rb +1 -1
- data/lib/docusign_esign/models/carbon_copy.rb +1 -10
- data/lib/docusign_esign/models/certified_delivery.rb +1 -10
- data/lib/docusign_esign/models/checkbox.rb +20 -1
- data/lib/docusign_esign/models/connect_custom_configuration.rb +14 -4
- data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
- data/lib/docusign_esign/models/connect_user_info.rb +224 -0
- data/lib/docusign_esign/models/credit_card_information.rb +24 -4
- data/lib/docusign_esign/models/date.rb +20 -1
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +44 -4
- data/lib/docusign_esign/models/downgrade_plan_update_response.rb +64 -4
- data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
- data/lib/docusign_esign/models/editor.rb +1 -10
- data/lib/docusign_esign/models/email.rb +20 -1
- data/lib/docusign_esign/models/event_notification.rb +11 -1
- data/lib/docusign_esign/models/formula_tab.rb +20 -1
- data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
- data/lib/docusign_esign/models/intermediary.rb +1 -10
- data/lib/docusign_esign/models/list.rb +20 -1
- data/lib/docusign_esign/models/notary_recipient.rb +1 -10
- data/lib/docusign_esign/models/number.rb +20 -1
- data/lib/docusign_esign/models/radio_group.rb +20 -1
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +41 -4
- data/lib/docusign_esign/models/recipient_identity_verification.rb +13 -4
- data/lib/docusign_esign/models/recipient_proof_file.rb +11 -1
- data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +31 -1
- data/lib/docusign_esign/models/signer.rb +1 -10
- data/lib/docusign_esign/models/ssn.rb +20 -1
- data/lib/docusign_esign/models/template_role.rb +10 -1
- data/lib/docusign_esign/models/text.rb +20 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
- data/lib/docusign_esign/models/user_signature_definition.rb +11 -1
- data/lib/docusign_esign/models/witness.rb +1 -10
- data/lib/docusign_esign/models/zip.rb +20 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +4 -1
- data/runLinter.sh +1 -0
- metadata +53 -34
- data/Gemfile.lock +0 -73
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -42
- data/tests/docs/private.pem +0 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9d6c3eb6f9313bf186461f8d379beb9310eb54da9d2104b0be8ed3a33c98a998
|
4
|
+
data.tar.gz: 140c92b8d199f8f5ef54f3f0061033282cc98d7062612a8cbf11239aed62d2e7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '08f0073cb69c71d78603f1526e93afc6e9f51ef16cd58006eb1694a6c30e46d0e547d0aab344260af8aa971729540a07423afd74e7be8a4778a56d80553d0895'
|
7
|
+
data.tar.gz: 630217d52123fa8fa6513a711ff5b78be2d134f5ed38130c8f8f7c85e0ec3fd472d1d3c755410d2f4b1b7fe1d8162cb49fb2ff9b0f047ae7ed153015a43de42d
|
data/CHANGELOG.md
CHANGED
@@ -3,6 +3,23 @@ All notable changes to this project will be documented in this file.
|
|
3
3
|
|
4
4
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
5
5
|
|
6
|
+
## [3.13.0] - ESignature API v2.1-21.3.02.00 - 2021-10-29
|
7
|
+
### Changed
|
8
|
+
- Added support for version v2.1-21.3.02.00 of the DocuSign ESignature API.
|
9
|
+
- Updated the SDK release version.
|
10
|
+
|
11
|
+
|
12
|
+
## [3.13.0.rc1] - ESignature API v2.1-21.3.00.00 - 2021-09-21
|
13
|
+
### Changed
|
14
|
+
- Added support for version v2.1-21.3.00.00 of the DocuSign ESignature API.
|
15
|
+
- Updated the SDK release version.
|
16
|
+
|
17
|
+
|
18
|
+
## [v3.12.0] - ESignature API v2.1-21.2.02.00 - 2021-09-03
|
19
|
+
### Changed
|
20
|
+
- Added support for version v2.1-21.2.02.00 of the DocuSign ESignature API.
|
21
|
+
- Updated the SDK release version.
|
22
|
+
|
6
23
|
## [v3.11.0] - eSignature API v2.1-21.2.00.00 - 2021-07-22
|
7
24
|
### Added
|
8
25
|
- Added new models and properties.
|
data/docusign_esign.gemspec
CHANGED
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
|
|
27
27
|
s.required_ruby_version = ">= 1.9"
|
28
28
|
|
29
29
|
s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
|
30
|
+
s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
|
30
31
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
32
|
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
33
|
|
@@ -1875,7 +1875,7 @@ module DocuSign_eSign
|
|
1875
1875
|
# Gets the Electronic Record and Signature Disclosure.
|
1876
1876
|
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
1877
1877
|
# @param account_id The external account number (int) or account ID Guid.
|
1878
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to
|
1878
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
1879
1879
|
# @return [ConsumerDisclosure]
|
1880
1880
|
def get_consumer_disclosure(account_id, lang_code)
|
1881
1881
|
data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
|
@@ -1885,7 +1885,7 @@ module DocuSign_eSign
|
|
1885
1885
|
# Gets the Electronic Record and Signature Disclosure.
|
1886
1886
|
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
1887
1887
|
# @param account_id The external account number (int) or account ID Guid.
|
1888
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to
|
1888
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
1889
1889
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
1890
1890
|
def get_consumer_disclosure_with_http_info(account_id, lang_code)
|
1891
1891
|
if @api_client.config.debugging
|
@@ -3362,7 +3362,7 @@ module DocuSign_eSign
|
|
3362
3362
|
# Put one branding logo.
|
3363
3363
|
#
|
3364
3364
|
# @param account_id The external account number (int) or account ID GUID.
|
3365
|
-
# @param brand_id The
|
3365
|
+
# @param brand_id The ID of the brand.
|
3366
3366
|
# @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email`
|
3367
3367
|
# @param logo_file_bytes Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places
|
3368
3368
|
# @return [nil]
|
@@ -3374,7 +3374,7 @@ module DocuSign_eSign
|
|
3374
3374
|
# Put one branding logo.
|
3375
3375
|
#
|
3376
3376
|
# @param account_id The external account number (int) or account ID GUID.
|
3377
|
-
# @param brand_id The
|
3377
|
+
# @param brand_id The ID of the brand.
|
3378
3378
|
# @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email`
|
3379
3379
|
# @param logo_file_bytes Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places
|
3380
3380
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -3424,7 +3424,7 @@ module DocuSign_eSign
|
|
3424
3424
|
# Uploads a branding resource file.
|
3425
3425
|
#
|
3426
3426
|
# @param account_id The external account number (int) or account ID GUID.
|
3427
|
-
# @param brand_id The
|
3427
|
+
# @param brand_id The ID of the brand.
|
3428
3428
|
# @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
|
3429
3429
|
# @return [BrandResources]
|
3430
3430
|
def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
|
@@ -3435,7 +3435,7 @@ module DocuSign_eSign
|
|
3435
3435
|
# Uploads a branding resource file.
|
3436
3436
|
#
|
3437
3437
|
# @param account_id The external account number (int) or account ID GUID.
|
3438
|
-
# @param brand_id The
|
3438
|
+
# @param brand_id The ID of the brand.
|
3439
3439
|
# @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
|
3440
3440
|
# @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
|
3441
3441
|
def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
|
@@ -3486,7 +3486,7 @@ module DocuSign_eSign
|
|
3486
3486
|
# Update Consumer Disclosure.
|
3487
3487
|
#
|
3488
3488
|
# @param account_id The external account number (int) or account ID Guid.
|
3489
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to
|
3489
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3490
3490
|
# @param consumer_disclosure (optional parameter)
|
3491
3491
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3492
3492
|
# @return [ConsumerDisclosure]
|
@@ -3498,7 +3498,7 @@ module DocuSign_eSign
|
|
3498
3498
|
# Update Consumer Disclosure.
|
3499
3499
|
#
|
3500
3500
|
# @param account_id The external account number (int) or account ID Guid.
|
3501
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to
|
3501
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3502
3502
|
# @param consumer_disclosure (optional parameter)
|
3503
3503
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3504
3504
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -17,6 +17,9 @@ module DocuSign_eSign
|
|
17
17
|
# When set to **true**, excludes credit card information from the response.
|
18
18
|
attr_accessor :include_credit_card_information
|
19
19
|
|
20
|
+
#
|
21
|
+
attr_accessor :include_downgrade_information
|
22
|
+
|
20
23
|
# When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information.
|
21
24
|
attr_accessor :include_metadata
|
22
25
|
|
@@ -217,7 +220,7 @@ module DocuSign_eSign
|
|
217
220
|
end
|
218
221
|
|
219
222
|
# Retrieves a billing invoice.
|
220
|
-
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check |
|
223
|
+
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
|
221
224
|
# @param account_id The external account number (int) or account ID Guid.
|
222
225
|
# @param invoice_id
|
223
226
|
# @return [BillingInvoice]
|
@@ -227,7 +230,7 @@ module DocuSign_eSign
|
|
227
230
|
end
|
228
231
|
|
229
232
|
# Retrieves a billing invoice.
|
230
|
-
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check |
|
233
|
+
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
|
231
234
|
# @param account_id The external account number (int) or account ID Guid.
|
232
235
|
# @param invoice_id
|
233
236
|
# @return [Array<(BillingInvoice, Fixnum, Hash)>] BillingInvoice data, response status code and response headers
|
@@ -349,6 +352,7 @@ module DocuSign_eSign
|
|
349
352
|
# query parameters
|
350
353
|
query_params = {}
|
351
354
|
query_params[:'include_credit_card_information'] = options.include_credit_card_information if !options.include_credit_card_information.nil?
|
355
|
+
query_params[:'include_downgrade_information'] = options.include_downgrade_information if !options.include_downgrade_information.nil?
|
352
356
|
query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
|
353
357
|
query_params[:'include_successor_plans'] = options.include_successor_plans if !options.include_successor_plans.nil?
|
354
358
|
|
@@ -13,6 +13,30 @@ require "uri"
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
|
16
|
+
class GetConnectAllUsersOptions
|
17
|
+
#
|
18
|
+
attr_accessor :count
|
19
|
+
|
20
|
+
#
|
21
|
+
attr_accessor :email_substring
|
22
|
+
|
23
|
+
#
|
24
|
+
attr_accessor :is_recipient_connect_config
|
25
|
+
|
26
|
+
#
|
27
|
+
attr_accessor :start_position
|
28
|
+
|
29
|
+
#
|
30
|
+
attr_accessor :status
|
31
|
+
|
32
|
+
#
|
33
|
+
attr_accessor :user_name_substring
|
34
|
+
|
35
|
+
def self.default
|
36
|
+
@@default ||= GetConnectAllUsersOptions.new
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
16
40
|
class GetEventLogOptions
|
17
41
|
# When true, the connectDebugLog information is included in the response.
|
18
42
|
attr_accessor :additional_info
|
@@ -185,17 +209,17 @@ module DocuSign_eSign
|
|
185
209
|
# Deletes the Connect failure log information for the specified entry.
|
186
210
|
# @param account_id The external account number (int) or account ID Guid.
|
187
211
|
# @param failure_id The ID of the failed connect log entry.
|
188
|
-
# @return [
|
212
|
+
# @return [ConnectDeleteFailureResult]
|
189
213
|
def delete_event_failure_log(account_id, failure_id)
|
190
|
-
delete_event_failure_log_with_http_info(account_id, failure_id)
|
191
|
-
return
|
214
|
+
data, _status_code, _headers = delete_event_failure_log_with_http_info(account_id, failure_id)
|
215
|
+
return data
|
192
216
|
end
|
193
217
|
|
194
218
|
# Deletes a Connect failure log entry.
|
195
219
|
# Deletes the Connect failure log information for the specified entry.
|
196
220
|
# @param account_id The external account number (int) or account ID Guid.
|
197
221
|
# @param failure_id The ID of the failed connect log entry.
|
198
|
-
# @return [Array<(
|
222
|
+
# @return [Array<(ConnectDeleteFailureResult, Fixnum, Hash)>] ConnectDeleteFailureResult data, response status code and response headers
|
199
223
|
def delete_event_failure_log_with_http_info(account_id, failure_id)
|
200
224
|
if @api_client.config.debugging
|
201
225
|
@api_client.config.logger.debug "Calling API: ConnectApi.delete_event_failure_log ..."
|
@@ -226,7 +250,8 @@ module DocuSign_eSign
|
|
226
250
|
:query_params => query_params,
|
227
251
|
:form_params => form_params,
|
228
252
|
:body => post_body,
|
229
|
-
:auth_names => auth_names
|
253
|
+
:auth_names => auth_names,
|
254
|
+
:return_type => 'ConnectDeleteFailureResult')
|
230
255
|
if @api_client.config.debugging
|
231
256
|
@api_client.config.logger.debug "API called: ConnectApi#delete_event_failure_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
232
257
|
end
|
@@ -437,6 +462,67 @@ module DocuSign_eSign
|
|
437
462
|
return data, status_code, headers
|
438
463
|
end
|
439
464
|
|
465
|
+
# Returns all users from the configured Connect service.
|
466
|
+
#
|
467
|
+
# @param account_id
|
468
|
+
# @param connect_id
|
469
|
+
# @param DocuSign_eSign::GetConnectAllUsersOptions Options for modifying the behavior of the function.
|
470
|
+
# @return [IntegratedConnectUserInfoList]
|
471
|
+
def get_connect_all_users(account_id, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default)
|
472
|
+
data, _status_code, _headers = get_connect_all_users_with_http_info(account_id, connect_id, options)
|
473
|
+
return data
|
474
|
+
end
|
475
|
+
|
476
|
+
# Returns all users from the configured Connect service.
|
477
|
+
#
|
478
|
+
# @param account_id
|
479
|
+
# @param connect_id
|
480
|
+
# @param DocuSign_eSign::GetConnectAllUsersOptions Options for modifying the behavior of the function.
|
481
|
+
# @return [Array<(IntegratedConnectUserInfoList, Fixnum, Hash)>] IntegratedConnectUserInfoList data, response status code and response headers
|
482
|
+
def get_connect_all_users_with_http_info(account_id, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default)
|
483
|
+
if @api_client.config.debugging
|
484
|
+
@api_client.config.logger.debug "Calling API: ConnectApi.get_connect_all_users ..."
|
485
|
+
end
|
486
|
+
# verify the required parameter 'account_id' is set
|
487
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_all_users" if account_id.nil?
|
488
|
+
# verify the required parameter 'connect_id' is set
|
489
|
+
fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.get_connect_all_users" if connect_id.nil?
|
490
|
+
# resource path
|
491
|
+
local_var_path = "/v2.1/accounts/{accountId}/connect/{connectId}/all/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s)
|
492
|
+
|
493
|
+
# query parameters
|
494
|
+
query_params = {}
|
495
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
496
|
+
query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
|
497
|
+
query_params[:'is_recipient_connect_config'] = options.is_recipient_connect_config if !options.is_recipient_connect_config.nil?
|
498
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
499
|
+
query_params[:'status'] = options.status if !options.status.nil?
|
500
|
+
query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
|
501
|
+
|
502
|
+
# header parameters
|
503
|
+
header_params = {}
|
504
|
+
# HTTP header 'Accept' (if needed)
|
505
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
506
|
+
|
507
|
+
# form parameters
|
508
|
+
form_params = {}
|
509
|
+
|
510
|
+
# http body (model)
|
511
|
+
post_body = nil
|
512
|
+
auth_names = []
|
513
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
514
|
+
:header_params => header_params,
|
515
|
+
:query_params => query_params,
|
516
|
+
:form_params => form_params,
|
517
|
+
:body => post_body,
|
518
|
+
:auth_names => auth_names,
|
519
|
+
:return_type => 'IntegratedConnectUserInfoList')
|
520
|
+
if @api_client.config.debugging
|
521
|
+
@api_client.config.logger.debug "API called: ConnectApi#get_connect_all_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
522
|
+
end
|
523
|
+
return data, status_code, headers
|
524
|
+
end
|
525
|
+
|
440
526
|
# Get the specified Connect log entry.
|
441
527
|
# Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
|
442
528
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -80,7 +80,7 @@ module DocuSign_eSign
|
|
80
80
|
end
|
81
81
|
|
82
82
|
class GetConsumerDisclosureOptions
|
83
|
-
#
|
83
|
+
# The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
84
84
|
attr_accessor :lang_code2
|
85
85
|
|
86
86
|
def self.default
|
@@ -148,6 +148,15 @@ module DocuSign_eSign
|
|
148
148
|
end
|
149
149
|
end
|
150
150
|
|
151
|
+
class GetDocumentResponsiveHtmlOptions
|
152
|
+
#
|
153
|
+
attr_accessor :include_anchor_tab_locations
|
154
|
+
|
155
|
+
def self.default
|
156
|
+
@@default ||= GetDocumentResponsiveHtmlOptions.new
|
157
|
+
end
|
158
|
+
end
|
159
|
+
|
151
160
|
class GetDocumentTabsOptions
|
152
161
|
#
|
153
162
|
attr_accessor :include_metadata
|
@@ -229,6 +238,15 @@ module DocuSign_eSign
|
|
229
238
|
end
|
230
239
|
end
|
231
240
|
|
241
|
+
class GetResponsiveHtmlOptions
|
242
|
+
#
|
243
|
+
attr_accessor :include_anchor_tab_locations
|
244
|
+
|
245
|
+
def self.default
|
246
|
+
@@default ||= GetResponsiveHtmlOptions.new
|
247
|
+
end
|
248
|
+
end
|
249
|
+
|
232
250
|
class ListDocumentsOptions
|
233
251
|
#
|
234
252
|
attr_accessor :documents_by_userid
|
@@ -3056,7 +3074,7 @@ module DocuSign_eSign
|
|
3056
3074
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
3057
3075
|
# @param account_id The external account number (int) or account ID Guid.
|
3058
3076
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3059
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to
|
3077
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3060
3078
|
# @param recipient_id The ID of the recipient being accessed.
|
3061
3079
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3062
3080
|
# @return [ConsumerDisclosure]
|
@@ -3069,7 +3087,7 @@ module DocuSign_eSign
|
|
3069
3087
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
3070
3088
|
# @param account_id The external account number (int) or account ID Guid.
|
3071
3089
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3072
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to
|
3090
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3073
3091
|
# @param recipient_id The ID of the recipient being accessed.
|
3074
3092
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3075
3093
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -3311,6 +3329,66 @@ module DocuSign_eSign
|
|
3311
3329
|
return data, status_code, headers
|
3312
3330
|
end
|
3313
3331
|
|
3332
|
+
# Get Responsive HTML for a document in an envelope.
|
3333
|
+
#
|
3334
|
+
# @param account_id
|
3335
|
+
# @param document_id
|
3336
|
+
# @param envelope_id
|
3337
|
+
# @param DocuSign_eSign::GetDocumentResponsiveHtmlOptions Options for modifying the behavior of the function.
|
3338
|
+
# @return [DocumentHtmlDefinitionOriginals]
|
3339
|
+
def get_document_responsive_html(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentResponsiveHtmlOptions.default)
|
3340
|
+
data, _status_code, _headers = get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, options)
|
3341
|
+
return data
|
3342
|
+
end
|
3343
|
+
|
3344
|
+
# Get Responsive HTML for a document in an envelope.
|
3345
|
+
#
|
3346
|
+
# @param account_id
|
3347
|
+
# @param document_id
|
3348
|
+
# @param envelope_id
|
3349
|
+
# @param DocuSign_eSign::GetDocumentResponsiveHtmlOptions Options for modifying the behavior of the function.
|
3350
|
+
# @return [Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>] DocumentHtmlDefinitionOriginals data, response status code and response headers
|
3351
|
+
def get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentResponsiveHtmlOptions.default)
|
3352
|
+
if @api_client.config.debugging
|
3353
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_document_responsive_html ..."
|
3354
|
+
end
|
3355
|
+
# verify the required parameter 'account_id' is set
|
3356
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document_responsive_html" if account_id.nil?
|
3357
|
+
# verify the required parameter 'document_id' is set
|
3358
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_document_responsive_html" if document_id.nil?
|
3359
|
+
# verify the required parameter 'envelope_id' is set
|
3360
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_responsive_html" if envelope_id.nil?
|
3361
|
+
# resource path
|
3362
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
3363
|
+
|
3364
|
+
# query parameters
|
3365
|
+
query_params = {}
|
3366
|
+
query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
|
3367
|
+
|
3368
|
+
# header parameters
|
3369
|
+
header_params = {}
|
3370
|
+
# HTTP header 'Accept' (if needed)
|
3371
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3372
|
+
|
3373
|
+
# form parameters
|
3374
|
+
form_params = {}
|
3375
|
+
|
3376
|
+
# http body (model)
|
3377
|
+
post_body = nil
|
3378
|
+
auth_names = []
|
3379
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3380
|
+
:header_params => header_params,
|
3381
|
+
:query_params => query_params,
|
3382
|
+
:form_params => form_params,
|
3383
|
+
:body => post_body,
|
3384
|
+
:auth_names => auth_names,
|
3385
|
+
:return_type => 'DocumentHtmlDefinitionOriginals')
|
3386
|
+
if @api_client.config.debugging
|
3387
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#get_document_responsive_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3388
|
+
end
|
3389
|
+
return data, status_code, headers
|
3390
|
+
end
|
3391
|
+
|
3314
3392
|
# Returns tabs on the document.
|
3315
3393
|
#
|
3316
3394
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -4218,6 +4296,62 @@ module DocuSign_eSign
|
|
4218
4296
|
return data, status_code, headers
|
4219
4297
|
end
|
4220
4298
|
|
4299
|
+
# Get Responsive HTML for all documents in an envelope.
|
4300
|
+
#
|
4301
|
+
# @param account_id
|
4302
|
+
# @param envelope_id
|
4303
|
+
# @param DocuSign_eSign::GetResponsiveHtmlOptions Options for modifying the behavior of the function.
|
4304
|
+
# @return [DocumentHtmlDefinitionOriginals]
|
4305
|
+
def get_responsive_html(account_id, envelope_id, options = DocuSign_eSign::GetResponsiveHtmlOptions.default)
|
4306
|
+
data, _status_code, _headers = get_responsive_html_with_http_info(account_id, envelope_id, options)
|
4307
|
+
return data
|
4308
|
+
end
|
4309
|
+
|
4310
|
+
# Get Responsive HTML for all documents in an envelope.
|
4311
|
+
#
|
4312
|
+
# @param account_id
|
4313
|
+
# @param envelope_id
|
4314
|
+
# @param DocuSign_eSign::GetResponsiveHtmlOptions Options for modifying the behavior of the function.
|
4315
|
+
# @return [Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>] DocumentHtmlDefinitionOriginals data, response status code and response headers
|
4316
|
+
def get_responsive_html_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetResponsiveHtmlOptions.default)
|
4317
|
+
if @api_client.config.debugging
|
4318
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_responsive_html ..."
|
4319
|
+
end
|
4320
|
+
# verify the required parameter 'account_id' is set
|
4321
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_responsive_html" if account_id.nil?
|
4322
|
+
# verify the required parameter 'envelope_id' is set
|
4323
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_responsive_html" if envelope_id.nil?
|
4324
|
+
# resource path
|
4325
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
4326
|
+
|
4327
|
+
# query parameters
|
4328
|
+
query_params = {}
|
4329
|
+
query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
|
4330
|
+
|
4331
|
+
# header parameters
|
4332
|
+
header_params = {}
|
4333
|
+
# HTTP header 'Accept' (if needed)
|
4334
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4335
|
+
|
4336
|
+
# form parameters
|
4337
|
+
form_params = {}
|
4338
|
+
|
4339
|
+
# http body (model)
|
4340
|
+
post_body = nil
|
4341
|
+
auth_names = []
|
4342
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
4343
|
+
:header_params => header_params,
|
4344
|
+
:query_params => query_params,
|
4345
|
+
:form_params => form_params,
|
4346
|
+
:body => post_body,
|
4347
|
+
:auth_names => auth_names,
|
4348
|
+
:return_type => 'DocumentHtmlDefinitionOriginals')
|
4349
|
+
if @api_client.config.debugging
|
4350
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#get_responsive_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4351
|
+
end
|
4352
|
+
return data, status_code, headers
|
4353
|
+
end
|
4354
|
+
|
4221
4355
|
# Get encrypted tabs for envelope.
|
4222
4356
|
#
|
4223
4357
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -16,6 +16,7 @@ require 'tempfile'
|
|
16
16
|
require 'typhoeus'
|
17
17
|
require 'uri'
|
18
18
|
require 'jwt'
|
19
|
+
require 'addressable/uri'
|
19
20
|
|
20
21
|
module DocuSign_eSign
|
21
22
|
class ApiClient
|
@@ -259,8 +260,8 @@ module DocuSign_eSign
|
|
259
260
|
def build_request_url(path, opts)
|
260
261
|
# Add leading and trailing slashes to path
|
261
262
|
path = "/#{path}".gsub(/\/+/, '/')
|
262
|
-
return URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth]
|
263
|
-
URI.encode(@config.base_url + path)
|
263
|
+
return Addressable::URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth]
|
264
|
+
Addressable::URI.encode(@config.base_url + path)
|
264
265
|
end
|
265
266
|
|
266
267
|
# Builds the HTTP request body
|
@@ -10,6 +10,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
10
10
|
=end
|
11
11
|
|
12
12
|
require 'uri'
|
13
|
+
require 'addressable/uri'
|
13
14
|
|
14
15
|
module DocuSign_eSign
|
15
16
|
class Configuration
|
@@ -168,7 +169,7 @@ module DocuSign_eSign
|
|
168
169
|
|
169
170
|
def base_url
|
170
171
|
url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
|
171
|
-
URI.encode(url)
|
172
|
+
Addressable::URI.encode(url)
|
172
173
|
end
|
173
174
|
|
174
175
|
# Gets API key (with prefix if set).
|
@@ -76,6 +76,9 @@ module DocuSign_eSign
|
|
76
76
|
#
|
77
77
|
attr_accessor :plan_start_date
|
78
78
|
|
79
|
+
#
|
80
|
+
attr_accessor :product_id
|
81
|
+
|
79
82
|
#
|
80
83
|
attr_accessor :renewal_date
|
81
84
|
|
@@ -85,6 +88,9 @@ module DocuSign_eSign
|
|
85
88
|
# A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent.
|
86
89
|
attr_accessor :seat_discounts
|
87
90
|
|
91
|
+
#
|
92
|
+
attr_accessor :subscription_start_date
|
93
|
+
|
88
94
|
# The support incident fee charged for each support incident.
|
89
95
|
attr_accessor :support_incident_fee
|
90
96
|
|
@@ -115,9 +121,11 @@ module DocuSign_eSign
|
|
115
121
|
:'plan_id' => :'planId',
|
116
122
|
:'plan_name' => :'planName',
|
117
123
|
:'plan_start_date' => :'planStartDate',
|
124
|
+
:'product_id' => :'productId',
|
118
125
|
:'renewal_date' => :'renewalDate',
|
119
126
|
:'renewal_status' => :'renewalStatus',
|
120
127
|
:'seat_discounts' => :'seatDiscounts',
|
128
|
+
:'subscription_start_date' => :'subscriptionStartDate',
|
121
129
|
:'support_incident_fee' => :'supportIncidentFee',
|
122
130
|
:'support_plan_fee' => :'supportPlanFee'
|
123
131
|
}
|
@@ -147,9 +155,11 @@ module DocuSign_eSign
|
|
147
155
|
:'plan_id' => :'String',
|
148
156
|
:'plan_name' => :'String',
|
149
157
|
:'plan_start_date' => :'String',
|
158
|
+
:'product_id' => :'String',
|
150
159
|
:'renewal_date' => :'String',
|
151
160
|
:'renewal_status' => :'String',
|
152
161
|
:'seat_discounts' => :'Array<SeatDiscount>',
|
162
|
+
:'subscription_start_date' => :'String',
|
153
163
|
:'support_incident_fee' => :'String',
|
154
164
|
:'support_plan_fee' => :'String'
|
155
165
|
}
|
@@ -251,6 +261,10 @@ module DocuSign_eSign
|
|
251
261
|
self.plan_start_date = attributes[:'planStartDate']
|
252
262
|
end
|
253
263
|
|
264
|
+
if attributes.has_key?(:'productId')
|
265
|
+
self.product_id = attributes[:'productId']
|
266
|
+
end
|
267
|
+
|
254
268
|
if attributes.has_key?(:'renewalDate')
|
255
269
|
self.renewal_date = attributes[:'renewalDate']
|
256
270
|
end
|
@@ -265,6 +279,10 @@ module DocuSign_eSign
|
|
265
279
|
end
|
266
280
|
end
|
267
281
|
|
282
|
+
if attributes.has_key?(:'subscriptionStartDate')
|
283
|
+
self.subscription_start_date = attributes[:'subscriptionStartDate']
|
284
|
+
end
|
285
|
+
|
268
286
|
if attributes.has_key?(:'supportIncidentFee')
|
269
287
|
self.support_incident_fee = attributes[:'supportIncidentFee']
|
270
288
|
end
|
@@ -313,9 +331,11 @@ module DocuSign_eSign
|
|
313
331
|
plan_id == o.plan_id &&
|
314
332
|
plan_name == o.plan_name &&
|
315
333
|
plan_start_date == o.plan_start_date &&
|
334
|
+
product_id == o.product_id &&
|
316
335
|
renewal_date == o.renewal_date &&
|
317
336
|
renewal_status == o.renewal_status &&
|
318
337
|
seat_discounts == o.seat_discounts &&
|
338
|
+
subscription_start_date == o.subscription_start_date &&
|
319
339
|
support_incident_fee == o.support_incident_fee &&
|
320
340
|
support_plan_fee == o.support_plan_fee
|
321
341
|
end
|
@@ -329,7 +349,7 @@ module DocuSign_eSign
|
|
329
349
|
# Calculates hash code according to all attributes.
|
330
350
|
# @return [Fixnum] Hash code
|
331
351
|
def hash
|
332
|
-
[add_ons, app_store_receipt_expiration_date, app_store_receipt_purchase_date, can_cancel_renewal, can_upgrade, currency_code, downgrade_plan_information, enable_support, included_seats, incremental_seats, is_downgrade, notification_type, other_discount_percent, payment_cycle, payment_method, per_seat_price, plan_classification, plan_feature_sets, plan_id, plan_name, plan_start_date, renewal_date, renewal_status, seat_discounts, support_incident_fee, support_plan_fee].hash
|
352
|
+
[add_ons, app_store_receipt_expiration_date, app_store_receipt_purchase_date, can_cancel_renewal, can_upgrade, currency_code, downgrade_plan_information, enable_support, included_seats, incremental_seats, is_downgrade, notification_type, other_discount_percent, payment_cycle, payment_method, per_seat_price, plan_classification, plan_feature_sets, plan_id, plan_name, plan_start_date, product_id, renewal_date, renewal_status, seat_discounts, subscription_start_date, support_incident_fee, support_plan_fee].hash
|
333
353
|
end
|
334
354
|
|
335
355
|
# Builds the object from hash
|