switchboard-contract 1.9.5

data/contracts/3/source/advice_session.avdl

@@ -0,0 +1,72 @@
+@namespace("Switchboard")
+
+protocol AdviceSession {
+  /** The main class for this protocol */
+  record AdviceSession {
+    /** The primary key */
+    int id;
+    int specialty_id;
+    int advisor_id;
+    int review_id;
+    boolean chose_advisor;
+
+    string state;
+    boolean called;
+    union {null, string} advice_session_image_token = null;
+    array<string> advice_session_image_tokens;
+
+    string name;
+    string email_address;
+    string phone_number;
+    int payment_amount;
+    string promo_code;
+    int offer_id;
+    int location_id;
+    int lawyer_id;
+    int package_id;
+    string package_name;
+  }
+
+  /** Options you can send for limiting AdviceSession results */
+  record AdviceSessionFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 30;
+  }
+
+  /** Params to create a new AdviceSession */
+  record AdviceSessionCreateParams {
+    int specialty_id;
+    int advisor_id;
+
+    string state;
+    string client_name;
+    string client_email_address;
+    string client_phone_number;
+    union {null, string} payment_gateway = null;
+    string card_href;
+    string name_on_card;
+    union {null, string} advice_session_image_token = null;
+    array<string> advice_session_image_tokens;
+    union {null, string} promo_code = null;
+  }
+
+  record AdviceSessionPromoCode {
+    int promo_discount_amount_in_cents;
+    int promo_advice_session_price_in_cents;
+  }
+
+  /** Returns a list of AdviceSession */
+  array<AdviceSession> index(AdviceSessionFetchOption options);
+
+  /** Return a single AdviceSession */
+  array<AdviceSession> show(int id);
+
+  /** Create a new AdviceSession */
+  array<AdviceSession> create(AdviceSessionCreateParams advice_session);
+
+  /** Apply an Advice Session Promo Code */
+  array<AdviceSessionPromoCode> find_promo_code(string promo_code);
+}

data/contracts/3/source/advice_session_image.avdl

@@ -0,0 +1,16 @@
+@namespace("Switchboard")
+
+protocol AdviceSessionImage {
+  /** The main class for this protocol */
+  record AdviceSessionImage {
+    string token;
+  }
+
+  record AdviceSessionImageCreateParams {
+    string data;
+    string content_type;
+  }
+
+  /** Create a new AdviceSessionImage */
+  array<AdviceSessionImage> create(AdviceSessionImageCreateParams advice_session_image);
+}

data/contracts/3/source/advice_session_review.avdl

@@ -0,0 +1,40 @@
+@namespace("Switchboard")
+
+protocol AdviceSessionReview {
+  /** The main class for this protocol */
+  record AdviceSessionReview {
+    /** The primary key */
+    int id;
+    int advice_session_id;
+
+    int rating;
+    string body;
+    int approval_status_id;
+  }
+
+  /** Params to create a new Review */
+  record AdviceSessionReviewCreateParams {
+    int advice_session_id;
+
+    int rating;
+    string body;
+  }
+
+  /** Return a single Review */
+  array<AdviceSessionReview> show(int id);
+
+  /** Create a new Review */
+  array<AdviceSessionReview> create(AdviceSessionReviewCreateParams advice_session_review);
+
+  /** Options you can send for limiting Review results */
+  record AdviceSessionReviewFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 20;
+  }
+
+  /** Returns a list of Review */
+  array<AdviceSessionReview> index(AdviceSessionReviewFetchOption options);
+}

data/contracts/3/source/advisor.avdl

@@ -0,0 +1,30 @@
+@namespace("Switchboard")
+
+protocol Advisor {
+  /** The main class for this protocol */
+  record Advisor {
+    /** The primary key */
+    int id;
+    int lawyer_id;
+
+    array<int> specialty_ids;
+    array<string> states;
+    boolean available;
+    array<int> offer_ids;
+  }
+
+  /** Options you can send for limiting Advisor results */
+  record AdvisorFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 30;
+  }
+
+  /** Returns a list of Advisor */
+  array<Advisor> index(AdvisorFetchOption options);
+
+  /** Return a single Advisor */
+  array<Advisor> show(int id);
+}

data/contracts/3/source/advisor_config.avdl

@@ -0,0 +1,17 @@
+@namespace("Switchboard")
+
+protocol AdvisorConfig {
+  /** The main class for this protocol */
+  record AdvisorConfig {
+    array<string> enabled_states;
+
+    array<int> enabled_specialty_ids;
+
+    int default_advice_session_price_in_cents;
+
+    union {null, string} payment_gateway;
+  }
+
+  /** Return the Config */
+  array<AdvisorConfig> index();
+}

