switchboard-contract 1.9.5

data/contracts/4/source/lawyer_address.avdl

@@ -0,0 +1,31 @@
+@namespace("Switchboard")
+
+protocol LawyerAddress {
+
+  /** The main class for this protocol */
+  record LawyerAddress {
+    /** The LawyerAddress's id */
+    int id;
+
+    /** The lawyer's id */
+    int lawyer_id;
+
+    /** The first line of the address */
+    string line1;
+
+    /** The second line of the address */
+    string line2;
+
+    /** The city of the address */
+    string city;
+
+    /** The state abbreviation of the address */
+    string state_code;
+
+    /** The postal code of the address */
+    string postal_code;
+  }
+
+  /** Look up many adddresses in bulk */
+  array<LawyerAddress> index(int lawyer_id, string lawyer_ids);
+}

data/contracts/4/source/review.avdl

@@ -0,0 +1,28 @@
+@namespace("Switchboard")
+
+protocol Review {
+
+  /** The main class for this protocol */
+  record Review {
+    /** The reviews's id */
+    int id;
+
+    /** The lawyer's id */
+    int lawyer_id;
+
+    /** Overall rating  **/
+    int rating;
+
+    /** Title of the Review */
+    string title;
+
+    /** The body text of the review */
+    string body;
+
+    /** The integer timestamp of when the review was created */
+    int created_at;
+  }
+
+  /** Look up many reviews in bulk */
+  array<Review> index();
+}

data/contracts/4/source/specialty.avdl

@@ -0,0 +1,23 @@
+@namespace("Switchboard")
+
+protocol Specialty {
+
+  /** 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 description;
+  }
+
+  /** Look up many specialties in bulk */
+  array<Specialty> index();
+
+  /** Look up a specialty by id */
+  array<Specialty> show(int id);
+
+}

data/contracts/messaging/compiled/access_token.avpr

