consoleql

Documentation

Index

• Constants
• func CreateSchema(log *zap.Logger, service *console.Service, mailService *mailservice.Service) (schema graphql.Schema, err error)
• type AccountActivationEmail
  • func (*AccountActivationEmail) Subject() string
  • func (*AccountActivationEmail) Template() string
• type ForgotPasswordEmail
  • func (*ForgotPasswordEmail) Subject() string
  • func (*ForgotPasswordEmail) Template() string
• type ProjectInvitationEmail
  • func (email *ProjectInvitationEmail) Subject() string
  • func (*ProjectInvitationEmail) Template() string
• type TypeCreator
  • func (c *TypeCreator) Create(log *zap.Logger, service *console.Service, mailService *mailservice.Service) error
  • func (c *TypeCreator) RootMutation() *graphql.Object
  • func (c *TypeCreator) RootQuery() *graphql.Object

Constants

const (
	// APIKeyInfoType is graphql type name for api key.
	APIKeyInfoType = "keyInfo"
	// CreateAPIKeyType is graphql type name for createAPIKey struct
	// which incapsulates the actual key and it's info.
	CreateAPIKeyType = "graphqlCreateAPIKey"
	// FieldKey is field name for the actual key in createAPIKey.
	FieldKey = "key"
)

const (
	// ActivationPath is key for path which handles account activation.
	ActivationPath = "activationPath"
	// PasswordRecoveryPath is key for path which handles password recovery.
	PasswordRecoveryPath = "passwordRecoveryPath"
	// CancelPasswordRecoveryPath is key for path which handles let us know sequence.
	CancelPasswordRecoveryPath = "cancelPasswordRecoveryPath"
	// SignInPath is key for sign in server route.
	SignInPath = "signInPath"
	// LetUsKnowURL is key to store let us know URL.
	LetUsKnowURL = "letUsKnowURL"
	// ContactInfoURL is a key to store contact info URL.
	ContactInfoURL = "contactInfoURL"
	// TermsAndConditionsURL is a key to store terms and conditions URL.
	TermsAndConditionsURL = "termsAndConditionsURL"
)

const (
	// Mutation is graphql request that modifies data.
	Mutation = "mutation"

	// CreateProjectMutation is a mutation name for project creation.
	CreateProjectMutation = "createProject"
	// DeleteProjectMutation is a mutation name for project deletion.
	DeleteProjectMutation = "deleteProject"
	// UpdateProjectMutation is a mutation name for project name and description updating.
	UpdateProjectMutation = "updateProject"

	// AddProjectMembersMutation is a mutation name for adding new project members.
	AddProjectMembersMutation = "addProjectMembers"
	// DeleteProjectMembersMutation is a mutation name for deleting project members.
	DeleteProjectMembersMutation = "deleteProjectMembers"

	// CreateAPIKeyMutation is a mutation name for api key creation.
	CreateAPIKeyMutation = "createAPIKey"
	// DeleteAPIKeysMutation is a mutation name for api key deleting.
	DeleteAPIKeysMutation = "deleteAPIKeys"

	// AddPaymentMethodMutation is mutation name for adding new payment method.
	AddPaymentMethodMutation = "addPaymentMethod"
	// DeletePaymentMethodMutation is mutation name for deleting payment method.
	DeletePaymentMethodMutation = "deletePaymentMethod"
	// SetDefaultPaymentMethodMutation is mutation name setting payment method as default payment method.
	SetDefaultPaymentMethodMutation = "setDefaultPaymentMethod"

	// InputArg is argument name for all input types.
	InputArg = "input"
	// ProjectFields is a field name for project specific fields.
	ProjectFields = "projectFields"
	// ProjectLimits is a field name for project specific limits.
	ProjectLimits = "projectLimits"
	// FieldProjectID is field name for projectID.
	FieldProjectID = "projectID"
	// FieldNewPassword is a field name for new password.
	FieldNewPassword = "newPassword"
	// Secret is a field name for registration token for user creation during Vanguard release.
	Secret = "secret"
	// ReferrerUserID is a field name for passing referrer's user id.
	ReferrerUserID = "referrerUserId"
)

