checkify 0.1.0

data/docs/CommunicationApi.md

@@ -0,0 +1,151 @@
+# Checkify::CommunicationApi
+
+All URIs are relative to *https://checkify.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**email_validation**](CommunicationApi.md#email_validation) | **GET** /email | Email validation |
+| [**phone_validation**](CommunicationApi.md#phone_validation) | **GET** /phone | Phone validation |
+
+
+## email_validation
+
+> <EmailResponse> email_validation(email)
+
+Email validation
+
+Validate an email address — checks RFC format, DNS/MX records, SMTP deliverability, disposable/free/role detection, and quality score. Costs 1 unit. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkify'
+# setup authorization
+Checkify.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Checkify::CommunicationApi.new
+email = 'email_example' # String | Email address to validate (max 254 characters)
+
+begin
+  # Email validation
+  result = api_instance.email_validation(email)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling CommunicationApi->email_validation: #{e}"
+end
+```
+
+#### Using the email_validation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailResponse>, Integer, Hash)> email_validation_with_http_info(email)
+
+```ruby
+begin
+  # Email validation
+  data, status_code, headers = api_instance.email_validation_with_http_info(email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling CommunicationApi->email_validation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address to validate (max 254 characters) |  |
+
+### Return type
+
+[**EmailResponse**](EmailResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## phone_validation
+
+> <PhoneResponse> phone_validation(phone, opts)
+
+Phone validation
+
+Validate and normalise a phone number. Detects country, returns E.164 / national / international formats, line type, carrier, and location. Defaults to AU parsing. Costs 1 unit. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkify'
+# setup authorization
+Checkify.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Checkify::CommunicationApi.new
+phone = 'phone_example' # String | Phone number to validate — include country code or use the country hint
+opts = {
+  country: 'country_example' # String | ISO 3166-1 alpha-2 country code hint for local numbers (default AU)
+}
+
+begin
+  # Phone validation
+  result = api_instance.phone_validation(phone, opts)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling CommunicationApi->phone_validation: #{e}"
+end
+```
+
+#### Using the phone_validation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneResponse>, Integer, Hash)> phone_validation_with_http_info(phone, opts)
+
+```ruby
+begin
+  # Phone validation
+  data, status_code, headers = api_instance.phone_validation_with_http_info(phone, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling CommunicationApi->phone_validation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** | Phone number to validate — include country code or use the country hint |  |
+| **country** | **String** | ISO 3166-1 alpha-2 country code hint for local numbers (default AU) | [optional][default to &#39;AU&#39;] |
+
+### Return type
+
+[**PhoneResponse**](PhoneResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DirectorIdResponse.md

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

data/docs/EmailResponse.md

@@ -0,0 +1,42 @@
+# Checkify::EmailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Normalised (lowercased) email address | [optional] |
+| **valid** | **Boolean** | true only if both format and DNS checks pass | [optional] |
+| **format** | [**EmailResponseFormat**](EmailResponseFormat.md) |  | [optional] |
+| **dns** | [**EmailResponseDns**](EmailResponseDns.md) |  | [optional] |
+| **deliverable** | **Boolean** |  | [optional] |
+| **can_connect_smtp** | **Boolean** |  | [optional] |
+| **inbox_full** | **Boolean** |  | [optional] |
+| **disabled** | **Boolean** |  | [optional] |
+| **catch_all** | **Boolean** |  | [optional] |
+| **score** | **Float** | Quality score — higher is better | [optional] |
+| **free** | **Boolean** | Whether the email uses a free provider | [optional] |
+| **disposable** | **Boolean** | Whether the email uses a disposable/temporary provider | [optional] |
+| **role** | **Boolean** | Whether this is a role-based address (e.g. support@, info@) | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::EmailResponse.new(
+  email: null,
+  valid: null,
+  format: null,
+  dns: null,
+  deliverable: null,
+  can_connect_smtp: null,
+  inbox_full: null,
+  disabled: null,
+  catch_all: null,
+  score: null,
+  free: null,
+  disposable: null,
+  role: null
+)
+```
+

data/docs/EmailResponseDns.md

@@ -0,0 +1,18 @@
+# Checkify::EmailResponseDns
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | Domain has valid MX or A records | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::EmailResponseDns.new(
+  valid: null
+)
+```
+

data/docs/EmailResponseFormat.md

@@ -0,0 +1,22 @@
+# Checkify::EmailResponseFormat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** |  | [optional] |
+| **account** | **String** | Local part (before @) | [optional] |
+| **domain** | **String** | Domain part (after @) | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::EmailResponseFormat.new(
+  valid: null,
+  account: null,
+  domain: null
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,22 @@
+# Checkify::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **errors** | **Hash<String, Array<String>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::Error.new(
+  error: null,
+  message: null,
+  errors: null
+)
+```
+

data/docs/FormerName.md

@@ -0,0 +1,22 @@
+# Checkify::FormerName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **active_from** | **Date** |  | [optional] |
+| **active_to** | **Date** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::FormerName.new(
+  name: null,
+  active_from: null,
+  active_to: null
+)
+```
+

data/docs/IdentityApi.md

@@ -0,0 +1,225 @@
+# Checkify::IdentityApi
+
+All URIs are relative to *https://checkify.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**director_id_validation**](IdentityApi.md#director_id_validation) | **GET** /director-id | Director ID validation |
+| [**sanctions_screening**](IdentityApi.md#sanctions_screening) | **GET** /sanctions-screening | Sanctions screening |
+| [**tfn_validation**](IdentityApi.md#tfn_validation) | **GET** /tfn | TFN validation |
+
+
+## director_id_validation
+
+> <DirectorIdResponse> director_id_validation(director_id)
+
+Director ID validation
+
+Validate the format and checksum of an Australian Director Identification Number using the official ABRS Damm algorithm. Structural check only — no live ABRS registry lookup. Costs 1 unit. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkify'
+# setup authorization
+Checkify.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Checkify::IdentityApi.new
+director_id = 'director_id_example' # String | 15-digit Director ID starting with 036 — spaces accepted
+
+begin
+  # Director ID validation
+  result = api_instance.director_id_validation(director_id)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling IdentityApi->director_id_validation: #{e}"
+end
+```
+
+#### Using the director_id_validation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DirectorIdResponse>, Integer, Hash)> director_id_validation_with_http_info(director_id)
+
+```ruby
+begin
+  # Director ID validation
+  data, status_code, headers = api_instance.director_id_validation_with_http_info(director_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DirectorIdResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling IdentityApi->director_id_validation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **director_id** | **String** | 15-digit Director ID starting with 036 — spaces accepted |  |
+
+### Return type
+
+[**DirectorIdResponse**](DirectorIdResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sanctions_screening
+
+> <SanctionsResponse> sanctions_screening(name, opts)
+
+Sanctions screening
+
+Screen an individual or entity name against 11 sanctions and debarment lists including DFAT, UN, OFAC SDN, EU, UK OFSI, Canada, New Zealand, France, Hong Kong, World Bank, and IDB. Costs 3 units. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkify'
+# setup authorization
+Checkify.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Checkify::IdentityApi.new
+name = 'name_example' # String | Full name to screen (3–200 characters)
+opts = {
+  birth_year: 56, # Integer | Year of birth (1900–2008) — boosts confidence if matched
+  country: 'country_example', # String | ISO 3166-1 alpha-2 country code — boosts confidence if matched
+  city: 'city_example' # String | City of birth (max 200 characters) — fuzzy-compared for confidence boost
+}
+
+begin
+  # Sanctions screening
+  result = api_instance.sanctions_screening(name, opts)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling IdentityApi->sanctions_screening: #{e}"
+end
+```
+
+#### Using the sanctions_screening_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SanctionsResponse>, Integer, Hash)> sanctions_screening_with_http_info(name, opts)
+
+```ruby
+begin
+  # Sanctions screening
+  data, status_code, headers = api_instance.sanctions_screening_with_http_info(name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SanctionsResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling IdentityApi->sanctions_screening_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Full name to screen (3–200 characters) |  |
+| **birth_year** | **Integer** | Year of birth (1900–2008) — boosts confidence if matched | [optional] |
+| **country** | **String** | ISO 3166-1 alpha-2 country code — boosts confidence if matched | [optional] |
+| **city** | **String** | City of birth (max 200 characters) — fuzzy-compared for confidence boost | [optional] |
+
+### Return type
+
+[**SanctionsResponse**](SanctionsResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tfn_validation
+
+> <TfnResponse> tfn_validation(tfn)
+
+TFN validation
+
+Validate the format and checksum of an Australian Tax File Number. Structural check only — no live ATO registry lookup. Costs 1 unit. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkify'
+# setup authorization
+Checkify.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Checkify::IdentityApi.new
+tfn = 'tfn_example' # String | 8 or 9-digit TFN — spaces and hyphens accepted
+
+begin
+  # TFN validation
+  result = api_instance.tfn_validation(tfn)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling IdentityApi->tfn_validation: #{e}"
+end
+```
+
+#### Using the tfn_validation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TfnResponse>, Integer, Hash)> tfn_validation_with_http_info(tfn)
+
+```ruby
+begin
+  # TFN validation
+  data, status_code, headers = api_instance.tfn_validation_with_http_info(tfn)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TfnResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling IdentityApi->tfn_validation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tfn** | **String** | 8 or 9-digit TFN — spaces and hyphens accepted |  |
+
+### Return type
+
+[**TfnResponse**](TfnResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/NameAvailability.md

@@ -0,0 +1,26 @@
+# Checkify::NameAvailability
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Normalised (uppercased) name | [optional] |
+| **availability** | **String** | Availability status (e.g. Available) | [optional] |
+| **short_description** | **String** |  | [optional] |
+| **objections** | **Array<String>** |  | [optional] |
+| **existing_business_name** | **Boolean** | Whether the name already exists as a registered business name | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::NameAvailability.new(
+  name: null,
+  availability: null,
+  short_description: null,
+  objections: null,
+  existing_business_name: null
+)
+```
+

data/docs/PhoneResponse.md

@@ -0,0 +1,32 @@
+# Checkify::PhoneResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** | E.164 format | [optional] |
+| **phone_national** | **String** | National format as dialled locally | [optional] |
+| **phone_international** | **String** | International format with country code | [optional] |
+| **valid** | **Boolean** |  | [optional] |
+| **country** | **String** | Detected ISO 3166-1 alpha-2 country code | [optional] |
+| **type** | **String** | Line type: mobile, fixed-line, toll-free, voip, etc. | [optional] |
+| **carrier** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::PhoneResponse.new(
+  phone: null,
+  phone_national: null,
+  phone_international: null,
+  valid: null,
+  country: null,
+  type: null,
+  carrier: null,
+  location: null
+)
+```
+

data/docs/PostcodeResult.md

@@ -0,0 +1,30 @@
+# Checkify::PostcodeResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **locality_id** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **postcode** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **state_full** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **country_full** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::PostcodeResult.new(
+  locality_id: null,
+  city: null,
+  postcode: null,
+  state: null,
+  state_full: null,
+  country: null,
+  country_full: null
+)
+```
+

data/docs/ReverseResult.md

@@ -0,0 +1,38 @@
+# Checkify::ReverseResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_id** | **String** |  | [optional] |
+| **address_full** | **String** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **street_number** | **String** |  | [optional] |
+| **street** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **postcode** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **latitude** | **Float** |  | [optional] |
+| **longitude** | **Float** |  | [optional] |
+| **distance_metres** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::ReverseResult.new(
+  address_id: null,
+  address_full: null,
+  unit: null,
+  street_number: null,
+  street: null,
+  city: null,
+  postcode: null,
+  state: null,
+  latitude: null,
+  longitude: null,
+  distance_metres: null
+)
+```
+

data/docs/SanctionsResponse.md

@@ -0,0 +1,20 @@
+# Checkify::SanctionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match** | **Boolean** | true if any results meet the confidence threshold | [optional] |
+| **results** | [**Array<SanctionsResult>**](SanctionsResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::SanctionsResponse.new(
+  match: null,
+  results: null
+)
+```
+