diff --git a/src/docs/docs.go b/src/docs/docs.go index 00b4cb5..53401c6 100644 --- a/src/docs/docs.go +++ b/src/docs/docs.go @@ -1091,6 +1091,47 @@ var doc = `{ } } }, + "/v1/unregister/{number}": { + "post": { + "description": "Disables push support for this device. **WARNING:** If *delete_account* is set to *true*, the account will be deleted from the Signal Server. This cannot be undone without loss.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Devices" + ], + "summary": "Unregister a phone number.", + "parameters": [ + { + "type": "string", + "description": "Registered Phone Number", + "name": "number", + "in": "path", + "required": true + }, + { + "description": "Additional Settings", + "name": "data", + "in": "body", + "schema": { + "$ref": "#/definitions/api.UnregisterNumberRequest" + } + } + ], + "responses": { + "204": {}, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/api.Error" + } + } + } + } + }, "/v2/send": { "post": { "description": "Send a signal message", @@ -1323,6 +1364,15 @@ var doc = `{ } } }, + "api.UnregisterNumberRequest": { + "type": "object", + "properties": { + "delete_account": { + "type": "boolean", + "example": false + } + } + }, "api.UpdateProfileRequest": { "type": "object", "properties": { diff --git a/src/docs/swagger.json b/src/docs/swagger.json index e75ec64..758a23d 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -1076,6 +1076,47 @@ } } }, + "/v1/unregister/{number}": { + "post": { + "description": "Disables push support for this device. **WARNING:** If *delete_account* is set to *true*, the account will be deleted from the Signal Server. This cannot be undone without loss.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Devices" + ], + "summary": "Unregister a phone number.", + "parameters": [ + { + "type": "string", + "description": "Registered Phone Number", + "name": "number", + "in": "path", + "required": true + }, + { + "description": "Additional Settings", + "name": "data", + "in": "body", + "schema": { + "$ref": "#/definitions/api.UnregisterNumberRequest" + } + } + ], + "responses": { + "204": {}, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/api.Error" + } + } + } + } + }, "/v2/send": { "post": { "description": "Send a signal message", @@ -1308,6 +1349,15 @@ } } }, + "api.UnregisterNumberRequest": { + "type": "object", + "properties": { + "delete_account": { + "type": "boolean", + "example": false + } + } + }, "api.UpdateProfileRequest": { "type": "object", "properties": { diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index e0a1f5a..5bcec43 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -124,6 +124,12 @@ definitions: recipient: type: string type: object + api.UnregisterNumberRequest: + properties: + delete_account: + example: false + type: boolean + type: object api.UpdateProfileRequest: properties: base64_avatar: @@ -900,6 +906,33 @@ paths: summary: Show Typing Indicator. tags: - Messages + /v1/unregister/{number}: + post: + consumes: + - application/json + description: Disables push support for this device. **WARNING:** If *delete_account* is set to *true*, the account will be deleted from the Signal Server. This cannot be undone without loss. + parameters: + - description: Registered Phone Number + in: path + name: number + required: true + type: string + - description: Additional Settings + in: body + name: data + schema: + $ref: '#/definitions/api.UnregisterNumberRequest' + produces: + - application/json + responses: + "204": {} + "400": + description: Bad Request + schema: + $ref: '#/definitions/api.Error' + summary: Unregister a phone number. + tags: + - Devices /v2/send: post: consumes: