up_banking 1.0.0

data/docs/UpdateTransactionCategoryRequestData.md

@@ -0,0 +1,20 @@
+# UpBankingClient::UpdateTransactionCategoryRequestData
+
+## 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::UpdateTransactionCategoryRequestData.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/UpdateTransactionTagsRequest.md

@@ -0,0 +1,18 @@
+# UpBankingClient::UpdateTransactionTagsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<TagInputResourceIdentifier>**](TagInputResourceIdentifier.md) | The tags to add to or remove from the transaction.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::UpdateTransactionTagsRequest.new(
+  data: null
+)
+```
+

data/docs/UtilityEndpointsApi.md

@@ -0,0 +1,74 @@
+# UpBankingClient::UtilityEndpointsApi
+
+All URIs are relative to *https://api.up.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**util_ping_get**](UtilityEndpointsApi.md#util_ping_get) | **GET** /util/ping | Ping |
+
+
+## util_ping_get
+
+> <PingResponse> util_ping_get
+
+Ping
+
+Make a basic ping request to the API. This is useful to verify that authentication is functioning correctly. On authentication success an HTTP `200` status is returned. On failure an HTTP `401` error response is returned. 
+
+### 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::UtilityEndpointsApi.new
+
+begin
+  # Ping
+  result = api_instance.util_ping_get
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling UtilityEndpointsApi->util_ping_get: #{e}"
+end
+```
+
+#### Using the util_ping_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PingResponse>, Integer, Hash)> util_ping_get_with_http_info
+
+```ruby
+begin
+  # Ping
+  data, status_code, headers = api_instance.util_ping_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PingResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling UtilityEndpointsApi->util_ping_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PingResponse**](PingResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/WebhookDeliveryLogResource.md

@@ -0,0 +1,24 @@
+# UpBankingClient::WebhookDeliveryLogResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `webhook-delivery-logs` |  |
+| **id** | **String** | The unique identifier for this log entry.  |  |
+| **attributes** | [**WebhookDeliveryLogResourceAttributes**](WebhookDeliveryLogResourceAttributes.md) |  |  |
+| **relationships** | [**WebhookDeliveryLogResourceRelationships**](WebhookDeliveryLogResourceRelationships.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookDeliveryLogResource.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null
+)
+```
+

data/docs/WebhookDeliveryLogResourceAttributes.md

@@ -0,0 +1,24 @@
+# UpBankingClient::WebhookDeliveryLogResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request** | [**WebhookDeliveryLogResourceAttributesRequest**](WebhookDeliveryLogResourceAttributesRequest.md) |  |  |
+| **response** | [**WebhookDeliveryLogResourceAttributesResponse**](WebhookDeliveryLogResourceAttributesResponse.md) |  |  |
+| **delivery_status** | [**WebhookDeliveryStatusEnum**](WebhookDeliveryStatusEnum.md) | The success or failure status of this delivery attempt.  |  |
+| **created_at** | **Time** | The date-time at which this log entry was created.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookDeliveryLogResourceAttributes.new(
+  request: null,
+  response: null,
+  delivery_status: null,
+  created_at: null
+)
+```
+

data/docs/WebhookDeliveryLogResourceAttributesRequest.md

@@ -0,0 +1,18 @@
+# UpBankingClient::WebhookDeliveryLogResourceAttributesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | The payload that was sent in the request body.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookDeliveryLogResourceAttributesRequest.new(
+  body: null
+)
+```
+

data/docs/WebhookDeliveryLogResourceAttributesResponse.md

