imbarcode.core — democracyworks/imbarcode 1.0.2

Top-level encoding functionality for generating IMbarcodes.

barcode-id:default clj/s

encodable? clj/s

(encodable? structure-digits)

(encodable? barcode service customer-number routing)

(encodable? barcode service mailer serial-number routing)

Returns true if structure-digits (or the other breakdown arities) are encodable as an IMbarcode or false otherwise.

encode clj/s

(encode structure-digits)

(encode barcode service customer-number routing)

(encode barcode service mailer serial-number routing)

Generate the texual representation of an encoded USPS IMbarcode from the data provided. You can pass in the full numerical sequence if you have that available. For origin tracing, pass in a barcode id, service type id, customer number, and routing number. For destination tracing, pass in a barcode id, service type id, mailer id, serial number, and routing number.

The generated string will consist of the characters [ADFT]. See section 3.1.3 of the IMb spec for a detailed description of the parameters.

origin-service-types clj/s

The service type IDs that allow our system to classify an IMb as partner-bound (aka "origin tracing").

service-type-id:destination clj/s

service-type-id:origin clj/s

split-structure-digits clj/s

(split-structure-digits imb)

Split IMbarcode structure digits into their constituent parts