checkify 0.1.0

data/docs/BatchApi.md

@@ -0,0 +1,217 @@
+# Checkify::BatchApi
+
+All URIs are relative to *https://checkify.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_bulk_job**](BatchApi.md#create_bulk_job) | **POST** /bulk | Create bulk job |
+| [**download_bulk_results**](BatchApi.md#download_bulk_results) | **GET** /bulk/{id}/download | Download bulk results |
+| [**get_bulk_job**](BatchApi.md#get_bulk_job) | **GET** /bulk/{id} | Get bulk job status |
+
+
+## create_bulk_job
+
+> <BulkJob> create_bulk_job(bulk_create_request)
+
+Create bulk job
+
+Submit a batch of records for asynchronous processing. Supports ABN, ACN, TFN, Director ID, Email, Phone, Reverse Geocode, Address Validation, and Sanctions Screening. Each row consumes the same units as a single API call. Business & Enterprise plans only. 
+
+### 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::BatchApi.new
+bulk_create_request = Checkify::BulkCreateRequest.new({endpoint: 'address-validation', items: nil}) # BulkCreateRequest | 
+
+begin
+  # Create bulk job
+  result = api_instance.create_bulk_job(bulk_create_request)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BatchApi->create_bulk_job: #{e}"
+end
+```
+
+#### Using the create_bulk_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkJob>, Integer, Hash)> create_bulk_job_with_http_info(bulk_create_request)
+
+```ruby
+begin
+  # Create bulk job
+  data, status_code, headers = api_instance.create_bulk_job_with_http_info(bulk_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkJob>
+rescue Checkify::ApiError => e
+  puts "Error when calling BatchApi->create_bulk_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_create_request** | [**BulkCreateRequest**](BulkCreateRequest.md) |  |  |
+
+### Return type
+
+[**BulkJob**](BulkJob.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## download_bulk_results
+
+> File download_bulk_results(id)
+
+Download bulk results
+
+Download the completed bulk job results as CSV.
+
+### 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::BatchApi.new
+id = 56 # Integer | 
+
+begin
+  # Download bulk results
+  result = api_instance.download_bulk_results(id)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BatchApi->download_bulk_results: #{e}"
+end
+```
+
+#### Using the download_bulk_results_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> download_bulk_results_with_http_info(id)
+
+```ruby
+begin
+  # Download bulk results
+  data, status_code, headers = api_instance.download_bulk_results_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Checkify::ApiError => e
+  puts "Error when calling BatchApi->download_bulk_results_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## get_bulk_job
+
+> <BulkJob> get_bulk_job(id)
+
+Get bulk job status
+
+Check the status of a bulk processing job.
+
+### 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::BatchApi.new
+id = 56 # Integer | 
+
+begin
+  # Get bulk job status
+  result = api_instance.get_bulk_job(id)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BatchApi->get_bulk_job: #{e}"
+end
+```
+
+#### Using the get_bulk_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkJob>, Integer, Hash)> get_bulk_job_with_http_info(id)
+
+```ruby
+begin
+  # Get bulk job status
+  data, status_code, headers = api_instance.get_bulk_job_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkJob>
+rescue Checkify::ApiError => e
+  puts "Error when calling BatchApi->get_bulk_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**BulkJob**](BulkJob.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BulkCreateRequest.md

@@ -0,0 +1,20 @@
+# Checkify::BulkCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint** | **String** | Endpoint slug to process |  |
+| **items** | [**BulkCreateRequestItems**](BulkCreateRequestItems.md) |  |  |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::BulkCreateRequest.new(
+  endpoint: null,
+  items: null
+)
+```
+

data/docs/BulkCreateRequestItems.md

@@ -0,0 +1,49 @@
+# Checkify::BulkCreateRequestItems
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'checkify'
+
+Checkify::BulkCreateRequestItems.openapi_one_of
+# =>
+# [
+#   :'Array<Object>',
+#   :'Array<String>'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'checkify'
+
+Checkify::BulkCreateRequestItems.build(data)
+# => #<Array<Object>:0x00007fdd4aab02a0>
+
+Checkify::BulkCreateRequestItems.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<Object>`
+- `Array<String>`
+- `nil` (if no type matches)
+

data/docs/BulkJob.md

@@ -0,0 +1,26 @@
+# Checkify::BulkJob
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **endpoint** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **total_rows** | **Integer** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::BulkJob.new(
+  id: null,
+  endpoint: null,
+  status: null,
+  total_rows: null,
+  created_at: null
+)
+```
+

data/docs/BusinessActivity.md

@@ -0,0 +1,22 @@
+# Checkify::BusinessActivity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Unique activity identifier | [optional] |
+| **industry_code** | **String** | ANZSIC industry classification code | [optional] |
+| **full_name** | **String** | Business activity description | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::BusinessActivity.new(
+  code: null,
+  industry_code: null,
+  full_name: null
+)
+```
+

data/docs/BusinessActivityResponse.md

@@ -0,0 +1,22 @@
+# Checkify::BusinessActivityResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **activities** | [**Array<BusinessActivity>**](BusinessActivity.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'checkify'
+
+instance = Checkify::BusinessActivityResponse.new(
+  status: null,
+  count: null,
+  activities: null
+)
+```
+

data/docs/BusinessApi.md

@@ -0,0 +1,361 @@
+# Checkify::BusinessApi
+
+All URIs are relative to *https://checkify.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**abn_lookup**](BusinessApi.md#abn_lookup) | **GET** /abn | ABN lookup |
+| [**acn_lookup**](BusinessApi.md#acn_lookup) | **GET** /acn | ACN lookup |
+| [**business_activity**](BusinessApi.md#business_activity) | **GET** /business-activity | Business activity search |
+| [**business_name_check**](BusinessApi.md#business_name_check) | **GET** /business-name | Business name availability |
+| [**company_name_check**](BusinessApi.md#company_name_check) | **GET** /company-name | Company name availability |
+
+
+## abn_lookup
+
+> <AbnResponse> abn_lookup(abn)
+
+ABN lookup
+
+Validate an Australian Business Number and retrieve registered business details from the ABR. 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::BusinessApi.new
+abn = 'abn_example' # String | 11-digit ABN — spaces accepted
+
+begin
+  # ABN lookup
+  result = api_instance.abn_lookup(abn)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->abn_lookup: #{e}"
+end
+```
+
+#### Using the abn_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AbnResponse>, Integer, Hash)> abn_lookup_with_http_info(abn)
+
+```ruby
+begin
+  # ABN lookup
+  data, status_code, headers = api_instance.abn_lookup_with_http_info(abn)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AbnResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->abn_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abn** | **String** | 11-digit ABN — spaces accepted |  |
+
+### Return type
+
+[**AbnResponse**](AbnResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## acn_lookup
+
+> <AcnResponse> acn_lookup(acn)
+
+ACN lookup
+
+Validate an Australian Company Number and retrieve registered company details from ASIC, including entity name, type, registration dates, addresses, former names, and recent documents. 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::BusinessApi.new
+acn = 'acn_example' # String | 9-digit ACN — spaces accepted
+
+begin
+  # ACN lookup
+  result = api_instance.acn_lookup(acn)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->acn_lookup: #{e}"
+end
+```
+
+#### Using the acn_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AcnResponse>, Integer, Hash)> acn_lookup_with_http_info(acn)
+
+```ruby
+begin
+  # ACN lookup
+  data, status_code, headers = api_instance.acn_lookup_with_http_info(acn)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AcnResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->acn_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acn** | **String** | 9-digit ACN — spaces accepted |  |
+
+### Return type
+
+[**AcnResponse**](AcnResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## business_activity
+
+> <BusinessActivityResponse> business_activity(search, opts)
+
+Business activity search
+
+Search over 9,000 Australian business activities and industry classifications (ANZSIC codes) with fuzzy matching, misspelling correction, and relevance scoring. Costs 0 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::BusinessApi.new
+search = 'search_example' # String | Search query, min 3 characters
+opts = {
+  limit: 56 # Integer | Max results (1–100, default 25)
+}
+
+begin
+  # Business activity search
+  result = api_instance.business_activity(search, opts)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->business_activity: #{e}"
+end
+```
+
+#### Using the business_activity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BusinessActivityResponse>, Integer, Hash)> business_activity_with_http_info(search, opts)
+
+```ruby
+begin
+  # Business activity search
+  data, status_code, headers = api_instance.business_activity_with_http_info(search, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BusinessActivityResponse>
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->business_activity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search** | **String** | Search query, min 3 characters |  |
+| **limit** | **Integer** | Max results (1–100, default 25) | [optional][default to 25] |
+
+### Return type
+
+[**BusinessActivityResponse**](BusinessActivityResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## business_name_check
+
+> <NameAvailability> business_name_check(name)
+
+Business name availability
+
+Check whether a proposed business (trading) name is available for registration with ASIC. 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::BusinessApi.new
+name = 'name_example' # String | Proposed business name (max 200 characters)
+
+begin
+  # Business name availability
+  result = api_instance.business_name_check(name)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->business_name_check: #{e}"
+end
+```
+
+#### Using the business_name_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NameAvailability>, Integer, Hash)> business_name_check_with_http_info(name)
+
+```ruby
+begin
+  # Business name availability
+  data, status_code, headers = api_instance.business_name_check_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NameAvailability>
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->business_name_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Proposed business name (max 200 characters) |  |
+
+### Return type
+
+[**NameAvailability**](NameAvailability.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## company_name_check
+
+> <NameAvailability> company_name_check(name)
+
+Company name availability
+
+Check whether a proposed company name is available for registration with ASIC. 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::BusinessApi.new
+name = 'name_example' # String | Proposed company name (max 200 characters)
+
+begin
+  # Company name availability
+  result = api_instance.company_name_check(name)
+  p result
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->company_name_check: #{e}"
+end
+```
+
+#### Using the company_name_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NameAvailability>, Integer, Hash)> company_name_check_with_http_info(name)
+
+```ruby
+begin
+  # Company name availability
+  data, status_code, headers = api_instance.company_name_check_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NameAvailability>
+rescue Checkify::ApiError => e
+  puts "Error when calling BusinessApi->company_name_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Proposed company name (max 200 characters) |  |
+
+### Return type
+
+[**NameAvailability**](NameAvailability.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+