Update SDK to allow the new result field (#46)

merging on behalf of Fangming
sailpoint-oss · Oct 27, 2023 · 9f17e34 · 9f17e34
1 parent d910f51
commit 9f17e34
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 4 deletions.
diff --git a/lib/commands/command.ts b/lib/commands/command.ts
@@ -166,3 +166,35 @@ export type EntitlementSchema = Schema & {
 	type: string,
 	includePermissions?: boolean
 }
+
+/**
+ * Granular result for an attribute to indicate partial attribule level success & warning & failure 
+ */
+export type Result = {
+	attribute: string,
+	status?: ResultStatus,
+	messages?: ResultMessage[]
+}
+
+/**
+ * Status for result
+ */
+export enum ResultStatus {
+	Error = 'error',
+}
+
+/**
+ * Warning or error message for a result
+ */
+export type ResultMessage = {
+	level: ResultMessageLevel,
+	message: string
+}
+
+/**
+ * Level for result message
+ */
+export enum ResultMessageLevel {
+	WARN = 'WARN',
+	ERROR = 'ERROR',
+}
diff --git a/lib/commands/std-account-create.ts b/lib/commands/std-account-create.ts
@@ -1,6 +1,6 @@
 /* Copyright (c) 2021. SailPoint Technologies, Inc. All rights reserved. */
 
-import { AccountSchema, Attributes, ObjectOutput } from './command'
+import { AccountSchema, Attributes, ObjectOutput, Result } from './command'
 
 /**
  * Input object of `std:account:create` command
@@ -17,5 +17,6 @@ export type StdAccountCreateInput = {
 export type StdAccountCreateOutput = ObjectOutput & {
 	disabled?: boolean
 	locked?: boolean
-	attributes: Attributes
+	attributes: Attributes,
+	results?: Result[]
 }
diff --git a/lib/commands/std-account-update.ts b/lib/commands/std-account-update.ts
@@ -1,6 +1,6 @@
 /* Copyright (c) 2021. SailPoint Technologies, Inc. All rights reserved. */
 
-import { AccountSchema, Attributes, ObjectInput, ObjectOutput } from './command'
+import { AccountSchema, Attributes, ObjectInput, ObjectOutput, Result } from './command'
 
 export enum AttributeChangeOp {
 	Add = 'Add',
@@ -30,4 +30,9 @@ export type StdAccountUpdateInput = ObjectInput & {
  *
  * All properties are optional for this output
  */
-export type StdAccountUpdateOutput = ObjectOutput & { disabled?: boolean, locked?: boolean, attributes?: Attributes }
+export type StdAccountUpdateOutput = ObjectOutput & {
+	disabled?: boolean,
+	locked?: boolean,
+	attributes?: Attributes,
+	results?: Result[]
+}