Ruby Migration Guide

1
require "hello_sign"

1
require 'hello_sign'
2
3
HelloSign.configure do |config|
4
  config.api_key = 'api_key'
5
end

1
signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new({
2
  :email_address => "jack@dropboxsign.com",
3
  :name          => "Jack",
4
  :order         => 0,
5
})
6
7
attachment1 = Dropbox::Sign::SubAttachment.new({
8
  :name         => "Attachment 1",
9
  :instructions => "Please download this file",
10
  :signer_index => 0,
11
  :required     => true,
12
})

1
form_fields_per_document: [
2
  [
3
    {
4
      name: 'address',
5
      type: 'text',
6
      x: 160,
7
      y: 80,
8
      width: 206,
9
      height: 32,
10
      signer: 0
11
    }
12
  ],
13
  [
14
    {
15
      name: 'phone',
16
      type: 'text',
17
      x: 160,
18
      y: 150,
19
      width: 206,
20
      height: 32,
21
      signer: 1
22
      }
23
  ]
24
]

1
form_field_1 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.init({
2
  type: "signature",
3
  document_index: 0,
4
  api_id: "4688957689",
5
  name: "signature1",
6
  x: 5,
7
  y: 7,
8
  width: 60,
9
  height: 30,
10
  required: true,
11
  signer: 0,
12
  page: 1,
13
})

1
{
2
  "signers": {
3
    "Client": {
4
      "name": "George",
5
      "email_address": "george@example.com"
6
    },
7
    "Manager": {
8
      "name": "Bob",
9
      "email_address": "bob@example.com"
10
    }
11
  }
12
}

1
require "dropbox-sign"
2
3
Dropbox::Sign.configure do |config|
4
  config.username = "YOUR_API_KEY"
5
end
6
7
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
8
9
data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.init({
10
  template_ids: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
11
  subject: "Purchase Order",
12
  message: "Glad we could come to an agreement.",
13
  signers: [
14
    {
15
      role: "Client",
16
      email_address: "george@example.com",
17
      name: "George",
18
    },
19
    {
20
      role: "Manager",
21
      email_address: "bob@example.com",
22
      name: "Bob",
23
    }
24
  ],
25
})
26
27
begin
28
  result = signature_request_api.signature_request_send_with_template(data)
29
  p result
30
rescue Dropbox::Sign::ApiError => e
31
  puts "Exception when calling Dropbox Sign API: #{e}"
32
end

1
{
2
  "ccs": {
3
    "Client": "george@example.com",
4
    "Manager": "bob@example.com"
5
  }
6
}

1
require "dropbox-sign"
2
3
Dropbox::Sign.configure do |config|
4
  config.username = "YOUR_API_KEY"
5
end
6
7
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
8
9
data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.init({
10
  template_ids: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
11
  subject: "Purchase Order",
12
  message: "Glad we could come to an agreement.",
13
  signers: [
14
    {
15
      role: "Client",
16
      email_address: "george@example.com",
17
      name: "George",
18
    },
19
    {
20
      role: "Manager",
21
      email_address: "bob@example.com",
22
      name: "Bob",
23
    }
24
  ],
25
  ccs: [
26
    {
27
      role: "Client",
28
      email_address: "george@example.com",
29
    },
30
    {
31
      role: "Manager",
32
      email_address: "bob@example.com",
33
    }
34
  ]
35
})
36
37
begin
38
  result = signature_request_api.signature_request_send_with_template(data)
39
  p result
40
rescue Dropbox::Sign::ApiError => e
41
  puts "Exception when calling Dropbox Sign API: #{e}"
42
end

1
{
2
  "custom_fields": {
3
    "company": {
4
      "value": "ABC Corp",
5
      "required": true
6
    }
7
  }
8
}

1
require "dropbox-sign"
2
3
Dropbox::Sign.configure do |config|
4
  config.username = "YOUR_API_KEY"
