idoklad/bin/Release/net8.0/Idoklad.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Idoklad</name>
    </assembly>
    <members>
        <member name="T:Idoklad.Client.ApiResultExtensions">
            <summary>
            Helpers that unwrap the SDK's <see cref="T:IdokladSdk.Response.ApiResult`1"/> envelope, returning the payload
            on success and translating failures into <see cref="T:Idoklad.Client.IdokladApiException"/>.
            </summary>
        </member>
        <member name="T:Idoklad.Client.DokladApiFactory">
            <summary>
            Builds <see cref="T:IdokladSdk.DokladApi"/> instances from resolved per-request credentials, using the
            official iDoklad .NET SDK (IdokladSdk) and an <see cref="T:System.Net.Http.IHttpClientFactory"/>-managed
            <see cref="T:System.Net.Http.HttpClient"/>. This is the iDoklad analogue of microsoft-365-service's graph_client.
            </summary>
        </member>
        <member name="T:Idoklad.Client.IdokladApiAccessor">
            <summary>
            Scoped accessor that resolves the credentials for the current request and lazily builds a
            single <see cref="T:IdokladSdk.DokladApi"/> shared by all services handling that request.
            </summary>
        </member>
        <member name="T:Idoklad.Client.IdokladApiException">
            <summary>
            Raised when an upstream iDoklad API call does not succeed. Carries the upstream HTTP status
            code, message and iDoklad error code so the failure can be surfaced to the caller.
            </summary>
        </member>
        <member name="T:Idoklad.Configuration.IdokladSettings">
             <summary>
             Service configuration resolved from environment variables.
            
             Mirrors the structure used by the sibling microsoft-365-service (config.py): non-secret
             configuration and credential defaults live in environment variables. Per-request callers
             can override the credential values through request headers (see
             <see cref="T:Idoklad.Credentials.RequestCredentialsProvider"/>).
             </summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.ClientId">
            <summary>Default iDoklad OAuth2 client id (client credentials flow).</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.ClientSecret">
            <summary>Default iDoklad OAuth2 client secret (client credentials flow).</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.ApplicationId">
            <summary>Default iDoklad application id from the developer portal (required by client credentials flow).</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.ApiUrl">
            <summary>Optional custom iDoklad API base url (defaults to the SDK production url when empty).</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.IdentityServerUrl">
            <summary>Optional custom Identity Server token url (defaults to the SDK production url when empty).</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.Language">
            <summary>Default response language for the iDoklad API (Cz, Sk, En). Defaults to Cz.</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.HasCustomUrls">
            <summary>True when both custom urls are configured (e.g. for a sandbox environment).</summary>
        </member>
        <member name="P:Idoklad.Configuration.IdokladSettings.HasDefaultCredentials">
            <summary>True when the default credential triplet is fully configured via environment variables.</summary>
        </member>
        <member name="T:Idoklad.Controllers.AccountController">
            <summary>
            Account agenda: the current agenda (company) and current user. Requires iDoklad credentials
            (headers or environment defaults).
            </summary>
        </member>
        <member name="M:Idoklad.Controllers.AccountController.Agenda(System.Threading.CancellationToken)">
            <summary>Get information about the current agenda (company).</summary>
        </member>
        <member name="M:Idoklad.Controllers.AccountController.CurrentUser(System.Threading.CancellationToken)">
            <summary>Get information about the current user.</summary>
        </member>
        <member name="T:Idoklad.Controllers.ContactsController">
             <summary>
             Contacts (customers/suppliers) agenda.
            
             All endpoints require iDoklad credentials. Provide them as request headers
             (<c>X-ClientId</c>, <c>X-ClientSecret</c>, <c>X-ApplicationId</c>) or rely on the service
             environment defaults. See the Swagger description for details.
             </summary>
        </member>
        <member name="M:Idoklad.Controllers.ContactsController.List(System.Int32,System.Int32,System.Threading.CancellationToken)">
            <summary>List contacts (paged).</summary>
        </member>
        <member name="M:Idoklad.Controllers.ContactsController.Detail(System.Int32,System.Threading.CancellationToken)">
            <summary>Get a contact detail by id.</summary>
        </member>
        <member name="M:Idoklad.Controllers.ContactsController.Default(System.Threading.CancellationToken)">
            <summary>Get a pre-filled default contact model for creating a new contact.</summary>
        </member>
        <member name="M:Idoklad.Controllers.ContactsController.Create(IdokladSdk.Models.Contact.ContactPostModel,System.Threading.CancellationToken)">
            <summary>Create a new contact.</summary>
        </member>
        <member name="M:Idoklad.Controllers.ContactsController.Update(IdokladSdk.Models.Contact.ContactPatchModel,System.Threading.CancellationToken)">
            <summary>Update an existing contact (the model id identifies the contact).</summary>
        </member>
        <member name="M:Idoklad.Controllers.ContactsController.Delete(System.Int32,System.Threading.CancellationToken)">
            <summary>Delete a contact by id.</summary>
        </member>
        <member name="T:Idoklad.Controllers.IssuedInvoicesController">
            <summary>
            Issued (outgoing) invoices agenda. Requires iDoklad credentials (headers or environment
            defaults).
            </summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.List(System.Int32,System.Int32,System.Threading.CancellationToken)">
            <summary>List issued invoices (paged).</summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.Detail(System.Int32,System.Threading.CancellationToken)">
            <summary>Get an issued invoice detail by id.</summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.Default(System.Threading.CancellationToken)">
            <summary>Get a pre-filled default model for creating a new issued invoice.</summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.Create(IdokladSdk.Models.IssuedInvoice.IssuedInvoicePostModel,System.Threading.CancellationToken)">
            <summary>Create a new issued invoice.</summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.Update(IdokladSdk.Models.IssuedInvoice.IssuedInvoicePatchModel,System.Threading.CancellationToken)">
            <summary>Update an existing issued invoice (the model id identifies the invoice).</summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.Copy(System.Int32,System.Threading.CancellationToken)">
            <summary>Create a copy (draft) of an existing issued invoice.</summary>
        </member>
        <member name="M:Idoklad.Controllers.IssuedInvoicesController.Delete(System.Int32,System.Threading.CancellationToken)">
            <summary>Delete an issued invoice by id.</summary>
        </member>
        <member name="T:Idoklad.Controllers.MetaController">
            <summary>Service metadata endpoints. These do not require iDoklad credentials.</summary>
        </member>
        <member name="M:Idoklad.Controllers.MetaController.Health">
            <summary>Liveness probe.</summary>
        </member>
        <member name="M:Idoklad.Controllers.MetaController.Version">
            <summary>Service name, version and language.</summary>
        </member>
        <member name="M:Idoklad.Controllers.MetaController.Status">
            <summary>
            Reports whether the service has default iDoklad credentials configured through
            environment variables. Per-request callers can always override them with headers.
            </summary>
        </member>
        <member name="T:Idoklad.Controllers.ReceivedInvoicesController">
            <summary>
            Received (incoming) invoices agenda. Requires iDoklad credentials (headers or environment
            defaults).
            </summary>
        </member>
        <member name="M:Idoklad.Controllers.ReceivedInvoicesController.List(System.Int32,System.Int32,System.Threading.CancellationToken)">
            <summary>List received invoices (paged).</summary>
        </member>
        <member name="M:Idoklad.Controllers.ReceivedInvoicesController.Detail(System.Int32,System.Threading.CancellationToken)">
            <summary>Get a received invoice detail by id.</summary>
        </member>
        <member name="M:Idoklad.Controllers.ReceivedInvoicesController.Default(System.Threading.CancellationToken)">
            <summary>Get a pre-filled default model for creating a new received invoice.</summary>
        </member>
        <member name="M:Idoklad.Controllers.ReceivedInvoicesController.Create(IdokladSdk.Models.ReceivedInvoice.ReceivedInvoicePostModel,System.Threading.CancellationToken)">
            <summary>Create a new received invoice.</summary>
        </member>
        <member name="M:Idoklad.Controllers.ReceivedInvoicesController.Update(IdokladSdk.Models.ReceivedInvoice.ReceivedInvoicePatchModel,System.Threading.CancellationToken)">
            <summary>Update an existing received invoice (the model id identifies the invoice).</summary>
        </member>
        <member name="M:Idoklad.Controllers.ReceivedInvoicesController.Delete(System.Int32,System.Threading.CancellationToken)">
            <summary>Delete a received invoice by id.</summary>
        </member>
        <member name="T:Idoklad.Controllers.RegistersController">
            <summary>
            Supporting registers: bank accounts, VAT rates and numeric sequences. Requires iDoklad
            credentials (headers or environment defaults).
            </summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.ListBankAccounts(System.Int32,System.Int32,System.Threading.CancellationToken)">
            <summary>List bank accounts (paged).</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.BankAccountDetail(System.Int32,System.Threading.CancellationToken)">
            <summary>Get a bank account detail by id.</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.CreateBankAccount(IdokladSdk.Models.BankAccount.BankAccountPostModel,System.Threading.CancellationToken)">
            <summary>Create a new bank account.</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.UpdateBankAccount(IdokladSdk.Models.BankAccount.BankAccountPatchModel,System.Threading.CancellationToken)">
            <summary>Update an existing bank account (the model id identifies the account).</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.DeleteBankAccount(System.Int32,System.Threading.CancellationToken)">
            <summary>Delete a bank account by id.</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.ListVatRates(System.Int32,System.Int32,System.Threading.CancellationToken)">
            <summary>List VAT rates (paged).</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.VatRateDetail(System.Int32,System.Threading.CancellationToken)">
            <summary>Get a VAT rate detail by id.</summary>
        </member>
        <member name="M:Idoklad.Controllers.RegistersController.ListNumericSequences(System.Int32,System.Int32,System.Threading.CancellationToken)">
            <summary>List numeric (document) sequences (paged).</summary>
        </member>
        <member name="T:Idoklad.Credentials.CredentialConstants">
             <summary>
             Names of the HTTP headers that carry per-request iDoklad credentials.
            
             Secrets are never accepted in the query string or request body: they are required in
             request headers (and documented as such in Swagger). Each header carries the credential
             value directly and must therefore only be sent over TLS.
             </summary>
        </member>
        <member name="F:Idoklad.Credentials.CredentialConstants.LanguageHeader">
            <summary>Header carrying the response language override (Cz, Sk, En).</summary>
        </member>
        <member name="T:Idoklad.Credentials.IdokladCredentials">
            <summary>
            Fully resolved set of credentials and request options used to build a <c>DokladApi</c>
            instance for a single request.
            </summary>
        </member>
        <member name="T:Idoklad.Credentials.MissingCredentialsException">
            <summary>
            Raised when the request does not provide a complete set of iDoklad credentials,
            neither through request headers nor through the service environment defaults.
            </summary>
        </member>
        <member name="T:Idoklad.Credentials.RequestCredentialsProvider">
             <summary>
             Resolves the iDoklad credentials for the current request.
            
             Mirrors <c>get_request_settings</c> from the sibling microsoft-365-service: each credential
             value is taken from its request header when present and otherwise falls back to the
             environment-configured default. Secrets are only ever read from headers (never query/body).
             If, after applying the fallbacks, any required value is still missing, the request is rejected.
             </summary>
        </member>
        <member name="T:Idoklad.Infrastructure.CredentialHeadersOperationFilter">
            <summary>
            Documents the per-request credential headers in Swagger for every operation that talks to
            iDoklad. The headers are marked optional because the service can fall back to environment
            defaults, but the description makes the requirement and secret handling explicit.
            </summary>
        </member>
        <member name="T:Idoklad.Infrastructure.ExceptionHandlingMiddleware">
            <summary>
            Translates domain exceptions into JSON <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails"/> responses:
            missing credentials become 401, and upstream iDoklad failures surface the upstream status.
            </summary>
        </member>
        <member name="T:Idoklad.Services.AccountService">
            <summary>Account agenda: information about the current agenda and the current user.</summary>
        </member>
        <member name="T:Idoklad.Services.ContactsService">
            <summary>Contacts (customers/suppliers) agenda.</summary>
        </member>
        <member name="T:Idoklad.Services.IssuedInvoicesService">
            <summary>Issued (outgoing) invoices agenda.</summary>
        </member>
        <member name="T:Idoklad.Services.ReceivedInvoicesService">
            <summary>Received (incoming) invoices agenda.</summary>
        </member>
        <member name="T:Idoklad.Services.RegistersService">
            <summary>
            Supporting registers: bank accounts, VAT rates and numeric (document) sequences.
            </summary>
        </member>
    </members>
</doc>