@namespace("Switchboard")

protocol Offer {

  record Package {
      /** The primary key */
      int id;
      string name;
      string short_description;
      boolean call;
      int call_duration_in_minutes;
      boolean document;
      int max_document_length_in_pages;
      boolean claim_game;
      boolean offline;
      int specialty_id;
      string micro_description;
   }

  /** The main class for this protocol */
  record Offer {
    /** The primary key */
    int id;
    int state_id;
    int consumer_fee_in_cents;
    Package package;
  }

  record OfferFetchOption {
    /** Which page of records to fetch */
    int page = 1;

    /** How many records per page */
    int per_page = 10;

    /** The ID of the package this offer is associated with. */
    int package_id;

    /** Enabled meaning it is available for the public to purchase. */
    boolean enabled;

    /** The name of the package this offer is associated with. */
    string name;
  }

  /** Returns a list of Offers */
  array<Offer> index(OfferFetchOption options);

  /** Return a single Offer */
  array<Offer> show(int id);
}