Files
medusa-store/docs/api/admin/paths/invites.yaml
2022-12-22 17:09:49 +02:00

83 lines
2.1 KiB
YAML

post:
operationId: PostInvites
summary: Create an Invite
description: Creates an Invite and triggers an 'invite' created event
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostInvitesReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/invites/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
get:
operationId: GetInvites
summary: Lists Invites
description: Lists all Invites
x-authenticated: true
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/invites/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites/getundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
invites:
type: array
items:
$ref: ../components/schemas/Invite.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml