.. AUTO-GENERATED FILE. DO NOT EDIT.

fuel-pump-inventories-pumps-patch-one
=====================================

Source
------

- Repository: ``jef-systems/jef-fuel-pump-inventories-backend``
- Source Run ID: ``24967078100``
- Source SHA: ``1159f01c85f4a6aefdd03618419a726c3fc9edbb``
- Module: ``fuel-pump-inventories``
- Documentation Scope: ``async``
- Lambda: ``jef-fuel-pump-inventories-patch-12``

Endpoint
--------

- API Name: ``jef-fuel-pump-inventories``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/fuel-pump-inventories-pumps-patch-one``
- Complete Endpoint: ``https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-fuel-pump-inventories-patch-12``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-fuel-pump-inventories-patch-12
   Module: jef-fuel-pump-inventories
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /fuel-pump-inventories-pumps-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-fuel-pump-inventories-pumps
   
   Payload Example:
   - pk: pump-001
   - gsi_1_pk: 0001
   - gsi_1_sk: pump-001
   - entity_number: 0001
   - pump_id: pump-001
   - pump_label: Pump 1
   - product: Diesel
   - price_per_liter: 62.5
   - display_order: 1
   - is_active: True
   - created_at: 2026-04-26T00:00:00Z
   - updated_at: 2026-04-26T00:00:00Z
   
   Payload Schema:
   - pk: string-{pump_id}
   - gsi_1_pk: string-{entity_number}
   - gsi_1_sk: string-{pump_id}
   - entity_number: string
   - pump_id: string
   - pump_label: string
   - product: string
   - price_per_liter: number
   - display_order: number
   - is_active: boolean
   - created_at: string
   - updated_at: string
   
   Response Schema:
   - is_accepted: boolean
   - message: string

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

.. code-block:: json

   {
     "pk": "pump-001",
     "gsi_1_pk": "0001",
     "gsi_1_sk": "pump-001",
     "entity_number": "0001",
     "pump_id": "pump-001",
     "pump_label": "Pump 1",
     "product": "Diesel",
     "price_per_liter": "62.5",
     "display_order": "1",
     "is_active": "True",
     "created_at": "2026-04-26T00:00:00Z",
     "updated_at": "2026-04-26T00:00:00Z"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"pump-001\", \"gsi_1_pk\": \"0001\", \"gsi_1_sk\": \"pump-001\", \"entity_number\": \"0001\", \"pump_id\": \"pump-001\", \"pump_label\": \"Pump 1\", \"product\": \"Diesel\", \"price_per_liter\": 62.5, \"display_order\": 1, \"is_active\": true, \"created_at\": \"2026-04-26T00:00:00Z\", \"updated_at\": \"2026-04-26T00:00:00Z\"}"

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

.. code-block:: text

   curl.exe -X PATCH "https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "pump-001", "gsi_1_pk": "0001", "gsi_1_sk": "pump-001", "entity_number": "0001", "pump_id": "pump-001", "pump_label": "Pump 1", "product": "Diesel", "price_per_liter": 62.5, "display_order": 1, "is_active": true, "created_at": "2026-04-26T00:00:00Z", "updated_at": "2026-04-26T00:00:00Z"}'