Module: Postmen::Types

Defined in:: lib/postmen/types.rb,
lib/postmen/types/aes.rb,
lib/postmen/types/file.rb,
lib/postmen/types/item.rb,
lib/postmen/types/uuid.rb,
lib/postmen/types/money.rb,
lib/postmen/types/no_eei.rb,
lib/postmen/types/weight.rb,
lib/postmen/types/address.rb,
lib/postmen/types/billing.rb,
lib/postmen/types/customs.rb,
lib/postmen/types/invoice.rb,
lib/postmen/types/passport.rb,
lib/postmen/types/dimension.rb,
lib/postmen/types/reference.rb,
lib/postmen/types/payment_method.rb,
lib/postmen/types/customs_billing.rb,
lib/postmen/types/detailed_charges.rb,
lib/postmen/types/manifesting_label.rb,
lib/postmen/types/brief_shipper_account.rb

Overview

This module holds all definitions of simple types used in the API

Classes: AES, Address, Billing, BriefShipperAccount, Customs, CustomsBilling, DetailedCharges, Dimension, File, Invoice, Item, ManifestingLabel, Money, NoEEI, Passport, PaymentMethod, Reference, Weight

RateStatuses = Possible statuses for Rates.

Types::String.enum(
  'calculating',
  'calculated',
  'failed'
)

LabelStatuses = Possible statuses for Labels.

Types::String.enum(
  'creating',
  'created',
  'cancelling',
  'cancelled',
  'manifesting',
  'manifested',
  'failed'
)

ManifestStatuses = Possible statuses for Manifest

Types::String.enum(
  'manifesting',
  'manifested',
  'failed'
)

AddressType = Type of the address See Also: Address

Types::String.enum(
  'business',
  'residential'
)

ShipperAccountStatus = List of possible Shipper Account Statuses

Types::String.enum(
  'enabled',
  'disabled',
  'deleted'
)

ShipperAccountTypes = List of possible Shipper Account Types

Types::String.enum(
  'default',
  'user',
  'user_prepaid'
)

Timezone = Timezone (use IANA name)

Types::String

Country = Name of the country

Types::String

PaperSize = Paper size

Types::String.enum(PAPER_SIZES)

CustomsPurpose = Purpose used in customs object See Also: API Documentation

Types::String.enum(
  'gift',
  'merchandise',
  'sample',
  'return',
  'repair'
)

PaidBy = Paid by, used in customs billing. See Also: CustomsBilling API Documentation

Types::String.enum(
  'shipper',
  'recipient',
  'third_party'
)

TermsOfTrade = Terms of trade - used in customs object See Also: Customs API Documentation

Types::String.enum(
  'dat',
  'ddu',
  'ddp',
  'dap'
)

FtrExemption = FTR Exemption - used in NoEEI object See Also: NoEEI API Documentation

Types::String.enum(
  'noeei_30_37_a',
  'noeei_30_37_h',
  'noeei_30_36'
)

WeightUnit = Unit of weight - used in Weight object See Also: Weight

Types::String.enum(
  'lb',
  'kg',
  'oz',
  'g'
)

DimensionUnit = Unit for dimension - used in Dimension object See Also: Dimension

Types::String.enum(
  'cm',
  'in',
  'mm',
  'm',
  'ft',
  'yd'
)

UUID = UUID Type See Also: Definition

Types::Strict::String.constrained(
  format: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i
)