up_banking 1.0.0

data/docs/WebhooksApi.md

@@ -0,0 +1,434 @@
+# UpBankingClient::WebhooksApi
+
+All URIs are relative to *https://api.up.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**webhooks_get**](WebhooksApi.md#webhooks_get) | **GET** /webhooks | List webhooks |
+| [**webhooks_id_delete**](WebhooksApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Delete webhook |
+| [**webhooks_id_get**](WebhooksApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Retrieve webhook |
+| [**webhooks_post**](WebhooksApi.md#webhooks_post) | **POST** /webhooks | Create webhook |
+| [**webhooks_webhook_id_logs_get**](WebhooksApi.md#webhooks_webhook_id_logs_get) | **GET** /webhooks/{webhookId}/logs | List webhook logs |
+| [**webhooks_webhook_id_ping_post**](WebhooksApi.md#webhooks_webhook_id_ping_post) | **POST** /webhooks/{webhookId}/ping | Ping webhook |
+
+
+## webhooks_get
+
+> <ListWebhooksResponse> webhooks_get(opts)
+
+List webhooks
+
+Retrieve a list of configured webhooks. The returned list is [paginated](#pagination) and can be scrolled by following the `next` and `prev` links where present. Results are ordered oldest first to newest last. 
+
+### 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::WebhooksApi.new
+opts = {
+  page_size: 30 # Integer | The number of records to return in each page. 
+}
+
+begin
+  # List webhooks
+  result = api_instance.webhooks_get(opts)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_get: #{e}"
+end
+```
+
+#### Using the webhooks_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWebhooksResponse>, Integer, Hash)> webhooks_get_with_http_info(opts)
+
+```ruby
+begin
+  # List webhooks
+  data, status_code, headers = api_instance.webhooks_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWebhooksResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_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
+
+[**ListWebhooksResponse**](ListWebhooksResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhooks_id_delete
+
+> webhooks_id_delete(id)
+
+Delete webhook
+
+Delete a specific webhook by providing its unique identifier. Once deleted, webhook events will no longer be sent to the configured URL. 
+
+### 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::WebhooksApi.new
+id = 'a940825b-80b6-4798-b378-c6284259b4c5' # String | The unique identifier for the webhook. 
+
+begin
+  # Delete webhook
+  api_instance.webhooks_id_delete(id)
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_id_delete: #{e}"
+end
+```
+
+#### Using the webhooks_id_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)> webhooks_id_delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete webhook
+  data, status_code, headers = api_instance.webhooks_id_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier for the webhook.  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## webhooks_id_get
+
+> <GetWebhookResponse> webhooks_id_get(id)
+
+Retrieve webhook
+
+Retrieve a specific webhook 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::WebhooksApi.new
+id = 'c8283a72-24b0-4fd8-9b13-fccccab371e5' # String | The unique identifier for the webhook. 
+
+begin
+  # Retrieve webhook
+  result = api_instance.webhooks_id_get(id)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_id_get: #{e}"
+end
+```
+
+#### Using the webhooks_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWebhookResponse>, Integer, Hash)> webhooks_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve webhook
+  data, status_code, headers = api_instance.webhooks_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWebhookResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier for the webhook.  |  |
+
+### Return type
+
+[**GetWebhookResponse**](GetWebhookResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhooks_post
+
+> <CreateWebhookResponse> webhooks_post(opts)
+
+Create webhook
+
+Create a new webhook with a given URL. The URL will receive webhook events as JSON-encoded `POST` requests. The URL must respond with a HTTP `200` status on success.  There is currently a limit of 10 webhooks at any given time. Once this limit is reached, existing webhooks will need to be deleted before new webhooks can be created.  Event delivery is retried with exponential backoff if the URL is unreachable or it does not respond with a `200` status. The response includes a `secretKey` attribute, which is used to sign requests sent to the webhook URL. It will not be returned from any other endpoints within the Up API. If the `secretKey` is lost, simply create a new webhook with the same URL, capture its `secretKey` and then delete the original webhook. See [Handling webhook events](#callback_post_webhookURL) for details on how to process webhook events.  It is probably a good idea to test the webhook by [sending it a `PING` event](#post_webhooks_webhookId_ping) after creating it. 
+
+### 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::WebhooksApi.new
+opts = {
+  create_webhook_request: UpBankingClient::CreateWebhookRequest.new({data: UpBankingClient::CreateWebhookRequestData.new({attributes: UpBankingClient::WebhookInputResourceAttributes.new({url: 'url_example'})})}) # CreateWebhookRequest | 
+}
+
+begin
+  # Create webhook
+  result = api_instance.webhooks_post(opts)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_post: #{e}"
+end
+```
+
+#### Using the webhooks_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWebhookResponse>, Integer, Hash)> webhooks_post_with_http_info(opts)
+
+```ruby
+begin
+  # Create webhook
+  data, status_code, headers = api_instance.webhooks_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWebhookResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateWebhookResponse**](CreateWebhookResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## webhooks_webhook_id_logs_get
+
+> <ListWebhookDeliveryLogsResponse> webhooks_webhook_id_logs_get(webhook_id, opts)
+
+List webhook logs
+
+Retrieve a list of delivery logs for a webhook by providing its unique identifier. This is useful for analysis and debugging purposes. The returned list is [paginated](#pagination) and can be scrolled by following the `next` and `prev` links where present. Results are ordered newest first to oldest last. Logs may be automatically purged after a period of time. 
+
+### 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::WebhooksApi.new
+webhook_id = '7104f5df-4993-495f-9d29-2b4d062c03a9' # String | The unique identifier for the webhook. 
+opts = {
+  page_size: 30 # Integer | The number of records to return in each page. 
+}
+
+begin
+  # List webhook logs
+  result = api_instance.webhooks_webhook_id_logs_get(webhook_id, opts)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_webhook_id_logs_get: #{e}"
+end
+```
+
+#### Using the webhooks_webhook_id_logs_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWebhookDeliveryLogsResponse>, Integer, Hash)> webhooks_webhook_id_logs_get_with_http_info(webhook_id, opts)
+
+```ruby
+begin
+  # List webhook logs
+  data, status_code, headers = api_instance.webhooks_webhook_id_logs_get_with_http_info(webhook_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWebhookDeliveryLogsResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_webhook_id_logs_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** | The unique identifier for the webhook.  |  |
+| **page_size** | **Integer** | The number of records to return in each page.  | [optional] |
+
+### Return type
+
+[**ListWebhookDeliveryLogsResponse**](ListWebhookDeliveryLogsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhooks_webhook_id_ping_post
+
+> <WebhookEventCallback> webhooks_webhook_id_ping_post(webhook_id)
+
+Ping webhook
+
+Send a `PING` event to a webhook by providing its unique identifier. This is useful for testing and debugging purposes. The event is delivered asynchronously and its data is returned in the response to this request. 
+
+### 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::WebhooksApi.new
+webhook_id = '830e127d-fb89-4400-92bb-f3f48289dcba' # String | The unique identifier for the webhook. 
+
+begin
+  # Ping webhook
+  result = api_instance.webhooks_webhook_id_ping_post(webhook_id)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_webhook_id_ping_post: #{e}"
+end
+```
+
+#### Using the webhooks_webhook_id_ping_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookEventCallback>, Integer, Hash)> webhooks_webhook_id_ping_post_with_http_info(webhook_id)
+
+```ruby
+begin
+  # Ping webhook
+  data, status_code, headers = api_instance.webhooks_webhook_id_ping_post_with_http_info(webhook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookEventCallback>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling WebhooksApi->webhooks_webhook_id_ping_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** | The unique identifier for the webhook.  |  |
+
+### Return type
+
+[**WebhookEventCallback**](WebhookEventCallback.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/up_banking/api/accounts_api.rb

@@ -0,0 +1,151 @@
+=begin
+#Up API
+
+#The Up API gives you programmatic access to your balances and transaction data. You can request past transactions or set up webhooks to receive real-time events when new transactions hit your account. It’s new, it’s exciting and it’s just the beginning. 
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.0
+
+=end
+
+require 'cgi'
+
+module UpBankingClient
+  class AccountsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List accounts
+    # Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the `prev` and `next` links where present. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size The number of records to return in each page. 
+    # @option opts [AccountTypeEnum] :filter_account_type The type of account for which to return records. This can be used to filter Savers from spending accounts. 
+    # @option opts [OwnershipTypeEnum] :filter_ownership_type The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts. 
+    # @return [ListAccountsResponse]
+    def accounts_get(opts = {})
+      data, _status_code, _headers = accounts_get_with_http_info(opts)
+      data
+    end
+
+    # List accounts
+    # Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the `prev` and `next` links where present. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size The number of records to return in each page. 
+    # @option opts [AccountTypeEnum] :filter_account_type The type of account for which to return records. This can be used to filter Savers from spending accounts. 
+    # @option opts [OwnershipTypeEnum] :filter_ownership_type The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts. 
+    # @return [Array<(ListAccountsResponse, Integer, Hash)>] ListAccountsResponse data, response status code and response headers
+    def accounts_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_get ...'
+      end
+      # resource path
+      local_var_path = '/accounts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'filter[accountType]'] = opts[:'filter_account_type'] if !opts[:'filter_account_type'].nil?
+      query_params[:'filter[ownershipType]'] = opts[:'filter_ownership_type'] if !opts[:'filter_ownership_type'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListAccountsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.accounts_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#accounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve account
+    # Retrieve a specific account by providing its unique identifier. 
+    # @param id [String] The unique identifier for the account. 
+    # @param [Hash] opts the optional parameters
+    # @return [GetAccountResponse]
+    def accounts_id_get(id, opts = {})
+      data, _status_code, _headers = accounts_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve account
+    # Retrieve a specific account by providing its unique identifier. 
+    # @param id [String] The unique identifier for the account. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetAccountResponse, Integer, Hash)>] GetAccountResponse data, response status code and response headers
+    def accounts_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.accounts_id_get"
+      end
+      # resource path
+      local_var_path = '/accounts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAccountResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.accounts_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#accounts_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end