switchboard-contract 1.9.5

data/contracts/mobile/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/mobile/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/mobile/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);
+}

data/contracts/mobile/source/package_slug.avdl

@@ -0,0 +1,30 @@
+@namespace("Switchboard")
+
+protocol PackageSlug {
+
+  /** The main class for this protocol */
+  record PackageSlug {
+    /** The primary key */
+    int id;
+    int specialty_id;
+    string name;
+    string slug;
+  }
+
+  record PackageFetchOption {
+    /** Which page of records to fetch */
+    int page = 1;
+
+    /** How many records per page */
+    int per_page = 10;
+
+    int specialty_id;
+    boolean advisor;
+  }
+
+  /** Returns a list of PackageSlugs */
+  array<PackageSlug> index(PackageFetchOption options);
+
+  /** Return a single PackageSlug */
+  array<PackageSlug> show(int id);
+}

data/contracts/mobile/source/promotion.avdl

@@ -0,0 +1,18 @@
+@namespace("Switchboard")
+
+protocol Promotion {
+
+  record Promotion {
+    int discount_amount_in_cents;
+    int new_total_price_in_cents;
+  }
+
+  record PromotionFetchOption {
+    int page = 1;
+    int per_page = 10;
+    int offer_id;
+    string short_code;
+  }
+
+  array<Promotion> index(PromotionFetchOption options);
+}

data/contracts/mobile/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/mobile/source/review.avdl

@@ -0,0 +1,43 @@
+@namespace("Switchboard")
+
+protocol Review {
+
+  /** Each individual rating type */
+  record ReviewRatings {
+    int overall;
+    int trustworthy;
+    int responsive;
+    int knowledgeable;
+    int communication;
+  }
+
+  /** The main class for this protocol */
+  record Review {
+    /** The primary key */
+    int id;
+
+    /** The lawyer's id */
+    int lawyer_id;
+
+    /** Title of the Review */
+    string title;
+
+    /** The body text of the review */
+    string body;
+
+    boolean recommended;
+    int specialty_id;
+    boolean anonymous;
+    int approval_status;
+    string display_name;
+    int created_at;
+    int updated_at;
+
+    string cache_key;
+
+    ReviewRatings ratings;
+  }
+
+  /** Look up many reviews in bulk */
+  array<Review> index();
+}

data/contracts/mobile/source/specialty.avdl

@@ -0,0 +1,32 @@
+@namespace("Switchboard")
+
+protocol Specialty {
+
+  /** The main class for this protocol */
+  record Specialty {
+    /** The primary key */
+    int id;
+
+    /** Name of the specialty */
+    string name;
+
+    /** Pretty name for SEO */
+    string seo_name;
+
+    /** What you would call an attorny practicing in this area (i.e. Bankruptcy Attorney) */
+    string title;
+
+    /** Blurb about what this specialty is about */
+    string description;
+
+    /** Pretty slug for use in the URLs */
+    string slug;
+  }
+
+  /** Look up many specialties in bulk */
+  array<Specialty> index();
+
+  /** Look up a specialty by id */
+  array<Specialty> show(int id);
+
+}

data/contracts/sales_force/compiled/account.avpr

@@ -0,0 +1,94 @@
+{
+  "protocol" : "Account",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "AccountAddress",
+    "fields" : [ {
+      "name" : "address_line1",
+      "type" : "string"
+    }, {
+      "name" : "address_line2",
+      "type" : [ "null", "string" ]
+    }, {
+      "name" : "city",
+      "type" : "string"
+    }, {
+      "name" : "county",
+      "type" : [ "null", "string" ]
+    }, {
+      "name" : "postal_code",
+      "type" : "string"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "UpsertParams",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "Account id field in sales force"
+    }, {
+      "name" : "address",
+      "type" : "AccountAddress"
+    }, {
+      "name" : "contact_email",
+      "type" : "string"
+    }, {
+      "name" : "contact_name",
+      "type" : [ "null", "string" ]
+    }, {
+      "name" : "phone_number",
+      "type" : [ "null", "string" ]
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "Account",
+    "doc" : "The main account record data type",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "Account id field in sales force"
+    }, {
+      "name" : "customer_id",
+      "type" : "int",
+      "doc" : "Avvo's internal customer id"
+    }, {
+      "name" : "address",
+      "type" : "AccountAddress"
+    }, {
+      "name" : "contact_email",
+      "type" : "string"
+    }, {
+      "name" : "contact_name",
+      "type" : [ "null", "string" ]
+    }, {
+      "name" : "phone_number",
+      "type" : [ "null", "string" ]
+    }, {
+      "name" : "start_date",
+      "type" : [ "null", "string" ],
+      "doc" : "Date of first invoice for the customer, YYYY-mm-dd"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "UpsertRequest",
+    "doc" : "REQUEST DATA TYPES",
+    "fields" : [ {
+      "name" : "account",
+      "type" : "UpsertParams"
+    } ]
+  } ],
+  "messages" : {
+    "update" : {
+      "doc" : "Procedures",
+      "request" : [ {
+        "name" : "params",
+        "type" : "UpsertParams"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Account"
+      }
+    }
+  }
+}

data/contracts/sales_force/compiled/account_professional.avpr

@@ -0,0 +1,39 @@
+{
+  "protocol" : "AccountProfessional",
+  "namespace" : "Switchboard",
+  "types" : [ {
+    "type" : "record",
+    "name" : "AccountProfessional",
+    "fields" : [ {
+      "name" : "account_id",
+      "type" : "string",
+      "doc" : "sales force account id (string uuid)"
+    }, {
+      "name" : "professional_id",
+      "type" : "int",
+      "doc" : "avvo account id"
+    } ]
+  } ],
+  "messages" : {
+    "create" : {
+      "request" : [ {
+        "name" : "params",
+        "type" : "AccountProfessional"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AccountProfessional"
+      }
+    },
+    "destroy" : {
+      "request" : [ {
+        "name" : "params",
+        "type" : "AccountProfessional"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "AccountProfessional"
+      }
+    }
+  }
+}

data/contracts/sales_force/source/account.avdl

@@ -0,0 +1,50 @@
+@namespace("Switchboard")
+
+protocol Account {
+  record AccountAddress {
+    string address_line1;
+    union { null, string } address_line2;
+    string city;
+    union { null, string } county;
+    string postal_code;
+  }
+
+  record UpsertParams {
+    /** Account id field in sales force */
+    int id;
+
+    AccountAddress address;
+    string contact_email;
+    union { null, string } contact_name;
+    union { null, string } phone_number;
+  }
+
+  /** The main account record data type */
+  record Account {
+    /** Account id field in sales force */
+    int id;
+
+    /** Avvo's internal customer id */
+    int customer_id;
+
+    AccountAddress address;
+    string contact_email;
+    union { null, string } contact_name;
+    union { null, string } phone_number;
+
+    /** Date of first invoice for the customer, YYYY-mm-dd */
+    union { null, string } start_date;
+  }
+
+
+  /** REQUEST DATA TYPES */
+
+  record UpsertRequest {
+    UpsertParams account;
+  }
+
+
+  /** Procedures */
+
+  array<Account> update(UpsertParams params);
+}