@@ -0,0 +1,41 @@
+{
+  "protocol" : "AccessToken",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "AccessToken",
+    "doc" : "A Twilio Access token that the client can use to authenticate with Avvo's Twilio IP Messaging Channels",
+    "fields" : [ {
+      "name" : "identity",
+      "type" : "string"
+    }, {
+      "name" : "token",
+      "type" : "string"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "AccessTokenRequestParams",
+    "doc" : "The accepted attributes that we'd like to fetch by in the index endpoint",
+    "fields" : [ {
+      "name" : "push_notifications_sid",
+      "type" : [ "null", "int" ],
+      "doc" : "The Twilio Push Notifications SID for the client, used primarily by the iOS SDK"
+    }, {
+      "name" : "endpoint_id",
+      "type" : [ "null", "int" ],
+      "doc" : "The unique endpoint ID for the IP Messaging Client"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "request" : [ {
+        "name" : "params",
+        "type" : "AccessTokenRequestParams"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AccessToken"
+      }
+    }
+  }
+}

data/contracts/messaging/compiled/channel.avpr

@@ -0,0 +1,111 @@
+{
+  "protocol" : "Channel",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Channel",
+    "doc" : "A Chat Channel, includes basic information allowing client to setup",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The Avvo ID for the partner user of the channel"
+    }, {
+      "name" : "channel_sid",
+      "type" : "string",
+      "doc" : "The Twilio Service ID for the Channel"
+    }, {
+      "name" : "operating_user_id",
+      "type" : "int",
+      "doc" : "The Avvo ID for the operating user"
+    }, {
+      "name" : "operating_user_sid",
+      "type" : "string",
+      "doc" : "The Twilio Service ID for the operating user"
+    }, {
+      "name" : "operating_user_identity",
+      "type" : "string",
+      "doc" : "The Twilio Unique Identifier for the operating user"
+    }, {
+      "name" : "partner_sid",
+      "type" : "string",
+      "doc" : "The Twilio Service ID for the partner user"
+    }, {
+      "name" : "partner_identity",
+      "type" : "string",
+      "doc" : "The Twilio Unique Identifier for the partner user"
+    }, {
+      "name" : "archived",
+      "type" : "boolean",
+      "doc" : "Is the channel archived by the operating user"
+    }, {
+      "name" : "spam",
+      "type" : "boolean",
+      "doc" : "Is the channel marked as spam by the operating user"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "ChannelSearchParams",
+    "doc" : "Accepted parameters for filtering channels",
+    "fields" : [ {
+      "name" : "spam",
+      "type" : [ "boolean", "null" ],
+      "doc" : "Show only records marked as spam?"
+    }, {
+      "name" : "archived",
+      "type" : [ "boolean", "null" ],
+      "doc" : "Show only records marked as archived"
+    }, {
+      "name" : "partner_user_id",
+      "type" : [ "int", "null" ],
+      "doc" : "Filter the given user's channels by the user id of the partner user"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "UpdateChannelParams",
+    "doc" : "Accepted inbound attributes for updating a channel",
+    "fields" : [ {
+      "name" : "spam",
+      "type" : [ "boolean", "null" ],
+      "doc" : "Should the new record be marked as spam?"
+    }, {
+      "name" : "archived",
+      "type" : [ "boolean", "null" ],
+      "doc" : "Should the new record be archived?"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "request" : [ {
+        "name" : "params",
+        "type" : "ChannelSearchParams"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Channel"
+      }
+    },
+    "show" : {
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Channel"
+      }
+    },
+    "update" : {
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      }, {
+        "name" : "channel",
+        "type" : "UpdateChannelParams"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Channel"
+      }
+    }
+  }
+}

data/contracts/messaging/source/access_token.avdl

@@ -0,0 +1,21 @@
+@namespace("Switchboard")
+protocol AccessToken {
+  /** A Twilio Access token that the client can use to authenticate with Avvo's Twilio IP Messaging Channels */
+
+  record AccessToken {
+    string identity;
+    string token;
+  }
+
+  /** The accepted attributes that we'd like to fetch by in the index endpoint */
+  record AccessTokenRequestParams {
+    /** The Twilio Push Notifications SID for the client, used primarily by the iOS SDK */
+    union { null, int } push_notifications_sid;
+
+    /** The unique endpoint ID for the IP Messaging Client */
+    union { null, int } endpoint_id;
+  }
+
+  array<AccessToken> index(AccessTokenRequestParams params);
+}
+

data/contracts/messaging/source/channel.avdl

@@ -0,0 +1,59 @@
+@namespace("Switchboard")
+protocol Channel {
+  /** A Chat Channel, includes basic information allowing client to setup */
+
+  record Channel {
+    /** The Avvo ID for the partner user of the channel */
+    int id;
+
+    /** The Twilio Service ID for the Channel */
+    string channel_sid;
+
+    /** The Avvo ID for the operating user */
+    int operating_user_id;
+
+    /** The Twilio Service ID for the operating user */
+    string operating_user_sid;
+
+    /** The Twilio Unique Identifier for the operating user */
+    string operating_user_identity;
+    
+    /** The Twilio Service ID for the partner user */
+    string partner_sid;
+    
+    /** The Twilio Unique Identifier for the partner user */
+    string partner_identity;
+
+    /** Is the channel archived by the operating user */
+    boolean archived;
+
+    /** Is the channel marked as spam by the operating user */
+    boolean spam;
+  }
+
+  /** Accepted parameters for filtering channels */
+  record ChannelSearchParams {
+    /** Show only records marked as spam? */
+    union { boolean, null } spam;
+
+    /** Show only records marked as archived */
+    union { boolean, null } archived;
+
+    /** Filter the given user's channels by the user id of the partner user  */
+    union { int, null } partner_user_id;
+  }
+
+  /** Accepted inbound attributes for updating a channel */
+  record UpdateChannelParams {
+    /** Should the new record be marked as spam? */
+    union { boolean, null } spam;
+
+    /** Should the new record be archived? */
+    union { boolean, null } archived;
+  }
+
+  array<Channel> index(ChannelSearchParams params);
+  array<Channel> show(int id);
+  array<Channel> update(int id, UpdateChannelParams `channel`);
+}
+

data/contracts/mobile/compiled/advice_session.avpr

@@ -0,0 +1,160 @@
+{
+  "protocol" : "AdviceSession",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "AdviceSession",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    }, {
+      "name" : "advisor_id",
+      "type" : "int"
+    }, {
+      "name" : "review_id",
+      "type" : "int"
+    }, {
+      "name" : "chose_advisor",
+      "type" : "boolean"
+    }, {
+      "name" : "state",
+      "type" : "string"
+    }, {
+      "name" : "called",
+      "type" : "boolean"
+    }, {
+      "name" : "advice_session_image_token",
+      "type" : [ "null", "string" ],
+      "default" : null
+    }, {
+      "name" : "advice_session_image_tokens",
+      "type" : {
+        "type" : "array",
+        "items" : "string"
+      }
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "AdviceSessionFetchOption",
+    "doc" : "Options you can send for limiting AdviceSession results",
+    "fields" : [ {
+      "name" : "page",
+      "type" : "int",
+      "doc" : "Which page of records to fetch",
+      "default" : 1
+    }, {
+      "name" : "per_page",
+      "type" : "int",
+      "doc" : "How many records per page",
+      "default" : 30
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "AdviceSessionCreateParams",
+    "doc" : "Params to create a new AdviceSession",
+    "fields" : [ {
+      "name" : "specialty_id",
+      "type" : "int"
+    }, {
+      "name" : "advisor_id",
+      "type" : "int"
+    }, {
+      "name" : "state",
+      "type" : "string"
+    }, {
+      "name" : "client_name",
+      "type" : "string"
+    }, {
+      "name" : "client_email_address",
+      "type" : "string"
+    }, {
+      "name" : "client_phone_number",
+      "type" : "string"
+    }, {
+      "name" : "payment_gateway",
+      "type" : [ "null", "string" ],
+      "default" : null
+    }, {
+      "name" : "card_href",
+      "type" : "string"
+    }, {
+      "name" : "name_on_card",
+      "type" : "string"
+    }, {
+      "name" : "advice_session_image_token",
+      "type" : [ "null", "string" ],
+      "default" : null
+    }, {
+      "name" : "advice_session_image_tokens",
+      "type" : {
+        "type" : "array",
+        "items" : "string"
+      }
+    }, {
+      "name" : "promo_code",
+      "type" : [ "null", "string" ],
+      "default" : null
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "AdviceSessionPromoCode",
+    "fields" : [ {
+      "name" : "promo_discount_amount_in_cents",
+      "type" : "int"
+    }, {
+      "name" : "promo_advice_session_price_in_cents",
+      "type" : "int"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Returns a list of AdviceSession",
+      "request" : [ {
+        "name" : "options",
+        "type" : "AdviceSessionFetchOption"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AdviceSession"
+      }
+    },
+    "show" : {
+      "doc" : "Return a single AdviceSession",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AdviceSession"
+      }
+    },
+    "create" : {
+      "doc" : "Create a new AdviceSession",
+      "request" : [ {
+        "name" : "advice_session",
+        "type" : "AdviceSessionCreateParams"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AdviceSession"
+      }
+    },
+    "find_promo_code" : {
+      "doc" : "Apply an Advice Session Promo Code",
+      "request" : [ {
+        "name" : "promo_code",
+        "type" : "string"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AdviceSessionPromoCode"
+      }
+    }
+  }
+}