@kernelminds/scailo-sdk 0.1.0 → 0.1.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.
Files changed (31) hide show
  1. package/lib/cjs/index.js +34 -0
  2. package/lib/cjs/src/forms_fields.scailo_pb.js +45 -24
  3. package/lib/cjs/src/transactional_emails.scailo_connect.js +132 -0
  4. package/lib/cjs/src/transactional_emails.scailo_pb.js +948 -0
  5. package/lib/cjs/src/vault_commons.scailo_pb.js +29 -22
  6. package/lib/cjs/types/index.d.ts +31 -0
  7. package/lib/cjs/types/index.d.ts.map +1 -1
  8. package/lib/cjs/types/src/forms_fields.scailo_pb.d.ts +36 -18
  9. package/lib/cjs/types/src/forms_fields.scailo_pb.d.ts.map +1 -1
  10. package/lib/cjs/types/src/transactional_emails.scailo_connect.d.ts +126 -0
  11. package/lib/cjs/types/src/transactional_emails.scailo_connect.d.ts.map +1 -0
  12. package/lib/cjs/types/src/transactional_emails.scailo_pb.d.ts +698 -0
  13. package/lib/cjs/types/src/transactional_emails.scailo_pb.d.ts.map +1 -0
  14. package/lib/cjs/types/src/vault_commons.scailo_pb.d.ts +21 -15
  15. package/lib/cjs/types/src/vault_commons.scailo_pb.d.ts.map +1 -1
  16. package/lib/esm/index.js +34 -0
  17. package/lib/esm/src/forms_fields.scailo_pb.js +45 -24
  18. package/lib/esm/src/transactional_emails.scailo_connect.js +132 -0
  19. package/lib/esm/src/transactional_emails.scailo_pb.js +966 -0
  20. package/lib/esm/src/vault_commons.scailo_pb.js +29 -22
  21. package/lib/esm/types/index.d.ts +31 -0
  22. package/lib/esm/types/index.d.ts.map +1 -1
  23. package/lib/esm/types/src/forms_fields.scailo_pb.d.ts +36 -18
  24. package/lib/esm/types/src/forms_fields.scailo_pb.d.ts.map +1 -1
  25. package/lib/esm/types/src/transactional_emails.scailo_connect.d.ts +126 -0
  26. package/lib/esm/types/src/transactional_emails.scailo_connect.d.ts.map +1 -0
  27. package/lib/esm/types/src/transactional_emails.scailo_pb.d.ts +698 -0
  28. package/lib/esm/types/src/transactional_emails.scailo_pb.d.ts.map +1 -0
  29. package/lib/esm/types/src/vault_commons.scailo_pb.d.ts +21 -15
  30. package/lib/esm/types/src/vault_commons.scailo_pb.d.ts.map +1 -1
  31. package/package.json +1 -1
package/lib/cjs/index.js CHANGED
@@ -112,6 +112,7 @@ exports.getScailoClientForSupplyOffersService = getScailoClientForSupplyOffersSe
112
112
  exports.getScailoClientForTaxGroupsService = getScailoClientForTaxGroupsService;
113
113
  exports.getScailoClientForTaxParamsService = getScailoClientForTaxParamsService;
114
114
  exports.getScailoClientForTeamsService = getScailoClientForTeamsService;
115
+ exports.getScailoClientForTransactionalEmailsService = getScailoClientForTransactionalEmailsService;
115
116
  exports.getScailoClientForUnitsOfMaterialsService = getScailoClientForUnitsOfMaterialsService;
116
117
  exports.getScailoClientForUsersService = getScailoClientForUsersService;
117
118
  exports.getScailoClientForVaultService = getScailoClientForVaultService;
@@ -319,6 +320,8 @@ __exportStar(require("./src/tax_params.scailo_connect"), exports);
319
320
  __exportStar(require("./src/tax_params.scailo_pb"), exports);
320
321
  __exportStar(require("./src/teams.scailo_connect"), exports);
321
322
  __exportStar(require("./src/teams.scailo_pb"), exports);
323
+ __exportStar(require("./src/transactional_emails.scailo_connect"), exports);
324
+ __exportStar(require("./src/transactional_emails.scailo_pb"), exports);
322
325
  __exportStar(require("./src/units_of_materials.scailo_connect"), exports);
323
326
  __exportStar(require("./src/units_of_materials.scailo_pb"), exports);
324
327
  __exportStar(require("./src/users.scailo_connect"), exports);