@@ -0,0 +1,20 @@
+# UpBankingClient::WebhookDeliveryLogResourceAttributesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status_code** | **Integer** | The HTTP status code received in the response.  |  |
+| **body** | **String** | The payload that was received in the response body.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookDeliveryLogResourceAttributesResponse.new(
+  status_code: null,
+  body: null
+)
+```
+

data/docs/WebhookDeliveryLogResourceRelationships.md

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

data/docs/WebhookDeliveryLogResourceRelationshipsWebhookEvent.md

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

data/docs/WebhookDeliveryLogResourceRelationshipsWebhookEventData.md

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

data/docs/WebhookDeliveryStatusEnum.md

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

data/docs/WebhookEventCallback.md

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

data/docs/WebhookEventCallbackData.md

@@ -0,0 +1,24 @@
+# UpBankingClient::WebhookEventCallbackData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `webhook-events` |  |
+| **id** | **String** | The unique identifier for this event. This will remain constant across delivery retries.  |  |
+| **attributes** | [**WebhookEventResourceAttributes**](WebhookEventResourceAttributes.md) |  |  |
+| **relationships** | [**WebhookEventResourceRelationships**](WebhookEventResourceRelationships.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookEventCallbackData.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null
+)
+```
+

data/docs/WebhookEventResource.md

@@ -0,0 +1,24 @@
+# UpBankingClient::WebhookEventResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `webhook-events` |  |
+| **id** | **String** | The unique identifier for this event. This will remain constant across delivery retries.  |  |
+| **attributes** | [**WebhookEventResourceAttributes**](WebhookEventResourceAttributes.md) |  |  |
+| **relationships** | [**WebhookEventResourceRelationships**](WebhookEventResourceRelationships.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookEventResource.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null
+)
+```
+

data/docs/WebhookEventResourceAttributes.md

@@ -0,0 +1,20 @@
+# UpBankingClient::WebhookEventResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | [**WebhookEventTypeEnum**](WebhookEventTypeEnum.md) | The type of this event. This can be used to determine what action to take in response to the event.  |  |
+| **created_at** | **Time** | The date-time at which this event was generated.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookEventResourceAttributes.new(
+  event_type: null,
+  created_at: null
+)
+```
+

data/docs/WebhookEventResourceRelationships.md

@@ -0,0 +1,20 @@
+# UpBankingClient::WebhookEventResourceRelationships
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook** | [**WebhookEventResourceRelationshipsWebhook**](WebhookEventResourceRelationshipsWebhook.md) |  |  |
+| **transaction** | [**WebhookEventResourceRelationshipsTransaction**](WebhookEventResourceRelationshipsTransaction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookEventResourceRelationships.new(
+  webhook: null,
+  transaction: null
+)
+```
+

data/docs/WebhookEventResourceRelationshipsTransaction.md

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

data/docs/WebhookEventResourceRelationshipsTransactionData.md

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

data/docs/WebhookEventResourceRelationshipsWebhook.md

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

data/docs/WebhookEventResourceRelationshipsWebhookData.md

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

data/docs/WebhookEventTypeEnum.md

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

data/docs/WebhookInputResource.md

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

data/docs/WebhookInputResourceAttributes.md

@@ -0,0 +1,20 @@
+# UpBankingClient::WebhookInputResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL that this webhook should post events to. This must be a valid HTTP or HTTPS URL that does not exceed 300 characters in length.  |  |
+| **description** | **String** | An optional description for this webhook, up to 64 characters in length.  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookInputResourceAttributes.new(
+  url: null,
+  description: null
+)
+```
+

data/docs/WebhookResource.md

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

data/docs/WebhookResourceAttributes.md

@@ -0,0 +1,24 @@
+# UpBankingClient::WebhookResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL that this webhook is configured to `POST` events to.  |  |
+| **description** | **String** | An optional description that was provided at the time the webhook was created.  |  |
+| **secret_key** | **String** | A shared secret key used to sign all webhook events sent to the configured webhook URL. This field is returned only once, upon the initial creation of the webhook. If lost, create a new webhook and delete this webhook.  The webhook URL receives a request with a `X-Up-Authenticity-Signature` header, which is the SHA-256 HMAC of the entire raw request body signed using this `secretKey`. It is advised to compute and check this signature to verify the authenticity of requests sent to the webhook URL. See [Handling webhook events](#callback_post_webhookURL) for full details.  | [optional] |
+| **created_at** | **Time** | The date-time at which this webhook was created.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::WebhookResourceAttributes.new(
+  url: null,
+  description: null,
+  secret_key: null,
+  created_at: null
+)
+```
+

data/docs/WebhookResourceRelationships.md

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