hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta

data/oas/examples/json/EventCallbackAccountTemplateCreatedExample.json

@@ -0,0 +1,140 @@
+{
+  "json": {
+    "event": {
+      "event_time": "1348177752",
+      "event_type": "template_created",
+      "event_hash": "3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947",
+      "event_metadata": {
+        "related_signature_id": null,
+        "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd",
+        "reported_for_app_id": null
+      }
+    },
+    "template": {
+      "template_id": "f57db65d3f933b5316d398057a36176831451a35",
+      "title": "Mutual NDA",
+      "message": "Please sign this NDA as soon as possible.",
+      "updated_at": 1570471067,
+      "is_embedded": false,
+      "metadata": {},
+      "signer_roles": [
+        {
+          "name": "Outside Vendor",
+          "order": 0
+        },
+        {
+          "name": "Internal Manager",
+          "order": 1
+        }
+      ],
+      "cc_roles": [
+        {
+          "name": "Corporate Attorney"
+        }
+      ],
+      "documents": [
+        {
+          "index": 0,
+          "name": "mutual_nda.pdf",
+          "field_groups": [
+            {
+              "name": "group1",
+              "rule": "require_1-ormore"
+            }
+          ],
+          "form_fields": [
+            {
+              "api_id": "b65e03_10",
+              "name": "DepartmentA",
+              "type": "checkbox",
+              "x": 117,
+              "y": 19,
+              "width": 15,
+              "height": 15,
+              "required": false,
+              "group": "group1"
+            },
+            {
+              "api_id": "b65e03_11",
+              "name": "DepartmentB",
+              "type": "checkbox",
+              "x": 118,
+              "y": 41,
+              "width": 15,
+              "height": 15,
+              "required": false,
+              "group": "group1"
+            },
+            {
+              "api_id": "0ec7a7_1",
+              "name": "VendorName",
+              "type": "text",
+              "x": 160,
+              "y": 141,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_2",
+              "name": "VendorTitle",
+              "type": "text",
+              "x": 160,
+              "y": 181,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_3",
+              "name": "ManagerName",
+              "type": "text",
+              "x": 160,
+              "y": 221,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_4",
+              "name": "ManagerTitle",
+              "type": "text",
+              "x": 160,
+              "y": 251,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_5",
+              "name": "DateSigned",
+              "type": "date_signed",
+              "x": 523,
+              "y": 28,
+              "width": 105,
+              "height": 16,
+              "required": true,
+              "group": null
+            }
+          ],
+          "custom_fields": [
+            {
+              "name": "Effective Date",
+              "type": "text"
+            }
+          ]
+        }
+      ],
+      "accounts": [
+        {
+          "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
+          "email_address": "me@hellosign.com"
+        }
+      ]
+    }
+  }
+}

data/oas/examples/json/EventCallbackApiAppAccountConfirmedExample.json

@@ -0,0 +1,28 @@
+{
+  "json": {
+    "event": {
+      "event_time": "1348177752",
+      "event_type": "account_confirmed",
+      "event_hash": "3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947",
+      "event_metadata": {
+        "related_signature_id": null,
+        "reported_for_account_id": null,
+        "reported_for_app_id": "5b6eac0ac5f82db0cf5f394ce4f6b150"
+      }
+    },
+    "account": {
+      "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
+      "email_address": "me@hellosign.com",
+      "is_locked": false,
+      "is_paid_hs": true,
+      "is_paid_hf": false,
+      "quotas": {
+        "api_signature_requests_left": 1250,
+        "documents_left": null,
+        "templates_left": null
+      },
+      "callback_url": null,
+      "role_code": null
+    }
+  }
+}

data/oas/examples/json/EventCallbackApiAppSignatureRequestSentExample.json

