workmail

type AccessControlRule struct {
	DateCreated  time.Time
	DateModified time.Time
	Name         string
	Effect       string
	Description  string

	IPRanges    []string
	NotIPRanges []string
	Actions     []string
	NotActions  []string
	UserIDs     []string
	NotUserIDs  []string
	// ImpersonationRoleIDs/NotImpersonationRoleIDs mirror
	// types.AccessControlRule's ImpersonationRoleIds/NotImpersonationRoleIds,
	// added to the real API after impersonation roles shipped.
	ImpersonationRoleIDs    []string
	NotImpersonationRoleIDs []string
	// contains filtered or unexported fields
}

type AvailabilityConfiguration struct {
	DateCreated  time.Time
	DateModified time.Time
	DomainName   string
	ProviderType string
	EwsEndpoint  string
	EwsUsername  string
	LambdaARN    string
	// contains filtered or unexported fields
}

type AvailabilityEwsProvider struct {
	EwsEndpoint string
	EwsUsername string
	EwsPassword string
}

type CreateUserParams struct {
	DisplayName                 string
	Password                    string
	Role                        string
	FirstName                   string
	LastName                    string
	IdentityProviderUserID      string
	HiddenFromGlobalAddressList bool
}

type DNSRecord struct {
	Hostname string
	Type     string
	Value    string
}

type Delegate struct {
	DelegateID   string
	DelegateType string
}

type EmailMonitoringConfiguration struct {
	RoleARN     string
	LogGroupARN string
	// contains filtered or unexported fields
}

type EntityDescription struct {
	EntityID string
	Name     string
	Type     string
	State    string
}

type FolderConfiguration struct {
	Period *int32
	Name   string
	Action string
}

type Group struct {
	CreatedAt    time.Time
	EnabledDate  time.Time
	DisabledDate time.Time
	GroupID      string
	Name         string
	Email        string
	State        string
	ARN          string

	Hidden bool
	// contains filtered or unexported fields
}

type GroupFilter struct {
	NamePrefix         string
	PrimaryEmailPrefix string
	State              string
}

type GroupSummary struct {
	GroupID string
	Name    string
	Email   string
	State   string
}

type Handler struct {
	Backend StorageBackend
	// contains filtered or unexported fields
}

type IdentityProviderConfiguration struct {
	PATLifetimeDays           *int32
	AuthMode                  string
	IdentityCenterAppARN      string
	IdentityCenterInstanceARN string
	PATStatus                 string
	// contains filtered or unexported fields
}

type ImpersonationMatchedRule struct {
	RuleID string
	Name   string
}

type ImpersonationRole struct {
	DateCreated  time.Time
	DateModified time.Time
	RoleID       string
	Name         string
	RoleType     string
	Description  string

	Rules []ImpersonationRule
	// contains filtered or unexported fields
}

type ImpersonationRule struct {
	RuleID         string
	Name           string
	Description    string
	Effect         string
	TargetUsers    []string
	NotTargetUsers []string
}

type InMemoryBackend struct {
	// contains filtered or unexported fields
}

type MailDomain struct {
	DomainName                  string
	OwnershipVerificationStatus string
	MxRecord                    string
	// DkimVerificationStatus mirrors GetMailDomainOutput.DkimVerificationStatus
	// (types.DnsRecordVerificationStatus: PENDING/VERIFIED/FAILED).
	DkimVerificationStatus string

	Records      []DNSRecord
	IsDefault    bool
	IsTestDomain bool
	// contains filtered or unexported fields
}

type MailDomainSummary struct {
	DomainName   string
	IsDefault    bool
	IsTestDomain bool
}

type MailboxDetails struct {
	MailboxQuota int32
	MailboxSize  float64
}

type MailboxExportJob struct {
	StartTime    time.Time
	EndTime      time.Time
	S3Prefix     string
	RoleARN      string
	KmsKeyARN    string
	S3BucketName string
	JobID        string
	S3Path       string
	State        string
	ErrorInfo    string
	Description  string
	EntityID     string

	EstimatedProgress int32
	// contains filtered or unexported fields
}

type Member struct {
	EnabledDate  time.Time
	DisabledDate time.Time
	MemberID     string
	Name         string
	State        string
	MemberType   string
}

type MobileDeviceAccessOverride struct {
	DateCreated  time.Time
	DateModified time.Time
	UserID       string
	DeviceID     string
	Effect       string
	Description  string
	// contains filtered or unexported fields
}

type MobileDeviceAccessRule struct {
	DateModified time.Time
	DateCreated  time.Time

	RuleID                    string
	Name                      string
	Effect                    string
	Description               string
	DeviceModels              []string
	DeviceTypes               []string
	NotDeviceTypes            []string
	DeviceOperatingSystems    []string
	NotDeviceOperatingSystems []string
	DeviceUserAgents          []string
	NotDeviceUserAgents       []string
	NotDeviceModels           []string
	// contains filtered or unexported fields
}

