switchboard-contract 1.9.5

data/contracts/3/compiled/package_detail.avpr

@@ -0,0 +1,100 @@
+{
+  "protocol" : "PackageDetail",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Package",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "name",
+      "type" : "string"
+    }, {
+      "name" : "short_description",
+      "type" : "string"
+    }, {
+      "name" : "call",
+      "type" : "boolean"
+    }, {
+      "name" : "call_duration_in_minutes",
+      "type" : "int"
+    }, {
+      "name" : "document",
+      "type" : "boolean"
+    }, {
+      "name" : "max_document_length_in_pages",
+      "type" : "int"
+    }, {
+      "name" : "claim_game",
+      "type" : "boolean"
+    }, {
+      "name" : "offline",
+      "type" : "boolean"
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    }, {
+      "name" : "how_it_works",
+      "type" : "string"
+    }, {
+      "name" : "whats_included",
+      "type" : "string"
+    }, {
+      "name" : "whats_not_included",
+      "type" : "string"
+    }, {
+      "name" : "micro_description",
+      "type" : "string"
+    }, {
+      "name" : "right_for_you_if",
+      "type" : "string"
+    }, {
+      "name" : "hero_image_url",
+      "type" : "string"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "PackageFetchOption",
+    "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" : 10
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Returns a list of Packages",
+      "request" : [ {
+        "name" : "options",
+        "type" : "PackageFetchOption"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Package"
+      }
+    },
+    "show" : {
+      "doc" : "Return a single Package",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Package"
+      }
+    }
+  }
+}

data/contracts/3/compiled/provider_offer.avpr

@@ -0,0 +1,144 @@
+{
+  "protocol" : "ProviderOffer",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Package",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "name",
+      "type" : "string"
+    }, {
+      "name" : "short_description",
+      "type" : "string"
+    }, {
+      "name" : "call",
+      "type" : "boolean"
+    }, {
+      "name" : "call_duration_in_minutes",
+      "type" : "int"
+    }, {
+      "name" : "document",
+      "type" : "boolean"
+    }, {
+      "name" : "max_document_length_in_pages",
+      "type" : "int"
+    }, {
+      "name" : "claim_game",
+      "type" : "boolean"
+    }, {
+      "name" : "offline",
+      "type" : "boolean"
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    }, {
+      "name" : "micro_description",
+      "type" : "string"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "PackageFetchOption",
+    "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" : 10
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "ProviderOffer",
+    "doc" : "The main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "state_id",
+      "type" : "int"
+    }, {
+      "name" : "lawyer_id",
+      "type" : "int"
+    }, {
+      "name" : "provider_id",
+      "type" : "int"
+    }, {
+      "name" : "offer_id",
+      "type" : "int"
+    }, {
+      "name" : "consumer_fee_in_cents",
+      "type" : "int"
+    }, {
+      "name" : "available",
+      "type" : "boolean"
+    }, {
+      "name" : "package",
+      "type" : "Package"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "ProviderOfferFetchOption",
+    "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" : 10
+    }, {
+      "name" : "provider_id",
+      "type" : "int"
+    }, {
+      "name" : "offer_id",
+      "type" : "int"
+    }, {
+      "name" : "state_id",
+      "type" : "int"
+    }, {
+      "name" : "specialty_id",
+      "type" : "int"
+    }, {
+      "name" : "available",
+      "type" : "boolean"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Returns a list of ProviderOffers",
+      "request" : [ {
+        "name" : "options",
+        "type" : "ProviderOfferFetchOption"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "ProviderOffer"
+      }
+    },
+    "show" : {
+      "doc" : "Return a single ProviderOffer",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "ProviderOffer"
+      }
+    }
+  }
+}

data/contracts/3/compiled/specialty.avpr

@@ -0,0 +1,61 @@
+{
+  "protocol" : "Specialty",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "SpecialtyCompact",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "name",
+      "type" : "string",
+      "doc" : "Name of the specialty"
+    } ]
+  }, {
+    "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" : "image_url",
+      "type" : "string",
+      "doc" : "Url to the icon representing this specialty"
+    }, {
+      "name" : "ancestors",
+      "type" : {
+        "type" : "array",
+        "items" : "SpecialtyCompact"
+      }
+    } ]
+  } ],
+  "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/3/compiled/user.avpr

@@ -0,0 +1,50 @@
+{
+  "protocol" : "User",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "User",
+    "doc" : "The main User class",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "name",
+      "type" : "string",
+      "doc" : "Their name"
+    }, {
+      "name" : "email_address",
+      "type" : "string",
+      "doc" : "The email address of the user"
+    }, {
+      "name" : "permissions",
+      "type" : {
+        "type" : "array",
+        "items" : "string"
+      },
+      "doc" : "An array of the names of all permissions the user has"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Look up many Users in bulk",
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "User"
+      }
+    },
+    "show" : {
+      "doc" : "Look up a single User by id",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "User"
+      }
+    }
+  }
+}

data/contracts/3/compiled/user_authentication.avpr

@@ -0,0 +1,111 @@
+{
+  "protocol" : "UserAuthentication",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "UserAuthenticationUser",
+    "doc" : "The main User class",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "The primary key"
+    }, {
+      "name" : "name",
+      "type" : "string",
+      "doc" : "Their name"
+    }, {
+      "name" : "email_address",
+      "type" : "string",
+      "doc" : "The email address of the user"
+    }, {
+      "name" : "permissions",
+      "type" : {
+        "type" : "array",
+        "items" : "string"
+      },
+      "doc" : "An array of the names of all permissions the user has"
+    }, {
+      "name" : "lawyer_id",
+      "type" : [ "null", "int" ],
+      "doc" : "The id of the lawyer this user has claimed, if any"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "UserAuthentication",
+    "fields" : [ {
+      "name" : "user",
+      "type" : "UserAuthenticationUser",
+      "doc" : "The authorized user"
+    }, {
+      "name" : "access_token",
+      "type" : "string",
+      "doc" : "An OAuth2 access token the client can use on this user's behalf"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "UserRegistrationParams",
+    "doc" : "When registering a user, provide these options",
+    "fields" : [ {
+      "name" : "email_address",
+      "type" : "string",
+      "doc" : "User's email address"
+    }, {
+      "name" : "password",
+      "type" : "string",
+      "doc" : "User's new password"
+    }, {
+      "name" : "name",
+      "type" : [ "string", "null" ],
+      "doc" : "User's display name name"
+    } ]
+  }, {
+    "type" : "enum",
+    "name" : "SocialNetwork",
+    "doc" : "All the allowed different social networks that we can auth via",
+    "symbols" : [ "FACEBOOK", "GOOGLE", "TWITTER", "LINKEDIN" ]
+  } ],
+  "messages" : {
+    "register" : {
+      "doc" : "POST: Register a user by email_address and password",
+      "request" : [ {
+        "name" : "user",
+        "type" : "UserRegistrationParams"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "UserAuthentication"
+      }
+    },
+    "authenticate" : {
+      "doc" : "POST: Authenticate a user via email_address and password",
+      "request" : [ {
+        "name" : "email_address",
+        "type" : "string"
+      }, {
+        "name" : "password",
+        "type" : "string"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "UserAuthentication"
+      }
+    },
+    "find_or_create_via_social" : {
+      "doc" : "POST: Login or register via a social network",
+      "request" : [ {
+        "name" : "social_network",
+        "type" : "SocialNetwork"
+      }, {
+        "name" : "access_token",
+        "type" : "string"
+      }, {
+        "name" : "secret",
+        "type" : [ "null", "string" ]
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "UserAuthentication"
+      }
+    }
+  }
+}