@@ -0,0 +1,51 @@
+{
+  "json": {
+    "event": {
+      "event_time": "1348177752",
+      "event_type": "signature_request_sent",
+      "event_hash": "3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947",
+      "event_metadata": {
+        "related_signature_id": null,
+        "reported_for_account_id": null,
+        "reported_for_app_id": "5b6eac0ac5f82db0cf5f394ce4f6b150"
+      }
+    },
+    "signature_request": {
+      "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
+      "title": "Purchase Agreement",
+      "original_title": "Purchase Agreement",
+      "subject": "Purchase Agreement we talked about",
+      "message": "Please sign and return.",
+      "metadata": {},
+      "created_at": 1570471067,
+      "is_complete": false,
+      "is_declined": false,
+      "has_error": false,
+      "custom_fields": [],
+      "response_data": [],
+      "signing_url": null,
+      "signing_redirect_url": null,
+      "files_url": "https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f",
+      "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967",
+      "requester_email_address": "me@hellosign.com",
+      "signatures": [
+        {
+          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
+          "signer_email_address": "john@example.com",
+          "signer_name": "John Doe",
+          "signer_role": null,
+          "order": null,
+          "status_code": "signed",
+          "signed_at": 1346521550,
+          "last_viewed_at": 1346521483,
+          "last_reminded_at": null,
+          "has_pin": false,
+          "has_sms_auth": false
+        }
+      ],
+      "cc_email_addresses": [],
+      "template_ids": null,
+      "client_id": "5b6eac0ac5f82db0cf5f394ce4f6b150"
+    }
+  }
+}

data/oas/examples/json/EventCallbackApiAppTemplateCreatedExample.json

@@ -0,0 +1,140 @@
+{
+  "json": {
+    "event": {
+      "event_time": "1348177752",
+      "event_type": "template_created",
+      "event_hash": "3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947",
+      "event_metadata": {
+        "related_signature_id": null,
+        "reported_for_account_id": null,
+        "reported_for_app_id": "5b6eac0ac5f82db0cf5f394ce4f6b150"
+      }
+    },
+    "template": {
+      "template_id": "f57db65d3f933b5316d398057a36176831451a35",
+      "title": "Mutual NDA",
+      "message": "Please sign this NDA as soon as possible.",
+      "updated_at": 1570471067,
+      "is_embedded": false,
+      "metadata": {},
+      "signer_roles": [
+        {
+          "name": "Outside Vendor",
+          "order": 0
+        },
+        {
+          "name": "Internal Manager",
+          "order": 1
+        }
+      ],
+      "cc_roles": [
+        {
+          "name": "Corporate Attorney"
+        }
+      ],
+      "documents": [
+        {
+          "index": 0,
+          "name": "mutual_nda.pdf",
+          "field_groups": [
+            {
+              "name": "group1",
+              "rule": "require_1-ormore"
+            }
+          ],
+          "form_fields": [
+            {
+              "api_id": "b65e03_10",
+              "name": "DepartmentA",
+              "type": "checkbox",
+              "x": 117,
+              "y": 19,
+              "width": 15,
+              "height": 15,
+              "required": false,
+              "group": "group1"
+            },
+            {
+              "api_id": "b65e03_11",
+              "name": "DepartmentB",
+              "type": "checkbox",
+              "x": 118,
+              "y": 41,
+              "width": 15,
+              "height": 15,
+              "required": false,
+              "group": "group1"
+            },
+            {
+              "api_id": "0ec7a7_1",
+              "name": "VendorName",
+              "type": "text",
+              "x": 160,
+              "y": 141,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_2",
+              "name": "VendorTitle",
+              "type": "text",
+              "x": 160,
+              "y": 181,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_3",
+              "name": "ManagerName",
+              "type": "text",
+              "x": 160,
+              "y": 221,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_4",
+              "name": "ManagerTitle",
+              "type": "text",
+              "x": 160,
+              "y": 251,
+              "width": 80,
+              "height": 30,
+              "required": true,
+              "group": null
+            },
+            {
+              "api_id": "0ec7a7_5",
+              "name": "DateSigned",
+              "type": "date_signed",
+              "x": 523,
+              "y": 28,
+              "width": 105,
+              "height": 16,
+              "required": true,
+              "group": null
+            }
+          ],
+          "custom_fields": [
+            {
+              "name": "Effective Date",
+              "type": "text"
+            }
+          ]
+        }
+      ],
+      "accounts": [
+        {
+          "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
+          "email_address": "me@hellosign.com"
+        }
+      ]
+    }
+  }
+}

