.. AUTO-GENERATED FILE. DO NOT EDIT.

delete-menu-items-by-id
=======================

Source
------

- Repository: ``jef-systems/jef-caferimo-backend``
- Module: ``caferimo``
- Documentation Scope: ``async``
- Lambda: ``jef-caferimo-delete-4``

Endpoint
--------

- API Name: ``jef-caferimo``
- Action Name: ``delete``
- Method: ``DELETE``
- Scope Label: ``Async``
- Resource Path: ``/delete-menu-items-by-id``
- Complete Endpoint: ``https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/delete-menu-items-by-id``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-delete-4``
- curl payload mode: ``json_body``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-caferimo-delete-4
   API Name: jef-caferimo
   Action: delete
   Method: DELETE
   Resource Path: /delete-menu-items-by-id
   
   Payload:
   - entity_number: string-4-digits-nonzerostart
   - id: string
   
   Response:
   - exists: boolean
   - message: string
   - item: {"pk":"string-{entity_number}#{id}","gsi_1_pk":"string-{entity_number}#{category}","gsi_1_sk":"string-name","gsi_2_pk":"string-{entity_number}#{available}","gsi_2_sk":"string-name","entity_number":"string-4-digits-nonzerostart","id":"string","name":"string","category":"string","price":"number-decimal","sizes":{"medium":"number-decimal","large":"number-decimal"},"available":"boolean","recipe_binding_mode":"string-enum-none-single_recipe-variant_recipe","recipe_reference":{"recipe_number":"string-4-digits-optional","recipe_name":"string-optional"},"recipe_variants":[{"size":"string-enum-medium-large-or-null","temperature":"string-enum-hot-or-iced-or-null","recipe_number":"string-4-digits","recipe_name":"string"}],"recipe_output_mapping":[{"size":"string-enum-medium-large-or-null","temperature":"string-enum-hot-or-iced-or-null","output_key":"string","output_value":"string"}]}
   - deleted_pk: string

Request Payload
---------------

.. code-block:: json

   {
     "entity_number": "string-4-digits-nonzerostart",
     "id": "string"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"pk\":\"string-{entity_number}#{id}\",\"gsi_1_pk\":\"string-{entity_number}#{category}\",\"gsi_1_sk\":\"string-name\",\"gsi_2_pk\":\"string-{entity_number}#{available}\",\"gsi_2_sk\":\"string-name\",\"entity_number\":\"string-4-digits-nonzerostart\",\"id\":\"string\",\"name\":\"string\",\"category\":\"string\",\"price\":\"number-decimal\",\"sizes\":{\"medium\":\"number-decimal\",\"large\":\"number-decimal\"},\"available\":\"boolean\",\"recipe_binding_mode\":\"string-enum-none-single_recipe-variant_recipe\",\"recipe_reference\":{\"recipe_number\":\"string-4-digits-optional\",\"recipe_name\":\"string-optional\"},\"recipe_variants\":[{\"size\":\"string-enum-medium-large-or-null\",\"temperature\":\"string-enum-hot-or-iced-or-null\",\"recipe_number\":\"string-4-digits\",\"recipe_name\":\"string\"}],\"recipe_output_mapping\":[{\"size\":\"string-enum-medium-large-or-null\",\"temperature\":\"string-enum-hot-or-iced-or-null\",\"output_key\":\"string\",\"output_value\":\"string\"}]}",
     "deleted_pk": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X DELETE "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/delete-menu-items-by-id" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"string-4-digits-nonzerostart\", \"id\": \"string\"}"

PowerShell curl
---------------

.. code-block:: text

   curl.exe -X DELETE "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/delete-menu-items-by-id" -H "Content-Type: application/json" --data-raw '{"entity_number": "string-4-digits-nonzerostart", "id": "string"}'