diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh new file mode 100644 index 0000000000..8cb8da2cbd --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/notifications' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh new file mode 100644 index 0000000000..4696e5e151 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/notifications/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh new file mode 100644 index 0000000000..342d49a687 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/products/export' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh new file mode 100644 index 0000000000..3f9fa1af6e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh new file mode 100644 index 0000000000..daf79d095d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh new file mode 100644 index 0000000000..f7b1a9a521 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh new file mode 100644 index 0000000000..529c435c37 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/returns/{id}/receive-items' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh new file mode 100644 index 0000000000..2dd087ed2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh new file mode 100644 index 0000000000..71a5bc5488 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh new file mode 100644 index 0000000000..75900a6937 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/returns/{id}/receive' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh new file mode 100644 index 0000000000..f53ae5c12f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/returns/{id}/receive/confirm' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductRequest.yaml new file mode 100644 index 0000000000..aa3490570b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductRequest.yaml @@ -0,0 +1,3 @@ +type: object +description: SUMMARY +x-schemaName: AdminExportProductRequest diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml new file mode 100644 index 0000000000..01300d7807 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminExportProductResponse +required: + - workflow_id +properties: + workflow_id: + type: string + title: workflow_id + description: The product's workflow id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml new file mode 100644 index 0000000000..0c85e980ce --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -0,0 +1,18 @@ +type: object +required: + - return_id + - internal_note +x-schemaName: AdminPostCancelReturnReqSchema +properties: + return_id: + type: string + title: return_id + description: The return's return id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index c5a60d0da0..5369559d9e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -2,42 +2,16 @@ type: object description: SUMMARY x-schemaName: AdminPostReceiveReturnsReqSchema required: - - return_id - - items - - internal_note + - metadata properties: - return_id: - type: string - title: return_id - description: The return's return id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. internal_note: type: string title: internal_note description: The return's internal note. + description: + type: string + title: description + description: The return's description. + metadata: + type: object + description: The return's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml new file mode 100644 index 0000000000..d9f9bc3340 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsDismissItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml new file mode 100644 index 0000000000..2b7ac0d973 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml new file mode 100644 index 0000000000..abb7e8850f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml @@ -0,0 +1,30 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReceiveItemsReqSchema +properties: + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 5d6b8a47fa..0646ffce9a 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -47,6 +47,7 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + - name: Notifications - name: Orders - name: Payments - name: Price Lists @@ -6858,6 +6859,216 @@ paths: content: application/json: schema: {} + /admin/notifications: + get: + operationId: GetNotifications + summary: List Notifications + description: Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated. + 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The notification's q. + required: false + schema: + type: string + title: q + description: The notification's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The notification's ID. + - type: array + description: The notification's ID. + items: + type: string + title: id + description: The id's ID. + - name: channel + in: query + required: false + schema: + oneOf: + - type: string + title: channel + description: The notification's channel. + - type: array + description: The notification's channel. + items: + type: string + title: channel + description: The channel's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/notifications' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Notifications + responses: + '200': + 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' + /admin/notifications/{id}: + get: + operationId: GetNotificationsId + summary: Get a Notification + description: Retrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The notification's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/notifications/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Notifications + responses: + '200': + 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' /admin/orders: get: operationId: GetOrders @@ -25456,6 +25667,95 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/products/export: + post: + operationId: PostProductsExport + summary: Create Product + description: Create a product. + 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExportProductRequest' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/export' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Products + responses: + '202': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExportProductResponse' + '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' /admin/products/{id}: get: operationId: GetProductsId @@ -32144,7 +32444,287 @@ paths: requestBody: content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/AdminPostCancelReturnReqSchema' + /admin/returns/{id}/dismiss-items: + post: + operationId: PostReturnsIdDismissItems + summary: Add Dismiss Items to Return + description: Add a list of dismiss items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReceiveItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' + /admin/returns/{id}/dismiss-items/{action_id}: + post: + operationId: PostReturnsIdDismissItemsAction_id + summary: Add Dismiss Items to Return + description: Add a list of dismiss items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsDismissItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' + delete: + operationId: DeleteReturnsIdDismissItemsAction_id + summary: Remove Dismiss Items from Return + description: Remove a list of dismiss items from a return. This doesn't delete the Dismiss Item, only the association between the Dismiss Item and the return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' /admin/returns/{id}/receive: post: operationId: PostReturnsIdReceive @@ -32241,6 +32821,461 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + delete: + operationId: DeleteReturnsIdReceive + summary: Remove Receives from Return + description: Remove a list of receives from a return. This doesn't delete the Receive, only the association between the Receive and the return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/returns/{id}/receive' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' + /admin/returns/{id}/receive-items: + post: + operationId: PostReturnsIdReceiveItems + summary: Add Receive Items to Return + description: Add a list of receive items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReceiveItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/receive-items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' + /admin/returns/{id}/receive-items/{action_id}: + post: + operationId: PostReturnsIdReceiveItemsAction_id + summary: Add Receive Items to Return + description: Add a list of receive items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' + delete: + operationId: DeleteReturnsIdReceiveItemsAction_id + summary: Remove Receive Items from Return + description: Remove a list of receive items from a return. This doesn't delete the Receive Item, only the association between the Receive Item and the return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' + /admin/returns/{id}/receive/confirm: + post: + operationId: PostReturnsIdReceiveConfirm + summary: Add Confirms to Return + description: Add a list of confirms to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsConfirmRequestReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/receive/confirm' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + 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' /admin/returns/{id}/request: post: operationId: PostReturnsIdRequest @@ -32346,18 +33381,12 @@ paths: 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. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -32395,8 +33424,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -40421,6 +41448,21 @@ components: format: date-time title: updated_at description: The group's updated at. + AdminExportProductRequest: + type: object + description: SUMMARY + x-schemaName: AdminExportProductRequest + AdminExportProductResponse: + type: object + description: SUMMARY + x-schemaName: AdminExportProductResponse + required: + - workflow_id + properties: + workflow_id: + type: string + title: workflow_id + description: The product's workflow id. AdminFulfillmentProvider: type: object description: The shipping option's provider. @@ -40620,50 +41662,43 @@ components: metadata: type: object description: The order's metadata. - AdminPostReceiveReturnsReqSchema: + AdminPostCancelReturnReqSchema: type: object - description: SUMMARY - x-schemaName: AdminPostReceiveReturnsReqSchema required: - return_id - - items - internal_note + x-schemaName: AdminPostCancelReturnReqSchema properties: return_id: type: string title: return_id description: The return's return id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. internal_note: type: string title: internal_note description: The return's internal note. + AdminPostReceiveReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReceiveReturnsReqSchema + required: + - metadata + properties: + internal_note: + type: string + title: internal_note + description: The return's internal note. + description: + type: string + title: description + description: The return's description. + metadata: + type: object + description: The return's metadata. AdminPostReturnsConfirmRequestReqSchema: type: object description: SUMMARY @@ -40673,6 +41708,63 @@ components: type: boolean title: no_notification description: The return's no notification. + AdminPostReturnsDismissItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsDismissItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. + AdminPostReturnsReceiveItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. + AdminPostReturnsReceiveItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReceiveItemsReqSchema + properties: + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. AdminPostReturnsReqSchema: type: object description: SUMMARY diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index fda838af8c..49bcef5735 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -53,6 +53,7 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + - name: Notifications - name: Orders - name: Payments - name: Price Lists @@ -180,6 +181,10 @@ paths: $ref: paths/admin_invites_{id}.yaml /admin/invites/{id}/resend: $ref: paths/admin_invites_{id}_resend.yaml + /admin/notifications: + $ref: paths/admin_notifications.yaml + /admin/notifications/{id}: + $ref: paths/admin_notifications_{id}.yaml /admin/orders: $ref: paths/admin_orders.yaml /admin/orders/{id}: @@ -238,6 +243,8 @@ paths: $ref: paths/admin_products.yaml /admin/products/batch: $ref: paths/admin_products_batch.yaml + /admin/products/export: + $ref: paths/admin_products_export.yaml /admin/products/{id}: $ref: paths/admin_products_{id}.yaml /admin/products/{id}/options: @@ -292,8 +299,18 @@ paths: $ref: paths/admin_returns_{id}.yaml /admin/returns/{id}/cancel: $ref: paths/admin_returns_{id}_cancel.yaml + /admin/returns/{id}/dismiss-items: + $ref: paths/admin_returns_{id}_dismiss-items.yaml + /admin/returns/{id}/dismiss-items/{action_id}: + $ref: paths/admin_returns_{id}_dismiss-items_{action_id}.yaml /admin/returns/{id}/receive: $ref: paths/admin_returns_{id}_receive.yaml + /admin/returns/{id}/receive-items: + $ref: paths/admin_returns_{id}_receive-items.yaml + /admin/returns/{id}/receive-items/{action_id}: + $ref: paths/admin_returns_{id}_receive-items_{action_id}.yaml + /admin/returns/{id}/receive/confirm: + $ref: paths/admin_returns_{id}_receive_confirm.yaml /admin/returns/{id}/request: $ref: paths/admin_returns_{id}_request.yaml /admin/returns/{id}/request-items: diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml new file mode 100644 index 0000000000..4bcec8267d --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -0,0 +1,131 @@ +get: + operationId: GetNotifications + summary: List Notifications + description: >- + Retrieve a list of notifications. The notifications can be filtered by + fields such as `id`. The notifications can also be sorted or paginated. + 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The notification's q. + required: false + schema: + type: string + title: q + description: The notification's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The notification's ID. + - type: array + description: The notification's ID. + items: + type: string + title: id + description: The id's ID. + - name: channel + in: query + required: false + schema: + oneOf: + - type: string + title: channel + description: The notification's channel. + - type: array + description: The notification's channel. + items: + type: string + title: channel + description: The channel's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_notifications/get.sh + tags: + - Notifications + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml new file mode 100644 index 0000000000..8ced732f89 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml @@ -0,0 +1,93 @@ +get: + operationId: GetNotificationsId + summary: Get a Notification + description: >- + Retrieve a notification by its ID. You can expand the notification's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The notification's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_notifications_{id}/get.sh + tags: + - Notifications + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml new file mode 100644 index 0000000000..b4399fca01 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml @@ -0,0 +1,94 @@ +post: + operationId: PostProductsExport + summary: Create Product + description: Create a product. + 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminExportProductRequest.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_products_export/post.sh + tags: + - Products + responses: + '202': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExportProductResponse.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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml index 84f47965a0..4aa235fabc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -92,4 +92,5 @@ post: requestBody: content: application/json: - schema: {} + schema: + $ref: ../components/schemas/AdminPostCancelReturnReqSchema.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml new file mode 100644 index 0000000000..6e21c786d3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostReturnsIdDismissItems + summary: Add Dismiss Items to Return + description: Add a list of dismiss items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh + tags: + - Returns + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml new file mode 100644 index 0000000000..be34c0078d --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml @@ -0,0 +1,204 @@ +post: + operationId: PostReturnsIdDismissItemsAction_id + summary: Add Dismiss Items to Return + description: Add a list of dismiss items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh + tags: + - Returns + 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 +delete: + operationId: DeleteReturnsIdDismissItemsAction_id + summary: Remove Dismiss Items from Return + description: >- + Remove a list of dismiss items from a return. This doesn't delete the + Dismiss Item, only the association between the Dismiss Item and the return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh + tags: + - Returns + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml new file mode 100644 index 0000000000..49c4727024 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostReturnsIdReceiveItems + summary: Add Receive Items to Return + description: Add a list of receive items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}_receive-items/post.sh + tags: + - Returns + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml new file mode 100644 index 0000000000..33694a125d --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml @@ -0,0 +1,204 @@ +post: + operationId: PostReturnsIdReceiveItemsAction_id + summary: Add Receive Items to Return + description: Add a list of receive items to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh + tags: + - Returns + 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 +delete: + operationId: DeleteReturnsIdReceiveItemsAction_id + summary: Remove Receive Items from Return + description: >- + Remove a list of receive items from a return. This doesn't delete the + Receive Item, only the association between the Receive Item and the return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The return's action id. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh + tags: + - Returns + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 30f9e66dc2..4631e576d2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -94,3 +94,96 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteReturnsIdReceive + summary: Remove Receives from Return + description: >- + Remove a list of receives from a return. This doesn't delete the Receive, + only the association between the Receive and the return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}_receive/delete.sh + tags: + - Returns + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml new file mode 100644 index 0000000000..8910055b72 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostReturnsIdReceiveConfirm + summary: Add Confirms to Return + description: Add a list of confirms to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - 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. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - 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: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh + tags: + - Returns + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml index b2bf8cc580..7c1d4434ef 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml @@ -120,18 +120,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -173,8 +175,6 @@ delete: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExportProductRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExportProductRequest.yaml new file mode 100644 index 0000000000..aa3490570b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExportProductRequest.yaml @@ -0,0 +1,3 @@ +type: object +description: SUMMARY +x-schemaName: AdminExportProductRequest diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml new file mode 100644 index 0000000000..01300d7807 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminExportProductResponse +required: + - workflow_id +properties: + workflow_id: + type: string + title: workflow_id + description: The product's workflow id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml new file mode 100644 index 0000000000..0c85e980ce --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -0,0 +1,18 @@ +type: object +required: + - return_id + - internal_note +x-schemaName: AdminPostCancelReturnReqSchema +properties: + return_id: + type: string + title: return_id + description: The return's return id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index c5a60d0da0..5369559d9e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -2,42 +2,16 @@ type: object description: SUMMARY x-schemaName: AdminPostReceiveReturnsReqSchema required: - - return_id - - items - - internal_note + - metadata properties: - return_id: - type: string - title: return_id - description: The return's return id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. internal_note: type: string title: internal_note description: The return's internal note. + description: + type: string + title: description + description: The return's description. + metadata: + type: object + description: The return's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml new file mode 100644 index 0000000000..d9f9bc3340 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsDismissItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml new file mode 100644 index 0000000000..2b7ac0d973 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml new file mode 100644 index 0000000000..abb7e8850f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml @@ -0,0 +1,30 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReceiveItemsReqSchema +properties: + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 604dfc5969..a231414e57 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -5366,6 +5366,21 @@ components: format: date-time title: updated_at description: The group's updated at. + AdminExportProductRequest: + type: object + description: SUMMARY + x-schemaName: AdminExportProductRequest + AdminExportProductResponse: + type: object + description: SUMMARY + x-schemaName: AdminExportProductResponse + required: + - workflow_id + properties: + workflow_id: + type: string + title: workflow_id + description: The product's workflow id. AdminFulfillmentProvider: type: object description: The shipping option's provider. @@ -5565,50 +5580,43 @@ components: metadata: type: object description: The order's metadata. - AdminPostReceiveReturnsReqSchema: + AdminPostCancelReturnReqSchema: type: object - description: SUMMARY - x-schemaName: AdminPostReceiveReturnsReqSchema required: - return_id - - items - internal_note + x-schemaName: AdminPostCancelReturnReqSchema properties: return_id: type: string title: return_id description: The return's return id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. internal_note: type: string title: internal_note description: The return's internal note. + AdminPostReceiveReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReceiveReturnsReqSchema + required: + - metadata + properties: + internal_note: + type: string + title: internal_note + description: The return's internal note. + description: + type: string + title: description + description: The return's description. + metadata: + type: object + description: The return's metadata. AdminPostReturnsConfirmRequestReqSchema: type: object description: SUMMARY @@ -5618,6 +5626,63 @@ components: type: boolean title: no_notification description: The return's no notification. + AdminPostReturnsDismissItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsDismissItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. + AdminPostReturnsReceiveItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The return's quantity. + internal_note: + type: string + title: internal_note + description: The return's internal note. + AdminPostReturnsReceiveItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReceiveItemsReqSchema + properties: + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. AdminPostReturnsReqSchema: type: object description: SUMMARY diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index d3b800177d..c7865c43f6 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -48,6 +48,7 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + - name: Notifications - name: Orders - name: Payments - name: Price Lists diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts new file mode 100644 index 0000000000..2e9ca8a43f --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -0,0 +1,103 @@ +/** + * @oas [delete] /admin/returns/{id}/dismiss-items/{action_id} + * operationId: DeleteReturnsIdDismissItemsAction_id + * summary: Remove Dismiss Items from Return + * description: Remove a list of dismiss items from a return. This doesn't delete + * the Dismiss Item, only the association between the Dismiss Item and the + * return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The return's action id. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts new file mode 100644 index 0000000000..3e4e8ffdbb --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -0,0 +1,103 @@ +/** + * @oas [delete] /admin/returns/{id}/receive-items/{action_id} + * operationId: DeleteReturnsIdReceiveItemsAction_id + * summary: Remove Receive Items from Return + * description: Remove a list of receive items from a return. This doesn't delete + * the Receive Item, only the association between the Receive Item and the + * return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The return's action id. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts new file mode 100644 index 0000000000..f62d9f1eec --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts @@ -0,0 +1,94 @@ +/** + * @oas [delete] /admin/returns/{id}/receive + * operationId: DeleteReturnsIdReceive + * summary: Remove Receives from Return + * description: Remove a list of receives from a return. This doesn't delete the + * Receive, only the association between the Receive and the return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/returns/{id}/receive' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts index 46447b50c1..c9e5534f5d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts @@ -22,18 +22,18 @@ * 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. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -75,8 +75,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts new file mode 100644 index 0000000000..10d7eb9ec7 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -0,0 +1,132 @@ +/** + * @oas [get] /admin/notifications + * operationId: GetNotifications + * summary: List Notifications + * description: Retrieve a list of notifications. The notifications can be filtered + * by fields such as `id`. The notifications can also be sorted or paginated. + * 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * - name: q + * in: query + * description: The notification's q. + * required: false + * schema: + * type: string + * title: q + * description: The notification's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The notification's ID. + * - type: array + * description: The notification's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: channel + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: channel + * description: The notification's channel. + * - type: array + * description: The notification's channel. + * items: + * type: string + * title: channel + * description: The channel's details. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/notifications' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Notifications + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts new file mode 100644 index 0000000000..fa59fd1fac --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts @@ -0,0 +1,94 @@ +/** + * @oas [get] /admin/notifications/{id} + * operationId: GetNotificationsId + * summary: Get a Notification + * description: Retrieve a notification by its ID. You can expand the + * notification's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The notification's ID. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/notifications/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Notifications + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts new file mode 100644 index 0000000000..3e5e404e5b --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts @@ -0,0 +1,96 @@ +/** + * @oas [post] /admin/products/export + * operationId: PostProductsExport + * summary: Create Product + * description: Create a product. + * 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExportProductRequest" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/export' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Products + * responses: + * "202": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExportProductResponse" + * "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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts index 790642245b..37c4dd4d8d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts @@ -89,7 +89,8 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * $ref: "#/components/schemas/AdminPostCancelReturnReqSchema" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts new file mode 100644 index 0000000000..c550caa921 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/returns/{id}/dismiss-items + * operationId: PostReturnsIdDismissItems + * summary: Add Dismiss Items to Return + * description: Add a list of dismiss items to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsReceiveItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts new file mode 100644 index 0000000000..c9f18b3217 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts @@ -0,0 +1,106 @@ +/** + * @oas [post] /admin/returns/{id}/dismiss-items/{action_id} + * operationId: PostReturnsIdDismissItemsAction_id + * summary: Add Dismiss Items to Return + * description: Add a list of dismiss items to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The return's action id. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsDismissItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts new file mode 100644 index 0000000000..0f609697e7 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/returns/{id}/receive-items + * operationId: PostReturnsIdReceiveItems + * summary: Add Receive Items to Return + * description: Add a list of receive items to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsReceiveItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/receive-items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts new file mode 100644 index 0000000000..d58e325e13 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts @@ -0,0 +1,106 @@ +/** + * @oas [post] /admin/returns/{id}/receive-items/{action_id} + * operationId: PostReturnsIdReceiveItemsAction_id + * summary: Add Receive Items to Return + * description: Add a list of receive items to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The return's action id. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts new file mode 100644 index 0000000000..5183b540a9 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/returns/{id}/receive/confirm + * operationId: PostReturnsIdReceiveConfirm + * summary: Add Confirms to Return + * description: Add a list of confirms to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - 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. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - 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: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsConfirmRequestReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/receive/confirm' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts b/www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts new file mode 100644 index 0000000000..806b01b1c6 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminExportProductRequest + * type: object + * description: SUMMARY + * x-schemaName: AdminExportProductRequest + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts b/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts new file mode 100644 index 0000000000..939fc86b0e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts @@ -0,0 +1,15 @@ +/** + * @schema AdminExportProductResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminExportProductResponse + * required: + * - workflow_id + * properties: + * workflow_id: + * type: string + * title: workflow_id + * description: The product's workflow id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts new file mode 100644 index 0000000000..cf306839a8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminPostCancelReturnReqSchema + * type: object + * required: + * - return_id + * - internal_note + * x-schemaName: AdminPostCancelReturnReqSchema + * properties: + * return_id: + * type: string + * title: return_id + * description: The return's return id. + * no_notification: + * type: boolean + * title: no_notification + * description: The return's no notification. + * internal_note: + * type: string + * title: internal_note + * description: The return's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts index 65fe5f1bcc..670646407a 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts @@ -4,45 +4,19 @@ * description: SUMMARY * x-schemaName: AdminPostReceiveReturnsReqSchema * required: - * - return_id - * - items - * - internal_note + * - metadata * properties: - * return_id: - * type: string - * title: return_id - * description: The return's return id. - * items: - * type: array - * description: The return's items. - * items: - * type: object - * description: The item's items. - * required: - * - id - * - quantity - * - reason_id - * properties: - * id: - * type: string - * title: id - * description: The item's ID. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * reason_id: - * type: string - * title: reason_id - * description: The item's reason id. - * note: - * type: string - * title: note - * description: The item's note. * internal_note: * type: string * title: internal_note * description: The return's internal note. + * description: + * type: string + * title: description + * description: The return's description. + * metadata: + * type: object + * description: The return's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsDismissItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsDismissItemsActionReqSchema.ts new file mode 100644 index 0000000000..bb2d24d209 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsDismissItemsActionReqSchema.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminPostReturnsDismissItemsActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostReturnsDismissItemsActionReqSchema + * properties: + * quantity: + * type: number + * title: quantity + * description: The return's quantity. + * internal_note: + * type: string + * title: internal_note + * description: The return's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsActionReqSchema.ts new file mode 100644 index 0000000000..784126d4b0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsActionReqSchema.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminPostReturnsReceiveItemsActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema + * properties: + * quantity: + * type: number + * title: quantity + * description: The return's quantity. + * internal_note: + * type: string + * title: internal_note + * description: The return's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts new file mode 100644 index 0000000000..25de0b63e7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts @@ -0,0 +1,35 @@ +/** + * @schema AdminPostReturnsReceiveItemsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostReturnsReceiveItemsReqSchema + * properties: + * items: + * type: array + * description: The return's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * description: + * type: string + * title: description + * description: The item's description. + * internal_note: + * type: string + * title: internal_note + * description: The item's internal note. + * +*/ +