up_banking 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +219 -0
- data/Rakefile +10 -0
- data/config.json +11 -0
- data/docs/AccountResource.md +26 -0
- data/docs/AccountResourceAttributes.md +26 -0
- data/docs/AccountResourceAttributesBalance.md +22 -0
- data/docs/AccountResourceLinks.md +18 -0
- data/docs/AccountResourceRelationships.md +18 -0
- data/docs/AccountResourceRelationshipsTransactions.md +18 -0
- data/docs/AccountResourceRelationshipsTransactionsLinks.md +18 -0
- data/docs/AccountTypeEnum.md +15 -0
- data/docs/AccountsApi.md +153 -0
- data/docs/CashbackObject.md +20 -0
- data/docs/CashbackObjectAmount.md +22 -0
- data/docs/CategoriesApi.md +222 -0
- data/docs/CategoryInputResourceIdentifier.md +20 -0
- data/docs/CategoryResource.md +26 -0
- data/docs/CategoryResourceAttributes.md +18 -0
- data/docs/CategoryResourceRelationships.md +20 -0
- data/docs/CategoryResourceRelationshipsChildren.md +20 -0
- data/docs/CategoryResourceRelationshipsChildrenDataInner.md +20 -0
- data/docs/CategoryResourceRelationshipsParent.md +20 -0
- data/docs/CategoryResourceRelationshipsParentData.md +20 -0
- data/docs/CreateWebhookRequest.md +18 -0
- data/docs/CreateWebhookRequestData.md +18 -0
- data/docs/CreateWebhookResponse.md +18 -0
- data/docs/CreateWebhookResponseData.md +26 -0
- data/docs/ErrorObject.md +24 -0
- data/docs/ErrorObjectSource.md +20 -0
- data/docs/ErrorResponse.md +18 -0
- data/docs/GetAccountResponse.md +18 -0
- data/docs/GetAccountResponseData.md +26 -0
- data/docs/GetCategoryResponse.md +18 -0
- data/docs/GetCategoryResponseData.md +26 -0
- data/docs/GetTransactionResponse.md +18 -0
- data/docs/GetTransactionResponseData.md +26 -0
- data/docs/GetWebhookResponse.md +18 -0
- data/docs/GetWebhookResponseData.md +26 -0
- data/docs/HoldInfoObject.md +20 -0
- data/docs/HoldInfoObjectAmount.md +22 -0
- data/docs/HoldInfoObjectForeignAmount.md +22 -0
- data/docs/ListAccountsResponse.md +20 -0
- data/docs/ListAccountsResponseLinks.md +20 -0
- data/docs/ListCategoriesResponse.md +18 -0
- data/docs/ListTagsResponse.md +20 -0
- data/docs/ListTransactionsResponse.md +20 -0
- data/docs/ListWebhookDeliveryLogsResponse.md +20 -0
- data/docs/ListWebhooksResponse.md +20 -0
- data/docs/MoneyObject.md +22 -0
- data/docs/OwnershipTypeEnum.md +15 -0
- data/docs/PingResponse.md +18 -0
- data/docs/PingResponseMeta.md +20 -0
- data/docs/RoundUpObject.md +20 -0
- data/docs/RoundUpObjectAmount.md +22 -0
- data/docs/RoundUpObjectBoostPortion.md +22 -0
- data/docs/TagInputResourceIdentifier.md +20 -0
- data/docs/TagResource.md +22 -0
- data/docs/TagsApi.md +225 -0
- data/docs/TransactionResource.md +26 -0
- data/docs/TransactionResourceAttributes.md +40 -0
- data/docs/TransactionResourceAttributesAmount.md +22 -0
- data/docs/TransactionResourceAttributesCashback.md +20 -0
- data/docs/TransactionResourceAttributesForeignAmount.md +22 -0
- data/docs/TransactionResourceAttributesHoldInfo.md +20 -0
- data/docs/TransactionResourceAttributesRoundUp.md +20 -0
- data/docs/TransactionResourceRelationships.md +26 -0
- data/docs/TransactionResourceRelationshipsAccount.md +20 -0
- data/docs/TransactionResourceRelationshipsAccountData.md +20 -0
- data/docs/TransactionResourceRelationshipsCategory.md +20 -0
- data/docs/TransactionResourceRelationshipsCategoryLinks.md +20 -0
- data/docs/TransactionResourceRelationshipsTags.md +20 -0
- data/docs/TransactionResourceRelationshipsTagsDataInner.md +20 -0
- data/docs/TransactionResourceRelationshipsTagsLinks.md +18 -0
- data/docs/TransactionResourceRelationshipsTransferAccount.md +20 -0
- data/docs/TransactionResourceRelationshipsTransferAccountData.md +20 -0
- data/docs/TransactionStatusEnum.md +15 -0
- data/docs/TransactionsApi.md +243 -0
- data/docs/UpdateTransactionCategoryRequest.md +18 -0
- data/docs/UpdateTransactionCategoryRequestData.md +20 -0
- data/docs/UpdateTransactionTagsRequest.md +18 -0
- data/docs/UtilityEndpointsApi.md +74 -0
- data/docs/WebhookDeliveryLogResource.md +24 -0
- data/docs/WebhookDeliveryLogResourceAttributes.md +24 -0
- data/docs/WebhookDeliveryLogResourceAttributesRequest.md +18 -0
- data/docs/WebhookDeliveryLogResourceAttributesResponse.md +20 -0
- data/docs/WebhookDeliveryLogResourceRelationships.md +18 -0
- data/docs/WebhookDeliveryLogResourceRelationshipsWebhookEvent.md +18 -0
- data/docs/WebhookDeliveryLogResourceRelationshipsWebhookEventData.md +20 -0
- data/docs/WebhookDeliveryStatusEnum.md +15 -0
- data/docs/WebhookEventCallback.md +18 -0
- data/docs/WebhookEventCallbackData.md +24 -0
- data/docs/WebhookEventResource.md +24 -0
- data/docs/WebhookEventResourceAttributes.md +20 -0
- data/docs/WebhookEventResourceRelationships.md +20 -0
- data/docs/WebhookEventResourceRelationshipsTransaction.md +20 -0
- data/docs/WebhookEventResourceRelationshipsTransactionData.md +20 -0
- data/docs/WebhookEventResourceRelationshipsWebhook.md +20 -0
- data/docs/WebhookEventResourceRelationshipsWebhookData.md +20 -0
- data/docs/WebhookEventTypeEnum.md +15 -0
- data/docs/WebhookInputResource.md +18 -0
- data/docs/WebhookInputResourceAttributes.md +20 -0
- data/docs/WebhookResource.md +26 -0
- data/docs/WebhookResourceAttributes.md +24 -0
- data/docs/WebhookResourceRelationships.md +18 -0
- data/docs/WebhooksApi.md +434 -0
- data/git_push.sh +57 -0
- data/lib/.DS_Store +0 -0
- data/lib/up_banking/.DS_Store +0 -0
- data/lib/up_banking/api/accounts_api.rb +151 -0
- data/lib/up_banking/api/categories_api.rb +213 -0
- data/lib/up_banking/api/tags_api.rb +218 -0
- data/lib/up_banking/api/transactions_api.rb +241 -0
- data/lib/up_banking/api/utility_endpoints_api.rb +79 -0
- data/lib/up_banking/api/webhooks_api.rb +399 -0
- data/lib/up_banking/api_client.rb +392 -0
- data/lib/up_banking/api_error.rb +57 -0
- data/lib/up_banking/configuration.rb +279 -0
- data/lib/up_banking/models/account_resource.rb +278 -0
- data/lib/up_banking/models/account_resource_attributes.rb +284 -0
- data/lib/up_banking/models/account_resource_attributes_balance.rb +263 -0
- data/lib/up_banking/models/account_resource_links.rb +225 -0
- data/lib/up_banking/models/account_resource_relationships.rb +224 -0
- data/lib/up_banking/models/account_resource_relationships_transactions.rb +219 -0
- data/lib/up_banking/models/account_resource_relationships_transactions_links.rb +225 -0
- data/lib/up_banking/models/account_type_enum.rb +40 -0
- data/lib/up_banking/models/cashback_object.rb +240 -0
- data/lib/up_banking/models/cashback_object_amount.rb +263 -0
- data/lib/up_banking/models/category_input_resource_identifier.rb +241 -0
- data/lib/up_banking/models/category_resource.rb +278 -0
- data/lib/up_banking/models/category_resource_attributes.rb +225 -0
- data/lib/up_banking/models/category_resource_relationships.rb +238 -0
- data/lib/up_banking/models/category_resource_relationships_children.rb +235 -0
- data/lib/up_banking/models/category_resource_relationships_children_data_inner.rb +240 -0
- data/lib/up_banking/models/category_resource_relationships_parent.rb +229 -0
- data/lib/up_banking/models/category_resource_relationships_parent_data.rb +240 -0
- data/lib/up_banking/models/create_webhook_request.rb +225 -0
- data/lib/up_banking/models/create_webhook_request_data.rb +232 -0
- data/lib/up_banking/models/create_webhook_response.rb +225 -0
- data/lib/up_banking/models/create_webhook_response_data.rb +285 -0
- data/lib/up_banking/models/error_object.rb +265 -0
- data/lib/up_banking/models/error_object_source.rb +231 -0
- data/lib/up_banking/models/error_response.rb +228 -0
- data/lib/up_banking/models/get_account_response.rb +225 -0
- data/lib/up_banking/models/get_account_response_data.rb +285 -0
- data/lib/up_banking/models/get_category_response.rb +225 -0
- data/lib/up_banking/models/get_category_response_data.rb +285 -0
- data/lib/up_banking/models/get_transaction_response.rb +225 -0
- data/lib/up_banking/models/get_transaction_response_data.rb +285 -0
- data/lib/up_banking/models/get_webhook_response.rb +225 -0
- data/lib/up_banking/models/get_webhook_response_data.rb +285 -0
- data/lib/up_banking/models/hold_info_object.rb +235 -0
- data/lib/up_banking/models/hold_info_object_amount.rb +263 -0
- data/lib/up_banking/models/hold_info_object_foreign_amount.rb +263 -0
- data/lib/up_banking/models/list_accounts_response.rb +242 -0
- data/lib/up_banking/models/list_accounts_response_links.rb +232 -0
- data/lib/up_banking/models/list_categories_response.rb +228 -0
- data/lib/up_banking/models/list_tags_response.rb +242 -0
- data/lib/up_banking/models/list_transactions_response.rb +242 -0
- data/lib/up_banking/models/list_webhook_delivery_logs_response.rb +242 -0
- data/lib/up_banking/models/list_webhooks_response.rb +242 -0
- data/lib/up_banking/models/money_object.rb +256 -0
- data/lib/up_banking/models/ownership_type_enum.rb +40 -0
- data/lib/up_banking/models/ping_response.rb +225 -0
- data/lib/up_banking/models/ping_response_meta.rb +240 -0
- data/lib/up_banking/models/round_up_object.rb +235 -0
- data/lib/up_banking/models/round_up_object_amount.rb +263 -0
- data/lib/up_banking/models/round_up_object_boost_portion.rb +263 -0
- data/lib/up_banking/models/tag_input_resource_identifier.rb +241 -0
- data/lib/up_banking/models/tag_resource.rb +255 -0
- data/lib/up_banking/models/transaction_resource.rb +277 -0
- data/lib/up_banking/models/transaction_resource_attributes.rb +357 -0
- data/lib/up_banking/models/transaction_resource_attributes_amount.rb +263 -0
- data/lib/up_banking/models/transaction_resource_attributes_cashback.rb +247 -0
- data/lib/up_banking/models/transaction_resource_attributes_foreign_amount.rb +263 -0
- data/lib/up_banking/models/transaction_resource_attributes_hold_info.rb +242 -0
- data/lib/up_banking/models/transaction_resource_attributes_round_up.rb +242 -0
- data/lib/up_banking/models/transaction_resource_relationships.rb +280 -0
- data/lib/up_banking/models/transaction_resource_relationships_account.rb +233 -0
- data/lib/up_banking/models/transaction_resource_relationships_account_data.rb +240 -0
- data/lib/up_banking/models/transaction_resource_relationships_category.rb +229 -0
- data/lib/up_banking/models/transaction_resource_relationships_category_links.rb +235 -0
- data/lib/up_banking/models/transaction_resource_relationships_tags.rb +235 -0
- data/lib/up_banking/models/transaction_resource_relationships_tags_data_inner.rb +240 -0
- data/lib/up_banking/models/transaction_resource_relationships_tags_links.rb +225 -0
- data/lib/up_banking/models/transaction_resource_relationships_transfer_account.rb +230 -0
- data/lib/up_banking/models/transaction_resource_relationships_transfer_account_data.rb +240 -0
- data/lib/up_banking/models/transaction_status_enum.rb +40 -0
- data/lib/up_banking/models/update_transaction_category_request.rb +221 -0
- data/lib/up_banking/models/update_transaction_category_request_data.rb +248 -0
- data/lib/up_banking/models/update_transaction_tags_request.rb +228 -0
- data/lib/up_banking/models/webhook_delivery_log_resource.rb +269 -0
- data/lib/up_banking/models/webhook_delivery_log_resource_attributes.rb +264 -0
- data/lib/up_banking/models/webhook_delivery_log_resource_attributes_request.rb +226 -0
- data/lib/up_banking/models/webhook_delivery_log_resource_attributes_response.rb +241 -0
- data/lib/up_banking/models/webhook_delivery_log_resource_relationships.rb +224 -0
- data/lib/up_banking/models/webhook_delivery_log_resource_relationships_webhook_event.rb +224 -0
- data/lib/up_banking/models/webhook_delivery_log_resource_relationships_webhook_event_data.rb +240 -0
- data/lib/up_banking/models/webhook_delivery_status_enum.rb +41 -0
- data/lib/up_banking/models/webhook_event_callback.rb +225 -0
- data/lib/up_banking/models/webhook_event_callback_data.rb +276 -0
- data/lib/up_banking/models/webhook_event_resource.rb +269 -0
- data/lib/up_banking/models/webhook_event_resource_attributes.rb +240 -0
- data/lib/up_banking/models/webhook_event_resource_relationships.rb +233 -0
- data/lib/up_banking/models/webhook_event_resource_relationships_transaction.rb +233 -0
- data/lib/up_banking/models/webhook_event_resource_relationships_transaction_data.rb +240 -0
- data/lib/up_banking/models/webhook_event_resource_relationships_webhook.rb +233 -0
- data/lib/up_banking/models/webhook_event_resource_relationships_webhook_data.rb +240 -0
- data/lib/up_banking/models/webhook_event_type_enum.rb +42 -0
- data/lib/up_banking/models/webhook_input_resource.rb +225 -0
- data/lib/up_banking/models/webhook_input_resource_attributes.rb +236 -0
- data/lib/up_banking/models/webhook_resource.rb +278 -0
- data/lib/up_banking/models/webhook_resource_attributes.rb +261 -0
- data/lib/up_banking/models/webhook_resource_relationships.rb +224 -0
- data/lib/up_banking/version.rb +15 -0
- data/lib/up_banking.rb +141 -0
- data/spec/.DS_Store +0 -0
- data/spec/api/accounts_api_spec.rb +61 -0
- data/spec/api/categories_api_spec.rb +72 -0
- data/spec/api/tags_api_spec.rb +73 -0
- data/spec/api/transactions_api_spec.rb +82 -0
- data/spec/api/utility_endpoints_api_spec.rb +46 -0
- data/spec/api/webhooks_api_spec.rb +108 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_resource_attributes_balance_spec.rb +46 -0
- data/spec/models/account_resource_attributes_spec.rb +58 -0
- data/spec/models/account_resource_links_spec.rb +34 -0
- data/spec/models/account_resource_relationships_spec.rb +34 -0
- data/spec/models/account_resource_relationships_transactions_links_spec.rb +34 -0
- data/spec/models/account_resource_relationships_transactions_spec.rb +34 -0
- data/spec/models/account_resource_spec.rb +58 -0
- data/spec/models/account_type_enum_spec.rb +28 -0
- data/spec/models/cashback_object_amount_spec.rb +46 -0
- data/spec/models/cashback_object_spec.rb +40 -0
- data/spec/models/category_input_resource_identifier_spec.rb +40 -0
- data/spec/models/category_resource_attributes_spec.rb +34 -0
- data/spec/models/category_resource_relationships_children_data_inner_spec.rb +40 -0
- data/spec/models/category_resource_relationships_children_spec.rb +40 -0
- data/spec/models/category_resource_relationships_parent_data_spec.rb +40 -0
- data/spec/models/category_resource_relationships_parent_spec.rb +40 -0
- data/spec/models/category_resource_relationships_spec.rb +40 -0
- data/spec/models/category_resource_spec.rb +58 -0
- data/spec/models/create_webhook_request_data_spec.rb +34 -0
- data/spec/models/create_webhook_request_spec.rb +34 -0
- data/spec/models/create_webhook_response_data_spec.rb +58 -0
- data/spec/models/create_webhook_response_spec.rb +34 -0
- data/spec/models/error_object_source_spec.rb +40 -0
- data/spec/models/error_object_spec.rb +52 -0
- data/spec/models/error_response_spec.rb +34 -0
- data/spec/models/get_account_response_data_spec.rb +58 -0
- data/spec/models/get_account_response_spec.rb +34 -0
- data/spec/models/get_category_response_data_spec.rb +58 -0
- data/spec/models/get_category_response_spec.rb +34 -0
- data/spec/models/get_transaction_response_data_spec.rb +58 -0
- data/spec/models/get_transaction_response_spec.rb +34 -0
- data/spec/models/get_webhook_response_data_spec.rb +58 -0
- data/spec/models/get_webhook_response_spec.rb +34 -0
- data/spec/models/hold_info_object_amount_spec.rb +46 -0
- data/spec/models/hold_info_object_foreign_amount_spec.rb +46 -0
- data/spec/models/hold_info_object_spec.rb +40 -0
- data/spec/models/list_accounts_response_links_spec.rb +40 -0
- data/spec/models/list_accounts_response_spec.rb +40 -0
- data/spec/models/list_categories_response_spec.rb +34 -0
- data/spec/models/list_tags_response_spec.rb +40 -0
- data/spec/models/list_transactions_response_spec.rb +40 -0
- data/spec/models/list_webhook_delivery_logs_response_spec.rb +40 -0
- data/spec/models/list_webhooks_response_spec.rb +40 -0
- data/spec/models/money_object_spec.rb +46 -0
- data/spec/models/ownership_type_enum_spec.rb +28 -0
- data/spec/models/ping_response_meta_spec.rb +40 -0
- data/spec/models/ping_response_spec.rb +34 -0
- data/spec/models/round_up_object_amount_spec.rb +46 -0
- data/spec/models/round_up_object_boost_portion_spec.rb +46 -0
- data/spec/models/round_up_object_spec.rb +40 -0
- data/spec/models/tag_input_resource_identifier_spec.rb +40 -0
- data/spec/models/tag_resource_spec.rb +46 -0
- data/spec/models/transaction_resource_attributes_amount_spec.rb +46 -0
- data/spec/models/transaction_resource_attributes_cashback_spec.rb +40 -0
- data/spec/models/transaction_resource_attributes_foreign_amount_spec.rb +46 -0
- data/spec/models/transaction_resource_attributes_hold_info_spec.rb +40 -0
- data/spec/models/transaction_resource_attributes_round_up_spec.rb +40 -0
- data/spec/models/transaction_resource_attributes_spec.rb +100 -0
- data/spec/models/transaction_resource_relationships_account_data_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_account_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_category_links_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_category_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_spec.rb +58 -0
- data/spec/models/transaction_resource_relationships_tags_data_inner_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_tags_links_spec.rb +34 -0
- data/spec/models/transaction_resource_relationships_tags_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_transfer_account_data_spec.rb +40 -0
- data/spec/models/transaction_resource_relationships_transfer_account_spec.rb +40 -0
- data/spec/models/transaction_resource_spec.rb +58 -0
- data/spec/models/transaction_status_enum_spec.rb +28 -0
- data/spec/models/update_transaction_category_request_data_spec.rb +40 -0
- data/spec/models/update_transaction_category_request_spec.rb +34 -0
- data/spec/models/update_transaction_tags_request_spec.rb +34 -0
- data/spec/models/webhook_delivery_log_resource_attributes_request_spec.rb +34 -0
- data/spec/models/webhook_delivery_log_resource_attributes_response_spec.rb +40 -0
- data/spec/models/webhook_delivery_log_resource_attributes_spec.rb +52 -0
- data/spec/models/webhook_delivery_log_resource_relationships_spec.rb +34 -0
- data/spec/models/webhook_delivery_log_resource_relationships_webhook_event_data_spec.rb +40 -0
- data/spec/models/webhook_delivery_log_resource_relationships_webhook_event_spec.rb +34 -0
- data/spec/models/webhook_delivery_log_resource_spec.rb +52 -0
- data/spec/models/webhook_delivery_status_enum_spec.rb +28 -0
- data/spec/models/webhook_event_callback_data_spec.rb +52 -0
- data/spec/models/webhook_event_callback_spec.rb +34 -0
- data/spec/models/webhook_event_resource_attributes_spec.rb +40 -0
- data/spec/models/webhook_event_resource_relationships_spec.rb +40 -0
- data/spec/models/webhook_event_resource_relationships_transaction_data_spec.rb +40 -0
- data/spec/models/webhook_event_resource_relationships_transaction_spec.rb +40 -0
- data/spec/models/webhook_event_resource_relationships_webhook_data_spec.rb +40 -0
- data/spec/models/webhook_event_resource_relationships_webhook_spec.rb +40 -0
- data/spec/models/webhook_event_resource_spec.rb +52 -0
- data/spec/models/webhook_event_type_enum_spec.rb +28 -0
- data/spec/models/webhook_input_resource_attributes_spec.rb +40 -0
- data/spec/models/webhook_input_resource_spec.rb +34 -0
- data/spec/models/webhook_resource_attributes_spec.rb +52 -0
- data/spec/models/webhook_resource_relationships_spec.rb +34 -0
- data/spec/models/webhook_resource_spec.rb +58 -0
- data/spec/spec_helper.rb +111 -0
- data/up_banking.gemspec +38 -0
- metadata +511 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8295d7f7c28d47f98e689d0c7537f46a358f3210da5c250e964d2ae64a72e806
|
4
|
+
data.tar.gz: '0309e653257e0c51d344da2c90ea21d11b03e497928e1a6a0154443491add2d5'
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 6214779804a10699248f2863e08fde683c66b74e139bf46a66a273fbb693b7bdb894bcc7005482c3d6e2e2ee8020831d1d873032d1db0eac37ad0338130a788e
|
7
|
+
data.tar.gz: ea0aa1fe20a4ce27f89d77810c17d3c953dc2382c4659ce4343ddecdf579a3de0f62d137eaeb0425e19e40a044367c7f04965ad4135d74c96d71b134bba40320
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,219 @@
|
|
1
|
+
# up_banking
|
2
|
+
|
3
|
+
UpBankingClient - the Ruby gem for the Up API
|
4
|
+
|
5
|
+
The Up API gives you programmatic access to your balances and
|
6
|
+
transaction data. You can request past transactions or set up
|
7
|
+
webhooks to receive real-time events when new transactions hit your
|
8
|
+
account. It’s new, it’s exciting and it’s just the beginning.
|
9
|
+
|
10
|
+
|
11
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
12
|
+
|
13
|
+
- API version: v1
|
14
|
+
- Package version: 1.0.0
|
15
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
16
|
+
For more information, please visit [https://github.com/up-banking/api](https://github.com/up-banking/api)
|
17
|
+
|
18
|
+
## Installation
|
19
|
+
|
20
|
+
### Build a gem
|
21
|
+
|
22
|
+
To build the Ruby code into a gem:
|
23
|
+
|
24
|
+
```shell
|
25
|
+
gem build up_banking.gemspec
|
26
|
+
```
|
27
|
+
|
28
|
+
Then either install the gem locally:
|
29
|
+
|
30
|
+
```shell
|
31
|
+
gem install ./up_banking-1.0.0.gem
|
32
|
+
```
|
33
|
+
|
34
|
+
(for development, run `gem install --dev ./up_banking-1.0.0.gem` to install the development dependencies)
|
35
|
+
|
36
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
37
|
+
|
38
|
+
Finally add this to the Gemfile:
|
39
|
+
|
40
|
+
gem 'up_banking', '~> 1.0.0'
|
41
|
+
|
42
|
+
### Install from Git
|
43
|
+
|
44
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
45
|
+
|
46
|
+
gem 'up_banking', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
47
|
+
|
48
|
+
### Include the Ruby code directly
|
49
|
+
|
50
|
+
Include the Ruby code directly using `-I` as follows:
|
51
|
+
|
52
|
+
```shell
|
53
|
+
ruby -Ilib script.rb
|
54
|
+
```
|
55
|
+
|
56
|
+
## Getting Started
|
57
|
+
|
58
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
# Load the gem
|
62
|
+
require 'up_banking'
|
63
|
+
|
64
|
+
# Setup authorization
|
65
|
+
UpBankingClient.configure do |config|
|
66
|
+
# Configure Bearer authorization: bearer_auth
|
67
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
68
|
+
end
|
69
|
+
|
70
|
+
api_instance = UpBankingClient::AccountsApi.new
|
71
|
+
opts = {
|
72
|
+
page_size: 30, # Integer | The number of records to return in each page.
|
73
|
+
filter_account_type: UpBankingClient::AccountTypeEnum::SAVER, # AccountTypeEnum | The type of account for which to return records. This can be used to filter Savers from spending accounts.
|
74
|
+
filter_ownership_type: UpBankingClient::OwnershipTypeEnum::INDIVIDUAL # OwnershipTypeEnum | The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts.
|
75
|
+
}
|
76
|
+
|
77
|
+
begin
|
78
|
+
#List accounts
|
79
|
+
result = api_instance.accounts_get(opts)
|
80
|
+
p result
|
81
|
+
rescue UpBankingClient::ApiError => e
|
82
|
+
puts "Exception when calling AccountsApi->accounts_get: #{e}"
|
83
|
+
end
|
84
|
+
|
85
|
+
```
|
86
|
+
|
87
|
+
## Documentation for API Endpoints
|
88
|
+
|
89
|
+
All URIs are relative to *https://api.up.com.au/api/v1*
|
90
|
+
|
91
|
+
Class | Method | HTTP request | Description
|
92
|
+
------------ | ------------- | ------------- | -------------
|
93
|
+
*UpBankingClient::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts | List accounts
|
94
|
+
*UpBankingClient::AccountsApi* | [**accounts_id_get**](docs/AccountsApi.md#accounts_id_get) | **GET** /accounts/{id} | Retrieve account
|
95
|
+
*UpBankingClient::CategoriesApi* | [**categories_get**](docs/CategoriesApi.md#categories_get) | **GET** /categories | List categories
|
96
|
+
*UpBankingClient::CategoriesApi* | [**categories_id_get**](docs/CategoriesApi.md#categories_id_get) | **GET** /categories/{id} | Retrieve category
|
97
|
+
*UpBankingClient::CategoriesApi* | [**transactions_transaction_id_relationships_category_patch**](docs/CategoriesApi.md#transactions_transaction_id_relationships_category_patch) | **PATCH** /transactions/{transactionId}/relationships/category | Categorize transaction
|
98
|
+
*UpBankingClient::TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | List tags
|
99
|
+
*UpBankingClient::TagsApi* | [**transactions_transaction_id_relationships_tags_delete**](docs/TagsApi.md#transactions_transaction_id_relationships_tags_delete) | **DELETE** /transactions/{transactionId}/relationships/tags | Remove tags from transaction
|
100
|
+
*UpBankingClient::TagsApi* | [**transactions_transaction_id_relationships_tags_post**](docs/TagsApi.md#transactions_transaction_id_relationships_tags_post) | **POST** /transactions/{transactionId}/relationships/tags | Add tags to transaction
|
101
|
+
*UpBankingClient::TransactionsApi* | [**accounts_account_id_transactions_get**](docs/TransactionsApi.md#accounts_account_id_transactions_get) | **GET** /accounts/{accountId}/transactions | List transactions by account
|
102
|
+
*UpBankingClient::TransactionsApi* | [**transactions_get**](docs/TransactionsApi.md#transactions_get) | **GET** /transactions | List transactions
|
103
|
+
*UpBankingClient::TransactionsApi* | [**transactions_id_get**](docs/TransactionsApi.md#transactions_id_get) | **GET** /transactions/{id} | Retrieve transaction
|
104
|
+
*UpBankingClient::UtilityEndpointsApi* | [**util_ping_get**](docs/UtilityEndpointsApi.md#util_ping_get) | **GET** /util/ping | Ping
|
105
|
+
*UpBankingClient::WebhooksApi* | [**webhooks_get**](docs/WebhooksApi.md#webhooks_get) | **GET** /webhooks | List webhooks
|
106
|
+
*UpBankingClient::WebhooksApi* | [**webhooks_id_delete**](docs/WebhooksApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Delete webhook
|
107
|
+
*UpBankingClient::WebhooksApi* | [**webhooks_id_get**](docs/WebhooksApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Retrieve webhook
|
108
|
+
*UpBankingClient::WebhooksApi* | [**webhooks_post**](docs/WebhooksApi.md#webhooks_post) | **POST** /webhooks | Create webhook
|
109
|
+
*UpBankingClient::WebhooksApi* | [**webhooks_webhook_id_logs_get**](docs/WebhooksApi.md#webhooks_webhook_id_logs_get) | **GET** /webhooks/{webhookId}/logs | List webhook logs
|
110
|
+
*UpBankingClient::WebhooksApi* | [**webhooks_webhook_id_ping_post**](docs/WebhooksApi.md#webhooks_webhook_id_ping_post) | **POST** /webhooks/{webhookId}/ping | Ping webhook
|
111
|
+
|
112
|
+
|
113
|
+
## Documentation for Models
|
114
|
+
|
115
|
+
- [UpBankingClient::AccountResource](docs/AccountResource.md)
|
116
|
+
- [UpBankingClient::AccountResourceAttributes](docs/AccountResourceAttributes.md)
|
117
|
+
- [UpBankingClient::AccountResourceAttributesBalance](docs/AccountResourceAttributesBalance.md)
|
118
|
+
- [UpBankingClient::AccountResourceLinks](docs/AccountResourceLinks.md)
|
119
|
+
- [UpBankingClient::AccountResourceRelationships](docs/AccountResourceRelationships.md)
|
120
|
+
- [UpBankingClient::AccountResourceRelationshipsTransactions](docs/AccountResourceRelationshipsTransactions.md)
|
121
|
+
- [UpBankingClient::AccountResourceRelationshipsTransactionsLinks](docs/AccountResourceRelationshipsTransactionsLinks.md)
|
122
|
+
- [UpBankingClient::AccountTypeEnum](docs/AccountTypeEnum.md)
|
123
|
+
- [UpBankingClient::CashbackObject](docs/CashbackObject.md)
|
124
|
+
- [UpBankingClient::CashbackObjectAmount](docs/CashbackObjectAmount.md)
|
125
|
+
- [UpBankingClient::CategoryInputResourceIdentifier](docs/CategoryInputResourceIdentifier.md)
|
126
|
+
- [UpBankingClient::CategoryResource](docs/CategoryResource.md)
|
127
|
+
- [UpBankingClient::CategoryResourceAttributes](docs/CategoryResourceAttributes.md)
|
128
|
+
- [UpBankingClient::CategoryResourceRelationships](docs/CategoryResourceRelationships.md)
|
129
|
+
- [UpBankingClient::CategoryResourceRelationshipsChildren](docs/CategoryResourceRelationshipsChildren.md)
|
130
|
+
- [UpBankingClient::CategoryResourceRelationshipsChildrenDataInner](docs/CategoryResourceRelationshipsChildrenDataInner.md)
|
131
|
+
- [UpBankingClient::CategoryResourceRelationshipsParent](docs/CategoryResourceRelationshipsParent.md)
|
132
|
+
- [UpBankingClient::CategoryResourceRelationshipsParentData](docs/CategoryResourceRelationshipsParentData.md)
|
133
|
+
- [UpBankingClient::CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
134
|
+
- [UpBankingClient::CreateWebhookRequestData](docs/CreateWebhookRequestData.md)
|
135
|
+
- [UpBankingClient::CreateWebhookResponse](docs/CreateWebhookResponse.md)
|
136
|
+
- [UpBankingClient::CreateWebhookResponseData](docs/CreateWebhookResponseData.md)
|
137
|
+
- [UpBankingClient::ErrorObject](docs/ErrorObject.md)
|
138
|
+
- [UpBankingClient::ErrorObjectSource](docs/ErrorObjectSource.md)
|
139
|
+
- [UpBankingClient::ErrorResponse](docs/ErrorResponse.md)
|
140
|
+
- [UpBankingClient::GetAccountResponse](docs/GetAccountResponse.md)
|
141
|
+
- [UpBankingClient::GetAccountResponseData](docs/GetAccountResponseData.md)
|
142
|
+
- [UpBankingClient::GetCategoryResponse](docs/GetCategoryResponse.md)
|
143
|
+
- [UpBankingClient::GetCategoryResponseData](docs/GetCategoryResponseData.md)
|
144
|
+
- [UpBankingClient::GetTransactionResponse](docs/GetTransactionResponse.md)
|
145
|
+
- [UpBankingClient::GetTransactionResponseData](docs/GetTransactionResponseData.md)
|
146
|
+
- [UpBankingClient::GetWebhookResponse](docs/GetWebhookResponse.md)
|
147
|
+
- [UpBankingClient::GetWebhookResponseData](docs/GetWebhookResponseData.md)
|
148
|
+
- [UpBankingClient::HoldInfoObject](docs/HoldInfoObject.md)
|
149
|
+
- [UpBankingClient::HoldInfoObjectAmount](docs/HoldInfoObjectAmount.md)
|
150
|
+
- [UpBankingClient::HoldInfoObjectForeignAmount](docs/HoldInfoObjectForeignAmount.md)
|
151
|
+
- [UpBankingClient::ListAccountsResponse](docs/ListAccountsResponse.md)
|
152
|
+
- [UpBankingClient::ListAccountsResponseLinks](docs/ListAccountsResponseLinks.md)
|
153
|
+
- [UpBankingClient::ListCategoriesResponse](docs/ListCategoriesResponse.md)
|
154
|
+
- [UpBankingClient::ListTagsResponse](docs/ListTagsResponse.md)
|
155
|
+
- [UpBankingClient::ListTransactionsResponse](docs/ListTransactionsResponse.md)
|
156
|
+
- [UpBankingClient::ListWebhookDeliveryLogsResponse](docs/ListWebhookDeliveryLogsResponse.md)
|
157
|
+
- [UpBankingClient::ListWebhooksResponse](docs/ListWebhooksResponse.md)
|
158
|
+
- [UpBankingClient::MoneyObject](docs/MoneyObject.md)
|
159
|
+
- [UpBankingClient::OwnershipTypeEnum](docs/OwnershipTypeEnum.md)
|
160
|
+
- [UpBankingClient::PingResponse](docs/PingResponse.md)
|
161
|
+
- [UpBankingClient::PingResponseMeta](docs/PingResponseMeta.md)
|
162
|
+
- [UpBankingClient::RoundUpObject](docs/RoundUpObject.md)
|
163
|
+
- [UpBankingClient::RoundUpObjectAmount](docs/RoundUpObjectAmount.md)
|
164
|
+
- [UpBankingClient::RoundUpObjectBoostPortion](docs/RoundUpObjectBoostPortion.md)
|
165
|
+
- [UpBankingClient::TagInputResourceIdentifier](docs/TagInputResourceIdentifier.md)
|
166
|
+
- [UpBankingClient::TagResource](docs/TagResource.md)
|
167
|
+
- [UpBankingClient::TransactionResource](docs/TransactionResource.md)
|
168
|
+
- [UpBankingClient::TransactionResourceAttributes](docs/TransactionResourceAttributes.md)
|
169
|
+
- [UpBankingClient::TransactionResourceAttributesAmount](docs/TransactionResourceAttributesAmount.md)
|
170
|
+
- [UpBankingClient::TransactionResourceAttributesCashback](docs/TransactionResourceAttributesCashback.md)
|
171
|
+
- [UpBankingClient::TransactionResourceAttributesForeignAmount](docs/TransactionResourceAttributesForeignAmount.md)
|
172
|
+
- [UpBankingClient::TransactionResourceAttributesHoldInfo](docs/TransactionResourceAttributesHoldInfo.md)
|
173
|
+
- [UpBankingClient::TransactionResourceAttributesRoundUp](docs/TransactionResourceAttributesRoundUp.md)
|
174
|
+
- [UpBankingClient::TransactionResourceRelationships](docs/TransactionResourceRelationships.md)
|
175
|
+
- [UpBankingClient::TransactionResourceRelationshipsAccount](docs/TransactionResourceRelationshipsAccount.md)
|
176
|
+
- [UpBankingClient::TransactionResourceRelationshipsAccountData](docs/TransactionResourceRelationshipsAccountData.md)
|
177
|
+
- [UpBankingClient::TransactionResourceRelationshipsCategory](docs/TransactionResourceRelationshipsCategory.md)
|
178
|
+
- [UpBankingClient::TransactionResourceRelationshipsCategoryLinks](docs/TransactionResourceRelationshipsCategoryLinks.md)
|
179
|
+
- [UpBankingClient::TransactionResourceRelationshipsTags](docs/TransactionResourceRelationshipsTags.md)
|
180
|
+
- [UpBankingClient::TransactionResourceRelationshipsTagsDataInner](docs/TransactionResourceRelationshipsTagsDataInner.md)
|
181
|
+
- [UpBankingClient::TransactionResourceRelationshipsTagsLinks](docs/TransactionResourceRelationshipsTagsLinks.md)
|
182
|
+
- [UpBankingClient::TransactionResourceRelationshipsTransferAccount](docs/TransactionResourceRelationshipsTransferAccount.md)
|
183
|
+
- [UpBankingClient::TransactionResourceRelationshipsTransferAccountData](docs/TransactionResourceRelationshipsTransferAccountData.md)
|
184
|
+
- [UpBankingClient::TransactionStatusEnum](docs/TransactionStatusEnum.md)
|
185
|
+
- [UpBankingClient::UpdateTransactionCategoryRequest](docs/UpdateTransactionCategoryRequest.md)
|
186
|
+
- [UpBankingClient::UpdateTransactionCategoryRequestData](docs/UpdateTransactionCategoryRequestData.md)
|
187
|
+
- [UpBankingClient::UpdateTransactionTagsRequest](docs/UpdateTransactionTagsRequest.md)
|
188
|
+
- [UpBankingClient::WebhookDeliveryLogResource](docs/WebhookDeliveryLogResource.md)
|
189
|
+
- [UpBankingClient::WebhookDeliveryLogResourceAttributes](docs/WebhookDeliveryLogResourceAttributes.md)
|
190
|
+
- [UpBankingClient::WebhookDeliveryLogResourceAttributesRequest](docs/WebhookDeliveryLogResourceAttributesRequest.md)
|
191
|
+
- [UpBankingClient::WebhookDeliveryLogResourceAttributesResponse](docs/WebhookDeliveryLogResourceAttributesResponse.md)
|
192
|
+
- [UpBankingClient::WebhookDeliveryLogResourceRelationships](docs/WebhookDeliveryLogResourceRelationships.md)
|
193
|
+
- [UpBankingClient::WebhookDeliveryLogResourceRelationshipsWebhookEvent](docs/WebhookDeliveryLogResourceRelationshipsWebhookEvent.md)
|
194
|
+
- [UpBankingClient::WebhookDeliveryLogResourceRelationshipsWebhookEventData](docs/WebhookDeliveryLogResourceRelationshipsWebhookEventData.md)
|
195
|
+
- [UpBankingClient::WebhookDeliveryStatusEnum](docs/WebhookDeliveryStatusEnum.md)
|
196
|
+
- [UpBankingClient::WebhookEventCallback](docs/WebhookEventCallback.md)
|
197
|
+
- [UpBankingClient::WebhookEventCallbackData](docs/WebhookEventCallbackData.md)
|
198
|
+
- [UpBankingClient::WebhookEventResource](docs/WebhookEventResource.md)
|
199
|
+
- [UpBankingClient::WebhookEventResourceAttributes](docs/WebhookEventResourceAttributes.md)
|
200
|
+
- [UpBankingClient::WebhookEventResourceRelationships](docs/WebhookEventResourceRelationships.md)
|
201
|
+
- [UpBankingClient::WebhookEventResourceRelationshipsTransaction](docs/WebhookEventResourceRelationshipsTransaction.md)
|
202
|
+
- [UpBankingClient::WebhookEventResourceRelationshipsTransactionData](docs/WebhookEventResourceRelationshipsTransactionData.md)
|
203
|
+
- [UpBankingClient::WebhookEventResourceRelationshipsWebhook](docs/WebhookEventResourceRelationshipsWebhook.md)
|
204
|
+
- [UpBankingClient::WebhookEventResourceRelationshipsWebhookData](docs/WebhookEventResourceRelationshipsWebhookData.md)
|
205
|
+
- [UpBankingClient::WebhookEventTypeEnum](docs/WebhookEventTypeEnum.md)
|
206
|
+
- [UpBankingClient::WebhookInputResource](docs/WebhookInputResource.md)
|
207
|
+
- [UpBankingClient::WebhookInputResourceAttributes](docs/WebhookInputResourceAttributes.md)
|
208
|
+
- [UpBankingClient::WebhookResource](docs/WebhookResource.md)
|
209
|
+
- [UpBankingClient::WebhookResourceAttributes](docs/WebhookResourceAttributes.md)
|
210
|
+
- [UpBankingClient::WebhookResourceRelationships](docs/WebhookResourceRelationships.md)
|
211
|
+
|
212
|
+
|
213
|
+
## Documentation for Authorization
|
214
|
+
|
215
|
+
|
216
|
+
### bearer_auth
|
217
|
+
|
218
|
+
- **Type**: Bearer authentication
|
219
|
+
|
data/Rakefile
ADDED
data/config.json
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
{
|
2
|
+
"gemName": "UpBanking",
|
3
|
+
"gemAuthor": "Ben Richardson",
|
4
|
+
"gemDescription": "Unofficial Ruby gem for the Up Banking API",
|
5
|
+
"gemHomepage": "https://github.com/ben-gy/up-banking",
|
6
|
+
"gemName": "up_banking",
|
7
|
+
"gemSummary": "Unofficial Ruby gem for the Up Banking API",
|
8
|
+
"moduleName": "UpBankingClient"
|
9
|
+
}
|
10
|
+
|
11
|
+
// openapi-generator generate -i https://raw.githubusercontent.com/up-banking/api/master/v1/openapi.json -g ruby -o /Users/benrichardson/Code/up-banking-ruby/ -c /Users/benrichardson/Code/up-banking-ruby/config.json
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UpBankingClient::AccountResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | The type of this resource: `accounts` | |
|
8
|
+
| **id** | **String** | The unique identifier for this account. | |
|
9
|
+
| **attributes** | [**AccountResourceAttributes**](AccountResourceAttributes.md) | | |
|
10
|
+
| **relationships** | [**AccountResourceRelationships**](AccountResourceRelationships.md) | | |
|
11
|
+
| **links** | [**AccountResourceLinks**](AccountResourceLinks.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'up_banking'
|
17
|
+
|
18
|
+
instance = UpBankingClient::AccountResource.new(
|
19
|
+
type: null,
|
20
|
+
id: null,
|
21
|
+
attributes: null,
|
22
|
+
relationships: null,
|
23
|
+
links: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UpBankingClient::AccountResourceAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **display_name** | **String** | The name associated with the account in the Up application. | |
|
8
|
+
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type of this account. | |
|
9
|
+
| **ownership_type** | [**OwnershipTypeEnum**](OwnershipTypeEnum.md) | The ownership structure for this account. | |
|
10
|
+
| **balance** | [**AccountResourceAttributesBalance**](AccountResourceAttributesBalance.md) | | |
|
11
|
+
| **created_at** | **Time** | The date-time at which this account was first opened. | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'up_banking'
|
17
|
+
|
18
|
+
instance = UpBankingClient::AccountResourceAttributes.new(
|
19
|
+
display_name: null,
|
20
|
+
account_type: null,
|
21
|
+
ownership_type: null,
|
22
|
+
balance: null,
|
23
|
+
created_at: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UpBankingClient::AccountResourceAttributesBalance
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **currency_code** | **String** | The ISO 4217 currency code. | |
|
8
|
+
| **value** | **String** | The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `\"10.56\"`. The currency symbol is not included in the string. | |
|
9
|
+
| **value_in_base_units** | **Integer** | The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'up_banking'
|
15
|
+
|
16
|
+
instance = UpBankingClient::AccountResourceAttributesBalance.new(
|
17
|
+
currency_code: null,
|
18
|
+
value: null,
|
19
|
+
value_in_base_units: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UpBankingClient::AccountResourceLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_self** | **String** | The canonical link to this resource within the API. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'up_banking'
|
13
|
+
|
14
|
+
instance = UpBankingClient::AccountResourceLinks.new(
|
15
|
+
_self: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UpBankingClient::AccountResourceRelationships
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **transactions** | [**AccountResourceRelationshipsTransactions**](AccountResourceRelationshipsTransactions.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'up_banking'
|
13
|
+
|
14
|
+
instance = UpBankingClient::AccountResourceRelationships.new(
|
15
|
+
transactions: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UpBankingClient::AccountResourceRelationshipsTransactions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **links** | [**AccountResourceRelationshipsTransactionsLinks**](AccountResourceRelationshipsTransactionsLinks.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'up_banking'
|
13
|
+
|
14
|
+
instance = UpBankingClient::AccountResourceRelationshipsTransactions.new(
|
15
|
+
links: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UpBankingClient::AccountResourceRelationshipsTransactionsLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **related** | **String** | The link to retrieve the related resource(s) in this relationship. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'up_banking'
|
13
|
+
|
14
|
+
instance = UpBankingClient::AccountResourceRelationshipsTransactionsLinks.new(
|
15
|
+
related: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# UpBankingClient::AccountTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'up_banking'
|
12
|
+
|
13
|
+
instance = UpBankingClient::AccountTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/AccountsApi.md
ADDED
@@ -0,0 +1,153 @@
|
|
1
|
+
# UpBankingClient::AccountsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.up.com.au/api/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts | List accounts |
|
8
|
+
| [**accounts_id_get**](AccountsApi.md#accounts_id_get) | **GET** /accounts/{id} | Retrieve account |
|
9
|
+
|
10
|
+
|
11
|
+
## accounts_get
|
12
|
+
|
13
|
+
> <ListAccountsResponse> accounts_get(opts)
|
14
|
+
|
15
|
+
List accounts
|
16
|
+
|
17
|
+
Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the `prev` and `next` links where present.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'up_banking'
|
24
|
+
# setup authorization
|
25
|
+
UpBankingClient.configure do |config|
|
26
|
+
# Configure Bearer authorization: bearer_auth
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = UpBankingClient::AccountsApi.new
|
31
|
+
opts = {
|
32
|
+
page_size: 30, # Integer | The number of records to return in each page.
|
33
|
+
filter_account_type: UpBankingClient::AccountTypeEnum::SAVER, # AccountTypeEnum | The type of account for which to return records. This can be used to filter Savers from spending accounts.
|
34
|
+
filter_ownership_type: UpBankingClient::OwnershipTypeEnum::INDIVIDUAL # OwnershipTypeEnum | The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts.
|
35
|
+
}
|
36
|
+
|
37
|
+
begin
|
38
|
+
# List accounts
|
39
|
+
result = api_instance.accounts_get(opts)
|
40
|
+
p result
|
41
|
+
rescue UpBankingClient::ApiError => e
|
42
|
+
puts "Error when calling AccountsApi->accounts_get: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
#### Using the accounts_get_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
49
|
+
|
50
|
+
> <Array(<ListAccountsResponse>, Integer, Hash)> accounts_get_with_http_info(opts)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# List accounts
|
55
|
+
data, status_code, headers = api_instance.accounts_get_with_http_info(opts)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => <ListAccountsResponse>
|
59
|
+
rescue UpBankingClient::ApiError => e
|
60
|
+
puts "Error when calling AccountsApi->accounts_get_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **page_size** | **Integer** | The number of records to return in each page. | [optional] |
|
69
|
+
| **filter_account_type** | [**AccountTypeEnum**](.md) | The type of account for which to return records. This can be used to filter Savers from spending accounts. | [optional] |
|
70
|
+
| **filter_ownership_type** | [**OwnershipTypeEnum**](.md) | The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts. | [optional] |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
[**ListAccountsResponse**](ListAccountsResponse.md)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[bearer_auth](../README.md#bearer_auth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: Not defined
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## accounts_id_get
|
87
|
+
|
88
|
+
> <GetAccountResponse> accounts_id_get(id)
|
89
|
+
|
90
|
+
Retrieve account
|
91
|
+
|
92
|
+
Retrieve a specific account by providing its unique identifier.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'up_banking'
|
99
|
+
# setup authorization
|
100
|
+
UpBankingClient.configure do |config|
|
101
|
+
# Configure Bearer authorization: bearer_auth
|
102
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = UpBankingClient::AccountsApi.new
|
106
|
+
id = '92b41408-6b7b-4fca-982b-3fb1fdd77220' # String | The unique identifier for the account.
|
107
|
+
|
108
|
+
begin
|
109
|
+
# Retrieve account
|
110
|
+
result = api_instance.accounts_id_get(id)
|
111
|
+
p result
|
112
|
+
rescue UpBankingClient::ApiError => e
|
113
|
+
puts "Error when calling AccountsApi->accounts_id_get: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the accounts_id_get_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<GetAccountResponse>, Integer, Hash)> accounts_id_get_with_http_info(id)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
# Retrieve account
|
126
|
+
data, status_code, headers = api_instance.accounts_id_get_with_http_info(id)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <GetAccountResponse>
|
130
|
+
rescue UpBankingClient::ApiError => e
|
131
|
+
puts "Error when calling AccountsApi->accounts_id_get_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **id** | **String** | The unique identifier for the account. | |
|
140
|
+
|
141
|
+
### Return type
|
142
|
+
|
143
|
+
[**GetAccountResponse**](GetAccountResponse.md)
|
144
|
+
|
145
|
+
### Authorization
|
146
|
+
|
147
|
+
[bearer_auth](../README.md#bearer_auth)
|
148
|
+
|
149
|
+
### HTTP request headers
|
150
|
+
|
151
|
+
- **Content-Type**: Not defined
|
152
|
+
- **Accept**: application/json
|
153
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UpBankingClient::CashbackObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | A brief description of why this cashback was paid. | |
|
8
|
+
| **amount** | [**CashbackObjectAmount**](CashbackObjectAmount.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'up_banking'
|
14
|
+
|
15
|
+
instance = UpBankingClient::CashbackObject.new(
|
16
|
+
description: null,
|
17
|
+
amount: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UpBankingClient::CashbackObjectAmount
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **currency_code** | **String** | The ISO 4217 currency code. | |
|
8
|
+
| **value** | **String** | The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `\"10.56\"`. The currency symbol is not included in the string. | |
|
9
|
+
| **value_in_base_units** | **Integer** | The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'up_banking'
|
15
|
+
|
16
|
+
instance = UpBankingClient::CashbackObjectAmount.new(
|
17
|
+
currency_code: null,
|
18
|
+
value: null,
|
19
|
+
value_in_base_units: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|