added /v1/rate-limit-challenge endpoint

see #456

src/docs/docs.go

@@ -47,7 +47,7 @@ var doc = `{
         },
         "/v1/accounts": {
             "get": {
-                "description": "Lists all of the devices linked or registered",
+                "description": "Lists all of the accounts linked or registered",
                 "produces": [
                     "application/json"
                 ],
@@ -74,6 +74,48 @@ var doc = `{
                 }
             }
         },
+        "/v1/accounts/{number}/rate-limit-challenge": {
+            "post": {
+                "description": "When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA. To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html. The \"challenge_token\" is the token from the failed send attempt. The \"captcha\" is the captcha result, starting with signalcaptcha://",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Accounts"
+                ],
+                "summary": "Lift rate limit restrictions by solving a captcha.",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Registered Phone Number",
+                        "name": "number",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "description": "Request",
+                        "name": "data",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/api.RateLimitChallengeRequest"
+                        }
+                    }
+                ],
+                "responses": {
+                    "204": {},
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/api.Error"
+                        }
+                    }
+                }
+            }
+        },
         "/v1/attachments": {
             "get": {
                 "description": "List all downloaded attachments",
@@ -1779,6 +1821,19 @@ var doc = `{
                 }
             }
         },
+        "api.RateLimitChallengeRequest": {
+            "type": "object",
+            "properties": {
+                "captcha": {
+                    "type": "string",
+                    "example": "signalcaptcha://{captcha value}"
+                },
+                "challenge_token": {
+                    "type": "string",
+                    "example": "\u003cchallenge token\u003e"
+                }
+            }
+        },
         "api.Reaction": {
             "type": "object",
             "properties": {

src/docs/swagger.json

@@ -31,7 +31,7 @@
         },
         "/v1/accounts": {
             "get": {
-                "description": "Lists all of the devices linked or registered",
+                "description": "Lists all of the accounts linked or registered",
                 "produces": [
                     "application/json"
                 ],
@@ -58,6 +58,48 @@
                 }
             }
         },
+        "/v1/accounts/{number}/rate-limit-challenge": {
+            "post": {
+                "description": "When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA. To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html. The \"challenge_token\" is the token from the failed send attempt. The \"captcha\" is the captcha result, starting with signalcaptcha://",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Accounts"
+                ],
+                "summary": "Lift rate limit restrictions by solving a captcha.",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Registered Phone Number",
+                        "name": "number",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "description": "Request",
+                        "name": "data",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/api.RateLimitChallengeRequest"
+                        }
+                    }
+                ],
+                "responses": {
+                    "204": {},
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/api.Error"
+                        }
+                    }
+                }
+            }
+        },
         "/v1/attachments": {
             "get": {
                 "description": "List all downloaded attachments",
@@ -1763,6 +1805,19 @@
                 }
             }
         },
+        "api.RateLimitChallengeRequest": {
+            "type": "object",
+            "properties": {
+                "captcha": {
+                    "type": "string",
+                    "example": "signalcaptcha://{captcha value}"
+                },
+                "challenge_token": {
+                    "type": "string",
+                    "example": "\u003cchallenge token\u003e"
+                }
+            }
+        },
         "api.Reaction": {
             "type": "object",
             "properties": {

src/docs/swagger.yaml

@@ -73,6 +73,15 @@ definitions:
       Level:
         type: string
     type: object
+  api.RateLimitChallengeRequest:
+    properties:
+      captcha:
+        example: signalcaptcha://{captcha value}
+        type: string
+      challenge_token:
+        example: <challenge token>
+        type: string
+    type: object
   api.Reaction:
     properties:
       reaction:
@@ -313,7 +322,7 @@ paths:
       - General
   /v1/accounts:
     get:
-      description: Lists all of the devices linked or registered
+      description: Lists all of the accounts linked or registered
       produces:
       - application/json
       responses:
@@ -330,6 +339,34 @@ paths:
       summary: List all accounts
       tags:
       - Accounts
+  /v1/accounts/{number}/rate-limit-challenge:
+    post:
+      consumes:
+      - application/json
+      description: 'When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA. To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html. The "challenge_token" is the token from the failed send attempt. The "captcha" is the captcha result, starting with signalcaptcha://'
+      parameters:
+      - description: Registered Phone Number
+        in: path
+        name: number
+        required: true
+        type: string
+      - description: Request
+        in: body
+        name: data
+        required: true
+        schema:
+          $ref: '#/definitions/api.RateLimitChallengeRequest'
+      produces:
+      - application/json
+      responses:
+        "204": {}
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/api.Error'
+      summary: Lift rate limit restrictions by solving a captcha.
+      tags:
+      - Accounts
   /v1/attachments:
     get:
       description: List all downloaded attachments