data/contracts/3/source/common.inc

@@ -0,0 +1,20 @@
+@namespace("Switchboard")
+
+protocol Common {
+
+  /** The main User class */
+  record User {
+    /** The primary key */
+    int id;
+
+    /** Their name */
+    string name;
+
+    /** The email address of the user */
+    string email_address;
+
+    /** An array of the names of all permissions the user has */
+    array<string> permissions;
+  }
+
+}

data/contracts/3/source/lawyer.avdl

@@ -0,0 +1,45 @@
+@namespace("Switchboard")
+
+protocol Lawyer {
+
+  /** The main class for this protocol */
+  record Lawyer {
+    /** The primary key */
+    int id;
+
+    /** Their name */
+    string firstname;
+    string middlename;
+    string lastname;
+
+    /** Is the lawyer claimed? */
+    boolean claimed;
+
+    /** id of claiming user **/ 
+    int claimed_by;
+
+    /** Url to their full-size headshot photo */
+    string headshot_url;
+
+    /** Avvo Rating (Scale of 1-10) */
+    float avvo_rating;
+
+    /** Average client review score (Scale of 1-5) */
+    float aggregate_client_review_score;
+
+    /** Number of reviews the average is based upon */
+    int client_review_count;
+
+    /** List of specialties this lawyer practices */
+    array<int> specialty_ids;
+
+    /** List of states this lawyer is licensed in */
+    array<string> licensed_states;
+  }
+
+  /** Look up many lawyers in bulk */
+  array<Lawyer> index();
+
+  /** Look up a single lawyer by id */
+  array<Lawyer> show(int id);
+}

data/contracts/3/source/location.avdl

@@ -0,0 +1,76 @@
+@namespace("Switchboard")
+
+protocol Location {
+
+  /** The main class for this protocol */
+  record Location {
+    /** The primary key */
+    int id;
+
+    /** What type of record this is. (Gnomon::Country, Gnomon::State, Gnomon::County, Gnomon::City, Gnomon::PostalCode, Gnomon::Neighborhood) */
+    string type;
+
+    /** Name of the county this location is in (or nil) */
+    string county_name;
+
+    /** Name of the state this location is in (or nil) */
+    string state_name;
+
+    /** Short name of state **/
+    string state_code;
+
+    /** Name of the country this location is in (or nil) */
+    string country_name;
+
+    /** Name of the city this location is in (or nil) */
+    string city_name;
+
+    /** Name of the neighborhood this location is in (or nil) */
+    string neighborhood_name;
+
+    /** Zip code of this location (or nil) */
+    string postal_code_name;
+
+    /** Most common description of this location */
+    string to_location;
+
+    /** Shorter description of this location */
+    string to_short_location;
+
+    /** More verbose description of this location */
+    string to_long_location;
+
+    /** More verbose description of this location, usually with 3 levels of detail */
+    string to_location_with_region;
+
+    /** Latitude of the center of this location */
+    float latitude;
+
+    /** Longitude of the center of this location */
+    float longitude;
+
+    /** Approximate population of this location */
+    int population;
+
+    /** Datetime string of when this location was last updated */
+    string updated_at;
+  }
+
+  /** Options you can send for limiting Location results */
+  record LocationFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 30;
+  }
+
+  /** Returns a list of Locations */
+  array<Location> index(LocationFetchOption options);
+
+  /** Return a single Location */
+  array<Location> show(int id);
+
+  /** Try to guess a location from a given string */
+  array<Location> resolve(string q);
+}

data/contracts/3/source/offer.avdl

@@ -0,0 +1,51 @@
+@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);
+}

data/contracts/3/source/package.avdl

@@ -0,0 +1,36 @@
+@namespace("Switchboard")
+
+protocol Package {
+
+  /** The main class for this protocol */
+  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;
+  }
+
+  record PackageFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 10;
+
+    int specialty_id;
+  }
+
+  /** Returns a list of Packages */
+  array<Package> index(PackageFetchOption options);
+
+  /** Return a single Package */
+  array<Package> show(int id);
+}

data/contracts/3/source/package_detail.avdl

@@ -0,0 +1,41 @@
+@namespace("Switchboard")
+
+protocol PackageDetail {
+
+  /** The main class for this protocol */
+  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 how_it_works;
+    string whats_included;
+    string whats_not_included;
+    string micro_description;
+    string right_for_you_if;
+    string hero_image_url;
+  }
+
+  record PackageFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 10;
+
+    int specialty_id;
+  }
+
+  /** Returns a list of Packages */
+  array<Package> index(PackageFetchOption options);
+
+  /** Return a single Package */
+  array<Package> show(int id);
+}