switchboard-contract 1.9.5

data/contracts/3/source/provider_offer.avdl

@@ -0,0 +1,38 @@
+@namespace("Switchboard")
+
+protocol ProviderOffer {
+  import protocol "../compiled/package.avpr";
+
+  /** The main class for this protocol */
+  record ProviderOffer {
+    /** The primary key */
+    int id;
+    int state_id;
+    int lawyer_id;
+    int provider_id;
+    int offer_id;
+    int consumer_fee_in_cents;
+    boolean available;
+    Package package;
+  }
+
+  record ProviderOfferFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 10;
+
+    int provider_id;
+    int offer_id;
+    int state_id;
+    int specialty_id;
+    boolean available;
+  }
+
+  /** Returns a list of ProviderOffers */
+  array<ProviderOffer> index(ProviderOfferFetchOption options);
+
+  /** Return a single ProviderOffer */
+  array<ProviderOffer> show(int id);
+}

data/contracts/3/source/specialty.avdl

@@ -0,0 +1,33 @@
+@namespace("Switchboard")
+
+protocol Specialty {
+
+  record SpecialtyCompact{
+    /** The primary key */
+    int id;
+
+    /** Name of the specialty */
+    string name;
+  }
+
+  /** The main class for this protocol */
+  record Specialty {
+    /** The primary key */
+    int id;
+
+    /** Name of the specialty */
+    string name;
+
+    /** Url to the icon representing this specialty */
+    string image_url;
+
+    array<SpecialtyCompact> ancestors;
+  }
+
+  /** Look up many specialties in bulk */
+  array<Specialty> index();
+
+  /** Look up a specialty by id */
+  array<Specialty> show(int id);
+
+}

data/contracts/3/source/user.avdl

@@ -0,0 +1,12 @@
+@namespace("Switchboard")
+
+protocol User {
+
+  import idl "common.inc";
+
+  /** Look up many Users in bulk */
+  array<User> index();
+
+  /** Look up a single User by id */
+  array<User> show(int id);
+}

data/contracts/3/source/user_authentication.avdl

@@ -0,0 +1,57 @@
+@namespace("Switchboard")
+
+protocol UserAuthentication {
+
+  /** The main User class */
+  record UserAuthenticationUser {
+    /** 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;
+
+    /** The id of the lawyer this user has claimed, if any */
+    union {null, int} lawyer_id;
+  }
+
+  record UserAuthentication {
+    /** The authorized user */
+    UserAuthenticationUser user;
+
+    /** An OAuth2 access token the client can use on this user's behalf */
+    string access_token;
+  }
+
+  /** When registering a user, provide these options */
+  record UserRegistrationParams {
+    /** User's email address */
+    string email_address;
+
+    /** User's new password */
+    string password;
+
+    /** User's display name name */
+    union{string, null} name;
+  }
+
+  /** All the allowed different social networks that we can auth via */
+  enum SocialNetwork {
+    FACEBOOK, GOOGLE, TWITTER, LINKEDIN
+  }
+
+  /** POST: Register a user by email_address and password */
+  array<UserAuthentication> register(UserRegistrationParams user);
+
+  /** POST: Authenticate a user via email_address and password */
+  array<UserAuthentication> authenticate(string email_address, string password);
+
+  /** POST: Login or register via a social network */
+  array<UserAuthentication> find_or_create_via_social(SocialNetwork social_network, string access_token, union{null, string} secret);
+
+}

data/contracts/4/compiled/lawyer.avpr

@@ -0,0 +1,127 @@
+{
+  "protocol" : "Lawyer",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "LawyerSpecialty",
+    "fields" : [ {
+      "name" : "name",
+      "type" : "string"
+    }, {
+      "name" : "percent",
+      "type" : "int"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "BrowseLink",
+    "fields" : [ {
+      "name" : "type",
+      "type" : "string",
+      "doc" : "type of url: profile, contact *"
+    }, {
+      "name" : "url",
+      "type" : "string",
+      "doc" : "actual url *"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "Lawyer",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "firstname",
+      "type" : "string",
+      "doc" : "name"
+    }, {
+      "name" : "middlename",
+      "type" : "string"
+    }, {
+      "name" : "lastname",
+      "type" : "string"
+    }, {
+      "name" : "suffix",
+      "type" : "string"
+    }, {
+      "name" : "aliases",
+      "type" : {
+        "type" : "array",
+        "items" : "string"
+      },
+      "doc" : "Lawyer's alternative names *"
+    }, {
+      "name" : "avvo_pro",
+      "type" : "boolean",
+      "doc" : "whether the lawyer is Avvo Pro *"
+    }, {
+      "name" : "avvo_rating",
+      "type" : "float",
+      "doc" : "Avvo Rating (Scale of 1-10)"
+    }, {
+      "name" : "client_review_count",
+      "type" : "int",
+      "doc" : "Number of reviews the average is based upon"
+    }, {
+      "name" : "client_review_score",
+      "type" : "float",
+      "doc" : "Average client review score (Scale of 1-5)"
+    }, {
+      "name" : "headshot_url",
+      "type" : "string",
+      "doc" : "Url to their full-size headshot photo"
+    }, {
+      "name" : "licensed_since",
+      "type" : "int",
+      "doc" : "year licensed since *"
+    }, {
+      "name" : "browse_links",
+      "type" : {
+        "type" : "array",
+        "items" : "BrowseLink"
+      },
+      "doc" : "Avvo browsing links *"
+    }, {
+      "name" : "bio",
+      "type" : "string",
+      "doc" : "Lawyer's bio *"
+    }, {
+      "name" : "lawyer_specialties",
+      "type" : {
+        "type" : "array",
+        "items" : "LawyerSpecialty"
+      },
+      "doc" : "List of specialties this lawyer practices"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Look up many lawyers in bulk",
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "Lawyer"
+      }
+    },
+    "show" : {
+      "doc" : "Look up a single lawyer by id",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Lawyer"
+      }
+    },
+    "search" : {
+      "doc" : "Look up many lawyers in bulk",
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "Lawyer"
+      }
+    }
+  }
+}

