list serivce plan editable quantifiers via service_plans api (2600hz#…

…4754)
regner · Apr 4, 2018 · 3a9e5b9 · 3a9e5b9
1 parent a2121b8
commit 3a9e5b9
Show file tree

Hide file tree

Showing 5 changed files with 534 additions and 0 deletions.
diff --git a/applications/crossbar/doc/ref/service_plans.md b/applications/crossbar/doc/ref/service_plans.md
@@ -126,6 +126,16 @@ curl -v -X DELETE \
 
 #### Fetch
 
+> GET /v2/accounts/{ACCOUNT_ID}/service_plans/editable
+
+```shell
+curl -v -X GET \
+    -H "X-Auth-Token: {AUTH_TOKEN}" \
+    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/service_plans/editable
+```
+
+#### Fetch
+
 > GET /v2/accounts/{ACCOUNT_ID}/service_plans/available
 
 ```shell

diff --git a/applications/crossbar/doc/service_plans.md b/applications/crossbar/doc/service_plans.md
@@ -73,6 +73,163 @@ Key | Description | Type | Default | Required
 
 
 
+#### Available Fields To Customize
+
+Get a list of fields that can be customize for each service plan.
+
+> GET /v2/service_plans/editable
+
+```shell
+curl -v -X GET \
+    -H "X-Auth-Token: {AUTH_TOKEN}" \
+    http://{SERVER}:8000/v2/service_plans/editable
+```
+
+##### Response
+
+```json
+{
+  "data": {
+    "devices": {
+      "_all": {
+        "activation_charge": {},
+        "as": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "exceptions": {},
+        "minimum": {},
+        "rate": {}
+      },
+      "landline": {
+        "activation_charge": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "minimum": {},
+        "rate": {}
+      }
+      "..."
+    },
+    "limits": {
+      "_all": {
+        "activation_charge": {},
+        "as": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "exceptions": {},
+        "minimum": {},
+        "rate": {}
+        }
+        "..."
+    },
+    "number_services": {
+      "_all": {
+        "activation_charge": {},
+        "as": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "exceptions": {},
+        "minimum": {},
+        "rate": {}
+      },
+      "cnam": {
+        "activation_charge": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "minimum": {},
+        "rate": {}
+      }
+      "..."
+    },
+    "phone_numbers": {
+      "_all": {
+        "activation_charge": {},
+        "as": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "exceptions": {},
+        "minimum": {},
+        "rate": {}
+        },
+      "did_us": {
+        "activation_charge": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "minimum": {},
+        "rate": {}
+      }
+      "..."
+    },
+    "ui_apps": {
+      "_all": {
+        "activation_charge": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "minimum": {},
+        "rate": {},
+        "exceptions": {},
+        "as": {}
+      },
+      "accounts": {
+        "activation_charge": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "minimum": {},
+        "rate": {}
+      }
+      "..."
+    },
+    "users": {
+      "_all": {
+        "activation_charge": {},
+        "as": {},
+        "discounts": {
+            "maximum": {},
+            "rate": {}
+        },
+        "exceptions": {},
+        "minimum": {},
+        "rate": {}
+        },
+      "admin": {
+        "activation_charge": {},
+        "discounts": {
+          "maximum": {},
+          "rate": {}
+        },
+        "minimum": {},
+        "rate": {}
+      }
+      "..."
+    }
+  },
+  "revision": "{REVISION}",
+  "timestamp": "{TIMESTAMP}",
+  "version": "{VERSION}",
+  "node": "{NODE}",
+  "request_id": "{REQUEST_ID}",
+  "status": "{STATUS}",
+  "auth_token": "{AUTH_TOKEN}"
+}
+```
+
 #### Fetch
 
 > GET /v2/accounts/{ACCOUNT_ID}/service_plans

diff --git a/applications/crossbar/priv/api/swagger.json b/applications/crossbar/priv/api/swagger.json
@@ -41807,6 +41807,23 @@
                 }
             }
         },
+        "/accounts/{ACCOUNT_ID}/service_plans/editable": {
+            "get": {
+                "parameters": [
+                    {
+                        "$ref": "#/parameters/auth_token_header"
+                    },
+                    {
+                        "$ref": "#/parameters/ACCOUNT_ID"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "request succeeded"
+                    }
+                }
+            }
+        },
         "/accounts/{ACCOUNT_ID}/service_plans/override": {
             "post": {
                 "parameters": [