switchboard-contract 1.9.5

data/contracts/mobile/compiled/review.avpr

@@ -0,0 +1,83 @@
+{
+  "protocol" : "Review",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "ReviewRatings",
+    "doc" : "Each individual rating type",
+    "fields" : [ {
+      "name" : "overall",
+      "type" : "int"
+    }, {
+      "name" : "trustworthy",
+      "type" : "int"
+    }, {
+      "name" : "responsive",
+      "type" : "int"
+    }, {
+      "name" : "knowledgeable",
+      "type" : "int"
+    }, {
+      "name" : "communication",
+      "type" : "int"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "Review",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "lawyer_id",
+      "type" : "int",
+      "doc" : "The lawyer's id"
+    }, {
+      "name" : "title",
+      "type" : "string",
+      "doc" : "Title of the Review"
+    }, {
+      "name" : "body",
+      "type" : "string",
+      "doc" : "The body text of the review"
+    }, {
+      "name" : "recommended",
+      "type" : "boolean"
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    }, {
+      "name" : "anonymous",
+      "type" : "boolean"
+    }, {
+      "name" : "approval_status",
+      "type" : "int"
+    }, {
+      "name" : "display_name",
+      "type" : "string"
+    }, {
+      "name" : "created_at",
+      "type" : "int"
+    }, {
+      "name" : "updated_at",
+      "type" : "int"
+    }, {
+      "name" : "cache_key",
+      "type" : "string"
+    }, {
+      "name" : "ratings",
+      "type" : "ReviewRatings"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Look up many reviews in bulk",
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "Review"
+      }
+    }
+  }
+}

data/contracts/mobile/compiled/specialty.avpr

@@ -0,0 +1,55 @@
+{
+  "protocol" : "Specialty",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Specialty",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "name",
+      "type" : "string",
+      "doc" : "Name of the specialty"
+    }, {
+      "name" : "seo_name",
+      "type" : "string",
+      "doc" : "Pretty name for SEO"
+    }, {
+      "name" : "title",
+      "type" : "string",
+      "doc" : "What you would call an attorny practicing in this area (i.e. Bankruptcy Attorney)"
+    }, {
+      "name" : "description",
+      "type" : "string",
+      "doc" : "Blurb about what this specialty is about"
+    }, {
+      "name" : "slug",
+      "type" : "string",
+      "doc" : "Pretty slug for use in the URLs"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Look up many specialties in bulk",
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "Specialty"
+      }
+    },
+    "show" : {
+      "doc" : "Look up a specialty by id",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Specialty"
+      }
+    }
+  }
+}

data/contracts/mobile/source/advice_session.avdl

@@ -0,0 +1,61 @@
+@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;
+  }
+
+  /** 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/mobile/source/checkout.avdl

@@ -0,0 +1,90 @@
+@namespace("Switchboard")
+
+protocol Checkout {
+  /** The main class for this protocol */
+  record Checkout {
+    /* the ID */
+    int id;
+
+    /* The ID of the associated specialty */
+    int specialty_id;
+
+    /* The ID of the associated advisor */
+    int advisor_id;
+
+    /* The ID of the associated review */
+    int review_id;
+
+    /* The state */
+    string state;
+
+    /* Flag showing if the user was called or not */
+    boolean called;
+
+    /* The token used to access the assocaited image */
+    union {null, string} advice_session_image_token = null;
+
+    /* Flag showing if the user chose the attorney or not */
+    boolean chose_advisor;
+  }
+
+  /** Params to create AdviceSessionImages when the file is already on S3 */
+  record ImageParams {
+    /* The token for the image on S3 */
+    string token;
+
+    /* The file name of the image */
+    string filename;
+  }
+
+  /** Params to create a new Checkout */
+  record CheckoutCreateParams {
+    /* The ID of the associated Provider */
+    int provider_id;
+
+    /* The ID of the associated Offer */
+    int offer_id;
+
+    /* The ID of the associated Specialty */
+    int specialty_id;
+
+    /* The ID of the associated State */
+    int state_id;
+
+    /* The gateway service that the payment was processed by */
+    union {null, string} payment_gateway = null;
+
+    /* The ID of the associated credit card */
+    string card_id;
+
+    /* The name of the client */
+    string client_name;
+
+    /* The name of the card */
+    string card_name;
+
+    /* The users email address */
+    string email_address;
+
+    /* The users phone number */
+    string phone_number;
+
+    /* The s3 token for the associated uploaded image */
+    union {null, string} uploaded_image_token = null;
+
+    /* The code for the assocaited Promotion */
+    union {null, string} promo_code = null;
+
+    /* The source of the checkout */
+    string source;
+
+    /* The remote IP of the user */
+    string remote_ip;
+
+    /* The uploaded images */
+    array<ImageParams> uploaded_images;
+  }
+
+  /** Create a new Checkout */
+  array<Checkout> create(CheckoutCreateParams checkout);
+}

