@kernelminds/scailo-sdk 0.0.96 → 0.0.98

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 (127) hide show
  1. package/lib/cjs/index.js +34 -0
  2. package/lib/cjs/permissions.js +60 -38
  3. package/lib/cjs/src/credit_notes.scailo_connect.js +12 -0
  4. package/lib/cjs/src/debit_notes.scailo_connect.js +12 -0
  5. package/lib/cjs/src/general_settings.scailo_pb.js +14 -0
  6. package/lib/cjs/src/goods_dispatches.scailo_connect.js +12 -0
  7. package/lib/cjs/src/goods_receipts.scailo_connect.js +12 -0
  8. package/lib/cjs/src/inward_jobs.scailo_connect.js +12 -0
  9. package/lib/cjs/src/login.scailo_pb.js +7 -0
  10. package/lib/cjs/src/magic_links.scailo_connect.js +198 -0
  11. package/lib/cjs/src/magic_links.scailo_pb.js +1035 -0
  12. package/lib/cjs/src/outward_jobs.scailo_connect.js +12 -0
  13. package/lib/cjs/src/proforma_invoices.scailo_connect.js +12 -0
  14. package/lib/cjs/src/purchases_orders.scailo_connect.js +12 -0
  15. package/lib/cjs/src/purchases_returns.scailo_connect.js +12 -0
  16. package/lib/cjs/src/sales_enquiries.scailo_connect.js +12 -0
  17. package/lib/cjs/src/sales_invoices.scailo_connect.js +12 -0
  18. package/lib/cjs/src/sales_orders.scailo_connect.js +12 -0
  19. package/lib/cjs/src/sales_quotations.scailo_connect.js +12 -0
  20. package/lib/cjs/src/sales_returns.scailo_connect.js +12 -0
  21. package/lib/cjs/src/vendor_invoices.scailo_connect.js +12 -0
  22. package/lib/cjs/types/index.d.ts +31 -0
  23. package/lib/cjs/types/index.d.ts.map +1 -1
  24. package/lib/cjs/types/permissions.d.ts +105 -0
  25. package/lib/cjs/types/permissions.d.ts.map +1 -1
  26. package/lib/cjs/types/src/credit_notes.scailo_connect.d.ts +12 -0
  27. package/lib/cjs/types/src/credit_notes.scailo_connect.d.ts.map +1 -1
  28. package/lib/cjs/types/src/debit_notes.scailo_connect.d.ts +12 -0
  29. package/lib/cjs/types/src/debit_notes.scailo_connect.d.ts.map +1 -1
  30. package/lib/cjs/types/src/general_settings.scailo_pb.d.ts +12 -0
  31. package/lib/cjs/types/src/general_settings.scailo_pb.d.ts.map +1 -1
  32. package/lib/cjs/types/src/goods_dispatches.scailo_connect.d.ts +12 -0
  33. package/lib/cjs/types/src/goods_dispatches.scailo_connect.d.ts.map +1 -1
  34. package/lib/cjs/types/src/goods_receipts.scailo_connect.d.ts +12 -0
  35. package/lib/cjs/types/src/goods_receipts.scailo_connect.d.ts.map +1 -1
  36. package/lib/cjs/types/src/inward_jobs.scailo_connect.d.ts +12 -0
  37. package/lib/cjs/types/src/inward_jobs.scailo_connect.d.ts.map +1 -1
  38. package/lib/cjs/types/src/login.scailo_pb.d.ts +6 -0
  39. package/lib/cjs/types/src/login.scailo_pb.d.ts.map +1 -1
  40. package/lib/cjs/types/src/magic_links.scailo_connect.d.ts +192 -0
  41. package/lib/cjs/types/src/magic_links.scailo_connect.d.ts.map +1 -0
  42. package/lib/cjs/types/src/magic_links.scailo_pb.d.ts +774 -0
  43. package/lib/cjs/types/src/magic_links.scailo_pb.d.ts.map +1 -0
  44. package/lib/cjs/types/src/outward_jobs.scailo_connect.d.ts +12 -0
  45. package/lib/cjs/types/src/outward_jobs.scailo_connect.d.ts.map +1 -1
  46. package/lib/cjs/types/src/proforma_invoices.scailo_connect.d.ts +12 -0
  47. package/lib/cjs/types/src/proforma_invoices.scailo_connect.d.ts.map +1 -1
  48. package/lib/cjs/types/src/purchases_orders.scailo_connect.d.ts +12 -0
  49. package/lib/cjs/types/src/purchases_orders.scailo_connect.d.ts.map +1 -1
  50. package/lib/cjs/types/src/purchases_returns.scailo_connect.d.ts +12 -0
  51. package/lib/cjs/types/src/purchases_returns.scailo_connect.d.ts.map +1 -1
  52. package/lib/cjs/types/src/sales_enquiries.scailo_connect.d.ts +12 -0
  53. package/lib/cjs/types/src/sales_enquiries.scailo_connect.d.ts.map +1 -1
  54. package/lib/cjs/types/src/sales_invoices.scailo_connect.d.ts +12 -0
  55. package/lib/cjs/types/src/sales_invoices.scailo_connect.d.ts.map +1 -1
  56. package/lib/cjs/types/src/sales_orders.scailo_connect.d.ts +12 -0
  57. package/lib/cjs/types/src/sales_orders.scailo_connect.d.ts.map +1 -1
  58. package/lib/cjs/types/src/sales_quotations.scailo_connect.d.ts +12 -0
  59. package/lib/cjs/types/src/sales_quotations.scailo_connect.d.ts.map +1 -1
  60. package/lib/cjs/types/src/sales_returns.scailo_connect.d.ts +12 -0
  61. package/lib/cjs/types/src/sales_returns.scailo_connect.d.ts.map +1 -1
  62. package/lib/cjs/types/src/vendor_invoices.scailo_connect.d.ts +12 -0
  63. package/lib/cjs/types/src/vendor_invoices.scailo_connect.d.ts.map +1 -1
  64. package/lib/esm/index.js +34 -0
  65. package/lib/esm/permissions.js +60 -38
  66. package/lib/esm/src/credit_notes.scailo_connect.js +12 -0
  67. package/lib/esm/src/debit_notes.scailo_connect.js +12 -0
  68. package/lib/esm/src/general_settings.scailo_pb.js +14 -0
  69. package/lib/esm/src/goods_dispatches.scailo_connect.js +12 -0
  70. package/lib/esm/src/goods_receipts.scailo_connect.js +12 -0
  71. package/lib/esm/src/inward_jobs.scailo_connect.js +12 -0
  72. package/lib/esm/src/login.scailo_pb.js +7 -0
  73. package/lib/esm/src/magic_links.scailo_connect.js +198 -0
  74. package/lib/esm/src/magic_links.scailo_pb.js +1047 -0
  75. package/lib/esm/src/outward_jobs.scailo_connect.js +12 -0
  76. package/lib/esm/src/proforma_invoices.scailo_connect.js +12 -0
  77. package/lib/esm/src/purchases_orders.scailo_connect.js +12 -0
  78. package/lib/esm/src/purchases_returns.scailo_connect.js +12 -0
  79. package/lib/esm/src/sales_enquiries.scailo_connect.js +12 -0
  80. package/lib/esm/src/sales_invoices.scailo_connect.js +12 -0
  81. package/lib/esm/src/sales_orders.scailo_connect.js +12 -0
  82. package/lib/esm/src/sales_quotations.scailo_connect.js +12 -0
  83. package/lib/esm/src/sales_returns.scailo_connect.js +12 -0
  84. package/lib/esm/src/vendor_invoices.scailo_connect.js +12 -0
  85. package/lib/esm/types/index.d.ts +31 -0
  86. package/lib/esm/types/index.d.ts.map +1 -1
  87. package/lib/esm/types/permissions.d.ts +105 -0
  88. package/lib/esm/types/permissions.d.ts.map +1 -1
  89. package/lib/esm/types/src/credit_notes.scailo_connect.d.ts +12 -0
  90. package/lib/esm/types/src/credit_notes.scailo_connect.d.ts.map +1 -1
  91. package/lib/esm/types/src/debit_notes.scailo_connect.d.ts +12 -0
  92. package/lib/esm/types/src/debit_notes.scailo_connect.d.ts.map +1 -1
  93. package/lib/esm/types/src/general_settings.scailo_pb.d.ts +12 -0
  94. package/lib/esm/types/src/general_settings.scailo_pb.d.ts.map +1 -1
  95. package/lib/esm/types/src/goods_dispatches.scailo_connect.d.ts +12 -0
  96. package/lib/esm/types/src/goods_dispatches.scailo_connect.d.ts.map +1 -1
  97. package/lib/esm/types/src/goods_receipts.scailo_connect.d.ts +12 -0
  98. package/lib/esm/types/src/goods_receipts.scailo_connect.d.ts.map +1 -1
  99. package/lib/esm/types/src/inward_jobs.scailo_connect.d.ts +12 -0
  100. package/lib/esm/types/src/inward_jobs.scailo_connect.d.ts.map +1 -1
  101. package/lib/esm/types/src/login.scailo_pb.d.ts +6 -0
  102. package/lib/esm/types/src/login.scailo_pb.d.ts.map +1 -1
  103. package/lib/esm/types/src/magic_links.scailo_connect.d.ts +192 -0
  104. package/lib/esm/types/src/magic_links.scailo_connect.d.ts.map +1 -0
  105. package/lib/esm/types/src/magic_links.scailo_pb.d.ts +774 -0
  106. package/lib/esm/types/src/magic_links.scailo_pb.d.ts.map +1 -0
  107. package/lib/esm/types/src/outward_jobs.scailo_connect.d.ts +12 -0
  108. package/lib/esm/types/src/outward_jobs.scailo_connect.d.ts.map +1 -1
  109. package/lib/esm/types/src/proforma_invoices.scailo_connect.d.ts +12 -0
  110. package/lib/esm/types/src/proforma_invoices.scailo_connect.d.ts.map +1 -1
  111. package/lib/esm/types/src/purchases_orders.scailo_connect.d.ts +12 -0
  112. package/lib/esm/types/src/purchases_orders.scailo_connect.d.ts.map +1 -1
  113. package/lib/esm/types/src/purchases_returns.scailo_connect.d.ts +12 -0
  114. package/lib/esm/types/src/purchases_returns.scailo_connect.d.ts.map +1 -1
  115. package/lib/esm/types/src/sales_enquiries.scailo_connect.d.ts +12 -0
  116. package/lib/esm/types/src/sales_enquiries.scailo_connect.d.ts.map +1 -1
  117. package/lib/esm/types/src/sales_invoices.scailo_connect.d.ts +12 -0
  118. package/lib/esm/types/src/sales_invoices.scailo_connect.d.ts.map +1 -1
  119. package/lib/esm/types/src/sales_orders.scailo_connect.d.ts +12 -0
  120. package/lib/esm/types/src/sales_orders.scailo_connect.d.ts.map +1 -1
  121. package/lib/esm/types/src/sales_quotations.scailo_connect.d.ts +12 -0
  122. package/lib/esm/types/src/sales_quotations.scailo_connect.d.ts.map +1 -1
  123. package/lib/esm/types/src/sales_returns.scailo_connect.d.ts +12 -0
  124. package/lib/esm/types/src/sales_returns.scailo_connect.d.ts.map +1 -1
  125. package/lib/esm/types/src/vendor_invoices.scailo_connect.d.ts +12 -0
  126. package/lib/esm/types/src/vendor_invoices.scailo_connect.d.ts.map +1 -1
  127. package/package.json +1 -1
