Documentation
¶
Overview ¶
Package eric is the contract-pinned, machine-only ERiC SDK.
Code generated from the pinned ERiC public catalog. Do not edit.
Index ¶
- Constants
- func Wait[T any](ctx context.Context, timeout time.Duration, ...) (T, error)
- type APIError
- type Client
- func (c *Client) ConfirmDelegatedReview(ctx context.Context, productId genprod.ID, reviewId genprod.ID, ...) (*genprod.ConfirmDelegatedReviewResponse, error)
- func (c *Client) ConfirmEBilanzMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.ConfirmEBilanzMappingResponse, error)
- func (c *Client) ConfirmFilingConsent(ctx context.Context, productId genprod.ID, consentId genprod.ID, ...) (*genprod.ConfirmFilingConsentResponse, error)
- func (c *Client) ConfirmUStVAMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.ConfirmUStVAMappingResponse, error)
- func (c *Client) CreateCredentialIntake(ctx context.Context, productId genprod.ID, ...) (*genprod.CreateCredentialIntakeResponse, error)
- func (c *Client) CreateDelegatedReview(ctx context.Context, productId genprod.ID, preparationId genprod.ID, ...) (*genprod.CreateDelegatedReviewResponse, error)
- func (c *Client) CreateDraft(ctx context.Context, productId genprod.ID, params *genprod.CreateDraftParams, ...) (*genprod.CreateDraftResponse, error)
- func (c *Client) CreateEBilanzMapping(ctx context.Context, productId genprod.ID, ...) (*genprod.CreateEBilanzMappingResponse, error)
- func (c *Client) CreateEricTestSimulation(ctx context.Context, tenantId gentest.Tenant, productId gentest.Product, ...) (*gentest.CreateEricTestSimulationResponse, error)
- func (c *Client) CreateFilingConsent(ctx context.Context, productId genprod.ID, preparationId genprod.ID, ...) (*genprod.CreateFilingConsentResponse, error)
- func (c *Client) CreatePreparation(ctx context.Context, productId genprod.ID, ...) (*genprod.CreatePreparationResponse, error)
- func (c *Client) CreateProfile(ctx context.Context, productId genprod.ID, params *genprod.CreateProfileParams, ...) (*genprod.CreateProfileResponse, error)
- func (c *Client) CreateRetrievalArchiveAcknowledgement(ctx context.Context, productId genprod.ID, artifactId genprod.ID, ...) (*genprod.CreateRetrievalArchiveAcknowledgementResponse, error)
- func (c *Client) CreateRetrievalDecryption(ctx context.Context, productId genprod.ID, ...) (*genprod.CreateRetrievalDecryptionResponse, error)
- func (c *Client) CreateRetrievalPreservation(ctx context.Context, productId genprod.ID, decryptionId genprod.ID, ...) (*genprod.CreateRetrievalPreservationResponse, error)
- func (c *Client) CreateUStVAMapping(ctx context.Context, productId genprod.ID, ...) (*genprod.CreateUStVAMappingResponse, error)
- func (c *Client) CreateUtility(ctx context.Context, productId genprod.ID, params *genprod.CreateUtilityParams, ...) (*genprod.CreateUtilityResponse, error)
- func (c *Client) CreateValidation(ctx context.Context, productId genprod.ID, ...) (*genprod.CreateValidationResponse, error)
- func (c *Client) GetCredentialOperation(ctx context.Context, productId genprod.ID, intakeId genprod.ID, ...) (*genprod.GetCredentialOperationResponse, error)
- func (c *Client) GetDelegatedReview(ctx context.Context, productId genprod.ID, reviewId genprod.ID, ...) (*genprod.GetDelegatedReviewResponse, error)
- func (c *Client) GetDraft(ctx context.Context, productId genprod.ID, draftId genprod.ID, ...) (*genprod.GetDraftResponse, error)
- func (c *Client) GetDraftRevision(ctx context.Context, productId genprod.ID, draftId genprod.ID, ...) (*genprod.GetDraftRevisionResponse, error)
- func (c *Client) GetEBilanzMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.GetEBilanzMappingResponse, error)
- func (c *Client) GetEBilanzMappingCatalog(ctx context.Context, productId genprod.ID, ...) (*genprod.GetEBilanzMappingCatalogResponse, error)
- func (c *Client) GetEBilanzMappingRevision(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.GetEBilanzMappingRevisionResponse, error)
- func (c *Client) GetEricTestSimulation(ctx context.Context, tenantId gentest.Tenant, productId gentest.Product, ...) (*gentest.GetEricTestSimulationResponse, error)
- func (c *Client) GetFilingConsent(ctx context.Context, productId genprod.ID, consentId genprod.ID, ...) (*genprod.GetFilingConsentResponse, error)
- func (c *Client) GetPreparation(ctx context.Context, productId genprod.ID, preparationId genprod.ID, ...) (*genprod.GetPreparationResponse, error)
- func (c *Client) GetPreparationArtifact(ctx context.Context, productId genprod.ID, preparationId genprod.ID, ...) (*genprod.GetPreparationArtifactResponse, error)
- func (c *Client) GetProfile(ctx context.Context, productId genprod.ID, version genprod.ProfileVersion, ...) (*genprod.GetProfileResponse, error)
- func (c *Client) GetRetrievalArtifact(ctx context.Context, productId genprod.ID, artifactId genprod.ID, ...) (*genprod.GetRetrievalArtifactResponse, error)
- func (c *Client) GetRetrievalArtifactContent(ctx context.Context, productId genprod.ID, artifactId genprod.ID, ...) (*genprod.GetRetrievalArtifactContentResponse, error)
- func (c *Client) GetRetrievalDecryption(ctx context.Context, productId genprod.ID, decryptionId genprod.ID, ...) (*genprod.GetRetrievalDecryptionResponse, error)
- func (c *Client) GetSimulation(ctx context.Context, product, simulation uuid.UUID) (Simulation, error)
- func (c *Client) GetSoftwareCredential(ctx context.Context, productId genprod.ID, credentialId genprod.ID, ...) (*genprod.GetSoftwareCredentialResponse, error)
- func (c *Client) GetUStVADerivedRules(ctx context.Context, productId genprod.ID, ...) (*genprod.GetUStVADerivedRulesResponse, error)
- func (c *Client) GetUStVAFieldCatalog(ctx context.Context, productId genprod.ID, ...) (*genprod.GetUStVAFieldCatalogResponse, error)
- func (c *Client) GetUStVAMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.GetUStVAMappingResponse, error)
- func (c *Client) GetUStVAMappingRevision(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.GetUStVAMappingRevisionResponse, error)
- func (c *Client) GetUserNotices(ctx context.Context, productId genprod.ID, ...) (*genprod.GetUserNoticesResponse, error)
- func (c *Client) GetUtility(ctx context.Context, productId genprod.ID, utilityId genprod.ID, ...) (*genprod.GetUtilityResponse, error)
- func (c *Client) GetValidation(ctx context.Context, productId genprod.ID, validationId genprod.ID, ...) (*genprod.GetValidationResponse, error)
- func (c *Client) GetValidationArtifact(ctx context.Context, productId genprod.ID, validationId genprod.ID, ...) (*genprod.GetValidationArtifactResponse, error)
- func (c *Client) PlanEBilanzForm(ctx context.Context, productId genprod.ID, ...) (*genprod.PlanEBilanzFormResponse, error)
- func (c *Client) ReviseDraft(ctx context.Context, productId genprod.ID, draftId genprod.ID, ...) (*genprod.ReviseDraftResponse, error)
- func (c *Client) ReviseEBilanzMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.ReviseEBilanzMappingResponse, error)
- func (c *Client) ReviseUStVAMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.ReviseUStVAMappingResponse, error)
- func (c *Client) RevokeDelegatedReview(ctx context.Context, productId genprod.ID, reviewId genprod.ID, ...) (*genprod.RevokeDelegatedReviewResponse, error)
- func (c *Client) RevokeFilingConsent(ctx context.Context, productId genprod.ID, consentId genprod.ID, ...) (*genprod.RevokeFilingConsentResponse, error)
- func (c *Client) RevokeSoftwareCredential(ctx context.Context, productId genprod.ID, credentialId genprod.ID, ...) (*genprod.RevokeSoftwareCredentialResponse, error)
- func (c *Client) Simulate(ctx context.Context, product uuid.UUID, fixture SimulationFixture, ...) (Simulation, error)
- func (c *Client) WithdrawEBilanzMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.WithdrawEBilanzMappingResponse, error)
- func (c *Client) WithdrawUStVAMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, ...) (*genprod.WithdrawUStVAMappingResponse, error)
- type Profile
- type Simulation
- type SimulationFixture
- type SimulationOutcome
Constants ¶
View Source
const ( ValidationAccepted SimulationFixture = "validation-accepted-v1" ValidationRejected SimulationFixture = "validation-rejected-v1" SimulatedAccepted SimulationOutcome = "simulated_accepted" SimulatedRejected SimulationOutcome = "simulated_rejected" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
NewClient accepts a preconfigured shared machine client; injectable for offline fixtures.
func NewMachineClient ¶
func (*Client) ConfirmDelegatedReview ¶
func (c *Client) ConfirmDelegatedReview(ctx context.Context, productId genprod.ID, reviewId genprod.ID, params *genprod.ConfirmDelegatedReviewParams, body genprod.ConfirmDelegatedReviewJSONRequestBody) (*genprod.ConfirmDelegatedReviewResponse, error)
func (*Client) ConfirmEBilanzMapping ¶
func (*Client) ConfirmFilingConsent ¶
func (c *Client) ConfirmFilingConsent(ctx context.Context, productId genprod.ID, consentId genprod.ID, params *genprod.ConfirmFilingConsentParams, body genprod.ConfirmFilingConsentJSONRequestBody) (*genprod.ConfirmFilingConsentResponse, error)
func (*Client) ConfirmUStVAMapping ¶
func (*Client) CreateCredentialIntake ¶
func (c *Client) CreateCredentialIntake(ctx context.Context, productId genprod.ID, params *genprod.CreateCredentialIntakeParams, body genprod.CreateCredentialIntakeJSONRequestBody) (*genprod.CreateCredentialIntakeResponse, error)
func (*Client) CreateDelegatedReview ¶
func (c *Client) CreateDelegatedReview(ctx context.Context, productId genprod.ID, preparationId genprod.ID, params *genprod.CreateDelegatedReviewParams, body genprod.CreateDelegatedReviewJSONRequestBody) (*genprod.CreateDelegatedReviewResponse, error)
func (*Client) CreateDraft ¶
func (c *Client) CreateDraft(ctx context.Context, productId genprod.ID, params *genprod.CreateDraftParams, body genprod.CreateDraftJSONRequestBody) (*genprod.CreateDraftResponse, error)
func (*Client) CreateEBilanzMapping ¶
func (c *Client) CreateEBilanzMapping(ctx context.Context, productId genprod.ID, params *genprod.CreateEBilanzMappingParams, body genprod.CreateEBilanzMappingJSONRequestBody) (*genprod.CreateEBilanzMappingResponse, error)
func (*Client) CreateEricTestSimulation ¶
func (c *Client) CreateEricTestSimulation(ctx context.Context, tenantId gentest.Tenant, productId gentest.Product, params *gentest.CreateEricTestSimulationParams, body gentest.CreateEricTestSimulationJSONRequestBody) (*gentest.CreateEricTestSimulationResponse, error)
func (*Client) CreateFilingConsent ¶
func (c *Client) CreateFilingConsent(ctx context.Context, productId genprod.ID, preparationId genprod.ID, params *genprod.CreateFilingConsentParams, body genprod.CreateFilingConsentJSONRequestBody) (*genprod.CreateFilingConsentResponse, error)
func (*Client) CreatePreparation ¶
func (c *Client) CreatePreparation(ctx context.Context, productId genprod.ID, params *genprod.CreatePreparationParams, body genprod.CreatePreparationJSONRequestBody) (*genprod.CreatePreparationResponse, error)
func (*Client) CreateProfile ¶
func (c *Client) CreateProfile(ctx context.Context, productId genprod.ID, params *genprod.CreateProfileParams, body genprod.CreateProfileJSONRequestBody) (*genprod.CreateProfileResponse, error)
func (*Client) CreateRetrievalArchiveAcknowledgement ¶
func (c *Client) CreateRetrievalArchiveAcknowledgement(ctx context.Context, productId genprod.ID, artifactId genprod.ID, params *genprod.CreateRetrievalArchiveAcknowledgementParams, body genprod.CreateRetrievalArchiveAcknowledgementJSONRequestBody) (*genprod.CreateRetrievalArchiveAcknowledgementResponse, error)
func (*Client) CreateRetrievalDecryption ¶
func (c *Client) CreateRetrievalDecryption(ctx context.Context, productId genprod.ID, params *genprod.CreateRetrievalDecryptionParams, body genprod.CreateRetrievalDecryptionJSONRequestBody) (*genprod.CreateRetrievalDecryptionResponse, error)
func (*Client) CreateRetrievalPreservation ¶
func (c *Client) CreateRetrievalPreservation(ctx context.Context, productId genprod.ID, decryptionId genprod.ID, params *genprod.CreateRetrievalPreservationParams, body genprod.CreateRetrievalPreservationJSONRequestBody) (*genprod.CreateRetrievalPreservationResponse, error)
func (*Client) CreateUStVAMapping ¶
func (c *Client) CreateUStVAMapping(ctx context.Context, productId genprod.ID, params *genprod.CreateUStVAMappingParams, body genprod.CreateUStVAMappingJSONRequestBody) (*genprod.CreateUStVAMappingResponse, error)
func (*Client) CreateUtility ¶
func (c *Client) CreateUtility(ctx context.Context, productId genprod.ID, params *genprod.CreateUtilityParams, body genprod.CreateUtilityJSONRequestBody) (*genprod.CreateUtilityResponse, error)
func (*Client) CreateValidation ¶
func (c *Client) CreateValidation(ctx context.Context, productId genprod.ID, params *genprod.CreateValidationParams, body genprod.CreateValidationJSONRequestBody) (*genprod.CreateValidationResponse, error)
func (*Client) GetCredentialOperation ¶
func (*Client) GetDelegatedReview ¶
func (*Client) GetDraftRevision ¶
func (*Client) GetEBilanzMapping ¶
func (*Client) GetEBilanzMappingCatalog ¶
func (c *Client) GetEBilanzMappingCatalog(ctx context.Context, productId genprod.ID, params *genprod.GetEBilanzMappingCatalogParams) (*genprod.GetEBilanzMappingCatalogResponse, error)
func (*Client) GetEBilanzMappingRevision ¶
func (*Client) GetEricTestSimulation ¶
func (c *Client) GetEricTestSimulation(ctx context.Context, tenantId gentest.Tenant, productId gentest.Product, simulationId openapi_types.UUID, params *gentest.GetEricTestSimulationParams) (*gentest.GetEricTestSimulationResponse, error)
func (*Client) GetFilingConsent ¶
func (*Client) GetPreparation ¶
func (*Client) GetPreparationArtifact ¶
func (c *Client) GetPreparationArtifact(ctx context.Context, productId genprod.ID, preparationId genprod.ID, kind genprod.GetPreparationArtifactParamsKind, params *genprod.GetPreparationArtifactParams) (*genprod.GetPreparationArtifactResponse, error)
func (*Client) GetProfile ¶
func (c *Client) GetProfile(ctx context.Context, productId genprod.ID, version genprod.ProfileVersion, params *genprod.GetProfileParams) (*genprod.GetProfileResponse, error)
func (*Client) GetRetrievalArtifact ¶
func (*Client) GetRetrievalArtifactContent ¶
func (c *Client) GetRetrievalArtifactContent(ctx context.Context, productId genprod.ID, artifactId genprod.ID, kind genprod.GetRetrievalArtifactContentParamsKind, params *genprod.GetRetrievalArtifactContentParams) (*genprod.GetRetrievalArtifactContentResponse, error)
func (*Client) GetRetrievalDecryption ¶
func (*Client) GetSimulation ¶
func (c *Client) GetSimulation(ctx context.Context, product, simulation uuid.UUID) (Simulation, error)
GetSimulation reads the immutable result of a synthetic test fixture.
func (*Client) GetSoftwareCredential ¶
func (*Client) GetUStVADerivedRules ¶
func (c *Client) GetUStVADerivedRules(ctx context.Context, productId genprod.ID, params *genprod.GetUStVADerivedRulesParams) (*genprod.GetUStVADerivedRulesResponse, error)
func (*Client) GetUStVAFieldCatalog ¶
func (c *Client) GetUStVAFieldCatalog(ctx context.Context, productId genprod.ID, params *genprod.GetUStVAFieldCatalogParams) (*genprod.GetUStVAFieldCatalogResponse, error)
func (*Client) GetUStVAMapping ¶
func (*Client) GetUStVAMappingRevision ¶
func (*Client) GetUserNotices ¶
func (c *Client) GetUserNotices(ctx context.Context, productId genprod.ID, params *genprod.GetUserNoticesParams) (*genprod.GetUserNoticesResponse, error)
func (*Client) GetUtility ¶
func (*Client) GetValidation ¶
func (*Client) GetValidationArtifact ¶
func (c *Client) GetValidationArtifact(ctx context.Context, productId genprod.ID, validationId genprod.ID, kind genprod.GetValidationArtifactParamsKind, params *genprod.GetValidationArtifactParams) (*genprod.GetValidationArtifactResponse, error)
func (*Client) PlanEBilanzForm ¶
func (c *Client) PlanEBilanzForm(ctx context.Context, productId genprod.ID, params *genprod.PlanEBilanzFormParams, body genprod.PlanEBilanzFormJSONRequestBody) (*genprod.PlanEBilanzFormResponse, error)
func (*Client) ReviseDraft ¶
func (c *Client) ReviseDraft(ctx context.Context, productId genprod.ID, draftId genprod.ID, params *genprod.ReviseDraftParams, body genprod.ReviseDraftJSONRequestBody) (*genprod.ReviseDraftResponse, error)
func (*Client) ReviseEBilanzMapping ¶
func (c *Client) ReviseEBilanzMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, params *genprod.ReviseEBilanzMappingParams, body genprod.ReviseEBilanzMappingJSONRequestBody) (*genprod.ReviseEBilanzMappingResponse, error)
func (*Client) ReviseUStVAMapping ¶
func (c *Client) ReviseUStVAMapping(ctx context.Context, productId genprod.ID, mappingId genprod.MappingID, params *genprod.ReviseUStVAMappingParams, body genprod.ReviseUStVAMappingJSONRequestBody) (*genprod.ReviseUStVAMappingResponse, error)
func (*Client) RevokeDelegatedReview ¶
func (c *Client) RevokeDelegatedReview(ctx context.Context, productId genprod.ID, reviewId genprod.ID, params *genprod.RevokeDelegatedReviewParams, body genprod.RevokeDelegatedReviewJSONRequestBody) (*genprod.RevokeDelegatedReviewResponse, error)
func (*Client) RevokeFilingConsent ¶
func (c *Client) RevokeFilingConsent(ctx context.Context, productId genprod.ID, consentId genprod.ID, params *genprod.RevokeFilingConsentParams, body genprod.RevokeFilingConsentJSONRequestBody) (*genprod.RevokeFilingConsentResponse, error)
func (*Client) RevokeSoftwareCredential ¶
func (*Client) Simulate ¶
func (c *Client) Simulate(ctx context.Context, product uuid.UUID, fixture SimulationFixture, idempotencyKey string) (Simulation, error)
Simulate creates one allowed test fixture; it never calls the production API.
func (*Client) WithdrawEBilanzMapping ¶
func (*Client) WithdrawUStVAMapping ¶
type Simulation ¶
type Simulation struct {
ID uuid.UUID `json:"id"`
Fixture SimulationFixture `json:"fixture"`
Status string `json:"status"`
Outcome SimulationOutcome `json:"outcome"`
Simulated bool `json:"simulated"`
}
type SimulationFixture ¶
type SimulationFixture string
Simulation is the deterministic, synthetic-only ERiC test result.
type SimulationOutcome ¶
type SimulationOutcome string
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
fixture
command
Offline ERiC example: production notice read and both test simulations.
|
Offline ERiC example: production notice read and both test simulations. |
|
Package genprod provides primitives to interact with the openapi HTTP API.
|
Package genprod provides primitives to interact with the openapi HTTP API. |
|
Package gentest provides primitives to interact with the openapi HTTP API.
|
Package gentest provides primitives to interact with the openapi HTTP API. |
Click to show internal directories.
Click to hide internal directories.