Skip to content
BranchesTags

Repository files navigation

dropbox-sign

Dropbox::Sign - the Ruby gem for the Dropbox Sign API

Dropbox Sign v3 API

Migrating from legacy SDK

This SDK is generated from our officially maintained OpenAPI spec. We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK. However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK. Please refer to this migration guide for more information.

Contributing

This repo is no longer accepting new issues or Pull Requests. All issues or Pull Requests must be opened against the hellosign/hellosign-openapi repo!

Changes to the SDK code

You must make SDK code changes in the mustache file within the templates directory that corresponds to the file you want updated.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.0
  • Package version: 1.12.0
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Install gem

gem install dropbox-sign

Build a gem

To build the Ruby code into a gem:

gem build dropbox-sign.gemspec

Then install the gem locally:

gem install ./dropbox-sign-1.12.0.gem

(for development, run gem install --dev ./dropbox-sign-1.12.0.gem to install the development dependencies)

Finally add this to the Gemfile:

gem 'dropbox-sign', '~> 1.12.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'dropbox-sign', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

require"json"require"dropbox-sign"Dropbox::Sign.configuredo |config|
config.username="YOUR_API_KEY"# config.access_token = "YOUR_ACCESS_TOKEN"endaccount_create_request=Dropbox::Sign::AccountCreateRequest.newaccount_create_request.email_address="newuser@dropboxsign.com"beginresponse=Dropbox::Sign::AccountApi.new.account_create(account_create_request,)presponserescueDropbox::Sign::ApiError=>eputs"Exception when calling AccountApi#account_create: #{e}"end

Documentation for API Endpoints

All URIs are relative to https://api.hellosign.com/v3

