members.go

// Code generated by internal/cmd/gen; DO NOT EDIT.

package flashduty

import "context"

// MembersService handles the "Platform/Members" API resource.
type MembersService service

// Delete member.
//
// Remove a member from the organization by ID, email, phone, or name.
//
// API: POST /member/delete (memberDelete).
func (s *MembersService) MemberDelete(ctx context.Context, req *MemberDeleteRequest) (*Response, error) {
	return s.client.do(ctx, "/member/delete", req, nil)
}

// Grant role to member.
//
// Add role assignments to a member. Role IDs that do not exist are silently ignored; if none resolve, the call is a no-op success.
//
// API: POST /member/role/grant (memberGrantRole).
func (s *MembersService) MemberGrantRole(ctx context.Context, req *MemberRoleGrantRequest) (*Response, error) {
	return s.client.do(ctx, "/member/role/grant", req, nil)
}

// Get current member info.
//
// Return the profile of the member the credential belongs to. Requires a member-scoped credential — calls authenticated as the account principal (e.g. an account-level app key) are rejected with a 400.
//
// API: POST /member/info (memberInfo).
func (s *MembersService) MemberInfo(ctx context.Context) (*MemberInfoResponse, *Response, error) {
	out := new(MemberInfoResponse)
	resp, err := s.client.do(ctx, "/member/info", nil, out)
	if err != nil {
		return nil, resp, err
	}
	return out, resp, nil
}

// Invite members.
//
// Batch invite new members to the organization by email or phone.
//
// API: POST /member/invite (memberInvite).
func (s *MembersService) MemberInvite(ctx context.Context, req *MemberInviteRequest) (*MemberInviteResponse, *Response, error) {
	out := new(MemberInviteResponse)
	resp, err := s.client.do(ctx, "/member/invite", req, out)
	if err != nil {
		return nil, resp, err
	}
	return out, resp, nil
}

// List members.
//
// Return a paginated list of organization members.
//
// API: POST /member/list (memberList).
func (s *MembersService) MemberList(ctx context.Context, req *MemberListRequest) (*MemberListResponse, *Response, error) {
	out := new(MemberListResponse)
	resp, err := s.client.do(ctx, "/member/list", req, out)
	if err != nil {
		return nil, resp, err
	}
	return out, resp, nil
}

// Reset member info.
//
// Identify a member and reset the specified profile fields.
//
// API: POST /member/info/reset (memberResetInfo).
func (s *MembersService) MemberResetInfo(ctx context.Context, req *MemberResetInfoRequest) (*Response, error) {
	return s.client.do(ctx, "/member/info/reset", req, nil)
}

// Revoke role from member.
//
// Remove role assignments from a member. Role IDs that do not exist are silently ignored; if none resolve, the call is a no-op success.
//
// API: POST /member/role/revoke (memberRevokeRole).
func (s *MembersService) MemberRevokeRole(ctx context.Context, req *MemberRoleRevokeRequest) (*Response, error) {
	return s.client.do(ctx, "/member/role/revoke", req, nil)
}

// Update member roles.
//
// Replace all role assignments for a member at once. Role IDs that do not exist are silently dropped; an empty `role_ids` resets the member to the built-in Viewer role (ID 8).
//
// API: POST /member/role/update (memberUpdateRole).
func (s *MembersService) MemberUpdateRole(ctx context.Context, req *MemberRoleUpdateRequest) (*Response, error) {
	return s.client.do(ctx, "/member/role/update", req, nil)
}

// Batch get persons.
//
// Return profile information for a batch of person IDs (members or accounts).
//
// API: POST /person/infos (personInfos).
func (s *MembersService) PersonInfos(ctx context.Context, req *PersonInfosRequest) (*PersonInfosResponse, *Response, error) {
	out := new(PersonInfosResponse)
	resp, err := s.client.do(ctx, "/person/infos", req, out)
	if err != nil {
		return nil, resp, err
	}
	return out, resp, nil
}