@verdocs/js-sdk 6.0.0 → 6.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -150,11 +150,12 @@ interface ISigningSession {
150
150
  aud: string;
151
151
  iss: string;
152
152
  sub: string; // Verdocs access key ID
153
- email: string;
154
153
  iat: number;
155
154
  exp: number;
156
155
  session_type: "signing";
157
156
  key_type: TAccessKeyType;
157
+ email: string;
158
+ profile_id: string;
158
159
  envelope_id: string;
159
160
  role_name: string;
160
161
  // @deprecated
@@ -174,10 +175,10 @@ interface IUserSession {
174
175
  aud: string;
175
176
  iss: string;
176
177
  sub: string; // Verdocs user_id
177
- email: string;
178
178
  iat: number;
179
179
  exp: number;
180
180
  session_type: "user";
181
+ email: string;
181
182
  profile_id: string;
182
183
  organization_id: string;
183
184
  global_admin: boolean;
@@ -1865,8 +1866,12 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
1865
1866
  * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
1866
1867
  * to be "stamped" by the user.
1867
1868
  *
1869
+ * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
1870
+ * typically only ever have one, tied to that session. But authenticated users can create more than
1871
+ * one, and can use them interchangeably.
1872
+ *
1868
1873
  * @group Signatures and Initials
1869
- * @api POST /initials Create Initial Block
1874
+ * @api POST /v2/profiles/initials Create Initial Block
1870
1875
  * @apiBody string initial Blob containing initials image to store.
1871
1876
  * @apiSuccess IInitial . The newly-created initial block.
1872
1877
  */
@@ -2183,9 +2188,12 @@ declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
2183
2188
  * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
2184
2189
  * to be "stamped" by the user.
2185
2190
  *
2186
- * @group Signatures and Initials
2187
- * @api POST /signatures Create Signature Block
2191
+ * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
2192
+ * typically only ever have one, tied to that session. But authenticated users can create more than
2193
+ * one, and can use them interchangeably.
2188
2194
  *
2195
+ * @group Signatures and Initials
2196
+ * @api POST /v2/profiles/signatures Create Signature Block
2189
2197
  * @apiBody string signature Blob containing signature image to store.
2190
2198
  * @apiSuccess ISignature . The newly-created signature block.
2191
2199
  */
package/dist/index.d.ts CHANGED
@@ -150,11 +150,12 @@ interface ISigningSession {
150
150
  aud: string;
151
151
  iss: string;
152
152
  sub: string; // Verdocs access key ID
153
- email: string;
154
153
  iat: number;
155
154
  exp: number;
156
155
  session_type: "signing";
157
156
  key_type: TAccessKeyType;
157
+ email: string;
158
+ profile_id: string;
158
159
  envelope_id: string;
159
160
  role_name: string;
160
161
  // @deprecated
@@ -174,10 +175,10 @@ interface IUserSession {
174
175
  aud: string;
175
176
  iss: string;
176
177
  sub: string; // Verdocs user_id
177
- email: string;
178
178
  iat: number;
179
179
  exp: number;
180
180
  session_type: "user";
181
+ email: string;
181
182
  profile_id: string;
182
183
  organization_id: string;
183
184
  global_admin: boolean;
@@ -1865,8 +1866,12 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
1865
1866
  * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
1866
1867
  * to be "stamped" by the user.
1867
1868
  *
1869
+ * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
1870
+ * typically only ever have one, tied to that session. But authenticated users can create more than
1871
+ * one, and can use them interchangeably.
1872
+ *
1868
1873
  * @group Signatures and Initials
1869
- * @api POST /initials Create Initial Block
1874
+ * @api POST /v2/profiles/initials Create Initial Block
1870
1875
  * @apiBody string initial Blob containing initials image to store.
1871
1876
  * @apiSuccess IInitial . The newly-created initial block.
1872
1877
  */
@@ -2183,9 +2188,12 @@ declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
2183
2188
  * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
2184
2189
  * to be "stamped" by the user.
2185
2190
  *
2186
- * @group Signatures and Initials
2187
- * @api POST /signatures Create Signature Block
2191
+ * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
2192
+ * typically only ever have one, tied to that session. But authenticated users can create more than
2193
+ * one, and can use them interchangeably.
2188
2194
  *
2195
+ * @group Signatures and Initials
2196
+ * @api POST /v2/profiles/signatures Create Signature Block
2189
2197
  * @apiBody string signature Blob containing signature image to store.
2190
2198
  * @apiSuccess ISignature . The newly-created signature block.
2191
2199
  */
package/dist/index.js CHANGED
@@ -1809,8 +1809,12 @@ const getEnvelopes = (endpoint, params) => endpoint.api //
1809
1809
  * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
1810
1810
  * to be "stamped" by the user.
1811
1811
  *
1812
+ * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
1813
+ * typically only ever have one, tied to that session. But authenticated users can create more than
1814
+ * one, and can use them interchangeably.
1815
+ *
1812
1816
  * @group Signatures and Initials
1813
- * @api POST /initials Create Initial Block
1817
+ * @api POST /v2/profiles/initials Create Initial Block
1814
1818
  * @apiBody string initial Blob containing initials image to store.
1815
1819
  * @apiSuccess IInitial . The newly-created initial block.
1816
1820
  */
@@ -1818,7 +1822,7 @@ const createInitials = (endpoint, name, initials) => {
1818
1822
  const data = new FormData();
1819
1823
  data.append('initial', initials, name);
1820
1824
  return endpoint.api //
1821
- .post(`/initials`, data)
1825
+ .post(`/v2/profiles/initials`, data)
1822
1826
  .then((r) => r.data);
1823
1827
  };
1824
1828
 
@@ -2111,9 +2115,12 @@ const getNextRecipient = (envelope) => {
2111
2115
  * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
2112
2116
  * to be "stamped" by the user.
2113
2117
  *
2114
- * @group Signatures and Initials
2115
- * @api POST /signatures Create Signature Block
2118
+ * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
2119
+ * typically only ever have one, tied to that session. But authenticated users can create more than
2120
+ * one, and can use them interchangeably.
2116
2121
  *
2122
+ * @group Signatures and Initials
2123
+ * @api POST /v2/profiles/signatures Create Signature Block
2117
2124
  * @apiBody string signature Blob containing signature image to store.
2118
2125
  * @apiSuccess ISignature . The newly-created signature block.
2119
2126
  */
@@ -2121,7 +2128,7 @@ const createSignature = (endpoint, name, signature) => {
2121
2128
  const data = new FormData();
2122
2129
  data.append('signature', signature, name);
2123
2130
  return endpoint.api //
2124
- .post(`/signatures`, data)
2131
+ .post(`/v2/profiles/signatures`, data)
2125
2132
  .then((r) => r.data);
2126
2133
  };
2127
2134
  /**