Skip to content

Commit 6fc59f8

Browse files
Release 1.9.0 (#16)
* Release 1.9.0 * Add edit&resend to OpenAPI docs, and note that it uses quota
1 parent bc73d6a commit 6fc59f8

File tree

411 files changed

+17201
-8266
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

411 files changed

+17201
-8266
lines changed

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
5353
```json
5454
{
5555
"require": {
56-
"dropbox/sign": "^1.8.0"
56+
"dropbox/sign": "^1.9.0"
5757
},
5858
"minimum-stability": "dev"
5959
}
@@ -64,7 +64,7 @@ Then run `composer install`
6464
Alternatively, install directly with
6565

6666
```
67-
composer require dropbox/sign:^1.8.0
67+
composer require dropbox/sign:^1.9.0
6868
```
6969

7070
## Getting Started
@@ -75,28 +75,28 @@ Please follow the [installation procedure](#installation--usage) and then run th
7575
```php
7676
<?php
7777

78-
require_once __DIR__ . "/vendor/autoload.php";
78+
namespace Dropbox\SignSandbox;
7979

80-
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
80+
require_once __DIR__ . '/../vendor/autoload.php';
8181

82-
// Configure HTTP basic authorization: api_key
83-
$config->setUsername("YOUR_API_KEY");
82+
use SplFileObject;
83+
use Dropbox;
8484

85-
// or, configure Bearer (JWT) authorization: oauth2
85+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
86+
$config->setUsername("YOUR_API_KEY");
8687
// $config->setAccessToken("YOUR_ACCESS_TOKEN");
8788

88-
$accountApi = new Dropbox\Sign\Api\AccountApi($config);
89-
90-
$data = new Dropbox\Sign\Model\AccountCreateRequest();
91-
$data->setEmailAddress("newuser@dropboxsign.com");
89+
$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest())
90+
->setEmailAddress("newuser@dropboxsign.com");
9291

9392
try {
94-
$result = $accountApi->accountCreate($data);
95-
print_r($result);
93+
$response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate(
94+
account_create_request: $account_create_request,
95+
);
96+
97+
print_r($response);
9698
} catch (Dropbox\Sign\ApiException $e) {
97-
$error = $e->getResponseObject();
98-
echo "Exception when calling Dropbox Sign API: "
99-
. print_r($error->getError());
99+
echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}";
100100
}
101101

