oro-sdk-apis 1.38.2 → 1.39.0

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.38.2",
+    "version": "1.39.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/models/guard.ts

@@ -157,6 +157,7 @@ export type PermissionBasedScopes =
     | 'practice.configs.get'
     | 'practice.invoices.get'
     | 'practice.payments.get'
+    | 'practice.secrets.get'
     | 'teller.emails.post'
 
 export type AllScopes = RoleBasedScopes | PermissionBasedScopes

package/src/models/practice.ts

@@ -616,3 +616,19 @@ export interface PracticeInvoice {
     currency: string
     discount: number
 }
+
+/**
+ * This interface represents a practice secret
+ * It is used to generate a symetric key to encrypt
+ * practice related data
+ */
+export interface PracticeSecret {
+    practiceUuid: string
+    /**
+     * The payload is the actual base64 encoded bytes that can
+     * be used as the practice secret. In the db,
+     * this field is base64 encoded nonce+encrypted-payload.
+     * It's decrypted on the fly when returned by the api.
+     */
+    payload: string
+}