@oneblink/sdk 13.0.0-beta.2 → 13.0.0-beta.3

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.
Files changed (24) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/tenants/classes/Approvals.d.ts +1 -1
  4. package/tenants/classes/Approvals.js +1 -1
  5. package/tenants/classes/DataManager.d.ts +1 -1
  6. package/tenants/classes/DataManager.js +1 -1
  7. package/tenants/classes/EmailTemplates.d.ts +1 -1
  8. package/tenants/classes/EmailTemplates.js +1 -1
  9. package/tenants/classes/Forms.d.ts +8 -8
  10. package/tenants/classes/Forms.js +8 -8
  11. package/tenants/classes/FormsAppEnvironments.d.ts +1 -1
  12. package/tenants/classes/FormsAppEnvironments.js +1 -1
  13. package/tenants/classes/FormsApps.d.ts +1 -1
  14. package/tenants/classes/FormsApps.js +1 -1
  15. package/tenants/classes/Jobs.d.ts +1 -1
  16. package/tenants/classes/Jobs.js +1 -1
  17. package/tenants/classes/Keys.d.ts +1 -1
  18. package/tenants/classes/Keys.js +1 -1
  19. package/tenants/classes/Organisations.d.ts +1 -1
  20. package/tenants/classes/Organisations.js +1 -1
  21. package/tenants/classes/PDF.d.ts +7 -7
  22. package/tenants/classes/PDF.js +7 -7
  23. package/tenants/classes/sendEmail.d.ts +1 -1
  24. package/tenants/classes/sendEmail.js +1 -1
package/README.md CHANGED
@@ -18,7 +18,7 @@ If you currently have more than 200 forms returned from this function, or expect
18
18
  If you do need to account for this, accessing all forms as you previously could now requires that you make multiple calls to this function. This could look something like:
19
19
 
