@types/hellosign-embedded
Advanced tools
| // Type definitions for hellosign-embedded v1.0.3 | ||
| // Project: https://github.com/HelloFax/hellosign-embedded | ||
| // Definitions by: Brian Surowiec <https://github.com/xt0rted/> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
| declare module HelloSign { | ||
| interface MessageEvent { | ||
| event: string; | ||
| } | ||
| interface ClientCultures { | ||
| /** | ||
| * English (United States) | ||
| * | ||
| * @default en_US | ||
| */ | ||
| EN_US: string; | ||
| /** | ||
| * French (France) | ||
| * | ||
| * @default fr_FR | ||
| */ | ||
| FR_FR: string; | ||
| /** | ||
| * German (Germany) | ||
| * | ||
| * @default de_DE | ||
| */ | ||
| DE_DE: string; | ||
| /** | ||
| * Swedish (Sweden) | ||
| * | ||
| * @default sv_SE | ||
| */ | ||
| SV_SE: string; | ||
| /** | ||
| * Chinese (China) | ||
| * | ||
| * @default zh_CN | ||
| */ | ||
| ZH_CN: string; | ||
| /** | ||
| * Danish (Denmark) | ||
| * | ||
| * @default da_DK | ||
| */ | ||
| DA_DK: string; | ||
| /** | ||
| * Dutch (The Netherlands) | ||
| * @default nl_NL | ||
| */ | ||
| NL_NL: string; | ||
| /** | ||
| * The available client UI cultures | ||
| */ | ||
| supportedCultures: string[]; | ||
| } | ||
| interface OpenParameters { | ||
| /** | ||
| * The url to open in the child frame | ||
| */ | ||
| url?: string; | ||
| /** | ||
| * Where to go after the signature is completed | ||
| */ | ||
| redirectUrl?: string; | ||
| /** | ||
| * Whether a cancel button should be displayed | ||
| * | ||
| * @default true | ||
| */ | ||
| allowCancel?: boolean; | ||
| /** | ||
| * A listener for X-window messages coming from the child frame | ||
| */ | ||
| messageListener?: (eventData: MessageEvent) => void; | ||
| /** | ||
| * One of the HelloSign.CULTURES.supportedCultures | ||
| * | ||
| * @default HelloSign.CULTURES.EN_US | ||
| */ | ||
| userCulture?: string; | ||
| /** | ||
| * When true, debugging statements will be written to the console | ||
| * | ||
| * @default false | ||
| */ | ||
| debug?: boolean; | ||
| /** | ||
| * When true, domain verification step will be skipped if and only if the Signature Request was created with test_mode=1 | ||
| * | ||
| * @default false | ||
| */ | ||
| skipDomainVerification?: boolean; | ||
| /** | ||
| * DOM element that will contain the iframe on the page (defaults to document.body) | ||
| */ | ||
| container?: Element; | ||
| /** | ||
| * Height of the iFrame (only applicable when a container is specified) | ||
| */ | ||
| height?: number; | ||
| /** | ||
| * When true, the header will be hidden. | ||
| * This is only functional for customers with embedded branding enabled. | ||
| * | ||
| * @default false | ||
| */ | ||
| hideHeader?: boolean; | ||
| /** | ||
| * The version of the embedded user experience to display to signers (1 = legacy, 2 = responsive). | ||
| * This option is only honored if your account has accessed the API prior to Nov 14, 2015. | ||
| */ | ||
| uxVersion?: number; | ||
| /** | ||
| * The email of the person issuing a signature request. | ||
| * Required for allowing 'Me + Others' requests | ||
| */ | ||
| requester?: string; | ||
| /** | ||
| * An associative array to be used to customize the app's signer page | ||
| */ | ||
| whiteLabelingOptions?: Object; | ||
| } | ||
| interface HelloSignStatic { | ||
| /** | ||
| * The available client UI cultures | ||
| */ | ||
| CULTURES: ClientCultures; | ||
| /** | ||
| * The signature request was signed | ||
| * | ||
| * @default signature_request_signed | ||
| */ | ||
| EVENT_SIGNED: string; | ||
| /** | ||
| * The user closed the iFrame before completing | ||
| * | ||
| * @default signature_request_canceled | ||
| */ | ||
| EVENT_CANCELED: string; | ||
| /** | ||
| * An error occurred in the iFrame | ||
| * | ||
| * @default error | ||
| */ | ||
| EVENT_ERROR: string; | ||
| /** | ||
| * Initialize using your HelloSign API client ID. | ||
| * | ||
| * @param appClientId The API client ID the request is for. | ||
| */ | ||
| init(appClientId: string): void; | ||
| /** | ||
| * Open the signing window. | ||
| * | ||
| * @param params The options to use when opening the signing window. | ||
| */ | ||
| open(params: OpenParameters): void; | ||
| /** | ||
| * Close the signing window. | ||
| */ | ||
| close(): void; | ||
| } | ||
| } | ||
| declare var HelloSign: HelloSign.HelloSignStatic; |
| { | ||
| "name": "@types/hellosign-embedded", | ||
| "version": "1.0.3", | ||
| "version": "1.0.4", | ||
| "description": "TypeScript definitions for hellosign-embedded v1.0.3", | ||
@@ -14,4 +14,5 @@ "license": "MIT", | ||
| "dependencies": {}, | ||
| "typings": "hellosign-embedded.d.ts", | ||
| "typesPublisherContentHash": "1b98a2c500909f64fafc9a3858c77df3dffc4a7c0914d46dbbbdd7bf93afa685" | ||
| "peerDependencies": {}, | ||
| "typings": "index.d.ts", | ||
| "typesPublisherContentHash": "b9ad9aad8b827977ab98ae54cb27c295396364093c522e55da23267f1590b8b1" | ||
| } |
@@ -11,3 +11,3 @@ # Installation | ||
| Additional Details | ||
| * Last updated: Mon, 19 Sep 2016 17:28:59 GMT | ||
| * Last updated: Wed, 05 Oct 2016 20:53:33 GMT | ||
| * File structure: Global | ||
@@ -14,0 +14,0 @@ * Library Dependencies: none |
| { | ||
| "authors": "Brian Surowiec <https://github.com/xt0rted/>", | ||
| "definitionFilename": "hellosign-embedded.d.ts", | ||
| "definitionFilename": "index.d.ts", | ||
| "libraryDependencies": [], | ||
@@ -19,6 +19,6 @@ "moduleDependencies": [], | ||
| "files": [ | ||
| "hellosign-embedded.d.ts" | ||
| "index.d.ts" | ||
| ], | ||
| "hasPackageJson": false, | ||
| "contentHash": "1b98a2c500909f64fafc9a3858c77df3dffc4a7c0914d46dbbbdd7bf93afa685" | ||
| "contentHash": "b9ad9aad8b827977ab98ae54cb27c295396364093c522e55da23267f1590b8b1" | ||
| } |
| // Type definitions for hellosign-embedded v1.0.3 | ||
| // Project: https://github.com/HelloFax/hellosign-embedded | ||
| // Definitions by: Brian Surowiec <https://github.com/xt0rted/> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
| declare module HelloSign { | ||
| interface MessageEvent { | ||
| event: string; | ||
| } | ||
| interface ClientCultures { | ||
| /** | ||
| * English (United States) | ||
| * | ||
| * @default en_US | ||
| */ | ||
| EN_US: string; | ||
| /** | ||
| * French (France) | ||
| * | ||
| * @default fr_FR | ||
| */ | ||
| FR_FR: string; | ||
| /** | ||
| * German (Germany) | ||
| * | ||
| * @default de_DE | ||
| */ | ||
| DE_DE: string; | ||
| /** | ||
| * Swedish (Sweden) | ||
| * | ||
| * @default sv_SE | ||
| */ | ||
| SV_SE: string; | ||
| /** | ||
| * Chinese (China) | ||
| * | ||
| * @default zh_CN | ||
| */ | ||
| ZH_CN: string; | ||
| /** | ||
| * Danish (Denmark) | ||
| * | ||
| * @default da_DK | ||
| */ | ||
| DA_DK: string; | ||
| /** | ||
| * Dutch (The Netherlands) | ||
| * @default nl_NL | ||
| */ | ||
| NL_NL: string; | ||
| /** | ||
| * The available client UI cultures | ||
| */ | ||
| supportedCultures: string[]; | ||
| } | ||
| interface OpenParameters { | ||
| /** | ||
| * The url to open in the child frame | ||
| */ | ||
| url?: string; | ||
| /** | ||
| * Where to go after the signature is completed | ||
| */ | ||
| redirectUrl?: string; | ||
| /** | ||
| * Whether a cancel button should be displayed | ||
| * | ||
| * @default true | ||
| */ | ||
| allowCancel?: boolean; | ||
| /** | ||
| * A listener for X-window messages coming from the child frame | ||
| */ | ||
| messageListener?: (eventData: MessageEvent) => void; | ||
| /** | ||
| * One of the HelloSign.CULTURES.supportedCultures | ||
| * | ||
| * @default HelloSign.CULTURES.EN_US | ||
| */ | ||
| userCulture?: string; | ||
| /** | ||
| * When true, debugging statements will be written to the console | ||
| * | ||
| * @default false | ||
| */ | ||
| debug?: boolean; | ||
| /** | ||
| * When true, domain verification step will be skipped if and only if the Signature Request was created with test_mode=1 | ||
| * | ||
| * @default false | ||
| */ | ||
| skipDomainVerification?: boolean; | ||
| /** | ||
| * DOM element that will contain the iframe on the page (defaults to document.body) | ||
| */ | ||
| container?: Element; | ||
| /** | ||
| * Height of the iFrame (only applicable when a container is specified) | ||
| */ | ||
| height?: number; | ||
| /** | ||
| * When true, the header will be hidden. | ||
| * This is only functional for customers with embedded branding enabled. | ||
| * | ||
| * @default false | ||
| */ | ||
| hideHeader?: boolean; | ||
| /** | ||
| * The version of the embedded user experience to display to signers (1 = legacy, 2 = responsive). | ||
| * This option is only honored if your account has accessed the API prior to Nov 14, 2015. | ||
| */ | ||
| uxVersion?: number; | ||
| /** | ||
| * The email of the person issuing a signature request. | ||
| * Required for allowing 'Me + Others' requests | ||
| */ | ||
| requester?: string; | ||
| /** | ||
| * An associative array to be used to customize the app's signer page | ||
| */ | ||
| whiteLabelingOptions?: Object; | ||
| } | ||
| interface HelloSignStatic { | ||
| /** | ||
| * The available client UI cultures | ||
| */ | ||
| CULTURES: ClientCultures; | ||
| /** | ||
| * The signature request was signed | ||
| * | ||
| * @default signature_request_signed | ||
| */ | ||
| EVENT_SIGNED: string; | ||
| /** | ||
| * The user closed the iFrame before completing | ||
| * | ||
| * @default signature_request_canceled | ||
| */ | ||
| EVENT_CANCELED: string; | ||
| /** | ||
| * An error occurred in the iFrame | ||
| * | ||
| * @default error | ||
| */ | ||
| EVENT_ERROR: string; | ||
| /** | ||
| * Initialize using your HelloSign API client ID. | ||
| * | ||
| * @param appClientId The API client ID the request is for. | ||
| */ | ||
| init(appClientId: string): void; | ||
| /** | ||
| * Open the signing window. | ||
| * | ||
| * @param params The options to use when opening the signing window. | ||
| */ | ||
| open(params: OpenParameters): void; | ||
| /** | ||
| * Close the signing window. | ||
| */ | ||
| close(): void; | ||
| } | ||
| } | ||
| declare var HelloSign: HelloSign.HelloSignStatic; |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
6709
2.79%1
Infinity%