Merge pull request #655 from bbiggerr/add/account/profile/phone

Add Phone Number Endpoints

Author: bbiggerr

openapi.yaml

@@ -2631,7 +2631,7 @@ paths:
         email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See
         our [Linode Managed guide](/docs/platform/linode-managed/)
         to learn more.
-      operationId: enableAccountManged
+      operationId: enableAccountManaged
       x-linode-cli-action: enable-managed
       security:
       - personalAccessToken: []
@@ -17564,6 +17564,165 @@ paths:
       - lang: CLI
         source: >
           linode-cli sshkey delete 42
+  /profile/phone-number:
+    x-linode-cli-command: phone
+    delete:
+      x-linode-grant: read_write
+      tags:
+      - Profile
+      summary: Phone Number Delete
+      description: |
+        Delete the verified phone number for the User making this request.
+
+        Use this command to opt out of SMS messages for the requesting User after a phone number has been verified with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
+      operationId: deleteProfilePhoneNumber
+      x-linode-cli-command: delete
+      security:
+      - personalAccessToken: []
+      - oauth:
+        - account:read_write
+      responses:
+        '200':
+          description: >
+            Phone number deletion request successful.
+          content:
+            application/json:
+              schema:
+                type: object
+        default:
+          $ref: '#/components/responses/ErrorResponse'
+      x-code-samples:
+      - lang: Shell
+        source: >
+          curl -H "Content-Type: application/json" \
+            -H "Authorization: Bearer $TOKEN_BBIGGER_DEV" \
+            -X DELETE \
+            https://api.dev.linode.com/v4/profile/phone-number
+      - lang: CLI
+        source: >
+          linode-cli phone delete
+    post:
+      x-linode-grant: read_write
+      tags:
+      - Profile
+      summary: Phone Number Verification Code Send
+      description: |
+        Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply.
+
+        * By accessing this command you are opting in to receive SMS messages. You can opt out of SMS messages by using the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command after your phone number is verified.
+
+        * Verification codes are valid for 10 minutes after they are sent.
+
+        * Subsequent requests made prior to code expiration result in sending the same code.
+
+        Once a verification code is received, verify your phone number with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
+      operationId: postProfilePhoneNumber
+      x-linode-cli-command: sms-code-send
+      security:
+      - personalAccessToken: []
+      - oauth:
+        - account:read_write
+      requestBody:
+        description: Enter a phone number and country code for verification.
+        content:
+          application/json:
+            schema:
+              required:
+              - iso_code
+              - phone_number
+              type: object
+              properties:
+                iso_code:
+                  type: string
+                  description: The two-letter ISO 3166 country code associated with the phone number.
+                  example: US
+                phone_number:
+                  type: string
+                  description: A valid phone number.
+                  format: phone
+                  example: 555-555-5555
+      responses:
+        '200':
+          description: >
+            Phone number verification code request successful.
+          content:
+            application/json:
+              schema:
+                type: object
+        default:
+          $ref: '#/components/responses/ErrorResponse'
+      x-code-samples:
+      - lang: Shell
+        source: >
+          curl -H "Content-Type: application/json" \
+            -H "Authorization: Bearer $TOKEN_BBIGGER_DEV" \
+            -X POST -d '{
+              "iso_code": "US",
+              "phone_number": "267-273-8229"
+            }' \
+            https://api.dev.linode.com/v4/profile/phone-number
+      - lang: CLI
+        source: >
+          linode-cli phone sms-code-send \
+            --iso-code US \
+            --phone-number 555-555-5555
+  /profile/phone-number/verify:
+    x-linode-cli-command: phone
+    post:
+      x-linode-grant: read_write
+      tags:
+      - Profile
+      summary: Phone Number Verify
+      description: |
+        Verify a phone number by confirming the one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
+
+        * Verification codes are valid for 10 minutes after they are sent.
+
+        * Only the same User that made the verification code request can use that code with this command.
+
+        Once completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first use the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command, then begin the verification process again with the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
+      operationId: postProfilePhoneNumberVerify
+      x-linode-cli-command: verify
+      security:
+      - personalAccessToken: []
+      - oauth:
+        - account:read_write
+      requestBody:
+        description: Enter a phone verification code for confirmation.
+        content:
+          application/json:
+            schema:
+              required:
+              - otp_code
+              type: object
+              properties:
+                otp_code:
+                  type: string
+                  description: The one-time, six-digit code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
+                  example: "US"
+      responses:
+        '200':
+          description: >
+            Phone number verification successful.
+          content:
+            application/json:
+              schema:
+                type: object
+        default:
+          $ref: '#/components/responses/ErrorResponse'
+      x-code-samples:
+      - lang: Shell
+        source: >
+          curl -H "Content-Type: application/json" \
+            -H "Authorization: Bearer $TOKEN" \
+            -X POST -d '{
+              "otp_code": "123456"
+            }' \
+            https://api.linode.com/v4/profile/phone-number/verify
+      - lang: CLI
+        source: >
+          linode-cli phone verify \
+            --otp_code 123456
   /profile/preferences:
     x-linode-cli-command: profile
     get:
@@ -25159,6 +25318,15 @@ components:
             as necessary.
           example: [email protected]
           x-linode-cli-display: 2
+        verified_phone_number:
+          type: string
+          format: phone
+          readOnly: true
+          description: |
+            The phone number verified for this Profile with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
+
+            `null` if this Profile has no verified phone number.
+          example: "+5555555555"
         timezone:
           type: string
           description: >