@verdocs/js-sdk 3.6.12 → 3.7.0

package/Organizations/Organizations.d.ts

@@ -5,9 +5,28 @@
  */
 import { IOrganization } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
+/**
+ * Get a list of organizations the user has access to.
+ */
 export declare const getOrganizations: (endpoint: VerdocsEndpoint) => Promise<IOrganization[]>;
+/**
+ * Create an organization.
+ */
 export declare const createOrganization: (endpoint: VerdocsEndpoint) => Promise<IOrganization>;
-export declare const validateOrganization: (endpoint: VerdocsEndpoint) => Promise<IOrganization>;
+/**
+ * Delete an organization.
+ */
 export declare const deleteOrganization: (endpoint: VerdocsEndpoint, organizationId: string) => Promise<any>;
+/**
+ * Get an organization by ID.
+ */
 export declare const getOrganization: (endpoint: VerdocsEndpoint, organizationId: string) => Promise<any>;
+/**
+ * Update an organization.
+ */
 export declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: string, params: any) => Promise<any>;
+/**
+ * Check if an organization name is available. Typically used during the sign-up process. This endpoint is rate-limited
+ * to prevent abuse. Developers experiencing problems with testing new applications should contact support.
+ */
+export declare const isOrgAvailable: (endpoint: VerdocsEndpoint) => Promise<"OK" | "TAKEN">;

package/Organizations/Organizations.js

@@ -3,33 +3,52 @@
  *
  * @module
  */
+/**
+ * Get a list of organizations the user has access to.
+ */
 export var getOrganizations = function (endpoint) {
     return endpoint.api //
         .get('/organizations')
         .then(function (r) { return r.data; });
 };
+/**
+ * Create an organization.
+ */
 export var createOrganization = function (endpoint) {
     return endpoint.api //
         .post('/organizations')
         .then(function (r) { return r.data; });
 };
-export var validateOrganization = function (endpoint) {
-    return endpoint.api //
-        .get('/organizations/is_valid')
-        .then(function (r) { return r.data; });
-};
+/**
+ * Delete an organization.
+ */
 export var deleteOrganization = function (endpoint, organizationId) {
     return endpoint.api //
         .delete("/organizations/".concat(organizationId))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get an organization by ID.
+ */
 export var getOrganization = function (endpoint, organizationId) {
     return endpoint.api //
         .get("/organizations/".concat(organizationId))
         .then(function (r) { return r.data; });
 };
+/**
+ * Update an organization.
+ */
 export var updateOrganization = function (endpoint, organizationId, params) {
     return endpoint.api //
         .patch("/organizations/".concat(organizationId), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Check if an organization name is available. Typically used during the sign-up process. This endpoint is rate-limited
+ * to prevent abuse. Developers experiencing problems with testing new applications should contact support.
+ */
+export var isOrgAvailable = function (endpoint) {
+    return endpoint.api //
+        .get('/organizations/check-availability', { baseURL: endpoint.getBaseURLv2() })
+        .then(function (r) { return r.data; });
+};

package/VerdocsEndpoint.d.ts

@@ -4,6 +4,7 @@ export type TEnvironment = 'verdocs' | 'verdocs-stage';
 export type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
 export interface VerdocsEndpointOptions {
     baseURL?: string;
+    baseURLv2?: string;
     timeout?: number;
     environment?: TEnvironment;
     sessionType?: TSessionType;
@@ -33,7 +34,8 @@ export interface VerdocsEndpointOptions {
 export declare class VerdocsEndpoint {
     private environment;
     private sessionType;
-    private readonly baseURL;
+    private baseURL;
+    private baseURLv2;
     private clientID;
     private timeout;
     private token;
@@ -70,6 +72,11 @@ export declare class VerdocsEndpoint {
      * Get the current base URL. This should rarely be anything other than 'https://api.verdocs.com'.
      */
     getBaseURL(): string;
+    /**
+     * Get the current base URL for the v2 APIs.
+     * This should rarely be anything other than 'https://api-v2.verdocs.com'.
+     */
+    getBaseURLv2(): string;
     /**
      * Get the current client ID, if set.
      */
@@ -121,6 +128,17 @@ export declare class VerdocsEndpoint {
      * ```
      */
     setBaseURL(url: string): VerdocsEndpoint;
+    /**
+     * Set the base URL for API calls. Should be called only upon direction from Verdocs Customer Solutions Engineering.
+     *
+     * ```typescript
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new VerdocsEndpoint();
+     * endpoint.setBaseURL('https://api.verdocs.com');
+     * ```
+     */
+    setBaseURLv2(url: string): VerdocsEndpoint;
     /**
      * Set the Client ID for Verdocs API calls.
      *

package/VerdocsEndpoint.js

@@ -44,6 +44,7 @@ var VerdocsEndpoint = /** @class */ (function () {
         this.environment = 'verdocs';
         this.sessionType = 'user';
         this.baseURL = 'https://api.verdocs.com';
+        this.baseURLv2 = 'https://api-v2.verdocs.com';
         this.clientID = 'not-set';
         this.timeout = 60000;
         this.token = null;
@@ -57,6 +58,7 @@ var VerdocsEndpoint = /** @class */ (function () {
          */
         this.session = null;
         this.baseURL = (options === null || options === void 0 ? void 0 : options.baseURL) || 'https://api.verdocs.com';
+        this.baseURLv2 = (options === null || options === void 0 ? void 0 : options.baseURLv2) || 'https://api-v2.verdocs.com';
         this.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || 60000;
         this.environment = (options === null || options === void 0 ? void 0 : options.environment) || 'verdocs';
         this.sessionType = (options === null || options === void 0 ? void 0 : options.sessionType) || 'user';
@@ -99,6 +101,13 @@ var VerdocsEndpoint = /** @class */ (function () {
     VerdocsEndpoint.prototype.getBaseURL = function () {
         return this.baseURL;
     };
+    /**
+     * Get the current base URL for the v2 APIs.
+     * This should rarely be anything other than 'https://api-v2.verdocs.com'.
+     */
+    VerdocsEndpoint.prototype.getBaseURLv2 = function () {
+        return this.baseURLv2;
+    };
     /**
      * Get the current client ID, if set.
      */
@@ -162,9 +171,25 @@ var VerdocsEndpoint = /** @class */ (function () {
      * ```
      */
     VerdocsEndpoint.prototype.setBaseURL = function (url) {
+        this.baseURL = url;
         this.api.defaults.baseURL = url;
         return this;
     };
+    /**
+     * Set the base URL for API calls. Should be called only upon direction from Verdocs Customer Solutions Engineering.
+     *
+     * ```typescript
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new VerdocsEndpoint();
+     * endpoint.setBaseURL('https://api.verdocs.com');
+     * ```
+     */
+    VerdocsEndpoint.prototype.setBaseURLv2 = function (url) {
+        this.baseURLv2 = url;
+        // NOTE: We do not set this on the Axios instance because v1 is still the standard.
+        return this;
+    };
     /**
      * Set the Client ID for Verdocs API calls.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.6.12",
+  "version": "3.7.0",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",