type MobileDeviceMatchedRule struct {
	RuleID string
	Name   string
}

type OrgSummary struct {
	OrgID             string
	Alias             string
	DefaultMailDomain string
	State             string
	ErrorMessage      string
}

type Organization struct {
	CreatedAt         time.Time
	CompletedDate     time.Time
	OrgID             string
	Alias             string
	ARN               string
	State             string
	DirectoryID       string
	DirectoryType     string
	DefaultMailDomain string
	ErrorMessage      string
	Region            string
	// MigrationAdmin mirrors DescribeOrganizationOutput.MigrationAdmin. The
	// real WorkMail API exposes no operation (in this SDK's surface) that
	// ever sets it -- it is populated out-of-band by an Exchange
	// interoperability/migration flow this backend does not simulate -- so
	// it is always empty here, which correctly matches every organization
	// that never configured migration.
	MigrationAdmin string
}

type Permission struct {
	GranteeID   string
	GranteeType string

	Permissions []string
	// contains filtered or unexported fields
}

type PersonalAccessToken struct {
	DateCreated  time.Time
	DateLastUsed time.Time
	ExpiresTime  time.Time
	TokenID      string
	UserID       string
	Name         string

	Scopes []string
	// contains filtered or unexported fields
}

type Provider struct{}

type PutAccessControlRuleParams struct {
	Name                    string
	Effect                  string
	Description             string
	IPRanges                []string
	NotIPRanges             []string
	Actions                 []string
	NotActions              []string
	UserIDs                 []string
	NotUserIDs              []string
	ImpersonationRoleIDs    []string
	NotImpersonationRoleIDs []string
}

type Resource struct {
	CreatedAt    time.Time
	EnabledDate  time.Time
	DisabledDate time.Time
	ResourceID   string
	Name         string
	Email        string
	ResourceType string
	Description  string
	State        string
	ARN          string
	// contains filtered or unexported fields
}

type ResourceFilter struct {
	NamePrefix         string
	PrimaryEmailPrefix string
	State              string
}

type ResourceSummary struct {
	ResourceID   string
	Name         string
	Email        string
	ResourceType string
	State        string
	Description  string
}

type RetentionPolicy struct {
	ID          string
	Name        string
	Description string

	FolderConfigurations []*FolderConfiguration
	// contains filtered or unexported fields
}