@@ -0,0 +1,774 @@
1
+ import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
2
+ import { Message, proto3 } from "@bufbuild/protobuf";
3
+ import { BOOL_FILTER, EmployeeMetadata, SORT_ORDER } from "./base.scailo_pb.js";
4
+ /**
5
+ *
6
+ * Describes the available resource types magic links
7
+ *
8
+ * @generated from enum Scailo.MAGIC_LINK_RESOURCE_TYPE
9
+ */
10
+ export declare enum MAGIC_LINK_RESOURCE_TYPE {
11
+ /**
12
+ * Used only in filters
13
+ *
14
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_ANY_UNSPECIFIED = 0;
15
+ */
16
+ MAGIC_LINK_RESOURCE_TYPE_ANY_UNSPECIFIED = 0,
17
+ /**
18
+ * Denotes that the magic link was created for a purchase order
19
+ *
20
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_PURCHASE_ORDER = 100;
21
+ */
22
+ MAGIC_LINK_RESOURCE_TYPE_PURCHASE_ORDER = 100,
23
+ /**
24
+ * Denotes that the magic link was created for a goods receipt
25
+ *
26
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_GOODS_RECEIPT = 110;
27
+ */
28
+ MAGIC_LINK_RESOURCE_TYPE_GOODS_RECEIPT = 110,
29
+ /**
30
+ * Denotes that the magic link was created for a vendor invoice
31
+ *
32
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_VENDOR_INVOICE = 120;
33
+ */
34
+ MAGIC_LINK_RESOURCE_TYPE_VENDOR_INVOICE = 120,
35
+ /**
36
+ * Denotes that the magic link was created for a debit note
37
+ *
38
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_DEBIT_NOTE = 130;
39
+ */
40
+ MAGIC_LINK_RESOURCE_TYPE_DEBIT_NOTE = 130,
41
+ /**
42
+ * Denotes that the magic link was created for a purchase return
43
+ *
44
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_PURCHASE_RETURN = 140;
45
+ */
46
+ MAGIC_LINK_RESOURCE_TYPE_PURCHASE_RETURN = 140,
47
+ /**
48
+ * Denotes that the magic link was created for a sales enquiry
49
+ *
50
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_SALES_ENQUIRY = 200;
51
+ */
52
+ MAGIC_LINK_RESOURCE_TYPE_SALES_ENQUIRY = 200,
53
+ /**
54
+ * Denotes that the magic link was created for a sales quotation;
55
+ *
56
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_SALES_QUOTATION = 205;
57
+ */
58
+ MAGIC_LINK_RESOURCE_TYPE_SALES_QUOTATION = 205,
59
+ /**
60
+ * Denotes that the magic link was created for a sales order
61
+ *
62
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_SALES_ORDER = 210;
63
+ */
64
+ MAGIC_LINK_RESOURCE_TYPE_SALES_ORDER = 210,
65
+ /**
66
+ * Denotes that the magic link was created for a goods dispatch
67
+ *
68
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_GOODS_DISPATCH = 220;
69
+ */
70
+ MAGIC_LINK_RESOURCE_TYPE_GOODS_DISPATCH = 220,
71
+ /**
72
+ * Denotes that the magic link was created for a proforma invoice
73
+ *
74
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_PROFORMA_INVOICE = 225;
75
+ */
76
+ MAGIC_LINK_RESOURCE_TYPE_PROFORMA_INVOICE = 225,
77
+ /**
78
+ * Denotes that the magic link was created for a sales invoice
79
+ *
80
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_SALES_INVOICE = 230;
81
+ */
82
+ MAGIC_LINK_RESOURCE_TYPE_SALES_INVOICE = 230,
83
+ /**
84
+ * Denotes that the magic link was created for a credit note
85
+ *
86
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_CREDIT_NOTE = 240;
87
+ */
88
+ MAGIC_LINK_RESOURCE_TYPE_CREDIT_NOTE = 240,
89
+ /**
90
+ * Denotes that the magic link was created for a sales return
91
+ *
92
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_SALES_RETURN = 250;
93
+ */
94
+ MAGIC_LINK_RESOURCE_TYPE_SALES_RETURN = 250,
95
+ /**
96
+ * Denotes that the magic link was created for an inward job
97
+ *
98
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_INWARD_JOB = 300;
99
+ */
100
+ MAGIC_LINK_RESOURCE_TYPE_INWARD_JOB = 300,
101
+ /**
102
+ * Denotes that the magic link was created for an outward job
103
+ *
104
+ * @generated from enum value: MAGIC_LINK_RESOURCE_TYPE_OUTWARD_JOB = 400;
105
+ */
106
+ MAGIC_LINK_RESOURCE_TYPE_OUTWARD_JOB = 400
107
+ }
108
+ /**
109
+ *
110
+ * Describes the available sort keys for retrieving magic links
111
+ *
112
+ * @generated from enum Scailo.MAGIC_LINK_SORT_KEY
113
+ */
114
+ export declare enum MAGIC_LINK_SORT_KEY {
115
+ /**
116
+ * Fetch ordered results by id
117
+ *
118
+ * @generated from enum value: MAGIC_LINK_SORT_KEY_ID_UNSPECIFIED = 0;
119
+ */
120
+ MAGIC_LINK_SORT_KEY_ID_UNSPECIFIED = 0,
121
+ /**
122
+ * Fetch ordered results by the creation timestamp
123
+ *
124
+ * @generated from enum value: MAGIC_LINK_SORT_KEY_CREATED_AT = 1;
125
+ */
126
+ MAGIC_LINK_SORT_KEY_CREATED_AT = 1,
127
+ /**
128
+ * Fetch ordered results by the modified timestamp
129
+ *
130
+ * @generated from enum value: MAGIC_LINK_SORT_KEY_MODIFIED_AT = 2;
131
+ */
132
+ MAGIC_LINK_SORT_KEY_MODIFIED_AT = 2,
133
+ /**
134
+ * Fetch ordered results by expiry timestamp
135
+ *
136
+ * @generated from enum value: MAGIC_LINK_SORT_KEY_EXPIRES_AT = 10;
137
+ */
138
+ MAGIC_LINK_SORT_KEY_EXPIRES_AT = 10
139
+ }
140
+ /**
141
+ *
142
+ * Describes the data structure of each magic link on the platform
143
+ *
144
+ * @generated from message Scailo.MagicLink
145
+ */
146
+ export declare class MagicLink extends Message<MagicLink> {
147
+ /**
148
+ * Stores a globally unique entity UUID. This will be set at the organization level
149
+ *
150
+ * @generated from field: string entity_uuid = 1;
151
+ */
152
+ entityUuid: string;
153
+ /**
154
+ * Stores the metadata of this resource
155
+ *
156
+ * @generated from field: Scailo.EmployeeMetadata metadata = 2;
157
+ */
158
+ metadata?: EmployeeMetadata;
159
+ /**
160
+ * The UUID of the resource
161
+ *
162
+ * @generated from field: string resource_uuid = 10;
163
+ */
164
+ resourceUuid: string;
165
+ /**
166
+ * The type of the resource
167
+ *
168
+ * @generated from field: Scailo.MAGIC_LINK_RESOURCE_TYPE resource_type = 21;
169
+ */
170
+ resourceType: MAGIC_LINK_RESOURCE_TYPE;
171
+ /**
172
+ * Stores the UNIX timestamp of when the link expires. If 0, then the link never expires
173
+ *
174
+ * @generated from field: uint64 expires_at = 30;
175
+ */
176
+ expiresAt: bigint;
177
+ /**
178
+ * Stores an optional description of the magic link
179
+ *
180
+ * @generated from field: string description = 35;
181
+ */
182
+ description: string;
183
+ /**
184
+ * Stores the code of the magic link that can be used to uniquely identify the magic link. This code will be used in the associated links, and will be used to uniquely identify the resource.
185
+ *
186
+ * @generated from field: string code = 40;
187
+ */
188
+ code: string;
189
+ /**
190
+ * Stores the generated URL of the magic link
191
+ *
192
+ * @generated from field: string url = 100;
193
+ */
194
+ url: string;
195
+ constructor(data?: PartialMessage<MagicLink>);
196
+ static readonly runtime: typeof proto3;
197
+ static readonly typeName = "Scailo.MagicLink";
198
+ static readonly fields: FieldList;
199
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLink;
200
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLink;
201
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLink;
202
+ static equals(a: MagicLink | PlainMessage<MagicLink> | undefined, b: MagicLink | PlainMessage<MagicLink> | undefined): boolean;
203
+ }
204
+ /**
205
+ *
206
+ * Describes the data structure that stores a list of magic links
207
+ *
208
+ * @generated from message Scailo.MagicLinksList
209
+ */
210
+ export declare class MagicLinksList extends Message<MagicLinksList> {
211
+ /**
212
+ * List of magic links
213
+ *
214
+ * @generated from field: repeated Scailo.MagicLink list = 1;
215
+ */
216
+ list: MagicLink[];
217
+ constructor(data?: PartialMessage<MagicLinksList>);
218
+ static readonly runtime: typeof proto3;
219
+ static readonly typeName = "Scailo.MagicLinksList";
220
+ static readonly fields: FieldList;
221
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksList;
222
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksList;
223
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksList;
224
+ static equals(a: MagicLinksList | PlainMessage<MagicLinksList> | undefined, b: MagicLinksList | PlainMessage<MagicLinksList> | undefined): boolean;
225
+ }
226
+ /**
227
+ *
228
+ * Describes the data structure that responds to a pagination request
229
+ *
230
+ * @generated from message Scailo.MagicLinkPaginationResp
231
+ */
232
+ export declare class MagicLinkPaginationResp extends Message<MagicLinkPaginationResp> {
233
+ /**
234
+ * The number of records in this payload
235
+ *
236
+ * @generated from field: uint64 count = 1;
237
+ */
238
+ count: bigint;
239
+ /**
240
+ * The number that has been offset before fetching the records. This is the same value that has been sent as part of the pagination request
241
+ *
242
+ * @generated from field: uint64 offset = 2;
243
+ */
244
+ offset: bigint;
245
+ /**
246
+ * The total number of records that are available
247
+ *
248
+ * @generated from field: uint64 total = 3;
249
+ */
250
+ total: bigint;
251
+ /**
252
+ * The list of records
253
+ *
254
+ * @generated from field: repeated Scailo.MagicLink payload = 4;
255
+ */
256
+ payload: MagicLink[];
257
+ constructor(data?: PartialMessage<MagicLinkPaginationResp>);
258
+ static readonly runtime: typeof proto3;
259
+ static readonly typeName = "Scailo.MagicLinkPaginationResp";
260
+ static readonly fields: FieldList;
261
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinkPaginationResp;
262
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinkPaginationResp;
263
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinkPaginationResp;
264
+ static equals(a: MagicLinkPaginationResp | PlainMessage<MagicLinkPaginationResp> | undefined, b: MagicLinkPaginationResp | PlainMessage<MagicLinkPaginationResp> | undefined): boolean;
265
+ }
266
+ /**
267
+ *
268
+ * Describes the necessary data structure during creation of a magic link
269
+ *
270
+ * @generated from message Scailo.MagicLinksServiceCreateRequest
271
+ */
272
+ export declare class MagicLinksServiceCreateRequest extends Message<MagicLinksServiceCreateRequest> {
273
+ /**
274
+ * Stores a globally unique entity UUID. This will be set at the organization level
275
+ *
276
+ * @generated from field: string entity_uuid = 1;
277
+ */
278
+ entityUuid: string;
279
+ /**
280
+ * Stores any comment that the user might add during this operation
281
+ *
282
+ * @generated from field: string user_comment = 2;
283
+ */
284
+ userComment: string;
285
+ /**
286
+ * The UUID of the resource
287
+ *
288
+ * @generated from field: string resource_uuid = 10;
289
+ */
290
+ resourceUuid: string;
291
+ /**
292
+ * The type of the resource
293
+ *
294
+ * @generated from field: Scailo.MAGIC_LINK_RESOURCE_TYPE resource_type = 21;
295
+ */
296
+ resourceType: MAGIC_LINK_RESOURCE_TYPE;
297
+ /**
298
+ * Stores the UNIX timestamp of when the link expires. If 0, then the link never expires
299
+ *
300
+ * @generated from field: uint64 expires_at = 30;
301
+ */
302
+ expiresAt: bigint;
303
+ /**
304
+ * Stores an optional description of the magic link
305
+ *
306
+ * @generated from field: string description = 35;
307
+ */
308
+ description: string;
309
+ constructor(data?: PartialMessage<MagicLinksServiceCreateRequest>);
310
+ static readonly runtime: typeof proto3;
311
+ static readonly typeName = "Scailo.MagicLinksServiceCreateRequest";
312
+ static readonly fields: FieldList;
313
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServiceCreateRequest;
314
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServiceCreateRequest;
315
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServiceCreateRequest;
316
+ static equals(a: MagicLinksServiceCreateRequest | PlainMessage<MagicLinksServiceCreateRequest> | undefined, b: MagicLinksServiceCreateRequest | PlainMessage<MagicLinksServiceCreateRequest> | undefined): boolean;
317
+ }
318
+ /**
319
+ *
320
+ * Describes the necessary data structure for creation of a magic link. This data structure is used within other services, while creating magic links for the given resource
321
+ *
322
+ * @generated from message Scailo.MagicLinksServiceCreateRequestForSpecificResource
323
+ */
324
+ export declare class MagicLinksServiceCreateRequestForSpecificResource extends Message<MagicLinksServiceCreateRequestForSpecificResource> {
325
+ /**
326
+ * Stores any comment that the user might add during this operation
327
+ *
328
+ * @generated from field: string user_comment = 2;
329
+ */
330
+ userComment: string;
331
+ /**
332
+ * The UUID of the resource
333
+ *
334
+ * @generated from field: string resource_uuid = 10;
335
+ */
336
+ resourceUuid: string;
337
+ /**
338
+ * Stores the UNIX timestamp of when the link expires. If 0, then the link never expires
339
+ *
340
+ * @generated from field: uint64 expires_at = 30;
341
+ */
342
+ expiresAt: bigint;
343
+ /**
344
+ * Stores an optional description of the magic link
345
+ *
346
+ * @generated from field: string description = 35;
347
+ */
348
+ description: string;
349
+ constructor(data?: PartialMessage<MagicLinksServiceCreateRequestForSpecificResource>);
350
+ static readonly runtime: typeof proto3;
351
+ static readonly typeName = "Scailo.MagicLinksServiceCreateRequestForSpecificResource";
352
+ static readonly fields: FieldList;
353
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServiceCreateRequestForSpecificResource;
354
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServiceCreateRequestForSpecificResource;
355
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServiceCreateRequestForSpecificResource;
356
+ static equals(a: MagicLinksServiceCreateRequestForSpecificResource | PlainMessage<MagicLinksServiceCreateRequestForSpecificResource> | undefined, b: MagicLinksServiceCreateRequestForSpecificResource | PlainMessage<MagicLinksServiceCreateRequestForSpecificResource> | undefined): boolean;
357
+ }
358
+ /**
359
+ *
360
+ * Describes the data structure to perform the update (draft/revision) operation on a magic link
361
+ *
362
+ * @generated from message Scailo.MagicLinksServiceUpdateRequest
363
+ */
364
+ export declare class MagicLinksServiceUpdateRequest extends Message<MagicLinksServiceUpdateRequest> {
365
+ /**
366
+ * Stores any comment that the user might add during this operation
367
+ *
368
+ * @generated from field: string user_comment = 1;
369
+ */
370
+ userComment: string;
371
+ /**
372
+ * The ID of the magic link that needs to be updated
373
+ *
374
+ * @generated from field: uint64 id = 2;
375
+ */
376
+ id: bigint;
377
+ /**
378
+ * Stores the UNIX timestamp of when the link expires. If 0, then the link never expires
379
+ *
380
+ * @generated from field: uint64 expires_at = 30;
381
+ */
382
+ expiresAt: bigint;
383
+ /**
384
+ * Stores an optional description of the magic link
385
+ *
386
+ * @generated from field: string description = 35;
387
+ */
388
+ description: string;
389
+ constructor(data?: PartialMessage<MagicLinksServiceUpdateRequest>);
390
+ static readonly runtime: typeof proto3;
391
+ static readonly typeName = "Scailo.MagicLinksServiceUpdateRequest";
392
+ static readonly fields: FieldList;
393
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServiceUpdateRequest;
394
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServiceUpdateRequest;
395
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServiceUpdateRequest;
396
+ static equals(a: MagicLinksServiceUpdateRequest | PlainMessage<MagicLinksServiceUpdateRequest> | undefined, b: MagicLinksServiceUpdateRequest | PlainMessage<MagicLinksServiceUpdateRequest> | undefined): boolean;
397
+ }
398
+ /**
399
+ *
400
+ * Describes a pagination request to retrieve records
401
+ *
402
+ * @generated from message Scailo.MagicLinksServicePaginationReq
403
+ */
404
+ export declare class MagicLinksServicePaginationReq extends Message<MagicLinksServicePaginationReq> {
405
+ /**
406
+ * If true, then returns only active records. If false, then returns only inactive records
407
+ *
408
+ * @generated from field: Scailo.BOOL_FILTER is_active = 1;
409
+ */
410
+ isActive: BOOL_FILTER;
411
+ /**
412
+ * The number of records that need to be sent in the response
413
+ *
414
+ * @generated from field: int64 count = 2;
415
+ */
416
+ count: bigint;
417
+ /**
418
+ * The number that need to be offset by before fetching the records
419
+ *
420
+ * @generated from field: uint64 offset = 3;
421
+ */
422
+ offset: bigint;
423
+ /**
424
+ * The sort order that is to be used to fetch the pagination response
425
+ *
426
+ * @generated from field: Scailo.SORT_ORDER sort_order = 4;
427
+ */
428
+ sortOrder: SORT_ORDER;
429
+ /**
430
+ * The sort key that is to be used to fetch the pagination response
431
+ *
432
+ * @generated from field: Scailo.MAGIC_LINK_SORT_KEY sort_key = 5;
433
+ */
434
+ sortKey: MAGIC_LINK_SORT_KEY;
435
+ constructor(data?: PartialMessage<MagicLinksServicePaginationReq>);
436
+ static readonly runtime: typeof proto3;
437
+ static readonly typeName = "Scailo.MagicLinksServicePaginationReq";
438
+ static readonly fields: FieldList;
439
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServicePaginationReq;
440
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServicePaginationReq;
441
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServicePaginationReq;
442
+ static equals(a: MagicLinksServicePaginationReq | PlainMessage<MagicLinksServicePaginationReq> | undefined, b: MagicLinksServicePaginationReq | PlainMessage<MagicLinksServicePaginationReq> | undefined): boolean;
443
+ }
444
+ /**
445
+ *
446
+ * Describes the base request payload of a filter search
447
+ *
448
+ * @generated from message Scailo.MagicLinksServiceFilterReq
449
+ */
450
+ export declare class MagicLinksServiceFilterReq extends Message<MagicLinksServiceFilterReq> {
451
+ /**
452
+ * If true, then returns only active records. If false, then returns only inactive records
453
+ *
454
+ * @generated from field: Scailo.BOOL_FILTER is_active = 1;
455
+ */
456
+ isActive: BOOL_FILTER;
457
+ /**
458
+ * The number of records that need to be sent in the response. Returns all records if it is set to -1
459
+ *
460
+ * @generated from field: int64 count = 2;
461
+ */
462
+ count: bigint;
463
+ /**
464
+ * The number that need to be offset by before fetching the records
465
+ *
466
+ * @generated from field: uint64 offset = 3;
467
+ */
468
+ offset: bigint;
469
+ /**
470
+ * The sort order that is to be used to fetch the pagination response
471
+ *
472
+ * @generated from field: Scailo.SORT_ORDER sort_order = 4;
473
+ */
474
+ sortOrder: SORT_ORDER;
475
+ /**
476
+ * The sort key that is to be used to fetch the pagination response
477
+ *
478
+ * @generated from field: Scailo.MAGIC_LINK_SORT_KEY sort_key = 5;
479
+ */
480
+ sortKey: MAGIC_LINK_SORT_KEY;
481
+ /**
482
+ * The minimum timestamp that needs to be considered to filter by creation
483
+ *
484
+ * @generated from field: uint64 creation_timestamp_start = 101;
485
+ */
486
+ creationTimestampStart: bigint;
487
+ /**
488
+ * The maximum timestamp that needs to be considered to filter by creation
489
+ *
490
+ * @generated from field: uint64 creation_timestamp_end = 102;
491
+ */
492
+ creationTimestampEnd: bigint;
493
+ /**
494
+ * The minimum timestamp that needs to be considered to filter by modification
495
+ *
496
+ * @generated from field: uint64 modification_timestamp_start = 103;
497
+ */
498
+ modificationTimestampStart: bigint;
499
+ /**
500
+ * The maximum timestamp that needs to be considered to filter by modification
501
+ *
502
+ * @generated from field: uint64 modification_timestamp_end = 104;
503
+ */
504
+ modificationTimestampEnd: bigint;
505
+ /**
506
+ * The entity UUID that is to be used to filter records
507
+ *
508
+ * @generated from field: string entity_uuid = 8;
509
+ */
510
+ entityUuid: string;
511
+ /**
512
+ * The type of the resource
513
+ *
514
+ * @generated from field: Scailo.MAGIC_LINK_RESOURCE_TYPE resource_type = 21;
515
+ */
516
+ resourceType: MAGIC_LINK_RESOURCE_TYPE;
517
+ /**
518
+ * The UUID of the resource
519
+ *
520
+ * @generated from field: string resource_uuid = 22;
521
+ */
522
+ resourceUuid: string;
523
+ /**
524
+ * The start timestamp that needs to be considered to filter by expiry
525
+ *
526
+ * @generated from field: uint64 expires_at_start = 30;
527
+ */
528
+ expiresAtStart: bigint;
529
+ /**
530
+ * The end timestamp that needs to be considered to filter by expiry
531
+ *
532
+ * @generated from field: uint64 expires_at_end = 31;
533
+ */
534
+ expiresAtEnd: bigint;
535
+ constructor(data?: PartialMessage<MagicLinksServiceFilterReq>);
536
+ static readonly runtime: typeof proto3;
537
+ static readonly typeName = "Scailo.MagicLinksServiceFilterReq";
538
+ static readonly fields: FieldList;
539
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServiceFilterReq;
540
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServiceFilterReq;
541
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServiceFilterReq;
542
+ static equals(a: MagicLinksServiceFilterReq | PlainMessage<MagicLinksServiceFilterReq> | undefined, b: MagicLinksServiceFilterReq | PlainMessage<MagicLinksServiceFilterReq> | undefined): boolean;
543
+ }
544
+ /**
545
+ *
546
+ * Describes the base request payload of a count search
547
+ *
548
+ * @generated from message Scailo.MagicLinksServiceCountReq
549
+ */
550
+ export declare class MagicLinksServiceCountReq extends Message<MagicLinksServiceCountReq> {
551
+ /**
552
+ * If true, then returns only active records. If false, then returns only inactive records
553
+ *
554
+ * @generated from field: Scailo.BOOL_FILTER is_active = 1;
555
+ */
556
+ isActive: BOOL_FILTER;
557
+ /**
558
+ * The minimum timestamp that needs to be considered to filter by creation
559
+ *
560
+ * @generated from field: uint64 creation_timestamp_start = 101;
561
+ */
562
+ creationTimestampStart: bigint;
563
+ /**
564
+ * The maximum timestamp that needs to be considered to filter by creation
565
+ *
566
+ * @generated from field: uint64 creation_timestamp_end = 102;
567
+ */
568
+ creationTimestampEnd: bigint;
569
+ /**
570
+ * The minimum timestamp that needs to be considered to filter by modification
571
+ *
572
+ * @generated from field: uint64 modification_timestamp_start = 103;
573
+ */
574
+ modificationTimestampStart: bigint;
575
+ /**
576
+ * The maximum timestamp that needs to be considered to filter by modification
577
+ *
578
+ * @generated from field: uint64 modification_timestamp_end = 104;
579
+ */
580
+ modificationTimestampEnd: bigint;
581
+ /**
582
+ * The entity UUID that is to be used to filter records
583
+ *
584
+ * @generated from field: string entity_uuid = 8;
585
+ */
586
+ entityUuid: string;
587
+ /**
588
+ * The type of the resource
589
+ *
590
+ * @generated from field: Scailo.MAGIC_LINK_RESOURCE_TYPE resource_type = 21;
591
+ */
592
+ resourceType: MAGIC_LINK_RESOURCE_TYPE;
593
+ /**
594
+ * The UUID of the resource
595
+ *
596
+ * @generated from field: string resource_uuid = 22;
597
+ */
598
+ resourceUuid: string;
599
+ /**
600
+ * The start timestamp that needs to be considered to filter by expiry
601
+ *
602
+ * @generated from field: uint64 expires_at_start = 30;
603
+ */
604
+ expiresAtStart: bigint;
605
+ /**
606
+ * The end timestamp that needs to be considered to filter by expiry
607
+ *
608
+ * @generated from field: uint64 expires_at_end = 31;
609
+ */
610
+ expiresAtEnd: bigint;
611
+ constructor(data?: PartialMessage<MagicLinksServiceCountReq>);
612
+ static readonly runtime: typeof proto3;
613
+ static readonly typeName = "Scailo.MagicLinksServiceCountReq";
614
+ static readonly fields: FieldList;
615
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServiceCountReq;
616
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServiceCountReq;
617
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServiceCountReq;
618
+ static equals(a: MagicLinksServiceCountReq | PlainMessage<MagicLinksServiceCountReq> | undefined, b: MagicLinksServiceCountReq | PlainMessage<MagicLinksServiceCountReq> | undefined): boolean;
619
+ }
620
+ /**
621
+ *
622
+ * Describes the request payload for performing a generic search operation on magic links
623
+ *
624
+ * @generated from message Scailo.MagicLinksServiceSearchAllReq
625
+ */
626
+ export declare class MagicLinksServiceSearchAllReq extends Message<MagicLinksServiceSearchAllReq> {
627
+ /**
628
+ * If true, then returns only active records. If false, then returns only inactive records
629
+ *
630
+ * @generated from field: Scailo.BOOL_FILTER is_active = 1;
631
+ */
632
+ isActive: BOOL_FILTER;
633
+ /**
634
+ * The number of records that need to be sent in the response. Returns all records if it is set to -1
635
+ *
636
+ * @generated from field: int64 count = 2;
637
+ */
638
+ count: bigint;
639
+ /**
640
+ * The number that need to be offset by before fetching the records
641
+ *
642
+ * @generated from field: uint64 offset = 3;
643
+ */
644
+ offset: bigint;
645
+ /**
646
+ * The sort order that is to be used to fetch the pagination response
647
+ *
648
+ * @generated from field: Scailo.SORT_ORDER sort_order = 4;
649
+ */
650
+ sortOrder: SORT_ORDER;
651
+ /**
652
+ * The sort key that is to be used to fetch the response
653
+ *
654
+ * @generated from field: Scailo.MAGIC_LINK_SORT_KEY sort_key = 5;
655
+ */
656
+ sortKey: MAGIC_LINK_SORT_KEY;
657
+ /**
658
+ * The entity UUID that is to be used to filter magic links
659
+ *
660
+ * @generated from field: string entity_uuid = 6;
661
+ */
662
+ entityUuid: string;
663
+ /**
664
+ * Describes the key with which the search operation needs to be performed
665
+ *
666
+ * @generated from field: string search_key = 10;
667
+ */
668
+ searchKey: string;
669
+ /**
670
+ * The type of the resource
671
+ *
672
+ * @generated from field: Scailo.MAGIC_LINK_RESOURCE_TYPE resource_type = 21;
673
+ */
674
+ resourceType: MAGIC_LINK_RESOURCE_TYPE;
675
+ constructor(data?: PartialMessage<MagicLinksServiceSearchAllReq>);
676
+ static readonly runtime: typeof proto3;
677
+ static readonly typeName = "Scailo.MagicLinksServiceSearchAllReq";
678
+ static readonly fields: FieldList;
679
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinksServiceSearchAllReq;
680
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinksServiceSearchAllReq;
681
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinksServiceSearchAllReq;
682
+ static equals(a: MagicLinksServiceSearchAllReq | PlainMessage<MagicLinksServiceSearchAllReq> | undefined, b: MagicLinksServiceSearchAllReq | PlainMessage<MagicLinksServiceSearchAllReq> | undefined): boolean;
683
+ }
684
+ /**
685
+ *
686
+ * Describes the request payload for retrieving the magic link information using the code
687
+ *
688
+ * @generated from message Scailo.MagicLinkServiceSearchByCodeReq
689
+ */
690
+ export declare class MagicLinkServiceSearchByCodeReq extends Message<MagicLinkServiceSearchByCodeReq> {
691
+ /**
692
+ * The code that needs to be used to retrieve the magic link
693
+ *
694
+ * @generated from field: string code = 1;
695
+ */
696
+ code: string;
697
+ /**
698
+ * The IP address that is requesting the search (must be a valid IPv4 or IPv6 address)
699
+ *
700
+ * @generated from field: string ip_address = 2;
701
+ */
702
+ ipAddress: string;
703
+ constructor(data?: PartialMessage<MagicLinkServiceSearchByCodeReq>);
704
+ static readonly runtime: typeof proto3;
705
+ static readonly typeName = "Scailo.MagicLinkServiceSearchByCodeReq";
706
+ static readonly fields: FieldList;
707
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinkServiceSearchByCodeReq;
708
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinkServiceSearchByCodeReq;
709
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinkServiceSearchByCodeReq;
710
+ static equals(a: MagicLinkServiceSearchByCodeReq | PlainMessage<MagicLinkServiceSearchByCodeReq> | undefined, b: MagicLinkServiceSearchByCodeReq | PlainMessage<MagicLinkServiceSearchByCodeReq> | undefined): boolean;
711
+ }
712
+ /**
713
+ *
714
+ * Describes the access log of each magic link
715
+ *
716
+ * @generated from message Scailo.MagicLinkAccessLog
717
+ */
718
+ export declare class MagicLinkAccessLog extends Message<MagicLinkAccessLog> {
719
+ /**
720
+ * Stores a globally unique entity UUID. This will be set at the organization level
721
+ *
722
+ * @generated from field: string entity_uuid = 1;
723
+ */
724
+ entityUuid: string;
725
+ /**
726
+ * Stores the metadata of this user
727
+ *
728
+ * @generated from field: Scailo.EmployeeMetadata metadata = 2;
729
+ */
730
+ metadata?: EmployeeMetadata;
731
+ /**
732
+ * Stores the UUID of the magic link that was accessed
733
+ *
734
+ * @generated from field: string magic_link_uuid = 12;
735
+ */
736
+ magicLinkUuid: string;
737
+ /**
738
+ * Stores the IP address from where the resource was accessed
739
+ *
740
+ * @generated from field: string ip_addr = 13;
741
+ */
742
+ ipAddr: string;
743
+ constructor(data?: PartialMessage<MagicLinkAccessLog>);
744
+ static readonly runtime: typeof proto3;
745
+ static readonly typeName = "Scailo.MagicLinkAccessLog";
746
+ static readonly fields: FieldList;
747
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinkAccessLog;
748
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinkAccessLog;
749
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinkAccessLog;
750
+ static equals(a: MagicLinkAccessLog | PlainMessage<MagicLinkAccessLog> | undefined, b: MagicLinkAccessLog | PlainMessage<MagicLinkAccessLog> | undefined): boolean;
751
+ }
752
+ /**
753
+ *
754
+ * Describes the message consisting of the list of access logs
755
+ *
756
+ * @generated from message Scailo.MagicLinkAccessLogsList
757
+ */
758
+ export declare class MagicLinkAccessLogsList extends Message<MagicLinkAccessLogsList> {
759
+ /**
760
+ * List of access logs
761
+ *
762
+ * @generated from field: repeated Scailo.MagicLinkAccessLog list = 1;
763
+ */
764
+ list: MagicLinkAccessLog[];
765
+ constructor(data?: PartialMessage<MagicLinkAccessLogsList>);
766
+ static readonly runtime: typeof proto3;
767
+ static readonly typeName = "Scailo.MagicLinkAccessLogsList";
768
+ static readonly fields: FieldList;
769
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MagicLinkAccessLogsList;
770
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MagicLinkAccessLogsList;
771
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MagicLinkAccessLogsList;
772
+ static equals(a: MagicLinkAccessLogsList | PlainMessage<MagicLinkAccessLogsList> | undefined, b: MagicLinkAccessLogsList | PlainMessage<MagicLinkAccessLogsList> | undefined): boolean;
773
+ }
774
+ //# sourceMappingURL=magic_links.scailo_pb.d.ts.map