102102
```
@@ -161,7 +161,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
161161
| *EmbeddedApi* | [**embeddedEditUrl**](docs/Api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
162162
| *EmbeddedApi* | [**embeddedSignUrl**](docs/Api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
163163
| *FaxApi* | [**faxDelete**](docs/Api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax |
164-
| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files |
164+
| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files |
165165
| *FaxApi* | [**faxGet**](docs/Api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax |
166166
| *FaxApi* | [**faxList**](docs/Api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes |
167167
| *FaxApi* | [**faxSend**](docs/Api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax |
@@ -180,6 +180,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
180180
| *SignatureRequestApi* | [**signatureRequestCancel**](docs/Api/SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request |
181181
| *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](docs/Api/SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request |
182182
| *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](docs/Api/SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template |
183+
| *SignatureRequestApi* | [**signatureRequestEdit**](docs/Api/SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request |
184+
| *SignatureRequestApi* | [**signatureRequestEditEmbedded**](docs/Api/SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request |
185+
| *SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](docs/Api/SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template |
186+
| *SignatureRequestApi* | [**signatureRequestEditWithTemplate**](docs/Api/SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template |
183187
| *SignatureRequestApi* | [**signatureRequestFiles**](docs/Api/SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files |
184188
| *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](docs/Api/SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri |
185189
| *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](docs/Api/SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url |
@@ -283,6 +287,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
283287
- [SignatureRequestBulkSendWithTemplateRequest](docs/Model/SignatureRequestBulkSendWithTemplateRequest.md)
284288
- [SignatureRequestCreateEmbeddedRequest](docs/Model/SignatureRequestCreateEmbeddedRequest.md)
285289
- [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md)
290+
- [SignatureRequestEditEmbeddedRequest](docs/Model/SignatureRequestEditEmbeddedRequest.md)
291+
- [SignatureRequestEditEmbeddedWithTemplateRequest](docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md)
292+
- [SignatureRequestEditRequest](docs/Model/SignatureRequestEditRequest.md)
293+
- [SignatureRequestEditWithTemplateRequest](docs/Model/SignatureRequestEditWithTemplateRequest.md)
286294
- [SignatureRequestGetResponse](docs/Model/SignatureRequestGetResponse.md)
287295
- [SignatureRequestListResponse](docs/Model/SignatureRequestListResponse.md)
288296
- [SignatureRequestRemindRequest](docs/Model/SignatureRequestRemindRequest.md)
@@ -439,6 +447,6 @@ apisupport@hellosign.com
439447
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
440448

441449
- API version: `3.0.0`
442-
- Package version: `1.8.0`
443-
- Generator version: `7.8.0`
450+
- Package version: `1.9.0`
451+
- Generator version: `7.12.0`
444452
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.8.0
1+
1.9.0

bin/copy-constants.php

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
#!/usr/bin/env php
2+
<?php
3+
4+
require_once __DIR__ . '/../vendor/autoload.php';
5+
6+
ini_set('display_errors', 1);
7+
ini_set('display_startup_errors', 1);
8+
error_reporting(E_ALL);
9+
10+
set_error_handler(function ($level, $msg) {
11+
echo "Error: {$msg}";
12+
exit(1);
13+
});
14+
15+
/**
16+
* Between openapi-generator v7.8.0 and v7.12.0 a change was made to the way
17+
* a few generators create constant names from values. The original way was
18+
* actually broken. For example "change-field-visibility" would generate a
19+
* constant name of "TYPE_FIELD_VISIBILITY", dropping the "change" part.
20+
*
21+
* The fix now generates the correct name, "TYPE_CHANGE_FIELD_VISIBILITY".
22+
* However, the fix also gets rid of the previous (incorrect) constant names,
23+
* making the fix a BC break.
24+
*
25+
* This simple script just adds the old constant names back, alongside the new
26+
* ones.
27+
*/
28+
class CopyConstants
29+
{
30+
public function run(): void
31+
{
32+
$file = __DIR__ . '/../src/Model/SubFormFieldRuleAction.php';
33+
$contents = file_get_contents($file);
34+
35+
$constant_1 = " public const TYPE_CHANGE_FIELD_VISIBILITY = 'change-field-visibility';";
36+
$replace_1 = implode("\n", [
37+
$constant_1,
38+
' public const TYPE_FIELD_VISIBILITY = self::TYPE_CHANGE_FIELD_VISIBILITY;',
39+
]);
40+
41+
$constant_2 = " public const TYPE_CHANGE_GROUP_VISIBILITY = 'change-group-visibility';";
42+
$replace_2 = implode("\n", [
43+
$constant_2,
44+
' public const TYPE_GROUP_VISIBILITY = self::TYPE_CHANGE_GROUP_VISIBILITY;',
45+
]);
46+
47+
$contents = str_replace(
48+
$constant_1,
49+
$replace_1,
50+
$contents,
51+
);
52+
53+
$contents = str_replace(
54+
$constant_2,
55+
$replace_2,
56+
$contents,
57+
);
58+
59+
file_put_contents($file, $contents);
60+
}
61+
}
62+
63+
$copier = new CopyConstants();
64+
$copier->run();

docs/Api/AccountApi.md

Lines changed: 53 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -24,28 +24,28 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_
2424
```php
2525
<?php
2626

27-
require_once __DIR__ . "/vendor/autoload.php";
27+
namespace Dropbox\SignSandbox;
2828

29-
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
29+
require_once __DIR__ . '/../vendor/autoload.php';
3030

31-
// Configure HTTP basic authorization: api_key
32-
$config->setUsername("YOUR_API_KEY");
31+
use SplFileObject;
32+
use Dropbox;
3333

34-
// or, configure Bearer (JWT) authorization: oauth2
34+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
35+
$config->setUsername("YOUR_API_KEY");
3536
// $config->setAccessToken("YOUR_ACCESS_TOKEN");
3637

37-
$accountApi = new Dropbox\Sign\Api\AccountApi($config);
38-
39-
$data = new Dropbox\Sign\Model\AccountCreateRequest();
40-
$data->setEmailAddress("newuser@dropboxsign.com");
38+
$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest())
39+
->setEmailAddress("newuser@dropboxsign.com");
4140

4241
try {
43-
$result = $accountApi->accountCreate($data);
44-
print_r($result);
42+
$response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate(
43+
account_create_request: $account_create_request,
44+
);
45+
46+
print_r($response);
4547
} catch (Dropbox\Sign\ApiException $e) {
46-
$error = $e->getResponseObject();
47-
echo "Exception when calling Dropbox Sign API: "
48-
. print_r($error->getError());
48+
echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}";
4949
}
5050