type StorageBackend interface {
	// Organizations
	CreateOrganization(ctx context.Context, alias string, domains []string) (*Organization, error)
	DescribeOrganization(orgID string) (*Organization, error)
	DeleteOrganization(orgID string, deleteDirectory bool) error
	ListOrganizations(ctx context.Context, maxResults int32, nextToken string) ([]*OrgSummary, string, error)

	// Users
	CreateUser(orgID, name string, params CreateUserParams) (*User, error)
	DescribeUser(orgID, entityID string) (*User, error)
	UpdateUser(orgID, entityID string, params UpdateUserParams) error
	DeleteUser(orgID, entityID string) error
	ListUsers(orgID string, filter *UserFilter, maxResults int32, nextToken string) ([]*UserSummary, string, error)
	RegisterToWorkMail(orgID, entityID, email string) error
	DeregisterFromWorkMail(orgID, entityID string) error
	ResetPassword(orgID, userID, password string) error
	GetMailboxDetails(orgID, userID string) (*MailboxDetails, error)
	UpdateMailboxQuota(orgID, userID string, quota int32) error
	UpdatePrimaryEmailAddress(orgID, entityID, email string) error

	// Groups
	CreateGroup(orgID, name string, hidden bool) (*Group, error)
	DescribeGroup(orgID, entityID string) (*Group, error)
	UpdateGroup(orgID, entityID string, hidden bool) error
	DeleteGroup(orgID, entityID string) error
	ListGroups(
		orgID string, filter *GroupFilter, maxResults int32, nextToken string,
	) ([]*GroupSummary, string, error)
	AssociateMemberToGroup(orgID, groupID, memberID string) error
	DisassociateMemberFromGroup(orgID, groupID, memberID string) error
	ListGroupMembers(orgID, groupID string, maxResults int32, nextToken string) ([]*Member, string, error)
	ListGroupsForEntity(
		orgID, entityID, groupNamePrefix string, maxResults int32, nextToken string,
	) ([]*GroupSummary, string, error)

	// Resources
	CreateResource(orgID, name, resourceType, description string) (*Resource, error)
	DescribeResource(orgID, entityID string) (*Resource, error)
	UpdateResource(orgID, entityID, name, description string) error
	DeleteResource(orgID, entityID string) error
	ListResources(
		orgID string, filter *ResourceFilter, maxResults int32, nextToken string,
	) ([]*ResourceSummary, string, error)
	AssociateDelegateToResource(orgID, resourceID, entityID string) error
	DisassociateDelegateFromResource(orgID, resourceID, entityID string) error
	ListResourceDelegates(orgID, resourceID string, maxResults int32, nextToken string) ([]*Delegate, string, error)

	// Aliases
	CreateAlias(orgID, entityID, alias string) error
	DeleteAlias(orgID, entityID, alias string) error
	ListAliases(orgID, entityID string, maxResults int32, nextToken string) ([]string, string, error)

	// Mailbox permissions
	PutMailboxPermissions(orgID, entityID, granteeID string, perms []string) error
	DeleteMailboxPermissions(orgID, entityID, granteeID string) error
	ListMailboxPermissions(orgID, entityID string, maxResults int32, nextToken string) ([]*Permission, string, error)

	// Mail domains
	RegisterMailDomain(orgID, domainName string) error
	DeregisterMailDomain(orgID, domainName string) error
	GetMailDomain(orgID, domainName string) (*MailDomain, error)
	ListMailDomains(orgID string, maxResults int32, nextToken string) ([]*MailDomainSummary, string, error)
	UpdateDefaultMailDomain(orgID, domainName string) error

	// Access control rules
	PutAccessControlRule(orgID string, params PutAccessControlRuleParams) (*AccessControlRule, error)
	DeleteAccessControlRule(orgID, name string) error
	GetAccessControlEffect(
		orgID, ipAddr, action, userID, impersonationRoleID string,
	) (string, []string, error)
	ListAccessControlRules(orgID string) ([]*AccessControlRule, error)

	// Impersonation roles
	CreateImpersonationRole(
		orgID, name, roleType, description string,
		rules []ImpersonationRule,
	) (*ImpersonationRole, error)
	GetImpersonationRole(orgID, roleID string) (*ImpersonationRole, error)
	UpdateImpersonationRole(orgID, roleID, name, roleType, description string, rules []ImpersonationRule) error
	DeleteImpersonationRole(orgID, roleID string) error
	ListImpersonationRoles(orgID string, maxResults int32, nextToken string) ([]*ImpersonationRole, string, error)

	// Tags
	TagResource(resourceARN string, tags []Tag) error
	UntagResource(resourceARN string, tagKeys []string) error
	ListTagsForResource(resourceARN string) ([]Tag, error)

	// Describe entity (user, group, or resource by email or ID)
	DescribeEntity(orgID, email string) (*EntityDescription, error)

	// Availability configurations
	CreateAvailabilityConfiguration(
		orgID, domainName string,
		ewsProvider *AvailabilityEwsProvider,
		lambdaARN string,
	) (*AvailabilityConfiguration, error)
	DeleteAvailabilityConfiguration(orgID, domainName string) error
	UpdateAvailabilityConfiguration(
		orgID, domainName string,
		ewsProvider *AvailabilityEwsProvider,
		lambdaARN string,
	) error
	ListAvailabilityConfigurations(
		orgID string,
		maxResults int32,
		nextToken string,
	) ([]*AvailabilityConfiguration, string, error)
	TestAvailabilityConfiguration(orgID, domainName string) (bool, string, error)

	// Mobile device access rules
	CreateMobileDeviceAccessRule(orgID, name, effect, description string,
		deviceModels, notDeviceModels, deviceTypes, notDeviceTypes,
		deviceOperatingSystems, notDeviceOperatingSystems, deviceUserAgents, notDeviceUserAgents []string,
	) (*MobileDeviceAccessRule, error)
	DeleteMobileDeviceAccessRule(orgID, ruleID string) error
	UpdateMobileDeviceAccessRule(orgID, ruleID, name, effect, description string,
		deviceModels, notDeviceModels, deviceTypes, notDeviceTypes,
		deviceOperatingSystems, notDeviceOperatingSystems, deviceUserAgents, notDeviceUserAgents []string,
	) error
	ListMobileDeviceAccessRules(orgID string) ([]*MobileDeviceAccessRule, error)
	GetMobileDeviceAccessEffect(
		orgID, deviceType, deviceModel, deviceOS, deviceUserAgent string,
	) (string, []*MobileDeviceMatchedRule, error)

	// Mobile device access overrides
	PutMobileDeviceAccessOverride(orgID, userID, deviceID, effect, description string) error
	DeleteMobileDeviceAccessOverride(orgID, userID, deviceID string) error
	GetMobileDeviceAccessOverride(orgID, userID, deviceID string) (*MobileDeviceAccessOverride, error)
	ListMobileDeviceAccessOverrides(
		orgID, userID, deviceID string,
		maxResults int32,
		nextToken string,
	) ([]*MobileDeviceAccessOverride, string, error)

	// Email monitoring configuration
	PutEmailMonitoringConfiguration(orgID, roleARN, logGroupARN string) error
	DeleteEmailMonitoringConfiguration(orgID string) error
	DescribeEmailMonitoringConfiguration(orgID string) (*EmailMonitoringConfiguration, error)

	// Inbound DMARC settings
	PutInboundDmarcSettings(orgID string, enforced bool) error
	DescribeInboundDmarcSettings(orgID string) (bool, error)

	// Retention policies
	PutRetentionPolicy(orgID, id, name, description string, folderConfigurations []*FolderConfiguration) error
	DeleteRetentionPolicy(orgID, id string) error
	GetDefaultRetentionPolicy(orgID string) (*RetentionPolicy, error)

	// Mailbox export jobs
	StartMailboxExportJob(
		orgID, entityID, description, roleARN, kmsKeyARN, s3BucketName, s3Prefix string,
	) (*MailboxExportJob, error)
	CancelMailboxExportJob(orgID, jobID string) error
	DescribeMailboxExportJob(orgID, jobID string) (*MailboxExportJob, error)
	ListMailboxExportJobs(orgID string, maxResults int32, nextToken string) ([]*MailboxExportJob, string, error)

	// Identity center applications
	CreateIdentityCenterApplication(instanceARN, name string) (string, error)
	DeleteIdentityCenterApplication(applicationARN string) error

	// Identity provider configuration
	PutIdentityProviderConfiguration(
		orgID, authMode string,
		identityCenterAppARN, identityCenterInstanceARN, patStatus string,
		patLifetimeDays int32,
	) error
	DeleteIdentityProviderConfiguration(orgID string) error
	DescribeIdentityProviderConfiguration(orgID string) (*IdentityProviderConfiguration, error)

	// Personal access tokens
	DeletePersonalAccessToken(orgID, tokenID string) error
	GetPersonalAccessTokenMetadata(orgID, tokenID string) (*PersonalAccessToken, error)
	ListPersonalAccessTokens(
		orgID, userID string,
		maxResults int32,
		nextToken string,
	) ([]*PersonalAccessToken, string, error)

	// Impersonation role effect
	GetImpersonationRoleEffect(orgID, roleID, targetUser string) (string, string, []*ImpersonationMatchedRule, error)

	// Assume impersonation role
	AssumeImpersonationRole(orgID, roleID string) (string, int64, error)

	AccountID() string
	Region() string
	Reset()

	// Snapshot and Restore implement persistence.Persistable. Handler
	// delegates to them (see persistence.go) so cli.go's generic
	// setupPersistence picks WorkMail up.
	Snapshot(ctx context.Context) []byte
	Restore(ctx context.Context, data []byte) error
}