const (
	// ProjectType is a graphql type name for project.
	ProjectType = "project"
	// ProjectInputType is a graphql type name for project input.
	ProjectInputType = "projectInput"
	// ProjectLimitType is a graphql type name for project limit.
	ProjectLimitType = "projectLimit"
	// ProjectUsageType is a graphql type name for project usage.
	ProjectUsageType = "projectUsage"
	// ProjectsCursorInputType is a graphql input type name for projects cursor.
	ProjectsCursorInputType = "projectsCursor"
	// ProjectsPageType is a graphql type name for projects page.
	ProjectsPageType = "projectsPage"
	// BucketUsageCursorInputType is a graphql input
	// type name for bucket usage cursor.
	BucketUsageCursorInputType = "bucketUsageCursor"
	// BucketUsageType is a graphql type name for bucket usage.
	BucketUsageType = "bucketUsage"
	// BucketUsagePageType is a field name for bucket usage page.
	BucketUsagePageType = "bucketUsagePage"
	// ProjectMembersPageType is a field name for project members page.
	ProjectMembersPageType = "projectMembersPage"
	// ProjectMembersCursorInputType is a graphql type name for project members.
	ProjectMembersCursorInputType = "projectMembersCursor"
	// APIKeysPageType is a field name for api keys page.
	APIKeysPageType = "apiKeysPage"
	// APIKeysCursorInputType is a graphql type name for api keys.
	APIKeysCursorInputType = "apiKeysCursor"
	// FieldOwnerID is a field name for "ownerId".
	FieldOwnerID = "ownerId"
	// FieldName is a field name for "name".
	FieldName = "name"
	// FieldBucketName is a field name for "bucket name".
	FieldBucketName = "bucketName"
	// FieldDescription is a field name for description.
	FieldDescription = "description"
	// FieldMembers is field name for members.
	FieldMembers = "members"
	// FieldAPIKeys is a field name for api keys.
	FieldAPIKeys = "apiKeys"
	// FieldUsage is a field name for usage rollup.
	FieldUsage = "usage"
	// FieldBucketUsages is a field name for bucket usages.
	FieldBucketUsages = "bucketUsages"
	// FieldStorageLimit is a field name for the storage limit.
	FieldStorageLimit = "storageLimit"
	// FieldBandwidthLimit is a field name for bandwidth limit.
	FieldBandwidthLimit = "bandwidthLimit"
	// FieldStorage is a field name for storage total.
	FieldStorage = "storage"
	// FieldEgress is a field name for egress total.
	FieldEgress = "egress"
	// FieldSegmentCount is a field name for segments count.
	FieldSegmentCount = "segmentCount"
	// FieldObjectCount is a field name for objects count.
	FieldObjectCount = "objectCount"
	// FieldPageCount is a field name for total page count.
	FieldPageCount = "pageCount"
	// FieldCurrentPage is a field name for current page number.
	FieldCurrentPage = "currentPage"
	// FieldTotalCount is a field name for bucket usage count total.
	FieldTotalCount = "totalCount"
	// FieldMemberCount is a field name for number of project members.
	FieldMemberCount = "memberCount"
	// FieldProjects is a field name for projects.
	FieldProjects = "projects"
	// FieldProjectMembers is a field name for project members.
	FieldProjectMembers = "projectMembers"
	// CursorArg is an argument name for cursor.
	CursorArg = "cursor"
	// PageArg ia an argument name for page number.
	PageArg = "page"
	// LimitArg is argument name for limit.
	LimitArg = "limit"
	// OffsetArg is argument name for offset.
	OffsetArg = "offset"
	// SearchArg is argument name for search.
	SearchArg = "search"
	// OrderArg is argument name for order.
	OrderArg = "order"
	// OrderDirectionArg is argument name for order direction.
	OrderDirectionArg = "orderDirection"
	// SinceArg marks start of the period.
	SinceArg = "since"
	// BeforeArg marks end of the period.
	BeforeArg = "before"
)

const (
	// ProjectMemberType is a graphql type name for project member.
	ProjectMemberType = "projectMember"
	// FieldJoinedAt is a field name for joined at timestamp.
	FieldJoinedAt = "joinedAt"
)

const (
	// Query is immutable graphql request.
	Query = "query"
	// ProjectQuery is a query name for project.
	ProjectQuery = "project"
	// OwnedProjectsQuery is a query name for projects owned by an account.
	OwnedProjectsQuery = "ownedProjects"
	// MyProjectsQuery is a query name for projects related to account.
	MyProjectsQuery = "myProjects"
)

