accountmanagement

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

• Constants
• type AccountManagementCreateAccountQueryResponse
• type AccountManagementCreateInput
• type AccountManagementCreateResponse
• type AccountManagementManagedAccount
• type AccountManagementOrganizationStitchedFields
• type AccountManagementUpdateAccountQueryResponse
• type AccountManagementUpdateInput
• type AccountManagementUpdateResponse
• type Accountmanagement
  • func New(config config.Config) Accountmanagement
  • func (a *Accountmanagement) AccountManagementCreateAccount(managedAccount AccountManagementCreateInput) (*AccountManagementCreateResponse, error)
  • func (a *Accountmanagement) AccountManagementCreateAccountWithContext(ctx context.Context, managedAccount AccountManagementCreateInput) (*AccountManagementCreateResponse, error)
  • func (a *Accountmanagement) AccountManagementUpdateAccount(managedAccount AccountManagementUpdateInput) (*AccountManagementUpdateResponse, error)
  • func (a *Accountmanagement) AccountManagementUpdateAccountWithContext(ctx context.Context, managedAccount AccountManagementUpdateInput) (*AccountManagementUpdateResponse, error)
  • func (a *Accountmanagement) GetManagedAccounts() (*[]AccountManagementManagedAccount, error)
  • func (a *Accountmanagement) GetManagedAccountsWithContext(ctx context.Context) (*[]AccountManagementManagedAccount, error)
• type Actor
• type Organization

Constants

const AccountManagementCreateAccountMutation = `` /* 182-byte string literal not displayed */

const AccountManagementUpdateAccountMutation = `` /* 182-byte string literal not displayed */

Types

type AccountManagementCreateAccountQueryResponse

type AccountManagementCreateAccountQueryResponse struct {
	AccountManagementCreateResponse AccountManagementCreateResponse `json:"AccountManagementCreateAccount"`
}

type AccountManagementCreateInput

type AccountManagementCreateInput struct {
	// The name of the account.
	Name string `json:"name"`
	// The data center region for the account
	RegionCode string `json:"regionCode,omitempty"`
}

AccountManagementCreateInput - Attributes for creating an account.

type AccountManagementCreateResponse

type AccountManagementCreateResponse struct {
	// Information about the newly created account.
	ManagedAccount AccountManagementManagedAccount `json:"managedAccount,omitempty"`
}

AccountManagementCreateResponse - The return object for a create-account mutation.

type AccountManagementManagedAccount

type AccountManagementManagedAccount struct {
	// The account ID.
	ID int `json:"id"`
	// The name of the account.
	Name string `json:"name"`
	// The data center region for the account (US or EU).
	RegionCode string `json:"regionCode"`
}

AccountManagementManagedAccount - Account data view for administration tasks.

type AccountManagementOrganizationStitchedFields

type AccountManagementOrganizationStitchedFields struct {
	// Admin-level info about the accounts in an organization.
	ManagedAccounts []AccountManagementManagedAccount `json:"managedAccounts"`
}

AccountManagementOrganizationStitchedFields - The field type for stitching into the NerdGraph schema.

type AccountManagementUpdateAccountQueryResponse

type AccountManagementUpdateAccountQueryResponse struct {
	AccountManagementUpdateResponse AccountManagementUpdateResponse `json:"AccountManagementUpdateAccount"`
}

type AccountManagementUpdateInput

type AccountManagementUpdateInput struct {
	// The ID for the account being updated.
	ID int `json:"id"`
	// The new account name.
	Name string `json:"name"`
}

AccountManagementUpdateInput - The attributes for updating an account.

type AccountManagementUpdateResponse

type AccountManagementUpdateResponse struct {
	// Information about an updated account
	ManagedAccount AccountManagementManagedAccount `json:"managedAccount,omitempty"`
}

AccountManagementUpdateResponse - The return object for an update-account mutation.

type Accountmanagement

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

func New

func New(config config.Config) Accountmanagement

New is used to create a new Account Management.

func (*Accountmanagement) AccountManagementCreateAccount

func (a *Accountmanagement) AccountManagementCreateAccount(
	managedAccount AccountManagementCreateInput,
) (*AccountManagementCreateResponse, error)

Creates an organization-scoped account.

func (*Accountmanagement) AccountManagementCreateAccountWithContext

func (a *Accountmanagement) AccountManagementCreateAccountWithContext(
	ctx context.Context,
	managedAccount AccountManagementCreateInput,
) (*AccountManagementCreateResponse, error)

Creates an organization-scoped account.

func (*Accountmanagement) AccountManagementUpdateAccount

func (a *Accountmanagement) AccountManagementUpdateAccount(
	managedAccount AccountManagementUpdateInput,
) (*AccountManagementUpdateResponse, error)

Updates an account.

func (*Accountmanagement) AccountManagementUpdateAccountWithContext

func (a *Accountmanagement) AccountManagementUpdateAccountWithContext(
	ctx context.Context,
	managedAccount AccountManagementUpdateInput,
) (*AccountManagementUpdateResponse, error)

Updates an account.

func (*Accountmanagement) GetManagedAccounts

func (a *Accountmanagement) GetManagedAccounts() (*[]AccountManagementManagedAccount, error)

Admin-level info about the accounts in an organization.

func (*Accountmanagement) GetManagedAccountsWithContext

func (a *Accountmanagement) GetManagedAccountsWithContext(
	ctx context.Context,
) (*[]AccountManagementManagedAccount, error)

Admin-level info about the accounts in an organization.

type Actor

type Actor struct {
	// The `organization` field is the entry point into data that is scoped to the user's organization.
	Organization Organization `json:"organization,omitempty"`
}

Actor - The `Actor` object contains fields that are scoped to the API user's access level.

type Organization

type Organization struct {
	// This field provides access to AccountManagement data.
	AccountManagement AccountManagementOrganizationStitchedFields `json:"accountManagement,omitempty"`
	// The customer id for the organization.
	CustomerId string `json:"customerId,omitempty"`
	// The name of the organization.
	Name string `json:"name,omitempty"`
	// The telemetry id for the organization
	TelemetryId string `json:"telemetryId,omitempty"`
}

Organization - The `Organization` object provides basic data about an organization.