Documentation
¶
Index ¶
- func CreateAccount(c *gin.Context)
- func CreateAllocation(c *gin.Context)
- func CreateBudget(c *gin.Context)
- func CreateCategory(c *gin.Context)
- func CreateEnvelope(c *gin.Context)
- func CreateTransaction(c *gin.Context)
- func DeleteAccount(c *gin.Context)
- func DeleteAllocation(c *gin.Context)
- func DeleteBudget(c *gin.Context)
- func DeleteCategory(c *gin.Context)
- func DeleteEnvelope(c *gin.Context)
- func DeleteTransaction(c *gin.Context)
- func GetAccount(c *gin.Context)
- func GetAccounts(c *gin.Context)
- func GetAllocation(c *gin.Context)
- func GetAllocations(c *gin.Context)
- func GetBudget(c *gin.Context)
- func GetBudgetMonth(c *gin.Context)
- func GetBudgets(c *gin.Context)
- func GetCategories(c *gin.Context)
- func GetCategory(c *gin.Context)
- func GetEnvelope(c *gin.Context)
- func GetEnvelopeMonth(c *gin.Context)
- func GetEnvelopes(c *gin.Context)
- func GetRoot(c *gin.Context)
- func GetTransaction(c *gin.Context)
- func GetTransactions(c *gin.Context)
- func GetV1(c *gin.Context)
- func OptionsAccountDetail(c *gin.Context)
- func OptionsAccountList(c *gin.Context)
- func OptionsAllocationDetail(c *gin.Context)
- func OptionsAllocationList(c *gin.Context)
- func OptionsBudgetDetail(c *gin.Context)
- func OptionsBudgetList(c *gin.Context)
- func OptionsCategoryDetail(c *gin.Context)
- func OptionsCategoryList(c *gin.Context)
- func OptionsEnvelopeDetail(c *gin.Context)
- func OptionsEnvelopeList(c *gin.Context)
- func OptionsRoot(c *gin.Context)
- func OptionsTransactionDetail(c *gin.Context)
- func OptionsTransactionList(c *gin.Context)
- func OptionsV1(c *gin.Context)
- func OptionsVersion(c *gin.Context)
- func RegisterAccountRoutes(r *gin.RouterGroup)
- func RegisterAllocationRoutes(r *gin.RouterGroup)
- func RegisterBudgetRoutes(r *gin.RouterGroup)
- func RegisterCategoryRoutes(r *gin.RouterGroup)
- func RegisterEnvelopeRoutes(r *gin.RouterGroup)
- func RegisterTransactionRoutes(r *gin.RouterGroup)
- func Router() (*gin.Engine, error)
- func UpdateAccount(c *gin.Context)
- func UpdateAllocation(c *gin.Context)
- func UpdateBudget(c *gin.Context)
- func UpdateCategory(c *gin.Context)
- func UpdateEnvelope(c *gin.Context)
- func UpdateTransaction(c *gin.Context)
- func VersionRoot(c *gin.Context)
- type Account
- type AccountLinks
- type AccountListResponse
- type AccountResponse
- type Allocation
- type AllocationLinks
- type AllocationListResponse
- type AllocationResponse
- type Budget
- type BudgetLinks
- type BudgetListResponse
- type BudgetMonthResponse
- type BudgetResponse
- type Category
- type CategoryLinks
- type CategoryListResponse
- type CategoryResponse
- type Envelope
- type EnvelopeLinks
- type EnvelopeListResponse
- type EnvelopeMonthResponse
- type EnvelopeResponse
- type RootLinks
- type RootResponse
- type Transaction
- type TransactionLinks
- type TransactionListResponse
- type TransactionResponse
- type URIMonth
- type V1Links
- type V1Response
- type VersionObject
- type VersionResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateAccount ¶ added in v0.1.0
@Summary Create account @Description Create a new account @Tags Accounts @Produce json @Success 201 {object} AccountResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param account body models.AccountCreate true "Account" @Router /v1/accounts [post]
func CreateAllocation ¶ added in v0.1.0
@Summary Create allocations @Description Create a new allocation of funds to an envelope for a specific month @Tags Allocations @Produce json @Success 201 {object} AllocationResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param allocation body models.AllocationCreate true "Allocation" @Router /v1/allocations [post]
func CreateBudget ¶
@Summary Create a budget @Description Creates a new budget @Tags Budgets @Accept json @Produce json @Success 201 {object} BudgetResponse @Failure 400 {object} httputil.HTTPError @Failure 500 {object} httputil.HTTPError @Param budget body models.BudgetCreate true "Budget" @Router /v1/budgets [post]
func CreateCategory ¶ added in v0.1.0
@Summary Create category @Description Create a new category for a specific budget @Tags Categories @Produce json @Success 201 {object} CategoryResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param category body models.CategoryCreate true "Category" @Router /v1/categories [post]
func CreateEnvelope ¶ added in v0.1.0
@Summary Create envelope @Description Create a new envelope for a specific category @Tags Envelopes @Produce json @Success 201 {object} EnvelopeResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param envelope body models.EnvelopeCreate true "Envelope" @Router /v1/envelopes [post]
func CreateTransaction ¶ added in v0.1.0
@Summary Create transaction @Description Create a new transaction @Tags Transactions @Produce json @Success 201 {object} TransactionResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param transaction body models.TransactionCreate true "Transaction" @Router /v1/transactions [post]
func DeleteAccount ¶ added in v0.1.0
@Summary Delete account @Description Deletes the specified account. @Tags Accounts @Produce json @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param accountId path uint64 true "ID of the account" @Router /v1/accounts/{accountId} [delete]
func DeleteAllocation ¶ added in v0.1.0
@Summary Delete an allocation @Description Deletes an existing allocation @Tags Allocations @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param allocationId path uint64 true "ID of the allocation" @Router /v1/allocations/{allocationId} [delete]
func DeleteBudget ¶
@Summary Delete a budget @Description Deletes an existing budget @Tags Budgets @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param budgetId path uint64 true "ID of the budget" @Router /v1/budgets/{budgetId} [delete]
func DeleteCategory ¶ added in v0.1.0
@Summary Delete a category @Description Deletes an existing category @Tags Categories @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param categoryId path uint64 true "ID of the category" @Router /v1/categories/{categoryId} [delete]
func DeleteEnvelope ¶ added in v0.1.0
@Summary Delete an envelope @Description Deletes an existing envelope @Tags Envelopes @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param envelopeId path uint64 true "ID of the envelope" @Router /v1/envelopes/{envelopeId} [delete]
func DeleteTransaction ¶ added in v0.1.0
@Summary Delete a transaction @Description Deletes an existing transaction @Tags Transactions @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param transactionId path uint64 true "ID of the transaction" @Router /v1/transactions/{transactionId} [delete]
func GetAccount ¶ added in v0.1.0
@Summary Get account @Description Returns a specific account @Tags Accounts @Produce json @Success 200 {object} AccountResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param accountId path uint64 true "ID of the account" @Router /v1/accounts/{accountId} [get]
func GetAccounts ¶ added in v0.1.0
@Summary List accounts @Description Returns a list of all accounts @Tags Accounts @Produce json @Success 200 {object} AccountListResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Router /v1/accounts [get]
func GetAllocation ¶ added in v0.1.0
@Summary Get allocation @Description Returns an allocation by its ID @Tags Allocations @Produce json @Success 200 {object} AllocationResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param allocationId path uint64 true "ID of the allocation" @Router /v1/allocations/{allocationId} [get]
func GetAllocations ¶ added in v0.1.0
@Summary Get all allocations for an envelope @Description Returns all allocations for an envelope @Tags Allocations @Produce json @Success 200 {object} AllocationListResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Router /v1/allocations [get]
func GetBudget ¶
@Summary Get a budget @Description Returns a specific budget @Tags Budgets @Produce json @Success 200 {object} BudgetResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param budgetId path uint64 true "ID of the budget" @Router /v1/budgets/{budgetId} [get]
func GetBudgetMonth ¶ added in v0.16.0
@Summary Get Budget month data @Description Returns data about a budget for a for a specific month @Tags Budgets @Produce json @Success 200 {object} BudgetMonthResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param budgetId path uint64 true "ID of the budget" @Param month path string true "The month in YYYY-MM format" @Router /v1/budgets/{budgetId}/{month} [get]
func GetBudgets ¶
@Summary List all budgets @Description Returns list of budgets @Tags Budgets @Produce json @Success 200 {object} BudgetListResponse @Failure 500 {object} httputil.HTTPError @Router /v1/budgets [get]
func GetCategories ¶ added in v0.1.0
@Summary Get all categories for a budget @Description Returns the full list of all categories for a specific budget @Tags Categories @Produce json @Success 200 {object} CategoryListResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Router /v1/categories [get]
func GetCategory ¶ added in v0.1.0
@Summary Get category @Description Returns a category by its ID @Tags Categories @Produce json @Success 200 {object} CategoryResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param categoryId path uint64 true "ID of the category" @Router /v1/categories/{categoryId} [get]
func GetEnvelope ¶ added in v0.1.0
@Summary Get envelope @Description Returns an envelope by its ID @Tags Envelopes @Produce json @Success 200 {object} EnvelopeResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param envelopeId path uint64 true "ID of the envelope" @Router /v1/envelopes/{envelopeId} [get]
func GetEnvelopeMonth ¶ added in v0.16.0
@Summary Get Envelope month data @Description Returns data about an envelope for a for a specific month @Tags Envelopes @Produce json @Success 200 {object} EnvelopeMonthResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param envelopeId path uint64 true "ID of the envelope" @Param month path string true "The month in YYYY-MM format" @Router /v1/envelopes/{envelopeId}/{month} [get]
func GetEnvelopes ¶ added in v0.1.0
@Summary Get all envelopes for a category @Description Returns the full list of all envelopes for a specific category @Tags Envelopes @Produce json @Success 200 {object} EnvelopeListResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Router /v1/envelopes [get]
func GetRoot ¶ added in v0.14.0
@Summary API root @Description Entrypoint for the API, listing all endpoints @Tags General @Success 200 {object} RootResponse @Router / [get]
func GetTransaction ¶ added in v0.1.0
@Summary Get transaction @Description Returns a transaction by its ID @Tags Transactions @Produce json @Success 200 {object} TransactionResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param transactionId path uint64 true "ID of the transaction" @Router /v1/transactions/{transactionId} [get]
func GetTransactions ¶ added in v0.1.0
@Summary Get all transactions @Description Returns all transactions for a specific budget @Tags Transactions @Produce json @Success 200 {object} TransactionListResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Router /v1/transactions [get]
func GetV1 ¶ added in v0.14.0
@Sumary v1 API @Description Returns general information about the v1 API @Tags General @Success 200 {object} V1Response @Router /v1 [get]
func OptionsAccountDetail ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Accounts @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Param accountId path uint64 true "ID of the account" @Router /v1/accounts/{accountId} [options]
func OptionsAccountList ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Accounts @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Router /v1/accounts [options]
func OptionsAllocationDetail ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Allocations @Success 204 @Param allocationId path uint64 true "ID of the allocation" @Router /v1/allocations/{allocationId} [options]
func OptionsAllocationList ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Allocations @Success 204 @Router /v1/allocations [options]
func OptionsBudgetDetail ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Budgets @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param budgetId path uint64 true "ID of the budget" @Router /v1/budgets/{budgetId} [options]
func OptionsBudgetList ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Budgets @Success 204 @Failure 500 {object} httputil.HTTPError @Router /v1/budgets [options]
func OptionsCategoryDetail ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Categories @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Param categoryId path uint64 true "ID of the category" @Router /v1/categories/{categoryId} [options]
func OptionsCategoryList ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Categories @Success 204 @Failure 400 {object} httputil.HTTPError @Failure 404 @Router /v1/categories [options]
func OptionsEnvelopeDetail ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Param envelopeId path uint64 true "ID of the envelope" @Router /v1/envelopes/{envelopeId} [options]
func OptionsEnvelopeList ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Router /v1/envelopes [options]
func OptionsRoot ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags General @Success 204 @Router / [options]
func OptionsTransactionDetail ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Transactions @Success 204 @Param transactionId path uint64 true "ID of the transaction" @Router /v1/transactions/{transactionId} [options]
func OptionsTransactionList ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Transactions @Success 204 @Router /v1/transactions [options]
func OptionsV1 ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags General @Success 204 @Router /v1 [options]
func OptionsVersion ¶ added in v0.14.0
@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags General @Success 204 @Router /version [options]
func RegisterAccountRoutes ¶ added in v0.1.0
func RegisterAccountRoutes(r *gin.RouterGroup)
RegisterAccountRoutes registers the routes for accounts with the RouterGroup that is passed.
func RegisterAllocationRoutes ¶ added in v0.1.0
func RegisterAllocationRoutes(r *gin.RouterGroup)
RegisterAllocationRoutes registers the routes for allocations with the RouterGroup that is passed.
func RegisterBudgetRoutes ¶ added in v0.1.0
func RegisterBudgetRoutes(r *gin.RouterGroup)
RegisterBudgetRoutes registers the routes for budgets with the RouterGroup that is passed.
func RegisterCategoryRoutes ¶ added in v0.1.0
func RegisterCategoryRoutes(r *gin.RouterGroup)
RegisterCategoryRoutes registers the routes for categories with the RouterGroup that is passed.
func RegisterEnvelopeRoutes ¶ added in v0.1.0
func RegisterEnvelopeRoutes(r *gin.RouterGroup)
RegisterEnvelopeRoutes registers the routes for envelopes with the RouterGroup that is passed.
func RegisterTransactionRoutes ¶ added in v0.1.0
func RegisterTransactionRoutes(r *gin.RouterGroup)
RegisterTransactionRoutes registers the routes for transactions with the RouterGroup that is passed.
func UpdateAccount ¶ added in v0.1.0
@Summary Update account @Description Updates an account. Only values to be updated need to be specified. @Tags Accounts @Produce json @Success 200 {object} AccountResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param accountId path uint64 true "ID of the account" @Param account body models.AccountCreate true "Account" @Router /v1/accounts/{accountId} [patch]
func UpdateAllocation ¶ added in v0.1.0
@Summary Update an allocation @Description Update an existing allocation. Only values to be updated need to be specified. @Tags Allocations @Accept json @Produce json @Success 200 {object} AllocationResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param allocationId path uint64 true "ID of the allocation" @Param allocation body models.AllocationCreate true "Allocation" @Router /v1/allocations/{allocationId} [patch]
func UpdateBudget ¶
@Summary Update a budget @Description Update an existing budget. Only values to be updated need to be specified. @Tags Budgets @Accept json @Produce json @Success 200 {object} BudgetResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param budgetId path uint64 true "ID of the budget" @Param budget body models.BudgetCreate true "Budget" @Router /v1/budgets/{budgetId} [patch]
func UpdateCategory ¶ added in v0.1.0
@Summary Update a category @Description Update an existing category. Only values to be updated need to be specified. @Tags Categories @Accept json @Produce json @Success 200 {object} CategoryResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param categoryId path uint64 true "ID of the category" @Param category body models.CategoryCreate true "Category" @Router /v1/categories/{categoryId} [patch]
func UpdateEnvelope ¶ added in v0.1.0
@Summary Update an envelope @Description Update an existing envelope. Only values to be updated need to be specified. @Tags Envelopes @Accept json @Produce json @Success 200 {object} EnvelopeResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param envelopeId path uint64 true "ID of the envelope" @Param envelope body models.EnvelopeCreate true "Envelope" @Router /v1/envelopes/{envelopeId} [patch]
func UpdateTransaction ¶ added in v0.1.0
@Summary Update a transaction @Description Update an existing transaction. Only values to be updated need to be specified. @Tags Transactions @Accept json @Produce json @Success 200 {object} TransactionResponse @Failure 400 {object} httputil.HTTPError @Failure 404 @Failure 500 {object} httputil.HTTPError @Param transactionId path uint64 true "ID of the transaction" @Param transaction body models.TransactionCreate true "Transaction" @Router /v1/transactions/{transactionId} [patch]
func VersionRoot ¶ added in v0.14.0
@Sumary API version @Description Returns the software version of the API @Tags General @Success 200 {object} VersionResponse @Router /version [get]
Types ¶
type Account ¶ added in v0.16.0
type Account struct { models.Account Links AccountLinks `json:"links"` }
type AccountLinks ¶ added in v0.14.0
type AccountLinks struct {
Self string `json:"self" example:"https://example.com/api/v1/accounts/17"`
}
type AccountListResponse ¶ added in v0.14.0
type AccountListResponse struct {
Data []Account `json:"data"`
}
type AccountResponse ¶ added in v0.14.0
type AccountResponse struct {
Data Account `json:"data"`
}
type Allocation ¶ added in v0.19.0
type Allocation struct { models.Allocation Links AllocationLinks `json:"links"` }
type AllocationLinks ¶ added in v0.19.0
type AllocationLinks struct {
Self string `json:"self" example:"https://example.com/api/v1/allocations/47"`
}
type AllocationListResponse ¶ added in v0.14.0
type AllocationListResponse struct {
Data []Allocation `json:"data"`
}
type AllocationResponse ¶ added in v0.14.0
type AllocationResponse struct {
Data Allocation `json:"data"`
}
type Budget ¶ added in v0.17.0
type Budget struct { models.Budget Links BudgetLinks `json:"links"` }
type BudgetLinks ¶ added in v0.14.0
type BudgetLinks struct { Self string `json:"self" example:"https://example.com/api/v1/budgets/4"` Accounts string `json:"accounts" example:"https://example.com/api/v1/accounts?budget=2"` Categories string `json:"categories" example:"https://example.com/api/v1/categories?budget=2"` Transactions string `json:"transactions" example:"https://example.com/api/v1/budgets/2/transactions"` Month string `json:"month" example:"https://example.com/api/v1/budgets/2/2022-03"` }
type BudgetListResponse ¶ added in v0.14.0
type BudgetListResponse struct {
Data []Budget `json:"data"`
}
type BudgetMonthResponse ¶ added in v0.16.0
type BudgetMonthResponse struct {
Data models.BudgetMonth `json:"data"`
}
type BudgetResponse ¶ added in v0.14.0
type BudgetResponse struct {
Data Budget `json:"data"`
}
type Category ¶ added in v0.19.0
type Category struct { models.Category Links CategoryLinks `json:"links"` }
type CategoryLinks ¶ added in v0.14.0
type CategoryListResponse ¶ added in v0.14.0
type CategoryListResponse struct {
Data []Category `json:"data"`
}
type CategoryResponse ¶ added in v0.14.0
type CategoryResponse struct {
Data Category `json:"data"`
}
type Envelope ¶ added in v0.19.0
type Envelope struct { models.Envelope Links EnvelopeLinks `json:"links"` }
type EnvelopeLinks ¶ added in v0.14.0
type EnvelopeListResponse ¶ added in v0.14.0
type EnvelopeListResponse struct {
Data []Envelope `json:"data"`
}
type EnvelopeMonthResponse ¶ added in v0.16.0
type EnvelopeMonthResponse struct {
Data models.EnvelopeMonth `json:"data"`
}
type EnvelopeResponse ¶ added in v0.14.0
type EnvelopeResponse struct {
Data Envelope `json:"data"`
}
type RootResponse ¶ added in v0.14.0
type RootResponse struct {
Links RootLinks `json:"links"`
}
type Transaction ¶ added in v0.18.0
type Transaction struct { models.Transaction Links TransactionLinks `json:"links"` }
type TransactionLinks ¶ added in v0.18.0
type TransactionLinks struct {
Self string `json:"self" example:"https://example.com/api/v1/transactions/1741"`
}
type TransactionListResponse ¶ added in v0.14.0
type TransactionListResponse struct {
Data []Transaction `json:"data"`
}
type TransactionResponse ¶ added in v0.14.0
type TransactionResponse struct {
Data Transaction `json:"data"`
}
type V1Links ¶ added in v0.14.0
type V1Links struct { Budgets string `json:"budgets" example:"https://example.com/api/v1/budgets"` Accounts string `json:"accounts" example:"https://example.com/api/v1/accounts"` Categories string `json:"categories" example:"https://example.com/api/v1/categories"` Transactions string `json:"transactions" example:"https://example.com/api/v1/transactions"` Envelopes string `json:"envelopes" example:"https://example.com/api/v1/envelopes"` Allocations string `json:"allocations" example:"https://example.com/api/v1/allocations3"` }
type V1Response ¶ added in v0.14.0
type V1Response struct {
Links V1Links `json:"links"`
}
type VersionObject ¶ added in v0.14.0
type VersionObject struct {
Version string `json:"version" example:"1.1.0"`
}
type VersionResponse ¶ added in v0.14.0
type VersionResponse struct {
Data VersionObject `json:"data"`
}