up_banking 1.0.0

data/docs/CategoriesApi.md

@@ -0,0 +1,222 @@
+# UpBankingClient::CategoriesApi
+
+All URIs are relative to *https://api.up.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**categories_get**](CategoriesApi.md#categories_get) | **GET** /categories | List categories |
+| [**categories_id_get**](CategoriesApi.md#categories_id_get) | **GET** /categories/{id} | Retrieve category |
+| [**transactions_transaction_id_relationships_category_patch**](CategoriesApi.md#transactions_transaction_id_relationships_category_patch) | **PATCH** /transactions/{transactionId}/relationships/category | Categorize transaction |
+
+
+## categories_get
+
+> <ListCategoriesResponse> categories_get(opts)
+
+List categories
+
+Retrieve a list of all categories and their ancestry. The returned list is not paginated. 
+
+### 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::CategoriesApi.new
+opts = {
+  filter_parent: 'good-life' # String | The unique identifier of a parent category for which to return only its children. Providing an invalid category identifier results in a `404` response. 
+}
+
+begin
+  # List categories
+  result = api_instance.categories_get(opts)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling CategoriesApi->categories_get: #{e}"
+end
+```
+
+#### Using the categories_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCategoriesResponse>, Integer, Hash)> categories_get_with_http_info(opts)
+
+```ruby
+begin
+  # List categories
+  data, status_code, headers = api_instance.categories_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCategoriesResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling CategoriesApi->categories_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter_parent** | **String** | The unique identifier of a parent category for which to return only its children. Providing an invalid category identifier results in a &#x60;404&#x60; response.  | [optional] |
+
+### Return type
+
+[**ListCategoriesResponse**](ListCategoriesResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## categories_id_get
+
+> <GetCategoryResponse> categories_id_get(id)
+
+Retrieve category
+
+Retrieve a specific category by providing its unique identifier. 
+
+### 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::CategoriesApi.new
+id = 'restaurants-and-cafes' # String | The unique identifier for the category. 
+
+begin
+  # Retrieve category
+  result = api_instance.categories_id_get(id)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling CategoriesApi->categories_id_get: #{e}"
+end
+```
+
+#### Using the categories_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCategoryResponse>, Integer, Hash)> categories_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve category
+  data, status_code, headers = api_instance.categories_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCategoryResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling CategoriesApi->categories_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier for the category.  |  |
+
+### Return type
+
+[**GetCategoryResponse**](GetCategoryResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## transactions_transaction_id_relationships_category_patch
+
+> transactions_transaction_id_relationships_category_patch(transaction_id, opts)
+
+Categorize transaction
+
+Updates the category associated with a transaction. Only transactions for which `isCategorizable` is set to true support this operation. The `id` is taken from the list exposed on `/categories` and cannot be one of the top-level (parent) categories. To de-categorize a transaction, set the entire `data` key to `null`. An HTTP `204` is returned on success. The associated category, along with its request URL is also exposed via the `category` 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::CategoriesApi.new
+transaction_id = 'a572c7c3-b637-433c-a4ce-c0be5dcb0a5a' # String | The unique identifier for the transaction. 
+opts = {
+  update_transaction_category_request: UpBankingClient::UpdateTransactionCategoryRequest.new({data: UpBankingClient::UpdateTransactionCategoryRequestData.new({type: 'type_example', id: 'id_example'})}) # UpdateTransactionCategoryRequest | 
+}
+
+begin
+  # Categorize transaction
+  api_instance.transactions_transaction_id_relationships_category_patch(transaction_id, opts)
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling CategoriesApi->transactions_transaction_id_relationships_category_patch: #{e}"
+end
+```
+
+#### Using the transactions_transaction_id_relationships_category_patch_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_category_patch_with_http_info(transaction_id, opts)
+
+```ruby
+begin
+  # Categorize transaction
+  data, status_code, headers = api_instance.transactions_transaction_id_relationships_category_patch_with_http_info(transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling CategoriesApi->transactions_transaction_id_relationships_category_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | The unique identifier for the transaction.  |  |
+| **update_transaction_category_request** | [**UpdateTransactionCategoryRequest**](UpdateTransactionCategoryRequest.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
+

data/docs/CategoryInputResourceIdentifier.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CategoryInputResourceIdentifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `categories` |  |
+| **id** | **String** | The unique identifier of the category, as returned by the `/categories` endpoint.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryInputResourceIdentifier.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/CategoryResource.md

@@ -0,0 +1,26 @@
+# UpBankingClient::CategoryResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `categories` |  |
+| **id** | **String** | The unique identifier for this category. This is a human-readable but URL-safe value.  |  |
+| **attributes** | [**CategoryResourceAttributes**](CategoryResourceAttributes.md) |  |  |
+| **relationships** | [**CategoryResourceRelationships**](CategoryResourceRelationships.md) |  |  |
+| **links** | [**AccountResourceLinks**](AccountResourceLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResource.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null,
+  links: null
+)
+```
+

data/docs/CategoryResourceAttributes.md

@@ -0,0 +1,18 @@
+# UpBankingClient::CategoryResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of this category as seen in the Up application.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResourceAttributes.new(
+  name: null
+)
+```
+

data/docs/CategoryResourceRelationships.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CategoryResourceRelationships
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parent** | [**CategoryResourceRelationshipsParent**](CategoryResourceRelationshipsParent.md) |  |  |
+| **children** | [**CategoryResourceRelationshipsChildren**](CategoryResourceRelationshipsChildren.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResourceRelationships.new(
+  parent: null,
+  children: null
+)
+```
+

data/docs/CategoryResourceRelationshipsChildren.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CategoryResourceRelationshipsChildren
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CategoryResourceRelationshipsChildrenDataInner>**](CategoryResourceRelationshipsChildrenDataInner.md) |  |  |
+| **links** | [**AccountResourceRelationshipsTransactionsLinks**](AccountResourceRelationshipsTransactionsLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResourceRelationshipsChildren.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/CategoryResourceRelationshipsChildrenDataInner.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CategoryResourceRelationshipsChildrenDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `categories` |  |
+| **id** | **String** | The unique identifier of the resource within its type.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResourceRelationshipsChildrenDataInner.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/CategoryResourceRelationshipsParent.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CategoryResourceRelationshipsParent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CategoryResourceRelationshipsParentData**](CategoryResourceRelationshipsParentData.md) |  |  |
+| **links** | [**AccountResourceRelationshipsTransactionsLinks**](AccountResourceRelationshipsTransactionsLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResourceRelationshipsParent.new(
+  data: null,
+  links: null
+)
+```
+

data/docs/CategoryResourceRelationshipsParentData.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CategoryResourceRelationshipsParentData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `categories` |  |
+| **id** | **String** | The unique identifier of the resource within its type.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CategoryResourceRelationshipsParentData.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/CreateWebhookRequest.md

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

data/docs/CreateWebhookRequestData.md

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

data/docs/CreateWebhookResponse.md

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

data/docs/CreateWebhookResponseData.md

@@ -0,0 +1,26 @@
+# UpBankingClient::CreateWebhookResponseData
+
+## 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::CreateWebhookResponseData.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null,
+  links: null
+)
+```
+

data/docs/ErrorObject.md

@@ -0,0 +1,24 @@
+# UpBankingClient::ErrorObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The HTTP status code associated with this error. This can also be obtained from the response headers. The status indicates the broad type of error according to HTTP semantics.  |  |
+| **title** | **String** | A short description of this error. This should be stable across multiple occurrences of this type of error and typically expands on the reason for the status code.  |  |
+| **detail** | **String** | A detailed description of this error. This should be considered unique to individual occurrences of an error and subject to change. It is useful for debugging purposes.  |  |
+| **source** | [**ErrorObjectSource**](ErrorObjectSource.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ErrorObject.new(
+  status: null,
+  title: null,
+  detail: null,
+  source: null
+)
+```
+

data/docs/ErrorObjectSource.md

@@ -0,0 +1,20 @@
+# UpBankingClient::ErrorObjectSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parameter** | **String** | If this error relates to a query parameter, the name of the parameter.  | [optional] |
+| **pointer** | **String** | If this error relates to an attribute in the request body, a rfc-6901 JSON pointer to the attribute.  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::ErrorObjectSource.new(
+  parameter: null,
+  pointer: null
+)
+```
+

data/docs/ErrorResponse.md

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

data/docs/GetAccountResponse.md

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

data/docs/GetAccountResponseData.md

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

data/docs/GetCategoryResponse.md

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

data/docs/GetCategoryResponseData.md

@@ -0,0 +1,26 @@
+# UpBankingClient::GetCategoryResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `categories` |  |
+| **id** | **String** | The unique identifier for this category. This is a human-readable but URL-safe value.  |  |
+| **attributes** | [**CategoryResourceAttributes**](CategoryResourceAttributes.md) |  |  |
+| **relationships** | [**CategoryResourceRelationships**](CategoryResourceRelationships.md) |  |  |
+| **links** | [**AccountResourceLinks**](AccountResourceLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::GetCategoryResponseData.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null,
+  links: null
+)
+```
+

data/docs/GetTransactionResponse.md

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

data/docs/GetTransactionResponseData.md

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