Skip to content

Commit e4f71c7

Browse files
committed
basic service descriptions added
1 parent 779bc37 commit e4f71c7

File tree

8 files changed

+25
-1
lines changed

8 files changed

+25
-1
lines changed

Abstractions/IApiKeyService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Fiscalapi.Abstractions
44
{
5+
/// <summary>
6+
/// Interface for the ApiKey service
7+
/// </summary>
58
public interface IApiKeyService : IFiscalApiService<ApiKey>
69
{
710
}

Abstractions/ICatalogService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace Fiscalapi.Abstractions
66
{
7+
/// <summary>
8+
/// Interface for the Catalog service
9+
/// </summary>
710
public interface ICatalogService : IFiscalApiService<CatalogDto>
811
{
912
//GET /api/v4/catalogs

Abstractions/IFiscalApiClient.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
namespace Fiscalapi.Abstractions
22
{
3+
/// <summary>
4+
/// Interface for the Fiscal API client
5+
/// </summary>
36
public interface IFiscalApiClient
47
{
58
IInvoiceService Invoices { get; }

Abstractions/IFiscalApiService.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
namespace Fiscalapi.Abstractions
55
{
6+
/// <summary>
7+
/// Interface for the FiscalApi service
8+
/// </summary>
9+
/// <typeparam name="T"></typeparam>
610
public interface IFiscalApiService<T> where T : BaseDto
711
{
812
Task<ApiResponse<PagedList<T>>> GetListAsync(int pageNumber, int pageSize);

Abstractions/IInvoiceService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace Fiscalapi.Abstractions
66
{
7+
/// <summary>
8+
/// Interface for the Invoice service
9+
/// </summary>
710
public interface IInvoiceService : IFiscalApiService<Invoice>
811
{
912

Abstractions/IPersonService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Fiscalapi.Abstractions
44
{
5+
/// <summary>
6+
/// Interface for the Person (emisor, receptor, cliente, usuario) service
7+
/// </summary>
58
public interface IPersonService : IFiscalApiService<Person>
69
{
710
}

Abstractions/IProductService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
namespace Fiscalapi.Abstractions
77
{
8+
/// <summary>
9+
/// Interface for the Product service
10+
/// </summary>
811
public interface IProductService : IFiscalApiService<Product>
912
{
1013
// GET /api/v4/products/{id}/taxes

Services/FiscalApiClient.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55

66
namespace Fiscalapi.Services
77
{
8-
// Core Fiscalapi service
8+
/// <summary>
9+
/// Client for the Fiscal API
10+
/// </summary>
911
public class FiscalApiClient : IFiscalApiClient
1012
{
1113
public IInvoiceService Invoices { get; }

0 commit comments

Comments
 (0)