data/oas/examples/json/OAuthTokenGenerateRequestExample.json

@@ -0,0 +1,7 @@
+{
+  "state": "900e06e2",
+  "code": "1b0d28d90c86c141",
+  "grant_type": "authorization_code",
+  "client_id": "cc91c61d00f8bb2ece1428035716b",
+  "client_secret": "1d14434088507ffa390e6f5528465"
+}

data/oas/examples/json/OAuthTokenGenerateResponseExample.json

@@ -0,0 +1,7 @@
+{
+  "access_token": "NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=",
+  "token_type": "Bearer",
+  "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3",
+  "expires_in": 86400,
+  "state": "900e06e2"
+}

data/oas/examples/json/OAuthTokenRefreshRequestExample.json

@@ -0,0 +1,4 @@
+{
+  "grant_type": "refresh_token",
+  "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"
+}

data/oas/examples/json/OAuthTokenRefreshResponseExample.json

@@ -0,0 +1,6 @@
+{
+  "access_token": "MDZhYzBlMGI1YzQ0ZjI1ZjYzYmUyNmMzZWQ5ZGNmOGYyNmQxMmMyMmQ2NmNiY2M3NW=",
+  "expires_in": 86400,
+  "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3",
+  "token_type": "Bearer"
+}

data/oas/examples/json/ReportCreateRequestDefaultExample.json

@@ -0,0 +1,8 @@
+{
+  "start_date": "09/01/2020",
+  "end_date": "09/01/2020",
+  "report_type": [
+    "user_activity",
+    "document_status"
+  ]
+}

data/oas/examples/json/ReportCreateResponseExample.json

@@ -0,0 +1,11 @@
+{
+  "report": {
+    "success": "Your request is being processed. You will receive an email when the report is ready.",
+    "start_date": "09/01/2020",
+    "end_date": "09/02/2020",
+    "report_type": [
+      "user_activity",
+      "document_status"
+    ]
+  }
+}

data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json

@@ -0,0 +1,49 @@
+{
+  "client_id": "1a659d9ad95bccd307ecad78d72192f8",
+  "template_ids": [
+    "c26b8a16784a872da37ea946b9ddec7c1e11dff6"
+  ],
+  "subject": "Purchase Order",
+  "message": "Glad we could come to an agreement.",
+  "signer_list": [
+    {
+      "signers": [
+        {
+          "role": "Client",
+          "name": "George",
+          "email_address": "george@example.com",
+          "pin": "d79a3td"
+        }
+      ],
+      "custom_fields": [
+        {
+          "name": "company",
+          "value": "ABC Corp"
+        }
+      ]
+    },
+    {
+      "signers": [
+        {
+          "role": "Client",
+          "name": "Mary",
+          "email_address": "mary@example.com",
+          "pin": "gd9as5b"
+        }
+      ],
+      "custom_fields": [
+        {
+          "name": "company",
+          "value": "123 LLC"
+        }
+      ]
+    }
+  ],
+  "ccs": [
+    {
+      "role": "Accounting",
+      "email_address": "accounting@example.com"
+    }
+  ],
+  "test_mode": true
+}

data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json

@@ -0,0 +1,16 @@
+{
+  "client_id": "1a659d9ad95bccd307ecad78d72192f8",
+  "template_ids": [
+    "c26b8a16784a872da37ea946b9ddec7c1e11dff6"
+  ],
+  "subject": "Purchase Order",
+  "message": "Glad we could come to an agreement.",
+  "signer_file": "@SignerFile.csv",
+  "ccs": [
+    {
+      "role": "Accounting",
+      "email_address": "accounting@example.com"
+    }
+  ],
+  "test_mode": true
+}

