Ruby

Yousign: List Files

See more Yousign Examples

List Yousign files. Ruby

require 'chilkat'

success = false

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl --location --request GET 'https://staging-api.yousign.com/files' \
# --header 'Authorization: Bearer YOUR_API_KEY' \
# --header 'Content-Type: application/json'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.put_AuthToken("YOUR_API_KEY")
http.SetRequestHeader("Content-Type","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://staging-api.yousign.com/files",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.LoadSb(sbResponseBody)
json.put_EmitCompact(false)

print "Response Body:" + "\n";
print json.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "\/files\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
#   "name": "abc.pdf",
#   "type": "signable",
#   "contentType": "application\/pdf",
#   "description": null,
#   "createdAt": "2020-05-27T09:14:12+02:00",
#   "updatedAt": "2020-05-27T09:14:12+02:00",
#   "sha256": "ea2a92b0eff5bebfa3ccd869fd61e27bb7fe973d0dff63f106d8b0d614469fa0",
#   "metadata": [
#   ],
#   "workspace": "\/workspaces\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
#   "creator": null,
#   "fileObjects": [
#   ],
#   "protected": false,
#   "position": 0,
#   "parent": null,
#   "fieldsCompatible": true,
#   "company": "\/companies\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
# }

# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

id = json.stringOf("id")
name = json.stringOf("name")
v_type = json.stringOf("type")
contentType = json.stringOf("contentType")
description = json.stringOf("description")
createdAt = json.stringOf("createdAt")
updatedAt = json.stringOf("updatedAt")
sha256 = json.stringOf("sha256")
workspace = json.stringOf("workspace")
creator = json.stringOf("creator")
v_protected = json.BoolOf("protected")
position = json.IntOf("position")
parent = json.stringOf("parent")
fieldsCompatible = json.BoolOf("fieldsCompatible")
company = json.stringOf("company")
i = 0
count_i = json.SizeOfArray("metadata")
while i < count_i
    json.put_I(i)
    i = i + 1
end
i = 0
count_i = json.SizeOfArray("fileObjects")
while i < count_i
    json.put_I(i)
    i = i + 1
end