hellosign-ruby-sdk 3.7.5 → 6.0.0.pre.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +5 -8
- data/Gemfile.lock +76 -0
- data/LICENSE +2 -2
- data/README.md +283 -85
- data/Rakefile +7 -13
- data/bin/generate-examples.php +269 -0
- data/bin/php +15 -0
- data/bin/replace +10 -0
- data/bin/ruby +15 -0
- data/bin/scan_for +31 -0
- data/composer.json +10 -0
- data/composer.lock +246 -0
- data/docs/AccountApi.md +300 -0
- data/docs/AccountCreateRequest.md +13 -0
- data/docs/AccountCreateResponse.md +12 -0
- data/docs/AccountGetResponse.md +11 -0
- data/docs/AccountResponse.md +18 -0
- data/docs/AccountResponseQuotas.md +13 -0
- data/docs/AccountUpdateRequest.md +12 -0
- data/docs/AccountVerifyRequest.md +10 -0
- data/docs/AccountVerifyResponse.md +11 -0
- data/docs/AccountVerifyResponseAccount.md +10 -0
- data/docs/ApiAppApi.md +402 -0
- data/docs/ApiAppCreateRequest.md +16 -0
- data/docs/ApiAppGetResponse.md +11 -0
- data/docs/ApiAppListResponse.md +12 -0
- data/docs/ApiAppResponse.md +19 -0
- data/docs/ApiAppResponseOAuth.md +13 -0
- data/docs/ApiAppResponseOptions.md +10 -0
- data/docs/ApiAppResponseOwnerAccount.md +11 -0
- data/docs/ApiAppResponseWhiteLabelingOptions.md +23 -0
- data/docs/ApiAppUpdateRequest.md +16 -0
- data/docs/BulkSendJobApi.md +155 -0
- data/docs/BulkSendJobGetResponse.md +13 -0
- data/docs/BulkSendJobGetResponseSignatureRequests.md +32 -0
- data/docs/BulkSendJobListResponse.md +12 -0
- data/docs/BulkSendJobResponse.md +13 -0
- data/docs/BulkSendJobSendResponse.md +11 -0
- data/docs/EmbeddedApi.md +158 -0
- data/docs/EmbeddedEditUrlRequest.md +19 -0
- data/docs/EmbeddedEditUrlResponse.md +11 -0
- data/docs/EmbeddedEditUrlResponseEmbedded.md +11 -0
- data/docs/EmbeddedSignUrlResponse.md +11 -0
- data/docs/EmbeddedSignUrlResponseEmbedded.md +11 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorResponseError.md +12 -0
- data/docs/EventCallbackAccountRequest.md +10 -0
- data/docs/EventCallbackAccountRequestPayload.md +12 -0
- data/docs/EventCallbackApiAppRequest.md +10 -0
- data/docs/EventCallbackApiAppRequestPayload.md +13 -0
- data/docs/EventCallbackRequestEvent.md +13 -0
- data/docs/EventCallbackRequestEventMetadata.md +13 -0
- data/docs/FileResponse.md +11 -0
- data/docs/ListInfoResponse.md +13 -0
- data/docs/OAuthApi.md +158 -0
- data/docs/OAuthTokenGenerateRequest.md +14 -0
- data/docs/OAuthTokenRefreshRequest.md +11 -0
- data/docs/OAuthTokenResponse.md +14 -0
- data/docs/ReportApi.md +83 -0
- data/docs/ReportCreateRequest.md +12 -0
- data/docs/ReportCreateResponse.md +11 -0
- data/docs/ReportResponse.md +13 -0
- data/docs/SignatureRequestApi.md +1233 -0
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestCreateEmbeddedRequest.md +31 -0
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
- data/docs/SignatureRequestGetResponse.md +11 -0
- data/docs/SignatureRequestListResponse.md +12 -0
- data/docs/SignatureRequestRemindRequest.md +11 -0
- data/docs/SignatureRequestResponse.md +31 -0
- data/docs/SignatureRequestResponseAttachment.md +15 -0
- data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
- data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
- data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
- data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
- data/docs/SignatureRequestResponseData.md +14 -0
- data/docs/SignatureRequestResponseDataBase.md +14 -0
- data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
- data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
- data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
- data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
- data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
- data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
- data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
- data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
- data/docs/SignatureRequestResponseDataValueText.md +11 -0
- data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
- data/docs/SignatureRequestResponseSignatures.md +26 -0
- data/docs/SignatureRequestSendRequest.md +32 -0
- data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
- data/docs/SignatureRequestUpdateRequest.md +12 -0
- data/docs/SubAttachment.md +13 -0
- data/docs/SubBulkSignerList.md +11 -0
- data/docs/SubBulkSignerListCustomField.md +11 -0
- data/docs/SubCC.md +11 -0
- data/docs/SubCustomField.md +17 -0
- data/docs/SubEditorOptions.md +11 -0
- data/docs/SubFieldOptions.md +10 -0
- data/docs/SubFormFieldGroup.md +12 -0
- data/docs/SubFormFieldRule.md +13 -0
- data/docs/SubFormFieldRuleAction.md +13 -0
- data/docs/SubFormFieldRuleTrigger.md +13 -0
- data/docs/SubFormFieldsPerDocumentBase.md +33 -0
- data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
- data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
- data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
- data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
- data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
- data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
- data/docs/SubFormFieldsPerDocumentText.md +17 -0
- data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
- data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
- data/docs/SubMergeField.md +11 -0
- data/docs/SubOAuth.md +11 -0
- data/docs/SubOptions.md +10 -0
- data/docs/SubSignatureRequestSigner.md +15 -0
- data/docs/SubSignatureRequestTemplateSigner.md +15 -0
- data/docs/SubSigningOptions.md +16 -0
- data/docs/SubTeamResponse.md +11 -0
- data/docs/SubTemplateRole.md +11 -0
- data/docs/SubUnclaimedDraftSigner.md +12 -0
- data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
- data/docs/SubWhiteLabelingOptions.md +26 -0
- data/docs/TeamAddMemberRequest.md +12 -0
- data/docs/TeamApi.md +664 -0
- data/docs/TeamCreateRequest.md +10 -0
- data/docs/TeamGetInfoResponse.md +11 -0
- data/docs/TeamGetResponse.md +11 -0
- data/docs/TeamInfoResponse.md +14 -0
- data/docs/TeamMemberResponse.md +12 -0
- data/docs/TeamMembersResponse.md +12 -0
- data/docs/TeamParentResponse.md +11 -0
- data/docs/TeamRemoveMemberRequest.md +14 -0
- data/docs/TeamResponse.md +12 -0
- data/docs/TeamSubTeamsResponse.md +12 -0
- data/docs/TeamUpdateRequest.md +10 -0
- data/docs/TemplateAddUserRequest.md +12 -0
- data/docs/TemplateApi.md +638 -0
- data/docs/TemplateCreateEmbeddedDraftRequest.md +34 -0
- data/docs/TemplateCreateEmbeddedDraftResponse.md +11 -0
- data/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +13 -0
- data/docs/TemplateEditResponse.md +10 -0
- data/docs/TemplateGetResponse.md +11 -0
- data/docs/TemplateListResponse.md +12 -0
- data/docs/TemplateRemoveUserRequest.md +11 -0
- data/docs/TemplateResponse.md +24 -0
- data/docs/TemplateResponseAccount.md +15 -0
- data/docs/TemplateResponseAccountQuota.md +13 -0
- data/docs/TemplateResponseCCRole.md +10 -0
- data/docs/TemplateResponseCustomField.md +22 -0
- data/docs/TemplateResponseDocument.md +15 -0
- data/docs/TemplateResponseDocumentCustomField.md +25 -0
- data/docs/TemplateResponseDocumentFieldGroup.md +11 -0
- data/docs/TemplateResponseDocumentFormField.md +23 -0
- data/docs/TemplateResponseDocumentStaticField.md +19 -0
- data/docs/TemplateResponseFieldAvgTextLength.md +11 -0
- data/docs/TemplateResponseNamedFormField.md +23 -0
- data/docs/TemplateResponseSignerRole.md +11 -0
- data/docs/TemplateUpdateFilesRequest.md +15 -0
- data/docs/TemplateUpdateFilesResponse.md +10 -0
- data/docs/TemplateUpdateFilesResponseTemplate.md +11 -0
- data/docs/UnclaimedDraftApi.md +359 -0
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +44 -0
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
- data/docs/UnclaimedDraftCreateRequest.md +32 -0
- data/docs/UnclaimedDraftCreateResponse.md +11 -0
- data/docs/UnclaimedDraftEditAndResendRequest.md +17 -0
- data/docs/UnclaimedDraftResponse.md +15 -0
- data/docs/WarningResponse.md +11 -0
- data/{spec/fixtures/file.json → examples/.gitkeep} +0 -0
- data/examples/AccountCreate.rb +21 -0
- data/examples/AccountGet.rb +18 -0
- data/examples/AccountUpdate.rb +21 -0
- data/examples/AccountVerify.rb +21 -0
- data/examples/ApiAppCreate.rb +35 -0
- data/examples/ApiAppDelete.rb +20 -0
- data/examples/ApiAppGet.rb +20 -0
- data/examples/ApiAppList.rb +21 -0
- data/examples/ApiAppUpdate.rb +32 -0
- data/examples/BulkSendJobGet.rb +20 -0
- data/examples/BulkSendJobList.rb +21 -0
- data/examples/EmbeddedEditUrl.rb +24 -0
- data/examples/EmbeddedSignUrl.rb +20 -0
- data/examples/OauthTokenGenerate.rb +24 -0
- data/examples/OauthTokenRefresh.rb +21 -0
- data/examples/ReportCreate.rb +23 -0
- data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
- data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
- data/examples/SignatureRequestCancel.rb +20 -0
- data/examples/SignatureRequestCreateEmbedded.rb +46 -0
- data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
- data/examples/SignatureRequestFiles.rb +20 -0
- data/examples/SignatureRequestGet.rb +20 -0
- data/examples/SignatureRequestList.rb +21 -0
- data/examples/SignatureRequestReleaseHold.rb +20 -0
- data/examples/SignatureRequestRemind.rb +23 -0
- data/examples/SignatureRequestRemove.rb +20 -0
- data/examples/SignatureRequestSend.rb +56 -0
- data/examples/SignatureRequestSendWithTemplate.rb +50 -0
- data/examples/SignatureRequestUpdate.rb +24 -0
- data/examples/TeamAddMember.rb +21 -0
- data/examples/TeamCreate.rb +21 -0
- data/examples/TeamDelete.rb +18 -0
- data/examples/TeamGet.rb +18 -0
- data/examples/TeamInfo.rb +18 -0
- data/examples/TeamMembers.rb +20 -0
- data/examples/TeamRemoveMember.rb +22 -0
- data/examples/TeamSubTeams.rb +20 -0
- data/examples/TeamUpdate.rb +21 -0
- data/examples/TemplateAddUser.rb +23 -0
- data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
- data/examples/TemplateDelete.rb +20 -0
- data/examples/TemplateFiles.rb +20 -0
- data/examples/TemplateGet.rb +20 -0
- data/examples/TemplateList.rb +20 -0
- data/examples/TemplateRemoveUser.rb +23 -0
- data/examples/TemplateUpdateFiles.rb +23 -0
- data/examples/UnclaimedDraftCreate.rb +56 -0
- data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
- data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
- data/examples/UnclaimedDraftEditAndResend.rb +24 -0
- data/hellosign-ruby-sdk.gemspec +37 -52
- data/lib/hellosign-ruby-sdk/api/account_api.rb +440 -0
- data/lib/hellosign-ruby-sdk/api/api_app_api.rb +501 -0
- data/lib/hellosign-ruby-sdk/api/bulk_send_job_api.rb +210 -0
- data/lib/hellosign-ruby-sdk/api/embedded_api.rb +231 -0
- data/lib/hellosign-ruby-sdk/api/o_auth_api.rb +212 -0
- data/lib/hellosign-ruby-sdk/api/report_api.rb +131 -0
- data/lib/hellosign-ruby-sdk/api/signature_request_api.rb +1435 -0
- data/lib/hellosign-ruby-sdk/api/team_api.rb +917 -0
- data/lib/hellosign-ruby-sdk/api/template_api.rb +852 -0
- data/lib/hellosign-ruby-sdk/api/unclaimed_draft_api.rb +464 -0
- data/lib/hellosign-ruby-sdk/api_client.rb +414 -0
- data/lib/hellosign-ruby-sdk/api_error.rb +57 -0
- data/lib/hellosign-ruby-sdk/configuration.rb +314 -0
- data/lib/hellosign-ruby-sdk/event_callback_helper.rb +32 -0
- data/lib/hellosign-ruby-sdk/models/account_create_request.rb +284 -0
- data/lib/hellosign-ruby-sdk/models/account_create_response.rb +269 -0
- data/lib/hellosign-ruby-sdk/models/account_get_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/account_response.rb +331 -0
- data/lib/hellosign-ruby-sdk/models/account_response_quotas.rb +284 -0
- data/lib/hellosign-ruby-sdk/models/account_update_request.rb +270 -0
- data/lib/hellosign-ruby-sdk/models/account_verify_request.rb +254 -0
- data/lib/hellosign-ruby-sdk/models/account_verify_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/account_verify_response_account.rb +249 -0
- data/lib/hellosign-ruby-sdk/models/api_app_create_request.rb +346 -0
- data/lib/hellosign-ruby-sdk/models/api_app_get_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/api_app_list_response.rb +272 -0
- data/lib/hellosign-ruby-sdk/models/api_app_response.rb +341 -0
- data/lib/hellosign-ruby-sdk/models/api_app_response_o_auth.rb +282 -0
- data/lib/hellosign-ruby-sdk/models/api_app_response_options.rb +250 -0
- data/lib/hellosign-ruby-sdk/models/api_app_response_owner_account.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/api_app_response_white_labeling_options.rb +366 -0
- data/lib/hellosign-ruby-sdk/models/api_app_update_request.rb +323 -0
- data/lib/hellosign-ruby-sdk/models/bulk_send_job_get_response.rb +281 -0
- data/lib/hellosign-ruby-sdk/models/bulk_send_job_get_response_signature_requests.rb +492 -0
- data/lib/hellosign-ruby-sdk/models/bulk_send_job_list_response.rb +272 -0
- data/lib/hellosign-ruby-sdk/models/bulk_send_job_response.rb +281 -0
- data/lib/hellosign-ruby-sdk/models/bulk_send_job_send_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/embedded_edit_url_request.rb +356 -0
- data/lib/hellosign-ruby-sdk/models/embedded_edit_url_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/embedded_edit_url_response_embedded.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/embedded_sign_url_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/embedded_sign_url_response_embedded.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/error_response.rb +253 -0
- data/lib/hellosign-ruby-sdk/models/error_response_error.rb +280 -0
- data/lib/hellosign-ruby-sdk/models/event_callback_account_request.rb +253 -0
- data/lib/hellosign-ruby-sdk/models/event_callback_account_request_payload.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/event_callback_api_app_request.rb +253 -0
- data/lib/hellosign-ruby-sdk/models/event_callback_api_app_request_payload.rb +280 -0
- data/lib/hellosign-ruby-sdk/models/event_callback_request_event.rb +333 -0
- data/lib/hellosign-ruby-sdk/models/event_callback_request_event_metadata.rb +284 -0
- data/lib/hellosign-ruby-sdk/models/file_response.rb +259 -0
- data/lib/hellosign-ruby-sdk/models/list_info_response.rb +281 -0
- data/lib/hellosign-ruby-sdk/models/o_auth_token_generate_request.rb +316 -0
- data/lib/hellosign-ruby-sdk/models/o_auth_token_refresh_request.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/o_auth_token_response.rb +286 -0
- data/lib/hellosign-ruby-sdk/models/report_create_request.rb +318 -0
- data/lib/hellosign-ruby-sdk/models/report_create_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/report_response.rb +304 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_bulk_send_with_template_request.rb +439 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_create_embedded_request.rb +551 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_create_embedded_with_template_request.rb +475 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_get_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_list_response.rb +272 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_remind_request.rb +264 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response.rb +483 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_attachment.rb +322 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_base.rb +325 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_checkbox.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_text.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_type_enum.rb +37 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_base.rb +335 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_type_enum.rb +44 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox_merge.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_date_signed.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_dropdown.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_initials.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_radio.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_signature.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_text.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_text_merge.rb +265 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_response_signatures.rb +423 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_send_request.rb +555 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_send_with_template_request.rb +479 -0
- data/lib/hellosign-ruby-sdk/models/signature_request_update_request.rb +274 -0
- data/lib/hellosign-ruby-sdk/models/sub_attachment.rb +291 -0
- data/lib/hellosign-ruby-sdk/models/sub_bulk_signer_list.rb +263 -0
- data/lib/hellosign-ruby-sdk/models/sub_bulk_signer_list_custom_field.rb +269 -0
- data/lib/hellosign-ruby-sdk/models/sub_cc.rb +269 -0
- data/lib/hellosign-ruby-sdk/models/sub_custom_field.rb +287 -0
- data/lib/hellosign-ruby-sdk/models/sub_editor_options.rb +264 -0
- data/lib/hellosign-ruby-sdk/models/sub_field_options.rb +289 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_field_group.rb +284 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_field_rule.rb +352 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_field_rule_action.rb +322 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_field_rule_trigger.rb +325 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_base.rb +444 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox.rb +286 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox_merge.rb +261 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_date_signed.rb +261 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_dropdown.rb +307 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_hyperlink.rb +291 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_initials.rb +261 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_radio.rb +291 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_signature.rb +261 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_text.rb +363 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_text_merge.rb +261 -0
- data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_type_enum.rb +45 -0
- data/lib/hellosign-ruby-sdk/models/sub_merge_field.rb +303 -0
- data/lib/hellosign-ruby-sdk/models/sub_o_auth.rb +284 -0
- data/lib/hellosign-ruby-sdk/models/sub_options.rb +252 -0
- data/lib/hellosign-ruby-sdk/models/sub_signature_request_signer.rb +368 -0
- data/lib/hellosign-ruby-sdk/models/sub_signature_request_template_signer.rb +372 -0
- data/lib/hellosign-ruby-sdk/models/sub_signing_options.rb +337 -0
- data/lib/hellosign-ruby-sdk/models/sub_team_response.rb +259 -0
- data/lib/hellosign-ruby-sdk/models/sub_template_role.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/sub_unclaimed_draft_signer.rb +280 -0
- data/lib/hellosign-ruby-sdk/models/sub_unclaimed_draft_template_signer.rb +284 -0
- data/lib/hellosign-ruby-sdk/models/sub_white_labeling_options.rb +438 -0
- data/lib/hellosign-ruby-sdk/models/team_add_member_request.rb +303 -0
- data/lib/hellosign-ruby-sdk/models/team_create_request.rb +251 -0
- data/lib/hellosign-ruby-sdk/models/team_get_info_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/team_get_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/team_info_response.rb +289 -0
- data/lib/hellosign-ruby-sdk/models/team_member_response.rb +269 -0
- data/lib/hellosign-ruby-sdk/models/team_members_response.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/team_parent_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/team_remove_member_request.rb +323 -0
- data/lib/hellosign-ruby-sdk/models/team_response.rb +273 -0
- data/lib/hellosign-ruby-sdk/models/team_sub_teams_response.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/team_update_request.rb +249 -0
- data/lib/hellosign-ruby-sdk/models/template_add_user_request.rb +271 -0
- data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_request.rb +566 -0
- data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_response_template.rb +282 -0
- data/lib/hellosign-ruby-sdk/models/template_edit_response.rb +249 -0
- data/lib/hellosign-ruby-sdk/models/template_get_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/template_list_response.rb +272 -0
- data/lib/hellosign-ruby-sdk/models/template_remove_user_request.rb +259 -0
- data/lib/hellosign-ruby-sdk/models/template_response.rb +409 -0
- data/lib/hellosign-ruby-sdk/models/template_response_account.rb +298 -0
- data/lib/hellosign-ruby-sdk/models/template_response_account_quota.rb +280 -0
- data/lib/hellosign-ruby-sdk/models/template_response_cc_role.rb +249 -0
- data/lib/hellosign-ruby-sdk/models/template_response_custom_field.rb +406 -0
- data/lib/hellosign-ruby-sdk/models/template_response_document.rb +308 -0
- data/lib/hellosign-ruby-sdk/models/template_response_document_custom_field.rb +437 -0
- data/lib/hellosign-ruby-sdk/models/template_response_document_field_group.rb +259 -0
- data/lib/hellosign-ruby-sdk/models/template_response_document_form_field.rb +416 -0
- data/lib/hellosign-ruby-sdk/models/template_response_document_static_field.rb +340 -0
- data/lib/hellosign-ruby-sdk/models/template_response_field_avg_text_length.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/template_response_named_form_field.rb +382 -0
- data/lib/hellosign-ruby-sdk/models/template_response_signer_role.rb +259 -0
- data/lib/hellosign-ruby-sdk/models/template_update_files_request.rb +335 -0
- data/lib/hellosign-ruby-sdk/models/template_update_files_response.rb +248 -0
- data/lib/hellosign-ruby-sdk/models/template_update_files_response_template.rb +262 -0
- data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_request.rb +716 -0
- data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_with_template_request.rb +630 -0
- data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_request.rb +574 -0
- data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_response.rb +260 -0
- data/lib/hellosign-ruby-sdk/models/unclaimed_draft_edit_and_resend_request.rb +327 -0
- data/lib/hellosign-ruby-sdk/models/unclaimed_draft_response.rb +304 -0
- data/lib/hellosign-ruby-sdk/models/warning_response.rb +270 -0
- data/lib/hellosign-ruby-sdk/version.rb +15 -0
- data/lib/hellosign-ruby-sdk.rb +199 -3
- data/oas/.editorconfig +6 -0
- data/oas/.git +1 -0
- data/oas/.github/workflows/github-actions.yml +79 -0
- data/oas/.gitignore +2 -0
- data/oas/.redocly.lint-ignore.yaml +5 -0
- data/oas/.redocly.yaml +11 -0
- data/oas/LICENSE +68 -0
- data/oas/README.md +107 -0
- data/oas/bin/generate-sdk-oas.php +75 -0
- data/oas/bin/generate-translated-oas.php +144 -0
- data/oas/bin/php +15 -0
- data/oas/bin/plugins/decorators/check-for-beta-features.js +68 -0
- data/oas/bin/plugins/set-beta-plugin.js +14 -0
- data/oas/bin/redoc +17 -0
- data/oas/bin/validate +14 -0
- data/oas/build +23 -0
- data/oas/composer.json +15 -0
- data/oas/composer.lock +246 -0
- data/oas/examples/AccountCreate.cs +36 -0
- data/oas/examples/AccountCreate.java +42 -0
- data/oas/examples/AccountCreate.js +21 -0
- data/oas/examples/AccountCreate.php +25 -0
- data/oas/examples/AccountCreate.py +25 -0
- data/oas/examples/AccountCreate.rb +21 -0
- data/oas/examples/AccountCreate.ts +21 -0
- data/oas/examples/AccountGet.cs +32 -0
- data/oas/examples/AccountGet.java +39 -0
- data/oas/examples/AccountGet.js +17 -0
- data/oas/examples/AccountGet.php +22 -0
- data/oas/examples/AccountGet.py +21 -0
- data/oas/examples/AccountGet.rb +18 -0
- data/oas/examples/AccountGet.ts +17 -0
- data/oas/examples/AccountUpdate.cs +36 -0
- data/oas/examples/AccountUpdate.java +42 -0
- data/oas/examples/AccountUpdate.js +21 -0
- data/oas/examples/AccountUpdate.php +25 -0
- data/oas/examples/AccountUpdate.py +25 -0
- data/oas/examples/AccountUpdate.rb +21 -0
- data/oas/examples/AccountUpdate.ts +21 -0
- data/oas/examples/AccountVerify.cs +36 -0
- data/oas/examples/AccountVerify.java +42 -0
- data/oas/examples/AccountVerify.js +21 -0
- data/oas/examples/AccountVerify.php +25 -0
- data/oas/examples/AccountVerify.py +25 -0
- data/oas/examples/AccountVerify.rb +21 -0
- data/oas/examples/AccountVerify.ts +21 -0
- data/oas/examples/ApiAppCreate.cs +59 -0
- data/oas/examples/ApiAppCreate.java +61 -0
- data/oas/examples/ApiAppCreate.js +38 -0
- data/oas/examples/ApiAppCreate.php +42 -0
- data/oas/examples/ApiAppCreate.py +41 -0
- data/oas/examples/ApiAppCreate.rb +35 -0
- data/oas/examples/ApiAppCreate.ts +38 -0
- data/oas/examples/ApiAppDelete.cs +34 -0
- data/oas/examples/ApiAppDelete.java +40 -0
- data/oas/examples/ApiAppDelete.js +19 -0
- data/oas/examples/ApiAppDelete.php +23 -0
- data/oas/examples/ApiAppDelete.py +23 -0
- data/oas/examples/ApiAppDelete.rb +20 -0
- data/oas/examples/ApiAppDelete.ts +19 -0
- data/oas/examples/ApiAppGet.cs +34 -0
- data/oas/examples/ApiAppGet.java +41 -0
- data/oas/examples/ApiAppGet.js +19 -0
- data/oas/examples/ApiAppGet.php +24 -0
- data/oas/examples/ApiAppGet.py +23 -0
- data/oas/examples/ApiAppGet.rb +20 -0
- data/oas/examples/ApiAppGet.ts +19 -0
- data/oas/examples/ApiAppList.cs +35 -0
- data/oas/examples/ApiAppList.java +42 -0
- data/oas/examples/ApiAppList.js +20 -0
- data/oas/examples/ApiAppList.php +25 -0
- data/oas/examples/ApiAppList.py +27 -0
- data/oas/examples/ApiAppList.rb +21 -0
- data/oas/examples/ApiAppList.ts +20 -0
- data/oas/examples/ApiAppUpdate.cs +61 -0
- data/oas/examples/ApiAppUpdate.java +63 -0
- data/oas/examples/ApiAppUpdate.js +31 -0
- data/oas/examples/ApiAppUpdate.php +36 -0
- data/oas/examples/ApiAppUpdate.py +37 -0
- data/oas/examples/ApiAppUpdate.rb +32 -0
- data/oas/examples/ApiAppUpdate.ts +31 -0
- data/oas/examples/BulkSendJobGet.cs +35 -0
- data/oas/examples/BulkSendJobGet.java +41 -0
- data/oas/examples/BulkSendJobGet.js +19 -0
- data/oas/examples/BulkSendJobGet.php +24 -0
- data/oas/examples/BulkSendJobGet.py +23 -0
- data/oas/examples/BulkSendJobGet.rb +20 -0
- data/oas/examples/BulkSendJobGet.ts +19 -0
- data/oas/examples/BulkSendJobList.cs +36 -0
- data/oas/examples/BulkSendJobList.java +42 -0
- data/oas/examples/BulkSendJobList.js +20 -0
- data/oas/examples/BulkSendJobList.php +25 -0
- data/oas/examples/BulkSendJobList.py +27 -0
- data/oas/examples/BulkSendJobList.rb +21 -0
- data/oas/examples/BulkSendJobList.ts +20 -0
- data/oas/examples/EmbeddedEditUrl.cs +40 -0
- data/oas/examples/EmbeddedEditUrl.java +47 -0
- data/oas/examples/EmbeddedEditUrl.js +24 -0
- data/oas/examples/EmbeddedEditUrl.php +28 -0
- data/oas/examples/EmbeddedEditUrl.py +28 -0
- data/oas/examples/EmbeddedEditUrl.rb +24 -0
- data/oas/examples/EmbeddedEditUrl.ts +24 -0
- data/oas/examples/EmbeddedSignUrl.cs +35 -0
- data/oas/examples/EmbeddedSignUrl.java +44 -0
- data/oas/examples/EmbeddedSignUrl.js +19 -0
- data/oas/examples/EmbeddedSignUrl.php +24 -0
- data/oas/examples/EmbeddedSignUrl.py +23 -0
- data/oas/examples/EmbeddedSignUrl.rb +20 -0
- data/oas/examples/EmbeddedSignUrl.ts +19 -0
- data/oas/examples/OauthTokenGenerate.cs +40 -0
- data/oas/examples/OauthTokenGenerate.java +45 -0
- data/oas/examples/OauthTokenGenerate.js +23 -0
- data/oas/examples/OauthTokenGenerate.php +22 -0
- data/oas/examples/OauthTokenGenerate.py +28 -0
- data/oas/examples/OauthTokenGenerate.rb +24 -0
- data/oas/examples/OauthTokenGenerate.ts +23 -0
- data/oas/examples/OauthTokenRefresh.cs +37 -0
- data/oas/examples/OauthTokenRefresh.java +42 -0
- data/oas/examples/OauthTokenRefresh.js +20 -0
- data/oas/examples/OauthTokenRefresh.php +19 -0
- data/oas/examples/OauthTokenRefresh.py +25 -0
- data/oas/examples/OauthTokenRefresh.rb +21 -0
- data/oas/examples/OauthTokenRefresh.ts +20 -0
- data/oas/examples/ReportCreate.cs +42 -0
- data/oas/examples/ReportCreate.java +47 -0
- data/oas/examples/ReportCreate.js +23 -0
- data/oas/examples/ReportCreate.php +27 -0
- data/oas/examples/ReportCreate.py +27 -0
- data/oas/examples/ReportCreate.rb +23 -0
- data/oas/examples/ReportCreate.ts +23 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs +82 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java +81 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js +63 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php +60 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py +70 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
- data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts +63 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.cs +81 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.java +81 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.js +65 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.php +62 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.py +69 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
- data/oas/examples/SignatureRequestBulkSendWithTemplate.ts +65 -0
- data/oas/examples/SignatureRequestCancel.cs +34 -0
- data/oas/examples/SignatureRequestCancel.java +42 -0
- data/oas/examples/SignatureRequestCancel.js +19 -0
- data/oas/examples/SignatureRequestCancel.php +23 -0
- data/oas/examples/SignatureRequestCancel.py +23 -0
- data/oas/examples/SignatureRequestCancel.rb +20 -0
- data/oas/examples/SignatureRequestCancel.ts +19 -0
- data/oas/examples/SignatureRequestCreateEmbedded.cs +64 -0
- data/oas/examples/SignatureRequestCreateEmbedded.java +69 -0
- data/oas/examples/SignatureRequestCreateEmbedded.js +52 -0
- data/oas/examples/SignatureRequestCreateEmbedded.php +53 -0
- data/oas/examples/SignatureRequestCreateEmbedded.py +53 -0
- data/oas/examples/SignatureRequestCreateEmbedded.rb +46 -0
- data/oas/examples/SignatureRequestCreateEmbedded.ts +52 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.cs +55 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.java +51 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.js +41 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.php +43 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.py +45 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
- data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.ts +41 -0
- data/oas/examples/SignatureRequestFiles.cs +34 -0
- data/oas/examples/SignatureRequestFiles.java +41 -0
- data/oas/examples/SignatureRequestFiles.js +19 -0
- data/oas/examples/SignatureRequestFiles.php +24 -0
- data/oas/examples/SignatureRequestFiles.py +23 -0
- data/oas/examples/SignatureRequestFiles.rb +20 -0
- data/oas/examples/SignatureRequestFiles.ts +19 -0
- data/oas/examples/SignatureRequestGet.cs +34 -0
- data/oas/examples/SignatureRequestGet.java +41 -0
- data/oas/examples/SignatureRequestGet.js +19 -0
- data/oas/examples/SignatureRequestGet.php +24 -0
- data/oas/examples/SignatureRequestGet.py +23 -0
- data/oas/examples/SignatureRequestGet.rb +20 -0
- data/oas/examples/SignatureRequestGet.ts +19 -0
- data/oas/examples/SignatureRequestList.cs +34 -0
- data/oas/examples/SignatureRequestList.java +41 -0
- data/oas/examples/SignatureRequestList.js +20 -0
- data/oas/examples/SignatureRequestList.php +25 -0
- data/oas/examples/SignatureRequestList.py +27 -0
- data/oas/examples/SignatureRequestList.rb +21 -0
- data/oas/examples/SignatureRequestList.ts +20 -0
- data/oas/examples/SignatureRequestReleaseHold.cs +34 -0
- data/oas/examples/SignatureRequestReleaseHold.java +40 -0
- data/oas/examples/SignatureRequestReleaseHold.js +19 -0
- data/oas/examples/SignatureRequestReleaseHold.php +24 -0
- data/oas/examples/SignatureRequestReleaseHold.py +23 -0
- data/oas/examples/SignatureRequestReleaseHold.rb +20 -0
- data/oas/examples/SignatureRequestReleaseHold.ts +19 -0
- data/oas/examples/SignatureRequestRemind.cs +38 -0
- data/oas/examples/SignatureRequestRemind.java +43 -0
- data/oas/examples/SignatureRequestRemind.js +23 -0
- data/oas/examples/SignatureRequestRemind.php +27 -0
- data/oas/examples/SignatureRequestRemind.py +27 -0
- data/oas/examples/SignatureRequestRemind.rb +23 -0
- data/oas/examples/SignatureRequestRemind.ts +23 -0
- data/oas/examples/SignatureRequestRemove.cs +33 -0
- data/oas/examples/SignatureRequestRemove.java +39 -0
- data/oas/examples/SignatureRequestRemove.js +19 -0
- data/oas/examples/SignatureRequestRemove.php +20 -0
- data/oas/examples/SignatureRequestRemove.py +23 -0
- data/oas/examples/SignatureRequestRemove.rb +20 -0
- data/oas/examples/SignatureRequestRemove.ts +19 -0
- data/oas/examples/SignatureRequestSend.cs +75 -0
- data/oas/examples/SignatureRequestSend.java +75 -0
- data/oas/examples/SignatureRequestSend.js +60 -0
- data/oas/examples/SignatureRequestSend.php +60 -0
- data/oas/examples/SignatureRequestSend.py +64 -0
- data/oas/examples/SignatureRequestSend.rb +56 -0
- data/oas/examples/SignatureRequestSend.ts +60 -0
- data/oas/examples/SignatureRequestSendWithTemplate.cs +69 -0
- data/oas/examples/SignatureRequestSendWithTemplate.java +75 -0
- data/oas/examples/SignatureRequestSendWithTemplate.js +54 -0
- data/oas/examples/SignatureRequestSendWithTemplate.php +54 -0
- data/oas/examples/SignatureRequestSendWithTemplate.py +58 -0
- data/oas/examples/SignatureRequestSendWithTemplate.rb +50 -0
- data/oas/examples/SignatureRequestSendWithTemplate.ts +54 -0
- data/oas/examples/SignatureRequestUpdate.cs +39 -0
- data/oas/examples/SignatureRequestUpdate.java +44 -0
- data/oas/examples/SignatureRequestUpdate.js +24 -0
- data/oas/examples/SignatureRequestUpdate.php +28 -0
- data/oas/examples/SignatureRequestUpdate.py +28 -0
- data/oas/examples/SignatureRequestUpdate.rb +24 -0
- data/oas/examples/SignatureRequestUpdate.ts +24 -0
- data/oas/examples/TeamAddMember.cs +36 -0
- data/oas/examples/TeamAddMember.java +41 -0
- data/oas/examples/TeamAddMember.js +21 -0
- data/oas/examples/TeamAddMember.php +25 -0
- data/oas/examples/TeamAddMember.py +25 -0
- data/oas/examples/TeamAddMember.rb +21 -0
- data/oas/examples/TeamAddMember.ts +21 -0
- data/oas/examples/TeamCreate.cs +36 -0
- data/oas/examples/TeamCreate.java +41 -0
- data/oas/examples/TeamCreate.js +21 -0
- data/oas/examples/TeamCreate.php +25 -0
- data/oas/examples/TeamCreate.py +25 -0
- data/oas/examples/TeamCreate.rb +21 -0
- data/oas/examples/TeamCreate.ts +21 -0
- data/oas/examples/TeamDelete.cs +31 -0
- data/oas/examples/TeamDelete.java +37 -0
- data/oas/examples/TeamDelete.js +17 -0
- data/oas/examples/TeamDelete.php +21 -0
- data/oas/examples/TeamDelete.py +21 -0
- data/oas/examples/TeamDelete.rb +18 -0
- data/oas/examples/TeamDelete.ts +17 -0
- data/oas/examples/TeamGet.cs +32 -0
- data/oas/examples/TeamGet.java +38 -0
- data/oas/examples/TeamGet.js +17 -0
- data/oas/examples/TeamGet.php +22 -0
- data/oas/examples/TeamGet.py +21 -0
- data/oas/examples/TeamGet.rb +18 -0
- data/oas/examples/TeamGet.ts +17 -0
- data/oas/examples/TeamInfo.cs +32 -0
- data/oas/examples/TeamInfo.java +38 -0
- data/oas/examples/TeamInfo.js +17 -0
- data/oas/examples/TeamInfo.php +22 -0
- data/oas/examples/TeamInfo.py +21 -0
- data/oas/examples/TeamInfo.rb +18 -0
- data/oas/examples/TeamInfo.ts +17 -0
- data/oas/examples/TeamMembers.cs +33 -0
- data/oas/examples/TeamMembers.java +40 -0
- data/oas/examples/TeamMembers.js +19 -0
- data/oas/examples/TeamMembers.php +24 -0
- data/oas/examples/TeamMembers.py +23 -0
- data/oas/examples/TeamMembers.rb +20 -0
- data/oas/examples/TeamMembers.ts +19 -0
- data/oas/examples/TeamRemoveMember.cs +37 -0
- data/oas/examples/TeamRemoveMember.java +42 -0
- data/oas/examples/TeamRemoveMember.js +22 -0
- data/oas/examples/TeamRemoveMember.php +26 -0
- data/oas/examples/TeamRemoveMember.py +26 -0
- data/oas/examples/TeamRemoveMember.rb +22 -0
- data/oas/examples/TeamRemoveMember.ts +22 -0
- data/oas/examples/TeamSubTeams.cs +33 -0
- data/oas/examples/TeamSubTeams.java +40 -0
- data/oas/examples/TeamSubTeams.js +19 -0
- data/oas/examples/TeamSubTeams.php +24 -0
- data/oas/examples/TeamSubTeams.py +23 -0
- data/oas/examples/TeamSubTeams.rb +20 -0
- data/oas/examples/TeamSubTeams.ts +19 -0
- data/oas/examples/TeamUpdate.cs +36 -0
- data/oas/examples/TeamUpdate.java +40 -0
- data/oas/examples/TeamUpdate.js +21 -0
- data/oas/examples/TeamUpdate.php +25 -0
- data/oas/examples/TeamUpdate.py +25 -0
- data/oas/examples/TeamUpdate.rb +21 -0
- data/oas/examples/TeamUpdate.ts +21 -0
- data/oas/examples/TemplateAddUser.cs +38 -0
- data/oas/examples/TemplateAddUser.java +42 -0
- data/oas/examples/TemplateAddUser.js +23 -0
- data/oas/examples/TemplateAddUser.php +27 -0
- data/oas/examples/TemplateAddUser.py +27 -0
- data/oas/examples/TemplateAddUser.rb +23 -0
- data/oas/examples/TemplateAddUser.ts +23 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.cs +69 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.java +70 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.js +60 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.php +53 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.py +58 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.rb +49 -0
- data/oas/examples/TemplateCreateEmbeddedDraft.ts +60 -0
- data/oas/examples/TemplateDelete.cs +33 -0
- data/oas/examples/TemplateDelete.java +39 -0
- data/oas/examples/TemplateDelete.js +19 -0
- data/oas/examples/TemplateDelete.php +23 -0
- data/oas/examples/TemplateDelete.py +23 -0
- data/oas/examples/TemplateDelete.rb +20 -0
- data/oas/examples/TemplateDelete.ts +19 -0
- data/oas/examples/TemplateFiles.cs +34 -0
- data/oas/examples/TemplateFiles.java +40 -0
- data/oas/examples/TemplateFiles.js +19 -0
- data/oas/examples/TemplateFiles.php +24 -0
- data/oas/examples/TemplateFiles.py +23 -0
- data/oas/examples/TemplateFiles.rb +20 -0
- data/oas/examples/TemplateFiles.ts +19 -0
- data/oas/examples/TemplateGet.cs +34 -0
- data/oas/examples/TemplateGet.java +40 -0
- data/oas/examples/TemplateGet.js +19 -0
- data/oas/examples/TemplateGet.php +24 -0
- data/oas/examples/TemplateGet.py +23 -0
- data/oas/examples/TemplateGet.rb +20 -0
- data/oas/examples/TemplateGet.ts +19 -0
- data/oas/examples/TemplateList.cs +34 -0
- data/oas/examples/TemplateList.java +40 -0
- data/oas/examples/TemplateList.js +19 -0
- data/oas/examples/TemplateList.php +24 -0
- data/oas/examples/TemplateList.py +25 -0
- data/oas/examples/TemplateList.rb +20 -0
- data/oas/examples/TemplateList.ts +19 -0
- data/oas/examples/TemplateRemoveUser.cs +38 -0
- data/oas/examples/TemplateRemoveUser.java +43 -0
- data/oas/examples/TemplateRemoveUser.js +23 -0
- data/oas/examples/TemplateRemoveUser.php +27 -0
- data/oas/examples/TemplateRemoveUser.py +27 -0
- data/oas/examples/TemplateRemoveUser.rb +23 -0
- data/oas/examples/TemplateRemoveUser.ts +23 -0
- data/oas/examples/TemplateUpdateFiles.cs +38 -0
- data/oas/examples/TemplateUpdateFiles.java +44 -0
- data/oas/examples/TemplateUpdateFiles.js +23 -0
- data/oas/examples/TemplateUpdateFiles.php +27 -0
- data/oas/examples/TemplateUpdateFiles.py +27 -0
- data/oas/examples/TemplateUpdateFiles.rb +23 -0
- data/oas/examples/TemplateUpdateFiles.ts +23 -0
- data/oas/examples/UnclaimedDraftCreate.cs +75 -0
- data/oas/examples/UnclaimedDraftCreate.java +73 -0
- data/oas/examples/UnclaimedDraftCreate.js +63 -0
- data/oas/examples/UnclaimedDraftCreate.php +60 -0
- data/oas/examples/UnclaimedDraftCreate.py +64 -0
- data/oas/examples/UnclaimedDraftCreate.rb +56 -0
- data/oas/examples/UnclaimedDraftCreate.ts +63 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.cs +39 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.java +46 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.js +24 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.php +28 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.py +28 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
- data/oas/examples/UnclaimedDraftCreateEmbedded.ts +24 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs +52 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java +58 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js +37 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php +39 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py +41 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
- data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts +37 -0
- data/oas/examples/UnclaimedDraftEditAndResend.cs +39 -0
- data/oas/examples/UnclaimedDraftEditAndResend.java +44 -0
- data/oas/examples/UnclaimedDraftEditAndResend.js +24 -0
- data/oas/examples/UnclaimedDraftEditAndResend.php +28 -0
- data/oas/examples/UnclaimedDraftEditAndResend.py +28 -0
- data/oas/examples/UnclaimedDraftEditAndResend.rb +24 -0
- data/oas/examples/UnclaimedDraftEditAndResend.ts +24 -0
- data/oas/examples/json/AccountCreateOAuthResponseExample.json +14 -0
- data/oas/examples/json/AccountCreateRequestDefaultExample.json +3 -0
- data/oas/examples/json/AccountCreateRequestOAuthExample.json +5 -0
- data/oas/examples/json/AccountCreateResponseExample.json +18 -0
- data/oas/examples/json/AccountGetResponseExample.json +18 -0
- data/oas/examples/json/AccountUpdateRequestDefaultExample.json +4 -0
- data/oas/examples/json/AccountUpdateResponseExample.json +18 -0
- data/oas/examples/json/AccountVerifyFoundResponseExample.json +5 -0
- data/oas/examples/json/AccountVerifyNotFoundResponseExample.json +1 -0
- data/oas/examples/json/AccountVerifyRequestDefaultExample.json +3 -0
- data/oas/examples/json/ApiAppCreateRequestDefaultExample.json +17 -0
- data/oas/examples/json/ApiAppCreateRequestFormDataExample.json +18 -0
- data/oas/examples/json/ApiAppCreateResponseExample.json +26 -0
- data/oas/examples/json/ApiAppGetResponseExample.json +22 -0
- data/oas/examples/json/ApiAppListResponseExample.json +43 -0
- data/oas/examples/json/ApiAppUpdateRequestDefaultExample.json +8 -0
- data/oas/examples/json/ApiAppUpdateRequestFormDataExample.json +9 -0
- data/oas/examples/json/ApiAppUpdateResponseExample.json +26 -0
- data/oas/examples/json/BulkSendJobGetResponseExample.json +69 -0
- data/oas/examples/json/BulkSendJobListResponseExample.json +22 -0
- data/oas/examples/json/EmbeddedEditUrlRequestDefaultExample.json +6 -0
- data/oas/examples/json/EmbeddedEditUrlResponseExample.json +6 -0
- data/oas/examples/json/EmbeddedSignUrlResponseExample.json +6 -0
- data/oas/examples/json/Error400ResponseExample.json +7 -0
- data/oas/examples/json/Error401ResponseExample.json +6 -0
- data/oas/examples/json/Error402ResponseExample.json +6 -0
- data/oas/examples/json/Error403ResponseExample.json +6 -0
- data/oas/examples/json/Error404ResponseExample.json +6 -0
- data/oas/examples/json/Error409ResponseExample.json +6 -0
- data/oas/examples/json/Error410ResponseExample.json +6 -0
- data/oas/examples/json/Error422ResponseExample.json +6 -0
- data/oas/examples/json/Error429ResponseExample.json +6 -0
- data/oas/examples/json/Error4XXResponseExample.json +7 -0
- data/oas/examples/json/EventCallbackAccountSignatureRequestSentExample.json +51 -0
- data/oas/examples/json/EventCallbackAccountTemplateCreatedExample.json +140 -0
- data/oas/examples/json/EventCallbackApiAppAccountConfirmedExample.json +28 -0
- data/oas/examples/json/EventCallbackApiAppSignatureRequestSentExample.json +51 -0
- data/oas/examples/json/EventCallbackApiAppTemplateCreatedExample.json +140 -0
- data/oas/examples/json/OAuthTokenGenerateRequestExample.json +7 -0
- data/oas/examples/json/OAuthTokenGenerateResponseExample.json +7 -0
- data/oas/examples/json/OAuthTokenRefreshRequestExample.json +4 -0
- data/oas/examples/json/OAuthTokenRefreshResponseExample.json +6 -0
- data/oas/examples/json/ReportCreateRequestDefaultExample.json +8 -0
- data/oas/examples/json/ReportCreateResponseExample.json +11 -0
- data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json +49 -0
- data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json +16 -0
- data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json +8 -0
- data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json +48 -0
- data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json +15 -0
- data/oas/examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json +8 -0
- data/oas/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json +33 -0
- data/oas/examples/json/SignatureRequestCreateEmbeddedRequestFormDataExample.json +34 -0
- data/oas/examples/json/SignatureRequestCreateEmbeddedResponseExample.json +52 -0
- data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json +23 -0
- data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestFormDataExample.json +27 -0
- data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json +45 -0
- data/oas/examples/json/SignatureRequestFilesResponseExample.json +4 -0
- data/oas/examples/json/SignatureRequestGetResponseExample.json +58 -0
- data/oas/examples/json/SignatureRequestListResponseExample.json +112 -0
- data/oas/examples/json/SignatureRequestReleaseHoldResponseExample.json +32 -0
- data/oas/examples/json/SignatureRequestRemindRequestDefaultExample.json +3 -0
- data/oas/examples/json/SignatureRequestRemindResponseExample.json +35 -0
- data/oas/examples/json/SignatureRequestSendFormDataExample.json +40 -0
- data/oas/examples/json/SignatureRequestSendRequestDefaultExample.json +39 -0
- data/oas/examples/json/SignatureRequestSendResponseExample.json +76 -0
- data/oas/examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json +36 -0
- data/oas/examples/json/SignatureRequestSendWithTemplateRequestFormDataExample.json +40 -0
- data/oas/examples/json/SignatureRequestSendWithTemplateResponseExample.json +46 -0
- data/oas/examples/json/SignatureRequestUpdateRequestDefaultExample.json +4 -0
- data/oas/examples/json/SignatureRequestUpdateResponseExample.json +32 -0
- data/oas/examples/json/TeamAddMemberRequestAccountIdExample.json +3 -0
- data/oas/examples/json/TeamAddMemberRequestEmailAddressExample.json +3 -0
- data/oas/examples/json/TeamAddMemberResponseExample.json +34 -0
- data/oas/examples/json/TeamCreateRequestDefaultExample.json +3 -0
- data/oas/examples/json/TeamCreateResponseExample.json +21 -0
- data/oas/examples/json/TeamDoesNotExistResponseExample.json +6 -0
- data/oas/examples/json/TeamGetInfoResponseExample.json +12 -0
- data/oas/examples/json/TeamGetResponseExample.json +34 -0
- data/oas/examples/json/TeamGetRootInfoResponseExample.json +9 -0
- data/oas/examples/json/TeamMembersResponseExample.json +20 -0
- data/oas/examples/json/TeamRemoveMemberRequestAccountIdExample.json +3 -0
- data/oas/examples/json/TeamRemoveMemberRequestEmailAddressExample.json +4 -0
- data/oas/examples/json/TeamRemoveMemberResponseExample.json +21 -0
- data/oas/examples/json/TeamSubTeamsResponseExample.json +18 -0
- data/oas/examples/json/TeamUpdateRequestDefaultExample.json +3 -0
- data/oas/examples/json/TeamUpdateResponseExample.json +21 -0
- data/oas/examples/json/TemplateAddUserRequestDefaultExample.json +3 -0
- data/oas/examples/json/TemplateAddUserResponseExample.json +202 -0
- data/oas/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json +36 -0
- data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormDataExample.json +36 -0
- data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json +75 -0
- data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json +85 -0
- data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json +66 -0
- data/oas/examples/json/TemplateCreateEmbeddedDraftResponseExample.json +7 -0
- data/oas/examples/json/TemplateFilesResponseExample.json +4 -0
- data/oas/examples/json/TemplateGetResponseExample.json +190 -0
- data/oas/examples/json/TemplateListResponseExample.json +263 -0
- data/oas/examples/json/TemplateRemoveUserRequestDefaultExample.json +3 -0
- data/oas/examples/json/TemplateRemoveUserResponseExample.json +190 -0
- data/oas/examples/json/TemplateUpdateFilesRequestDefaultExample.json +5 -0
- data/oas/examples/json/TemplateUpdateFilesRequestFormDataExample.json +5 -0
- data/oas/examples/json/TemplateUpdateFilesResponseExample.json +5 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json +8 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormDataExample.json +8 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json +47 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json +57 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json +38 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json +10 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json +21 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestFormDataExample.json +24 -0
- data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json +9 -0
- data/oas/examples/json/UnclaimedDraftCreateRequestDefaultExample.json +14 -0
- data/oas/examples/json/UnclaimedDraftCreateRequestFormDataExample.json +6 -0
- data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json +45 -0
- data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json +55 -0
- data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json +36 -0
- data/oas/examples/json/UnclaimedDraftCreateResponseExample.json +8 -0
- data/oas/examples/json/UnclaimedDraftEditAndResendExample.json +10 -0
- data/oas/examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json +4 -0
- data/oas/markdown/en/descriptions/account-callback-description.md +5 -0
- data/oas/markdown/en/descriptions/api-app-callback-description.md +5 -0
- data/oas/markdown/en/tags/account-tag-description.md +1 -0
- data/oas/markdown/en/tags/api-app-tag-description.md +1 -0
- data/oas/markdown/en/tags/bulk-send-job-tag-description.md +1 -0
- data/oas/markdown/en/tags/callbacks-tag-description.md +7 -0
- data/oas/markdown/en/tags/embedded-tag-description.md +1 -0
- data/oas/markdown/en/tags/oauth-tag-description.md +20 -0
- data/oas/markdown/en/tags/report-tag-description.md +1 -0
- data/oas/markdown/en/tags/signature-request-tag-description.md +1 -0
- data/oas/markdown/en/tags/team-tag-description.md +1 -0
- data/oas/markdown/en/tags/template-tag-description.md +1 -0
- data/oas/markdown/en/tags/unclaimed-draft-tag-description.md +1 -0
- data/oas/openapi-raw.yaml +9709 -0
- data/oas/openapi-sdk.yaml +10206 -0
- data/oas/openapi.yaml +10251 -0
- data/oas/src/Hello/OpenApi/RawFile.php +220 -0
- data/oas/src/Hello/OpenApi/TranslationResult.php +53 -0
- data/oas/test_fixtures/AccountCreateRequest.json +7 -0
- data/oas/test_fixtures/AccountCreateResponse.json +15 -0
- data/oas/test_fixtures/AccountGetResponse.json +14 -0
- data/oas/test_fixtures/AccountUpdateRequest.json +5 -0
- data/oas/test_fixtures/AccountVerifyRequest.json +5 -0
- data/oas/test_fixtures/AccountVerifyResponse.json +7 -0
- data/oas/test_fixtures/ApiAppCreateRequest.json +36 -0
- data/oas/test_fixtures/ApiAppGetResponse.json +27 -0
- data/oas/test_fixtures/ApiAppListResponse.json +42 -0
- data/oas/test_fixtures/ApiAppUpdateRequest.json +36 -0
- data/oas/test_fixtures/BulkSendJobGetResponse.json +67 -0
- data/oas/test_fixtures/BulkSendJobListResponse.json +24 -0
- data/oas/test_fixtures/BulkSendJobSendResponse.json +10 -0
- data/oas/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
- data/oas/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
- data/oas/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
- data/oas/test_fixtures/ErrorResponse.json +9 -0
- data/oas/test_fixtures/EventCallbackHelper.json +50 -0
- data/oas/test_fixtures/FileResponse.json +6 -0
- data/oas/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
- data/oas/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
- data/oas/test_fixtures/OAuthTokenResponse.json +15 -0
- data/oas/test_fixtures/ReportCreateRequest.json +10 -0
- data/oas/test_fixtures/ReportCreateResponse.json +13 -0
- data/oas/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +68 -0
- data/oas/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +67 -0
- data/oas/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +121 -0
- data/oas/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +63 -0
- data/oas/test_fixtures/SignatureRequestGetResponse.json +146 -0
- data/oas/test_fixtures/SignatureRequestListResponse.json +102 -0
- data/oas/test_fixtures/SignatureRequestRemindRequest.json +5 -0
- data/oas/test_fixtures/SignatureRequestSendRequest.json +271 -0
- data/oas/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
- data/oas/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
- data/oas/test_fixtures/SubFormFieldsPerDocument.json +107 -0
- data/oas/test_fixtures/TeamAddMemberRequest.json +6 -0
- data/oas/test_fixtures/TeamCreateRequest.json +5 -0
- data/oas/test_fixtures/TeamGetResponse.json +34 -0
- data/oas/test_fixtures/TeamRemoveMemberRequest.json +7 -0
- data/oas/test_fixtures/TeamUpdateRequest.json +5 -0
- data/oas/test_fixtures/TemplateAddUserRequest.json +7 -0
- data/oas/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +121 -0
- data/oas/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
- data/oas/test_fixtures/TemplateGetResponse.json +102 -0
- data/oas/test_fixtures/TemplateListResponse.json +143 -0
- data/oas/test_fixtures/TemplateRemoveUserRequest.json +6 -0
- data/oas/test_fixtures/TemplateUpdateFilesRequest.json +14 -0
- data/oas/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
- data/oas/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +137 -0
- data/oas/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +70 -0
- data/oas/test_fixtures/UnclaimedDraftCreateRequest.json +122 -0
- data/oas/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
- data/oas/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
- data/oas/test_fixtures/pdf-sample-2.pdf +0 -0
- data/oas/test_fixtures/pdf-sample.pdf +0 -0
- data/oas/translations/en-plugin.json +8 -0
- data/oas/translations/en.yaml +1513 -0
- data/openapi-config.yaml +21 -0
- data/run-build +47 -0
- data/spec/api/account_api_spec.rb +110 -0
- data/spec/api/api_app_api_spec.rb +94 -0
- data/spec/api/bulk_send_job_api_spec.rb +55 -0
- data/spec/api/embedded_api_spec.rb +58 -0
- data/spec/api/oauth_api_spec.rb +58 -0
- data/spec/api/report_api_spec.rb +41 -0
- data/spec/api/signature_request_api_spec.rb +265 -0
- data/spec/api/team_api_spec.rb +108 -0
- data/spec/api/template_api_spec.rb +153 -0
- data/spec/api/unclaimed_draft_api_spec.rb +94 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/event_callback_helper_spec.rb +25 -0
- data/spec/fixtures_spec.rb +60 -0
- data/spec/models/deserialize_spec.rb +53 -0
- data/spec/models/sub_form_fields_per_document_base_spec.rb +30 -0
- data/spec/spec_helper.rb +97 -92
- data/spec/test_utils.rb +27 -0
- data/templates/Gemfile.mustache +10 -0
- data/templates/README.mustache +119 -0
- data/templates/Rakefile.mustache +10 -0
- data/templates/api.mustache +280 -0
- data/templates/api_client.mustache +288 -0
- data/templates/api_client_faraday_partial.mustache +136 -0
- data/templates/api_client_spec.mustache +220 -0
- data/templates/api_client_typhoeus_partial.mustache +153 -0
- data/templates/api_doc.mustache +77 -0
- data/templates/api_error.mustache +49 -0
- data/templates/api_info.mustache +12 -0
- data/templates/api_test.mustache +47 -0
- data/templates/base_object.mustache +146 -0
- data/templates/configuration.mustache +383 -0
- data/templates/configuration_spec.mustache +34 -0
- data/templates/configuration_tls_faraday_partial.mustache +29 -0
- data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
- data/templates/event_callback_helper.mustache +24 -0
- data/templates/gem.mustache +52 -0
- data/templates/gemspec.mustache +35 -0
- data/templates/git_push.sh.mustache +57 -0
- data/templates/gitignore.mustache +41 -0
- data/templates/model.mustache +26 -0
- data/templates/model_doc.mustache +12 -0
- data/templates/model_test.mustache +77 -0
- data/templates/partial_model_enum_class.mustache +20 -0
- data/templates/partial_model_generic.mustache +402 -0
- data/templates/partial_model_generic_doc.mustache +10 -0
- data/templates/partial_oneof_module.mustache +137 -0
- data/templates/partial_oneof_module_doc.mustache +92 -0
- data/templates/rspec.mustache +2 -0
- data/templates/rubocop.mustache +148 -0
- data/templates/spec_helper.mustache +103 -0
- data/templates/travis.mustache +14 -0
- data/templates/version.mustache +7 -0
- data/vendor/autoload.php +7 -0
- data/vendor/bin/yaml-lint +117 -0
- data/vendor/composer/ClassLoader.php +572 -0
- data/vendor/composer/InstalledVersions.php +350 -0
- data/vendor/composer/LICENSE +21 -0
- data/vendor/composer/autoload_classmap.php +10 -0
- data/vendor/composer/autoload_files.php +11 -0
- data/vendor/composer/autoload_namespaces.php +9 -0
- data/vendor/composer/autoload_psr4.php +11 -0
- data/vendor/composer/autoload_real.php +80 -0
- data/vendor/composer/autoload_static.php +46 -0
- data/vendor/composer/installed.json +239 -0
- data/vendor/composer/installed.php +50 -0
- data/vendor/composer/platform_check.php +26 -0
- data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
- data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
- data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
- data/vendor/symfony/deprecation-contracts/README.md +26 -0
- data/vendor/symfony/deprecation-contracts/composer.json +35 -0
- data/vendor/symfony/deprecation-contracts/function.php +27 -0
- data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
- data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
- data/vendor/symfony/polyfill-ctype/README.md +12 -0
- data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
- data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
- data/vendor/symfony/polyfill-ctype/composer.json +41 -0
- data/vendor/symfony/yaml/CHANGELOG.md +237 -0
- data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
- data/vendor/symfony/yaml/Dumper.php +140 -0
- data/vendor/symfony/yaml/Escaper.php +95 -0
- data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
- data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
- data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
- data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
- data/vendor/symfony/yaml/Inline.php +812 -0
- data/vendor/symfony/yaml/LICENSE +19 -0
- data/vendor/symfony/yaml/Parser.php +1305 -0
- data/vendor/symfony/yaml/README.md +13 -0
- data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
- data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
- data/vendor/symfony/yaml/Unescaper.php +132 -0
- data/vendor/symfony/yaml/Yaml.php +100 -0
- data/vendor/symfony/yaml/composer.json +42 -0
- metadata +1092 -174
- data/.gitignore +0 -19
- data/.rspec +0 -2
- data/.travis.yml +0 -15
- data/CONTRIBUTING.md +0 -42
- data/Guardfile +0 -14
- data/lib/hello_sign/.error.rb.swp +0 -0
- data/lib/hello_sign/api/account.rb +0 -91
- data/lib/hello_sign/api/api_app.rb +0 -119
- data/lib/hello_sign/api/embedded.rb +0 -74
- data/lib/hello_sign/api/oauth.rb +0 -103
- data/lib/hello_sign/api/signature_request.rb +0 -479
- data/lib/hello_sign/api/team.rb +0 -112
- data/lib/hello_sign/api/template.rb +0 -218
- data/lib/hello_sign/api/unclaimed_draft.rb +0 -277
- data/lib/hello_sign/api.rb +0 -32
- data/lib/hello_sign/client.rb +0 -333
- data/lib/hello_sign/configuration.rb +0 -82
- data/lib/hello_sign/error.rb +0 -100
- data/lib/hello_sign/resource/account.rb +0 -46
- data/lib/hello_sign/resource/api_app.rb +0 -46
- data/lib/hello_sign/resource/base_resource.rb +0 -77
- data/lib/hello_sign/resource/embedded.rb +0 -46
- data/lib/hello_sign/resource/resource_array.rb +0 -59
- data/lib/hello_sign/resource/signature_request.rb +0 -46
- data/lib/hello_sign/resource/team.rb +0 -46
- data/lib/hello_sign/resource/template.rb +0 -46
- data/lib/hello_sign/resource/template_draft.rb +0 -47
- data/lib/hello_sign/resource/unclaimed_draft.rb +0 -49
- data/lib/hello_sign/resource.rb +0 -34
- data/lib/hello_sign/version.rb +0 -27
- data/lib/hello_sign.rb +0 -55
- data/spec/fixtures/account.json +0 -15
- data/spec/fixtures/api_app.json +0 -16
- data/spec/fixtures/api_apps.json +0 -43
- data/spec/fixtures/embedded.json +0 -6
- data/spec/fixtures/empty.pdf +0 -0
- data/spec/fixtures/error.json +0 -6
- data/spec/fixtures/headers.json +0 -18
- data/spec/fixtures/nda.pdf +0 -0
- data/spec/fixtures/signature_request.json +0 -45
- data/spec/fixtures/signature_requests.json +0 -44
- data/spec/fixtures/team.json +0 -15
- data/spec/fixtures/template.json +0 -53
- data/spec/fixtures/templates.json +0 -59
- data/spec/fixtures/token.json +0 -14
- data/spec/fixtures/unclaimed_draft.json +0 -6
- data/spec/hello_sign/.error_spec.rb.swp +0 -0
- data/spec/hello_sign/api/account_spec.rb +0 -42
- data/spec/hello_sign/api/api_app_spec.rb +0 -104
- data/spec/hello_sign/api/embedded_spec.rb +0 -23
- data/spec/hello_sign/api/oauth_spec.rb +0 -27
- data/spec/hello_sign/api/signature_request_spec.rb +0 -230
- data/spec/hello_sign/api/team_spec.rb +0 -101
- data/spec/hello_sign/api/template_spec.rb +0 -172
- data/spec/hello_sign/api/unclaimed_draft_spec.rb +0 -145
- data/spec/hello_sign/client_spec.rb +0 -191
- data/spec/hello_sign/error_spec.rb +0 -10
- data/spec/hello_sign/resource/base_resource_spec.rb +0 -53
- data/spec/hello_sign_spec.rb +0 -59
- data/spec/scenarios/uploads_spec.rb +0 -19
@@ -1,479 +0,0 @@
|
|
1
|
-
#
|
2
|
-
# The MIT License (MIT)
|
3
|
-
#
|
4
|
-
# Copyright (C) 2014 hellosign.com
|
5
|
-
#
|
6
|
-
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
7
|
-
# of this software and associated documentation files (the "Software"), to deal
|
8
|
-
# in the Software without restriction, including without limitation the rights
|
9
|
-
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10
|
-
# copies of the Software, and to permit persons to whom the Software is
|
11
|
-
# furnished to do so, subject to the following conditions:
|
12
|
-
#
|
13
|
-
# The above copyright notice and this permission notice shall be included in all
|
14
|
-
# copies or substantial portions of the Software.
|
15
|
-
#
|
16
|
-
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17
|
-
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18
|
-
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
19
|
-
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20
|
-
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21
|
-
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
22
|
-
# SOFTWARE.
|
23
|
-
#
|
24
|
-
|
25
|
-
module HelloSign
|
26
|
-
module Api
|
27
|
-
|
28
|
-
#
|
29
|
-
# Contains all the API calls for the SignatureRequest resource.
|
30
|
-
# Take a look at our API Documentation for sending Signature Requests (https://app.hellosign.com/api/reference#SignatureRequest)
|
31
|
-
# for more information about this.
|
32
|
-
#
|
33
|
-
# @author [hellosign]
|
34
|
-
#
|
35
|
-
module SignatureRequest
|
36
|
-
|
37
|
-
#
|
38
|
-
# Retrieves a Signature Request with the given ID.
|
39
|
-
# @option opts [String] signature_request_id The id of the SignatureRequest to retrieve.
|
40
|
-
#
|
41
|
-
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest object
|
42
|
-
#
|
43
|
-
# @example
|
44
|
-
# signature_request = @client.get_signature_request :signature_request_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
|
45
|
-
#
|
46
|
-
def get_signature_request(opts)
|
47
|
-
path = "/signature_request/#{opts[:signature_request_id]}"
|
48
|
-
query = create_query_string(opts, [:ux_version])
|
49
|
-
path += query
|
50
|
-
HelloSign::Resource::SignatureRequest.new get(path)
|
51
|
-
end
|
52
|
-
|
53
|
-
#
|
54
|
-
# Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CC'd on.
|
55
|
-
# @option opts [String] account_id Indicates which account to return SignatureRequests for. Defaults to your account. (optional)
|
56
|
-
# @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional)
|
57
|
-
# @option opts [Integer] page_size Determines the number of SignatureRequests returned per page. Defaults to 20. (optional)
|
58
|
-
# @option opts [String] query Search terms and/or fields to filter the SignatureRequests. (optional)
|
59
|
-
#
|
60
|
-
# @return [HelloSign::Resource::ResourceArray]
|
61
|
-
#
|
62
|
-
# @example
|
63
|
-
# signature_requests = @client.get_signature_requests :page => 1
|
64
|
-
#
|
65
|
-
def get_signature_requests(opts={})
|
66
|
-
path = '/signature_request/list'
|
67
|
-
opts[:query] = create_search_string(opts[:query]) if opts[:query]
|
68
|
-
query = create_query_string(opts, [:page, :page_size, :query])
|
69
|
-
path += query
|
70
|
-
HelloSign::Resource::ResourceArray.new get(path, opts), 'signature_requests', HelloSign::Resource::SignatureRequest
|
71
|
-
end
|
72
|
-
|
73
|
-
#
|
74
|
-
# Creates and sends a new SignatureRequest with the submitted documents.
|
75
|
-
# If form_fields_per_document is not specified or use_text_tags is not enabled, a signature page will be affixed at the end
|
76
|
-
# and all signers will be required to add their signature there.
|
77
|
-
# @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
|
78
|
-
# @option opts [Array<String>] files Specified file path(s) to upload file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
|
79
|
-
# @option opts [Array<String>] file_urls URL(s) for HelloSign to download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
|
80
|
-
# @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
|
81
|
-
# @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
|
82
|
-
# @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
|
83
|
-
# @option opts [String] signing_redirect_url The URL you want the signer(s) redirected to after they successfully sign. (optional)
|
84
|
-
# @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys:
|
85
|
-
# * :name (String) Signer's name
|
86
|
-
# * :email_address (String) Signer's email address
|
87
|
-
# * :order (Integer) The order the signers are required to sign in (optional)
|
88
|
-
# * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
|
89
|
-
# @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags or form_fields_per_document (optional)
|
90
|
-
# * :name (String) Custom field name or "Field Label"
|
91
|
-
# * :value (String) The value of the field. This data will appear on the SignatureRequest.
|
92
|
-
# * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
|
93
|
-
# * :required (Boolean) Determines if the field is required or not. (optional)
|
94
|
-
# @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed on the SignatureRequest. (optional)
|
95
|
-
# @option opts [Boolean] use_text_tags Indicates whether the SignatureRequest should have Text Tags enabled. Defaults to 0. (optional)
|
96
|
-
# @option opts [Boolean] hide_text_tags Indicates whether the Text Tags should be removed automatically. Note that this is not the preferred method. Defaults to 0. (optional)
|
97
|
-
# @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
|
98
|
-
# @option opts [String] client_id The API App Client ID associated with the SignatureRequest. (optional)
|
99
|
-
# @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
|
100
|
-
# @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
|
101
|
-
# @option opts [Array<Hash>] form_fields_per_document The fields that should appear on the document. (optional)
|
102
|
-
#
|
103
|
-
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
|
104
|
-
#
|
105
|
-
# @example
|
106
|
-
# signature_request = @client.send_signature_request(
|
107
|
-
# :test_mode => 1,
|
108
|
-
# :allow_decline => 1,
|
109
|
-
# :title => 'NDA with Acme Co.',
|
110
|
-
# :subject => 'The NDA we talked about',
|
111
|
-
# :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
|
112
|
-
# :metadata => {
|
113
|
-
# :client_id => '1234',
|
114
|
-
# :custom_text => 'NDA #9'
|
115
|
-
# },
|
116
|
-
# :signers => [{
|
117
|
-
# :email_address => 'jack@example.com',
|
118
|
-
# :name => 'Jack',
|
119
|
-
# :order => 0,
|
120
|
-
# },{
|
121
|
-
# :email_address => 'jill@example.com',
|
122
|
-
# :name => 'Jill',
|
123
|
-
# :order => 1,
|
124
|
-
# }
|
125
|
-
# ],
|
126
|
-
# :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
|
127
|
-
# :files => ['NDA.pdf', 'AppendixA.pdf'],
|
128
|
-
# :form_fields_per_document => [
|
129
|
-
# [
|
130
|
-
# {
|
131
|
-
# "name": "address",
|
132
|
-
# "type": "text",
|
133
|
-
# "x": 160,
|
134
|
-
# "y": 80,
|
135
|
-
# "width": 206,
|
136
|
-
# "height": 32,
|
137
|
-
# "signer": 0
|
138
|
-
# }
|
139
|
-
# ],
|
140
|
-
# [
|
141
|
-
# {
|
142
|
-
# "name": "phone",
|
143
|
-
# "type": "text",
|
144
|
-
# "x": 160,
|
145
|
-
# "y": 150,
|
146
|
-
# "width": 206,
|
147
|
-
# "height": 32,
|
148
|
-
# "signer": 1
|
149
|
-
# }
|
150
|
-
# ]
|
151
|
-
# ]
|
152
|
-
# )
|
153
|
-
#
|
154
|
-
|
155
|
-
def send_signature_request(opts)
|
156
|
-
prepare_files opts
|
157
|
-
prepare_signers opts
|
158
|
-
prepare_form_fields opts
|
159
|
-
prepare_custom_fields opts
|
160
|
-
|
161
|
-
request = HelloSign::Resource::SignatureRequest.new post('/signature_request/send', :body => opts)
|
162
|
-
end
|
163
|
-
|
164
|
-
#
|
165
|
-
# Creates and sends a new SignatureRequest based off of the Template specified with the template_id parameter.
|
166
|
-
# @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
|
167
|
-
# @option opts [String] template_id The Template ID to use when creating the SignatureRequest.
|
168
|
-
# * Use template_ids[%i%] if using multiple templates, replacing %i% with an integer to indicate the order of the Templates
|
169
|
-
# @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
|
170
|
-
# @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
|
171
|
-
# @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
|
172
|
-
# @option opts [String] signing_redirect_url The URL you want the signer(s) redirected to after they successfully sign. (optional)
|
173
|
-
# @option opts [Array<Hash>] signers List of signers
|
174
|
-
# * :role (String) The signer role indicated on the Template. Note that the role name is case sensitive.
|
175
|
-
# * :name (String) Signer's name
|
176
|
-
# * :email_address (String) Signer's email address
|
177
|
-
# * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
|
178
|
-
# @option opts [Array<Hash>] ccs The individual(s) to be CC'd on the SignatureRequest. Required when a CC role exists for the Template.
|
179
|
-
# * :role (String) The CC role indicated on the Template. Note that the role name is case sensitive.
|
180
|
-
# * :email_address (String) CC Recipient's email address
|
181
|
-
# @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the Template. (optional)
|
182
|
-
# * :name (String) Custom field name or "Field Label"
|
183
|
-
# * :value (String) The value of the field. This data will appear on the SignatureRequest.
|
184
|
-
# * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
|
185
|
-
# * :required (Boolean) Determines if the field is required or not. (optional)
|
186
|
-
# @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
|
187
|
-
# @option opts [String] client_id The API App Client ID associated with the SignatureRequest. (optional)
|
188
|
-
# @option opts [Array<String>] files Use files to indicate the uploaded file(s) to append to the SignatureRequest. (optional)
|
189
|
-
# @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to append to the SignatureRequest. (optional)
|
190
|
-
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
|
191
|
-
# @example
|
192
|
-
# signature_request = @client.send_signature_request_with_template(
|
193
|
-
# :test_mode => 1,
|
194
|
-
# :allow_decline => 1,
|
195
|
-
# :template_ids => [
|
196
|
-
# 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
|
197
|
-
# 'c7ab48e9a9ee7102dd6229dbbc719abc7d90ff9f'
|
198
|
-
# ],
|
199
|
-
# :title => 'Purchase Order',
|
200
|
-
# :subject => 'Purchase Order',
|
201
|
-
# :message => 'Glad we could come to an agreement.',
|
202
|
-
# :metadata => {
|
203
|
-
# :client_id => '1234',
|
204
|
-
# :custom_text => 'NDA #9'
|
205
|
-
# },
|
206
|
-
# :signers => [
|
207
|
-
# {
|
208
|
-
# :email_address => 'george@example.com',
|
209
|
-
# :name => 'George',
|
210
|
-
# :role => 'Client'
|
211
|
-
# },
|
212
|
-
# {
|
213
|
-
# :email_address => 'mary@example.com',
|
214
|
-
# :name => 'Mary',
|
215
|
-
# :role => 'Manager'
|
216
|
-
# }
|
217
|
-
# ]
|
218
|
-
# )
|
219
|
-
# @example
|
220
|
-
# signature_request = @client.send_signature_request_with_template(
|
221
|
-
# :test_mode => 1,
|
222
|
-
# :allow_decline => 0,
|
223
|
-
# :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
|
224
|
-
# :title => 'Purchase Order',
|
225
|
-
# :subject => 'Purchase Order',
|
226
|
-
# :message => 'Glad we could come to an agreement.',
|
227
|
-
# :files => ['NDA.pdf', 'AppendixA.pdf'],
|
228
|
-
# :metadata => {
|
229
|
-
# :client_id => '1234',
|
230
|
-
# :custom_text => 'NDA #9'
|
231
|
-
# },
|
232
|
-
# :signers => [
|
233
|
-
# {
|
234
|
-
# :email_address => 'george@example.com',
|
235
|
-
# :name => 'George',
|
236
|
-
# :role => 'Client'
|
237
|
-
# }
|
238
|
-
# ],
|
239
|
-
# :ccs => [
|
240
|
-
# {
|
241
|
-
# :email_address =>'accounting@example.com',
|
242
|
-
# :role => "Accounting"
|
243
|
-
# }
|
244
|
-
# ],
|
245
|
-
# :custom_fields => [
|
246
|
-
# {
|
247
|
-
# :CustomFieldName => '$20,000'
|
248
|
-
# }
|
249
|
-
# ]
|
250
|
-
# )
|
251
|
-
#
|
252
|
-
def send_signature_request_with_template(opts)
|
253
|
-
prepare_signers opts
|
254
|
-
prepare_ccs opts
|
255
|
-
prepare_templates opts
|
256
|
-
prepare_custom_fields opts
|
257
|
-
prepare_files opts
|
258
|
-
|
259
|
-
HelloSign::Resource::SignatureRequest.new post('/signature_request/send_with_template', :body => opts)
|
260
|
-
end
|
261
|
-
|
262
|
-
#
|
263
|
-
# Sends an email to the signer reminding them to sign the signature request.
|
264
|
-
# @option opts [String] signature_request_id Indicates the ID of the SignatureRequest to send a reminder.
|
265
|
-
# @option opts [String] email_address The email address of the signer who will receive a reminder.
|
266
|
-
# @option opts [String] name The name of the signer who will receive a reminder. (optional)
|
267
|
-
#
|
268
|
-
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
|
269
|
-
# @example
|
270
|
-
# signature_request = @client.remind_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491', :email_address => 'john@example.com'
|
271
|
-
#
|
272
|
-
def remind_signature_request(opts)
|
273
|
-
HelloSign::Resource::SignatureRequest.new post("/signature_request/remind/#{opts[:signature_request_id]}", :body => opts)
|
274
|
-
end
|
275
|
-
|
276
|
-
#
|
277
|
-
# Cancels a SignatureRequest.
|
278
|
-
# @option opts [String] signature_request_id The ID of the incomplete SignatureRequest to cancel.
|
279
|
-
#
|
280
|
-
# @example
|
281
|
-
# @client.cancel_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
|
282
|
-
def cancel_signature_request(opts)
|
283
|
-
post("/signature_request/cancel/#{opts[:signature_request_id]}", :body => opts)
|
284
|
-
end
|
285
|
-
|
286
|
-
#
|
287
|
-
# Removes your access to a completed a SignatureRequest.
|
288
|
-
# @option opts [String] signature_request_id The ID of the completed SignatureRequest to remove access.
|
289
|
-
#
|
290
|
-
# @example
|
291
|
-
# @client.remove_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
|
292
|
-
def remove_signature_request(opts)
|
293
|
-
post("/signature_request/remove/#{opts[:signature_request_id]}", :body => opts)
|
294
|
-
end
|
295
|
-
|
296
|
-
#
|
297
|
-
# Download a copy of the SignatureRequest documents specified by the signature_request_id parameter.
|
298
|
-
# @option opts [String] signature_request_id The ID of the SignatureRequest to download.
|
299
|
-
# @option opts [String] file_type Determines the format of the file - either 'pdf' or 'zip' depending on the file type desired. Defaults to pdf. (optional)
|
300
|
-
# @option opts [Boolean] get_url Response contains a URL link to the file if set to true. Links are only available for PDFs and have a TTL of 3 days. Defaults to false. (optional)
|
301
|
-
#
|
302
|
-
# @return a PDF or Zip
|
303
|
-
#
|
304
|
-
# @example
|
305
|
-
# pdf = @client.signature_request_files :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
|
306
|
-
#
|
307
|
-
def signature_request_files(opts)
|
308
|
-
path = "/signature_request/files/#{opts[:signature_request_id]}"
|
309
|
-
if opts[:file_type]
|
310
|
-
path = path + "?file_type=#{opts[:file_type]}"
|
311
|
-
end
|
312
|
-
if opts[:get_url]
|
313
|
-
separator = opts[:file_type].nil? ? '?' : '&'
|
314
|
-
path = path + "#{separator}get_url=#{opts[:get_url]}"
|
315
|
-
end
|
316
|
-
|
317
|
-
get(path)[:body]
|
318
|
-
end
|
319
|
-
|
320
|
-
#
|
321
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame.
|
322
|
-
# If form_fields_per_document is not specified or use_text_tags is not enabled, a signature page will be affixed at the end
|
323
|
-
# and all signers will be required to add their signature there.
|
324
|
-
# Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.com.
|
325
|
-
# See our Embedded Signing Walkthrough for more information on Embedded Signing: https://app.hellosign.com/api/embeddedSigningWalkthrough
|
326
|
-
# @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
|
327
|
-
# @option opts [String] client_id The API App Client ID associated with the this embedded SignatureRequest.
|
328
|
-
# @option opts [Array<String>] files Use files to indicate the uploaded file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
|
329
|
-
# @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
|
330
|
-
# @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
|
331
|
-
# @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
|
332
|
-
# @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
|
333
|
-
# @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys:
|
334
|
-
# * :name (String) Signer's name
|
335
|
-
# * :email_address (String) Signer's email address
|
336
|
-
# * :order (Integer) The order the signers are required to sign in (optional)
|
337
|
-
# * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
|
338
|
-
# @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags or form_fields_per_document (optional)
|
339
|
-
# * :name (String) Custom field name or "Field Label"
|
340
|
-
# * :value (String) The value of the field. This data will appear on the SignatureRequest
|
341
|
-
# * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
|
342
|
-
# * :required (Boolean) Determines if the field is required or not. (optional)
|
343
|
-
# @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed on the SignatureRequest. (optional)
|
344
|
-
# @option opts [Boolean] use_text_tags Indicates whether the SignatureRequest should have Text Tags enabled. Defaults to 0. (optional)
|
345
|
-
# @option opts [Boolean] hide_text_tags Indicates whether the Text Tags should be removed automatically. Note that this is not the preferred method. Defaults to 0. (optional)
|
346
|
-
# @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
|
347
|
-
# @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
|
348
|
-
# @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
|
349
|
-
# @option opts [Array<Hash>] form_fields_per_document The fields that should appear on the document. (optional)
|
350
|
-
#
|
351
|
-
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
|
352
|
-
# @example
|
353
|
-
# request = @client.create_embedded_signature_request(
|
354
|
-
# :test_mode => 1,
|
355
|
-
# :allow_decline => 1,
|
356
|
-
# :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
|
357
|
-
# :title => 'NDA with Acme Co.',
|
358
|
-
# :subject => 'The NDA we talked about',
|
359
|
-
# :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
|
360
|
-
# :metadata => {
|
361
|
-
# :client_id => '1234',
|
362
|
-
# :custom_text => 'NDA #9'
|
363
|
-
# },
|
364
|
-
# :signers => [{
|
365
|
-
# :email_address => 'jack@example.com',
|
366
|
-
# :name => 'Jack',
|
367
|
-
# :order => 0,
|
368
|
-
# },{
|
369
|
-
# :email_address => 'jill@example.com',
|
370
|
-
# :name => 'Jill',
|
371
|
-
# :order => 1,
|
372
|
-
# }
|
373
|
-
# ],
|
374
|
-
# :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
|
375
|
-
# :files => ['NDA.pdf', 'AppendixA.pdf']
|
376
|
-
# )
|
377
|
-
#
|
378
|
-
def create_embedded_signature_request(opts)
|
379
|
-
opts[:client_id] ||= self.client_id
|
380
|
-
prepare_files opts
|
381
|
-
prepare_signers opts
|
382
|
-
prepare_form_fields opts
|
383
|
-
prepare_custom_fields opts
|
384
|
-
|
385
|
-
HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded', :body => opts)
|
386
|
-
end
|
387
|
-
|
388
|
-
#
|
389
|
-
# Creates a new SignatureRequest based on the given Template to be signed in an embedded iFrame.
|
390
|
-
# Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
|
391
|
-
# @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
|
392
|
-
# @option opts [String] client_id The API App Client ID associated with the this embedded SignatureRequest.
|
393
|
-
# @option opts [String] template_id The Template ID to use when creating the SignatureRequest.
|
394
|
-
# * Use template_ids[%i%] if using multiple templates, replacing %i% with an integer to indicate the order of the Templates
|
395
|
-
# @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
|
396
|
-
# @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
|
397
|
-
# @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
|
398
|
-
# @option opts [Array<Hash>] signers List of signers
|
399
|
-
# * :role (String) The signer role indicated on the Template. Note that the role name is case sensitive.
|
400
|
-
# * :name (String) Signer's name
|
401
|
-
# * :email_address (String) Signer's email address
|
402
|
-
# * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
|
403
|
-
# @option opts [Array<Hash>] ccs The individual(s) to be CC'd on the SignatureRequest. Required when a CC role exists for the Template.
|
404
|
-
# * :role (String) The CC role indicated on the Template. Note that the role name is case sensitive.
|
405
|
-
# * :email_address (String) CC Recipient's email address
|
406
|
-
# @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the Template. (optional)
|
407
|
-
# * :name (String) Custom field name or "Field Label"
|
408
|
-
# * :value (String) The value of the field. This data will appear on the SignatureRequest.
|
409
|
-
# * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
|
410
|
-
# * :required (Boolean) Determines if the field is required or not. (optional)
|
411
|
-
# @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
|
412
|
-
# @option opts [Array<String>] files Use files to indicate the uploaded file(s) to append to the SignatureRequest. (optional)
|
413
|
-
# @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to append to the SignatureRequest. (optional)
|
414
|
-
#
|
415
|
-
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
|
416
|
-
# @example
|
417
|
-
# request = @client.create_embedded_signature_request_with_template(
|
418
|
-
# :test_mode => 1,
|
419
|
-
# :allow_decline => 1,
|
420
|
-
# :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
|
421
|
-
# :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
|
422
|
-
# :title => 'Purchase Order',
|
423
|
-
# :subject => 'Purchase Order',
|
424
|
-
# :message => 'Glad we could come to an agreement.',
|
425
|
-
# :files => ['NDA.pdf', 'AppendixA.pdf'],
|
426
|
-
# :metadata => {
|
427
|
-
# :client_id => '1234',
|
428
|
-
# :custom_text => 'NDA #9'
|
429
|
-
# },
|
430
|
-
# :signers => [
|
431
|
-
# {
|
432
|
-
# :email_address => 'george@example.com',
|
433
|
-
# :name => 'George',
|
434
|
-
# :role => 'Client'
|
435
|
-
# }
|
436
|
-
# ],
|
437
|
-
# :ccs => [
|
438
|
-
# {
|
439
|
-
# :email_address =>'accounting@example.com',
|
440
|
-
# :role => "Accounting"
|
441
|
-
# }
|
442
|
-
# ],
|
443
|
-
# :custom_fields => {
|
444
|
-
# :Cost => '$20,000'
|
445
|
-
# }
|
446
|
-
# )
|
447
|
-
#
|
448
|
-
def create_embedded_signature_request_with_template(opts)
|
449
|
-
opts[:client_id] ||= self.client_id
|
450
|
-
prepare_signers opts
|
451
|
-
prepare_ccs opts
|
452
|
-
prepare_templates opts
|
453
|
-
prepare_custom_fields opts
|
454
|
-
prepare_files opts
|
455
|
-
|
456
|
-
HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded_with_template', :body => opts)
|
457
|
-
end
|
458
|
-
|
459
|
-
#
|
460
|
-
# Updates the email address on a SignatureRequest.
|
461
|
-
# @option opts [String] signature_request_id The ID of the SignatureRequest to update.
|
462
|
-
# @option opts [String] signature_id The Signature ID of the recipient to update.
|
463
|
-
# @option opts [String] email_address The new email address of the recipient.
|
464
|
-
#
|
465
|
-
# @example
|
466
|
-
# @client.update_signature_request(
|
467
|
-
# :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491',
|
468
|
-
# :signature_id => '5064ca698bde9581ad75f6d62450eb4b',
|
469
|
-
# :email_address => 'newEmail@example.com'
|
470
|
-
# )
|
471
|
-
|
472
|
-
def update_signature_request(opts)
|
473
|
-
signature_request_id = opts.delete(:signature_request_id)
|
474
|
-
path = "/signature_request/update/#{signature_request_id}"
|
475
|
-
HelloSign::Resource::SignatureRequest.new post(path, :body => opts)
|
476
|
-
end
|
477
|
-
end
|
478
|
-
end
|
479
|
-
end
|
data/lib/hello_sign/api/team.rb
DELETED
@@ -1,112 +0,0 @@
|
|
1
|
-
#
|
2
|
-
# The MIT License (MIT)
|
3
|
-
#
|
4
|
-
# Copyright (C) 2014 hellosign.com
|
5
|
-
#
|
6
|
-
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
7
|
-
# of this software and associated documentation files (the "Software"), to deal
|
8
|
-
# in the Software without restriction, including without limitation the rights
|
9
|
-
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10
|
-
# copies of the Software, and to permit persons to whom the Software is
|
11
|
-
# furnished to do so, subject to the following conditions:
|
12
|
-
#
|
13
|
-
# The above copyright notice and this permission notice shall be included in all
|
14
|
-
# copies or substantial portions of the Software.
|
15
|
-
#
|
16
|
-
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17
|
-
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18
|
-
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
19
|
-
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20
|
-
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21
|
-
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
22
|
-
# SOFTWARE.
|
23
|
-
#
|
24
|
-
|
25
|
-
module HelloSign
|
26
|
-
module Api
|
27
|
-
#
|
28
|
-
# Contains all the API calls for the Team resource.
|
29
|
-
# Take a look at our API Documentation on the Team Resource (https://app.hellosign.com/api/reference#Team)
|
30
|
-
# for more information about this.
|
31
|
-
#
|
32
|
-
# @author [hellosign]
|
33
|
-
#
|
34
|
-
module Team
|
35
|
-
#
|
36
|
-
# Returns information about your Team as well as a list of its members.
|
37
|
-
# If you do not belong to a Team, HelloSign::Error::NotFound will be raised
|
38
|
-
#
|
39
|
-
# @return [HelloSign::Resource::Team] your current Team
|
40
|
-
#
|
41
|
-
# @example
|
42
|
-
# team = @client.get_team
|
43
|
-
def get_team
|
44
|
-
HelloSign::Resource::Team.new get('/team')
|
45
|
-
end
|
46
|
-
|
47
|
-
#
|
48
|
-
# Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
|
49
|
-
# @option opts [String] name The name of the Team.
|
50
|
-
#
|
51
|
-
# @return [HelloSign::Resource::Team] new created Team object
|
52
|
-
#
|
53
|
-
# @example
|
54
|
-
# team = @client.create_team :name => 'Team America World Police'
|
55
|
-
def create_team(opts)
|
56
|
-
HelloSign::Resource::Team.new post('/team/create', :body => opts)
|
57
|
-
end
|
58
|
-
|
59
|
-
#
|
60
|
-
# Updates the name of your Team.
|
61
|
-
# @option opts [String] name The name of your Team.
|
62
|
-
#
|
63
|
-
# @return [HelloSign::Resource::Team] a Team object
|
64
|
-
#
|
65
|
-
# @example
|
66
|
-
# team = @client.update_team :name => 'New Team Name'
|
67
|
-
def update_team(opts)
|
68
|
-
HelloSign::Resource::Team.new post('/team', :body => opts)
|
69
|
-
end
|
70
|
-
|
71
|
-
#
|
72
|
-
# Deletes your Team. Can only be invoked with a Team with one member (yourself).
|
73
|
-
#
|
74
|
-
# @example
|
75
|
-
# team = @client.destroy_team
|
76
|
-
def destroy_team
|
77
|
-
post('/team/destroy')
|
78
|
-
end
|
79
|
-
|
80
|
-
#
|
81
|
-
# Adds or invites a user (specified using the email_address parameter) to the Team.
|
82
|
-
# If the user does not currently have a HelloSign Account, a new one will be created for them.
|
83
|
-
# If the user currently has a paid subscription, they will be emailed an invitation to join the Team.
|
84
|
-
# If a user is already a part of a Team, a "team_invite_failed" error will be returned.
|
85
|
-
# @option opts [String] account_id The user's Account ID to invite to the Team.
|
86
|
-
# @option opts [String] email_address The user's email address to invite to your Team.
|
87
|
-
# Note: The account_id prevails if both email_address and acccount_id are provided.
|
88
|
-
#
|
89
|
-
# @return [HelloSign::Resource::Team] updated Team object
|
90
|
-
#
|
91
|
-
# @example
|
92
|
-
# team = @client.add_member_to_team :email_address => 'george@example.com'
|
93
|
-
def add_member_to_team(opts)
|
94
|
-
HelloSign::Resource::Team.new post('/team/add_member', :body => opts)
|
95
|
-
end
|
96
|
-
|
97
|
-
#
|
98
|
-
# Removes a user from the Team. If the user had an outstanding invitation to your Team, the original invitation will expire.
|
99
|
-
# @option opts [String] account_id The user's Account ID to remove from the Team.
|
100
|
-
# @option opts [String] email_address The user's email address to remove from your Team.
|
101
|
-
# @option opts [String] new_owner_email_address The Account's email address to receive all documents, API Apps (if applicable), and API key from removed account. (optional)
|
102
|
-
# Note: The account_id prevails if both email_address and acccount_id are provided.
|
103
|
-
#
|
104
|
-
# @return [HelloSign::Resource::Team] updated Team object
|
105
|
-
# @example
|
106
|
-
# team = @client.remove_member_from_team :email_address => 'george@example.com'
|
107
|
-
def remove_member_from_team(opts)
|
108
|
-
HelloSign::Resource::Team.new post('/team/remove_member', :body => opts)
|
109
|
-
end
|
110
|
-
end
|
111
|
-
end
|
112
|
-
end
|