Skip to main content

`user_account.proto`

path mgmt/v1alpha1/user_account.proto

package mgmt.v1alpha1

Messages

`AcceptTeamAccountInviteRequest`

Name	Type	Description
`token`	`string`

`AcceptTeamAccountInviteResponse`

Name	Type	Description
`account`	`UserAccount`

`AccountInvite`

Name	Type	Description
`id`	`string`
`account_id`	`string`
`sender_user_id`	`string`
`email`	`string`
`token`	`string`
`accepted`	`bool`
`created_at`	`google.protobuf.Timestamp`
`updated_at`	`google.protobuf.Timestamp`
`expires_at`	`google.protobuf.Timestamp`

`AccountOnboardingConfig`

Name	Type	Description
`has_created_source_connection`	`bool`
`has_created_destination_connection`	`bool`
`has_created_job`	`bool`
`has_invited_members`	`bool`

`AccountTemporalConfig`

Name	Type	Description
`url`	`string`
`namespace`	`string`
`sync_job_queue_name`	`string`

`AccountUser`

Name	Type	Description
`id`	`string`
`name`	`string`
`image`	`string`
`email`	`string`

`ConvertPersonalToTeamAccountRequest`

Name	Type	Description

`ConvertPersonalToTeamAccountResponse`

Name	Type	Description

`CreateTeamAccountRequest`

Name	Type	Description
`name`	`string`

`CreateTeamAccountResponse`

Name	Type	Description
`account_id`	`string`
`checkout_session_url`	optional `string`	If NeosyncCloud, will respond with a checkout session url so they can setup billing

`GetAccountBillingCheckoutSessionRequest`

Name	Type	Description
`account_id`	`string`

`GetAccountBillingCheckoutSessionResponse`

Name	Type	Description
`checkout_session_url`	`string`	The url that will be redirected to

`GetAccountBillingPortalSessionRequest`

Name	Type	Description
`account_id`	`string`

`GetAccountBillingPortalSessionResponse`

Name	Type	Description
`portal_session_url`	`string`	The url that will be redirected to

`GetAccountOnboardingConfigRequest`

Name	Type	Description
`account_id`	`string`

`GetAccountOnboardingConfigResponse`

Name	Type	Description
`config`	`AccountOnboardingConfig`

`GetAccountStatusRequest`

Name	Type	Description
`account_id`	`string`

`GetAccountStatusResponse`

Name	Type	Description
`used_record_count`	`uint64`	A count of the currently used records for the current billing period. This may go over the allowed record count depending on when the record count is polled by the metric system.
`allowed_record_count`	optional `uint64`	The allowed record count. It will be null if there is no limit.
`subscription_status`	`BillingStatus`	The current subscription status determined by the billing system.

`GetAccountTemporalConfigRequest`

Name	Type	Description
`account_id`	`string`

`GetAccountTemporalConfigResponse`

Name	Type	Description
`config`	`AccountTemporalConfig`

`GetSystemInformationRequest`

Name	Type	Description

`GetSystemInformationResponse`

Name	Type	Description
`version`	`string`
`commit`	`string`
`compiler`	`string`
`platform`	`string`
`build_date`	`google.protobuf.Timestamp`

`GetTeamAccountInvitesRequest`

Name	Type	Description
`account_id`	`string`

`GetTeamAccountInvitesResponse`

Name	Type	Description
`invites`	repeated `AccountInvite`

`GetTeamAccountMembersRequest`

Name	Type	Description
`account_id`	`string`

`GetTeamAccountMembersResponse`

Name	Type	Description
`users`	repeated `AccountUser`

`GetUserAccountsRequest`

Name	Type	Description

`GetUserAccountsResponse`

Name	Type	Description
`accounts`	repeated `UserAccount`

`GetUserRequest`

Name	Type	Description

`GetUserResponse`

Name	Type	Description
`user_id`	`string`

`InviteUserToTeamAccountRequest`

Name	Type	Description
`account_id`	`string`
`email`	`string`

`InviteUserToTeamAccountResponse`

Name	Type	Description
`invite`	`AccountInvite`

`IsAccountStatusValidRequest`

Name	Type	Description
`account_id`	`string`
`requested_record_count`	optional `uint64`	An optional count of records to be added to the current usage for validation.

`IsAccountStatusValidResponse`

Name	Type	Description
`is_valid`	`bool`
`reason`	optional `string`	If the account is not valid, a reason for why may be provided.

`IsUserInAccountRequest`

Name	Type	Description
`account_id`	`string`

`IsUserInAccountResponse`

Name	Type	Description
`ok`	`bool`

`RemoveTeamAccountInviteRequest`

Name	Type	Description
`id`	`string`

`RemoveTeamAccountInviteResponse`

Name	Type	Description

`RemoveTeamAccountMemberRequest`

Name	Type	Description
`user_id`	`string`
`account_id`	`string`

`RemoveTeamAccountMemberResponse`

Name	Type	Description

`SetAccountOnboardingConfigRequest`

Name	Type	Description
`account_id`	`string`
`config`	`AccountOnboardingConfig`

`SetAccountOnboardingConfigResponse`

Name	Type	Description
`config`	`AccountOnboardingConfig`

`SetAccountTemporalConfigRequest`

Name	Type	Description
`account_id`	`string`
`config`	`AccountTemporalConfig`

`SetAccountTemporalConfigResponse`

Name	Type	Description
`config`	`AccountTemporalConfig`

`SetPersonalAccountRequest`

Name	Type	Description

