kvstore

type DeleteRecordsQueryParams struct {
	// Query : Query JSON expression.
	Query string `key:"query"`
}

type ErrorResponse struct {
	// Internal status code of the error.
	Code string `json:"code"`
	// Detailed error message.
	Message string `json:"message"`
}

type IndexDefinition struct {
	Fields []IndexFieldDefinition `json:"fields"`
	// The name of the index.
	Name string `json:"name"`
}

type IndexDescription struct {
	// The collection name.
	Collection *string                `json:"collection,omitempty"`
	Fields     []IndexFieldDefinition `json:"fields,omitempty"`
	// The name of the index.
	Name *string `json:"name,omitempty"`
}

type IndexFieldDefinition struct {
	// The sort direction for the indexed field.
	Direction int32 `json:"direction"`
	// The name of the field to index.
	Field string `json:"field"`
}

type Key struct {
	// Key of the inserted document.
	Key string `json:"_key"`
}

type ListRecordsQueryParams struct {
	// Count : Maximum number of records to return.
	Count *int32 `key:"count"`
	// Fields : Comma-separated list of fields to include or exclude.
	Fields  []string               `key:"fields"`
	Filters map[string]interface{} `key:"filters"`
	// Offset : Number of records to skip from the start.
	Offset *int32 `key:"offset"`
	// Orderby : Sort order. Format is `<field>:<sort order>`. Valid sort orders are 1 for ascending, -1 for descending.
	Orderby []string `key:"orderby"`
}

type PingResponse struct {
	// Database status.
	Status PingResponseStatus `json:"status"`
	// If database is not healthy, detailed error message.
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

type PingResponseStatus string

type QueryRecordsQueryParams struct {
	// Count : Maximum number of records to return.
	Count *int32 `key:"count"`
	// Fields : Comma-separated list of fields to include or exclude.
	Fields []string `key:"fields"`
	// Offset : Number of records to skip from the start.
	Offset *int32 `key:"offset"`
	// Orderby : Sort order. Format is `<field>:<sort order>`. Valid sort orders are 1 for ascending, -1 for descending.
	Orderby []string `key:"orderby"`
	// Query : Query JSON expression.
	Query string `key:"query"`
}

type Service services.BaseService

type Servicer interface {
	/*
		CreateIndex - Creates an index on a collection.
		Parameters:
			collection: The name of the collection.
			indexDefinition
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateIndex(collection string, indexDefinition IndexDefinition, resp ...*http.Response) (*IndexDescription, error)
	/*
		DeleteIndex - Removes an index from a collection.
		Parameters:
			collection: The name of the collection.
			index: The name of the index.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteIndex(collection string, index string, resp ...*http.Response) error
	/*
		DeleteRecordByKey - Deletes a record with a given key.
		Parameters:
			collection: The name of the collection.
			key: The key of the record.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteRecordByKey(collection string, key string, resp ...*http.Response) error
	/*
		DeleteRecords - Removes records in a collection that match the query.
		Parameters:
			collection: The name of the collection.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteRecords(collection string, query *DeleteRecordsQueryParams, resp ...*http.Response) error
	/*
		GetRecordByKey - Returns a record with a given key.
		Parameters:
			collection: The name of the collection.
			key: The key of the record.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRecordByKey(collection string, key string, resp ...*http.Response) (*map[string]interface{}, error)
	/*
		InsertRecord - Inserts a record into a collection.
		Parameters:
			collection: The name of the collection.
			body: Record to add to the collection, formatted as a JSON object.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	InsertRecord(collection string, body map[string]interface{}, resp ...*http.Response) (*Key, error)
	/*
		InsertRecords - Inserts multiple records in a single request.
		Parameters:
			collection: The name of the collection.
			requestBody: Array of records to insert.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	InsertRecords(collection string, requestBody []map[string]interface{}, resp ...*http.Response) ([]string, error)
	/*
		ListIndexes - Returns a list of all indexes on a collection.
		Parameters:
			collection: The name of the collection.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListIndexes(collection string, resp ...*http.Response) ([]IndexDefinition, error)
	/*
		ListRecords - Returns a list of records in a collection with basic filtering, sorting, pagination and field projection.
		Use key-value query parameters to filter fields. Fields are implicitly ANDed and values for the same field are implicitly ORed.
		Parameters:
			collection: The name of the collection.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRecords(collection string, query *ListRecordsQueryParams, resp ...*http.Response) ([]map[string]interface{}, error)
	/*
		Ping - Returns the health status from the database.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	Ping(resp ...*http.Response) (*PingResponse, error)
	/*
		PutRecord - Updates the record with a given key, either by inserting or replacing the record.
		Parameters:
			collection: The name of the collection.
			key: The key of the record.
			body: Record to add to the collection, formatted as a JSON object.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	PutRecord(collection string, key string, body map[string]interface{}, resp ...*http.Response) (*Key, error)
	/*
		QueryRecords - Returns a list of query records in a collection.
		Parameters:
			collection: The name of the collection.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	QueryRecords(collection string, query *QueryRecordsQueryParams, resp ...*http.Response) ([]map[string]interface{}, error)
}