up_banking 1.0.0

data/docs/GetWebhookResponse.md

@@ -0,0 +1,18 @@
+# UpBankingClient::GetWebhookResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**GetWebhookResponseData**](GetWebhookResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::GetWebhookResponse.new(
+  data: null
+)
+```
+

data/docs/GetWebhookResponseData.md

@@ -0,0 +1,26 @@
+# UpBankingClient::GetWebhookResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `webhooks` |  |
+| **id** | **String** | The unique identifier for this webhook.  |  |
+| **attributes** | [**WebhookResourceAttributes**](WebhookResourceAttributes.md) |  |  |
+| **relationships** | [**WebhookResourceRelationships**](WebhookResourceRelationships.md) |  |  |
+| **links** | [**AccountResourceLinks**](AccountResourceLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::GetWebhookResponseData.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null,
+  links: null
+)
+```
+

data/docs/HoldInfoObject.md

@@ -0,0 +1,20 @@
+# UpBankingClient::HoldInfoObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | [**HoldInfoObjectAmount**](HoldInfoObjectAmount.md) |  |  |
+| **foreign_amount** | [**HoldInfoObjectForeignAmount**](HoldInfoObjectForeignAmount.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::HoldInfoObject.new(
+  amount: null,
+  foreign_amount: null
+)
+```
+

data/docs/HoldInfoObjectAmount.md

@@ -0,0 +1,22 @@
+# UpBankingClient::HoldInfoObjectAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **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.  |  |
+| **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`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::HoldInfoObjectAmount.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+

data/docs/HoldInfoObjectForeignAmount.md

@@ -0,0 +1,22 @@
+# UpBankingClient::HoldInfoObjectForeignAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **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.  |  |
+| **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`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::HoldInfoObjectForeignAmount.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+

data/docs/ListAccountsResponse.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ListAccountsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<AccountResource>**](AccountResource.md) | The list of accounts returned in this response.  |  |
+| **links** | [**ListAccountsResponseLinks**](ListAccountsResponseLinks.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListAccountsResponse.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/ListAccountsResponseLinks.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ListAccountsResponseLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prev** | **String** | The link to the previous page in the results. If this value is `null` there is no previous page.  |  |
+| **_next** | **String** | The link to the next page in the results. If this value is `null` there is no next page.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListAccountsResponseLinks.new(
+  prev: null,
+  _next: null
+)
+```
+

data/docs/ListCategoriesResponse.md

@@ -0,0 +1,18 @@
+# UpBankingClient::ListCategoriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CategoryResource>**](CategoryResource.md) | The list of categories returned in this response.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListCategoriesResponse.new(
+  data: null
+)
+```
+

data/docs/ListTagsResponse.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ListTagsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<TagResource>**](TagResource.md) | The list of tags returned in this response.  |  |
+| **links** | [**ListAccountsResponseLinks**](ListAccountsResponseLinks.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListTagsResponse.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/ListTransactionsResponse.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ListTransactionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<TransactionResource>**](TransactionResource.md) | The list of transactions returned in this response.  |  |
+| **links** | [**ListAccountsResponseLinks**](ListAccountsResponseLinks.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListTransactionsResponse.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/ListWebhookDeliveryLogsResponse.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ListWebhookDeliveryLogsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<WebhookDeliveryLogResource>**](WebhookDeliveryLogResource.md) | The list of delivery logs returned in this response.  |  |
+| **links** | [**ListAccountsResponseLinks**](ListAccountsResponseLinks.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListWebhookDeliveryLogsResponse.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/ListWebhooksResponse.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ListWebhooksResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<WebhookResource>**](WebhookResource.md) | The list of webhooks returned in this response.  |  |
+| **links** | [**ListAccountsResponseLinks**](ListAccountsResponseLinks.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ListWebhooksResponse.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/MoneyObject.md

@@ -0,0 +1,22 @@
+# UpBankingClient::MoneyObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **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.  |  |
+| **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`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::MoneyObject.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+

data/docs/OwnershipTypeEnum.md

@@ -0,0 +1,15 @@
+# UpBankingClient::OwnershipTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::OwnershipTypeEnum.new()
+```
+

data/docs/PingResponse.md

@@ -0,0 +1,18 @@
+# UpBankingClient::PingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meta** | [**PingResponseMeta**](PingResponseMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::PingResponse.new(
+  meta: null
+)
+```
+

data/docs/PingResponseMeta.md

@@ -0,0 +1,20 @@
+# UpBankingClient::PingResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier of the authenticated customer.  |  |
+| **status_emoji** | **String** | A cute emoji that represents the response status.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::PingResponseMeta.new(
+  id: null,
+  status_emoji: null
+)
+```
+

data/docs/RoundUpObject.md

@@ -0,0 +1,20 @@
+# UpBankingClient::RoundUpObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | [**RoundUpObjectAmount**](RoundUpObjectAmount.md) |  |  |
+| **boost_portion** | [**RoundUpObjectBoostPortion**](RoundUpObjectBoostPortion.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::RoundUpObject.new(
+  amount: null,
+  boost_portion: null
+)
+```
+

data/docs/RoundUpObjectAmount.md

@@ -0,0 +1,22 @@
+# UpBankingClient::RoundUpObjectAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **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.  |  |
+| **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`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::RoundUpObjectAmount.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+

data/docs/RoundUpObjectBoostPortion.md

@@ -0,0 +1,22 @@
+# UpBankingClient::RoundUpObjectBoostPortion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **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.  |  |
+| **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`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::RoundUpObjectBoostPortion.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+

data/docs/TagInputResourceIdentifier.md

@@ -0,0 +1,20 @@
+# UpBankingClient::TagInputResourceIdentifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `tags` |  |
+| **id** | **String** | The label of the tag, which also acts as the tag’s unique identifier.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::TagInputResourceIdentifier.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/TagResource.md