`SetPersonalAccountResponse`

Name	Type	Description
`account_id`	`string`

`SetUserRequest`

Name	Type	Description

`SetUserResponse`

Name	Type	Description
`user_id`	`string`

`UserAccount`

Name	Type	Description
`id`	`string`	The unique identifier of the account
`name`	`string`	The account slug
`type`	`UserAccountType`	The type of account
`has_stripe_customer_id`	`bool`	Whether or not the account has an associated stripe customer id

Enums

`BillingStatus`

Name	Number	Description
`BILLING_STATUS_UNSPECIFIED`	`0`
`BILLING_STATUS_ACTIVE`	`1`	Corresponds to a billing subscription and rolls up various states into active This may be split into the future to be more granular and mirror the underlying billing system
`BILLING_STATUS_EXPIRED`	`2`	If the system could not find any active subscriptions

`UserAccountType`

Name	Number	Description
`USER_ACCOUNT_TYPE_UNSPECIFIED`	`0`
`USER_ACCOUNT_TYPE_PERSONAL`	`1`
`USER_ACCOUNT_TYPE_TEAM`	`2`
`USER_ACCOUNT_TYPE_ENTERPRISE`	`3`

Services

`UserAccountService`

`GetUser`

Method	`GetUser`
Request	`GetUserRequest`
Response	`GetUserResponse`
Description

`SetUser`

Method	`SetUser`
Request	`SetUserRequest`
Response	`SetUserResponse`
Description

`GetUserAccounts`

Method	`GetUserAccounts`
Request	`GetUserAccountsRequest`
Response	`GetUserAccountsResponse`
Description

`SetPersonalAccount`

Method	`SetPersonalAccount`
Request	`SetPersonalAccountRequest`
Response	`SetPersonalAccountResponse`
Description

`ConvertPersonalToTeamAccount`

Method	`ConvertPersonalToTeamAccount`
Request	`ConvertPersonalToTeamAccountRequest`
Response	`ConvertPersonalToTeamAccountResponse`
Description

`CreateTeamAccount`

Method	`CreateTeamAccount`
Request	`CreateTeamAccountRequest`
Response	`CreateTeamAccountResponse`
Description

`IsUserInAccount`

Method	`IsUserInAccount`
Request	`IsUserInAccountRequest`
Response	`IsUserInAccountResponse`
Description

`GetAccountTemporalConfig`

Method	`GetAccountTemporalConfig`
Request	`GetAccountTemporalConfigRequest`
Response	`GetAccountTemporalConfigResponse`
Description

`SetAccountTemporalConfig`

Method	`SetAccountTemporalConfig`
Request	`SetAccountTemporalConfigRequest`
Response	`SetAccountTemporalConfigResponse`
Description

`GetTeamAccountMembers`

Method	`GetTeamAccountMembers`
Request	`GetTeamAccountMembersRequest`
Response	`GetTeamAccountMembersResponse`
Description

`RemoveTeamAccountMember`

Method	`RemoveTeamAccountMember`
Request	`RemoveTeamAccountMemberRequest`
Response	`RemoveTeamAccountMemberResponse`
Description

`InviteUserToTeamAccount`

Method	`InviteUserToTeamAccount`
Request	`InviteUserToTeamAccountRequest`
Response	`InviteUserToTeamAccountResponse`
Description

`GetTeamAccountInvites`

Method	`GetTeamAccountInvites`
Request	`GetTeamAccountInvitesRequest`
Response	`GetTeamAccountInvitesResponse`
Description

`RemoveTeamAccountInvite`

Method	`RemoveTeamAccountInvite`
Request	`RemoveTeamAccountInviteRequest`
Response	`RemoveTeamAccountInviteResponse`
Description

`AcceptTeamAccountInvite`

Method	`AcceptTeamAccountInvite`
Request	`AcceptTeamAccountInviteRequest`
Response	`AcceptTeamAccountInviteResponse`
Description

`GetSystemInformation`

Method	`GetSystemInformation`
Request	`GetSystemInformationRequest`
Response	`GetSystemInformationResponse`
Description

`GetAccountOnboardingConfig`

Method	`GetAccountOnboardingConfig`
Request	`GetAccountOnboardingConfigRequest`
Response	`GetAccountOnboardingConfigResponse`
Description

`SetAccountOnboardingConfig`

Method	`SetAccountOnboardingConfig`
Request	`SetAccountOnboardingConfigRequest`
Response	`SetAccountOnboardingConfigResponse`
Description

`GetAccountStatus`

Method	`GetAccountStatus`
Request	`GetAccountStatusRequest`
Response	`GetAccountStatusResponse`
Description	Returns different metrics on the account status for the active billing period

`IsAccountStatusValid`

Method	`IsAccountStatusValid`
Request	`IsAccountStatusValidRequest`
Response	`IsAccountStatusValidResponse`
Description	Distils the account status down to whether not it is in a valid state.

`GetAccountBillingCheckoutSession`

Method	`GetAccountBillingCheckoutSession`
Request	`GetAccountBillingCheckoutSessionRequest`
Response	`GetAccountBillingCheckoutSessionResponse`
Description	Returns a new checkout session for the account to subscribe

`GetAccountBillingPortalSession`

Method	`GetAccountBillingPortalSession`
Request	`GetAccountBillingPortalSessionRequest`
Response	`GetAccountBillingPortalSessionResponse`
Description	Returns a new billing portal session if the account has a billing customer id

Messages
Enums
- BillingStatus
- UserAccountType
Services
- UserAccountService