20
20
  ```javascript
21
- const { Forms } = require('@oneblink/sdk')
21
+ import { Forms } from '@oneblink/sdk'
22
22
 
23
23
  const options = {
24
24
  accessKey: '123455678901ABCDEFGHIJKL',
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@oneblink/sdk",
3
3
  "description": "OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS",
4
- "version": "13.0.0-beta.2",
4
+ "version": "13.0.0-beta.3",
5
5
  "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
6
6
  "bugs": {
7
7
  "url": "https://github.com/oneblink/sdk-node-js/issues"
package/tenants/classes/Approvals.d.ts CHANGED
@@ -3,7 +3,7 @@ import { ConstructorOptions, FormApprovalFlowInstanceResponse, FormSubmissionApp
3
3
  export default class Approvals extends OneBlinkAPI {
4
4
  /**
5
5
  * @example
6
- * const OneBlink = require('@oneblink/sdk')
6
+ * import * as OneBlink from '@oneblink/sdk'
7
7
  * const options = {
8
8
  * accessKey: '123455678901ABCDEFGHIJKL',
9
9
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Approvals.js CHANGED
@@ -2,7 +2,7 @@ import OneBlinkAPI from '../lib/one-blink-api.js';
2
2
  export default class Approvals extends OneBlinkAPI {
3
3
  /**
4
4
  * @example
5
- * const OneBlink = require('@oneblink/sdk')
5
+ * import * as OneBlink from '@oneblink/sdk'
6
6
  * const options = {
7
7
  * accessKey: '123455678901ABCDEFGHIJKL',
8
8
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/DataManager.d.ts CHANGED
@@ -3,7 +3,7 @@ import { ConstructorOptions, SearchDataManagerRecordsOptions, SearchDataManagerR
3
3
  export default class DataManager extends OneBlinkAPI {
4
4
  /**
5
5
  * @example
6
- * const OneBlink = require('@oneblink/sdk')
6
+ * import * as OneBlink from '@oneblink/sdk'
7
7
  * const options = {
8
8
  * accessKey: '123455678901ABCDEFGHIJKL',
9
9
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/DataManager.js CHANGED
@@ -2,7 +2,7 @@ import OneBlinkAPI from '../lib/one-blink-api.js';
2
2
  export default class DataManager extends OneBlinkAPI {
3
3
  /**
4
4
  * @example
5
- * const OneBlink = require('@oneblink/sdk')
5
+ * import * as OneBlink from '@oneblink/sdk'
6
6
  * const options = {
7
7
  * accessKey: '123455678901ABCDEFGHIJKL',
8
8
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/EmailTemplates.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions, EmailTemplatesSearchOptions, EmailTemplatesSearchRe
4
4
  export default class EmailTemplates extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/EmailTemplates.js CHANGED
@@ -3,7 +3,7 @@ const basePath = `/email-templates`;
3
3
  export default class EmailTemplates extends OneBlinkAPI {
4
4
  /**
5
5
  * @example
6
- * const OneBlink = require('@oneblink/sdk')
6
+ * import * as OneBlink from '@oneblink/sdk'
7
7
  * const options = {
8
8
  * accessKey: '123455678901ABCDEFGHIJKL',
9
9
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Forms.d.ts CHANGED
@@ -7,7 +7,7 @@ import { type ConstructorOptions, type FormsSearchOptions, type FormsSearchResul
7
7
  export default class Forms extends OneBlinkAPI {
8
8
  /**
9
9
  * @example
10
- * const OneBlink = require('@oneblink/sdk')
10
+ * import * as OneBlink from '@oneblink/sdk'
11
11
  * const options = {
12
12
  * accessKey: '123455678901ABCDEFGHIJKL',
13
13
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
@@ -186,9 +186,9 @@ export default class Forms extends OneBlinkAPI {
186
186
  * Submission Data: _Read Only_
187
187
  *
188
188
  * @example
189
- * const fs = require('fs')
190
- * const util = require('util')
191
- * const stream = require('stream')
189
+ * import fs from 'fs'
190
+ * import util from 'util'
191
+ * import stream from 'stream'
192
192
  *
193
193
  * const finishedAsync = util.promisify(stream.finished)
194
194
  *
@@ -221,8 +221,8 @@ export default class Forms extends OneBlinkAPI {
221
221
  * Submission Data: _Read Only_
222
222
  *
223
223
  * @example
224
- * const fs = require('fs')
225
- * const util = require('util')
224
+ * import fs from 'fs'
225
+ * import util from 'util'
226
226
  *
227
227
  * const writeFileAsync = util.promisify(fs.writeFile)
228
228
  *
@@ -248,8 +248,8 @@ export default class Forms extends OneBlinkAPI {
248
248
  * Upload Attachments: _On_
249
249
  *
250
250
  * @example
251
- * const fs = require('fs')
252
- * const util = require('util')
251
+ * import fs from 'fs'
252
+ * import util from 'util'
253
253
  *
254
254
  * const readFileAsync = util.promisify(fs.readFile)
255
255
  *
package/tenants/classes/Forms.js CHANGED
@@ -6,7 +6,7 @@ import { validateWithFormSchema, validateFormEventData, validateEndpointConfigur
6
6
  export default class Forms extends OneBlinkAPI {
7
7
  /**
8
8
  * @example
9
- * const OneBlink = require('@oneblink/sdk')
9
+ * import * as OneBlink from '@oneblink/sdk'
10
10
  * const options = {
11
11
  * accessKey: '123455678901ABCDEFGHIJKL',
12
12
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
@@ -281,9 +281,9 @@ export default class Forms extends OneBlinkAPI {
281
281
  * Submission Data: _Read Only_
282
282
  *
283
283
  * @example
284
- * const fs = require('fs')
285
- * const util = require('util')
286
- * const stream = require('stream')
284
+ * import fs from 'fs'
285
+ * import util from 'util'
286
+ * import stream from 'stream'
287
287
  *
288
288
  * const finishedAsync = util.promisify(stream.finished)
289
289
  *
@@ -322,8 +322,8 @@ export default class Forms extends OneBlinkAPI {
322
322
  * Submission Data: _Read Only_
323
323
  *
324
324
  * @example
325
- * const fs = require('fs')
326
- * const util = require('util')
325
+ * import fs from 'fs'
326
+ * import util from 'util'
327
327
  *
328
328
  * const writeFileAsync = util.promisify(fs.writeFile)
329
329
  *
@@ -353,8 +353,8 @@ export default class Forms extends OneBlinkAPI {
353
353
  * Upload Attachments: _On_
354
354
  *
355
355
  * @example
356
- * const fs = require('fs')
357
- * const util = require('util')
356
+ * import fs from 'fs'
357
+ * import util from 'util'
358
358
  *
359
359
  * const readFileAsync = util.promisify(fs.readFile)
360
360
  *
package/tenants/classes/FormsAppEnvironments.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions, FormsAppEnvironmentsSearchOptions, FormsAppEnvironm
4
4
  export default class FormsAppEnvironments extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/FormsAppEnvironments.js CHANGED
@@ -3,7 +3,7 @@ const basePath = `/forms-app-environments`;
3
3
  export default class FormsAppEnvironments extends OneBlinkAPI {
4
4
  /**
5
5
  * @example
6
- * const OneBlink = require('@oneblink/sdk')
6
+ * import * as OneBlink from '@oneblink/sdk'
7
7
  * const options = {
8
8
  * accessKey: '123455678901ABCDEFGHIJKL',
9
9
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/FormsApps.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions } from '../types.js';
4
4
  export default class FormsApps extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/FormsApps.js CHANGED
@@ -4,7 +4,7 @@ const basePath = `/forms-apps`;
4
4
  export default class FormsApps extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Jobs.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions, JobsSearchResult } from '../types.js';
4
4
  export default class Jobs extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Jobs.js CHANGED
@@ -17,7 +17,7 @@ const newJobSchema = Joi.object()
17
17
  export default class Jobs extends OneBlinkAPI {
18
18
  /**
19
19
  * @example
20
- * const OneBlink = require('@oneblink/sdk')
20
+ * import * as OneBlink from '@oneblink/sdk'
21
21
  * const options = {
22
22
  * accessKey: '123455678901ABCDEFGHIJKL',
23
23
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Keys.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions } from '../types.js';
4
4
  export default class Keys extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Keys.js CHANGED
@@ -2,7 +2,7 @@ import OneBlinkAPI from '../lib/one-blink-api.js';
2
2
  export default class Keys extends OneBlinkAPI {
3
3
  /**
4
4
  * @example
5
- * const OneBlink = require('@oneblink/sdk')
5
+ * import * as OneBlink from '@oneblink/sdk'
6
6
  * const options = {
7
7
  * accessKey: '123455678901ABCDEFGHIJKL',
8
8
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Organisations.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions } from '../types.js';
4
4
  export default class Organisations extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/Organisations.js CHANGED
@@ -3,7 +3,7 @@ import { Readable } from 'stream';
3
3
  export default class Organisations extends OneBlinkAPI {
4
4
  /**
5
5
  * @example
6
- * const OneBlink = require('@oneblink/sdk')
6
+ * import * as OneBlink from '@oneblink/sdk'
7
7
  * const options = {
8
8
  * accessKey: '123455678901ABCDEFGHIJKL',
9
9
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
package/tenants/classes/PDF.d.ts CHANGED
@@ -4,7 +4,7 @@ import { ConstructorOptions } from '../types.js';
4
4
  export default class PDF extends OneBlinkAPI {
5
5
  /**
6
6
  * @example
7
- * const OneBlink = require('@oneblink/sdk')
7
+ * import * as OneBlink from '@oneblink/sdk'
8
8
  * const options = {
9
9
  * accessKey: '123455678901ABCDEFGHIJKL',
10
10
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
@@ -22,8 +22,8 @@ export default class PDF extends OneBlinkAPI {
22
22
  * Submission Data: _Read Only_
23
23
  *
24
24
  * @example
25
- * const fs = require('fs')
26
- * const util = require('util')
25
+ * import fs from 'fs'
26
+ * import util from 'util'
27
27
  *
28
28
  * const writeFileAsync = util.promisify(fs.writeFile)
29
29
  *
@@ -57,8 +57,8 @@ export default class PDF extends OneBlinkAPI {
57
57
  * PDF Generation: _On_
58
58
  *
59
59
  * @example
60
- * const fs = require('fs')
61
- * const util = require('util')
60
+ * import fs from 'fs'
61
+ * import util from 'util'
62
62
  *
63
63
  * const writeFileAsync = util.promisify(fs.writeFile)
64
64
  *
@@ -106,8 +106,8 @@ export default class PDF extends OneBlinkAPI {
106
106
  * PDF Generation: _On_
107
107
  *
108
108
  * @example
109
- * const fs = require('fs')
110
- * const util = require('util')
109
+ * import fs from 'fs'
110
+ * import util from 'util'
111
111
  *
112
112
  * const writeFileAsync = util.promisify(fs.writeFile)
113
113
  *
package/tenants/classes/PDF.js CHANGED
@@ -2,7 +2,7 @@ import OneBlinkAPI from '../lib/one-blink-api.js';
2
2
  export default class PDF extends OneBlinkAPI {
3
3
  /**
4
4
  * @example
5
- * const OneBlink = require('@oneblink/sdk')
5
+ * import * as OneBlink from '@oneblink/sdk'
6
6
  * const options = {
7
7
  * accessKey: '123455678901ABCDEFGHIJKL',
8
8
  * secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
@@ -23,8 +23,8 @@ export default class PDF extends OneBlinkAPI {
23
23
  * Submission Data: _Read Only_
24
24
  *
25
25
  * @example
26
- * const fs = require('fs')
27
- * const util = require('util')
26
+ * import fs from 'fs'
27
+ * import util from 'util'
28
28
  *
29
29
  * const writeFileAsync = util.promisify(fs.writeFile)
30
30
  *
@@ -73,8 +73,8 @@ export default class PDF extends OneBlinkAPI {
73
73
  * PDF Generation: _On_
74
74
  *
75
75
  * @example
76
- * const fs = require('fs')
77
- * const util = require('util')
76
+ * import fs from 'fs'
77
+ * import util from 'util'
78
78
  *
79
79
  * const writeFileAsync = util.promisify(fs.writeFile)
80
80
  *
@@ -138,8 +138,8 @@ export default class PDF extends OneBlinkAPI {
138
138
  * PDF Generation: _On_
139
139
  *
140
140
  * @example
141
- * const fs = require('fs')
142
- * const util = require('util')
141
+ * import fs from 'fs'
142
+ * import util from 'util'
143
143
  *
144
144
  * const writeFileAsync = util.promisify(fs.writeFile)
145
145
  *
package/tenants/classes/sendEmail.d.ts CHANGED
@@ -9,7 +9,7 @@ import { SendMailOptions, SendEmailResult } from '../types.js';
9
9
  * - `SendRawEmail`
10
10
  *
11
11
  * @example
12
- * const OneBlink = require('@oneblink/sdk')
12
+ * import * as OneBlink from '@oneblink/sdk'
13
13
  *
14
14
  * await OneBlink.sendEmail({
15
15
  * subject: 'Message title',
package/tenants/classes/sendEmail.js CHANGED
@@ -12,7 +12,7 @@ import OneBlinkAPI from '../lib/one-blink-api.js';
12
12
  * - `SendRawEmail`
13
13
  *
14
14
  * @example
15
- * const OneBlink = require('@oneblink/sdk')
15
+ * import * as OneBlink from '@oneblink/sdk'
16
16
  *
17
17
  * await OneBlink.sendEmail({
18
18
  * subject: 'Message title',