type Tag struct {
	Key   string
	Value string
}

type UpdateUserParams struct {
	HiddenFromGlobalAddressList *bool
	JobTitle                    string
	Telephone                   string
	City                        string
	Company                     string
	Country                     string
	Department                  string
	LastName                    string
	Office                      string
	Initials                    string
	Street                      string
	DisplayName                 string
	ZipCode                     string
	IdentityProviderUserID      string
	Role                        string
	FirstName                   string
}

type User struct {
	CreatedAt    time.Time
	EnabledDate  time.Time
	DisabledDate time.Time
	// MailboxProvisionedDate/MailboxDeprovisionedDate mirror
	// DescribeUserOutput's fields of the same name. Real WorkMail sets these
	// alongside EnabledDate/DisabledDate when the mailbox itself is
	// created/removed (RegisterToWorkMail/DeregisterFromWorkMail), so this
	// backend mirrors EnabledDate/DisabledDate at those same call sites (see
	// RegisterToWorkMail/DeregisterFromWorkMail in users.go).
	MailboxProvisionedDate   time.Time
	MailboxDeprovisionedDate time.Time
	UserID                   string
	Name                     string
	Email                    string
	DisplayName              string
	FirstName                string
	LastName                 string
	Role                     string
	State                    string
	ARN                      string
	// The following mirror DescribeUserOutput's/UpdateUserInput's optional
	// profile fields -- none affect entity identity or state transitions,
	// they are plain profile metadata settable via CreateUser/UpdateUser and
	// surfaced via DescribeUser.
	City                            string
	Company                         string
	Country                         string
	Department                      string
	Initials                        string
	JobTitle                        string
	Office                          string
	Street                          string
	Telephone                       string
	ZipCode                         string
	IdentityProviderIdentityStoreID string
	IdentityProviderUserID          string

	HiddenFromGlobalAddressList bool
	// contains filtered or unexported fields
}

type UserFilter struct {
	DisplayNamePrefix            string
	PrimaryEmailPrefix           string
	State                        string
	UsernamePrefix               string
	IdentityProviderUserIDPrefix string
}

type UserSummary struct {
	UserID      string
	Name        string
	Email       string
	DisplayName string
	State       string
	Role        string
}