fga

type CheckBatchOpts struct {
	// List of warrants to check.
	Checks []WarrantCheck `json:"checks"`

	// Flag to include debug information in the response.
	Debug bool `json:"debug,omitempty"`

	// Optional token to specify desired read consistency
	WarrantToken string `json:"-"`
}

type CheckOpts struct {
	// The operator to use for the given warrants.
	Op string `json:"op,omitempty"`

	// List of warrants to check.
	Checks []WarrantCheck `json:"checks"`

	// Flag to include debug information in the response.
	Debug bool `json:"debug,omitempty"`

	// Optional token to specify desired read consistency
	WarrantToken string `json:"-"`
}

type CheckResponse struct {
	Result     string    `json:"result"`
	IsImplicit bool      `json:"is_implicit"`
	DebugInfo  DebugInfo `json:"debug_info,omitempty"`
}

type Client struct {
	// The WorkOS API Key. It can be found in https://dashboard.workos.com/api-keys.
	APIKey string

	// The http.Client that is used to get FGA records from WorkOS.
	// Defaults to http.Client.
	HTTPClient *retryablehttp.HttpClient

	// The endpoint to WorkOS API. Defaults to https://api.workos.com.
	Endpoint string

	// The function used to encode in JSON. Defaults to json.Marshal.
	JSONEncode func(v interface{}) ([]byte, error)
	// contains filtered or unexported fields
}

type Context map[string]interface{}

type ConvertResourceTypesToSchemaOpts struct {
	// The version of the transpiler to use.
	Version string `json:"version"`

	// The resource types to convert to a schema.
	ResourceTypes []ResourceType `json:"resource_types"`
}

type ConvertSchemaResponse struct {
	// The version transpiler used to convert the schema.
	Version string `json:"version"`

	// Warnings generated from schema issues.
	Warnings []ConvertSchemaWarning `json:"warnings,omitempty"`

	// The schema generated from the resource types.
	Schema *string `json:"schema,omitempty"`

	// The resource types generated from the schema.
	ResourceTypes []ResourceType `json:"resource_types,omitempty"`
}

type ConvertSchemaToResourceTypesOpts struct {
	// The schema to convert to resource types.
	Schema string
}

type ConvertSchemaWarning struct {
	// The warning message.
	Message string `json:"message"`
}

type CreateResourceOpts struct {
	// The type of the resource.
	ResourceType string `json:"resource_type"`

	// The customer defined string identifier for this resource.
	ResourceId string `json:"resource_id,omitempty"`

	// Map containing additional information about this resource.
	Meta map[string]interface{} `json:"meta,omitempty"`
}

type DebugInfo struct {
	ProcessingTime time.Duration     `json:"processing_time"`
	DecisionTree   *DecisionTreeNode `json:"decision_tree"`
}

type DecisionTreeNode struct {
	Check          WarrantCheck       `json:"check"`
	Policy         string             `json:"policy,omitempty"`
	Decision       string             `json:"decision"`
	ProcessingTime time.Duration      `json:"processing_time"`
	Children       []DecisionTreeNode `json:"children"`
}

type DeleteResourceOpts struct {
	// The type of the resource.
	ResourceType string

	// The customer defined string identifier for this resource.
	ResourceId string
}

type GetResourceOpts struct {
	// The type of the resource.
	ResourceType string

	// The customer defined string identifier for this resource.
	ResourceId string
}

type GetSchemaResponse struct {
	// The version of the schema.
	Version string `json:"version"`

	// The resource types generated from the schema.
	ResourceTypes []ResourceType `json:"resource_types"`

	// The policies generated from the schema.
	Policies map[string]Policy `json:"policies"`
}

type ListResourceTypesOpts struct {
	// Maximum number of records to return.
	Limit int `url:"limit,omitempty"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided ResourceType ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided ResourceType ID.
	After string `url:"after,omitempty"`
}

type ListResourceTypesResponse struct {
	// List of Resource Types.
	Data []ResourceType `json:"data"`

	// Cursor pagination options.
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type ListResourcesOpts struct {
	// The type of the resource.
	ResourceType string `url:"resource_type,omitempty"`

	// Searchable text for a Resource. Can be empty.
	Search string `url:"search,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit,omitempty"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided Resource ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided Resource ID.
	After string `url:"after,omitempty"`
}

