@verdocs/js-sdk 1.0.8 → 1.0.12

package/src/Organizations/index.ts

@@ -0,0 +1,16 @@
+/**
+ * An Organization is a high-level container within Verdocs that groups together Templates, Documents, Profiles, Billing, and
+ * other settings. A User may be a member of more than one Organization. Each membership is tracked by a Profile representing
+ * that user's settings within that organization. It is important to select the correct Profile before performing operations
+ * against the Verdocs API, as this also sets the Organization that will be operated on, and the user's permissions within it.
+ *
+ * @module
+ */
+
+export * as ApiKeys from './ApiKeys';
+export * as Groups from './Groups';
+export * as Invitations from './Invitations';
+export * as Members from './Members';
+export * as Organizations from './Organizations';
+export * as Types from './Types';
+export * as Webhooks from './Webhooks';

package/src/Search/Content.ts

@@ -0,0 +1,45 @@
+import {ISavedSearch, ISearchHistory, ISearchParams, ISearchResult} from './Types';
+import {getEndpoint} from '../HTTP/Transport';
+
+/**
+ * Retrieve recent and saved searches. Note that result counts will be limited to a maximum of 20 entries for each
+ * type but this may be expanded in the future. Client UI's should self-limit display counts as needed.
+ *
+ * ```typescript
+ * import {Content} from '@verdocs/js-sdk/Search';
+ *
+ * const {recent, saved} = await Content.getSearchHistory();
+ * ```
+ */
+export const getSearchHistory = async () =>
+  getEndpoint()
+    .get<ISearchHistory>('/search/history')
+    .then((r) => r.data);
+
+/**
+ * Save a search. If a name is re-used, that saved search will be overwritten with the new parameters.
+ *
+ * ```typescript
+ * import {Content} from '@verdocs/js-sdk/Search';
+ *
+ * const entry = await Documents.saveSearch('W9 Forms', {q: 'w9', type: 'template});
+ * ```
+ */
+export const saveSearch = async (name: string, params: ISearchParams) =>
+  getEndpoint()
+    .post<ISavedSearch>('/search/saved', {name, params})
+    .then((r) => r.data);
+
+/**
+ * Search for documents matching various criteria.
+ *
+ * ```typescript
+ * import {Content} from '@verdocs/js-sdk/Search';
+ *
+ * const {result, page, total} = await Documents.search({ ... });
+ * ```
+ */
+export const searchContent = async (params: ISearchParams) =>
+  getEndpoint()
+    .post<ISearchResult>('/search/content')
+    .then((r) => r.data);

package/src/Search/Types.ts

@@ -0,0 +1,83 @@
+import {IDocumentStatus, IRecipientStatus} from '../Documents/Documents';
+
+export interface IDocumentFile {
+  id: string;
+  url: string;
+  name: string;
+  created_at: string;
+  updated_at: string;
+  page_numbers: number;
+  mime: string;
+}
+
+export interface IDocumentResult {
+  id: string;
+  name: string;
+  status: IDocumentStatus;
+  profile_id: string;
+  template_id: string;
+  organization_id: string;
+  created_at: string;
+  updated_at: string;
+  canceled_at: string | null;
+  no_contact: boolean;
+  instrument: IDocumentFile;
+  certificate: IDocumentFile | null;
+}
+
+export interface ITemplateResult {
+  id: string;
+  name: string;
+  status: IDocumentStatus;
+  profile_id: string;
+  template_id: string;
+  organization_id: string;
+  created_at: string;
+  updated_at: string;
+  canceled_at: string | null;
+  no_contact: boolean;
+  instrument: IDocumentFile;
+  certificate: IDocumentFile | null;
+}
+
+export interface ISearchParams {
+  page?: number;
+  limit?: number;
+  q?: string;
+  tags?: string[];
+  type?: 'template' | 'document' | 'organization';
+  shared?: 'private' | 'shared' | 'public';
+  mine?: boolean;
+  status?: IDocumentStatus | IRecipientStatus;
+}
+
+export interface IRecentSearch {
+  id: string;
+  created_at: string;
+  updated_at: string;
+  profile_id: string;
+  organization_id: string;
+  params: ISearchParams;
+}
+
+export interface ISavedSearch {
+  id: string;
+  created_at: string;
+  updated_at: string;
+  profile_id: string;
+  organization_id: string;
+  name: string;
+  params: ISearchParams;
+}
+
+export interface ISearchHistory {
+  recent: IRecentSearch[];
+  saved: ISavedSearch[];
+}
+
+export interface ISearchResult {
+  matches: number;
+  templates: any[];
+  documents: IDocumentResult[];
+  organizations: any[];
+}