@@ -0,0 +1,22 @@
+# UpBankingClient::TagResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `tags` |  |
+| **id** | **String** | The label of the tag, which also acts as the tag’s unique identifier.  |  |
+| **relationships** | [**AccountResourceRelationships**](AccountResourceRelationships.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::TagResource.new(
+  type: null,
+  id: null,
+  relationships: null
+)
+```
+

data/docs/TagsApi.md

@@ -0,0 +1,225 @@
+# UpBankingClient::TagsApi
+
+All URIs are relative to *https://api.up.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**tags_get**](TagsApi.md#tags_get) | **GET** /tags | List tags |
+| [**transactions_transaction_id_relationships_tags_delete**](TagsApi.md#transactions_transaction_id_relationships_tags_delete) | **DELETE** /transactions/{transactionId}/relationships/tags | Remove tags from transaction |
+| [**transactions_transaction_id_relationships_tags_post**](TagsApi.md#transactions_transaction_id_relationships_tags_post) | **POST** /transactions/{transactionId}/relationships/tags | Add tags to transaction |
+
+
+## tags_get
+
+> <ListTagsResponse> tags_get(opts)
+
+List tags
+
+Retrieve a list of all tags currently in use. The returned list is [paginated](#pagination) and can be scrolled by following the `next` and `prev` links where present. Results are ordered lexicographically. The `transactions` relationship for each tag exposes a link to get the transactions with the given tag. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'up_banking'
+# setup authorization
+UpBankingClient.configure do |config|
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = UpBankingClient::TagsApi.new
+opts = {
+  page_size: 50 # Integer | The number of records to return in each page. 
+}
+
+begin
+  # List tags
+  result = api_instance.tags_get(opts)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling TagsApi->tags_get: #{e}"
+end
+```
+
+#### Using the tags_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTagsResponse>, Integer, Hash)> tags_get_with_http_info(opts)
+
+```ruby
+begin
+  # List tags
+  data, status_code, headers = api_instance.tags_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTagsResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling TagsApi->tags_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_size** | **Integer** | The number of records to return in each page.  | [optional] |
+
+### Return type
+
+[**ListTagsResponse**](ListTagsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## transactions_transaction_id_relationships_tags_delete
+
+> transactions_transaction_id_relationships_tags_delete(transaction_id, opts)
+
+Remove tags from transaction
+
+Disassociates one or more tags from a specific transaction. Tags that are not associated are silently ignored. An HTTP `204` is returned on success. The associated tags, along with this request URL, are also exposed via the `tags` relationship on the transaction resource returned from `/transactions/{id}`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'up_banking'
+# setup authorization
+UpBankingClient.configure do |config|
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = UpBankingClient::TagsApi.new
+transaction_id = 'c3feb4ba-829c-4482-b882-1b9bd23da82d' # String | The unique identifier for the transaction. 
+opts = {
+  update_transaction_tags_request: UpBankingClient::UpdateTransactionTagsRequest.new({data: [UpBankingClient::TagInputResourceIdentifier.new({type: 'type_example', id: 'id_example'})]}) # UpdateTransactionTagsRequest | 
+}
+
+begin
+  # Remove tags from transaction
+  api_instance.transactions_transaction_id_relationships_tags_delete(transaction_id, opts)
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling TagsApi->transactions_transaction_id_relationships_tags_delete: #{e}"
+end
+```
+
+#### Using the transactions_transaction_id_relationships_tags_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> transactions_transaction_id_relationships_tags_delete_with_http_info(transaction_id, opts)
+
+```ruby
+begin
+  # Remove tags from transaction
+  data, status_code, headers = api_instance.transactions_transaction_id_relationships_tags_delete_with_http_info(transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling TagsApi->transactions_transaction_id_relationships_tags_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | The unique identifier for the transaction.  |  |
+| **update_transaction_tags_request** | [**UpdateTransactionTagsRequest**](UpdateTransactionTagsRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## transactions_transaction_id_relationships_tags_post
+
+> transactions_transaction_id_relationships_tags_post(transaction_id, opts)
+
+Add tags to transaction
+
+Associates one or more tags with a specific transaction. No more than 6 tags may be present on any single transaction. Duplicate tags are silently ignored. An HTTP `204` is returned on success. The associated tags, along with this request URL, are also exposed via the `tags` relationship on the transaction resource returned from `/transactions/{id}`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'up_banking'
+# setup authorization
+UpBankingClient.configure do |config|
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = UpBankingClient::TagsApi.new
+transaction_id = 'acde4631-db56-49a6-aea3-4e2311ef1d6a' # String | The unique identifier for the transaction. 
+opts = {
+  update_transaction_tags_request: UpBankingClient::UpdateTransactionTagsRequest.new({data: [UpBankingClient::TagInputResourceIdentifier.new({type: 'type_example', id: 'id_example'})]}) # UpdateTransactionTagsRequest | 
+}
+
+begin
+  # Add tags to transaction
+  api_instance.transactions_transaction_id_relationships_tags_post(transaction_id, opts)
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling TagsApi->transactions_transaction_id_relationships_tags_post: #{e}"
+end
+```
+
+#### Using the transactions_transaction_id_relationships_tags_post_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> transactions_transaction_id_relationships_tags_post_with_http_info(transaction_id, opts)
+
+```ruby
+begin
+  # Add tags to transaction
+  data, status_code, headers = api_instance.transactions_transaction_id_relationships_tags_post_with_http_info(transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling TagsApi->transactions_transaction_id_relationships_tags_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | The unique identifier for the transaction.  |  |
+| **update_transaction_tags_request** | [**UpdateTransactionTagsRequest**](UpdateTransactionTagsRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+