medusa/www/utils/generated/oas-output/operations/auth/post_auth_verification_request.ts at 8754958c84378eb5087f1bbb0069763e0448ce26 · medusajs/medusa · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**
 * @oas [post] /auth/verification/request
 * operationId: PostVerificationRequest
 * summary: Create Verification
 * description: Create a verification.
 * x-authenticated: false
 * requestBody:
 *   content:
 *     application/json:
 *       schema:
 *         type: object
 *         description: SUMMARY
 *         required:
 *           - entity_id
 *           - entity_type
 *           - code_provider
 *         properties:
 *           entity_id:
 *             type: string
 *             title: entity_id
 *             description: The verification's entity id.
 *           entity_type:
 *             type: string
 *             title: entity_type
 *             description: The verification's entity type.
 *           code_provider:
 *             type: string
 *             title: code_provider
 *             description: The verification's code provider.
 *           metadata:
 *             type: object
 *             description: The verification's metadata.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/auth/verification/request' \
 *       -H 'Content-Type: application/json' \
 *       --data-raw '{
 *         "entity_id": "{value}",
 *         "entity_type": "{value}",
 *         "code_provider": "{value}"
 *       }'
 * tags:
 *   - Verification
 * responses:
 *   "201":
 *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
 *     $ref: "#/components/responses/unauthorized"
 *   "404":
 *     $ref: "#/components/responses/not_found_error"
 *   "409":
 *     $ref: "#/components/responses/invalid_state_error"
 *   "422":
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: requestVerificationWorkflow
 * x-events:
 *   - name: auth.verification_requested
 *     payload: |-
 *       ```ts
 *       {
 *         entity_id, // The identifier of the entity being verified. For example, an email address.
 *         entity_type, // The kind of entity being verified. For example, "email".
 *         code_provider, // The verification provider that generated the code. For example, "token".
 *         auth_identity_id, // The ID of the auth identity being verified.
 *         code, // The generated verification code.
 *         expires_at, // (Date) The code expiry date.
 *         metadata, // (object) Optional custom metadata passed from the request.
 *       }
 *       ```
 *     description: |-
 *       Emitted when a verification code is generated. You can listen to
 *       this event and decide how to deliver the code to the user or customer.
 *       The payload changed in v2.17.0:
 *       `actor_type` and `provider_identity_id` were removed,
 *       `provider` was renamed to `code_provider`, and `entity_type` was added.
 *       Subscribers written before v2.17.0 must be updated to use the payload below.
 *     deprecated: false
 *     since: 2.15.5
 * x-since: 2.16.0
 *
*/