Skip to content

Commit

Permalink
Release 1.3.0 (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
jtreminio-dropbox authored Jan 29, 2024
1 parent 6b7a05d commit 6dae958
Show file tree
Hide file tree
Showing 41 changed files with 226 additions and 192 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.2.3
1.3.0
2 changes: 1 addition & 1 deletion api/apis.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export const queryParamsSerializer = (params) => {

export { RequestFile } from "../model";

export const USER_AGENT = "OpenAPI-Generator/1.2.3/node";
export const USER_AGENT = "OpenAPI-Generator/1.3.0/node";

/**
* Generates an object containing form data.
Expand Down
9 changes: 9 additions & 0 deletions api/signatureRequestApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1218,10 +1218,12 @@ export class SignatureRequestApi {
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
* @summary Download Files as File Url
* @param signatureRequestId The id of the SignatureRequest to retrieve.
* @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.
* @param options
*/
public async signatureRequestFilesAsFileUrl(
signatureRequestId: string,
forceDownload?: number,
options: optionsI = { headers: {} }
): Promise<returnTypeT<FileResponse>> {
const localVarPath =
Expand Down Expand Up @@ -1252,6 +1254,13 @@ export class SignatureRequestApi {
);
}

if (forceDownload !== undefined) {
localVarQueryParameters["force_download"] = ObjectSerializer.serialize(
forceDownload,
"number"
);
}

(<any>Object).assign(localVarHeaderParams, options.headers);

let localVarUseFormData = false;
Expand Down
9 changes: 9 additions & 0 deletions api/templateApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1055,10 +1055,12 @@ export class TemplateApi {
* Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
* @summary Get Template Files as File Url
* @param templateId The id of the template files to retrieve.
* @param forceDownload By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser.
* @param options
*/
public async templateFilesAsFileUrl(
templateId: string,
forceDownload?: number,
options: optionsI = { headers: {} }
): Promise<returnTypeT<FileResponse>> {
const localVarPath =
Expand Down Expand Up @@ -1089,6 +1091,13 @@ export class TemplateApi {
);
}

if (forceDownload !== undefined) {
localVarQueryParameters["force_download"] = ObjectSerializer.serialize(
forceDownload,
"number"
);
}

(<any>Object).assign(localVarHeaderParams, options.headers);

let localVarUseFormData = false;
Expand Down
30 changes: 24 additions & 6 deletions dist/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -26492,7 +26492,7 @@ TemplateCreateResponse.attributeTypeMap = [
{
name: "template",
baseName: "template",
type: "TemplateCreateResponse"
type: "TemplateCreateResponseTemplate"
},
{
name: "warnings",
Expand Down Expand Up @@ -28086,6 +28086,7 @@ var _UnclaimedDraftCreateEmbeddedWithTemplateRequest = class {
this["skipMeNow"] = false;
this["testMode"] = false;
this["populateAutoFillFields"] = false;
this["allowCcs"] = false;
}
static getAttributeTypeMap() {
return _UnclaimedDraftCreateEmbeddedWithTemplateRequest.attributeTypeMap;
Expand Down Expand Up @@ -28244,6 +28245,11 @@ UnclaimedDraftCreateEmbeddedWithTemplateRequest.attributeTypeMap = [
name: "populateAutoFillFields",
baseName: "populate_auto_fill_fields",
type: "boolean"
},
{
name: "allowCcs",
baseName: "allow_ccs",
type: "boolean"
}
];

Expand Down Expand Up @@ -31907,8 +31913,8 @@ var SignatureRequestApi = class {
});
});
}
signatureRequestFilesAsFileUrl(_0) {
return __async(this, arguments, function* (signatureRequestId, options = { headers: {} }) {
signatureRequestFilesAsFileUrl(_0, _1) {
return __async(this, arguments, function* (signatureRequestId, forceDownload, options = { headers: {} }) {
const localVarPath = this.basePath + "/signature_request/files_as_file_url/{signature_request_id}".replace(
"{signature_request_id}",
encodeURIComponent(String(signatureRequestId))
Expand All @@ -31931,6 +31937,12 @@ var SignatureRequestApi = class {
"Required parameter signatureRequestId was null or undefined when calling signatureRequestFilesAsFileUrl."
);
}
if (forceDownload !== void 0) {
localVarQueryParameters["force_download"] = ObjectSerializer.serialize(
forceDownload,
"number"
);
}
Object.assign(localVarHeaderParams, options.headers);
let localVarUseFormData = false;
let localVarRequestOptions = {
Expand Down Expand Up @@ -34800,8 +34812,8 @@ var TemplateApi = class {
});
});
}
templateFilesAsFileUrl(_0) {
return __async(this, arguments, function* (templateId, options = { headers: {} }) {
templateFilesAsFileUrl(_0, _1) {
return __async(this, arguments, function* (templateId, forceDownload, options = { headers: {} }) {
const localVarPath = this.basePath + "/template/files_as_file_url/{template_id}".replace(
"{template_id}",
encodeURIComponent(String(templateId))
Expand All @@ -34824,6 +34836,12 @@ var TemplateApi = class {
"Required parameter templateId was null or undefined when calling templateFilesAsFileUrl."
);
}
if (forceDownload !== void 0) {
localVarQueryParameters["force_download"] = ObjectSerializer.serialize(
forceDownload,
"number"
);
}
Object.assign(localVarHeaderParams, options.headers);
let localVarUseFormData = false;
let localVarRequestOptions = {
Expand Down Expand Up @@ -35962,7 +35980,7 @@ var HttpError = class extends Error {
var queryParamsSerializer = (params) => {
return import_qs.default.stringify(params, { arrayFormat: "brackets" });
};
var USER_AGENT = "OpenAPI-Generator/1.2.3/node";
var USER_AGENT = "OpenAPI-Generator/1.3.0/node";
var generateFormData = (obj, typemap) => {
const data = {};
let localVarUseFormData = false;
Expand Down
12 changes: 4 additions & 8 deletions docs/api/ApiAppApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ Creates a new API App.

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const apiAppApi = new DropboxSign.ApiAppApi();

Expand Down Expand Up @@ -71,8 +70,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const apiAppApi = new DropboxSign.ApiAppApi();

Expand Down Expand Up @@ -402,8 +400,7 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const apiAppApi = new DropboxSign.ApiAppApi();

Expand Down Expand Up @@ -441,8 +438,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const apiAppApi = new DropboxSign.ApiAppApi();

Expand Down
15 changes: 6 additions & 9 deletions docs/api/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -468,8 +468,7 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const signatureRequestApi = new DropboxSign.SignatureRequestApi();

Expand Down Expand Up @@ -528,8 +527,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const signatureRequestApi = new DropboxSign.SignatureRequestApi();

Expand Down Expand Up @@ -910,7 +908,7 @@ result.then(response => {
## `signatureRequestFilesAsFileUrl()`

```typescript
signatureRequestFilesAsFileUrl(signatureRequestId: string): FileResponse
signatureRequestFilesAsFileUrl(signatureRequestId: string, forceDownload: number): FileResponse
```

Download Files as File Url
Expand Down Expand Up @@ -972,6 +970,7 @@ result.then(response => {
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **signatureRequestId** | **string**| The id of the SignatureRequest to retrieve. | |
| **forceDownload** | **number**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] |

### Return type

Expand Down Expand Up @@ -1433,8 +1432,7 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const signatureRequestApi = new DropboxSign.SignatureRequestApi();

Expand Down Expand Up @@ -1522,8 +1520,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const signatureRequestApi = new DropboxSign.SignatureRequestApi();

Expand Down
21 changes: 8 additions & 13 deletions docs/api/TemplateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,7 @@ Creates a template that can then be used.

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const templateApi = new DropboxSign.TemplateApi();

Expand Down Expand Up @@ -191,8 +190,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const templateApi = new DropboxSign.TemplateApi();

Expand Down Expand Up @@ -292,8 +290,7 @@ The first step in an embedded template workflow. Creates a draft template that c

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const templateApi = new DropboxSign.TemplateApi();

Expand Down Expand Up @@ -360,8 +357,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const templateApi = new DropboxSign.TemplateApi();

Expand Down Expand Up @@ -704,7 +700,7 @@ result.then(response => {
## `templateFilesAsFileUrl()`

```typescript
templateFilesAsFileUrl(templateId: string): FileResponse
templateFilesAsFileUrl(templateId: string, forceDownload: number): FileResponse
```

Get Template Files as File Url
Expand Down Expand Up @@ -766,6 +762,7 @@ result.then(response => {
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **templateId** | **string**| The id of the template files to retrieve. | |
| **forceDownload** | **number**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] |

### Return type

Expand Down Expand Up @@ -1059,8 +1056,7 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import fs from "fs";

const templateApi = new DropboxSign.TemplateApi();

Expand Down Expand Up @@ -1090,8 +1086,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const templateApi = new DropboxSign.TemplateApi();

Expand Down
12 changes: 4 additions & 8 deletions docs/api/UnclaimedDraftApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi();

Expand Down Expand Up @@ -95,8 +94,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi();

Expand Down Expand Up @@ -199,8 +197,7 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs

```typescript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi();

Expand Down Expand Up @@ -231,8 +228,7 @@ result.then(response => {

```javascript
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi();

Expand Down
2 changes: 1 addition & 1 deletion docs/model/TemplateCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `template` | [```TemplateCreateResponse```](TemplateCreateResponse.md) | | |
| `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,6 @@ Name | Type | Description | Notes
| `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
| `allowCcs` | ```boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
3 changes: 1 addition & 2 deletions examples/ApiAppCreate.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const apiAppApi = new DropboxSign.ApiAppApi();

Expand Down
3 changes: 1 addition & 2 deletions examples/ApiAppCreate.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import * as DropboxSign from "@dropbox/sign";

const fs = require('fs');
import * as fs from 'fs';

const apiAppApi = new DropboxSign.ApiAppApi();

Expand Down
Loading

0 comments on commit 6dae958

Please sign in to comment.