5
end
6
7
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
8
9
data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.init({
10
  template_ids: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
11
  subject: "Purchase Order",
12
  message: "Glad we could come to an agreement.",
13
  signers: [
14
    {
15
      role: "Client",
16
      email_address: "george@example.com",
17
      name: "George",
18
    },
19
    {
20
      role: "Manager",
21
      email_address: "bob@example.com",
22
      name: "Bob",
23
    }
24
  ],
25
  custom_fields: [
26
    {
27
      name: "company",
28
      value: "ABC Corp",
29
      required: true,
30
    },
31
  ]
32
})
33
34
begin
35
  result = signature_request_api.signature_request_send_with_template(data)
36
  p result
37
rescue Dropbox::Sign::ApiError => e
38
  puts "Exception when calling Dropbox Sign API: #{e}"
39
end

1
client.send_signature_request(
2
  :test_mode => 1,
3
  :title => 'NDA',
4
  :files => ['/Users/NDA.pdf']
5
)

1
client = HelloSign::Client.new :api_key => 'SIGN_IN_AND_CREATE_API_KEY_FIRST'
2
file_bin = client.signature_request_files :signature_request_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967', :file_type => 'pdf'
3
open("files.pdf", "pdf") do |file|
4
    file.write(file_bin)
5
end

1
client = HelloSign::Client.new :api_key => 'SIGN_IN_AND_CREATE_API_KEY_FIRST'
2
file_bin = client.get_template_files :template_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967', :file_type => 'pdf'
3
open("files.pdf", "pdf") do |file|
4
    file.write(file_bin)
5
end

1
client = HelloSign::Client.new
2
  client.send_signature_request(
3
    :test_mode => 1,
4
    :title => 'NDA',
5
    :subject => 'Please sign this NDA',
6
    :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any
7
    questions.',
8
    :signers => [
9
      {
10
        :email_address => 'example@example.com',
11
        :name => 'Jack',
12
        :order => 0,
13
      },
14
      {
15
        :email_address => 'example+1@example.com',
16
        :name => 'Jack 2',
17
        :order => 1,
18
      }
19
    ],
20
    :files => ['path_to_file']
21
  )
22
end

1
client.create_embedded_signature_request(
2
  :test_mode => 1,
3
  :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
4
  :title => 'NDA with Acme Co.',
5
  :subject => 'The NDA we talked about',
6
  :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any
7
  questions.',
8
  :signers => [
9
    {
10
      :email_address => 'jack@example.com',
11
      :name => 'Jack',
12
      :order => 0,
13
    },{
14
      :email_address => 'jill@example.com',
15
      :name => 'Jill',
16
      :order => 1,
17
    }
18
  ],
19
  :files => ['NDA.pdf', 'AppendixA.pdf']

1
client = HelloSign::Client.new :api_key => 'SIGN_IN_AND_CREATE_API_KEY_FIRST'
2
client.send_signature_request_with_template(
3
  :test_mode => 1,
4
  :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
5
  :subject => 'Purchase Order',
6
  :message => 'Glad we could come to an agreement.',
7
  :signers => [
8
    {
9
      :email_address => 'george@example.com',
10
      :name => 'George',
11
      :role => 'Client'
12
    }
13
  ],
14
  :ccs => [
15
    {
16
      :email_address =>'accounting@example.com',
17
      :role => "Accounting"
18
    }
19
  ],
20
  :custom_fields => [
21
    {
22
      :name => 'Cost',
23
      :value => '$20,000'
24
    }
25
  ]
26
)

1
client.get_signature_request :signature_request_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967'

1
client.get_signature_requests :page => 1

1
client = HelloSign::Client.new :api_key => 'SIGN_IN_AND_CREATE_API_KEY_FIRST'
2
file_bin = client.signature_request_files :signature_request_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967', :file_type => 'pdf'
3
open("files.pdf", "pdf") do |file|
4
    file.write(file_bin)
5
end

1
client = HelloSign::Client.new :api_key => 'SIGN_IN_AND_CREATE_API_KEY_FIRST'
2
client.get_account