const (
	// RewardType is a graphql type for reward.
	RewardType = "reward"
	// FieldAwardCreditInCent is a field name for award credit amount for referrers.
	FieldAwardCreditInCent = "awardCreditInCent"
	// FieldInviteeCreditInCents is a field name for credit amount rewarded to invitees.
	FieldInviteeCreditInCents = "inviteeCreditInCents"
	// FieldRedeemableCap is a field name for the total redeemable amount of the reward offer.
	FieldRedeemableCap = "redeemableCap"
	// FieldAwardCreditDurationDays is a field name for the valid time frame of current award credit.
	FieldAwardCreditDurationDays = "awardCreditDurationDays"
	// FieldInviteeCreditDurationDays is a field name for the valid time frame of current invitee credit.
	FieldInviteeCreditDurationDays = "inviteeCreditDurationDays"
	// FieldExpiresAt is a field name for the expiration time of a reward offer.
	FieldExpiresAt = "expiresAt"
	// FieldType is a field name for the type of reward offers.
	FieldType = "type"
	// FieldStatus is a field name for the status of reward offers.
	FieldStatus = "status"
)

const (
	// UserType is a graphql type for user.
	UserType = "user"
	// UserInputType is a graphql type for user input.
	UserInputType = "userInput"
	// FieldID is a field name for id.
	FieldID = "id"
	// FieldEmail is a field name for email.
	FieldEmail = "email"
	// FieldPassword is a field name for password.
	FieldPassword = "password"
	// FieldFullName is a field name for "first name".
	FieldFullName = "fullName"
	// FieldShortName is a field name for "last name".
	FieldShortName = "shortName"
	// FieldCreatedAt is a field name for created at timestamp.
	FieldCreatedAt = "createdAt"
	// FieldPartnerID is a field name for partnerID.
	FieldPartnerID = "partnerId"
)

Functions

func CreateSchema

func CreateSchema(log *zap.Logger, service *console.Service, mailService *mailservice.Service) (schema graphql.Schema, err error)

CreateSchema creates a schema for satellites console graphql api.

Types

type AccountActivationEmail

type AccountActivationEmail struct {
	Origin                string
	ActivationLink        string
	ContactInfoURL        string
	TermsAndConditionsURL string
	UserName              string
}

AccountActivationEmail is mailservice template with activation data.

func (*AccountActivationEmail) Subject

func (*AccountActivationEmail) Subject() string

Subject gets email subject.

func (*AccountActivationEmail) Template

func (*AccountActivationEmail) Template() string

Template returns email template name.

type ForgotPasswordEmail

type ForgotPasswordEmail struct {
	Origin                     string
	UserName                   string
	ResetLink                  string
	CancelPasswordRecoveryLink string
	LetUsKnowURL               string
	ContactInfoURL             string
	TermsAndConditionsURL      string
}

ForgotPasswordEmail is mailservice template with reset password data.

func (*ForgotPasswordEmail) Subject

func (*ForgotPasswordEmail) Subject() string

Subject gets email subject.

func (*ForgotPasswordEmail) Template

func (*ForgotPasswordEmail) Template() string

Template returns email template name.

type ProjectInvitationEmail

type ProjectInvitationEmail struct {
	Origin                string
	UserName              string
	ProjectName           string
	SignInLink            string
	LetUsKnowURL          string
	ContactInfoURL        string
	TermsAndConditionsURL string
}

ProjectInvitationEmail is mailservice template for project invitation email.

func (*ProjectInvitationEmail) Subject

func (email *ProjectInvitationEmail) Subject() string

Subject gets email subject.

func (*ProjectInvitationEmail) Template

func (*ProjectInvitationEmail) Template() string

Template returns email template name.

type TypeCreator

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

TypeCreator handles graphql type creation and error checking.

func (*TypeCreator) Create

func (c *TypeCreator) Create(log *zap.Logger, service *console.Service, mailService *mailservice.Service) error

Create create types and check for error.

func (*TypeCreator) RootMutation

func (c *TypeCreator) RootMutation() *graphql.Object

RootMutation returns instance of mutation *graphql.Object.

func (*TypeCreator) RootQuery

func (c *TypeCreator) RootQuery() *graphql.Object

RootQuery returns instance of query *graphql.Object.