dropbox-sign 1.0.0.pre.beta2301
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +10 -0
- data/Gemfile.lock +78 -0
- data/LICENSE +21 -0
- data/README.md +333 -0
- data/Rakefile +10 -0
- data/bin/generate-examples.php +269 -0
- data/bin/php +16 -0
- data/bin/replace +11 -0
- data/bin/ruby +16 -0
- data/bin/scan_for +32 -0
- data/composer.json +10 -0
- data/composer.lock +246 -0
- data/docs/AccountApi.md +301 -0
- data/docs/AccountCreateRequest.md +13 -0
- data/docs/AccountCreateResponse.md +12 -0
- data/docs/AccountGetResponse.md +11 -0
- data/docs/AccountResponse.md +19 -0
- data/docs/AccountResponseQuotas.md +14 -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 +33 -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/EventCallbackRequest.md +13 -0
- data/docs/EventCallbackRequestEvent.md +13 -0
- data/docs/EventCallbackRequestEventMetadata.md +13 -0
- data/docs/FileResponse.md +11 -0
- data/docs/FileResponseDataUri.md +10 -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 +1377 -0
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestCreateEmbeddedRequest.md +33 -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 +32 -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/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 +28 -0
- data/docs/SignatureRequestSendRequest.md +34 -0
- data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
- data/docs/SignatureRequestUpdateRequest.md +13 -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/SubSignatureRequestGroupedSigners.md +12 -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 +737 -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/TeamInviteResponse.md +15 -0
- data/docs/TeamInvitesResponse.md +11 -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 +782 -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 +45 -0
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
- data/docs/UnclaimedDraftCreateRequest.md +33 -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/dropbox-sign.gemspec +38 -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/EventCallback.rb +32 -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/SignatureRequestFilesAsDataUri.rb +20 -0
- data/examples/SignatureRequestFilesAsFileUrl.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/TeamInvites.rb +20 -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/TemplateFilesAsDataUri.rb +20 -0
- data/examples/TemplateFilesAsFileUrl.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/lib/dropbox-sign/api/account_api.rb +446 -0
- data/lib/dropbox-sign/api/api_app_api.rb +504 -0
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +213 -0
- data/lib/dropbox-sign/api/embedded_api.rb +234 -0
- data/lib/dropbox-sign/api/o_auth_api.rb +215 -0
- data/lib/dropbox-sign/api/report_api.rb +134 -0
- data/lib/dropbox-sign/api/signature_request_api.rb +1620 -0
- data/lib/dropbox-sign/api/team_api.rb +1011 -0
- data/lib/dropbox-sign/api/template_api.rb +1037 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +467 -0
- data/lib/dropbox-sign/api_client.rb +417 -0
- data/lib/dropbox-sign/api_error.rb +60 -0
- data/lib/dropbox-sign/configuration.rb +303 -0
- data/lib/dropbox-sign/event_callback_helper.rb +54 -0
- data/lib/dropbox-sign/models/account_create_request.rb +285 -0
- data/lib/dropbox-sign/models/account_create_response.rb +270 -0
- data/lib/dropbox-sign/models/account_get_response.rb +261 -0
- data/lib/dropbox-sign/models/account_response.rb +343 -0
- data/lib/dropbox-sign/models/account_response_quotas.rb +296 -0
- data/lib/dropbox-sign/models/account_update_request.rb +271 -0
- data/lib/dropbox-sign/models/account_verify_request.rb +255 -0
- data/lib/dropbox-sign/models/account_verify_response.rb +261 -0
- data/lib/dropbox-sign/models/account_verify_response_account.rb +250 -0
- data/lib/dropbox-sign/models/api_app_create_request.rb +347 -0
- data/lib/dropbox-sign/models/api_app_get_response.rb +261 -0
- data/lib/dropbox-sign/models/api_app_list_response.rb +273 -0
- data/lib/dropbox-sign/models/api_app_response.rb +343 -0
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +283 -0
- data/lib/dropbox-sign/models/api_app_response_options.rb +251 -0
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +261 -0
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +367 -0
- data/lib/dropbox-sign/models/api_app_update_request.rb +324 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +282 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +503 -0
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +273 -0
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +282 -0
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +357 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +261 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +261 -0
- data/lib/dropbox-sign/models/error_response.rb +254 -0
- data/lib/dropbox-sign/models/error_response_error.rb +281 -0
- data/lib/dropbox-sign/models/event_callback_request.rb +281 -0
- data/lib/dropbox-sign/models/event_callback_request_event.rb +334 -0
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +285 -0
- data/lib/dropbox-sign/models/file_response.rb +260 -0
- data/lib/dropbox-sign/models/file_response_data_uri.rb +250 -0
- data/lib/dropbox-sign/models/list_info_response.rb +282 -0
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +317 -0
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +272 -0
- data/lib/dropbox-sign/models/o_auth_token_response.rb +287 -0
- data/lib/dropbox-sign/models/report_create_request.rb +319 -0
- data/lib/dropbox-sign/models/report_create_response.rb +261 -0
- data/lib/dropbox-sign/models/report_response.rb +305 -0
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +440 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +569 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +475 -0
- data/lib/dropbox-sign/models/signature_request_get_response.rb +261 -0
- data/lib/dropbox-sign/models/signature_request_list_response.rb +273 -0
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +265 -0
- data/lib/dropbox-sign/models/signature_request_response.rb +494 -0
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +323 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +316 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +272 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +272 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +40 -0
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +326 -0
- data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +47 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +446 -0
- data/lib/dropbox-sign/models/signature_request_send_request.rb +574 -0
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +480 -0
- data/lib/dropbox-sign/models/signature_request_update_request.rb +286 -0
- data/lib/dropbox-sign/models/sub_attachment.rb +292 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +264 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +270 -0
- data/lib/dropbox-sign/models/sub_cc.rb +270 -0
- data/lib/dropbox-sign/models/sub_custom_field.rb +288 -0
- data/lib/dropbox-sign/models/sub_editor_options.rb +265 -0
- data/lib/dropbox-sign/models/sub_field_options.rb +290 -0
- data/lib/dropbox-sign/models/sub_form_field_group.rb +285 -0
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +353 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +323 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +326 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +435 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +287 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +308 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +292 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +292 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +364 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +48 -0
- data/lib/dropbox-sign/models/sub_merge_field.rb +304 -0
- data/lib/dropbox-sign/models/sub_o_auth.rb +285 -0
- data/lib/dropbox-sign/models/sub_options.rb +253 -0
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +283 -0
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +369 -0
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +373 -0
- data/lib/dropbox-sign/models/sub_signing_options.rb +338 -0
- data/lib/dropbox-sign/models/sub_team_response.rb +260 -0
- data/lib/dropbox-sign/models/sub_template_role.rb +261 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +281 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +285 -0
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +439 -0
- data/lib/dropbox-sign/models/team_add_member_request.rb +304 -0
- data/lib/dropbox-sign/models/team_create_request.rb +252 -0
- data/lib/dropbox-sign/models/team_get_info_response.rb +261 -0
- data/lib/dropbox-sign/models/team_get_response.rb +261 -0
- data/lib/dropbox-sign/models/team_info_response.rb +290 -0
- data/lib/dropbox-sign/models/team_invite_response.rb +300 -0
- data/lib/dropbox-sign/models/team_invites_response.rb +263 -0
- data/lib/dropbox-sign/models/team_member_response.rb +270 -0
- data/lib/dropbox-sign/models/team_members_response.rb +272 -0
- data/lib/dropbox-sign/models/team_parent_response.rb +261 -0
- data/lib/dropbox-sign/models/team_remove_member_request.rb +324 -0
- data/lib/dropbox-sign/models/team_response.rb +274 -0
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +272 -0
- data/lib/dropbox-sign/models/team_update_request.rb +250 -0
- data/lib/dropbox-sign/models/template_add_user_request.rb +272 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +567 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +261 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +283 -0
- data/lib/dropbox-sign/models/template_edit_response.rb +250 -0
- data/lib/dropbox-sign/models/template_get_response.rb +261 -0
- data/lib/dropbox-sign/models/template_list_response.rb +273 -0
- data/lib/dropbox-sign/models/template_remove_user_request.rb +260 -0
- data/lib/dropbox-sign/models/template_response.rb +410 -0
- data/lib/dropbox-sign/models/template_response_account.rb +299 -0
- data/lib/dropbox-sign/models/template_response_account_quota.rb +281 -0
- data/lib/dropbox-sign/models/template_response_cc_role.rb +250 -0
- data/lib/dropbox-sign/models/template_response_custom_field.rb +407 -0
- data/lib/dropbox-sign/models/template_response_document.rb +309 -0
- data/lib/dropbox-sign/models/template_response_document_custom_field.rb +438 -0
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +260 -0
- data/lib/dropbox-sign/models/template_response_document_form_field.rb +417 -0
- data/lib/dropbox-sign/models/template_response_document_static_field.rb +341 -0
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +261 -0
- data/lib/dropbox-sign/models/template_response_named_form_field.rb +383 -0
- data/lib/dropbox-sign/models/template_response_signer_role.rb +260 -0
- data/lib/dropbox-sign/models/template_update_files_request.rb +336 -0
- data/lib/dropbox-sign/models/template_update_files_response.rb +249 -0
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +263 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +728 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +631 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +586 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +261 -0
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +328 -0
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +305 -0
- data/lib/dropbox-sign/models/warning_response.rb +271 -0
- data/lib/dropbox-sign/version.rb +18 -0
- data/lib/dropbox-sign.rb +204 -0
- data/openapi-config.yaml +21 -0
- data/openapi-sdk.yaml +11080 -0
- data/run-build +53 -0
- data/spec/api/account_api_spec.rb +107 -0
- data/spec/api/api_app_api_spec.rb +95 -0
- data/spec/api/bulk_send_job_api_spec.rb +52 -0
- data/spec/api/embedded_api_spec.rb +55 -0
- data/spec/api/oauth_api_spec.rb +55 -0
- data/spec/api/report_api_spec.rb +38 -0
- data/spec/api/signature_request_api_spec.rb +263 -0
- data/spec/api/team_api_spec.rb +105 -0
- data/spec/api/template_api_spec.rb +147 -0
- data/spec/api/unclaimed_draft_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/event_callback_helper_spec.rb +22 -0
- data/spec/fixtures_spec.rb +59 -0
- data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
- data/spec/spec_helper.rb +111 -0
- data/spec/test_utils.rb +19 -0
- data/templates/Gemfile.mustache +10 -0
- data/templates/README.mustache +133 -0
- data/templates/Rakefile.mustache +10 -0
- data/templates/api.mustache +283 -0
- data/templates/api_client.mustache +291 -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 +52 -0
- data/templates/api_info.mustache +12 -0
- data/templates/api_test.mustache +47 -0
- data/templates/base_object.mustache +132 -0
- data/templates/configuration.mustache +372 -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 +46 -0
- data/templates/gem.mustache +55 -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 +29 -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 +414 -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 +10 -0
- data/test_fixtures/AccountCreateRequest.json +7 -0
- data/test_fixtures/AccountCreateResponse.json +15 -0
- data/test_fixtures/AccountGetResponse.json +14 -0
- data/test_fixtures/AccountUpdateRequest.json +5 -0
- data/test_fixtures/AccountVerifyRequest.json +5 -0
- data/test_fixtures/AccountVerifyResponse.json +7 -0
- data/test_fixtures/ApiAppCreateRequest.json +35 -0
- data/test_fixtures/ApiAppGetResponse.json +27 -0
- data/test_fixtures/ApiAppListResponse.json +42 -0
- data/test_fixtures/ApiAppUpdateRequest.json +35 -0
- data/test_fixtures/BulkSendJobGetResponse.json +67 -0
- data/test_fixtures/BulkSendJobListResponse.json +24 -0
- data/test_fixtures/BulkSendJobSendResponse.json +10 -0
- data/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
- data/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
- data/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
- data/test_fixtures/ErrorResponse.json +9 -0
- data/test_fixtures/EventCallbackHelper.json +50 -0
- data/test_fixtures/FileResponse.json +6 -0
- data/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
- data/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
- data/test_fixtures/OAuthTokenResponse.json +15 -0
- data/test_fixtures/ReportCreateRequest.json +10 -0
- data/test_fixtures/ReportCreateResponse.json +13 -0
- data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +67 -0
- data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +66 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +252 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +60 -0
- data/test_fixtures/SignatureRequestGetResponse.json +146 -0
- data/test_fixtures/SignatureRequestListResponse.json +102 -0
- data/test_fixtures/SignatureRequestRemindRequest.json +5 -0
- data/test_fixtures/SignatureRequestSendRequest.json +463 -0
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
- data/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +107 -0
- data/test_fixtures/TeamAddMemberRequest.json +6 -0
- data/test_fixtures/TeamCreateRequest.json +5 -0
- data/test_fixtures/TeamGetResponse.json +34 -0
- data/test_fixtures/TeamRemoveMemberRequest.json +7 -0
- data/test_fixtures/TeamUpdateRequest.json +5 -0
- data/test_fixtures/TemplateAddUserRequest.json +7 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +118 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
- data/test_fixtures/TemplateGetResponse.json +102 -0
- data/test_fixtures/TemplateListResponse.json +143 -0
- data/test_fixtures/TemplateRemoveUserRequest.json +6 -0
- data/test_fixtures/TemplateUpdateFilesRequest.json +11 -0
- data/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +134 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +67 -0
- data/test_fixtures/UnclaimedDraftCreateRequest.json +119 -0
- data/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
- data/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
- data/test_fixtures/bulk-send-sample.csv +3 -0
- data/test_fixtures/pdf-sample-2.pdf +0 -0
- data/test_fixtures/pdf-sample.pdf +0 -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 +650 -0
@@ -0,0 +1,213 @@
|
|
1
|
+
=begin
|
2
|
+
#Dropbox Sign API
|
3
|
+
|
4
|
+
#Dropbox Sign v3 API
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 3.0.0
|
7
|
+
Contact: apisupport@hellosign.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Dropbox
|
16
|
+
end
|
17
|
+
|
18
|
+
module Dropbox::Sign
|
19
|
+
class BulkSendJobApi
|
20
|
+
attr_accessor :api_client
|
21
|
+
|
22
|
+
def initialize(api_client = ApiClient.default)
|
23
|
+
@api_client = api_client
|
24
|
+
end
|
25
|
+
# Get Bulk Send Job
|
26
|
+
# Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
|
27
|
+
# @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
|
28
|
+
# @param [Hash] opts the optional parameters
|
29
|
+
# @return [BulkSendJobGetResponse]
|
30
|
+
def bulk_send_job_get(bulk_send_job_id, opts = {})
|
31
|
+
data, _status_code, _headers = bulk_send_job_get_with_http_info(bulk_send_job_id, opts)
|
32
|
+
data
|
33
|
+
end
|
34
|
+
|
35
|
+
# Get Bulk Send Job
|
36
|
+
# Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
|
37
|
+
# @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(BulkSendJobGetResponse, Integer, Hash)>] BulkSendJobGetResponse data, response status code and response headers
|
40
|
+
def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug 'Calling API: BulkSendJobApi.bulk_send_job_get ...'
|
43
|
+
end
|
44
|
+
# verify the required parameter 'bulk_send_job_id' is set
|
45
|
+
if @api_client.config.client_side_validation && bulk_send_job_id.nil?
|
46
|
+
fail ArgumentError, "Missing the required parameter 'bulk_send_job_id' when calling BulkSendJobApi.bulk_send_job_get"
|
47
|
+
end
|
48
|
+
# resource path
|
49
|
+
local_var_path = '/bulk_send_job/{bulk_send_job_id}'.sub('{' + 'bulk_send_job_id' + '}', CGI.escape(bulk_send_job_id.to_s))
|
50
|
+
|
51
|
+
# query parameters
|
52
|
+
query_params = opts[:query_params] || {}
|
53
|
+
|
54
|
+
# header parameters
|
55
|
+
header_params = opts[:header_params] || {}
|
56
|
+
# HTTP header 'Accept' (if needed)
|
57
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
58
|
+
|
59
|
+
post_body = {}
|
60
|
+
form_params = opts[:form_params] || {}
|
61
|
+
|
62
|
+
# http body (model)
|
63
|
+
post_body = opts[:debug_body]
|
64
|
+
|
65
|
+
# return_type
|
66
|
+
return_type = opts[:debug_return_type] || 'BulkSendJobGetResponse'
|
67
|
+
|
68
|
+
# auth_names
|
69
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
70
|
+
|
71
|
+
new_options = opts.merge(
|
72
|
+
:operation => :"BulkSendJobApi.bulk_send_job_get",
|
73
|
+
:header_params => header_params,
|
74
|
+
:query_params => query_params,
|
75
|
+
:form_params => form_params,
|
76
|
+
:body => post_body,
|
77
|
+
:auth_names => auth_names,
|
78
|
+
:return_type => return_type
|
79
|
+
)
|
80
|
+
|
81
|
+
begin
|
82
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
83
|
+
rescue Dropbox::Sign::ApiError => e
|
84
|
+
if e.code === 200
|
85
|
+
body = @api_client.convert_to_type(
|
86
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
87
|
+
"Dropbox::Sign::BulkSendJobGetResponse"
|
88
|
+
)
|
89
|
+
|
90
|
+
fail ApiError.new(:code => e.code,
|
91
|
+
:response_headers => e.response_headers,
|
92
|
+
:response_body => body),
|
93
|
+
e.message
|
94
|
+
end
|
95
|
+
|
96
|
+
range_code = "4XX".split('').first
|
97
|
+
range_code_left = "#{range_code}00".to_i
|
98
|
+
range_code_right = "#{range_code}99".to_i
|
99
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
100
|
+
body = @api_client.convert_to_type(
|
101
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
102
|
+
"Dropbox::Sign::ErrorResponse"
|
103
|
+
)
|
104
|
+
|
105
|
+
fail ApiError.new(:code => e.code,
|
106
|
+
:response_headers => e.response_headers,
|
107
|
+
:response_body => body),
|
108
|
+
e.message
|
109
|
+
end
|
110
|
+
|
111
|
+
end
|
112
|
+
|
113
|
+
if @api_client.config.debugging
|
114
|
+
@api_client.config.logger.debug "API called: BulkSendJobApi#bulk_send_job_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
115
|
+
end
|
116
|
+
return data, status_code, headers
|
117
|
+
end
|
118
|
+
|
119
|
+
# List Bulk Send Jobs
|
120
|
+
# Returns a list of BulkSendJob that you can access.
|
121
|
+
# @param [Hash] opts the optional parameters
|
122
|
+
# @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to `1`. (default to 1)
|
123
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20)
|
124
|
+
# @return [BulkSendJobListResponse]
|
125
|
+
def bulk_send_job_list(opts = {})
|
126
|
+
data, _status_code, _headers = bulk_send_job_list_with_http_info(opts)
|
127
|
+
data
|
128
|
+
end
|
129
|
+
|
130
|
+
# List Bulk Send Jobs
|
131
|
+
# Returns a list of BulkSendJob that you can access.
|
132
|
+
# @param [Hash] opts the optional parameters
|
133
|
+
# @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to `1`.
|
134
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.
|
135
|
+
# @return [Array<(BulkSendJobListResponse, Integer, Hash)>] BulkSendJobListResponse data, response status code and response headers
|
136
|
+
def bulk_send_job_list_with_http_info(opts = {})
|
137
|
+
if @api_client.config.debugging
|
138
|
+
@api_client.config.logger.debug 'Calling API: BulkSendJobApi.bulk_send_job_list ...'
|
139
|
+
end
|
140
|
+
# resource path
|
141
|
+
local_var_path = '/bulk_send_job/list'
|
142
|
+
|
143
|
+
# query parameters
|
144
|
+
query_params = opts[:query_params] || {}
|
145
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
146
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
147
|
+
|
148
|
+
# header parameters
|
149
|
+
header_params = opts[:header_params] || {}
|
150
|
+
# HTTP header 'Accept' (if needed)
|
151
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
152
|
+
|
153
|
+
post_body = {}
|
154
|
+
form_params = opts[:form_params] || {}
|
155
|
+
|
156
|
+
# http body (model)
|
157
|
+
post_body = opts[:debug_body]
|
158
|
+
|
159
|
+
# return_type
|
160
|
+
return_type = opts[:debug_return_type] || 'BulkSendJobListResponse'
|
161
|
+
|
162
|
+
# auth_names
|
163
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
164
|
+
|
165
|
+
new_options = opts.merge(
|
166
|
+
:operation => :"BulkSendJobApi.bulk_send_job_list",
|
167
|
+
:header_params => header_params,
|
168
|
+
:query_params => query_params,
|
169
|
+
:form_params => form_params,
|
170
|
+
:body => post_body,
|
171
|
+
:auth_names => auth_names,
|
172
|
+
:return_type => return_type
|
173
|
+
)
|
174
|
+
|
175
|
+
begin
|
176
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
177
|
+
rescue Dropbox::Sign::ApiError => e
|
178
|
+
if e.code === 200
|
179
|
+
body = @api_client.convert_to_type(
|
180
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
181
|
+
"Dropbox::Sign::BulkSendJobListResponse"
|
182
|
+
)
|
183
|
+
|
184
|
+
fail ApiError.new(:code => e.code,
|
185
|
+
:response_headers => e.response_headers,
|
186
|
+
:response_body => body),
|
187
|
+
e.message
|
188
|
+
end
|
189
|
+
|
190
|
+
range_code = "4XX".split('').first
|
191
|
+
range_code_left = "#{range_code}00".to_i
|
192
|
+
range_code_right = "#{range_code}99".to_i
|
193
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
194
|
+
body = @api_client.convert_to_type(
|
195
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
196
|
+
"Dropbox::Sign::ErrorResponse"
|
197
|
+
)
|
198
|
+
|
199
|
+
fail ApiError.new(:code => e.code,
|
200
|
+
:response_headers => e.response_headers,
|
201
|
+
:response_body => body),
|
202
|
+
e.message
|
203
|
+
end
|
204
|
+
|
205
|
+
end
|
206
|
+
|
207
|
+
if @api_client.config.debugging
|
208
|
+
@api_client.config.logger.debug "API called: BulkSendJobApi#bulk_send_job_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
209
|
+
end
|
210
|
+
return data, status_code, headers
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
@@ -0,0 +1,234 @@
|
|
1
|
+
=begin
|
2
|
+
#Dropbox Sign API
|
3
|
+
|
4
|
+
#Dropbox Sign v3 API
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 3.0.0
|
7
|
+
Contact: apisupport@hellosign.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Dropbox
|
16
|
+
end
|
17
|
+
|
18
|
+
module Dropbox::Sign
|
19
|
+
class EmbeddedApi
|
20
|
+
attr_accessor :api_client
|
21
|
+
|
22
|
+
def initialize(api_client = ApiClient.default)
|
23
|
+
@api_client = api_client
|
24
|
+
end
|
25
|
+
# Get Embedded Template Edit URL
|
26
|
+
# Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
|
27
|
+
# @param template_id [String] The id of the template to edit.
|
28
|
+
# @param embedded_edit_url_request [EmbeddedEditUrlRequest]
|
29
|
+
# @param [Hash] opts the optional parameters
|
30
|
+
# @return [EmbeddedEditUrlResponse]
|
31
|
+
def embedded_edit_url(template_id, embedded_edit_url_request, opts = {})
|
32
|
+
data, _status_code, _headers = embedded_edit_url_with_http_info(template_id, embedded_edit_url_request, opts)
|
33
|
+
data
|
34
|
+
end
|
35
|
+
|
36
|
+
# Get Embedded Template Edit URL
|
37
|
+
# Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
|
38
|
+
# @param template_id [String] The id of the template to edit.
|
39
|
+
# @param embedded_edit_url_request [EmbeddedEditUrlRequest]
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Array<(EmbeddedEditUrlResponse, Integer, Hash)>] EmbeddedEditUrlResponse data, response status code and response headers
|
42
|
+
def embedded_edit_url_with_http_info(template_id, embedded_edit_url_request, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug 'Calling API: EmbeddedApi.embedded_edit_url ...'
|
45
|
+
end
|
46
|
+
# verify the required parameter 'template_id' is set
|
47
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
48
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling EmbeddedApi.embedded_edit_url"
|
49
|
+
end
|
50
|
+
# verify the required parameter 'embedded_edit_url_request' is set
|
51
|
+
if @api_client.config.client_side_validation && embedded_edit_url_request.nil?
|
52
|
+
fail ArgumentError, "Missing the required parameter 'embedded_edit_url_request' when calling EmbeddedApi.embedded_edit_url"
|
53
|
+
end
|
54
|
+
# resource path
|
55
|
+
local_var_path = '/embedded/edit_url/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
|
56
|
+
|
57
|
+
# query parameters
|
58
|
+
query_params = opts[:query_params] || {}
|
59
|
+
|
60
|
+
# header parameters
|
61
|
+
header_params = opts[:header_params] || {}
|
62
|
+
# HTTP header 'Accept' (if needed)
|
63
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
64
|
+
# HTTP header 'Content-Type'
|
65
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
66
|
+
if !content_type.nil?
|
67
|
+
header_params['Content-Type'] = content_type
|
68
|
+
end
|
69
|
+
|
70
|
+
post_body = {}
|
71
|
+
form_params = opts[:form_params] || {}
|
72
|
+
result = @api_client.generate_form_data(
|
73
|
+
embedded_edit_url_request,
|
74
|
+
Dropbox::Sign::EmbeddedEditUrlRequest.openapi_types
|
75
|
+
)
|
76
|
+
|
77
|
+
# form parameters
|
78
|
+
if result[:has_file]
|
79
|
+
form_params = opts[:form_params] || result[:params]
|
80
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
81
|
+
else
|
82
|
+
# http body (model)
|
83
|
+
post_body = opts[:debug_body] || result[:params]
|
84
|
+
end
|
85
|
+
|
86
|
+
# return_type
|
87
|
+
return_type = opts[:debug_return_type] || 'EmbeddedEditUrlResponse'
|
88
|
+
|
89
|
+
# auth_names
|
90
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
91
|
+
|
92
|
+
new_options = opts.merge(
|
93
|
+
:operation => :"EmbeddedApi.embedded_edit_url",
|
94
|
+
:header_params => header_params,
|
95
|
+
:query_params => query_params,
|
96
|
+
:form_params => form_params,
|
97
|
+
:body => post_body,
|
98
|
+
:auth_names => auth_names,
|
99
|
+
:return_type => return_type
|
100
|
+
)
|
101
|
+
|
102
|
+
begin
|
103
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
104
|
+
rescue Dropbox::Sign::ApiError => e
|
105
|
+
if e.code === 200
|
106
|
+
body = @api_client.convert_to_type(
|
107
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
108
|
+
"Dropbox::Sign::EmbeddedEditUrlResponse"
|
109
|
+
)
|
110
|
+
|
111
|
+
fail ApiError.new(:code => e.code,
|
112
|
+
:response_headers => e.response_headers,
|
113
|
+
:response_body => body),
|
114
|
+
e.message
|
115
|
+
end
|
116
|
+
|
117
|
+
range_code = "4XX".split('').first
|
118
|
+
range_code_left = "#{range_code}00".to_i
|
119
|
+
range_code_right = "#{range_code}99".to_i
|
120
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
121
|
+
body = @api_client.convert_to_type(
|
122
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
123
|
+
"Dropbox::Sign::ErrorResponse"
|
124
|
+
)
|
125
|
+
|
126
|
+
fail ApiError.new(:code => e.code,
|
127
|
+
:response_headers => e.response_headers,
|
128
|
+
:response_body => body),
|
129
|
+
e.message
|
130
|
+
end
|
131
|
+
|
132
|
+
end
|
133
|
+
|
134
|
+
if @api_client.config.debugging
|
135
|
+
@api_client.config.logger.debug "API called: EmbeddedApi#embedded_edit_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
136
|
+
end
|
137
|
+
return data, status_code, headers
|
138
|
+
end
|
139
|
+
|
140
|
+
# Get Embedded Sign URL
|
141
|
+
# Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
|
142
|
+
# @param signature_id [String] The id of the signature to get a signature url for.
|
143
|
+
# @param [Hash] opts the optional parameters
|
144
|
+
# @return [EmbeddedSignUrlResponse]
|
145
|
+
def embedded_sign_url(signature_id, opts = {})
|
146
|
+
data, _status_code, _headers = embedded_sign_url_with_http_info(signature_id, opts)
|
147
|
+
data
|
148
|
+
end
|
149
|
+
|
150
|
+
# Get Embedded Sign URL
|
151
|
+
# Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
|
152
|
+
# @param signature_id [String] The id of the signature to get a signature url for.
|
153
|
+
# @param [Hash] opts the optional parameters
|
154
|
+
# @return [Array<(EmbeddedSignUrlResponse, Integer, Hash)>] EmbeddedSignUrlResponse data, response status code and response headers
|
155
|
+
def embedded_sign_url_with_http_info(signature_id, opts = {})
|
156
|
+
if @api_client.config.debugging
|
157
|
+
@api_client.config.logger.debug 'Calling API: EmbeddedApi.embedded_sign_url ...'
|
158
|
+
end
|
159
|
+
# verify the required parameter 'signature_id' is set
|
160
|
+
if @api_client.config.client_side_validation && signature_id.nil?
|
161
|
+
fail ArgumentError, "Missing the required parameter 'signature_id' when calling EmbeddedApi.embedded_sign_url"
|
162
|
+
end
|
163
|
+
# resource path
|
164
|
+
local_var_path = '/embedded/sign_url/{signature_id}'.sub('{' + 'signature_id' + '}', CGI.escape(signature_id.to_s))
|
165
|
+
|
166
|
+
# query parameters
|
167
|
+
query_params = opts[:query_params] || {}
|
168
|
+
|
169
|
+
# header parameters
|
170
|
+
header_params = opts[:header_params] || {}
|
171
|
+
# HTTP header 'Accept' (if needed)
|
172
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
173
|
+
|
174
|
+
post_body = {}
|
175
|
+
form_params = opts[:form_params] || {}
|
176
|
+
|
177
|
+
# http body (model)
|
178
|
+
post_body = opts[:debug_body]
|
179
|
+
|
180
|
+
# return_type
|
181
|
+
return_type = opts[:debug_return_type] || 'EmbeddedSignUrlResponse'
|
182
|
+
|
183
|
+
# auth_names
|
184
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
185
|
+
|
186
|
+
new_options = opts.merge(
|
187
|
+
:operation => :"EmbeddedApi.embedded_sign_url",
|
188
|
+
:header_params => header_params,
|
189
|
+
:query_params => query_params,
|
190
|
+
:form_params => form_params,
|
191
|
+
:body => post_body,
|
192
|
+
:auth_names => auth_names,
|
193
|
+
:return_type => return_type
|
194
|
+
)
|
195
|
+
|
196
|
+
begin
|
197
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
198
|
+
rescue Dropbox::Sign::ApiError => e
|
199
|
+
if e.code === 200
|
200
|
+
body = @api_client.convert_to_type(
|
201
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
202
|
+
"Dropbox::Sign::EmbeddedSignUrlResponse"
|
203
|
+
)
|
204
|
+
|
205
|
+
fail ApiError.new(:code => e.code,
|
206
|
+
:response_headers => e.response_headers,
|
207
|
+
:response_body => body),
|
208
|
+
e.message
|
209
|
+
end
|
210
|
+
|
211
|
+
range_code = "4XX".split('').first
|
212
|
+
range_code_left = "#{range_code}00".to_i
|
213
|
+
range_code_right = "#{range_code}99".to_i
|
214
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
215
|
+
body = @api_client.convert_to_type(
|
216
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
217
|
+
"Dropbox::Sign::ErrorResponse"
|
218
|
+
)
|
219
|
+
|
220
|
+
fail ApiError.new(:code => e.code,
|
221
|
+
:response_headers => e.response_headers,
|
222
|
+
:response_body => body),
|
223
|
+
e.message
|
224
|
+
end
|
225
|
+
|
226
|
+
end
|
227
|
+
|
228
|
+
if @api_client.config.debugging
|
229
|
+
@api_client.config.logger.debug "API called: EmbeddedApi#embedded_sign_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
230
|
+
end
|
231
|
+
return data, status_code, headers
|
232
|
+
end
|
233
|
+
end
|
234
|
+
end
|
@@ -0,0 +1,215 @@
|
|
1
|
+
=begin
|
2
|
+
#Dropbox Sign API
|
3
|
+
|
4
|
+
#Dropbox Sign v3 API
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 3.0.0
|
7
|
+
Contact: apisupport@hellosign.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Dropbox
|
16
|
+
end
|
17
|
+
|
18
|
+
module Dropbox::Sign
|
19
|
+
class OAuthApi
|
20
|
+
attr_accessor :api_client
|
21
|
+
|
22
|
+
def initialize(api_client = ApiClient.default)
|
23
|
+
@api_client = api_client
|
24
|
+
end
|
25
|
+
# OAuth Token Generate
|
26
|
+
# Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
|
27
|
+
# @param o_auth_token_generate_request [OAuthTokenGenerateRequest]
|
28
|
+
# @param [Hash] opts the optional parameters
|
29
|
+
# @return [OAuthTokenResponse]
|
30
|
+
def oauth_token_generate(o_auth_token_generate_request, opts = {})
|
31
|
+
data, _status_code, _headers = oauth_token_generate_with_http_info(o_auth_token_generate_request, opts)
|
32
|
+
data
|
33
|
+
end
|
34
|
+
|
35
|
+
# OAuth Token Generate
|
36
|
+
# Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
|
37
|
+
# @param o_auth_token_generate_request [OAuthTokenGenerateRequest]
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers
|
40
|
+
def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug 'Calling API: OAuthApi.oauth_token_generate ...'
|
43
|
+
end
|
44
|
+
# verify the required parameter 'o_auth_token_generate_request' is set
|
45
|
+
if @api_client.config.client_side_validation && o_auth_token_generate_request.nil?
|
46
|
+
fail ArgumentError, "Missing the required parameter 'o_auth_token_generate_request' when calling OAuthApi.oauth_token_generate"
|
47
|
+
end
|
48
|
+
# resource path
|
49
|
+
local_var_path = '/oauth/token'
|
50
|
+
|
51
|
+
# query parameters
|
52
|
+
query_params = opts[:query_params] || {}
|
53
|
+
|
54
|
+
# header parameters
|
55
|
+
header_params = opts[:header_params] || {}
|
56
|
+
# HTTP header 'Accept' (if needed)
|
57
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
58
|
+
# HTTP header 'Content-Type'
|
59
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
60
|
+
if !content_type.nil?
|
61
|
+
header_params['Content-Type'] = content_type
|
62
|
+
end
|
63
|
+
|
64
|
+
post_body = {}
|
65
|
+
form_params = opts[:form_params] || {}
|
66
|
+
result = @api_client.generate_form_data(
|
67
|
+
o_auth_token_generate_request,
|
68
|
+
Dropbox::Sign::OAuthTokenGenerateRequest.openapi_types
|
69
|
+
)
|
70
|
+
|
71
|
+
# form parameters
|
72
|
+
if result[:has_file]
|
73
|
+
form_params = opts[:form_params] || result[:params]
|
74
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
75
|
+
else
|
76
|
+
# http body (model)
|
77
|
+
post_body = opts[:debug_body] || result[:params]
|
78
|
+
end
|
79
|
+
|
80
|
+
# return_type
|
81
|
+
return_type = opts[:debug_return_type] || 'OAuthTokenResponse'
|
82
|
+
|
83
|
+
# auth_names
|
84
|
+
auth_names = opts[:debug_auth_names] || []
|
85
|
+
|
86
|
+
new_options = opts.merge(
|
87
|
+
:operation => :"OAuthApi.oauth_token_generate",
|
88
|
+
:header_params => header_params,
|
89
|
+
:query_params => query_params,
|
90
|
+
:form_params => form_params,
|
91
|
+
:body => post_body,
|
92
|
+
:auth_names => auth_names,
|
93
|
+
:return_type => return_type
|
94
|
+
)
|
95
|
+
|
96
|
+
begin
|
97
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
98
|
+
rescue Dropbox::Sign::ApiError => e
|
99
|
+
if e.code === 200
|
100
|
+
body = @api_client.convert_to_type(
|
101
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
102
|
+
"Dropbox::Sign::OAuthTokenResponse"
|
103
|
+
)
|
104
|
+
|
105
|
+
fail ApiError.new(:code => e.code,
|
106
|
+
:response_headers => e.response_headers,
|
107
|
+
:response_body => body),
|
108
|
+
e.message
|
109
|
+
end
|
110
|
+
|
111
|
+
|
112
|
+
end
|
113
|
+
|
114
|
+
if @api_client.config.debugging
|
115
|
+
@api_client.config.logger.debug "API called: OAuthApi#oauth_token_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
116
|
+
end
|
117
|
+
return data, status_code, headers
|
118
|
+
end
|
119
|
+
|
120
|
+
# OAuth Token Refresh
|
121
|
+
# Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.
|
122
|
+
# @param o_auth_token_refresh_request [OAuthTokenRefreshRequest]
|
123
|
+
# @param [Hash] opts the optional parameters
|
124
|
+
# @return [OAuthTokenResponse]
|
125
|
+
def oauth_token_refresh(o_auth_token_refresh_request, opts = {})
|
126
|
+
data, _status_code, _headers = oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts)
|
127
|
+
data
|
128
|
+
end
|
129
|
+
|
130
|
+
# OAuth Token Refresh
|
131
|
+
# Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.
|
132
|
+
# @param o_auth_token_refresh_request [OAuthTokenRefreshRequest]
|
133
|
+
# @param [Hash] opts the optional parameters
|
134
|
+
# @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers
|
135
|
+
def oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts = {})
|
136
|
+
if @api_client.config.debugging
|
137
|
+
@api_client.config.logger.debug 'Calling API: OAuthApi.oauth_token_refresh ...'
|
138
|
+
end
|
139
|
+
# verify the required parameter 'o_auth_token_refresh_request' is set
|
140
|
+
if @api_client.config.client_side_validation && o_auth_token_refresh_request.nil?
|
141
|
+
fail ArgumentError, "Missing the required parameter 'o_auth_token_refresh_request' when calling OAuthApi.oauth_token_refresh"
|
142
|
+
end
|
143
|
+
# resource path
|
144
|
+
local_var_path = '/oauth/token?refresh'
|
145
|
+
|
146
|
+
# query parameters
|
147
|
+
query_params = opts[:query_params] || {}
|
148
|
+
|
149
|
+
# header parameters
|
150
|
+
header_params = opts[:header_params] || {}
|
151
|
+
# HTTP header 'Accept' (if needed)
|
152
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
153
|
+
# HTTP header 'Content-Type'
|
154
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
155
|
+
if !content_type.nil?
|
156
|
+
header_params['Content-Type'] = content_type
|
157
|
+
end
|
158
|
+
|
159
|
+
post_body = {}
|
160
|
+
form_params = opts[:form_params] || {}
|
161
|
+
result = @api_client.generate_form_data(
|
162
|
+
o_auth_token_refresh_request,
|
163
|
+
Dropbox::Sign::OAuthTokenRefreshRequest.openapi_types
|
164
|
+
)
|
165
|
+
|
166
|
+
# form parameters
|
167
|
+
if result[:has_file]
|
168
|
+
form_params = opts[:form_params] || result[:params]
|
169
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
170
|
+
else
|
171
|
+
# http body (model)
|
172
|
+
post_body = opts[:debug_body] || result[:params]
|
173
|
+
end
|
174
|
+
|
175
|
+
# return_type
|
176
|
+
return_type = opts[:debug_return_type] || 'OAuthTokenResponse'
|
177
|
+
|
178
|
+
# auth_names
|
179
|
+
auth_names = opts[:debug_auth_names] || []
|
180
|
+
|
181
|
+
new_options = opts.merge(
|
182
|
+
:operation => :"OAuthApi.oauth_token_refresh",
|
183
|
+
:header_params => header_params,
|
184
|
+
:query_params => query_params,
|
185
|
+
:form_params => form_params,
|
186
|
+
:body => post_body,
|
187
|
+
:auth_names => auth_names,
|
188
|
+
:return_type => return_type
|
189
|
+
)
|
190
|
+
|
191
|
+
begin
|
192
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
193
|
+
rescue Dropbox::Sign::ApiError => e
|
194
|
+
if e.code === 200
|
195
|
+
body = @api_client.convert_to_type(
|
196
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
197
|
+
"Dropbox::Sign::OAuthTokenResponse"
|
198
|
+
)
|
199
|
+
|
200
|
+
fail ApiError.new(:code => e.code,
|
201
|
+
:response_headers => e.response_headers,
|
202
|
+
:response_body => body),
|
203
|
+
e.message
|
204
|
+
end
|
205
|
+
|
206
|
+
|
207
|
+
end
|
208
|
+
|
209
|
+
if @api_client.config.debugging
|
210
|
+
@api_client.config.logger.debug "API called: OAuthApi#oauth_token_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
211
|
+
end
|
212
|
+
return data, status_code, headers
|
213
|
+
end
|
214
|
+
end
|
215
|
+
end
|