diff --git a/VERSION b/VERSION index f8e233b..a13e7b9 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.9.0 +10.0.0 diff --git a/api/apis.ts b/api/apis.ts index 53fbc15..2b3e3b7 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.9.0/node"; +export const USER_AGENT = "OpenAPI-Generator/10.0.0/node"; /** * Generates an object containing form data. diff --git a/dist/api.js b/dist/api.js index c385a9a..1e8723d 100644 --- a/dist/api.js +++ b/dist/api.js @@ -19239,6 +19239,7 @@ var ReportCreateRequest = class _ReportCreateRequest { ((ReportTypeEnum2) => { ReportTypeEnum2["UserActivity"] = "user_activity"; ReportTypeEnum2["DocumentStatus"] = "document_status"; + ReportTypeEnum2["SmsActivity"] = "sms_activity"; })(ReportTypeEnum = ReportCreateRequest2.ReportTypeEnum || (ReportCreateRequest2.ReportTypeEnum = {})); })(ReportCreateRequest || (ReportCreateRequest = {})); @@ -19312,6 +19313,7 @@ var ReportResponse = class _ReportResponse { ((ReportTypeEnum2) => { ReportTypeEnum2["UserActivity"] = "user_activity"; ReportTypeEnum2["DocumentStatus"] = "document_status"; + ReportTypeEnum2["SmsActivity"] = "sms_activity"; })(ReportTypeEnum = ReportResponse2.ReportTypeEnum || (ReportResponse2.ReportTypeEnum = {})); })(ReportResponse || (ReportResponse = {})); @@ -25344,6 +25346,16 @@ var TemplateResponseDocumentFormFieldText = class _TemplateResponseDocumentFormF baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum" }, + { + name: "validationCustomRegex", + baseName: "validation_custom_regex", + type: "string" + }, + { + name: "validationCustomRegexFormatLabel", + baseName: "validation_custom_regex_format_label", + type: "string" + }, { name: "group", baseName: "group", @@ -36223,7 +36235,7 @@ var HttpError = class extends Error { var queryParamsSerializer = (params) => { return import_qs.default.stringify(params, { arrayFormat: "brackets" }); }; -var USER_AGENT = "OpenAPI-Generator/1.9.0/node"; +var USER_AGENT = "OpenAPI-Generator/10.0.0/node"; var generateFormData = (obj, typemap) => { const data = {}; let localVarUseFormData = false; diff --git a/docs/model/OAuthTokenRefreshRequest.md b/docs/model/OAuthTokenRefreshRequest.md index 8a24bdc..b09d1e8 100644 --- a/docs/model/OAuthTokenRefreshRequest.md +++ b/docs/model/OAuthTokenRefreshRequest.md @@ -8,7 +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. | | +| `clientId` | ```string``` | The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | | +| `clientSecret` | ```string``` | The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | | [[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 25a86e8..07154a2 100644 --- a/docs/model/TemplateResponseDocumentFormFieldText.md +++ b/docs/model/TemplateResponseDocumentFormFieldText.md @@ -12,6 +12,8 @@ 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. | | +| `validationCustomRegex` | ```string``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | +| `validationCustomRegexFormatLabel` | ```string``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | | `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/model/oAuthTokenRefreshRequest.ts b/model/oAuthTokenRefreshRequest.ts index 2f8971d..0474497 100644 --- a/model/oAuthTokenRefreshRequest.ts +++ b/model/oAuthTokenRefreshRequest.ts @@ -34,11 +34,11 @@ export class OAuthTokenRefreshRequest { */ "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. + * The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. */ "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. + * The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. */ "clientSecret"?: string; diff --git a/model/reportCreateRequest.ts b/model/reportCreateRequest.ts index 48960cc..de07444 100644 --- a/model/reportCreateRequest.ts +++ b/model/reportCreateRequest.ts @@ -72,5 +72,6 @@ export namespace ReportCreateRequest { export enum ReportTypeEnum { UserActivity = "user_activity", DocumentStatus = "document_status", + SmsActivity = "sms_activity", } } diff --git a/model/reportResponse.ts b/model/reportResponse.ts index 589ded1..e47c024 100644 --- a/model/reportResponse.ts +++ b/model/reportResponse.ts @@ -84,5 +84,6 @@ export namespace ReportResponse { export enum ReportTypeEnum { UserActivity = "user_activity", DocumentStatus = "document_status", + SmsActivity = "sms_activity", } } diff --git a/model/templateResponseDocumentFormFieldText.ts b/model/templateResponseDocumentFormFieldText.ts index e758496..a10ace9 100644 --- a/model/templateResponseDocumentFormFieldText.ts +++ b/model/templateResponseDocumentFormFieldText.ts @@ -51,6 +51,14 @@ 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; + /** + * When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. + */ + "validationCustomRegex"?: string | null; + /** + * When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. + */ + "validationCustomRegexFormatLabel"?: string | null; /** * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. */ @@ -89,6 +97,16 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum", }, + { + name: "validationCustomRegex", + baseName: "validation_custom_regex", + type: "string", + }, + { + name: "validationCustomRegexFormatLabel", + baseName: "validation_custom_regex_format_label", + type: "string", + }, { name: "group", baseName: "group", diff --git a/openapi-config.yaml b/openapi-config.yaml index 9741af3..48d50e7 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -2,7 +2,7 @@ generatorName: typescript-node typeMappings: {} additionalProperties: npmName: "@dropbox/sign" - npmVersion: 1.9.0 + npmVersion: 10.0.0 supportsES6: true apiDocPath: ./docs/api modelDocPath: ./docs/model diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index c832450..c123c2e 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -7797,7 +7797,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 minItems: 1 name: description: 'The name you want to assign to the ApiApp.' @@ -7823,7 +7823,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 name: description: 'The name you want to assign to the ApiApp.' type: string @@ -8112,10 +8112,10 @@ components: 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.' + description: 'The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.' 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.' + description: 'The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.' type: string type: object ReportCreateRequest: @@ -8135,6 +8135,7 @@ components: enum: - user_activity - document_status + - sms_activity maxItems: 2 minItems: 1 start_date: @@ -11964,6 +11965,7 @@ components: enum: - user_activity - document_status + - sms_activity type: object x-internal-class: true SignatureRequestResponse: @@ -13130,6 +13132,14 @@ components: - employer_identification_number - custom_regex nullable: true + validation_custom_regex: + description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.' + type: string + nullable: true + validation_custom_regex_format_label: + description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.' + type: string + 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 diff --git a/package-lock.json b/package-lock.json index 694968c..ddcce96 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dropbox/sign", - "version": "1.9.0", + "version": "10.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@dropbox/sign", - "version": "1.9.0", + "version": "10.0.0", "dependencies": { "axios": "^1.8.2", "bluebird": "^3.7.2", diff --git a/package.json b/package.json index 3fadcbd..fb63050 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@dropbox/sign", - "version": "1.9.0", + "version": "10.0.0", "description": "Official Node client for Dropbox Sign", "repository": { "type": "git", diff --git a/test_fixtures/FaxGetResponse.json b/test_fixtures/FaxGetResponse.json index 2eda936..0d668e0 100644 --- a/test_fixtures/FaxGetResponse.json +++ b/test_fixtures/FaxGetResponse.json @@ -20,12 +20,11 @@ "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", + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" } } } diff --git a/test_fixtures/FaxLineCreateRequest.json b/test_fixtures/FaxLineCreateRequest.json new file mode 100644 index 0000000..91d11c8 --- /dev/null +++ b/test_fixtures/FaxLineCreateRequest.json @@ -0,0 +1,6 @@ +{ + "default": { + "country": "US", + "area_code": 949 + } +} diff --git a/test_fixtures/FaxLineListResponse.json b/test_fixtures/FaxLineListResponse.json new file mode 100644 index 0000000..c241c1b --- /dev/null +++ b/test_fixtures/FaxLineListResponse.json @@ -0,0 +1,26 @@ +{ + "default": { + "list_info": { + "num_pages": 1, + "num_results": 1, + "page": 1, + "page_size": 1 + }, + "fax_lines": [ + { + "number": "14155557897", + "created_at": 1750196223, + "updated_at": 1750196223, + "accounts": [ + { + "account_id": "a3367a4130f3624687ea7de6f09df951a44923dd", + "email_address": "me@dropboxsign.com", + "is_locked": false, + "is_paid_hs": false, + "is_paid_hf": true + } + ] + } + ] + } +} diff --git a/test_fixtures/FaxLineResponse.json b/test_fixtures/FaxLineResponse.json new file mode 100644 index 0000000..3855a8a --- /dev/null +++ b/test_fixtures/FaxLineResponse.json @@ -0,0 +1,18 @@ +{ + "default": { + "fax_line": { + "number": "14155557897", + "created_at": 1750196223, + "updated_at": 1750196223, + "accounts": [ + { + "account_id": "a3367a4130f3624687ea7de6f09df951a44923dd", + "email_address": "me@dropboxsign.com", + "is_locked": false, + "is_paid_hs": false, + "is_paid_hf": true + } + ] + } + } +} diff --git a/test_fixtures/FaxListResponse.json b/test_fixtures/FaxListResponse.json index a9ebf63..d0ce7fe 100644 --- a/test_fixtures/FaxListResponse.json +++ b/test_fixtures/FaxListResponse.json @@ -27,12 +27,11 @@ "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", + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" } ] } diff --git a/test_fixtures/FaxResponse.json b/test_fixtures/FaxResponse.json new file mode 100644 index 0000000..32a44d5 --- /dev/null +++ b/test_fixtures/FaxResponse.json @@ -0,0 +1,24 @@ +{ + "default": { + "fax": { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "metadata": {}, + "created_at": 1750105080, + "sender": "14155557068", + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "final_copy_uri": "/v3/transmission/final_copy/c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "transmissions": [ + { + "recipient": "18005550199", + "status_code": "transmitting" + } + ], + "transmission_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "from": "14155557068", + "test_mode": false + } + } +} + diff --git a/test_fixtures/FaxSendResponse.json b/test_fixtures/FaxSendResponse.json deleted file mode 100644 index b651c78..0000000 --- a/test_fixtures/FaxSendResponse.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "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/tests/api/faxApi.test.ts b/tests/api/faxApi.test.ts new file mode 100644 index 0000000..a943da1 --- /dev/null +++ b/tests/api/faxApi.test.ts @@ -0,0 +1,89 @@ +import 'jest'; + +import { FaxApi } from '../../api/'; +import * as m from '../../model/'; +import { + getFixtureData, + setExpectedResponse, + diffJson, +} from '../test_utils'; + +const axios = require('axios'); +const fs = require('fs'); +const MockAdapter = require('axios-mock-adapter'); + +describe('FaxApiTest', () => { + let mock: typeof MockAdapter; + + beforeEach(() => { + mock = new MockAdapter(axios); + }); + + const api = new FaxApi(); + const rootFilePath = __dirname + '/../../test_fixtures'; + + it('testFaxSend', () => { + const requestClass = 'FaxSendRequest'; + const requestData = getFixtureData(requestClass)['default']; + + const responseClass = 'FaxGetResponse'; + const responseData = getFixtureData(responseClass)['default']; + + setExpectedResponse(mock, responseData, 200); + + const obj = m.FaxSendRequest.init(requestData); + obj.files = [fs.createReadStream(`${rootFilePath}/pdf-sample.pdf`)]; + + api.faxSend(obj).then(response => { + const diff = diffJson( + response.body, + m.FaxGetResponse.init(responseData), + ); + + expect(response.body.constructor.name).toBe(responseClass); + expect(diff).toBeFalsy(); + }).catch(error => { + throw new Error('Should not have thrown error: ' + error); + }); + }); + + it('testFaxGet', () => { + const faxId = 'c2e9691c85d9d6fa6ae773842e3680b2b8650f1d'; + + const responseClass = 'FaxGetResponse'; + const responseData = getFixtureData(responseClass)['default']; + + setExpectedResponse(mock, responseData, 200); + + api.faxGet(faxId).then(response => { + const diff = diffJson( + response.body, + m.FaxGetResponse.init(responseData), + ); + + expect(response.body.constructor.name).toBe(responseClass); + expect(diff).toBeFalsy(); + }).catch(error => { + throw new Error('Should not have thrown error: ' + error); + }); + }); + + it('testFaxList', () => { + const responseClass = 'FaxListResponse'; + const responseData = getFixtureData(responseClass)['default']; + + setExpectedResponse(mock, responseData, 200); + + api.faxList().then(response => { + const diff = diffJson( + response.body, + m.FaxListResponse.init(responseData), + ); + + expect(response.body.constructor.name).toBe(responseClass); + expect(diff).toBeFalsy(); + }).catch(error => { + throw new Error('Should not have thrown error: ' + error); + }); + }); +}); diff --git a/tests/api/faxLineApi.test.ts b/tests/api/faxLineApi.test.ts new file mode 100644 index 0000000..2d0ff99 --- /dev/null +++ b/tests/api/faxLineApi.test.ts @@ -0,0 +1,86 @@ +import 'jest'; + +import { FaxLineApi } from '../../api/'; +import * as m from '../../model/'; +import { + getFixtureData, + setExpectedResponse, + diffJson, +} from '../test_utils'; + +const axios = require('axios'); +const fs = require('fs'); +const MockAdapter = require('axios-mock-adapter'); + +describe('FaxLineApiTest', () => { + let mock: typeof MockAdapter; + + beforeEach(() => { + mock = new MockAdapter(axios); + }); + + const api = new FaxLineApi(); + const rootFilePath = __dirname + '/../../test_fixtures'; + + it('testFaxLineCreate', () => { + const requestClass = 'FaxLineCreateRequest'; + const requestData = getFixtureData(requestClass)['default']; + + const responseClass = 'FaxLineResponse'; + const responseData = getFixtureData(responseClass)['default']; + + setExpectedResponse(mock, responseData, 200); + + api.faxLineCreate(requestData).then(response => { + const diff = diffJson( + response.body, + m.FaxLineResponse.init(responseData), + ); + + expect(response.body.constructor.name).toBe(responseClass); + expect(diff).toBeFalsy(); + }).catch(error => { + throw new Error('Should not have thrown error: ' + error); + }); + }); + + it('testFaxLineGet', () => { + const faxLineNumber = '14155557897'; + + const responseClass = 'FaxLineResponse'; + const responseData = getFixtureData(responseClass)['default']; + + setExpectedResponse(mock, responseData, 200); + + api.faxLineGet(faxLineNumber).then(response => { + const diff = diffJson( + response.body, + m.FaxLineResponse.init(responseData), + ); + + expect(response.body.constructor.name).toBe(responseClass); + expect(diff).toBeFalsy(); + }).catch(error => { + throw new Error('Should not have thrown error: ' + error); + }); + }); + + it('testFaxLineList', () => { + const responseClass = 'FaxLineListResponse'; + const responseData = getFixtureData(responseClass)['default']; + + setExpectedResponse(mock, responseData, 200); + + api.faxLineList().then(response => { + const diff = diffJson( + response.body, + m.FaxLineListResponse.init(responseData), + ); + + expect(response.body.constructor.name).toBe(responseClass); + expect(diff).toBeFalsy(); + }).catch(error => { + throw new Error('Should not have thrown error: ' + error); + }); + }); +}); diff --git a/types/api/apis.d.ts b/types/api/apis.d.ts index 30607a8..18d9666 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.9.0/node"; +export declare const USER_AGENT = "OpenAPI-Generator/10.0.0/node"; export declare const generateFormData: (obj: any, typemap: AttributeTypeMap) => { localVarUseFormData: boolean; data: object; diff --git a/types/model/reportCreateRequest.d.ts b/types/model/reportCreateRequest.d.ts index 7ccc67a..4bdd1f5 100644 --- a/types/model/reportCreateRequest.d.ts +++ b/types/model/reportCreateRequest.d.ts @@ -11,6 +11,7 @@ export declare class ReportCreateRequest { export declare namespace ReportCreateRequest { enum ReportTypeEnum { UserActivity = "user_activity", - DocumentStatus = "document_status" + DocumentStatus = "document_status", + SmsActivity = "sms_activity" } } diff --git a/types/model/reportResponse.d.ts b/types/model/reportResponse.d.ts index 88546b6..1490e79 100644 --- a/types/model/reportResponse.d.ts +++ b/types/model/reportResponse.d.ts @@ -12,6 +12,7 @@ export declare class ReportResponse { export declare namespace ReportResponse { enum ReportTypeEnum { UserActivity = "user_activity", - DocumentStatus = "document_status" + DocumentStatus = "document_status", + SmsActivity = "sms_activity" } } diff --git a/types/model/templateResponseDocumentFormFieldText.d.ts b/types/model/templateResponseDocumentFormFieldText.d.ts index 5f6dcb4..2509450 100644 --- a/types/model/templateResponseDocumentFormFieldText.d.ts +++ b/types/model/templateResponseDocumentFormFieldText.d.ts @@ -8,6 +8,8 @@ export declare class TemplateResponseDocumentFormFieldText extends TemplateRespo "originalFontSize"?: number; "fontFamily"?: string; "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + "validationCustomRegex"?: string | null; + "validationCustomRegexFormatLabel"?: string | null; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap;