README

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.

We use OpenAPI Generator to automatically generate this SDK from the OAS, using the template files.

Building

You must have docker (or podman linked to docker) installed. Highly recommended to use rootless docker.

Run the following and everything is done for you:

./run-build

Attention: Any changes you have made to the SDK code that you have not made to the OAS file and/or the mustache template files will be lost when you run this command.

Installation & Usage

Requirements

PHP 7.4 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
    "require": {
        "dropbox/sign": "^1.7.0"
    },
    "minimum-stability": "dev"
}

Then run composer install

Alternatively, install directly with

composer require dropbox/sign:^1.7.0

Getting Started

Please follow the installation procedure and then run the following:

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$accountApi = new Dropbox\Sign\Api\AccountApi($config);

$data = new Dropbox\Sign\Model\AccountCreateRequest();
$data->setEmailAddress("newuser@dropboxsign.com");

try {
    $result = $accountApi->accountCreate($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

You may also instantiate objects by calling the class' ::init() method:

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");

$api = new Dropbox\Sign\Api\SignatureRequestApi($config);

$data = Dropbox\Sign\Model\SignatureRequestSendRequest::init([
    "title"   => "NDA with Acme Co.",
    "signers" => [
        [
            "email_address" => "jack@example.com",
            "name"          => "Jack",
            "order"         => 0,
        ],
        [
            "email_address" => "jill@example.com",
            "name"          => "Jill",
            "order"         => 1,
        ],
    ],
    "files"    => [
        new SplFileObject("/absolute/path/to/file.pdf"),
    ],
]);

try {
    $result = $api->signatureRequestSend($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling Dropbox Sign API: "
        . $e->getMessage() . PHP_EOL;
}

API Endpoints

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

Models

Authorization

api_key

Type: HTTP basic authentication

oauth2

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

apisupport@hellosign.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 3.0.0
- Package version: 1.7.0
- Generator version: 7.8.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

dropbox / sign

Maintainers

Details