up_banking 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResource
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of this resource: `transactions` | |
|
|
8
|
+
| **id** | **String** | The unique identifier for this transaction. | |
|
|
9
|
+
| **attributes** | [**TransactionResourceAttributes**](TransactionResourceAttributes.md) | | |
|
|
10
|
+
| **relationships** | [**TransactionResourceRelationships**](TransactionResourceRelationships.md) | | |
|
|
11
|
+
| **links** | [**AccountResourceLinks**](AccountResourceLinks.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'up_banking'
|
|
17
|
+
|
|
18
|
+
instance = UpBankingClient::TransactionResource.new(
|
|
19
|
+
type: null,
|
|
20
|
+
id: null,
|
|
21
|
+
attributes: null,
|
|
22
|
+
relationships: null,
|
|
23
|
+
links: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceAttributes
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | [**TransactionStatusEnum**](TransactionStatusEnum.md) | The current processing status of this transaction, according to whether or not this transaction has settled or is still held. | |
|
|
8
|
+
| **raw_text** | **String** | The original, unprocessed text of the transaction. This is often not a perfect indicator of the actual merchant, but it is useful for reconciliation purposes in some cases. | |
|
|
9
|
+
| **description** | **String** | A short description for this transaction. Usually the merchant name for purchases. | |
|
|
10
|
+
| **message** | **String** | Attached message for this transaction, such as a payment message, or a transfer note. | |
|
|
11
|
+
| **is_categorizable** | **Boolean** | Boolean flag set to true on transactions that support the use of categories. | |
|
|
12
|
+
| **hold_info** | [**TransactionResourceAttributesHoldInfo**](TransactionResourceAttributesHoldInfo.md) | | |
|
|
13
|
+
| **round_up** | [**TransactionResourceAttributesRoundUp**](TransactionResourceAttributesRoundUp.md) | | |
|
|
14
|
+
| **cashback** | [**TransactionResourceAttributesCashback**](TransactionResourceAttributesCashback.md) | | |
|
|
15
|
+
| **amount** | [**TransactionResourceAttributesAmount**](TransactionResourceAttributesAmount.md) | | |
|
|
16
|
+
| **foreign_amount** | [**TransactionResourceAttributesForeignAmount**](TransactionResourceAttributesForeignAmount.md) | | |
|
|
17
|
+
| **settled_at** | **Time** | The date-time at which this transaction settled. This field will be `null` for transactions that are currently in the `HELD` status. | |
|
|
18
|
+
| **created_at** | **Time** | The date-time at which this transaction was first encountered. | |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'up_banking'
|
|
24
|
+
|
|
25
|
+
instance = UpBankingClient::TransactionResourceAttributes.new(
|
|
26
|
+
status: null,
|
|
27
|
+
raw_text: null,
|
|
28
|
+
description: null,
|
|
29
|
+
message: null,
|
|
30
|
+
is_categorizable: null,
|
|
31
|
+
hold_info: null,
|
|
32
|
+
round_up: null,
|
|
33
|
+
cashback: null,
|
|
34
|
+
amount: null,
|
|
35
|
+
foreign_amount: null,
|
|
36
|
+
settled_at: null,
|
|
37
|
+
created_at: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceAttributesAmount
|
|
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::TransactionResourceAttributesAmount.new(
|
|
17
|
+
currency_code: null,
|
|
18
|
+
value: null,
|
|
19
|
+
value_in_base_units: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceAttributesCashback
|
|
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::TransactionResourceAttributesCashback.new(
|
|
16
|
+
description: null,
|
|
17
|
+
amount: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceAttributesForeignAmount
|
|
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::TransactionResourceAttributesForeignAmount.new(
|
|
17
|
+
currency_code: null,
|
|
18
|
+
value: null,
|
|
19
|
+
value_in_base_units: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceAttributesHoldInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **amount** | [**HoldInfoObjectAmount**](HoldInfoObjectAmount.md) | | |
|
|
8
|
+
| **foreign_amount** | [**HoldInfoObjectForeignAmount**](HoldInfoObjectForeignAmount.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceAttributesHoldInfo.new(
|
|
16
|
+
amount: null,
|
|
17
|
+
foreign_amount: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceAttributesRoundUp
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **amount** | [**RoundUpObjectAmount**](RoundUpObjectAmount.md) | | |
|
|
8
|
+
| **boost_portion** | [**RoundUpObjectBoostPortion**](RoundUpObjectBoostPortion.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceAttributesRoundUp.new(
|
|
16
|
+
amount: null,
|
|
17
|
+
boost_portion: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationships
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account** | [**TransactionResourceRelationshipsAccount**](TransactionResourceRelationshipsAccount.md) | | |
|
|
8
|
+
| **transfer_account** | [**TransactionResourceRelationshipsTransferAccount**](TransactionResourceRelationshipsTransferAccount.md) | | |
|
|
9
|
+
| **category** | [**TransactionResourceRelationshipsCategory**](TransactionResourceRelationshipsCategory.md) | | |
|
|
10
|
+
| **parent_category** | [**CategoryResourceRelationshipsParent**](CategoryResourceRelationshipsParent.md) | | |
|
|
11
|
+
| **tags** | [**TransactionResourceRelationshipsTags**](TransactionResourceRelationshipsTags.md) | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'up_banking'
|
|
17
|
+
|
|
18
|
+
instance = UpBankingClient::TransactionResourceRelationships.new(
|
|
19
|
+
account: null,
|
|
20
|
+
transfer_account: null,
|
|
21
|
+
category: null,
|
|
22
|
+
parent_category: null,
|
|
23
|
+
tags: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**TransactionResourceRelationshipsAccountData**](TransactionResourceRelationshipsAccountData.md) | | |
|
|
8
|
+
| **links** | [**AccountResourceRelationshipsTransactionsLinks**](AccountResourceRelationshipsTransactionsLinks.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsAccount.new(
|
|
16
|
+
data: null,
|
|
17
|
+
links: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsAccountData
|
|
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 of the resource within its type. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsAccountData.new(
|
|
16
|
+
type: null,
|
|
17
|
+
id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsCategory
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**CategoryResourceRelationshipsParentData**](CategoryResourceRelationshipsParentData.md) | | |
|
|
8
|
+
| **links** | [**TransactionResourceRelationshipsCategoryLinks**](TransactionResourceRelationshipsCategoryLinks.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsCategory.new(
|
|
16
|
+
data: null,
|
|
17
|
+
links: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsCategoryLinks
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_self** | **String** | The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship. | |
|
|
8
|
+
| **related** | **String** | The link to retrieve the related resource(s) in this relationship. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsCategoryLinks.new(
|
|
16
|
+
_self: null,
|
|
17
|
+
related: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsTags
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<TransactionResourceRelationshipsTagsDataInner>**](TransactionResourceRelationshipsTagsDataInner.md) | | |
|
|
8
|
+
| **links** | [**TransactionResourceRelationshipsTagsLinks**](TransactionResourceRelationshipsTagsLinks.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsTags.new(
|
|
16
|
+
data: null,
|
|
17
|
+
links: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsTagsDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of this resource: `tags` | |
|
|
8
|
+
| **id** | **String** | The label of the tag, which also acts as the tag’s unique identifier. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsTagsDataInner.new(
|
|
16
|
+
type: null,
|
|
17
|
+
id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsTagsLinks
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_self** | **String** | The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'up_banking'
|
|
13
|
+
|
|
14
|
+
instance = UpBankingClient::TransactionResourceRelationshipsTagsLinks.new(
|
|
15
|
+
_self: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsTransferAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**TransactionResourceRelationshipsTransferAccountData**](TransactionResourceRelationshipsTransferAccountData.md) | | |
|
|
8
|
+
| **links** | [**AccountResourceRelationshipsTransactionsLinks**](AccountResourceRelationshipsTransactionsLinks.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsTransferAccount.new(
|
|
16
|
+
data: null,
|
|
17
|
+
links: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpBankingClient::TransactionResourceRelationshipsTransferAccountData
|
|
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 of the resource within its type. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'up_banking'
|
|
14
|
+
|
|
15
|
+
instance = UpBankingClient::TransactionResourceRelationshipsTransferAccountData.new(
|
|
16
|
+
type: null,
|
|
17
|
+
id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# UpBankingClient::TransactionStatusEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'up_banking'
|
|
12
|
+
|
|
13
|
+
instance = UpBankingClient::TransactionStatusEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
# UpBankingClient::TransactionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.up.com.au/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**accounts_account_id_transactions_get**](TransactionsApi.md#accounts_account_id_transactions_get) | **GET** /accounts/{accountId}/transactions | List transactions by account |
|
|
8
|
+
| [**transactions_get**](TransactionsApi.md#transactions_get) | **GET** /transactions | List transactions |
|
|
9
|
+
| [**transactions_id_get**](TransactionsApi.md#transactions_id_get) | **GET** /transactions/{id} | Retrieve transaction |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## accounts_account_id_transactions_get
|
|
13
|
+
|
|
14
|
+
> <ListTransactionsResponse> accounts_account_id_transactions_get(account_id, opts)
|
|
15
|
+
|
|
16
|
+
List transactions by account
|
|
17
|
+
|
|
18
|
+
Retrieve a list of all transactions for a specific account. The returned list is [paginated](#pagination) and can be scrolled by following the `next` and `prev` links where present. To narrow the results to a specific date range pass one or both of `filter[since]` and `filter[until]` in the query string. These filter parameters **should not** be used for pagination. Results are ordered newest first to oldest last.
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'up_banking'
|
|
25
|
+
# setup authorization
|
|
26
|
+
UpBankingClient.configure do |config|
|
|
27
|
+
# Configure Bearer authorization: bearer_auth
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = UpBankingClient::TransactionsApi.new
|
|
32
|
+
account_id = 'b5544658-4bbd-4eb1-8f63-a9909e0f564b' # String | The unique identifier for the account.
|
|
33
|
+
opts = {
|
|
34
|
+
page_size: 30, # Integer | The number of records to return in each page.
|
|
35
|
+
filter_status: UpBankingClient::TransactionStatusEnum::HELD, # TransactionStatusEnum | The transaction status for which to return records. This can be used to filter `HELD` transactions from those that are `SETTLED`.
|
|
36
|
+
filter_since: Time.parse('2020-01-01T01:02:03+10:00'), # Time | The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
|
|
37
|
+
filter_until: Time.parse('2020-02-01T01:02:03+10:00'), # Time | The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
|
|
38
|
+
filter_category: 'good-life', # String | The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter. Providing an invalid category identifier results in a `404` response.
|
|
39
|
+
filter_tag: 'Holiday' # String | A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given.
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
# List transactions by account
|
|
44
|
+
result = api_instance.accounts_account_id_transactions_get(account_id, opts)
|
|
45
|
+
p result
|
|
46
|
+
rescue UpBankingClient::ApiError => e
|
|
47
|
+
puts "Error when calling TransactionsApi->accounts_account_id_transactions_get: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Using the accounts_account_id_transactions_get_with_http_info variant
|
|
52
|
+
|
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
|
54
|
+
|
|
55
|
+
> <Array(<ListTransactionsResponse>, Integer, Hash)> accounts_account_id_transactions_get_with_http_info(account_id, opts)
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
begin
|
|
59
|
+
# List transactions by account
|
|
60
|
+
data, status_code, headers = api_instance.accounts_account_id_transactions_get_with_http_info(account_id, opts)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => <ListTransactionsResponse>
|
|
64
|
+
rescue UpBankingClient::ApiError => e
|
|
65
|
+
puts "Error when calling TransactionsApi->accounts_account_id_transactions_get_with_http_info: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **account_id** | **String** | The unique identifier for the account. | |
|
|
74
|
+
| **page_size** | **Integer** | The number of records to return in each page. | [optional] |
|
|
75
|
+
| **filter_status** | [**TransactionStatusEnum**](.md) | The transaction status for which to return records. This can be used to filter `HELD` transactions from those that are `SETTLED`. | [optional] |
|
|
76
|
+
| **filter_since** | **Time** | The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. | [optional] |
|
|
77
|
+
| **filter_until** | **Time** | The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. | [optional] |
|
|
78
|
+
| **filter_category** | **String** | The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter. Providing an invalid category identifier results in a `404` response. | [optional] |
|
|
79
|
+
| **filter_tag** | **String** | A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given. | [optional] |
|
|
80
|
+
|
|
81
|
+
### Return type
|
|
82
|
+
|
|
83
|
+
[**ListTransactionsResponse**](ListTransactionsResponse.md)
|
|
84
|
+
|
|
85
|
+
### Authorization
|
|
86
|
+
|
|
87
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
88
|
+
|
|
89
|
+
### HTTP request headers
|
|
90
|
+
|
|
91
|
+
- **Content-Type**: Not defined
|
|
92
|
+
- **Accept**: application/json
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
## transactions_get
|
|
96
|
+
|
|
97
|
+
> <ListTransactionsResponse> transactions_get(opts)
|
|
98
|
+
|
|
99
|
+
List transactions
|
|
100
|
+
|
|
101
|
+
Retrieve a list of all transactions across all accounts for the currently authenticated user. The returned list is [paginated](#pagination) and can be scrolled by following the `next` and `prev` links where present. To narrow the results to a specific date range pass one or both of `filter[since]` and `filter[until]` in the query string. These filter parameters **should not** be used for pagination. Results are ordered newest first to oldest last.
|
|
102
|
+
|
|
103
|
+
### Examples
|
|
104
|
+
|
|
105
|
+
```ruby
|
|
106
|
+
require 'time'
|
|
107
|
+
require 'up_banking'
|
|
108
|
+
# setup authorization
|
|
109
|
+
UpBankingClient.configure do |config|
|
|
110
|
+
# Configure Bearer authorization: bearer_auth
|
|
111
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
api_instance = UpBankingClient::TransactionsApi.new
|
|
115
|
+
opts = {
|
|
116
|
+
page_size: 30, # Integer | The number of records to return in each page.
|
|
117
|
+
filter_status: UpBankingClient::TransactionStatusEnum::HELD, # TransactionStatusEnum | The transaction status for which to return records. This can be used to filter `HELD` transactions from those that are `SETTLED`.
|
|
118
|
+
filter_since: Time.parse('2020-01-01T01:02:03+10:00'), # Time | The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
|
|
119
|
+
filter_until: Time.parse('2020-02-01T01:02:03+10:00'), # Time | The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.
|
|
120
|
+
filter_category: 'good-life', # String | The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter. Providing an invalid category identifier results in a `404` response.
|
|
121
|
+
filter_tag: 'Holiday' # String | A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given.
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
begin
|
|
125
|
+
# List transactions
|
|
126
|
+
result = api_instance.transactions_get(opts)
|
|
127
|
+
p result
|
|
128
|
+
rescue UpBankingClient::ApiError => e
|
|
129
|
+
puts "Error when calling TransactionsApi->transactions_get: #{e}"
|
|
130
|
+
end
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
#### Using the transactions_get_with_http_info variant
|
|
134
|
+
|
|
135
|
+
This returns an Array which contains the response data, status code and headers.
|
|
136
|
+
|
|
137
|
+
> <Array(<ListTransactionsResponse>, Integer, Hash)> transactions_get_with_http_info(opts)
|
|
138
|
+
|
|
139
|
+
```ruby
|
|
140
|
+
begin
|
|
141
|
+
# List transactions
|
|
142
|
+
data, status_code, headers = api_instance.transactions_get_with_http_info(opts)
|
|
143
|
+
p status_code # => 2xx
|
|
144
|
+
p headers # => { ... }
|
|
145
|
+
p data # => <ListTransactionsResponse>
|
|
146
|
+
rescue UpBankingClient::ApiError => e
|
|
147
|
+
puts "Error when calling TransactionsApi->transactions_get_with_http_info: #{e}"
|
|
148
|
+
end
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
| Name | Type | Description | Notes |
|
|
154
|
+
| ---- | ---- | ----------- | ----- |
|
|
155
|
+
| **page_size** | **Integer** | The number of records to return in each page. | [optional] |
|
|
156
|
+
| **filter_status** | [**TransactionStatusEnum**](.md) | The transaction status for which to return records. This can be used to filter `HELD` transactions from those that are `SETTLED`. | [optional] |
|
|
157
|
+
| **filter_since** | **Time** | The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. | [optional] |
|
|
158
|
+
| **filter_until** | **Time** | The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. | [optional] |
|
|
159
|
+
| **filter_category** | **String** | The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter. Providing an invalid category identifier results in a `404` response. | [optional] |
|
|
160
|
+
| **filter_tag** | **String** | A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given. | [optional] |
|
|
161
|
+
|
|
162
|
+
### Return type
|
|
163
|
+
|
|
164
|
+
[**ListTransactionsResponse**](ListTransactionsResponse.md)
|
|
165
|
+
|
|
166
|
+
### Authorization
|
|
167
|
+
|
|
168
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
169
|
+
|
|
170
|
+
### HTTP request headers
|
|
171
|
+
|
|
172
|
+
- **Content-Type**: Not defined
|
|
173
|
+
- **Accept**: application/json
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
## transactions_id_get
|
|
177
|
+
|
|
178
|
+
> <GetTransactionResponse> transactions_id_get(id)
|
|
179
|
+
|
|
180
|
+
Retrieve transaction
|
|
181
|
+
|
|
182
|
+
Retrieve a specific transaction by providing its unique identifier.
|
|
183
|
+
|
|
184
|
+
### Examples
|
|
185
|
+
|
|
186
|
+
```ruby
|
|
187
|
+
require 'time'
|
|
188
|
+
require 'up_banking'
|
|
189
|
+
# setup authorization
|
|
190
|
+
UpBankingClient.configure do |config|
|
|
191
|
+
# Configure Bearer authorization: bearer_auth
|
|
192
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
api_instance = UpBankingClient::TransactionsApi.new
|
|
196
|
+
id = '7a9d19f9-106c-4e29-8591-52fc5d8f09c5' # String | The unique identifier for the transaction.
|
|
197
|
+
|
|
198
|
+
begin
|
|
199
|
+
# Retrieve transaction
|
|
200
|
+
result = api_instance.transactions_id_get(id)
|
|
201
|
+
p result
|
|
202
|
+
rescue UpBankingClient::ApiError => e
|
|
203
|
+
puts "Error when calling TransactionsApi->transactions_id_get: #{e}"
|
|
204
|
+
end
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
#### Using the transactions_id_get_with_http_info variant
|
|
208
|
+
|
|
209
|
+
This returns an Array which contains the response data, status code and headers.
|
|
210
|
+
|
|
211
|
+
> <Array(<GetTransactionResponse>, Integer, Hash)> transactions_id_get_with_http_info(id)
|
|
212
|
+
|
|
213
|
+
```ruby
|
|
214
|
+
begin
|
|
215
|
+
# Retrieve transaction
|
|
216
|
+
data, status_code, headers = api_instance.transactions_id_get_with_http_info(id)
|
|
217
|
+
p status_code # => 2xx
|
|
218
|
+
p headers # => { ... }
|
|
219
|
+
p data # => <GetTransactionResponse>
|
|
220
|
+
rescue UpBankingClient::ApiError => e
|
|
221
|
+
puts "Error when calling TransactionsApi->transactions_id_get_with_http_info: #{e}"
|
|
222
|
+
end
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Name | Type | Description | Notes |
|
|
228
|
+
| ---- | ---- | ----------- | ----- |
|
|
229
|
+
| **id** | **String** | The unique identifier for the transaction. | |
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
[**GetTransactionResponse**](GetTransactionResponse.md)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: Not defined
|
|
242
|
+
- **Accept**: application/json
|
|
243
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UpBankingClient::UpdateTransactionCategoryRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**UpdateTransactionCategoryRequestData**](UpdateTransactionCategoryRequestData.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'up_banking'
|
|
13
|
+
|
|
14
|
+
instance = UpBankingClient::UpdateTransactionCategoryRequest.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|