package/src/Search/index.ts

@@ -0,0 +1,2 @@
+export * as Content from './Content';
+export * as Types from './Types';

package/src/Signatures.ts

@@ -0,0 +1,29 @@
+import {getEndpoint} from './HTTP/Transport';
+
+export interface ISignature {
+  id?: string;
+  profile_id: string;
+  url: string;
+  created_at?: Date;
+  updated_at?: Date;
+}
+
+export const createSignature = (params: any) =>
+  getEndpoint()
+    .post<ISignature>('/signatures', params)
+    .then((r) => r.data);
+
+export const getSignatures = () =>
+  getEndpoint()
+    .get<ISignature[]>('/signatures')
+    .then((r) => r.data);
+
+export const getSignature = (signatureId: string) =>
+  getEndpoint()
+    .get(`/signatures/${signatureId}`)
+    .then((r) => r.data);
+
+export const deleteSignature = (signatureId: string) =>
+  getEndpoint()
+    .delete(`/signatures/${signatureId}`)
+    .then((r) => r.data);

package/src/Tags.ts

@@ -0,0 +1,22 @@
+import {getEndpoint} from './HTTP/Transport';
+
+export interface ITags {
+  name: string;
+  featured?: boolean;
+  created_at?: Date;
+}
+
+export const createTag = (params: ITags) =>
+  getEndpoint()
+    .post<ITags>('/tags', params)
+    .then((r) => r.data);
+
+export const getTag = (tagName: string) =>
+  getEndpoint()
+    .get<ITags>(`/tags/${tagName}`)
+    .then((r) => r.data);
+
+export const searchTag = (params: any) =>
+  getEndpoint()
+    .get<ITags[]>('/tags', params)
+    .then((r) => r.data);

package/src/Templates/Documents.ts

@@ -0,0 +1,58 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {IDocument} from './Types';
+
+/**
+ * Get all the Documents associated to a particular Template.
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Templates';
+ *
+ * await Documents.getDocuments(templateID);
+ * ```
+ */
+export const getDocuments = (templateId: string) =>
+  getEndpoint()
+    .get(`/templates/${templateId}/documents/`)
+    .then((r) => r.data);
+
+/**
+ * Create a Document for a particular Template.
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Templates';
+ *
+ * await Documents.createDocument(templateID, params);
+ * ```
+ */
+export const createDocument = (templateId: string, params: any) =>
+  getEndpoint()
+    .post<IDocument>(`/templates/${templateId}/documents/`, params)
+    .then((r) => r.data);
+
+/**
+ * Get a specific Document.
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Templates';
+ *
+ * await Documents.getDocument(templateID, documentID);
+ * ```
+ */
+export const getDocument = (templateId: string, documentId: string) =>
+  getEndpoint()
+    .get<IDocument>(`/templates/${templateId}/documents/${documentId}`)
+    .then((r) => r.data);
+
+/**
+ * Delete a specific Document.
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Templates';
+ *
+ * await Documents.deleteDocument(templateID, documentID);
+ * ```
+ */
+export const deleteDocument = (templateId: string, documentId: string) =>
+  getEndpoint()
+    .delete(`/templates/${templateId}/documents/${documentId}`)
+    .then((r) => r.data);

package/src/Templates/Fields.ts