data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json

@@ -0,0 +1,8 @@
+{
+  "bulk_send_job": {
+    "bulk_send_job_id": "ccaf88244ef006b6e31ebba5ed4cb53b3131d9ac",
+    "total": 3,
+    "is_creator": true,
+    "created_at": 1543556038
+  }
+}

data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json

@@ -0,0 +1,48 @@
+{
+  "template_ids": [
+    "c26b8a16784a872da37ea946b9ddec7c1e11dff6"
+  ],
+  "subject": "Purchase Order",
+  "message": "Glad we could come to an agreement.",
+  "signer_list": [
+    {
+      "signers": [
+        {
+          "role": "Client",
+          "name": "George",
+          "email_address": "george@example.com",
+          "pin": "d79a3td"
+        }
+      ],
+      "custom_fields": [
+        {
+          "name": "company",
+          "value": "ABC Corp"
+        }
+      ]
+    },
+    {
+      "signers": [
+        {
+          "role": "Client",
+          "name": "Mary",
+          "email_address": "mary@example.com",
+          "pin": "gd9as5b"
+        }
+      ],
+      "custom_fields": [
+        {
+          "name": "company",
+          "value": "123 LLC"
+        }
+      ]
+    }
+  ],
+  "ccs": [
+    {
+      "role": "Accounting",
+      "email_address": "accounting@example.com"
+    }
+  ],
+  "test_mode": true
+}

data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json

@@ -0,0 +1,15 @@
+{
+  "template_ids": [
+    "c26b8a16784a872da37ea946b9ddec7c1e11dff6"
+  ],
+  "subject": "Purchase Order",
+  "message": "Glad we could come to an agreement.",
+  "signer_file": "@SignerFile.csv",
+  "ccs": [
+    {
+      "role": "Accounting",
+      "email_address": "accounting@example.com"
+    }
+  ],
+  "test_mode": true
+}

data/oas/examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json

@@ -0,0 +1,8 @@
+{
+  "bulk_send_job": {
+    "bulk_send_job_id": "4bce667844dc3711d05e7aa4a1b5a6b64b738b2b",
+    "total": 1,
+    "is_creator": true,
+    "created_at": 1532640962
+  }
+}

data/oas/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json

@@ -0,0 +1,33 @@
+{
+  "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
+  "title": "NDA with Acme Co.",
+  "subject": "The NDA we talked about",
+  "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
+  "signers": [
+    {
+      "email_address": "jack@example.com",
+      "name": "Jack",
+      "order": 0
+    },
+    {
+      "email_address": "jill@example.com",
+      "name": "Jill",
+      "order": 1
+    }
+  ],
+  "cc_email_addresses": [
+    "lawyer@hellosign.com",
+    "lawyer@example.com"
+  ],
+  "file_url": [
+    "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"
+  ],
+  "signing_options": {
+    "draw": true,
+    "type": true,
+    "upload": true,
+    "phone": false,
+    "default_type": "draw"
+  },
+  "test_mode": true
+}

data/oas/examples/json/SignatureRequestCreateEmbeddedRequestFormDataExample.json

@@ -0,0 +1,34 @@
+{
+  "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
+  "title": "NDA with Acme Co.",
+  "subject": "The NDA we talked about",
+  "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
+  "signers": [
+    {
+      "email_address": "jack@example.com",
+      "name": "Jack",
+      "order": 0
+    },
+    {
+      "email_address": "jill@example.com",
+      "name": "Jill",
+      "order": 1
+    }
+  ],
+  "cc_email_addresses": [
+    "lawyer@hellosign.com",
+    "lawyer@example.com"
+  ],
+  "file": [
+    "@NDA.pdf",
+    "@AppendixA.pdf"
+  ],
+  "signing_options": {
+    "draw": true,
+    "type": true,
+    "upload": true,
+    "phone": false,
+    "default_type": "draw"
+  },
+  "test_mode": true
+}