data/contracts/4/compiled/lawyer_address.avpr

@@ -0,0 +1,54 @@
+{
+  "protocol" : "LawyerAddress",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "LawyerAddress",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The LawyerAddress's id"
+    }, {
+      "name" : "lawyer_id",
+      "type" : "int",
+      "doc" : "The lawyer's id"
+    }, {
+      "name" : "line1",
+      "type" : "string",
+      "doc" : "The first line of the address"
+    }, {
+      "name" : "line2",
+      "type" : "string",
+      "doc" : "The second line of the address"
+    }, {
+      "name" : "city",
+      "type" : "string",
+      "doc" : "The city of the address"
+    }, {
+      "name" : "state_code",
+      "type" : "string",
+      "doc" : "The state abbreviation of the address"
+    }, {
+      "name" : "postal_code",
+      "type" : "string",
+      "doc" : "The postal code of the address"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Look up many adddresses in bulk",
+      "request" : [ {
+        "name" : "lawyer_id",
+        "type" : "int"
+      }, {
+        "name" : "lawyer_ids",
+        "type" : "string"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "LawyerAddress"
+      }
+    }
+  }
+}

data/contracts/4/compiled/review.avpr

@@ -0,0 +1,44 @@
+{
+  "protocol" : "Review",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Review",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The reviews's id"
+    }, {
+      "name" : "lawyer_id",
+      "type" : "int",
+      "doc" : "The lawyer's id"
+    }, {
+      "name" : "rating",
+      "type" : "int",
+      "doc" : "Overall rating  *"
+    }, {
+      "name" : "title",
+      "type" : "string",
+      "doc" : "Title of the Review"
+    }, {
+      "name" : "body",
+      "type" : "string",
+      "doc" : "The body text of the review"
+    }, {
+      "name" : "created_at",
+      "type" : "int",
+      "doc" : "The integer timestamp of when the review was created"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Look up many reviews in bulk",
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "Review"
+      }
+    }
+  }
+}

data/contracts/4/compiled/specialty.avpr

@@ -0,0 +1,43 @@
+{
+  "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" : "description",
+      "type" : "string",
+      "doc" : "Url to the icon representing this specialty"
+    } ]
+  } ],
+  "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/4/source/lawyer.avdl

@@ -0,0 +1,69 @@
+@namespace("Switchboard")
+
+protocol Lawyer {
+
+  record LawyerSpecialty {
+    string name;
+    int percent;
+  }
+
+  record BrowseLink {
+    /** type of url: profile, contact **/
+    string type;
+    /** actual url **/
+    string url;
+  }
+
+  /** The main class for this protocol */
+  record Lawyer {
+    /** The primary key */
+    int id;
+
+    /** name */
+    string firstname;
+    string middlename;
+    string lastname;
+    string suffix;
+    
+    /** Lawyer's alternative names **/
+    array<string> aliases;
+    
+    /** whether the lawyer is Avvo Pro **/
+    boolean avvo_pro;
+
+    /** Avvo Rating (Scale of 1-10) */
+    float avvo_rating;
+    
+    /** Number of reviews the average is based upon */
+    int client_review_count;
+    
+    /** Average client review score (Scale of 1-5) */
+    float client_review_score;
+
+    /** Url to their full-size headshot photo */
+    string headshot_url;
+    
+    /** year licensed since **/
+    int licensed_since;
+    
+    /** Avvo browsing links **/
+    array<BrowseLink> browse_links;
+
+    /** Lawyer's bio **/
+    string bio;
+    
+
+    /** List of specialties this lawyer practices */
+    array<LawyerSpecialty> lawyer_specialties;
+
+  }
+
+  /** Look up many lawyers in bulk */
+  array<Lawyer> index();
+
+  /** Look up a single lawyer by id */
+  array<Lawyer> show(int id);
+
+  /** Look up many lawyers in bulk */
+  array<Lawyer> search();
+}