@@ -0,0 +1,17 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {IField} from './Types';
+
+export const createField = (templateId: string, params: IField) =>
+  getEndpoint()
+    .post<IField>(`/templates/${templateId}/pages/`, params)
+    .then((r) => r.data);
+
+export const editField = (templateId: string, fieldName: string, params: IField) =>
+  getEndpoint()
+    .put<IField>(`/templates/${templateId}/pages/${fieldName}`, params)
+    .then((r) => r.data);
+
+export const deleteField = (templateId: string, fieldName: string) =>
+  getEndpoint()
+    .delete(`/templates/${templateId}/pages/${fieldName}`)
+    .then((r) => r.data);

package/src/Templates/Pages.ts

@@ -0,0 +1,22 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {IPage} from './Types';
+
+export const createPage = (templateId: string, params: IPage) =>
+  getEndpoint()
+    .post<IPage>(`/templates/${templateId}/pages/`, params)
+    .then((r) => r.data);
+
+export const editPage = (templateId: string, sequence: string) =>
+  getEndpoint()
+    .put(`/templates/${templateId}/pages/${sequence}`)
+    .then((r) => r.data);
+
+export const getPage = (templateId: string, sequence: string) =>
+  getEndpoint()
+    .get(`/templates/${templateId}/pages/${sequence}`)
+    .then((r) => r.data);
+
+export const deletePage = (templateId: string, sequence: string) =>
+  getEndpoint()
+    .delete(`/templates/${templateId}/pages/${sequence}`)
+    .then((r) => r.data);

package/src/Templates/Reminders.ts

@@ -0,0 +1,22 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {IReminder, ITemplate} from './Types';
+
+export const createReminder = (templateId: string, params: any) =>
+  getEndpoint()
+    .post<ITemplate>(`/templates/${templateId}/reminder/`, params)
+    .then((r) => r.data);
+
+export const getReminder = (templateId: string, reminderId: string) =>
+  getEndpoint()
+    .get<IReminder>(`/templates/${templateId}/reminder/${reminderId}`)
+    .then((r) => r.data);
+
+export const editReminder = (templateId: string, reminderId: string) =>
+  getEndpoint()
+    .put<IReminder>(`/templates/${templateId}/reminder/${reminderId}`)
+    .then((r) => r.data);
+
+export const deleteReminder = (templateId: string, reminderId: string) =>
+  getEndpoint()
+    .delete(`/templates/${templateId}/reminder/${reminderId}`)
+    .then((r) => r.data);

package/src/Templates/Roles.ts

@@ -0,0 +1,37 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {IField, IRole} from './Types';
+
+export const createRole = (templateId: string, params: IRole) =>
+  getEndpoint()
+    .post<IRole>(`/templates/${templateId}/roles/`, params)
+    .then((r) => r.data);
+
+export const getRoles = (templateId: string) =>
+  getEndpoint()
+    .get<IRole[]>(`/templates/${templateId}/roles/`)
+    .then((r) => r.data);
+
+export const getRole = (templateId: string, roleName: string) =>
+  getEndpoint()
+    .get<IRole>(`/templates/${templateId}/roles/${roleName}`)
+    .then((r) => r.data);
+
+export const editRole = (templateId: string, roleName: string, params: IRole) =>
+  getEndpoint()
+    .put<IRole>(`/templates/${templateId}/roles/${roleName}`, params)
+    .then((r) => r.data);
+
+export const deleteRole = (templateId: string, roleName: string) =>
+  getEndpoint()
+    .delete(`/templates/${templateId}/roles/${roleName}`)
+    .then((r) => r.data);
+
+export const getRoleFields = (templateId: string, roleName: string) =>
+  getEndpoint()
+    .get<IField[]>(`/templates/${templateId}/roles/${roleName}/fields`)
+    .then((r) => r.data);
+
+export const deleteSequence = (templateId: string) =>
+  getEndpoint()
+    .delete<IRole[]>(`/templates/${templateId}/roles/`)
+    .then((r) => r.data);

package/src/Templates/Stars.ts

@@ -0,0 +1,12 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {IStar, ITemplatesSummary} from './Types';
+
+export const getStars = (templateId: string) =>
+  getEndpoint()
+    .get<IStar[]>(`/templates/${templateId}/stars/`)
+    .then((r) => r.data);
+
+export const toggleStar = (templateId: string) =>
+  getEndpoint()
+    .get<ITemplatesSummary>(`/templates/${templateId}/stars/toggle`)
+    .then((r) => r.data);

