hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- 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 -90
- 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 -182
- 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 -78
- data/lib/hello_sign/api/api_app.rb +0 -121
- data/lib/hello_sign/api/bulk_send_job.rb +0 -62
- data/lib/hello_sign/api/embedded.rb +0 -68
- data/lib/hello_sign/api/oauth.rb +0 -95
- data/lib/hello_sign/api/signature_request.rb +0 -662
- data/lib/hello_sign/api/team.rb +0 -107
- data/lib/hello_sign/api/template.rb +0 -227
- data/lib/hello_sign/api/unclaimed_draft.rb +0 -328
- data/lib/hello_sign/api.rb +0 -31
- data/lib/hello_sign/client.rb +0 -369
- data/lib/hello_sign/configuration.rb +0 -78
- data/lib/hello_sign/error.rb +0 -99
- data/lib/hello_sign/resource/account.rb +0 -43
- data/lib/hello_sign/resource/api_app.rb +0 -43
- data/lib/hello_sign/resource/base_resource.rb +0 -73
- data/lib/hello_sign/resource/bulk_send_job.rb +0 -43
- data/lib/hello_sign/resource/embedded.rb +0 -43
- data/lib/hello_sign/resource/resource_array.rb +0 -56
- data/lib/hello_sign/resource/signature_request.rb +0 -43
- data/lib/hello_sign/resource/team.rb +0 -43
- data/lib/hello_sign/resource/template.rb +0 -43
- data/lib/hello_sign/resource/template_draft.rb +0 -44
- data/lib/hello_sign/resource/unclaimed_draft.rb +0 -44
- data/lib/hello_sign/resource.rb +0 -33
- data/lib/hello_sign/version.rb +0 -25
- data/lib/hello_sign.rb +0 -50
- 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/bulk_send_job.json +0 -88
- data/spec/fixtures/bulk_send_jobs.json +0 -22
- 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/bulk_send_job_spec.rb +0 -53
- 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 -57
- data/spec/scenarios/uploads_spec.rb +0 -19
data/docs/ApiAppApi.md
ADDED
@@ -0,0 +1,402 @@
|
|
1
|
+
# HelloSign::ApiAppApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.hellosign.com/v3*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [`api_app_create`](ApiAppApi.md#api_app_create) | **POST** `/api_app` | Create API App |
|
8
|
+
| [`api_app_delete`](ApiAppApi.md#api_app_delete) | **DELETE** `/api_app/{client_id}` | Delete API App |
|
9
|
+
| [`api_app_get`](ApiAppApi.md#api_app_get) | **GET** `/api_app/{client_id}` | Get API App |
|
10
|
+
| [`api_app_list`](ApiAppApi.md#api_app_list) | **GET** `/api_app/list` | List API Apps |
|
11
|
+
| [`api_app_update`](ApiAppApi.md#api_app_update) | **PUT** `/api_app/{client_id}` | Update API App |
|
12
|
+
|
13
|
+
|
14
|
+
## `api_app_create`
|
15
|
+
|
16
|
+
> `<ApiAppGetResponse> api_app_create(api_app_create_request)`
|
17
|
+
|
18
|
+
Create API App
|
19
|
+
|
20
|
+
Creates a new API App.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require "hellosign-ruby-sdk"
|
26
|
+
|
27
|
+
HelloSign.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: api_key
|
29
|
+
config.username = "YOUR_API_KEY"
|
30
|
+
|
31
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
32
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
33
|
+
end
|
34
|
+
|
35
|
+
api = HelloSign::ApiAppApi.new
|
36
|
+
|
37
|
+
oauth = HelloSign::SubOAuth.new
|
38
|
+
oauth.callback_url = "https://example.com/oauth"
|
39
|
+
oauth.scopes = %w[basic_account_info request_signature]
|
40
|
+
|
41
|
+
white_labeling_options = HelloSign::SubWhiteLabelingOptions.new
|
42
|
+
white_labeling_options.primary_button_color = "#00b3e6"
|
43
|
+
white_labeling_options.primary_button_text_color = "#ffffff"
|
44
|
+
|
45
|
+
custom_logo_file = File.new('./CustomLogoFile.png')
|
46
|
+
|
47
|
+
data = HelloSign::ApiAppCreateRequest.new
|
48
|
+
data.name = "My Production App"
|
49
|
+
data.domains = ["example.com"]
|
50
|
+
data.oauth = oauth
|
51
|
+
data.white_labeling_options = white_labeling_options
|
52
|
+
data.custom_logo_file = custom_logo_file
|
53
|
+
|
54
|
+
begin
|
55
|
+
result = api.api_app_create(data)
|
56
|
+
p result
|
57
|
+
rescue HelloSign::ApiError => e
|
58
|
+
puts "Exception when calling HelloSign API: #{e}"
|
59
|
+
end
|
60
|
+
|
61
|
+
```
|
62
|
+
|
63
|
+
#### Using the `api_app_create_with_http_info` variant
|
64
|
+
|
65
|
+
This returns an Array which contains the response data, status code and headers.
|
66
|
+
|
67
|
+
> `<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_create_with_http_info(api_app_create_request)`
|
68
|
+
|
69
|
+
```ruby
|
70
|
+
begin
|
71
|
+
# Create API App
|
72
|
+
data, status_code, headers = api_instance.api_app_create_with_http_info(api_app_create_request)
|
73
|
+
p status_code # => 2xx
|
74
|
+
p headers # => { ... }
|
75
|
+
p data # => <ApiAppGetResponse>
|
76
|
+
rescue HelloSign::ApiError => e
|
77
|
+
puts "Error when calling ApiAppApi->api_app_create_with_http_info: #{e}"
|
78
|
+
end
|
79
|
+
```
|
80
|
+
|
81
|
+
### Parameters
|
82
|
+
|
83
|
+
| Name | Type | Description | Notes |
|
84
|
+
| ---- | ---- | ----------- | ----- |
|
85
|
+
| `api_app_create_request` | [**ApiAppCreateRequest**](ApiAppCreateRequest.md) | | |
|
86
|
+
|
87
|
+
### Return type
|
88
|
+
|
89
|
+
[**ApiAppGetResponse**](ApiAppGetResponse.md)
|
90
|
+
|
91
|
+
### Authorization
|
92
|
+
|
93
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
94
|
+
|
95
|
+
### HTTP request headers
|
96
|
+
|
97
|
+
- **Content-Type**: application/json, multipart/form-data
|
98
|
+
- **Accept**: application/json
|
99
|
+
|
100
|
+
|
101
|
+
## `api_app_delete`
|
102
|
+
|
103
|
+
> `api_app_delete(client_id)`
|
104
|
+
|
105
|
+
Delete API App
|
106
|
+
|
107
|
+
Deletes an API App. Can only be invoked for apps you own.
|
108
|
+
|
109
|
+
### Examples
|
110
|
+
|
111
|
+
```ruby
|
112
|
+
require "hellosign-ruby-sdk"
|
113
|
+
|
114
|
+
HelloSign.configure do |config|
|
115
|
+
# Configure HTTP basic authorization: api_key
|
116
|
+
config.username = "YOUR_API_KEY"
|
117
|
+
|
118
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
119
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
120
|
+
end
|
121
|
+
|
122
|
+
api = HelloSign::ApiAppApi.new
|
123
|
+
|
124
|
+
client_id = "0dd3b823a682527788c4e40cb7b6f7e9"
|
125
|
+
|
126
|
+
begin
|
127
|
+
result = api.api_app_delete(client_id)
|
128
|
+
p result
|
129
|
+
rescue HelloSign::ApiError => e
|
130
|
+
puts "Exception when calling HelloSign API: #{e}"
|
131
|
+
end
|
132
|
+
|
133
|
+
```
|
134
|
+
|
135
|
+
#### Using the `api_app_delete_with_http_info` variant
|
136
|
+
|
137
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
138
|
+
|
139
|
+
> `<Array(nil, Integer, Hash)> api_app_delete_with_http_info(client_id)`
|
140
|
+
|
141
|
+
```ruby
|
142
|
+
begin
|
143
|
+
# Delete API App
|
144
|
+
data, status_code, headers = api_instance.api_app_delete_with_http_info(client_id)
|
145
|
+
p status_code # => 2xx
|
146
|
+
p headers # => { ... }
|
147
|
+
p data # => nil
|
148
|
+
rescue HelloSign::ApiError => e
|
149
|
+
puts "Error when calling ApiAppApi->api_app_delete_with_http_info: #{e}"
|
150
|
+
end
|
151
|
+
```
|
152
|
+
|
153
|
+
### Parameters
|
154
|
+
|
155
|
+
| Name | Type | Description | Notes |
|
156
|
+
| ---- | ---- | ----------- | ----- |
|
157
|
+
| `client_id` | **String** | The client id of the API App to delete. | |
|
158
|
+
|
159
|
+
### Return type
|
160
|
+
|
161
|
+
nil (empty response body)
|
162
|
+
|
163
|
+
### Authorization
|
164
|
+
|
165
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
166
|
+
|
167
|
+
### HTTP request headers
|
168
|
+
|
169
|
+
- **Content-Type**: Not defined
|
170
|
+
- **Accept**: application/json
|
171
|
+
|
172
|
+
|
173
|
+
## `api_app_get`
|
174
|
+
|
175
|
+
> `<ApiAppGetResponse> api_app_get(client_id)`
|
176
|
+
|
177
|
+
Get API App
|
178
|
+
|
179
|
+
Returns an object with information about an API App.
|
180
|
+
|
181
|
+
### Examples
|
182
|
+
|
183
|
+
```ruby
|
184
|
+
require "hellosign-ruby-sdk"
|
185
|
+
|
186
|
+
HelloSign.configure do |config|
|
187
|
+
# Configure HTTP basic authorization: api_key
|
188
|
+
config.username = "YOUR_API_KEY"
|
189
|
+
|
190
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
191
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
192
|
+
end
|
193
|
+
|
194
|
+
api = HelloSign::ApiAppApi.new
|
195
|
+
|
196
|
+
client_id = "0dd3b823a682527788c4e40cb7b6f7e9"
|
197
|
+
|
198
|
+
begin
|
199
|
+
result = api.api_app_get(client_id)
|
200
|
+
p result
|
201
|
+
rescue HelloSign::ApiError => e
|
202
|
+
puts "Exception when calling HelloSign API: #{e}"
|
203
|
+
end
|
204
|
+
|
205
|
+
```
|
206
|
+
|
207
|
+
#### Using the `api_app_get_with_http_info` variant
|
208
|
+
|
209
|
+
This returns an Array which contains the response data, status code and headers.
|
210
|
+
|
211
|
+
> `<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_get_with_http_info(client_id)`
|
212
|
+
|
213
|
+
```ruby
|
214
|
+
begin
|
215
|
+
# Get API App
|
216
|
+
data, status_code, headers = api_instance.api_app_get_with_http_info(client_id)
|
217
|
+
p status_code # => 2xx
|
218
|
+
p headers # => { ... }
|
219
|
+
p data # => <ApiAppGetResponse>
|
220
|
+
rescue HelloSign::ApiError => e
|
221
|
+
puts "Error when calling ApiAppApi->api_app_get_with_http_info: #{e}"
|
222
|
+
end
|
223
|
+
```
|
224
|
+
|
225
|
+
### Parameters
|
226
|
+
|
227
|
+
| Name | Type | Description | Notes |
|
228
|
+
| ---- | ---- | ----------- | ----- |
|
229
|
+
| `client_id` | **String** | The client id of the API App to retrieve. | |
|
230
|
+
|
231
|
+
### Return type
|
232
|
+
|
233
|
+
[**ApiAppGetResponse**](ApiAppGetResponse.md)
|
234
|
+
|
235
|
+
### Authorization
|
236
|
+
|
237
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
238
|
+
|
239
|
+
### HTTP request headers
|
240
|
+
|
241
|
+
- **Content-Type**: Not defined
|
242
|
+
- **Accept**: application/json
|
243
|
+
|
244
|
+
|
245
|
+
## `api_app_list`
|
246
|
+
|
247
|
+
> `<ApiAppListResponse> api_app_list(opts)`
|
248
|
+
|
249
|
+
List API Apps
|
250
|
+
|
251
|
+
Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.
|
252
|
+
|
253
|
+
### Examples
|
254
|
+
|
255
|
+
```ruby
|
256
|
+
require "hellosign-ruby-sdk"
|
257
|
+
|
258
|
+
HelloSign.configure do |config|
|
259
|
+
# Configure HTTP basic authorization: api_key
|
260
|
+
config.username = "YOUR_API_KEY"
|
261
|
+
|
262
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
263
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
264
|
+
end
|
265
|
+
|
266
|
+
api = HelloSign::ApiAppApi.new
|
267
|
+
|
268
|
+
page = 1
|
269
|
+
page_size = 2
|
270
|
+
|
271
|
+
begin
|
272
|
+
result = api.api_app_list({ page: page, page_size: page_size })
|
273
|
+
p result
|
274
|
+
rescue HelloSign::ApiError => e
|
275
|
+
puts "Exception when calling HelloSign API: #{e}"
|
276
|
+
end
|
277
|
+
|
278
|
+
```
|
279
|
+
|
280
|
+
#### Using the `api_app_list_with_http_info` variant
|
281
|
+
|
282
|
+
This returns an Array which contains the response data, status code and headers.
|
283
|
+
|
284
|
+
> `<Array(<ApiAppListResponse>, Integer, Hash)> api_app_list_with_http_info(opts)`
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
begin
|
288
|
+
# List API Apps
|
289
|
+
data, status_code, headers = api_instance.api_app_list_with_http_info(opts)
|
290
|
+
p status_code # => 2xx
|
291
|
+
p headers # => { ... }
|
292
|
+
p data # => <ApiAppListResponse>
|
293
|
+
rescue HelloSign::ApiError => e
|
294
|
+
puts "Error when calling ApiAppApi->api_app_list_with_http_info: #{e}"
|
295
|
+
end
|
296
|
+
```
|
297
|
+
|
298
|
+
### Parameters
|
299
|
+
|
300
|
+
| Name | Type | Description | Notes |
|
301
|
+
| ---- | ---- | ----------- | ----- |
|
302
|
+
| `page` | **Integer** | Which page number of the API App List to return. Defaults to `1`. | [optional][default to 1] |
|
303
|
+
| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] |
|
304
|
+
|
305
|
+
### Return type
|
306
|
+
|
307
|
+
[**ApiAppListResponse**](ApiAppListResponse.md)
|
308
|
+
|
309
|
+
### Authorization
|
310
|
+
|
311
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
312
|
+
|
313
|
+
### HTTP request headers
|
314
|
+
|
315
|
+
- **Content-Type**: Not defined
|
316
|
+
- **Accept**: application/json
|
317
|
+
|
318
|
+
|
319
|
+
## `api_app_update`
|
320
|
+
|
321
|
+
> `<ApiAppGetResponse> api_app_update(client_id, api_app_update_request)`
|
322
|
+
|
323
|
+
Update API App
|
324
|
+
|
325
|
+
Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.
|
326
|
+
|
327
|
+
### Examples
|
328
|
+
|
329
|
+
```ruby
|
330
|
+
require "hellosign-ruby-sdk"
|
331
|
+
|
332
|
+
HelloSign.configure do |config|
|
333
|
+
# Configure HTTP basic authorization: api_key
|
334
|
+
config.username = "YOUR_API_KEY"
|
335
|
+
|
336
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
337
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
338
|
+
end
|
339
|
+
|
340
|
+
api = HelloSign::ApiAppApi.new
|
341
|
+
|
342
|
+
white_labeling_options = HelloSign::SubWhiteLabelingOptions.new
|
343
|
+
white_labeling_options.primary_button_color = "#00b3e6"
|
344
|
+
white_labeling_options.primary_button_text_color = "#ffffff"
|
345
|
+
|
346
|
+
custom_logo_file = File.new('./CustomLogoFile.png')
|
347
|
+
|
348
|
+
data = HelloSign::ApiAppUpdateRequest.new
|
349
|
+
data.name = "New Name"
|
350
|
+
data.callback_url = "http://example.com/hellosign"
|
351
|
+
data.white_labeling_options = white_labeling_options
|
352
|
+
data.custom_logo_file = custom_logo_file
|
353
|
+
|
354
|
+
client_id = "0dd3b823a682527788c4e40cb7b6f7e9"
|
355
|
+
|
356
|
+
begin
|
357
|
+
result = api.api_app_update(client_id, data)
|
358
|
+
p result
|
359
|
+
rescue HelloSign::ApiError => e
|
360
|
+
puts "Exception when calling HelloSign API: #{e}"
|
361
|
+
end
|
362
|
+
|
363
|
+
```
|
364
|
+
|
365
|
+
#### Using the `api_app_update_with_http_info` variant
|
366
|
+
|
367
|
+
This returns an Array which contains the response data, status code and headers.
|
368
|
+
|
369
|
+
> `<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_update_with_http_info(client_id, api_app_update_request)`
|
370
|
+
|
371
|
+
```ruby
|
372
|
+
begin
|
373
|
+
# Update API App
|
374
|
+
data, status_code, headers = api_instance.api_app_update_with_http_info(client_id, api_app_update_request)
|
375
|
+
p status_code # => 2xx
|
376
|
+
p headers # => { ... }
|
377
|
+
p data # => <ApiAppGetResponse>
|
378
|
+
rescue HelloSign::ApiError => e
|
379
|
+
puts "Error when calling ApiAppApi->api_app_update_with_http_info: #{e}"
|
380
|
+
end
|
381
|
+
```
|
382
|
+
|
383
|
+
### Parameters
|
384
|
+
|
385
|
+
| Name | Type | Description | Notes |
|
386
|
+
| ---- | ---- | ----------- | ----- |
|
387
|
+
| `client_id` | **String** | The client id of the API App to update. | |
|
388
|
+
| `api_app_update_request` | [**ApiAppUpdateRequest**](ApiAppUpdateRequest.md) | | |
|
389
|
+
|
390
|
+
### Return type
|
391
|
+
|
392
|
+
[**ApiAppGetResponse**](ApiAppGetResponse.md)
|
393
|
+
|
394
|
+
### Authorization
|
395
|
+
|
396
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
397
|
+
|
398
|
+
### HTTP request headers
|
399
|
+
|
400
|
+
- **Content-Type**: application/json, multipart/form-data
|
401
|
+
- **Accept**: application/json
|
402
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# HelloSign::ApiAppCreateRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `domains`<sup>*_required_</sup> | ```Array<String>``` | The domain names the ApiApp will be associated with. | |
|
10
|
+
| `name`<sup>*_required_</sup> | ```String``` | The name you want to assign to the ApiApp. | |
|
11
|
+
| `callback_url` | ```String``` | The URL at which the ApiApp should receive event callbacks. | |
|
12
|
+
| `custom_logo_file` | ```File``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
|
13
|
+
| `oauth` | [```SubOAuth```](SubOAuth.md) | | |
|
14
|
+
| `options` | [```SubOptions```](SubOptions.md) | | |
|
15
|
+
| `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | |
|
16
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# HelloSign::ApiAppGetResponse
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `api_app` | [```ApiAppResponse```](ApiAppResponse.md) | | |
|
10
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# HelloSign::ApiAppListResponse
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `api_apps` | [```Array<ApiAppResponse>```](ApiAppResponse.md) | Contains information about API Apps. | |
|
10
|
+
| `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | |
|
11
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
12
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# HelloSign::ApiAppResponse
|
2
|
+
|
3
|
+
Contains information about an API App.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `callback_url` | ```String``` | The app's callback URL (for events) | |
|
10
|
+
| `client_id` | ```String``` | The app's client id | |
|
11
|
+
| `created_at` | ```Integer``` | The time that the app was created | |
|
12
|
+
| `domains` | ```Array<String>``` | The domain name(s) associated with the app | |
|
13
|
+
| `name` | ```String``` | The name of the app | |
|
14
|
+
| `is_approved` | ```Boolean``` | Boolean to indicate if the app has been approved | |
|
15
|
+
| `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | |
|
16
|
+
| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | |
|
17
|
+
| `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | |
|
18
|
+
| `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | |
|
19
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# HelloSign::ApiAppResponseOAuth
|
2
|
+
|
3
|
+
An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `callback_url` | ```String``` | The app's OAuth callback URL. | |
|
10
|
+
| `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | |
|
11
|
+
| `scopes` | ```Array<String>``` | Array of OAuth scopes used by the app. | |
|
12
|
+
| `charges_users` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | |
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# HelloSign::ApiAppResponseOptions
|
2
|
+
|
3
|
+
An object with options that override account settings.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `can_insert_everywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | |
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# HelloSign::ApiAppResponseOwnerAccount
|
2
|
+
|
3
|
+
An object describing the app's owner
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `account_id` | ```String``` | The owner account's ID | |
|
10
|
+
| `email_address` | ```String``` | The owner account's email address | |
|
11
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# HelloSign::ApiAppResponseWhiteLabelingOptions
|
2
|
+
|
3
|
+
An object with options to customize the app's signer page
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `header_background_color` | ```String``` | | |
|
10
|
+
| `legal_version` | ```String``` | | |
|
11
|
+
| `link_color` | ```String``` | | |
|
12
|
+
| `page_background_color` | ```String``` | | |
|
13
|
+
| `primary_button_color` | ```String``` | | |
|
14
|
+
| `primary_button_color_hover` | ```String``` | | |
|
15
|
+
| `primary_button_text_color` | ```String``` | | |
|
16
|
+
| `primary_button_text_color_hover` | ```String``` | | |
|
17
|
+
| `secondary_button_color` | ```String``` | | |
|
18
|
+
| `secondary_button_color_hover` | ```String``` | | |
|
19
|
+
| `secondary_button_text_color` | ```String``` | | |
|
20
|
+
| `secondary_button_text_color_hover` | ```String``` | | |
|
21
|
+
| `text_color1` | ```String``` | | |
|
22
|
+
| `text_color2` | ```String``` | | |
|
23
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# HelloSign::ApiAppUpdateRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `callback_url` | ```String``` | The URL at which the API App should receive event callbacks. | |
|
10
|
+
| `custom_logo_file` | ```File``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
|
11
|
+
| `domains` | ```Array<String>``` | The domain names the ApiApp will be associated with. | |
|
12
|
+
| `name` | ```String``` | The name you want to assign to the ApiApp. | |
|
13
|
+
| `oauth` | [```SubOAuth```](SubOAuth.md) | | |
|
14
|
+
| `options` | [```SubOptions```](SubOptions.md) | | |
|
15
|
+
| `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | |
|
16
|
+
|
@@ -0,0 +1,155 @@
|
|
1
|
+
# HelloSign::BulkSendJobApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.hellosign.com/v3*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [`bulk_send_job_get`](BulkSendJobApi.md#bulk_send_job_get) | **GET** `/bulk_send_job/{bulk_send_job_id}` | Get Bulk Send Job |
|
8
|
+
| [`bulk_send_job_list`](BulkSendJobApi.md#bulk_send_job_list) | **GET** `/bulk_send_job/list` | List Bulk Send Jobs |
|
9
|
+
|
10
|
+
|
11
|
+
## `bulk_send_job_get`
|
12
|
+
|
13
|
+
> `<BulkSendJobGetResponse> bulk_send_job_get(bulk_send_job_id)`
|
14
|
+
|
15
|
+
Get Bulk Send Job
|
16
|
+
|
17
|
+
Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require "hellosign-ruby-sdk"
|
23
|
+
|
24
|
+
HelloSign.configure do |config|
|
25
|
+
# Configure HTTP basic authorization: api_key
|
26
|
+
config.username = "YOUR_API_KEY"
|
27
|
+
|
28
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
29
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
30
|
+
end
|
31
|
+
|
32
|
+
api = HelloSign::BulkSendJobApi.new
|
33
|
+
|
34
|
+
bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"
|
35
|
+
|
36
|
+
begin
|
37
|
+
result = api.bulk_send_job_get(bulk_send_job_id)
|
38
|
+
p result
|
39
|
+
rescue HelloSign::ApiError => e
|
40
|
+
puts "Exception when calling HelloSign API: #{e}"
|
41
|
+
end
|
42
|
+
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the `bulk_send_job_get_with_http_info` variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> `<Array(<BulkSendJobGetResponse>, Integer, Hash)> bulk_send_job_get_with_http_info(bulk_send_job_id)`
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# Get Bulk Send Job
|
54
|
+
data, status_code, headers = api_instance.bulk_send_job_get_with_http_info(bulk_send_job_id)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <BulkSendJobGetResponse>
|
58
|
+
rescue HelloSign::ApiError => e
|
59
|
+
puts "Error when calling BulkSendJobApi->bulk_send_job_get_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| `bulk_send_job_id` | **String** | The id of the BulkSendJob to retrieve. | |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**BulkSendJobGetResponse**](BulkSendJobGetResponse.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: Not defined
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## `bulk_send_job_list`
|
84
|
+
|
85
|
+
> `<BulkSendJobListResponse> bulk_send_job_list(opts)`
|
86
|
+
|
87
|
+
List Bulk Send Jobs
|
88
|
+
|
89
|
+
Returns a list of BulkSendJob that you can access.
|
90
|
+
|
91
|
+
### Examples
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
require "hellosign-ruby-sdk"
|
95
|
+
|
96
|
+
HelloSign.configure do |config|
|
97
|
+
# Configure HTTP basic authorization: api_key
|
98
|
+
config.username = "YOUR_API_KEY"
|
99
|
+
|
100
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
101
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
102
|
+
end
|
103
|
+
|
104
|
+
api = HelloSign::BulkSendJobApi.new
|
105
|
+
|
106
|
+
page = 1
|
107
|
+
page_size = 20
|
108
|
+
|
109
|
+
begin
|
110
|
+
result = api.bulk_send_job_list({page: page, page_size: page_size})
|
111
|
+
p result
|
112
|
+
rescue HelloSign::ApiError => e
|
113
|
+
puts "Exception when calling HelloSign API: #{e}"
|
114
|
+
end
|
115
|
+
|
116
|
+
```
|
117
|
+
|
118
|
+
#### Using the `bulk_send_job_list_with_http_info` variant
|
119
|
+
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
121
|
+
|
122
|
+
> `<Array(<BulkSendJobListResponse>, Integer, Hash)> bulk_send_job_list_with_http_info(opts)`
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
begin
|
126
|
+
# List Bulk Send Jobs
|
127
|
+
data, status_code, headers = api_instance.bulk_send_job_list_with_http_info(opts)
|
128
|
+
p status_code # => 2xx
|
129
|
+
p headers # => { ... }
|
130
|
+
p data # => <BulkSendJobListResponse>
|
131
|
+
rescue HelloSign::ApiError => e
|
132
|
+
puts "Error when calling BulkSendJobApi->bulk_send_job_list_with_http_info: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
| Name | Type | Description | Notes |
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
140
|
+
| `page` | **Integer** | Which page number of the BulkSendJob List to return. Defaults to `1`. | [optional][default to 1] |
|
141
|
+
| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional][default to 20] |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**BulkSendJobListResponse**](BulkSendJobListResponse.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|