@@ -439,6 +442,7 @@ const supply_offers_scailo_connect_1 = require("./src/supply_offers.scailo_conne
439
442
  const tax_groups_scailo_connect_1 = require("./src/tax_groups.scailo_connect");
440
443
  const tax_params_scailo_connect_1 = require("./src/tax_params.scailo_connect");
441
444
  const teams_scailo_connect_1 = require("./src/teams.scailo_connect");
445
+ const transactional_emails_scailo_connect_1 = require("./src/transactional_emails.scailo_connect");
442
446
  const units_of_materials_scailo_connect_1 = require("./src/units_of_materials.scailo_connect");
443
447
  const users_scailo_connect_1 = require("./src/users.scailo_connect");
444
448
  const vault_scailo_connect_1 = require("./src/vault.scailo_connect");
@@ -3390,6 +3394,36 @@ function getScailoClientForTeamsService(transport) {
3390
3394
  }
3391
3395
  /**
3392
3396
 
3397
+ Get the client to access the TransactionalEmailsService. Transport is a connectrpc Transport, which is created as follows:
3398
+
3399
+ For web:
3400
+ ```
3401
+ import { createConnectTransport } from "@connectrpc/connect-web";
3402
+
3403
+ function getWebTransport(apiEndPoint: string = location.origin) {
3404
+ return createConnectTransport({
3405
+ baseUrl: apiEndPoint, useBinaryFormat: false, interceptors: []
3406
+ });
3407
+ }
3408
+ ```
3409
+
3410
+ For node:
3411
+ ```
3412
+ import { createConnectTransport } from "@connectrpc/connect-node";
3413
+
3414
+ function getNodeTransport(apiEndPoint: string) {
3415
+ return createConnectTransport({
3416
+ baseUrl: apiEndPoint, httpVersion: "1.1", useBinaryFormat: false, interceptors: []
3417
+ });
3418
+ }
3419
+ ```
3420
+
3421
+ */
3422
+ function getScailoClientForTransactionalEmailsService(transport) {
3423
+ return (0, connect_1.createClient)(transactional_emails_scailo_connect_1.TransactionalEmailsService, transport);
3424
+ }
3425
+ /**
3426
+
3393
3427
  Get the client to access the UnitsOfMaterialsService. Transport is a connectrpc Transport, which is created as follows:
3394
3428
 
3395
3429
  For web:
@@ -131,17 +131,23 @@ class FormField extends protobuf_1.Message {
131
131
  */
132
132
  this.definedValues = [];
133
133
  /**
134
- * Stores if the form field is printable
134
+ * Denotes if the field is readonly (changes shall not be allowed to be made on the UI). Any changes will still be made through the API
135
135
  *
136
- * @generated from field: bool printable = 18;
136
+ * @generated from field: bool is_readonly = 30;
137
137
  */
138
- this.printable = false;
138
+ this.isReadonly = false;
139
139
  /**
140
- * Stores the the form field needs to be highlighted
140
+ * Denotes if the field is hidden (field shall not be visible on the UI). The field shall be visible only through the API
141
141
  *
142
- * @generated from field: bool highlightable = 19;
142
+ * @generated from field: bool is_hidden = 31;
143
143
  */
144
- this.highlightable = false;
144
+ this.isHidden = false;
145
+ /**
146
+ * Denotes if the field is searchable (field shall not be visible on the UI in the filters view). The field will continue to be searchable through the API
147
+ *
148
+ * @generated from field: bool is_searchable = 32;
149
+ */
150
+ this.isSearchable = false;
145
151
  protobuf_1.proto3.util.initPartial(data, this);
146
152
  }
