.. AUTO-GENERATED FILE. DO NOT EDIT.

hardware-rentals-patch-one
==========================

Source
------

- Repository: ``jef-systems/jef-hardware-backend``
- Source Run ID: ``25090787814``
- Source SHA: ``444376867c764658b4ed0286bc44ff0ac8c80995``
- Module: ``hardware``
- Documentation Scope: ``async``
- Lambda: ``jef-hardware-patch-6``

Endpoint
--------

- API Name: ``jef-hardware``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/hardware-rentals-patch-one``
- Complete Endpoint: ``https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rentals-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-hardware-patch-6``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-hardware-patch-6
   Module: jef-hardware
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /hardware-rentals-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-hardware-rentals
   
   Payload Example:
   - pk: RNT-2026-0001
   - gsi_1_pk: 8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001
   - gsi_1_sk: 2026-04-24T11:00:00+08:00
   - id: RNT-2026-0001
   - deposit: 2000
   - items[0].lineId: LINE-0001
   - items[0].equipmentId: TBX-0001
   - items[0].toolboxNumber: BOX-0001
   - items[0].equipmentName: Rotary Hammer Drill
   - items[0].category: Power Tools
   - items[0].includedItems[0]: Carry Case
   - items[0].includedItems[1]: 2 Drill Bits
   - items[0].includedItems[2]: Depth Gauge
   - items[0].includedItems[3]: Side Handle
   - items[0].ratePerDay: 800
   - items[0].days: 2
   - items[0].subtotal: 1600
   - items[0].qrValue: QR-TBX-0001
   - items[0].expectedReturnAt: 2026-04-26T11:00:00+08:00
   - items[1].lineId: LINE-0002
   - items[1].equipmentId: TBX-0002
   - items[1].toolboxNumber: BOX-0002
   - items[1].equipmentName: Concrete Cutter
   - items[1].category: Cutting Tools
   - items[1].includedItems[0]: Blade Guard
   - items[1].includedItems[1]: Diamond Blade
   - items[1].includedItems[2]: Wrench
   - items[1].includedItems[3]: Fuel Bottle
   - items[1].ratePerDay: 1200
   - items[1].days: 1
   - items[1].subtotal: 1200
   - items[1].qrValue: QR-TBX-0002
   - items[1].expectedReturnAt: 2026-04-25T11:00:00+08:00
   - version: 1
   
   Payload Schema:
   - pk: string-{rental_id}
   - gsi_1_pk: string-{entity_number}
   - gsi_1_sk: string-{rental_id}
   - entity_number: string
   - id: string
   - rental_id: string
   - order_number: string
   - created_at: string
   - updated_at: string
   - cashier_name: string
   - terminal_name: string
   - customer_id: string
   - customer_code: string
   - customer_name: string
   - customer_mobile_number: string
   - customer_address: string
   - customer_government_id_type: string
   - customer_government_id_number: string
   - deposit: number
   - gross_total: number
   - total_due: number
   - items[0].line_id: string
   - items[0].equipment_id: string
   - items[0].toolbox_number: string
   - items[0].equipment_name: string
   - items[0].category: string
   - items[0].included_items[0]: string
   - items[0].rate_per_day: number
   - items[0].days: number
   - items[0].subtotal: number
   - items[0].qr_value: string
   - items[0].expected_return_at: string
   - expected_return_at: string
   - rental_status: string
   - print_status: string
   - printed_at: string
   - printer_device_id: string
   - printer_device_name: string
   - version: number
   - is_deleted: boolean
   - sync_status: string
   - sync_attempt_count: number
   
   Response Schema:
   - is_accepted: boolean
   - message: string

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

