@dfns/sdk 0.2.1 → 0.2.3-rc.1

package/codegen/datamodel/Permissions/types.ts

@@ -0,0 +1,221 @@
+import { EntityId, IsoDatetime } from '../Foundations'
+
+// FIXME: Missing documentation for Permission
+export type Permission = {
+  // FIXME: Missing documentation for id
+  id: EntityId
+
+  // FIXME: Missing documentation for orgId
+  orgId: EntityId
+
+  // FIXME: Missing documentation for name
+  name: string
+
+  // FIXME: Missing documentation for operations
+  operations: string[]
+
+  // FIXME: Missing documentation for status
+  status: PermissionStatus
+
+  // FIXME: Missing documentation for resourceId
+  resourceId?: string
+
+  // FIXME: Missing documentation for isImmutable
+  isImmutable: boolean
+
+  // FIXME: Missing documentation for predicates
+  predicates?: PermissionPredicate[]
+
+  // FIXME: Missing documentation for dateCreated
+  dateCreated: IsoDatetime
+
+  // FIXME: Missing documentation for dateUpdated
+  dateUpdated: IsoDatetime
+
+  // FIXME: Missing documentation for isArchived
+  isArchived: boolean
+}
+
+// FIXME: Missing documentation for PermissionPredicate
+export type PermissionPredicate = {
+  // FIXME: Missing documentation for id
+  id: EntityId
+
+  // FIXME: Missing documentation for permissionId
+  permissionId: EntityId
+
+  // FIXME: Missing documentation for fieldName
+  fieldName: string
+
+  // FIXME: Missing documentation for evaluatorKind
+  evaluatorKind: FieldEvaluatorKind
+
+  // FIXME: Missing documentation for parameters
+  parameters: string[]
+
+  // FIXME: Missing documentation for isImmutable
+  isImmutable: boolean
+
+  // FIXME: Missing documentation for dateCreated
+  dateCreated: IsoDatetime
+
+  // FIXME: Missing documentation for dateUpdated
+  dateUpdated: IsoDatetime
+
+  // FIXME: Missing documentation for isArchived
+  isArchived: boolean
+}
+
+// FIXME: Missing documentation for PermissionAssignment
+export type PermissionAssignment = {
+  // FIXME: Missing documentation for id
+  id: EntityId
+
+  // FIXME: Missing documentation for permissionId
+  permissionId: string
+
+  // FIXME: Missing documentation for identityId
+  identityId: EntityId
+
+  // FIXME: Missing documentation for dateCreated
+  dateCreated: IsoDatetime
+
+  // FIXME: Missing documentation for dateUpdated
+  dateUpdated: IsoDatetime
+}
+
+// FIXME: Missing documentation for DeletionAcknowledgement
+export type DeletionAcknowledgement = {
+  // FIXME: Missing documentation for id
+  id: string
+}
+
+// FIXME: Missing documentation for ResourceOwnership
+export type ResourceOwnership = {
+  // FIXME: Missing documentation for id
+  id: EntityId
+
+  // FIXME: Missing documentation for orgId
+  orgId: EntityId
+
+  // FIXME: Missing documentation for resourceId
+  resourceId: EntityId
+
+  // FIXME: Missing documentation for resourceKind
+  resourceKind: string
+
+  // FIXME: Missing documentation for ownerId
+  ownerId: EntityId
+
+  // FIXME: Missing documentation for ownerKind
+  ownerKind: OwnerKind
+
+  // FIXME: Missing documentation for dateCreated
+  dateCreated: IsoDatetime
+
+  // FIXME: Missing documentation for dateUpdated
+  dateUpdated: IsoDatetime
+}
+
+// FIXME: Missing documentation for CreatePermissionInput
+export type CreatePermissionInput = {
+  // FIXME: Missing documentation for name
+  name: string
+
+  // FIXME: Missing documentation for operations
+  operations: string[]
+}
+
+// FIXME: Missing documentation for UpdatePermissionInput
+export type UpdatePermissionInput = {
+  // FIXME: Missing documentation for name
+  name?: string
+
+  // FIXME: Missing documentation for operations
+  operations?: string[]
+}
+
+// FIXME: Missing documentation for ArchivePermissionInput
+export type ArchivePermissionInput = {
+  // FIXME: Missing documentation for isArchived
+  isArchived: boolean
+}
+
+// FIXME: Missing documentation for CreatePermissionPredicateInput
+export type CreatePermissionPredicateInput = {
+  // FIXME: Missing documentation for fieldName
+  fieldName: string
+
+  // FIXME: Missing documentation for evaluatorKind
+  evaluatorKind: FieldEvaluatorKind
+
+  // FIXME: Missing documentation for parameters
+  parameters: string[]
+}
+
+// FIXME: Missing documentation for UpdatePermissionPredicateInput
+export type UpdatePermissionPredicateInput = {
+  // FIXME: Missing documentation for fieldName
+  fieldName?: string
+
+  // FIXME: Missing documentation for evaluatorKind
+  evaluatorKind?: FieldEvaluatorKind
+
+  // FIXME: Missing documentation for parameters
+  parameters?: string[]
+}
+
+// FIXME: Missing documentation for ArchivePermissionPredicateInput
+export type ArchivePermissionPredicateInput = {
+  // FIXME: Missing documentation for isArchived
+  isArchived: boolean
+}
+
+// FIXME: Missing documentation for CreatePermissionAssignmentInput
+export type CreatePermissionAssignmentInput = {
+  // FIXME: Missing documentation for permissionId
+  permissionId: string
+
+  // FIXME: Missing documentation for identityId
+  identityId: string
+}
+
+// FIXME: Missing documentation for FieldEvaluatorKind
+export enum FieldEvaluatorKind {
+  // FIXME: Missing documentation for ContainsAll
+  ContainsAll = 'ContainsAll',
+  // FIXME: Missing documentation for ContainsOneOf
+  ContainsOneOf = 'ContainsOneOf',
+  // FIXME: Missing documentation for DateAfter
+  DateAfter = 'DateAfter',
+  // FIXME: Missing documentation for DateBefore
+  DateBefore = 'DateBefore',
+  // FIXME: Missing documentation for Is
+  Is = 'Is',
+  // FIXME: Missing documentation for ValueGreaterThan
+  ValueGreaterThan = 'ValueGreaterThan',
+  // FIXME: Missing documentation for ValueLessThan
+  ValueLessThan = 'ValueLessThan',
+}
+
+// FIXME: Missing documentation for PermissionStatus
+export enum PermissionStatus {
+  // FIXME: Missing documentation for Active
+  Active = 'Active',
+}
+
+// FIXME: Missing documentation for OwnerKind
+export enum OwnerKind {
+  // FIXME: Missing documentation for LegalPerson
+  LegalPerson = 'LegalPerson',
+  // FIXME: Missing documentation for NaturalPerson
+  NaturalPerson = 'NaturalPerson',
+}
+
+// FIXME: Missing documentation for ResourceKind
+export enum ResourceKind {
+  // FIXME: Missing documentation for Wallet
+  Wallet = 'Wallet',
+  // FIXME: Missing documentation for PublicKey
+  PublicKey = 'PublicKey',
+}

