client

package
v0.7.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 8, 2025 License: Apache-2.0 Imports: 12 Imported by: 40

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DEFAULT_MAX_METHOD_PARALLEL_REQS = int32(10)

Functions

This section is empty.

Types

type AuthorizationModelIdOptions

type AuthorizationModelIdOptions struct {
	AuthorizationModelId *string `json:"authorization_model_id,omitempty"`
}

type BatchCheckOptions added in v0.6.6

type BatchCheckOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	MaxParallelRequests  *int32                        `json:"max_parallel_requests,omitempty"`
	MaxBatchSize         *int32                        `json:"max_batch_size,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

BatchCheckOptions represents options for server-side batch check operations

type ClientAssertion

type ClientAssertion struct {
	User             string                     `json:"user,omitempty"`
	Relation         string                     `json:"relation,omitempty"`
	Object           string                     `json:"object,omitempty"`
	Expectation      bool                       `json:"expectation,omitempty"`
	Context          *map[string]interface{}    `json:"context,omitempty"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
}

func (ClientAssertion) ToAssertion

func (clientAssertion ClientAssertion) ToAssertion() fgaSdk.Assertion

type ClientBatchCheckClientBody added in v0.6.6

type ClientBatchCheckClientBody = []ClientCheckRequest

type ClientBatchCheckClientOptions added in v0.6.6

type ClientBatchCheckClientOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	MaxParallelRequests  *int32                        `json:"max_parallel_requests,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientBatchCheckClientResponse added in v0.6.6

type ClientBatchCheckClientResponse = []ClientBatchCheckClientSingleResponse

type ClientBatchCheckClientSingleResponse added in v0.6.6

type ClientBatchCheckClientSingleResponse struct {
	ClientCheckResponse
	Request ClientCheckRequest
	Error   error
}

type ClientBatchCheckItem added in v0.6.6

type ClientBatchCheckItem struct {
	User             string                     `json:"user"`
	Relation         string                     `json:"relation"`
	Object           string                     `json:"object"`
	CorrelationId    string                     `json:"correlation_id"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
	Context          *map[string]interface{}    `json:"context,omitempty"`
}

ClientBatchCheckItem represents a flattened check item for batch check operations

type ClientBatchCheckRequest added in v0.6.6

type ClientBatchCheckRequest struct {
	Checks []ClientBatchCheckItem `json:"checks"`
}

ClientBatchCheckRequest represents a request for batch check operations

type ClientCheckOptions

type ClientCheckOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientCheckRequest

type ClientCheckRequest struct {
	User             string                     `json:"user,omitempty"`
	Relation         string                     `json:"relation,omitempty"`
	Object           string                     `json:"object,omitempty"`
	Context          *map[string]interface{}    `json:"context,omitempty"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
}

type ClientCheckRequestTupleKey added in v0.3.0

type ClientCheckRequestTupleKey = fgaSdk.CheckRequestTupleKey

type ClientCheckResponse

type ClientCheckResponse struct {
	fgaSdk.CheckResponse
	HttpResponse *_nethttp.Response
}

type ClientConfiguration

type ClientConfiguration struct {
	fgaSdk.Configuration
	// ApiScheme - defines the scheme for the API: http or https
	// Deprecated: use ApiUrl instead of ApiScheme and ApiHost
	ApiScheme string `json:"api_scheme"`
	// ApiHost - defines the host for the API without the scheme e.g. (api.fga.example)
	// Deprecated: use ApiUrl instead of ApiScheme and ApiHost
	ApiHost              string                   `json:"api_host"`
	ApiUrl               string                   `json:"api_url"`
	StoreId              string                   `json:"store_id"`
	AuthorizationModelId string                   `json:"authorization_model_id"`
	Credentials          *credentials.Credentials `json:"credentials"`
	DefaultHeaders       map[string]string        `json:"default_headers"`
	UserAgent            string                   `json:"user_agent"`
	Debug                bool                     `json:"debug"`
	HTTPClient           *_nethttp.Client
	RetryParams          *fgaSdk.RetryParams
	Telemetry            *telemetry.Configuration `json:"telemetry,omitempty"`
}

type ClientContextualTupleKey added in v0.3.0

type ClientContextualTupleKey = ClientTupleKey

type ClientCreateStoreOptions

type ClientCreateStoreOptions struct {
	RequestOptions
}

type ClientCreateStoreRequest

type ClientCreateStoreRequest struct {
	Name string `json:"name"`
}

type ClientCreateStoreResponse

type ClientCreateStoreResponse = fgaSdk.CreateStoreResponse

type ClientDeleteStoreOptions

type ClientDeleteStoreOptions struct {
	RequestOptions

	StoreId *string `json:"store_id,omitempty"`
}

type ClientDeleteStoreResponse

type ClientDeleteStoreResponse struct{}

type ClientDeleteTuplesBody

type ClientDeleteTuplesBody = []ClientTupleKeyWithoutCondition

type ClientExpandOptions

type ClientExpandOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientExpandRequest

type ClientExpandRequest struct {
	Relation         string                     `json:"relation,omitempty"`
	Object           string                     `json:"object,omitempty"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
}

type ClientExpandRequestTupleKey added in v0.3.0

type ClientExpandRequestTupleKey = fgaSdk.ExpandRequestTupleKey

type ClientExpandResponse

type ClientExpandResponse = fgaSdk.ExpandResponse

type ClientGetStoreOptions

type ClientGetStoreOptions struct {
	RequestOptions

	StoreId *string `json:"store_id,omitempty"`
}

type ClientGetStoreResponse

type ClientGetStoreResponse = fgaSdk.GetStoreResponse

type ClientListObjectsOptions

type ClientListObjectsOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientListObjectsRequest

type ClientListObjectsRequest struct {
	User             string                     `json:"user,omitempty"`
	Relation         string                     `json:"relation,omitempty"`
	Type             string                     `json:"type,omitempty"`
	Context          *map[string]interface{}    `json:"context,omitempty"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
}

type ClientListObjectsResponse

type ClientListObjectsResponse = fgaSdk.ListObjectsResponse

type ClientListRelationsOptions

type ClientListRelationsOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	MaxParallelRequests  *int32                        `json:"max_parallel_requests,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientListRelationsRequest

type ClientListRelationsRequest struct {
	User             string                     `json:"user,omitempty"`
	Object           string                     `json:"object,omitempty"`
	Relations        []string                   `json:"relations,omitempty"`
	Context          *map[string]interface{}    `json:"context,omitempty"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
}

type ClientListRelationsResponse

type ClientListRelationsResponse struct {
	Relations []string `json:"response,omitempty"`
}

func (ClientListRelationsResponse) MarshalJSON

func (o ClientListRelationsResponse) MarshalJSON() ([]byte, error)

type ClientListStoresOptions

type ClientListStoresOptions struct {
	RequestOptions

	PageSize          *int32  `json:"page_size,omitempty"`
	ContinuationToken *string `json:"continuation_token,omitempty"`
	Name              *string `json:"name,omitempty"`
}

type ClientListStoresResponse

type ClientListStoresResponse = fgaSdk.ListStoresResponse

type ClientListUsersOptions added in v0.3.6

type ClientListUsersOptions struct {
	RequestOptions

	AuthorizationModelId *string                       `json:"authorization_model_id,omitempty"`
	StoreId              *string                       `json:"store_id,omitempty"`
	Consistency          *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientListUsersRequest added in v0.3.6

type ClientListUsersRequest struct {
	Object           fgaSdk.FgaObject           `json:"object" yaml:"object"`
	Relation         string                     `json:"relation" yaml:"relation"`
	UserFilters      []fgaSdk.UserTypeFilter    `json:"user_filters" yaml:"user_filters"`
	ContextualTuples []ClientContextualTupleKey `json:"contextual_tuples,omitempty"`
	// Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation.
	Context *map[string]interface{} `json:"context,omitempty" yaml:"context,omitempty"`
}

type ClientListUsersResponse added in v0.3.6

type ClientListUsersResponse = fgaSdk.ListUsersResponse

type ClientPaginationOptions

type ClientPaginationOptions struct {
	PageSize          *int32  `json:"page_size,omitempty"`
	ContinuationToken *string `json:"continuation_token,omitempty"`
}

type ClientReadAssertionsOptions

type ClientReadAssertionsOptions struct {
	RequestOptions

	AuthorizationModelId *string `json:"authorization_model_id,omitempty"`
	StoreId              *string `json:"store_id,omitempty"`
}

type ClientReadAssertionsResponse

type ClientReadAssertionsResponse = fgaSdk.ReadAssertionsResponse

type ClientReadAuthorizationModelOptions

type ClientReadAuthorizationModelOptions struct {
	RequestOptions

	AuthorizationModelId *string `json:"authorization_model_id,omitempty"`
	StoreId              *string `json:"store_id,omitempty"`
}

type ClientReadAuthorizationModelRequest

type ClientReadAuthorizationModelRequest struct {
}

type ClientReadAuthorizationModelResponse

type ClientReadAuthorizationModelResponse = fgaSdk.ReadAuthorizationModelResponse

type ClientReadAuthorizationModelsOptions

type ClientReadAuthorizationModelsOptions struct {
	RequestOptions

	PageSize          *int32  `json:"page_size,omitempty"`
	ContinuationToken *string `json:"continuation_token,omitempty"`
	StoreId           *string `json:"store_id,omitempty"`
}

type ClientReadAuthorizationModelsResponse

type ClientReadAuthorizationModelsResponse = fgaSdk.ReadAuthorizationModelsResponse

type ClientReadChangesOptions

type ClientReadChangesOptions struct {
	RequestOptions

	PageSize          *int32  `json:"page_size,omitempty"`
	ContinuationToken *string `json:"continuation_token,omitempty"`
	StoreId           *string `json:"store_id"`
}

type ClientReadChangesRequest

type ClientReadChangesRequest struct {
	Type      string    `json:"type,omitempty"`
	StartTime time.Time `json:"start_time,omitempty"`
}

type ClientReadChangesResponse

type ClientReadChangesResponse = fgaSdk.ReadChangesResponse

type ClientReadLatestAuthorizationModelOptions

type ClientReadLatestAuthorizationModelOptions struct {
	RequestOptions

	StoreId *string `json:"store_id,omitempty"`
}

type ClientReadOptions

type ClientReadOptions struct {
	RequestOptions

	PageSize          *int32                        `json:"page_size,omitempty"`
	ContinuationToken *string                       `json:"continuation_token,omitempty"`
	StoreId           *string                       `json:"store_id,omitempty"`
	Consistency       *fgaSdk.ConsistencyPreference `json:"consistency,omitempty"`
}

type ClientReadRequest

type ClientReadRequest struct {
	User     *string `json:"user,omitempty"`
	Relation *string `json:"relation,omitempty"`
	Object   *string `json:"object,omitempty"`
}

type ClientReadRequestTupleKey added in v0.3.0

type ClientReadRequestTupleKey = fgaSdk.ReadRequestTupleKey

type ClientReadResponse

type ClientReadResponse = fgaSdk.ReadResponse

type ClientRequestOptionsWithAuthZModelId

type ClientRequestOptionsWithAuthZModelId struct {
	RequestOptions
	AuthorizationModelIdOptions
}

type ClientTupleKey

type ClientTupleKey = fgaSdk.TupleKey

type ClientTupleKeyWithoutCondition added in v0.3.0

type ClientTupleKeyWithoutCondition = fgaSdk.TupleKeyWithoutCondition

type ClientWriteAssertionsOptions

type ClientWriteAssertionsOptions struct {
	RequestOptions

	AuthorizationModelId *string `json:"authorization_model_id,omitempty"`
	StoreId              *string `json:"store_id,omitempty"`
}

type ClientWriteAssertionsRequest

type ClientWriteAssertionsRequest = []ClientAssertion

type ClientWriteAssertionsResponse added in v0.2.3

type ClientWriteAssertionsResponse struct {
}

type ClientWriteAuthorizationModelOptions

type ClientWriteAuthorizationModelOptions struct {
	RequestOptions

	StoreId *string `json:"store_id,omitempty"`
}

type ClientWriteAuthorizationModelRequest

type ClientWriteAuthorizationModelRequest = fgaSdk.WriteAuthorizationModelRequest

type ClientWriteAuthorizationModelResponse

type ClientWriteAuthorizationModelResponse = fgaSdk.WriteAuthorizationModelResponse

type ClientWriteConflictOptions added in v0.7.3

type ClientWriteConflictOptions struct {
	// OnDuplicateWrites defines what to do when a write conflicts with an existing tuple
	// Options are: "error" (default) or "ignore"
	OnDuplicateWrites ClientWriteRequestOnDuplicateWrites `json:"on_duplicate_writes,omitempty"`
	// OnMissingDeletes defines what to do when a delete is issued for a tuple that does not exist
	// Options are: "error" (default) or "ignore"
	OnMissingDeletes ClientWriteRequestOnMissingDeletes `json:"on_missing_deletes,omitempty"`
}

type ClientWriteOptions

type ClientWriteOptions struct {
	RequestOptions

	AuthorizationModelId *string             `json:"authorization_model_id,omitempty"`
	StoreId              *string             `json:"store_id,omitempty"`
	Transaction          *TransactionOptions `json:"transaction_options,omitempty"`
	Conflict             ClientWriteConflictOptions
}

type ClientWriteRequest

type ClientWriteRequest struct {
	Writes  []ClientTupleKey
	Deletes []ClientTupleKeyWithoutCondition
}

type ClientWriteRequestDeleteResponse added in v0.3.0

type ClientWriteRequestDeleteResponse struct {
	TupleKey     ClientTupleKeyWithoutCondition `json:"tuple_key,omitempty"`
	Status       ClientWriteStatus              `json:"status,omitempty"`
	HttpResponse *_nethttp.Response             `json:"http_response,omitempty"`
	Error        error                          `json:"error,omitempty"`
}

func (ClientWriteRequestDeleteResponse) MarshalJSON added in v0.3.0

func (o ClientWriteRequestDeleteResponse) MarshalJSON() ([]byte, error)

type ClientWriteRequestOnDuplicateWrites added in v0.7.3

type ClientWriteRequestOnDuplicateWrites string

ClientWriteRequestOnDuplicateWrites indicates what to do when a write conflicts with an existing tuple

const (
	// CLIENT_WRITE_REQUEST_ON_DUPLICATE_WRITES_ERROR returns an error if a write conflicts with an existing tuple (default)
	CLIENT_WRITE_REQUEST_ON_DUPLICATE_WRITES_ERROR ClientWriteRequestOnDuplicateWrites = "error"
	// CLIENT_WRITE_REQUEST_ON_DUPLICATE_WRITES_IGNORE ignores writes that conflict with existing tuples (they must match exactly, including conditions)
	CLIENT_WRITE_REQUEST_ON_DUPLICATE_WRITES_IGNORE ClientWriteRequestOnDuplicateWrites = "ignore"
)

func (*ClientWriteRequestOnDuplicateWrites) ToString added in v0.7.3

type ClientWriteRequestOnMissingDeletes added in v0.7.3

type ClientWriteRequestOnMissingDeletes string

ClientWriteRequestOnMissingDeletes indicates what to do when a delete is issued for a tuple that does not exist

const (
	// CLIENT_WRITE_REQUEST_ON_MISSING_DELETES_ERROR returns an error if a delete is issued for a tuple that does not exist (default)
	CLIENT_WRITE_REQUEST_ON_MISSING_DELETES_ERROR ClientWriteRequestOnMissingDeletes = "error"
	// CLIENT_WRITE_REQUEST_ON_MISSING_DELETES_IGNORE ignores deletes for tuples that do not exist
	CLIENT_WRITE_REQUEST_ON_MISSING_DELETES_IGNORE ClientWriteRequestOnMissingDeletes = "ignore"
)

func (*ClientWriteRequestOnMissingDeletes) ToString added in v0.7.3

type ClientWriteRequestWriteResponse added in v0.3.0

type ClientWriteRequestWriteResponse struct {
	TupleKey     ClientTupleKey     `json:"tuple_key,omitempty"`
	Status       ClientWriteStatus  `json:"status,omitempty"`
	HttpResponse *_nethttp.Response `json:"http_response,omitempty"`
	Error        error              `json:"error,omitempty"`
}

func (ClientWriteRequestWriteResponse) MarshalJSON added in v0.3.0

func (o ClientWriteRequestWriteResponse) MarshalJSON() ([]byte, error)

type ClientWriteResponse

type ClientWriteResponse struct {
	Writes  []ClientWriteRequestWriteResponse  `json:"writes,omitempty"`
	Deletes []ClientWriteRequestDeleteResponse `json:"deletes,omitempty"`
}

func (ClientWriteResponse) MarshalJSON

func (o ClientWriteResponse) MarshalJSON() ([]byte, error)

type ClientWriteStatus

type ClientWriteStatus string
const (
	SUCCESS ClientWriteStatus = "CLIENT_WRITE_STATUS_SUCCESS"
	FAILURE ClientWriteStatus = "CLIENT_WRITE_STATUS_FAILURE"
)

List of ClientWriteStatus

type ClientWriteTuplesBody

type ClientWriteTuplesBody = []ClientTupleKey

type FgaInvalidError added in v0.2.3

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

FgaInvalidError Provides access to the body, error and model on returned errors.

func (FgaInvalidError) Error added in v0.2.3

func (e FgaInvalidError) Error() string

Error returns non-empty string if there was an error.

func (FgaInvalidError) Param added in v0.2.3

func (e FgaInvalidError) Param() string

Param returns the name of the invalid parameter

type FgaRequiredParamError added in v0.2.3

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

FgaRequiredParamError Provides access to the body, error and model on returned errors.

func (FgaRequiredParamError) Error added in v0.2.3

func (e FgaRequiredParamError) Error() string

Error returns non-empty string if there was an error.

func (FgaRequiredParamError) Param added in v0.2.3

func (e FgaRequiredParamError) Param() string

Param returns the name of the missing parameter

type OpenFgaClient

type OpenFgaClient struct {
	SdkClient
	fgaSdk.APIClient
	// contains filtered or unexported fields
}

func NewSdkClient

func NewSdkClient(cfg *ClientConfiguration) (*OpenFgaClient, error)

func (*OpenFgaClient) BatchCheck

BatchCheck initializes a new batch check request

func (*OpenFgaClient) BatchCheckExecute

func (client *OpenFgaClient) BatchCheckExecute(request SdkClientBatchCheckRequestInterface) (*fgaSdk.BatchCheckResponse, error)

* BatchCheckExecute executes the server-side BatchCheck request * @param request SdkClientBatchCheckRequestInterface - the request interface * @return *fgaSdk.BatchCheckResponse

func (*OpenFgaClient) Check

func (*OpenFgaClient) CheckExecute

func (client *OpenFgaClient) CheckExecute(request SdkClientCheckRequestInterface) (*ClientCheckResponse, error)

func (*OpenFgaClient) ClientBatchCheck added in v0.6.6

func (*OpenFgaClient) ClientBatchCheckExecute added in v0.6.6

func (*OpenFgaClient) CreateStore

func (*OpenFgaClient) CreateStoreExecute

func (*OpenFgaClient) DeleteStore

func (*OpenFgaClient) DeleteStoreExecute

func (*OpenFgaClient) DeleteTuples

func (*OpenFgaClient) DeleteTuplesExecute

func (client *OpenFgaClient) DeleteTuplesExecute(request SdkClientDeleteTuplesRequestInterface) (*ClientWriteResponse, error)

func (*OpenFgaClient) Expand

func (*OpenFgaClient) ExpandExecute

func (client *OpenFgaClient) ExpandExecute(request SdkClientExpandRequestInterface) (*ClientExpandResponse, error)

func (*OpenFgaClient) GetAuthorizationModelId added in v0.3.0

func (client *OpenFgaClient) GetAuthorizationModelId() (string, error)

func (*OpenFgaClient) GetStore

func (*OpenFgaClient) GetStoreExecute

func (client *OpenFgaClient) GetStoreExecute(request SdkClientGetStoreRequestInterface) (*ClientGetStoreResponse, error)

func (*OpenFgaClient) GetStoreId added in v0.4.0

func (client *OpenFgaClient) GetStoreId() (string, error)

func (*OpenFgaClient) ListObjects

func (*OpenFgaClient) ListObjectsExecute

func (*OpenFgaClient) ListRelations

func (*OpenFgaClient) ListRelationsExecute

func (*OpenFgaClient) ListStores

func (*OpenFgaClient) ListStoresExecute

func (*OpenFgaClient) ListUsers added in v0.3.6

func (*OpenFgaClient) ListUsersExecute added in v0.3.6

func (client *OpenFgaClient) ListUsersExecute(request SdkClientListUsersRequestInterface) (*ClientListUsersResponse, error)

func (*OpenFgaClient) Read

func (*OpenFgaClient) ReadAssertions

func (*OpenFgaClient) ReadAssertionsExecute

func (*OpenFgaClient) ReadAuthorizationModel

func (*OpenFgaClient) ReadAuthorizationModels

func (*OpenFgaClient) ReadChanges

func (*OpenFgaClient) ReadChangesExecute

func (*OpenFgaClient) ReadExecute

func (client *OpenFgaClient) ReadExecute(request SdkClientReadRequestInterface) (*ClientReadResponse, error)

func (*OpenFgaClient) ReadLatestAuthorizationModel

func (client *OpenFgaClient) ReadLatestAuthorizationModel(ctx _context.Context) SdkClientReadLatestAuthorizationModelRequestInterface

func (*OpenFgaClient) SetAuthorizationModelId added in v0.3.0

func (client *OpenFgaClient) SetAuthorizationModelId(authorizationModelId string) error

func (*OpenFgaClient) SetStoreId added in v0.4.0

func (client *OpenFgaClient) SetStoreId(storeId string) error

func (*OpenFgaClient) Write

func (*OpenFgaClient) WriteAssertions

func (*OpenFgaClient) WriteAssertionsExecute

func (*OpenFgaClient) WriteAuthorizationModel

func (*OpenFgaClient) WriteExecute

func (client *OpenFgaClient) WriteExecute(request SdkClientWriteRequestInterface) (*ClientWriteResponse, error)

func (*OpenFgaClient) WriteTuples

func (*OpenFgaClient) WriteTuplesExecute

func (client *OpenFgaClient) WriteTuplesExecute(request SdkClientWriteTuplesRequestInterface) (*ClientWriteResponse, error)

type RequestOptions added in v0.7.3

type RequestOptions = fgaSdk.RequestOptions

type SdkClient

type SdkClient interface {

	/*
	 * ListStores Get a paginated list of stores.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientListStoresRequestInterface
	 */
	ListStores(ctx _context.Context) SdkClientListStoresRequestInterface

	/*
	 * ListStoresExecute executes the ListStores request
	 * @return *ClientListStoresResponse
	 */
	ListStoresExecute(request SdkClientListStoresRequestInterface) (*ClientListStoresResponse, error)

	/*
	 * CreateStore Create and initialize a store
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientCreateStoreRequestInterface
	 */
	CreateStore(ctx _context.Context) SdkClientCreateStoreRequestInterface

	/*
	 * CreateStoreExecute executes the CreateStore request
	 * @return *ClientCreateStoreResponse
	 */
	CreateStoreExecute(request SdkClientCreateStoreRequestInterface) (*ClientCreateStoreResponse, error)

	/*
	 * GetStore Get information about the current store.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientGetStoreRequestInterface
	 */
	GetStore(ctx _context.Context) SdkClientGetStoreRequestInterface

	/*
	 * GetStoreExecute executes the GetStore request
	 * @return *ClientGetStoreResponse
	 */
	GetStoreExecute(request SdkClientGetStoreRequestInterface) (*ClientGetStoreResponse, error)

	/*
	 * DeleteStore Delete a store.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientDeleteStoreRequestInterface
	 */
	DeleteStore(ctx _context.Context) SdkClientDeleteStoreRequestInterface

	/*
	 * DeleteStoreExecute executes the DeleteStore request
	 * @return *ClientDeleteStoreResponse
	 */
	DeleteStoreExecute(request SdkClientDeleteStoreRequestInterface) (*ClientDeleteStoreResponse, error)

	/*
	 * ReadAuthorizationModels Read all authorization models in the store.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientReadAuthorizationModelsRequest
	 */
	ReadAuthorizationModels(ctx _context.Context) SdkClientReadAuthorizationModelsRequestInterface

	/*
	 * ReadAuthorizationModelsExecute executes the ReadAuthorizationModels request
	 * @return *ClientReadAuthorizationModelsResponse
	 */
	ReadAuthorizationModelsExecute(request SdkClientReadAuthorizationModelsRequestInterface) (*ClientReadAuthorizationModelsResponse, error)

	/*
	 * WriteAuthorizationModel Create a new authorization model.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientWriteAuthorizationModelRequest
	 */
	WriteAuthorizationModel(ctx _context.Context) SdkClientWriteAuthorizationModelRequestInterface

	/*
	 * WriteAuthorizationModelExecute executes the WriteAuthorizationModel request
	 * @return *ClientWriteAuthorizationModelResponse
	 */
	WriteAuthorizationModelExecute(request SdkClientWriteAuthorizationModelRequestInterface) (*ClientWriteAuthorizationModelResponse, error)

	/*
	 * ReadAuthorizationModel Read a particular authorization model.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientReadAuthorizationModelRequestInterface
	 */
	ReadAuthorizationModel(ctx _context.Context) SdkClientReadAuthorizationModelRequestInterface

	/*
	 * ReadAuthorizationModelExecute executes the ReadAuthorizationModel request
	 * @return *ClientReadAuthorizationModelResponse
	 */
	ReadAuthorizationModelExecute(request SdkClientReadAuthorizationModelRequestInterface) (*ClientReadAuthorizationModelResponse, error)

	/*
	 * ReadLatestAuthorizationModel Reads the latest authorization model (note: this ignores the model id in configuration).
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientReadLatestAuthorizationModelRequestInterface
	 */
	ReadLatestAuthorizationModel(ctx _context.Context) SdkClientReadLatestAuthorizationModelRequestInterface

	/*
	 * ReadLatestAuthorizationModelExecute executes the ReadLatestAuthorizationModel request
	 * @return *ClientReadAuthorizationModelResponse
	 */
	ReadLatestAuthorizationModelExecute(request SdkClientReadLatestAuthorizationModelRequestInterface) (*ClientReadAuthorizationModelResponse, error)

	/*
	 * ReadChanges Reads the list of historical relationship tuple writes and deletes.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientReadChangesRequestInterface
	 */
	ReadChanges(ctx _context.Context) SdkClientReadChangesRequestInterface

	/*
	 * ReadChangesExecute executes the ReadChanges request
	 * @return *ClientReadChangesResponse
	 */
	ReadChangesExecute(request SdkClientReadChangesRequestInterface) (*ClientReadChangesResponse, error)

	/*
	 * Read Reads the relationship tuples stored in the database. It does not evaluate nor exclude invalid tuples according to the authorization model.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientReadRequestInterface
	 */
	Read(ctx _context.Context) SdkClientReadRequestInterface

	/*
	 * ReadExecute executes the Read request
	 * @return *ClientReadResponse
	 */
	ReadExecute(request SdkClientReadRequestInterface) (*ClientReadResponse, error)

	/*
	 * Write Create and/or delete relationship tuples to update the system state.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientWriteRequestInterface
	 */
	Write(ctx _context.Context) SdkClientWriteRequestInterface

	/*
	 * WriteExecute executes the Write request
	 * @return *ClientWriteResponse
	 */
	WriteExecute(request SdkClientWriteRequestInterface) (*ClientWriteResponse, error)

	/*
	 * WriteTuples Utility method around Write
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientWriteTuplesRequestInterface
	 */
	WriteTuples(ctx _context.Context) SdkClientWriteTuplesRequestInterface

	/*
	 * WriteTuplesExecute executes the WriteTuples request
	 * @return *ClientWriteResponse
	 */
	WriteTuplesExecute(request SdkClientWriteTuplesRequestInterface) (*ClientWriteResponse, error)

	/*
	 * DeleteTuples Utility method around Write
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientDeleteTuplesRequestInterface
	 */
	DeleteTuples(ctx _context.Context) SdkClientDeleteTuplesRequestInterface

	/*
	 * DeleteTuplesExecute executes the DeleteTuples request
	 * @return *ClientWriteResponse
	 */
	DeleteTuplesExecute(request SdkClientDeleteTuplesRequestInterface) (*ClientWriteResponse, error)

	/*
	 * Check Check if a user has a particular relation with an object.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientCheckRequestInterface
	 */
	Check(ctx _context.Context) SdkClientCheckRequestInterface

	/*
	 * CheckExecute executes the Check request
	 * @return *ClientCheckResponse
	 */
	CheckExecute(request SdkClientCheckRequestInterface) (*ClientCheckResponse, error)

	/*
	 * ClientBatchCheck Run a set of [checks](#check). Batch Check will return `allowed: false` if it encounters an error, and will return the error in the body.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientBatchCheckRequestInterface
	 */
	ClientBatchCheck(ctx _context.Context) SdkClientBatchCheckClientRequestInterface

	/*
	 * ClientBatchCheckExecute executes the BatchCheck request
	 * @return *ClientBatchCheckResponse
	 */
	ClientBatchCheckExecute(request SdkClientBatchCheckClientRequestInterface) (*ClientBatchCheckClientResponse, error)

	/*
	 * BatchCheck Run a set of checks on the server. Server-side batch check allows for more efficient checking of multiple tuples.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientBatchCheckRequestInterface
	 */
	BatchCheck(ctx _context.Context) SdkClientBatchCheckRequestInterface

	/*
	 * BatchCheckExecute executes the server-side BatchCheck request
	 * @return *BatchCheckResponse
	 */
	BatchCheckExecute(request SdkClientBatchCheckRequestInterface) (*fgaSdk.BatchCheckResponse, error)

	/*
	 * Expand Expands the relationships in userset tree format.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientExpandRequestInterface
	 */
	Expand(ctx _context.Context) SdkClientExpandRequestInterface

	/*
	 * ExpandExecute executes the Expand request
	 * @return *ClientExpandResponse
	 */
	ExpandExecute(request SdkClientExpandRequestInterface) (*ClientExpandResponse, error)

	/*
	 * ListObjects List the objects of a particular type a user has access to.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientListObjectsRequestInterface
	 */
	ListObjects(ctx _context.Context) SdkClientListObjectsRequestInterface

	/*
	 * ListObjectsExecute executes the ListObjects request
	 * @return *ClientListObjectsResponse
	 */
	ListObjectsExecute(request SdkClientListObjectsRequestInterface) (*ClientListObjectsResponse, error)

	/*
	 * ListRelations List the relations a user has on an object.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientListRelationsRequestInterface
	 */
	ListRelations(ctx _context.Context) SdkClientListRelationsRequestInterface

	/*
	 * ListRelationsExecute executes the ListRelations request
	 * @return *ClientListRelationsResponse
	 */
	ListRelationsExecute(request SdkClientListRelationsRequestInterface) (*ClientListRelationsResponse, error)

	/*
	 * ListUsers List all users of the given type that the object has a relation with
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return ApiListUsersRequest
	 */
	ListUsers(ctx _context.Context) SdkClientListUsersRequestInterface

	/*
	 * ListUsersExecute executes the request
	 * @return ListUsersResponse
	 */
	ListUsersExecute(r SdkClientListUsersRequestInterface) (*ClientListUsersResponse, error)

	/*
	 * ReadAssertions Read assertions for a particular authorization model.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientReadAssertionsRequestInterface
	 */
	ReadAssertions(ctx _context.Context) SdkClientReadAssertionsRequestInterface

	/*
	 * ReadAssertionsExecute executes the ReadAssertions request
	 * @return *ClientReadAssertionsResponse
	 */
	ReadAssertionsExecute(request SdkClientReadAssertionsRequestInterface) (*ClientReadAssertionsResponse, error)

	/*
	 * WriteAssertions Update the assertions for a particular authorization model.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return SdkClientWriteAssertionsRequestInterface
	 */
	WriteAssertions(ctx _context.Context) SdkClientWriteAssertionsRequestInterface

	/*
	 * WriteAssertionsExecute executes the WriteAssertions request
	 * @return *ClientWriteAssertionsResponse
	 */
	WriteAssertionsExecute(request SdkClientWriteAssertionsRequestInterface) (*ClientWriteAssertionsResponse, error)

	/*
	 * SetAuthorizationModelId allows setting the Authorization Model ID for an OpenFgaClient.
	 * @param string authorizationModelId - The Authorization Model ID to set.
	 */
	SetAuthorizationModelId(authorizationModelId string) error
	/*
	 * GetAuthorizationModelId retrieves the Authorization Model ID for an OpenFgaClient.
	 * @return string
	 */
	GetAuthorizationModelId() (string, error)
	/*
	 * SetStoreId allows setting the Store ID for an OpenFgaClient.
	 * @param string storeId - The Store ID to set.
	 */
	SetStoreId(storeId string) error
	/*
	 * GetStoreId retrieves the Store ID set in the OpenFgaClient.
	 * @return string
	 */
	GetStoreId() (string, error)
}

type SdkClientBatchCheckClientRequest added in v0.6.6

type SdkClientBatchCheckClientRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

func (*SdkClientBatchCheckClientRequest) Body added in v0.6.6

func (*SdkClientBatchCheckClientRequest) Execute added in v0.6.6

func (*SdkClientBatchCheckClientRequest) GetAuthorizationModelIdOverride added in v0.6.6

func (request *SdkClientBatchCheckClientRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientBatchCheckClientRequest) GetBody added in v0.6.6

func (*SdkClientBatchCheckClientRequest) GetContext added in v0.6.6

func (request *SdkClientBatchCheckClientRequest) GetContext() _context.Context

func (*SdkClientBatchCheckClientRequest) GetOptions added in v0.6.6

func (*SdkClientBatchCheckClientRequest) GetStoreIdOverride added in v0.6.6

func (request *SdkClientBatchCheckClientRequest) GetStoreIdOverride() *string

func (*SdkClientBatchCheckClientRequest) Options added in v0.6.6

type SdkClientBatchCheckClientRequestInterface added in v0.6.6

type SdkClientBatchCheckClientRequestInterface interface {
	Options(options ClientBatchCheckClientOptions) SdkClientBatchCheckClientRequestInterface
	Body(body ClientBatchCheckClientBody) SdkClientBatchCheckClientRequestInterface
	Execute() (*ClientBatchCheckClientResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientBatchCheckClientBody
	GetOptions() *ClientBatchCheckClientOptions
}

type SdkClientBatchCheckRequest

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

SdkClientBatchCheckRequest represents a server-side batch check request

func (*SdkClientBatchCheckRequest) Body

func (*SdkClientBatchCheckRequest) Execute

func (*SdkClientBatchCheckRequest) GetBody added in v0.2.3

func (*SdkClientBatchCheckRequest) GetContext added in v0.2.3

func (*SdkClientBatchCheckRequest) GetOptions added in v0.2.3

func (*SdkClientBatchCheckRequest) Options

type SdkClientBatchCheckRequestInterface added in v0.2.3

type SdkClientBatchCheckRequestInterface interface {
	Body(body ClientBatchCheckRequest) SdkClientBatchCheckRequestInterface
	Options(options BatchCheckOptions) SdkClientBatchCheckRequestInterface
	Execute() (*fgaSdk.BatchCheckResponse, error)
	GetContext() _context.Context
	GetBody() *ClientBatchCheckRequest
	GetOptions() *BatchCheckOptions
}

SdkClientBatchCheckRequestInterface defines the interface for server-side batch check requests

type SdkClientCheckRequest

type SdkClientCheckRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

func (*SdkClientCheckRequest) Body

func (*SdkClientCheckRequest) Execute

func (request *SdkClientCheckRequest) Execute() (*ClientCheckResponse, error)

func (*SdkClientCheckRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientCheckRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientCheckRequest) GetBody added in v0.2.3

func (request *SdkClientCheckRequest) GetBody() *ClientCheckRequest

func (*SdkClientCheckRequest) GetContext added in v0.2.3

func (request *SdkClientCheckRequest) GetContext() _context.Context

func (*SdkClientCheckRequest) GetOptions added in v0.2.3

func (request *SdkClientCheckRequest) GetOptions() *ClientCheckOptions

func (*SdkClientCheckRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientCheckRequest) GetStoreIdOverride() *string

func (*SdkClientCheckRequest) Options

type SdkClientCheckRequestInterface added in v0.2.3

type SdkClientCheckRequestInterface interface {
	Options(options ClientCheckOptions) SdkClientCheckRequestInterface
	Body(body ClientCheckRequest) SdkClientCheckRequestInterface
	Execute() (*ClientCheckResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientCheckRequest
	GetOptions() *ClientCheckOptions
}

type SdkClientCreateStoreRequest

type SdkClientCreateStoreRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ CreateStore

func (*SdkClientCreateStoreRequest) Body

func (*SdkClientCreateStoreRequest) Execute

func (*SdkClientCreateStoreRequest) GetBody added in v0.2.3

func (*SdkClientCreateStoreRequest) GetContext added in v0.2.3

func (request *SdkClientCreateStoreRequest) GetContext() _context.Context

func (*SdkClientCreateStoreRequest) GetOptions added in v0.2.3

func (*SdkClientCreateStoreRequest) Options

type SdkClientCreateStoreRequestInterface added in v0.2.3

type SdkClientCreateStoreRequestInterface interface {
	Options(options ClientCreateStoreOptions) SdkClientCreateStoreRequestInterface
	Body(body ClientCreateStoreRequest) SdkClientCreateStoreRequestInterface
	Execute() (*ClientCreateStoreResponse, error)

	GetContext() _context.Context
	GetOptions() *ClientCreateStoreOptions
	GetBody() *ClientCreateStoreRequest
}

type SdkClientDeleteStoreRequest

type SdkClientDeleteStoreRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ DeleteStore

func (*SdkClientDeleteStoreRequest) Execute

func (*SdkClientDeleteStoreRequest) GetContext added in v0.2.3

func (request *SdkClientDeleteStoreRequest) GetContext() _context.Context

func (*SdkClientDeleteStoreRequest) GetOptions added in v0.2.3

func (*SdkClientDeleteStoreRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientDeleteStoreRequest) GetStoreIdOverride() *string

func (*SdkClientDeleteStoreRequest) Options

type SdkClientDeleteStoreRequestInterface added in v0.2.3

type SdkClientDeleteStoreRequestInterface interface {
	Options(options ClientDeleteStoreOptions) SdkClientDeleteStoreRequestInterface
	Execute() (*ClientDeleteStoreResponse, error)
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetOptions() *ClientDeleteStoreOptions
}

type SdkClientDeleteTuplesRequest

type SdkClientDeleteTuplesRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ DeleteTuples

func (*SdkClientDeleteTuplesRequest) Body

func (*SdkClientDeleteTuplesRequest) Execute

func (*SdkClientDeleteTuplesRequest) GetBody added in v0.2.3

func (*SdkClientDeleteTuplesRequest) GetContext added in v0.2.3

func (request *SdkClientDeleteTuplesRequest) GetContext() _context.Context

func (*SdkClientDeleteTuplesRequest) GetOptions added in v0.2.3

func (request *SdkClientDeleteTuplesRequest) GetOptions() *ClientWriteOptions

func (*SdkClientDeleteTuplesRequest) Options

type SdkClientDeleteTuplesRequestInterface added in v0.2.3

type SdkClientDeleteTuplesRequestInterface interface {
	Options(options ClientWriteOptions) SdkClientDeleteTuplesRequestInterface
	Body(body ClientDeleteTuplesBody) SdkClientDeleteTuplesRequestInterface
	Execute() (*ClientWriteResponse, error)

	GetContext() _context.Context
	GetBody() *ClientDeleteTuplesBody
	GetOptions() *ClientWriteOptions
}

type SdkClientExpandRequest

type SdkClientExpandRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ Expand

func (*SdkClientExpandRequest) Body

func (*SdkClientExpandRequest) Execute

func (request *SdkClientExpandRequest) Execute() (*ClientExpandResponse, error)

func (*SdkClientExpandRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientExpandRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientExpandRequest) GetBody added in v0.2.3

func (request *SdkClientExpandRequest) GetBody() *ClientExpandRequest

func (*SdkClientExpandRequest) GetContext added in v0.2.3

func (request *SdkClientExpandRequest) GetContext() _context.Context

func (*SdkClientExpandRequest) GetOptions added in v0.2.3

func (request *SdkClientExpandRequest) GetOptions() *ClientExpandOptions

func (*SdkClientExpandRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientExpandRequest) GetStoreIdOverride() *string

func (*SdkClientExpandRequest) Options

type SdkClientExpandRequestInterface added in v0.2.3

type SdkClientExpandRequestInterface interface {
	Options(options ClientExpandOptions) SdkClientExpandRequestInterface
	Body(body ClientExpandRequest) SdkClientExpandRequestInterface
	Execute() (*ClientExpandResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientExpandRequest
	GetOptions() *ClientExpandOptions
}

type SdkClientGetStoreRequest

type SdkClientGetStoreRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ GetStore

func (*SdkClientGetStoreRequest) Execute

func (request *SdkClientGetStoreRequest) Execute() (*ClientGetStoreResponse, error)

func (*SdkClientGetStoreRequest) GetContext added in v0.2.3

func (request *SdkClientGetStoreRequest) GetContext() _context.Context

func (*SdkClientGetStoreRequest) GetOptions added in v0.2.3

func (request *SdkClientGetStoreRequest) GetOptions() *ClientGetStoreOptions

func (*SdkClientGetStoreRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientGetStoreRequest) GetStoreIdOverride() *string

func (*SdkClientGetStoreRequest) Options

type SdkClientGetStoreRequestInterface added in v0.2.3

type SdkClientGetStoreRequestInterface interface {
	Options(options ClientGetStoreOptions) SdkClientGetStoreRequestInterface
	Execute() (*ClientGetStoreResponse, error)
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetOptions() *ClientGetStoreOptions
}

type SdkClientListObjectsRequest

type SdkClientListObjectsRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ListObjects

func (*SdkClientListObjectsRequest) Body

func (*SdkClientListObjectsRequest) Execute

func (*SdkClientListObjectsRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientListObjectsRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientListObjectsRequest) GetBody added in v0.2.3

func (*SdkClientListObjectsRequest) GetContext added in v0.2.3

func (request *SdkClientListObjectsRequest) GetContext() _context.Context

func (*SdkClientListObjectsRequest) GetOptions added in v0.2.3

func (*SdkClientListObjectsRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientListObjectsRequest) GetStoreIdOverride() *string

func (*SdkClientListObjectsRequest) Options

type SdkClientListObjectsRequestInterface added in v0.2.3

type SdkClientListObjectsRequestInterface interface {
	Options(options ClientListObjectsOptions) SdkClientListObjectsRequestInterface
	Body(body ClientListObjectsRequest) SdkClientListObjectsRequestInterface
	Execute() (*ClientListObjectsResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientListObjectsRequest
	GetOptions() *ClientListObjectsOptions
}

type SdkClientListRelationsRequest

type SdkClientListRelationsRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

func (*SdkClientListRelationsRequest) Body

func (*SdkClientListRelationsRequest) Execute

func (*SdkClientListRelationsRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientListRelationsRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientListRelationsRequest) GetBody added in v0.2.3

func (*SdkClientListRelationsRequest) GetContext added in v0.2.3

func (request *SdkClientListRelationsRequest) GetContext() _context.Context

func (*SdkClientListRelationsRequest) GetOptions added in v0.2.3

func (*SdkClientListRelationsRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientListRelationsRequest) GetStoreIdOverride() *string

func (*SdkClientListRelationsRequest) Options

type SdkClientListRelationsRequestInterface added in v0.2.3

type SdkClientListRelationsRequestInterface interface {
	Options(options ClientListRelationsOptions) SdkClientListRelationsRequestInterface
	Body(body ClientListRelationsRequest) SdkClientListRelationsRequestInterface
	Execute() (*ClientListRelationsResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientListRelationsRequest
	GetOptions() *ClientListRelationsOptions
}

type SdkClientListStoresRequest

type SdkClientListStoresRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ListStores

func (*SdkClientListStoresRequest) Execute

func (*SdkClientListStoresRequest) GetContext added in v0.2.3

func (request *SdkClientListStoresRequest) GetContext() _context.Context

func (*SdkClientListStoresRequest) GetOptions added in v0.2.3

func (request *SdkClientListStoresRequest) GetOptions() *ClientListStoresOptions

func (*SdkClientListStoresRequest) Options

type SdkClientListStoresRequestInterface added in v0.2.3

type SdkClientListStoresRequestInterface interface {
	Options(options ClientListStoresOptions) SdkClientListStoresRequestInterface
	Execute() (*ClientListStoresResponse, error)
	GetContext() _context.Context
	GetOptions() *ClientListStoresOptions
}

type SdkClientListUsersRequest added in v0.3.6

type SdkClientListUsersRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ListUsers

func (*SdkClientListUsersRequest) Body added in v0.3.6

func (*SdkClientListUsersRequest) Execute added in v0.3.6

func (*SdkClientListUsersRequest) GetAuthorizationModelIdOverride added in v0.3.6

func (request *SdkClientListUsersRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientListUsersRequest) GetBody added in v0.3.6

func (*SdkClientListUsersRequest) GetContext added in v0.3.6

func (request *SdkClientListUsersRequest) GetContext() _context.Context

func (*SdkClientListUsersRequest) GetOptions added in v0.3.6

func (request *SdkClientListUsersRequest) GetOptions() *ClientListUsersOptions

func (*SdkClientListUsersRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientListUsersRequest) GetStoreIdOverride() *string

func (*SdkClientListUsersRequest) Options added in v0.3.6

type SdkClientListUsersRequestInterface added in v0.3.6

type SdkClientListUsersRequestInterface interface {
	Options(options ClientListUsersOptions) SdkClientListUsersRequestInterface
	Body(body ClientListUsersRequest) SdkClientListUsersRequestInterface
	Execute() (*ClientListUsersResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientListUsersRequest
	GetOptions() *ClientListUsersOptions
}

type SdkClientReadAssertionsRequest

type SdkClientReadAssertionsRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ReadAssertions

func (*SdkClientReadAssertionsRequest) Execute

func (*SdkClientReadAssertionsRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientReadAssertionsRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientReadAssertionsRequest) GetContext added in v0.2.3

func (request *SdkClientReadAssertionsRequest) GetContext() _context.Context

func (*SdkClientReadAssertionsRequest) GetOptions added in v0.2.3

func (*SdkClientReadAssertionsRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientReadAssertionsRequest) GetStoreIdOverride() *string

func (*SdkClientReadAssertionsRequest) Options

type SdkClientReadAssertionsRequestInterface added in v0.2.3

type SdkClientReadAssertionsRequestInterface interface {
	Options(options ClientReadAssertionsOptions) SdkClientReadAssertionsRequestInterface
	Execute() (*ClientReadAssertionsResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetOptions() *ClientReadAssertionsOptions
}

type SdkClientReadAuthorizationModelRequest

type SdkClientReadAuthorizationModelRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ReadAuthorizationModel

func (*SdkClientReadAuthorizationModelRequest) Execute

func (*SdkClientReadAuthorizationModelRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientReadAuthorizationModelRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientReadAuthorizationModelRequest) GetBody added in v0.2.3

func (*SdkClientReadAuthorizationModelRequest) GetContext added in v0.2.3

func (*SdkClientReadAuthorizationModelRequest) GetOptions added in v0.2.3

func (*SdkClientReadAuthorizationModelRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientReadAuthorizationModelRequest) GetStoreIdOverride() *string

func (*SdkClientReadAuthorizationModelRequest) Options

type SdkClientReadAuthorizationModelRequestInterface added in v0.2.3

type SdkClientReadAuthorizationModelRequestInterface interface {
	Options(options ClientReadAuthorizationModelOptions) SdkClientReadAuthorizationModelRequestInterface
	Body(body ClientReadAuthorizationModelRequest) SdkClientReadAuthorizationModelRequestInterface
	Execute() (*ClientReadAuthorizationModelResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientReadAuthorizationModelRequest
	GetOptions() *ClientReadAuthorizationModelOptions
}

type SdkClientReadAuthorizationModelsRequest

type SdkClientReadAuthorizationModelsRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ReadAuthorizationModels

func (*SdkClientReadAuthorizationModelsRequest) Execute

func (*SdkClientReadAuthorizationModelsRequest) GetContext added in v0.2.3

func (*SdkClientReadAuthorizationModelsRequest) GetOptions added in v0.2.3

func (*SdkClientReadAuthorizationModelsRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientReadAuthorizationModelsRequest) GetStoreIdOverride() *string

type SdkClientReadAuthorizationModelsRequestInterface added in v0.2.3

type SdkClientReadAuthorizationModelsRequestInterface interface {
	Options(options ClientReadAuthorizationModelsOptions) SdkClientReadAuthorizationModelsRequestInterface
	Execute() (*ClientReadAuthorizationModelsResponse, error)
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetOptions() *ClientReadAuthorizationModelsOptions
}

type SdkClientReadChangesRequest

type SdkClientReadChangesRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ ReadChanges

func (*SdkClientReadChangesRequest) Body

func (*SdkClientReadChangesRequest) Execute

func (*SdkClientReadChangesRequest) GetBody added in v0.2.3

func (*SdkClientReadChangesRequest) GetContext added in v0.2.3

func (request *SdkClientReadChangesRequest) GetContext() _context.Context

func (*SdkClientReadChangesRequest) GetOptions added in v0.2.3

func (*SdkClientReadChangesRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientReadChangesRequest) GetStoreIdOverride() *string

func (*SdkClientReadChangesRequest) Options

type SdkClientReadChangesRequestInterface added in v0.2.3

type SdkClientReadChangesRequestInterface interface {
	Options(options ClientReadChangesOptions) SdkClientReadChangesRequestInterface
	Body(body ClientReadChangesRequest) SdkClientReadChangesRequestInterface
	Execute() (*ClientReadChangesResponse, error)
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientReadChangesRequest
	GetOptions() *ClientReadChangesOptions
}

type SdkClientReadLatestAuthorizationModelRequest

type SdkClientReadLatestAuthorizationModelRequest struct {
	Client OpenFgaClient
	// contains filtered or unexported fields
}

/ ReadLatestAuthorizationModel

func (*SdkClientReadLatestAuthorizationModelRequest) Execute

func (*SdkClientReadLatestAuthorizationModelRequest) GetContext added in v0.2.3

func (*SdkClientReadLatestAuthorizationModelRequest) GetOptions added in v0.2.3

func (*SdkClientReadLatestAuthorizationModelRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientReadLatestAuthorizationModelRequest) GetStoreIdOverride() *string

type SdkClientReadLatestAuthorizationModelRequestInterface added in v0.2.3

type SdkClientReadLatestAuthorizationModelRequestInterface interface {
	Options(options ClientReadLatestAuthorizationModelOptions) SdkClientReadLatestAuthorizationModelRequestInterface
	Execute() (*ClientReadAuthorizationModelResponse, error)
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetOptions() *ClientReadLatestAuthorizationModelOptions
}

type SdkClientReadRequest

type SdkClientReadRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ Read

func (*SdkClientReadRequest) Body

func (*SdkClientReadRequest) Execute

func (request *SdkClientReadRequest) Execute() (*ClientReadResponse, error)

func (*SdkClientReadRequest) GetBody added in v0.2.3

func (request *SdkClientReadRequest) GetBody() *ClientReadRequest

func (*SdkClientReadRequest) GetContext added in v0.2.3

func (request *SdkClientReadRequest) GetContext() _context.Context

func (*SdkClientReadRequest) GetOptions added in v0.2.3

func (request *SdkClientReadRequest) GetOptions() *ClientReadOptions

func (*SdkClientReadRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientReadRequest) GetStoreIdOverride() *string

func (*SdkClientReadRequest) Options

type SdkClientReadRequestInterface added in v0.2.3

type SdkClientReadRequestInterface interface {
	Options(options ClientReadOptions) SdkClientReadRequestInterface
	Body(body ClientReadRequest) SdkClientReadRequestInterface
	Execute() (*ClientReadResponse, error)
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientReadRequest
	GetOptions() *ClientReadOptions
}

type SdkClientWriteAssertionsRequest

type SdkClientWriteAssertionsRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ WriteAssertions

func (*SdkClientWriteAssertionsRequest) Body

func (*SdkClientWriteAssertionsRequest) Execute

func (*SdkClientWriteAssertionsRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientWriteAssertionsRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientWriteAssertionsRequest) GetBody added in v0.2.3

func (*SdkClientWriteAssertionsRequest) GetContext added in v0.2.3

func (request *SdkClientWriteAssertionsRequest) GetContext() _context.Context

func (*SdkClientWriteAssertionsRequest) GetOptions added in v0.2.3

func (*SdkClientWriteAssertionsRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientWriteAssertionsRequest) GetStoreIdOverride() *string

func (*SdkClientWriteAssertionsRequest) Options

type SdkClientWriteAssertionsRequestInterface added in v0.2.3

type SdkClientWriteAssertionsRequestInterface interface {
	Options(options ClientWriteAssertionsOptions) SdkClientWriteAssertionsRequestInterface
	Body(body ClientWriteAssertionsRequest) SdkClientWriteAssertionsRequestInterface
	Execute() (*ClientWriteAssertionsResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetBody() *ClientWriteAssertionsRequest
	GetOptions() *ClientWriteAssertionsOptions
}

type SdkClientWriteAuthorizationModelRequest

type SdkClientWriteAuthorizationModelRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ WriteAuthorizationModel

func (*SdkClientWriteAuthorizationModelRequest) Execute

func (*SdkClientWriteAuthorizationModelRequest) GetBody added in v0.2.3

func (*SdkClientWriteAuthorizationModelRequest) GetContext added in v0.2.3

func (*SdkClientWriteAuthorizationModelRequest) GetOptions added in v0.2.3

func (*SdkClientWriteAuthorizationModelRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientWriteAuthorizationModelRequest) GetStoreIdOverride() *string

type SdkClientWriteRequest

type SdkClientWriteRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ Write

func (*SdkClientWriteRequest) Body

func (*SdkClientWriteRequest) Execute

func (request *SdkClientWriteRequest) Execute() (*ClientWriteResponse, error)

func (*SdkClientWriteRequest) GetAuthorizationModelIdOverride added in v0.2.3

func (request *SdkClientWriteRequest) GetAuthorizationModelIdOverride() *string

func (*SdkClientWriteRequest) GetBody added in v0.2.3

func (request *SdkClientWriteRequest) GetBody() *ClientWriteRequest

func (*SdkClientWriteRequest) GetContext added in v0.2.3

func (request *SdkClientWriteRequest) GetContext() _context.Context

func (*SdkClientWriteRequest) GetOptions added in v0.2.3

func (request *SdkClientWriteRequest) GetOptions() *ClientWriteOptions

func (*SdkClientWriteRequest) GetStoreIdOverride added in v0.4.0

func (request *SdkClientWriteRequest) GetStoreIdOverride() *string

func (*SdkClientWriteRequest) Options

type SdkClientWriteRequestInterface added in v0.2.3

type SdkClientWriteRequestInterface interface {
	Options(options ClientWriteOptions) SdkClientWriteRequestInterface
	Body(body ClientWriteRequest) SdkClientWriteRequestInterface
	Execute() (*ClientWriteResponse, error)
	GetAuthorizationModelIdOverride() *string
	GetStoreIdOverride() *string

	GetContext() _context.Context
	GetOptions() *ClientWriteOptions
	GetBody() *ClientWriteRequest
}

type SdkClientWriteTuplesRequest

type SdkClientWriteTuplesRequest struct {
	Client *OpenFgaClient
	// contains filtered or unexported fields
}

/ WriteTuples

func (*SdkClientWriteTuplesRequest) Body

func (*SdkClientWriteTuplesRequest) Execute

func (request *SdkClientWriteTuplesRequest) Execute() (*ClientWriteResponse, error)

func (*SdkClientWriteTuplesRequest) GetBody added in v0.2.3

func (*SdkClientWriteTuplesRequest) GetContext added in v0.2.3

func (request *SdkClientWriteTuplesRequest) GetContext() _context.Context

func (*SdkClientWriteTuplesRequest) GetOptions added in v0.2.3

func (request *SdkClientWriteTuplesRequest) GetOptions() *ClientWriteOptions

func (*SdkClientWriteTuplesRequest) Options

type SdkClientWriteTuplesRequestInterface added in v0.2.3

type SdkClientWriteTuplesRequestInterface interface {
	Options(options ClientWriteOptions) SdkClientWriteTuplesRequestInterface
	Body(body ClientWriteTuplesBody) SdkClientWriteTuplesRequestInterface
	Execute() (*ClientWriteResponse, error)

	GetContext() _context.Context
	GetBody() *ClientWriteTuplesBody
	GetOptions() *ClientWriteOptions
}

type TransactionOptions

type TransactionOptions struct {
	// If set to true will disable running in transaction mode (transaction mode means everything is sent in a single transaction to the server)
	Disable bool `json:"disable,omitempty"`
	// When transaction mode is disabled, the requests are chunked and sent separately and each chunk is a transaction (default = 1)
	MaxPerChunk int32 `json:"max_per_chunk,omitempty"`
	// Number of requests to issue in parallel
	MaxParallelRequests int32 `json:"max_parallel_requests,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL