checkify 0.1.0

data/docs/SanctionsResult.md

@@ -0,0 +1,42 @@
+# Checkify::SanctionsResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | **String** | Source sanctions list | [optional] |
+| **reference** | **String** | Source-specific reference number | [optional] |
+| **name** | **String** | Primary name of the sanctioned individual or entity | [optional] |
+| **type** | **String** |  | [optional] |
+| **aliases** | **Array<String>** |  | [optional] |
+| **confidence** | **Float** | Confidence score — higher when birth details match | [optional] |
+| **sanctions** | [**SanctionsResultSanctions**](SanctionsResultSanctions.md) |  | [optional] |
+| **date_of_birth** | **String** |  | [optional] |
+| **place_of_birth** | **String** |  | [optional] |
+| **citizenship** | **String** |  | [optional] |
+| **committees** | **String** |  | [optional] |
+| **listing_information** | **String** |  | [optional] |
+| **source_updated_at** | **String** | Date of last source list update | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::SanctionsResult.new(
+  source: null,
+  reference: null,
+  name: null,
+  type: null,
+  aliases: null,
+  confidence: null,
+  sanctions: null,
+  date_of_birth: null,
+  place_of_birth: null,
+  citizenship: null,
+  committees: null,
+  listing_information: null,
+  source_updated_at: null
+)
+```
+

data/docs/SanctionsResultSanctions.md

@@ -0,0 +1,24 @@
+# Checkify::SanctionsResultSanctions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **targeted_financial_sanction** | **Boolean** |  | [optional] |
+| **travel_ban** | **Boolean** |  | [optional] |
+| **arms_embargo** | **Boolean** |  | [optional] |
+| **maritime_restriction** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::SanctionsResultSanctions.new(
+  targeted_financial_sanction: null,
+  travel_ban: null,
+  arms_embargo: null,
+  maritime_restriction: null
+)
+```
+

data/docs/SuburbDetails.md

@@ -0,0 +1,30 @@
+# Checkify::SuburbDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** |  | [optional] |
+| **postcode** | **String** | 4-digit postcode (null for NZ) | [optional] |
+| **state** | **String** | State abbreviation — AU only | [optional] |
+| **state_full** | **String** | Full state name — AU only | [optional] |
+| **region** | **String** | Region/city — NZ only | [optional] |
+| **country** | **String** |  | [optional] |
+| **country_full** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::SuburbDetails.new(
+  city: null,
+  postcode: null,
+  state: null,
+  state_full: null,
+  region: null,
+  country: null,
+  country_full: null
+)
+```
+

data/docs/TfnResponse.md

@@ -0,0 +1,24 @@
+# Checkify::TfnResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tfn** | **String** | Normalised digits only | [optional] |
+| **tfn_formatted** | **String** | Grouped with spaces | [optional] |
+| **valid** | **Boolean** |  | [optional] |
+| **notice** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::TfnResponse.new(
+  tfn: null,
+  tfn_formatted: null,
+  valid: null,
+  notice: null
+)
+```
+

data/lib/checkify/api/account_api.rb

@@ -0,0 +1,79 @@
+=begin
+#Checkify API
+
+#Australian and New Zealand address validation, business lookups, identity checks, and communication validation through a single REST interface.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'cgi'
+
+module Checkify
+  class AccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get account details
+    # Returns your current plan, unit usage, billing period, subscription status, and a per-endpoint breakdown of API calls for the current period. Costs 0 units. Usage breakdown is cached for 5 minutes. 
+    # @param [Hash] opts the optional parameters
+    # @return [Account]
+    def get_account(opts = {})
+      data, _status_code, _headers = get_account_with_http_info(opts)
+      data
+    end
+
+    # Get account details
+    # Returns your current plan, unit usage, billing period, subscription status, and a per-endpoint breakdown of API calls for the current period. Costs 0 units. Usage breakdown is cached for 5 minutes. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
+    def get_account_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_account ...'
+      end
+      # resource path
+      local_var_path = '/account'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Account'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_account",
+        :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: AccountApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end