enterprisemanagementv1

type Account struct {
	// The URL of the account.
	URL *string `json:"url,omitempty"`

	// The account ID.
	ID *string `json:"id,omitempty"`

	// The Cloud Resource Name (CRN) of the account.
	CRN *string `json:"crn,omitempty"`

	// The CRN of the parent of the account.
	Parent *string `json:"parent,omitempty"`

	// The enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// The enterprise ID that the account is a part of.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The path from the enterprise to this particular account.
	EnterprisePath *string `json:"enterprise_path,omitempty"`

	// The name of the account.
	Name *string `json:"name,omitempty"`

	// The state of the account.
	State *string `json:"state,omitempty"`

	// The IAM ID of the owner of the account.
	OwnerIamID *string `json:"owner_iam_id,omitempty"`

	// The type of account - whether it is free or paid.
	Paid *bool `json:"paid,omitempty"`

	// The email address of the owner of the account.
	OwnerEmail *string `json:"owner_email,omitempty"`

	// The flag to indicate whether the account is an enterprise account or not.
	IsEnterpriseAccount *bool `json:"is_enterprise_account,omitempty"`

	// The time stamp at which the account was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The IAM ID of the user or service that created the account.
	CreatedBy *string `json:"created_by,omitempty"`

	// The time stamp at which the account was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The IAM ID of the user or service that updated the account.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

type AccountGroup struct {
	// The URL of the account group.
	URL *string `json:"url,omitempty"`

	// The account group ID.
	ID *string `json:"id,omitempty"`

	// The Cloud Resource Name (CRN) of the account group.
	CRN *string `json:"crn,omitempty"`

	// The CRN of the parent of the account group.
	Parent *string `json:"parent,omitempty"`

	// The enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// The enterprise ID that the account group is a part of.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The path from the enterprise to this particular account group.
	EnterprisePath *string `json:"enterprise_path,omitempty"`

	// The name of the account group.
	Name *string `json:"name,omitempty"`

	// The state of the account group.
	State *string `json:"state,omitempty"`

	// The IAM ID of the primary contact of the account group.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// The email address of the primary contact of the account group.
	PrimaryContactEmail *string `json:"primary_contact_email,omitempty"`

	// The time stamp at which the account group was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The IAM ID of the user or service that created the account group.
	CreatedBy *string `json:"created_by,omitempty"`

	// The time stamp at which the account group was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The IAM ID of the user or service that updated the account group.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

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

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

type CreateAccountGroupOptions struct {
	// The CRN of the parent under which the account group will be created. The parent can be an existing account group or
	// the enterprise itself.
	Parent *string `json:"parent" validate:"required"`

	// The name of the account group. This field must have 3 - 60 characters.
	Name *string `json:"name" validate:"required"`

	// The IAM ID of the primary contact for this account group, such as `IBMid-0123ABC`. The IAM ID must already exist.
	PrimaryContactIamID *string `json:"primary_contact_iam_id" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type CreateAccountGroupResponse struct {
	// The ID of the account group entity that was created.
	AccountGroupID *string `json:"account_group_id,omitempty"`
}

type CreateAccountOptions struct {
	// The CRN of the parent under which the account will be created. The parent can be an existing account group or the
	// enterprise itself.
	Parent *string `json:"parent" validate:"required"`

	// The name of the account. This field must have 3 - 60 characters.
	Name *string `json:"name" validate:"required"`

	// The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist.
	OwnerIamID *string `json:"owner_iam_id" validate:"required"`

	// The traits object can be used to set properties on child accounts of an enterprise. You can pass a field to opt-out
	// of the default multi-factor authentication setting or enable enterprise-managed IAM when creating a child account in
	// the enterprise. This is an optional field.
	Traits *CreateAccountRequestTraits `json:"traits,omitempty"`

	// The options object can be used to set properties on child accounts of an enterprise. You can pass a field to to
	// create IAM service id with IAM api key when creating a child account in the enterprise. This is an optional field.
	Options *CreateAccountRequestOptions `json:"options,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type CreateAccountRequestOptions struct {
	// By default create_iam_service_id_with_apikey_and_owner_policies is turned off for a newly created child account. You
	// can enable this property by passing 'true' in this boolean field. IAM service id has account owner IAM policies and
	// the API key associated with it can generate a token and setup resources in the account. This is an optional field.
	CreateIamServiceIDWithApikeyAndOwnerPolicies *bool `json:"create_iam_service_id_with_apikey_and_owner_policies,omitempty"`
}

type CreateAccountRequestTraits struct {
	// By default MFA is set to `NONE_NO_ROPC` on a child account, which disables CLI logins with only a password. To opt
	// out, pass the traits object with the mfa field set to empty string. This is an optional field.
	Mfa *string `json:"mfa,omitempty"`

	// By default enterprise-managed IAM is turned off for a newly created child account. You can enable this property by
	// passing 'true' in this boolean field. Enabling enterprise-managed IAM allows the enterprise account to assign IAM
	// resources, like access groups, trusted profiles, and account settings, to the child account. This is an optional
	// field.
	EnterpriseIamManaged *bool `json:"enterprise_iam_managed,omitempty"`
}

type CreateAccountResponse struct {
	// The ID of the account entity that was created.
	AccountID *string `json:"account_id,omitempty"`

	// The iam_service_id of the account entity that was created.
	IamServiceID *string `json:"iam_service_id,omitempty"`

	// The iam_apikey_id of the account entity that was created.
	IamApikeyID *string `json:"iam_apikey_id,omitempty"`

	// The iam_apikey of the account entity with owner iam policies that was created.
	IamApikey *string `json:"iam_apikey,omitempty"`
}

type CreateEnterpriseOptions struct {
	// The ID of the account that is used to create the enterprise.
	SourceAccountID *string `json:"source_account_id" validate:"required"`

	// The name of the enterprise. This field must have 3 - 60 characters.
	Name *string `json:"name" validate:"required"`

	// The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist.
	PrimaryContactIamID *string `json:"primary_contact_iam_id" validate:"required"`

	// A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`.
	Domain *string `json:"domain,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type CreateEnterpriseResponse struct {
	// The ID of the enterprise entity that was created. This entity is the root of the hierarchy.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The ID of the enterprise account that was created. The enterprise account is used to manage billing and access to
	// the enterprise management.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`
}

type DeleteAccountGroupOptions struct {
	// The ID of the account group to retrieve.
	AccountGroupID *string `json:"account_group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteAccountOptions struct {
	// The ID of the target account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Enterprise struct {
	// The URL of the enterprise.
	URL *string `json:"url,omitempty"`

	// The enterprise ID.
	ID *string `json:"id,omitempty"`

	// The enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// The Cloud Resource Name (CRN) of the enterprise.
	CRN *string `json:"crn,omitempty"`

	// The name of the enterprise.
	Name *string `json:"name,omitempty"`

	// The domain of the enterprise.
	Domain *string `json:"domain,omitempty"`

	// The state of the enterprise.
	State *string `json:"state,omitempty"`

	// The IAM ID of the primary contact of the enterprise, such as `IBMid-0123ABC`.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// The email of the primary contact of the enterprise.
	PrimaryContactEmail *string `json:"primary_contact_email,omitempty"`

	// The ID of the account that is used to create the enterprise.
	SourceAccountID *string `json:"source_account_id,omitempty"`

	// The time stamp at which the enterprise was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The IAM ID of the user or service that created the enterprise.
	CreatedBy *string `json:"created_by,omitempty"`

	// The time stamp at which the enterprise was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The IAM ID of the user or service that updated the enterprise.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

type EnterpriseManagementV1 struct {
	Service *core.BaseService
}

type EnterpriseManagementV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

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

type GetAccountGroupOptions struct {
	// The ID of the account group to retrieve.
	AccountGroupID *string `json:"account_group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetAccountOptions struct {
	// The ID of the target account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetEnterpriseOptions struct {
	// The ID of the enterprise to retrieve.
	EnterpriseID *string `json:"enterprise_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ImportAccountToEnterpriseOptions struct {
	// The ID of the enterprise to import the stand-alone account into.
	EnterpriseID *string `json:"enterprise_id" validate:"required,ne="`

	// The ID of the existing stand-alone account to be imported.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The CRN of the expected parent of the imported account. The parent is the enterprise or account group that the
	// account is added to.
	Parent *string `json:"parent,omitempty"`

	// The ID of the [billing unit](/apidocs/enterprise-apis/billing-unit) to use for billing this account in the
	// enterprise.
	BillingUnitID *string `json:"billing_unit_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListAccountGroupsOptions struct {
	// Get account groups that are either immediate children or are a part of the hierarchy for a given enterprise ID.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// Get account groups that are either immediate children or are a part of the hierarchy for a given account group ID.
	ParentAccountGroupID *string `json:"parent_account_group_id,omitempty"`

	// The first item to be returned in the page of results. This value can be obtained from the next_url property from the
	// previous call of the operation. If not specified, then the first page of results is returned.
	NextDocid *string `json:"next_docid,omitempty"`

	// Get account groups that are either immediate children or are a part of the hierarchy for a given parent CRN.
	Parent *string `json:"parent,omitempty"`

	// Return results up to this limit. Valid values are between `0` and `100`.
	Limit *int64 `json:"limit,omitempty"`

	// Include the deleted account groups from an enterprise when used in conjunction with other query parameters.
	IncludeDeleted *bool `json:"include_deleted,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListAccountGroupsResponse struct {
	// The number of enterprises returned from calling list account groups.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A string that represents the link to the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// A list of account groups.
	Resources []AccountGroup `json:"resources,omitempty"`
}

type ListAccountsOptions struct {
	// Get accounts that are either immediate children or are a part of the hierarchy for a given enterprise ID.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// Get accounts that are either immediate children or are a part of the hierarchy for a given account group ID.
	AccountGroupID *string `json:"account_group_id,omitempty"`

	// The first item to be returned in the page of results. This value can be obtained from the next_url property from the
	// previous call of the operation. If not specified, then the first page of results is returned.
	NextDocid *string `json:"next_docid,omitempty"`

	// Get accounts that are either immediate children or are a part of the hierarchy for a given parent CRN.
	Parent *string `json:"parent,omitempty"`

	// Return results up to this limit. Valid values are between `0` and `100`.
	Limit *int64 `json:"limit,omitempty"`

	// Include the deleted accounts from an enterprise when used in conjunction with enterprise_id.
	IncludeDeleted *bool `json:"include_deleted,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListAccountsResponse struct {
	// The number of enterprises returned from calling list accounts.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A string that represents the link to the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// A list of accounts.
	Resources []Account `json:"resources,omitempty"`
}

type ListEnterprisesOptions struct {
	// Get enterprises for a given enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// Get enterprises for a given account group ID.
	AccountGroupID *string `json:"account_group_id,omitempty"`

	// Get enterprises for a given account ID.
	AccountID *string `json:"account_id,omitempty"`

	// The first item to be returned in the page of results. This value can be obtained from the next_url property from the
	// previous call of the operation. If not specified, then the first page of results is returned.
	NextDocid *string `json:"next_docid,omitempty"`

	// Return results up to this limit. Valid values are between `0` and `100`.
	Limit *int64 `json:"limit,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListEnterprisesResponse struct {
	// The number of enterprises returned from calling list enterprise.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A string that represents the link to the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// A list of enterprise objects.
	Resources []Enterprise `json:"resources,omitempty"`
}

type UpdateAccountGroupOptions struct {
	// The ID of the account group to retrieve.
	AccountGroupID *string `json:"account_group_id" validate:"required,ne="`

	// The new name of the account group. This field must have 3 - 60 characters.
	Name *string `json:"name,omitempty"`

	// The IAM ID of the user to be the new primary contact for the account group.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type UpdateAccountOptions struct {
	// The ID of the target account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The CRN of the new parent within the enterprise.
	Parent *string `json:"parent" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type UpdateEnterpriseOptions struct {
	// The ID of the enterprise to retrieve.
	EnterpriseID *string `json:"enterprise_id" validate:"required,ne="`

	// The new name of the enterprise. This field must have 3 - 60 characters.
	Name *string `json:"name,omitempty"`

	// The new domain of the enterprise. This field has a limit of 60 characters.
	Domain *string `json:"domain,omitempty"`

	// The IAM ID of the user to be the new primary contact for the enterprise.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}