README.md in hellosign-ruby-sdk-3.7.7 vs README.md in hellosign-ruby-sdk-6.0.0.pre.beta

- old
+ new

@@ -1,115 +1,313 @@ -# HelloSign Ruby SDK +# hellosign-ruby-sdk -In addition to this readme, checkout our quickstart guide here: -https://app.hellosign.com/api/documentation#QuickStart +HelloSign - the Ruby gem for the HelloSign API +HelloSign v3 API + +## ⚠ This package is not yet ready for production use ⚠ + +We are working hard on getting this package ready, but it is not there, yet! + +You should think twice before using package on anything critical. + +The interfaces may change without warning. Backwards compatibility is not yet +guaranteed nor implied! + +This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 3.0.0 +- Package version: 6.0.0-beta +- Build package: org.openapitools.codegen.languages.RubyClientCodegen + ## Installation -Add this line to your application's Gemfile: +### Build a gem - gem 'hellosign-ruby-sdk' +To build the Ruby code into a gem: -And then execute: +```shell +gem build hellosign-ruby-sdk.gemspec +``` - $ bundle +Then either install the gem locally: -## Configuration +```shell +gem install ./hellosign-ruby-sdk-6.0.0-beta.gem +``` -Create a config block. At a minimum you'll want to set your [API Key](https://app.hellosign.com/home/myAccount/current_tab/integrations#api) but depending on your usage you'll possibly -want to set your app's [Client ID](https://app.hellosign.com/oauth/createAppForm) and [Client Secret](https://app.hellosign.com/oauth/createAppForm). In Rails you can place it in `config/initializers/hello_sign.rb` +(for development, run `gem install --dev ./hellosign-ruby-sdk-6.0.0-beta.gem` to install the development dependencies) +or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). + +Finally add this to the Gemfile: + + gem 'hellosign-ruby-sdk', '~> 6.0.0-beta' + +### 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 'hellosign-ruby-sdk', :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: + +```shell +ruby -Ilib script.rb +``` + +## Getting Started + +Please follow the [installation](#installation) procedure and then run the following code: + + ```ruby -require 'hello_sign' +require "hellosign-ruby-sdk" + HelloSign.configure do |config| - config.api_key = 'api_key' - # You can use email_address and password instead of api_key. But api_key is recommended - # If api_key, email_address and password are all present, api_key will be used - # config.email_address = 'email_address' - # config.password = 'password' + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" + + # or, configure Bearer (JWT) authorization: oauth2 + # config.access_token = "YOUR_ACCESS_TOKEN" end -``` -## Usage -When you have configured your app like above, you can start using it: +api = HelloSign::AccountApi.new -```ruby -# get your account -my_account = HelloSign.get_account +data = HelloSign::AccountCreateRequest.new +data.email_address = "newuser@hellosign.com" -# get your signature requests -my_signature_requests = HelloSign.get_signature_requests +begin + result = api.account_create(data) + p result +rescue HelloSign::ApiError => e + puts "Exception when calling HelloSign API: #{e}" +end -# view a specific signature request -signature_request = HelloSign.get_signature_request signature_request_id: '42383e7327eda33f4b8b91217cbe95408cc1285f' ``` -If you need to authenticate for multiple users and you want a separated client for them, you can run: -```ruby -client2 = HelloSign::Client.new api_key: 'your_user_api_key' -user_account = client2.get_account -``` -### Specifying files -When using request endpoints that send files, such as a signature request, you can specify files either as -1. A string representing the path -2. A Ruby File Object (File.open, then assign to a variable) -3. A Rails ActionDispatch::Http::UploadedFile +## Documentation for API Endpoints -## Testing +All URIs are relative to *https://api.hellosign.com/v3* -Testing relies on built in hard-coded fixtures. You can run the tests without affecting your actual account data. To do so -from the root of your project run <code>rake spec</code>. +|Class | Method | HTTP request | Description| +|------------ | ------------- | ------------- | -------------| +|*HelloSign::AccountApi* | [**account_create**](docs/AccountApi.md#account_create) | **POST** /account/create | Create Account | +|*HelloSign::AccountApi* | [**account_get**](docs/AccountApi.md#account_get) | **GET** /account | Get Account | +|*HelloSign::AccountApi* | [**account_update**](docs/AccountApi.md#account_update) | **PUT** /account | Update Account | +|*HelloSign::AccountApi* | [**account_verify**](docs/AccountApi.md#account_verify) | **POST** /account/verify | Verify Account | +|*HelloSign::ApiAppApi* | [**api_app_create**](docs/ApiAppApi.md#api_app_create) | **POST** /api_app | Create API App | +|*HelloSign::ApiAppApi* | [**api_app_delete**](docs/ApiAppApi.md#api_app_delete) | **DELETE** /api_app/{client_id} | Delete API App | +|*HelloSign::ApiAppApi* | [**api_app_get**](docs/ApiAppApi.md#api_app_get) | **GET** /api_app/{client_id} | Get API App | +|*HelloSign::ApiAppApi* | [**api_app_list**](docs/ApiAppApi.md#api_app_list) | **GET** /api_app/list | List API Apps | +|*HelloSign::ApiAppApi* | [**api_app_update**](docs/ApiAppApi.md#api_app_update) | **PUT** /api_app/{client_id} | Update API App | +|*HelloSign::BulkSendJobApi* | [**bulk_send_job_get**](docs/BulkSendJobApi.md#bulk_send_job_get) | **GET** /bulk_send_job/{bulk_send_job_id} | Get Bulk Send Job | +|*HelloSign::BulkSendJobApi* | [**bulk_send_job_list**](docs/BulkSendJobApi.md#bulk_send_job_list) | **GET** /bulk_send_job/list | List Bulk Send Jobs | +|*HelloSign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | +|*HelloSign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | +|*HelloSign::OAuthApi* | [**oauth_token_generate**](docs/OAuthApi.md#oauth_token_generate) | **POST** /oauth/token | OAuth Token Generate | +|*HelloSign::OAuthApi* | [**oauth_token_refresh**](docs/OAuthApi.md#oauth_token_refresh) | **POST** /oauth/token?refresh | OAuth Token Refresh | +|*HelloSign::ReportApi* | [**report_create**](docs/ReportApi.md#report_create) | **POST** /report/create | Create Report | +|*HelloSign::SignatureRequestApi* | [**signature_request_bulk_create_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_bulk_create_embedded_with_template) | **POST** /signature_request/bulk_create_embedded_with_template | Embedded Bulk Send with Template | +|*HelloSign::SignatureRequestApi* | [**signature_request_bulk_send_with_template**](docs/SignatureRequestApi.md#signature_request_bulk_send_with_template) | **POST** /signature_request/bulk_send_with_template | Bulk Send with Template | +|*HelloSign::SignatureRequestApi* | [**signature_request_cancel**](docs/SignatureRequestApi.md#signature_request_cancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | +|*HelloSign::SignatureRequestApi* | [**signature_request_create_embedded**](docs/SignatureRequestApi.md#signature_request_create_embedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | +|*HelloSign::SignatureRequestApi* | [**signature_request_create_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +|*HelloSign::SignatureRequestApi* | [**signature_request_files**](docs/SignatureRequestApi.md#signature_request_files) | **GET** /signature_request/files/{signature_request_id} | Download Files | +|*HelloSign::SignatureRequestApi* | [**signature_request_get**](docs/SignatureRequestApi.md#signature_request_get) | **GET** /signature_request/{signature_request_id} | Get Signature Request | +|*HelloSign::SignatureRequestApi* | [**signature_request_list**](docs/SignatureRequestApi.md#signature_request_list) | **GET** /signature_request/list | List Signature Requests | +|*HelloSign::SignatureRequestApi* | [**signature_request_release_hold**](docs/SignatureRequestApi.md#signature_request_release_hold) | **POST** /signature_request/release_hold/{signature_request_id} | Release On-Hold Signature Request | +|*HelloSign::SignatureRequestApi* | [**signature_request_remind**](docs/SignatureRequestApi.md#signature_request_remind) | **POST** /signature_request/remind/{signature_request_id} | Send Request Reminder | +|*HelloSign::SignatureRequestApi* | [**signature_request_remove**](docs/SignatureRequestApi.md#signature_request_remove) | **POST** /signature_request/remove/{signature_request_id} | Remove Signature Request Access | +|*HelloSign::SignatureRequestApi* | [**signature_request_send**](docs/SignatureRequestApi.md#signature_request_send) | **POST** /signature_request/send | Send Signature Request | +|*HelloSign::SignatureRequestApi* | [**signature_request_send_with_template**](docs/SignatureRequestApi.md#signature_request_send_with_template) | **POST** /signature_request/send_with_template | Send with Template | +|*HelloSign::SignatureRequestApi* | [**signature_request_update**](docs/SignatureRequestApi.md#signature_request_update) | **POST** /signature_request/update/{signature_request_id} | Update Signature Request | +|*HelloSign::TeamApi* | [**team_add_member**](docs/TeamApi.md#team_add_member) | **PUT** /team/add_member | Add User to Team | +|*HelloSign::TeamApi* | [**team_create**](docs/TeamApi.md#team_create) | **POST** /team/create | Create Team | +|*HelloSign::TeamApi* | [**team_delete**](docs/TeamApi.md#team_delete) | **DELETE** /team/destroy | Delete Team | +|*HelloSign::TeamApi* | [**team_get**](docs/TeamApi.md#team_get) | **GET** /team | Get Team | +|*HelloSign::TeamApi* | [**team_info**](docs/TeamApi.md#team_info) | **GET** /team/info | Get Team Info | +|*HelloSign::TeamApi* | [**team_members**](docs/TeamApi.md#team_members) | **GET** /team/members/{team_id} | List Team Members | +|*HelloSign::TeamApi* | [**team_remove_member**](docs/TeamApi.md#team_remove_member) | **POST** /team/remove_member | Remove User from Team | +|*HelloSign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | +|*HelloSign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team | +|*HelloSign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template | +|*HelloSign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | +|*HelloSign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template | +|*HelloSign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files | +|*HelloSign::TemplateApi* | [**template_get**](docs/TemplateApi.md#template_get) | **GET** /template/{template_id} | Get Template | +|*HelloSign::TemplateApi* | [**template_list**](docs/TemplateApi.md#template_list) | **GET** /template/list | List Templates | +|*HelloSign::TemplateApi* | [**template_remove_user**](docs/TemplateApi.md#template_remove_user) | **POST** /template/remove_user/{template_id} | Remove User from Template | +|*HelloSign::TemplateApi* | [**template_update_files**](docs/TemplateApi.md#template_update_files) | **POST** /template/update_files/{template_id} | Update Template Files | +|*HelloSign::UnclaimedDraftApi* | [**unclaimed_draft_create**](docs/UnclaimedDraftApi.md#unclaimed_draft_create) | **POST** /unclaimed_draft/create | Create Unclaimed Draft | +|*HelloSign::UnclaimedDraftApi* | [**unclaimed_draft_create_embedded**](docs/UnclaimedDraftApi.md#unclaimed_draft_create_embedded) | **POST** /unclaimed_draft/create_embedded | Create Embedded Unclaimed Draft | +|*HelloSign::UnclaimedDraftApi* | [**unclaimed_draft_create_embedded_with_template**](docs/UnclaimedDraftApi.md#unclaimed_draft_create_embedded_with_template) | **POST** /unclaimed_draft/create_embedded_with_template | Create Embedded Unclaimed Draft with Template | +|*HelloSign::UnclaimedDraftApi* | [**unclaimed_draft_edit_and_resend**](docs/UnclaimedDraftApi.md#unclaimed_draft_edit_and_resend) | **POST** /unclaimed_draft/edit_and_resend/{signature_request_id} | Edit and Resend Unclaimed Draft | -## Additional notes -## Warnings -Any warnings returned from the API can be accessed by using the 'warnings' accessor on a returned object or list: +## Documentation for Models -````ruby -my_signature_requests = client.get_signature_requests -puts my_signature_requests.warnings -```` + - [HelloSign::AccountCreateRequest](docs/AccountCreateRequest.md) + - [HelloSign::AccountCreateResponse](docs/AccountCreateResponse.md) + - [HelloSign::AccountGetResponse](docs/AccountGetResponse.md) + - [HelloSign::AccountResponse](docs/AccountResponse.md) + - [HelloSign::AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [HelloSign::AccountUpdateRequest](docs/AccountUpdateRequest.md) + - [HelloSign::AccountVerifyRequest](docs/AccountVerifyRequest.md) + - [HelloSign::AccountVerifyResponse](docs/AccountVerifyResponse.md) + - [HelloSign::AccountVerifyResponseAccount](docs/AccountVerifyResponseAccount.md) + - [HelloSign::ApiAppCreateRequest](docs/ApiAppCreateRequest.md) + - [HelloSign::ApiAppGetResponse](docs/ApiAppGetResponse.md) + - [HelloSign::ApiAppListResponse](docs/ApiAppListResponse.md) + - [HelloSign::ApiAppResponse](docs/ApiAppResponse.md) + - [HelloSign::ApiAppResponseOAuth](docs/ApiAppResponseOAuth.md) + - [HelloSign::ApiAppResponseOptions](docs/ApiAppResponseOptions.md) + - [HelloSign::ApiAppResponseOwnerAccount](docs/ApiAppResponseOwnerAccount.md) + - [HelloSign::ApiAppResponseWhiteLabelingOptions](docs/ApiAppResponseWhiteLabelingOptions.md) + - [HelloSign::ApiAppUpdateRequest](docs/ApiAppUpdateRequest.md) + - [HelloSign::BulkSendJobGetResponse](docs/BulkSendJobGetResponse.md) + - [HelloSign::BulkSendJobGetResponseSignatureRequests](docs/BulkSendJobGetResponseSignatureRequests.md) + - [HelloSign::BulkSendJobListResponse](docs/BulkSendJobListResponse.md) + - [HelloSign::BulkSendJobResponse](docs/BulkSendJobResponse.md) + - [HelloSign::BulkSendJobSendResponse](docs/BulkSendJobSendResponse.md) + - [HelloSign::EmbeddedEditUrlRequest](docs/EmbeddedEditUrlRequest.md) + - [HelloSign::EmbeddedEditUrlResponse](docs/EmbeddedEditUrlResponse.md) + - [HelloSign::EmbeddedEditUrlResponseEmbedded](docs/EmbeddedEditUrlResponseEmbedded.md) + - [HelloSign::EmbeddedSignUrlResponse](docs/EmbeddedSignUrlResponse.md) + - [HelloSign::EmbeddedSignUrlResponseEmbedded](docs/EmbeddedSignUrlResponseEmbedded.md) + - [HelloSign::ErrorResponse](docs/ErrorResponse.md) + - [HelloSign::ErrorResponseError](docs/ErrorResponseError.md) + - [HelloSign::EventCallbackAccountRequest](docs/EventCallbackAccountRequest.md) + - [HelloSign::EventCallbackAccountRequestPayload](docs/EventCallbackAccountRequestPayload.md) + - [HelloSign::EventCallbackApiAppRequest](docs/EventCallbackApiAppRequest.md) + - [HelloSign::EventCallbackApiAppRequestPayload](docs/EventCallbackApiAppRequestPayload.md) + - [HelloSign::EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md) + - [HelloSign::EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md) + - [HelloSign::FileResponse](docs/FileResponse.md) + - [HelloSign::ListInfoResponse](docs/ListInfoResponse.md) + - [HelloSign::OAuthTokenGenerateRequest](docs/OAuthTokenGenerateRequest.md) + - [HelloSign::OAuthTokenRefreshRequest](docs/OAuthTokenRefreshRequest.md) + - [HelloSign::OAuthTokenResponse](docs/OAuthTokenResponse.md) + - [HelloSign::ReportCreateRequest](docs/ReportCreateRequest.md) + - [HelloSign::ReportCreateResponse](docs/ReportCreateResponse.md) + - [HelloSign::ReportResponse](docs/ReportResponse.md) + - [HelloSign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest](docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md) + - [HelloSign::SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) + - [HelloSign::SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) + - [HelloSign::SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [HelloSign::SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) + - [HelloSign::SignatureRequestListResponse](docs/SignatureRequestListResponse.md) + - [HelloSign::SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) + - [HelloSign::SignatureRequestResponse](docs/SignatureRequestResponse.md) + - [HelloSign::SignatureRequestResponseAttachment](docs/SignatureRequestResponseAttachment.md) + - [HelloSign::SignatureRequestResponseCustomFieldBase](docs/SignatureRequestResponseCustomFieldBase.md) + - [HelloSign::SignatureRequestResponseCustomFieldCheckbox](docs/SignatureRequestResponseCustomFieldCheckbox.md) + - [HelloSign::SignatureRequestResponseCustomFieldText](docs/SignatureRequestResponseCustomFieldText.md) + - [HelloSign::SignatureRequestResponseCustomFieldTypeEnum](docs/SignatureRequestResponseCustomFieldTypeEnum.md) + - [HelloSign::SignatureRequestResponseDataBase](docs/SignatureRequestResponseDataBase.md) + - [HelloSign::SignatureRequestResponseDataTypeEnum](docs/SignatureRequestResponseDataTypeEnum.md) + - [HelloSign::SignatureRequestResponseDataValueCheckbox](docs/SignatureRequestResponseDataValueCheckbox.md) + - [HelloSign::SignatureRequestResponseDataValueCheckboxMerge](docs/SignatureRequestResponseDataValueCheckboxMerge.md) + - [HelloSign::SignatureRequestResponseDataValueDateSigned](docs/SignatureRequestResponseDataValueDateSigned.md) + - [HelloSign::SignatureRequestResponseDataValueDropdown](docs/SignatureRequestResponseDataValueDropdown.md) + - [HelloSign::SignatureRequestResponseDataValueInitials](docs/SignatureRequestResponseDataValueInitials.md) + - [HelloSign::SignatureRequestResponseDataValueRadio](docs/SignatureRequestResponseDataValueRadio.md) + - [HelloSign::SignatureRequestResponseDataValueSignature](docs/SignatureRequestResponseDataValueSignature.md) + - [HelloSign::SignatureRequestResponseDataValueText](docs/SignatureRequestResponseDataValueText.md) + - [HelloSign::SignatureRequestResponseDataValueTextMerge](docs/SignatureRequestResponseDataValueTextMerge.md) + - [HelloSign::SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md) + - [HelloSign::SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md) + - [HelloSign::SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md) + - [HelloSign::SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md) + - [HelloSign::SubAttachment](docs/SubAttachment.md) + - [HelloSign::SubBulkSignerList](docs/SubBulkSignerList.md) + - [HelloSign::SubBulkSignerListCustomField](docs/SubBulkSignerListCustomField.md) + - [HelloSign::SubCC](docs/SubCC.md) + - [HelloSign::SubCustomField](docs/SubCustomField.md) + - [HelloSign::SubEditorOptions](docs/SubEditorOptions.md) + - [HelloSign::SubFieldOptions](docs/SubFieldOptions.md) + - [HelloSign::SubFormFieldGroup](docs/SubFormFieldGroup.md) + - [HelloSign::SubFormFieldRule](docs/SubFormFieldRule.md) + - [HelloSign::SubFormFieldRuleAction](docs/SubFormFieldRuleAction.md) + - [HelloSign::SubFormFieldRuleTrigger](docs/SubFormFieldRuleTrigger.md) + - [HelloSign::SubFormFieldsPerDocumentBase](docs/SubFormFieldsPerDocumentBase.md) + - [HelloSign::SubFormFieldsPerDocumentCheckbox](docs/SubFormFieldsPerDocumentCheckbox.md) + - [HelloSign::SubFormFieldsPerDocumentCheckboxMerge](docs/SubFormFieldsPerDocumentCheckboxMerge.md) + - [HelloSign::SubFormFieldsPerDocumentDateSigned](docs/SubFormFieldsPerDocumentDateSigned.md) + - [HelloSign::SubFormFieldsPerDocumentDropdown](docs/SubFormFieldsPerDocumentDropdown.md) + - [HelloSign::SubFormFieldsPerDocumentHyperlink](docs/SubFormFieldsPerDocumentHyperlink.md) + - [HelloSign::SubFormFieldsPerDocumentInitials](docs/SubFormFieldsPerDocumentInitials.md) + - [HelloSign::SubFormFieldsPerDocumentRadio](docs/SubFormFieldsPerDocumentRadio.md) + - [HelloSign::SubFormFieldsPerDocumentSignature](docs/SubFormFieldsPerDocumentSignature.md) + - [HelloSign::SubFormFieldsPerDocumentText](docs/SubFormFieldsPerDocumentText.md) + - [HelloSign::SubFormFieldsPerDocumentTextMerge](docs/SubFormFieldsPerDocumentTextMerge.md) + - [HelloSign::SubFormFieldsPerDocumentTypeEnum](docs/SubFormFieldsPerDocumentTypeEnum.md) + - [HelloSign::SubMergeField](docs/SubMergeField.md) + - [HelloSign::SubOAuth](docs/SubOAuth.md) + - [HelloSign::SubOptions](docs/SubOptions.md) + - [HelloSign::SubSignatureRequestSigner](docs/SubSignatureRequestSigner.md) + - [HelloSign::SubSignatureRequestTemplateSigner](docs/SubSignatureRequestTemplateSigner.md) + - [HelloSign::SubSigningOptions](docs/SubSigningOptions.md) + - [HelloSign::SubTeamResponse](docs/SubTeamResponse.md) + - [HelloSign::SubTemplateRole](docs/SubTemplateRole.md) + - [HelloSign::SubUnclaimedDraftSigner](docs/SubUnclaimedDraftSigner.md) + - [HelloSign::SubUnclaimedDraftTemplateSigner](docs/SubUnclaimedDraftTemplateSigner.md) + - [HelloSign::SubWhiteLabelingOptions](docs/SubWhiteLabelingOptions.md) + - [HelloSign::TeamAddMemberRequest](docs/TeamAddMemberRequest.md) + - [HelloSign::TeamCreateRequest](docs/TeamCreateRequest.md) + - [HelloSign::TeamGetInfoResponse](docs/TeamGetInfoResponse.md) + - [HelloSign::TeamGetResponse](docs/TeamGetResponse.md) + - [HelloSign::TeamInfoResponse](docs/TeamInfoResponse.md) + - [HelloSign::TeamMemberResponse](docs/TeamMemberResponse.md) + - [HelloSign::TeamMembersResponse](docs/TeamMembersResponse.md) + - [HelloSign::TeamParentResponse](docs/TeamParentResponse.md) + - [HelloSign::TeamRemoveMemberRequest](docs/TeamRemoveMemberRequest.md) + - [HelloSign::TeamResponse](docs/TeamResponse.md) + - [HelloSign::TeamSubTeamsResponse](docs/TeamSubTeamsResponse.md) + - [HelloSign::TeamUpdateRequest](docs/TeamUpdateRequest.md) + - [HelloSign::TemplateAddUserRequest](docs/TemplateAddUserRequest.md) + - [HelloSign::TemplateCreateEmbeddedDraftRequest](docs/TemplateCreateEmbeddedDraftRequest.md) + - [HelloSign::TemplateCreateEmbeddedDraftResponse](docs/TemplateCreateEmbeddedDraftResponse.md) + - [HelloSign::TemplateCreateEmbeddedDraftResponseTemplate](docs/TemplateCreateEmbeddedDraftResponseTemplate.md) + - [HelloSign::TemplateEditResponse](docs/TemplateEditResponse.md) + - [HelloSign::TemplateGetResponse](docs/TemplateGetResponse.md) + - [HelloSign::TemplateListResponse](docs/TemplateListResponse.md) + - [HelloSign::TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md) + - [HelloSign::TemplateResponse](docs/TemplateResponse.md) + - [HelloSign::TemplateResponseAccount](docs/TemplateResponseAccount.md) + - [HelloSign::TemplateResponseAccountQuota](docs/TemplateResponseAccountQuota.md) + - [HelloSign::TemplateResponseCCRole](docs/TemplateResponseCCRole.md) + - [HelloSign::TemplateResponseCustomField](docs/TemplateResponseCustomField.md) + - [HelloSign::TemplateResponseDocument](docs/TemplateResponseDocument.md) + - [HelloSign::TemplateResponseDocumentCustomField](docs/TemplateResponseDocumentCustomField.md) + - [HelloSign::TemplateResponseDocumentFieldGroup](docs/TemplateResponseDocumentFieldGroup.md) + - [HelloSign::TemplateResponseDocumentFormField](docs/TemplateResponseDocumentFormField.md) + - [HelloSign::TemplateResponseDocumentStaticField](docs/TemplateResponseDocumentStaticField.md) + - [HelloSign::TemplateResponseFieldAvgTextLength](docs/TemplateResponseFieldAvgTextLength.md) + - [HelloSign::TemplateResponseNamedFormField](docs/TemplateResponseNamedFormField.md) + - [HelloSign::TemplateResponseSignerRole](docs/TemplateResponseSignerRole.md) + - [HelloSign::TemplateUpdateFilesRequest](docs/TemplateUpdateFilesRequest.md) + - [HelloSign::TemplateUpdateFilesResponse](docs/TemplateUpdateFilesResponse.md) + - [HelloSign::TemplateUpdateFilesResponseTemplate](docs/TemplateUpdateFilesResponseTemplate.md) + - [HelloSign::UnclaimedDraftCreateEmbeddedRequest](docs/UnclaimedDraftCreateEmbeddedRequest.md) + - [HelloSign::UnclaimedDraftCreateEmbeddedWithTemplateRequest](docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md) + - [HelloSign::UnclaimedDraftCreateRequest](docs/UnclaimedDraftCreateRequest.md) + - [HelloSign::UnclaimedDraftCreateResponse](docs/UnclaimedDraftCreateResponse.md) + - [HelloSign::UnclaimedDraftEditAndResendRequest](docs/UnclaimedDraftEditAndResendRequest.md) + - [HelloSign::UnclaimedDraftResponse](docs/UnclaimedDraftResponse.md) + - [HelloSign::WarningResponse](docs/WarningResponse.md) -and will give output of warnings in the following format (as an array of hashes): -```` -[ - [0] { - "warning_msg" => "Parameter hodor was ignored. Hodor.", - "warning_name" => "parameter_ignored" - }, - [1] { - "warning_msg" => "Email address sirjorah@targarian.org is unconfirmed. Please pledge your allegiance to the queen first.", - "warning_name" => "unconfirmed" - } -] -```` +## Documentation for Authorization -### Local callbacks -We do not allow app callbacks (event or OAuth) to be set to localhost. However it is still possible to test callbacks against a local server. Tunneling services such as ngrok (http://ngrok.com) can help you set this up. -## License +### api_key -``` -The MIT License (MIT) +- **Type**: HTTP basic authentication -Copyright (C) 2014 hellosign.com +### oauth2 -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +- **Type**: Bearer authentication (JWT) -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -```