Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

@types/hellosign-sdk

Package Overview
Dependencies
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/hellosign-sdk - npm Package Compare versions

Comparing version

1.6.12
to
1.6.13

300

hellosign-sdk/index.d.ts

@@ -8,3 +8,3 @@ // Type definitions for hellosign-sdk 1.6

/// <reference types="node" />
import { IncomingMessage } from 'http';
import { IncomingMessage } from "http";

@@ -53,18 +53,18 @@ declare class HelloSign {

| {
key: string;
}
key: string;
}
| {
username: string;
password: string;
}
username: string;
password: string;
}
| {
key: string;
client_id: string;
client_secret: string;
};
key: string;
client_id: string;
client_secret: string;
};
interface BaseResponse {
resHeaders: IncomingMessage['headers'];
statusCode?: IncomingMessage['statusCode'];
statusMessage?: IncomingMessage['statusMessage'];
resHeaders: IncomingMessage["headers"];
statusCode?: IncomingMessage["statusCode"];
statusMessage?: IncomingMessage["statusMessage"];
}

@@ -114,3 +114,3 @@

order: number;
status_code: string | 'awaiting_signature' | 'signed' | 'declined';
status_code: string | "awaiting_signature" | "signed" | "declined";
decline_reason: string;

@@ -127,11 +127,11 @@ signed_at: number | null;

| string
| 'text'
| 'checkbox'
| 'date_signed'
| 'dropdown'
| 'initials'
| 'radio'
| 'signature'
| 'text-merge'
| 'checkbox-merge';
| "text"
| "checkbox"
| "date_signed"
| "dropdown"
| "initials"
| "radio"
| "signature"
| "text-merge"
| "checkbox-merge";
interface SignatureRequest<Metadata = GenericObject> {

@@ -161,17 +161,19 @@ test_mode: number;

custom_fields?:
| Array<{
name: string;
type: 'text';
value: string;
required: boolean;
api_id: string;
editor: string;
} | {
name: string;
type: 'checkbox';
value: boolean;
required: boolean;
api_id: string;
editor: string;
}>
| Array<
{
name: string;
type: "text";
value: string;
required: boolean;
api_id: string;
editor: string;
} | {
name: string;
type: "checkbox";
value: boolean;
required: boolean;
api_id: string;
editor: string;
}
>
| undefined;

@@ -200,12 +202,12 @@ response_data: Array<{

validation_type?:
| 'numbers_only'
| 'letters_only'
| 'phone_number'
| 'bank_routing_number'
| 'bank_account_number'
| 'email_address'
| 'zip_code'
| 'social_security_number'
| 'employer_identification_number'
| 'custom_regex'
| "numbers_only"
| "letters_only"
| "phone_number"
| "bank_routing_number"
| "bank_account_number"
| "email_address"
| "zip_code"
| "social_security_number"
| "employer_identification_number"
| "custom_regex"
| undefined;

@@ -233,15 +235,15 @@ }

| Array<{
name?: string | undefined;
instructions?: string | undefined;
signer_index?: string | undefined;
required?: boolean | undefined;
}>
name?: string | undefined;
instructions?: string | undefined;
signer_index?: string | undefined;
required?: boolean | undefined;
}>
| undefined;
custom_fields?:
| Array<{
name: string;
value: string | boolean;
editor?: string | undefined;
required?: boolean | undefined;
}>
name: string;
value: string | boolean;
editor?: string | undefined;
required?: boolean | undefined;
}>
| undefined;

@@ -258,19 +260,19 @@ cc_email_addresses?: string[] | undefined;

| {
draw?: boolean | undefined;
type?: boolean | undefined;
upload?: boolean | undefined;
phone?: boolean | undefined;
default: string;
}
draw?: boolean | undefined;
type?: boolean | undefined;
upload?: boolean | undefined;
phone?: boolean | undefined;
default: string;
}
| undefined;
field_options?:
| {
date_format:
| 'MM / DD / YYYY'
| 'MM - DD - YYYY'
| 'DD / MM / YYYY'
| 'DD - MM - YYYY'
| 'YYYY / MM / DD'
| 'YYYY - MM - DD';
}
date_format:
| "MM / DD / YYYY"
| "MM - DD - YYYY"
| "DD / MM / YYYY"
| "DD - MM - YYYY"
| "YYYY / MM / DD"
| "YYYY - MM - DD";
}
| undefined;

@@ -289,3 +291,3 @@ signing_redirect_url?: string | undefined;

}
type FilesOptions = { file_type: 'pdf'; get_url?: boolean; get_data_uri?: boolean } | { file_type: 'zip' };
type FilesOptions = { file_type: "pdf"; get_url?: boolean; get_data_uri?: boolean } | { file_type: "zip" };
interface SignatureRequestModule {

@@ -305,6 +307,5 @@ get(signatureRequestId: string): Promise<SignatureRequestResponse>;

): Promise<
Options extends { file_type: 'pdf'; get_url: true }
? { file_url: string; expires_at: Date } & BaseResponse
: Options extends { file_type: 'pdf'; get_data_uri: true }
? { data_uri: string; expires_at: Date } & BaseResponse
Options extends { file_type: "pdf"; get_url: true } ? { file_url: string; expires_at: Date } & BaseResponse
: Options extends { file_type: "pdf"; get_data_uri: true }
? { data_uri: string; expires_at: Date } & BaseResponse
: IncomingMessage

@@ -315,6 +316,6 @@ >;

createEmbedded(
options: Omit<SignatureRequestRequestOptions, 'signing_redirect_url'>,
options: Omit<SignatureRequestRequestOptions, "signing_redirect_url">,
): Promise<SignatureRequestResponse>;
createEmbeddedWithTemplate(
options: Omit<SignatureRequestRequestOptions, 'signing_redirect_url'>,
options: Omit<SignatureRequestRequestOptions, "signing_redirect_url">,
): Promise<SignatureRequestResponse>;

@@ -348,5 +349,5 @@ releaseHold(requestId: string): Promise<BaseResponse>;

| {
allow_edit_signers?: boolean | undefined;
allow_edit_documents?: boolean | undefined;
}
allow_edit_signers?: boolean | undefined;
allow_edit_documents?: boolean | undefined;
}
| undefined;

@@ -366,3 +367,3 @@ }

}
interface Report extends Omit<ReportsRequestOptions, 'test_mode'> {
interface Report extends Omit<ReportsRequestOptions, "test_mode"> {
success?: string | undefined;

@@ -416,4 +417,4 @@ }

get(): Promise<TeamResponse>;
create(options: Pick<Team, 'name'>): Promise<TeamResponse>;
update(options: Pick<Team, 'name'>): Promise<TeamResponse>;
create(options: Pick<Team, "name">): Promise<TeamResponse>;
update(options: Pick<Team, "name">): Promise<TeamResponse>;
destroy(): Promise<BaseResponse>;

@@ -451,4 +452,4 @@ addMember(options: AccountIdOrEmailRequestOptions): Promise<TeamResponse>;

interface Template<Metadata = GenericObject>
extends Partial<{
interface Template<Metadata = GenericObject> extends
Partial<{
template_id: string;

@@ -491,3 +492,4 @@ title: string;

is_locked: boolean;
}> {}
}>
{}
interface TemplateResponse extends BaseResponse {

@@ -514,6 +516,5 @@ template: Template;

) => Promise<
Options extends { file_type: 'pdf'; get_url: true }
? { file_url: string; expires_at: Date } & BaseResponse
: Options extends { file_type: 'pdf'; get_data_uri: true }
? { data_uri: string; expires_at: Date } & BaseResponse
Options extends { file_type: "pdf"; get_url: true } ? { file_url: string; expires_at: Date } & BaseResponse
: Options extends { file_type: "pdf"; get_data_uri: true }
? { data_uri: string; expires_at: Date } & BaseResponse
: IncomingMessage

@@ -543,22 +544,22 @@ >;

| Array<{
email_address?: string | undefined;
name?: string | undefined;
order?: number | undefined;
}>
email_address?: string | undefined;
name?: string | undefined;
order?: number | undefined;
}>
| undefined;
attachments?:
| Array<{
name?: string | undefined;
instructions?: string | undefined;
signer_index?: string | undefined;
required?: boolean | undefined;
}>
name?: string | undefined;
instructions?: string | undefined;
signer_index?: string | undefined;
required?: boolean | undefined;
}>
| undefined;
custom_fields?:
| Array<{
name: string;
value: string | boolean;
editor?: string | undefined;
required?: boolean | undefined;
}>
name: string;
value: string | boolean;
editor?: string | undefined;
required?: boolean | undefined;
}>
| undefined;

@@ -576,19 +577,19 @@ cc_email_addresses?: string[] | undefined;

| {
draw?: boolean | undefined;
type?: boolean | undefined;
upload?: boolean | undefined;
phone?: boolean | undefined;
default: string;
}
draw?: boolean | undefined;
type?: boolean | undefined;
upload?: boolean | undefined;
phone?: boolean | undefined;
default: string;
}
| undefined;
field_options?:
| {
date_format:
| 'MM / DD / YYYY'
| 'MM - DD - YYYY'
| 'DD / MM / YYYY'
| 'DD - MM - YYYY'
| 'YYYY / MM / DD'
| 'YYYY - MM - DD';
}
date_format:
| "MM / DD / YYYY"
| "MM - DD - YYYY"
| "DD / MM / YYYY"
| "DD - MM - YYYY"
| "YYYY / MM / DD"
| "YYYY - MM - DD";
}
| undefined;

@@ -608,21 +609,21 @@ is_for_embedded_signing?: number | undefined;

type HellosignEvents =
| 'signature_request_viewed'
| 'signature_request_signed'
| 'signature_request_downloadable'
| 'signature_request_sent'
| 'signature_request_declined'
| 'signature_request_reassigned'
| 'signature_request_remind'
| 'signature_request_all_signed'
| 'signature_request_email_bounce'
| 'signature_request_invalid'
| 'signature_request_canceled'
| 'signature_request_prepared'
| 'file_error'
| 'unknown_error'
| 'sign_url_invalid'
| 'account_confirmed'
| 'template_created'
| 'template_error'
| 'callback_test';
| "signature_request_viewed"
| "signature_request_signed"
| "signature_request_downloadable"
| "signature_request_sent"
| "signature_request_declined"
| "signature_request_reassigned"
| "signature_request_remind"
| "signature_request_all_signed"
| "signature_request_email_bounce"
| "signature_request_invalid"
| "signature_request_canceled"
| "signature_request_prepared"
| "file_error"
| "unknown_error"
| "sign_url_invalid"
| "account_confirmed"
| "template_created"
| "template_error"
| "callback_test";

@@ -651,7 +652,8 @@ interface Event<Metadata = GenericObject> {

}
type EventResponse<Response = SignatureRequestResponse> = Partial<AccountResponse> &
Partial<SignatureRequestResponse> &
Partial<TemplateResponse> &
Event &
Response;
type EventResponse<Response = SignatureRequestResponse> =
& Partial<AccountResponse>
& Partial<SignatureRequestResponse>
& Partial<TemplateResponse>
& Event
& Response;

@@ -693,5 +695,5 @@ interface ApiApp {

| {
callback_url: string;
scopes: string;
}
callback_url: string;
scopes: string;
}
| undefined;

@@ -701,4 +703,4 @@ white_labeling_options?: any[] | undefined;

| {
can_insert_everywhere?: boolean | undefined;
}
can_insert_everywhere?: boolean | undefined;
}
| undefined;

@@ -705,0 +707,0 @@ }

6

hellosign-sdk/package.json
{
"name": "@types/hellosign-sdk",
"version": "1.6.12",
"version": "1.6.13",
"description": "TypeScript definitions for hellosign-sdk",

@@ -25,4 +25,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hellosign-sdk",

},
"typesPublisherContentHash": "2b029e64ed4d062d6205fc442cc2de3c7711cb64953e34d5eb125d9c1ef2c57c",
"typeScriptVersion": "4.3"
"typesPublisherContentHash": "437511c0e8f4b95dd5b5c73350e5be84ca162da45f895c634032d85cd9105330",
"typeScriptVersion": "4.5"
}

2

hellosign-sdk/README.md

@@ -11,3 +11,3 @@ # Installation

### Additional Details
* Last updated: Mon, 20 Mar 2023 23:02:31 GMT
* Last updated: Sat, 16 Sep 2023 08:06:32 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node)

@@ -14,0 +14,0 @@ * Global values: none

SocketSocket SOC 2 Logo

Product

About

Packages

Explore npm
Explore Cargo
Explore Go
Explore Maven
Explore NuGet
Explore PyPI
Explore Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.