.. code-block:: json

   {
     "pk": "RNT-2026-0001",
     "gsi_1_pk": "8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001",
     "gsi_1_sk": "2026-04-24T11:00:00+08:00",
     "id": "RNT-2026-0001",
     "deposit": "2000",
     "items[0].lineId": "LINE-0001",
     "items[0].equipmentId": "TBX-0001",
     "items[0].toolboxNumber": "BOX-0001",
     "items[0].equipmentName": "Rotary Hammer Drill",
     "items[0].category": "Power Tools",
     "items[0].includedItems[0]": "Carry Case",
     "items[0].includedItems[1]": "2 Drill Bits",
     "items[0].includedItems[2]": "Depth Gauge",
     "items[0].includedItems[3]": "Side Handle",
     "items[0].ratePerDay": "800",
     "items[0].days": "2",
     "items[0].subtotal": "1600",
     "items[0].qrValue": "QR-TBX-0001",
     "items[0].expectedReturnAt": "2026-04-26T11:00:00+08:00",
     "items[1].lineId": "LINE-0002",
     "items[1].equipmentId": "TBX-0002",
     "items[1].toolboxNumber": "BOX-0002",
     "items[1].equipmentName": "Concrete Cutter",
     "items[1].category": "Cutting Tools",
     "items[1].includedItems[0]": "Blade Guard",
     "items[1].includedItems[1]": "Diamond Blade",
     "items[1].includedItems[2]": "Wrench",
     "items[1].includedItems[3]": "Fuel Bottle",
     "items[1].ratePerDay": "1200",
     "items[1].days": "1",
     "items[1].subtotal": "1200",
     "items[1].qrValue": "QR-TBX-0002",
     "items[1].expectedReturnAt": "2026-04-25T11:00:00+08:00",
     "version": "1"
   }

Response
--------

.. code-block:: json

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

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rentals-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"RNT-2026-0001\", \"gsi_1_pk\": \"8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001\", \"gsi_1_sk\": \"2026-04-24T11:00:00+08:00\", \"id\": \"RNT-2026-0001\", \"deposit\": 2000, \"items\": [{\"lineId\": \"LINE-0001\", \"equipmentId\": \"TBX-0001\", \"toolboxNumber\": \"BOX-0001\", \"equipmentName\": \"Rotary Hammer Drill\", \"category\": \"Power Tools\", \"includedItems\": [\"Carry Case\", \"2 Drill Bits\", \"Depth Gauge\", \"Side Handle\"], \"ratePerDay\": 800, \"days\": 2, \"subtotal\": 1600, \"qrValue\": \"QR-TBX-0001\", \"expectedReturnAt\": \"2026-04-26T11:00:00+08:00\"}, {\"lineId\": \"LINE-0002\", \"equipmentId\": \"TBX-0002\", \"toolboxNumber\": \"BOX-0002\", \"equipmentName\": \"Concrete Cutter\", \"category\": \"Cutting Tools\", \"includedItems\": [\"Blade Guard\", \"Diamond Blade\", \"Wrench\", \"Fuel Bottle\"], \"ratePerDay\": 1200, \"days\": 1, \"subtotal\": 1200, \"qrValue\": \"QR-TBX-0002\", \"expectedReturnAt\": \"2026-04-25T11:00:00+08:00\"}], \"version\": 1}"

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

.. code-block:: text

   curl.exe -X PATCH "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rentals-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "RNT-2026-0001", "gsi_1_pk": "8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001", "gsi_1_sk": "2026-04-24T11:00:00+08:00", "id": "RNT-2026-0001", "deposit": 2000, "items": [{"lineId": "LINE-0001", "equipmentId": "TBX-0001", "toolboxNumber": "BOX-0001", "equipmentName": "Rotary Hammer Drill", "category": "Power Tools", "includedItems": ["Carry Case", "2 Drill Bits", "Depth Gauge", "Side Handle"], "ratePerDay": 800, "days": 2, "subtotal": 1600, "qrValue": "QR-TBX-0001", "expectedReturnAt": "2026-04-26T11:00:00+08:00"}, {"lineId": "LINE-0002", "equipmentId": "TBX-0002", "toolboxNumber": "BOX-0002", "equipmentName": "Concrete Cutter", "category": "Cutting Tools", "includedItems": ["Blade Guard", "Diamond Blade", "Wrench", "Fuel Bottle"], "ratePerDay": 1200, "days": 1, "subtotal": 1200, "qrValue": "QR-TBX-0002", "expectedReturnAt": "2026-04-25T11:00:00+08:00"}], "version": 1}'