template

type AppleWalletOptions struct {

	// Background color, in hex format, of credential when stored in an Apple Wallet.
	BackgroundColor string `protobuf:"bytes,1,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
	// Foreground color, in hex format, of credential when stored in an Apple Wallet.
	ForegroundColor string `protobuf:"bytes,2,opt,name=foreground_color,json=foregroundColor,proto3" json:"foreground_color,omitempty"`
	// Label color, in hex format, of credential when stored in an Apple Wallet.
	LabelColor string `protobuf:"bytes,3,opt,name=label_color,json=labelColor,proto3" json:"label_color,omitempty"`
	// The ID of the template field which should be used as the primary field of a credential.
	PrimaryField string `protobuf:"bytes,4,opt,name=primary_field,json=primaryField,proto3" json:"primary_field,omitempty"`
	// The secondary fields of the credential. This is a mapping between the order of a secondary field (0 or 1) and the field name.
	SecondaryFields []string `protobuf:"bytes,5,rep,name=secondary_fields,json=secondaryFields,proto3" json:"secondary_fields,omitempty"`
	// The auxiliary fields of the credential. This is a mapping between the order of an auxiliary field (0 or 1) and the field name.
	AuxiliaryFields []string `protobuf:"bytes,6,rep,name=auxiliary_fields,json=auxiliaryFields,proto3" json:"auxiliary_fields,omitempty"`
	// contains filtered or unexported fields
}

type CreateCredentialTemplateRequest struct {

	// Name of new template. Must be a unique identifier within its ecosystem.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Fields which compose the template
	Fields map[string]*TemplateField `` /* 153-byte string literal not displayed */
	// Whether credentials may be issued against this template which have fields
	// not specified in `fields`
	AllowAdditionalFields bool `` /* 127-byte string literal not displayed */
	// Human-readable name of template
	Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
	// Human-readable description of template
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// Optional map describing how to order and categorize the fields within the template. The key of this map is the field `name`.
	// If not provided, this will be auto-generated.
	FieldOrdering map[string]*FieldOrdering `` /* 188-byte string literal not displayed */
	// Options for rendering the template in Apple Wallet
	AppleWalletOptions *AppleWalletOptions `protobuf:"bytes,7,opt,name=apple_wallet_options,json=appleWalletOptions,proto3,oneof" json:"apple_wallet_options,omitempty"`
	// contains filtered or unexported fields
}

type CreateCredentialTemplateResponse struct {

	// Created template
	Data *TemplateData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

type CreateVerificationTemplateRequest struct {

	// Name of new template. Must be a unique identifier within its ecosystem.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Fields which will be required in the verification proof template
	Fields map[string]*VerificationTemplateField `` // TODO - Add support for predicate types - currently only equality.
	/* 153-byte string literal not displayed */
	// Source credential template, used for verifying that the specified `fields` are present in the credential template
	CredentialTemplateId string `protobuf:"bytes,3,opt,name=credential_template_id,json=credentialTemplateId,proto3" json:"credential_template_id,omitempty"`
	// Human-readable name of template
	Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
	// Human-readable description of template
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

type CreateVerificationTemplateResponse struct {
	Data *VerificationTemplateData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

type CredentialTemplatesClient interface {
	// Create a credential template in the current ecosystem
	Create(ctx context.Context, in *CreateCredentialTemplateRequest, opts ...grpc.CallOption) (*CreateCredentialTemplateResponse, error)
	// Fetch a credential template by ID
	Get(ctx context.Context, in *GetCredentialTemplateRequest, opts ...grpc.CallOption) (*GetCredentialTemplateResponse, error)
	// Update metadata of a template
	Update(ctx context.Context, in *UpdateCredentialTemplateRequest, opts ...grpc.CallOption) (*UpdateCredentialTemplateResponse, error)
	// Search credential templates using SQL, returning strongly-typed template data
	List(ctx context.Context, in *ListCredentialTemplatesRequest, opts ...grpc.CallOption) (*ListCredentialTemplatesResponse, error)
	// Search credential templates using SQL, returning raw JSON data
	Search(ctx context.Context, in *SearchCredentialTemplatesRequest, opts ...grpc.CallOption) (*SearchCredentialTemplatesResponse, error)
	// Delete a credential template from the current ecosystem by ID
	Delete(ctx context.Context, in *DeleteCredentialTemplateRequest, opts ...grpc.CallOption) (*DeleteCredentialTemplateResponse, error)
	// Create/update verification templates
	CreateVerificationTemplate(ctx context.Context, in *CreateVerificationTemplateRequest, opts ...grpc.CallOption) (*CreateVerificationTemplateResponse, error)
	ListVerificationTemplates(ctx context.Context, in *ListVerificationTemplatesRequest, opts ...grpc.CallOption) (*ListVerificationTemplatesResponse, error)
	GetVerificationTemplate(ctx context.Context, in *GetVerificationTemplateRequest, opts ...grpc.CallOption) (*GetVerificationTemplateResponse, error)
	UpdateVerificationTemplate(ctx context.Context, in *UpdateVerificationTemplateRequest, opts ...grpc.CallOption) (*UpdateVerificationTemplateResponse, error)
	DeleteVerificationTemplate(ctx context.Context, in *DeleteVerificationTemplateRequest, opts ...grpc.CallOption) (*DeleteVerificationTemplateResponse, error)
}

type CredentialTemplatesServer interface {
	// Create a credential template in the current ecosystem
	Create(context.Context, *CreateCredentialTemplateRequest) (*CreateCredentialTemplateResponse, error)
	// Fetch a credential template by ID
	Get(context.Context, *GetCredentialTemplateRequest) (*GetCredentialTemplateResponse, error)
	// Update metadata of a template
	Update(context.Context, *UpdateCredentialTemplateRequest) (*UpdateCredentialTemplateResponse, error)
	// Search credential templates using SQL, returning strongly-typed template data
	List(context.Context, *ListCredentialTemplatesRequest) (*ListCredentialTemplatesResponse, error)
	// Search credential templates using SQL, returning raw JSON data
	Search(context.Context, *SearchCredentialTemplatesRequest) (*SearchCredentialTemplatesResponse, error)
	// Delete a credential template from the current ecosystem by ID
	Delete(context.Context, *DeleteCredentialTemplateRequest) (*DeleteCredentialTemplateResponse, error)
	// Create/update verification templates
	CreateVerificationTemplate(context.Context, *CreateVerificationTemplateRequest) (*CreateVerificationTemplateResponse, error)
	ListVerificationTemplates(context.Context, *ListVerificationTemplatesRequest) (*ListVerificationTemplatesResponse, error)
	GetVerificationTemplate(context.Context, *GetVerificationTemplateRequest) (*GetVerificationTemplateResponse, error)
	UpdateVerificationTemplate(context.Context, *UpdateVerificationTemplateRequest) (*UpdateVerificationTemplateResponse, error)
	DeleteVerificationTemplate(context.Context, *DeleteVerificationTemplateRequest) (*DeleteVerificationTemplateResponse, error)
	// contains filtered or unexported methods
}

type DeleteCredentialTemplateRequest struct {

	// ID of template to delete
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

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

type DeleteVerificationTemplateRequest struct {
	VerificationTemplateId string `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

type FieldOrdering struct {

	// The order of the field; must be unique within the Template. Fields are sorted by order ascending when displaying a credential.
	// Field orders must be contiguous from `0` to the number of fields minus 1.
	Order int32 `protobuf:"varint,1,opt,name=order,proto3" json:"order,omitempty"`
	// The human-readable name of the section this field appears in; used to group together fields when displaying a credential.
	// Sections must be contiguous with respect to `order`.
	Section string `protobuf:"bytes,2,opt,name=section,proto3" json:"section,omitempty"`
	// contains filtered or unexported fields
}

type FieldType int32

type GetCredentialTemplateRequest struct {

	// ID of template to fetch
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetCredentialTemplateResponse struct {

	// Template fetched by ID
	Template *TemplateData `protobuf:"bytes,1,opt,name=template,proto3" json:"template,omitempty"`
	// contains filtered or unexported fields
}

type GetVerificationTemplateRequest struct {

	// ID of template to fetch
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetVerificationTemplateResponse struct {

	// Template fetched by ID
	Template *VerificationTemplateData `protobuf:"bytes,1,opt,name=template,proto3" json:"template,omitempty"`
	// contains filtered or unexported fields
}

type ListCredentialTemplatesRequest struct {

	// SQL query to execute. Example: `SELECT * FROM c WHERE c.name = 'Diploma'`
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Token provided by previous `ListCredentialTemplatesResponse`
	// if more data is available for query
	ContinuationToken string `protobuf:"bytes,2,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

type ListCredentialTemplatesResponse struct {

	// Templates found by query
	Templates []*TemplateData `protobuf:"bytes,1,rep,name=templates,proto3" json:"templates,omitempty"`
	// Whether more results are available for this query via `continuation_token`
	HasMoreResults bool `protobuf:"varint,2,opt,name=has_more_results,json=hasMoreResults,proto3" json:"has_more_results,omitempty"`
	// Token to fetch next set of results via `ListCredentialTemplatesRequest`
	ContinuationToken string `protobuf:"bytes,3,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

type ListVerificationTemplatesRequest struct {

	// SQL query to execute. Example: `SELECT * FROM c WHERE c.name = 'Diploma'`
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Token provided by previous `ListCredentialTemplatesResponse`
	// if more data is available for query
	ContinuationToken string `protobuf:"bytes,2,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

type ListVerificationTemplatesResponse struct {

	// Templates found by query
	Templates []*VerificationTemplateData `protobuf:"bytes,1,rep,name=templates,proto3" json:"templates,omitempty"`
	// Whether more results are available for this query via `continuation_token`
	HasMoreResults bool `protobuf:"varint,2,opt,name=has_more_results,json=hasMoreResults,proto3" json:"has_more_results,omitempty"`
	// Token to fetch next set of results via `ListVerificationTemplatesRequest`
	ContinuationToken string `protobuf:"bytes,3,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

type SearchCredentialTemplatesRequest struct {

	// SQL query to execute. Example: `SELECT * FROM c WHERE c.name = 'Diploma'`
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Token provided by previous `SearchCredentialTemplatesResponse`
	// if more data is available for query
	ContinuationToken string `protobuf:"bytes,2,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

type SearchCredentialTemplatesResponse struct {

	// Raw JSON data returned from query
	ItemsJson string `protobuf:"bytes,1,opt,name=items_json,json=itemsJson,proto3" json:"items_json,omitempty"`
	// Whether more results are available for this query via `continuation_token`
	HasMoreResults bool `protobuf:"varint,2,opt,name=has_more_results,json=hasMoreResults,proto3" json:"has_more_results,omitempty"`
	// Token to fetch next set of results via `SearchCredentialTemplatesRequest`
	ContinuationToken string `protobuf:"bytes,4,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

type TemplateData struct {

	// Template ID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Template name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Template version number
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// Fields defined for the template
	Fields map[string]*TemplateField `` /* 153-byte string literal not displayed */
	// Whether credentials issued against this template may
	// contain fields not defined by template
	AllowAdditionalFields bool `` /* 127-byte string literal not displayed */
	// URI pointing to template JSON schema document
	SchemaUri string `protobuf:"bytes,6,opt,name=schema_uri,json=schemaUri,proto3" json:"schema_uri,omitempty"`
	// ID of ecosystem in which template resides
	EcosystemId string `protobuf:"bytes,8,opt,name=ecosystem_id,json=ecosystemId,proto3" json:"ecosystem_id,omitempty"`
	// Template type (`VerifiableCredential`)
	Type string `protobuf:"bytes,9,opt,name=type,proto3" json:"type,omitempty"`
	// ID of template creator
	CreatedBy string `protobuf:"bytes,10,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Date when template was created as ISO 8601 utc string
	DateCreated string `protobuf:"bytes,11,opt,name=date_created,json=dateCreated,proto3" json:"date_created,omitempty"`
	// Human-readable template title
	Title string `protobuf:"bytes,12,opt,name=title,proto3" json:"title,omitempty"`
	// Human-readable template description
	Description string `protobuf:"bytes,13,opt,name=description,proto3" json:"description,omitempty"`
	// Map describing how to order and categorize the fields within the template. The key of this map is the field `name`.
	FieldOrdering map[string]*FieldOrdering `` /* 189-byte string literal not displayed */
	// Options for rendering the template in Apple Wallet
	AppleWalletOptions *AppleWalletOptions `protobuf:"bytes,15,opt,name=apple_wallet_options,json=appleWalletOptions,proto3" json:"apple_wallet_options,omitempty"`
	// contains filtered or unexported fields
}

type TemplateField struct {

	// Human-readable name of the field
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Human-readable description of the field
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Whether this field may be omitted when a credential is issued against the template
	Optional bool `protobuf:"varint,3,opt,name=optional,proto3" json:"optional,omitempty"`
	// The type of the field
	Type FieldType `protobuf:"varint,4,opt,name=type,proto3,enum=services.verifiablecredentials.templates.v1.FieldType" json:"type,omitempty"`
	// How to deal with this URI field when rendering credential. Only use if `type` is `URI`.
	UriData *UriFieldData `protobuf:"bytes,6,opt,name=uri_data,json=uriData,proto3,oneof" json:"uri_data,omitempty"`
	// contains filtered or unexported fields
}

type TemplateFieldPatch struct {

	// Human-readable name of the field
	Title *string `protobuf:"bytes,1,opt,name=title,proto3,oneof" json:"title,omitempty"`
	// Human-readable description of the field
	Description *string `protobuf:"bytes,2,opt,name=description,proto3,oneof" json:"description,omitempty"`
	// How to deal with this URI field when rendering credential. Only use if `type` is `URI`.
	UriData *UriFieldData `protobuf:"bytes,3,opt,name=uri_data,json=uriData,proto3,oneof" json:"uri_data,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedCredentialTemplatesServer struct {
}

type UnsafeCredentialTemplatesServer interface {
	// contains filtered or unexported methods
}

type UpdateCredentialTemplateRequest struct {

	// ID of Template to update
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// New human-readable title of Template
	Title *string `protobuf:"bytes,2,opt,name=title,proto3,oneof" json:"title,omitempty"`
	// New human-readable description of Template
	Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"`
	// Fields to update within the Template
	Fields map[string]*TemplateFieldPatch `` /* 153-byte string literal not displayed */
	// New field ordering options. See documentation for template creation for usage information.
	FieldOrdering map[string]*FieldOrdering `` /* 188-byte string literal not displayed */
	// New Apple Wallet configuration
	AppleWalletOptions *AppleWalletOptions `protobuf:"bytes,6,opt,name=apple_wallet_options,json=appleWalletOptions,proto3,oneof" json:"apple_wallet_options,omitempty"`
	// contains filtered or unexported fields
}

type UpdateCredentialTemplateResponse struct {

	// The Template after the update has been applied
	UpdatedTemplate *TemplateData `protobuf:"bytes,1,opt,name=updated_template,json=updatedTemplate,proto3" json:"updated_template,omitempty"`
	// contains filtered or unexported fields
}

type UpdateVerificationTemplateRequest struct {

	// ID of Template to update
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// New human-readable title of Template
	Title *string `protobuf:"bytes,2,opt,name=title,proto3,oneof" json:"title,omitempty"`
	// New human-readable description of Template
	Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"`
	// Fields to update within the Template
	Fields map[string]*VerificationTemplateFieldPatch `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type UpdateVerificationTemplateResponse struct {
	Template *VerificationTemplateData `protobuf:"bytes,1,opt,name=template,proto3" json:"template,omitempty"`
	// contains filtered or unexported fields
}

type UriFieldData struct {

	// Expected MIME Type of content pointed to by URI. Can be generic (eg, "image/") or specific ("image/png").
	// Defaults to "application/octet-stream".
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// How to display the URI value when rendering a credential.
	RenderMethod UriRenderMethod `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

type UriRenderMethod int32

type VerificationShareType int32

type VerificationTemplateData struct {

	// Template ID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Template name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Template version number
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// Fields defined for the template
	Fields map[string]*VerificationTemplateField `` /* 153-byte string literal not displayed */
	// Source credential template, used for verifying that the specified `fields` are present in the credential template
	CredentialTemplateId string `protobuf:"bytes,5,opt,name=credential_template_id,json=credentialTemplateId,proto3" json:"credential_template_id,omitempty"`
	// ID of ecosystem in which template resides
	EcosystemId string `protobuf:"bytes,8,opt,name=ecosystem_id,json=ecosystemId,proto3" json:"ecosystem_id,omitempty"`
	// Template type (`VerificationTemplate`)
	Type string `protobuf:"bytes,9,opt,name=type,proto3" json:"type,omitempty"`
	// ID of template creator
	CreatedBy string `protobuf:"bytes,10,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Date when template was created as ISO 8601 utc string
	DateCreated string `protobuf:"bytes,11,opt,name=date_created,json=dateCreated,proto3" json:"date_created,omitempty"`
	// Human-readable template title
	Title string `protobuf:"bytes,12,opt,name=title,proto3" json:"title,omitempty"`
	// Human-readable template description
	Description string `protobuf:"bytes,13,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

type VerificationTemplateField struct {

	// Whether this field may be omitted on proof creation
	FieldShareType VerificationShareType `` /* 177-byte string literal not displayed */
	// User-facing explanation of what is done with this data
	UsagePolicy string `protobuf:"bytes,2,opt,name=usage_policy,json=usagePolicy,proto3" json:"usage_policy,omitempty"` // TODO - Future work supporting proof conditionals/ranges/etc
	// contains filtered or unexported fields
}

type VerificationTemplateFieldPatch struct {

	// Human-readable name of the field
	FieldShareType VerificationShareType `` /* 177-byte string literal not displayed */
	// User-facing explanation of what is done with this data
	UsagePolicy string `protobuf:"bytes,2,opt,name=usage_policy,json=usagePolicy,proto3" json:"usage_policy,omitempty"`
	// contains filtered or unexported fields
}