package/src/Templates/Tags.ts

@@ -0,0 +1,17 @@
+import {getEndpoint} from '../HTTP/Transport';
+import {ITag} from './Types';
+
+export const createTag = (templateId: string, params: any) =>
+  getEndpoint()
+    .post<ITag>(`/templates/${templateId}/tags/`, params)
+    .then((r) => r.data);
+
+export const getTags = (templateId: string) =>
+  getEndpoint()
+    .get<ITag[]>(`/templates/${templateId}/tags/`)
+    .then((r) => r.data);
+
+export const deleteTag = (templateId: string, tagName: string) =>
+  getEndpoint()
+    .post(`/templates/${templateId}/tags/${tagName}`)
+    .then((r) => r.data);

package/src/Templates/Templates.ts

@@ -0,0 +1,42 @@
+import {getEndpoint} from '../HTTP/Transport';
+
+import {ITemplate, ITemplatesSearchResult, ITemplatesSummary} from './Types';
+
+export const getTemplates = () =>
+  getEndpoint()
+    .get<any[]>('/templates/')
+    .then((r) => r.data);
+
+export const getTemplate = (templateId: string) =>
+  getEndpoint()
+    .get(`/templates/${templateId}`)
+    .then((r) => r.data);
+
+export const createTemplate = (params: any) =>
+  getEndpoint()
+    .post<ITemplate>('/templates/', params)
+    .then((r) => r.data);
+
+export const editTemplate = (templateId: string, params: any) =>
+  getEndpoint()
+    .put<ITemplate>(`/templates/${templateId}`, params)
+    .then((r) => r.data);
+
+/**
+ * Search for templates matching various criteria.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const {result, page, total} = await Templates.search({ ... });
+ * ```
+ */
+export const searchTemplate = async (params: any): Promise<ITemplatesSearchResult> =>
+  getEndpoint()
+    .post('/templates/search', params)
+    .then((r) => r.data);
+
+export const getSummary = async (page: number): Promise<ITemplatesSummary> =>
+  getEndpoint()
+    .post('/templates/summary', {page})
+    .then((r) => r.data);

package/src/Templates/Types.ts

@@ -0,0 +1,201 @@
+export interface ITemplate {
+  template_document?: IDocument;
+  pages?: IPage[];
+  roles?: IRole[];
+  counter?: number;
+  star_counter?: number;
+  name: string;
+  id?: string;
+  profile_id?: string;
+  created_at?: Date;
+  updated_at?: Date;
+  last_used_at?: Date;
+  token?: string;
+  reminder_id?: string;
+  reminder?: IReminder;
+  organization_id?: string;
+  is_personal?: boolean;
+  is_public?: boolean;
+  sender?: TemplateSenderTypes;
+  description?: string;
+}
+
+export interface ITemplateSummaryEntry {
+  id: string;
+  name: string;
+  sender: string;
+  counter: number;
+  description: string | null;
+  created_at: string;
+  updated_at: string;
+  is_personal: boolean;
+  is_public: boolean;
+  profile_id: string;
+  organization_id: string;
+  last_used_at: string | null;
+  document_name: string | null;
+  star_counter: number;
+  tag_name: string | null;
+  is_starred: boolean;
+}
+export enum Template {
+  ID = 'id',
+  PROFILE_ID = 'profile_id',
+  NAME = 'name',
+  COUNTER = 'counter',
+  CREATED_AT = 'created_at',
+  UPDATED_AT = 'updated_at',
+  TOKEN = 'token',
+  REMINDER_ID = 'reminder_id',
+  ORGANIZATION_ID = 'organization_id',
+  IS_PERSONAL = 'is_personal',
+  IS_PUBLIC = 'is_public',
+  SENDER = 'sender',
+  DESCRIPTION = 'description',
+}
+
+export enum TemplateSenderTypes {
+  CREATOR = 'creator',
+  ORGANIZATION_MEMBER = 'organization_member',
+  ORGANIZATION_MEMBER_AS_CREATOR = 'organization_member_as_creator',
+  EVERYONE = 'everyone',
+  EVERYONE_AS_CREATOR = 'everyone_as_creator',
+}
+
+export enum TemplatePermissions {
+  TEMPLATE_CREATOR_CREATE_PUBLIC = 'template:creator:create:public',
+  TEMPLATE_CREATOR_CREATE_ORG = 'template:creator:create:org',
+  TEMPLATE_CREATOR_CREATE_PERSONAL = 'template:creator:create:personal',
+  TEMPLATE_CREATOR_DELETE = 'template:creator:delete',
+  TEMPLATE_CREATOR_VISIBILITY = 'template:creator:visibility',
+  TEMPLATE_MEMBER_READ = 'template:member:read',
+  TEMPLATE_MEMBER_WRITE = 'template:member:write',
+  TEMPLATE_MEMBER_DELETE = 'template:member:delete',
+  TEMPLATE_MEMBER_VISIBILITY = 'template:member:visibility',
+}
+
+export interface ITemplateSearchParams {
+  id?: string;
+  name?: string;
+  sender?: string;
+  description?: string;
+  profile_id?: string;
+  organization_id?: string;
+  updated_at?: ITimePeriod;
+  created_at?: ITimePeriod;
+  last_used_at?: ITimePeriod;
+  is_personal?: boolean;
+  is_public?: boolean;
+  tags?: string[];
+  document_name?: string;
+  sort_by?: SortOptions;
+  ascending?: boolean;
+  row?: number;
+  page?: number;
+}
+
+export interface ITimePeriod {
+  start_time: string; // Date
+  end_time: string; // Date
+}
+
+export enum SortOptions {
+  CREATED_AT = 'created_at',
+  UPDATED_AT = 'updated_at',
+  NAME = 'name',
+  LAST_USED_AT = 'last_used_at',
+  COUNTER = 'counter',
+  STAR_COUNTER = 'star_counter',
+}
+
+export interface ITemplatesSummary {
+  page: number;
+  total: number;
+  result: ITemplateSummaryEntry[];
+}
+
+export interface ITemplatesSearchResult {
+  page: number;
+  total: number;
+  result: ITemplate[];
+}
+
+export interface ITag {
+  tag_name: string;
+  template_id: string;
+}
+
+export interface IStar {
+  template_id: string;
+  profile_id: string;
+}
+
+export interface IRole {
+  template_id: string;
+  name: string;
+  full_name?: string;
+  email?: string;
+  type: string;
+  sequence: number;
+  fields?: IField[];
+  delegator?: boolean;
+  message?: string;
+  phone?: string;
+}
+
+export interface IDocument {
+  url: string;
+  name: string;
+  page_numbers: number;
+  id?: string;
+  updated_at?: Date;
+  created_at?: Date;
+  template_id: string;
+  mime: string;
+  thumbnail_url: string;
+}
+
+export interface IField {
+  name: string;
+  role_name: string;
+  template_id: string;
+  type: string;
+  required: boolean;
+  setting?: ISetting;
+  page_sequence: number;
+  validator?: string;
+  label?: string;
+}
+
+export interface ISetting {
+  x?: number;
+  y?: number;
+  width?: number;
+  height?: number;
+  result?: string;
+  type?: string;
+  options?: any[];
+  value?: string;
+}
+
+export interface IPage {
+  template_id: string;
+  document_id: string;
+  template_document?: IDocument;
+  sequence: number;
+  page_number: number;
+  thumbnail_url: string;
+  fields?: IField[];
+}
+
+export interface IReminder {
+  id?: string;
+  created_at?: Date;
+  is_on: boolean;
+  setup_time: number;
+  interval_time: number;
+  last_time: number;
+  next_time: number;
+  envelope_id: string;
+  template_id: string;
+}

package/src/Templates/index.ts

@@ -0,0 +1,9 @@
+export * as Documents from './Documents';
+export * as Fields from './Fields';
+export * as Pages from './Pages';
+export * as Reminders from './Reminders';
+export * as Roles from './Roles';
+export * as Stars from './Stars';
+export * as Tags from './Tags';
+export * as Templates from './Templates';
+export * as Types from './Types';