googleworkspace

type Adapter struct {
	GoogleWorkspaceClient Client
}

type Client interface {
	GetPage(ctx context.Context, request *Request) (*Response, *framework.Error)
}

type Config struct {
	// Common configuration
	*config.CommonConfig

	// APIVersion is the version of the Google Workspace API to use.
	APIVersion string `json:"apiVersion"`

	// Note: Only one of Customer or Domain should be set.
	// The unique ID for the customer's Google Workspace account. In case of a multi-domain account,
	// to fetch all entities for a customer, use this field instead of domain.
	Customer *string `json:"customer"`

	// Note: Only one of Customer or Domain should be set.
	// Use this field to get entities from only one domain.
	Domain *string `json:"domain"`

	Filters Filters `json:"filters"`
}

type Datasource struct {
	Client *http.Client
}

type DatasourceResponse struct {
	DatasourceResponseTemplate
	Users   []map[string]interface{} `json:"users"`
	Groups  []map[string]interface{} `json:"groups"`
	Members []map[string]interface{} `json:"members"`
}

type DatasourceResponseTemplate struct {
	Kind          string        `json:"kind"`
	Etag          string        `json:"etag"`
	NextPageToken *string       `json:"nextPageToken"`
	Error         *ErrorDetails `json:"error"`
}

type Entity struct {
	// Path is the endpoint to query the entity.
	Path string

	// OrderByAttribute is the attribute to order the results by.
	// This is only supported for certain endpoints.
	// User: https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list#orderby
	// Group: https://developers.google.com/admin-sdk/directory/reference/rest/v1/groups/list#orderby
	OrderByAttribute string

	// MaxPageSize is the maximum page size allowed for each entity's endpoint.
	MaxPageSize int64

	// The RequiredAttributes array specifies attributes necessary to create the uniqueID in the response.
	// In Member, the id field is the member object's id. To create the uniqueId, both id and groupId are needed.
	// groupId is required for establishing relationships between Groups and Members (members can be groups or users).
	RequiredAttributes []string

	// UniqueIDAttribute is the attribute that uniquely identifies an entity.
	UniqueIDAttribute string
}

type ErrorDetails struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Errors  []ErrorInfo `json:"errors"`
	Status  string      `json:"status"`
	Details []ErrorInfo `json:"details"`
}

type ErrorInfo struct {
	Message string `json:"message"`
	Reason  string `json:"reason"`
}

type Filters struct {
	UserFilters   *UserFilters   `json:"user"`
	GroupFilters  *GroupFilters  `json:"group"`
	MemberFilters *MemberFilters `json:"member"`
}

type GroupFilters struct {
	// Query is a string for searching entity fields. For more information:
	// Constructing group queries: https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
	Query *string `json:"query"`
}

type MemberFilters struct {
	// This determines whether to list indirect memberships. Default: false.
	IncludeDerivedMembership bool `json:"includeDerivedMembership"`

	// The roles query parameter allows you to retrieve group members by role.
	Roles *string `json:"roles"`
}

type Request struct {
	Filters

	// BaseURL is the Base URL of the datasource to query.
	BaseURL string

	// APIVersion is the version of the Google Workspace Admin API to query.
	APIVersion string

	// Customer is the Google Workspace customer ID to query for entities in.
	Customer *string

	// Domain is the domain to query for entities in.
	Domain *string

	// Bearer token to authenticate with the datasource.
	Token string

	// PageSize is the maximum number of objects to return from the entity.
	PageSize int64

	// EntityExternalID is the external ID of the entity.
	// The external ID should match the API's resource name.
	EntityExternalID string

	// Cursor identifies the first object of the page to return, as returned by
	// the last request for the entity.
	// nil in the request for the first page.
	Cursor *pagination.CompositeCursor[string]

	// RequestTimeoutSeconds is the timeout duration for requests made to datasources.
	// This should be set to the number of seconds to wait before timing out.
	RequestTimeoutSeconds int

	// Ordered is a boolean that indicates whether the results should be ordered.
	Ordered bool
}

type Response struct {
	// StatusCode is an HTTP status code.
	StatusCode int

	// RetryAfterHeader is the Retry-After response HTTP header, if set.
	RetryAfterHeader string

	// Objects is the list of items returned by the datasource.
	// May be empty.
	Objects []map[string]any

	// NextCursor is the cursor that identifies the first object of the next page.
	// nil if this is the last page in this full sync.
	NextCursor *pagination.CompositeCursor[string]
}

type UserFilters struct {
	// If set to true, retrieves the list of deleted users. (Default: false)
	ShowDeleted bool `json:"showDeleted"`

	// Query is a string for searching entity fields. For more information:
	// Constructing user queries: https://developers.google.com/admin-sdk/directory/v1/guides/search-users
	Query *string `json:"query"`
}