Ruby Core

Verifiabl::Issuer

module

build_barcode_payload

method, singleton

def self.build_barcode_payload: (verifiabl_reference: String, encrypted_pii: binary) -> String

build_barcode_png

method, singleton

def self.build_barcode_png: (verifiabl_reference: String, encrypted_pii: binary, ?width: Integer, ?environment: Symbol | String, ?scan_base_url: String?, ?max_error_correction: Symbol | String, ?error_correction_level: Symbol | String, ?compression_level: Integer) -> Rendering::PngResult

build_barcode_svg

method, singleton

def self.build_barcode_svg: (verifiabl_reference: String, encrypted_pii: binary, ?width: Numeric, ?environment: Symbol | String, ?scan_base_url: String?, ?max_error_correction: Symbol | String, ?error_correction_level: Symbol | String) -> Rendering::SvgResult

build_scan_url

method, singleton

def self.build_scan_url: (verifiabl_reference: String, encrypted_pii: binary, ?environment: Symbol | String, ?scan_base_url: String?) -> String

encrypt_pii

method, singleton

def self.encrypt_pii: (String, binary) -> Crypto::EncryptedPii

format_australian_pii

method, singleton

def self.format_australian_pii: (australian_pii_fields) -> String

format_new_zealand_pii

method, singleton

def self.format_new_zealand_pii: (new_zealand_pii_fields) -> String

format_pii

method, singleton

def self.format_pii: (Hash[Symbol | String, String?]) -> String

generate_verifiabl_reference

method, singleton

def self.generate_verifiabl_reference: () -> String

prepare_australian_v2_payslip

method, singleton

def self.prepare_australian_v2_payslip: (pii: australian_pii_fields, payslip_non_pii: Hash[Symbol | String, untyped], issued_at: String | Time, key: binary, ?verifiabl_reference: String) -> PreparedV2Payslip

prepare_new_zealand_v2_payslip

method, singleton

def self.prepare_new_zealand_v2_payslip: (pii: new_zealand_pii_fields, payslip_non_pii: Hash[Symbol | String, untyped], issued_at: String | Time, key: binary, ?verifiabl_reference: String) -> PreparedV2Payslip

AUSTRALIAN_PAYSLIP_V2_SCHEMA

constant

AUSTRALIAN_PAYSLIP_V2_SCHEMA: String

NEW_ZEALAND_PAYSLIP_V2_SCHEMA

constant

NEW_ZEALAND_PAYSLIP_V2_SCHEMA: String

SUPPORTED_V2_CURRENCIES

constant

SUPPORTED_V2_CURRENCIES: Array[String]

VERSION

constant

VERSION: String

Verifiabl::Issuer::ApiError

class, inherits from Error

body

attribute, instance

attr_reader body: Hash[String, untyped]?

Returns the value of attribute body.

code

attribute, instance

attr_reader code: String

Returns the value of attribute code.

request_id

attribute, instance

attr_reader request_id: String?

Returns the value of attribute request_id.

status

attribute, instance

attr_reader status: Integer

Returns the value of attribute status.

Verifiabl::Issuer::AuthError

class, inherits from Error

status

attribute, instance

attr_reader status: Integer?

Returns the value of attribute status.

Verifiabl::Issuer::Client

class

initialize

method, instance

def initialize: (Configuration, ?transport: _Transport?) -> void

The optional transport is a supported integration seam for test doubles and custom HTTP adapters. Timing and retry dependencies remain internal.

Parameter: Configuration client credentials and request settings

Parameter: #call | nil adapter called with method:, url:, headers:, body:, and timeout:. It must return an object with status, headers, and body readers. The adapter owns its own I/O timeouts and connection cleanup; it is not asynchronously interrupted.

Returns: Client a new instance of Client

register_and_build_barcode

method, instance

def register_and_build_barcode: (encrypted_pii: binary, schema: String, issued_at: String | Time, payslip_non_pii: Hash[Symbol | String, untyped], encryption_metadata: Hash[Symbol | String, binary]) -> Responses::BarcodeRegistration

register_non_pii

method, instance

def register_non_pii: (?verifiabl_reference: String?, schema: String, issued_at: String | Time, payslip_non_pii: Hash[Symbol | String, untyped], encryption_metadata: Hash[Symbol | String, binary]) -> Responses::Registration

Registers non-PII data under a provider-generated reference. When the caller omits one, generate it once before the request loop so every automatic retry uses the same idempotency key. Callers that need to retry from another process or invocation should generate, persist, and pass the reference explicitly.

register_non_pii_batch

method, instance

def register_non_pii_batch: (Array[Hash[Symbol | String, untyped]]) -> Responses::BatchRegistration

Verifiabl::Issuer::Configuration

class

Immutable settings used to construct one Client. Applications own the resulting client and can place it in their normal dependency container.

client_id

attribute, instance

attr_reader client_id: String?

client_secret

attribute, instance

attr_reader client_secret: String?

environment

attribute, instance

attr_reader environment: Symbol

initialize

method, instance

def initialize: (?client_id: String?, ?client_secret: String?, ?environment: Symbol | String, ?issuer_base_url: String?, ?token_url: String?, ?timeout: Numeric, ?max_retries: Integer, ?on_request: Proc?, ?on_response: Proc?, ?on_error: Proc?) -> void

Raises: ArgumentError

issuer_base_url

attribute, instance

attr_reader issuer_base_url: String?

max_retries

attribute, instance

attr_reader max_retries: Integer

on_error

attribute, instance

attr_reader on_error: Proc?

on_request

attribute, instance

attr_reader on_request: Proc?

on_response

attribute, instance

attr_reader on_response: Proc?

timeout

attribute, instance

attr_reader timeout: Numeric

token_url

attribute, instance

attr_reader token_url: String?

Verifiabl::Issuer::Error

class, inherits from StandardError

Verifiabl::Issuer::IvReuseError

class, inherits from ApiError

Verifiabl::Issuer::PreparedV2Payslip

class

A single encryption and registration pair. Keep the reference and registration together for self-managed retries; the API-managed endpoint allocates its own.

api_managed_registration

method, instance

def api_managed_registration: () -> Hash[Symbol, untyped]

barcode_parts

method, instance

def barcode_parts: (String) -> Hash[Symbol, untyped]

registration

attribute, instance

attr_reader registration: Hash[Symbol, untyped]

A mutable, independent self-managed registration request.

verifiabl_reference

attribute, instance

attr_reader verifiabl_reference: String

Returns the value of attribute verifiabl_reference.

Verifiabl::Issuer::TimeoutError

class, inherits from TransportError

timeout

attribute, instance

attr_reader timeout: Numeric

Returns the value of attribute timeout.

Verifiabl::Issuer::TransportError

class, inherits from Error