Files
medusa-store/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts
Shahed Nasser 4fe28f5a95 chore: reorganize docs apps (#7228)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
2024-05-03 17:36:38 +03:00

105 lines
3.0 KiB
TypeScript

/**
* @oas [post] /admin/invites/accept
* operationId: PostInvitesAccept
* summary: Create Invite
* description: Create a invite.
* x-authenticated: true
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - email
* - first_name
* - last_name
* properties:
* first_name:
* type: string
* title: first_name
* description: The invite's first name.
* last_name:
* type: string
* title: last_name
* description: The invite's last name.
* email:
* type: string
* title: email
* description: The invite's email.
* format: email
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/invites/accept' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "first_name": "{value}",
* "last_name": "{value}"
* }'
* tags:
* - Invites
* responses:
* "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"
*
*/