5151
```
@@ -87,25 +87,23 @@ Returns the properties and settings of your Account.
8787
```php
8888
<?php
8989

90-
require_once __DIR__ . "/vendor/autoload.php";
90+
namespace Dropbox\SignSandbox;
9191

92-
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
92+
require_once __DIR__ . '/../vendor/autoload.php';
9393

94-
// Configure HTTP basic authorization: api_key
95-
$config->setUsername("YOUR_API_KEY");
94+
use SplFileObject;
95+
use Dropbox;
9696

97-
// or, configure Bearer (JWT) authorization: oauth2
97+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
98+
$config->setUsername("YOUR_API_KEY");
9899
// $config->setAccessToken("YOUR_ACCESS_TOKEN");
99100

100-
$accountApi = new Dropbox\Sign\Api\AccountApi($config);
101-
102101
try {
103-
$result = $accountApi->accountGet(null, 'jack@example.com');
104-
print_r($result);
102+
$response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet();
103+
104+
print_r($response);
105105
} catch (Dropbox\Sign\ApiException $e) {
106-
$error = $e->getResponseObject();
107-
echo "Exception when calling Dropbox Sign API: "
108-
. print_r($error->getError());
106+
echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}";
109107
}
110108

111109
```
@@ -148,28 +146,29 @@ Updates the properties and settings of your Account. Currently only allows for u
148146
```php
149147
<?php
150148

151-
require_once __DIR__ . "/vendor/autoload.php";
149+
namespace Dropbox\SignSandbox;
152150

153-
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
151+
require_once __DIR__ . '/../vendor/autoload.php';
154152

155-
// Configure HTTP basic authorization: api_key
156-
$config->setUsername("YOUR_API_KEY");
153+
use SplFileObject;
154+
use Dropbox;
157155

158-
// or, configure Bearer (JWT) authorization: oauth2
156+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
157+
$config->setUsername("YOUR_API_KEY");
159158
// $config->setAccessToken("YOUR_ACCESS_TOKEN");
160159

161-
$accountApi = new Dropbox\Sign\Api\AccountApi($config);
162-
163-
$data = new Dropbox\Sign\Model\AccountUpdateRequest();
164-
$data->setCallbackUrl("https://www.example.com/callback");
160+
$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest())
161+
->setCallbackUrl("https://www.example.com/callback")
162+
->setLocale("en-US");
165163

166164
try {
167-
$result = $accountApi->accountUpdate($data);
168-
print_r($result);
165+
$response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate(
166+
account_update_request: $account_update_request,
167+
);
168+
169+
print_r($response);
169170
} catch (Dropbox\Sign\ApiException $e) {
170-
$error = $e->getResponseObject();
171-
echo "Exception when calling Dropbox Sign API: "
172-
. print_r($error->getError());
171+
echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}";
173172
}
174173

175174
```
@@ -211,28 +210,28 @@ Verifies whether an Dropbox Sign Account exists for the given email address.
211210
```php
212211
<?php
213212

214-
require_once __DIR__ . "/vendor/autoload.php";
213+
namespace Dropbox\SignSandbox;
215214

216-
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
215+
require_once __DIR__ . '/../vendor/autoload.php';
217216

218-
// Configure HTTP basic authorization: api_key
219-
$config->setUsername("YOUR_API_KEY");
217+
use SplFileObject;
218+
use Dropbox;
220219

221-
// or, configure Bearer (JWT) authorization: oauth2
220+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
221+
$config->setUsername("YOUR_API_KEY");
222222
// $config->setAccessToken("YOUR_ACCESS_TOKEN");
223223

224-
$accountApi = new Dropbox\Sign\Api\AccountApi($config);
225-
226-
$data = new Dropbox\Sign\Model\AccountVerifyRequest();
227-
$data->setEmailAddress("some_user@dropboxsign.com");
224+
$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest())
225+
->setEmailAddress("some_user@dropboxsign.com");
228226

229227
try {
230-
$result = $accountApi->accountVerify($data);
231-
print_r($result);
228+
$response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify(
229+
account_verify_request: $account_verify_request,
230+
);
231+
232+
print_r($response);
232233
} catch (Dropbox\Sign\ApiException $e) {
233-
$error = $e->getResponseObject();
234-
echo "Exception when calling Dropbox Sign API: "
235-
. print_r($error->getError());
234+
echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}";
236235
}
237236

238237
```

0 commit comments

Comments
 (0)