data/contracts/mobile/source/lawyer.avdl

@@ -0,0 +1,321 @@
+@namespace("Switchboard")
+
+protocol Lawyer {
+
+  record Phone {
+    string area_code;
+    string local_number;
+    string type;
+  }
+  record Address {
+    int id;
+    int lawyer_id;
+    string address_line1;
+    string address_line2;
+    string city;
+    string state;
+    string postal_code;
+    string standardized_address;
+    int location_id;
+    float latitude;
+    float longitude;
+    array<Phone> phones;
+    string firm_name;
+
+  }
+
+  record License {
+    int id;
+    string state;
+    string status;
+    string status_type;
+    int license_date;
+    int licensing_authority_id;
+    int last_updated;
+
+  }
+
+  record Sanction {
+    int id;
+    int lawyer_id;
+    int license_id;
+    string state;
+    string name;
+    string type;
+    int sanction_date;
+    int updated_at;
+    string description;
+    string interpretation;
+    string comment;
+  }
+
+  record Fee {
+    string name;
+    string symbolic_name;
+    int min_rate;
+    int max_rate;
+  }
+
+  record AdditionalProfileLink {
+    int id;
+    string url;
+    string title;
+    string social_network;
+    string rss;
+    boolean rssable;
+    int updated_at;
+  }
+
+  record Media {
+    int id;
+    string path;
+    int mime_type_id;
+    string external_url;
+    string caption;
+    string copyright;
+    boolean is_video;
+  }
+
+  record Personal {
+    array<string> aliases;
+    string bio;
+    array<string> languages;
+    array<string> payment_types;
+    string fixed_acceptance_type;
+    string retainer_acceptance_type;
+    int probono_contribution;
+    int free_consultation;
+    string cache_key;
+    array<Fee> fees;
+    array<Media> media_thumbnails;
+    array<AdditionalProfileLink> social_networks;
+  }
+  record Status {
+    boolean deceased;
+    boolean judge;
+    boolean retired;
+    boolean official;
+    boolean unverified;
+    boolean displayable;
+    boolean sanctioned;
+    boolean rateable;
+  }
+  record Rating {
+    int overall;
+    int trustworthy;
+    int responsive;
+    int knowledgeable;
+    int communication;
+
+  }
+  record Review {
+    int id;
+    int lawyer_id;
+    string title;
+    string body;
+    boolean recommended;
+    int specialty_id;
+    boolean anonymous;
+    int approval_status;
+    string display_name;
+    int created_at;
+    int updated_at;
+    string cache_key;
+    Rating ratings;
+  }
+  record LawyerSpecialty {
+    int id;
+    string name;
+    int specialty_id;
+    int percent;
+    int start_date;
+    string description;
+    int cases;
+  }
+
+  /** The main class for this protocol */
+  record Lawyer {
+    /** The primary key */
+    int id;
+
+    /** Their name */
+    string firstname;
+    string middlename;
+    string lastname;
+    string suffix;
+    string email_address;
+    int licensed_since;
+    string website;
+    int advisor_id;
+    boolean advisor_available;
+    array<int> sanction_ids;
+    array<License> licenses;
+    Status status;
+    array<Address> addresses;
+    array<Review> reviews;
+    array<LawyerSpecialty> lawyer_specialties;
+    Personal personal;
+    array<Sanction> sanctions;
+
+    /** 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;
+    boolean avvo_pro;
+
+    /** 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;
+  }
+
+  /** The lawyer result when performing a search */
+    record SearchLawyer {
+      /** The primary key */
+      int id;
+
+      /** Their name */
+      string firstname;
+      string middlename;
+      string lastname;
+      string suffix;
+      string email_address;
+      int licensed_since;
+      int advisor_id;
+      boolean advisor_available;
+      array<Address> addresses;
+
+      /** 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;
+      boolean avvo_pro;
+
+      /** 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;
+    }
+
+  record SearchParams{
+
+      /** location **/
+
+      /** takes a string that will be then processed through Gnomon **/
+      string loc;
+
+      /** latitude **/
+      float lat;
+      /** longitude **/
+      float Long;
+      /** radius **/
+      float radius;
+
+      /** this is the query interface. "divorce" or "Mark Britton" go here **/
+      string q;
+
+      /** this is to force what kind of search you want. The options are "specialty"(this is what we default to), "location", and "name" **/
+      string type;
+
+      /** filters **/
+
+      /** takes a language string, such as "English". With the new UI, the requirement is to only filter by one language at a time **/
+      string language;
+      boolean has_reviews;
+      boolean has_endorsements;
+      boolean free_consultation;
+      /** takes an expertise name string **/
+      string expertise;
+      /** can take a single value, or an array of `[min, max]` where max & min are 0-5 in 0.5 increments.  (Test note, the format in the URL for this is client_ratings[] =min&client_ratings[]=max) **/
+      array<int> client_ratings;
+     /** single year value or an array of `[start, end]`. has to be a year.  **/
+      array<int> licensed_since;
+
+      /** ordering **/
+
+      /** order by avvo rating. takes "asc" or "desc" **/
+      string avvo_rating;
+      /** order by client review rating. takes "asc" or "desc" **/
+      string client_rating;
+      /** order by number of client reviews. takes "asc" or "desc" **/
+      string number_of_reviews;
+
+      /** pagination **/
+
+      /** page of results **/
+      int page;
+      /** results per page **/
+      int per_page;
+    }
+
+    record SearchFilters {
+      array<string> language;
+      array<boolean> has_reviews;
+      array<boolean> has_endorsements;
+      array<boolean> free_consultation;
+      array<string> expertise;
+      array<float> client_reviews;
+    }
+
+    record SearchLocation {
+      int location_id;
+      float lat;
+      float Long;
+      string type;
+      array<int> surrounding_location_ids;
+    }
+
+    record SearchStats {
+      int review_count;
+      float average_review_rating;
+    }
+
+    record SearchContext {
+      string search;
+      int specialty;
+      boolean name_suggestion;
+      SearchFilters filters;
+      SearchLocation location;
+      SearchStats stats;
+      array<int> pls_lawyer_ids;
+    }
+
+    record SearchMetadata {
+      SearchContext context;
+      int status;
+      int current_page;
+      int per_page;
+      int total_pages;
+      int total_entries;
+    }
+
+    record SearchResult {
+      array<SearchLawyer> lawyers;
+      SearchMetadata meta;
+    }
+
+  /** Look up many lawyers in bulk */
+  array<Lawyer> index();
+
+  /** Look up a single lawyer by id */
+  array<Lawyer> show(int id);
+
+  /** Look up a single lawyer by id */
+  SearchResult search(SearchParams params);
+}