147
153
  static fromBinary(bytes, options) {
@@ -172,8 +178,9 @@ FormField.fields = protobuf_1.proto3.util.newFieldList(() => [
172
178
  { no: 15, name: "placeholder", kind: "scalar", T: 9 /* ScalarType.STRING */ },
173
179
  { no: 16, name: "regex", kind: "scalar", T: 9 /* ScalarType.STRING */ },
174
180
  { no: 17, name: "defined_values", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
175
- { no: 18, name: "printable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
176
- { no: 19, name: "highlightable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
181
+ { no: 30, name: "is_readonly", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
182
+ { no: 31, name: "is_hidden", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
183
+ { no: 32, name: "is_searchable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
177
184
  ]);
178
185
  /**
179
186
  *
@@ -344,17 +351,23 @@ class FormsFieldsServiceCreateRequest extends protobuf_1.Message {
344
351
  */
345
352
  this.definedValues = [];
346
353
  /**
347
- * Stores if the form field is printable
354
+ * Denotes if the field is readonly (changes shall not be allowed to be made on the UI). Any changes will still be made through the API
348
355
  *
349
- * @generated from field: bool printable = 18;
356
+ * @generated from field: bool is_readonly = 30;
350
357
  */
351
- this.printable = false;
358
+ this.isReadonly = false;
352
359
  /**
353
- * Stores the the form field needs to be highlighted
360
+ * Denotes if the field is hidden (field shall not be visible on the UI). The field shall be visible only through the API
354
361
  *
355
- * @generated from field: bool highlightable = 19;
362
+ * @generated from field: bool is_hidden = 31;
356
363
  */
357
- this.highlightable = false;
364
+ this.isHidden = false;
365
+ /**
366
+ * Denotes if the field is searchable (field shall not be visible on the UI in the filters view). The field will continue to be searchable through the API
367
+ *
368
+ * @generated from field: bool is_searchable = 32;
369
+ */
370
+ this.isSearchable = false;
358
371
  protobuf_1.proto3.util.initPartial(data, this);
359
372
  }
360
373
  static fromBinary(bytes, options) {
@@ -385,8 +398,9 @@ FormsFieldsServiceCreateRequest.fields = protobuf_1.proto3.util.newFieldList(()
385
398
  { no: 15, name: "placeholder", kind: "scalar", T: 9 /* ScalarType.STRING */ },
386
399
  { no: 16, name: "regex", kind: "scalar", T: 9 /* ScalarType.STRING */ },
387
400
  { no: 17, name: "defined_values", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
388
- { no: 18, name: "printable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
389
- { no: 19, name: "highlightable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
401
+ { no: 30, name: "is_readonly", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
402
+ { no: 31, name: "is_hidden", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
403
+ { no: 32, name: "is_searchable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
390
404
  ]);
391
405
  /**
392
406
  *
@@ -452,17 +466,23 @@ class FormsFieldsServiceUpdateRequest extends protobuf_1.Message {
452
466
  */
453
467
  this.definedValues = [];
454
468
  /**
455
- * Stores if the form field is printable
469
+ * Denotes if the field is readonly (changes shall not be allowed to be made on the UI). Any changes will still be made through the API
470
+ *
471
+ * @generated from field: bool is_readonly = 30;
472
+ */
473
+ this.isReadonly = false;
474
+ /**
475
+ * Denotes if the field is hidden (field shall not be visible on the UI). The field shall be visible only through the API
456
476
  *
457
- * @generated from field: bool printable = 18;
477
+ * @generated from field: bool is_hidden = 31;
458
478
  */
459
- this.printable = false;
479
+ this.isHidden = false;
460
480
  /**
461
- * Stores the the form field needs to be highlighted
481
+ * Denotes if the field is searchable (field shall not be visible on the UI in the filters view). The field will continue to be searchable through the API
462
482
  *
463
- * @generated from field: bool highlightable = 19;
483
+ * @generated from field: bool is_searchable = 32;
464
484
  */
465
- this.highlightable = false;
485
+ this.isSearchable = false;
466
486
  protobuf_1.proto3.util.initPartial(data, this);
467
487
  }
468
488
  static fromBinary(bytes, options) {
@@ -491,8 +511,9 @@ FormsFieldsServiceUpdateRequest.fields = protobuf_1.proto3.util.newFieldList(()
491
511
  { no: 15, name: "placeholder", kind: "scalar", T: 9 /* ScalarType.STRING */ },
492
512
  { no: 16, name: "regex", kind: "scalar", T: 9 /* ScalarType.STRING */ },
493
513
  { no: 17, name: "defined_values", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
494
- { no: 18, name: "printable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
495
- { no: 19, name: "highlightable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
514
+ { no: 30, name: "is_readonly", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
515
+ { no: 31, name: "is_hidden", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
516
+ { no: 32, name: "is_searchable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
496
517
  ]);
497
518
  /**
498
519
  *
@@ -0,0 +1,132 @@
1
+ "use strict";
2
+ // @generated by protoc-gen-connect-es v0.12.0 with parameter "target=ts"
3
+ // @generated from file transactional_emails.scailo.proto (package Scailo, syntax proto3)
4
+ /* eslint-disable */
5
+ // @ts-nocheck
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.TransactionalEmailsService = void 0;
8
+ const transactional_emails_scailo_pb_js_1 = require("./transactional_emails.scailo_pb.js");
9
+ const protobuf_1 = require("@bufbuild/protobuf");
10
+ const base_scailo_pb_js_1 = require("./base.scailo_pb.js");
11
+ /**
12
+ *
13
+ * Describes the methods applicable on each transactional email
14
+ *
15
+ * @generated from service Scailo.TransactionalEmailsService
16
+ */
17
+ exports.TransactionalEmailsService = {
18
+ typeName: "Scailo.TransactionalEmailsService",
19
+ methods: {
20
+ /**
21
+ * Create a transactional email
22
+ *
23
+ * @generated from rpc Scailo.TransactionalEmailsService.Create
24
+ */
25
+ create: {
26
+ name: "Create",
27
+ I: transactional_emails_scailo_pb_js_1.TransactionalEmailsServiceCreateRequest,
28
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmail,
29
+ kind: protobuf_1.MethodKind.Unary,
30
+ },
31
+ /**
32
+ * View by ID
33
+ *
34
+ * @generated from rpc Scailo.TransactionalEmailsService.ViewByID
35
+ */
36
+ viewByID: {
37
+ name: "ViewByID",
38
+ I: base_scailo_pb_js_1.Identifier,
39
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmail,
40
+ kind: protobuf_1.MethodKind.Unary,
41
+ },
42
+ /**
43
+ * View by UUID
44
+ *
45
+ * @generated from rpc Scailo.TransactionalEmailsService.ViewByUUID
46
+ */
47
+ viewByUUID: {
48
+ name: "ViewByUUID",
49
+ I: base_scailo_pb_js_1.IdentifierUUID,
50
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmail,
51
+ kind: protobuf_1.MethodKind.Unary,
52
+ },
53
+ /**
54
+ * View all records with the given IDs
55
+ *
56
+ * @generated from rpc Scailo.TransactionalEmailsService.ViewFromIDs
57
+ */
58
+ viewFromIDs: {
59
+ name: "ViewFromIDs",
60
+ I: base_scailo_pb_js_1.IdentifiersList,
61
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmailsList,
62
+ kind: protobuf_1.MethodKind.Unary,
63
+ },
64
+ /**
65
+ * View all recipients of the transactional email
66
+ *
67
+ * @generated from rpc Scailo.TransactionalEmailsService.ViewRecipients
68
+ */
69
+ viewRecipients: {
70
+ name: "ViewRecipients",
71
+ I: base_scailo_pb_js_1.IdentifierUUID,
72
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmailRecipientsList,
73
+ kind: protobuf_1.MethodKind.Unary,
74
+ },
75
+ /**
76
+ * View all attachments of the transactional email
77
+ *
78
+ * @generated from rpc Scailo.TransactionalEmailsService.ViewAttachments
79
+ */
80
+ viewAttachments: {
81
+ name: "ViewAttachments",
82
+ I: base_scailo_pb_js_1.IdentifierUUID,
83
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmailAttachmentsList,
84
+ kind: protobuf_1.MethodKind.Unary,
85
+ },
86
+ /**
87
+ * View all transactional emails that match the given search key
88
+ *
89
+ * @generated from rpc Scailo.TransactionalEmailsService.SearchAll
90
+ */
91
+ searchAll: {
92
+ name: "SearchAll",
93
+ I: transactional_emails_scailo_pb_js_1.TransactionalEmailsServiceSearchAllReq,
94
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmailsList,
95
+ kind: protobuf_1.MethodKind.Unary,
96
+ },
97
+ /**
98
+ * View all that match the given filter criteria
99
+ *
100
+ * @generated from rpc Scailo.TransactionalEmailsService.Filter
101
+ */
102
+ filter: {
103
+ name: "Filter",
104
+ I: transactional_emails_scailo_pb_js_1.TransactionalEmailsServiceFilterReq,
105
+ O: transactional_emails_scailo_pb_js_1.TransactionalEmailsList,
106
+ kind: protobuf_1.MethodKind.Unary,
107
+ },
108
+ /**
109
+ * Count all that match the given criteria
110
+ *
111
+ * @generated from rpc Scailo.TransactionalEmailsService.Count
112
+ */
113
+ count: {
114
+ name: "Count",
115
+ I: transactional_emails_scailo_pb_js_1.TransactionalEmailsServiceCountReq,
116
+ O: base_scailo_pb_js_1.CountResponse,
117
+ kind: protobuf_1.MethodKind.Unary,
118
+ },
119
+ /**
120
+ * CSV operations
121
+ * Download the CSV file that consists of the list of records according to the given filter request. The same file could also be used as a template for uploading records
122
+ *
123
+ * @generated from rpc Scailo.TransactionalEmailsService.DownloadAsCSV
124
+ */
125
+ downloadAsCSV: {
126
+ name: "DownloadAsCSV",
127
+ I: transactional_emails_scailo_pb_js_1.TransactionalEmailsServiceFilterReq,
128
+ O: base_scailo_pb_js_1.StandardFile,
129
+ kind: protobuf_1.MethodKind.Unary,
130
+ },
131
+ }
132
+ };