AnPostReturn

gem 'an_post_return'

AnPostReturn.configure do |config|
  # API Configuration (required)
  config.subscription_key = 'your_subscription_key'  # The Ocp-Apim-Subscription-Key for authentication

  # SFTP Configuration (required)
  config.sftp_config = {
    host: 'your_sftp_host',
    username: 'your_username',
    password: 'your_password',
    remote_path: '/path/to/remote/files'  # The remote directory where An Post places tracking files
  }

  # Optional proxy configuration (for An Post IP whitelisting)
  config.proxy_config = {
    host: 'proxy-host',
    port: 'proxy-port',
    user: 'proxy-user',     # Optional proxy authentication
    password: 'proxy-password'  # Optional proxy authentication
  }

  # Environment setting
  config.test = false # Set to true for sandbox environment
end

# Initialize a new return label request
client = AnPostReturn::Client.new
return_label = client.return_labels.create(
  output_response_type: "Label",
  sender: {
    first_name: "Jane",
    last_name: "Smith",
    contact_number: "0871234567",
    email_address: "test@email.com"
  },
  sender_address: {
    address_line1: "Exo Building",
    address_line2: "North Wall Quay",
    city: "Dublin 1",
    eircode: "D01 W5Y2",
    county: "Dublin",
    country: "Ireland",
    countrycode: "IE"
  },
  retailer_account_no: "your_account_number",
  retailer_return_reason: "Does not fit",
  retailer_order_number: "987654321"
)

# Access the response data
puts return_label.tracking_number  # The An Post tracking number for this shipment
puts return_label.label_data      # The label data (usually a PDF bitstream)

tracker = AnPostReturn::Tracker.new

# Track by account number (gets all files)
# This will retrieve all tracking files for the given account number
tracker.track_with_account_number("3795540") do |file, data|
  puts "Processing file: #{file}"
  puts "Tracking data: #{data}"
end

# Track by account number (get last N files)
# Useful when you only want recent tracking updates
tracker.track_with_account_number("3795540", last: 2) do |file, data|
  puts "Processing file: #{file}"
  puts "Tracking data: #{data}"
end

# Track from a specific file onwards, by incrementing file name by 1 until no file is found
# Useful for resuming tracking from a known point
tracker.track_from("cdt0370132115864.txt") do |file, data|
  puts "Processing file: #{file}"
  puts "Tracking data: #{data}"
end

# The tracker will reuse the same sftp connection within the tracker instance
# Remember to call the disconnect function to prevent the sftp connection stays idle in the memory
tracker.disconnect