ClassMethodHTTP requestDescription
Dropbox::Sign::AccountApiaccount_createPOST /account/createCreate Account
Dropbox::Sign::AccountApiaccount_getGET /accountGet Account
Dropbox::Sign::AccountApiaccount_updatePUT /accountUpdate Account
Dropbox::Sign::AccountApiaccount_verifyPOST /account/verifyVerify Account
Dropbox::Sign::ApiAppApiapi_app_createPOST /api_appCreate API App
Dropbox::Sign::ApiAppApiapi_app_deleteDELETE /api_app/{client_id}Delete API App
Dropbox::Sign::ApiAppApiapi_app_getGET /api_app/{client_id}Get API App
Dropbox::Sign::ApiAppApiapi_app_listGET /api_app/listList API Apps
Dropbox::Sign::ApiAppApiapi_app_updatePUT /api_app/{client_id}Update API App
Dropbox::Sign::BulkSendJobApibulk_send_job_getGET /bulk_send_job/{bulk_send_job_id}Get Bulk Send Job
Dropbox::Sign::BulkSendJobApibulk_send_job_listGET /bulk_send_job/listList Bulk Send Jobs
Dropbox::Sign::EmbeddedApiembedded_edit_urlPOST /embedded/edit_url/{template_id}Get Embedded Template Edit URL
Dropbox::Sign::EmbeddedApiembedded_sign_urlGET /embedded/sign_url/{signature_id}Get Embedded Sign URL
Dropbox::Sign::FaxApifax_deleteDELETE /fax/{fax_id}Delete Fax
Dropbox::Sign::FaxApifax_filesGET /fax/files/{fax_id}Download Fax Files
Dropbox::Sign::FaxApifax_getGET /fax/{fax_id}Get Fax
Dropbox::Sign::FaxApifax_listGET /fax/listLists Faxes
Dropbox::Sign::FaxApifax_sendPOST /fax/sendSend Fax
Dropbox::Sign::FaxLineApifax_line_add_userPUT /fax_line/add_userAdd Fax Line User
Dropbox::Sign::FaxLineApifax_line_area_code_getGET /fax_line/area_codesGet Available Fax Line Area Codes
Dropbox::Sign::FaxLineApifax_line_createPOST /fax_line/createPurchase Fax Line
Dropbox::Sign::FaxLineApifax_line_deleteDELETE /fax_lineDelete Fax Line
Dropbox::Sign::FaxLineApifax_line_getGET /fax_lineGet Fax Line
Dropbox::Sign::FaxLineApifax_line_listGET /fax_line/listList Fax Lines
Dropbox::Sign::FaxLineApifax_line_remove_userPUT /fax_line/remove_userRemove Fax Line Access
Dropbox::Sign::OAuthApioauth_token_generatePOST /oauth/tokenOAuth Token Generate
Dropbox::Sign::OAuthApioauth_token_refreshPOST /oauth/token?refreshOAuth Token Refresh
Dropbox::Sign::ReportApireport_createPOST /report/createCreate Report
Dropbox::Sign::SignatureRequestApisignature_request_bulk_create_embedded_with_templatePOST /signature_request/bulk_create_embedded_with_templateEmbedded Bulk Send with Template
Dropbox::Sign::SignatureRequestApisignature_request_bulk_send_with_templatePOST /signature_request/bulk_send_with_templateBulk Send with Template
Dropbox::Sign::SignatureRequestApisignature_request_cancelPOST /signature_request/cancel/{signature_request_id}Cancel Incomplete Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_create_embeddedPOST /signature_request/create_embeddedCreate Embedded Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_create_embedded_with_templatePOST /signature_request/create_embedded_with_templateCreate Embedded Signature Request with Template
Dropbox::Sign::SignatureRequestApisignature_request_editPUT /signature_request/edit/{signature_request_id}Edit Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_edit_embeddedPUT /signature_request/edit_embedded/{signature_request_id}Edit Embedded Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_edit_embedded_with_templatePUT /signature_request/edit_embedded_with_template/{signature_request_id}Edit Embedded Signature Request with Template
Dropbox::Sign::SignatureRequestApisignature_request_edit_with_templatePUT /signature_request/edit_with_template/{signature_request_id}Edit Signature Request With Template
Dropbox::Sign::SignatureRequestApisignature_request_filesGET /signature_request/files/{signature_request_id}Download Files
Dropbox::Sign::SignatureRequestApisignature_request_files_as_data_uriGET /signature_request/files_as_data_uri/{signature_request_id}Download Files as Data Uri
Dropbox::Sign::SignatureRequestApisignature_request_files_as_file_urlGET /signature_request/files_as_file_url/{signature_request_id}Download Files as File Url
Dropbox::Sign::SignatureRequestApisignature_request_getGET /signature_request/{signature_request_id}Get Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_listGET /signature_request/listList Signature Requests
Dropbox::Sign::SignatureRequestApisignature_request_release_holdPOST /signature_request/release_hold/{signature_request_id}Release On-Hold Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_remindPOST /signature_request/remind/{signature_request_id}Send Request Reminder
Dropbox::Sign::SignatureRequestApisignature_request_removePOST /signature_request/remove/{signature_request_id}Remove Signature Request Access
Dropbox::Sign::SignatureRequestApisignature_request_sendPOST /signature_request/sendSend Signature Request
Dropbox::Sign::SignatureRequestApisignature_request_send_with_templatePOST /signature_request/send_with_templateSend with Template
Dropbox::Sign::SignatureRequestApisignature_request_updatePOST /signature_request/update/{signature_request_id}Update Signature Request
Dropbox::Sign::TeamApiteam_add_memberPUT /team/add_memberAdd User to Team
Dropbox::Sign::TeamApiteam_createPOST /team/createCreate Team
Dropbox::Sign::TeamApiteam_deleteDELETE /team/destroyDelete Team
Dropbox::Sign::TeamApiteam_getGET /teamGet Team
Dropbox::Sign::TeamApiteam_infoGET /team/infoGet Team Info
Dropbox::Sign::TeamApiteam_invitesGET /team/invitesList Team Invites
Dropbox::Sign::TeamApiteam_membersGET /team/members/{team_id}List Team Members
Dropbox::Sign::TeamApiteam_remove_memberPOST /team/remove_memberRemove User from Team
Dropbox::Sign::TeamApiteam_sub_teamsGET /team/sub_teams/{team_id}List Sub Teams
Dropbox::Sign::TeamApiteam_updatePUT /teamUpdate Team
Dropbox::Sign::TemplateApitemplate_add_userPOST /template/add_user/{template_id}Add User to Template
Dropbox::Sign::TemplateApitemplate_createPOST /template/createCreate Template
Dropbox::Sign::TemplateApitemplate_create_embedded_draftPOST /template/create_embedded_draftCreate Embedded Template Draft
Dropbox::Sign::TemplateApitemplate_deletePOST /template/delete/{template_id}Delete Template
Dropbox::Sign::TemplateApitemplate_filesGET /template/files/{template_id}Get Template Files
Dropbox::Sign::TemplateApitemplate_files_as_data_uriGET /template/files_as_data_uri/{template_id}Get Template Files as Data Uri
Dropbox::Sign::TemplateApitemplate_files_as_file_urlGET /template/files_as_file_url/{template_id}Get Template Files as File Url
Dropbox::Sign::TemplateApitemplate_getGET /template/{template_id}Get Template
Dropbox::Sign::TemplateApitemplate_listGET /template/listList Templates
Dropbox::Sign::TemplateApitemplate_remove_userPOST /template/remove_user/{template_id}Remove User from Template
Dropbox::Sign::TemplateApitemplate_update_filesPOST /template/update_files/{template_id}Update Template Files
Dropbox::Sign::UnclaimedDraftApiunclaimed_draft_createPOST /unclaimed_draft/createCreate Unclaimed Draft
Dropbox::Sign::UnclaimedDraftApiunclaimed_draft_create_embeddedPOST /unclaimed_draft/create_embeddedCreate Embedded Unclaimed Draft
Dropbox::Sign::UnclaimedDraftApiunclaimed_draft_create_embedded_with_templatePOST /unclaimed_draft/create_embedded_with_templateCreate Embedded Unclaimed Draft with Template
Dropbox::Sign::UnclaimedDraftApiunclaimed_draft_edit_and_resendPOST /unclaimed_draft/edit_and_resend/{signature_request_id}Edit and Resend Unclaimed Draft

Documentation for Models

Documentation for Authorization

api_key

  • Type: HTTP basic authentication

oauth2

  • Type: Bearer authentication (JWT)

About

Official Ruby SDK for the Dropbox Sign API

rubygems.org/gems/dropbox-sign

Topics

dropboxdropbox-signhellosignhellosign-apiopenapi

Resources

Readme
MIT license
Activity
Custom properties

Stars

4 stars

Watchers

5 watching

Forks

1 fork
Report repository

Releases

Used by

Contributors

Languages