policystore

type CreateEntitlementPolicyRequest struct {
	// This attribute is used to attach a human friendly label to the policy
	// suitable for presenting to the end user in the DECODE wallet. This is a
	// required field.
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// The list of operations we wish to create for the policy. This field is
	// required, and it is required that the client supplies at least one
	// Operation.
	Operations []*Operation `protobuf:"bytes,3,rep,name=operations,proto3" json:"operations,omitempty"`
	// This attribute contains an identifier of an authorizable attribute required
	// for taking part in the Coconut protocol.
	AuthorizableAttributeId string `` /* 132-byte string literal not displayed */
	// This attribute contains a reference to the credential issuer service the
	// end user must interact with in order to obtain blind credentials when
	// taking part in the Coconut protocol.
	CredentialIssuerEndpointUrl string `` /* 146-byte string literal not displayed */
	// Multi language description of the community for which this policy applies
	// consisting of a map where the map keys are a standard language code, and
	// the value is the description in that language.
	Descriptions         map[string]string `` /* 165-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

type CreateEntitlementPolicyResponse struct {
	// This attribute contains a unique identifier for the community that can be
	// used for later requests to either join a community to a specific device, or
	// to delete the policy and so prevent new instances being applied to devices.
	CommunityId string `protobuf:"bytes,3,opt,name=community_id,json=communityId,proto3" json:"community_id,omitempty"`
	// This attribute contains a secret generated by the service that is
	// associated with the policy. This token is required to be presented by a
	// caller when deleting a policy, so must be treated as confidential by the
	// caller.
	Token                string   `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DeleteEntitlementPolicyRequest struct {
	// This attribute contains the unique community identifier returned when
	// creating the policy. This is a required field.
	CommunityId string `protobuf:"bytes,3,opt,name=community_id,json=communityId,proto3" json:"community_id,omitempty"`
	// This attribute contains the token returned to the creator when they
	// created the policy, and must match the value stored within the
	// PolicyStore. This is a required field.
	Token                string   `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DeleteEntitlementPolicyResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type ListEntitlementPoliciesRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ListEntitlementPoliciesResponse struct {
	// This attribute contains the list of all policies currently available on
	// the device registration service.
	Policies             []*ListEntitlementPoliciesResponse_Policy `protobuf:"bytes,1,rep,name=policies,proto3" json:"policies,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                                  `json:"-"`
	XXX_unrecognized     []byte                                    `json:"-"`
	XXX_sizecache        int32                                     `json:"-"`
}

type ListEntitlementPoliciesResponse_Policy struct {
	// This attribute contains the unique identifier of the policy.
	CommunityId string `protobuf:"bytes,7,opt,name=community_id,json=communityId,proto3" json:"community_id,omitempty"`
	// This attribute contains a human friendly label describing the policy
	// suitable for rendering in the DECODE wallet
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// This field contains a list of the operations that define the policy.
	Operations []*Operation `protobuf:"bytes,3,rep,name=operations,proto3" json:"operations,omitempty"`
	// This attribute contains the public key of the policy. This public key
	// attribute is the label applied to the bucket within the datastore which
	// will be how data can be downloaded for the entitlement policy.
	PublicKey string `protobuf:"bytes,4,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// This attribute contains an identifier of an authorizable attribute required
	// for taking part in the Coconut protocol.
	AuthorizableAttributeId string `` /* 132-byte string literal not displayed */
	// This attribute contains a reference to the credential issuer service the
	// end user must interact with in order to obtain blind credentials when
	// taking part in the Coconut protocol.
	CredentialIssuerEndpointUrl string `` /* 146-byte string literal not displayed */
	// Multi language description of the community for which this policy applies
	// consisting of a map where the map keys are a standard language code, and
	// the value is the description in that language.
	Descriptions         map[string]string `` /* 165-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

type Operation struct {
	// The unique id of the sensor type for which this specific entitlement is
	// defined. This is a required field.
	SensorId uint32 `protobuf:"varint,1,opt,name=sensor_id,json=sensorId,proto3" json:"sensor_id,omitempty"`
	// The specific action this operation defines for the sensor type. This is a
	// required field.
	Action Operation_Action `protobuf:"varint,2,opt,name=action,proto3,enum=decode.iot.policystore.Operation_Action" json:"action,omitempty"`
	// The bins attribute is used to specify the the bins into which incoming
	// values should be classified. Each element in the list is the upper
	// inclusive bound of a bin. The values submitted must be sorted in strictly
	// increasing order. There is no need to add a highest bin with +Inf bound, it
	// will be added implicitly. This field is optional unless an Action of `BIN`
	// has been requested, in which case it is required. It is an error to send
	// values for this attribute unless the value of Action is `BIN`.
	Bins []float64 `protobuf:"fixed64,3,rep,packed,name=bins,proto3" json:"bins,omitempty"`
	// This attribute is used to control the entitlement in the case for which we
	// have specified an action type representing a moving average. It represents
	// the interval in seconds over which the moving average should be calculated,
	// e.g. for a 15 minute moving average the value supplied here would be 900.
	// This field is optional unless an Action of `MOVING_AVG` has been specified,
	// in which case it is required. It is an error to send a value for this
	// attribute unless the value of Action is `MOVING_AVG`.
	Interval             uint32   `protobuf:"varint,4,opt,name=interval,proto3" json:"interval,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Operation_Action int32

type PolicyStore interface {
	// CreateEntitlementPolicy is a method exposed by the service which allows a
	// new entitlement policy to be created and stored within the device
	// registration service. Once a policy has been created, users will then be
	// able to apply this policy to their devices via the wallet.
	CreateEntitlementPolicy(context.Context, *CreateEntitlementPolicyRequest) (*CreateEntitlementPolicyResponse, error)

	// DeleteEntitlementPolicy is a method exposed by the service which allows an
	// authorized client to request that an entitlement policy be deleted.
	// Deleting a policy will not affect any existing devices that have already
	// used the policy in order to create one or more streams within the encoder,
	// however it will prevent any new applications of that policy to other
	// devices.
	DeleteEntitlementPolicy(context.Context, *DeleteEntitlementPolicyRequest) (*DeleteEntitlementPolicyResponse, error)

	// ListEntitlementPolicies is a method exposed by the service which returns a
	// list of all policies currently defined and available within the service to
	// be applied to devices. Currently it just returns a list of all known
	// policies with no capability to filter or paginate these policies.
	ListEntitlementPolicies(context.Context, *ListEntitlementPoliciesRequest) (*ListEntitlementPoliciesResponse, error)
}

type TwirpServer interface {
	http.Handler
	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// github.com/golang/protobuf/protoc-gen-go/descriptor.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)
	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string
}