Skip to content

SendBonusRequest

Source code in docs_src/capo_mturk/types/send_bonus_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class SendBonusRequest(TypedDict, closed=True):
    worker_id: "capo_mturk.types.customer_id.CustomerId"
    """<p>The ID of the Worker being paid the bonus.</p>"""
    bonus_amount: "capo_mturk.types.currency_amount.CurrencyAmount"
    """<p> The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes. </p>"""
    assignment_id: "capo_mturk.types.entity_id.EntityId"
    """<p>The ID of the assignment for which this bonus is paid.</p>"""
    reason: "capo_mturk.types.string.String"
    """<p>A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.</p>"""
    unique_request_token: NotRequired[
        "capo_mturk.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.</p>"""

assignment_id instance-attribute 

assignment_id: EntityId

The ID of the assignment for which this bonus is paid.

bonus_amount instance-attribute 

bonus_amount: CurrencyAmount

The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.

reason instance-attribute 

reason: String

A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

unique_request_token instance-attribute 

unique_request_token: NotRequired[IdempotencyToken]

A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

worker_id instance-attribute 

worker_id: CustomerId

The ID of the Worker being paid the bonus.