package/codegen/datamodel/PolicyExecution/errors.ts

@@ -0,0 +1,24 @@
+import { DfnsError } from '../Foundations'
+export class PolicyApprovalNotAllowedError extends DfnsError {
+  name: string = 'PolicyApprovalNotAllowedError'
+  // FIXME: Missing documentation for serviceName
+  serviceName: string
+
+  // FIXME: Missing documentation for message
+  message: string
+
+  // FIXME: Missing documentation for causes
+  causes?: string[]
+
+  // FIXME: Missing documentation for shouldTriggerInvestigaton
+  shouldTriggerInvestigaton: boolean
+
+  // FIXME: Missing documentation for isDfnsError
+  isDfnsError: boolean = true
+
+  // FIXME: Missing documentation for httpStatus
+  httpStatus: number = 403
+
+  // FIXME: Missing documentation for errorName
+  errorName: string = 'Policy Approval Not Allowed'
+}

package/codegen/datamodel/PolicyExecution/index.ts

@@ -0,0 +1,3 @@
+export * from './errors'
+export * from './responses'
+export * from './types'

package/codegen/datamodel/PolicyExecution/responses.ts

@@ -0,0 +1,59 @@
+import {
+  BadRequestError,
+  EntityNotFoundError,
+  ForbiddenError,
+  UnauthorizedError,
+} from '../Foundations'
+import { PolicyControlExecution } from './types'
+
+// Response for ListPolicyControlExecutions
+
+export type ListPolicyControlExecutionsSuccess = {
+  items: PolicyControlExecution[]
+}
+
+export type ListPolicyControlExecutionsError = {
+  error:
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ListPolicyControlExecutionsResponse =
+  | ListPolicyControlExecutionsSuccess
+  | ListPolicyControlExecutionsError
+
+// Response for GetPolicyControlExecutionById
+
+export type GetPolicyControlExecutionByIdSuccess = PolicyControlExecution
+
+export type GetPolicyControlExecutionByIdError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type GetPolicyControlExecutionByIdResponse =
+  | GetPolicyControlExecutionByIdSuccess
+  | GetPolicyControlExecutionByIdError
+
+// Response for UpdatePolicyControlExecution
+
+export type UpdatePolicyControlExecutionSuccess = PolicyControlExecution
+
+export type UpdatePolicyControlExecutionError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type UpdatePolicyControlExecutionResponse =
+  | UpdatePolicyControlExecutionSuccess
+  | UpdatePolicyControlExecutionError

package/codegen/datamodel/PolicyExecution/types.ts

@@ -0,0 +1,122 @@
+import {
+  DocumentSnapshot,
+  EntityId,
+  InitiatorKind,
+  IsoDatetime,
+} from '../Foundations'
+import { PolicyActivityKind, PolicyControlKind } from '../PolicyManagement'
+
+/**
+ * @deprecated use the new policy engine instead
+ */
+export type PolicyExecution = {
+  // FIXME: Missing documentation for id
+  id: EntityId
+
+  // FIXME: Missing documentation for kind
+  kind: PolicyActivityKind
+
+  // FIXME: Missing documentation for status
+  status: ExecutionStatus
+
+  // FIXME: Missing documentation for orgId
+  orgId: EntityId
+
+  // FIXME: Missing documentation for dateCreated
+  dateCreated: IsoDatetime
+
+  // FIXME: Missing documentation for initiatorKind
+  initiatorKind: InitiatorKind
+
+  // FIXME: Missing documentation for initiatingEventId
+  initiatingEventId: EntityId
+
+  /**
+   * Applied poliies stored along with PolicyExecution status as-raw-json-string. This ensures that even if somebody tampers with policy, the audit log would have actual-literal representation of what was executed.
+   *
+   */
+  documentedPolicies?: DocumentSnapshot[]
+
+  // FIXME: Missing documentation for documentedActivity
+  documentedActivity: DocumentSnapshot
+
+  // FIXME: Missing documentation for controlExecutions
+  controlExecutions?: PolicyControlExecution[]
+
+  // FIXME: Missing documentation for policyId
+  policyId: EntityId
+}
+
+/**
+ * @deprecated use the new policy engine instead
+ */
+export type PolicyControlExecution = {
+  // FIXME: Missing documentation for id
+  id: EntityId
+
+  // FIXME: Missing documentation for status
+  status: ExecutionStatus
+
+  // FIXME: Missing documentation for controlId
+  controlId: EntityId
+
+  // FIXME: Missing documentation for dateExecuted
+  dateExecuted: IsoDatetime
+
+  // FIXME: Missing documentation for dateFullfiled
+  dateFullfiled?: IsoDatetime
+
+  // FIXME: Missing documentation for policyExecutionId
+  policyExecutionId: EntityId
+
+  // FIXME: Missing documentation for approvals
+  approvals?: string[]
+
+  // FIXME: Missing documentation for documentedActivity
+  documentedActivity: DocumentSnapshot
+
+  // FIXME: Missing documentation for controlKind
+  controlKind: PolicyControlKind
+
+  // FIXME: Missing documentation for author
+  author: EntityId
+
+  // FIXME: Missing documentation for approverUsernames
+  approverUsernames?: string[]
+
+  // FIXME: Missing documentation for activityKind
+  activityKind: PolicyActivityKind
+
+  // FIXME: Missing documentation for numApprovals
+  numApprovals?: number
+
+  // FIXME: Missing documentation for activityId
+  activityId: string
+}
+
+/**
+ * @deprecated use the new policy engine instead
+ */
+export type AppraisableActivity = {}
+
+/**
+ * @deprecated use the new policy engine instead
+ */
+export type UpdatePolicyControlExecutionInput = {
+  // FIXME: Missing documentation for status
+  status: ExecutionStatus
+}
+
+/**
+ * @deprecated use the new policy engine instead
+ */
+export enum ExecutionStatus {
+  // FIXME: Missing documentation for Awaiting
+  Awaiting = 'Awaiting',
+  // FIXME: Missing documentation for Passed
+  Passed = 'Passed',
+  // FIXME: Missing documentation for Failed
+  Failed = 'Failed',
+  // FIXME: Missing documentation for Timedout
+  Timedout = 'Timedout',
+}

package/codegen/datamodel/PolicyManagement/index.ts

@@ -0,0 +1,2 @@
+export * from './responses'
+export * from './types'

package/codegen/datamodel/PolicyManagement/responses.ts

@@ -0,0 +1,255 @@
+import {
+  BadRequestError,
+  EntityNotFoundError,
+  ForbiddenError,
+  UnauthorizedError,
+} from '../Foundations'
+import { Policy, PolicyControl, PolicyRule } from './types'
+
+// Response for CreatePolicy
+
+export type CreatePolicySuccess = Policy
+
+export type CreatePolicyError = {
+  error:
+    | BadRequestError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type CreatePolicyResponse = CreatePolicySuccess | CreatePolicyError
+
+// Response for UpdatePolicy
+
+export type UpdatePolicySuccess = Policy
+
+export type UpdatePolicyError = {
+  error:
+    | BadRequestError
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type UpdatePolicyResponse = UpdatePolicySuccess | UpdatePolicyError
+
+// Response for GetPolicyById
+
+export type GetPolicyByIdSuccess = Policy
+
+export type GetPolicyByIdError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type GetPolicyByIdResponse = GetPolicyByIdSuccess | GetPolicyByIdError
+
+// Response for ListPolicies
+
+export type ListPoliciesSuccess = {
+  items: Policy[]
+}
+
+export type ListPoliciesError = {
+  error:
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ListPoliciesResponse = ListPoliciesSuccess | ListPoliciesError
+
+// Response for ArchivePolicy
+
+export type ArchivePolicySuccess = Policy
+
+export type ArchivePolicyError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ArchivePolicyResponse = ArchivePolicySuccess | ArchivePolicyError
+
+// Response for CreatePolicyControl
+
+export type CreatePolicyControlSuccess = PolicyControl
+
+export type CreatePolicyControlError = {
+  error:
+    | BadRequestError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type CreatePolicyControlResponse =
+  | CreatePolicyControlSuccess
+  | CreatePolicyControlError
+
+// Response for UpdatePolicyControl
+
+export type UpdatePolicyControlSuccess = PolicyControl
+
+export type UpdatePolicyControlError = {
+  error:
+    | BadRequestError
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type UpdatePolicyControlResponse =
+  | UpdatePolicyControlSuccess
+  | UpdatePolicyControlError
+
+// Response for GetPolicyControlById
+
+export type GetPolicyControlByIdSuccess = PolicyControl
+
+export type GetPolicyControlByIdError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type GetPolicyControlByIdResponse =
+  | GetPolicyControlByIdSuccess
+  | GetPolicyControlByIdError
+
+// Response for ListPolicyControls
+
+export type ListPolicyControlsSuccess = {
+  items: PolicyControl[]
+}
+
+export type ListPolicyControlsError = {
+  error:
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ListPolicyControlsResponse =
+  | ListPolicyControlsSuccess
+  | ListPolicyControlsError
+
+// Response for ArchivePolicyControl
+
+export type ArchivePolicyControlSuccess = PolicyControl
+
+export type ArchivePolicyControlError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ArchivePolicyControlResponse =
+  | ArchivePolicyControlSuccess
+  | ArchivePolicyControlError
+
+// Response for CreatePolicyRule
+
+export type CreatePolicyRuleSuccess = PolicyRule
+
+export type CreatePolicyRuleError = {
+  error:
+    | BadRequestError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type CreatePolicyRuleResponse =
+  | CreatePolicyRuleSuccess
+  | CreatePolicyRuleError
+
+// Response for UpdatePolicyRule
+
+export type UpdatePolicyRuleSuccess = PolicyRule
+
+export type UpdatePolicyRuleError = {
+  error:
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type UpdatePolicyRuleResponse =
+  | UpdatePolicyRuleSuccess
+  | UpdatePolicyRuleError
+
+// Response for GetPolicyRuleById
+
+export type GetPolicyRuleByIdSuccess = PolicyRule
+
+export type GetPolicyRuleByIdError = {
+  error:
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type GetPolicyRuleByIdResponse =
+  | GetPolicyRuleByIdSuccess
+  | GetPolicyRuleByIdError
+
+// Response for ListPolicyRules
+
+export type ListPolicyRulesSuccess = {
+  items: PolicyRule[]
+}
+
+export type ListPolicyRulesError = {
+  error:
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ListPolicyRulesResponse =
+  | ListPolicyRulesSuccess
+  | ListPolicyRulesError
+
+// Response for ArchivePolicyRule
+
+export type ArchivePolicyRuleSuccess = PolicyRule
+
+export type ArchivePolicyRuleError = {
+  error:
+    | EntityNotFoundError
+    | UnauthorizedError
+    | ForbiddenError
+    | BadRequestError
+    | EntityNotFoundError
+}
+
+export type ArchivePolicyRuleResponse =
+  | ArchivePolicyRuleSuccess
+  | ArchivePolicyRuleError