Skip to content

Commit 0db4ab1

Browse files
jtreminio-dropboxjtreminio-dropbox
authored
Release 1.7.0 (#13)
1 parent d835369 commit 0db4ab1

File tree

67 files changed

+6778
-753
lines changed

Some content is hidden

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

67 files changed

+6778
-753
lines changed

‎.github/workflows/github-actions.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ jobs:
1919

2020
- name: Build SDK
2121
run: ./run-build
22+
env:
23+
DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}}
24+
DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}}
2225

2326
- name: Ensure no changes in Generated Code
2427
run: ./bin/check-clean-git-status

‎README.md‎

Lines changed: 14 additions & 4 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.3.0"
56+
"dropbox/sign": "^1.7.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.3.0
67+
composer require dropbox/sign:^1.7.0
6868
```
6969

7070
## Getting Started
@@ -160,6 +160,11 @@ All URIs are relative to *https://api.hellosign.com/v3*
160160
| *BulkSendJobApi* | [**bulkSendJobList**](docs/Api/BulkSendJobApi.md#bulksendjoblist) | **GET** /bulk_send_job/list | List Bulk Send Jobs |
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 |
163+
| *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 |
165+
| *FaxApi* | [**faxGet**](docs/Api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax |
166+
| *FaxApi* | [**faxList**](docs/Api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes |
167+
| *FaxApi* | [**faxSend**](docs/Api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax |
163168
| *FaxLineApi* | [**faxLineAddUser**](docs/Api/FaxLineApi.md#faxlineadduser) | **PUT** /fax_line/add_user | Add Fax Line User |
164169
| *FaxLineApi* | [**faxLineAreaCodeGet**](docs/Api/FaxLineApi.md#faxlineareacodeget) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes |
165170
| *FaxLineApi* | [**faxLineCreate**](docs/Api/FaxLineApi.md#faxlinecreate) | **POST** /fax_line/create | Purchase Fax Line |
@@ -197,7 +202,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
197202
| *TeamApi* | [**teamSubTeams**](docs/Api/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams |
198203
| *TeamApi* | [**teamUpdate**](docs/Api/TeamApi.md#teamupdate) | **PUT** /team | Update Team |
199204
| *TemplateApi* | [**templateAddUser**](docs/Api/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template |
200-
| *TemplateApi* | [**templateCreate**](docs/Api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template |
205+
| *TemplateApi* | [**templateCreate**](docs/Api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template |
201206
| *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/Api/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
202207
| *TemplateApi* | [**templateDelete**](docs/Api/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template |
203208
| *TemplateApi* | [**templateFiles**](docs/Api/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files |
@@ -249,6 +254,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
249254
- [EventCallbackRequest](docs/Model/EventCallbackRequest.md)
250255
- [EventCallbackRequestEvent](docs/Model/EventCallbackRequestEvent.md)
251256
- [EventCallbackRequestEventMetadata](docs/Model/EventCallbackRequestEventMetadata.md)
257+
- [FaxGetResponse](docs/Model/FaxGetResponse.md)
252258
- [FaxLineAddUserRequest](docs/Model/FaxLineAddUserRequest.md)
253259
- [FaxLineAreaCodeGetCountryEnum](docs/Model/FaxLineAreaCodeGetCountryEnum.md)
254260
- [FaxLineAreaCodeGetProvinceEnum](docs/Model/FaxLineAreaCodeGetProvinceEnum.md)
@@ -260,6 +266,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
260266
- [FaxLineRemoveUserRequest](docs/Model/FaxLineRemoveUserRequest.md)
261267
- [FaxLineResponse](docs/Model/FaxLineResponse.md)
262268
- [FaxLineResponseFaxLine](docs/Model/FaxLineResponseFaxLine.md)
269+
- [FaxListResponse](docs/Model/FaxListResponse.md)
270+
- [FaxResponse](docs/Model/FaxResponse.md)
271+
- [FaxResponseTransmission](docs/Model/FaxResponseTransmission.md)
272+
- [FaxSendRequest](docs/Model/FaxSendRequest.md)
263273
- [FileResponse](docs/Model/FileResponse.md)
264274
- [FileResponseDataUri](docs/Model/FileResponseDataUri.md)
265275
- [ListInfoResponse](docs/Model/ListInfoResponse.md)
@@ -429,6 +439,6 @@ [email protected]
429439
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
430440

431441
- API version: `3.0.0`
432-
- Package version: `1.6.1`
442+
- Package version: `1.7.0`
433443
- Generator version: `7.8.0`
434444
- 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.6.1
1+
1.7.0

‎docs/Api/FaxApi.md‎

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
1+
# Dropbox\Sign\FaxApi
2+
3+
All URIs are relative to https://api.hellosign.com/v3.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**faxDelete()**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax |
8+
| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files |
9+
| [**faxGet()**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax |
10+
| [**faxList()**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes |
11+
| [**faxSend()**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax |
12+
13+
14+
## `faxDelete()`
15+
16+
```php
17+
faxDelete($fax_id)
18+
```
19+
Delete Fax
20+
21+
Deletes the specified Fax from the system.
22+
23+
### Example
24+
25+
```php
26+
<?php
27+
28+
require_once __DIR__ . "/vendor/autoload.php";
29+
30+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
31+
32+
// Configure HTTP basic authorization: api_key
33+
$config->setUsername("YOUR_API_KEY");
34+
35+
$faxApi = new Dropbox\Sign\Api\FaxApi($config);
36+
37+
try {
38+
$faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967");
39+
} catch (Dropbox\Sign\ApiException $e) {
40+
$error = $e->getResponseObject();
41+
echo "Exception when calling Dropbox Sign API: "
42+
. print_r($error->getError());
43+
}
44+
45+
```
46+
47+
### Parameters
48+
49+
|Name | Type | Description | Notes |
50+
| ------------- | ------------- | ------------- | ------------- |
51+
| **fax_id** | **string**| Fax ID | |
52+
53+
### Return type
54+
55+
void (empty response body)
56+
57+
### Authorization
58+
59+
[api_key](../../README.md#api_key)
60+
61+
### HTTP request headers
62+
63+
- **Content-Type**: Not defined
64+
- **Accept**: `application/json`
65+
66+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
67+
[[Back to Model list]](../../README.md#models)
68+
[[Back to README]](../../README.md)
69+
70+
## `faxFiles()`
71+
72+
```php
73+
faxFiles($fax_id): \SplFileObject
74+
```
75+
List Fax Files
76+
77+
Returns list of fax files
78+
79+
### Example
80+
81+
```php
82+
<?php
83+
84+
require_once __DIR__ . "/vendor/autoload.php";
85+
86+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
87+
88+
// Configure HTTP basic authorization: api_key
89+
$config->setUsername("YOUR_API_KEY");
90+
91+
$faxApi = new Dropbox\Sign\Api\FaxApi($config);
92+
93+
$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
94+
95+
try {
96+
$result = $faxApi->faxFiles($faxId);
97+
copy($result->getRealPath(), __DIR__ . '/file_response.pdf');
98+
} catch (Dropbox\Sign\ApiException $e) {
99+
$error = $e->getResponseObject();
100+
echo "Exception when calling Dropbox Sign API: "
101+
. print_r($error->getError());
102+
}
103+
104+
```
105+
106+
### Parameters
107+
108+
|Name | Type | Description | Notes |
109+
| ------------- | ------------- | ------------- | ------------- |
110+
| **fax_id** | **string**| Fax ID | |
111+
112+
### Return type
113+
114+
**\SplFileObject**
115+
116+
### Authorization
117+
118+
[api_key](../../README.md#api_key)
119+
120+
### HTTP request headers
121+
122+
- **Content-Type**: Not defined
123+
- **Accept**: `application/pdf`, `application/json`
124+
125+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
126+
[[Back to Model list]](../../README.md#models)
127+
[[Back to README]](../../README.md)
128+
129+
## `faxGet()`
130+
131+
```php
132+
faxGet($fax_id): \Dropbox\Sign\Model\FaxGetResponse
133+
```
134+
Get Fax
135+
136+
Returns information about fax
137+
138+
### Example
139+
140+
```php
141+
<?php
142+
143+
require_once __DIR__ . "/vendor/autoload.php";
144+
145+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
146+
147+
// Configure HTTP basic authorization: api_key
148+
$config->setUsername("YOUR_API_KEY");
149+
150+
$faxApi = new Dropbox\Sign\Api\FaxApi($config);
151+
152+
$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
153+
154+
try {
155+
$result = $faxApi->faxGet($faxId);
156+
print_r($result);
157+
} catch (Dropbox\Sign\ApiException $e) {
158+
$error = $e->getResponseObject();
159+
echo "Exception when calling Dropbox Sign API: "
160+
. print_r($error->getError());
161+
}
162+
163+
```
164+
165+
### Parameters
166+
167+
|Name | Type | Description | Notes |
168+
| ------------- | ------------- | ------------- | ------------- |
169+
| **fax_id** | **string**| Fax ID | |
170+
171+
### Return type
172+
173+
[**\Dropbox\Sign\Model\FaxGetResponse**](../Model/FaxGetResponse.md)
174+
175+
### Authorization
176+
177+
[api_key](../../README.md#api_key)
178+
179+
### HTTP request headers
180+
181+
- **Content-Type**: Not defined
182+
- **Accept**: `application/json`
183+
184+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
185+
[[Back to Model list]](../../README.md#models)
186+
[[Back to README]](../../README.md)
187+
188+
## `faxList()`
189+
190+
```php
191+
faxList($page, $page_size): \Dropbox\Sign\Model\FaxListResponse
192+
```
193+
Lists Faxes
194+
195+
Returns properties of multiple faxes
196+
197+
### Example
198+
199+
```php
200+
<?php
201+
202+
require_once __DIR__ . "/vendor/autoload.php";
203+
204+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
205+
206+
// Configure HTTP basic authorization: api_key
207+
$config->setUsername("YOUR_API_KEY");
208+
209+
$faxApi = new Dropbox\Sign\Api\FaxApi($config);
210+
211+
$page = 1;
212+
$pageSize = 2;
213+
214+
try {
215+
$result = $faxApi->faxList($page, $pageSize);
216+
print_r($result);
217+
} catch (Dropbox\Sign\ApiException $e) {
218+
$error = $e->getResponseObject();
219+
echo "Exception when calling Dropbox Sign API: "
220+
. print_r($error->getError());
221+
}
222+
223+
```
224+
225+
### Parameters
226+
227+
|Name | Type | Description | Notes |
228+
| ------------- | ------------- | ------------- | ------------- |
229+
| **page** | **int**| Page | [optional] [default to 1] |
230+
| **page_size** | **int**| Page size | [optional] [default to 20] |
231+
232+
### Return type
233+
234+
[**\Dropbox\Sign\Model\FaxListResponse**](../Model/FaxListResponse.md)
235+
236+
### Authorization
237+
238+
[api_key](../../README.md#api_key)
239+
240+
### HTTP request headers
241+
242+
- **Content-Type**: Not defined
243+
- **Accept**: `application/json`
244+
245+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
246+
[[Back to Model list]](../../README.md#models)
247+
[[Back to README]](../../README.md)
248+
249+
## `faxSend()`
250+
251+
```php
252+
faxSend($fax_send_request): \Dropbox\Sign\Model\FaxGetResponse
253+
```
254+
Send Fax
255+
256+
Action to prepare and send a fax
257+
258+
### Example
259+
260+
```php
261+
<?php
262+
263+
require_once __DIR__ . "/vendor/autoload.php";
264+
265+
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
266+
267+
// Configure HTTP basic authorization: api_key
268+
$config->setUsername("YOUR_API_KEY");
269+
270+
$faxApi = new Dropbox\Sign\Api\FaxApi($config);
271+
272+
$data = new Dropbox\Sign\Model\FaxSendRequest();
273+
$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")])
274+
->setTestMode(true)
275+
->setRecipient("16690000001")
276+
->setSender("16690000000")
277+
->setCoverPageTo("Jill Fax")
278+
->setCoverPageMessage("I'm sending you a fax!")
279+
->setCoverPageFrom("Faxer Faxerson")
280+
->setTitle("This is what the fax is about!");
281+
282+
try {
283+
$result = $faxApi->faxSend($data);
284+
print_r($result);
285+
} catch (Dropbox\Sign\ApiException $e) {
286+
$error = $e->getResponseObject();
287+
echo "Exception when calling Dropbox Sign API: "
288+
. print_r($error->getError());
289+
}
290+
291+
```
292+
293+
### Parameters
294+
295+
|Name | Type | Description | Notes |
296+
| ------------- | ------------- | ------------- | ------------- |
297+
| **fax_send_request** | [**\Dropbox\Sign\Model\FaxSendRequest**](../Model/FaxSendRequest.md)| | |
298+
299+
### Return type
300+
301+
[**\Dropbox\Sign\Model\FaxGetResponse**](../Model/FaxGetResponse.md)
302+
303+
### Authorization
304+
305+
[api_key](../../README.md#api_key)
306+
307+
### HTTP request headers
308+
309+
- **Content-Type**: `application/json`, `multipart/form-data`
310+
- **Accept**: `application/json`
311+
312+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
313+
[[Back to Model list]](../../README.md#models)
314+
[[Back to README]](../../README.md)

0 commit comments

Comments
 (0)