type ListResourcesResponse struct {
	// List of provisioned Resources.
	Data []Resource `json:"data"`

	// Cursor pagination options.
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type ListWarrantsOpts struct {
	// Only return warrants whose resourceType matches this value.
	ResourceType string `url:"resource_type,omitempty"`

	// Only return warrants whose resourceId matches this value.
	ResourceId string `url:"resource_id,omitempty"`

	// Only return warrants whose relation matches this value.
	Relation string `url:"relation,omitempty"`

	// Only return warrants with a subject whose resourceType matches this value.
	SubjectType string `url:"subject_type,omitempty"`

	// Only return warrants with a subject whose resourceId matches this value.
	SubjectId string `url:"subject_id,omitempty"`

	// Only return warrants with a subject whose relation matches this value.
	SubjectRelation string `url:"subject_relation,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit,omitempty"`

	// Pagination cursor to receive records after a provided Warrant ID.
	After string `url:"after,omitempty"`

	// Optional token to specify desired read consistency
	WarrantToken string `url:"-"`
}

type ListWarrantsResponse struct {
	// List of provisioned Warrants.
	Data []Warrant `json:"data"`

	// Cursor pagination options.
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type Order string

type Policy struct {
	// The name of the policy.
	Name string `json:"name"`

	// The language of the policy expression.
	Language string `json:"language"`

	//The description of the policy.
	Description string `json:"description,omitempty"`

	// Parameters for the policy.
	Parameters []PolicyParameter `json:"parameters"`

	// The expression of the policy.
	Expression string `json:"expression"`
}

type PolicyParameter struct {
	// The name of the parameter.
	Name string `json:"name"`
	// The type of the parameter.
	Type string `json:"type"`
}

type QueryOpts struct {
	// Query to be executed.
	Query string `url:"q"`

	// Contextual data to use for the query.
	Context Context `url:"context,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit,omitempty"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided Warrant ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided Warrant ID.
	After string `url:"after,omitempty"`

	// Optional token to specify desired read consistency
	WarrantToken string `url:"-"`
}

type QueryResponse struct {
	// List of query results.
	Data []QueryResult `json:"data"`

	// Cursor pagination options.
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type QueryResult struct {
	// The type of the resource.
	ResourceType string `json:"resource_type"`

	// Id of the specific resource.
	ResourceId string `json:"resource_id"`

	// Relation between the resource and subject.
	Relation string `json:"relation"`

	// Warrant matching the provided query
	Warrant Warrant `json:"warrant"`

	// Specifies whether the warrant is implicitly defined.
	IsImplicit bool `json:"is_implicit"`

	// Metadata of the resource.
	Meta map[string]interface{} `json:"meta,omitempty"`
}

type Resource struct {
	// The type of the resource.
	ResourceType string `json:"resource_type"`

	// The customer defined string identifier for this resource.
	ResourceId string `json:"resource_id"`

	// Map containing additional information about this resource.
	Meta map[string]interface{} `json:"meta"`
}

type ResourceType struct {
	// Unique string ID of the resource type.
	Type string `json:"type"`

	// Set of relationships that subjects can have on resources of this type.
	Relations map[string]interface{} `json:"relations"`
}

type Subject struct {
	// The type of the subject.
	ResourceType string `json:"resource_type"`

	// The customer defined string identifier for this subject.
	ResourceId string `json:"resource_id"`

	// The relation of the subject.
	Relation string `json:"relation,omitempty"`
}

type UpdatePolicyOpts struct {
	// The name of the policy.
	Name string `json:"name"`

	// The language of the policy expression.
	Language string `json:"language"`

	// The description of the policy.
	Description string `json:"description,omitempty"`

	// Parameters for the policy.
	Parameters []PolicyParameter `json:"parameters"`

	// The expression of the policy.
	Expression string `json:"expression"`
}

type UpdateResourceOpts struct {
	// The type of the resource.
	ResourceType string `json:"resource_type"`

	// The customer defined string identifier for this resource.
	ResourceId string `json:"resource_id"`

	// Map containing additional information about this resource.
	Meta map[string]interface{} `json:"meta,omitempty"`
}

type UpdateResourceTypeOpts struct {
	// Unique string ID of the resource type.
	Type string `json:"type"`

	// Set of relationships that subjects can have on resources of this type.
	Relations map[string]interface{} `json:"relations"`
}

type UpdateSchemaOpts struct {
	// The resource types generated from the schema.
	ResourceTypes []UpdateResourceTypeOpts `json:"resource_types"`

	// The policies generated from the schema.
	Policies map[string]UpdatePolicyOpts `json:"policies"`
}

type Warrant struct {
	// Type of resource to assign a relation to. Must be an existing type.
	ResourceType string `json:"resource_type"`

	// Id of the resource to assign a relation to.
	ResourceId string `json:"resource_id"`

	// Relation to assign to the resource.
	Relation string `json:"relation"`

	// Subject of the warrant
	Subject Subject `json:"subject"`

	// Policy that must evaluate to true for warrant to be valid
	Policy string `json:"policy,omitempty"`
}

type WarrantCheck struct {
	// The type of the resource.
	ResourceType string `json:"resource_type"`

	// Id of the specific resource.
	ResourceId string `json:"resource_id"`

	// Relation to check between the resource and subject.
	Relation string `json:"relation"`

	// The subject that must have the specified relation.
	Subject Subject `json:"subject"`

	// Contextual data to use for the access check.
	Context Context `json:"context,omitempty"`
}

type WriteWarrantOpts struct {
	// Operation to perform for the given warrant
	Op string `json:"op,omitempty"`

	// Type of resource to assign a relation to. Must be an existing type.
	ResourceType string `json:"resource_type"`

	// Id of the resource to assign a relation to.
	ResourceId string `json:"resource_id"`

	// Relation to assign to the resource.
	Relation string `json:"relation"`

	// Subject of the warrant
	Subject Subject `json:"subject"`

	// Policy that must evaluate to true for warrant to be valid
	Policy string `json:"policy,omitempty"`
}

type WriteWarrantResponse struct {
	WarrantToken string `json:"warrant_token"`
}