Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/cjappl/ynab_rust

ynab swagger codegen
https://github.com/cjappl/ynab_rust
Last synced: 4 days ago
JSON representation
ynab swagger codegen
Host: GitHub
URL: https://github.com/cjappl/ynab_rust
Owner: cjappl
Created: 2023-01-12T00:04:58.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-01-12T00:05:56.000Z (about 2 years ago)
Last Synced: 2024-11-16T23:28:11.407Z (2 months ago)
Language: Rust
Size: 66.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Rust API client for ynab

Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.youneedabudget.com

## Overview

This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.

- API version: 1.0.0

- Package version: 1.0.0

- Build package: io.swagger.codegen.languages.RustClientCodegen

## Installation

Put the package under your project folder and add the following in import:

```

    "./ynab"

```

## Documentation for API Endpoints

All URIs are relative to *https://api.youneedabudget.com/v1*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **Post** /budgets/{budget_id}/accounts | Create a new account

*AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **Get** /budgets/{budget_id}/accounts/{account_id} | Single account

*AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **Get** /budgets/{budget_id}/accounts | Account list

*BudgetsApi* | [**get_budget_by_id**](docs/BudgetsApi.md#get_budget_by_id) | **Get** /budgets/{budget_id} | Single budget

*BudgetsApi* | [**get_budget_settings_by_id**](docs/BudgetsApi.md#get_budget_settings_by_id) | **Get** /budgets/{budget_id}/settings | Budget Settings

*BudgetsApi* | [**get_budgets**](docs/BudgetsApi.md#get_budgets) | **Get** /budgets | List budgets

*CategoriesApi* | [**get_categories**](docs/CategoriesApi.md#get_categories) | **Get** /budgets/{budget_id}/categories | List categories

*CategoriesApi* | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | **Get** /budgets/{budget_id}/categories/{category_id} | Single category

*CategoriesApi* | [**get_month_category_by_id**](docs/CategoriesApi.md#get_month_category_by_id) | **Get** /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month

*CategoriesApi* | [**update_month_category**](docs/CategoriesApi.md#update_month_category) | **Patch** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month

*DeprecatedApi* | [**bulk_create_transactions**](docs/DeprecatedApi.md#bulk_create_transactions) | **Post** /budgets/{budget_id}/transactions/bulk | Bulk create transactions

*MonthsApi* | [**get_budget_month**](docs/MonthsApi.md#get_budget_month) | **Get** /budgets/{budget_id}/months/{month} | Single budget month

*MonthsApi* | [**get_budget_months**](docs/MonthsApi.md#get_budget_months) | **Get** /budgets/{budget_id}/months | List budget months

*PayeeLocationsApi* | [**get_payee_location_by_id**](docs/PayeeLocationsApi.md#get_payee_location_by_id) | **Get** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location

*PayeeLocationsApi* | [**get_payee_locations**](docs/PayeeLocationsApi.md#get_payee_locations) | **Get** /budgets/{budget_id}/payee_locations | List payee locations

*PayeeLocationsApi* | [**get_payee_locations_by_payee**](docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | **Get** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee

*PayeesApi* | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | **Get** /budgets/{budget_id}/payees/{payee_id} | Single payee

*PayeesApi* | [**get_payees**](docs/PayeesApi.md#get_payees) | **Get** /budgets/{budget_id}/payees | List payees

*ScheduledTransactionsApi* | [**get_scheduled_transaction_by_id**](docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **Get** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction

*ScheduledTransactionsApi* | [**get_scheduled_transactions**](docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | **Get** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions

*TransactionsApi* | [**create_transaction**](docs/TransactionsApi.md#create_transaction) | **Post** /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions

*TransactionsApi* | [**get_transaction_by_id**](docs/TransactionsApi.md#get_transaction_by_id) | **Get** /budgets/{budget_id}/transactions/{transaction_id} | Single transaction

*TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **Get** /budgets/{budget_id}/transactions | List transactions

*TransactionsApi* | [**get_transactions_by_account**](docs/TransactionsApi.md#get_transactions_by_account) | **Get** /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions

*TransactionsApi* | [**get_transactions_by_category**](docs/TransactionsApi.md#get_transactions_by_category) | **Get** /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions

*TransactionsApi* | [**get_transactions_by_payee**](docs/TransactionsApi.md#get_transactions_by_payee) | **Get** /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions

*TransactionsApi* | [**import_transactions**](docs/TransactionsApi.md#import_transactions) | **Post** /budgets/{budget_id}/transactions/import | Import transactions

*TransactionsApi* | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | **Put** /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction

*TransactionsApi* | [**update_transactions**](docs/TransactionsApi.md#update_transactions) | **Patch** /budgets/{budget_id}/transactions | Update multiple transactions

*UserApi* | [**get_user**](docs/UserApi.md#get_user) | **Get** /user | User info

## Documentation For Models

 - [Account](docs/Account.md)

 - [AccountResponse](docs/AccountResponse.md)

 - [AccountResponseData](docs/AccountResponseData.md)

 - [AccountType](docs/AccountType.md)

 - [AccountsResponse](docs/AccountsResponse.md)

 - [AccountsResponseData](docs/AccountsResponseData.md)

 - [BudgetDetail](docs/BudgetDetail.md)

 - [BudgetDetailResponse](docs/BudgetDetailResponse.md)

 - [BudgetDetailResponseData](docs/BudgetDetailResponseData.md)

 - [BudgetSettings](docs/BudgetSettings.md)

 - [BudgetSettingsResponse](docs/BudgetSettingsResponse.md)

 - [BudgetSettingsResponseData](docs/BudgetSettingsResponseData.md)

 - [BudgetSummary](docs/BudgetSummary.md)

 - [BudgetSummaryResponse](docs/BudgetSummaryResponse.md)

 - [BudgetSummaryResponseData](docs/BudgetSummaryResponseData.md)

 - [BulkResponse](docs/BulkResponse.md)

 - [BulkResponseData](docs/BulkResponseData.md)

 - [BulkResponseDataBulk](docs/BulkResponseDataBulk.md)

 - [BulkTransactions](docs/BulkTransactions.md)

 - [CategoriesResponse](docs/CategoriesResponse.md)

 - [CategoriesResponseData](docs/CategoriesResponseData.md)

 - [Category](docs/Category.md)

 - [CategoryGroup](docs/CategoryGroup.md)

 - [CategoryGroupWithCategories](docs/CategoryGroupWithCategories.md)

 - [CategoryResponse](docs/CategoryResponse.md)

 - [CategoryResponseData](docs/CategoryResponseData.md)

 - [CurrencyFormat](docs/CurrencyFormat.md)

 - [DateFormat](docs/DateFormat.md)

 - [ErrorDetail](docs/ErrorDetail.md)

 - [ErrorResponse](docs/ErrorResponse.md)

 - [HybridTransaction](docs/HybridTransaction.md)

 - [HybridTransactionsResponse](docs/HybridTransactionsResponse.md)

 - [HybridTransactionsResponseData](docs/HybridTransactionsResponseData.md)

 - [MonthDetail](docs/MonthDetail.md)

 - [MonthDetailResponse](docs/MonthDetailResponse.md)

 - [MonthDetailResponseData](docs/MonthDetailResponseData.md)

 - [MonthSummariesResponse](docs/MonthSummariesResponse.md)

 - [MonthSummariesResponseData](docs/MonthSummariesResponseData.md)

 - [MonthSummary](docs/MonthSummary.md)

 - [Payee](docs/Payee.md)

 - [PayeeLocation](docs/PayeeLocation.md)

 - [PayeeLocationResponse](docs/PayeeLocationResponse.md)

 - [PayeeLocationResponseData](docs/PayeeLocationResponseData.md)

 - [PayeeLocationsResponse](docs/PayeeLocationsResponse.md)

 - [PayeeLocationsResponseData](docs/PayeeLocationsResponseData.md)

 - [PayeeResponse](docs/PayeeResponse.md)

 - [PayeeResponseData](docs/PayeeResponseData.md)

 - [PayeesResponse](docs/PayeesResponse.md)

 - [PayeesResponseData](docs/PayeesResponseData.md)

 - [SaveAccount](docs/SaveAccount.md)

 - [SaveAccountWrapper](docs/SaveAccountWrapper.md)

 - [SaveCategoryResponse](docs/SaveCategoryResponse.md)

 - [SaveCategoryResponseData](docs/SaveCategoryResponseData.md)

 - [SaveMonthCategory](docs/SaveMonthCategory.md)

 - [SaveMonthCategoryWrapper](docs/SaveMonthCategoryWrapper.md)

 - [SaveSubTransaction](docs/SaveSubTransaction.md)

 - [SaveTransaction](docs/SaveTransaction.md)

 - [SaveTransactionWrapper](docs/SaveTransactionWrapper.md)

 - [SaveTransactionsResponse](docs/SaveTransactionsResponse.md)

 - [SaveTransactionsResponseData](docs/SaveTransactionsResponseData.md)

 - [SaveTransactionsWrapper](docs/SaveTransactionsWrapper.md)

 - [ScheduledSubTransaction](docs/ScheduledSubTransaction.md)

 - [ScheduledTransactionDetail](docs/ScheduledTransactionDetail.md)

 - [ScheduledTransactionResponse](docs/ScheduledTransactionResponse.md)

 - [ScheduledTransactionResponseData](docs/ScheduledTransactionResponseData.md)

 - [ScheduledTransactionSummary](docs/ScheduledTransactionSummary.md)

 - [ScheduledTransactionsResponse](docs/ScheduledTransactionsResponse.md)

 - [ScheduledTransactionsResponseData](docs/ScheduledTransactionsResponseData.md)

 - [SubTransaction](docs/SubTransaction.md)

 - [TransactionDetail](docs/TransactionDetail.md)

 - [TransactionResponse](docs/TransactionResponse.md)

 - [TransactionResponseData](docs/TransactionResponseData.md)

 - [TransactionSummary](docs/TransactionSummary.md)

 - [TransactionsImportResponse](docs/TransactionsImportResponse.md)

 - [TransactionsImportResponseData](docs/TransactionsImportResponseData.md)

 - [TransactionsResponse](docs/TransactionsResponse.md)

 - [TransactionsResponseData](docs/TransactionsResponseData.md)

 - [UpdateTransaction](docs/UpdateTransaction.md)

 - [UpdateTransactionsWrapper](docs/UpdateTransactionsWrapper.md)

 - [User](docs/User.md)

 - [UserResponse](docs/UserResponse.md)

 - [UserResponseData](docs/UserResponseData.md)

## Documentation For Authorization

## bearer

- **Type**: API key 

Example

```

	auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{

		Key: "APIKEY",

		Prefix: "Bearer", // Omit if not necessary.

	})

    r, err := client.Service.Operation(auth, args)

```

## Author