diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 9d03938..f9f3ba3 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -19,6 +19,9 @@ jobs: - name: Build SDK run: ./run-build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status @@ -99,4 +102,3 @@ jobs: ref: "refs/tags/" + process.env.PACKAGE_VERSION, sha: context.sha }) - diff --git a/README.md b/README.md index 4aca5d2..bfee788 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,11 @@ All URIs are relative to *https://api.hellosign.com/v3* | *BulkSendJobApi* | [**bulkSendJobList**](./docs/api/BulkSendJobApi.md#bulksendjoblist) | **GET** /bulk_send_job/list | List Bulk Send Jobs | | *EmbeddedApi* | [**embeddedEditUrl**](./docs/api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](./docs/api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | +| *FaxApi* | [**faxDelete**](./docs/api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxGet**](./docs/api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | +| *FaxApi* | [**faxList**](./docs/api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | +| *FaxApi* | [**faxSend**](./docs/api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | | *FaxLineApi* | [**faxLineAddUser**](./docs/api/FaxLineApi.md#faxlineadduser) | **PUT** /fax_line/add_user | Add Fax Line User | | *FaxLineApi* | [**faxLineAreaCodeGet**](./docs/api/FaxLineApi.md#faxlineareacodeget) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes | | *FaxLineApi* | [**faxLineCreate**](./docs/api/FaxLineApi.md#faxlinecreate) | **POST** /fax_line/create | Purchase Fax Line | @@ -157,7 +162,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *TeamApi* | [**teamSubTeams**](./docs/api/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | | *TeamApi* | [**teamUpdate**](./docs/api/TeamApi.md#teamupdate) | **PUT** /team | Update Team | | *TemplateApi* | [**templateAddUser**](./docs/api/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| *TemplateApi* | [**templateCreate**](./docs/api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| *TemplateApi* | [**templateCreate**](./docs/api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | *TemplateApi* | [**templateCreateEmbeddedDraft**](./docs/api/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | *TemplateApi* | [**templateDelete**](./docs/api/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | *TemplateApi* | [**templateFiles**](./docs/api/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -208,6 +213,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [EventCallbackRequest](./docs/model/EventCallbackRequest.md) - [EventCallbackRequestEvent](./docs/model/EventCallbackRequestEvent.md) - [EventCallbackRequestEventMetadata](./docs/model/EventCallbackRequestEventMetadata.md) +- [FaxGetResponse](./docs/model/FaxGetResponse.md) - [FaxLineAddUserRequest](./docs/model/FaxLineAddUserRequest.md) - [FaxLineAreaCodeGetCountryEnum](./docs/model/FaxLineAreaCodeGetCountryEnum.md) - [FaxLineAreaCodeGetProvinceEnum](./docs/model/FaxLineAreaCodeGetProvinceEnum.md) @@ -219,6 +225,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [FaxLineRemoveUserRequest](./docs/model/FaxLineRemoveUserRequest.md) - [FaxLineResponse](./docs/model/FaxLineResponse.md) - [FaxLineResponseFaxLine](./docs/model/FaxLineResponseFaxLine.md) +- [FaxListResponse](./docs/model/FaxListResponse.md) +- [FaxResponse](./docs/model/FaxResponse.md) +- [FaxResponseTransmission](./docs/model/FaxResponseTransmission.md) +- [FaxSendRequest](./docs/model/FaxSendRequest.md) - [FileResponse](./docs/model/FileResponse.md) - [FileResponseDataUri](./docs/model/FileResponseDataUri.md) - [ListInfoResponse](./docs/model/ListInfoResponse.md) diff --git a/VERSION b/VERSION index fdd3be6..bd8bf88 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.6.2 +1.7.0 diff --git a/api/apis.ts b/api/apis.ts index 9a6b328..881cc66 100644 --- a/api/apis.ts +++ b/api/apis.ts @@ -38,7 +38,7 @@ export const queryParamsSerializer = (params) => { return Qs.stringify(params, { arrayFormat: "brackets" }); }; -export const USER_AGENT = "OpenAPI-Generator/1.6.2/node"; +export const USER_AGENT = "OpenAPI-Generator/1.7.0/node"; /** * Generates an object containing form data. diff --git a/api/faxApi.ts b/api/faxApi.ts new file mode 100644 index 0000000..dd9c6df --- /dev/null +++ b/api/faxApi.ts @@ -0,0 +1,779 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from "axios"; + +import { + Authentication, + FaxGetResponse, + FaxListResponse, + FaxSendRequest, + HttpBasicAuth, + HttpBearerAuth, + Interceptor, + ObjectSerializer, + VoidAuth, +} from "../model"; + +import { + generateFormData, + HttpError, + optionsI, + queryParamsSerializer, + returnTypeI, + returnTypeT, + toFormData, + USER_AGENT, +} from "./"; + +let defaultBasePath = "https://api.hellosign.com/v3"; + +// =============================================== +// This file is autogenerated - Please do not edit +// =============================================== + +export enum FaxApiApiKeys {} + +export class FaxApi { + protected _basePath = defaultBasePath; + protected _defaultHeaders: any = { "User-Agent": USER_AGENT }; + protected _useQuerystring: boolean = false; + + protected authentications = { + default: new VoidAuth(), + api_key: new HttpBasicAuth(), + oauth2: new HttpBearerAuth(), + }; + + protected interceptors: Interceptor[] = []; + + constructor(basePath?: string) { + if (basePath) { + this.basePath = basePath; + } + } + + set useQuerystring(value: boolean) { + this._useQuerystring = value; + } + + set basePath(basePath: string) { + this._basePath = basePath; + } + + set defaultHeaders(defaultHeaders: any) { + this._defaultHeaders = { ...defaultHeaders, "User-Agent": USER_AGENT }; + } + + get defaultHeaders() { + return this._defaultHeaders; + } + + get basePath() { + return this._basePath; + } + + public setDefaultAuthentication(auth: Authentication) { + this.authentications.default = auth; + } + + public setApiKey(key: string) { + this.authentications.api_key.username = key; + } + + set username(username: string) { + this.authentications.api_key.username = username; + } + + set password(password: string) { + this.authentications.api_key.password = password; + } + + set accessToken(accessToken: string | (() => string)) { + this.authentications.oauth2.accessToken = accessToken; + } + + public addInterceptor(interceptor: Interceptor) { + this.interceptors.push(interceptor); + } + + /** + * Deletes the specified Fax from the system. + * @summary Delete Fax + * @param faxId Fax ID + * @param options + */ + public async faxDelete( + faxId: string, + options: optionsI = { headers: {} } + ): Promise { + const localVarPath = + this.basePath + + "/fax/{fax_id}".replace( + "{" + "fax_id" + "}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxId' is not null or undefined + if (faxId === null || faxId === undefined) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxDelete." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "DELETE", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse(resolve, reject, response); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Returns list of fax files + * @summary List Fax Files + * @param faxId Fax ID + * @param options + */ + public async faxFiles( + faxId: string, + options: optionsI = { headers: {} } + ): Promise> { + const localVarPath = + this.basePath + + "/fax/files/{fax_id}".replace( + "{" + "fax_id" + "}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/pdf", "application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxId' is not null or undefined + if (faxId === null || faxId === undefined) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxFiles." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "arraybuffer", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "Buffer" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "RequestFile" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Returns information about fax + * @summary Get Fax + * @param faxId Fax ID + * @param options + */ + public async faxGet( + faxId: string, + options: optionsI = { headers: {} } + ): Promise> { + const localVarPath = + this.basePath + + "/fax/{fax_id}".replace( + "{" + "fax_id" + "}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxId' is not null or undefined + if (faxId === null || faxId === undefined) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxGet." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "FaxGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Returns properties of multiple faxes + * @summary Lists Faxes + * @param page Page + * @param pageSize Page size + * @param options + */ + public async faxList( + page?: number, + pageSize?: number, + options: optionsI = { headers: {} } + ): Promise> { + const localVarPath = this.basePath + "/fax/list"; + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + if (page !== undefined) { + localVarQueryParameters["page"] = ObjectSerializer.serialize( + page, + "number" + ); + } + + if (pageSize !== undefined) { + localVarQueryParameters["page_size"] = ObjectSerializer.serialize( + pageSize, + "number" + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "FaxListResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "FaxListResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Action to prepare and send a fax + * @summary Send Fax + * @param faxSendRequest + * @param options + */ + public async faxSend( + faxSendRequest: FaxSendRequest, + options: optionsI = { headers: {} } + ): Promise> { + faxSendRequest = deserializeIfNeeded(faxSendRequest, "FaxSendRequest"); + const localVarPath = this.basePath + "/fax/send"; + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxSendRequest' is not null or undefined + if (faxSendRequest === null || faxSendRequest === undefined) { + throw new Error( + "Required parameter faxSendRequest was null or undefined when calling faxSend." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + const result = generateFormData( + faxSendRequest, + FaxSendRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + + let data = {}; + if (localVarUseFormData) { + const formData = toFormData(result.data); + data = formData; + localVarHeaderParams = { + ...localVarHeaderParams, + ...formData.getHeaders(), + }; + } else { + data = ObjectSerializer.serialize(faxSendRequest, "FaxSendRequest"); + } + + let localVarRequestOptions: AxiosRequestConfig = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data, + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "FaxGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } +} + +function deserializeIfNeeded(obj: T, classname: string): T { + if (obj !== null && obj !== undefined && obj.constructor.name !== classname) { + return ObjectSerializer.deserialize(obj, classname); + } + + return obj; +} + +type AxiosResolve = ( + value: returnTypeT | PromiseLike> +) => void; + +type AxiosReject = (reason?: any) => void; + +function handleSuccessfulResponse( + resolve: AxiosResolve, + reject: AxiosReject, + response: AxiosResponse, + returnType?: string +) { + let body = response.data; + + if (response.status && response.status >= 200 && response.status <= 299) { + if (returnType) { + body = ObjectSerializer.deserialize(body, returnType); + } + + resolve({ response: response, body: body }); + } else { + reject(new HttpError(response, body, response.status)); + } +} + +function handleErrorCodeResponse( + reject: AxiosReject, + response: AxiosResponse, + code: number, + returnType: string +): boolean { + if (response.status !== code) { + return false; + } + + const body = ObjectSerializer.deserialize(response.data, returnType); + + reject(new HttpError(response, body, response.status)); + + return true; +} + +function handleErrorRangeResponse( + reject: AxiosReject, + response: AxiosResponse, + code: string, + returnType: string +): boolean { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + + reject(new HttpError(response, body, response.status)); + + return true; + } + + return false; +} diff --git a/api/index.ts b/api/index.ts index 1304b00..d32b5b1 100644 --- a/api/index.ts +++ b/api/index.ts @@ -2,6 +2,7 @@ import { AccountApi } from "./accountApi"; import { ApiAppApi } from "./apiAppApi"; import { BulkSendJobApi } from "./bulkSendJobApi"; import { EmbeddedApi } from "./embeddedApi"; +import { FaxApi } from "./faxApi"; import { FaxLineApi } from "./faxLineApi"; import { OAuthApi } from "./oAuthApi"; import { ReportApi } from "./reportApi"; @@ -15,6 +16,7 @@ export { ApiAppApi, BulkSendJobApi, EmbeddedApi, + FaxApi, FaxLineApi, OAuthApi, ReportApi, @@ -40,6 +42,7 @@ export const APIS = [ ApiAppApi, BulkSendJobApi, EmbeddedApi, + FaxApi, FaxLineApi, OAuthApi, ReportApi, diff --git a/api/oAuthApi.ts b/api/oAuthApi.ts index c1b0803..1478d53 100644 --- a/api/oAuthApi.ts +++ b/api/oAuthApi.ts @@ -236,6 +236,17 @@ export class OAuthApi { return; } + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + reject(error); } ); @@ -361,6 +372,17 @@ export class OAuthApi { return; } + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + reject(error); } ); diff --git a/api/signatureRequestApi.ts b/api/signatureRequestApi.ts index 51ccd93..3fd0d61 100644 --- a/api/signatureRequestApi.ts +++ b/api/signatureRequestApi.ts @@ -422,7 +422,7 @@ export class SignatureRequestApi { }); } /** - * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. * @summary Cancel Incomplete Signature Request * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. * @param options diff --git a/api/templateApi.ts b/api/templateApi.ts index 50ff0b4..35ac246 100644 --- a/api/templateApi.ts +++ b/api/templateApi.ts @@ -291,7 +291,7 @@ export class TemplateApi { } /** * Creates a template that can then be used. - * @summary Create Template + * @summary Create Template * @param templateCreateRequest * @param options */ diff --git a/dist/api.js b/dist/api.js index a97d30e..0d28dcd 100644 --- a/dist/api.js +++ b/dist/api.js @@ -12976,6 +12976,8 @@ __export(api_exports, { EventCallbackRequest: () => EventCallbackRequest, EventCallbackRequestEvent: () => EventCallbackRequestEvent, EventCallbackRequestEventMetadata: () => EventCallbackRequestEventMetadata, + FaxApi: () => FaxApi, + FaxGetResponse: () => FaxGetResponse, FaxLineAddUserRequest: () => FaxLineAddUserRequest, FaxLineApi: () => FaxLineApi, FaxLineAreaCodeGetCountryEnum: () => FaxLineAreaCodeGetCountryEnum, @@ -12988,6 +12990,10 @@ __export(api_exports, { FaxLineRemoveUserRequest: () => FaxLineRemoveUserRequest, FaxLineResponse: () => FaxLineResponse, FaxLineResponseFaxLine: () => FaxLineResponseFaxLine, + FaxListResponse: () => FaxListResponse, + FaxResponse: () => FaxResponse, + FaxResponseTransmission: () => FaxResponseTransmission, + FaxSendRequest: () => FaxSendRequest, FileResponse: () => FileResponse, FileResponseDataUri: () => FileResponseDataUri, HttpBasicAuth: () => HttpBasicAuth, @@ -17692,6 +17698,30 @@ EventCallbackRequestEventMetadata.attributeTypeMap = [ } ]; +// model/faxGetResponse.ts +var _FaxGetResponse = class { + static getAttributeTypeMap() { + return _FaxGetResponse.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxGetResponse"); + } +}; +var FaxGetResponse = _FaxGetResponse; +FaxGetResponse.discriminator = void 0; +FaxGetResponse.attributeTypeMap = [ + { + name: "fax", + baseName: "fax", + type: "FaxResponse" + }, + { + name: "warnings", + baseName: "warnings", + type: "Array" + } +]; + // model/faxLineAddUserRequest.ts var _FaxLineAddUserRequest = class { static getAttributeTypeMap() { @@ -17999,6 +18029,203 @@ FaxLineResponseFaxLine.attributeTypeMap = [ } ]; +// model/faxListResponse.ts +var _FaxListResponse = class { + static getAttributeTypeMap() { + return _FaxListResponse.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxListResponse"); + } +}; +var FaxListResponse = _FaxListResponse; +FaxListResponse.discriminator = void 0; +FaxListResponse.attributeTypeMap = [ + { + name: "faxes", + baseName: "faxes", + type: "Array" + }, + { + name: "listInfo", + baseName: "list_info", + type: "ListInfoResponse" + } +]; + +// model/faxResponse.ts +var _FaxResponse = class { + static getAttributeTypeMap() { + return _FaxResponse.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxResponse"); + } +}; +var FaxResponse = _FaxResponse; +FaxResponse.discriminator = void 0; +FaxResponse.attributeTypeMap = [ + { + name: "faxId", + baseName: "fax_id", + type: "string" + }, + { + name: "title", + baseName: "title", + type: "string" + }, + { + name: "originalTitle", + baseName: "original_title", + type: "string" + }, + { + name: "subject", + baseName: "subject", + type: "string" + }, + { + name: "message", + baseName: "message", + type: "string" + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }" + }, + { + name: "createdAt", + baseName: "created_at", + type: "number" + }, + { + name: "sender", + baseName: "sender", + type: "string" + }, + { + name: "transmissions", + baseName: "transmissions", + type: "Array" + }, + { + name: "filesUrl", + baseName: "files_url", + type: "string" + } +]; + +// model/faxResponseTransmission.ts +var _FaxResponseTransmission = class { + static getAttributeTypeMap() { + return _FaxResponseTransmission.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxResponseTransmission"); + } +}; +var FaxResponseTransmission = _FaxResponseTransmission; +FaxResponseTransmission.discriminator = void 0; +FaxResponseTransmission.attributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string" + }, + { + name: "sender", + baseName: "sender", + type: "string" + }, + { + name: "statusCode", + baseName: "status_code", + type: "FaxResponseTransmission.StatusCodeEnum" + }, + { + name: "sentAt", + baseName: "sent_at", + type: "number" + } +]; +((FaxResponseTransmission2) => { + let StatusCodeEnum; + ((StatusCodeEnum2) => { + StatusCodeEnum2["Success"] = "success"; + StatusCodeEnum2["Transmitting"] = "transmitting"; + StatusCodeEnum2["ErrorCouldNotFax"] = "error_could_not_fax"; + StatusCodeEnum2["ErrorUnknown"] = "error_unknown"; + StatusCodeEnum2["ErrorBusy"] = "error_busy"; + StatusCodeEnum2["ErrorNoAnswer"] = "error_no_answer"; + StatusCodeEnum2["ErrorDisconnected"] = "error_disconnected"; + StatusCodeEnum2["ErrorBadDestination"] = "error_bad_destination"; + })(StatusCodeEnum = FaxResponseTransmission2.StatusCodeEnum || (FaxResponseTransmission2.StatusCodeEnum = {})); +})(FaxResponseTransmission || (FaxResponseTransmission = {})); + +// model/faxSendRequest.ts +var _FaxSendRequest = class { + constructor() { + this["testMode"] = false; + } + static getAttributeTypeMap() { + return _FaxSendRequest.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxSendRequest"); + } +}; +var FaxSendRequest = _FaxSendRequest; +FaxSendRequest.discriminator = void 0; +FaxSendRequest.attributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string" + }, + { + name: "sender", + baseName: "sender", + type: "string" + }, + { + name: "files", + baseName: "files", + type: "Array" + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array" + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean" + }, + { + name: "coverPageTo", + baseName: "cover_page_to", + type: "string" + }, + { + name: "coverPageFrom", + baseName: "cover_page_from", + type: "string" + }, + { + name: "coverPageMessage", + baseName: "cover_page_message", + type: "string" + }, + { + name: "title", + baseName: "title", + type: "string" + } +]; + // model/fileResponse.ts var _FileResponse = class { static getAttributeTypeMap() { @@ -18331,6 +18558,16 @@ OAuthTokenRefreshRequest.attributeTypeMap = [ name: "refreshToken", baseName: "refresh_token", type: "string" + }, + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "clientSecret", + baseName: "client_secret", + type: "string" } ]; @@ -21433,20 +21670,20 @@ SubUnclaimedDraftTemplateSigner.attributeTypeMap = [ // model/subWhiteLabelingOptions.ts var _SubWhiteLabelingOptions = class { constructor() { - this["headerBackgroundColor"] = "#1A1A1A"; + this["headerBackgroundColor"] = "#1a1a1a"; this["legalVersion"] = _SubWhiteLabelingOptions.LegalVersionEnum.Terms1; - this["linkColor"] = "#00B3E6"; - this["pageBackgroundColor"] = "#F7F8F9"; - this["primaryButtonColor"] = "#00B3E6"; - this["primaryButtonColorHover"] = "#00B3E6"; - this["primaryButtonTextColor"] = "#FFFFFF"; - this["primaryButtonTextColorHover"] = "#FFFFFF"; - this["secondaryButtonColor"] = "#FFFFFF"; - this["secondaryButtonColorHover"] = "#FFFFFF"; - this["secondaryButtonTextColor"] = "#00B3E6"; - this["secondaryButtonTextColorHover"] = "#00B3E6"; + this["linkColor"] = "#0061FE"; + this["pageBackgroundColor"] = "#f7f8f9"; + this["primaryButtonColor"] = "#0061FE"; + this["primaryButtonColorHover"] = "#0061FE"; + this["primaryButtonTextColor"] = "#ffffff"; + this["primaryButtonTextColorHover"] = "#ffffff"; + this["secondaryButtonColor"] = "#ffffff"; + this["secondaryButtonColorHover"] = "#ffffff"; + this["secondaryButtonTextColor"] = "#0061FE"; + this["secondaryButtonTextColorHover"] = "#0061FE"; this["textColor1"] = "#808080"; - this["textColor2"] = "#FFFFFF"; + this["textColor2"] = "#ffffff"; } static getAttributeTypeMap() { return _SubWhiteLabelingOptions.attributeTypeMap; @@ -22552,6 +22789,11 @@ TemplateResponse.attributeTypeMap = [ name: "accounts", baseName: "accounts", type: "Array" + }, + { + name: "attachments", + baseName: "attachments", + type: "Array" } ]; @@ -22978,11 +23220,6 @@ TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ name: "required", baseName: "required", type: "boolean" - }, - { - name: "group", - baseName: "group", - type: "string" } ]; @@ -23009,6 +23246,11 @@ TemplateResponseDocumentFormFieldCheckbox.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23035,6 +23277,11 @@ TemplateResponseDocumentFormFieldDateSigned.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23061,6 +23308,11 @@ TemplateResponseDocumentFormFieldDropdown.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23107,6 +23359,11 @@ TemplateResponseDocumentFormFieldHyperlink.attributeTypeMap = [ name: "fontFamily", baseName: "fontFamily", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23133,6 +23390,11 @@ TemplateResponseDocumentFormFieldInitials.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23159,6 +23421,11 @@ TemplateResponseDocumentFormFieldRadio.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23185,6 +23452,11 @@ TemplateResponseDocumentFormFieldSignature.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23236,6 +23508,11 @@ TemplateResponseDocumentFormFieldText.attributeTypeMap = [ name: "validationType", baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; ((TemplateResponseDocumentFormFieldText2) => { @@ -24412,6 +24689,7 @@ var enumsMap = { FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetStateEnum, "FaxLineCreateRequest.CountryEnum": FaxLineCreateRequest.CountryEnum, + "FaxResponseTransmission.StatusCodeEnum": FaxResponseTransmission.StatusCodeEnum, "ReportCreateRequest.ReportTypeEnum": ReportCreateRequest.ReportTypeEnum, "ReportResponse.ReportTypeEnum": ReportResponse.ReportTypeEnum, SignatureRequestResponseCustomFieldTypeEnum, @@ -24474,6 +24752,7 @@ var typeMap = { EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, + FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetResponse, FaxLineCreateRequest, @@ -24482,6 +24761,10 @@ var typeMap = { FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, + FaxListResponse, + FaxResponse, + FaxResponseTransmission, + FaxSendRequest, FileResponse, FileResponseDataUri, ListInfoResponse, @@ -26342,9 +26625,9 @@ function handleErrorRangeResponse4(reject, response, code, returnType) { return false; } -// api/faxLineApi.ts +// api/faxApi.ts var defaultBasePath5 = "https://api.hellosign.com/v3"; -var FaxLineApi = class { +var FaxApi = class { constructor(basePath) { this._basePath = defaultBasePath5; this._defaultHeaders = { "User-Agent": USER_AGENT }; @@ -26392,13 +26675,12 @@ var FaxLineApi = class { addInterceptor(interceptor) { this.interceptors.push(interceptor); } - faxLineAddUser(_0) { - return __async(this, arguments, function* (faxLineAddUserRequest, options = { headers: {} }) { - faxLineAddUserRequest = deserializeIfNeeded4( - faxLineAddUserRequest, - "FaxLineAddUserRequest" + faxDelete(_0) { + return __async(this, arguments, function* (faxId, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/{fax_id}".replace( + "{fax_id}", + encodeURIComponent(String(faxId)) ); - const localVarPath = this.basePath + "/fax_line/add_user"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -26412,39 +26694,22 @@ var FaxLineApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (faxLineAddUserRequest === null || faxLineAddUserRequest === void 0) { + if (faxId === null || faxId === void 0) { throw new Error( - "Required parameter faxLineAddUserRequest was null or undefined when calling faxLineAddUser." + "Required parameter faxId was null or undefined when calling faxDelete." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; - const result = generateFormData( - faxLineAddUserRequest, - FaxLineAddUserRequest.attributeTypeMap - ); - localVarUseFormData = result.localVarUseFormData; - let data = {}; - if (localVarUseFormData) { - const formData2 = toFormData3(result.data); - data = formData2; - localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); - } else { - data = ObjectSerializer.serialize( - faxLineAddUserRequest, - "FaxLineAddUserRequest" - ); - } let localVarRequestOptions = { - method: "PUT", + method: "DELETE", params: localVarQueryParameters, headers: localVarHeaderParams, url: localVarPath, paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, maxContentLength: Infinity, maxBodyLength: Infinity, - responseType: "json", - data + responseType: "json" }; let authenticationPromise = Promise.resolve(); if (this.authentications.api_key.username) { @@ -26465,26 +26730,13 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( - resolve, - reject, - response, - "FaxLineResponse" - ); + handleSuccessfulResponse5(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorCodeResponse5( - reject, - error.response, - 200, - "FaxLineResponse" - )) { - return; - } if (handleErrorRangeResponse5( reject, error.response, @@ -26500,15 +26752,18 @@ var FaxLineApi = class { }); }); } - faxLineAreaCodeGet(_0, _1, _2, _3) { - return __async(this, arguments, function* (country, state, province, city, options = { headers: {} }) { - const localVarPath = this.basePath + "/fax_line/area_codes"; + faxFiles(_0) { + return __async(this, arguments, function* (faxId, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/files/{fax_id}".replace( + "{fax_id}", + encodeURIComponent(String(faxId)) + ); let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, this._defaultHeaders ); - const produces = ["application/json"]; + const produces = ["application/pdf", "application/json"]; if (produces.indexOf("application/json") >= 0) { localVarHeaderParams["content-type"] = "application/json"; } else { @@ -26516,9 +26771,577 @@ var FaxLineApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (country === null || country === void 0) { + if (faxId === null || faxId === void 0) { throw new Error( - "Required parameter country was null or undefined when calling faxLineAreaCodeGet." + "Required parameter faxId was null or undefined when calling faxFiles." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "arraybuffer" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "Buffer" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "RequestFile" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxGet(_0) { + return __async(this, arguments, function* (faxId, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/{fax_id}".replace( + "{fax_id}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (faxId === null || faxId === void 0) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxGet." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "FaxGetResponse" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxList(_0, _1) { + return __async(this, arguments, function* (page, pageSize, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/list"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (page !== void 0) { + localVarQueryParameters["page"] = ObjectSerializer.serialize( + page, + "number" + ); + } + if (pageSize !== void 0) { + localVarQueryParameters["page_size"] = ObjectSerializer.serialize( + pageSize, + "number" + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "FaxListResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "FaxListResponse" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxSend(_0) { + return __async(this, arguments, function* (faxSendRequest, options = { headers: {} }) { + faxSendRequest = deserializeIfNeeded4(faxSendRequest, "FaxSendRequest"); + const localVarPath = this.basePath + "/fax/send"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (faxSendRequest === null || faxSendRequest === void 0) { + throw new Error( + "Required parameter faxSendRequest was null or undefined when calling faxSend." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + faxSendRequest, + FaxSendRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize(faxSendRequest, "FaxSendRequest"); + } + let localVarRequestOptions = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "FaxGetResponse" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } +}; +function deserializeIfNeeded4(obj, classname) { + if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { + return ObjectSerializer.deserialize(obj, classname); + } + return obj; +} +function handleSuccessfulResponse5(resolve, reject, response, returnType) { + let body = response.data; + if (response.status && response.status >= 200 && response.status <= 299) { + if (returnType) { + body = ObjectSerializer.deserialize(body, returnType); + } + resolve({ response, body }); + } else { + reject(new HttpError(response, body, response.status)); + } +} +function handleErrorCodeResponse5(reject, response, code, returnType) { + if (response.status !== code) { + return false; + } + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; +} +function handleErrorRangeResponse5(reject, response, code, returnType) { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; + } + return false; +} + +// api/faxLineApi.ts +var defaultBasePath6 = "https://api.hellosign.com/v3"; +var FaxLineApi = class { + constructor(basePath) { + this._basePath = defaultBasePath6; + this._defaultHeaders = { "User-Agent": USER_AGENT }; + this._useQuerystring = false; + this.authentications = { + default: new VoidAuth(), + api_key: new HttpBasicAuth(), + oauth2: new HttpBearerAuth() + }; + this.interceptors = []; + if (basePath) { + this.basePath = basePath; + } + } + set useQuerystring(value) { + this._useQuerystring = value; + } + set basePath(basePath) { + this._basePath = basePath; + } + set defaultHeaders(defaultHeaders) { + this._defaultHeaders = __spreadProps(__spreadValues({}, defaultHeaders), { "User-Agent": USER_AGENT }); + } + get defaultHeaders() { + return this._defaultHeaders; + } + get basePath() { + return this._basePath; + } + setDefaultAuthentication(auth) { + this.authentications.default = auth; + } + setApiKey(key) { + this.authentications.api_key.username = key; + } + set username(username) { + this.authentications.api_key.username = username; + } + set password(password) { + this.authentications.api_key.password = password; + } + set accessToken(accessToken) { + this.authentications.oauth2.accessToken = accessToken; + } + addInterceptor(interceptor) { + this.interceptors.push(interceptor); + } + faxLineAddUser(_0) { + return __async(this, arguments, function* (faxLineAddUserRequest, options = { headers: {} }) { + faxLineAddUserRequest = deserializeIfNeeded5( + faxLineAddUserRequest, + "FaxLineAddUserRequest" + ); + const localVarPath = this.basePath + "/fax_line/add_user"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (faxLineAddUserRequest === null || faxLineAddUserRequest === void 0) { + throw new Error( + "Required parameter faxLineAddUserRequest was null or undefined when calling faxLineAddUser." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + faxLineAddUserRequest, + FaxLineAddUserRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize( + faxLineAddUserRequest, + "FaxLineAddUserRequest" + ); + } + let localVarRequestOptions = { + method: "PUT", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse6( + resolve, + reject, + response, + "FaxLineResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse6( + reject, + error.response, + 200, + "FaxLineResponse" + )) { + return; + } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxLineAreaCodeGet(_0, _1, _2, _3) { + return __async(this, arguments, function* (country, state, province, city, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax_line/area_codes"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (country === null || country === void 0) { + throw new Error( + "Required parameter country was null or undefined when calling faxLineAreaCodeGet." ); } if (country !== void 0) { @@ -26577,7 +27400,7 @@ var FaxLineApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -26589,7 +27412,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -26597,7 +27420,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -26615,7 +27438,7 @@ var FaxLineApi = class { } faxLineCreate(_0) { return __async(this, arguments, function* (faxLineCreateRequest, options = { headers: {} }) { - faxLineCreateRequest = deserializeIfNeeded4( + faxLineCreateRequest = deserializeIfNeeded5( faxLineCreateRequest, "FaxLineCreateRequest" ); @@ -26686,7 +27509,7 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -26698,7 +27521,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -26706,7 +27529,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -26723,7 +27546,7 @@ var FaxLineApi = class { } faxLineDelete(_0) { return __async(this, arguments, function* (faxLineDeleteRequest, options = { headers: {} }) { - faxLineDeleteRequest = deserializeIfNeeded4( + faxLineDeleteRequest = deserializeIfNeeded5( faxLineDeleteRequest, "FaxLineDeleteRequest" ); @@ -26794,14 +27617,14 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5(resolve, reject, response); + handleSuccessfulResponse6(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -26874,7 +27697,7 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -26886,7 +27709,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -26894,7 +27717,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -26981,7 +27804,7 @@ var FaxLineApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -26993,7 +27816,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -27001,7 +27824,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -27019,7 +27842,7 @@ var FaxLineApi = class { } faxLineRemoveUser(_0) { return __async(this, arguments, function* (faxLineRemoveUserRequest, options = { headers: {} }) { - faxLineRemoveUserRequest = deserializeIfNeeded4( + faxLineRemoveUserRequest = deserializeIfNeeded5( faxLineRemoveUserRequest, "FaxLineRemoveUserRequest" ); @@ -27090,7 +27913,7 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -27102,7 +27925,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -27110,7 +27933,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -27126,13 +27949,13 @@ var FaxLineApi = class { }); } }; -function deserializeIfNeeded4(obj, classname) { +function deserializeIfNeeded5(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse5(resolve, reject, response, returnType) { +function handleSuccessfulResponse6(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -27143,7 +27966,7 @@ function handleSuccessfulResponse5(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse5(reject, response, code, returnType) { +function handleErrorCodeResponse6(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -27151,7 +27974,7 @@ function handleErrorCodeResponse5(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse5(reject, response, code, returnType) { +function handleErrorRangeResponse6(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27163,10 +27986,10 @@ function handleErrorRangeResponse5(reject, response, code, returnType) { } // api/oAuthApi.ts -var defaultBasePath6 = "https://app.hellosign.com"; +var defaultBasePath7 = "https://app.hellosign.com"; var OAuthApi = class { constructor(basePath) { - this._basePath = defaultBasePath6; + this._basePath = defaultBasePath7; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -27214,7 +28037,7 @@ var OAuthApi = class { } oauthTokenGenerate(_0) { return __async(this, arguments, function* (oAuthTokenGenerateRequest, options = { headers: {} }) { - oAuthTokenGenerateRequest = deserializeIfNeeded5( + oAuthTokenGenerateRequest = deserializeIfNeeded6( oAuthTokenGenerateRequest, "OAuthTokenGenerateRequest" ); @@ -27280,7 +28103,7 @@ var OAuthApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse6( + handleSuccessfulResponse7( resolve, reject, response, @@ -27292,7 +28115,7 @@ var OAuthApi = class { reject(error); return; } - if (handleErrorCodeResponse6( + if (handleErrorCodeResponse7( reject, error.response, 200, @@ -27300,6 +28123,14 @@ var OAuthApi = class { )) { return; } + if (handleErrorRangeResponse7( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); } ); @@ -27309,7 +28140,7 @@ var OAuthApi = class { } oauthTokenRefresh(_0) { return __async(this, arguments, function* (oAuthTokenRefreshRequest, options = { headers: {} }) { - oAuthTokenRefreshRequest = deserializeIfNeeded5( + oAuthTokenRefreshRequest = deserializeIfNeeded6( oAuthTokenRefreshRequest, "OAuthTokenRefreshRequest" ); @@ -27375,7 +28206,7 @@ var OAuthApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse6( + handleSuccessfulResponse7( resolve, reject, response, @@ -27387,11 +28218,19 @@ var OAuthApi = class { reject(error); return; } - if (handleErrorCodeResponse6( + if (handleErrorCodeResponse7( + reject, + error.response, + 200, + "OAuthTokenResponse" + )) { + return; + } + if (handleErrorRangeResponse7( reject, error.response, - 200, - "OAuthTokenResponse" + "4XX", + "ErrorResponse" )) { return; } @@ -27403,13 +28242,13 @@ var OAuthApi = class { }); } }; -function deserializeIfNeeded5(obj, classname) { +function deserializeIfNeeded6(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse6(resolve, reject, response, returnType) { +function handleSuccessfulResponse7(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -27420,7 +28259,7 @@ function handleSuccessfulResponse6(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse6(reject, response, code, returnType) { +function handleErrorCodeResponse7(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -27428,12 +28267,22 @@ function handleErrorCodeResponse6(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } +function handleErrorRangeResponse7(reject, response, code, returnType) { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; + } + return false; +} // api/reportApi.ts -var defaultBasePath7 = "https://api.hellosign.com/v3"; +var defaultBasePath8 = "https://api.hellosign.com/v3"; var ReportApi = class { constructor(basePath) { - this._basePath = defaultBasePath7; + this._basePath = defaultBasePath8; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -27481,7 +28330,7 @@ var ReportApi = class { } reportCreate(_0) { return __async(this, arguments, function* (reportCreateRequest, options = { headers: {} }) { - reportCreateRequest = deserializeIfNeeded6( + reportCreateRequest = deserializeIfNeeded7( reportCreateRequest, "ReportCreateRequest" ); @@ -27553,7 +28402,7 @@ var ReportApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse7( + handleSuccessfulResponse8( resolve, reject, response, @@ -27565,7 +28414,7 @@ var ReportApi = class { reject(error); return; } - if (handleErrorCodeResponse7( + if (handleErrorCodeResponse8( reject, error.response, 200, @@ -27573,7 +28422,7 @@ var ReportApi = class { )) { return; } - if (handleErrorRangeResponse6( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -27590,13 +28439,13 @@ var ReportApi = class { }); } }; -function deserializeIfNeeded6(obj, classname) { +function deserializeIfNeeded7(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse7(resolve, reject, response, returnType) { +function handleSuccessfulResponse8(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -27607,7 +28456,7 @@ function handleSuccessfulResponse7(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse7(reject, response, code, returnType) { +function handleErrorCodeResponse8(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -27615,7 +28464,7 @@ function handleErrorCodeResponse7(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse6(reject, response, code, returnType) { +function handleErrorRangeResponse8(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27627,10 +28476,10 @@ function handleErrorRangeResponse6(reject, response, code, returnType) { } // api/signatureRequestApi.ts -var defaultBasePath8 = "https://api.hellosign.com/v3"; +var defaultBasePath9 = "https://api.hellosign.com/v3"; var SignatureRequestApi = class { constructor(basePath) { - this._basePath = defaultBasePath8; + this._basePath = defaultBasePath9; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -27678,7 +28527,7 @@ var SignatureRequestApi = class { } signatureRequestBulkCreateEmbeddedWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestBulkCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - signatureRequestBulkCreateEmbeddedWithTemplateRequest = deserializeIfNeeded7( + signatureRequestBulkCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( signatureRequestBulkCreateEmbeddedWithTemplateRequest, "SignatureRequestBulkCreateEmbeddedWithTemplateRequest" ); @@ -27750,7 +28599,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -27762,7 +28611,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -27770,7 +28619,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -27788,7 +28637,7 @@ var SignatureRequestApi = class { } signatureRequestBulkSendWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestBulkSendWithTemplateRequest, options = { headers: {} }) { - signatureRequestBulkSendWithTemplateRequest = deserializeIfNeeded7( + signatureRequestBulkSendWithTemplateRequest = deserializeIfNeeded8( signatureRequestBulkSendWithTemplateRequest, "SignatureRequestBulkSendWithTemplateRequest" ); @@ -27865,7 +28714,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -27877,7 +28726,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -27885,7 +28734,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -27961,14 +28810,14 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8(resolve, reject, response); + handleSuccessfulResponse9(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -27985,7 +28834,7 @@ var SignatureRequestApi = class { } signatureRequestCreateEmbedded(_0) { return __async(this, arguments, function* (signatureRequestCreateEmbeddedRequest, options = { headers: {} }) { - signatureRequestCreateEmbeddedRequest = deserializeIfNeeded7( + signatureRequestCreateEmbeddedRequest = deserializeIfNeeded8( signatureRequestCreateEmbeddedRequest, "SignatureRequestCreateEmbeddedRequest" ); @@ -28062,7 +28911,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28074,7 +28923,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28082,7 +28931,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28100,7 +28949,7 @@ var SignatureRequestApi = class { } signatureRequestCreateEmbeddedWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - signatureRequestCreateEmbeddedWithTemplateRequest = deserializeIfNeeded7( + signatureRequestCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( signatureRequestCreateEmbeddedWithTemplateRequest, "SignatureRequestCreateEmbeddedWithTemplateRequest" ); @@ -28177,7 +29026,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28189,7 +29038,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28197,7 +29046,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28279,7 +29128,7 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28291,7 +29140,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28299,7 +29148,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28375,7 +29224,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28387,7 +29236,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28395,7 +29244,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28477,7 +29326,7 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28489,7 +29338,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28497,7 +29346,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28573,7 +29422,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28585,7 +29434,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28593,7 +29442,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28686,7 +29535,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28698,7 +29547,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28706,7 +29555,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28783,7 +29632,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28795,7 +29644,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28803,7 +29652,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28821,7 +29670,7 @@ var SignatureRequestApi = class { } signatureRequestRemind(_0, _1) { return __async(this, arguments, function* (signatureRequestId, signatureRequestRemindRequest, options = { headers: {} }) { - signatureRequestRemindRequest = deserializeIfNeeded7( + signatureRequestRemindRequest = deserializeIfNeeded8( signatureRequestRemindRequest, "SignatureRequestRemindRequest" ); @@ -28906,7 +29755,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28918,7 +29767,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28926,7 +29775,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28997,14 +29846,14 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8(resolve, reject, response); + handleSuccessfulResponse9(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29021,7 +29870,7 @@ var SignatureRequestApi = class { } signatureRequestSend(_0) { return __async(this, arguments, function* (signatureRequestSendRequest, options = { headers: {} }) { - signatureRequestSendRequest = deserializeIfNeeded7( + signatureRequestSendRequest = deserializeIfNeeded8( signatureRequestSendRequest, "SignatureRequestSendRequest" ); @@ -29098,7 +29947,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29110,7 +29959,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29118,7 +29967,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29136,7 +29985,7 @@ var SignatureRequestApi = class { } signatureRequestSendWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestSendWithTemplateRequest, options = { headers: {} }) { - signatureRequestSendWithTemplateRequest = deserializeIfNeeded7( + signatureRequestSendWithTemplateRequest = deserializeIfNeeded8( signatureRequestSendWithTemplateRequest, "SignatureRequestSendWithTemplateRequest" ); @@ -29213,7 +30062,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29225,7 +30074,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29233,7 +30082,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29251,7 +30100,7 @@ var SignatureRequestApi = class { } signatureRequestUpdate(_0, _1) { return __async(this, arguments, function* (signatureRequestId, signatureRequestUpdateRequest, options = { headers: {} }) { - signatureRequestUpdateRequest = deserializeIfNeeded7( + signatureRequestUpdateRequest = deserializeIfNeeded8( signatureRequestUpdateRequest, "SignatureRequestUpdateRequest" ); @@ -29336,7 +30185,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29348,7 +30197,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29356,7 +30205,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29373,13 +30222,13 @@ var SignatureRequestApi = class { }); } }; -function deserializeIfNeeded7(obj, classname) { +function deserializeIfNeeded8(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse8(resolve, reject, response, returnType) { +function handleSuccessfulResponse9(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -29390,7 +30239,7 @@ function handleSuccessfulResponse8(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse8(reject, response, code, returnType) { +function handleErrorCodeResponse9(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -29398,7 +30247,7 @@ function handleErrorCodeResponse8(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse7(reject, response, code, returnType) { +function handleErrorRangeResponse9(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -29410,10 +30259,10 @@ function handleErrorRangeResponse7(reject, response, code, returnType) { } // api/teamApi.ts -var defaultBasePath9 = "https://api.hellosign.com/v3"; +var defaultBasePath10 = "https://api.hellosign.com/v3"; var TeamApi = class { constructor(basePath) { - this._basePath = defaultBasePath9; + this._basePath = defaultBasePath10; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -29461,7 +30310,7 @@ var TeamApi = class { } teamAddMember(_0, _1) { return __async(this, arguments, function* (teamAddMemberRequest, teamId, options = { headers: {} }) { - teamAddMemberRequest = deserializeIfNeeded8( + teamAddMemberRequest = deserializeIfNeeded9( teamAddMemberRequest, "TeamAddMemberRequest" ); @@ -29543,7 +30392,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29555,7 +30404,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29563,7 +30412,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29580,7 +30429,7 @@ var TeamApi = class { } teamCreate(_0) { return __async(this, arguments, function* (teamCreateRequest, options = { headers: {} }) { - teamCreateRequest = deserializeIfNeeded8( + teamCreateRequest = deserializeIfNeeded9( teamCreateRequest, "TeamCreateRequest" ); @@ -29653,7 +30502,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29665,7 +30514,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29673,7 +30522,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29740,14 +30589,14 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9(resolve, reject, response); + handleSuccessfulResponse10(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29814,7 +30663,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29826,7 +30675,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29834,7 +30683,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29908,7 +30757,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29920,7 +30769,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29928,7 +30777,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30003,7 +30852,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30015,7 +30864,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30023,7 +30872,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30112,7 +30961,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30124,7 +30973,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30132,7 +30981,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30150,7 +30999,7 @@ var TeamApi = class { } teamRemoveMember(_0) { return __async(this, arguments, function* (teamRemoveMemberRequest, options = { headers: {} }) { - teamRemoveMemberRequest = deserializeIfNeeded8( + teamRemoveMemberRequest = deserializeIfNeeded9( teamRemoveMemberRequest, "TeamRemoveMemberRequest" ); @@ -30226,7 +31075,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30238,7 +31087,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 201, @@ -30246,7 +31095,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30334,7 +31183,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30346,7 +31195,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30354,7 +31203,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30372,7 +31221,7 @@ var TeamApi = class { } teamUpdate(_0) { return __async(this, arguments, function* (teamUpdateRequest, options = { headers: {} }) { - teamUpdateRequest = deserializeIfNeeded8( + teamUpdateRequest = deserializeIfNeeded9( teamUpdateRequest, "TeamUpdateRequest" ); @@ -30445,7 +31294,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30457,7 +31306,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30465,7 +31314,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30481,13 +31330,13 @@ var TeamApi = class { }); } }; -function deserializeIfNeeded8(obj, classname) { +function deserializeIfNeeded9(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse9(resolve, reject, response, returnType) { +function handleSuccessfulResponse10(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -30498,7 +31347,7 @@ function handleSuccessfulResponse9(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse9(reject, response, code, returnType) { +function handleErrorCodeResponse10(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -30506,7 +31355,7 @@ function handleErrorCodeResponse9(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse8(reject, response, code, returnType) { +function handleErrorRangeResponse10(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -30518,10 +31367,10 @@ function handleErrorRangeResponse8(reject, response, code, returnType) { } // api/templateApi.ts -var defaultBasePath10 = "https://api.hellosign.com/v3"; +var defaultBasePath11 = "https://api.hellosign.com/v3"; var TemplateApi = class { constructor(basePath) { - this._basePath = defaultBasePath10; + this._basePath = defaultBasePath11; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -30569,7 +31418,7 @@ var TemplateApi = class { } templateAddUser(_0, _1) { return __async(this, arguments, function* (templateId, templateAddUserRequest, options = { headers: {} }) { - templateAddUserRequest = deserializeIfNeeded9( + templateAddUserRequest = deserializeIfNeeded10( templateAddUserRequest, "TemplateAddUserRequest" ); @@ -30654,7 +31503,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -30666,7 +31515,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -30674,7 +31523,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -30692,7 +31541,7 @@ var TemplateApi = class { } templateCreate(_0) { return __async(this, arguments, function* (templateCreateRequest, options = { headers: {} }) { - templateCreateRequest = deserializeIfNeeded9( + templateCreateRequest = deserializeIfNeeded10( templateCreateRequest, "TemplateCreateRequest" ); @@ -30769,7 +31618,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -30781,7 +31630,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -30789,7 +31638,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -30807,7 +31656,7 @@ var TemplateApi = class { } templateCreateEmbeddedDraft(_0) { return __async(this, arguments, function* (templateCreateEmbeddedDraftRequest, options = { headers: {} }) { - templateCreateEmbeddedDraftRequest = deserializeIfNeeded9( + templateCreateEmbeddedDraftRequest = deserializeIfNeeded10( templateCreateEmbeddedDraftRequest, "TemplateCreateEmbeddedDraftRequest" ); @@ -30884,7 +31733,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -30896,7 +31745,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -30904,7 +31753,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -30980,14 +31829,14 @@ var TemplateApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10(resolve, reject, response); + handleSuccessfulResponse11(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31068,7 +31917,7 @@ var TemplateApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31080,7 +31929,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31088,7 +31937,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31164,7 +32013,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31176,7 +32025,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31184,7 +32033,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31266,7 +32115,7 @@ var TemplateApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31278,7 +32127,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31286,7 +32135,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31362,7 +32211,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31374,7 +32223,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31382,7 +32231,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31475,7 +32324,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31487,7 +32336,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31495,7 +32344,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31513,7 +32362,7 @@ var TemplateApi = class { } templateRemoveUser(_0, _1) { return __async(this, arguments, function* (templateId, templateRemoveUserRequest, options = { headers: {} }) { - templateRemoveUserRequest = deserializeIfNeeded9( + templateRemoveUserRequest = deserializeIfNeeded10( templateRemoveUserRequest, "TemplateRemoveUserRequest" ); @@ -31598,7 +32447,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31610,7 +32459,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31618,7 +32467,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31636,7 +32485,7 @@ var TemplateApi = class { } templateUpdateFiles(_0, _1) { return __async(this, arguments, function* (templateId, templateUpdateFilesRequest, options = { headers: {} }) { - templateUpdateFilesRequest = deserializeIfNeeded9( + templateUpdateFilesRequest = deserializeIfNeeded10( templateUpdateFilesRequest, "TemplateUpdateFilesRequest" ); @@ -31721,7 +32570,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31733,7 +32582,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31741,7 +32590,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31758,13 +32607,13 @@ var TemplateApi = class { }); } }; -function deserializeIfNeeded9(obj, classname) { +function deserializeIfNeeded10(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse10(resolve, reject, response, returnType) { +function handleSuccessfulResponse11(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -31775,7 +32624,7 @@ function handleSuccessfulResponse10(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse10(reject, response, code, returnType) { +function handleErrorCodeResponse11(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -31783,7 +32632,7 @@ function handleErrorCodeResponse10(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse9(reject, response, code, returnType) { +function handleErrorRangeResponse11(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -31795,10 +32644,10 @@ function handleErrorRangeResponse9(reject, response, code, returnType) { } // api/unclaimedDraftApi.ts -var defaultBasePath11 = "https://api.hellosign.com/v3"; +var defaultBasePath12 = "https://api.hellosign.com/v3"; var UnclaimedDraftApi = class { constructor(basePath) { - this._basePath = defaultBasePath11; + this._basePath = defaultBasePath12; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -31846,7 +32695,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftCreate(_0) { return __async(this, arguments, function* (unclaimedDraftCreateRequest, options = { headers: {} }) { - unclaimedDraftCreateRequest = deserializeIfNeeded10( + unclaimedDraftCreateRequest = deserializeIfNeeded11( unclaimedDraftCreateRequest, "UnclaimedDraftCreateRequest" ); @@ -31923,7 +32772,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -31935,7 +32784,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -31943,7 +32792,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -31961,7 +32810,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftCreateEmbedded(_0) { return __async(this, arguments, function* (unclaimedDraftCreateEmbeddedRequest, options = { headers: {} }) { - unclaimedDraftCreateEmbeddedRequest = deserializeIfNeeded10( + unclaimedDraftCreateEmbeddedRequest = deserializeIfNeeded11( unclaimedDraftCreateEmbeddedRequest, "UnclaimedDraftCreateEmbeddedRequest" ); @@ -32038,7 +32887,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32050,7 +32899,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32058,7 +32907,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32076,7 +32925,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftCreateEmbeddedWithTemplate(_0) { return __async(this, arguments, function* (unclaimedDraftCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - unclaimedDraftCreateEmbeddedWithTemplateRequest = deserializeIfNeeded10( + unclaimedDraftCreateEmbeddedWithTemplateRequest = deserializeIfNeeded11( unclaimedDraftCreateEmbeddedWithTemplateRequest, "UnclaimedDraftCreateEmbeddedWithTemplateRequest" ); @@ -32153,7 +33002,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32165,7 +33014,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32173,7 +33022,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32191,7 +33040,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftEditAndResend(_0, _1) { return __async(this, arguments, function* (signatureRequestId, unclaimedDraftEditAndResendRequest, options = { headers: {} }) { - unclaimedDraftEditAndResendRequest = deserializeIfNeeded10( + unclaimedDraftEditAndResendRequest = deserializeIfNeeded11( unclaimedDraftEditAndResendRequest, "UnclaimedDraftEditAndResendRequest" ); @@ -32276,7 +33125,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32288,7 +33137,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32296,7 +33145,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32313,13 +33162,13 @@ var UnclaimedDraftApi = class { }); } }; -function deserializeIfNeeded10(obj, classname) { +function deserializeIfNeeded11(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse11(resolve, reject, response, returnType) { +function handleSuccessfulResponse12(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -32330,7 +33179,7 @@ function handleSuccessfulResponse11(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse11(reject, response, code, returnType) { +function handleErrorCodeResponse12(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -32338,7 +33187,7 @@ function handleErrorCodeResponse11(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse10(reject, response, code, returnType) { +function handleErrorRangeResponse12(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -32364,7 +33213,7 @@ var HttpError = class extends Error { var queryParamsSerializer = (params) => { return import_qs.default.stringify(params, { arrayFormat: "brackets" }); }; -var USER_AGENT = "OpenAPI-Generator/1.6.2/node"; +var USER_AGENT = "OpenAPI-Generator/1.7.0/node"; var generateFormData = (obj, typemap) => { const data = {}; let localVarUseFormData = false; @@ -32428,6 +33277,7 @@ var APIS = [ ApiAppApi, BulkSendJobApi, EmbeddedApi, + FaxApi, FaxLineApi, OAuthApi, ReportApi, @@ -32479,6 +33329,8 @@ var APIS = [ EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, + FaxApi, + FaxGetResponse, FaxLineAddUserRequest, FaxLineApi, FaxLineAreaCodeGetCountryEnum, @@ -32491,6 +33343,10 @@ var APIS = [ FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, + FaxListResponse, + FaxResponse, + FaxResponseTransmission, + FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, diff --git a/docs/api/FaxApi.md b/docs/api/FaxApi.md new file mode 100644 index 0000000..84ccc7b --- /dev/null +++ b/docs/api/FaxApi.md @@ -0,0 +1,458 @@ +# FaxApi + +All URIs are relative to https://api.hellosign.com/v3. + +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**faxDelete()**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**faxGet()**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax | +| [**faxList()**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes | +| [**faxSend()**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax | + + +## `faxDelete()` + +```typescript +faxDelete(faxId: string) +``` + +Delete Fax + +Deletes the specified Fax from the system. + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxId** | **string**| Fax ID | | + +### Return type + +void (empty response body) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxFiles()` + +```typescript +faxFiles(faxId: string): Buffer +``` + +List Fax Files + +Returns list of fax files + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxId** | **string**| Fax ID | | + +### Return type + +**Buffer** + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/pdf`, `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxGet()` + +```typescript +faxGet(faxId: string): FaxGetResponse +``` + +Get Fax + +Returns information about fax + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.ApiAppApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxId** | **string**| Fax ID | | + +### Return type + +[**FaxGetResponse**](../model/FaxGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxList()` + +```typescript +faxList(page: number, pageSize: number): FaxListResponse +``` + +Lists Faxes + +Returns properties of multiple faxes + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **page** | **number**| Page | [optional] [default to 1] | +| **pageSize** | **number**| Page size | [optional] [default to 20] | + +### Return type + +[**FaxListResponse**](../model/FaxListResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxSend()` + +```typescript +faxSend(faxSendRequest: FaxSendRequest): FaxGetResponse +``` + +Send Fax + +Action to prepare and send a fax + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer: DropboxSign.RequestDetailedFile = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt: DropboxSign.RequestDetailedFile = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data: DropboxSign.FaxSendRequest = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxSendRequest** | [**FaxSendRequest**](../model/FaxSendRequest.md)| | | + +### Return type + +[**FaxGetResponse**](../model/FaxGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) diff --git a/docs/api/SignatureRequestApi.md b/docs/api/SignatureRequestApi.md index 189d58b..459c8c1 100644 --- a/docs/api/SignatureRequestApi.md +++ b/docs/api/SignatureRequestApi.md @@ -379,7 +379,7 @@ signatureRequestCancel(signatureRequestId: string) Cancel Incomplete Signature Request -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. ### TypeScript Example diff --git a/docs/api/TemplateApi.md b/docs/api/TemplateApi.md index 995945f..e73e593 100644 --- a/docs/api/TemplateApi.md +++ b/docs/api/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**templateAddUser()**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | +| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | | [**templateCreateEmbeddedDraft()**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**templateDelete()**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template | | [**templateFiles()**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -115,7 +115,7 @@ result.then(response => { templateCreate(templateCreateRequest: TemplateCreateRequest): TemplateCreateResponse ``` -Create Template +Create Template Creates a template that can then be used. diff --git a/docs/model/AccountResponseQuotas.md b/docs/model/AccountResponseQuotas.md index 55beed9..bc02d32 100644 --- a/docs/model/AccountResponseQuotas.md +++ b/docs/model/AccountResponseQuotas.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes | `documentsLeft` | ```number``` | Signature requests remaining. | | | `templatesTotal` | ```number``` | Total API templates allowed. | | | `templatesLeft` | ```number``` | API templates remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | +| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | | `numFaxPagesLeft` | ```number``` | Number of fax pages left | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/FaxGetResponse.md b/docs/model/FaxGetResponse.md new file mode 100644 index 0000000..d688d55 --- /dev/null +++ b/docs/model/FaxGetResponse.md @@ -0,0 +1,12 @@ +# # FaxGetResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```Array```](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) diff --git a/docs/model/FaxListResponse.md b/docs/model/FaxListResponse.md new file mode 100644 index 0000000..53d9cf5 --- /dev/null +++ b/docs/model/FaxListResponse.md @@ -0,0 +1,12 @@ +# # FaxListResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `faxes`*_required_ | [```Array```](FaxResponse.md) | | | +| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/FaxResponse.md b/docs/model/FaxResponse.md new file mode 100644 index 0000000..413a36b --- /dev/null +++ b/docs/model/FaxResponse.md @@ -0,0 +1,20 @@ +# # FaxResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `faxId`*_required_ | ```string``` | Fax ID | | +| `title`*_required_ | ```string``` | Fax Title | | +| `originalTitle`*_required_ | ```string``` | Fax Original Title | | +| `subject`*_required_ | ```string``` | Fax Subject | | +| `message`*_required_ | ```string``` | Fax Message | | +| `metadata`*_required_ | ```{ [key: string]: any; }``` | Fax Metadata | | +| `createdAt`*_required_ | ```number``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```string``` | Fax Sender Email | | +| `transmissions`*_required_ | [```Array```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `filesUrl`*_required_ | ```string``` | Fax Files URL | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/FaxResponseTransmission.md b/docs/model/FaxResponseTransmission.md new file mode 100644 index 0000000..c0d8491 --- /dev/null +++ b/docs/model/FaxResponseTransmission.md @@ -0,0 +1,14 @@ +# # FaxResponseTransmission + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```string``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```string``` | Fax Transmission Sender | | +| `statusCode`*_required_ | ```string``` | Fax Transmission Status Code | | +| `sentAt` | ```number``` | Fax Transmission Sent Timestamp | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/FaxSendRequest.md b/docs/model/FaxSendRequest.md new file mode 100644 index 0000000..72ebb6f --- /dev/null +++ b/docs/model/FaxSendRequest.md @@ -0,0 +1,19 @@ +# # FaxSendRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```Array``` | Fax File to Send | | +| `fileUrls` | ```Array``` | Fax File URL to Send | | +| `testMode` | ```boolean``` | API Test Mode Setting | [default to false] | +| `coverPageTo` | ```string``` | Fax Cover Page for Recipient | | +| `coverPageFrom` | ```string``` | Fax Cover Page for Sender | | +| `coverPageMessage` | ```string``` | Fax Cover Page Message | | +| `title` | ```string``` | Fax Title | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/OAuthTokenRefreshRequest.md b/docs/model/OAuthTokenRefreshRequest.md index d5dc06d..8a24bdc 100644 --- a/docs/model/OAuthTokenRefreshRequest.md +++ b/docs/model/OAuthTokenRefreshRequest.md @@ -8,5 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grantType`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refreshToken`*_required_ | ```string``` | The token provided when you got the expired access token. | | +| `clientId` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/SubWhiteLabelingOptions.md b/docs/model/SubWhiteLabelingOptions.md index 6306db0..b800c3f 100644 --- a/docs/model/SubWhiteLabelingOptions.md +++ b/docs/model/SubWhiteLabelingOptions.md @@ -8,20 +8,20 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `headerBackgroundColor` | ```string``` | | [default to '#1A1A1A'] | +| `headerBackgroundColor` | ```string``` | | [default to '#1a1a1a'] | | `legalVersion` | ```string``` | | [default to LegalVersionEnum.Terms1] | -| `linkColor` | ```string``` | | [default to '#00B3E6'] | -| `pageBackgroundColor` | ```string``` | | [default to '#F7F8F9'] | -| `primaryButtonColor` | ```string``` | | [default to '#00B3E6'] | -| `primaryButtonColorHover` | ```string``` | | [default to '#00B3E6'] | -| `primaryButtonTextColor` | ```string``` | | [default to '#FFFFFF'] | -| `primaryButtonTextColorHover` | ```string``` | | [default to '#FFFFFF'] | -| `secondaryButtonColor` | ```string``` | | [default to '#FFFFFF'] | -| `secondaryButtonColorHover` | ```string``` | | [default to '#FFFFFF'] | -| `secondaryButtonTextColor` | ```string``` | | [default to '#00B3E6'] | -| `secondaryButtonTextColorHover` | ```string``` | | [default to '#00B3E6'] | +| `linkColor` | ```string``` | | [default to '#0061FE'] | +| `pageBackgroundColor` | ```string``` | | [default to '#f7f8f9'] | +| `primaryButtonColor` | ```string``` | | [default to '#0061FE'] | +| `primaryButtonColorHover` | ```string``` | | [default to '#0061FE'] | +| `primaryButtonTextColor` | ```string``` | | [default to '#ffffff'] | +| `primaryButtonTextColorHover` | ```string``` | | [default to '#ffffff'] | +| `secondaryButtonColor` | ```string``` | | [default to '#ffffff'] | +| `secondaryButtonColorHover` | ```string``` | | [default to '#ffffff'] | +| `secondaryButtonTextColor` | ```string``` | | [default to '#0061FE'] | +| `secondaryButtonTextColorHover` | ```string``` | | [default to '#0061FE'] | | `textColor1` | ```string``` | | [default to '#808080'] | -| `textColor2` | ```string``` | | [default to '#FFFFFF'] | +| `textColor2` | ```string``` | | [default to '#ffffff'] | | `resetToDefault` | ```boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponse.md b/docs/model/TemplateResponse.md index e82af43..90ed7af 100644 --- a/docs/model/TemplateResponse.md +++ b/docs/model/TemplateResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes | `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updatedAt` | ```number``` | Time the template was last updated. | | -| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `isCreator` | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `canEdit` | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `isLocked` | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | @@ -21,5 +21,6 @@ Name | Type | Description | Notes | `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldBase.md b/docs/model/TemplateResponseDocumentFormFieldBase.md index 8596629..648b7fd 100644 --- a/docs/model/TemplateResponseDocumentFormFieldBase.md +++ b/docs/model/TemplateResponseDocumentFormFieldBase.md @@ -15,6 +15,5 @@ Name | Type | Description | Notes | `width` | ```number``` | The width in pixels of this form field. | | | `height` | ```number``` | The height in pixels of this form field. | | | `required` | ```boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldCheckbox.md b/docs/model/TemplateResponseDocumentFormFieldCheckbox.md index f2153cb..2ee1b9e 100644 --- a/docs/model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/docs/model/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldDateSigned.md b/docs/model/TemplateResponseDocumentFormFieldDateSigned.md index ada92f3..8996ce7 100644 --- a/docs/model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/docs/model/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldDropdown.md b/docs/model/TemplateResponseDocumentFormFieldDropdown.md index c868840..35cadab 100644 --- a/docs/model/TemplateResponseDocumentFormFieldDropdown.md +++ b/docs/model/TemplateResponseDocumentFormFieldDropdown.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldHyperlink.md b/docs/model/TemplateResponseDocumentFormFieldHyperlink.md index fadb22b..6ba74df 100644 --- a/docs/model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/docs/model/TemplateResponseDocumentFormFieldHyperlink.md @@ -11,5 +11,6 @@ Name | Type | Description | Notes | `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | | `originalFontSize` | ```number``` | Original font size used in this form field's text. | | | `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldInitials.md b/docs/model/TemplateResponseDocumentFormFieldInitials.md index 9040699..ab0ccda 100644 --- a/docs/model/TemplateResponseDocumentFormFieldInitials.md +++ b/docs/model/TemplateResponseDocumentFormFieldInitials.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldRadio.md b/docs/model/TemplateResponseDocumentFormFieldRadio.md index 409352e..3b888ca 100644 --- a/docs/model/TemplateResponseDocumentFormFieldRadio.md +++ b/docs/model/TemplateResponseDocumentFormFieldRadio.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldSignature.md b/docs/model/TemplateResponseDocumentFormFieldSignature.md index 3336b5b..b46f1d9 100644 --- a/docs/model/TemplateResponseDocumentFormFieldSignature.md +++ b/docs/model/TemplateResponseDocumentFormFieldSignature.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/model/TemplateResponseDocumentFormFieldText.md b/docs/model/TemplateResponseDocumentFormFieldText.md index c335bce..25a86e8 100644 --- a/docs/model/TemplateResponseDocumentFormFieldText.md +++ b/docs/model/TemplateResponseDocumentFormFieldText.md @@ -12,5 +12,6 @@ Name | Type | Description | Notes | `originalFontSize` | ```number``` | Original font size used in this form field's text. | | | `fontFamily` | ```string``` | Font family used in this form field's text. | | | `validationType` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/examples/FaxDelete.js b/examples/FaxDelete.js new file mode 100644 index 0000000..38492bd --- /dev/null +++ b/examples/FaxDelete.js @@ -0,0 +1,13 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxDelete.ts b/examples/FaxDelete.ts new file mode 100644 index 0000000..38492bd --- /dev/null +++ b/examples/FaxDelete.ts @@ -0,0 +1,13 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxFiles.js b/examples/FaxFiles.js new file mode 100644 index 0000000..d7390cf --- /dev/null +++ b/examples/FaxFiles.js @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxFiles.ts b/examples/FaxFiles.ts new file mode 100644 index 0000000..d7390cf --- /dev/null +++ b/examples/FaxFiles.ts @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxGet.js b/examples/FaxGet.js new file mode 100644 index 0000000..8a1dbbf --- /dev/null +++ b/examples/FaxGet.js @@ -0,0 +1,16 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxGet.ts b/examples/FaxGet.ts new file mode 100644 index 0000000..793f6e5 --- /dev/null +++ b/examples/FaxGet.ts @@ -0,0 +1,16 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.ApiAppApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxList.js b/examples/FaxList.js new file mode 100644 index 0000000..385f447 --- /dev/null +++ b/examples/FaxList.js @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxList.ts b/examples/FaxList.ts new file mode 100644 index 0000000..385f447 --- /dev/null +++ b/examples/FaxList.ts @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxSend.js b/examples/FaxSend.js new file mode 100644 index 0000000..4b0eef2 --- /dev/null +++ b/examples/FaxSend.js @@ -0,0 +1,47 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxSend.ts b/examples/FaxSend.ts new file mode 100644 index 0000000..2f3f6e2 --- /dev/null +++ b/examples/FaxSend.ts @@ -0,0 +1,47 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer: DropboxSign.RequestDetailedFile = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt: DropboxSign.RequestDetailedFile = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data: DropboxSign.FaxSendRequest = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/model/accountResponseQuotas.ts b/model/accountResponseQuotas.ts index 3553070..5bc605e 100644 --- a/model/accountResponseQuotas.ts +++ b/model/accountResponseQuotas.ts @@ -45,7 +45,7 @@ export class AccountResponseQuotas { */ "templatesLeft"?: number | null; /** - * SMS verifications remaining. + * SMS verifications remaining. */ "smsVerificationsLeft"?: number | null; /** diff --git a/model/apiAppResponseOAuth.ts b/model/apiAppResponseOAuth.ts index bd8d8fd..cefb71b 100644 --- a/model/apiAppResponseOAuth.ts +++ b/model/apiAppResponseOAuth.ts @@ -35,7 +35,7 @@ export class ApiAppResponseOAuth { /** * The app\'s OAuth secret, or null if the app does not belong to user. */ - "secret"?: string; + "secret"?: string | null; /** * Array of OAuth scopes used by the app. */ diff --git a/model/faxGetResponse.ts b/model/faxGetResponse.ts new file mode 100644 index 0000000..aa01674 --- /dev/null +++ b/model/faxGetResponse.ts @@ -0,0 +1,59 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; +import { FaxResponse } from "./faxResponse"; +import { WarningResponse } from "./warningResponse"; + +export class FaxGetResponse { + "fax": FaxResponse; + /** + * A list of warnings. + */ + "warnings"?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "fax", + baseName: "fax", + type: "FaxResponse", + }, + { + name: "warnings", + baseName: "warnings", + type: "Array", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxGetResponse.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxGetResponse { + return ObjectSerializer.deserialize(data, "FaxGetResponse"); + } +} diff --git a/model/faxListResponse.ts b/model/faxListResponse.ts new file mode 100644 index 0000000..f3bb7be --- /dev/null +++ b/model/faxListResponse.ts @@ -0,0 +1,56 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; +import { FaxResponse } from "./faxResponse"; +import { ListInfoResponse } from "./listInfoResponse"; + +export class FaxListResponse { + "faxes": Array; + "listInfo": ListInfoResponse; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "faxes", + baseName: "faxes", + type: "Array", + }, + { + name: "listInfo", + baseName: "list_info", + type: "ListInfoResponse", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxListResponse.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxListResponse { + return ObjectSerializer.deserialize(data, "FaxListResponse"); + } +} diff --git a/model/faxResponse.ts b/model/faxResponse.ts new file mode 100644 index 0000000..1697d21 --- /dev/null +++ b/model/faxResponse.ts @@ -0,0 +1,133 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; + +export class FaxResponse { + /** + * Fax ID + */ + "faxId": string; + /** + * Fax Title + */ + "title": string; + /** + * Fax Original Title + */ + "originalTitle": string; + /** + * Fax Subject + */ + "subject": string; + /** + * Fax Message + */ + "message": string; + /** + * Fax Metadata + */ + "metadata": { [key: string]: any }; + /** + * Fax Created At Timestamp + */ + "createdAt": number; + /** + * Fax Sender Email + */ + "sender": string; + /** + * Fax Transmissions List + */ + "transmissions": Array; + /** + * Fax Files URL + */ + "filesUrl": string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "faxId", + baseName: "fax_id", + type: "string", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + { + name: "originalTitle", + baseName: "original_title", + type: "string", + }, + { + name: "subject", + baseName: "subject", + type: "string", + }, + { + name: "message", + baseName: "message", + type: "string", + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }", + }, + { + name: "createdAt", + baseName: "created_at", + type: "number", + }, + { + name: "sender", + baseName: "sender", + type: "string", + }, + { + name: "transmissions", + baseName: "transmissions", + type: "Array", + }, + { + name: "filesUrl", + baseName: "files_url", + type: "string", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxResponse.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxResponse { + return ObjectSerializer.deserialize(data, "FaxResponse"); + } +} diff --git a/model/faxResponseTransmission.ts b/model/faxResponseTransmission.ts new file mode 100644 index 0000000..f43034a --- /dev/null +++ b/model/faxResponseTransmission.ts @@ -0,0 +1,91 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; + +export class FaxResponseTransmission { + /** + * Fax Transmission Recipient + */ + "recipient": string; + /** + * Fax Transmission Sender + */ + "sender": string; + /** + * Fax Transmission Status Code + */ + "statusCode": FaxResponseTransmission.StatusCodeEnum; + /** + * Fax Transmission Sent Timestamp + */ + "sentAt"?: number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string", + }, + { + name: "sender", + baseName: "sender", + type: "string", + }, + { + name: "statusCode", + baseName: "status_code", + type: "FaxResponseTransmission.StatusCodeEnum", + }, + { + name: "sentAt", + baseName: "sent_at", + type: "number", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxResponseTransmission.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxResponseTransmission { + return ObjectSerializer.deserialize(data, "FaxResponseTransmission"); + } +} + +export namespace FaxResponseTransmission { + export enum StatusCodeEnum { + Success = "success", + Transmitting = "transmitting", + ErrorCouldNotFax = "error_could_not_fax", + ErrorUnknown = "error_unknown", + ErrorBusy = "error_busy", + ErrorNoAnswer = "error_no_answer", + ErrorDisconnected = "error_disconnected", + ErrorBadDestination = "error_bad_destination", + } +} diff --git a/model/faxSendRequest.ts b/model/faxSendRequest.ts new file mode 100644 index 0000000..11ee71e --- /dev/null +++ b/model/faxSendRequest.ts @@ -0,0 +1,123 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; + +export class FaxSendRequest { + /** + * Fax Send To Recipient + */ + "recipient": string; + /** + * Fax Send From Sender (used only with fax number) + */ + "sender"?: string; + /** + * Fax File to Send + */ + "files"?: Array; + /** + * Fax File URL to Send + */ + "fileUrls"?: Array; + /** + * API Test Mode Setting + */ + "testMode"?: boolean = false; + /** + * Fax Cover Page for Recipient + */ + "coverPageTo"?: string; + /** + * Fax Cover Page for Sender + */ + "coverPageFrom"?: string; + /** + * Fax Cover Page Message + */ + "coverPageMessage"?: string; + /** + * Fax Title + */ + "title"?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string", + }, + { + name: "sender", + baseName: "sender", + type: "string", + }, + { + name: "files", + baseName: "files", + type: "Array", + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array", + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean", + }, + { + name: "coverPageTo", + baseName: "cover_page_to", + type: "string", + }, + { + name: "coverPageFrom", + baseName: "cover_page_from", + type: "string", + }, + { + name: "coverPageMessage", + baseName: "cover_page_message", + type: "string", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxSendRequest.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxSendRequest { + return ObjectSerializer.deserialize(data, "FaxSendRequest"); + } +} diff --git a/model/index.ts b/model/index.ts index c59b280..7813c02 100644 --- a/model/index.ts +++ b/model/index.ts @@ -33,6 +33,7 @@ import { EventCallbackHelper } from "./eventCallbackHelper"; import { EventCallbackRequest } from "./eventCallbackRequest"; import { EventCallbackRequestEvent } from "./eventCallbackRequestEvent"; import { EventCallbackRequestEventMetadata } from "./eventCallbackRequestEventMetadata"; +import { FaxGetResponse } from "./faxGetResponse"; import { FaxLineAddUserRequest } from "./faxLineAddUserRequest"; import { FaxLineAreaCodeGetCountryEnum } from "./faxLineAreaCodeGetCountryEnum"; import { FaxLineAreaCodeGetProvinceEnum } from "./faxLineAreaCodeGetProvinceEnum"; @@ -44,6 +45,10 @@ import { FaxLineListResponse } from "./faxLineListResponse"; import { FaxLineRemoveUserRequest } from "./faxLineRemoveUserRequest"; import { FaxLineResponse } from "./faxLineResponse"; import { FaxLineResponseFaxLine } from "./faxLineResponseFaxLine"; +import { FaxListResponse } from "./faxListResponse"; +import { FaxResponse } from "./faxResponse"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; +import { FaxSendRequest } from "./faxSendRequest"; import { FileResponse } from "./fileResponse"; import { FileResponseDataUri } from "./fileResponseDataUri"; import { ListInfoResponse } from "./listInfoResponse"; @@ -203,6 +208,8 @@ export let enumsMap: { [index: string]: any } = { FaxLineAreaCodeGetProvinceEnum: FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetStateEnum: FaxLineAreaCodeGetStateEnum, "FaxLineCreateRequest.CountryEnum": FaxLineCreateRequest.CountryEnum, + "FaxResponseTransmission.StatusCodeEnum": + FaxResponseTransmission.StatusCodeEnum, "ReportCreateRequest.ReportTypeEnum": ReportCreateRequest.ReportTypeEnum, "ReportResponse.ReportTypeEnum": ReportResponse.ReportTypeEnum, SignatureRequestResponseCustomFieldTypeEnum: @@ -279,6 +286,7 @@ export let typeMap: { [index: string]: any } = { EventCallbackRequest: EventCallbackRequest, EventCallbackRequestEvent: EventCallbackRequestEvent, EventCallbackRequestEventMetadata: EventCallbackRequestEventMetadata, + FaxGetResponse: FaxGetResponse, FaxLineAddUserRequest: FaxLineAddUserRequest, FaxLineAreaCodeGetResponse: FaxLineAreaCodeGetResponse, FaxLineCreateRequest: FaxLineCreateRequest, @@ -287,6 +295,10 @@ export let typeMap: { [index: string]: any } = { FaxLineRemoveUserRequest: FaxLineRemoveUserRequest, FaxLineResponse: FaxLineResponse, FaxLineResponseFaxLine: FaxLineResponseFaxLine, + FaxListResponse: FaxListResponse, + FaxResponse: FaxResponse, + FaxResponseTransmission: FaxResponseTransmission, + FaxSendRequest: FaxSendRequest, FileResponse: FileResponse, FileResponseDataUri: FileResponseDataUri, ListInfoResponse: ListInfoResponse, @@ -499,6 +511,7 @@ export { EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, + FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, @@ -510,6 +523,10 @@ export { FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, + FaxListResponse, + FaxResponse, + FaxResponseTransmission, + FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, diff --git a/model/oAuthTokenRefreshRequest.ts b/model/oAuthTokenRefreshRequest.ts index e6c6848..2f8971d 100644 --- a/model/oAuthTokenRefreshRequest.ts +++ b/model/oAuthTokenRefreshRequest.ts @@ -33,6 +33,14 @@ export class OAuthTokenRefreshRequest { * The token provided when you got the expired access token. */ "refreshToken": string; + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + */ + "clientId"?: string; + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + */ + "clientSecret"?: string; static discriminator: string | undefined = undefined; @@ -47,6 +55,16 @@ export class OAuthTokenRefreshRequest { baseName: "refresh_token", type: "string", }, + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "clientSecret", + baseName: "client_secret", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/subWhiteLabelingOptions.ts b/model/subWhiteLabelingOptions.ts index 17a64f3..0c1c502 100644 --- a/model/subWhiteLabelingOptions.ts +++ b/model/subWhiteLabelingOptions.ts @@ -28,21 +28,21 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; * An array of elements and values serialized to a string, to be used to customize the app\'s signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. */ export class SubWhiteLabelingOptions { - "headerBackgroundColor"?: string = "#1A1A1A"; + "headerBackgroundColor"?: string = "#1a1a1a"; "legalVersion"?: SubWhiteLabelingOptions.LegalVersionEnum = SubWhiteLabelingOptions.LegalVersionEnum.Terms1; - "linkColor"?: string = "#00B3E6"; - "pageBackgroundColor"?: string = "#F7F8F9"; - "primaryButtonColor"?: string = "#00B3E6"; - "primaryButtonColorHover"?: string = "#00B3E6"; - "primaryButtonTextColor"?: string = "#FFFFFF"; - "primaryButtonTextColorHover"?: string = "#FFFFFF"; - "secondaryButtonColor"?: string = "#FFFFFF"; - "secondaryButtonColorHover"?: string = "#FFFFFF"; - "secondaryButtonTextColor"?: string = "#00B3E6"; - "secondaryButtonTextColorHover"?: string = "#00B3E6"; + "linkColor"?: string = "#0061FE"; + "pageBackgroundColor"?: string = "#f7f8f9"; + "primaryButtonColor"?: string = "#0061FE"; + "primaryButtonColorHover"?: string = "#0061FE"; + "primaryButtonTextColor"?: string = "#ffffff"; + "primaryButtonTextColorHover"?: string = "#ffffff"; + "secondaryButtonColor"?: string = "#ffffff"; + "secondaryButtonColorHover"?: string = "#ffffff"; + "secondaryButtonTextColor"?: string = "#0061FE"; + "secondaryButtonTextColorHover"?: string = "#0061FE"; "textColor1"?: string = "#808080"; - "textColor2"?: string = "#FFFFFF"; + "textColor2"?: string = "#ffffff"; /** * Resets white labeling options to defaults. Only useful when updating an API App. */ diff --git a/model/templateResponse.ts b/model/templateResponse.ts index 88df4c0..81dc1a4 100644 --- a/model/templateResponse.ts +++ b/model/templateResponse.ts @@ -23,6 +23,7 @@ */ import { AttributeTypeMap, ObjectSerializer } from "./"; +import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -51,21 +52,21 @@ export class TemplateResponse { */ "updatedAt"?: number; /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. */ "isEmbedded"?: boolean | null; /** * `true` if you are the owner of this template, `false` if it\'s been shared with you by a team member. */ - "isCreator"?: boolean | null; + "isCreator"?: boolean; /** * Indicates whether edit rights have been granted to you by the owner (always `true` if that\'s you). */ - "canEdit"?: boolean | null; + "canEdit"?: boolean; /** * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. */ - "isLocked"?: boolean | null; + "isLocked"?: boolean; /** * The metadata attached to the template. */ @@ -93,7 +94,11 @@ export class TemplateResponse { /** * An array of the Accounts that can use this Template. */ - "accounts"?: Array | null; + "accounts"?: Array; + /** + * Signer attachments. + */ + "attachments"?: Array; static discriminator: string | undefined = undefined; @@ -173,6 +178,11 @@ export class TemplateResponse { baseName: "accounts", type: "Array", }, + { + name: "attachments", + baseName: "attachments", + type: "Array", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocument.ts b/model/templateResponseDocument.ts index 0c7a19e..6817367 100644 --- a/model/templateResponseDocument.ts +++ b/model/templateResponseDocument.ts @@ -52,7 +52,7 @@ export class TemplateResponseDocument { /** * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ - "staticFields"?: Array | null; + "staticFields"?: Array; static discriminator: string | undefined = undefined; diff --git a/model/templateResponseDocumentFormFieldBase.ts b/model/templateResponseDocumentFormFieldBase.ts index 94242a4..e28159b 100644 --- a/model/templateResponseDocumentFormFieldBase.ts +++ b/model/templateResponseDocumentFormFieldBase.ts @@ -61,10 +61,6 @@ export abstract class TemplateResponseDocumentFormFieldBase { * Boolean showing whether or not this field is required. */ "required"?: boolean; - /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - */ - "group"?: string | null; static discriminator: string | undefined = "type"; @@ -114,11 +110,6 @@ export abstract class TemplateResponseDocumentFormFieldBase { baseName: "required", type: "boolean", }, - { - name: "group", - baseName: "group", - type: "string", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldCheckbox.ts b/model/templateResponseDocumentFormFieldCheckbox.ts index 5e0b6d8..e27a9fd 100644 --- a/model/templateResponseDocumentFormFieldCheckbox.ts +++ b/model/templateResponseDocumentFormFieldCheckbox.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "checkbox"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldDateSigned.ts b/model/templateResponseDocumentFormFieldDateSigned.ts index b510aa5..08ce110 100644 --- a/model/templateResponseDocumentFormFieldDateSigned.ts +++ b/model/templateResponseDocumentFormFieldDateSigned.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "date_signed"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldDropdown.ts b/model/templateResponseDocumentFormFieldDropdown.ts index e2878fe..0aeb3e4 100644 --- a/model/templateResponseDocumentFormFieldDropdown.ts +++ b/model/templateResponseDocumentFormFieldDropdown.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "dropdown"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldHyperlink.ts b/model/templateResponseDocumentFormFieldHyperlink.ts index 4a59989..a3693ec 100644 --- a/model/templateResponseDocumentFormFieldHyperlink.ts +++ b/model/templateResponseDocumentFormFieldHyperlink.ts @@ -47,6 +47,10 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse * Font family used in this form field\'s text. */ "fontFamily"?: string; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -76,6 +80,11 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse baseName: "fontFamily", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldInitials.ts b/model/templateResponseDocumentFormFieldInitials.ts index 1b14087..02f89a9 100644 --- a/model/templateResponseDocumentFormFieldInitials.ts +++ b/model/templateResponseDocumentFormFieldInitials.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "initials"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldRadio.ts b/model/templateResponseDocumentFormFieldRadio.ts index 3a20f95..0841c0d 100644 --- a/model/templateResponseDocumentFormFieldRadio.ts +++ b/model/templateResponseDocumentFormFieldRadio.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "radio"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group": string; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldSignature.ts b/model/templateResponseDocumentFormFieldSignature.ts index c069e00..8467c91 100644 --- a/model/templateResponseDocumentFormFieldSignature.ts +++ b/model/templateResponseDocumentFormFieldSignature.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponse * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "signature"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponse baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/model/templateResponseDocumentFormFieldText.ts b/model/templateResponseDocumentFormFieldText.ts index 2c320d3..e758496 100644 --- a/model/templateResponseDocumentFormFieldText.ts +++ b/model/templateResponseDocumentFormFieldText.ts @@ -51,6 +51,10 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. */ "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -85,6 +89,11 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/openapi-config.yaml b/openapi-config.yaml index 3dfbf13..de78802 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -2,7 +2,7 @@ generatorName: typescript-node typeMappings: {} additionalProperties: npmName: "@dropbox/sign" - npmVersion: 1.6.2 + npmVersion: 1.7.0 supportsES6: true apiDocPath: ./docs/api modelDocPath: ./docs/model diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index c7189fd..fe81aca 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1409,6 +1409,304 @@ paths: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' + '/fax/{fax_id}': + get: + tags: + - Fax + summary: 'Get Fax' + description: 'Returns information about fax' + operationId: faxGet + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxGet.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxGet.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxGet.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxGet.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxGet.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxGet.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxGet.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxGet.sh + x-meta: + seo: + title: 'Get Fax | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + delete: + tags: + - Fax + summary: 'Delete Fax' + description: 'Deletes the specified Fax from the system.' + operationId: faxDelete + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 204: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxDelete.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxDelete.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxDelete.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxDelete.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxDelete.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxDelete.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxDelete.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxDelete.sh + x-meta: + seo: + title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.' + '/fax/files/{fax_id}': + get: + tags: + - Fax + summary: 'List Fax Files' + description: 'Returns list of fax files' + operationId: faxFiles + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxFiles.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxFiles.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxFiles.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxFiles.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxFiles.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxFiles.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxFiles.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxFiles.sh + x-meta: + seo: + title: 'Fax Files | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' /fax_line/add_user: put: tags: @@ -1977,31 +2275,243 @@ paths: lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDelete.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxLineDelete.sh + x-meta: + seo: + title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.' + /fax_line/list: + get: + tags: + - 'Fax Line' + summary: 'List Fax Lines' + description: 'Returns the properties and settings of multiple Fax Lines.' + operationId: faxLineList + parameters: + - + name: account_id + in: query + description: 'Account ID' + schema: + type: string + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + - + name: page + in: query + description: Page + schema: + type: integer + default: 1 + example: 1 + - + name: page_size + in: query + description: 'Page size' + schema: + type: integer + default: 20 + example: 20 + - + name: show_team_lines + in: query + description: 'Show team lines' + schema: + type: boolean + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineListResponse' + examples: + default_example: + $ref: '#/components/examples/FaxLineListResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxLineList.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxLineList.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxLineList.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxLineList.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxLineList.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxLineList.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxLineList.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxLineList.sh + x-meta: + seo: + title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.' + /fax_line/remove_user: + put: + tags: + - 'Fax Line' + summary: 'Remove Fax Line Access' + description: 'Removes a user''s access to the specified Fax Line.' + operationId: faxLineRemoveUser + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineRemoveUserRequest' + examples: + default_example: + $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineResponse' + examples: + default_example: + $ref: '#/components/examples/FaxLineResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxLineRemoveUser.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxLineRemoveUser.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxLineRemoveUser.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxLineRemoveUser.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxLineRemoveUser.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxLineRemoveUser.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxLineRemoveUser.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineRemoveUser.sh x-meta: seo: - title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.' - /fax_line/list: + title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + /fax/list: get: tags: - - 'Fax Line' - summary: 'List Fax Lines' - description: 'Returns the properties and settings of multiple Fax Lines.' - operationId: faxLineList + - Fax + summary: 'Lists Faxes' + description: 'Returns properties of multiple faxes' + operationId: faxList parameters: - - - name: account_id - in: query - description: 'Account ID' - schema: - type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2009,6 +2519,7 @@ paths: schema: type: integer default: 1 + minimum: 1 example: 1 - name: page_size @@ -2017,13 +2528,9 @@ paths: schema: type: integer default: 20 + maximum: 100 + minimum: 1 example: 20 - - - name: show_team_lines - in: query - description: 'Show team lines' - schema: - type: boolean responses: 200: description: 'successful operation' @@ -2037,10 +2544,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FaxLineListResponse' + $ref: '#/components/schemas/FaxListResponse' examples: default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + $ref: '#/components/examples/FaxListResponseExample' 4XX: description: failed_operation content: @@ -2066,62 +2573,65 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxList.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs + $ref: examples/FaxList.cs - lang: JavaScript label: JavaScript source: - $ref: examples/FaxLineList.js + $ref: examples/FaxList.js - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxList.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxList.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxList.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxList.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxList.sh x-meta: seo: - title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.' - /fax_line/remove_user: - put: + title: 'List Faxes | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.' + /fax/send: + post: tags: - - 'Fax Line' - summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' - operationId: faxLineRemoveUser + - Fax + summary: 'Send Fax' + description: 'Action to prepare and send a fax' + operationId: faxSend requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/FaxLineRemoveUserRequest' + $ref: '#/components/schemas/FaxSendRequest' examples: default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + $ref: '#/components/examples/FaxSendRequestExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/FaxSendRequest' responses: 200: description: 'successful operation' @@ -2135,10 +2645,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FaxLineResponse' + $ref: '#/components/schemas/FaxGetResponse' examples: default_example: - $ref: '#/components/examples/FaxLineResponseExample' + $ref: '#/components/examples/FaxGetResponseExample' 4XX: description: failed_operation content: @@ -2156,6 +2666,8 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -2166,46 +2678,46 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxSend.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs + $ref: examples/FaxSend.cs - lang: JavaScript label: JavaScript source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxSend.js - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxSend.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxSend.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxSend.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxSend.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxSend.sh x-meta: seo: - title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: tags: @@ -2239,6 +2751,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2322,6 +2851,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2703,7 +3249,7 @@ paths: The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. - This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. + This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. @@ -4617,7 +5163,7 @@ paths: 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: - $ref: '#/components/examples/TeamDoesNotExistResponseExample' + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5440,7 +5986,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -7345,6 +7891,50 @@ components: type: string format: email type: object + FaxSendRequest: + required: + - recipient + properties: + recipient: + description: 'Fax Send To Recipient' + type: string + example: recipient@example.com + sender: + description: 'Fax Send From Sender (used only with fax number)' + type: string + example: sender@example.com + files: + description: 'Fax File to Send' + type: array + items: + type: string + format: binary + file_urls: + description: 'Fax File URL to Send' + type: array + items: + type: string + test_mode: + description: 'API Test Mode Setting' + type: boolean + default: false + cover_page_to: + description: 'Fax Cover Page for Recipient' + type: string + example: 'Recipient Name' + cover_page_from: + description: 'Fax Cover Page for Sender' + type: string + example: 'Sender Name' + cover_page_message: + description: 'Fax Cover Page Message' + type: string + example: 'Please find the attached documents.' + title: + description: 'Fax Title' + type: string + example: 'Fax Title' + type: object OAuthTokenGenerateRequest: required: - client_id @@ -7382,6 +7972,12 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string + client_id: + description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string + client_secret: + description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string type: object ReportCreateRequest: required: @@ -9091,7 +9687,7 @@ components: properties: header_background_color: type: string - default: '#1A1A1A' + default: '#1a1a1a' legal_version: type: string default: terms1 @@ -9100,40 +9696,40 @@ components: - terms2 link_color: type: string - default: '#00B3E6' + default: '#0061FE' page_background_color: type: string - default: '#F7F8F9' + default: '#f7f8f9' primary_button_color: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_text_color: type: string - default: '#FFFFFF' + default: '#ffffff' primary_button_text_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_text_color: type: string - default: '#00B3E6' + default: '#0061FE' secondary_button_text_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' text_color1: type: string default: '#808080' text_color2: type: string - default: '#FFFFFF' + default: '#ffffff' reset_to_default: description: 'Resets white labeling options to defaults. Only useful when updating an API App.' type: boolean @@ -10211,6 +10807,19 @@ components: error: $ref: '#/components/schemas/ErrorResponseError' type: object + FaxGetResponse: + required: + - fax + properties: + fax: + $ref: '#/components/schemas/FaxResponse' + warnings: + description: 'A list of warnings.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true FaxLineResponse: required: - fax_line @@ -10246,6 +10855,19 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal-class: true + FaxListResponse: + required: + - faxes + - list_info + properties: + faxes: + type: array + items: + $ref: '#/components/schemas/FaxResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + type: object + x-internal-class: true FileResponse: required: - file_url @@ -10388,7 +11010,7 @@ components: type: integer nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer nullable: true num_fax_pages_left: @@ -10456,6 +11078,7 @@ components: secret: description: 'The app''s OAuth secret, or null if the app does not belong to user.' type: string + nullable: true scopes: description: 'Array of OAuth scopes used by the app.' type: array @@ -10589,6 +11212,54 @@ components: description: 'Name of the error.' type: string type: object + FaxResponse: + required: + - fax_id + - title + - original_title + - subject + - message + - metadata + - created_at + - sender + - transmissions + - files_url + properties: + fax_id: + description: 'Fax ID' + type: string + title: + description: 'Fax Title' + type: string + original_title: + description: 'Fax Original Title' + type: string + subject: + description: 'Fax Subject' + type: string + message: + description: 'Fax Message' + type: string + metadata: + description: 'Fax Metadata' + type: object + additionalProperties: {} + created_at: + description: 'Fax Created At Timestamp' + type: integer + sender: + description: 'Fax Sender Email' + type: string + transmissions: + description: 'Fax Transmissions List' + type: array + items: + $ref: '#/components/schemas/FaxResponseTransmission' + files_url: + description: 'Fax Files URL' + type: string + type: object + x-internal-class: true FaxLineResponseFaxLine: properties: number: @@ -10606,6 +11277,35 @@ components: $ref: '#/components/schemas/AccountResponse' type: object x-internal-class: true + FaxResponseTransmission: + required: + - recipient + - sender + - status_code + properties: + recipient: + description: 'Fax Transmission Recipient' + type: string + sender: + description: 'Fax Transmission Sender' + type: string + status_code: + description: 'Fax Transmission Status Code' + type: string + enum: + - success + - transmitting + - error_could_not_fax + - error_unknown + - error_busy + - error_no_answer + - error_disconnected + - error_bad_destination + sent_at: + description: 'Fax Transmission Sent Timestamp' + type: integer + type: object + x-internal-class: true ListInfoResponse: description: 'Contains pagination information about the data returned.' properties: @@ -11218,24 +11918,21 @@ components: description: 'Time the template was last updated.' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.' + description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' type: boolean nullable: true is_creator: description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' type: boolean - nullable: true can_edit: description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' type: boolean - nullable: true is_locked: description: |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. type: boolean - nullable: true metadata: description: 'The metadata attached to the template.' type: object @@ -11273,7 +11970,11 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: 'Signer attachments.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: @@ -11377,7 +12078,6 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: @@ -11529,10 +12229,6 @@ components: required: description: 'Boolean showing whether or not this field is required.' type: boolean - group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11549,12 +12245,12 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11570,6 +12266,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: checkbox + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11579,8 +12279,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11596,6 +12294,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: date_signed + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11605,8 +12307,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11622,6 +12322,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: dropdown + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11631,8 +12335,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11659,6 +12361,10 @@ components: fontFamily: description: 'Font family used in this form field''s text.' type: string + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11668,8 +12374,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11685,6 +12389,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: initials + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11695,8 +12403,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11712,6 +12418,9 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: radio + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11721,8 +12430,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11738,6 +12445,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: signature + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11747,8 +12458,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11790,6 +12499,10 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' @@ -11849,8 +12562,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11875,8 +12586,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11901,8 +12610,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11927,8 +12634,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11953,8 +12658,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11979,8 +12682,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12005,8 +12706,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12031,8 +12730,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12418,6 +13115,10 @@ components: summary: 'Default Example' value: $ref: examples/json/FaxLineRemoveUserRequestExample.json + FaxSendRequestExample: + summary: 'Default Example' + value: + $ref: examples/json/FaxSendRequestExample.json OAuthTokenGenerateRequestExample: summary: 'OAuth Token Generate Example' value: @@ -12662,6 +13363,10 @@ components: summary: 'Error 4XX failed_operation' value: $ref: examples/json/Error4XXResponseExample.json + FaxGetResponseExample: + summary: 'Fax Response' + value: + $ref: examples/json/FaxGetResponseExample.json FaxLineResponseExample: summary: 'Sample Fax Line Response' value: @@ -12674,6 +13379,10 @@ components: summary: 'Sample Fax Line List Response' value: $ref: examples/json/FaxLineListResponseExample.json + FaxListResponseExample: + summary: 'Returns the properties and settings of multiple Faxes.' + value: + $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: summary: Report value: diff --git a/package-lock.json b/package-lock.json index 9b3c25d..4df76c9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dropbox/sign", - "version": "1.6.2", + "version": "1.7.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@dropbox/sign", - "version": "1.6.2", + "version": "1.7.0", "dependencies": { "axios": "^1.7.0", "bluebird": "^3.7.2", diff --git a/package.json b/package.json index 45e7751..b879db5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@dropbox/sign", - "version": "1.6.2", + "version": "1.7.0", "description": "Official Node client for Dropbox Sign", "repository": { "type": "git", diff --git a/run-build b/run-build index 9bf210d..09afd7e 100755 --- a/run-build +++ b/run-build @@ -7,6 +7,17 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/javascript" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + +# cleanup +rm -f "${DIR}/api/"*.ts +rm -f "${DIR}/model/"*.ts +rm -f "${DIR}/types/api/"*.ts +rm -f "${DIR}/types/model/"*.ts + # Generate code docker run --rm \ -v "${DIR}/:/local" \ diff --git a/test_fixtures/ApiAppCreateRequest.json b/test_fixtures/ApiAppCreateRequest.json index ac9729d..2ee8e41 100644 --- a/test_fixtures/ApiAppCreateRequest.json +++ b/test_fixtures/ApiAppCreateRequest.json @@ -18,18 +18,18 @@ "white_labeling_options": { "header_background_color": "#1A1A1A", "legal_version": "terms1", - "link_color": "#00B3E6", - "page_background_color": "#F7F8F9", - "primary_button_color": "#00b3e6", - "primary_button_color_hover": "#00B3E6", + "link_color": "#0061FE", + "page_background_color": "#f7f8f9", + "primary_button_color": "#0061FE", + "primary_button_color_hover": "#0061FE", "primary_button_text_color": "#ffffff", - "primary_button_text_color_hover": "#FFFFFF", - "secondary_button_color": "#FFFFFF", - "secondary_button_color_hover": "#FFFFFF", - "secondary_button_text_color": "#00B3E6", - "secondary_button_text_color_hover": "#00B3E6", + "primary_button_text_color_hover": "#ffffff", + "secondary_button_color": "#ffffff", + "secondary_button_color_hover": "#ffffff", + "secondary_button_text_color": "#0061FE", + "secondary_button_text_color_hover": "#0061FE", "text_color1": "#808080", - "text_color2": "#FFFFFF" + "text_color2": "#ffffff" } } } diff --git a/test_fixtures/ApiAppGetResponse.json b/test_fixtures/ApiAppGetResponse.json index 07843c3..f7d799f 100644 --- a/test_fixtures/ApiAppGetResponse.json +++ b/test_fixtures/ApiAppGetResponse.json @@ -7,7 +7,7 @@ "is_approved": false, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" @@ -15,13 +15,28 @@ "charges_users": false, "secret": "98891a1b59f312d04cd88e4e0c498d75" }, + "options": { + "can_insert_everywhere": true + }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" }, "white_labeling_options": { - "primary_button_color": "#00b3e6", - "primary_button_text_color": "#ffffff" + "header_background_color": "#1A1A1A", + "legal_version": "terms1", + "link_color": "#0061FE", + "page_background_color": "#f7f8f9", + "primary_button_color": "#0061FE", + "primary_button_color_hover": "#0061FE", + "primary_button_text_color": "#ffffff", + "primary_button_text_color_hover": "#ffffff", + "secondary_button_color": "#ffffff", + "secondary_button_color_hover": "#ffffff", + "secondary_button_text_color": "#0061FE", + "secondary_button_text_color_hover": "#0061FE", + "text_color1": "#808080", + "text_color2": "#ffffff" } } } diff --git a/test_fixtures/ApiAppListResponse.json b/test_fixtures/ApiAppListResponse.json index 6bbacb4..cc17d45 100644 --- a/test_fixtures/ApiAppListResponse.json +++ b/test_fixtures/ApiAppListResponse.json @@ -8,7 +8,7 @@ "is_approved": true, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" @@ -16,6 +16,9 @@ "charges_users": false, "secret": "98891a1b59f312d04cd88e4e0c498d75" }, + "options": { + "can_insert_everywhere": true + }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" @@ -27,6 +30,9 @@ "domains": ["example.com"], "is_approved": false, "name": "My Other App", + "options": { + "can_insert_everywhere": true + }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" diff --git a/test_fixtures/ApiAppUpdateRequest.json b/test_fixtures/ApiAppUpdateRequest.json index 4744e05..ee4e9ff 100644 --- a/test_fixtures/ApiAppUpdateRequest.json +++ b/test_fixtures/ApiAppUpdateRequest.json @@ -4,7 +4,7 @@ "domains": [ "example.com" ], - "callback_url": "http://example.com/dropboxsign", + "callback_url": "https://example.com/dropboxsign", "oauth": { "callback_url": "https://example.com/oauth", "scopes": [ @@ -18,18 +18,18 @@ "white_labeling_options": { "header_background_color": "#1A1A1A", "legal_version": "terms1", - "link_color": "#00B3E6", - "page_background_color": "#F7F8F9", - "primary_button_color": "#00b3e6", - "primary_button_color_hover": "#00B3E6", + "link_color": "#0061FE", + "page_background_color": "#f7f8f9", + "primary_button_color": "#0061FE", + "primary_button_color_hover": "#0061FE", "primary_button_text_color": "#ffffff", - "primary_button_text_color_hover": "#FFFFFF", - "secondary_button_color": "#FFFFFF", - "secondary_button_color_hover": "#FFFFFF", - "secondary_button_text_color": "#00B3E6", - "secondary_button_text_color_hover": "#00B3E6", + "primary_button_text_color_hover": "#ffffff", + "secondary_button_color": "#ffffff", + "secondary_button_color_hover": "#ffffff", + "secondary_button_text_color": "#0061FE", + "secondary_button_text_color_hover": "#0061FE", "text_color1": "#808080", - "text_color2": "#FFFFFF" + "text_color2": "#ffffff" } } } diff --git a/test_fixtures/FaxGetResponse.json b/test_fixtures/FaxGetResponse.json new file mode 100644 index 0000000..5892719 --- /dev/null +++ b/test_fixtures/FaxGetResponse.json @@ -0,0 +1,23 @@ +{ + "default": { + "fax": { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [ + { + "recipient": "recipient@dropboxsign.com", + "sender": "me@dropboxsign.com", + "sent_at": 1723231831, + "status_code": "success" + } + ], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + } + } +} diff --git a/test_fixtures/FaxListResponse.json b/test_fixtures/FaxListResponse.json new file mode 100644 index 0000000..bfa69cd --- /dev/null +++ b/test_fixtures/FaxListResponse.json @@ -0,0 +1,31 @@ +{ + "default": { + "list_info": { + "num_pages": 1, + "num_results": 1, + "page": 1, + "page_size": 1 + }, + "faxes": [ + { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [ + { + "recipient": "recipient@dropboxsign.com", + "sender": "me@dropboxsign.com", + "sent_at": 1723231831, + "status_code": "success" + } + ], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + } + ] + } +} diff --git a/test_fixtures/FaxSendRequest.json b/test_fixtures/FaxSendRequest.json new file mode 100644 index 0000000..4c418cb --- /dev/null +++ b/test_fixtures/FaxSendRequest.json @@ -0,0 +1,14 @@ +{ + "default": { + "file_url": [ + "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + ], + "test_mode": "true", + "recipient": "16690000001", + "sender": "16690000000", + "cover_page_to": "Jill Fax", + "cover_page_message": "I'm sending you a fax!", + "cover_page_from": "Faxer Faxerson", + "title": "This is what the fax is about!" + } +} diff --git a/test_fixtures/FaxSendResponse.json b/test_fixtures/FaxSendResponse.json new file mode 100644 index 0000000..b651c78 --- /dev/null +++ b/test_fixtures/FaxSendResponse.json @@ -0,0 +1,16 @@ +{ + "default": { + "fax": { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [ ], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + } + } +} diff --git a/test_fixtures/TeamGetResponse.json b/test_fixtures/TeamGetResponse.json index 2ed1d16..327d26c 100644 --- a/test_fixtures/TeamGetResponse.json +++ b/test_fixtures/TeamGetResponse.json @@ -28,6 +28,11 @@ "api_signature_requests_left": 0 } } + ], + "invited_emails": [ + "invite_1@example.com", + "invite_2@example.com", + "invite_3@example.com" ] } } diff --git a/test_fixtures/TemplateGetResponse.json b/test_fixtures/TemplateGetResponse.json index 52ff622..b025913 100644 --- a/test_fixtures/TemplateGetResponse.json +++ b/test_fixtures/TemplateGetResponse.json @@ -5,7 +5,10 @@ "title": "Mutual NDA", "message": "Please sign this NDA as soon as possible.", "updated_at": 1570471067, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -566,496 +569,40 @@ ] } ], - "custom_fields": [ - { - "name": "merge_field_1", - "type": "text", - "x": 417, - "y": 219, - "width": 72, - "height": 15, - "required": false, - "api_id": "967c3e5f-2912-4f53-8ea3-c750652d29fc", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "merge_field_2", - "type": "checkbox", - "x": 515, - "y": 346, - "width": 18, - "height": 18, - "required": false, - "api_id": "5e8fe02f-51cf-4f0b-b1d9-2b1e4f6ad07f" - } - ], - "named_form_fields": [ - { - "name": "Signature1", - "type": "signature", - "signer": "1", - "x": 136, - "y": 17, - "width": 108, - "height": 27, - "required": true, - "api_id": "8b6d78a5-0870-4f46-af9c-b78b54a49348" - }, - { - "name": "Textbox1", - "type": "text", - "signer": "1", - "x": 328, - "y": 17, - "width": 144, - "height": 14, - "required": true, - "api_id": "7ec10d80-53c9-433b-b252-0b8daa90a8e0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox2", - "type": "text", - "signer": "1", - "x": 328, - "y": 48, - "width": 144, - "height": 14, - "required": true, - "api_id": "6574e6ad-7dac-49a2-9d56-650d7c5ade6e", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Initial1", - "type": "initials", - "signer": "1", - "x": 148, - "y": 66, - "width": 72, - "height": 27, - "required": true, - "api_id": "30f41f54-c7f3-46c3-a29a-bb76ec40b552" - }, - { - "name": "Checkbox1", - "type": "checkbox", - "signer": "1", - "x": 325, - "y": 111, - "width": 18, - "height": 18, - "required": false, - "api_id": "d4d6ada9-e1dc-419e-bc0d-1478da694449", - "group": "75a6e4b5fea47" - }, - { - "name": "Dropdown1", - "type": "dropdown", - "signer": "1", - "x": 423, - "y": 108, - "width": 70, - "height": 14, - "required": true, - "api_id": "5863be5e-ce5a-4c9d-aabe-c221914d73c2" - }, - { - "name": "DateSigned1", - "type": "date_signed", - "signer": "1", - "x": 150, - "y": 119, - "width": 105, - "height": 18, - "required": true, - "api_id": "9f6d3722-6db7-46da-8fac-3bc09f510262" - }, - { - "name": "Checkbox2", - "type": "checkbox", - "signer": "1", - "x": 325, - "y": 135, - "width": 18, - "height": 18, - "required": false, - "api_id": "edd732b8-b158-4714-a87b-503637d09ded", - "group": "75a6e4b5fea47" - }, - { - "name": "FullName1", - "type": "text", - "signer": "1", - "x": 144, - "y": 158, - "width": 72, - "height": 14, - "required": true, - "api_id": "62fd3f85-4808-4011-8eae-a14ebe9105ef", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Email1", - "type": "text", - "signer": "1", - "x": 133, - "y": 191, - "width": 144, - "height": 14, - "required": true, - "api_id": "a1c9bc6b-d498-4787-86e0-30ea779f06a7", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "email_address" - }, - { - "name": "RadioItem1", - "type": "radio", - "signer": "1", - "x": 307, - "y": 211, - "width": 18, - "height": 18, - "required": false, - "api_id": "fc8a1277-f757-47a2-aeea-5113fa81f2d5", - "group": "0831822584086" - }, - { - "name": "Company1", - "type": "text", - "signer": "1", - "x": 128, - "y": 221, - "width": 144, - "height": 14, - "required": true, - "api_id": "279b4e7f-e71f-426d-845c-6308cddde379", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Title1", - "type": "text", - "signer": "1", - "x": 127, - "y": 250, - "width": 144, - "height": 14, - "required": true, - "api_id": "8809e39a-a46c-4dae-aaf9-06fc6355d80f", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "RadioItem2", - "type": "radio", - "signer": "1", - "x": 307, - "y": 253, - "width": 18, - "height": 18, - "required": false, - "api_id": "f7b6b70d-0522-4ab7-bfec-b86f147c8be3", - "group": "0831822584086" - }, - { - "name": "Textbox3", - "type": "text", - "signer": "1", - "x": 410, - "y": 279, - "width": 144, - "height": 14, - "required": true, - "api_id": "bad7512a-e22b-46ed-ba03-123db0eda932", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox4", - "type": "text", - "signer": "1", - "x": 101, - "y": 314, - "width": 72, - "height": 14, - "required": true, - "api_id": "368ed029-bc93-4f92-8f7a-14c3bf8109b5", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "custom_regex" - }, - { - "name": "Textbox8", - "type": "text", - "signer": "1", - "x": 218, - "y": 313, - "width": 72, - "height": 14, - "required": true, - "api_id": "ecf2ae95-d2e6-41b2-819a-836a6fa8c7c5", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "bank_routing_number" - }, - { - "name": "Textbox12", - "type": "text", - "signer": "1", - "x": 339, - "y": 315, - "width": 72, - "height": 14, - "required": true, - "api_id": "3cb90a0a-a433-4f30-8af8-8fb4c747b704", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "social_security_number" - }, - { - "name": "Textbox9", - "type": "text", - "signer": "1", - "x": 224, - "y": 343, - "width": 72, - "height": 14, - "required": true, - "api_id": "5b9eb331-c97d-435b-a563-d936a9b930c0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "bank_account_number" - }, - { - "name": "Textbox13", - "type": "text", - "signer": "1", - "x": 339, - "y": 345, - "width": 72, - "height": 14, - "required": true, - "api_id": "2b98ce7e-e53a-4cf8-a9f3-d7fb18d88631", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "employer_identification_number" - }, - { - "name": "Textbox5", - "type": "text", - "signer": "1", - "x": 113, - "y": 350, - "width": 72, - "height": 14, - "required": true, - "api_id": "5f52c011-2c5f-4143-bf04-4694fb4a0d3f", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "numbers_only" - }, - { - "name": "Textbox6", - "type": "text", - "signer": "1", - "x": 122, - "y": 374, - "width": 72, - "height": 14, - "required": true, - "api_id": "47457b7d-b1e8-41a0-93ad-60ba30e64bb1", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "letters_only" - }, - { - "name": "Textbox10", - "type": "text", - "signer": "1", - "x": 234, - "y": 373, - "width": 72, - "height": 14, - "required": true, - "api_id": "18e3f994-1675-4d58-9b4a-4f92a2614551", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "email_address" - }, - { - "name": "Textbox14", - "type": "text", - "signer": "1", - "x": 339, - "y": 376, - "width": 72, - "height": 14, - "required": true, - "api_id": "9ad4b8cc-bac9-432b-8836-9f80f86fc7e0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox7", - "type": "text", - "signer": "1", - "x": 130, - "y": 401, - "width": 72, - "height": 14, - "required": true, - "api_id": "58c5f942-04fb-45f1-9703-5e8411f3a3bb", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "phone_number" - }, - { - "name": "me_now_hyperlink_1", - "type": "hyperlink", - "signer": "me_now", - "x": 434, - "y": 400, - "width": 112, - "height": 14, - "required": false, - "api_id": "fd928b56-cf59-40a4-9a90-62f97ffd0ddc", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 30 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "helvetica" - }, - { - "name": "Textbox11", - "type": "text", - "signer": "1", - "x": 237, - "y": 405, - "width": 72, - "height": 14, - "required": true, - "api_id": "e48c388d-8c26-4f20-848e-f8587a631746", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "zip_code" - } - ], "accounts": [ { "account_id": "5008b25c7f67153e57d5a357b1687968068fb465", "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } }, { "account_id": "", "email_address": "teammate@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } + } + ], + "attachments": [ + { + "id": "attachment_1", + "signer": "Outside Vendor", + "name": "Attachment #1", + "required": true } ] } diff --git a/test_fixtures/TemplateListResponse.json b/test_fixtures/TemplateListResponse.json index 7c4768b..caa5e6d 100644 --- a/test_fixtures/TemplateListResponse.json +++ b/test_fixtures/TemplateListResponse.json @@ -12,7 +12,10 @@ "title": "Purchase order", "message": "", "updated_at": 1570471067, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -49,7 +52,8 @@ "originalFontSize": 12, "fontFamily": "arial" } - ] + ], + "static_fields": [] } ], "accounts": [ @@ -58,7 +62,21 @@ "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } + } + ], + "attachments": [ + { + "id": "attachment_1", + "signer": "Outside Vendor", + "name": "Attachment #1", + "required": true } ] }, @@ -67,7 +85,10 @@ "title": "Mutual NDA", "message": "Please sign this NDA as soon as possible.", "updated_at": 1329478947, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -564,7 +585,8 @@ "fontFamily": "arial", "validation_type": "zip_code" } - ] + ], + "static_fields": [] } ], "accounts": [ @@ -573,9 +595,16 @@ "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } } - ] + ], + "attachments": [] } ] } diff --git a/types/api/apis.d.ts b/types/api/apis.d.ts index 1a3027e..7d24031 100644 --- a/types/api/apis.d.ts +++ b/types/api/apis.d.ts @@ -23,7 +23,7 @@ export interface returnTypeI { body?: any; } export declare const queryParamsSerializer: (params: any) => string; -export declare const USER_AGENT = "OpenAPI-Generator/1.6.2/node"; +export declare const USER_AGENT = "OpenAPI-Generator/1.7.0/node"; export declare const generateFormData: (obj: any, typemap: AttributeTypeMap) => { localVarUseFormData: boolean; data: object; diff --git a/types/api/faxApi.d.ts b/types/api/faxApi.d.ts new file mode 100644 index 0000000..f18e422 --- /dev/null +++ b/types/api/faxApi.d.ts @@ -0,0 +1,32 @@ +import { Authentication, FaxGetResponse, FaxListResponse, FaxSendRequest, HttpBasicAuth, HttpBearerAuth, Interceptor } from "../model"; +import { optionsI, returnTypeI, returnTypeT } from "./"; +export declare enum FaxApiApiKeys { +} +export declare class FaxApi { + protected _basePath: string; + protected _defaultHeaders: any; + protected _useQuerystring: boolean; + protected authentications: { + default: Authentication; + api_key: HttpBasicAuth; + oauth2: HttpBearerAuth; + }; + protected interceptors: Interceptor[]; + constructor(basePath?: string); + set useQuerystring(value: boolean); + set basePath(basePath: string); + set defaultHeaders(defaultHeaders: any); + get defaultHeaders(): any; + get basePath(): string; + setDefaultAuthentication(auth: Authentication): void; + setApiKey(key: string): void; + set username(username: string); + set password(password: string); + set accessToken(accessToken: string | (() => string)); + addInterceptor(interceptor: Interceptor): void; + faxDelete(faxId: string, options?: optionsI): Promise; + faxFiles(faxId: string, options?: optionsI): Promise>; + faxGet(faxId: string, options?: optionsI): Promise>; + faxList(page?: number, pageSize?: number, options?: optionsI): Promise>; + faxSend(faxSendRequest: FaxSendRequest, options?: optionsI): Promise>; +} diff --git a/types/api/index.d.ts b/types/api/index.d.ts index 567248c..4fb28dc 100644 --- a/types/api/index.d.ts +++ b/types/api/index.d.ts @@ -2,6 +2,7 @@ import { AccountApi } from "./accountApi"; import { ApiAppApi } from "./apiAppApi"; import { BulkSendJobApi } from "./bulkSendJobApi"; import { EmbeddedApi } from "./embeddedApi"; +import { FaxApi } from "./faxApi"; import { FaxLineApi } from "./faxLineApi"; import { OAuthApi } from "./oAuthApi"; import { ReportApi } from "./reportApi"; @@ -9,6 +10,6 @@ import { SignatureRequestApi } from "./signatureRequestApi"; import { TeamApi } from "./teamApi"; import { TemplateApi } from "./templateApi"; import { UnclaimedDraftApi } from "./unclaimedDraftApi"; -export { AccountApi, ApiAppApi, BulkSendJobApi, EmbeddedApi, FaxLineApi, OAuthApi, ReportApi, SignatureRequestApi, TeamApi, TemplateApi, UnclaimedDraftApi, }; +export { AccountApi, ApiAppApi, BulkSendJobApi, EmbeddedApi, FaxApi, FaxLineApi, OAuthApi, ReportApi, SignatureRequestApi, TeamApi, TemplateApi, UnclaimedDraftApi, }; export { generateFormData, HttpError, optionsI, queryParamsSerializer, returnTypeI, returnTypeT, toFormData, USER_AGENT, } from "./apis"; -export declare const APIS: (typeof AccountApi | typeof ApiAppApi | typeof BulkSendJobApi | typeof EmbeddedApi | typeof FaxLineApi | typeof OAuthApi | typeof ReportApi | typeof SignatureRequestApi | typeof TeamApi | typeof TemplateApi | typeof UnclaimedDraftApi)[]; +export declare const APIS: (typeof AccountApi | typeof ApiAppApi | typeof BulkSendJobApi | typeof EmbeddedApi | typeof FaxApi | typeof FaxLineApi | typeof OAuthApi | typeof ReportApi | typeof SignatureRequestApi | typeof TeamApi | typeof TemplateApi | typeof UnclaimedDraftApi)[]; diff --git a/types/model/apiAppResponseOAuth.d.ts b/types/model/apiAppResponseOAuth.d.ts index 13f00a8..cd298f6 100644 --- a/types/model/apiAppResponseOAuth.d.ts +++ b/types/model/apiAppResponseOAuth.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOAuth { "callbackUrl"?: string; - "secret"?: string; + "secret"?: string | null; "scopes"?: Array; "chargesUsers"?: boolean; static discriminator: string | undefined; diff --git a/types/model/faxGetResponse.d.ts b/types/model/faxGetResponse.d.ts new file mode 100644 index 0000000..05b6196 --- /dev/null +++ b/types/model/faxGetResponse.d.ts @@ -0,0 +1,11 @@ +import { AttributeTypeMap } from "./"; +import { FaxResponse } from "./faxResponse"; +import { WarningResponse } from "./warningResponse"; +export declare class FaxGetResponse { + "fax": FaxResponse; + "warnings"?: Array; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxGetResponse; +} diff --git a/types/model/faxListResponse.d.ts b/types/model/faxListResponse.d.ts new file mode 100644 index 0000000..e36e8a0 --- /dev/null +++ b/types/model/faxListResponse.d.ts @@ -0,0 +1,11 @@ +import { AttributeTypeMap } from "./"; +import { FaxResponse } from "./faxResponse"; +import { ListInfoResponse } from "./listInfoResponse"; +export declare class FaxListResponse { + "faxes": Array; + "listInfo": ListInfoResponse; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxListResponse; +} diff --git a/types/model/faxResponse.d.ts b/types/model/faxResponse.d.ts new file mode 100644 index 0000000..6aa5f2d --- /dev/null +++ b/types/model/faxResponse.d.ts @@ -0,0 +1,20 @@ +import { AttributeTypeMap } from "./"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; +export declare class FaxResponse { + "faxId": string; + "title": string; + "originalTitle": string; + "subject": string; + "message": string; + "metadata": { + [key: string]: any; + }; + "createdAt": number; + "sender": string; + "transmissions": Array; + "filesUrl": string; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxResponse; +} diff --git a/types/model/faxResponseTransmission.d.ts b/types/model/faxResponseTransmission.d.ts new file mode 100644 index 0000000..f1d587f --- /dev/null +++ b/types/model/faxResponseTransmission.d.ts @@ -0,0 +1,23 @@ +import { AttributeTypeMap } from "./"; +export declare class FaxResponseTransmission { + "recipient": string; + "sender": string; + "statusCode": FaxResponseTransmission.StatusCodeEnum; + "sentAt"?: number; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxResponseTransmission; +} +export declare namespace FaxResponseTransmission { + enum StatusCodeEnum { + Success = "success", + Transmitting = "transmitting", + ErrorCouldNotFax = "error_could_not_fax", + ErrorUnknown = "error_unknown", + ErrorBusy = "error_busy", + ErrorNoAnswer = "error_no_answer", + ErrorDisconnected = "error_disconnected", + ErrorBadDestination = "error_bad_destination" + } +} diff --git a/types/model/faxSendRequest.d.ts b/types/model/faxSendRequest.d.ts new file mode 100644 index 0000000..9545472 --- /dev/null +++ b/types/model/faxSendRequest.d.ts @@ -0,0 +1,16 @@ +import { AttributeTypeMap, RequestFile } from "./"; +export declare class FaxSendRequest { + "recipient": string; + "sender"?: string; + "files"?: Array; + "fileUrls"?: Array; + "testMode"?: boolean; + "coverPageTo"?: string; + "coverPageFrom"?: string; + "coverPageMessage"?: string; + "title"?: string; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxSendRequest; +} diff --git a/types/model/index.d.ts b/types/model/index.d.ts index ad78599..664b479 100644 --- a/types/model/index.d.ts +++ b/types/model/index.d.ts @@ -33,6 +33,7 @@ import { EventCallbackHelper } from "./eventCallbackHelper"; import { EventCallbackRequest } from "./eventCallbackRequest"; import { EventCallbackRequestEvent } from "./eventCallbackRequestEvent"; import { EventCallbackRequestEventMetadata } from "./eventCallbackRequestEventMetadata"; +import { FaxGetResponse } from "./faxGetResponse"; import { FaxLineAddUserRequest } from "./faxLineAddUserRequest"; import { FaxLineAreaCodeGetCountryEnum } from "./faxLineAreaCodeGetCountryEnum"; import { FaxLineAreaCodeGetProvinceEnum } from "./faxLineAreaCodeGetProvinceEnum"; @@ -44,6 +45,10 @@ import { FaxLineListResponse } from "./faxLineListResponse"; import { FaxLineRemoveUserRequest } from "./faxLineRemoveUserRequest"; import { FaxLineResponse } from "./faxLineResponse"; import { FaxLineResponseFaxLine } from "./faxLineResponseFaxLine"; +import { FaxListResponse } from "./faxListResponse"; +import { FaxResponse } from "./faxResponse"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; +import { FaxSendRequest } from "./faxSendRequest"; import { FileResponse } from "./fileResponse"; import { FileResponseDataUri } from "./fileResponseDataUri"; import { ListInfoResponse } from "./listInfoResponse"; @@ -189,4 +194,4 @@ export declare let enumsMap: { export declare let typeMap: { [index: string]: any; }; -export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; +export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FaxListResponse, FaxResponse, FaxResponseTransmission, FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; diff --git a/types/model/oAuthTokenRefreshRequest.d.ts b/types/model/oAuthTokenRefreshRequest.d.ts index 5321188..71f3d10 100644 --- a/types/model/oAuthTokenRefreshRequest.d.ts +++ b/types/model/oAuthTokenRefreshRequest.d.ts @@ -2,6 +2,8 @@ import { AttributeTypeMap } from "./"; export declare class OAuthTokenRefreshRequest { "grantType": string; "refreshToken": string; + "clientId"?: string; + "clientSecret"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponse.d.ts b/types/model/templateResponse.d.ts index 8ac333e..b063aef 100644 --- a/types/model/templateResponse.d.ts +++ b/types/model/templateResponse.d.ts @@ -1,4 +1,5 @@ import { AttributeTypeMap } from "./"; +import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -11,16 +12,17 @@ export declare class TemplateResponse { "message"?: string; "updatedAt"?: number; "isEmbedded"?: boolean | null; - "isCreator"?: boolean | null; - "canEdit"?: boolean | null; - "isLocked"?: boolean | null; + "isCreator"?: boolean; + "canEdit"?: boolean; + "isLocked"?: boolean; "metadata"?: object; "signerRoles"?: Array; "ccRoles"?: Array; "documents"?: Array; "customFields"?: Array | null; "namedFormFields"?: Array | null; - "accounts"?: Array | null; + "accounts"?: Array; + "attachments"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocument.d.ts b/types/model/templateResponseDocument.d.ts index 41b4537..c16b393 100644 --- a/types/model/templateResponseDocument.d.ts +++ b/types/model/templateResponseDocument.d.ts @@ -9,7 +9,7 @@ export declare class TemplateResponseDocument { "fieldGroups"?: Array; "formFields"?: Array; "customFields"?: Array; - "staticFields"?: Array | null; + "staticFields"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldBase.d.ts b/types/model/templateResponseDocumentFormFieldBase.d.ts index 6df5fc1..f2ae3c8 100644 --- a/types/model/templateResponseDocumentFormFieldBase.d.ts +++ b/types/model/templateResponseDocumentFormFieldBase.d.ts @@ -9,7 +9,6 @@ export declare abstract class TemplateResponseDocumentFormFieldBase { "width"?: number; "height"?: number; "required"?: boolean; - "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldCheckbox.d.ts b/types/model/templateResponseDocumentFormFieldCheckbox.d.ts index 0748b1e..40adf3c 100644 --- a/types/model/templateResponseDocumentFormFieldCheckbox.d.ts +++ b/types/model/templateResponseDocumentFormFieldCheckbox.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldDateSigned.d.ts b/types/model/templateResponseDocumentFormFieldDateSigned.d.ts index d66f2cb..d755cb4 100644 --- a/types/model/templateResponseDocumentFormFieldDateSigned.d.ts +++ b/types/model/templateResponseDocumentFormFieldDateSigned.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldDropdown.d.ts b/types/model/templateResponseDocumentFormFieldDropdown.d.ts index deb3e5b..b9f96a2 100644 --- a/types/model/templateResponseDocumentFormFieldDropdown.d.ts +++ b/types/model/templateResponseDocumentFormFieldDropdown.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldHyperlink.d.ts b/types/model/templateResponseDocumentFormFieldHyperlink.d.ts index 4d10cf2..856574e 100644 --- a/types/model/templateResponseDocumentFormFieldHyperlink.d.ts +++ b/types/model/templateResponseDocumentFormFieldHyperlink.d.ts @@ -7,6 +7,7 @@ export declare class TemplateResponseDocumentFormFieldHyperlink extends Template "isMultiline"?: boolean; "originalFontSize"?: number; "fontFamily"?: string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldInitials.d.ts b/types/model/templateResponseDocumentFormFieldInitials.d.ts index c935be0..6a1a035 100644 --- a/types/model/templateResponseDocumentFormFieldInitials.d.ts +++ b/types/model/templateResponseDocumentFormFieldInitials.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldRadio.d.ts b/types/model/templateResponseDocumentFormFieldRadio.d.ts index c3f1747..e0fc8a2 100644 --- a/types/model/templateResponseDocumentFormFieldRadio.d.ts +++ b/types/model/templateResponseDocumentFormFieldRadio.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase { "type": string; + "group": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldSignature.d.ts b/types/model/templateResponseDocumentFormFieldSignature.d.ts index 06a9634..d005bd0 100644 --- a/types/model/templateResponseDocumentFormFieldSignature.d.ts +++ b/types/model/templateResponseDocumentFormFieldSignature.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/types/model/templateResponseDocumentFormFieldText.d.ts b/types/model/templateResponseDocumentFormFieldText.d.ts index 9a65fc2..5f6dcb4 100644 --- a/types/model/templateResponseDocumentFormFieldText.d.ts +++ b/types/model/templateResponseDocumentFormFieldText.d.ts @@ -8,6 +8,7 @@ export declare class TemplateResponseDocumentFormFieldText extends TemplateRespo "originalFontSize"?: number; "fontFamily"?: string; "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap;